@itwin/core-backend 3.5.0-dev.8 → 3.5.1

package/lib/cjs/domains/GenericSchema.js

@@ -1,29 +1,29 @@
-"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 Schema
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GenericSchema = void 0;
-const path = require("path");
-const ClassRegistry_1 = require("../ClassRegistry");
-const IModelHost_1 = require("../IModelHost");
-const Schema_1 = require("../Schema");
-const elementsModule = require("./GenericElements");
-/** @public */
-class GenericSchema extends Schema_1.Schema {
-    static get schemaName() { return "Generic"; }
-    static get schemaFilePath() { return path.join(IModelHost_1.KnownLocations.nativeAssetsDir, "ECSchemas", "Dgn", `${GenericSchema.schemaName}.ecschema.xml`); }
-    static registerSchema() {
-        if (this !== Schema_1.Schemas.getRegisteredSchema(this.schemaName)) {
-            Schema_1.Schemas.unregisterSchema(this.schemaName);
-            Schema_1.Schemas.registerSchema(this);
-            ClassRegistry_1.ClassRegistry.registerModule(elementsModule, this);
-        }
-    }
-}
-exports.GenericSchema = GenericSchema;
+"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 Schema
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenericSchema = void 0;
+const path = require("path");
+const ClassRegistry_1 = require("../ClassRegistry");
+const IModelHost_1 = require("../IModelHost");
+const Schema_1 = require("../Schema");
+const elementsModule = require("./GenericElements");
+/** @public */
+class GenericSchema extends Schema_1.Schema {
+    static get schemaName() { return "Generic"; }
+    static get schemaFilePath() { return path.join(IModelHost_1.KnownLocations.nativeAssetsDir, "ECSchemas", "Dgn", `${GenericSchema.schemaName}.ecschema.xml`); }
+    static registerSchema() {
+        if (this !== Schema_1.Schemas.getRegisteredSchema(this.schemaName)) {
+            Schema_1.Schemas.unregisterSchema(this.schemaName);
+            Schema_1.Schemas.registerSchema(this);
+            ClassRegistry_1.ClassRegistry.registerModule(elementsModule, this);
+        }
+    }
+}
+exports.GenericSchema = GenericSchema;
 //# sourceMappingURL=GenericSchema.js.map

package/lib/cjs/domains/GenericSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"GenericSchema.js","sourceRoot":"","sources":["../../../src/domains/GenericSchema.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,6BAA6B;AAC7B,oDAAiD;AACjD,8CAA+C;AAC/C,sCAA4C;AAC5C,oDAAoD;AAEpD,cAAc;AACd,MAAa,aAAc,SAAQ,eAAM;IAChC,MAAM,KAAc,UAAU,KAAa,OAAO,SAAS,CAAC,CAAC,CAAC;IAC9D,MAAM,KAAK,cAAc,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,2BAAc,CAAC,eAAe,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,aAAa,CAAC,UAAU,eAAe,CAAC,CAAC,CAAC,CAAC;IACzJ,MAAM,CAAC,cAAc;QAC1B,IAAI,IAAI,KAAK,gBAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YACzD,gBAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC1C,gBAAO,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YAC7B,6BAAa,CAAC,cAAc,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;SACpD;IACH,CAAC;CACF;AAVD,sCAUC","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 Schema\r\n */\r\n\r\nimport * as path from \"path\";\r\nimport { ClassRegistry } from \"../ClassRegistry\";\r\nimport { KnownLocations } from \"../IModelHost\";\r\nimport { Schema, Schemas } from \"../Schema\";\r\nimport * as elementsModule from \"./GenericElements\";\r\n\r\n/** @public */\r\nexport class GenericSchema extends Schema {\r\n  public static override get schemaName(): string { return \"Generic\"; }\r\n  public static get schemaFilePath(): string { return path.join(KnownLocations.nativeAssetsDir, \"ECSchemas\", \"Dgn\", `${GenericSchema.schemaName}.ecschema.xml`); }\r\n  public static registerSchema() {\r\n    if (this !== Schemas.getRegisteredSchema(this.schemaName)) {\r\n      Schemas.unregisterSchema(this.schemaName);\r\n      Schemas.registerSchema(this);\r\n      ClassRegistry.registerModule(elementsModule, this);\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"GenericSchema.js","sourceRoot":"","sources":["../../../src/domains/GenericSchema.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,6BAA6B;AAC7B,oDAAiD;AACjD,8CAA+C;AAC/C,sCAA4C;AAC5C,oDAAoD;AAEpD,cAAc;AACd,MAAa,aAAc,SAAQ,eAAM;IAChC,MAAM,KAAc,UAAU,KAAa,OAAO,SAAS,CAAC,CAAC,CAAC;IAC9D,MAAM,KAAK,cAAc,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,2BAAc,CAAC,eAAe,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,aAAa,CAAC,UAAU,eAAe,CAAC,CAAC,CAAC,CAAC;IACzJ,MAAM,CAAC,cAAc;QAC1B,IAAI,IAAI,KAAK,gBAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YACzD,gBAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC1C,gBAAO,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YAC7B,6BAAa,CAAC,cAAc,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;SACpD;IACH,CAAC;CACF;AAVD,sCAUC","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 Schema\n */\n\nimport * as path from \"path\";\nimport { ClassRegistry } from \"../ClassRegistry\";\nimport { KnownLocations } from \"../IModelHost\";\nimport { Schema, Schemas } from \"../Schema\";\nimport * as elementsModule from \"./GenericElements\";\n\n/** @public */\nexport class GenericSchema extends Schema {\n  public static override get schemaName(): string { return \"Generic\"; }\n  public static get schemaFilePath(): string { return path.join(KnownLocations.nativeAssetsDir, \"ECSchemas\", \"Dgn\", `${GenericSchema.schemaName}.ecschema.xml`); }\n  public static registerSchema() {\n    if (this !== Schemas.getRegisteredSchema(this.schemaName)) {\n      Schemas.unregisterSchema(this.schemaName);\n      Schemas.registerSchema(this);\n      ClassRegistry.registerModule(elementsModule, this);\n    }\n  }\n}\n"]}

