@lwrjs/o11y 0.6.0-alpha.8

package/LICENSE

@@ -0,0 +1,10 @@
+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.

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

@@ -0,0 +1 @@
+import{getInstrumentation as t}from"o11y/client";import{registerDecorators as r}from"lwc";class e{constructor(t){this.marks={},this.instrumentation=t}track(){this.trackExistingMarks(),this.setupObserver()}trackExistingMarks(){const t=performance.getEntriesByType("mark").filter((t=>t.name.startsWith("lwr.bootstrap.")));for(const r of t){const{name:t}=r;this.marks[t]=r,performance.clearMarks(t)}}setupObserver(){let t=0;new PerformanceObserver((r=>{const e=[];r.getEntries().forEach((r=>{const{name:s,entryType:a}=r;"mark"===a&&s.startsWith("lwr.")&&e.push(r),"lwr.bootstrap.end"===s&&(this.marks[s]=r),"lwr.bootstrap.error"===s&&(t+=1)})),void 0!==this.marks["lwr.bootstrap.end"]&&(this.instrumentation.trackValue("lwr.bootstrap.duration",this.marks["lwr.bootstrap.end"].startTime),this.instrumentation.trackValue("lwr.bootstrap.availability",1/(1+t)*100),delete this.marks["lwr.bootstrap.end"]);const s=e.reduce(((t,r)=>r.name.startsWith("lwr.loader.module.fetch")?t+1:t),0);s>0&&this.instrumentation.incrementCounter("lwr.loader.module.fetch.count",s);const a=e.reduce(((t,r)=>r.name.startsWith("lwr.loader.mappings.fetch")?t+1:t),0);a>0&&this.instrumentation.incrementCounter("lwr.loader.mappings.fetch.count",a),e.forEach((t=>performance.clearMarks(t.name)))})).observe({entryTypes:["mark"]})}}r(e,{fields:["marks"]});const s=void 0!==globalThis.performance&&"function"==typeof globalThis.performance.mark,a={track:()=>{}};function o(r){const o=t("lwrjs.instrumentation");(s?new e(o):a).track()}export default o;

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

@@ -0,0 +1,21 @@
+import { getInstrumentation } from 'o11y/client';
+import { PerformanceApiSink } from './performanceApiSink'; // Check if the Performance API is available
+// e.g. JSDom (used in Jest) doesn't implement these
+
+const isPerfSupported = typeof globalThis.performance !== 'undefined' && typeof globalThis.performance.mark === 'function';
+
+const noop = () => {// noop
+};
+
+const noopSink = {
+  track: noop
+};
+/**
+ * Sets up o11y instrumentation instance.
+ */
+
+export default function hookO11yClient(loaderServices) {
+  const instrumentation = getInstrumentation('lwrjs.instrumentation');
+  const sink = isPerfSupported ? new PerformanceApiSink(instrumentation) : noopSink;
+  sink.track();
+}

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

