@grafana/faro-core 1.0.0-beta1

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,282 @@
+# @grafana/faro-core
+
+Core package of Faro.
+
+_Warning_: currently pre-release and subject to frequent breaking changes. Use at your own risk.
+
+The entire architecture of the library is contained within this package. Out of the box, it doesn't collect any metrics,
+logs etc. but it offers an API to capture them.
+
+## Installation
+
+```ts
+import { initializeFaro } from '@grafana/faro-core';
+
+initializeFaro({
+  // ...
+});
+```
+
+## Options
+
+Faro Web SDK requires a configuration object parameter with the following properties:
+
+| Property                | Description                                                                              | Type                  | Default Value Variable                                   |
+| ----------------------- | ---------------------------------------------------------------------------------------- | --------------------- | -------------------------------------------------------- |
+| `app`                   | Application metadata                                                                     | `App`                 |                                                          |
+| `dedupe`                | A flag for toggling deduplication filter                                                 | `boolean`             |                                                          |
+| `globalObjectKey`       | String that should be used when defining the Faro instance property on the global object | `string`              | `defaultGlobalObjectKey = 'faro'`                        |
+| `instrumentations`      | Array of instrumentations that should be ran                                             | `Instrumentation[]`   |                                                          |
+| `internalLoggerLevel`   | The level of information printed to console for internal messages                        | `InternalLoggerLevel` | `defaultInternalLoggerLevel = InternalLoggerLevel.ERROR` |
+| `isolate`               | A flag that will create an isolated Faro instance                                        | `boolean`             |                                                          |
+| `metas`                 | Array of metas that should be logged                                                     | `MetaItem[]`          |                                                          |
+| `parseStacktrace`       | A function used to parse stack traces                                                    | `StacktraceParser`    |                                                          |
+| `paused`                | Flag for initializing the Faro instance as paused                                        | `boolean`             |                                                          |
+| `preventGlobalExposure` | Flag for toggling the definition on the global object                                    | `boolean`             |                                                          |
+| `transports`            | Array of transports that should be used                                                  | `Transport[]`         |                                                          |
+
+Besides the mandatory properties, Faro configuration also supports the following optional properties:
+
+| Property       | Description                                                                            | Type             | Default Value |
+| -------------- | -------------------------------------------------------------------------------------- | ---------------- | ------------- |
+| `beforeSend`   | Hook invoked before pushing event to transport. Can be used to modify or filter events | `BeforeSendHook` | `undefined`   |
+| `eventDomain`  | event.domain attribute of an event, to be set on every event item as default           | `string`         | `undefined`   |
+| `ignoreErrors` | Error message patterns for errors that should be ignored                               | `Patterns`       | `[]`          |
+| `session`      | Session metadata                                                                       | `Session`        | `undefined`   |
+| `user`         | User metadata                                                                          | `User`           | `undefined`   |
+
+## Faro instance
+
+Faro instance is an object which can be accessed by either importing it from the package or by referencing it from the
+global object (`window` in browsers and `global` in Node.js).
+
+```ts
+// Browser/Node.js
+import { faro } from '@grafana/faro-core';
+
+faro.api.pushLog(/* ... */);
+
+// Browser
+window.faro.api.pushLog(/* ... */);
+
+// Node.js
+global.faro.api.pushLog(/* ... */);
+```
+
+## API
+
+The `api` property on the Faro instance contains all the necessary methods to push new events.
+
+## Errors
+
+- `pushError` - is a method to push an error/exception to the Faro instance. It accepts a mandatory `message` parameter
+  and an optional one where you can set:
+
+  - `skipDedupe` - a flag for enforcing event push even if the event is identical to the previous one.
+  - `stackFrames` - an array of stack frames. Defaults to parsing `error.stack` if present.
+  - `type` - the type of exception. Default value: `error.name` or `"error"`.
+
+  ```ts
+  faro.api.pushError(new Error('This is an error'));
+
+  faro.api.pushError(new Error('This is an unhandled exception'), { type: 'unhandledException' });
+
+  faro.api.pushError(new Error('This is an error with stack frames'), {
+    stackFrames: [
+      {
+        filename: 'file.js',
+        function: 'myFunction',
+        colno: 120,
+        lineno: 80,
+      },
+    ],
+  });
+  ```
+
+## Logs
+
+- `pushLog` - is a method to register a log event. The method accepts a mandatory `args` parameter which is an array of
+  arguments that will be stringified and send to the transports. The other two parameters are optional: `logLevel` is
+  the type of message that we register and `context` is a plain object containing primitive values that will be
+  recorded along with the message.
+
+  ```ts
+  faro.api.pushLog(['This is a log', 'With another message']);
+
+  faro.api.pushLog(['This is a warning'], { level: LogLevel.WARN });
+
+  faro.api.pushLog(['This is a log with context'], {
+    context: {
+      randomNumber: Math.random(),
+    },
+  });
+  ```
+
+## Measurements
+
+- `pushMeasurement` - is a method for registering metrics. The method accepts a mandatory `payload` parameter and an
+  optional parameter for passing additional options:
+
+  - `span` - the span where the exception has occurred. Default value: `undefined`.
+
+  ```ts
+  faro.api.pushMeasurement({
+    type: 'custom',
+    values: {
+      my_custom_metric: Math.random(),
+    },
+  });
+
+  faro.api.pushMeasurement(
+    {
+      type: 'custom',
+      values: {
+        my_custom_metric: Math.random(),
+      },
+    },
+    {
+      span: mySpan,
+    }
+  );
+  ```
+
+## Instrumentations
+
+Instrumentations are packages that leverage the Faro Web SDK API to provide automatic mechanisms
+for collecting data. They are just simple functions that are executed when the agent is initialized.
+
+Please note that the `core` package does not contain any instrumentations out of the box and they should be provided by
+platform specific packages like [@grafana/faro-web-sdk](https://github.com/grafana/faro-web-sdk/tree/main/packages/web)
+
+You can also write your own instrumentations:
+
+```ts
+import { initializeFaro, BaseInstrumentation } from '@grafana/faro-core';
+
+export class MyInstrumentation extends BaseInstrumentation {
+  readonly version = '1.0.0';
+  readonly name = 'my-instrumentation';
+
+  initialize(): void {
+    this.faro.api.pushLog(['hello from my instrumentation']);
+  }
+}
+
+initializeFaro({
+  // ...
+  instrumentations: [new MyInstrumentation()],
+});
+```
+
+## Metas
+
+Metas are objects that will be attached to every event that is triggered by the API.
+
+Out of the box, only one meta is provided: `sdk` which contains information about the Faro instance and its version. Additional
+metas can be provided by external packages like [@grafana/agent-meta-browser](https://github.com/grafana/faro-web-sdk/tree/main/packages/meta-browser)
+and [@grafana/agent-meta-page](https://github.com/grafana/faro-web-sdk/tree/main/packages/meta-page).
+
+You can also define your own metas:
+
+```ts
+import { initializeFaro } from '@grafana/faro-core';
+
+initializeFaro({
+  metas: [
+    // Define a static meta
+    {
+      app: {
+        name: 'my-app',
+        version: '1.0.0',
+      },
+    },
+
+    // Define a meta which caches some values on initialization
+    () => {
+      return {
+        user: {
+          username: getUser().name,
+        },
+      };
+    },
+  ],
+});
+```
+
+## Transports
+
+Transports are functions that will be called for every event that is triggered by the API. They are used to do
+something with the data after collecting it.
+
+Out of the box, no transports are provided in the `core` package and they should be provided by platform specific
+packages like [@grafana/faro-web-sdk](https://github.com/grafana/faro-web-sdk/tree/main/packages/web)
+
+You can also define your own transports:
+
+```ts
+import { initializeFaro, BaseTransport, TransportItem } from '@grafana/faro-core';
+
+class MyTransport extends BaseTransport {
+  send(item: TransportItem) {
+    // do something with paylaod
+  }
+}
+
+initializeFaro({
+  transports: [new MyTransport()],
+});
+```
+
+## Unpatched console
+
+Some instrumentations might override the default console methods but Faro instance provides a way to access the
+unmodified console methods.
+
+```ts
+faro.unpatchedConsole.log('This is a log');
+faro.unpatchedConsole.warn('This is a warning');
+```
+
+## Pause / unpause
+
+Faro instance can be paused by invoking `faro.pause()`.
+This will prevent events from being sent to transports.
+Call `faro.unpause()` to resume capturing events.
+
+## Isolated Faro instances
+
+Sometimes you may want to create one or more isolated Faro instances. For example:
+
+- you want to bundle Faro in a reusable library and report certain events only for it while the project where the
+  library is used has its own Faro instance
+- you want to log certain events in one system while other events in other systems
+- E2E libraries that may create multiple Faro instances without refreshing the page
+
+In order to achieve this, you can use the `isolate` flag when initializing the agent:
+
+```ts
+// faro 1 will be isolated
+const faro1 = initializeFaro({
+  // ...
+  isolate: true,
+});
+
+// globalFaro will be available globally
+const globalFaro = initializeFaro({
+  // ...
+  isolate: false,
+});
+
+// another isolated Faro instance
+const faro2 = initializeFaro({
+  // ...
+  isolate: true,
+});
+```
+
+Although an isolated agent may sound like a great idea, there are some limitations which apply to them:
+
+- some instrumentations will still register globally (i.e. exceptions instrumentation or console instrumentation)
+- an isolated Faro instance will not be available on the global object
+- the Faro reference should be stored by the project as it won't be available via
+  `import { faro } from '@grafana/faro-core';`

package/dist/cjs/api/events/index.d.ts

@@ -0,0 +1,2 @@
+export type { EventEvent, EventsAPI } from './types';
+export { initializeEventsAPI } from './initialize';

package/dist/cjs/api/events/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initializeEventsAPI = void 0;
+var initialize_1 = require("./initialize");
+Object.defineProperty(exports, "initializeEventsAPI", { enumerable: true, get: function () { return initialize_1.initializeEventsAPI; } });
+//# sourceMappingURL=index.js.map

package/dist/cjs/api/events/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/events/index.ts"],"names":[],"mappings":";;;AACA,2CAAmD;AAA1C,iHAAA,mBAAmB,OAAA"}

package/dist/cjs/api/events/initialize.d.ts

@@ -0,0 +1,7 @@
+import type { Config } from '../../config';
+import type { InternalLogger } from '../../internalLogger';
+import type { Metas } from '../../metas';
+import { Transports } from '../../transports';
+import type { TracesAPI } from '../traces';
+import type { EventsAPI } from './types';
+export declare function initializeEventsAPI(internalLogger: InternalLogger, config: Config, transports: Transports, metas: Metas, tracesApi: TracesAPI): EventsAPI;

package/dist/cjs/api/events/initialize.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initializeEventsAPI = void 0;
+var transports_1 = require("../../transports");
+var utils_1 = require("../../utils");
+function initializeEventsAPI(internalLogger, config, transports, metas, tracesApi) {
+    var lastPayload = null;
+    var pushEvent = function (name, attributes, domain, _a) {
+        var _b = _a === void 0 ? {} : _a, skipDedupe = _b.skipDedupe;
+        try {
+            var item = {
+                meta: metas.value,
+                payload: {
+                    name: name,
+                    domain: domain !== null && domain !== void 0 ? domain : config.eventDomain,
+                    attributes: attributes,
+                    timestamp: (0, utils_1.getCurrentTimestamp)(),
+                    trace: tracesApi.getTraceContext(),
+                },
+                type: transports_1.TransportItemType.EVENT,
+            };
+            var testingPayload = {
+                name: item.payload.name,
+                attributes: item.payload.attributes,
+                domain: item.payload.domain,
+            };
+            if (!skipDedupe && config.dedupe && !(0, utils_1.isNull)(lastPayload) && (0, utils_1.deepEqual)(testingPayload, lastPayload)) {
+                internalLogger.debug('Skipping event push because it is the same as the last one\n', item.payload);
+                return;
+            }
+            lastPayload = testingPayload;
+            internalLogger.debug('Pushing event\n', item);
+            transports.execute(item);
+        }
+        catch (err) {
+            internalLogger.error('Error pushing event', err);
+        }
+    };
+    return {
+        pushEvent: pushEvent,
+    };
+}
+exports.initializeEventsAPI = initializeEventsAPI;
+//# sourceMappingURL=initialize.js.map

package/dist/cjs/api/events/initialize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"initialize.js","sourceRoot":"","sources":["../../../../src/api/events/initialize.ts"],"names":[],"mappings":";;;AAGA,+CAAgF;AAChF,qCAAqE;AAIrE,SAAgB,mBAAmB,CACjC,cAA8B,EAC9B,MAAc,EACd,UAAsB,EACtB,KAAY,EACZ,SAAoB;IAEpB,IAAI,WAAW,GAA8D,IAAI,CAAC;IAElF,IAAM,SAAS,GAA2B,UAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,EAAmB;YAAnB,qBAAiB,EAAE,KAAA,EAAjB,UAAU,gBAAA;QAC/E,IAAI;YACF,IAAM,IAAI,GAA8B;gBACtC,IAAI,EAAE,KAAK,CAAC,KAAK;gBACjB,OAAO,EAAE;oBACP,IAAI,MAAA;oBACJ,MAAM,EAAE,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,MAAM,CAAC,WAAW;oBACpC,UAAU,YAAA;oBACV,SAAS,EAAE,IAAA,2BAAmB,GAAE;oBAChC,KAAK,EAAE,SAAS,CAAC,eAAe,EAAE;iBACnC;gBACD,IAAI,EAAE,8BAAiB,CAAC,KAAK;aAC9B,CAAC;YAEF,IAAM,cAAc,GAAG;gBACrB,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI;gBACvB,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;gBACnC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;aAC5B,CAAC;YAEF,IAAI,CAAC,UAAU,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,IAAA,cAAM,EAAC,WAAW,CAAC,IAAI,IAAA,iBAAS,EAAC,cAAc,EAAE,WAAW,CAAC,EAAE;gBAClG,cAAc,CAAC,KAAK,CAAC,8DAA8D,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;gBAEnG,OAAO;aACR;YAED,WAAW,GAAG,cAAc,CAAC;YAE7B,cAAc,CAAC,KAAK,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;YAE9C,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SAC1B;QAAC,OAAO,GAAG,EAAE;YACZ,cAAc,CAAC,KAAK,CAAC,qBAAqB,EAAE,GAAG,CAAC,CAAC;SAClD;IACH,CAAC,CAAC;IAEF,OAAO;QACL,SAAS,WAAA;KACV,CAAC;AACJ,CAAC;AAhDD,kDAgDC"}

package/dist/cjs/api/events/initialize.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/api/events/initialize.test.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var metas_1 = require("../../metas");
+var testUtils_1 = require("../../testUtils");
+var transports_1 = require("../../transports");
+var traces_1 = require("../traces");
+var initialize_1 = require("./initialize");
+describe('api.events', function () {
+    function createAPI(_a) {
+        var _b = _a === void 0 ? { dedupe: true } : _a, dedupe = _b.dedupe;
+        var transport = new testUtils_1.MockTransport();
+        var config = (0, testUtils_1.mockConfig)({
+            dedupe: dedupe,
+            transports: [transport],
+        });
+        var transports = (0, transports_1.initializeTransports)(testUtils_1.mockInternalLogger, config);
+        var metas = (0, metas_1.initializeMetas)(testUtils_1.mockInternalLogger, config);
+        var tracesAPI = (0, traces_1.initializeTracesAPI)(testUtils_1.mockInternalLogger, config, transports, metas);
+        var api = (0, initialize_1.initializeEventsAPI)(testUtils_1.mockInternalLogger, config, transports, metas, tracesAPI);
+        return [api, transport];
+    }
+    describe('pushEvent', function () {
+        var api;
+        var transport;
+        beforeEach(function () {
+            var _a;
+            _a = createAPI(), api = _a[0], transport = _a[1];
+        });
+        describe('Filtering', function () {
+            it('filters the same event', function () {
+                api.pushEvent('test', {
+                    a: '1',
+                });
+                expect(transport.items).toHaveLength(1);
+                api.pushEvent('test', {
+                    a: '1',
+                });
+                expect(transport.items).toHaveLength(1);
+            });
+            it("doesn't filter events with same name and partially same values", function () {
+                api.pushEvent('test', {
+                    a: '1',
+                });
+                expect(transport.items).toHaveLength(1);
+                api.pushEvent('test', {
+                    a: '1',
+                    b: '2',
+                });
+                expect(transport.items).toHaveLength(2);
+            });
+            it("doesn't filter events with different name and same values", function () {
+                api.pushEvent('test1', {
+                    a: '1',
+                });
+                expect(transport.items).toHaveLength(1);
+                api.pushEvent('test2', {
+                    a: '1',
+                });
+                expect(transport.items).toHaveLength(2);
+            });
+            it("filters an event and doesn't filter the next different one", function () {
+                api.pushEvent('test1', {
+                    a: '1',
+                });
+                expect(transport.items).toHaveLength(1);
+                api.pushEvent('test1', {
+                    a: '1',
+                });
+                expect(transport.items).toHaveLength(1);
+                api.pushEvent('test2', {
+                    b: '1',
+                });
+                expect(transport.items).toHaveLength(2);
+            });
+            it("doesn't filter when dedupe is false", function () {
+                var _a;
+                _a = createAPI({ dedupe: false }), api = _a[0], transport = _a[1];
+                api.pushEvent('test');
+                expect(transport.items).toHaveLength(1);
+                api.pushEvent('test');
+                expect(transport.items).toHaveLength(2);
+            });
+            it("doesn't filter when skipDedupe is true", function () {
+                api.pushEvent('test');
+                expect(transport.items).toHaveLength(1);
+                api.pushEvent('test', {}, undefined, { skipDedupe: true });
+                expect(transport.items).toHaveLength(2);
+            });
+        });
+    });
+});
+//# sourceMappingURL=initialize.test.js.map

package/dist/cjs/api/events/initialize.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"initialize.test.js","sourceRoot":"","sources":["../../../../src/api/events/initialize.test.ts"],"names":[],"mappings":";;AAAA,qCAA8C;AAC9C,6CAAgF;AAChF,+CAAwD;AACxD,oCAAgD;AAChD,2CAAmD;AAGnD,QAAQ,CAAC,YAAY,EAAE;IACrB,SAAS,SAAS,CAAC,EAAkD;YAAlD,qBAAkC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAA,EAAhD,MAAM,YAAA;QACzB,IAAM,SAAS,GAAG,IAAI,yBAAa,EAAE,CAAC;QACtC,IAAM,MAAM,GAAG,IAAA,sBAAU,EAAC;YACxB,MAAM,QAAA;YACN,UAAU,EAAE,CAAC,SAAS,CAAC;SACxB,CAAC,CAAC;QACH,IAAM,UAAU,GAAG,IAAA,iCAAoB,EAAC,8BAAkB,EAAE,MAAM,CAAC,CAAC;QACpE,IAAM,KAAK,GAAG,IAAA,uBAAe,EAAC,8BAAkB,EAAE,MAAM,CAAC,CAAC;QAC1D,IAAM,SAAS,GAAG,IAAA,4BAAmB,EAAC,8BAAkB,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QACrF,IAAM,GAAG,GAAG,IAAA,gCAAmB,EAAC,8BAAkB,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;QAE1F,OAAO,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IAC1B,CAAC;IAED,QAAQ,CAAC,WAAW,EAAE;QACpB,IAAI,GAAc,CAAC;QACnB,IAAI,SAAwB,CAAC;QAE7B,UAAU,CAAC;;YACT,KAAmB,SAAS,EAAE,EAA7B,GAAG,QAAA,EAAE,SAAS,QAAA,CAAgB;QACjC,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,WAAW,EAAE;YACpB,EAAE,CAAC,wBAAwB,EAAE;gBAC3B,GAAG,CAAC,SAAS,CAAC,MAAM,EAAE;oBACpB,CAAC,EAAE,GAAG;iBACP,CAAC,CAAC;gBACH,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;gBAExC,GAAG,CAAC,SAAS,CAAC,MAAM,EAAE;oBACpB,CAAC,EAAE,GAAG;iBACP,CAAC,CAAC;gBACH,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,gEAAgE,EAAE;gBACnE,GAAG,CAAC,SAAS,CAAC,MAAM,EAAE;oBACpB,CAAC,EAAE,GAAG;iBACP,CAAC,CAAC;gBACH,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;gBAExC,GAAG,CAAC,SAAS,CAAC,MAAM,EAAE;oBACpB,CAAC,EAAE,GAAG;oBACN,CAAC,EAAE,GAAG;iBACP,CAAC,CAAC;gBACH,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,2DAA2D,EAAE;gBAC9D,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE;oBACrB,CAAC,EAAE,GAAG;iBACP,CAAC,CAAC;gBACH,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;gBAExC,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE;oBACrB,CAAC,EAAE,GAAG;iBACP,CAAC,CAAC;gBACH,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,4DAA4D,EAAE;gBAC/D,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE;oBACrB,CAAC,EAAE,GAAG;iBACP,CAAC,CAAC;gBACH,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;gBAExC,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE;oBACrB,CAAC,EAAE,GAAG;iBACP,CAAC,CAAC;gBACH,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;gBAExC,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE;oBACrB,CAAC,EAAE,GAAG;iBACP,CAAC,CAAC;gBACH,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,qCAAqC,EAAE;;gBACxC,KAAmB,SAAS,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAA9C,GAAG,QAAA,EAAE,SAAS,QAAA,CAAiC;gBAEhD,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBACtB,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;gBAExC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBACtB,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,wCAAwC,EAAE;gBAC3C,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBACtB,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;gBAExC,GAAG,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC3D,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}