Skip to content

test: Make the Vue and React Native contract test WebSocket extend the shared base #2141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joker23 wants to merge 2 commits into from
Open

test: Make the Vue and React Native contract test WebSocket extend the shared base #2141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68c96ac
feat: Make the Vue and React Native contract test WebSocket extend th…
joker23 Oct 30, 2026
8f673e3
style: fix lint issue
joker23 Oct 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
160 changes: 48 additions & 112 deletions packages/sdk/react-native/contract-tests/entity/src/TestHarnessWebSocket.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,124 +1,60 @@
import { makeLogger } from '@launchdarkly/js-contract-test-utils/client';
import { LDLogger } from '@launchdarkly/react-native-client-sdk';
import {
CommandParams,
CreateInstanceParams,
TestHarnessWebSocket as BaseTestHarnessWebSocket,
} from '@launchdarkly/js-contract-test-utils/client';

import { ClientEntity, newSdkClientEntity } from './ClientEntity';

export default class TestHarnessWebSocket {
private _ws?: WebSocket;
private readonly _entities: Record<string, ClientEntity> = {};
private _clientCounter = 0;
private _logger: LDLogger = makeLogger('TestHarnessWebSocket');
private _intentionalClose = false;
private _onConnectionChange?: (connected: boolean) => void;

constructor(
private readonly _url: string,
onConnectionChange?: (connected: boolean) => void,
) {
this._onConnectionChange = onConnectionChange;
const CAPABILITIES = [
'client-side',
'mobile',
'service-endpoints',
'tags',
'user-type',
'inline-context-all',
'anonymous-redaction',
'strongly-typed',
'client-prereq-events',
'client-prereq-cycle-detection',
'client-per-context-summaries',
'track-hooks',
'fdv1-fallback',
'client-event-source-http-errors',
'retry-conformance-fdv1-streaming',
'retry-conformance-fdv1-polling',
'bootstrap',
];

export default class TestHarnessWebSocket extends BaseTestHarnessWebSocket {
constructor(url: string, onConnectionChange?: (connected: boolean) => void) {
super(url, { capabilities: CAPABILITIES, onConnectionChange });
}

connect() {
this._intentionalClose = false;
this._logger.info(`Connecting to web socket.`);
this._ws = new WebSocket(this._url, 'v1');
this._ws.onopen = () => {
this._logger.info('Connected to websocket.');
this._onConnectionChange?.(true);
};
this._ws.onclose = () => {
this._logger.info('Websocket closed. Attempting to reconnect in 1 second.');
this._onConnectionChange?.(false);
if (!this._intentionalClose) {
setTimeout(() => {
this.connect();
}, 1000);
}
};
this._ws.onerror = (err) => {
this._logger.info(`error:`, err);
};

this._ws.onmessage = async (msg) => {
this._logger.info('Test harness message', msg);
const data = JSON.parse(msg.data as string);
const resData: any = { reqId: data.reqId };
switch (data.command) {
case 'getCapabilities':
resData.capabilities = [
'client-side',
'mobile',
'service-endpoints',
'tags',
'user-type',
'inline-context-all',
'anonymous-redaction',
'strongly-typed',
'client-prereq-events',
'client-prereq-cycle-detection',
'client-per-context-summaries',
'track-hooks',
'fdv1-fallback',
'client-event-source-http-errors',
'retry-conformance-fdv1-streaming',
'retry-conformance-fdv1-polling',
'bootstrap',
];

break;
case 'createClient':
try {
resData.resourceUrl = `/clients/${this._clientCounter}`;
resData.status = 201;
const entity = await newSdkClientEntity(data.body);
this._entities[this._clientCounter] = entity;
this._clientCounter += 1;
} catch (e: any) {
this._logger.error(`Failed to create client: ${e?.message ?? e}`);
resData.status = 500;
}
break;
case 'runCommand':
if (Object.prototype.hasOwnProperty.call(this._entities, data.id)) {
const entity = this._entities[data.id];
try {
const body = await entity.doCommand(data.body);
resData.body = body;
resData.status = body ? 200 : 204;
} catch (e: any) {
this._logger.error(`Command failed: ${e?.message ?? e}`);
resData.status = 500;
}
} else {
resData.status = 404;
this._logger.warn(`Client did not exist: ${data.id}`);
}

break;
case 'deleteClient':
if (Object.prototype.hasOwnProperty.call(this._entities, data.id)) {
const entity = this._entities[data.id];
entity.close();
delete this._entities[data.id];
} else {
resData.status = 404;
this._logger.warn(`Could not delete client because it did not exist: ${data.id}`);
}
break;
default:
break;
}
private readonly _entities: Record<string, ClientEntity> = {};
private _clientCounter = 0;

this.send(resData);
};
protected async createClient(params: CreateInstanceParams): Promise<string> {
const entity = await newSdkClientEntity(params);
const id = String(this._clientCounter);
this._clientCounter += 1;
this._entities[id] = entity;
return id;
}

disconnect() {
this._intentionalClose = true;
this._ws?.close();
protected getCommandHandler(id: string) {
if (!Object.prototype.hasOwnProperty.call(this._entities, id)) {
return undefined;
}
return (params: CommandParams) => this._entities[id].doCommand(params);
}

send(data: unknown) {
this._ws?.send(JSON.stringify(data));
protected deleteClient(id: string): boolean {
if (!Object.prototype.hasOwnProperty.call(this._entities, id)) {
return false;
}
this._entities[id].close();
delete this._entities[id];
return true;
}
}
139 changes: 48 additions & 91 deletions packages/sdk/vue/contract-tests/src/TestHarnessWebSocket.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,103 +1,60 @@
import { makeLogger } from '@launchdarkly/js-contract-test-utils/client';
import type { LDLogger } from '@launchdarkly/vue-client-sdk';
import {
CommandParams,
CreateInstanceParams,
TestHarnessWebSocket as BaseTestHarnessWebSocket,
} from '@launchdarkly/js-contract-test-utils/client';

import { ClientEntity, newSdkClientEntity } from './ClientEntity';

export default class TestHarnessWebSocket {
private _ws?: WebSocket;
const CAPABILITIES = [
'client-side',
'service-endpoints',
'tags',
'user-type',
'inline-context',
'inline-context-all',
'anonymous-redaction',
'strongly-typed',
'client-prereq-events',
'client-per-context-summaries',
'client-prereq-cycle-detection',
'evaluation-hooks',
'track-hooks',
'secure-mode-hash',
'flag-change-listeners',
'fdv1-fallback',
'bootstrap',
];

export default class TestHarnessWebSocket extends BaseTestHarnessWebSocket {
constructor(url: string) {
super(url, { capabilities: CAPABILITIES });
}

private readonly _entities: Record<string, ClientEntity> = {};
private _clientCounter = 0;
private _logger: LDLogger = makeLogger('TestHarnessWebSocket');

constructor(private readonly _url: string) {}

connect() {
this._logger.info(`Connecting to web socket.`);
this._ws = new WebSocket(this._url, ['v1']);
this._ws.onopen = () => {
this._logger.info('Connected to websocket.');
};
this._ws.onclose = () => {
this._logger.info('Websocket closed. Attempting to reconnect in 1 second.');
setTimeout(() => {
this.connect();
}, 1000);
};
this._ws.onerror = (err) => {
this._logger.info(`error:`, err);
};

this._ws.onmessage = async (msg) => {
this._logger.info('Test harness message', msg);
const data = JSON.parse(msg.data);
const resData: any = { reqId: data.reqId };
switch (data.command) {
case 'getCapabilities':
resData.capabilities = [
'client-side',
'service-endpoints',
'tags',
'user-type',
'inline-context',
'inline-context-all',
'anonymous-redaction',
'strongly-typed',
'client-prereq-events',
'client-per-context-summaries',
'client-prereq-cycle-detection',
'evaluation-hooks',
'track-hooks',
'secure-mode-hash',
'flag-change-listeners',
'fdv1-fallback',
'bootstrap',
];

break;
case 'createClient':
{
resData.resourceUrl = `/clients/${this._clientCounter}`;
resData.status = 201;
const entity = await newSdkClientEntity(data.body);
this._entities[this._clientCounter] = entity;
this._clientCounter += 1;
}
break;
case 'runCommand':
if (Object.prototype.hasOwnProperty.call(this._entities, data.id)) {
const entity = this._entities[data.id];
const body = await entity.doCommand(data.body);
resData.body = body;
resData.status = body ? 200 : 204;
} else {
resData.status = 404;
this._logger.warn(`Client did not exist: ${data.id}`);
}

break;
case 'deleteClient':
if (Object.prototype.hasOwnProperty.call(this._entities, data.id)) {
const entity = this._entities[data.id];
entity.close();
delete this._entities[data.id];
} else {
resData.status = 404;
this._logger.warn(`Could not delete client because it did not exist: ${data.id}`);
}
break;
default:
break;
}

this.send(resData);
};
protected async createClient(params: CreateInstanceParams): Promise<string> {
const entity = await newSdkClientEntity(params);
const id = String(this._clientCounter);
this._clientCounter += 1;
this._entities[id] = entity;
return id;
}

disconnect() {
this._ws?.close();
protected getCommandHandler(id: string) {
if (!Object.prototype.hasOwnProperty.call(this._entities, id)) {
return undefined;
}
return (params: CommandParams) => this._entities[id].doCommand(params);
}

send(data: unknown) {
this._ws?.send(JSON.stringify(data));
protected deleteClient(id: string): boolean {
if (!Object.prototype.hasOwnProperty.call(this._entities, id)) {
return false;
}
this._entities[id].close();
delete this._entities[id];
return true;
}
}
4 changes: 4 additions & 0 deletions packages/tooling/contract-test-utils/src/client-side/TestHarnessWebSocket.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ const DEFAULT_CAPABILITIES = [
export interface TestHarnessWebSocketOptions {
/** Capabilities reported to the harness. Defaults to the browser list. */
capabilities?: string[];
/** Called with true when the socket opens and false when it closes. */
onConnectionChange?: (connected: boolean) => void;
}

/**
Expand Down Expand Up @@ -63,8 +65,10 @@ export default abstract class TestHarnessWebSocket {
this._ws = new WebSocket(this._url, ['v1']);
this._ws.onopen = () => {
this.logger.info('Connected to websocket.');
this._options.onConnectionChange?.(true);
};
this._ws.onclose = () => {
this._options.onConnectionChange?.(false);
if (this._intentionalClose) {
this.logger.info('Websocket closed.');
return;
Expand Down
5 changes: 4 additions & 1 deletion packages/tooling/contract-test-utils/src/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,7 @@ export * from './index.js';
// Client-side exports
export { default as ClientSideTestHook } from './client-side/TestHook.js';
export { default as TestHarnessWebSocket } from './client-side/TestHarnessWebSocket.js';
export type { CommandHandler } from './client-side/TestHarnessWebSocket.js';
export type {
CommandHandler,
TestHarnessWebSocketOptions,
} from './client-side/TestHarnessWebSocket.js';
Loading