@contrail/flexplm 1.8.1 → 2.0.0-alpha.9af4b96

package/lib/util/telemetry-attributes.d.ts

@@ -0,0 +1,68 @@
+/** Span and log attribute names emitted by this library. Connectors should reuse these instead of defining their own. */
+/** Which FlexPLM call a span covers: 'csrf' | 'send' | 'get'. */
+export declare const ATTR_FLEXPLM_REQUEST_KIND: "contrail.flexplm.request.kind";
+/** True when the cached session was rejected and the request was retried with a new session. */
+export declare const ATTR_FLEXPLM_REQUEST_RETRIED: "contrail.flexplm.request.retried";
+/** Number of events in the payload sent to FlexPLM. */
+export declare const ATTR_FLEXPLM_PAYLOAD_COUNT: "contrail.flexplm.payload.count";
+export declare const ATTR_FLEXPLM_EVENT_OBJECT_CLASS: "contrail.flexplm.event.object_class";
+/** The event type: inbound 'PERSIST' | 'DELETE'; outbound 'create' | 'update' | 'delete' | 'sendUpsertToFlexPLM'. */
+export declare const ATTR_FLEXPLM_EVENT_TYPE: "contrail.flexplm.event.type";
+/** Where the FlexPLM session for a request came from: 'cached' | 'new' | 'disabled' (session reuse off). */
+export declare const ATTR_FLEXPLM_SESSION_SOURCE: "contrail.flexplm.session.source";
+/** True when the request waited for another request's session acquisition before running. */
+export declare const ATTR_FLEXPLM_SESSION_WAITED: "contrail.flexplm.session.waited";
+/** Number of properties written to the VibeIQ entity by a create or update. */
+export declare const ATTR_FLEXPLM_CHANGED_PROPERTY_COUNT: "contrail.flexplm.entity.changed_property_count";
+/** Whether a lookup found the entity. */
+export declare const ATTR_FLEXPLM_ENTITY_FOUND: "contrail.flexplm.entity.found";
+/** Number of entities a criteria query returned. */
+export declare const ATTR_FLEXPLM_ENTITY_RESULT_COUNT: "contrail.flexplm.entity.result_count";
+/** Result of syncing a FlexPLM thumbnail: 'removed' | 'created' | 'replaced' | 'already_synced' | 'no_thumbnail'. */
+export declare const ATTR_FLEXPLM_THUMBNAIL_OUTCOME: "contrail.flexplm.thumbnail.outcome";
+/** FlexPLM's per-item result counts for a publish, reported to the publish callback. */
+export declare const ATTR_FLEXPLM_PUBLISH_FAILURE_COUNT: "contrail.flexplm.publish.failure_count";
+export declare const ATTR_FLEXPLM_PUBLISH_INVALID_COUNT: "contrail.flexplm.publish.invalid_count";
+/** True when the publish callback dispatched a failure notification. */
+export declare const ATTR_FLEXPLM_PUBLISH_NOTIFICATION_SENT: "contrail.flexplm.publish.notification_sent";
+export declare const ATTR_FLEXPLM_ENTITY_TYPE: "contrail.flexplm.entity.type";
+export declare const ATTR_FLEXPLM_PUBLISH_ADDED_COUNT: "contrail.flexplm.publish.added_count";
+export declare const ATTR_FLEXPLM_PUBLISH_REMOVED_COUNT: "contrail.flexplm.publish.removed_count";
+export declare const ATTR_FLEXPLM_PUBLISH_CHANGED_COUNT: "contrail.flexplm.publish.changed_count";
+/** Result of processing one entity event: EventShortMessageStatus 'Success' | 'Failure'. */
+export declare const ATTR_FLEXPLM_STATUS: "contrail.flexplm.status";
+/** Short status message for one inbound entity event, e.g. 'Created', 'Updated', 'No_Changes'. */
+export declare const ATTR_FLEXPLM_OUTCOME: "contrail.flexplm.outcome";
+export declare const ATTR_FLEXPLM_ENTITY_ID: "contrail.flexplm.entity.id";
+export declare const ATTR_FLEXPLM_FEDERATED_ID: "contrail.flexplm.federated_id";
+export declare const ATTR_FLEXPLM_ASSORTMENT_ID: "contrail.flexplm.assortment.id";
+export declare const ATTR_FLEXPLM_PUBLISH_CHANGE_ID: "contrail.flexplm.publish.change_id";
+/** LCSProductSeasonLink events sent for one assortment publish. */
+export declare const ATTR_FLEXPLM_PUBLISH_PRODUCT_SEASON_COUNT: "contrail.flexplm.publish.product_season_count";
+/** LCSSKUSeasonLink events sent for one assortment publish. */
+export declare const ATTR_FLEXPLM_PUBLISH_COLORWAY_SEASON_COUNT: "contrail.flexplm.publish.colorway_season_count";
+/** True when FlexPLM's response produced updates that were applied back to the VibeIQ entity. */
+export declare const ATTR_FLEXPLM_UPDATED_FROM_RESPONSE: "contrail.flexplm.outbound.updated_from_response";
+/** FlexPLM's per-item status in a send response ('OK' | 'FAIL'); FlexPLM can answer HTTP 200 and still reject the item. */
+export declare const ATTR_FLEXPLM_RESPONSE_ITEM_STATUS: "contrail.flexplm.response.item_status";
+/** Which publish file a download span covers: 'hydrated_detail' | 'baseline'. */
+export declare const ATTR_FLEXPLM_PUBLISH_FILE: "contrail.flexplm.publish.file";
+/** Publish files that could not be downloaded; the publish continues without them. */
+export declare const ATTR_FLEXPLM_PUBLISH_FAILED_DOWNLOADS: "contrail.flexplm.publish.failed_downloads";
+/** Number of publish-change records in the assortment's history. */
+export declare const ATTR_FLEXPLM_PUBLISH_HISTORY_COUNT: "contrail.flexplm.publish.history_count";
+/** Number of delete changes being published, including ones carried over from earlier publishes. */
+export declare const ATTR_FLEXPLM_PUBLISH_DELETE_CHANGE_COUNT: "contrail.flexplm.publish.delete_change_count";
+/** Delete changes carried over from earlier publishes that had not been sent yet. */
+export declare const ATTR_FLEXPLM_PUBLISH_HISTORICAL_DELETE_COUNT: "contrail.flexplm.publish.historical_delete_count";
+/** Deleted items in scope that were skipped because their item entity was missing. */
+export declare const ATTR_FLEXPLM_PUBLISH_SKIPPED_DELETE_COUNT: "contrail.flexplm.publish.skipped_delete_count";
+/** Number of item families with changes in a publish. */
+export declare const ATTR_FLEXPLM_PUBLISH_ITEM_FAMILY_COUNT: "contrail.flexplm.publish.item_family_count";
+/** The configured sendMode for ASYNC_PUBLISH_SEASON, e.g. 'sendtoflexplm', 'vibeiqfile', 'localfile'. */
+export declare const ATTR_FLEXPLM_PUBLISH_SEND_MODE: "contrail.flexplm.publish.send_mode";
+/** True when FlexPLM accepted the publish but the external-event that records it could not be created. */
+export declare const ATTR_FLEXPLM_PUBLISH_SENT_UNRECORDED: "contrail.flexplm.publish.sent_unrecorded";
+export declare const ATTR_HTTP_REQUEST_METHOD = "http.request.method";
+export declare const ATTR_HTTP_RESPONSE_STATUS_CODE = "http.response.status_code";
+export declare const ATTR_URL_PATH = "url.path";

