@itwin/core-backend 5.0.0-dev.9 → 5.0.0-dev.92

package/lib/esm/rpc/web/response.js

@@ -0,0 +1,136 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { BentleyError, Logger } from "@itwin/core-bentley";
+import { CommonLoggerCategory, RpcContentType, RpcMultipart, RpcProtocol, RpcRequestStatus, RpcResponseCacheControl, WEB_RPC_CONSTANTS, WebAppRpcRequest, } from "@itwin/core-common";
+import { Stream } from "node:stream";
+import { promisify } from "node:util";
+import { brotliCompress, createBrotliCompress, createGzip, gzip, constants as zlibConstants } from "node:zlib";
+/* eslint-disable @typescript-eslint/no-deprecated */
+function configureResponse(protocol, request, fulfillment, res) {
+    const success = protocol.getStatus(fulfillment.status) === RpcRequestStatus.Resolved;
+    // TODO: Use stale-while-revalidate in cache headers. This needs to be tested, and does not currently have support in the router/caching-service.
+    // This will allow browsers to use stale cached responses while also revalidating with the router, allowing us to start up a backend if necessary.
+    // RPC Caching Service uses the s-maxage header to determine the TTL for the redis cache.
+    const oneHourInSeconds = 3600;
+    if (success && request.caching === RpcResponseCacheControl.Immutable) {
+        // If response size is > 50 MB, do not cache it.
+        if (fulfillment.result.objects.length > (50 * 10 ** 7)) {
+            res.set("Cache-Control", "no-store");
+        }
+        else if (request.operation.operationName === "generateTileContent") {
+            res.set("Cache-Control", "no-store");
+        }
+        else if (request.operation.operationName === "getConnectionProps") {
+            // GetConnectionprops can't be cached on the browser longer than the lifespan of the backend. The lifespan of backend may shrink too. Keep it at 1 second to be safe.
+            res.set("Cache-Control", `s-maxage=${oneHourInSeconds * 24}, max-age=1, immutable`);
+        }
+        else if (request.operation.operationName === "getTileCacheContainerUrl") {
+            // getTileCacheContainerUrl returns a SAS with an expiry of 23:59:59. We can't exceed that time when setting the max-age.
+            res.set("Cache-Control", `s-maxage=${oneHourInSeconds * 23}, max-age=${oneHourInSeconds * 23}, immutable`);
+        }
+        else {
+            res.set("Cache-Control", `s-maxage=${oneHourInSeconds * 24}, max-age=${oneHourInSeconds * 48}, immutable`);
+        }
+    }
+    if (fulfillment.retry) {
+        res.set("Retry-After", fulfillment.retry);
+    }
+}
+function configureText(fulfillment, res) {
+    res.set(WEB_RPC_CONSTANTS.CONTENT, WEB_RPC_CONSTANTS.TEXT);
+    return (fulfillment.status === 204) ? "" : fulfillment.result.objects;
+}
+function configureBinary(fulfillment, res) {
+    res.set(WEB_RPC_CONSTANTS.CONTENT, WEB_RPC_CONSTANTS.BINARY);
+    const data = fulfillment.result.data[0];
+    return Buffer.isBuffer(data) ? data : Buffer.from(data);
+}
+function configureMultipart(fulfillment, res) {
+    const response = RpcMultipart.createStream(fulfillment.result);
+    const headers = response.getHeaders();
+    for (const header in headers) {
+        if (headers.hasOwnProperty(header)) {
+            res.set(header, headers[header]);
+        }
+    }
+    return response;
+}
+function configureStream(fulfillment) {
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    return fulfillment.result.stream;
+}
+async function configureEncoding(req, res, responseBody) {
+    const acceptedEncodings = req.header("Accept-Encoding")?.split(",").map((value) => value.trim());
+    if (!acceptedEncodings)
+        return responseBody;
+    const encoding = acceptedEncodings.includes("br") ? "br" : acceptedEncodings.includes("gzip") ? "gzip" : undefined;
+    if (!encoding)
+        return responseBody;
+    res.set("Content-Encoding", encoding);
+    const brotliOptions = {
+        params: {
+            // Experimentation revealed that the default compression quality significantly increases the compression time for larger texts.
+            // Reducing the quality improves speed substantially without a significant loss in the compression ratio.
+            [zlibConstants.BROTLI_PARAM_QUALITY]: 3,
+        },
+    };
+    if (responseBody instanceof Stream) {
+        const compressStream = encoding === "br" ? createBrotliCompress(brotliOptions) : createGzip();
+        return responseBody.pipe(compressStream);
+    }
+    return encoding === "br" ? promisify(brotliCompress)(responseBody, brotliOptions) : promisify(gzip)(responseBody);
+}
+/** @internal */
+export async function sendResponse(protocol, request, fulfillment, req, res) {
+    logResponse(request, fulfillment.status, fulfillment.rawResult);
+    const versionHeader = protocol.protocolVersionHeaderName;
+    if (versionHeader && RpcProtocol.protocolVersion) {
+        res.set(versionHeader, RpcProtocol.protocolVersion.toString());
+    }
+    const transportType = WebAppRpcRequest.computeTransportType(fulfillment.result, fulfillment.rawResult);
+    let responseBody;
+    if (transportType === RpcContentType.Binary) {
+        responseBody = configureBinary(fulfillment, res);
+    }
+    else if (transportType === RpcContentType.Multipart) {
+        responseBody = configureMultipart(fulfillment, res);
+    }
+    else if (transportType === RpcContentType.Stream) {
+        responseBody = configureStream(fulfillment);
+    }
+    else {
+        responseBody = configureText(fulfillment, res);
+    }
+    configureResponse(protocol, request, fulfillment, res);
+    res.status(fulfillment.status);
+    if (fulfillment.allowCompression)
+        responseBody = await configureEncoding(req, res, responseBody);
+    // This check should in theory look for instances of Readable, but that would break backend implementation at
+    // core/backend/src/RpcBackend.ts
+    if (responseBody instanceof Stream) {
+        responseBody.pipe(res);
+    }
+    else {
+        res.send(responseBody);
+    }
+}
+function logResponse(request, statusCode, resultObj) {
+    const metadata = {
+        ActivityId: request.id, // eslint-disable-line @typescript-eslint/naming-convention
+        method: request.method,
+        path: request.path,
+        operation: request.operation,
+        statusCode,
+        errorObj: resultObj instanceof Error ? BentleyError.getErrorProps(resultObj) : undefined,
+    };
+    if (statusCode < 400)
+        Logger.logInfo(CommonLoggerCategory.RpcInterfaceBackend, "RPC over HTTP success response", metadata);
+    else
+        Logger.logError(CommonLoggerCategory.RpcInterfaceBackend, "RPC over HTTP failure response", metadata);
+}
+//# sourceMappingURL=response.js.map

