@lwrjs/o11y 0.6.1 → 0.6.5

package/build/bundle/prod/lwr/o11yService/o11yService.js

@@ -1 +1 @@
-import{getInstrumentation as t}from"o11y/client";import{registerDecorators as r}from"lwc";import{MODULE_FETCH as e,MAPPINGS_FETCH as s,MODULE_DEFINE as n,MODULE_DEFINE_COUNT as i,BOOTSTRAP_END as a,MODULE_FETCH_DURATION as o,MAPPINGS_FETCH_DURATION as m,BOOTSTRAP_DURATION as c,BOOTSTRAP_AVAILABILITY as h,MODULE_FETCH_COUNT as u,MODULE_AVAILABILITY as l,MAPPINGS_FETCH_COUNT as k,MAPPINGS_AVAILABILITY as f,BOOTSTRAP_ERROR as p,MODULE_ERROR as d,MAPPINGS_ERROR as W}from"lwr/metrics";class b{constructor(t){this.marks={},this.instrumentation=t}track(){this.trackExistingMarks(),this.setupObserver()}isClearable(t){return!t.startsWith(e)&&!t.startsWith(s)}trackExistingMarks(){const t=performance.getEntriesByType("mark").filter((t=>t.name.startsWith(n)));t.length>0&&this.instrumentation.incrementCounter(i,t.length)}setupObserver(){let t=0,r=0,b=0;new PerformanceObserver((g=>{const y=[];g.getEntries().forEach((e=>{const{name:s,entryType:n,duration:i}=e;"mark"===n&&s.startsWith("lwr.")&&y.push(e),s===a&&(this.marks[s]=e),s===p&&(t+=1),s===d&&(r+=1),s===W&&(b+=1),(s.startsWith(o)||s.startsWith(m))&&this.instrumentation.trackValue(s,i)})),void 0!==this.marks[a]&&(this.instrumentation.trackValue(c,this.marks[a].startTime),this.instrumentation.trackValue(h,1/(1+t)*100),delete this.marks[a]);const v=y.reduce(((t,r)=>r.name.startsWith(n)?t+1:t),0);v>0&&this.instrumentation.incrementCounter(i,v);const w=y.reduce(((t,r)=>r.name.startsWith(e)?t+1:t),0);w>0&&(this.instrumentation.incrementCounter(u,w),this.instrumentation.trackValue(l,w/(w+r)*100));const C=y.reduce(((t,r)=>r.name.startsWith(s)?t+1:t),0);C>0&&(this.instrumentation.incrementCounter(k,C),this.instrumentation.trackValue(f,C/(C+b)*100)),y.forEach((t=>this.isClearable(t.name)&&performance.clearMarks(t.name)))})).observe({entryTypes:["mark","measure"]})}}r(b,{fields:["marks"]});const g=void 0!==globalThis.performance&&"function"==typeof globalThis.performance.mark,y={track:()=>{}};function v(r){const e=t("lwrjs");(g?new b(e):y).track()}export default v;
+import{getInstrumentation as t}from"o11y/client";import{registerDecorators as e}from"lwc";import{MODULE_FETCH as r,MAPPINGS_FETCH as s,MODULE_DEFINE as n,MODULE_DEFINE_COUNT as i,BOOTSTRAP_END as a,MODULE_FETCH_DURATION as o,MAPPINGS_FETCH_DURATION as c,BOOTSTRAP_DURATION as m,BOOTSTRAP_AVAILABILITY as h,MODULE_FETCH_COUNT as u,MODULE_AVAILABILITY as l,MAPPINGS_FETCH_COUNT as k,MAPPINGS_AVAILABILITY as f,BOOTSTRAP_ERROR as p,MODULE_ERROR as g,MAPPINGS_ERROR as b}from"lwr/metrics";class d{constructor(t,e){this.marks={},this.config=e||{},this.instrumentation=t}track(){this.trackExistingMarks(),this.setupObserver()}isClearable(t){return!t.startsWith(r)&&!t.startsWith(s)}trackExistingMarks(){const t=performance.getEntriesByType("mark").filter((t=>t.name.startsWith(n)));t.length>0&&this.instrumentation.incrementCounter(i,t.length)}setupObserver(){let t=0,e=0,d=0;new PerformanceObserver((W=>{const T=[];W.getEntries().forEach((r=>{const{name:s,entryType:n,duration:i}=r;"mark"===n&&s.startsWith("lwr.")&&T.push(r),s===a&&(this.marks[s]=r),s===p&&(t+=1),s===g&&(e+=1),s===b&&(d+=1),this.config.enableModuleFetchTracking&&s.startsWith(o)&&this.instrumentation.trackValue(s,i),this.config.enableMappingFetchTracking&&s.startsWith(c)&&this.instrumentation.trackValue(s,i)})),void 0!==this.marks[a]&&(this.instrumentation.trackValue(m,this.marks[a].startTime),this.instrumentation.trackValue(h,1/(1+t)*100),delete this.marks[a]);const y=T.reduce(((t,e)=>e.name.startsWith(n)?t+1:t),0);y>0&&this.instrumentation.incrementCounter(i,y);const C=T.reduce(((t,e)=>e.name.startsWith(r)?t+1:t),0);C>0&&(this.instrumentation.incrementCounter(u,C),this.instrumentation.trackValue(l,C/(C+e)*100));const v=T.reduce(((t,e)=>e.name.startsWith(s)?t+1:t),0);v>0&&(this.instrumentation.incrementCounter(k,v),this.instrumentation.trackValue(f,v/(v+d)*100)),T.forEach((t=>this.isClearable(t.name)&&performance.clearMarks(t.name)))})).observe({entryTypes:["mark","measure"]})}}e(d,{fields:["marks"]});const W=void 0!==globalThis.performance&&"function"==typeof globalThis.performance.mark,T=globalThis.LWR,y={track:()=>{}};function C(e){const r=t("lwrjs"),s=T.metricsConfig||{};(W?new d(r,s):y).track()}export default C;

