@itwin/core-common 3.4.1 → 3.4.3

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

@@ -1,18 +1,18 @@
-/** @packageDocumentation
- * @module RpcInterface
- */
-import { RpcProtocolEvent } from "../core/RpcConstants";
-import { RpcInvocation } from "../core/RpcInvocation";
-import { RpcRequest } from "../core/RpcRequest";
-/** @internal */
-export declare class WebAppRpcLogging {
-    static logProtocolEvent(event: RpcProtocolEvent, object: RpcRequest | RpcInvocation): Promise<void>;
-    private static getRpcInterfaceName;
-    private static findPathIds;
-    private static buildOperationDescriptor;
-    private static logRequest;
-    private static logResponse;
-    private static logErrorFrontend;
-    private static logErrorBackend;
-}
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { RpcProtocolEvent } from "../core/RpcConstants";
+import { RpcInvocation } from "../core/RpcInvocation";
+import { RpcRequest } from "../core/RpcRequest";
+/** @internal */
+export declare class WebAppRpcLogging {
+    static logProtocolEvent(event: RpcProtocolEvent, object: RpcRequest | RpcInvocation): Promise<void>;
+    private static getRpcInterfaceName;
+    private static findPathIds;
+    private static buildOperationDescriptor;
+    private static logRequest;
+    private static logResponse;
+    private static logErrorFrontend;
+    private static logErrorBackend;
+}
 //# sourceMappingURL=WebAppRpcLogging.d.ts.map

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

