hypha-rpc 0.20.42 → 0.20.44

package/dist/hypha-rpc-websocket.js

@@ -36,7 +36,7 @@ __webpack_require__.r(__webpack_exports__);
 
 
 
-const API_VERSION = "0.20.0";
+const API_VERSION = 2;
 const CHUNK_SIZE = 1024 * 500;
 
 const ArrayBufferView = Object.getPrototypeOf(
@@ -325,7 +325,11 @@ class RPC extends _utils__WEBPACK_IMPORTED_MODULE_0__.MessageEmitter {
         id: "built-in",
         type: "built-in",
         name: `Built-in services for ${this._local_workspace}/${this._client_id}`,
-        config: { require_context: true, visibility: "public" },
+        config: {
+          require_context: true,
+          visibility: "public",
+          api_version: API_VERSION,
+        },
         ping: this._ping.bind(this),
         get_service: this.get_local_service.bind(this),
         message_cache: {
@@ -474,6 +478,7 @@ class RPC extends _utils__WEBPACK_IMPORTED_MODULE_0__.MessageEmitter {
     Object.assign(main, {
       from: context.from,
       to: context.to,
+      ws: context.ws,
       user: context.user,
     });
     main["ctx"] = JSON.parse(JSON.stringify(main));
@@ -844,13 +849,11 @@ class RPC extends _utils__WEBPACK_IMPORTED_MODULE_0__.MessageEmitter {
     let method_id = `${session_id}.${name}`;
     let encoded = {
       _rtype: "method",
-      _rserver: this._server_base_url,
       _rtarget: local_workspace
         ? `${local_workspace}/${this._client_id}`
         : this._client_id,
       _rmethod: method_id,
       _rpromise: false,
-      _rdoc: `callback: ${method_id}, context: (${description})`,
     };
 
     const self = this;
@@ -994,7 +997,7 @@ class RPC extends _utils__WEBPACK_IMPORTED_MODULE_0__.MessageEmitter {
       encoded_method._rtarget = target_id;
     }
     let method_id = encoded_method._rmethod;
-    let with_promise = encoded_method._rpromise;
+    let with_promise = encoded_method._rpromise || false;
     const description = `method: ${method_id}, docs: ${encoded_method._rdoc}`;
     const self = this;
 
@@ -1081,7 +1084,7 @@ class RPC extends _utils__WEBPACK_IMPORTED_MODULE_0__.MessageEmitter {
               break;
             }
           }
-          extra_data["promise"] = await self._encode_promise(
+          const promiseData = await self._encode_promise(
             resolve,
             reject,
             local_session_id,
@@ -1090,6 +1093,15 @@ class RPC extends _utils__WEBPACK_IMPORTED_MODULE_0__.MessageEmitter {
             local_workspace,
             description,
           );
+
+          if (with_promise === true) {
+            extra_data["promise"] = promiseData;
+          } else if (with_promise === "*") {
+            extra_data["promise"] = "*";
+            extra_data["t"] = self._method_timeout / 2;
+          } else {
+            throw new Error(`Unsupported promise type: ${with_promise}`);
+          }
         }
         // The message consists of two segments, the main message and extra data
         let message_package = (0,_msgpack_msgpack__WEBPACK_IMPORTED_MODULE_3__.encode)(main_message);
@@ -1098,7 +1110,7 @@ class RPC extends _utils__WEBPACK_IMPORTED_MODULE_0__.MessageEmitter {
           message_package = new Uint8Array([...message_package, ...extra]);
         }
         const total_size = message_package.length;
-        if (total_size <= CHUNK_SIZE + 1024) {
+        if (total_size <= CHUNK_SIZE + 1024 || remote_method.__no_chunk__) {
           self
             ._emit_message(message_package)
             .then(function () {
@@ -1145,6 +1157,9 @@ class RPC extends _utils__WEBPACK_IMPORTED_MODULE_0__.MessageEmitter {
     remote_method.__doc__ =
       encoded_method._rdoc || `Remote method: ${method_id}`;
     remote_method.__schema__ = encoded_method._rschema;
+    // Prevent circular chunk sending
+    remote_method.__no_chunk__ =
+      encoded_method._rmethod === "services.built-in.message_cache.append";
     return remote_method;
   }
 
@@ -1195,7 +1210,7 @@ class RPC extends _utils__WEBPACK_IMPORTED_MODULE_0__.MessageEmitter {
         // Decode the promise with the remote session id
         // Such that the session id will be passed to the remote as a parent session id
         const promise = await this._decode(
-          data.promise,
+          data.promise === "*" ? this._expand_promise(data) : data.promise,
           data.session,
           local_parent,
           remote_workspace,
@@ -1434,7 +1449,7 @@ class RPC extends _utils__WEBPACK_IMPORTED_MODULE_0__.MessageEmitter {
           _rserver: this._server_base_url,
           _rtarget: this._client_id,
           _rmethod: annotation.method_id,
-          _rpromise: true,
+          _rpromise: "*",
         };
       } else {
         (0,_utils__WEBPACK_IMPORTED_MODULE_0__.assert)(typeof session_id === "string");
@@ -1449,7 +1464,7 @@ class RPC extends _utils__WEBPACK_IMPORTED_MODULE_0__.MessageEmitter {
           _rserver: this._server_base_url,
           _rtarget: this._client_id,
           _rmethod: `${session_id}.${object_id}`,
-          _rpromise: true,
+          _rpromise: "*",
         };
         let store = this._get_session_store(session_id, true);
         (0,_utils__WEBPACK_IMPORTED_MODULE_0__.assert)(
@@ -1798,6 +1813,30 @@ class RPC extends _utils__WEBPACK_IMPORTED_MODULE_0__.MessageEmitter {
     }
     return bObject;
   }
+
+  _expand_promise(data) {
+    return {
+      heartbeat: {
+        _rtype: "method",
+        _rtarget: data.from.split("/")[1],
+        _rmethod: data.session + ".heartbeat",
+        _rdoc: `heartbeat callback for method: ${data.method}`,
+      },
+      resolve: {
+        _rtype: "method",
+        _rtarget: data.from.split("/")[1],
+        _rmethod: data.session + ".resolve",
+        _rdoc: `resolve callback for method: ${data.method}`,
+      },
+      reject: {
+        _rtype: "method",
+        _rtarget: data.from.split("/")[1],
+        _rmethod: data.session + ".reject",
+        _rdoc: `reject callback for method: ${data.method}`,
+      },
+      interval: data.t,
+    };
+  }
 }