package/lib/util/telemetry-attributes.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ATTR_URL_PATH = exports.ATTR_HTTP_RESPONSE_STATUS_CODE = exports.ATTR_HTTP_REQUEST_METHOD = exports.ATTR_FLEXPLM_PUBLISH_SENT_UNRECORDED = exports.ATTR_FLEXPLM_PUBLISH_SEND_MODE = exports.ATTR_FLEXPLM_PUBLISH_ITEM_FAMILY_COUNT = exports.ATTR_FLEXPLM_PUBLISH_SKIPPED_DELETE_COUNT = exports.ATTR_FLEXPLM_PUBLISH_HISTORICAL_DELETE_COUNT = exports.ATTR_FLEXPLM_PUBLISH_DELETE_CHANGE_COUNT = exports.ATTR_FLEXPLM_PUBLISH_HISTORY_COUNT = exports.ATTR_FLEXPLM_PUBLISH_FAILED_DOWNLOADS = exports.ATTR_FLEXPLM_PUBLISH_FILE = exports.ATTR_FLEXPLM_RESPONSE_ITEM_STATUS = exports.ATTR_FLEXPLM_UPDATED_FROM_RESPONSE = exports.ATTR_FLEXPLM_PUBLISH_COLORWAY_SEASON_COUNT = exports.ATTR_FLEXPLM_PUBLISH_PRODUCT_SEASON_COUNT = exports.ATTR_FLEXPLM_PUBLISH_CHANGE_ID = exports.ATTR_FLEXPLM_ASSORTMENT_ID = exports.ATTR_FLEXPLM_FEDERATED_ID = exports.ATTR_FLEXPLM_ENTITY_ID = exports.ATTR_FLEXPLM_OUTCOME = exports.ATTR_FLEXPLM_STATUS = exports.ATTR_FLEXPLM_PUBLISH_CHANGED_COUNT = exports.ATTR_FLEXPLM_PUBLISH_REMOVED_COUNT = exports.ATTR_FLEXPLM_PUBLISH_ADDED_COUNT = exports.ATTR_FLEXPLM_ENTITY_TYPE = exports.ATTR_FLEXPLM_PUBLISH_NOTIFICATION_SENT = exports.ATTR_FLEXPLM_PUBLISH_INVALID_COUNT = exports.ATTR_FLEXPLM_PUBLISH_FAILURE_COUNT = exports.ATTR_FLEXPLM_THUMBNAIL_OUTCOME = exports.ATTR_FLEXPLM_ENTITY_RESULT_COUNT = exports.ATTR_FLEXPLM_ENTITY_FOUND = exports.ATTR_FLEXPLM_CHANGED_PROPERTY_COUNT = exports.ATTR_FLEXPLM_SESSION_WAITED = exports.ATTR_FLEXPLM_SESSION_SOURCE = exports.ATTR_FLEXPLM_EVENT_TYPE = exports.ATTR_FLEXPLM_EVENT_OBJECT_CLASS = exports.ATTR_FLEXPLM_PAYLOAD_COUNT = exports.ATTR_FLEXPLM_REQUEST_RETRIED = exports.ATTR_FLEXPLM_REQUEST_KIND = void 0;
+const telemetry_1 = require("@contrail/telemetry");
+/** Span and log attribute names emitted by this library. Connectors should reuse these instead of defining their own. */
+/** Which FlexPLM call a span covers: 'csrf' | 'send' | 'get'. */
+exports.ATTR_FLEXPLM_REQUEST_KIND = (0, telemetry_1.buildContrailAttributeName)('flexplm.request.kind');
+/** True when the cached session was rejected and the request was retried with a new session. */
+exports.ATTR_FLEXPLM_REQUEST_RETRIED = (0, telemetry_1.buildContrailAttributeName)('flexplm.request.retried');
+/** Number of events in the payload sent to FlexPLM. */
+exports.ATTR_FLEXPLM_PAYLOAD_COUNT = (0, telemetry_1.buildContrailAttributeName)('flexplm.payload.count');
+exports.ATTR_FLEXPLM_EVENT_OBJECT_CLASS = (0, telemetry_1.buildContrailAttributeName)('flexplm.event.object_class');
+/** The event type: inbound 'PERSIST' | 'DELETE'; outbound 'create' | 'update' | 'delete' | 'sendUpsertToFlexPLM'. */
+exports.ATTR_FLEXPLM_EVENT_TYPE = (0, telemetry_1.buildContrailAttributeName)('flexplm.event.type');
+/** Where the FlexPLM session for a request came from: 'cached' | 'new' | 'disabled' (session reuse off). */
+exports.ATTR_FLEXPLM_SESSION_SOURCE = (0, telemetry_1.buildContrailAttributeName)('flexplm.session.source');
+/** True when the request waited for another request's session acquisition before running. */
+exports.ATTR_FLEXPLM_SESSION_WAITED = (0, telemetry_1.buildContrailAttributeName)('flexplm.session.waited');
+/** Number of properties written to the VibeIQ entity by a create or update. */
+exports.ATTR_FLEXPLM_CHANGED_PROPERTY_COUNT = (0, telemetry_1.buildContrailAttributeName)('flexplm.entity.changed_property_count');
+/** Whether a lookup found the entity. */
+exports.ATTR_FLEXPLM_ENTITY_FOUND = (0, telemetry_1.buildContrailAttributeName)('flexplm.entity.found');
+/** Number of entities a criteria query returned. */
+exports.ATTR_FLEXPLM_ENTITY_RESULT_COUNT = (0, telemetry_1.buildContrailAttributeName)('flexplm.entity.result_count');
+/** Result of syncing a FlexPLM thumbnail: 'removed' | 'created' | 'replaced' | 'already_synced' | 'no_thumbnail'. */
+exports.ATTR_FLEXPLM_THUMBNAIL_OUTCOME = (0, telemetry_1.buildContrailAttributeName)('flexplm.thumbnail.outcome');
+/** FlexPLM's per-item result counts for a publish, reported to the publish callback. */
+exports.ATTR_FLEXPLM_PUBLISH_FAILURE_COUNT = (0, telemetry_1.buildContrailAttributeName)('flexplm.publish.failure_count');
+exports.ATTR_FLEXPLM_PUBLISH_INVALID_COUNT = (0, telemetry_1.buildContrailAttributeName)('flexplm.publish.invalid_count');
+/** True when the publish callback dispatched a failure notification. */
+exports.ATTR_FLEXPLM_PUBLISH_NOTIFICATION_SENT = (0, telemetry_1.buildContrailAttributeName)('flexplm.publish.notification_sent');
+exports.ATTR_FLEXPLM_ENTITY_TYPE = (0, telemetry_1.buildContrailAttributeName)('flexplm.entity.type');
+exports.ATTR_FLEXPLM_PUBLISH_ADDED_COUNT = (0, telemetry_1.buildContrailAttributeName)('flexplm.publish.added_count');
+exports.ATTR_FLEXPLM_PUBLISH_REMOVED_COUNT = (0, telemetry_1.buildContrailAttributeName)('flexplm.publish.removed_count');
+exports.ATTR_FLEXPLM_PUBLISH_CHANGED_COUNT = (0, telemetry_1.buildContrailAttributeName)('flexplm.publish.changed_count');
+/** Result of processing one entity event: EventShortMessageStatus 'Success' | 'Failure'. */
+exports.ATTR_FLEXPLM_STATUS = (0, telemetry_1.buildContrailAttributeName)('flexplm.status');
+/** Short status message for one inbound entity event, e.g. 'Created', 'Updated', 'No_Changes'. */
+exports.ATTR_FLEXPLM_OUTCOME = (0, telemetry_1.buildContrailAttributeName)('flexplm.outcome');
+exports.ATTR_FLEXPLM_ENTITY_ID = (0, telemetry_1.buildContrailAttributeName)('flexplm.entity.id');
+exports.ATTR_FLEXPLM_FEDERATED_ID = (0, telemetry_1.buildContrailAttributeName)('flexplm.federated_id');
+exports.ATTR_FLEXPLM_ASSORTMENT_ID = (0, telemetry_1.buildContrailAttributeName)('flexplm.assortment.id');
+exports.ATTR_FLEXPLM_PUBLISH_CHANGE_ID = (0, telemetry_1.buildContrailAttributeName)('flexplm.publish.change_id');
+/** LCSProductSeasonLink events sent for one assortment publish. */
+exports.ATTR_FLEXPLM_PUBLISH_PRODUCT_SEASON_COUNT = (0, telemetry_1.buildContrailAttributeName)('flexplm.publish.product_season_count');
+/** LCSSKUSeasonLink events sent for one assortment publish. */
+exports.ATTR_FLEXPLM_PUBLISH_COLORWAY_SEASON_COUNT = (0, telemetry_1.buildContrailAttributeName)('flexplm.publish.colorway_season_count');
+/** True when FlexPLM's response produced updates that were applied back to the VibeIQ entity. */
+exports.ATTR_FLEXPLM_UPDATED_FROM_RESPONSE = (0, telemetry_1.buildContrailAttributeName)('flexplm.outbound.updated_from_response');
+/** FlexPLM's per-item status in a send response ('OK' | 'FAIL'); FlexPLM can answer HTTP 200 and still reject the item. */
+exports.ATTR_FLEXPLM_RESPONSE_ITEM_STATUS = (0, telemetry_1.buildContrailAttributeName)('flexplm.response.item_status');
+/** Which publish file a download span covers: 'hydrated_detail' | 'baseline'. */
+exports.ATTR_FLEXPLM_PUBLISH_FILE = (0, telemetry_1.buildContrailAttributeName)('flexplm.publish.file');
+/** Publish files that could not be downloaded; the publish continues without them. */
+exports.ATTR_FLEXPLM_PUBLISH_FAILED_DOWNLOADS = (0, telemetry_1.buildContrailAttributeName)('flexplm.publish.failed_downloads');
+/** Number of publish-change records in the assortment's history. */
+exports.ATTR_FLEXPLM_PUBLISH_HISTORY_COUNT = (0, telemetry_1.buildContrailAttributeName)('flexplm.publish.history_count');
+/** Number of delete changes being published, including ones carried over from earlier publishes. */
+exports.ATTR_FLEXPLM_PUBLISH_DELETE_CHANGE_COUNT = (0, telemetry_1.buildContrailAttributeName)('flexplm.publish.delete_change_count');
+/** Delete changes carried over from earlier publishes that had not been sent yet. */
+exports.ATTR_FLEXPLM_PUBLISH_HISTORICAL_DELETE_COUNT = (0, telemetry_1.buildContrailAttributeName)('flexplm.publish.historical_delete_count');
+/** Deleted items in scope that were skipped because their item entity was missing. */
+exports.ATTR_FLEXPLM_PUBLISH_SKIPPED_DELETE_COUNT = (0, telemetry_1.buildContrailAttributeName)('flexplm.publish.skipped_delete_count');
+/** Number of item families with changes in a publish. */
+exports.ATTR_FLEXPLM_PUBLISH_ITEM_FAMILY_COUNT = (0, telemetry_1.buildContrailAttributeName)('flexplm.publish.item_family_count');
+/** The configured sendMode for ASYNC_PUBLISH_SEASON, e.g. 'sendtoflexplm', 'vibeiqfile', 'localfile'. */
+exports.ATTR_FLEXPLM_PUBLISH_SEND_MODE = (0, telemetry_1.buildContrailAttributeName)('flexplm.publish.send_mode');
+/** True when FlexPLM accepted the publish but the external-event that records it could not be created. */
+exports.ATTR_FLEXPLM_PUBLISH_SENT_UNRECORDED = (0, telemetry_1.buildContrailAttributeName)('flexplm.publish.sent_unrecorded');
+// Standard OpenTelemetry HTTP attributes. Only the path is recorded, never the host, headers or body.
+exports.ATTR_HTTP_REQUEST_METHOD = 'http.request.method';
+exports.ATTR_HTTP_RESPONSE_STATUS_CODE = 'http.response.status_code';
+exports.ATTR_URL_PATH = 'url.path';

