@holochain/client 0.19.0-dev.0 → 0.19.0-dev.1

package/README.md

@@ -179,8 +179,9 @@ You need `holochain` and `hc` on your path, best to get them from nix with `nix-
 
 To perform the pre-requisite DNA compilation steps, and run the Nodejs test, run:
 ```bash
-nix-shell
-./run-test.sh
+nix develop
+./build-fixture.sh
+npm run test
 ```
 
 ## Contribute

package/lib/api/admin/types.d.ts

@@ -120,6 +120,7 @@ export type AppInfo = {
     installed_app_id: InstalledAppId;
     cell_info: Record<RoleName, Array<CellInfo>>;
     status: InstalledAppInfoStatus;
+    installed_at: Timestamp;
 };
 /**
  * @public

package/lib/api/app/websocket.d.ts

@@ -16,6 +16,7 @@ export declare class AppWebsocket implements AppClient {
     private readonly defaultTimeout;
     private readonly emitter;
     private readonly callZomeTransform;
+    private readonly appAuthenticationToken;
     cachedAppInfo?: AppInfo | null;
     private readonly appInfoRequester;
     private readonly callZomeRequester;
@@ -103,7 +104,6 @@ export declare class AppWebsocket implements AppClient {
      */
     on<Name extends keyof AppEvents>(eventName: Name | readonly Name[], listener: SignalCb): UnsubscribeFunction;
     private static requester;
-    private containsCell;
 }
 /**
  * @public

package/lib/api/app/websocket.js

@@ -1,6 +1,6 @@
 import Emittery from "emittery";
 import { omit } from "lodash-es";
-import { CellType } from "../admin/index.js";
+import { CellType, } from "../admin/index.js";
 import { catchError, DEFAULT_TIMEOUT, getBaseRoleNameFromCloneId, HolochainError, isCloneId, promiseTimeout, requesterTransformer, } from "../common.js";
 import { getHostZomeCallSigner, getLauncherEnvironment, } from "../../environments/launcher.js";
 import { decode, encode } from "@msgpack/msgpack";
@@ -22,6 +22,7 @@ export class AppWebsocket {
     defaultTimeout;
     emitter;
     callZomeTransform;
+    appAuthenticationToken;
     cachedAppInfo;
     appInfoRequester;
     callZomeRequester;
@@ -31,12 +32,13 @@ export class AppWebsocket {
     enableCloneCellRequester;
     disableCloneCellRequester;
     networkInfoRequester;
-    constructor(client, appInfo, callZomeTransform, defaultTimeout) {
+    constructor(client, appInfo, token, callZomeTransform, defaultTimeout) {
         this.client = client;
         this.myPubKey = appInfo.agent_pub_key;
         this.installedAppId = appInfo.installed_app_id;
         this.defaultTimeout = defaultTimeout ?? DEFAULT_TIMEOUT;
         this.callZomeTransform = callZomeTransform ?? defaultCallZomeTransform;
+        this.appAuthenticationToken = token;
         this.emitter = new Emittery();
         this.cachedAppInfo = appInfo;
         this.appInfoRequester = AppWebsocket.requester(this.client, "app_info", this.defaultTimeout);
@@ -77,21 +79,15 @@ export class AppWebsocket {
             throw new HolochainError("ConnectionUrlMissing", `unable to connect to Conductor API - no url provided and not in a launcher environment.`);
         }
         const client = await WsClient.connect(options.url, options.wsClientOptions);
-        if (env?.APP_INTERFACE_TOKEN) {
-            // Note: This will only work for multiple connections if a single_use = false token is provided
-            await client.authenticate({ token: env.APP_INTERFACE_TOKEN });
-        }
-        else {
-            if (!options.token) {
-                throw new HolochainError("AppAuthenticationTokenMissing", `unable to connect to Conductor API - no app authentication token provided.`);
-            }
-            await client.authenticate({ token: options.token });
-        }
+        const token = options.token ?? env?.APP_INTERFACE_TOKEN;
+        if (!token)
+            throw new HolochainError("AppAuthenticationTokenMissing", `unable to connect to Conductor API - no app authentication token provided.`);
+        await client.authenticate({ token });
         const appInfo = await AppWebsocket.requester(client, "app_info", DEFAULT_TIMEOUT)(null);
         if (!appInfo) {
             throw new HolochainError("AppNotFound", `The app your connection token was issued for was not found. The app needs to be installed and enabled.`);
         }
-        return new AppWebsocket(client, appInfo, options.callZomeTransform, options.defaultTimeout);
+        return new AppWebsocket(client, appInfo, token, options.callZomeTransform, options.defaultTimeout);
     }
     /**
      * Request the app's info, including all cell infos.
@@ -237,25 +233,6 @@ export class AppWebsocket {
     static requester(client, tag, defaultTimeout, transformer) {
         return requesterTransformer((req, timeout) => promiseTimeout(client.request(req), tag, timeout || defaultTimeout).then(catchError), tag, transformer);
     }
-    containsCell(cellId) {
-        const appInfo = this.cachedAppInfo;
-        if (!appInfo) {
-            return false;
-        }
-        for (const roleName of Object.keys(appInfo.cell_info)) {
-            for (const cellInfo of appInfo.cell_info[roleName]) {
-                const currentCellId = CellType.Provisioned in cellInfo
-                    ? cellInfo[CellType.Provisioned].cell_id
-                    : CellType.Cloned in cellInfo
-                        ? cellInfo[CellType.Cloned].cell_id
-                        : undefined;
-                if (currentCellId && isSameCell(currentCellId, cellId)) {
-                    return true;
-                }
-            }
-        }
-        return false;
-    }
 }
 const defaultCallZomeTransform = {
     input: async (request) => {

package/lib/api/client.d.ts

@@ -23,8 +23,8 @@ export declare class WsClient extends Emittery {
     options: WsClientOptions;
     private pendingRequests;
     private index;
+    private authenticationToken;
     constructor(socket: IsoWebSocket, url?: URL, options?: WsClientOptions);
-    private setupSocket;
     /**
      * Instance factory for creating WsClients.
      *
@@ -47,6 +47,10 @@ export declare class WsClient extends Emittery {
      * @param request - The authentication request, containing an app authentication token.
      */
     authenticate(request: AppAuthenticationRequest): Promise<void>;
+    /**
+     * Close the websocket connection.
+     */
+    close(code?: number): Promise<IsoWebSocket.CloseEvent>;
     /**
      * Send requests to the connected websocket.
      *
@@ -56,10 +60,9 @@ export declare class WsClient extends Emittery {
     request<Response>(request: unknown): Promise<Response>;
     private exchange;
     private sendMessage;
+    private registerMessageListener;
+    private registerCloseListener;
+    private reconnectWebsocket;
     private handleResponse;
-    /**
-     * Close the websocket connection.
-     */
-    close(code?: number): Promise<CloseEvent>;
 }
 export { IsoWebSocket };

package/lib/api/client.js

@@ -17,74 +17,16 @@ export class WsClient extends Emittery {
     options;
     pendingRequests;
     index;
+    authenticationToken;
     constructor(socket, url, options) {
         super();
+        this.registerMessageListener(socket);
+        this.registerCloseListener(socket);
         this.socket = socket;
         this.url = url;
         this.options = options || {};
         this.pendingRequests = {};
         this.index = 0;
-        this.setupSocket();
-    }
-    setupSocket() {
-        this.socket.onmessage = async (serializedMessage) => {
-            // If data is not a buffer (nodejs), it will be a blob (browser)
-            let deserializedData;
-            if (globalThis.window &&
-                serializedMessage.data instanceof globalThis.window.Blob) {
-                deserializedData = await serializedMessage.data.arrayBuffer();
-            }
-            else {
-                if (typeof Buffer !== "undefined" &&
-                    Buffer.isBuffer(serializedMessage.data)) {
-                    deserializedData = serializedMessage.data;
-                }
-                else {
-                    throw new HolochainError("UnknownMessageFormat", `incoming message has unknown message format - ${deserializedData}`);
-                }
-            }
-            const message = decode(deserializedData);
-            assertHolochainMessage(message);
-            if (message.type === "signal") {
-                if (message.data === null) {
-                    throw new HolochainError("UnknownSignalFormat", "incoming signal has no data");
-                }
-                const deserializedSignal = decode(message.data);
-                assertHolochainSignal(deserializedSignal);
-                if (SignalType.System in deserializedSignal) {
-                    this.emit("signal", {
-                        System: deserializedSignal[SignalType.System],
-                    });
-                }
-                else {
-                    const encodedAppSignal = deserializedSignal[SignalType.App];
-                    // In order to return readable content to the UI, the signal payload must also be deserialized.
-                    const payload = decode(encodedAppSignal.signal);
-                    const signal = {
-                        cell_id: encodedAppSignal.cell_id,
-                        zome_name: encodedAppSignal.zome_name,
-                        payload,
-                    };
-                    this.emit("signal", { App: signal });
-                }
-            }
-            else if (message.type === "response") {
-                this.handleResponse(message);
-            }
-            else {
-                throw new HolochainError("UnknownMessageType", `incoming message has unknown type - ${message.type}`);
-            }
-        };
-        this.socket.onclose = (event) => {
-            const pendingRequestIds = Object.keys(this.pendingRequests).map((id) => parseInt(id));
-            if (pendingRequestIds.length) {
-                pendingRequestIds.forEach((id) => {
-                    const error = new HolochainError("ClientClosedWithPendingRequests", `client closed with pending requests - close event code: ${event.code}, request id: ${id}`);
-                    this.pendingRequests[id].reject(error);
-                    delete this.pendingRequests[id];
-                });
-            }
-        };
     }
     /**
      * Instance factory for creating WsClients.
@@ -96,13 +38,13 @@ export class WsClient extends Emittery {
     static connect(url, options) {
         return new Promise((resolve, reject) => {
             const socket = new IsoWebSocket(url, options);
-            socket.onerror = (errorEvent) => {
+            socket.addEventListener("error", (errorEvent) => {
                 reject(new HolochainError("ConnectionError", `could not connect to Holochain Conductor API at ${url} - ${errorEvent.error}`));
-            };
-            socket.onopen = () => {
+            });
+            socket.addEventListener("open", (_) => {
                 const client = new WsClient(socket, url, options);
                 resolve(client);
-            };
+            }, { once: true });
         });
     }
     /**
@@ -125,16 +67,35 @@ export class WsClient extends Emittery {
      * @param request - The authentication request, containing an app authentication token.
      */
     async authenticate(request) {
-        return this.exchange(request, (request, resolve) => {
+        this.authenticationToken = request.token;
+        return this.exchange(request, (request, resolve, reject) => {
+            const invalidTokenCloseListener = (closeEvent) => {
+                this.authenticationToken = undefined;
+                reject(new HolochainError("InvalidTokenError", `could not connect to ${this.url} due to an invalid app authentication token - close code ${closeEvent.code}`));
+            };
+            this.socket.addEventListener("close", invalidTokenCloseListener, {
+                once: true,
+            });
             const encodedMsg = encode({
                 type: "authenticate",
                 data: encode(request),
             });
             this.socket.send(encodedMsg);
-            // Message just needs to be sent first, no need to wait for a response or even require a flush
-            resolve(null);
+            // Wait before resolving in case authentication fails.
+            setTimeout(() => {
+                this.socket.removeEventListener("close", invalidTokenCloseListener);
+                resolve(null);
+            }, 10);
         });
     }
+    /**
+     * Close the websocket connection.
+     */
+    close(code = 1000) {
+        const closedPromise = new Promise((resolve) => this.socket.addEventListener("close", (closeEvent) => resolve(closeEvent), { once: true }));
+        this.socket.close(code);
+        return closedPromise;
+    }
     /**
      * Send requests to the connected websocket.
      *
@@ -144,15 +105,22 @@ export class WsClient extends Emittery {
     async request(request) {
         return this.exchange(request, this.sendMessage.bind(this));
     }
-    exchange(request, sendHandler) {
+    async exchange(request, sendHandler) {
         if (this.socket.readyState === this.socket.OPEN) {
             const promise = new Promise((resolve, reject) => {
                 sendHandler(request, resolve, reject);
             });
             return promise;
         }
+        else if (this.url && this.authenticationToken) {
+            await this.reconnectWebsocket(this.url, this.authenticationToken);
+            this.registerMessageListener(this.socket);
+            this.registerCloseListener(this.socket);
+            const promise = new Promise((resolve, reject) => sendHandler(request, resolve, reject));
+            return promise;
+        }
         else {
-            return Promise.reject(new Error("Socket is not open"));
+            return Promise.reject(new HolochainError("WebsocketClosedError", "Websocket is not open"));
         }
     }
     sendMessage(request, resolve, reject) {
@@ -166,6 +134,97 @@ export class WsClient extends Emittery {
         this.pendingRequests[id] = { resolve, reject };
         this.index += 1;
     }
+    registerMessageListener(socket) {
+        socket.onmessage = async (serializedMessage) => {
+            // If data is not a buffer (nodejs), it will be a blob (browser)
+            let deserializedData;
+            if (globalThis.window &&
+                serializedMessage.data instanceof globalThis.window.Blob) {
+                deserializedData = await serializedMessage.data.arrayBuffer();
+            }
+            else {
+                if (typeof Buffer !== "undefined" &&
+                    Buffer.isBuffer(serializedMessage.data)) {
+                    deserializedData = serializedMessage.data;
+                }
+                else {
+                    throw new HolochainError("UnknownMessageFormat", `incoming message has unknown message format - ${deserializedData}`);
+                }
+            }
+            const message = decode(deserializedData);
+            assertHolochainMessage(message);
+            if (message.type === "signal") {
+                if (message.data === null) {
+                    throw new HolochainError("UnknownSignalFormat", "incoming signal has no data");
+                }
+                const deserializedSignal = decode(message.data);
+                assertHolochainSignal(deserializedSignal);
+                if (SignalType.System in deserializedSignal) {
+                    this.emit("signal", {
+                        System: deserializedSignal[SignalType.System],
+                    });
+                }
+                else {
+                    const encodedAppSignal = deserializedSignal[SignalType.App];
+                    // In order to return readable content to the UI, the signal payload must also be deserialized.
+                    const payload = decode(encodedAppSignal.signal);
+                    const signal = {
+                        cell_id: encodedAppSignal.cell_id,
+                        zome_name: encodedAppSignal.zome_name,
+                        payload,
+                    };
+                    this.emit("signal", { App: signal });
+                }
+            }
+            else if (message.type === "response") {
+                this.handleResponse(message);
+            }
+            else {
+                throw new HolochainError("UnknownMessageType", `incoming message has unknown type - ${message.type}`);
+            }
+        };
+    }
+    registerCloseListener(socket) {
+        socket.addEventListener("close", (closeEvent) => {
+            const pendingRequestIds = Object.keys(this.pendingRequests).map((id) => parseInt(id));
+            if (pendingRequestIds.length) {
+                pendingRequestIds.forEach((id) => {
+                    const error = new HolochainError("ClientClosedWithPendingRequests", `client closed with pending requests - close event code: ${closeEvent.code}, request id: ${id}`);
+                    this.pendingRequests[id].reject(error);
+                    delete this.pendingRequests[id];
+                });
+            }
+        }, { once: true });
+    }
+    async reconnectWebsocket(url, token) {
+        return new Promise((resolve, reject) => {
+            this.socket = new IsoWebSocket(url, this.options);
+            // This error event never occurs in tests. Could be removed?
+            this.socket.addEventListener("error", (errorEvent) => {
+                this.authenticationToken = undefined;
+                reject(new HolochainError("ConnectionError", `could not connect to Holochain Conductor API at ${url} - ${errorEvent.message}`));
+            }, { once: true });
+            const invalidTokenCloseListener = (closeEvent) => {
+                this.authenticationToken = undefined;
+                reject(new HolochainError("InvalidTokenError", `could not connect to ${this.url} due to an invalid app authentication token - close code ${closeEvent.code}`));
+            };
+            this.socket.addEventListener("close", invalidTokenCloseListener, {
+                once: true,
+            });
+            this.socket.addEventListener("open", async (_) => {
+                const encodedMsg = encode({
+                    type: "authenticate",
+                    data: encode({ token }),
+                });
+                this.socket.send(encodedMsg);
+                // Wait in case authentication fails.
+                setTimeout(() => {
+                    this.socket.removeEventListener("close", invalidTokenCloseListener);
+                    resolve();
+                }, 10);
+            }, { once: true });
+        });
+    }
     handleResponse(msg) {
         const id = msg.id;
         if (this.pendingRequests[id]) {
@@ -181,20 +240,6 @@ export class WsClient extends Emittery {
             console.error(`got response with no matching request. id = ${id} msg = ${msg}`);
         }
     }
-    /**
-     * Close the websocket connection.
-     */
-    close(code = 1000) {
-        const closedPromise = new Promise((resolve) => 
-        // for an unknown reason "addEventListener" is seen as a non-callable
-        // property and gives a ts2349 error
-        // type assertion as workaround
-        this.socket.addEventListener("close", (event) => resolve(event))
-        // }
-        );
-        this.socket.close(code);
-        return closedPromise;
-    }
 }
 function assertHolochainMessage(message) {
     if (typeof message === "object" &&

package/lib/api/common.js

@@ -52,6 +52,7 @@ export const promiseTimeout = (promise, tag, ms) => {
         return res(a);
     })
         .catch((e) => {
+        clearTimeout(id);
         return rej(e);
     }));
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@holochain/client",
-  "version": "0.19.0-dev.0",
+  "version": "0.19.0-dev.1",
   "description": "A JavaScript client for the Holochain Conductor API",
   "author": "Holochain Foundation <info@holochain.org> (https://holochain.org)",
   "license": "CAL-1.0",
@@ -72,4 +72,4 @@
     "tsx": "^4.7.2",
     "typescript": "^4.9.5"
   }
-}
+}