@@ -0,0 +1,107 @@
+// TODO: import constants from shared util module
+const BOOTSTRAP_MARK = 'lwr.bootstrap.';
+const BOOTSTRAP_END_MARK = 'lwr.bootstrap.end';
+const BOOTSTRAP_ERROR_MARK = 'lwr.bootstrap.error';
+const BOOTSTRAP_DURATION_OP = 'lwr.bootstrap.duration';
+const BOOTSTRAP_AVAILABILITY_OP = 'lwr.bootstrap.availability';
+const LOADER_MODULE_FETCH = 'lwr.loader.module.fetch';
+const LOADER_MODULE_FETCH_COUNT = 'lwr.loader.module.fetch.count';
+const LOADER_MAPPING_FETCH = 'lwr.loader.mappings.fetch';
+const LOADER_MAPPING_FETCH_COUNT = 'lwr.loader.mappings.fetch.count';
+export class PerformanceApiSink {
+  marks = {};
+
+  constructor(instrumentation) {
+    this.instrumentation = instrumentation;
+  }
+
+  track() {
+    this.trackExistingMarks();
+    this.setupObserver();
+  } // Retrieve existing metrics to this point
+
+
+  trackExistingMarks() {
+    /**
+     * Bootstrap marks prior to service bootstrap:
+     * - lwr.bootstrap.init
+     * - lwr.bootstrap.application
+     */
+    const marks = performance.getEntriesByType('mark').filter(e => e.name.startsWith(BOOTSTRAP_MARK)); // TODO: saved these marks for now, but do we have real usages for them?
+
+    for (const mark of marks) {
+      const {
+        name
+      } = mark;
+      this.marks[name] = mark;
+      performance.clearMarks(name);
+    }
+  } // Add observer to log future metrics
+  // observe lwr client runtime performance metrics
+
+
+  setupObserver() {
+    let bootstrapErrorCount = 0;
+    const observer = new PerformanceObserver(list => {
+      // grab the lwr performance marks
+      const marks = [];
+      /**
+       * Bootstrap marks after to service bootstrap:
+       * - lwr.bootstrap.end
+       * - lwr.bootstrap.error
+       * Loader marks
+       * - lwr.loader.*
+       */
+
+      list.getEntries().forEach(entry => {
+        const {
+          name,
+          entryType
+        } = entry;
+
+        if (entryType === 'mark' && name.startsWith('lwr.')) {
+          marks.push(entry);
+        }
+
+        if (name === BOOTSTRAP_END_MARK) {
+          this.marks[name] = entry;
+        }
+
+        if (name === BOOTSTRAP_ERROR_MARK) {
+          bootstrapErrorCount += 1;
+        }
+      });
+
+      if (this.marks[BOOTSTRAP_END_MARK] !== undefined) {
+        this.instrumentation.trackValue(BOOTSTRAP_DURATION_OP, this.marks[BOOTSTRAP_END_MARK].startTime);
+        this.instrumentation.trackValue(BOOTSTRAP_AVAILABILITY_OP, 1 / (1 + bootstrapErrorCount) * 100); // reset to prevent multiple reports
+
+        delete this.marks[BOOTSTRAP_END_MARK];
+      } // count how many modules were loaded and report the count
+
+
+      const moduleLoadCount = marks.reduce((count, mark) => {
+        return mark.name.startsWith(LOADER_MODULE_FETCH) ? count + 1 : count;
+      }, 0);
+
+      if (moduleLoadCount > 0) {
+        this.instrumentation.incrementCounter(LOADER_MODULE_FETCH_COUNT, moduleLoadCount);
+      } // count how many mapping resources were loaded and report the count
+
+
+      const mappingLoadCount = marks.reduce((count, mark) => {
+        return mark.name.startsWith(LOADER_MAPPING_FETCH) ? count + 1 : count;
+      }, 0);
+
+      if (mappingLoadCount > 0) {
+        this.instrumentation.incrementCounter(LOADER_MAPPING_FETCH_COUNT, mappingLoadCount);
+      }
+
+      marks.forEach(mark => performance.clearMarks(mark.name));
+    });
+    observer.observe({
+      entryTypes: ['mark']
+    });
+  }
+
+}

package/package.json

@@ -0,0 +1,50 @@
+{
+    "name": "@lwrjs/o11y",
+    "license": "MIT",
+    "publishConfig": {
+        "access": "public"
+    },
+    "version": "0.6.0-alpha.8",
+    "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/salesforce/lwr.git",
+        "directory": "packages/@lwrjs/o11y"
+    },
+    "bugs": {
+        "url": "https://github.com/salesforce/lwr/issues"
+    },
+    "type": "module",
+    "files": [
+        "build/**/*.js",
+        "build/**/*.d.ts"
+    ],
+    "scripts": {
+        "build": "node ../../../bin/pack-lwc --dir modules build/modules && yarn build:bundle",
+        "build:bundle": "rollup --config scripts/rollup.moduleBundle.config.cjs"
+    },
+    "dependencies": {
+        "@lwrjs/shared-utils": "0.6.0-alpha.8",
+        "o11y": "238.1.2"
+    },
+    "devDependencies": {
+        "rollup-plugin-terser": "^7.0.2"
+    },
+    "lwc": {
+        "modules": [
+            {
+                "dir": "build/modules"
+            },
+            {
+                "npm": "o11y"
+            }
+        ],
+        "expose": [
+            "lwr/o11yService"
+        ]
+    },
+    "engines": {
+        "node": ">=14.15.4 <17"
+    },
+    "gitHead": "f57b843b079ef42fdd1e727521e5a88e70bf850a"
+}