@contrail/flexplm 1.8.1 → 2.0.0-alpha.df05bb5

package/lib/__tests__/telemetry-test-utils.d.ts

@@ -0,0 +1,8 @@
+import { InMemorySpanExporter, ReadableSpan } from '@opentelemetry/sdk-trace-base';
+/** Registers an in-memory tracer provider, so spans created by traceSection/@Traced can be asserted on.
+ * Call once per spec file (in beforeAll); jest gives each spec file its own globals.
+ */
+export declare const registerInMemoryTracing: () => InMemorySpanExporter;
+export declare const findSpans: (exporter: InMemorySpanExporter, name: string) => ReadableSpan[];
+export declare const findSpan: (exporter: InMemorySpanExporter, name: string) => ReadableSpan;
+export declare const isChildOf: (child: ReadableSpan, parent: ReadableSpan) => boolean;

package/lib/__tests__/telemetry-test-utils.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isChildOf = exports.findSpan = exports.findSpans = exports.registerInMemoryTracing = void 0;
+const api_1 = require("@opentelemetry/api");
+const context_async_hooks_1 = require("@opentelemetry/context-async-hooks");
+const sdk_trace_base_1 = require("@opentelemetry/sdk-trace-base");
+/** Registers an in-memory tracer provider, so spans created by traceSection/@Traced can be asserted on.
+ * Call once per spec file (in beforeAll); jest gives each spec file its own globals.
+ */
+const registerInMemoryTracing = () => {
+    const exporter = new sdk_trace_base_1.InMemorySpanExporter();
+    const provider = new sdk_trace_base_1.BasicTracerProvider({ spanProcessors: [new sdk_trace_base_1.SimpleSpanProcessor(exporter)] });
+    // The context manager makes spans opened across awaits nest under their parent.
+    api_1.context.setGlobalContextManager(new context_async_hooks_1.AsyncLocalStorageContextManager().enable());
+    api_1.trace.setGlobalTracerProvider(provider);
+    return exporter;
+};
+exports.registerInMemoryTracing = registerInMemoryTracing;
+const findSpans = (exporter, name) => exporter.getFinishedSpans().filter(span => span.name === name);
+exports.findSpans = findSpans;
+const findSpan = (exporter, name) => {
+    const spans = (0, exports.findSpans)(exporter, name);
+    if (spans.length !== 1)
+        throw new Error(`Expected one '${name}' span, found ${spans.length}`);
+    return spans[0];
+};
+exports.findSpan = findSpan;
+const isChildOf = (child, parent) => child.parentSpanContext?.spanId === parent.spanContext().spanId
+    && child.spanContext().traceId === parent.spanContext().traceId;
+exports.isChildOf = isChildOf;

package/lib/cli/commands/compile.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CompileCommand = void 0;
 const fs = __importStar(require("fs"));

package/lib/cli/commands/compile.spec.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs = __importStar(require("fs"));
 const os = __importStar(require("os"));

package/lib/cli/commands/create.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CreateCommand = void 0;
 const fs = __importStar(require("fs"));

package/lib/cli/commands/create.spec.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs = __importStar(require("fs"));
 const os = __importStar(require("os"));

package/lib/cli/commands/upload.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UploadCommand = void 0;
 const child_process_1 = require("child_process");

package/lib/cli/index.js

@@ -1,7 +1,8 @@
 #!/usr/bin/env node
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.main = exports.Cli = void 0;
+exports.Cli = void 0;
+exports.main = main;
 const create_1 = require("./commands/create");
 const compile_1 = require("./commands/compile");
 const upload_1 = require("./commands/upload");
@@ -62,7 +63,6 @@ exports.Cli = Cli;
 function main() {
     return new Cli().main();
 }
-exports.main = main;
 if (require.main === module) {
     main().catch((err) => {
         console.error(err && err.message ? err.message : err);

package/lib/entity-processor/base-entity-processor.d.ts

@@ -2,10 +2,28 @@ import { FCConfig, EntityPayloadType } from '../interfaces/interfaces';
 import { DataConverter } from '../util/data-converter';
 import { TypeUtils } from '../util/type-utils';
 import { MapFileUtil } from '@contrail/transform-data';
+import { EventShortMessageStatus } from '../util/event-short-message-status';
 export declare class IncomingEntityResponse {
     entity: any;
     earlyReturn: any;
 }
+export interface InboundStatus {
+    status: EventShortMessageStatus;
+    statusMessage: string;
+    objectClass: string;
+    entityId?: string;
+    federatedId?: string;
+}
+export interface OutboundStatus {
+    status: EventShortMessageStatus;
+    entityId: string;
+    objectClass: string;
+    httpStatus?: number;
+    updatedFromResponse: boolean;
+    /** FlexPLM's per-item status from the response payload, when it returned one. */
+    itemStatus?: string;
+    error?: unknown;
+}
 export declare abstract class BaseEntityProcessor {
     protected config: FCConfig;
     protected dc: DataConverter;
@@ -18,7 +36,18 @@ export declare abstract class BaseEntityProcessor {
     constructor(config: FCConfig, dc: DataConverter, mapFileUtil: MapFileUtil, baseType: string);
     inbound(event: EntityPayloadType): Promise<any>;
     handleIncomingUpsert(event: EntityPayloadType): Promise<any>;
+    /** @deprecated Use {@link recordInboundStatus}, which logs structured fields and sets span attributes. */
     getInboundStatusMessage(statusObject: any): string;
+    /** Records the result of one inbound event: attributes on the active span plus one structured log.
+     * A Failure here is a handled early return, so it is a warning and the span stays OK.
+     */
+    protected recordInboundStatus(statusObject: InboundStatus): void;
+    /** Records the result of sending one entity to FlexPLM: attributes on the active span plus one structured log.
+     * On failure the caller still rethrows; the log keeps the entity context that the action's error log lacks.
+     * A Success whose response item status is not 'OK' is recorded as a Failure: FlexPLM accepted the request
+     * but rejected the item. Nothing is thrown for it, so it is a warning and the span stays OK.
+     */
+    protected recordOutboundStatus(statusObject: OutboundStatus): void;
     /** Looks up an identity record from the identity service based on the passed in criteria.
      * If no identity record is found, returns undefined. If multiple are found, throws an error.
      *