@itwin/core-backend 4.0.0-dev.24 → 4.0.0-dev.28

package/lib/cjs/rpc/web/logging.js.map

@@ -1 +1 @@
-{"version":3,"file":"logging.js","sourceRoot":"","sources":["../../../../src/rpc/web/logging.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6C;AAC7C,oDAA6G;AAC7G,yBAAyB;AAEzB,4CAA4C;AAE5C,MAAa,uBAAwB,SAAQ,8BAAgB;IACxC,KAAK,CAAC,gBAAgB,CAAC,KAAuB,EAAE,MAAqB;QACtF,QAAQ,KAAK,EAAE;YACb,KAAK,8BAAgB,CAAC,eAAe,CAAC,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,kCAAoB,CAAC,mBAAmB,EAAE,8BAA8B,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;YACxJ,KAAK,8BAAgB,CAAC,oBAAoB,CAAC,CAAC,OAAO,IAAI,CAAC,eAAe,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;YAC9G,KAAK,8BAAgB,CAAC,sBAAsB,CAAC,CAAC,OAAO,IAAI,CAAC,WAAW,CAAC,kCAAoB,CAAC,mBAAmB,EAAE,+BAA+B,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;SACjM;IACH,CAAC;IAEkB,WAAW;QAC5B,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC;IACvB,CAAC;IAEO,KAAK,CAAC,eAAe,CAAC,OAAe,EAAE,UAAyB;QACtE,MAAM,mBAAmB,GAAG,IAAI,CAAC,wBAAwB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAChF,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC;QACvC,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,2CAA2C;QAElH,qBAAM,CAAC,OAAO,CAAC,kCAAoB,CAAC,mBAAmB,EAAE,GAAG,OAAO,IAAI,mBAAmB,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;YACnG,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,MAAM;YACjC,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,IAAI;YAC7B,MAAM,EAAE,UAAU,CAAC,MAAM;YACzB,YAAY;YACZ,uGAAuG;YACvG,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE;YACjC,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE;YAC/B,GAAG,OAAO;SACX,CAAC,CAAC,CAAC;IACN,CAAC;CACF;AA9BD,0DA8BC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module RpcInterface\r\n */\r\n\r\nimport { Logger } from \"@itwin/core-bentley\";\r\nimport { CommonLoggerCategory, RpcInvocation, RpcProtocolEvent, WebAppRpcLogging } from \"@itwin/core-common\";\r\nimport * as os from \"os\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\nexport class WebAppRpcLoggingBackend extends WebAppRpcLogging {\r\n  protected override async logProtocolEvent(event: RpcProtocolEvent, object: RpcInvocation): Promise<void> {\r\n    switch (event) {\r\n      case RpcProtocolEvent.RequestReceived: return this.logRequest(CommonLoggerCategory.RpcInterfaceBackend, \"RpcInterface.backend.request\", object.request);\r\n      case RpcProtocolEvent.BackendErrorOccurred: return this.logErrorBackend(\"RpcInterface.backend.error\", object);\r\n      case RpcProtocolEvent.BackendResponseCreated: return this.logResponse(CommonLoggerCategory.RpcInterfaceBackend, \"RpcInterface.backend.response\", object.request, object.status, object.elapsed);\r\n    }\r\n  }\r\n\r\n  protected override getHostname(): string {\r\n    return os.hostname();\r\n  }\r\n\r\n  private async logErrorBackend(message: string, invocation: RpcInvocation): Promise<void> {\r\n    const operationDescriptor = this.buildOperationDescriptor(invocation.operation);\r\n    const pathIds = this.findPathIds(invocation.request.path);\r\n    const result = await invocation.result;\r\n    const errorMessage = result.message ? result.message : result.objects; // Can be an error or an RpcSerializedValue\r\n\r\n    Logger.logInfo(CommonLoggerCategory.RpcInterfaceBackend, `${message}.${operationDescriptor}`, () => ({\r\n      method: invocation.request.method,\r\n      path: invocation.request.path,\r\n      status: invocation.status,\r\n      errorMessage,\r\n      // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!\r\n      ActivityId: invocation.request.id, // eslint-disable-line @typescript-eslint/naming-convention\r\n      MachineName: this.getHostname(), // eslint-disable-line @typescript-eslint/naming-convention\r\n      ...pathIds,\r\n    }));\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"logging.js","sourceRoot":"","sources":["../../../../src/rpc/web/logging.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6C;AAC7C,oDAA6G;AAC7G,yBAAyB;AAEzB,4CAA4C;AAE5C,MAAa,uBAAwB,SAAQ,8BAAgB;IACxC,KAAK,CAAC,gBAAgB,CAAC,KAAuB,EAAE,MAAqB;QACtF,QAAQ,KAAK,EAAE;YACb,KAAK,8BAAgB,CAAC,eAAe,CAAC,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,kCAAoB,CAAC,mBAAmB,EAAE,8BAA8B,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;YACxJ,KAAK,8BAAgB,CAAC,oBAAoB,CAAC,CAAC,OAAO,IAAI,CAAC,eAAe,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;YAC9G,KAAK,8BAAgB,CAAC,sBAAsB,CAAC,CAAC,OAAO,IAAI,CAAC,WAAW,CAAC,kCAAoB,CAAC,mBAAmB,EAAE,+BAA+B,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;SACjM;IACH,CAAC;IAEkB,WAAW;QAC5B,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC;IACvB,CAAC;IAEO,KAAK,CAAC,eAAe,CAAC,OAAe,EAAE,UAAyB;QACtE,MAAM,mBAAmB,GAAG,IAAI,CAAC,wBAAwB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAChF,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC;QACvC,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,2CAA2C;QAElH,qBAAM,CAAC,OAAO,CAAC,kCAAoB,CAAC,mBAAmB,EAAE,GAAG,OAAO,IAAI,mBAAmB,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;YACnG,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,MAAM;YACjC,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,IAAI;YAC7B,MAAM,EAAE,UAAU,CAAC,MAAM;YACzB,YAAY;YACZ,uGAAuG;YACvG,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE;YACjC,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE;YAC/B,GAAG,OAAO;SACX,CAAC,CAAC,CAAC;IACN,CAAC;CACF;AA9BD,0DA8BC","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 { Logger } from \"@itwin/core-bentley\";\nimport { CommonLoggerCategory, RpcInvocation, RpcProtocolEvent, WebAppRpcLogging } from \"@itwin/core-common\";\nimport * as os from \"os\";\n\n/* eslint-disable deprecation/deprecation */\n\nexport class WebAppRpcLoggingBackend extends WebAppRpcLogging {\n  protected override async logProtocolEvent(event: RpcProtocolEvent, object: RpcInvocation): Promise<void> {\n    switch (event) {\n      case RpcProtocolEvent.RequestReceived: return this.logRequest(CommonLoggerCategory.RpcInterfaceBackend, \"RpcInterface.backend.request\", object.request);\n      case RpcProtocolEvent.BackendErrorOccurred: return this.logErrorBackend(\"RpcInterface.backend.error\", object);\n      case RpcProtocolEvent.BackendResponseCreated: return this.logResponse(CommonLoggerCategory.RpcInterfaceBackend, \"RpcInterface.backend.response\", object.request, object.status, object.elapsed);\n    }\n  }\n\n  protected override getHostname(): string {\n    return os.hostname();\n  }\n\n  private async logErrorBackend(message: string, invocation: RpcInvocation): Promise<void> {\n    const operationDescriptor = this.buildOperationDescriptor(invocation.operation);\n    const pathIds = this.findPathIds(invocation.request.path);\n    const result = await invocation.result;\n    const errorMessage = result.message ? result.message : result.objects; // Can be an error or an RpcSerializedValue\n\n    Logger.logInfo(CommonLoggerCategory.RpcInterfaceBackend, `${message}.${operationDescriptor}`, () => ({\n      method: invocation.request.method,\n      path: invocation.request.path,\n      status: invocation.status,\n      errorMessage,\n      // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!\n      ActivityId: invocation.request.id, // eslint-disable-line @typescript-eslint/naming-convention\n      MachineName: this.getHostname(), // eslint-disable-line @typescript-eslint/naming-convention\n      ...pathIds,\n    }));\n  }\n}\n"]}