package/lib/esm/rpc/web/response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response.js","sourceRoot":"","sources":["../../../../src/rpc/web/response.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EACL,oBAAoB,EAIpB,cAAc,EACd,YAAY,EACZ,WAAW,EAEX,gBAAgB,EAChB,uBAAuB,EAEvB,iBAAiB,EAEjB,gBAAgB,GACjB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAY,MAAM,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,cAAc,EAAiB,oBAAoB,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,IAAI,aAAa,EAAE,MAAM,WAAW,CAAC;AAE9H,qDAAqD;AAErD,SAAS,iBAAiB,CAAC,QAA2B,EAAE,OAA6B,EAAE,WAAkC,EAAE,GAAuB;IAChJ,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,gBAAgB,CAAC,QAAQ,CAAC;IACrF,iJAAiJ;IACjJ,kJAAkJ;IAElJ,yFAAyF;IACzF,MAAM,gBAAgB,GAAG,IAAI,CAAC;IAC9B,IAAI,OAAO,IAAI,OAAO,CAAC,OAAO,KAAK,uBAAuB,CAAC,SAAS,EAAE,CAAC;QACrE,gDAAgD;QAChD,IAAI,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;YACvD,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;QACvC,CAAC;aAAM,IAAI,OAAO,CAAC,SAAS,CAAC,aAAa,KAAK,qBAAqB,EAAE,CAAC;YACrE,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;QACvC,CAAC;aAAM,IAAI,OAAO,CAAC,SAAS,CAAC,aAAa,KAAK,oBAAoB,EAAE,CAAC;YACpE,qKAAqK;YACrK,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,YAAY,gBAAgB,GAAG,EAAE,wBAAwB,CAAC,CAAC;QACtF,CAAC;aAAM,IAAI,OAAO,CAAC,SAAS,CAAC,aAAa,KAAK,0BAA0B,EAAE,CAAC;YAC1E,yHAAyH;YACzH,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,YAAY,gBAAgB,GAAG,EAAE,aAAa,gBAAgB,GAAG,EAAE,aAAa,CAAC,CAAC;QAC7G,CAAC;aAAM,CAAC;YACN,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,YAAY,gBAAgB,GAAG,EAAE,aAAa,gBAAgB,GAAG,EAAE,aAAa,CAAC,CAAC;QAC7G,CAAC;IACH,CAAC;IAED,IAAI,WAAW,CAAC,KAAK,EAAE,CAAC;QACtB,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,WAAkC,EAAE,GAAuB;IAChF,GAAG,CAAC,GAAG,CAAC,iBAAiB,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC3D,OAAO,CAAC,WAAW,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC;AACxE,CAAC;AAED,SAAS,eAAe,CAAC,WAAkC,EAAE,GAAuB;IAClF,GAAG,CAAC,GAAG,CAAC,iBAAiB,CAAC,OAAO,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC7D,MAAM,IAAI,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACxC,OAAO,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1D,CAAC;AAED,SAAS,kBAAkB,CAAC,WAAkC,EAAE,GAAuB;IACrF,MAAM,QAAQ,GAAG,YAAY,CAAC,YAAY,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAC/D,MAAM,OAAO,GAAG,QAAQ,CAAC,UAAU,EAAE,CAAC;IACtC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;YACnC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,eAAe,CAAC,WAAkC;IACzD,oEAAoE;IACpE,OAAO,WAAW,CAAC,MAAM,CAAC,MAAO,CAAC;AACpC,CAAC;AAED,KAAK,UAAU,iBAAiB,CAAC,GAAsB,EAAE,GAAuB,EAAE,YAAwC;IACxH,MAAM,iBAAiB,GAAG,GAAG,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;IACjG,IAAI,CAAC,iBAAiB;QACpB,OAAO,YAAY,CAAC;IAEtB,MAAM,QAAQ,GAAG,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IACnH,IAAI,CAAC,QAAQ;QACX,OAAO,YAAY,CAAC;IAEtB,GAAG,CAAC,GAAG,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC;IAEtC,MAAM,aAAa,GAAkB;QACnC,MAAM,EAAE;YACN,+HAA+H;YAC/H,yGAAyG;YACzG,CAAC,aAAa,CAAC,oBAAoB,CAAC,EAAE,CAAC;SACxC;KACF,CAAC;IAEF,IAAI,YAAY,YAAY,MAAM,EAAE,CAAC;QACnC,MAAM,cAAc,GAAG,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;QAC9F,OAAO,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3C,CAAC;IAED,OAAO,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC;AACpH,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,QAA2B,EAAE,OAA6B,EAAE,WAAkC,EAAE,GAAsB,EAAE,GAAuB;IAChL,WAAW,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IAEhE,MAAM,aAAa,GAAG,QAAQ,CAAC,yBAAyB,CAAC;IACzD,IAAI,aAAa,IAAI,WAAW,CAAC,eAAe,EAAE,CAAC;QACjD,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,WAAW,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,MAAM,aAAa,GAAG,gBAAgB,CAAC,oBAAoB,CAAC,WAAW,CAAC,MAAM,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IACvG,IAAI,YAAY,CAAC;IACjB,IAAI,aAAa,KAAK,cAAc,CAAC,MAAM,EAAE,CAAC;QAC5C,YAAY,GAAG,eAAe,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;IACnD,CAAC;SAAM,IAAI,aAAa,KAAK,cAAc,CAAC,SAAS,EAAE,CAAC;QACtD,YAAY,GAAG,kBAAkB,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;IACtD,CAAC;SAAM,IAAI,aAAa,KAAK,cAAc,CAAC,MAAM,EAAE,CAAC;QACnD,YAAY,GAAG,eAAe,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC;SAAM,CAAC;QACN,YAAY,GAAG,aAAa,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;IACjD,CAAC;IAED,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC;IACvD,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAE/B,IAAI,WAAW,CAAC,gBAAgB;QAC9B,YAAY,GAAG,MAAM,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC;IAEjE,6GAA6G;IAC7G,iCAAiC;IACjC,IAAI,YAAY,YAAY,MAAM,EAAE,CAAC;QACnC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;SAAM,CAAC;QACN,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACzB,CAAC;AACH,CAAC;AAED,SAAS,WAAW,CAAC,OAA6B,EAAE,UAAkB,EAAE,SAAkB;IACxF,MAAM,QAAQ,GAAG;QACf,UAAU,EAAE,OAAO,CAAC,EAAE,EAAE,2DAA2D;QACnF,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,UAAU;QACV,QAAQ,EAAE,SAAS,YAAY,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;KACzF,CAAC;IAEF,IAAI,UAAU,GAAG,GAAG;QAClB,MAAM,CAAC,OAAO,CAAC,oBAAoB,CAAC,mBAAmB,EAAE,gCAAgC,EAAE,QAAQ,CAAC,CAAC;;QAErG,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,mBAAmB,EAAE,gCAAgC,EAAE,QAAQ,CAAC,CAAC;AAC1G,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module RpcInterface\n */\n\nimport { BentleyError, Logger } from \"@itwin/core-bentley\";\nimport {\n  CommonLoggerCategory,\n  HttpServerRequest,\n  HttpServerResponse,\n  ReadableFormData,\n  RpcContentType,\n  RpcMultipart,\n  RpcProtocol,\n  RpcRequestFulfillment,\n  RpcRequestStatus,\n  RpcResponseCacheControl,\n  SerializedRpcRequest,\n  WEB_RPC_CONSTANTS,\n  WebAppRpcProtocol,\n  WebAppRpcRequest,\n} from \"@itwin/core-common\";\n\nimport { Readable, Stream } from \"node:stream\";\nimport { promisify } from \"node:util\";\nimport { brotliCompress, BrotliOptions, createBrotliCompress, createGzip, gzip, constants as zlibConstants } from \"node:zlib\";\n\n/* eslint-disable @typescript-eslint/no-deprecated */\n\nfunction configureResponse(protocol: WebAppRpcProtocol, request: SerializedRpcRequest, fulfillment: RpcRequestFulfillment, res: HttpServerResponse) {\n  const success = protocol.getStatus(fulfillment.status) === RpcRequestStatus.Resolved;\n  // TODO: Use stale-while-revalidate in cache headers. This needs to be tested, and does not currently have support in the router/caching-service.\n  // This will allow browsers to use stale cached responses while also revalidating with the router, allowing us to start up a backend if necessary.\n\n  // RPC Caching Service uses the s-maxage header to determine the TTL for the redis cache.\n  const oneHourInSeconds = 3600;\n  if (success && request.caching === RpcResponseCacheControl.Immutable) {\n    // If response size is > 50 MB, do not cache it.\n    if (fulfillment.result.objects.length > (50 * 10 ** 7)) {\n      res.set(\"Cache-Control\", \"no-store\");\n    } else if (request.operation.operationName === \"generateTileContent\") {\n      res.set(\"Cache-Control\", \"no-store\");\n    } else if (request.operation.operationName === \"getConnectionProps\") {\n      // GetConnectionprops can't be cached on the browser longer than the lifespan of the backend. The lifespan of backend may shrink too. Keep it at 1 second to be safe.\n      res.set(\"Cache-Control\", `s-maxage=${oneHourInSeconds * 24}, max-age=1, immutable`);\n    } else if (request.operation.operationName === \"getTileCacheContainerUrl\") {\n      // getTileCacheContainerUrl returns a SAS with an expiry of 23:59:59. We can't exceed that time when setting the max-age.\n      res.set(\"Cache-Control\", `s-maxage=${oneHourInSeconds * 23}, max-age=${oneHourInSeconds * 23}, immutable`);\n    } else {\n      res.set(\"Cache-Control\", `s-maxage=${oneHourInSeconds * 24}, max-age=${oneHourInSeconds * 48}, immutable`);\n    }\n  }\n\n  if (fulfillment.retry) {\n    res.set(\"Retry-After\", fulfillment.retry);\n  }\n}\n\nfunction configureText(fulfillment: RpcRequestFulfillment, res: HttpServerResponse): string {\n  res.set(WEB_RPC_CONSTANTS.CONTENT, WEB_RPC_CONSTANTS.TEXT);\n  return (fulfillment.status === 204) ? \"\" : fulfillment.result.objects;\n}\n\nfunction configureBinary(fulfillment: RpcRequestFulfillment, res: HttpServerResponse): Buffer {\n  res.set(WEB_RPC_CONSTANTS.CONTENT, WEB_RPC_CONSTANTS.BINARY);\n  const data = fulfillment.result.data[0];\n  return Buffer.isBuffer(data) ? data : Buffer.from(data);\n}\n\nfunction configureMultipart(fulfillment: RpcRequestFulfillment, res: HttpServerResponse): ReadableFormData {\n  const response = RpcMultipart.createStream(fulfillment.result);\n  const headers = response.getHeaders();\n  for (const header in headers) {\n    if (headers.hasOwnProperty(header)) {\n      res.set(header, headers[header]);\n    }\n  }\n\n  return response;\n}\n\nfunction configureStream(fulfillment: RpcRequestFulfillment) {\n  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n  return fulfillment.result.stream!;\n}\n\nasync function configureEncoding(req: HttpServerRequest, res: HttpServerResponse, responseBody: string | Buffer | Readable): Promise<string | Buffer | Readable> {\n  const acceptedEncodings = req.header(\"Accept-Encoding\")?.split(\",\").map((value) => value.trim());\n  if (!acceptedEncodings)\n    return responseBody;\n\n  const encoding = acceptedEncodings.includes(\"br\") ? \"br\" : acceptedEncodings.includes(\"gzip\") ? \"gzip\" : undefined;\n  if (!encoding)\n    return responseBody;\n\n  res.set(\"Content-Encoding\", encoding);\n\n  const brotliOptions: BrotliOptions = {\n    params: {\n      // Experimentation revealed that the default compression quality significantly increases the compression time for larger texts.\n      // Reducing the quality improves speed substantially without a significant loss in the compression ratio.\n      [zlibConstants.BROTLI_PARAM_QUALITY]: 3,\n    },\n  };\n\n  if (responseBody instanceof Stream) {\n    const compressStream = encoding === \"br\" ? createBrotliCompress(brotliOptions) : createGzip();\n    return responseBody.pipe(compressStream);\n  }\n\n  return encoding === \"br\" ? promisify(brotliCompress)(responseBody, brotliOptions) : promisify(gzip)(responseBody);\n}\n\n/** @internal */\nexport async function sendResponse(protocol: WebAppRpcProtocol, request: SerializedRpcRequest, fulfillment: RpcRequestFulfillment, req: HttpServerRequest, res: HttpServerResponse) {\n  logResponse(request, fulfillment.status, fulfillment.rawResult);\n\n  const versionHeader = protocol.protocolVersionHeaderName;\n  if (versionHeader && RpcProtocol.protocolVersion) {\n    res.set(versionHeader, RpcProtocol.protocolVersion.toString());\n  }\n\n  const transportType = WebAppRpcRequest.computeTransportType(fulfillment.result, fulfillment.rawResult);\n  let responseBody;\n  if (transportType === RpcContentType.Binary) {\n    responseBody = configureBinary(fulfillment, res);\n  } else if (transportType === RpcContentType.Multipart) {\n    responseBody = configureMultipart(fulfillment, res);\n  } else if (transportType === RpcContentType.Stream) {\n    responseBody = configureStream(fulfillment);\n  } else {\n    responseBody = configureText(fulfillment, res);\n  }\n\n  configureResponse(protocol, request, fulfillment, res);\n  res.status(fulfillment.status);\n\n  if (fulfillment.allowCompression)\n    responseBody = await configureEncoding(req, res, responseBody);\n\n  // This check should in theory look for instances of Readable, but that would break backend implementation at\n  // core/backend/src/RpcBackend.ts\n  if (responseBody instanceof Stream) {\n    responseBody.pipe(res);\n  } else {\n    res.send(responseBody);\n  }\n}\n\nfunction logResponse(request: SerializedRpcRequest, statusCode: number, resultObj: unknown) {\n  const metadata = {\n    ActivityId: request.id, // eslint-disable-line @typescript-eslint/naming-convention\n    method: request.method,\n    path: request.path,\n    operation: request.operation,\n    statusCode,\n    errorObj: resultObj instanceof Error ? BentleyError.getErrorProps(resultObj) : undefined,\n  };\n\n  if (statusCode < 400)\n    Logger.logInfo(CommonLoggerCategory.RpcInterfaceBackend, \"RPC over HTTP success response\", metadata);\n  else\n    Logger.logError(CommonLoggerCategory.RpcInterfaceBackend, \"RPC over HTTP failure response\", metadata);\n}\n"]}

