@salesforce/lds-instrumentation 1.419.0 → 1.421.0

package/dist/ldsInstrumentation.js

@@ -14,9 +14,9 @@
 /* proxy-compat-disable */
 import { getInstrumentation, idleDetector } from 'o11y/client';
 import { adapterUnfulfilledErrorSchema } from 'o11y_schema/sf_lds';
-import { pdpEventSchema } from 'o11y_schema/sf_pdp';
-import pftAdapterInvocationDisabledGate from '@salesforce/gate/lds.pft.adapterInvocation.disabled';
 import { ADAPTER_UNFULFILLED_ERROR, instrument } from 'force/ldsBindings';
+import pftAdapterInvocationDisabledGate from '@salesforce/gate/lds.pft.adapterInvocation.disabled';
+import { pdpEventSchema } from 'o11y_schema/sf_pdp';
 
 var SnapshotState;
 (function (SnapshotState) {
@@ -109,7 +109,7 @@ var TypeCheckShapes;
     TypeCheckShapes[TypeCheckShapes["Integer"] = 3] = "Integer";
     TypeCheckShapes[TypeCheckShapes["Unsupported"] = 4] = "Unsupported";
 })(TypeCheckShapes || (TypeCheckShapes = {}));
-// engine version: 0.160.1-e075b880
+// engine version: 0.160.3-354dc58b
 
 const DurableEnvironmentEventDiscriminator = 'durable';
 function isDurableEnvironmentEvent(event) {
@@ -866,17 +866,85 @@ function throttle(callback, ms) {
         }
     };
 }
+// Take 1 out of N adapter invocations to PFT (Don't hug PFT to death $$$$)
+const PFT_DEFAULT_SAMPLING_RATE = 1000;
+const LDS_PRODUCT_FEATURE_ID = 'aJCEE0000000mBk4AI'; // Product Feature ID for Lightning Data Service
+const PFT_DEFAULT_PAYLOAD = {
+    productFeatureId: LDS_PRODUCT_FEATURE_ID,
+};
+function logToPFT(instrumentation, payload, samplingRate = PFT_DEFAULT_SAMPLING_RATE) {
+    if (!pftAdapterInvocationDisabledGate.isOpen({ fallback: false }) &&
+        Math.random() * samplingRate <= 1) {
+        instrumentation.log(pdpEventSchema, {
+            ...PFT_DEFAULT_PAYLOAD,
+            ...payload,
+        });
+    }
+}
+
+const STATE_MANAGERS_NAMESPACE = 'state-managers';
+const stateManagersInstrumentation = getInstrumentation(STATE_MANAGERS_NAMESPACE);
+const STATE_CREATED_OPERATION = 'create';
+const STATE_DEFINED_OPERATION = 'define';
+const CONTEXT_CONSUMED_OPERATION = 'context';
+const PFT_SM_SAMPLING_RATE = 100;
+var OperationTypeValue;
+(function (OperationTypeValue) {
+    OperationTypeValue["Internal"] = "internal";
+    OperationTypeValue["External"] = "external";
+    OperationTypeValue["UiApi"] = "uiapi";
+    OperationTypeValue["Unknown"] = "unknown";
+    OperationTypeValue["Other"] = "other";
+})(OperationTypeValue || (OperationTypeValue = {}));
+/**
+ * Increments the state-created counter.
+ * @remarks Excludes `definedBy` from tags to avoid unbound cardinality.
+ */
+function incrementStateCreatedCount(tags) {
+    stateManagersInstrumentation.incrementCounter(STATE_CREATED_OPERATION, 1, undefined, {
+        type: tags.type,
+    });
+    logToPFT(stateManagersInstrumentation, {
+        eventName: `state-manager.create`,
+        contextName: 'type',
+        contextValue: tags.type,
+    }, PFT_SM_SAMPLING_RATE);
+}
+/**
+ * Increments the state-defined counter.
+ * @remarks Includes `definedBy` in tags; low cardinality makes unbound cardinality acceptable.
+ * No PFT log—single key:value without definedBy would be meaningless.
+ */
+function incrementStateDefinedCount(tags) {
+    stateManagersInstrumentation.incrementCounter(STATE_DEFINED_OPERATION, 1, undefined, tags);
+}
+/**
+ * Increments the context-consumed counter.
+ * @remarks Excludes `definedBy` from tags to avoid unbound cardinality.
+ */
+function incrementStateContextConsumedCount(tags) {
+    stateManagersInstrumentation.incrementCounter(CONTEXT_CONSUMED_OPERATION, 1, undefined, {
+        type: tags.type,
+    });
+    logToPFT(stateManagersInstrumentation, {
+        eventName: `state-manager.context`,
+        contextName: 'type',
+        contextValue: tags.type,
+    }, PFT_SM_SAMPLING_RATE);
+}
+const stateManagerInstrumentation = {
+    incrementStateCreatedCount,
+    incrementStateDefinedCount,
+    incrementStateContextConsumedCount,
+};
 
 const NAMESPACE = 'lds';
 const APEX_ADAPTER_NAME = 'getApex';
