From e959fbcb456b7195b24081905c1dc62b1be6edfd Mon Sep 17 00:00:00 2001
From: Mike Christensen <mike.christensen@ably.com>
Date: Tue, 17 Oct 2023 10:18:48 +0100
Subject: [PATCH] stream: rename channel to channelName

---
 src/Model.test.ts           | 58 ++++++++++++++++++-------------------
 src/Model.ts                |  6 ++--
 src/stream/Stream.test.ts   | 36 +++++++++++------------
 src/stream/Stream.ts        | 12 ++++----
 src/stream/StreamFactory.ts |  4 +--
 5 files changed, 58 insertions(+), 58 deletions(-)

diff --git a/src/Model.test.ts b/src/Model.test.ts
index 3ca235da..27b02d5e 100644
--- a/src/Model.test.ts
+++ b/src/Model.test.ts
@@ -21,12 +21,12 @@ vi.mock('ably/promises');
 // in these tests.
 vi.mock('./stream/StreamFactory', () => {
   class MockStream implements IStream {
-    constructor(readonly options: Pick<StreamOptions, 'channel'>) {}
+    constructor(readonly options: Pick<StreamOptions, 'channelName'>) {}
     get state() {
       return StreamState.READY;
     }
-    get channel() {
-      return this.options.channel;
+    get channelName() {
+      return this.options.channelName;
     }
     async pause() {}
     async resume() {}
@@ -40,11 +40,11 @@ vi.mock('./stream/StreamFactory', () => {
 
   return {
     default: class implements IStreamFactory {
-      newStream(options: Pick<StreamOptions, 'channel'>) {
-        if (!streams[options.channel]) {
-          streams[options.channel] = new MockStream(options);
+      newStream(options: Pick<StreamOptions, 'channelName'>) {
+        if (!streams[options.channelName]) {
+          streams[options.channelName] = new MockStream(options);
         }
-        return streams[options.channel];
+        return streams[options.channelName];
       }
     },
   };
@@ -157,7 +157,7 @@ describe('Model', () => {
   });
 
   it<ModelTestContext>('pauses and resumes the model', async ({ channelName, ably, logger, streams }) => {
-    const s1 = streams.newStream({ channel: channelName });
+    const s1 = streams.newStream({ channelName });
     s1.subscribe = vi.fn();
     s1.pause = vi.fn();
     s1.resume = vi.fn();
@@ -183,7 +183,7 @@ describe('Model', () => {
   });
 
   it<ModelTestContext>('disposes of the model', async ({ channelName, ably, logger, streams }) => {
-    const s1 = streams.newStream({ channel: channelName });
+    const s1 = streams.newStream({ channelName });
     s1.subscribe = vi.fn();
     s1.unsubscribe = vi.fn();
     const sync = vi.fn(async () => simpleTestData);
@@ -209,7 +209,7 @@ describe('Model', () => {
       channelEvents: new Subject<Types.Message>(),
     };
 
-    streams.newStream({ channel: channelName }).subscribe = vi.fn((callback) =>
+    streams.newStream({ channelName }).subscribe = vi.fn((callback) =>
       events.channelEvents.subscribe((message) => callback(null, message)),
     );
 
@@ -290,7 +290,7 @@ describe('Model', () => {
   });
 
   it<ModelTestContext>('executes a registered mutation', async ({ channelName, ably, logger, streams }) => {
-    const s1 = streams.newStream({ channel: channelName });
+    const s1 = streams.newStream({ channelName });
     s1.subscribe = vi.fn();
     const model = new Model<string, { foo: (_: MutationContext, a: string, b: number) => Promise<string> }>('test', {
       ably,
@@ -310,7 +310,7 @@ describe('Model', () => {
   });
 
   it<ModelTestContext>('fails to register twice', async ({ channelName, ably, logger, streams }) => {
-    const s1 = streams.newStream({ channel: channelName });
+    const s1 = streams.newStream({ channelName });
     s1.subscribe = vi.fn();
     const model = new Model<string, { foo: () => Promise<void> }>('test', { ably, channelName, logger });
 
@@ -339,7 +339,7 @@ describe('Model', () => {
       }
     }
 
-    const s1 = streams.newStream({ channel: channelName });
+    const s1 = streams.newStream({ channelName });
     s1.subscribe = vi.fn();
     const model = new ModelWithSetState<string, { foo: () => Promise<void> }>('test', { ably, channelName, logger });
 
@@ -359,7 +359,7 @@ describe('Model', () => {
     logger,
     streams,
   }) => {
-    const s1 = streams.newStream({ channel: channelName });
+    const s1 = streams.newStream({ channelName });
     s1.subscribe = vi.fn();
     const model = new Model<string, { foo: () => Promise<string> }>('test', { ably, channelName, logger });
 
@@ -374,7 +374,7 @@ describe('Model', () => {
   });
 
   it<ModelTestContext>('updates model state with optimistic event', async ({ channelName, ably, logger, streams }) => {
-    const s1 = streams.newStream({ channel: channelName });
+    const s1 = streams.newStream({ channelName });
     s1.subscribe = vi.fn();
     const model = new Model<string, { foo: () => Promise<string> }>('test', { ably, channelName, logger });
 
@@ -416,7 +416,7 @@ describe('Model', () => {
   });
 
   it<ModelTestContext>('confirms an optimistic event', async ({ channelName, ably, logger, streams }) => {
-    const s1 = streams.newStream({ channel: channelName });
+    const s1 = streams.newStream({ channelName });
     s1.subscribe = vi.fn();
 
     const events = { e1: new Subject<Types.Message>() };
@@ -470,7 +470,7 @@ describe('Model', () => {
   });
 
   it<ModelTestContext>('confirms an optimistic event by uuid', async ({ channelName, ably, logger, streams }) => {
-    const s1 = streams.newStream({ channel: channelName });
+    const s1 = streams.newStream({ channelName });
     s1.subscribe = vi.fn();
 
     const events = { e1: new Subject<Types.Message>() };
@@ -529,7 +529,7 @@ describe('Model', () => {
   });
 
   it<ModelTestContext>('mutation can access the optimistic events', async ({ channelName, ably, logger, streams }) => {
-    const s1 = streams.newStream({ channel: channelName });
+    const s1 = streams.newStream({ channelName });
     s1.subscribe = vi.fn();
 
     const events = { e1: new Subject<Types.Message>() };
@@ -568,7 +568,7 @@ describe('Model', () => {
   });
 
   it<ModelTestContext>('explicitly rejects an optimistic event', async ({ channelName, ably, logger, streams }) => {
-    const s1 = streams.newStream({ channel: channelName });
+    const s1 = streams.newStream({ channelName });
     s1.subscribe = vi.fn();
 
     const events = { e1: new Subject<Types.Message>() };
@@ -633,7 +633,7 @@ describe('Model', () => {
     logger,
     streams,
   }) => {
-    const s1 = streams.newStream({ channel: channelName });
+    const s1 = streams.newStream({ channelName });
     s1.subscribe = vi.fn();
 
     const events = { e1: new Subject<Types.Message>() };
@@ -696,7 +696,7 @@ describe('Model', () => {
   });
 
   it<ModelTestContext>('confirms optimistic events out of order', async ({ channelName, ably, logger, streams }) => {
-    const s1 = streams.newStream({ channel: channelName });
+    const s1 = streams.newStream({ channelName });
     s1.subscribe = vi.fn();
 
     const events = { e1: new Subject<Types.Message>() };
@@ -779,7 +779,7 @@ describe('Model', () => {
     logger,
     streams,
   }) => {
-    const s1 = streams.newStream({ channel: channelName });
+    const s1 = streams.newStream({ channelName });
     s1.subscribe = vi.fn();
 
     const events = { e1: new Subject<Types.Message>() };
@@ -865,7 +865,7 @@ describe('Model', () => {
   });
 
   it<ModelTestContext>('revert optimistic events if mutate fails', async ({ channelName, ably, logger, streams }) => {
-    const s1 = streams.newStream({ channel: channelName });
+    const s1 = streams.newStream({ channelName });
     s1.subscribe = vi.fn();
 
     const model = new Model<
@@ -910,7 +910,7 @@ describe('Model', () => {
 
   // If applying a received stream update throws, the model reverts to the PREPARING state and re-syncs.
   it<ModelTestContext>('resync if stream apply update fails', async ({ channelName, ably, logger, streams }) => {
-    const s1 = streams.newStream({ channel: channelName });
+    const s1 = streams.newStream({ channelName });
     s1.subscribe = vi.fn();
 
     // event subjects used to invoke the stream subscription callbacks
@@ -978,7 +978,7 @@ describe('Model', () => {
     logger,
     streams,
   }) => {
-    const s1 = streams.newStream({ channel: channelName });
+    const s1 = streams.newStream({ channelName });
     s1.subscribe = vi.fn();
 
     const model = new Model<string, { mutation: () => Promise<string> }>('test', { ably, channelName, logger });
@@ -1018,7 +1018,7 @@ describe('Model', () => {
 
   // Tests if the mutation throws, the the optimistic events are reverted.
   it<ModelTestContext>('revert optimistic events if mutation fails', async ({ channelName, ably, logger, streams }) => {
-    const s1 = streams.newStream({ channel: 's1' });
+    const s1 = streams.newStream({ channelName: 's1' });
     s1.subscribe = vi.fn();
 
     const model = new Model<string, { mutation1: () => Promise<string>; mutation2: () => Promise<string> }>('test', {
@@ -1065,7 +1065,7 @@ describe('Model', () => {
     logger,
     streams,
   }) => {
-    const s1 = streams.newStream({ channel: channelName });
+    const s1 = streams.newStream({ channelName });
     s1.subscribe = vi.fn();
 
     const model = new Model<string, { mutation: () => Promise<string> }>('test', { ably, channelName, logger });
@@ -1103,7 +1103,7 @@ describe('Model', () => {
     logger,
     streams,
   }) => {
-    const s1 = streams.newStream({ channel: channelName });
+    const s1 = streams.newStream({ channelName });
     s1.subscribe = vi.fn();
 
     const events = { e1: new Subject<Types.Message>() };
@@ -1144,7 +1144,7 @@ describe('Model', () => {
   });
 
   it<ModelTestContext>('optimistic event confirmation timeout', async ({ channelName, ably, logger, streams }) => {
-    const s1 = streams.newStream({ channel: 's1' });
+    const s1 = streams.newStream({ channelName: 's1' });
     s1.subscribe = vi.fn();
 
     const events = { e1: new Subject<Types.Message>() };
diff --git a/src/Model.ts b/src/Model.ts
index 461c170e..14f72a3a 100644
--- a/src/Model.ts
+++ b/src/Model.ts
@@ -78,7 +78,7 @@ export default class Model<T, M extends MutationMethods> extends EventEmitter<Re
       logger: options.logger,
       eventBufferOptions: options.eventBufferOptions,
     });
-    this.stream = this.streamFactory.newStream({ channel: options.channelName });
+    this.stream = this.streamFactory.newStream({ channelName: options.channelName });
 
     this.mutationsRegistry = new MutationsRegistry<M>(
       {
@@ -264,7 +264,7 @@ export default class Model<T, M extends MutationMethods> extends EventEmitter<Re
     }
 
     for (const event of events) {
-      if (event.channel !== this.stream.channel) {
+      if (event.channel !== this.stream.channelName) {
         throw new Error(`stream with name '${event.channel}' not registered on model '${this.name}'`);
       }
     }
@@ -298,7 +298,7 @@ export default class Model<T, M extends MutationMethods> extends EventEmitter<Re
     this.setState('preparing', reason);
 
     this.removeStream();
-    this.addStream(this.stream.channel);
+    this.addStream(this.stream.channelName);
 
     const data = await this.syncFunc();
     this.setOptimisticData(data);
diff --git a/src/stream/Stream.test.ts b/src/stream/Stream.test.ts
index f725bf60..c6308253 100644
--- a/src/stream/Stream.test.ts
+++ b/src/stream/Stream.test.ts
@@ -10,7 +10,7 @@ import { statePromise } from '../utilities/test/promises.js';
 vi.mock('ably/promises');
 
 interface StreamTestContext extends StreamOptions {
-  channel: string;
+  channelName: string;
   ably: Types.RealtimePromise;
   logger: Logger;
 }
@@ -34,7 +34,7 @@ describe('Stream', () => {
 
     context.ably = ably;
     context.logger = pino({ level: 'silent' });
-    context.channel = channelName;
+    context.channelName = channelName;
   });
 
   afterEach(() => {
@@ -44,7 +44,7 @@ describe('Stream', () => {
   it<StreamTestContext>('enters ready state when successfully attached to the channel', async ({
     ably,
     logger,
-    channel,
+    channelName: channel,
   }) => {
     // the promise returned by the subscribe method resolves when we have successfully attached to the channel
     let attach: (...args: any[]) => void = () => {
@@ -55,7 +55,7 @@ describe('Stream', () => {
       await attachment;
     });
 
-    const stream = new Stream({ ably, logger, channel: 'foobar' });
+    const stream = new Stream({ ably, logger, channelName: 'foobar' });
 
     await statePromise(stream, StreamState.PREPARING);
     attach();
@@ -63,13 +63,13 @@ describe('Stream', () => {
     expect(ably.channels.get(channel).subscribe).toHaveBeenCalledOnce();
   });
 
-  it<StreamTestContext>('subscribes to messages', async ({ ably, logger, channel }) => {
+  it<StreamTestContext>('subscribes to messages', async ({ ably, logger, channelName: channel }) => {
     let messages = new Subject<Types.Message>();
     ably.channels.get(channel).subscribe = vi.fn<any, any>((callback) => {
       messages.subscribe((message) => callback(message));
     });
 
-    const stream = new Stream({ ably, logger, channel });
+    const stream = new Stream({ ably, logger, channelName: channel });
     await statePromise(stream, StreamState.READY);
 
     const subscriptionSpy = vi.fn();
@@ -87,13 +87,13 @@ describe('Stream', () => {
     expect(ably.channels.get(channel).subscribe).toHaveBeenCalledOnce();
   });
 
-  it<StreamTestContext>('subscribes with multiple listeners', async ({ ably, logger, channel }) => {
+  it<StreamTestContext>('subscribes with multiple listeners', async ({ ably, logger, channelName: channel }) => {
     let messages = new Subject<Types.Message>();
     ably.channels.get(channel).subscribe = vi.fn<any, any>((callback) => {
       messages.subscribe((message) => callback(message));
     });
 
-    const stream = new Stream({ ably, logger, channel });
+    const stream = new Stream({ ably, logger, channelName: channel });
     await statePromise(stream, StreamState.READY);
 
     const subscriptionSpy1 = vi.fn();
@@ -116,13 +116,13 @@ describe('Stream', () => {
     expect(ably.channels.get(channel).subscribe).toHaveBeenCalledOnce();
   });
 
-  it<StreamTestContext>('unsubscribes to messages', async ({ ably, logger, channel }) => {
+  it<StreamTestContext>('unsubscribes to messages', async ({ ably, logger, channelName: channel }) => {
     let messages = new Subject<Types.Message>();
     ably.channels.get(channel).subscribe = vi.fn<any, any>((callback) => {
       messages.subscribe((message) => callback(message));
     });
 
-    const stream = new Stream({ ably, logger, channel });
+    const stream = new Stream({ ably, logger, channelName: channel });
     await statePromise(stream, StreamState.READY);
 
     const subscriptionSpy = vi.fn();
@@ -143,13 +143,13 @@ describe('Stream', () => {
     expect(ably.channels.get(channel).subscribe).toHaveBeenCalledOnce();
   });
 
-  it<StreamTestContext>('unsubscribes one of two listeners', async ({ ably, logger, channel }) => {
+  it<StreamTestContext>('unsubscribes one of two listeners', async ({ ably, logger, channelName: channel }) => {
     let messages = new Subject<Types.Message>();
     ably.channels.get(channel).subscribe = vi.fn<any, any>((callback) => {
       messages.subscribe((message) => callback(message));
     });
 
-    const stream = new Stream({ ably, logger, channel });
+    const stream = new Stream({ ably, logger, channelName: channel });
     await statePromise(stream, StreamState.READY);
 
     const subscriptionSpy1 = vi.fn();
@@ -177,8 +177,8 @@ describe('Stream', () => {
     expect(ably.channels.get(channel).subscribe).toHaveBeenCalledOnce();
   });
 
-  it<StreamTestContext>('pauses and resumes the stream', async ({ ably, logger, channel }) => {
-    const stream = new Stream({ ably, logger, channel });
+  it<StreamTestContext>('pauses and resumes the stream', async ({ ably, logger, channelName: channel }) => {
+    const stream = new Stream({ ably, logger, channelName: channel });
 
     await statePromise(stream, StreamState.READY);
     expect(ably.channels.get(channel).subscribe).toHaveBeenCalledOnce();
@@ -192,9 +192,9 @@ describe('Stream', () => {
     expect(ably.channels.get(channel).attach).toHaveBeenCalledOnce();
   });
 
-  it<StreamTestContext>('disposes of the stream', async ({ ably, logger, channel }) => {
+  it<StreamTestContext>('disposes of the stream', async ({ ably, logger, channelName: channel }) => {
     ably.channels.release = vi.fn();
-    const stream = new Stream({ ably, logger, channel });
+    const stream = new Stream({ ably, logger, channelName: channel });
 
     await statePromise(stream, StreamState.READY);
     expect(ably.channels.get(channel).subscribe).toHaveBeenCalledOnce();
@@ -204,7 +204,7 @@ describe('Stream', () => {
     expect(ably.channels.release).toHaveBeenCalledOnce();
   });
 
-  it<StreamTestContext>('disposes of the stream on channel failed', async ({ ably, logger, channel }) => {
+  it<StreamTestContext>('disposes of the stream on channel failed', async ({ ably, logger, channelName: channel }) => {
     ably.channels.release = vi.fn();
     let fail: (...args: any[]) => void = () => {
       throw new Error('fail not defined');
@@ -215,7 +215,7 @@ describe('Stream', () => {
       }
     });
 
-    const stream = new Stream({ ably, logger, channel });
+    const stream = new Stream({ ably, logger, channelName: channel });
 
     await statePromise(stream, StreamState.READY);
     expect(ably.channels.get(channel).subscribe).toHaveBeenCalledOnce();
diff --git a/src/stream/Stream.ts b/src/stream/Stream.ts
index 621e5c9a..5b3cf986 100644
--- a/src/stream/Stream.ts
+++ b/src/stream/Stream.ts
@@ -40,7 +40,7 @@ export enum StreamState {
  * Options used to configure a stream instance.
  */
 export type StreamOptions = {
-  channel: string;
+  channelName: string;
   ably: AblyTypes.RealtimePromise;
   logger: Logger;
   eventBufferOptions?: EventBufferOptions;
@@ -73,7 +73,7 @@ export type StreamStateChange = {
 
 export interface IStream {
   get state(): StreamState;
-  get channel(): string;
+  get channelName(): string;
   pause(): Promise<void>;
   resume(): Promise<void>;
   reset(): void;
@@ -100,8 +100,8 @@ export default class Stream extends EventEmitter<Record<StreamState, StreamState
     super();
     this.ably = options.ably;
     this.logger = options.logger;
-    this.ablyChannel = this.ably.channels.get(this.options.channel);
-    this.baseLogContext = { scope: `Stream#${options.channel}` };
+    this.ablyChannel = this.ably.channels.get(this.options.channelName);
+    this.baseLogContext = { scope: `Stream#${options.channelName}` };
     this.slidingWindow = new SlidingWindow(
       options.eventBufferOptions?.bufferMs || 0,
       (message: AblyTypes.Message) => this.subscriptions.next(message),
@@ -114,8 +114,8 @@ export default class Stream extends EventEmitter<Record<StreamState, StreamState
     return this.currentState;
   }
 
-  public get channel() {
-    return this.options.channel;
+  public get channelName() {
+    return this.options.channelName;
   }
 
   public async pause() {
diff --git a/src/stream/StreamFactory.ts b/src/stream/StreamFactory.ts
index 3d1e0e75..a3849076 100644
--- a/src/stream/StreamFactory.ts
+++ b/src/stream/StreamFactory.ts
@@ -1,7 +1,7 @@
 import Stream, { IStream, StreamOptions } from './Stream.js';
 
 export interface IStreamFactory {
-  newStream(options: Pick<StreamOptions, 'channel'>): IStream;
+  newStream(options: Pick<StreamOptions, 'channelName'>): IStream;
 }
 
 /**
@@ -26,7 +26,7 @@ export default class StreamFactory implements IStreamFactory {
    * @param {Pick<StreamOptions, 'channel'>} options - The options used in conjunction with the default options when instantiating a stream
    * @returns {IStream} The newly created stream instance.
    */
-  newStream(options: Pick<StreamOptions, 'channel'>) {
+  newStream(options: Pick<StreamOptions, 'channelName'>) {
     return new Stream(Object.assign(this.options, options));
   }
 }