@@ -1,141 +1,141 @@
-"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.WebAppRpcLogging = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const CommonLoggerCategory_1 = require("../../CommonLoggerCategory");
-const RpcConstants_1 = require("../core/RpcConstants");
-const RpcInvocation_1 = require("../core/RpcInvocation");
-const WebAppRpcRequest_1 = require("./WebAppRpcRequest");
-let hostname = "";
-function getHostname() {
-    if (!hostname) {
-        try {
-            // eslint-disable-next-line @typescript-eslint/no-var-requires
-            const os = require("os");
-            hostname = os.hostname();
-        }
-        catch (_) {
-            if (globalThis.window) {
-                hostname = globalThis.window.location.host;
-            }
-            else {
-                hostname = "imodeljs-mobile";
-            }
-        }
-    }
-    return hostname;
-}
-/** @internal */
-class WebAppRpcLogging {
-    static async logProtocolEvent(event, object) {
-        if (object instanceof WebAppRpcRequest_1.WebAppRpcRequest) {
-            switch (event) {
-                case RpcConstants_1.RpcProtocolEvent.RequestCreated: return WebAppRpcLogging.logRequest(CommonLoggerCategory_1.CommonLoggerCategory.RpcInterfaceFrontend, "RpcInterface.frontend.request", object);
-                case RpcConstants_1.RpcProtocolEvent.ResponseLoaded: return WebAppRpcLogging.logResponse(CommonLoggerCategory_1.CommonLoggerCategory.RpcInterfaceFrontend, "RpcInterface.frontend.response", object, object.metadata.status, object.elapsed);
-                case RpcConstants_1.RpcProtocolEvent.ConnectionErrorReceived: return WebAppRpcLogging.logErrorFrontend("RpcInterface.frontend.connectionError", object);
-                case RpcConstants_1.RpcProtocolEvent.ConnectionAborted: return WebAppRpcLogging.logErrorFrontend("RpcInterface.frontend.connectionAborted", object);
-            }
-        }
-        else if (object instanceof RpcInvocation_1.RpcInvocation) {
-            switch (event) {
-                case RpcConstants_1.RpcProtocolEvent.RequestReceived: return WebAppRpcLogging.logRequest(CommonLoggerCategory_1.CommonLoggerCategory.RpcInterfaceBackend, "RpcInterface.backend.request", object.request);
-                case RpcConstants_1.RpcProtocolEvent.BackendErrorOccurred: return WebAppRpcLogging.logErrorBackend("RpcInterface.backend.error", object);
-                case RpcConstants_1.RpcProtocolEvent.BackendResponseCreated: return WebAppRpcLogging.logResponse(CommonLoggerCategory_1.CommonLoggerCategory.RpcInterfaceBackend, "RpcInterface.backend.response", object.request, object.status, object.elapsed);
-            }
-        }
-    }
-    static getRpcInterfaceName(g) {
-        return (typeof g === "string") ? g : g.interfaceName;
-    }
-    static findPathIds(path) {
-        let iTwinId = "";
-        let iModelId = "";
-        const tokens = path.split("/");
-        for (let i = 0; i !== tokens.length; ++i) {
-            // For backwards compatibility, find old "context" or current "iTwin" terminology
-            if ((/^context$/i).test(tokens[i]) || (/^itwin$/i).test(tokens[i])) {
-                iTwinId = tokens[i + 1] || "";
-            }
-            if ((/^imodel$/i).test(tokens[i])) {
-                iModelId = tokens[i + 1] || "";
-            }
-        }
-        return { iTwinId, iModelId };
-    }
-    static buildOperationDescriptor(operation) {
-        if (!operation) {
-            return "unknown.unknown";
-        }
-        const interfaceName = typeof (operation.interfaceDefinition) === "string" ? operation.interfaceDefinition : operation.interfaceDefinition.interfaceName;
-        const operationName = operation.operationName;
-        return `${interfaceName}.${operationName}`;
-    }
-    static logRequest(loggerCategory, message, object) {
-        const operationDescriptor = WebAppRpcLogging.buildOperationDescriptor(object.operation);
-        const pathIds = WebAppRpcLogging.findPathIds(object.path);
-        core_bentley_1.Logger.logTrace(loggerCategory, `${message}.${operationDescriptor}`, () => ({
-            method: object.method,
-            path: object.path,
-            operation: object.operation.operationName,
-            rpcInterface: WebAppRpcLogging.getRpcInterfaceName(object.operation.interfaceDefinition),
-            // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!
-            ActivityId: object.id,
-            TimeElapsed: ("elapsed" in object) ? object.elapsed : 0,
-            MachineName: getHostname(),
-            ...pathIds,
-        }));
-    }
-    static logResponse(loggerCategory, message, object, status, elapsed) {
-        const operationDescriptor = WebAppRpcLogging.buildOperationDescriptor(object.operation);
-        const pathIds = WebAppRpcLogging.findPathIds(object.path);
-        core_bentley_1.Logger.logTrace(loggerCategory, `${message}.${operationDescriptor}`, () => ({
-            method: object.method,
-            path: object.path,
-            operation: object.operation.operationName,
-            rpcInterface: WebAppRpcLogging.getRpcInterfaceName(object.operation.interfaceDefinition),
-            status,
-            // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!
-            ActivityId: object.id,
-            TimeElapsed: elapsed,
-            MachineName: getHostname(),
-            ...pathIds,
-        }));
-    }
-    static logErrorFrontend(message, request) {
-        const operationDescriptor = WebAppRpcLogging.buildOperationDescriptor(request.operation);
-        const pathIds = WebAppRpcLogging.findPathIds(request.path);
-        core_bentley_1.Logger.logInfo(CommonLoggerCategory_1.CommonLoggerCategory.RpcInterfaceFrontend, `${message}.${operationDescriptor}`, () => ({
-            method: request.method,
-            path: request.path,
-            // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!
-            ActivityId: request.id,
-            MachineName: getHostname(),
-            ...pathIds,
-        }));
-    }
-    static async logErrorBackend(message, invocation) {
-        const operationDescriptor = WebAppRpcLogging.buildOperationDescriptor(invocation.operation);
-        const pathIds = WebAppRpcLogging.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(CommonLoggerCategory_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: getHostname(),
-            ...pathIds,
-        }));
-    }
-}
-exports.WebAppRpcLogging = WebAppRpcLogging;
+"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.WebAppRpcLogging = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const CommonLoggerCategory_1 = require("../../CommonLoggerCategory");
+const RpcConstants_1 = require("../core/RpcConstants");
+const RpcInvocation_1 = require("../core/RpcInvocation");
+const WebAppRpcRequest_1 = require("./WebAppRpcRequest");
+let hostname = "";
+function getHostname() {
+    if (!hostname) {
+        try {
+            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            const os = require("os");
+            hostname = os.hostname();
+        }
+        catch (_) {
+            if (globalThis.window) {
+                hostname = globalThis.window.location.host;
+            }
+            else {
+                hostname = "imodeljs-mobile";
+            }
+        }
+    }
+    return hostname;
+}
+/** @internal */
+class WebAppRpcLogging {
+    static async logProtocolEvent(event, object) {
+        if (object instanceof WebAppRpcRequest_1.WebAppRpcRequest) {
+            switch (event) {
+                case RpcConstants_1.RpcProtocolEvent.RequestCreated: return WebAppRpcLogging.logRequest(CommonLoggerCategory_1.CommonLoggerCategory.RpcInterfaceFrontend, "RpcInterface.frontend.request", object);
+                case RpcConstants_1.RpcProtocolEvent.ResponseLoaded: return WebAppRpcLogging.logResponse(CommonLoggerCategory_1.CommonLoggerCategory.RpcInterfaceFrontend, "RpcInterface.frontend.response", object, object.metadata.status, object.elapsed);
+                case RpcConstants_1.RpcProtocolEvent.ConnectionErrorReceived: return WebAppRpcLogging.logErrorFrontend("RpcInterface.frontend.connectionError", object);
+                case RpcConstants_1.RpcProtocolEvent.ConnectionAborted: return WebAppRpcLogging.logErrorFrontend("RpcInterface.frontend.connectionAborted", object);
+            }
+        }
+        else if (object instanceof RpcInvocation_1.RpcInvocation) {
+            switch (event) {
+                case RpcConstants_1.RpcProtocolEvent.RequestReceived: return WebAppRpcLogging.logRequest(CommonLoggerCategory_1.CommonLoggerCategory.RpcInterfaceBackend, "RpcInterface.backend.request", object.request);
+                case RpcConstants_1.RpcProtocolEvent.BackendErrorOccurred: return WebAppRpcLogging.logErrorBackend("RpcInterface.backend.error", object);
+                case RpcConstants_1.RpcProtocolEvent.BackendResponseCreated: return WebAppRpcLogging.logResponse(CommonLoggerCategory_1.CommonLoggerCategory.RpcInterfaceBackend, "RpcInterface.backend.response", object.request, object.status, object.elapsed);
+            }
+        }
+    }
+    static getRpcInterfaceName(g) {
+        return (typeof g === "string") ? g : g.interfaceName;
+    }
+    static findPathIds(path) {
+        let iTwinId = "";
+        let iModelId = "";
+        const tokens = path.split("/");
+        for (let i = 0; i !== tokens.length; ++i) {
+            // For backwards compatibility, find old "context" or current "iTwin" terminology
+            if ((/^context$/i).test(tokens[i]) || (/^itwin$/i).test(tokens[i])) {
+                iTwinId = tokens[i + 1] || "";
+            }
+            if ((/^imodel$/i).test(tokens[i])) {
+                iModelId = tokens[i + 1] || "";
+            }
+        }
+        return { iTwinId, iModelId };
+    }
+    static buildOperationDescriptor(operation) {
+        if (!operation) {
+            return "unknown.unknown";
+        }
+        const interfaceName = typeof (operation.interfaceDefinition) === "string" ? operation.interfaceDefinition : operation.interfaceDefinition.interfaceName;
+        const operationName = operation.operationName;
+        return `${interfaceName}.${operationName}`;
+    }
+    static logRequest(loggerCategory, message, object) {
+        const operationDescriptor = WebAppRpcLogging.buildOperationDescriptor(object.operation);
+        const pathIds = WebAppRpcLogging.findPathIds(object.path);
+        core_bentley_1.Logger.logTrace(loggerCategory, `${message}.${operationDescriptor}`, () => ({
+            method: object.method,
+            path: object.path,
+            operation: object.operation.operationName,
+            rpcInterface: WebAppRpcLogging.getRpcInterfaceName(object.operation.interfaceDefinition),
+            // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!
+            ActivityId: object.id,
+            TimeElapsed: ("elapsed" in object) ? object.elapsed : 0,
+            MachineName: getHostname(),
+            ...pathIds,
+        }));
+    }
+    static logResponse(loggerCategory, message, object, status, elapsed) {
+        const operationDescriptor = WebAppRpcLogging.buildOperationDescriptor(object.operation);
+        const pathIds = WebAppRpcLogging.findPathIds(object.path);
+        core_bentley_1.Logger.logTrace(loggerCategory, `${message}.${operationDescriptor}`, () => ({
+            method: object.method,
+            path: object.path,
+            operation: object.operation.operationName,
+            rpcInterface: WebAppRpcLogging.getRpcInterfaceName(object.operation.interfaceDefinition),
+            status,
+            // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!
+            ActivityId: object.id,
+            TimeElapsed: elapsed,
+            MachineName: getHostname(),
+            ...pathIds,
+        }));
+    }
+    static logErrorFrontend(message, request) {
+        const operationDescriptor = WebAppRpcLogging.buildOperationDescriptor(request.operation);
+        const pathIds = WebAppRpcLogging.findPathIds(request.path);
+        core_bentley_1.Logger.logInfo(CommonLoggerCategory_1.CommonLoggerCategory.RpcInterfaceFrontend, `${message}.${operationDescriptor}`, () => ({
+            method: request.method,
+            path: request.path,
+            // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!
+            ActivityId: request.id,
+            MachineName: getHostname(),
+            ...pathIds,
+        }));
+    }
+    static async logErrorBackend(message, invocation) {
+        const operationDescriptor = WebAppRpcLogging.buildOperationDescriptor(invocation.operation);
+        const pathIds = WebAppRpcLogging.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(CommonLoggerCategory_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: getHostname(),
+            ...pathIds,
+        }));
+    }
+}
+exports.WebAppRpcLogging = WebAppRpcLogging;
 //# sourceMappingURL=WebAppRpcLogging.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"WebAppRpcLogging.js","sourceRoot":"","sources":["../../../../src/rpc/web/WebAppRpcLogging.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6C;AAC7C,qEAAkE;AAElE,uDAAwD;AACxD,yDAAsD;AAItD,yDAAsD;AAEtD,IAAI,QAAQ,GAAG,EAAE,CAAC;AAClB,SAAS,WAAW;IAClB,IAAI,CAAC,QAAQ,EAAE;QACb,IAAI;YACF,8DAA8D;YAC9D,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;YACzB,QAAQ,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;SAC1B;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,UAAU,CAAC,MAAM,EAAE;gBACrB,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;aAC5C;iBAAM;gBACL,QAAQ,GAAG,iBAAiB,CAAC;aAC9B;SACF;KACF;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,gBAAgB;AAChB,MAAa,gBAAgB;IACpB,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,KAAuB,EAAE,MAAkC;QAC9F,IAAI,MAAM,YAAY,mCAAgB,EAAE;YACtC,QAAQ,KAAK,EAAE;gBACb,KAAK,+BAAgB,CAAC,cAAc,CAAC,CAAC,OAAO,gBAAgB,CAAC,UAAU,CAAC,2CAAoB,CAAC,oBAAoB,EAAE,+BAA+B,EAAE,MAAM,CAAC,CAAC;gBAC7J,KAAK,+BAAgB,CAAC,cAAc,CAAC,CAAC,OAAO,gBAAgB,CAAC,WAAW,CAAC,2CAAoB,CAAC,oBAAoB,EAAE,gCAAgC,EAAE,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;gBACvM,KAAK,+BAAgB,CAAC,uBAAuB,CAAC,CAAC,OAAO,gBAAgB,CAAC,gBAAgB,CAAC,uCAAuC,EAAE,MAAM,CAAC,CAAC;gBACzI,KAAK,+BAAgB,CAAC,iBAAiB,CAAC,CAAC,OAAO,gBAAgB,CAAC,gBAAgB,CAAC,yCAAyC,EAAE,MAAM,CAAC,CAAC;aACtI;SACF;aAAM,IAAI,MAAM,YAAY,6BAAa,EAAE;YAC1C,QAAQ,KAAK,EAAE;gBACb,KAAK,+BAAgB,CAAC,eAAe,CAAC,CAAC,OAAO,gBAAgB,CAAC,UAAU,CAAC,2CAAoB,CAAC,mBAAmB,EAAE,8BAA8B,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;gBACpK,KAAK,+BAAgB,CAAC,oBAAoB,CAAC,CAAC,OAAO,gBAAgB,CAAC,eAAe,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;gBAC1H,KAAK,+BAAgB,CAAC,sBAAsB,CAAC,CAAC,OAAO,gBAAgB,CAAC,WAAW,CAAC,2CAAoB,CAAC,mBAAmB,EAAE,+BAA+B,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;aAC7M;SACF;IACH,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,CAAkC;QACnE,OAAO,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;IACvD,CAAC;IAEO,MAAM,CAAC,WAAW,CAAC,IAAY;QACrC,IAAI,OAAO,GAAG,EAAE,CAAC;QACjB,IAAI,QAAQ,GAAG,EAAE,CAAC;QAElB,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YACxC,iFAAiF;YACjF,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE;gBAClE,OAAO,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;aAC/B;YAED,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE;gBACjC,QAAQ,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;aAChC;SACF;QAED,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;IAC/B,CAAC;IAEO,MAAM,CAAC,wBAAwB,CAAC,SAAgD;QACtF,IAAI,CAAC,SAAS,EAAE;YACd,OAAO,iBAAiB,CAAC;SAC1B;QAED,MAAM,aAAa,GAAG,OAAO,CAAC,SAAS,CAAC,mBAAmB,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC,mBAAmB,CAAC,aAAa,CAAC;QACxJ,MAAM,aAAa,GAAG,SAAS,CAAC,aAAa,CAAC;QAC9C,OAAO,GAAG,aAAa,IAAI,aAAa,EAAE,CAAC;IAC7C,CAAC;IAEO,MAAM,CAAC,UAAU,CAAC,cAAsB,EAAE,OAAe,EAAE,MAA+C;QAChH,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,wBAAwB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACxF,MAAM,OAAO,GAAG,gBAAgB,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAE1D,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,GAAG,OAAO,IAAI,mBAAmB,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;YAC1E,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,aAAa;YACzC,YAAY,EAAE,gBAAgB,CAAC,mBAAmB,CAAC,MAAM,CAAC,SAAS,CAAC,mBAAmB,CAAC;YACxF,uGAAuG;YACvG,UAAU,EAAE,MAAM,CAAC,EAAE;YACrB,WAAW,EAAE,CAAC,SAAS,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACvD,WAAW,EAAE,WAAW,EAAE;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC,CAAC;IACN,CAAC;IAEO,MAAM,CAAC,WAAW,CAAC,cAAsB,EAAE,OAAe,EAAE,MAA+C,EAAE,MAAc,EAAE,OAAe;QAClJ,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,wBAAwB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACxF,MAAM,OAAO,GAAG,gBAAgB,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAE1D,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,GAAG,OAAO,IAAI,mBAAmB,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;YAC1E,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,aAAa;YACzC,YAAY,EAAE,gBAAgB,CAAC,mBAAmB,CAAC,MAAM,CAAC,SAAS,CAAC,mBAAmB,CAAC;YACxF,MAAM;YACN,uGAAuG;YACvG,UAAU,EAAE,MAAM,CAAC,EAAE;YACrB,WAAW,EAAE,OAAO;YACpB,WAAW,EAAE,WAAW,EAAE;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC,CAAC;IACN,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,OAAe,EAAE,OAAyB;QACxE,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,wBAAwB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACzF,MAAM,OAAO,GAAG,gBAAgB,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAE3D,qBAAM,CAAC,OAAO,CAAC,2CAAoB,CAAC,oBAAoB,EAAE,GAAG,OAAO,IAAI,mBAAmB,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;YACpG,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,uGAAuG;YACvG,UAAU,EAAE,OAAO,CAAC,EAAE;YACtB,WAAW,EAAE,WAAW,EAAE;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC,CAAC;IACN,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,OAAe,EAAE,UAAyB;QAC7E,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,wBAAwB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAC5F,MAAM,OAAO,GAAG,gBAAgB,CAAC,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtE,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,2CAAoB,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,WAAW,EAAE;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC,CAAC;IACN,CAAC;CACF;AArHD,4CAqHC","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 } from \"../../CommonLoggerCategory\";\nimport { RpcInterfaceDefinition } from \"../../RpcInterface\";\nimport { RpcProtocolEvent } from \"../core/RpcConstants\";\nimport { RpcInvocation } from \"../core/RpcInvocation\";\nimport { RpcOperation } from \"../core/RpcOperation\";\nimport { SerializedRpcOperation, SerializedRpcRequest } from \"../core/RpcProtocol\";\nimport { RpcRequest } from \"../core/RpcRequest\";\nimport { WebAppRpcRequest } from \"./WebAppRpcRequest\";\n\nlet hostname = \"\";\nfunction getHostname(): string {\n  if (!hostname) {\n    try {\n      // eslint-disable-next-line @typescript-eslint/no-var-requires\n      const os = require(\"os\");\n      hostname = os.hostname();\n    } catch (_) {\n      if (globalThis.window) {\n        hostname = globalThis.window.location.host;\n      } else {\n        hostname = \"imodeljs-mobile\";\n      }\n    }\n  }\n  return hostname;\n}\n\n/** @internal */\nexport class WebAppRpcLogging {\n  public static async logProtocolEvent(event: RpcProtocolEvent, object: RpcRequest | RpcInvocation): Promise<void> {\n    if (object instanceof WebAppRpcRequest) {\n      switch (event) {\n        case RpcProtocolEvent.RequestCreated: return WebAppRpcLogging.logRequest(CommonLoggerCategory.RpcInterfaceFrontend, \"RpcInterface.frontend.request\", object);\n        case RpcProtocolEvent.ResponseLoaded: return WebAppRpcLogging.logResponse(CommonLoggerCategory.RpcInterfaceFrontend, \"RpcInterface.frontend.response\", object, object.metadata.status, object.elapsed);\n        case RpcProtocolEvent.ConnectionErrorReceived: return WebAppRpcLogging.logErrorFrontend(\"RpcInterface.frontend.connectionError\", object);\n        case RpcProtocolEvent.ConnectionAborted: return WebAppRpcLogging.logErrorFrontend(\"RpcInterface.frontend.connectionAborted\", object);\n      }\n    } else if (object instanceof RpcInvocation) {\n      switch (event) {\n        case RpcProtocolEvent.RequestReceived: return WebAppRpcLogging.logRequest(CommonLoggerCategory.RpcInterfaceBackend, \"RpcInterface.backend.request\", object.request);\n        case RpcProtocolEvent.BackendErrorOccurred: return WebAppRpcLogging.logErrorBackend(\"RpcInterface.backend.error\", object);\n        case RpcProtocolEvent.BackendResponseCreated: return WebAppRpcLogging.logResponse(CommonLoggerCategory.RpcInterfaceBackend, \"RpcInterface.backend.response\", object.request, object.status, object.elapsed);\n      }\n    }\n  }\n\n  private static getRpcInterfaceName(g: string | RpcInterfaceDefinition): string {\n    return (typeof g === \"string\") ? g : g.interfaceName;\n  }\n\n  private static findPathIds(path: string) {\n    let iTwinId = \"\";\n    let iModelId = \"\";\n\n    const tokens = path.split(\"/\");\n    for (let i = 0; i !== tokens.length; ++i) {\n      // For backwards compatibility, find old \"context\" or current \"iTwin\" terminology\n      if ((/^context$/i).test(tokens[i]) || (/^itwin$/i).test(tokens[i])) {\n        iTwinId = tokens[i + 1] || \"\";\n      }\n\n      if ((/^imodel$/i).test(tokens[i])) {\n        iModelId = tokens[i + 1] || \"\";\n      }\n    }\n\n    return { iTwinId, iModelId };\n  }\n\n  private static buildOperationDescriptor(operation: RpcOperation | SerializedRpcOperation): string {\n    if (!operation) {\n      return \"unknown.unknown\";\n    }\n\n    const interfaceName = typeof (operation.interfaceDefinition) === \"string\" ? operation.interfaceDefinition : operation.interfaceDefinition.interfaceName;\n    const operationName = operation.operationName;\n    return `${interfaceName}.${operationName}`;\n  }\n\n  private static logRequest(loggerCategory: string, message: string, object: WebAppRpcRequest | SerializedRpcRequest): void {\n    const operationDescriptor = WebAppRpcLogging.buildOperationDescriptor(object.operation);\n    const pathIds = WebAppRpcLogging.findPathIds(object.path);\n\n    Logger.logTrace(loggerCategory, `${message}.${operationDescriptor}`, () => ({\n      method: object.method,\n      path: object.path,\n      operation: object.operation.operationName,\n      rpcInterface: WebAppRpcLogging.getRpcInterfaceName(object.operation.interfaceDefinition),\n      // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!\n      ActivityId: object.id, // eslint-disable-line @typescript-eslint/naming-convention\n      TimeElapsed: (\"elapsed\" in object) ? object.elapsed : 0, // eslint-disable-line @typescript-eslint/naming-convention\n      MachineName: getHostname(), // eslint-disable-line @typescript-eslint/naming-convention\n      ...pathIds,\n    }));\n  }\n\n  private static logResponse(loggerCategory: string, message: string, object: WebAppRpcRequest | SerializedRpcRequest, status: number, elapsed: number): void {\n    const operationDescriptor = WebAppRpcLogging.buildOperationDescriptor(object.operation);\n    const pathIds = WebAppRpcLogging.findPathIds(object.path);\n\n    Logger.logTrace(loggerCategory, `${message}.${operationDescriptor}`, () => ({\n      method: object.method,\n      path: object.path,\n      operation: object.operation.operationName,\n      rpcInterface: WebAppRpcLogging.getRpcInterfaceName(object.operation.interfaceDefinition),\n      status,\n      // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!\n      ActivityId: object.id, // eslint-disable-line @typescript-eslint/naming-convention\n      TimeElapsed: elapsed, // eslint-disable-line @typescript-eslint/naming-convention\n      MachineName: getHostname(), // eslint-disable-line @typescript-eslint/naming-convention\n      ...pathIds,\n    }));\n  }\n\n  private static logErrorFrontend(message: string, request: WebAppRpcRequest): void {\n    const operationDescriptor = WebAppRpcLogging.buildOperationDescriptor(request.operation);\n    const pathIds = WebAppRpcLogging.findPathIds(request.path);\n\n    Logger.logInfo(CommonLoggerCategory.RpcInterfaceFrontend, `${message}.${operationDescriptor}`, () => ({\n      method: request.method,\n      path: request.path,\n      // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!\n      ActivityId: request.id, // eslint-disable-line @typescript-eslint/naming-convention\n      MachineName: getHostname(), // eslint-disable-line @typescript-eslint/naming-convention\n      ...pathIds,\n    }));\n  }\n\n  private static async logErrorBackend(message: string, invocation: RpcInvocation): Promise<void> {\n    const operationDescriptor = WebAppRpcLogging.buildOperationDescriptor(invocation.operation);\n    const pathIds = WebAppRpcLogging.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: getHostname(), // eslint-disable-line @typescript-eslint/naming-convention\n      ...pathIds,\n    }));\n  }\n}\n"]}
