@newrelic/browser-agent 0.0.9 → 0.1.229

package/package.json

@@ -1,85 +1,218 @@
 {
   "name": "@newrelic/browser-agent",
-  "version": "0.0.9",
-  "author": "New Relic Browser agent team <browser-agent@newrelic.com>",
+  "version": "0.1.229",
+  "private": false,
+  "author": "New Relic Browser Agent Team <browser-agent@newrelic.com>",
+  "description": "Tests for the New Relic JavaScript agent",
   "license": "Apache-2.0",
-  "contributors": [
-    {
-      "name": "Jordan Porter",
-      "email": "jporter@newrelic.com",
-      "web": "http://newrelic.com"
-    },
-    {
-      "name": "Aubrey Masten",
-      "email": "amasten@newrelic.com",
-      "web": "http://newrelic.com"
-    }
-  ],
-  "homepage": "https://github.com/newrelic/newrelic-browser-agent",
-  "repository": "github:newrelic/newrelic-browser-agent",
-  "main": "dist/umd/index.js",
-  "module": "dist/es/index.js",
-  "types": "dist/es/index.d.ts",
+  "homepage": "https://docs.newrelic.com/docs/browser/browser-monitoring",
+  "main": "./dist/cjs/index.js",
+  "types": "./types.ts",
   "exports": {
-    "./bundled": "./dist/bundled/es6/index.js",
-    "./cjs": "./dist/cjs/index.js",
-    "./es": "./dist/es/index.js",
-    "./umd": "./dist/umd/index.js",
     ".": {
-      "import": "./dist/es/index.js",
-      "require": "./dist/cjs/index.js",
-      "types": "./dist/es/index.d.ts"
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    },
+    "./loaders/agent": {
+      "import": "./dist/esm/loaders/agent.js",
+      "require": "./dist/cjs/loaders/agent.js"
+    },
+    "./loaders/browser-agent": {
+      "import": "./dist/esm/loaders/browser-agent.js",
+      "require": "./dist/cjs/loaders/browser-agent.js"
+    },
+    "./loaders/worker-agent": {
+      "import": "./dist/esm/loaders/worker-agent.js",
+      "require": "./dist/cjs/loaders/worker-agent.js"
+    },
+    "./features/ajax": {
+      "import": "./dist/esm/features/ajax/index.js",
+      "require": "./dist/cjs/features/ajax/index.js"
+    },
+    "./features/jserrors": {
+      "import": "./dist/esm/features/jserrors/index.js",
+      "require": "./dist/cjs/features/jserrors/index.js"
+    },
+    "./features/metrics": {
+      "import": "./dist/esm/features/metrics/index.js",
+      "require": "./dist/cjs/features/metrics/index.js"
+    },
+    "./features/page_action": {
+      "import": "./dist/esm/features/page_action/index.js",
+      "require": "./dist/cjs/features/page_action/index.js"
+    },
+    "./features/page_view_event": {
+      "import": "./dist/esm/features/page_view_event/index.js",
+      "require": "./dist/cjs/features/page_view_event/index.js"
+    },
+    "./features/page_view_timing": {
+      "import": "./dist/esm/features/page_view_timing/index.js",
+      "require": "./dist/cjs/features/page_view_timing/index.js"
+    },
+    "./features/session_trace": {
+      "import": "./dist/esm/features/session_trace/index.js",
+      "require": "./dist/cjs/features/session_trace/index.js"
+    },
+    "./features/spa": {
+      "import": "./dist/esm/features/spa/index.js",
+      "require": "./dist/cjs/features/spa/index.js"
     }
   },
-  "description": "",
+  "engines": {
+    "node": ">=12.17.0 < 13.0.0 || >=13.7.0"
+  },
+  "scripts": {
+    "wdio": "node tools/wdio/bin/cli.js",
+    "start": "npm-run-all --parallel cdn:watch test-server",
+    "unit": "jest",
+    "format": "prettier -w .",
+    "format:check": "prettier --check .",
+    "test": "node tools/jil/bin/cli.js",
+    "build:all": "npm run cdn:build:local && npm run build:npm && npm run tools:test-builds",
+    "build:npm": "npm run npm:build:esm && npm run npm:build:cjs && npm run npm:pack",
+    "lint": "eslint -c .eslintrc.js --ext .js,.cjs,.mjs . --fix",
+    "lint:fix": "eslint --ext .js -c .eslintrc . --fix",
+    "test-all": "tools/jil/bin/cli.js -b *@*",
+    "ci-build": "npm ci --cache ./.npm",
+    "build-tar": "npm run ci-build && tar czf ./build/browser-agent.tar.gz --exclude=.git --exclude=.npm --exclude=build/browser-agent.tar.gz .",
+    "watch": "jung -D '\\.npm|.git|node_modules|build|tools|tests' --run -- npm run build:all",
+    "cdn:build": "npm run cdn:build:prod",
+    "cdn:build:extension": "PUBLISH=EXTENSION rm -rf ./build && npm run cdn:webpack && npm run cdn:cleanup",
+    "cdn:build:local": "npm run cdn:webpack && npm run cdn:cleanup",
+    "cdn:build:prod": "npm run cdn:fresh-build && PUBLISH=PROD npm run cdn:webpack && npm run cdn:cleanup",
+    "cdn:build:dev": "npm run cdn:fresh-build && PUBLISH=DEV npm run cdn:webpack && npm run cdn:cleanup",
+    "cdn:build:current": "npm run cdn:fresh-build && PUBLISH=CURRENT npm run cdn:webpack && npm run cdn:cleanup",
+    "cdn:build:nr": "npm run cdn:fresh-build && PUBLISH=PROD SOURCEMAPS=false npm run cdn:webpack && npm run cdn:cleanup",
+    "cdn:build:pr": "npm run cdn:fresh-build && PUBLISH=PR npm run cdn:webpack && npm run cdn:cleanup",
+    "cdn:cleanup": "node ./tools/scripts/post-build-cleanup",
+    "cdn:fresh-build": "rm -rf ./build",
+    "cdn:watch": "jung -r ./src -F '.*\\.test\\.js' --run -- npm run cdn:build:local",
+    "cdn:watch:extension": "jung -r ./src -F '.*\\.test\\.js' --run -- npm run cdn:build:extension",
+    "cdn:webpack": "npx webpack --progress --config ./webpack.config.js",
+    "packages:bundle": "webpack -c tools/jil/webpack.modular.js",
+    "test-server": "node ./tools/jil/bin/server",
+    "sauce:connect": "node ./tools/wdio/bin/sauce",
+    "sauce:get-browsers": "node ./tools/jil/util/sauce-browsers && node ./tools/wdio/util/sauce-browsers",
+    "tools:test-builds": "npm --prefix ./tools/test-builds run build-all",
+    "third-party-updates": "oss third-party manifest --includeOptDeps && oss third-party notices --includeOptDeps",
+    "prepare": "husky install",
+    "npm:build:esm": "npx babel --config-file ./babel.npm.esm.js --out-dir dist/esm --out-file-extension .js ./src",
+    "npm:build:cjs": "npx babel --config-file ./babel.npm.cjs.js --out-dir dist/cjs --out-file-extension .js ./src",
+    "npm:pack": "mkdir -p temp && export PKG_NAME=$(npm pack --pack-destination temp) && echo ./temp/$PKG_NAME",
+    "sync:version": "node tools/scripts/sync-version.js"
+  },
+  "config": {
+    "unsafe-perm": true
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/newrelic/newrelic-browser-agent.git"
+  },
   "dependencies": {
-    "@newrelic/browser-agent-core": "^0.0.9"
+    "core-js": "^3.26.0",
+    "lodash._slice": "^2.4.1",
+    "web-vitals": "^3.1.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.18.0",
-    "@babel/preset-env": "^7.18.0",
-    "@types/jest": "^27.4.1",
-    "babel-jest": "^27.0.0",
+    "@actions/core": "^1.10.0",
+    "@babel/cli": "^7.20.7",
+    "@babel/core": "^7.20.12",
+    "@babel/eslint-parser": "^7.19.1",
+    "@babel/plugin-proposal-optional-chaining": "^7.20.7",
+    "@babel/plugin-syntax-dynamic-import": "^7.8.3",
+    "@babel/plugin-syntax-import-assertions": "^7.20.0",
+    "@babel/plugin-transform-modules-commonjs": "^7.18.2",
+    "@babel/plugin-transform-strict-mode": "^7.18.6",
+    "@babel/preset-env": "^7.20.2",
+    "@faker-js/faker": "^7.6.0",
+    "@fastify/cors": "^8.2.0",
+    "@fastify/multipart": "^7.3.0",
+    "@fastify/static": "^6.6.0",
+    "@newrelic/newrelic-oss-cli": "^0.1.2",
+    "@newrelic/nr-querypack": "https://git@github.com/newrelic/nr-querypack",
+    "@octokit/rest": "^19.0.7",
+    "@wdio/cli": "^8.1.2",
+    "@wdio/local-runner": "^8.1.2",
+    "@wdio/mocha-framework": "^8.1.2",
+    "@wdio/sauce-service": "^8.1.2",
+    "@wdio/selenium-standalone-service": "^8.1.2",
+    "@wdio/spec-reporter": "^8.1.2",
+    "aws-sdk": "^2.894.0",
+    "babel-jest": "^29.4.1",
     "babel-loader": "^8.2.5",
-    "babel-plugin-add-module-exports": "^1.0.4",
-    "babel-polyfill": "^6.26.0",
-    "babel-preset-minify": "^0.5.2",
-    "dotenv-webpack": "^7.1.0",
-    "eslint": "^8.8.0",
-    "jest": "^27.5.1",
-    "regenerator-runtime": "^0.13.9",
-    "shx": "^0.3.4",
-    "terser-webpack-plugin": "^5.3.1",
-    "ts-jest": "^27.1.4",
-    "ts-loader": "^9.3.0",
-    "tslint": "^6.1.3",
-    "typescript": "^4.6.2",
-    "webpack": "^5.70.0",
-    "webpack-bundle-analyzer": "^4.5.0",
-    "webpack-cli": "^4.9.2"
-  },
-  "scripts": {
-    "build": "npm run clean && tsc -p ./tsconfig.build.cjs.json && tsc -p ./tsconfig.build.es.lazy.json && tsc -p ./tsconfig.build.umd.json && npm run compile",
-    "compile": "npx webpack --config ./webpack.config.es6.js && npx webpack --config ./webpack.config.es5.js",
-    "pack": "npm run clean && npm run build && mkdir local-install && npm pack --pack-destination ./local-install && mv ./local-install/newrelic-browser-agent-*.tgz ./local-install/newrelic-browser-agent.tgz",
-    "clean": "shx rm -rf lib local-install dist",
-    "test": "jest --coverage",
-    "test:watch": "jest --watch",
-    "test:watch-cover": "jest --watch --coverage"
+    "babel-plugin-module-resolver": "^4.1.0",
+    "babel-plugin-search-and-replace": "^1.1.1",
+    "babel-plugin-transform-inline-environment-variables": "^0.4.4",
+    "babelify": "^10.0.0",
+    "browserify": "^13.3.0",
+    "bundle-collapser": "^1.2.1",
+    "chalk": "^5.1.2",
+    "charm": "^1.0.1",
+    "concat-stream": "^1.5.1",
+    "cors": "^2.7.1",
+    "create-polyfill-service-url": "^2.2.6",
+    "deepmerge-ts": "^4.2.2",
+    "defined": "^1.0.0",
+    "dotenv-webpack": "^8.0.1",
+    "eslint": "^8.34.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-import-resolver-alias": "^1.1.2",
+    "eslint-import-resolver-webpack": "^0.13.2",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-n": "^15.6.1",
+    "eslint-plugin-promise": "^6.1.1",
+    "fastify": "^4.13.0",
+    "fastify-plugin": "^4.4.0",
+    "filesize": "^10.0.6",
+    "fs-extra": "^11.1.0",
+    "function-bind": "^1.1.1",
+    "glob": "^7.0.5",
+    "husky": "^8.0.0",
+    "html-webpack-plugin": "^5.5.0",
+    "jest": "^28.1.1",
+    "jest-environment-jsdom": "28.1.1",
+    "jquery": "1.11.3",
+    "jsonc-eslint-parser": "^2.1.0",
+    "jung": "^2.1.0",
+    "just-debounce": "^1.0.0",
+    "ls-stream": "^1.0.0",
+    "mime-types": "^2.1.11",
+    "minimatch": "^3.0.3",
+    "multiparty": "^4.1.2",
+    "newrelic": "^9.7.5",
+    "node-fetch": "^3.3.0",
+    "npm-run-all": "^4.1.5",
+    "object-inspect": "^1.5.0",
+    "octokit": "^2.0.14",
+    "preprocessify": "0.0.6",
+    "request": "2.74.0",
+    "sauce-connect-launcher": "^1.2.4",
+    "saucelabs": "^7.2.0",
+    "semver": "^5.3.0",
+    "serialize-anything": "^1.2.3",
+    "server-destroy": "^1.0.1",
+    "sinon": "^1.17.5",
+    "tap-parser": "^1.2.2",
+    "tape": "^4.8.0",
+    "through": "^2.3.8",
+    "through2": "^2.0.1",
+    "transpile-webpack-plugin": "^1.1.1",
+    "uglify-js": "^3.15.4",
+    "uuid": "^9.0.0",
+    "vinyl-buffer": "^1.0.1",
+    "vinyl-source-stream": "^2.0.0",
+    "wait-on": "^7.0.1",
+    "watchify": "^3.7.0",
+    "wd": "^1.11.2",
+    "webpack": "^5.74.0",
+    "webpack-bundle-analyzer": "^4.7.0",
+    "webpack-cli": "^4.10.0",
+    "yargs": "^17.6.2"
   },
   "files": [
-    "dist/"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "keywords": [
-    "new relic",
-    "browser",
-    "instrumentation",
-    "errors",
-    "micro front ends",
-    "browser agent"
-  ],
-  "gitHead": "641472040562b78d2a334a8f41da97ccaf7c99ed"
+    "dist",
+    "LICENSE",
+    "README.md",
+    "types.ts"
+  ]
 }