package/lib/esm/rpc-impl/DevToolsRpcImpl.d.ts

@@ -0,0 +1,16 @@
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { LogLevel } from "@itwin/core-bentley";
+import { DevToolsRpcInterface, DevToolsStatsOptions, IModelRpcProps, RpcInterface } from "@itwin/core-common";
+/** The backend implementation of DevToolsRpcInterface.
+ * @internal
+ */
+export declare class DevToolsRpcImpl extends RpcInterface implements DevToolsRpcInterface {
+    static register(): void;
+    ping(_tokenProps: IModelRpcProps): Promise<boolean>;
+    stats(_tokenProps: IModelRpcProps, options: DevToolsStatsOptions): Promise<any>;
+    versions(_tokenProps: IModelRpcProps): Promise<any>;
+    setLogLevel(_tokenProps: IModelRpcProps, loggerCategory: string, logLevel: LogLevel): Promise<LogLevel | undefined>;
+}
+//# sourceMappingURL=DevToolsRpcImpl.d.ts.map

package/lib/esm/rpc-impl/DevToolsRpcImpl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DevToolsRpcImpl.d.ts","sourceRoot":"","sources":["../../../src/rpc-impl/DevToolsRpcImpl.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,cAAc,EAAE,YAAY,EAAc,MAAM,oBAAoB,CAAC;AAG1H;;GAEG;AACH,qBAAa,eAAgB,SAAQ,YAAa,YAAW,oBAAoB;WACjE,QAAQ;IAGT,IAAI,CAAC,WAAW,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAKnD,KAAK,CAAC,WAAW,EAAE,cAAc,EAAE,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,GAAG,CAAC;IAS/E,QAAQ,CAAC,WAAW,EAAE,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC;IAKnD,WAAW,CAAC,WAAW,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;CAGjI"}