package/lib/cjs/rpc/multipart.d.ts

@@ -0,0 +1,12 @@
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { FormDataCommon, HttpServerRequest, RpcSerializedValue } from "@itwin/core-common";
+import * as FormData from "form-data";
+/** @internal */
+export declare function createMultipartStream(value: RpcSerializedValue): FormData;
+/** @internal */
+export declare function parseMultipartRequest(req: HttpServerRequest): Promise<RpcSerializedValue>;
+/** @internal */
+export declare function appendToMultipartForm(i: number, form: FormDataCommon, value: RpcSerializedValue): void;
+//# sourceMappingURL=multipart.d.ts.map

package/lib/cjs/rpc/multipart.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"multipart.d.ts","sourceRoot":"","sources":["../../../src/rpc/multipart.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAiB,cAAc,EAAE,iBAAiB,EAA6B,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACrI,OAAO,KAAK,QAAQ,MAAM,WAAW,CAAC;AAGtC,gBAAgB;AAChB,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,kBAAkB,YAM9D;AAED,gBAAgB;AAChB,wBAAsB,qBAAqB,CAAC,GAAG,EAAE,iBAAiB,+BA4CjE;AAED,gBAAgB;AAChB,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,kBAAkB,QAG/F"}

package/lib/cjs/rpc/multipart.js