package/build/modules/lwr/o11yService/o11yService.js

@@ -3,6 +3,7 @@ import { PerformanceApiSink } from './performanceApiSink'; // Check if the Perfo
 // e.g. JSDom (used in Jest) doesn't implement these
 
 const isPerfSupported = typeof globalThis.performance !== 'undefined' && typeof globalThis.performance.mark === 'function';
+const clientBootstrapConfig = globalThis.LWR;
 
 const noop = () => {// noop
 };
@@ -17,6 +18,7 @@ const NAMESPACE = 'lwrjs';
 
 export default function hookO11yClient(serviceApi) {
   const instrumentation = getInstrumentation(NAMESPACE);
-  const sink = isPerfSupported ? new PerformanceApiSink(instrumentation) : noopSink;
+  const metricsConfig = clientBootstrapConfig.metricsConfig || {};
+  const sink = isPerfSupported ? new PerformanceApiSink(instrumentation, metricsConfig) : noopSink;
   sink.track();
 }

package/build/modules/lwr/o11yService/performanceApiSink.js

@@ -2,7 +2,8 @@ import { BOOTSTRAP_AVAILABILITY, BOOTSTRAP_DURATION, BOOTSTRAP_END, BOOTSTRAP_ER
 export class PerformanceApiSink {
   marks = {};
 
-  constructor(instrumentation) {
+  constructor(instrumentation, config) {
+    this.config = config || {};
     this.instrumentation = instrumentation;
   }
 
@@ -75,7 +76,11 @@ export class PerformanceApiSink {
           loaderMappingsErrorcount += 1;
         }
 
-        if (name.startsWith(MODULE_FETCH_DURATION) || name.startsWith(MAPPINGS_FETCH_DURATION)) {
+        if (this.config.enableModuleFetchTracking && name.startsWith(MODULE_FETCH_DURATION)) {
+          this.instrumentation.trackValue(name, duration);
+        }
+
+        if (this.config.enableMappingFetchTracking && name.startsWith(MAPPINGS_FETCH_DURATION)) {
           this.instrumentation.trackValue(name, duration);
         }
       });

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.6.1",
+    "version": "0.6.5",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -24,7 +24,7 @@
         "build:bundle": "rollup --config scripts/rollup.moduleBundle.config.cjs"
     },
     "dependencies": {
-        "@lwrjs/shared-utils": "0.6.1",
+        "@lwrjs/shared-utils": "0.6.5",
         "o11y": "238.1.4"
     },
     "devDependencies": {
@@ -45,6 +45,5 @@
     },
     "engines": {
         "node": ">=14.15.4 <17"
-    },
-    "gitHead": "4d7c44dfae958fe24ef1c94b0f60aa2b15e12f24"
+    }
 }

package/LICENSE

@@ -1,10 +0,0 @@
-MIT LICENSE
-
-Copyright (c) 2020, Salesforce.com, Inc.
-All rights reserved.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.