package/lib/esm/rpc-impl/DevToolsRpcImpl.js

@@ -0,0 +1,29 @@
+import { DevToolsRpcInterface, DevToolsStatsOptions, RpcInterface, RpcManager } from "@itwin/core-common";
+import { DevTools, DevToolsStatsFormatter } from "../DevTools";
+/** The backend implementation of DevToolsRpcInterface.
+ * @internal
+ */
+export class DevToolsRpcImpl extends RpcInterface {
+    static register() { RpcManager.registerImpl(DevToolsRpcInterface, DevToolsRpcImpl); }
+    // Returns true if the backend received the ping
+    async ping(_tokenProps) {
+        return DevTools.ping();
+    }
+    // Returns JSON object with statistics
+    async stats(_tokenProps, options) {
+        const stats = DevTools.stats();
+        if (options === DevToolsStatsOptions.None)
+            return stats;
+        const formattedStats = DevToolsStatsFormatter.toFormattedJson(stats);
+        return formattedStats;
+    }
+    // Returns JSON object with backend versions (application and iModelJs)
+    async versions(_tokenProps) {
+        return DevTools.versions();
+    }
+    // Sets up a log level at the backend
+    async setLogLevel(_tokenProps, loggerCategory, logLevel) {
+        return DevTools.setLogLevel(loggerCategory, logLevel);
+    }
+}
+//# sourceMappingURL=DevToolsRpcImpl.js.map

package/lib/esm/rpc-impl/DevToolsRpcImpl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DevToolsRpcImpl.js","sourceRoot":"","sources":["../../../src/rpc-impl/DevToolsRpcImpl.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAkB,YAAY,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAC1H,OAAO,EAAE,QAAQ,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAE/D;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,YAAY;IACxC,MAAM,CAAC,QAAQ,KAAK,UAAU,CAAC,YAAY,CAAC,oBAAoB,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;IAE5F,gDAAgD;IACzC,KAAK,CAAC,IAAI,CAAC,WAA2B;QAC3C,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;IAED,sCAAsC;IAC/B,KAAK,CAAC,KAAK,CAAC,WAA2B,EAAE,OAA6B;QAC3E,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;QAC/B,IAAI,OAAO,KAAK,oBAAoB,CAAC,IAAI;YACvC,OAAO,KAAK,CAAC;QACf,MAAM,cAAc,GAAG,sBAAsB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QACrE,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,uEAAuE;IAChE,KAAK,CAAC,QAAQ,CAAC,WAA2B;QAC/C,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED,qCAAqC;IAC9B,KAAK,CAAC,WAAW,CAAC,WAA2B,EAAE,cAAsB,EAAE,QAAkB;QAC9F,OAAO,QAAQ,CAAC,WAAW,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;IACxD,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module RpcInterface\n */\nimport { LogLevel } from \"@itwin/core-bentley\";\nimport { DevToolsRpcInterface, DevToolsStatsOptions, IModelRpcProps, RpcInterface, RpcManager } from \"@itwin/core-common\";\nimport { DevTools, DevToolsStatsFormatter } from \"../DevTools\";\n\n/** The backend implementation of DevToolsRpcInterface.\n * @internal\n */\nexport class DevToolsRpcImpl extends RpcInterface implements DevToolsRpcInterface {\n  public static register() { RpcManager.registerImpl(DevToolsRpcInterface, DevToolsRpcImpl); }\n\n  // Returns true if the backend received the ping\n  public async ping(_tokenProps: IModelRpcProps): Promise<boolean> {\n    return DevTools.ping();\n  }\n\n  // Returns JSON object with statistics\n  public async stats(_tokenProps: IModelRpcProps, options: DevToolsStatsOptions): Promise<any> {\n    const stats = DevTools.stats();\n    if (options === DevToolsStatsOptions.None)\n      return stats;\n    const formattedStats = DevToolsStatsFormatter.toFormattedJson(stats);\n    return formattedStats;\n  }\n\n  // Returns JSON object with backend versions (application and iModelJs)\n  public async versions(_tokenProps: IModelRpcProps): Promise<any> {\n    return DevTools.versions();\n  }\n\n  // Sets up a log level at the backend\n  public async setLogLevel(_tokenProps: IModelRpcProps, loggerCategory: string, logLevel: LogLevel): Promise<LogLevel | undefined> {\n    return DevTools.setLogLevel(loggerCategory, logLevel);\n  }\n}\n"]}