@@ -0,0 +1,71 @@
+"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.appendToMultipartForm = exports.parseMultipartRequest = exports.createMultipartStream = void 0;
+const core_common_1 = require("@itwin/core-common");
+const FormData = require("form-data");
+const multiparty = require("multiparty");
+/** @internal */
+function createMultipartStream(value) {
+    const form = new FormData();
+    core_common_1.RpcMultipart.writeValueToForm(form, value);
+    // Type information for FormData is lying. It actually extends Stream but not Readable, although it appears to work
+    // fine for now.
+    return form;
+}
+exports.createMultipartStream = createMultipartStream;
+/** @internal */
+async function parseMultipartRequest(req) {
+    return new Promise((resolve, reject) => {
+        const form = new multiparty.Form({ maxFieldsSize: Infinity });
+        form.on("error", (err) => {
+            reject(err);
+        });
+        const value = core_common_1.RpcSerializedValue.create();
+        const data = {};
+        form.on("part", (part) => {
+            part.on("data", (chunk) => {
+                if (part.name === "objects") {
+                    value.objects += chunk.toString();
+                }
+                else if (Buffer.isBuffer(chunk)) {
+                    if (!data[part.name]) {
+                        data[part.name] = { size: 0, chunks: [] };
+                    }
+                    data[part.name].size += chunk.byteLength;
+                    data[part.name].chunks.push(chunk);
+                }
+                else {
+                    throw new core_common_1.IModelError(core_common_1.BentleyStatus.ERROR, "Unknown input.");
+                }
+            });
+        });
+        form.on("close", () => {
+            let i = 0;
+            for (;;) {
+                const part = data[`data-${i}`];
+                if (!part) {
+                    break;
+                }
+                value.data.push(Buffer.concat(part.chunks, part.size));
+                ++i;
+            }
+            resolve(value);
+        });
+        form.parse(req);
+    });
+}
+exports.parseMultipartRequest = parseMultipartRequest;
+/** @internal */
+function appendToMultipartForm(i, form, value) {
+    const buf = value.data[i];
+    form.append(`data-${i}`, Buffer.from(buf.buffer, buf.byteOffset, buf.byteLength));
+}
+exports.appendToMultipartForm = appendToMultipartForm;
+//# sourceMappingURL=multipart.js.map

package/lib/cjs/rpc/multipart.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"multipart.js","sourceRoot":"","sources":["../../../src/rpc/multipart.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAAqI;AACrI,sCAAsC;AACtC,yCAAyC;AAEzC,gBAAgB;AAChB,SAAgB,qBAAqB,CAAC,KAAyB;IAC7D,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;IAC5B,0BAAY,CAAC,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC3C,mHAAmH;IACnH,gBAAgB;IAChB,OAAO,IAAI,CAAC;AACd,CAAC;AAND,sDAMC;AAED,gBAAgB;AACT,KAAK,UAAU,qBAAqB,CAAC,GAAsB;IAChE,OAAO,IAAI,OAAO,CAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACzD,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC9D,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACvB,MAAM,CAAC,GAAG,CAAC,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,gCAAkB,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAA4D,EAAE,CAAC;QAEzE,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAqB,EAAE,EAAE;YACxC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAsB,EAAE,EAAE;gBACzC,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;oBAC3B,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;iBACnC;qBAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;oBACjC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;wBACpB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;qBAC3C;oBAED,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,UAAU,CAAC;oBACzC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;iBACpC;qBAAM;oBACL,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC;iBAC9D;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACpB,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,SAAU;gBACR,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;gBAC/B,IAAI,CAAC,IAAI,EAAE;oBACT,MAAM;iBACP;gBAED,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;gBACvD,EAAE,CAAC,CAAC;aACL;YAED,OAAO,CAAC,KAAK,CAAC,CAAC;QACjB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC;AA5CD,sDA4CC;AAED,gBAAgB;AAChB,SAAgB,qBAAqB,CAAC,CAAS,EAAE,IAAoB,EAAE,KAAyB;IAC9F,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC1B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;AACpF,CAAC;AAHD,sDAGC","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 { BentleyStatus, FormDataCommon, HttpServerRequest, IModelError, RpcMultipart, RpcSerializedValue } from \"@itwin/core-common\";\nimport * as FormData from \"form-data\";\nimport * as multiparty from \"multiparty\";\n\n/** @internal */\nexport function createMultipartStream(value: RpcSerializedValue) {\n  const form = new FormData();\n  RpcMultipart.writeValueToForm(form, value);\n  // Type information for FormData is lying. It actually extends Stream but not Readable, although it appears to work\n  // fine for now.\n  return form;\n}\n\n/** @internal */\nexport async function parseMultipartRequest(req: HttpServerRequest) {\n  return new Promise<RpcSerializedValue>((resolve, reject) => {\n    const form = new multiparty.Form({ maxFieldsSize: Infinity });\n    form.on(\"error\", (err) => {\n      reject(err);\n    });\n\n    const value = RpcSerializedValue.create();\n    const data: { [index: string]: { size: number, chunks: Buffer[] } } = {};\n\n    form.on(\"part\", (part: multiparty.Part) => {\n      part.on(\"data\", (chunk: string | Buffer) => {\n        if (part.name === \"objects\") {\n          value.objects += chunk.toString();\n        } else if (Buffer.isBuffer(chunk)) {\n          if (!data[part.name]) {\n            data[part.name] = { size: 0, chunks: [] };\n          }\n\n          data[part.name].size += chunk.byteLength;\n          data[part.name].chunks.push(chunk);\n        } else {\n          throw new IModelError(BentleyStatus.ERROR, \"Unknown input.\");\n        }\n      });\n    });\n\n    form.on(\"close\", () => {\n      let i = 0;\n      for (; ;) {\n        const part = data[`data-${i}`];\n        if (!part) {\n          break;\n        }\n\n        value.data.push(Buffer.concat(part.chunks, part.size));\n        ++i;\n      }\n\n      resolve(value);\n    });\n\n    form.parse(req);\n  });\n}\n\n/** @internal */\nexport function appendToMultipartForm(i: number, form: FormDataCommon, value: RpcSerializedValue) {\n  const buf = value.data[i];\n  form.append(`data-${i}`, Buffer.from(buf.buffer, buf.byteOffset, buf.byteLength));\n}\n"]}