package/lib/util/telemetry-utils.d.ts

@@ -0,0 +1,3 @@
+import { Attributes } from '@opentelemetry/api';
+/** Sets the defined values on the active span; a no-op when no span is active. */
+export declare const setActiveSpanAttributes: (attributes: Attributes) => void;

package/lib/util/telemetry-utils.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setActiveSpanAttributes = void 0;
+const api_1 = require("@opentelemetry/api");
+/** Sets the defined values on the active span; a no-op when no span is active. */
+const setActiveSpanAttributes = (attributes) => {
+    const defined = Object.fromEntries(Object.entries(attributes).filter(([, value]) => value !== undefined && value !== null));
+    api_1.trace.getActiveSpan()?.setAttributes(defined);
+};
+exports.setActiveSpanAttributes = setActiveSpanAttributes;

package/lib/util/thumbnail-util.d.ts

@@ -43,12 +43,13 @@ export declare class ThumbnailUtil {
      * @param entityName - The entity type name (e.g. 'item', 'color') used for API calls.
      * @returns The updated entity, or undefined if no thumbnail changes were needed.
      */
-    syncThumbnailToVibeIQ({ entityId, primaryViewableId, event, entityName }: {
+    syncThumbnailToVibeIQ(params: {
         entityId: string;
         primaryViewableId?: string;
         event: any;
         entityName: string;
     }): Promise<any>;
+    private syncThumbnail;
     private createContentFromFlexPLM;
     private getPrimaryViewableUpdates;
     private getClearPrimaryViewableUpdates;

package/lib/util/thumbnail-util.js

@@ -1,9 +1,20 @@
 "use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ThumbnailUtil = void 0;
 const app_framework_1 = require("@contrail/app-framework");
 const sdk_1 = require("@contrail/sdk");
 const flexplm_connect_1 = require("./flexplm-connect");
+const telemetry_1 = require("@contrail/telemetry");
+const telemetry_attributes_1 = require("./telemetry-attributes");
 ;
 class ThumbnailUtil {
     constructor(config) {
@@ -131,7 +142,17 @@ class ThumbnailUtil {
      * @param entityName - The entity type name (e.g. 'item', 'color') used for API calls.
      * @returns The updated entity, or undefined if no thumbnail changes were needed.
      */
-    async syncThumbnailToVibeIQ({ entityId, primaryViewableId, event, entityName }) {
+    async syncThumbnailToVibeIQ(params) {
+        return (0, telemetry_1.traceSection)('sync_thumbnail_to_vibeiq', {
+            [telemetry_attributes_1.ATTR_FLEXPLM_ENTITY_TYPE]: params.entityName,
+            [telemetry_attributes_1.ATTR_FLEXPLM_ENTITY_ID]: params.entityId,
+        }, async (span) => {
+            const { outcome, result } = await this.syncThumbnail(params);
+            span.setAttribute(telemetry_attributes_1.ATTR_FLEXPLM_THUMBNAIL_OUTCOME, outcome);
+            return result;
+        });
+    }
+    async syncThumbnail({ entityId, primaryViewableId, event, entityName }) {
         console.debug(`syncThumbnailToVibeIQ: entityId=${entityId}, primaryViewableId=${primaryViewableId}, entityName=${entityName}`);
         const eventData = event.data || {};
         const newThumbnailId = eventData[ThumbnailUtil.NEW_THUMBNAIL_ID];
@@ -146,12 +167,12 @@ class ThumbnailUtil {
             const clearUpdates = await this.getClearPrimaryViewableUpdates();
             const updatedEntity = await this.entities.update({ entityName, id: entityId, object: clearUpdates });
             console.debug(`syncThumbnailToVibeIQ: applied clear updates for entityId=${entityId}`);
-            return updatedEntity;
+            return { outcome: 'removed', result: updatedEntity };
         }
         // Early return if no thumbnail URL
         if (!thumbnailUrl) {
             console.debug(`syncThumbnailToVibeIQ: no thumbnail URL for entityId=${entityId}`);
-            return undefined;
+            return { outcome: 'no_thumbnail', result: undefined };
         }
         // Case 2: No existing primaryViewableId — create new content
         if (!primaryViewableId) {
@@ -160,13 +181,13 @@ class ThumbnailUtil {
             const primaryUpdates = await this.getPrimaryViewableUpdates(content);
             const updatedEntity = await this.entities.update({ entityName, id: entityId, object: primaryUpdates });
             console.debug(`syncThumbnailToVibeIQ: created new content ${content.id} for entityId=${entityId}`);
-            return updatedEntity;
+            return { outcome: 'created', result: updatedEntity };
         }
         // Case 3: Has primaryViewableId — check if thumbnail changed
         const primaryViewable = await this.entities.get({ entityName: 'content', id: primaryViewableId });
         if (primaryViewable?.flexplmThumbnailUrl === thumbnailUrl) {
             console.debug(`syncThumbnailToVibeIQ: thumbnail already synced for entityId=${entityId}`);
-            return undefined; // Already synced
+            return { outcome: 'already_synced', result: undefined };
         }
         const content = await this.createContentFromFlexPLM(thumbnailUrl, entityId, entityName);
         await this.entities.update({ entityName: 'content', id: content.id, object: { flexplmThumbnailUrl: thumbnailUrl } });
@@ -174,8 +195,9 @@ class ThumbnailUtil {
         const updatedEntity = await this.entities.update({ entityName, id: entityId, object: primaryUpdates });
         await this.entities.delete({ entityName: 'content', id: primaryViewableId });
         console.debug(`syncThumbnailToVibeIQ: replaced content ${primaryViewableId} with ${content.id} for entityId=${entityId}`);
-        return updatedEntity;
+        return { outcome: 'replaced', result: updatedEntity };
     }
+    // Downloads the image from FlexPLM and stores it as VibeIQ content.
     async createContentFromFlexPLM(thumbnailUrl, entityId, entityName) {
         const urlParts = thumbnailUrl.split('/');
         const fileName = urlParts[urlParts.length - 1] || 'thumbnail';
@@ -189,7 +211,7 @@ class ThumbnailUtil {
             const urlPath = '/servlet/rest' + imageEndpoint + '?path=' + encodeURIComponent(thumbnailUrl);
             response = await flexPLMConnect.getRequest({
                 urlPath,
-                includeUrlContext: true,
+                includeUrlContext: true, // apiHost + /Windchill + /servlet/rest/rfa/vibeiq/image?path=...
                 returnFullResponse: true,
             });
         }
@@ -262,3 +284,9 @@ ThumbnailUtil.NEW_THUMBNAIL_ID = 'NEW_THUMBNAIL_ID';
 ThumbnailUtil.EXISTING_THUMBNAIL_ID = 'EXISTING_THUMBNAIL_ID';
 ThumbnailUtil.REMOVE_THUMBNAIL = 'REMOVE_THUMBNAIL';
 ThumbnailUtil.OOB_SIZES = [{ slug: 'largeViewable' }, { slug: 'mediumLargeViewable' }, { slug: 'mediumViewable' }, { slug: 'smallViewable' }, { slug: 'tinyViewable' }];
+__decorate([
+    (0, telemetry_1.Traced)('copy_thumbnail_from_flexplm'),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String, String]),
+    __metadata("design:returntype", Promise)
+], ThumbnailUtil.prototype, "createContentFromFlexPLM", null);

package/lib/util/thumbnail-util.spec.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const thumbnail_util_1 = require("./thumbnail-util");
+const telemetry_test_utils_1 = require("../__tests__/telemetry-test-utils");
+const telemetry_attributes_1 = require("./telemetry-attributes");
 const mockData_1 = require("./mockData");
 const mockEntitiesGet = jest.fn();
 const mockEntitiesUpdate = jest.fn();
@@ -563,3 +565,43 @@ describe('ThumbnailUtil Tests', () => {
         });
     });
 });
+describe('syncThumbnailToVibeIQ telemetry', () => {
+    const exporter = (0, telemetry_test_utils_1.registerInMemoryTracing)();
+    const image = { arrayBuffer: jest.fn().mockResolvedValue(new ArrayBuffer(8)), headers: { get: jest.fn().mockReturnValue('image/png') } };
+    let tu;
+    const outcomeOf = async (params) => {
+        exporter.reset();
+        await tu.syncThumbnailToVibeIQ({ entityId: 'entity1', primaryViewableId: params.primaryViewableId, event: { data: params.data }, entityName: 'color' });
+        const [span] = (0, telemetry_test_utils_1.findSpans)(exporter, 'sync_thumbnail_to_vibeiq');
+        expect(span.attributes[telemetry_attributes_1.ATTR_FLEXPLM_ENTITY_ID]).toBe('entity1');
+        return span.attributes[telemetry_attributes_1.ATTR_FLEXPLM_THUMBNAIL_OUTCOME];
+    };
+    beforeEach(() => {
+        jest.clearAllMocks();
+        tu = new thumbnail_util_1.ThumbnailUtil({});
+        mockGetRequest.mockResolvedValue(image);
+        mockContentCreate.mockResolvedValue({ id: 'newContent' });
+        mockEntitiesUpdate.mockImplementation((opts) => Promise.resolve({ id: opts.id }));
+        mockEntitiesGet.mockImplementation((opts) => {
+            if (opts.entityName === 'content-custom-size')
+                return Promise.resolve([]);
+            if (opts.entityName === 'content')
+                return Promise.resolve({ id: opts.id, flexplmThumbnailUrl: '/rest/thumbnail/same.png' });
+            return Promise.resolve({});
+        });
+    });
+    it('should record each sync outcome on the span', async () => {
+        expect(await outcomeOf({ data: {} })).toBe('no_thumbnail');
+        expect(await outcomeOf({ primaryViewableId: 'pv1', data: { [thumbnail_util_1.ThumbnailUtil.NEW_THUMBNAIL_ID]: thumbnail_util_1.ThumbnailUtil.REMOVE_THUMBNAIL } })).toBe('removed');
+        expect(await outcomeOf({ data: { [thumbnail_util_1.ThumbnailUtil.NEW_THUMBNAIL_ID]: '/rest/thumbnail/new.png' } })).toBe('created');
+        expect(await outcomeOf({ primaryViewableId: 'pv1', data: { [thumbnail_util_1.ThumbnailUtil.EXISTING_THUMBNAIL_ID]: '/rest/thumbnail/same.png' } })).toBe('already_synced');
+        expect(await outcomeOf({ primaryViewableId: 'pv1', data: { [thumbnail_util_1.ThumbnailUtil.NEW_THUMBNAIL_ID]: '/rest/thumbnail/new.png' } })).toBe('replaced');
+    });
+    it('should nest the thumbnail download under the sync span', async () => {
+        exporter.reset();
+        await tu.syncThumbnailToVibeIQ({ entityId: 'entity1', event: { data: { [thumbnail_util_1.ThumbnailUtil.NEW_THUMBNAIL_ID]: '/rest/thumbnail/new.png' } }, entityName: 'color' });
+        const [sync] = (0, telemetry_test_utils_1.findSpans)(exporter, 'sync_thumbnail_to_vibeiq');
+        const [copy] = (0, telemetry_test_utils_1.findSpans)(exporter, 'copy_thumbnail_from_flexplm');
+        expect(copy.parentSpanContext?.spanId).toBe(sync.spanContext().spanId);
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/flexplm",
-  "version": "1.8.1",
+  "version": "2.0.0-alpha.9af4b96",
   "description": "Library used for integration with flexplm.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -25,15 +25,23 @@
   "author": "VibeIQ",
   "license": "ISC",
   "devDependencies": {
+    "@contrail/app-framework": "2.1.1",
+    "@contrail/telemetry": "^2.3.1",
+    "@opentelemetry/api": "^1.9.1",
+    "@opentelemetry/context-async-hooks": "^2.12.0",
+    "@opentelemetry/sdk-trace-base": "^2.12.0",
     "@types/jest": "^29.5.2",
     "jest": "^29.5.0",
     "prettier": "^1.19.1",
     "ts-jest": "^29.1.1",
     "tslint": "^5.11.0",
     "tslint-config-prettier": "^1.18.0",
-    "typescript": "^4.0.0"
+    "typescript": "^5.9.3"
   },
   "peerDependencies": {
+    "@contrail/app-framework": "^2.1.1",
+    "@contrail/telemetry": "^2.3.1",
+    "@opentelemetry/api": "^1.9.0",
     "typescript": ">=4.0.0"
   },
   "peerDependenciesMeta": {
@@ -56,7 +64,6 @@
     "testEnvironment": "node"
   },
   "dependencies": {
-    "@contrail/app-framework": "^1.4.3",
     "@contrail/sdk": "^1.6.1",
     "@contrail/transform-data": "^1.3.2",
     "@contrail/util": "^1.3.1",