+{"version":3,"file":"WebAppRpcLogging.js","sourceRoot":"","sources":["../../../../src/rpc/web/WebAppRpcLogging.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6C;AAC7C,qEAAkE;AAElE,uDAAwD;AACxD,yDAAsD;AAItD,yDAAsD;AAEtD,IAAI,QAAQ,GAAG,EAAE,CAAC;AAClB,SAAS,WAAW;IAClB,IAAI,CAAC,QAAQ,EAAE;QACb,IAAI;YACF,8DAA8D;YAC9D,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;YACzB,QAAQ,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;SAC1B;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,UAAU,CAAC,MAAM,EAAE;gBACrB,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;aAC5C;iBAAM;gBACL,QAAQ,GAAG,iBAAiB,CAAC;aAC9B;SACF;KACF;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,gBAAgB;AAChB,MAAa,gBAAgB;IACpB,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,KAAuB,EAAE,MAAkC;QAC9F,IAAI,MAAM,YAAY,mCAAgB,EAAE;YACtC,QAAQ,KAAK,EAAE;gBACb,KAAK,+BAAgB,CAAC,cAAc,CAAC,CAAC,OAAO,gBAAgB,CAAC,UAAU,CAAC,2CAAoB,CAAC,oBAAoB,EAAE,+BAA+B,EAAE,MAAM,CAAC,CAAC;gBAC7J,KAAK,+BAAgB,CAAC,cAAc,CAAC,CAAC,OAAO,gBAAgB,CAAC,WAAW,CAAC,2CAAoB,CAAC,oBAAoB,EAAE,gCAAgC,EAAE,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;gBACvM,KAAK,+BAAgB,CAAC,uBAAuB,CAAC,CAAC,OAAO,gBAAgB,CAAC,gBAAgB,CAAC,uCAAuC,EAAE,MAAM,CAAC,CAAC;gBACzI,KAAK,+BAAgB,CAAC,iBAAiB,CAAC,CAAC,OAAO,gBAAgB,CAAC,gBAAgB,CAAC,yCAAyC,EAAE,MAAM,CAAC,CAAC;aACtI;SACF;aAAM,IAAI,MAAM,YAAY,6BAAa,EAAE;YAC1C,QAAQ,KAAK,EAAE;gBACb,KAAK,+BAAgB,CAAC,eAAe,CAAC,CAAC,OAAO,gBAAgB,CAAC,UAAU,CAAC,2CAAoB,CAAC,mBAAmB,EAAE,8BAA8B,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;gBACpK,KAAK,+BAAgB,CAAC,oBAAoB,CAAC,CAAC,OAAO,gBAAgB,CAAC,eAAe,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;gBAC1H,KAAK,+BAAgB,CAAC,sBAAsB,CAAC,CAAC,OAAO,gBAAgB,CAAC,WAAW,CAAC,2CAAoB,CAAC,mBAAmB,EAAE,+BAA+B,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;aAC7M;SACF;IACH,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,CAAkC;QACnE,OAAO,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;IACvD,CAAC;IAEO,MAAM,CAAC,WAAW,CAAC,IAAY;QACrC,IAAI,OAAO,GAAG,EAAE,CAAC;QACjB,IAAI,QAAQ,GAAG,EAAE,CAAC;QAElB,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YACxC,iFAAiF;YACjF,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE;gBAClE,OAAO,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;aAC/B;YAED,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE;gBACjC,QAAQ,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;aAChC;SACF;QAED,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;IAC/B,CAAC;IAEO,MAAM,CAAC,wBAAwB,CAAC,SAAgD;QACtF,IAAI,CAAC,SAAS,EAAE;YACd,OAAO,iBAAiB,CAAC;SAC1B;QAED,MAAM,aAAa,GAAG,OAAO,CAAC,SAAS,CAAC,mBAAmB,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC,mBAAmB,CAAC,aAAa,CAAC;QACxJ,MAAM,aAAa,GAAG,SAAS,CAAC,aAAa,CAAC;QAC9C,OAAO,GAAG,aAAa,IAAI,aAAa,EAAE,CAAC;IAC7C,CAAC;IAEO,MAAM,CAAC,UAAU,CAAC,cAAsB,EAAE,OAAe,EAAE,MAA+C;QAChH,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,wBAAwB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACxF,MAAM,OAAO,GAAG,gBAAgB,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAE1D,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,GAAG,OAAO,IAAI,mBAAmB,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;YAC1E,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,aAAa;YACzC,YAAY,EAAE,gBAAgB,CAAC,mBAAmB,CAAC,MAAM,CAAC,SAAS,CAAC,mBAAmB,CAAC;YACxF,uGAAuG;YACvG,UAAU,EAAE,MAAM,CAAC,EAAE;YACrB,WAAW,EAAE,CAAC,SAAS,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACvD,WAAW,EAAE,WAAW,EAAE;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC,CAAC;IACN,CAAC;IAEO,MAAM,CAAC,WAAW,CAAC,cAAsB,EAAE,OAAe,EAAE,MAA+C,EAAE,MAAc,EAAE,OAAe;QAClJ,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,wBAAwB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACxF,MAAM,OAAO,GAAG,gBAAgB,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAE1D,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,GAAG,OAAO,IAAI,mBAAmB,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;YAC1E,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,aAAa;YACzC,YAAY,EAAE,gBAAgB,CAAC,mBAAmB,CAAC,MAAM,CAAC,SAAS,CAAC,mBAAmB,CAAC;YACxF,MAAM;YACN,uGAAuG;YACvG,UAAU,EAAE,MAAM,CAAC,EAAE;YACrB,WAAW,EAAE,OAAO;YACpB,WAAW,EAAE,WAAW,EAAE;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC,CAAC;IACN,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,OAAe,EAAE,OAAyB;QACxE,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,wBAAwB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACzF,MAAM,OAAO,GAAG,gBAAgB,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAE3D,qBAAM,CAAC,OAAO,CAAC,2CAAoB,CAAC,oBAAoB,EAAE,GAAG,OAAO,IAAI,mBAAmB,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;YACpG,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,uGAAuG;YACvG,UAAU,EAAE,OAAO,CAAC,EAAE;YACtB,WAAW,EAAE,WAAW,EAAE;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC,CAAC;IACN,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,OAAe,EAAE,UAAyB;QAC7E,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,wBAAwB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAC5F,MAAM,OAAO,GAAG,gBAAgB,CAAC,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtE,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,2CAAoB,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,WAAW,EAAE;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC,CAAC;IACN,CAAC;CACF;AArHD,4CAqHC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module RpcInterface\r\n */\r\n\r\nimport { Logger } from \"@itwin/core-bentley\";\r\nimport { CommonLoggerCategory } from \"../../CommonLoggerCategory\";\r\nimport { RpcInterfaceDefinition } from \"../../RpcInterface\";\r\nimport { RpcProtocolEvent } from \"../core/RpcConstants\";\r\nimport { RpcInvocation } from \"../core/RpcInvocation\";\r\nimport { RpcOperation } from \"../core/RpcOperation\";\r\nimport { SerializedRpcOperation, SerializedRpcRequest } from \"../core/RpcProtocol\";\r\nimport { RpcRequest } from \"../core/RpcRequest\";\r\nimport { WebAppRpcRequest } from \"./WebAppRpcRequest\";\r\n\r\nlet hostname = \"\";\r\nfunction getHostname(): string {\r\n  if (!hostname) {\r\n    try {\r\n      // eslint-disable-next-line @typescript-eslint/no-var-requires\r\n      const os = require(\"os\");\r\n      hostname = os.hostname();\r\n    } catch (_) {\r\n      if (globalThis.window) {\r\n        hostname = globalThis.window.location.host;\r\n      } else {\r\n        hostname = \"imodeljs-mobile\";\r\n      }\r\n    }\r\n  }\r\n  return hostname;\r\n}\r\n\r\n/** @internal */\r\nexport class WebAppRpcLogging {\r\n  public static async logProtocolEvent(event: RpcProtocolEvent, object: RpcRequest | RpcInvocation): Promise<void> {\r\n    if (object instanceof WebAppRpcRequest) {\r\n      switch (event) {\r\n        case RpcProtocolEvent.RequestCreated: return WebAppRpcLogging.logRequest(CommonLoggerCategory.RpcInterfaceFrontend, \"RpcInterface.frontend.request\", object);\r\n        case RpcProtocolEvent.ResponseLoaded: return WebAppRpcLogging.logResponse(CommonLoggerCategory.RpcInterfaceFrontend, \"RpcInterface.frontend.response\", object, object.metadata.status, object.elapsed);\r\n        case RpcProtocolEvent.ConnectionErrorReceived: return WebAppRpcLogging.logErrorFrontend(\"RpcInterface.frontend.connectionError\", object);\r\n        case RpcProtocolEvent.ConnectionAborted: return WebAppRpcLogging.logErrorFrontend(\"RpcInterface.frontend.connectionAborted\", object);\r\n      }\r\n    } else if (object instanceof RpcInvocation) {\r\n      switch (event) {\r\n        case RpcProtocolEvent.RequestReceived: return WebAppRpcLogging.logRequest(CommonLoggerCategory.RpcInterfaceBackend, \"RpcInterface.backend.request\", object.request);\r\n        case RpcProtocolEvent.BackendErrorOccurred: return WebAppRpcLogging.logErrorBackend(\"RpcInterface.backend.error\", object);\r\n        case RpcProtocolEvent.BackendResponseCreated: return WebAppRpcLogging.logResponse(CommonLoggerCategory.RpcInterfaceBackend, \"RpcInterface.backend.response\", object.request, object.status, object.elapsed);\r\n      }\r\n    }\r\n  }\r\n\r\n  private static getRpcInterfaceName(g: string | RpcInterfaceDefinition): string {\r\n    return (typeof g === \"string\") ? g : g.interfaceName;\r\n  }\r\n\r\n  private static findPathIds(path: string) {\r\n    let iTwinId = \"\";\r\n    let iModelId = \"\";\r\n\r\n    const tokens = path.split(\"/\");\r\n    for (let i = 0; i !== tokens.length; ++i) {\r\n      // For backwards compatibility, find old \"context\" or current \"iTwin\" terminology\r\n      if ((/^context$/i).test(tokens[i]) || (/^itwin$/i).test(tokens[i])) {\r\n        iTwinId = tokens[i + 1] || \"\";\r\n      }\r\n\r\n      if ((/^imodel$/i).test(tokens[i])) {\r\n        iModelId = tokens[i + 1] || \"\";\r\n      }\r\n    }\r\n\r\n    return { iTwinId, iModelId };\r\n  }\r\n\r\n  private static buildOperationDescriptor(operation: RpcOperation | SerializedRpcOperation): string {\r\n    if (!operation) {\r\n      return \"unknown.unknown\";\r\n    }\r\n\r\n    const interfaceName = typeof (operation.interfaceDefinition) === \"string\" ? operation.interfaceDefinition : operation.interfaceDefinition.interfaceName;\r\n    const operationName = operation.operationName;\r\n    return `${interfaceName}.${operationName}`;\r\n  }\r\n\r\n  private static logRequest(loggerCategory: string, message: string, object: WebAppRpcRequest | SerializedRpcRequest): void {\r\n    const operationDescriptor = WebAppRpcLogging.buildOperationDescriptor(object.operation);\r\n    const pathIds = WebAppRpcLogging.findPathIds(object.path);\r\n\r\n    Logger.logTrace(loggerCategory, `${message}.${operationDescriptor}`, () => ({\r\n      method: object.method,\r\n      path: object.path,\r\n      operation: object.operation.operationName,\r\n      rpcInterface: WebAppRpcLogging.getRpcInterfaceName(object.operation.interfaceDefinition),\r\n      // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!\r\n      ActivityId: object.id, // eslint-disable-line @typescript-eslint/naming-convention\r\n      TimeElapsed: (\"elapsed\" in object) ? object.elapsed : 0, // eslint-disable-line @typescript-eslint/naming-convention\r\n      MachineName: getHostname(), // eslint-disable-line @typescript-eslint/naming-convention\r\n      ...pathIds,\r\n    }));\r\n  }\r\n\r\n  private static logResponse(loggerCategory: string, message: string, object: WebAppRpcRequest | SerializedRpcRequest, status: number, elapsed: number): void {\r\n    const operationDescriptor = WebAppRpcLogging.buildOperationDescriptor(object.operation);\r\n    const pathIds = WebAppRpcLogging.findPathIds(object.path);\r\n\r\n    Logger.logTrace(loggerCategory, `${message}.${operationDescriptor}`, () => ({\r\n      method: object.method,\r\n      path: object.path,\r\n      operation: object.operation.operationName,\r\n      rpcInterface: WebAppRpcLogging.getRpcInterfaceName(object.operation.interfaceDefinition),\r\n      status,\r\n      // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!\r\n      ActivityId: object.id, // eslint-disable-line @typescript-eslint/naming-convention\r\n      TimeElapsed: elapsed, // eslint-disable-line @typescript-eslint/naming-convention\r\n      MachineName: getHostname(), // eslint-disable-line @typescript-eslint/naming-convention\r\n      ...pathIds,\r\n    }));\r\n  }\r\n\r\n  private static logErrorFrontend(message: string, request: WebAppRpcRequest): void {\r\n    const operationDescriptor = WebAppRpcLogging.buildOperationDescriptor(request.operation);\r\n    const pathIds = WebAppRpcLogging.findPathIds(request.path);\r\n\r\n    Logger.logInfo(CommonLoggerCategory.RpcInterfaceFrontend, `${message}.${operationDescriptor}`, () => ({\r\n      method: request.method,\r\n      path: request.path,\r\n      // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!\r\n      ActivityId: request.id, // eslint-disable-line @typescript-eslint/naming-convention\r\n      MachineName: getHostname(), // eslint-disable-line @typescript-eslint/naming-convention\r\n      ...pathIds,\r\n    }));\r\n  }\r\n\r\n  private static async logErrorBackend(message: string, invocation: RpcInvocation): Promise<void> {\r\n    const operationDescriptor = WebAppRpcLogging.buildOperationDescriptor(invocation.operation);\r\n    const pathIds = WebAppRpcLogging.findPathIds(invocation.request.path);\r\n    const result = await invocation.result;\r\n    const errorMessage = result.message ? result.message : result.objects; // Can be an error or an RpcSerializedValue\r\n\r\n    Logger.logInfo(CommonLoggerCategory.RpcInterfaceBackend, `${message}.${operationDescriptor}`, () => ({\r\n      method: invocation.request.method,\r\n      path: invocation.request.path,\r\n      status: invocation.status,\r\n      errorMessage,\r\n      // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!\r\n      ActivityId: invocation.request.id, // eslint-disable-line @typescript-eslint/naming-convention\r\n      MachineName: getHostname(), // eslint-disable-line @typescript-eslint/naming-convention\r\n      ...pathIds,\r\n    }));\r\n  }\r\n}\r\n"]}

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