package/lib/cjs/rpc/web/request.d.ts

@@ -1,7 +1,7 @@
-/** @packageDocumentation
- * @module RpcInterface
- */
-import { HttpServerRequest, SerializedRpcRequest, WebAppRpcProtocol } from "@itwin/core-common";
-/** @internal */
-export declare function parseRequest(protocol: WebAppRpcProtocol, req: HttpServerRequest): Promise<SerializedRpcRequest>;
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { HttpServerRequest, SerializedRpcRequest, WebAppRpcProtocol } from "@itwin/core-common";
+/** @internal */
+export declare function parseRequest(protocol: WebAppRpcProtocol, req: HttpServerRequest): Promise<SerializedRpcRequest>;
 //# sourceMappingURL=request.d.ts.map

package/lib/cjs/rpc/web/request.js

@@ -1,75 +1,74 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseRequest = void 0;
-const core_common_1 = require("@itwin/core-common");
-/* eslint-disable deprecation/deprecation */
-function parseHeaders(protocol, req) {
-    var _a;
-    const headerNames = protocol.serializedClientRequestContextHeaderNames;
-    const parsedHeaders = {
-        id: req.header(headerNames.id) || "",
-        applicationId: req.header(headerNames.applicationId) || "",
-        applicationVersion: req.header(headerNames.applicationVersion) || "",
-        sessionId: req.header(headerNames.sessionId) || "",
-        authorization: (_a = (headerNames.authorization ? req.header(headerNames.authorization) : "")) !== null && _a !== void 0 ? _a : "",
-    };
-    return parsedHeaders;
-}
-function parseFromPath(operation) {
-    const decoded = operation.encodedRequest ? Buffer.from(operation.encodedRequest, "base64").toString("binary") : "";
-    return core_common_1.RpcSerializedValue.create(decoded);
-}
-async function parseFromBody(req) {
-    const contentType = core_common_1.WebAppRpcProtocol.computeContentType(req.header(core_common_1.WEB_RPC_CONSTANTS.CONTENT));
-    if (contentType === core_common_1.RpcContentType.Binary) {
-        const objects = JSON.stringify([core_common_1.MarshalingBinaryMarker.createDefault()]);
-        const data = [req.body];
-        return core_common_1.RpcSerializedValue.create(objects, data);
-    }
-    else if (contentType === core_common_1.RpcContentType.Multipart) {
-        return core_common_1.RpcMultipart.parseRequest(req);
-    }
-    else {
-        return core_common_1.RpcSerializedValue.create(req.body);
-    }
-}
-/** @internal */
-async function parseRequest(protocol, req) {
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    const operation = protocol.getOperationFromPath(req.url);
-    const parsedHeaders = parseHeaders(protocol, req);
-    const request = {
-        ...parsedHeaders,
-        operation: {
-            interfaceDefinition: operation.interfaceDefinition,
-            operationName: operation.operationName,
-            interfaceVersion: operation.interfaceVersion,
-        },
-        method: req.method,
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        path: req.url,
-        parameters: operation.encodedRequest ? parseFromPath(operation) : await parseFromBody(req),
-        caching: operation.encodedRequest ? core_common_1.RpcResponseCacheControl.Immutable : core_common_1.RpcResponseCacheControl.None,
-    };
-    request.ip = req.ip;
-    request.protocolVersion = 0;
-    if (protocol.protocolVersionHeaderName) {
-        const version = req.header(protocol.protocolVersionHeaderName);
-        if (version) {
-            request.protocolVersion = parseInt(version, 10);
-        }
-    }
-    if (!request.id) {
-        throw new core_common_1.IModelError(core_common_1.BentleyStatus.ERROR, `Invalid request: Missing required activity ID.`);
-    }
-    return request;
-}
-exports.parseRequest = parseRequest;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseRequest = void 0;
+const core_common_1 = require("@itwin/core-common");
+/* eslint-disable deprecation/deprecation */
+function parseHeaders(protocol, req) {
+    const headerNames = protocol.serializedClientRequestContextHeaderNames;
+    const parsedHeaders = {
+        id: req.header(headerNames.id) || "",
+        applicationId: req.header(headerNames.applicationId) || "",
+        applicationVersion: req.header(headerNames.applicationVersion) || "",
+        sessionId: req.header(headerNames.sessionId) || "",
+        authorization: (headerNames.authorization ? req.header(headerNames.authorization) : "") ?? "",
+    };
+    return parsedHeaders;
+}
+function parseFromPath(operation) {
+    const decoded = operation.encodedRequest ? Buffer.from(operation.encodedRequest, "base64").toString("binary") : "";
+    return core_common_1.RpcSerializedValue.create(decoded);
+}
+async function parseFromBody(req) {
+    const contentType = core_common_1.WebAppRpcProtocol.computeContentType(req.header(core_common_1.WEB_RPC_CONSTANTS.CONTENT));
+    if (contentType === core_common_1.RpcContentType.Binary) {
+        const objects = JSON.stringify([core_common_1.MarshalingBinaryMarker.createDefault()]);
+        const data = [req.body];
+        return core_common_1.RpcSerializedValue.create(objects, data);
+    }
+    else if (contentType === core_common_1.RpcContentType.Multipart) {
+        return core_common_1.RpcMultipart.parseRequest(req);
+    }
+    else {
+        return core_common_1.RpcSerializedValue.create(req.body);
+    }
+}
+/** @internal */
+async function parseRequest(protocol, req) {
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const operation = protocol.getOperationFromPath(req.url);
+    const parsedHeaders = parseHeaders(protocol, req);
+    const request = {
+        ...parsedHeaders,
+        operation: {
+            interfaceDefinition: operation.interfaceDefinition,
+            operationName: operation.operationName,
+            interfaceVersion: operation.interfaceVersion,
+        },
+        method: req.method,
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        path: req.url,
+        parameters: operation.encodedRequest ? parseFromPath(operation) : await parseFromBody(req),
+        caching: operation.encodedRequest ? core_common_1.RpcResponseCacheControl.Immutable : core_common_1.RpcResponseCacheControl.None,
+    };
+    request.ip = req.ip;
+    request.protocolVersion = 0;
+    if (protocol.protocolVersionHeaderName) {
+        const version = req.header(protocol.protocolVersionHeaderName);
+        if (version) {
+            request.protocolVersion = parseInt(version, 10);
+        }
+    }
+    if (!request.id) {
+        throw new core_common_1.IModelError(core_common_1.BentleyStatus.ERROR, `Invalid request: Missing required activity ID.`);
+    }
+    return request;
+}
+exports.parseRequest = parseRequest;
 //# sourceMappingURL=request.js.map