package/types.ts

@@ -0,0 +1,221 @@
+export interface BrowserAgent {
+    config: NrOptions;
+    start: (options: NrOptions) => Promise<boolean>;
+    sharedAggregator: any;
+    features: any[]
+    agentIdentifier: String;
+    setErrorHandler: (filterCallback: ErrorHandler) => void;
+    finished: (timestamp?: number) => void;
+    inlineHit: () => void;
+    addRelease: (releaseName: string, releaseId: string) => void;
+    addPageAction: (name: string, attributes?: Record<string, SimpleType>) => void;
+    addToTrace: (eventObject: EventObject) => void;
+    setCurrentRouteName: (name: string | null) => void;
+    setPageViewName: (name: string, host?: string) => void;
+    setCustomAttribute: (name: string, value: SimpleType) => void;
+    interaction: () => BrowserInteraction;
+    noticeError: (error: Error | string, customAttributes?: Record<string, SimpleType>) => void;
+}
+
+export interface NrOptions {
+    info: NrInfo,
+    init: NrInit,
+    loader_config: NrLoaderConfig,
+    runtime: NrRuntime,
+    exposed: boolean
+}
+
+interface NrShared {
+    applicationID?: string;
+    licenseKey?: string;
+}
+
+export interface NrRuntime {
+    customTransaction?: any,
+    disabled?: boolean,
+    features?: {},
+    maxBytes?: boolean,
+    offset?: number,
+    onerror?: () => boolean,
+    origin?: string,
+    ptid?: string,
+    releaseIds?: {},
+    sessionId?: string,
+    xhrWrappable?: boolean,
+    userAgent?: string
+}
+
+export interface NrInfo extends NrShared {
+    applicationID: string;
+    licenseKey: string;
+    beacon: string // sets beacon and errorBeacon
+    errorBeacon?: string
+    sa?: number
+    queueTime?: number;
+    applicationTime?: number;
+    ttGuid?: string;
+    user?: string;
+    account?: string;
+    product?: string;
+    extra?: string;
+    userAttributes?: string;
+    atts?: string;
+    transactionName?: string;
+    tNamePlain?: string;
+}
+
+export interface NrInit {
+    privacy?: { cookies_enabled?: boolean }, // *cli - per discussion, default should be boolean
+    ajax?: { deny_list?: string, enabled?: boolean, auto?: boolean, harvestTimeSeconds?: number },
+    distributed_tracing?: {
+        enabled?: boolean
+        exclude_newrelic_header?: boolean
+        cors_use_newrelic_header?: boolean
+        cors_use_tracecontext_headers?: boolean
+        allowed_origins?: string[]
+    }
+    ssl?: boolean,
+    obfuscate?: { regex?: string | RegExp, replacement?: string }[],
+    jserrors?: { enabled?: boolean, auto?: boolean, harvestTimeSeconds?: number },
+    metrics?: { enabled?: boolean, auto?: boolean },
+    page_action?: { enabled?: boolean, auto?: false, harvestTimeSeconds?: number },
+    page_view_event?: { enabled?: boolean, auto?: boolean },
+    page_view_timing?: { enabled?: boolean, auto?: boolean, harvestTimeSeconds?: number },
+    session_trace?: { enabled?: boolean, auto?: boolean, harvestTimeSeconds?: number },
+    spa?: { enabled?: boolean, auto?: boolean, harvestTimeSeconds?: number }
+}
+
+export interface NrLoaderConfig extends NrShared {
+    accountID?: string
+    trustKey?: string
+    agentID?: string
+    xpid?: string
+    licenseKey: string,
+    applicationID: string,
+}
+
+export type NrNoticeError = (err: Error | String, customAttributes: Object) => void;
+
+interface EventObject {
+    /** Event name */
+    name: string;
+    /** Start time in ms since epoch */
+    start: number;
+    /** End time in ms since epoch.  Defaults to same as start resulting in trace object with a duration of zero. */
+    end?: number | undefined;
+    /** Origin of event */
+    origin?: string | undefined;
+    /** Event type */
+    type?: string | undefined;
+}
+
+interface BrowserInteraction {
+    /**
+     * Sets the text value of the HTML element that was clicked to start a browser interaction.
+     *
+     * @param value The text value of the HTML element that represents the action that started the interaction.
+     * @returns This method returns the same API object created by interaction().
+     * @see https://docs.newrelic.com/docs/browser/new-relic-browser/browser-agent-spa-api/actiontext-browser-spa-api
+     */
+    actionText(value: string): this;
+
+    /**
+     * Times sub-components of a SPA interaction separately, including wait time and JS execution time.
+     *
+     * @param name This will be used as the name of the tracer. If you do not include a name,
+     *   New Relic Browser does not add a node to the interaction tree. The callback time will be
+     *   attributed to the parent node.
+     * @param callback A callback that contains the synchronous work to run at the end of the async work.
+     *   To execute this callback, call the wrapper function returned using createTracer()
+     * @returns This method ends the async time. It calls (and times) the callback that was passed into createTracer().
+     * @see https://docs.newrelic.com/docs/browser/new-relic-browser/browser-agent-spa-api/spa-create-tracer
+     */
+    createTracer(name: string, callback?: Callback): Wrapper;
+
+    /**
+     * Ends the New Relic SPA interaction at the current time.
+     *
+     * @returns This method returns the same API object created by interaction().
+     * @see https://docs.newrelic.com/docs/browser/new-relic-browser/browser-agent-spa-api/spa-end
+     */
+    end(): this;
+
+    /**
+     * Stores values across the current SPA interaction asynchronously in New Relic Browser.
+     *
+     * @param callback A function that accepts the interaction context object
+     *   as its only argument.
+     * @returns This method returns the same API object created by interaction().
+     * @see https://docs.newrelic.com/docs/browser/new-relic-browser/browser-agent-spa-api/spa-get-context
+     */
+    // tslint:disable-next-line:no-unnecessary-generics
+    getContext<T extends Record<string, any>>(callback: GetContextCallback<T>): this;
+
+    /**
+     * Overrides other SPA save() calls; ignores an interaction so it is not saved or sent to New Relic.
+     *
+     * @returns This method returns the same API object created by interaction().
+     * @see https://docs.newrelic.com/docs/browser/new-relic-browser/browser-agent-spa-api/spa-ignore-browser
+     */
+    ignore(): this;
+
+    /**
+     * Adds custom attributes for SPA interactions to the end of an event. It is called when the interaction
+     * has finished. You can invoke methods to modify the interaction, but methods that have asynchronous
+     * side effects will not have an effect.
+     *
+     * @returns This method returns the same API object created by interaction().
+     * @see https://docs.newrelic.com/docs/browser/new-relic-browser/browser-agent-spa-api/spa-on-end
+     */
+    // tslint:disable-next-line:no-unnecessary-generics
+    onEnd<T extends Record<string, any>>(callback: GetContextCallback<T>): this;
+
+    /**
+     * Ensures a SPA browser interaction will be saved when it ends.
+     *
+     * @returns This method returns the same API object created by interaction().
+     * @see https://docs.newrelic.com/docs/browser/new-relic-browser/browser-agent-spa-api/spa-save
+     */
+    save(): this;
+
+    /**
+     * Adds a custom SPA attribute only to the current interaction in New Relic Browser.
+     *
+     * @param key Used as the attribute name on the BrowserInteraction event.
+     * @param value Used as the attribute value on the BrowserInteraction event. This can be a
+     *   string, number, boolean, or object. If it is an object, New Relic serializes it to a JSON string.
+     * @returns This method returns the same API object created by interaction().
+     * @see https://docs.newrelic.com/docs/browser/new-relic-browser/browser-agent-spa-api/spa-set-attribute
+     */
+    setAttribute(key: string, value: ComplexType): this;
+
+    /**
+     * Sets the name and trigger of a SPA's browser interaction that is not a route change or URL change.
+     *
+     * @param name If null, the name will be set using the targetGroupedUrl attribute.
+     *   If not null, this will set the browserInteractionName attribute in the BrowserInteraction event.
+     * @param trigger If not null, this will set the TRIGGER attribute on the BrowserInteraction event.
+     * @returns This method returns the same API object created by interaction().
+     * @see https://docs.newrelic.com/docs/browser/new-relic-browser/browser-agent-spa-api/spa-set-name
+     */
+    setName(name: string, trigger?: string): this;
+}
+
+interface Callback {
+    (): void;
+}
+
+interface ErrorHandler {
+    (err: any): boolean;
+}
+
+interface GetContextCallback<T extends Record<string, any>> {
+    (contextObject: T): void;
+}
+
+interface Wrapper {
+    (): void;
+}
+
+type SimpleType = string | number;
+type ComplexType = string | number | boolean | unknown;