@signalapp/libsignal-client 0.50.0 → 0.51.0

package/Native.d.ts

@@ -114,6 +114,18 @@ export abstract class InputStream {
 
 export abstract class SyncInputStream extends Buffer {}
 
+export abstract class ChatListener {
+  _incoming_message(
+    envelope: Buffer,
+    timestamp: number,
+    ack: ServerMessageAck
+  ): void;
+  _queue_empty(): void;
+  _connection_interrupted(): void;
+}
+
+export abstract class MakeChatListener extends ChatListener {}
+
 type Wrapper<T> = Readonly<{
   _nativeHandle: T;
 }>;
@@ -168,6 +180,7 @@ export function Cds2ClientState_New(mrenclave: Buffer, attestationMsg: Buffer, c
 export function CdsiLookup_complete(asyncRuntime: Wrapper<TokioAsyncContext>, lookup: Wrapper<CdsiLookup>): Promise<LookupResponse>;
 export function CdsiLookup_new(asyncRuntime: Wrapper<TokioAsyncContext>, connectionManager: Wrapper<ConnectionManager>, username: string, password: string, request: Wrapper<LookupRequest>): Promise<CdsiLookup>;
 export function CdsiLookup_token(lookup: Wrapper<CdsiLookup>): Buffer;
+export function ChatServer_SetListener(runtime: Wrapper<TokioAsyncContext>, chat: Wrapper<Chat>, makeListener: MakeChatListener | null): void;
 export function ChatService_auth_send(asyncRuntime: Wrapper<TokioAsyncContext>, chat: Wrapper<Chat>, httpRequest: Wrapper<HttpRequest>, timeoutMillis: number): Promise<ChatResponse>;
 export function ChatService_auth_send_and_debug(asyncRuntime: Wrapper<TokioAsyncContext>, chat: Wrapper<Chat>, httpRequest: Wrapper<HttpRequest>, timeoutMillis: number): Promise<ResponseAndDebugInfo>;
 export function ChatService_connect_auth(asyncRuntime: Wrapper<TokioAsyncContext>, chat: Wrapper<Chat>): Promise<ChatServiceDebugInfo>;
@@ -480,6 +493,7 @@ export function TESTING_ChatServiceDebugInfoConvert(): ChatServiceDebugInfo;
 export function TESTING_ChatServiceErrorConvert(errorDescription: string): void;
 export function TESTING_ChatServiceResponseAndDebugInfoConvert(): ResponseAndDebugInfo;
 export function TESTING_ChatServiceResponseConvert(bodyPresent: boolean): ChatResponse;
+export function TESTING_ChatService_InjectConnectionInterrupted(chat: Wrapper<Chat>): void;
 export function TESTING_ChatService_InjectRawServerRequest(chat: Wrapper<Chat>, bytes: Buffer): void;
 export function TESTING_ErrorOnBorrowAsync(_input: null): Promise<void>;
 export function TESTING_ErrorOnBorrowIo(asyncRuntime: Wrapper<NonSuspendingBackgroundThreadRuntime>, _input: null): Promise<void>;

package/dist/acknowledgments.md

@@ -669,7 +669,7 @@ For more information on this, and how to apply and follow the GNU AGPL, see
 
 ```
 
-## attest 0.1.0, device-transfer 0.1.0, libsignal-bridge 0.1.0, libsignal-bridge-macros 0.1.0, libsignal-core 0.1.0, libsignal-ffi 0.50.0, libsignal-jni 0.50.0, libsignal-message-backup 0.1.0, libsignal-message-backup-macros 0.1.0, libsignal-net 0.1.0, libsignal-node 0.50.0, libsignal-protocol 0.1.0, libsignal-svr3 0.1.0, poksho 0.7.0, signal-crypto 0.1.0, signal-media 0.1.0, signal-neon-futures 0.1.0, signal-neon-futures-tests 0.1.0, signal-pin 0.1.0, usernames 0.1.0, zkcredential 0.1.0, zkgroup 0.9.0
+## attest 0.1.0, device-transfer 0.1.0, libsignal-bridge 0.1.0, libsignal-bridge-macros 0.1.0, libsignal-core 0.1.0, libsignal-ffi 0.51.0, libsignal-jni 0.51.0, libsignal-message-backup 0.1.0, libsignal-message-backup-macros 0.1.0, libsignal-net 0.1.0, libsignal-node 0.51.0, libsignal-protocol 0.1.0, libsignal-svr3 0.1.0, poksho 0.7.0, signal-crypto 0.1.0, signal-media 0.1.0, signal-neon-futures 0.1.0, signal-neon-futures-tests 0.1.0, signal-pin 0.1.0, usernames 0.1.0, zkcredential 0.1.0, zkgroup 0.9.0
 
 ```
 GNU AFFERO GENERAL PUBLIC LICENSE

package/dist/net.d.ts

@@ -2,6 +2,7 @@
 import type { ReadonlyDeep } from 'type-fest';
 import * as Native from '../Native';
 import { Wrapper } from '../Native';
+import { Buffer } from 'node:buffer';
 export declare enum Environment {
     Staging = 0,
     Production = 1
@@ -42,6 +43,41 @@ export declare class TokioAsyncContext {
     constructor(handle: Native.TokioAsyncContext);
     makeCancellable<T>(abortSignal: AbortSignal | undefined, promise: Promise<T>): Promise<T>;
 }
+export declare class ChatServerMessageAck {
+    private readonly asyncContext;
+    readonly _nativeHandle: Native.ServerMessageAck;
+    private promise;
+    constructor(asyncContext: TokioAsyncContext, _nativeHandle: Native.ServerMessageAck);
+    send(): Promise<void>;
+}
+export interface ChatServiceListener {
+    /**
+     * Called when the server delivers an incoming message to the client.
+     *
+     * `timestamp` is in milliseconds.
+     *
+     * If `ack`'s `send` method is not called, the server will leave this message in the message
+     * queue and attempt to deliver it again in the future.
+     */
+    onIncomingMessage(envelope: Buffer, timestamp: number, ack: ChatServerMessageAck): void;
+    /**
+     * Called when the server indicates that there are no further messages in the message queue.
+     *
+     * Note that further messages may still be delivered; this merely indicates that all messages that
+     * were in the queue *when the connection was established* have been delivered.
+     */
+    onQueueEmpty(): void;
+    /**
+     * Called when the client gets disconnected from the server.
+     *
+     * This includes both deliberate disconnects as well as unexpected socket closures that will be
+     * automatically retried.
+     *
+     * Will not be called if no other requests have been invoked for this connection attempt. That is,
+     * you should never see this as the first callback, nor two of these callbacks in a row.
+     */
+    onConnectionInterrupted(): void;
+}
 /**
  * Provides API methods to connect and communicate with the Chat Service.
  * Before using either authenticated or unauthenticated channels,
@@ -50,8 +86,19 @@ export declare class TokioAsyncContext {
  */
 export declare class ChatService {
     private readonly asyncContext;
-    private readonly chatService;
+    readonly chatService: Wrapper<Native.Chat>;
     constructor(asyncContext: TokioAsyncContext, connectionManager: ConnectionManager);
+    /**
+     * Sets the listener for server push messages on the authenticated connection.
+     *
+     * Note that this creates a **non-garbage-collectable** reference to `listener`. If `listener`
+     * contains a reference to this ChatService (directly or indirectly), both objects will be kept
+     * alive even with no other references. This may be fine if `listener` is a long-lived object
+     * anyway, but if not, make sure to eventually break the cycle, possibly by calling
+     * {@link #clearListener}.
+     */
+    setListener(listener: ChatServiceListener): void;
+    clearListener(): void;
     /**
      * Initiates termination of the underlying connection to the Chat Service. After the service is
      * disconnected, it will not attempt to automatically reconnect until you call
@@ -80,6 +127,7 @@ export declare class ChatService {
      * reconnect attempt will be made.
      *
      * Calling this method will result in starting to accept incoming requests from the Chat Service.
+     * You should set a listener first using {@link #setListener()}.
      *
      * @throws {AppExpiredError} if the current app version is too old (as judged by the server).
      * @throws {DeviceDelinkedError} if the current device has been delinked.

package/dist/net.js

@@ -4,9 +4,10 @@
 // SPDX-License-Identifier: AGPL-3.0-only
 //
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RestoredSecret = exports.Net = exports.ChatService = exports.TokioAsyncContext = exports.Environment = void 0;
+exports.RestoredSecret = exports.Net = exports.ChatService = exports.ChatServerMessageAck = exports.TokioAsyncContext = exports.Environment = void 0;
 const Native = require("../Native");
 const Address_1 = require("./Address");
+const node_buffer_1 = require("node:buffer");
 const DEFAULT_CHAT_REQUEST_TIMEOUT_MILLIS = 5000;
 // This must match the libsignal-bridge Rust enum of the same name.
 var Environment;
@@ -43,6 +44,20 @@ class TokioAsyncContext {
     }
 }
 exports.TokioAsyncContext = TokioAsyncContext;
+class ChatServerMessageAck {
+    constructor(asyncContext, _nativeHandle) {
+        this.asyncContext = asyncContext;
+        this._nativeHandle = _nativeHandle;
+        this.promise = null;
+    }
+    send() {
+        if (!this.promise) {
+            this.promise = Native.ServerMessageAck_Send(this.asyncContext, this);
+        }
+        return this.promise;
+    }
+}
+exports.ChatServerMessageAck = ChatServerMessageAck;
 /**
  * Provides API methods to connect and communicate with the Chat Service.
  * Before using either authenticated or unauthenticated channels,
@@ -54,6 +69,33 @@ class ChatService {
         this.asyncContext = asyncContext;
         this.chatService = newNativeHandle(Native.ChatService_new(connectionManager, '', ''));
     }
+    /**
+     * Sets the listener for server push messages on the authenticated connection.
+     *
+     * Note that this creates a **non-garbage-collectable** reference to `listener`. If `listener`
+     * contains a reference to this ChatService (directly or indirectly), both objects will be kept
+     * alive even with no other references. This may be fine if `listener` is a long-lived object
+     * anyway, but if not, make sure to eventually break the cycle, possibly by calling
+     * {@link #clearListener}.
+     */
+    setListener(listener) {
+        const asyncContext = this.asyncContext;
+        const nativeChatListener = {
+            _incoming_message(envelope, timestamp, ack) {
+                listener.onIncomingMessage(envelope, timestamp, new ChatServerMessageAck(asyncContext, ack));
+            },
+            _queue_empty() {
+                listener.onQueueEmpty();
+            },
+            _connection_interrupted() {
+                listener.onConnectionInterrupted();
+            },
+        };
+        Native.ChatServer_SetListener(asyncContext, this.chatService, nativeChatListener);
+    }
+    clearListener() {
+        Native.ChatServer_SetListener(this.asyncContext, this.chatService, null);
+    }
     /**
      * Initiates termination of the underlying connection to the Chat Service. After the service is
      * disconnected, it will not attempt to automatically reconnect until you call
@@ -84,6 +126,7 @@ class ChatService {
      * reconnect attempt will be made.
      *
      * Calling this method will result in starting to accept incoming requests from the Chat Service.
+     * You should set a listener first using {@link #setListener()}.
      *
      * @throws {AppExpiredError} if the current app version is too old (as judged by the server).
      * @throws {DeviceDelinkedError} if the current device has been delinked.
@@ -136,7 +179,7 @@ class ChatService {
     }
     static buildHttpRequest(chatRequest) {
         const { verb, path, body, headers } = chatRequest;
-        const bodyBuffer = body !== undefined ? Buffer.from(body) : null;
+        const bodyBuffer = body !== undefined ? node_buffer_1.Buffer.from(body) : null;
         const httpRequest = {
             _nativeHandle: Native.HttpRequest_new(verb, path, bodyBuffer),
         };
@@ -195,7 +238,7 @@ class Net {
             Native.LookupRequest_addE164(request, e164);
         });
         acisAndAccessKeys.forEach(({ aci: aciStr, accessKey: accessKeyStr }) => {
-            Native.LookupRequest_addAciAndAccessKey(request, Address_1.Aci.parseFromServiceIdString(aciStr).getServiceIdFixedWidthBinary(), Buffer.from(accessKeyStr, 'base64'));
+            Native.LookupRequest_addAciAndAccessKey(request, Address_1.Aci.parseFromServiceIdString(aciStr).getServiceIdFixedWidthBinary(), node_buffer_1.Buffer.from(accessKeyStr, 'base64'));
         });
         Native.LookupRequest_setReturnAcisWithoutUaks(request, returnAcisWithoutUaks);
         const lookup = await this.asyncContext.makeCancellable(abortSignal, Native.CdsiLookup_new(this.asyncContext, this.connectionManager, username, password, request));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalapp/libsignal-client",
-  "version": "0.50.0",
+  "version": "0.51.0",
   "license": "AGPL-3.0-only",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -19,6 +19,7 @@
   "scripts": {
     "install": "node-gyp-build",
     "build": "node-gyp build",
+    "build-with-debug-level-logs": "npx --libsignal-debug-level-logs node-gyp build",
     "tsc": "tsc -b",
     "clean": "rimraf dist build prebuilds",
     "test": "mocha --recursive dist/test --require source-map-support/register",
@@ -39,6 +40,8 @@
     "@types/chance": "^1.1.3",
     "@types/mocha": "^5.2.7",
     "@types/node": "~18.15.0",
+    "@types/sinon": "^17.0.3",
+    "@types/sinon-chai": "^3.2.12",
     "@types/uuid": "^8.3.0",
     "@typescript-eslint/eslint-plugin": "^5.47.0",
     "@typescript-eslint/parser": "^5.47.0",
@@ -57,6 +60,8 @@
     "prebuildify": "^5.0.1",
     "prettier": "^2.7.1",
     "rimraf": "^3.0.1",
+    "sinon": "^18.0.0",
+    "sinon-chai": "^3.7.0",
     "source-map-support": "^0.5.19",
     "typescript": "4.9.3"
   }