package/lib/cjs/rpc/tracing.d.ts

@@ -0,0 +1,29 @@
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { RpcActivity } from "@itwin/core-common";
+/**
+ * Utility for tracing Rpc activity processing. When multiple Rpc requests are being processed asynchronously, this
+ * class can be used to correlate the current calltrace with the originating RpcActivity. This is used for automatic appending
+ * of RpcActivity to log messages emitted during Rpc processing. It may also be used to retrieve the user accessToken
+ * from the RpcActivity.
+ * @public
+ */
+export declare class RpcTrace {
+    private static _storage;
+    /** Get the [RpcActivity]($common) for the currently executing async, or `undefined` if there is no
+     * RpcActivity in the current call stack.
+     * */
+    static get currentActivity(): RpcActivity | undefined;
+    /** Get the [RpcActivity]($common) for the currently executing async. Asserts that the RpcActivity
+     * exists in the current call stack.
+     * */
+    static get expectCurrentActivity(): RpcActivity;
+    /** Start the processing of an RpcActivity. */
+    static run<T>(activity: RpcActivity, fn: () => Promise<T>): Promise<T>;
+    /** Start the processing of an RpcActivity inside an OpenTelemetry span */
+    static runWithSpan<T>(activity: RpcActivity, fn: () => Promise<T>): Promise<T>;
+}
+/** @internal */
+export declare function initializeTracing(enableOpenTelemetry?: boolean): void;
+//# sourceMappingURL=tracing.d.ts.map

package/lib/cjs/rpc/tracing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracing.d.ts","sourceRoot":"","sources":["../../../src/rpc/tracing.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,WAAW,EAAiB,MAAM,oBAAoB,CAAC;AAKhE;;;;;;GAMG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA2B;IAElD;;SAEK;IACL,WAAkB,eAAe,IAAI,WAAW,GAAG,SAAS,CAE3D;IAED;;SAEK;IACL,WAAkB,qBAAqB,IAAI,WAAW,CAGrD;IAED,8CAA8C;WAC1B,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAInF,0EAA0E;WACtD,WAAW,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CAM5F;AAED,gBAAgB;AAChB,wBAAgB,iBAAiB,CAAC,mBAAmB,GAAE,OAAe,QAmBrE"}

package/lib/cjs/rpc/tracing.js

