Fix Model tests

Author: snikidev

package-lock.json

@@ -6,17 +6,18 @@
   "module": "dist/mjs/index.js",
   "types": "dist/mjs/index.d.ts",
   "scripts": {
-    "lint": "npx eslint .",
-    "lint:fix": "npx eslint --fix .",
-    "format": "npx prettier --write --ignore-path .gitignore src",
-    "format:check": "npx prettier --check --ignore-path .gitignore src",
-    "test": "npx vitest run",
-    "coverage": "npx vitest run --coverage",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "format": "prettier --write --ignore-path .gitignore src",
+    "format:check": "prettier --check --ignore-path .gitignore src",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "coverage": "vitest run --coverage",
     "build": "npm run build:cjs && npm run build:mjs",
-    "build:mjs": "npx tsc --project tsconfig.mjs.json && cp res/package.mjs.json dist/mjs/package.json",
-    "build:cjs": "npx tsc --project tsconfig.cjs.json && cp res/package.cjs.json dist/cjs/package.json",
-    "prepare": "npx husky install",
-    "docs": "npx typedoc"
+    "build:mjs": "tsc --project tsconfig.mjs.json && cp res/package.mjs.json dist/mjs/package.json",
+    "build:cjs": "tsc --project tsconfig.cjs.json && cp res/package.cjs.json dist/cjs/package.json",
+    "prepare": "husky install",
+    "docs": "typedoc"
   },
   "repository": {
     "type": "git",
@@ -50,6 +51,7 @@
     "eslint-plugin-jsdoc": "^46.0.0",
     "eslint-plugin-security": "^1.7.1",
     "husky": "^8.0.0",
+    "ky": "^1.2.0",
     "mock-socket": "^9.1.5",
     "prettier": "^3.1.0",
     "typedoc": "^0.25.3",

package.json

@@ -57,6 +57,7 @@ describe('Model', () => {
     );
     channel.detach = vi.fn<any, any>();
     ably.channels.release = vi.fn<any, any>();
+    channel.setOptions = vi.fn();
 
     let counter = 0;
 
@@ -133,6 +134,7 @@ describe('Model', () => {
     );
     channel.detach = vi.fn<any, any>();
     ably.channels.release = vi.fn<any, any>();
+    channel.setOptions = vi.fn();
 
     let counter = 0;
 

src/Model.discontinuity.test.ts

@@ -0,0 +1,65 @@
+import { Realtime, Types } from 'ably/promises';
+import pino from 'pino';
+import { it, describe, expect, beforeEach, afterEach } from 'vitest';
+
+import Stream from './Stream.js';
+import { defaultSyncOptions, defaultEventBufferOptions } from '../Options.js';
+import type { StreamOptions } from '../types/stream.js';
+import { createAblyApp } from '../utilities/test/createAblyApp.js';
+
+interface StreamTestContext extends StreamOptions {
+  stream: Stream;
+  channel: Types.RealtimeChannelPromise;
+}
+
+describe('Stream integration', () => {
+  beforeEach<StreamTestContext>(async (context) => {
+    const name = 'test';
+    const data = await createAblyApp({
+      keys: [{}],
+      namespaces: [{ id: name, persisted: true }],
+      channels: [
+        {
+          name,
+          presence: [
+            { clientId: 'John', data: '[email protected]' },
+            { clientId: 'Dave', data: '[email protected]' },
+          ],
+        },
+      ],
+    });
+    const ably = new Realtime({
+      key: data.keys[0].keyStr,
+      environment: 'sandbox',
+    });
+    const logger = pino({ level: 'silent' });
+    const channel = ably.channels.get(name);
+    const stream = new Stream({
+      ably,
+      logger,
+      channelName: name,
+      syncOptions: defaultSyncOptions,
+      eventBufferOptions: defaultEventBufferOptions,
+    });
+
+    context.stream = stream;
+    context.channel = channel;
+  });
+
+  afterEach<StreamTestContext>(async ({ stream, channel }) => {
+    await stream.dispose();
+    await channel.detach();
+  });
+
+  it<StreamTestContext>('sets agent options when state is not attached', async ({ channel, stream }) => {
+    await stream.replay('0');
+    //@ts-ignore - `agent` is filtered out in `channel.params`, so that's the only way to check this
+    expect(channel.channelOptions.params).toEqual({ agent: 'models/0.0.2' }); // initial call from test
+  });
+
+  it<StreamTestContext>('does not sets agent options when state is attached', async ({ channel }) => {
+    await channel.attach();
+    //@ts-ignore - `agent` is filtered out in `channel.params`, so that's the only way to check this
+    expect(channel.channelOptions.params).toEqual(undefined); // initial call from test
+  });
+});

src/stream/Stream.integration.test.ts

@@ -0,0 +1,88 @@
+import ky from 'ky';
+
+export const createAblyApp = async (json: Options): Promise<Data> => {
+  const response = await ky
+    .post('https://sandbox-rest.ably.io/apps', {
+      json,
+      headers: {
+        'content-type': 'application/json',
+        Accept: 'application/json',
+      },
+    })
+    .json<Data>();
+  return response;
+};
+
+interface Key {
+  capability?: {
+    private: ('subscribe' | 'publish')[];
+    chat?: 'presence'[];
+  };
+}
+
+interface Namespace {
+  id: string;
+  persisted: boolean;
+}
+
+interface Presence {
+  clientId: string;
+  data: string;
+}
+
+interface Channel {
+  name: string;
+  presence: Presence[];
+}
+
+interface Options {
+  keys?: Key[];
+  namespaces?: Namespace[];
+  channels?: Channel[];
+}
+
+interface Data {
+  status: number;
+  created: Date;
+  modified: Date;
+  tlsOnly: boolean;
+  labels: string;
+  enablePusherCompatibility: boolean;
+  namespaces: {
+    id: string;
+    created: Date;
+    modified: Date;
+    expires: Date | null;
+    persisted: boolean;
+    persistLast: boolean;
+    pushEnabled: boolean;
+    exposeTimeserial: boolean;
+    populateChannelRegistry: boolean;
+    tlsOnly: boolean;
+    authenticated: boolean;
+    identified: boolean;
+    cursorEventProcessing: boolean;
+  }[];
+  metaChannels: any;
+  id: string;
+  appId: string;
+  accountId: string;
+  keys: {
+    id: string;
+    value: string;
+    keyName: string;
+    keySecret: string;
+    keyStr: string;
+    capability: string;
+    expires: Date;
+  }[];
+  connections: {
+    name: string;
+    key: string;
+  }[];
+  channels: {
+    name: string;
+    presence: Presence[];
+    connection: string;
+  }[];
+}