package/lib/cjs/rpc/web/request.js.map

@@ -1 +1 @@
-{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../../src/rpc/web/request.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAc4B;AAE5B,4CAA4C;AAE5C,SAAS,YAAY,CAAC,QAA2B,EAAE,GAAsB;;IACvE,MAAM,WAAW,GAA0B,QAAQ,CAAC,yCAAyC,CAAC;IAC9F,MAAM,aAAa,GAA0B;QAC3C,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE;QACpC,aAAa,EAAE,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,IAAI,EAAE;QAC1D,kBAAkB,EAAE,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,IAAI,EAAE;QACpE,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE;QAClD,aAAa,EAAE,MAAA,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,mCAAI,EAAE;KAC9F,CAAC;IACF,OAAO,aAAa,CAAC;AACvB,CAAC;AAED,SAAS,aAAa,CAAC,SAAiC;IACtD,MAAM,OAAO,GAAG,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACnH,OAAO,gCAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAC5C,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,GAAsB;IACjD,MAAM,WAAW,GAAG,+BAAiB,CAAC,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,+BAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;IAChG,IAAI,WAAW,KAAK,4BAAc,CAAC,MAAM,EAAE;QACzC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,oCAAsB,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;QACzE,MAAM,IAAI,GAAG,CAAC,GAAG,CAAC,IAAc,CAAC,CAAC;QAClC,OAAO,gCAAkB,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;KACjD;SAAM,IAAI,WAAW,KAAK,4BAAc,CAAC,SAAS,EAAE;QACnD,OAAO,0BAAY,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;KACvC;SAAM;QACL,OAAO,gCAAkB,CAAC,MAAM,CAAC,GAAG,CAAC,IAAc,CAAC,CAAC;KACtD;AACH,CAAC;AAED,gBAAgB;AACT,KAAK,UAAU,YAAY,CAAC,QAA2B,EAAE,GAAsB;IACpF,oEAAoE;IACpE,MAAM,SAAS,GAAG,QAAQ,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAI,CAAC,CAAC;IAE1D,MAAM,aAAa,GAAG,YAAY,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IAElD,MAAM,OAAO,GAAyB;QACpC,GAAG,aAAa;QAChB,SAAS,EAAE;YACT,mBAAmB,EAAE,SAAS,CAAC,mBAAmB;YAClD,aAAa,EAAE,SAAS,CAAC,aAAa;YACtC,gBAAgB,EAAE,SAAS,CAAC,gBAAgB;SAC7C;QACD,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,oEAAoE;QACpE,IAAI,EAAE,GAAG,CAAC,GAAI;QACd,UAAU,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC;QAC1F,OAAO,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,qCAAuB,CAAC,SAAS,CAAC,CAAC,CAAC,qCAAuB,CAAC,IAAI;KACrG,CAAC;IAEF,OAAO,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,CAAC;IAEpB,OAAO,CAAC,eAAe,GAAG,CAAC,CAAC;IAE5B,IAAI,QAAQ,CAAC,yBAAyB,EAAE;QACtC,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;QAC/D,IAAI,OAAO,EAAE;YACX,OAAO,CAAC,eAAe,GAAG,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;SACjD;KACF;IAED,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE;QACf,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,gDAAgD,CAAC,CAAC;KAC9F;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AApCD,oCAoCC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module RpcInterface\r\n */\r\n\r\nimport {\r\n  BentleyStatus,\r\n  HttpServerRequest,\r\n  IModelError,\r\n  MarshalingBinaryMarker,\r\n  RpcContentType,\r\n  RpcMultipart,\r\n  RpcResponseCacheControl,\r\n  RpcSerializedValue,\r\n  SerializedRpcActivity,\r\n  SerializedRpcOperation,\r\n  SerializedRpcRequest,\r\n  WEB_RPC_CONSTANTS,\r\n  WebAppRpcProtocol,\r\n} from \"@itwin/core-common\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\nfunction parseHeaders(protocol: WebAppRpcProtocol, req: HttpServerRequest): SerializedRpcActivity {\r\n  const headerNames: SerializedRpcActivity = protocol.serializedClientRequestContextHeaderNames;\r\n  const parsedHeaders: SerializedRpcActivity = {\r\n    id: req.header(headerNames.id) || \"\",\r\n    applicationId: req.header(headerNames.applicationId) || \"\",\r\n    applicationVersion: req.header(headerNames.applicationVersion) || \"\",\r\n    sessionId: req.header(headerNames.sessionId) || \"\",\r\n    authorization: (headerNames.authorization ? req.header(headerNames.authorization) : \"\") ?? \"\",\r\n  };\r\n  return parsedHeaders;\r\n}\r\n\r\nfunction parseFromPath(operation: SerializedRpcOperation): RpcSerializedValue {\r\n  const decoded = operation.encodedRequest ? Buffer.from(operation.encodedRequest, \"base64\").toString(\"binary\") : \"\";\r\n  return RpcSerializedValue.create(decoded);\r\n}\r\n\r\nasync function parseFromBody(req: HttpServerRequest): Promise<RpcSerializedValue> {\r\n  const contentType = WebAppRpcProtocol.computeContentType(req.header(WEB_RPC_CONSTANTS.CONTENT));\r\n  if (contentType === RpcContentType.Binary) {\r\n    const objects = JSON.stringify([MarshalingBinaryMarker.createDefault()]);\r\n    const data = [req.body as Buffer];\r\n    return RpcSerializedValue.create(objects, data);\r\n  } else if (contentType === RpcContentType.Multipart) {\r\n    return RpcMultipart.parseRequest(req);\r\n  } else {\r\n    return RpcSerializedValue.create(req.body as string);\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport async function parseRequest(protocol: WebAppRpcProtocol, req: HttpServerRequest): Promise<SerializedRpcRequest> {\r\n  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\r\n  const operation = protocol.getOperationFromPath(req.url!);\r\n\r\n  const parsedHeaders = parseHeaders(protocol, req);\r\n\r\n  const request: SerializedRpcRequest = {\r\n    ...parsedHeaders,\r\n    operation: {\r\n      interfaceDefinition: operation.interfaceDefinition,\r\n      operationName: operation.operationName,\r\n      interfaceVersion: operation.interfaceVersion,\r\n    },\r\n    method: req.method,\r\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\r\n    path: req.url!,\r\n    parameters: operation.encodedRequest ? parseFromPath(operation) : await parseFromBody(req),\r\n    caching: operation.encodedRequest ? RpcResponseCacheControl.Immutable : RpcResponseCacheControl.None,\r\n  };\r\n\r\n  request.ip = req.ip;\r\n\r\n  request.protocolVersion = 0;\r\n\r\n  if (protocol.protocolVersionHeaderName) {\r\n    const version = req.header(protocol.protocolVersionHeaderName);\r\n    if (version) {\r\n      request.protocolVersion = parseInt(version, 10);\r\n    }\r\n  }\r\n\r\n  if (!request.id) {\r\n    throw new IModelError(BentleyStatus.ERROR, `Invalid request: Missing required activity ID.`);\r\n  }\r\n\r\n  return request;\r\n}\r\n"]}
+{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../../src/rpc/web/request.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAc4B;AAE5B,4CAA4C;AAE5C,SAAS,YAAY,CAAC,QAA2B,EAAE,GAAsB;IACvE,MAAM,WAAW,GAA0B,QAAQ,CAAC,yCAAyC,CAAC;IAC9F,MAAM,aAAa,GAA0B;QAC3C,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE;QACpC,aAAa,EAAE,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,IAAI,EAAE;QAC1D,kBAAkB,EAAE,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,IAAI,EAAE;QACpE,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE;QAClD,aAAa,EAAE,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE;KAC9F,CAAC;IACF,OAAO,aAAa,CAAC;AACvB,CAAC;AAED,SAAS,aAAa,CAAC,SAAiC;IACtD,MAAM,OAAO,GAAG,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACnH,OAAO,gCAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAC5C,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,GAAsB;IACjD,MAAM,WAAW,GAAG,+BAAiB,CAAC,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,+BAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;IAChG,IAAI,WAAW,KAAK,4BAAc,CAAC,MAAM,EAAE;QACzC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,oCAAsB,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;QACzE,MAAM,IAAI,GAAG,CAAC,GAAG,CAAC,IAAc,CAAC,CAAC;QAClC,OAAO,gCAAkB,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;KACjD;SAAM,IAAI,WAAW,KAAK,4BAAc,CAAC,SAAS,EAAE;QACnD,OAAO,0BAAY,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;KACvC;SAAM;QACL,OAAO,gCAAkB,CAAC,MAAM,CAAC,GAAG,CAAC,IAAc,CAAC,CAAC;KACtD;AACH,CAAC;AAED,gBAAgB;AACT,KAAK,UAAU,YAAY,CAAC,QAA2B,EAAE,GAAsB;IACpF,oEAAoE;IACpE,MAAM,SAAS,GAAG,QAAQ,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAI,CAAC,CAAC;IAE1D,MAAM,aAAa,GAAG,YAAY,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IAElD,MAAM,OAAO,GAAyB;QACpC,GAAG,aAAa;QAChB,SAAS,EAAE;YACT,mBAAmB,EAAE,SAAS,CAAC,mBAAmB;YAClD,aAAa,EAAE,SAAS,CAAC,aAAa;YACtC,gBAAgB,EAAE,SAAS,CAAC,gBAAgB;SAC7C;QACD,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,oEAAoE;QACpE,IAAI,EAAE,GAAG,CAAC,GAAI;QACd,UAAU,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC;QAC1F,OAAO,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,qCAAuB,CAAC,SAAS,CAAC,CAAC,CAAC,qCAAuB,CAAC,IAAI;KACrG,CAAC;IAEF,OAAO,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,CAAC;IAEpB,OAAO,CAAC,eAAe,GAAG,CAAC,CAAC;IAE5B,IAAI,QAAQ,CAAC,yBAAyB,EAAE;QACtC,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;QAC/D,IAAI,OAAO,EAAE;YACX,OAAO,CAAC,eAAe,GAAG,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;SACjD;KACF;IAED,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE;QACf,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,gDAAgD,CAAC,CAAC;KAC9F;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AApCD,oCAoCC","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 {\n  BentleyStatus,\n  HttpServerRequest,\n  IModelError,\n  MarshalingBinaryMarker,\n  RpcContentType,\n  RpcMultipart,\n  RpcResponseCacheControl,\n  RpcSerializedValue,\n  SerializedRpcActivity,\n  SerializedRpcOperation,\n  SerializedRpcRequest,\n  WEB_RPC_CONSTANTS,\n  WebAppRpcProtocol,\n} from \"@itwin/core-common\";\n\n/* eslint-disable deprecation/deprecation */\n\nfunction parseHeaders(protocol: WebAppRpcProtocol, req: HttpServerRequest): SerializedRpcActivity {\n  const headerNames: SerializedRpcActivity = protocol.serializedClientRequestContextHeaderNames;\n  const parsedHeaders: SerializedRpcActivity = {\n    id: req.header(headerNames.id) || \"\",\n    applicationId: req.header(headerNames.applicationId) || \"\",\n    applicationVersion: req.header(headerNames.applicationVersion) || \"\",\n    sessionId: req.header(headerNames.sessionId) || \"\",\n    authorization: (headerNames.authorization ? req.header(headerNames.authorization) : \"\") ?? \"\",\n  };\n  return parsedHeaders;\n}\n\nfunction parseFromPath(operation: SerializedRpcOperation): RpcSerializedValue {\n  const decoded = operation.encodedRequest ? Buffer.from(operation.encodedRequest, \"base64\").toString(\"binary\") : \"\";\n  return RpcSerializedValue.create(decoded);\n}\n\nasync function parseFromBody(req: HttpServerRequest): Promise<RpcSerializedValue> {\n  const contentType = WebAppRpcProtocol.computeContentType(req.header(WEB_RPC_CONSTANTS.CONTENT));\n  if (contentType === RpcContentType.Binary) {\n    const objects = JSON.stringify([MarshalingBinaryMarker.createDefault()]);\n    const data = [req.body as Buffer];\n    return RpcSerializedValue.create(objects, data);\n  } else if (contentType === RpcContentType.Multipart) {\n    return RpcMultipart.parseRequest(req);\n  } else {\n    return RpcSerializedValue.create(req.body as string);\n  }\n}\n\n/** @internal */\nexport async function parseRequest(protocol: WebAppRpcProtocol, req: HttpServerRequest): Promise<SerializedRpcRequest> {\n  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n  const operation = protocol.getOperationFromPath(req.url!);\n\n  const parsedHeaders = parseHeaders(protocol, req);\n\n  const request: SerializedRpcRequest = {\n    ...parsedHeaders,\n    operation: {\n      interfaceDefinition: operation.interfaceDefinition,\n      operationName: operation.operationName,\n      interfaceVersion: operation.interfaceVersion,\n    },\n    method: req.method,\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n    path: req.url!,\n    parameters: operation.encodedRequest ? parseFromPath(operation) : await parseFromBody(req),\n    caching: operation.encodedRequest ? RpcResponseCacheControl.Immutable : RpcResponseCacheControl.None,\n  };\n\n  request.ip = req.ip;\n\n  request.protocolVersion = 0;\n\n  if (protocol.protocolVersionHeaderName) {\n    const version = req.header(protocol.protocolVersionHeaderName);\n    if (version) {\n      request.protocolVersion = parseInt(version, 10);\n    }\n  }\n\n  if (!request.id) {\n    throw new IModelError(BentleyStatus.ERROR, `Invalid request: Missing required activity ID.`);\n  }\n\n  return request;\n}\n"]}