package/lib/esm/rpc-impl/IModelReadRpcImpl.d.ts

@@ -0,0 +1,51 @@
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { CompressedId64Set, GuidString, Id64String } from "@itwin/core-bentley";
+import { CodeProps, CustomViewState3dCreatorOptions, CustomViewState3dProps, DbBlobRequest, DbBlobResponse, DbQueryRequest, DbQueryResponse, ElementLoadOptions, ElementMeshRequestProps, ElementProps, EntityQueryParams, FontMapProps, GeoCoordinatesRequestProps, GeoCoordinatesResponseProps, GeometryContainmentRequestProps, GeometryContainmentResponseProps, GeometrySummaryRequestProps, HydrateViewStateRequestProps, HydrateViewStateResponseProps, IModelConnectionProps, IModelCoordinatesRequestProps, IModelCoordinatesResponseProps, IModelReadRpcInterface, IModelRpcOpenProps, IModelRpcProps, MassPropertiesPerCandidateRequestProps, MassPropertiesPerCandidateResponseProps, MassPropertiesRequestProps, MassPropertiesResponseProps, ModelExtentsProps, ModelProps, RpcInterface, SnapRequestProps, SnapResponseProps, SubCategoryResultRow, TextureData, TextureLoadProps, ViewStateLoadProps, ViewStateProps } from "@itwin/core-common";
+import { Range3dProps } from "@itwin/core-geometry";
+/** The backend implementation of IModelReadRpcInterface.
+ * @internal
+ */
+export declare class IModelReadRpcImpl extends RpcInterface implements IModelReadRpcInterface {
+    static register(): void;
+    getConnectionProps(tokenProps: IModelRpcOpenProps): Promise<IModelConnectionProps>;
+    getCustomViewState3dData(tokenProps: IModelRpcProps, options: CustomViewState3dCreatorOptions): Promise<CustomViewState3dProps>;
+    hydrateViewState(tokenProps: IModelRpcProps, options: HydrateViewStateRequestProps): Promise<HydrateViewStateResponseProps>;
+    queryAllUsedSpatialSubCategories(tokenProps: IModelRpcProps): Promise<SubCategoryResultRow[]>;
+    querySubCategories(tokenProps: IModelRpcProps, compressedCategoryIds: CompressedId64Set): Promise<SubCategoryResultRow[]>;
+    queryRows(tokenProps: IModelRpcProps, request: DbQueryRequest): Promise<DbQueryResponse>;
+    queryBlob(tokenProps: IModelRpcProps, request: DbBlobRequest): Promise<DbBlobResponse>;
+    queryModelRanges(tokenProps: IModelRpcProps, modelIds: Id64String[]): Promise<Range3dProps[]>;
+    queryModelExtents(tokenProps: IModelRpcProps, modelIds: Id64String[]): Promise<ModelExtentsProps[]>;
+    getModelProps(tokenProps: IModelRpcProps, modelIdsList: Id64String[]): Promise<ModelProps[]>;
+    queryModelProps(tokenProps: IModelRpcProps, params: EntityQueryParams): Promise<ModelProps[]>;
+    getElementProps(tokenProps: IModelRpcProps, elementIdsList: Id64String[]): Promise<ElementProps[]>;
+    loadElementProps(tokenProps: IModelRpcProps, identifier: Id64String | GuidString | CodeProps, options?: ElementLoadOptions): Promise<ElementProps | undefined>;
+    getGeometrySummary(tokenProps: IModelRpcProps, request: GeometrySummaryRequestProps): Promise<string>;
+    queryElementProps(tokenProps: IModelRpcProps, params: EntityQueryParams): Promise<ElementProps[]>;
+    queryEntityIds(tokenProps: IModelRpcProps, params: EntityQueryParams): Promise<Id64String[]>;
+    getClassHierarchy(tokenProps: IModelRpcProps, classFullName: string): Promise<string[]>;
+    getAllCodeSpecs(tokenProps: IModelRpcProps): Promise<any[]>;
+    getViewStateData(tokenProps: IModelRpcProps, viewDefinitionId: string, options?: ViewStateLoadProps): Promise<ViewStateProps>;
+    readFontJson(tokenProps: IModelRpcProps): Promise<FontMapProps>;
+    requestSnap(tokenProps: IModelRpcProps, sessionId: string, props: SnapRequestProps): Promise<SnapResponseProps>;
+    cancelSnap(tokenProps: IModelRpcProps, sessionId: string): Promise<void>;
+    getGeometryContainment(tokenProps: IModelRpcProps, props: GeometryContainmentRequestProps): Promise<GeometryContainmentResponseProps>;
+    getMassProperties(tokenProps: IModelRpcProps, props: MassPropertiesRequestProps): Promise<MassPropertiesResponseProps>;
+    getMassPropertiesPerCandidate(tokenProps: IModelRpcProps, props: MassPropertiesPerCandidateRequestProps): Promise<MassPropertiesPerCandidateResponseProps[]>;
+    getToolTipMessage(tokenProps: IModelRpcProps, id: string): Promise<string[]>;
+    /** Send a view thumbnail to the frontend. This is a binary transfer with the metadata in a 16-byte prefix header.
+     * @deprecated in 3.x - Use queryViewThumbnail instead
+     */
+    getViewThumbnail(tokenProps: IModelRpcProps, viewId: string): Promise<Uint8Array>;
+    getDefaultViewId(tokenProps: IModelRpcProps): Promise<Id64String>;
+    getSpatialCategoryId(tokenProps: IModelRpcProps, categoryName: string): Promise<Id64String | undefined>;
+    getIModelCoordinatesFromGeoCoordinates(tokenProps: IModelRpcProps, props: IModelCoordinatesRequestProps): Promise<IModelCoordinatesResponseProps>;
+    getGeoCoordinatesFromIModelCoordinates(tokenProps: IModelRpcProps, props: GeoCoordinatesRequestProps): Promise<GeoCoordinatesResponseProps>;
+    queryTextureData(tokenProps: IModelRpcProps, textureLoadProps: TextureLoadProps): Promise<TextureData | undefined>;
+    generateElementMeshes(tokenProps: IModelRpcProps, props: ElementMeshRequestProps): Promise<Uint8Array>;
+    /** @internal */
+    callViewStore(tokenProps: IModelRpcProps, version: string, forWrite: boolean, methodName: string, ...args: any[]): Promise<any>;
+}
+//# sourceMappingURL=IModelReadRpcImpl.d.ts.map

