Harvmaster/sync-server-example
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Formatting

Browse Source
This commit is contained in:
Harvmaster
2026-10-22 15:19:06 +00:00
parent 9cef3be6cb
commit 7f9bb97990
20 changed files with 12364 additions and 12277 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.gitignore
+2
View File
@@ -1,2 +1,4 @@
/node_modules
/dist
/coverage
/docs
.prettierrc.mjs
+23
View File
@@ -0,0 +1,23 @@
// Prettier configuration aligned with @xo-cash/eslint-config
export default {
// Matches @stylistic/max-len': [ 'warn', 150, ...]
printWidth: 150,
// Matches @stylistic/no-tabs': [ 'error' ]
useTabs: false,
// Matches @stylistic/indent': [ 'error', 4, ...]
tabWidth: 4,
// Matches @stylistic/array-bracket-spacing': [ 'error', 'always', ...]
bracketSpacing: true,
// Matches @stylistic/quotes: ['error', 'single', { avoidEscape: true }], from @chalp/eslint-airbnb/base/stylistic.js
singleQuote: true,
// Matches @stylistic/semi: ['error', 'always'], from @chalp/eslint-airbnb/base/stylistic.js
semi: true,
// Matches @stylistic/arrow-parens: ['error', 'always'], from @chalp/eslint-airbnb/base/stylistic.js
arrowParens: 'always',
};
demo/experimental/encrypted-client-per-resource.ts
+18 -12
View File
@@ -1,8 +1,8 @@
import { subtle, getRandomValues } from "node:crypto";
import { fromExtendedJson, toExtendedJson } from "@xo-cash/utils";
import { sha256, binToBase64, binToHex } from "@bitauth/libauth";
import { subtle, getRandomValues } from 'node:crypto';
import { fromExtendedJson, toExtendedJson } from '@xo-cash/utils';
import { sha256, binToBase64, binToHex } from '@bitauth/libauth';
import { BaseSyncClient, type Resource, type ResourcesRecord } from "../../source/shared/base-client.js";
import { BaseSyncClient, type Resource, type ResourcesRecord } from '../../source/shared/base-client.js';
type ResourceKey = {
resourceId: string;
@@ -32,7 +32,7 @@ export class EncryptedClientPerResource<T = unknown> extends BaseSyncClient<T> {
this.emit('resource-instance-updated', {
...message,
resourceId: resourceKey.resourceId,
value: await EncryptedClientPerResource.decrypt(resourceKey.keyMaterial, message.value) as T,
value: (await EncryptedClientPerResource.decrypt(resourceKey.keyMaterial, message.value)) as T,
});
} catch (error) {
this.emit('error', error instanceof Error ? error : new Error(String(error)));
@@ -75,17 +75,21 @@ export class EncryptedClientPerResource<T = unknown> extends BaseSyncClient<T> {
* @returns The resources record with decrypted values, keyed by original resource ID
*/
private async decryptResources(resources: ResourcesRecord<string>): Promise<ResourcesRecord<T>> {
const entries = await Promise.all(Object.entries(resources).map(async ([ hashedResourceId, resource ]) => {
const entries = await Promise.all(
Object.entries(resources).map(async ([hashedResourceId, resource]) => {
const { resourceId, keyMaterial } = this.getResourceKey(hashedResourceId);
const instances: Resource<T>[] = await Promise.all(resource.instances.map(async (instance) => ({
const instances: Resource<T>[] = await Promise.all(
resource.instances.map(async (instance) => ({
...instance,
resourceId,
value: await EncryptedClientPerResource.decrypt(keyMaterial, instance.value) as T,
})));
value: (await EncryptedClientPerResource.decrypt(keyMaterial, instance.value)) as T,
})),
);
return [resourceId, { ...resource, instances }] as const;
}));
}),
);
return Object.fromEntries(entries);
}
@@ -107,12 +111,14 @@ export class EncryptedClientPerResource<T = unknown> extends BaseSyncClient<T> {
}
public async writeMany(resources: Record<string, T>): Promise<ResourcesRecord<T>> {
const encryptedEntries = await Promise.all(Object.entries(resources).map(async ([ resourceId, value ]) => {
const encryptedEntries = await Promise.all(
Object.entries(resources).map(async ([resourceId, value]) => {
const hashedResourceId = this.hashResourceId(resourceId);
const { keyMaterial } = this.getResourceKey(hashedResourceId);
return [hashedResourceId, await EncryptedClientPerResource.encrypt(keyMaterial, value)] as const;
}));
}),
);
const response = await this.client.writeMany(Object.fromEntries(encryptedEntries));
demo/experimental/encrypted-client.ts
+22 -13
View File
@@ -1,8 +1,8 @@
import { subtle, getRandomValues } from "node:crypto";
import { fromExtendedJson, toExtendedJson } from "@xo-cash/utils";
import { sha256, binToBase64 } from "@bitauth/libauth";
import { subtle, getRandomValues } from 'node:crypto';
import { fromExtendedJson, toExtendedJson } from '@xo-cash/utils';
import { sha256, binToBase64 } from '@bitauth/libauth';
import { BaseSyncClient, type ResourcesRecord } from "../../source/shared/base-client.js";
import { BaseSyncClient, type ResourcesRecord } from '../../source/shared/base-client.js';
/**
* Encrypts every resource with a single shared key.
@@ -10,7 +10,10 @@ import { BaseSyncClient, type ResourcesRecord } from "../../source/shared/base-c
export class EncryptedClient<T = unknown> extends BaseSyncClient<T> {
private readonly encryptionKey: Uint8Array;
constructor(private readonly client: BaseSyncClient<string>, encryptionKey: Uint8Array | string) {
constructor(
private readonly client: BaseSyncClient<string>,
encryptionKey: Uint8Array | string,
) {
super();
// Hash the encryption key into 32 bytes if it is a string
@@ -20,7 +23,7 @@ export class EncryptedClient<T = unknown> extends BaseSyncClient<T> {
try {
this.emit('resource-instance-updated', {
...message,
value: await EncryptedClient.decrypt(this.encryptionKey, message.value) as T,
value: (await EncryptedClient.decrypt(this.encryptionKey, message.value)) as T,
});
} catch (error) {
this.emit('error', error instanceof Error ? error : new Error(String(error)));
@@ -34,14 +37,18 @@ export class EncryptedClient<T = unknown> extends BaseSyncClient<T> {
* @returns The resources record with decrypted values
*/
private async decryptResources(resources: ResourcesRecord<string>): Promise<ResourcesRecord<T>> {
const entries = await Promise.all(Object.entries(resources).map(async ([ resourceId, resource ]) => {
const instances = await Promise.all(resource.instances.map(async (instance) => ({
const entries = await Promise.all(
Object.entries(resources).map(async ([resourceId, resource]) => {
const instances = await Promise.all(
resource.instances.map(async (instance) => ({
...instance,
value: await EncryptedClient.decrypt(this.encryptionKey, instance.value) as T,
})));
value: (await EncryptedClient.decrypt(this.encryptionKey, instance.value)) as T,
})),
);
return [resourceId, { ...resource, instances }] as const;
}));
}),
);
return Object.fromEntries(entries);
}
@@ -61,9 +68,11 @@ export class EncryptedClient<T = unknown> extends BaseSyncClient<T> {
}
public async writeMany(resources: Record<string, T>): Promise<ResourcesRecord<T>> {
const encryptedEntries = await Promise.all(Object.entries(resources).map(async ([ resourceId, value ]) => {
const encryptedEntries = await Promise.all(
Object.entries(resources).map(async ([resourceId, value]) => {
return [resourceId, await EncryptedClient.encrypt(this.encryptionKey, value)] as const;
}));
}),
);
const response = await this.client.writeMany(Object.fromEntries(encryptedEntries));
demo/shared.ts
+8 -6
View File
@@ -1,21 +1,23 @@
import type { BaseSyncClient, ResourcesRecord } from "../source/shared/base-client.js";
import type { BaseSyncClient, ResourcesRecord } from '../source/shared/base-client.js';
export const writeMany = async (client: BaseSyncClient<{ message: string }>): Promise<ResourcesRecord<{ message: string }>> => {
// Create a group of resources with changes
const resources = Object.fromEntries(Array.from({ length: 10 }, (_, index) => [
const resources = Object.fromEntries(
Array.from({ length: 10 }, (_, index) => [
`resource-${index}`,
{
message: `Hello, world! this is the minimal sync client using ${client.constructor.name} ${index}`,
},
]));
]),
);
// Write the resources to the server
const res = await client.writeMany(resources);
return res;
}
};
export const readMany = async (client: BaseSyncClient<{ message: string }>,): Promise<ResourcesRecord<{ message: string }>> => {
export const readMany = async (client: BaseSyncClient<{ message: string }>): Promise<ResourcesRecord<{ message: string }>> => {
// Create a list of resource IDs
const resources = Array.from({ length: 10 }, (_, index) => `resource-${index}`);
@@ -23,4 +25,4 @@ export const readMany = async (client: BaseSyncClient<{ message: string }>,): Pr
const res = await client.readMany(resources);
return res;
}
};
demo/suite.ts
+14 -10
View File
@@ -1,16 +1,16 @@
import { PrivateKey } from "@xo-cash/primitives";
import { PrivateKey } from '@xo-cash/primitives';
// Core clients
import type { BaseSyncClient } from "../source/shared/base-client.js";
import type { BaseSyncClient } from '../source/shared/base-client.js';
import { SSEClient } from '../source/sse/client.js';
import { WsClient } from "../source/ws/client.js";
import { WsClient } from '../source/ws/client.js';
// Experimental clients
import { EncryptedClientPerResource } from "./experimental/encrypted-client-per-resource.js";
import { EncryptedClient } from "./experimental/encrypted-client.js";
import { EncryptedClientPerResource } from './experimental/encrypted-client-per-resource.js';
import { EncryptedClient } from './experimental/encrypted-client.js';
// Shared functions
import { writeMany, readMany } from "./shared.js";
import { writeMany, readMany } from './shared.js';
const privateKey = PrivateKey.fromString('c440ce6ac5b63ae7bc4af9891b80b7a88ccdeebba5e43246885e9ec56f912ac2');
@@ -18,7 +18,9 @@ const clients = {
sse: new SSEClient<{ message: string }>('https://dev.v2.sync.xo.harvmaster.com', privateKey),
ws: new WsClient<{ message: string }>('wss://dev.v2.sync.xo.harvmaster.com', privateKey),
encrypted: new EncryptedClient<{ message: string }>(new SSEClient<string>('https://dev.v2.sync.xo.harvmaster.com', privateKey), 'secret'),
encryptedPerResource: new EncryptedClientPerResource<{ message: string }>(new SSEClient<string>('https://dev.v2.sync.xo.harvmaster.com', privateKey)),
encryptedPerResource: new EncryptedClientPerResource<{ message: string }>(
new SSEClient<string>('https://dev.v2.sync.xo.harvmaster.com', privateKey),
),
};
// Test the suite for a given client
@@ -34,7 +36,9 @@ const testSuite = async (client: BaseSyncClient<{ message: string }>) => {
await client.subscribe('test');
// Write a new value to the resource
await client.write('test', {'message': 'Hello, world! this is the minimal sync client using ' + client.constructor.name});
await client.write('test', {
message: 'Hello, world! this is the minimal sync client using ' + client.constructor.name,
});
// Read the current value of the resource
const data = await client.read('test');
@@ -52,7 +56,7 @@ const testSuite = async (client: BaseSyncClient<{ message: string }>) => {
await client.disconnect();
process.exit(0);
});
}
};
// Get the clients to test
const selectClients = (params: string[]): BaseSyncClient<{ message: string }>[] => {
@@ -68,7 +72,7 @@ const selectClients = (params: string[]): BaseSyncClient<{ message: string }>[]
// Return the clients that are known to the clients object
return names.map((n) => clients[n as keyof typeof clients]);
}
};
// Get the params
const params = process.argv.slice(2);
demo/tui.ts
+17 -13
View File
@@ -1,28 +1,32 @@
import { PrivateKey } from "@xo-cash/primitives";
import { PrivateKey } from '@xo-cash/primitives';
import type { BaseSyncClient } from "../source/shared/base-client.js";
import type { BaseSyncClient } from '../source/shared/base-client.js';
import { SSEClient } from "../source/sse/client.js";
import { EncryptedClientPerResource } from "./experimental/encrypted-client-per-resource.js";
import { SSEClient } from '../source/sse/client.js';
import { EncryptedClientPerResource } from './experimental/encrypted-client-per-resource.js';
const privateKey = PrivateKey.fromString('c440ce6ac5b63ae7bc4af9891b80b7a88ccdeebba5e43246885e9ec56f912ac2');
// Define some formatting helpers
const formatResourceId = (resourceId: string) => {
return `\x1b[32m${resourceId}\x1b[0m`;
}
};
const formatMessage = (message: string) => {
return `\x1b[34m${message}\x1b[0m`;
}
};
const resetFormatting = () => {
return `\x1b[0m`;
}
return '\x1b[0m';
};
const startTUI = async (client: BaseSyncClient<string>) => {
// Listen and log out the resource change
client.on('resource-instance-updated', (message) => {
// Print the message with colours
console.log(`${formatResourceId(message.resourceId)}:${formatResourceId(message.publicKey)} updated: ${formatMessage(message.value)}${resetFormatting()}`);
console.log(
`${formatResourceId(message.resourceId)}:${formatResourceId(message.publicKey)} updated: ${formatMessage(message.value)}${resetFormatting()}`,
);
});
// Connect to the sync server and subscribe to the resource
@@ -43,12 +47,12 @@ const startTUI = async (client: BaseSyncClient<string>) => {
await client.write('encrypted-test', message);
}
}
}
};
const clients = {
'sse': new SSEClient<string>('https://dev.v2.sync.xo.harvmaster.com', privateKey),
'encrypted': new EncryptedClientPerResource<string>(new SSEClient<string>('https://dev.v2.sync.xo.harvmaster.com', privateKey)),
}
sse: new SSEClient<string>('https://dev.v2.sync.xo.harvmaster.com', privateKey),
encrypted: new EncryptedClientPerResource<string>(new SSEClient<string>('https://dev.v2.sync.xo.harvmaster.com', privateKey)),
};
const params = process.argv.slice(2);
const client = params[0] === 'false' ? clients.sse : clients.encrypted;
eslint.config.mjs
+8
View File
@@ -0,0 +1,8 @@
import baseConfig from '@xo-cash/eslint-config';
export default [
{
ignores: [ 'coverage/**', 'docs/**', 'demo/**' ],
},
...baseConfig,
];
source/index.ts
+3 -3
View File
@@ -1,4 +1,4 @@
export * from './shared/base-client.js';
export * from './shared/base-client.ts';
export * from './sse/client.js';
export * from './ws/client.js';
export * from './sse/client.ts';
export * from './ws/client.ts';
source/shared/base-client.ts
+5 -6
View File
@@ -1,8 +1,8 @@
import { binToHex, flattenBinArray, secp256k1, sha256 } from "@bitauth/libauth";
import { binToHex, flattenBinArray, secp256k1, sha256 } from '@bitauth/libauth';
import { toExtendedJson, EventEmitter, fromExtendedJson } from "@xo-cash/utils";
import type { WriteRequest } from "../types.js";
import z from "zod";
import { toExtendedJson, EventEmitter, fromExtendedJson } from '@xo-cash/utils';
import type { WriteRequest } from '../types.ts';
import z from 'zod';
export type AuthenticatedRequestHeaders = {
'X-Public-Key': string;
@@ -18,7 +18,7 @@ export type XOSyncClientEventMap<T = unknown> = {
resourceId: string;
};
'subscriptions-updated': Set<string>;
'error': Error;
error: Error;
};
export type Resource<PayloadType = unknown> = z.infer<typeof BaseSyncClient.resourceInstanceSchema> & {
@@ -28,7 +28,6 @@ export type Resource<PayloadType = unknown> = z.infer<typeof BaseSyncClient.reso
export type ResourcesRecord<PayloadType = unknown> = Record<string, { instances: Resource<PayloadType>[] }>;
export abstract class BaseSyncClient<T = unknown> extends EventEmitter<XOSyncClientEventMap<T>> {
/**
* Connects to the sync server
*/
source/sse/client.ts
+28 -19
View File
@@ -1,7 +1,7 @@
import { SSESession, toExtendedJson, fromExtendedJson } from '@xo-cash/utils';
import { PrivateKey } from '@xo-cash/primitives'
import type { PrivateKey } from '@xo-cash/primitives';
import { BaseSyncClient, type ResourcesRecord } from '../shared/base-client.js';
import { BaseSyncClient, type ResourcesRecord } from '../shared/base-client.ts';
export class SSEClient<PayloadType = unknown> extends BaseSyncClient<PayloadType> {
private readonly url: string;
@@ -11,7 +11,7 @@ export class SSEClient<PayloadType = unknown> extends BaseSyncClient<PayloadType
private privateKey: PrivateKey;
private textEncoder = new TextEncoder();
private get subscriptionUrl() {
private get subscriptionUrl(): string {
return `${this.url}/data/subscribe`;
}
@@ -28,16 +28,20 @@ export class SSEClient<PayloadType = unknown> extends BaseSyncClient<PayloadType
// Whenever we get a new subscription, we need to reconnect the session with the new subscriptions in the body
// We add a small debounce to this to prevent parallel subscriptions from causing multiple reconnects
this.on('subscriptions-updated', () => {
this.on(
'subscriptions-updated',
() => {
// Nothing awaits this listener, so report failures as an error event instead of an unhandled rejection
this.reconnect().catch((error) => this.emit('error', error));
}, 25);
},
25,
);
}
/**
* Connects to the server
*/
async connect() {
async connect(): Promise<void> {
// The server rejects a subscribe request with no resource IDs, so there is nothing to connect to yet.
// subscribe() connects once there is a subscription. read() and write() are plain fetches and don't need a session.
if (this.subscriptions.size === 0) {
@@ -52,14 +56,14 @@ export class SSEClient<PayloadType = unknown> extends BaseSyncClient<PayloadType
/**
* Disconnects from the server
*/
async disconnect() {
await this.sseSession?.disconnect();
async disconnect(): Promise<void> {
this.sseSession?.disconnect();
}
/**
* Reconnects to the server
*/
async reconnect() {
async reconnect(): Promise<void> {
// Close the current session. Its subscription list is fixed in the request body, so it can't be reused
this.sseSession?.close();
this.sseSession = undefined;
@@ -72,13 +76,13 @@ export class SSEClient<PayloadType = unknown> extends BaseSyncClient<PayloadType
* Creates a new SSE session
* @returns The SSE session
*/
private createSession() {
private createSession(): SSESession {
// Build the request body
const body = toExtendedJson({ resourceId: [ ...this.subscriptions ] });
// Create a new SSE session
const session = new SSESession(this.subscriptionUrl, {
onRequest: async (request) => {
onRequest: async (request): Promise<RequestInit> => {
// Get the path from the URL
const url = new URL(this.subscriptionUrl);
const path = url.pathname;
@@ -93,7 +97,7 @@ export class SSEClient<PayloadType = unknown> extends BaseSyncClient<PayloadType
request.headers = {
...request.headers,
...authHeaders,
}
};
// Return the request with the authentication headers
return request;
@@ -112,7 +116,7 @@ export class SSEClient<PayloadType = unknown> extends BaseSyncClient<PayloadType
session.on('disconnected', this.handleOnConnectionUpdated.bind(this, 'disconnected'));
// Create a listener to re-emit the messages
session.on('message', (message) => {
session.on('message', (message): void => {
const parsedMessage = BaseSyncClient.resourceInstanceSchema.safeParse(fromExtendedJson(message.data));
if (!parsedMessage.success) {
return;
@@ -143,11 +147,14 @@ export class SSEClient<PayloadType = unknown> extends BaseSyncClient<PayloadType
const signedResources = Object.entries(resources).map(([ resourceId, value ]) => {
const valueStr = toExtendedJson(value);
const valueBytes = this.textEncoder.encode(valueStr);
return BaseSyncClient.signWriteRequest(this.privateKey.toBytes(), resourceId, valueBytes);
});
// Send the resource write requests to the server
const res = await this.sendRequest('/data/write', { resources: signedResources });
const res = await this.sendRequest('/data/write', {
resources: signedResources,
});
// If the response is not ok, throw an error
if (!res.ok) {
@@ -169,7 +176,9 @@ export class SSEClient<PayloadType = unknown> extends BaseSyncClient<PayloadType
*/
async readMany(resourceIds: string[]): Promise<ResourcesRecord<PayloadType>> {
// Send the resource read requests to the server
const res = await this.sendRequest('/data/get', { resourceId: resourceIds });
const res = await this.sendRequest('/data/get', {
resourceId: resourceIds,
});
// If the response is not ok, throw an error
if (!res.ok) {
@@ -187,7 +196,7 @@ export class SSEClient<PayloadType = unknown> extends BaseSyncClient<PayloadType
* Destroy the current SSE Session, then re-create it with the additional resource ID in the subscription list
* @param resourceId - The resource ID to add to the subscription list
*/
async subscribe(resourceId: string) {
async subscribe(resourceId: string): Promise<void> {
this.subscriptions.add(resourceId);
this.emit('subscriptions-updated', this.subscriptions);
@@ -197,13 +206,13 @@ export class SSEClient<PayloadType = unknown> extends BaseSyncClient<PayloadType
* Destroy the current SSE Session, then re-create it without the resource ID in the subscription list
* @param resourceId - The resource ID to remove from the subscription list
*/
async unsubscribe(resourceId: string) {
async unsubscribe(resourceId: string): Promise<void> {
this.subscriptions.delete(resourceId);
this.emit('subscriptions-updated', this.subscriptions);
}
async handleOnConnectionUpdated(value: 'connected' | 'disconnected') {
async handleOnConnectionUpdated(value: 'connected' | 'disconnected'): Promise<void> {
this.emit('connection-updated', value);
}
@@ -241,7 +250,7 @@ export class SSEClient<PayloadType = unknown> extends BaseSyncClient<PayloadType
*/
private async decodeResponse(response: Response): Promise<ResourcesRecord<PayloadType>> {
// Decode the response from Extended JSON
const text = fromExtendedJson(await response.text())
const text = fromExtendedJson(await response.text());
// Parse the response as a record of resources
const resources = BaseSyncClient.resourcesResponseSchema.parse(text);
source/sse/index.ts
+1 -1
View File
@@ -1 +1 @@
export * from './client.js';
export * from './client.ts';
source/ws/client.ts
+37 -22
View File
@@ -1,8 +1,8 @@
import { ExponentialBackoff, fromExtendedJson, toExtendedJson } from '@xo-cash/utils';
import type { PrivateKey } from '@xo-cash/primitives';
import { WsMessageSchema, WsSuccessResponseSchema, WsErrorResponseSchema, type WsMessage } from './types.js';
import { BaseSyncClient, type ResourcesRecord } from '../shared/base-client.js';
import { WsMessageSchema, WsSuccessResponseSchema, WsErrorResponseSchema, type WsMessage } from './types.ts';
import { BaseSyncClient, type ResourcesRecord } from '../shared/base-client.ts';
/** A request sent over the sync server's WebSocket connection. */
type WsRequest = {
@@ -18,6 +18,7 @@ type PendingRequest = {
};
export type WsClientOptions = {
/** Called for server-pushed events and uncorrelated server errors. */
onMessage: (message: WsMessage) => void;
@@ -56,19 +57,18 @@ export class WsClient<PayloadType = unknown> extends BaseSyncClient<PayloadType>
private webSocket: Promise<WebSocket> | undefined;
/** Retries a failed connection attempt forever (maxAttempts 0), waiting up to 30s between attempts. */
private readonly connectBackoff = new ExponentialBackoff({ maxAttempts: 0, maxDelay: 30_000 });
private readonly connectBackoff = new ExponentialBackoff({
maxAttempts: 0,
maxDelay: 30_000,
});
constructor(
url: string,
privateKey: PrivateKey,
options: Partial<WsClientOptions> = {},
) {
constructor(url: string, privateKey: PrivateKey, options: Partial<WsClientOptions> = {}) {
super();
this.url = url;
this.privateKey = privateKey;
this.messageListeners.add(options.onMessage ?? (() => {}));
this.errorListeners.add(options.onError ?? (() => {}));
this.messageListeners.add(options.onMessage ?? ((): void => {}));
this.errorListeners.add(options.onError ?? ((): void => {}));
}
/** Connect, and keep reconnecting on drops until `disconnect()` is called. */
@@ -93,7 +93,10 @@ export class WsClient<PayloadType = unknown> extends BaseSyncClient<PayloadType>
// If the attempt is still retrying, it sees it is no longer current after its next handshake,
// closes that socket and stops. Its rejection is handled here.
attempt?.then((socket) => socket.close(), () => {});
attempt?.then(
(socket) => socket.close(),
() => {},
);
}
/**
@@ -125,7 +128,8 @@ export class WsClient<PayloadType = unknown> extends BaseSyncClient<PayloadType>
* It stops being current when `disconnect()` is called.
*/
private openWebSocket(): Promise<WebSocket> {
const attempt: Promise<WebSocket> = this.connectBackoff.run(async ({ stopRetries }) => {
const attempt: Promise<WebSocket> = this.connectBackoff.run(
async ({ stopRetries }) => {
// `attempt` is only read after this await: run() calls this function before `attempt` is assigned.
const socket = await WsClient.waitForOpen(new WebSocket(WsClient.httpToWsUrl(this.url)));
@@ -136,30 +140,32 @@ export class WsClient<PayloadType = unknown> extends BaseSyncClient<PayloadType>
throw new Error('WebSocket client disconnected');
}
socket.onmessage = (event) => this.handleMessage(String(event.data));
socket.onerror = () => this.emitError(new Error('WebSocket error'));
socket.onclose = () => {
socket.onmessage = (event): void => this.handleMessage(String(event.data));
socket.onerror = (): void => this.emitError(new Error('WebSocket error'));
socket.onclose = async (): Promise<void> => {
this.rejectPendingRequests(new Error('WebSocket connection closed'));
this.emit('connection-updated', 'disconnected');
// Reconnect, unless disconnect() was called
if (this.webSocket === attempt) {
this.webSocket = undefined;
this.getWebSocket();
await this.getWebSocket();
}
};
this.emit('connection-updated', 'connected');
return socket;
}, {
},
{
// Report failed handshakes, but not the error thrown above after disconnect()
onError: (error) => {
if (this.webSocket === attempt) {
this.emitError(error);
}
},
});
},
);
// Nothing may be awaiting this attempt (e.g. a reconnect started by onclose), and it rejects if disconnect() stops it.
// Mark the rejection as handled so it isn't reported as unhandled. Callers awaiting `attempt` still receive it.
@@ -170,7 +176,9 @@ export class WsClient<PayloadType = unknown> extends BaseSyncClient<PayloadType>
async readMany(resourceIds: string[]): Promise<ResourcesRecord<PayloadType>> {
// Read the resources from the server
const response = await this.request('/data/get', { resourceId: resourceIds });
const response = await this.request('/data/get', {
resourceId: resourceIds,
});
// Parse the response as a record of resources
const resources = BaseSyncClient.resourcesResponseSchema.parse(response);
@@ -186,11 +194,14 @@ export class WsClient<PayloadType = unknown> extends BaseSyncClient<PayloadType>
const signedResources = Object.entries(resourcesToWrite).map(([ resourceId, value ]) => {
const valueStr = toExtendedJson(value);
const valueBytes = this.textEncoder.encode(valueStr);
return BaseSyncClient.signWriteRequest(this.privateKey.toBytes(), resourceId, valueBytes);
});
// Write the resources to the server
const response = await this.request('/data/write', { resources: signedResources });
const response = await this.request('/data/write', {
resources: signedResources,
});
// Parse the response as a record of resources
const resources = BaseSyncClient.resourcesResponseSchema.parse(response);
@@ -275,8 +286,8 @@ export class WsClient<PayloadType = unknown> extends BaseSyncClient<PayloadType>
*/
private static waitForOpen(socket: WebSocket): Promise<WebSocket> {
return new Promise((resolve, reject) => {
socket.onopen = () => resolve(socket);
socket.onerror = () => reject(new Error('WebSocket connection failed'));
socket.onopen = (): void => resolve(socket);
socket.onerror = (): void => reject(new Error('WebSocket connection failed'));
});
}
@@ -288,6 +299,7 @@ export class WsClient<PayloadType = unknown> extends BaseSyncClient<PayloadType>
const { success, data: message } = WsMessageSchema.safeParse(fromExtendedJson(raw));
if (!success) {
this.emitError(new Error('Invalid WebSocket message'));
return;
}
@@ -305,6 +317,7 @@ export class WsClient<PayloadType = unknown> extends BaseSyncClient<PayloadType>
const error = WsErrorResponseSchema.safeParse(message);
if (error.success) {
this.emitError(new Error(`${error.data.error} (${error.data.statusCode})`));
return;
}
@@ -330,6 +343,7 @@ export class WsClient<PayloadType = unknown> extends BaseSyncClient<PayloadType>
if (message.type === 'error') {
const error = WsErrorResponseSchema.parse(message);
pending.reject(new Error(`${error.error} (${error.statusCode})`));
return;
}
@@ -340,6 +354,7 @@ export class WsClient<PayloadType = unknown> extends BaseSyncClient<PayloadType>
// If the response is not successful, reject the pending request
if (response.statusCode < 200 || response.statusCode >= 300) {
pending.reject(new Error(`Request failed (${response.statusCode})`));
return;
}
source/ws/index.ts
+1 -1
View File
@@ -1 +1 @@
export * from './client.js';
export * from './client.ts';
tsconfig.json
+7 -1
View File
@@ -2,6 +2,7 @@
// Visit https://aka.ms/tsconfig to read more about this file
"compilerOptions": {
// File Layout
"rootDir": "./source",
"outDir": "./dist",
// Environment Settings
@@ -27,5 +28,10 @@
"noUncheckedSideEffectImports": true,
"moduleDetection": "force",
"skipLibCheck": true,
}
// GP
"allowImportingTsExtensions": true,
"rewriteRelativeImportExtensions": true
},
"exclude": ["demo/**"]
}