@@ -1,87 +1,87 @@
-/** @packageDocumentation
- * @module RpcInterface
- */
-/// <reference types="node" />
-import { Readable, Writable } from "stream";
-import { RpcConfiguration } from "../core/RpcConfiguration";
-import { RpcContentType, RpcRequestStatus } from "../core/RpcConstants";
-import { RpcOperation } from "../core/RpcOperation";
-import { RpcProtocol } from "../core/RpcProtocol";
-import { OpenAPIInfo, OpenAPIParameter, RpcOpenAPIDescription } from "./OpenAPI";
-import { WebAppRpcRequest } from "./WebAppRpcRequest";
-/** An HTTP server request object.
- * @public
- */
-export interface HttpServerRequest extends Readable {
-    aborted: boolean;
-    httpVersion: string;
-    httpVersionMajor: number;
-    httpVersionMinor: number;
-    complete: boolean;
-    connection: any;
-    headers: {
-        [header: string]: string | string[] | undefined;
-    };
-    rawHeaders: string[];
-    trailers: {
-        [key: string]: string | undefined;
-    };
-    rawTrailers: string[];
-    setTimeout(msecs: number, callback: () => void): this;
-    url?: string;
-    statusCode?: number;
-    statusMessage?: string;
-    socket: any;
-    destroy(error?: Error): this;
-    body: string | Buffer;
-    path: string;
-    method: string;
-    ip?: string;
-    header: (field: string) => string | undefined;
-}
-/** An HTTP server response object.
- * @public
- */
-export interface HttpServerResponse extends Writable {
-    send(body?: any): HttpServerResponse;
-    status(code: number): HttpServerResponse;
-    set(field: string, value: string): void;
-}
-/** The HTTP application protocol.
- * @internal
- */
-export declare abstract class WebAppRpcProtocol extends RpcProtocol {
-    preserveStreams: boolean;
-    /** Convenience handler for an RPC operation get request for an HTTP server. */
-    handleOperationGetRequest(req: HttpServerRequest, res: HttpServerResponse): Promise<void>;
-    /** Convenience handler for an RPC operation post request for an HTTP server. */
-    handleOperationPostRequest(req: HttpServerRequest, res: HttpServerResponse): Promise<void>;
-    /** Convenience handler for an OpenAPI description request for an HTTP server. */
-    handleOpenApiDescriptionRequest(_req: HttpServerRequest, res: HttpServerResponse): void;
-    /** Converts an HTTP content type value to an RPC content type value. */
-    static computeContentType(httpType: string | null | undefined): RpcContentType;
-    /** The OpenAPI-compatible info object for this protocol. */
-    abstract info: OpenAPIInfo;
-    /** An optional prefix for RPC operation URI paths. */
-    pathPrefix: string;
-    /** The RPC request class for this protocol. */
-    readonly requestType: typeof WebAppRpcRequest;
-    /** Supplies the status corresponding to a protocol-specific code value. */
-    getStatus(code: number): RpcRequestStatus;
-    /** Supplies the protocol-specific code corresponding to a status value. */
-    getCode(status: RpcRequestStatus): number;
-    supportsStatusCategory: boolean;
-    /** Whether an HTTP status code indicates a request timeout. */
-    isTimeout(code: number): boolean;
-    /** An OpenAPI-compatible description of this protocol.
-     * @internal
-     */
-    get openAPIDescription(): RpcOpenAPIDescription;
-    /** Returns the OpenAPI-compatible URI path parameters for an RPC operation.
-     * @internal
-     */
-    abstract supplyPathParametersForOperation(_operation: RpcOperation): OpenAPIParameter[];
-    /** Constructs an HTTP protocol. */
-    constructor(configuration: RpcConfiguration);
-}
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+/// <reference types="node" />
+import { Readable, Writable } from "stream";
+import { RpcConfiguration } from "../core/RpcConfiguration";
+import { RpcContentType, RpcRequestStatus } from "../core/RpcConstants";
+import { RpcOperation } from "../core/RpcOperation";
+import { RpcProtocol } from "../core/RpcProtocol";
+import { OpenAPIInfo, OpenAPIParameter, RpcOpenAPIDescription } from "./OpenAPI";
+import { WebAppRpcRequest } from "./WebAppRpcRequest";
+/** An HTTP server request object.
+ * @public
+ */
+export interface HttpServerRequest extends Readable {
+    aborted: boolean;
+    httpVersion: string;
+    httpVersionMajor: number;
+    httpVersionMinor: number;
+    complete: boolean;
+    connection: any;
+    headers: {
+        [header: string]: string | string[] | undefined;
+    };
+    rawHeaders: string[];
+    trailers: {
+        [key: string]: string | undefined;
+    };
+    rawTrailers: string[];
+    setTimeout(msecs: number, callback: () => void): this;
+    url?: string;
+    statusCode?: number;
+    statusMessage?: string;
+    socket: any;
+    destroy(error?: Error): this;
+    body: string | Buffer;
+    path: string;
+    method: string;
+    ip?: string;
+    header: (field: string) => string | undefined;
+}
+/** An HTTP server response object.
+ * @public
+ */
+export interface HttpServerResponse extends Writable {
+    send(body?: any): HttpServerResponse;
+    status(code: number): HttpServerResponse;
+    set(field: string, value: string): void;
+}
+/** The HTTP application protocol.
+ * @internal
+ */
+export declare abstract class WebAppRpcProtocol extends RpcProtocol {
+    preserveStreams: boolean;
+    /** Convenience handler for an RPC operation get request for an HTTP server. */
+    handleOperationGetRequest(req: HttpServerRequest, res: HttpServerResponse): Promise<void>;
+    /** Convenience handler for an RPC operation post request for an HTTP server. */
+    handleOperationPostRequest(req: HttpServerRequest, res: HttpServerResponse): Promise<void>;
+    /** Convenience handler for an OpenAPI description request for an HTTP server. */
+    handleOpenApiDescriptionRequest(_req: HttpServerRequest, res: HttpServerResponse): void;
+    /** Converts an HTTP content type value to an RPC content type value. */
+    static computeContentType(httpType: string | null | undefined): RpcContentType;
+    /** The OpenAPI-compatible info object for this protocol. */
+    abstract info: OpenAPIInfo;
+    /** An optional prefix for RPC operation URI paths. */
+    pathPrefix: string;
+    /** The RPC request class for this protocol. */
+    readonly requestType: typeof WebAppRpcRequest;
+    /** Supplies the status corresponding to a protocol-specific code value. */
+    getStatus(code: number): RpcRequestStatus;
+    /** Supplies the protocol-specific code corresponding to a status value. */
+    getCode(status: RpcRequestStatus): number;
+    supportsStatusCategory: boolean;
+    /** Whether an HTTP status code indicates a request timeout. */
+    isTimeout(code: number): boolean;
+    /** An OpenAPI-compatible description of this protocol.
+     * @internal
+     */
+    get openAPIDescription(): RpcOpenAPIDescription;
+    /** Returns the OpenAPI-compatible URI path parameters for an RPC operation.
+     * @internal
+     */
+    abstract supplyPathParametersForOperation(_operation: RpcOperation): OpenAPIParameter[];
+    /** Constructs an HTTP protocol. */
+    constructor(configuration: RpcConfiguration);
+}
 //# sourceMappingURL=WebAppRpcProtocol.d.ts.map