@itwin/core-backend 4.0.0-dev.52 → 4.0.0-dev.55

package/lib/cjs/rpc/multipart.js

@@ -1,72 +1,72 @@
-"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");
-/* eslint-disable deprecation/deprecation */
-/** @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;
+"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");
+/* eslint-disable deprecation/deprecation */
+/** @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/tracing.d.ts

@@ -1,29 +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;
+/** @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.js

@@ -1,74 +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");
-/* eslint-disable deprecation/deprecation */
-/**
- * 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) {
-        return core_bentley_1.Tracing.withSpan(activity.rpcMethod ?? "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;
+"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");
+/* eslint-disable deprecation/deprecation */
+/**
+ * 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) {
+        return core_bentley_1.Tracing.withSpan(activity.rpcMethod ?? "unknown RPC method", async () => RpcTrace.run(activity, fn), {
+            attributes: { ...core_common_1.RpcInvocation.sanitizeForLog(activity) },
+            kind: core_bentley_1.SpanKind.SERVER,
+        });
+    }
+}
+RpcTrace._storage = new async_hooks_1.AsyncLocalStorage();
+exports.RpcTrace = RpcTrace;
+/** @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

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

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

@@ -1,10 +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;
-}
+/** @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.js

@@ -1,44 +1,44 @@
-"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");
-/* eslint-disable deprecation/deprecation */
-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;
+"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");
+/* eslint-disable deprecation/deprecation */
+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/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