@@ -0,0 +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.initializeTracing = exports.RpcTrace = void 0;
+// cspell:ignore calltrace
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const async_hooks_1 = require("async_hooks");
+const BackendLoggerCategory_1 = require("../BackendLoggerCategory");
+const IModelHost_1 = require("../IModelHost");
+/**
+ * Utility for tracing Rpc activity processing. When multiple Rpc requests are being processed asynchronously, this
+ * class can be used to correlate the current calltrace with the originating RpcActivity. This is used for automatic appending
+ * of RpcActivity to log messages emitted during Rpc processing. It may also be used to retrieve the user accessToken
+ * from the RpcActivity.
+ * @public
+ */
+class RpcTrace {
+    /** Get the [RpcActivity]($common) for the currently executing async, or `undefined` if there is no
+     * RpcActivity in the current call stack.
+     * */
+    static get currentActivity() {
+        return RpcTrace._storage.getStore();
+    }
+    /** Get the [RpcActivity]($common) for the currently executing async. Asserts that the RpcActivity
+     * exists in the current call stack.
+     * */
+    static get expectCurrentActivity() {
+        (0, core_bentley_1.assert)(undefined !== RpcTrace.currentActivity);
+        return RpcTrace.currentActivity;
+    }
+    /** Start the processing of an RpcActivity. */
+    static async run(activity, fn) {
+        return RpcTrace._storage.run(activity, fn);
+    }
+    /** Start the processing of an RpcActivity inside an OpenTelemetry span */
+    static async runWithSpan(activity, fn) {
+        var _a;
+        return core_bentley_1.Tracing.withSpan((_a = activity.rpcMethod) !== null && _a !== void 0 ? _a : "unknown RPC method", async () => RpcTrace.run(activity, fn), {
+            attributes: { ...core_common_1.RpcInvocation.sanitizeForLog(activity) },
+            kind: core_bentley_1.SpanKind.SERVER,
+        });
+    }
+}
+exports.RpcTrace = RpcTrace;
+RpcTrace._storage = new async_hooks_1.AsyncLocalStorage();
+/** @internal */
+function initializeTracing(enableOpenTelemetry = false) {
+    core_common_1.RpcInvocation.runActivity = RpcTrace.run; // redirect the invocation processing to the tracer
+    if (enableOpenTelemetry) {
+        try {
+            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            const api = require("@opentelemetry/api");
+            const tracer = api.trace.getTracer("@itwin/core-backend", IModelHost_1.IModelHost.backendVersion);
+            core_bentley_1.Tracing.enableOpenTelemetry(tracer, api);
+            core_common_1.RpcInvocation.runActivity = RpcTrace.runWithSpan; // wrap invocation in an OpenTelemetry span in addition to RpcTrace
+        }
+        catch (e) {
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            core_bentley_1.Logger.logError(BackendLoggerCategory_1.BackendLoggerCategory.IModelHost, "Failed to initialize OpenTelemetry");
+            core_bentley_1.Logger.logException(BackendLoggerCategory_1.BackendLoggerCategory.IModelHost, e);
+        }
+    }
+    // set up static logger metadata to include current RpcActivity information for logs during rpc processing
+    core_bentley_1.Logger.staticMetaData.set("rpc", () => core_common_1.RpcInvocation.sanitizeForLog(RpcTrace.currentActivity));
+}
+exports.initializeTracing = initializeTracing;
+//# sourceMappingURL=tracing.js.map