package/lib/esm/rpc-impl/IModelReadRpcImpl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelReadRpcImpl.d.ts","sourceRoot":"","sources":["../../../src/rpc-impl/IModelReadRpcImpl.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAC2C,iBAAiB,EAAE,UAAU,EAAQ,UAAU,EAChG,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACC,SAAS,EAAE,+BAA+B,EAAE,sBAAsB,EAAE,aAAa,EAAE,cAAc,EAAE,cAAc,EAAE,eAAe,EACxI,kBAAkB,EAAoB,uBAAuB,EAAE,YAAY,EAAkB,iBAAiB,EAAE,YAAY,EAC5H,0BAA0B,EAAE,2BAA2B,EAAE,+BAA+B,EAAE,gCAAgC,EAC1H,2BAA2B,EAAE,4BAA4B,EAAE,6BAA6B,EAA6B,qBAAqB,EAC1I,6BAA6B,EAAE,8BAA8B,EAAe,sBAAsB,EAAE,kBAAkB,EAAE,cAAc,EACtI,sCAAsC,EAAE,uCAAuC,EAAE,0BAA0B,EAAE,2BAA2B,EACxI,iBAAiB,EAAE,UAAU,EAAkB,YAAY,EAAkC,gBAAgB,EAAE,iBAAiB,EAChI,oBAAoB,EAAY,WAAW,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,cAAc,EAElG,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AA6EpD;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,YAAa,YAAW,sBAAsB;WAErE,QAAQ;IAET,kBAAkB,CAAC,UAAU,EAAE,kBAAkB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAIlF,wBAAwB,CAAC,UAAU,EAAE,cAAc,EAAE,OAAO,EAAE,+BAA+B,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAK/H,gBAAgB,CAAC,UAAU,EAAE,cAAc,EAAE,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAM3H,gCAAgC,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAK7F,kBAAkB,CAAC,UAAU,EAAE,cAAc,EAAE,qBAAqB,EAAE,iBAAiB,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAMzH,SAAS,CAAC,UAAU,EAAE,cAAc,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IASxF,SAAS,CAAC,UAAU,EAAE,cAAc,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAStF,gBAAgB,CAAC,UAAU,EAAE,cAAc,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAQ7F,iBAAiB,CAAC,UAAU,EAAE,cAAc,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAKnG,aAAa,CAAC,UAAU,EAAE,cAAc,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAgB5F,eAAe,CAAC,UAAU,EAAE,cAAc,EAAE,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAK7F,eAAe,CAAC,UAAU,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAelG,gBAAgB,CAAC,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IAe9J,kBAAkB,CAAC,UAAU,EAAE,cAAc,EAAE,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,MAAM,CAAC;IAKrG,iBAAiB,CAAC,UAAU,EAAE,cAAc,EAAE,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAMjG,cAAc,CAAC,UAAU,EAAE,cAAc,EAAE,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAM5F,iBAAiB,CAAC,UAAU,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAevF,eAAe,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAU3D,gBAAgB,CAAC,UAAU,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,cAAc,CAAC;IAK7H,YAAY,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAK/D,WAAW,CAAC,UAAU,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAK/G,UAAU,CAAC,UAAU,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKxE,sBAAsB,CAAC,UAAU,EAAE,cAAc,EAAE,KAAK,EAAE,+BAA+B,GAAG,OAAO,CAAC,gCAAgC,CAAC;IAKrI,iBAAiB,CAAC,UAAU,EAAE,cAAc,EAAE,KAAK,EAAE,0BAA0B,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAKtH,6BAA6B,CAAC,UAAU,EAAE,cAAc,EAAE,KAAK,EAAE,sCAAsC,GAAG,OAAO,CAAC,uCAAuC,EAAE,CAAC;IAoC5J,iBAAiB,CAAC,UAAU,EAAE,cAAc,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAMzF;;OAEG;IACU,gBAAgB,CAAC,UAAU,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAYjF,gBAAgB,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC;IAUjE,oBAAoB,CAAC,UAAU,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAMvG,sCAAsC,CAAC,UAAU,EAAE,cAAc,EAAE,KAAK,EAAE,6BAA6B,GAAG,OAAO,CAAC,8BAA8B,CAAC;IAKjJ,sCAAsC,CAAC,UAAU,EAAE,cAAc,EAAE,KAAK,EAAE,0BAA0B,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAK3I,gBAAgB,CAAC,UAAU,EAAE,cAAc,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAKlH,qBAAqB,CAAC,UAAU,EAAE,cAAc,EAAE,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,UAAU,CAAC;IAKnH,gBAAgB;IACH,aAAa,CAAC,UAAU,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;CAc7I"}

package/lib/esm/rpc-impl/IModelReadRpcImpl.js