-const STATE_MANAGERS_NAMESPACE = 'state-managers';
 const NORMALIZED_APEX_ADAPTER_NAME = createMetricsKey('Apex', APEX_ADAPTER_NAME);
 const GRAPHQL_ADAPTER_NAME = 'graphQL';
 const GRAPHQL_RECORDS_KEY = 'GraphQL::graphql__uiapi__query';
 const ldsInstrumentation = getInstrumentation(NAMESPACE);
 const observabilityInstrumentation = getInstrumentation(OBSERVABILITY_NAMESPACE);
-const stateManagersInstrumentation = getInstrumentation(STATE_MANAGERS_NAMESPACE);
-const LDS_PRODUCT_FEATURE_ID = 'aJCEE0000000mBk4AI'; // Product Feature ID for Lightning Data Service
 class Instrumentation {
     /**
      * Injected to LDS for Luvio specific instrumentation.
@@ -944,22 +1012,16 @@ function logObjectInfoChanged() {
 function logMessage(message) {
     ldsInstrumentation.log(message);
 }
-// Take 1 out of N adapter invocations to PFT (Don't hug PFT to death $$$$)
-const PFT_SAMPLING_RATE = 1000;
 /**
  * W-13639107
  * Logs to PFT (Product Feature Taxonomy) when an adapter is invoked
  */
 function logAdapterInvocationToPFT(adapterName) {
-    if (!pftAdapterInvocationDisabledGate.isOpen({ fallback: false }) &&
-        Math.random() * PFT_SAMPLING_RATE <= 1) {
-        ldsInstrumentation.log(pdpEventSchema, {
-            event_name: `luvioAdapter.invoked`,
-            productFeatureId: LDS_PRODUCT_FEATURE_ID,
-            contextName: 'adapter.name',
-            contextValue: adapterName,
-        });
-    }
+    logToPFT(ldsInstrumentation, {
+        eventName: `luvioAdapter.invoked`,
+        contextName: 'adapter.name',
+        contextValue: adapterName,
+    });
 }
 /**
  * Increment the counter based on the cache policy type for an adapter call
@@ -1405,9 +1467,6 @@ function incrementNotifyRecordUpdateAvailableDropCount() {
 function incrementNetworkRateLimitExceededCount() {
     incrementCounterMetric(NETWORK_RATE_LIMIT_EXCEEDED_COUNT);
 }
-function incrementStateCreatedCount() {
-    stateManagersInstrumentation.incrementCounter(STATE_CREATED_COUNT);
-}
 function instrumentStoreTrimTask(callback) {
     return () => {
         ldsInstrumentation.incrementCounter(STORE_TRIM_TASK_COUNT);
@@ -1604,5 +1663,5 @@ function onIdleDetected(callback) {
 }
 const instrumentation = new Instrumentation();
 
-export { Instrumentation, LRUCache, metricKeys as METRIC_KEYS, executeAsyncActivity, handleIngestedNewData, handleOnDataOutOfTtlDurationUpdate, incrementCounterMetric, incrementGetRecordNormalInvokeCount, incrementGetRecordNotifyChangeAllowCount, incrementGetRecordNotifyChangeDropCount, incrementNotifyRecordUpdateAvailableAllowCount, incrementNotifyRecordUpdateAvailableDropCount, incrementStateCreatedCount, instrumentAdapter, instrumentLuvio, instrumentMethods, instrumentStoreMethods, instrumentation, logAdapterInvocationToPFT, logError, logMessage, logObjectInfoChanged, onIdleDetected, setInstrumentationHooks, setLdsAdaptersUiapiInstrumentation, setLdsNetworkAdapterInstrumentation, setStoreEventObservers, setupInstrumentation, startAdapterActivity, updatePercentileHistogramMetric };
-// version: 1.419.0-ade430921b
+export { Instrumentation, LRUCache, metricKeys as METRIC_KEYS, OperationTypeValue, executeAsyncActivity, handleIngestedNewData, handleOnDataOutOfTtlDurationUpdate, incrementCounterMetric, incrementGetRecordNormalInvokeCount, incrementGetRecordNotifyChangeAllowCount, incrementGetRecordNotifyChangeDropCount, incrementNotifyRecordUpdateAvailableAllowCount, incrementNotifyRecordUpdateAvailableDropCount, instrumentAdapter, instrumentLuvio, instrumentMethods, instrumentStoreMethods, instrumentation, logAdapterInvocationToPFT, logError, logMessage, logObjectInfoChanged, onIdleDetected, setInstrumentationHooks, setLdsAdaptersUiapiInstrumentation, setLdsNetworkAdapterInstrumentation, setStoreEventObservers, setupInstrumentation, startAdapterActivity, stateManagerInstrumentation, updatePercentileHistogramMetric };
+// version: 1.421.0-2828c95aef

package/dist/types/main.d.ts

@@ -6,6 +6,7 @@ import type { AdapterReport } from '@salesforce/lds-utils-adapters';
 import type { ObservabilityContext } from '@salesforce/nimbus-plugin-lds';
 export * as METRIC_KEYS from './metric-keys';
 export { LRUCache } from './utils/lru-cache';
+export * from './state-managers';
 interface AdapterMetadata {
     apiFamily: string;
     name: string;
@@ -93,7 +94,6 @@ export declare function incrementGetRecordNotifyChangeAllowCount(): void;
 export declare function incrementGetRecordNotifyChangeDropCount(): void;
 export declare function incrementNotifyRecordUpdateAvailableAllowCount(): void;
 export declare function incrementNotifyRecordUpdateAvailableDropCount(): void;
-export declare function incrementStateCreatedCount(): void;
 /**
  * Sets up instrumentation for @salesforce/lds-adapters-uiapi
  */

package/dist/types/state-managers.d.ts

@@ -0,0 +1,33 @@
+export declare enum OperationTypeValue {
+    Internal = "internal",
+    External = "external",
+    UiApi = "uiapi",
+    Unknown = "unknown",
+    Other = "other"
+}
+export type OperationTags = {
+    type: OperationTypeValue;
+    definedBy: string;
+};
+/**
+ * Increments the state-created counter.
+ * @remarks Excludes `definedBy` from tags to avoid unbound cardinality.
+ */
+declare function incrementStateCreatedCount(tags: OperationTags): void;
+/**
+ * Increments the state-defined counter.
+ * @remarks Includes `definedBy` in tags; low cardinality makes unbound cardinality acceptable.
+ * No PFT log—single key:value without definedBy would be meaningless.
+ */
+declare function incrementStateDefinedCount(tags: OperationTags): void;
+/**
+ * Increments the context-consumed counter.
+ * @remarks Excludes `definedBy` from tags to avoid unbound cardinality.
+ */
+declare function incrementStateContextConsumedCount(tags: OperationTags): void;
+export declare const stateManagerInstrumentation: {
+    incrementStateCreatedCount: typeof incrementStateCreatedCount;
+    incrementStateDefinedCount: typeof incrementStateDefinedCount;
+    incrementStateContextConsumedCount: typeof incrementStateContextConsumedCount;
+};
+export {};

package/dist/types/utils/utils.d.ts

@@ -1,3 +1,4 @@
+import { getInstrumentation } from 'o11y/client';
 /**
  * A deterministic JSON stringify implementation. Heavily adapted from https://github.com/epoberezkin/fast-json-stable-stringify.
  * This is needed because insertion order for JSON.stringify(object) affects output:
@@ -13,3 +14,10 @@ export declare function stableJSONStringify(node: any): string | undefined;
 export declare function isPromise<D>(value: D | Promise<D> | null): value is Promise<D>;
 export declare function isAdapterError(error: unknown): boolean;
 export declare function throttle(callback: () => void, ms: number): () => void;
+export type PFTLogPayload = {
+    eventName: string;
+    productFeatureId?: string;
+    contextName?: string;
+    contextValue?: string;
+};
+export declare function logToPFT(instrumentation: ReturnType<typeof getInstrumentation>, payload: PFTLogPayload, samplingRate?: number): void;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-instrumentation",
-    "version": "1.419.0",
+    "version": "1.421.0",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "Instrumentation utils for Lightning Data Service",
     "main": "dist/ldsInstrumentation.js",
@@ -33,24 +33,24 @@
         "release:corejar": "yarn build && ../core-build/scripts/core.js --name=lds-instrumentation"
     },
     "dependencies": {
-        "@salesforce/lds-bindings": "^1.419.0",
-        "@salesforce/lds-default-luvio": "^1.419.0",
-        "@salesforce/lds-utils-adapters": "^1.419.0",
+        "@salesforce/lds-bindings": "^1.421.0",
+        "@salesforce/lds-default-luvio": "^1.421.0",
+        "@salesforce/lds-utils-adapters": "^1.421.0",
         "o11y": "262.6.0",
         "o11y_schema": "260.37.0"
     },
     "devDependencies": {
-        "@salesforce/lds-adapters-uiapi": "^1.419.0",
-        "@salesforce/lds-network-adapter": "^1.419.0",
-        "@salesforce/nimbus-plugin-lds": "^1.419.0"
+        "@salesforce/lds-adapters-uiapi": "^1.421.0",
+        "@salesforce/lds-network-adapter": "^1.421.0",
+        "@salesforce/nimbus-plugin-lds": "^1.421.0"
     },
     "luvioBundlesize": [
         {
             "path": "./dist/ldsInstrumentation.js",
             "maxSize": {
-                "none": "64 kB",
-                "min": "28 kB",
-                "compressed": "12 kB"
+                "none": "70 kB",
+                "min": "29 kB",
+                "compressed": "12.2 kB"
             }
         }
     ],