package/lib/cjs/rpc/tracing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracing.js","sourceRoot":"","sources":["../../../src/rpc/tracing.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,0BAA0B;AAE1B,sDAAwE;AACxE,oDAAgE;AAChE,6CAAgD;AAChD,oEAAiE;AACjE,8CAA2C;AAE3C;;;;;;GAMG;AACH,MAAa,QAAQ;IAGnB;;SAEK;IACE,MAAM,KAAK,eAAe;QAC/B,OAAO,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAA6B,CAAC;IACjE,CAAC;IAED;;SAEK;IACE,MAAM,KAAK,qBAAqB;QACrC,IAAA,qBAAM,EAAC,SAAS,KAAK,QAAQ,CAAC,eAAe,CAAC,CAAC;QAC/C,OAAO,QAAQ,CAAC,eAAe,CAAC;IAClC,CAAC;IAED,8CAA8C;IACvC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAI,QAAqB,EAAE,EAAoB;QACpE,OAAO,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED,0EAA0E;IACnE,MAAM,CAAC,KAAK,CAAC,WAAW,CAAI,QAAqB,EAAE,EAAoB;;QAC5E,OAAO,sBAAO,CAAC,QAAQ,CAAC,MAAA,QAAQ,CAAC,SAAS,mCAAI,oBAAoB,EAAE,KAAK,IAAI,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC,EAAE;YAC1G,UAAU,EAAE,EAAE,GAAG,2BAAa,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;YACzD,IAAI,EAAE,uBAAQ,CAAC,MAAM;SACtB,CAAC,CAAC;IACL,CAAC;;AA7BH,4BA8BC;AA7BgB,iBAAQ,GAAG,IAAI,+BAAiB,EAAE,CAAC;AA+BpD,gBAAgB;AAChB,SAAgB,iBAAiB,CAAC,sBAA+B,KAAK;IACpE,2BAAa,CAAC,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,mDAAmD;IAE7F,IAAI,mBAAmB,EAAE;QACvB,IAAI;YACF,8DAA8D;YAC9D,MAAM,GAAG,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;YAC1C,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,qBAAqB,EAAE,uBAAU,CAAC,cAAc,CAAC,CAAC;YACrF,sBAAO,CAAC,mBAAmB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YACzC,2BAAa,CAAC,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,mEAAmE;SACtH;QAAC,OAAO,CAAC,EAAE;YACV,gEAAgE;YAChE,qBAAM,CAAC,QAAQ,CAAC,6CAAqB,CAAC,UAAU,EAAE,oCAAoC,CAAC,CAAC;YACxF,qBAAM,CAAC,YAAY,CAAC,6CAAqB,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;SAC1D;KACF;IAED,0GAA0G;IAC1G,qBAAM,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,2BAAa,CAAC,cAAc,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC;AACjG,CAAC;AAnBD,8CAmBC","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\n// cspell:ignore calltrace\n\nimport { assert, Logger, SpanKind, Tracing } from \"@itwin/core-bentley\";\nimport { RpcActivity, RpcInvocation } from \"@itwin/core-common\";\nimport { AsyncLocalStorage } from \"async_hooks\";\nimport { BackendLoggerCategory } from \"../BackendLoggerCategory\";\nimport { IModelHost } from \"../IModelHost\";\n\n/**\n * Utility for tracing Rpc activity processing. When multiple Rpc requests are being processed asynchronously, this\n * class can be used to correlate the current calltrace with the originating RpcActivity. This is used for automatic appending\n * of RpcActivity to log messages emitted during Rpc processing. It may also be used to retrieve the user accessToken\n * from the RpcActivity.\n * @public\n */\nexport class RpcTrace {\n  private static _storage = new AsyncLocalStorage();\n\n  /** Get the [RpcActivity]($common) for the currently executing async, or `undefined` if there is no\n   * RpcActivity in the current call stack.\n   * */\n  public static get currentActivity(): RpcActivity | undefined {\n    return RpcTrace._storage.getStore() as RpcActivity | undefined;\n  }\n\n  /** Get the [RpcActivity]($common) for the currently executing async. Asserts that the RpcActivity\n   * exists in the current call stack.\n   * */\n  public static get expectCurrentActivity(): RpcActivity {\n    assert(undefined !== RpcTrace.currentActivity);\n    return RpcTrace.currentActivity;\n  }\n\n  /** Start the processing of an RpcActivity. */\n  public static async run<T>(activity: RpcActivity, fn: () => Promise<T>): Promise<T> {\n    return RpcTrace._storage.run(activity, fn);\n  }\n\n  /** Start the processing of an RpcActivity inside an OpenTelemetry span */\n  public static async runWithSpan<T>(activity: RpcActivity, fn: () => Promise<T>): Promise<T> {\n    return Tracing.withSpan(activity.rpcMethod ?? \"unknown RPC method\", async () => RpcTrace.run(activity, fn), {\n      attributes: { ...RpcInvocation.sanitizeForLog(activity) },\n      kind: SpanKind.SERVER,\n    });\n  }\n}\n\n/** @internal */\nexport function initializeTracing(enableOpenTelemetry: boolean = false) {\n  RpcInvocation.runActivity = RpcTrace.run; // redirect the invocation processing to the tracer\n\n  if (enableOpenTelemetry) {\n    try {\n      // eslint-disable-next-line @typescript-eslint/no-var-requires\n      const api = require(\"@opentelemetry/api\");\n      const tracer = api.trace.getTracer(\"@itwin/core-backend\", IModelHost.backendVersion);\n      Tracing.enableOpenTelemetry(tracer, api);\n      RpcInvocation.runActivity = RpcTrace.runWithSpan; // wrap invocation in an OpenTelemetry span in addition to RpcTrace\n    } catch (e) {\n      // eslint-disable-next-line @typescript-eslint/naming-convention\n      Logger.logError(BackendLoggerCategory.IModelHost, \"Failed to initialize OpenTelemetry\");\n      Logger.logException(BackendLoggerCategory.IModelHost, e);\n    }\n  }\n\n  // set up static logger metadata to include current RpcActivity information for logs during rpc processing\n  Logger.staticMetaData.set(\"rpc\", () => RpcInvocation.sanitizeForLog(RpcTrace.currentActivity));\n}\n"]}

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