package/lib/cjs/rpc/web/response.d.ts

@@ -1,7 +1,7 @@
-/** @packageDocumentation
- * @module RpcInterface
- */
-import { HttpServerRequest, HttpServerResponse, RpcRequestFulfillment, SerializedRpcRequest, WebAppRpcProtocol } from "@itwin/core-common";
-/** @internal */
-export declare function sendResponse(protocol: WebAppRpcProtocol, request: SerializedRpcRequest, fulfillment: RpcRequestFulfillment, req: HttpServerRequest, res: HttpServerResponse): Promise<void>;
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { HttpServerRequest, HttpServerResponse, RpcRequestFulfillment, SerializedRpcRequest, WebAppRpcProtocol } from "@itwin/core-common";
+/** @internal */
+export declare function sendResponse(protocol: WebAppRpcProtocol, request: SerializedRpcRequest, fulfillment: RpcRequestFulfillment, req: HttpServerRequest, res: HttpServerResponse): Promise<void>;
 //# sourceMappingURL=response.d.ts.map

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

@@ -1,107 +1,106 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sendResponse = void 0;
-const core_common_1 = require("@itwin/core-common");
-/* eslint-disable deprecation/deprecation */
-function configureResponse(protocol, request, fulfillment, res) {
-    const success = protocol.getStatus(fulfillment.status) === core_common_1.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 === core_common_1.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(core_common_1.WEB_RPC_CONSTANTS.CONTENT, core_common_1.WEB_RPC_CONSTANTS.TEXT);
-    return (fulfillment.status === 204) ? "" : fulfillment.result.objects;
-}
-function configureBinary(fulfillment, res) {
-    res.set(core_common_1.WEB_RPC_CONSTANTS.CONTENT, core_common_1.WEB_RPC_CONSTANTS.BINARY);
-    const data = fulfillment.result.data[0];
-    return Buffer.isBuffer(data) ? data : Buffer.from(data);
-}
-function configureMultipart(fulfillment, res) {
-    const response = core_common_1.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;
-}
-/** @internal */
-async function sendResponse(protocol, request, fulfillment, req, res) {
-    var _a;
-    const versionHeader = protocol.protocolVersionHeaderName;
-    if (versionHeader && core_common_1.RpcProtocol.protocolVersion) {
-        res.set(versionHeader, core_common_1.RpcProtocol.protocolVersion.toString());
-    }
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    const { Readable, Stream } = await Promise.resolve().then(() => require(/* webpackIgnore: true */ "stream"));
-    const { createGzip } = await Promise.resolve().then(() => require(/* webpackIgnore: true */ "zlib"));
-    const transportType = core_common_1.WebAppRpcRequest.computeTransportType(fulfillment.result, fulfillment.rawResult);
-    let responseBody;
-    if (transportType === core_common_1.RpcContentType.Binary) {
-        responseBody = configureBinary(fulfillment, res);
-    }
-    else if (transportType === core_common_1.RpcContentType.Multipart) {
-        responseBody = configureMultipart(fulfillment, res);
-    }
-    else if (transportType === core_common_1.RpcContentType.Stream) {
-        responseBody = configureStream(fulfillment);
-    }
-    else {
-        responseBody = configureText(fulfillment, res);
-    }
-    configureResponse(protocol, request, fulfillment, res);
-    res.status(fulfillment.status);
-    if (fulfillment.allowCompression && ((_a = req.header("Accept-Encoding")) === null || _a === void 0 ? void 0 : _a.includes("gzip"))) {
-        res.set("Content-Encoding", "gzip");
-        const readableResponseBody = (responseBody instanceof Stream) ? responseBody : Readable.from(responseBody);
-        responseBody = readableResponseBody.pipe(createGzip());
-    }
-    // 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);
-    }
-}
-exports.sendResponse = sendResponse;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendResponse = void 0;
+const core_common_1 = require("@itwin/core-common");
+/* eslint-disable deprecation/deprecation */
+function configureResponse(protocol, request, fulfillment, res) {
+    const success = protocol.getStatus(fulfillment.status) === core_common_1.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 === core_common_1.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(core_common_1.WEB_RPC_CONSTANTS.CONTENT, core_common_1.WEB_RPC_CONSTANTS.TEXT);
+    return (fulfillment.status === 204) ? "" : fulfillment.result.objects;
+}
+function configureBinary(fulfillment, res) {
+    res.set(core_common_1.WEB_RPC_CONSTANTS.CONTENT, core_common_1.WEB_RPC_CONSTANTS.BINARY);
+    const data = fulfillment.result.data[0];
+    return Buffer.isBuffer(data) ? data : Buffer.from(data);
+}
+function configureMultipart(fulfillment, res) {
+    const response = core_common_1.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;
+}
+/** @internal */
+async function sendResponse(protocol, request, fulfillment, req, res) {
+    const versionHeader = protocol.protocolVersionHeaderName;
+    if (versionHeader && core_common_1.RpcProtocol.protocolVersion) {
+        res.set(versionHeader, core_common_1.RpcProtocol.protocolVersion.toString());
+    }
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    const { Readable, Stream } = await Promise.resolve().then(() => require(/* webpackIgnore: true */ "stream"));
+    const { createGzip } = await Promise.resolve().then(() => require(/* webpackIgnore: true */ "zlib"));
+    const transportType = core_common_1.WebAppRpcRequest.computeTransportType(fulfillment.result, fulfillment.rawResult);
+    let responseBody;
+    if (transportType === core_common_1.RpcContentType.Binary) {
+        responseBody = configureBinary(fulfillment, res);
+    }
+    else if (transportType === core_common_1.RpcContentType.Multipart) {
+        responseBody = configureMultipart(fulfillment, res);
+    }
+    else if (transportType === core_common_1.RpcContentType.Stream) {
+        responseBody = configureStream(fulfillment);
+    }
+    else {
+        responseBody = configureText(fulfillment, res);
+    }
+    configureResponse(protocol, request, fulfillment, res);
+    res.status(fulfillment.status);
+    if (fulfillment.allowCompression && req.header("Accept-Encoding")?.includes("gzip")) {
+        res.set("Content-Encoding", "gzip");
+        const readableResponseBody = (responseBody instanceof Stream) ? responseBody : Readable.from(responseBody);
+        responseBody = readableResponseBody.pipe(createGzip());
+    }
+    // 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);
+    }
+}
+exports.sendResponse = sendResponse;
 //# sourceMappingURL=response.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"response.js","sourceRoot":"","sources":["../../../../src/rpc/web/response.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAc4B;AAE5B,4CAA4C;AAE5C,SAAS,iBAAiB,CAAC,QAA2B,EAAE,OAA6B,EAAE,WAAkC,EAAE,GAAuB;IAChJ,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,8BAAgB,CAAC,QAAQ,CAAC;IACrF,iJAAiJ;IACjJ,kJAAkJ;IAElJ,yFAAyF;IACzF,MAAM,gBAAgB,GAAG,IAAI,CAAC;IAC9B,IAAI,OAAO,IAAI,OAAO,CAAC,OAAO,KAAK,qCAAuB,CAAC,SAAS,EAAE;QACpE,gDAAgD;QAChD,IAAI,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,EAAE;YACtD,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;SACtC;aAAM,IAAI,OAAO,CAAC,SAAS,CAAC,aAAa,KAAK,qBAAqB,EAAE;YACpE,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;SACtC;aAAM,IAAI,OAAO,CAAC,SAAS,CAAC,aAAa,KAAK,oBAAoB,EAAE;YACnE,qKAAqK;YACrK,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,YAAY,gBAAgB,GAAG,EAAE,wBAAwB,CAAC,CAAC;SACrF;aAAM,IAAI,OAAO,CAAC,SAAS,CAAC,aAAa,KAAK,0BAA0B,EAAE;YACzE,yHAAyH;YACzH,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,YAAY,gBAAgB,GAAG,EAAE,aAAa,gBAAgB,GAAG,EAAE,aAAa,CAAC,CAAC;SAC5G;aAAM;YACL,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,YAAY,gBAAgB,GAAG,EAAE,aAAa,gBAAgB,GAAG,EAAE,aAAa,CAAC,CAAC;SAC5G;KACF;IAED,IAAI,WAAW,CAAC,KAAK,EAAE;QACrB,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;KAC3C;AACH,CAAC;AAED,SAAS,aAAa,CAAC,WAAkC,EAAE,GAAuB;IAChF,GAAG,CAAC,GAAG,CAAC,+BAAiB,CAAC,OAAO,EAAE,+BAAiB,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,+BAAiB,CAAC,OAAO,EAAE,+BAAiB,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,0BAAY,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;QAC5B,IAAI,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE;YAClC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;SAClC;KACF;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,eAAe,CAAC,WAAkC;IACzD,oEAAoE;IACpE,OAAO,WAAW,CAAC,MAAM,CAAC,MAAO,CAAC;AACpC,CAAC;AAED,gBAAgB;AACT,KAAK,UAAU,YAAY,CAAC,QAA2B,EAAE,OAA6B,EAAE,WAAkC,EAAE,GAAsB,EAAE,GAAuB;;IAChL,MAAM,aAAa,GAAG,QAAQ,CAAC,yBAAyB,CAAC;IACzD,IAAI,aAAa,IAAI,yBAAW,CAAC,eAAe,EAAE;QAChD,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,yBAAW,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,CAAC;KAChE;IACD,gEAAgE;IAChE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,2CAAa,yBAAyB,CAAC,QAAQ,EAAC,CAAC;IAC9E,MAAM,EAAE,UAAU,EAAE,GAAG,2CAAa,yBAAyB,CAAC,MAAM,EAAC,CAAC;IAEtE,MAAM,aAAa,GAAG,8BAAgB,CAAC,oBAAoB,CAAC,WAAW,CAAC,MAAM,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IACvG,IAAI,YAAY,CAAC;IACjB,IAAI,aAAa,KAAK,4BAAc,CAAC,MAAM,EAAE;QAC3C,YAAY,GAAG,eAAe,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;KAClD;SAAM,IAAI,aAAa,KAAK,4BAAc,CAAC,SAAS,EAAE;QACrD,YAAY,GAAG,kBAAkB,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;KACrD;SAAM,IAAI,aAAa,KAAK,4BAAc,CAAC,MAAM,EAAE;QAClD,YAAY,GAAG,eAAe,CAAC,WAAW,CAAC,CAAC;KAC7C;SAAM;QACL,YAAY,GAAG,aAAa,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;KAChD;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,KAAI,MAAA,GAAG,CAAC,MAAM,CAAC,iBAAiB,CAAC,0CAAE,QAAQ,CAAC,MAAM,CAAC,CAAA,EAAE;QACnF,GAAG,CAAC,GAAG,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;QACpC,MAAM,oBAAoB,GAAG,CAAC,YAAY,YAAY,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC3G,YAAY,GAAG,oBAAoB,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;KACxD;IAED,6GAA6G;IAC7G,iCAAiC;IACjC,IAAI,YAAY,YAAY,MAAM,EAAE;QAClC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACxB;SAAM;QACL,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;KACxB;AACH,CAAC;AArCD,oCAqCC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module RpcInterface\r\n */\r\n\r\nimport {\r\n  HttpServerRequest,\r\n  HttpServerResponse,\r\n  ReadableFormData,\r\n  RpcContentType,\r\n  RpcMultipart,\r\n  RpcProtocol,\r\n  RpcRequestFulfillment,\r\n  RpcRequestStatus,\r\n  RpcResponseCacheControl,\r\n  SerializedRpcRequest,\r\n  WEB_RPC_CONSTANTS,\r\n  WebAppRpcProtocol,\r\n  WebAppRpcRequest,\r\n} from \"@itwin/core-common\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\nfunction configureResponse(protocol: WebAppRpcProtocol, request: SerializedRpcRequest, fulfillment: RpcRequestFulfillment, res: HttpServerResponse) {\r\n  const success = protocol.getStatus(fulfillment.status) === RpcRequestStatus.Resolved;\r\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.\r\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.\r\n\r\n  // RPC Caching Service uses the s-maxage header to determine the TTL for the redis cache.\r\n  const oneHourInSeconds = 3600;\r\n  if (success && request.caching === RpcResponseCacheControl.Immutable) {\r\n    // If response size is > 50 MB, do not cache it.\r\n    if (fulfillment.result.objects.length > (50 * 10 ** 7)) {\r\n      res.set(\"Cache-Control\", \"no-store\");\r\n    } else if (request.operation.operationName === \"generateTileContent\") {\r\n      res.set(\"Cache-Control\", \"no-store\");\r\n    } else if (request.operation.operationName === \"getConnectionProps\") {\r\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.\r\n      res.set(\"Cache-Control\", `s-maxage=${oneHourInSeconds * 24}, max-age=1, immutable`);\r\n    } else if (request.operation.operationName === \"getTileCacheContainerUrl\") {\r\n      // getTileCacheContainerUrl returns a SAS with an expiry of 23:59:59. We can't exceed that time when setting the max-age.\r\n      res.set(\"Cache-Control\", `s-maxage=${oneHourInSeconds * 23}, max-age=${oneHourInSeconds * 23}, immutable`);\r\n    } else {\r\n      res.set(\"Cache-Control\", `s-maxage=${oneHourInSeconds * 24}, max-age=${oneHourInSeconds * 48}, immutable`);\r\n    }\r\n  }\r\n\r\n  if (fulfillment.retry) {\r\n    res.set(\"Retry-After\", fulfillment.retry);\r\n  }\r\n}\r\n\r\nfunction configureText(fulfillment: RpcRequestFulfillment, res: HttpServerResponse): string {\r\n  res.set(WEB_RPC_CONSTANTS.CONTENT, WEB_RPC_CONSTANTS.TEXT);\r\n  return (fulfillment.status === 204) ? \"\" : fulfillment.result.objects;\r\n}\r\n\r\nfunction configureBinary(fulfillment: RpcRequestFulfillment, res: HttpServerResponse): Buffer {\r\n  res.set(WEB_RPC_CONSTANTS.CONTENT, WEB_RPC_CONSTANTS.BINARY);\r\n  const data = fulfillment.result.data[0];\r\n  return Buffer.isBuffer(data) ? data : Buffer.from(data);\r\n}\r\n\r\nfunction configureMultipart(fulfillment: RpcRequestFulfillment, res: HttpServerResponse): ReadableFormData {\r\n  const response = RpcMultipart.createStream(fulfillment.result);\r\n  const headers = response.getHeaders();\r\n  for (const header in headers) {\r\n    if (headers.hasOwnProperty(header)) {\r\n      res.set(header, headers[header]);\r\n    }\r\n  }\r\n\r\n  return response;\r\n}\r\n\r\nfunction configureStream(fulfillment: RpcRequestFulfillment) {\r\n  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\r\n  return fulfillment.result.stream!;\r\n}\r\n\r\n/** @internal */\r\nexport async function sendResponse(protocol: WebAppRpcProtocol, request: SerializedRpcRequest, fulfillment: RpcRequestFulfillment, req: HttpServerRequest, res: HttpServerResponse) {\r\n  const versionHeader = protocol.protocolVersionHeaderName;\r\n  if (versionHeader && RpcProtocol.protocolVersion) {\r\n    res.set(versionHeader, RpcProtocol.protocolVersion.toString());\r\n  }\r\n  // eslint-disable-next-line @typescript-eslint/naming-convention\r\n  const { Readable, Stream } = await import(/* webpackIgnore: true */ \"stream\");\r\n  const { createGzip } = await import(/* webpackIgnore: true */ \"zlib\");\r\n\r\n  const transportType = WebAppRpcRequest.computeTransportType(fulfillment.result, fulfillment.rawResult);\r\n  let responseBody;\r\n  if (transportType === RpcContentType.Binary) {\r\n    responseBody = configureBinary(fulfillment, res);\r\n  } else if (transportType === RpcContentType.Multipart) {\r\n    responseBody = configureMultipart(fulfillment, res);\r\n  } else if (transportType === RpcContentType.Stream) {\r\n    responseBody = configureStream(fulfillment);\r\n  } else {\r\n    responseBody = configureText(fulfillment, res);\r\n  }\r\n\r\n  configureResponse(protocol, request, fulfillment, res);\r\n  res.status(fulfillment.status);\r\n\r\n  if (fulfillment.allowCompression && req.header(\"Accept-Encoding\")?.includes(\"gzip\")) {\r\n    res.set(\"Content-Encoding\", \"gzip\");\r\n    const readableResponseBody = (responseBody instanceof Stream) ? responseBody : Readable.from(responseBody);\r\n    responseBody = readableResponseBody.pipe(createGzip());\r\n  }\r\n\r\n  // This check should in theory look for instances of Readable, but that would break backend implementation at\r\n  // core/backend/src/RpcBackend.ts\r\n  if (responseBody instanceof Stream) {\r\n    responseBody.pipe(res);\r\n  } else {\r\n    res.send(responseBody);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"response.js","sourceRoot":"","sources":["../../../../src/rpc/web/response.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAc4B;AAE5B,4CAA4C;AAE5C,SAAS,iBAAiB,CAAC,QAA2B,EAAE,OAA6B,EAAE,WAAkC,EAAE,GAAuB;IAChJ,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,8BAAgB,CAAC,QAAQ,CAAC;IACrF,iJAAiJ;IACjJ,kJAAkJ;IAElJ,yFAAyF;IACzF,MAAM,gBAAgB,GAAG,IAAI,CAAC;IAC9B,IAAI,OAAO,IAAI,OAAO,CAAC,OAAO,KAAK,qCAAuB,CAAC,SAAS,EAAE;QACpE,gDAAgD;QAChD,IAAI,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,EAAE;YACtD,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;SACtC;aAAM,IAAI,OAAO,CAAC,SAAS,CAAC,aAAa,KAAK,qBAAqB,EAAE;YACpE,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;SACtC;aAAM,IAAI,OAAO,CAAC,SAAS,CAAC,aAAa,KAAK,oBAAoB,EAAE;YACnE,qKAAqK;YACrK,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,YAAY,gBAAgB,GAAG,EAAE,wBAAwB,CAAC,CAAC;SACrF;aAAM,IAAI,OAAO,CAAC,SAAS,CAAC,aAAa,KAAK,0BAA0B,EAAE;YACzE,yHAAyH;YACzH,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,YAAY,gBAAgB,GAAG,EAAE,aAAa,gBAAgB,GAAG,EAAE,aAAa,CAAC,CAAC;SAC5G;aAAM;YACL,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,YAAY,gBAAgB,GAAG,EAAE,aAAa,gBAAgB,GAAG,EAAE,aAAa,CAAC,CAAC;SAC5G;KACF;IAED,IAAI,WAAW,CAAC,KAAK,EAAE;QACrB,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;KAC3C;AACH,CAAC;AAED,SAAS,aAAa,CAAC,WAAkC,EAAE,GAAuB;IAChF,GAAG,CAAC,GAAG,CAAC,+BAAiB,CAAC,OAAO,EAAE,+BAAiB,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,+BAAiB,CAAC,OAAO,EAAE,+BAAiB,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,0BAAY,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;QAC5B,IAAI,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE;YAClC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;SAClC;KACF;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,eAAe,CAAC,WAAkC;IACzD,oEAAoE;IACpE,OAAO,WAAW,CAAC,MAAM,CAAC,MAAO,CAAC;AACpC,CAAC;AAED,gBAAgB;AACT,KAAK,UAAU,YAAY,CAAC,QAA2B,EAAE,OAA6B,EAAE,WAAkC,EAAE,GAAsB,EAAE,GAAuB;IAChL,MAAM,aAAa,GAAG,QAAQ,CAAC,yBAAyB,CAAC;IACzD,IAAI,aAAa,IAAI,yBAAW,CAAC,eAAe,EAAE;QAChD,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,yBAAW,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,CAAC;KAChE;IACD,gEAAgE;IAChE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,2CAAa,yBAAyB,CAAC,QAAQ,EAAC,CAAC;IAC9E,MAAM,EAAE,UAAU,EAAE,GAAG,2CAAa,yBAAyB,CAAC,MAAM,EAAC,CAAC;IAEtE,MAAM,aAAa,GAAG,8BAAgB,CAAC,oBAAoB,CAAC,WAAW,CAAC,MAAM,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IACvG,IAAI,YAAY,CAAC;IACjB,IAAI,aAAa,KAAK,4BAAc,CAAC,MAAM,EAAE;QAC3C,YAAY,GAAG,eAAe,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;KAClD;SAAM,IAAI,aAAa,KAAK,4BAAc,CAAC,SAAS,EAAE;QACrD,YAAY,GAAG,kBAAkB,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;KACrD;SAAM,IAAI,aAAa,KAAK,4BAAc,CAAC,MAAM,EAAE;QAClD,YAAY,GAAG,eAAe,CAAC,WAAW,CAAC,CAAC;KAC7C;SAAM;QACL,YAAY,GAAG,aAAa,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;KAChD;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,IAAI,GAAG,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE;QACnF,GAAG,CAAC,GAAG,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;QACpC,MAAM,oBAAoB,GAAG,CAAC,YAAY,YAAY,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC3G,YAAY,GAAG,oBAAoB,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;KACxD;IAED,6GAA6G;IAC7G,iCAAiC;IACjC,IAAI,YAAY,YAAY,MAAM,EAAE;QAClC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACxB;SAAM;QACL,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;KACxB;AACH,CAAC;AArCD,oCAqCC","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 {\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\n/* eslint-disable deprecation/deprecation */\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\n/** @internal */\nexport async function sendResponse(protocol: WebAppRpcProtocol, request: SerializedRpcRequest, fulfillment: RpcRequestFulfillment, req: HttpServerRequest, res: HttpServerResponse) {\n  const versionHeader = protocol.protocolVersionHeaderName;\n  if (versionHeader && RpcProtocol.protocolVersion) {\n    res.set(versionHeader, RpcProtocol.protocolVersion.toString());\n  }\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  const { Readable, Stream } = await import(/* webpackIgnore: true */ \"stream\");\n  const { createGzip } = await import(/* webpackIgnore: true */ \"zlib\");\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 && req.header(\"Accept-Encoding\")?.includes(\"gzip\")) {\n    res.set(\"Content-Encoding\", \"gzip\");\n    const readableResponseBody = (responseBody instanceof Stream) ? responseBody : Readable.from(responseBody);\n    responseBody = readableResponseBody.pipe(createGzip());\n  }\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"]}

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

@@ -1,16 +1,16 @@
-/** @packageDocumentation
- * @module RpcInterface
- */
-import { LogLevel } from "@itwin/core-bentley";
-import { DevToolsRpcInterface, DevToolsStatsOptions, IModelRpcProps, RpcInterface } from "@itwin/core-common";
-/** The backend implementation of WipRpcInterface.
- * @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>;
-}
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { LogLevel } from "@itwin/core-bentley";
+import { DevToolsRpcInterface, DevToolsStatsOptions, IModelRpcProps, RpcInterface } from "@itwin/core-common";
+/** The backend implementation of WipRpcInterface.
+ * @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/cjs/rpc-impl/DevToolsRpcImpl.js

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