@@ -0,0 +1,313 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { assert, BeDuration, BentleyStatus, CompressedId64Set, Id64, IModelStatus, Logger, } from "@itwin/core-bentley";
+import { Code, ImageSourceFormat, IModel, IModelError, IModelReadRpcInterface, NoContentError, RpcInterface, RpcManager, RpcPendingResponse, SyncMode, ViewStoreRpc, } from "@itwin/core-common";
+import { BackendLoggerCategory } from "../BackendLoggerCategory";
+import { SpatialCategory } from "../Category";
+import { ConcurrentQuery } from "../ConcurrentQuery";
+import { CustomViewState3dCreator } from "../CustomViewState3dCreator";
+import { generateGeometrySummaries } from "../GeometrySummary";
+import { PromiseMemoizer } from "../PromiseMemoizer";
+import { RpcTrace } from "../rpc/tracing";
+import { ViewStateHydrator } from "../ViewStateHydrator";
+import { RpcBriefcaseUtility } from "./RpcBriefcaseUtility";
+import { _nativeDb } from "../internal/Symbols";
+class ViewStateRequestMemoizer extends PromiseMemoizer {
+    _timeoutMs;
+    static _instance;
+    static async perform(props) {
+        if (!this._instance)
+            this._instance = new ViewStateRequestMemoizer();
+        return this._instance.perform(props);
+    }
+    constructor() {
+        const memoize = async (props) => {
+            const db = await RpcBriefcaseUtility.findOpenIModel(props.accessToken, props.tokenProps);
+            const viewCreator = new CustomViewState3dCreator(db);
+            return viewCreator.getCustomViewState3dData(props.options);
+        };
+        const stringify = (props) => {
+            const token = props.tokenProps;
+            const modelIds = props.options.modelIds;
+            return `${token.key}-${token.iTwinId}-${token.iModelId}-${token.changeset?.id}:${modelIds}`;
+        };
+        super(memoize, stringify);
+        this._timeoutMs = 20 * 1000;
+    }
+    async perform(props) {
+        const memo = this.memoize(props);
+        // Rejections must be caught so that the memoization entry is deleted.
+        await BeDuration.race(this._timeoutMs, memo.promise).catch(() => undefined);
+        if (memo.isPending)
+            throw new RpcPendingResponse(); // eslint-disable-line @typescript-eslint/only-throw-error
+        this.deleteMemoized(props);
+        if (memo.isFulfilled) {
+            assert(undefined !== memo.result);
+            return memo.result;
+        }
+        assert(memo.isRejected);
+        throw memo.error;
+    }
+}
+function currentActivity() {
+    return RpcTrace.expectCurrentActivity;
+}
+async function getIModelForRpc(tokenProps) {
+    return RpcBriefcaseUtility.findOpenIModel(RpcTrace.expectCurrentActivity.accessToken, tokenProps);
+}
+/** The backend implementation of IModelReadRpcInterface.
+ * @internal
+ */
+export class IModelReadRpcImpl extends RpcInterface {
+    static register() { RpcManager.registerImpl(IModelReadRpcInterface, IModelReadRpcImpl); }
+    async getConnectionProps(tokenProps) {
+        return RpcBriefcaseUtility.openWithTimeout(currentActivity(), tokenProps, SyncMode.FixedVersion);
+    }
+    async getCustomViewState3dData(tokenProps, options) {
+        const accessToken = currentActivity().accessToken;
+        return ViewStateRequestMemoizer.perform({ accessToken, tokenProps, options });
+    }
+    async hydrateViewState(tokenProps, options) {
+        const iModelDb = await getIModelForRpc(tokenProps);
+        const viewHydrater = new ViewStateHydrator(iModelDb);
+        return viewHydrater.getHydrateResponseProps(options);
+    }
+    async queryAllUsedSpatialSubCategories(tokenProps) {
+        const iModelDb = await getIModelForRpc(tokenProps);
+        return iModelDb.queryAllUsedSpatialSubCategories();
+    }
+    async querySubCategories(tokenProps, compressedCategoryIds) {
+        const iModelDb = await getIModelForRpc(tokenProps);
+        const decompressedIds = CompressedId64Set.decompressArray(compressedCategoryIds);
+        return iModelDb.querySubCategories(decompressedIds);
+    }
+    async queryRows(tokenProps, request) {
+        const iModelDb = await getIModelForRpc(tokenProps);
+        if (iModelDb.isReadonly && request.usePrimaryConn === true) {
+            Logger.logWarning(BackendLoggerCategory.IModelDb, "usePrimaryConn is only supported on imodel that is opened in read/write mode. The option will be ignored.", request);
+            request.usePrimaryConn = false;
+        }
+        return ConcurrentQuery.executeQueryRequest(iModelDb[_nativeDb], request);
+    }
+    async queryBlob(tokenProps, request) {
+        const iModelDb = await getIModelForRpc(tokenProps);
+        if (iModelDb.isReadonly && request.usePrimaryConn === true) {
+            Logger.logWarning(BackendLoggerCategory.IModelDb, "usePrimaryConn is only supported on imodel that is opened in read/write mode. The option will be ignored.", request);
+            request.usePrimaryConn = false;
+        }
+        return ConcurrentQuery.executeBlobRequest(iModelDb[_nativeDb], request);
+    }
+    async queryModelRanges(tokenProps, modelIds) {
+        const results = await this.queryModelExtents(tokenProps, modelIds);
+        if (results.length === 1 && results[0].status !== IModelStatus.Success)
+            throw new IModelError(results[0].status, "error querying model range");
+        return results.filter((x) => x.status === IModelStatus.Success).map((x) => x.extents);
+    }
+    async queryModelExtents(tokenProps, modelIds) {
+        const iModel = await getIModelForRpc(tokenProps);
+        return iModel.models.queryExtents(modelIds);
+    }
+    async getModelProps(tokenProps, modelIdsList) {
+        const modelIds = new Set(modelIdsList);
+        const iModelDb = await getIModelForRpc(tokenProps);
+        const modelJsonArray = [];
+        for (const id of modelIds) {
+            try {
+                const modelProps = iModelDb.models.getModelJson({ id });
+                modelJsonArray.push(modelProps);
+            }
+            catch (error) {
+                if (modelIds.size === 1)
+                    throw error; // if they're asking for more than one model, don't throw on error.
+            }
+        }
+        return modelJsonArray;
+    }
+    async queryModelProps(tokenProps, params) {
+        const ids = await this.queryEntityIds(tokenProps, params);
+        return this.getModelProps(tokenProps, [...ids]);
+    }
+    async getElementProps(tokenProps, elementIdsList) {
+        const elementIds = new Set(elementIdsList);
+        const iModelDb = await getIModelForRpc(tokenProps);
+        const elementProps = [];
+        for (const id of elementIds) {
+            try {
+                elementProps.push(iModelDb.elements.getElementJson({ id }));
+            }
+            catch (error) {
+                if (elementIds.size === 1)
+                    throw error; // if they're asking for more than one element, don't throw on error.
+            }
+        }
+        return elementProps;
+    }
+    async loadElementProps(tokenProps, identifier, options) {
+        const props = options ? { ...options } : {};
+        if (typeof identifier === "string") {
+            if (Id64.isId64(identifier))
+                props.id = identifier;
+            else
+                props.federationGuid = identifier;
+        }
+        else {
+            props.code = Code.fromJSON(identifier);
+        }
+        const iModelDb = await getIModelForRpc(tokenProps);
+        return iModelDb.elements.tryGetElementProps(props);
+    }
+    async getGeometrySummary(tokenProps, request) {
+        const iModel = await getIModelForRpc(tokenProps);
+        return generateGeometrySummaries(request, iModel);
+    }
+    async queryElementProps(tokenProps, params) {
+        const ids = await this.queryEntityIds(tokenProps, params);
+        const res = this.getElementProps(tokenProps, [...ids]);
+        return res;
+    }
+    async queryEntityIds(tokenProps, params) {
+        const iModelDb = await getIModelForRpc(tokenProps);
+        const res = iModelDb.queryEntityIds(params);
+        return [...res];
+    }
+    async getClassHierarchy(tokenProps, classFullName) {
+        const iModelDb = await getIModelForRpc(tokenProps);
+        const classArray = [];
+        while (true) {
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
+            const classMetaData = iModelDb.getMetaData(classFullName);
+            classArray.push(classFullName);
+            if (!classMetaData.baseClasses || classMetaData.baseClasses.length === 0)
+                break;
+            classFullName = classMetaData.baseClasses[0];
+        }
+        return classArray;
+    }
+    async getAllCodeSpecs(tokenProps) {
+        const codeSpecs = [];
+        const iModelDb = await getIModelForRpc(tokenProps);
+        iModelDb.withPreparedStatement("SELECT ECInstanceId AS id, name, jsonProperties FROM BisCore.CodeSpec", (statement) => {
+            for (const row of statement)
+                codeSpecs.push({ id: row.id, name: row.name, jsonProperties: JSON.parse(row.jsonProperties) });
+        });
+        return codeSpecs;
+    }
+    async getViewStateData(tokenProps, viewDefinitionId, options) {
+        const iModelDb = await getIModelForRpc(tokenProps);
+        return iModelDb.views.getViewStateProps(viewDefinitionId, options);
+    }
+    async readFontJson(tokenProps) {
+        const iModelDb = await getIModelForRpc(tokenProps);
+        return iModelDb[_nativeDb].readFontMap();
+    }
+    async requestSnap(tokenProps, sessionId, props) {
+        const iModelDb = await getIModelForRpc(tokenProps);
+        return iModelDb.requestSnap(sessionId, props);
+    }
+    async cancelSnap(tokenProps, sessionId) {
+        const iModelDb = await getIModelForRpc(tokenProps);
+        return iModelDb.cancelSnap(sessionId);
+    }
+    async getGeometryContainment(tokenProps, props) {
+        const iModelDb = await getIModelForRpc(tokenProps);
+        return iModelDb.getGeometryContainment(props);
+    }
+    async getMassProperties(tokenProps, props) {
+        const iModelDb = await getIModelForRpc(tokenProps);
+        return iModelDb.getMassProperties(props);
+    }
+    async getMassPropertiesPerCandidate(tokenProps, props) {
+        const iModelDb = await getIModelForRpc(tokenProps);
+        const getSingleCandidateMassProperties = async (candidate) => {
+            try {
+                const massPropResults = [];
+                for (const op of props.operations) {
+                    const massProperties = await iModelDb.getMassProperties({ operation: op, candidates: [candidate] });
+                    massPropResults.push(massProperties);
+                }
+                let singleCandidateResult = { status: BentleyStatus.ERROR, candidate }; // eslint-disable-line @typescript-eslint/no-deprecated
+                if (massPropResults.some((r) => r.status !== BentleyStatus.ERROR)) {
+                    singleCandidateResult.status = BentleyStatus.SUCCESS;
+                    for (const r of massPropResults.filter((mpr) => mpr.status !== BentleyStatus.ERROR)) {
+                        singleCandidateResult = { ...singleCandidateResult, ...r };
+                    }
+                }
+                return singleCandidateResult;
+            }
+            catch {
+                return { status: BentleyStatus.ERROR, candidate };
+            }
+        };
+        const promises = []; // eslint-disable-line @typescript-eslint/no-deprecated
+        for (const candidate of CompressedId64Set.iterable(props.candidates)) {
+            promises.push(getSingleCandidateMassProperties(candidate));
+        }
+        return Promise.all(promises);
+    }
+    async getToolTipMessage(tokenProps, id) {
+        const iModelDb = await getIModelForRpc(tokenProps);
+        const el = iModelDb.elements.getElement(id);
+        return (el === undefined) ? [] : el.getToolTipMessage();
+    }
+    /** Send a view thumbnail to the frontend. This is a binary transfer with the metadata in a 16-byte prefix header.
+     * @deprecated in 3.x - Use queryViewThumbnail instead
+     */
+    async getViewThumbnail(tokenProps, viewId) {
+        const iModelDb = await getIModelForRpc(tokenProps);
+        const thumbnail = iModelDb.views.getThumbnail(viewId);
+        if (undefined === thumbnail || 0 === thumbnail.image.length)
+            throw new NoContentError();
+        const val = new Uint8Array(thumbnail.image.length + 16); // allocate a new buffer 16 bytes larger than the image size
+        new Uint32Array(val.buffer, 0, 4).set([thumbnail.image.length, thumbnail.format === "jpeg" ? ImageSourceFormat.Jpeg : ImageSourceFormat.Png, thumbnail.width, thumbnail.height]); // Put the metadata in the first 16 bytes.
+        val.set(thumbnail.image, 16); // put the image data at offset 16 after metadata
+        return val;
+    }
+    async getDefaultViewId(tokenProps) {
+        const iModelDb = await getIModelForRpc(tokenProps);
+        const spec = { namespace: "dgn_View", name: "DefaultView" };
+        const blob = iModelDb.queryFilePropertyBlob(spec);
+        if (undefined === blob || 8 !== blob.length)
+            return Id64.invalid;
+        const view = new Uint32Array(blob.buffer);
+        return Id64.fromUint32Pair(view[0], view[1]);
+    }
+    async getSpatialCategoryId(tokenProps, categoryName) {
+        const iModelDb = await getIModelForRpc(tokenProps);
+        const dictionary = iModelDb.models.getModel(IModel.dictionaryId);
+        return SpatialCategory.queryCategoryIdByName(iModelDb, dictionary.id, categoryName);
+    }
+    async getIModelCoordinatesFromGeoCoordinates(tokenProps, props) {
+        const iModelDb = await getIModelForRpc(tokenProps);
+        return iModelDb.getIModelCoordinatesFromGeoCoordinates(props);
+    }
+    async getGeoCoordinatesFromIModelCoordinates(tokenProps, props) {
+        const iModelDb = await getIModelForRpc(tokenProps);
+        return iModelDb.getGeoCoordinatesFromIModelCoordinates(props);
+    }
+    async queryTextureData(tokenProps, textureLoadProps) {
+        const db = await getIModelForRpc(tokenProps);
+        return db.queryTextureData(textureLoadProps);
+    }
+    async generateElementMeshes(tokenProps, props) {
+        const db = await getIModelForRpc(tokenProps);
+        return db[_nativeDb].generateElementMeshes(props);
+    }
+    /** @internal */
+    async callViewStore(tokenProps, version, forWrite, methodName, ...args) {
+        if (!RpcInterface.isVersionCompatible(ViewStoreRpc.version, version))
+            throw new Error("ViewStoreRpc version mismatch");
+        const db = await getIModelForRpc(tokenProps);
+        const viewStore = await db.views.accessViewStore({ accessLevel: forWrite ? "write" : "read" });
+        const access = viewStore[forWrite ? "writeLocker" : "reader"];
+        const func = access[methodName];
+        if (typeof func !== "function")
+            throw new IModelError(IModelStatus.FunctionNotFound, `Illegal ViewStore RPC call "${methodName}"`);
+        return func.call(access, ...args);
+    }
+}
+//# sourceMappingURL=IModelReadRpcImpl.js.map