@dstny/faro-instrumentation-performance-timeline 1.19.5

package/.browserslistrc

@@ -0,0 +1 @@
+supports es6-module

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,143 @@
+# @grafana/instrumentation-performance-timeline
+
+Faro instrumentation to capture [Performance Timeline](https://www.w3.org/TR/performance-timeline/)
+data.
+
+❗️*Warning*: this package is experimental and may be subject to frequent and breaking changes.
+Use at your own risk.❗️
+
+## Installation
+
+```ts
+import { PerformanceTimelineInstrumentation } from '@grafana/faro-instrumentation-performance-timeline';
+import { getWebInstrumentations, initializeFaro } from '@grafana/faro-react';
+
+initializeFaro({
+  // ...
+  instrumentations: [
+    // Load the default Web instrumentations
+    ...getWebInstrumentations(),
+    new PerformanceTimelineInstrumentation(),
+  ],
+});
+```
+
+## Usage
+
+### What entry types can I capture?
+
+The FaroPerformanceTimeline instrumentation is able to track all entry types as defined by
+[PerformanceEntry: entryType property](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceEntry/entryType).
+
+For each Performance Entry it sends an event named `faro.performanceEntry`
+
+By default we track entries of type
+[navigation](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceNavigationTiming)
+and [resource](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
+These entry types allow you to track the load timings of the assets of your page or spa.
+
+You can specify which entry types to track via the `observeEntryTypes` array in the config.
+This will also overwrite the default entry types. Since the usage of the default entry types is so
+common, we provide them as a constant (`DEFAULT_PERFORMANCE_TIMELINE_ENTRY_TYPES`) you can add
+alongside your owen entries.
+
+#### Example of how to specify entry types to track
+
+Alongside the default entry types the example adds entries to track
+[PerformanceEventTiming](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceEventTiming),
+[mark](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceMark) and
+[PerformanceMeasure](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceMeasure).
+
+```ts
+new PerformanceTimelineInstrumentation({
+  observeEntryTypes: [
+    ...DEFAULT_PERFORMANCE_TIMELINE_ENTRY_TYPES,
+    { type: 'event', buffered: true },
+    { type: 'mark',  buffered: true },
+    { type: 'measure', , buffered: true },
+  ],
+}),
+```
+
+Additionally you can add all config properties a respective PerformanceEntry provides.
+For example if you want to change the duration threshold for `PerformanceEventTiming`.
+
+```ts
+{ type: 'event', durationThreshold: 96, buffered: true },
+```
+
+Note:
+Browser support for entry types differs. In the case that one of your specified entries
+is not support Faro will log a message and does not register to track these entries.
+
+### How can I skip entries?
+
+#### By URL
+
+It is possible to skip capturing entries by URL. This is can be archived by specifying respective
+URLs in the `ignoredURLs` array.
+By default Faro skips urls defined by the transports. Usually these are the receiver URLs.
+
+##### Example of how to specify skip URLs
+
+```ts
+new PerformanceTimelineInstrumentation({
+  ignoredURLs: [...]
+}),
+```
+
+Note:\
+This overwrites the default skip URLs.
+
+#### By using the beforeEmit hook
+
+You can use the beforeEmit hook to skip entries simply by returning `false` for the desired entry.
+For more information see `Mutating or filtering performance entries` below.
+
+##### Example: Skip back/forward navigation and page reloads to remove non human visible navigation
+
+```ts
+new PerformanceTimelineInstrumentation({
+  beforeEmit: (performanceEntryJSON) => {
+    const entryType = performanceEntryJSON.type;
+    const type = performanceEntryJSON.type;
+
+    if (entryType === 'navigation' && ['reload', 'back_forward'].includes(type)) {
+      return false;
+    }
+
+    return performanceEntryJSON;
+  },
+});
+```
+
+### Mutating or filtering performance entries
+
+The Performance Timeline emits a lot of data which quickly adds up. Often users mutate Performance
+Entries to trim down the payload size of an entry, to further remove noise or if they need
+a filter which can not be achieved with the above config options.
+
+Therefore we provide the `beforeEmit` hook.
+
+This hook triggers after all the other options mentioned above i. e. skipping entries by url.
+
+The `beforeEmit` hook receives the json representation of a performance entry as a parameter and
+either returns the performance entry which shall be send to the backend or `false` in case the
+entire entry should be dropped.
+
+`beforeEmit: (performanceEntry: performanceEntryJSON: any) => Record<string, any> | false;`
+
+Note:\
+The JSON representation of the performance entry is the object returned by calling the `toJSON()`
+function of the respective PerformanceEntry.
+
+### Config Options
+
+- `observeEntryTypes: ObserveEntries[]`: The Performance Entry types which should be observed.
+- `resourceTimingBufferSize: number`: The size of the browser's resource timing buffer which stores
+  the "resource" performance entries.
+- `maxResourceTimingBufferSize: number`: If resource buffer size is full, set this as the new.
+- `ignoredUrls?: Array<string | RegExp>`: URLs which should be ignored.
+- `beforeEmit?: (performanceEntryJSON: Record<string, any>) => Record<string, any> | false;`
+  : Mutate a performance entry before emitting it. Parameter is the JSON representation of the
+  PerformanceEntry. Return false if you want to skip an entire entry.

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@dstny/faro-instrumentation-performance-timeline",
+  "version": "1.19.5",
+  "description": "Faro instrumentation to capture Browser Performance Timeline data.",
+  "keywords": [
+    "observability",
+    "apm",
+    "rum",
+    "logs",
+    "traces",
+    "metrics",
+    "performanceTimeline"
+  ],
+  "license": "Apache-2.0",
+  "author": "Grafana Labs",
+  "homepage": "https://github.com/grafana/faro-web-sdk",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/grafana/faro-web-sdk.git",
+    "directory": "experimental/instrumentation-performance-timeline"
+  },
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "files": [
+    ".browserslistrc",
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "start": "yarn watch",
+    "build": "run-s 'build:*'",
+    "build:compile": "run-p 'build:compile:*'",
+    "build:compile:cjs": "tsc --build tsconfig.cjs.json",
+    "build:compile:esm": "tsc --build tsconfig.esm.json",
+    "build:compile:bundle": "run-s 'build:compile:bundle:*'",
+    "build:compile:bundle:create": "rollup -c ./rollup.config.js",
+    "build:compile:bundle:remove-extras": "rimraf dist/bundle/dist",
+    "watch": "run-s watch:compile",
+    "watch:compile": "yarn build:compile:cjs -w",
+    "clean": "rimraf dist/ yarn-error.log",
+    "quality": "run-s 'quality:*'",
+    "quality:test": "jest",
+    "quality:format": "prettier --cache --cache-location=../../.cache/prettier/instrumentationPerformanceTimeline --ignore-path ../../.prettierignore -w \"./**/*.{js,jsx,ts,tsx,css,scss,md,yaml,yml,json}\"",
+    "quality:lint": "run-s 'quality:lint:*'",
+    "quality:lint:eslint": "eslint --cache --cache-location ../../.cache/eslint/instrumentationPerformanceTimeline --ignore-path ../../.eslintignore \"./**/*.{js,jsx,ts,tsx}\"",
+    "quality:lint:prettier": "prettier --cache --cache-location=../../.cache/prettier/instrumentationPerformanceTimeline --ignore-path ../../.prettierignore -c \"./**/*.{js,jsx,ts,tsx,css,scss,md,yaml,yml,json}\"",
+    "quality:lint:md": "markdownlint README.md",
+    "quality:circular-deps": "madge --circular ."
+  },
+  "devDependencies": {
+    "@dstny/faro-core": "^1.19.5"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "4f6f40175de473c37009f544d20fabbfa0b91c3d"
+}