@@ -0,0 +1,10 @@
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { RpcInvocation, RpcProtocolEvent, WebAppRpcLogging } from "@itwin/core-common";
+export declare class WebAppRpcLoggingBackend extends WebAppRpcLogging {
+    protected logProtocolEvent(event: RpcProtocolEvent, object: RpcInvocation): Promise<void>;
+    protected getHostname(): string;
+    private logErrorBackend;
+}
+//# sourceMappingURL=logging.d.ts.map

package/lib/cjs/rpc/web/logging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.d.ts","sourceRoot":"","sources":["../../../../src/rpc/web/logging.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAwB,aAAa,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAG7G,qBAAa,uBAAwB,SAAQ,gBAAgB;cAClC,gBAAgB,CAAC,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;cAQrF,WAAW,IAAI,MAAM;YAI1B,eAAe;CAiB9B"}

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

@@ -0,0 +1,43 @@
+"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.WebAppRpcLoggingBackend = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const os = require("os");
+class WebAppRpcLoggingBackend extends core_common_1.WebAppRpcLogging {
+    async logProtocolEvent(event, object) {
+        switch (event) {
+            case core_common_1.RpcProtocolEvent.RequestReceived: return this.logRequest(core_common_1.CommonLoggerCategory.RpcInterfaceBackend, "RpcInterface.backend.request", object.request);
+            case core_common_1.RpcProtocolEvent.BackendErrorOccurred: return this.logErrorBackend("RpcInterface.backend.error", object);
+            case core_common_1.RpcProtocolEvent.BackendResponseCreated: return this.logResponse(core_common_1.CommonLoggerCategory.RpcInterfaceBackend, "RpcInterface.backend.response", object.request, object.status, object.elapsed);
+        }
+    }
+    getHostname() {
+        return os.hostname();
+    }
+    async logErrorBackend(message, invocation) {
+        const operationDescriptor = this.buildOperationDescriptor(invocation.operation);
+        const pathIds = this.findPathIds(invocation.request.path);
+        const result = await invocation.result;
+        const errorMessage = result.message ? result.message : result.objects; // Can be an error or an RpcSerializedValue
+        core_bentley_1.Logger.logInfo(core_common_1.CommonLoggerCategory.RpcInterfaceBackend, `${message}.${operationDescriptor}`, () => ({
+            method: invocation.request.method,
+            path: invocation.request.path,
+            status: invocation.status,
+            errorMessage,
+            // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!
+            ActivityId: invocation.request.id,
+            MachineName: this.getHostname(),
+            ...pathIds,
+        }));
+    }
+}
+exports.WebAppRpcLoggingBackend = WebAppRpcLoggingBackend;
+//# sourceMappingURL=logging.js.map

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

@@ -0,0 +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,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\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

@@ -0,0 +1,7 @@
+/** @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.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../../../src/rpc/web/request.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAEL,iBAAiB,EASjB,oBAAoB,EAEpB,iBAAiB,EAClB,MAAM,oBAAoB,CAAC;AAgC5B,gBAAgB;AAChB,wBAAsB,YAAY,CAAC,QAAQ,EAAE,iBAAiB,EAAE,GAAG,EAAE,iBAAiB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAoCrH"}

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

@@ -0,0 +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");
+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;
+//# sourceMappingURL=request.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../../src/rpc/web/request.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAc4B;AAE5B,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":["/*---------------------------------------------------------------------------------------------\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\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

@@ -0,0 +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>;
+//# sourceMappingURL=response.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../../../src/rpc/web/response.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAKlB,qBAAqB,EAGrB,oBAAoB,EAEpB,iBAAiB,EAElB,MAAM,oBAAoB,CAAC;AA2D5B,gBAAgB;AAChB,wBAAsB,YAAY,CAAC,QAAQ,EAAE,iBAAiB,EAAE,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,qBAAqB,EAAE,GAAG,EAAE,iBAAiB,EAAE,GAAG,EAAE,kBAAkB,iBAqCjL"}

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

@@ -0,0 +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");
+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;
+//# sourceMappingURL=response.js.map

package/lib/cjs/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,oDAc4B;AAE5B,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":["/*---------------------------------------------------------------------------------------------\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\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"]}