@apolitical/error-reporting 0.0.1 → 0.0.3-beta.3

package/CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.0.3] - 2022-01-31
+### Fixed
+- Node.js version
+### Removed
+- Buffer dependency
+
+## [0.0.2] - 2022-01-14
+### Updated
+- Dependencies
+
 ## [0.0.1] - 2021-06-14
 ### Added
 - Initial setup

package/README.md

@@ -6,7 +6,7 @@ Browser (and Node.js) library to report errors to GCP
 
 Requires the following to run:
 
-- [node.js][node] 12.20.1+
+- [node.js][node] 16.13.0+
 - [yarn][yarn]
 
 [node]: https://nodejs.org/en/download/
@@ -53,15 +53,5 @@ setContext({
 And then, you can report the error to GCP like this:
 
 ```js
-await reportError({
-  error: new Error('somthing went wrong'),
-  userId: 'some-user',
-});
+await reportError(new Error('Something went wrong'));
 ```
-
-## Troubleshooting
-
-### Usage of other libraries within your library
-
-- Add the library as a dependency in `package.json` (effectively requiring the calling project to provide this dependency)
-- Add the Stackdriver library as a dependency in `package.json`. By default, only the library code is published, meaning that the Stackdriver library needs to be installed separately.

package/build/index.js

@@ -1 +1 @@
-!function(e,r){"object"==typeof exports&&"object"==typeof module?module.exports=r(require("stackdriver-errors-js")):"function"==typeof define&&define.amd?define(["stackdriver-errors-js"],r):"object"==typeof exports?exports.ApoliticalErrorReporting=r(require("stackdriver-errors-js")):e.ApoliticalErrorReporting=r(e["stackdriver-errors-js"])}(this,(function(e){return function(){"use strict";var r={800:function(r){r.exports=e}},t={};function o(e){var n=t[e];if(void 0!==n)return n.exports;var i=t[e]={exports:{}};return r[e](i,i.exports,o),i.exports}o.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return o.d(r,{a:r}),r},o.d=function(e,r){for(var t in r)o.o(r,t)&&!o.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:r[t]})},o.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},o.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var n={};return function(){o.r(n),o.d(n,{reportError:function(){return p},setContext:function(){return u}});var e=o(800),r=o.n(e);const{APOLITICAL:{WEBSITES:t},GCP:{ENVIRONMENTS:i,PROJECT_ID:c}}={APOLITICAL:{WEBSITES:{BETA:"https://beta.apolitical.co",LIVE:"https://apolitical.co",RC:"https://rc.apolitical.co"}},GCP:{ENVIRONMENTS:{BETA:"beta",RC:"rc",LIVE:"live"},PROJECT_ID:"hazel-tea-194609"}},a=e=>{let r;switch(e){case t.BETA:r=i.BETA;break;case t.LIVE:r=i.LIVE;break;case t.RC:r=i.RC;break;default:r=i.BETA}return r};let s={key:null,environment:a(),projectId:c};const u=({accessToken:e,environment:r,origin:t,projectId:o,serviceName:n,isEncodedToken:i=!0})=>{var u;s.key=i?(u=e)&&Buffer.from(u,"base64").toString("ascii"):e,s.environment=r||a(t),s.projectId=o||c,n&&(s.service=`${n}:${s.environment}`)},p=async(e,t)=>{try{const o=new(r());o.start(s),t&&o.setUser(t),await o.report(e)}catch(e){console.warn(`Cannot report error: ${e.message}`)}}}(),n}()}));
+!function(e,r){"object"==typeof exports&&"object"==typeof module?module.exports=r(require("stackdriver-errors-js")):"function"==typeof define&&define.amd?define(["stackdriver-errors-js"],r):"object"==typeof exports?exports.ApoliticalErrorReporting=r(require("stackdriver-errors-js")):e.ApoliticalErrorReporting=r(e["stackdriver-errors-js"])}(this,(function(e){return function(){"use strict";var r={542:function(r){r.exports=e}},t={};function o(e){var n=t[e];if(void 0!==n)return n.exports;var i=t[e]={exports:{}};return r[e](i,i.exports,o),i.exports}o.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return o.d(r,{a:r}),r},o.d=function(e,r){for(var t in r)o.o(r,t)&&!o.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:r[t]})},o.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},o.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var n={};return function(){o.r(n),o.d(n,{reportError:function(){return u},setContext:function(){return s}});var e=o(542),r=o.n(e);const{APOLITICAL:{WEBSITES:t},GCP:{ENVIRONMENTS:i,PROJECT_ID:c}}={APOLITICAL:{WEBSITES:{BETA:"https://beta.apolitical.co",BETA_2:"https://beta-2.apolitical.co",LIVE:"https://apolitical.co",RC:"https://rc.apolitical.co"}},GCP:{ENVIRONMENTS:{BETA:"beta",BETA_2:"beta-2",RC:"rc",LIVE:"live"},PROJECT_ID:"hazel-tea-194609"}};let a={key:null,environment:null,projectId:c};const s=({apiKey:e,environment:r,origin:o=null,projectId:n,serviceName:s})=>{a.key=e,a.environment=r||(e=>{let r=null,o=null;switch(o="undefined"!=typeof window?window.origin||window.location.origin:e,o){case t.BETA:r=i.BETA;break;case t.BETA_2:r=i.BETA_2;break;case t.LIVE:r=i.LIVE;break;case t.RC:r=i.RC;break;default:r=i.BETA}return r})(o),a.projectId=n||c,s&&(a.service=`${s}:${a.environment}`)},u=async(e,t)=>{try{const o=new(r());o.start(a),t&&o.setUser(t),await o.report(e)}catch(e){console.warn(`Cannot report error: ${e.message}`)}}}(),n}()}));

package/package.json

@@ -1,71 +1,57 @@
 {
   "name": "@apolitical/error-reporting",
-  "version": "0.0.1",
-  "description": "Browser (and Node.js) library to report errors to GCP",
+  "version": "0.0.3-beta.3",
+  "description": "Browser library to report errors to GCP",
   "author": "Apolitical Group Limited <engineering@apolitical.co>",
-  "contributors": [
-    "Anouska Hopkins <anouska.hopkins@apolitical.co>",
-    "Antonio Cordasco <antonio.cordasco@apolitical.co>",
-    "Dorothy Yau <dorothy.yau@apolitical.co>",
-    "Laura Hanna-White <laura.hanna-white@apolitical.co>",
-    "Fatimat Gbajabiamila <fatimat.gbajabiamila@apolitical.co>",
-    "Renzo Rozza <renzo.rozza@apolitical.co>",
-    "Rihards Jukna <rihards.jukna@apolitical.co>"
-  ],
   "license": "MIT",
   "main": "build/index.js",
+  "files": [
+    "build/**"
+  ],
   "scripts": {
     "test": "jest --runInBand",
+    "unit-test": "jest test/unit/* --bail --runInBand --passWithNoTests",
+    "integration-test": "jest test/integration/* --bail --runInBand --passWithNoTests",
     "build": "webpack --config webpack.config.js",
     "lint": "eslint --ext .js ./lib",
-    "format": "prettier --write 'lib/**/*.+(js|json)'"
+    "format": "prettier --write 'lib/**/*.+(js|json)'",
+    "lint-format": "lint-staged",
+    "prepare": "husky install"
   },
   "keywords": [
     "JavaScript",
-    "Library",
+    "Browser",
     "Error Reporting"
   ],
   "dependencies": {
-    "stackdriver-errors-js": "0.8.0"
+    "stackdriver-errors-js": "0.12.0"
   },
   "peerDependencies": {
-    "stackdriver-errors-js": "0.8.0"
+    "stackdriver-errors-js": "0.12.0"
   },
   "devDependencies": {
-    "@babel/core": "7.14.5",
-    "babel-eslint": "10.1.0",
-    "babel-loader": "8.2.2",
-    "babel-preset-react-app": "10.0.0",
-    "eslint": "7.22.0",
-    "eslint-config-prettier": "8.1.0",
-    "eslint-plugin-jest": "24.3.2",
-    "eslint-plugin-prettier": "3.3.1",
-    "husky": "4.3.8",
-    "jest": "27.0.4",
-    "lint-staged": "11.0.0",
-    "prettier": "2.3.1",
-    "webpack": "5.38.1",
-    "webpack-cli": "4.7.2"
+    "@apolitical/eslint-config": "1.0.2-beta.1",
+    "@babel/core": "7.16.12",
+    "@babel/eslint-parser": "7.16.5",
+    "@babel/plugin-transform-runtime": "7.16.10",
+    "@babel/preset-env": "7.16.11",
+    "husky": "7.0.4",
+    "jest": "27.4.7",
+    "jest-junit": "13.0.0",
+    "lint-staged": "12.3.2",
+    "webpack": "5.67.0",
+    "webpack-cli": "4.9.2"
   },
   "eslintConfig": {
     "extends": [
-      "eslint:recommended",
-      "plugin:prettier/recommended",
-      "plugin:jest/recommended"
+      "@apolitical/eslint-config/base.config"
     ],
     "env": {
-      "node": true,
-      "es6": true,
-      "jest": true
+      "browser": true
     },
-    "plugins": [
-      "jest"
-    ],
-    "parser": "babel-eslint"
-  },
-  "prettier": {
-    "singleQuote": true
+    "parser": "@babel/eslint-parser"
   },
+  "prettier": "@apolitical/eslint-config/prettier.config",
   "browserslist": {
     "production": [
       ">0.2%",
@@ -83,23 +69,33 @@
     ],
     "coveragePathIgnorePatterns": [
       "<rootDir>/node_modules/"
-    ]
+    ],
+    "setupFiles": [
+      "./test/setupTests.js"
+    ],
+    "reporters": [
+      "default",
+      "jest-junit"
+    ],
+    "testResultsProcessor": "jest-junit"
   },
   "babel": {
     "presets": [
-      "react-app"
-    ]
+      "@babel/preset-env"
+    ],
+    "env": {
+      "test": {
+        "plugins": [
+          "@babel/plugin-transform-runtime"
+        ]
+      }
+    }
   },
   "engines": {
-    "node": ">=12.20.1"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged && yarn build && yarn test"
-    }
+    "node": ">=16.13.0"
   },
   "lint-staged": {
-    "*.js": "eslint --cache --fix",
-    "*.+(js|json)": "prettier --write"
+    "*.js": "eslint --cache --fix --ignore-path .gitignore",
+    "*.+(js|json)": "prettier --write --ignore-path .gitignore"
   }
 }

package/.gitlab-ci.yml

@@ -1,81 +0,0 @@
-default:
-  image: node:12.20.1-alpine3.11
-
-# Pipeline stages
-stages:
-  - cache
-  - test
-  - build
-  - publish
-
-# Cache jobs
-
-fill-cache:
-  stage: cache
-  only:
-    changes:
-      - yarn.lock
-  cache:
-    key: $CI_COMMIT_REF_SLUG-$CI_PROJECT_DIR
-    paths:
-      - node_modules/
-      - .yarn
-  script:
-    - yarn install --cache-folder .yarn --production=false
-
-# Test jobs
-
-.use-cache:
-  cache:
-    key: $CI_COMMIT_REF_SLUG-$CI_PROJECT_DIR
-    paths:
-      - node_modules/
-      - .yarn
-    policy: pull
-
-.lib-image:
-  extends: .use-cache
-  cache:
-    key: $CI_COMMIT_REF_SLUG-$CI_PROJECT_DIR
-    paths:
-      - node_modules/
-  before_script:
-    - yarn install --cache-folder .yarn --production=false
-
-outdated:
-  extends: .lib-image
-  stage: test
-  allow_failure: true
-  script:
-    - yarn outdated
-
-test:
-  extends: .lib-image
-  stage: test
-  allow_failure: false
-  script:
-    - yarn test
-
-# Build jobs
-
-build:
-  extends: .lib-image
-  stage: build
-  allow_failure: false
-  script:
-    - yarn build
-
-# Publish jobs
-
-publish-module:
-  extends: .lib-image
-  stage: publish
-  allow_failure: false
-  only:
-    - tags
-    - /^v\d+\.\d+\.\d+$/  
-  before_script:
-    - yarn build
-  script:
-    - echo '//registry.npmjs.org/:_authToken=${NPM_TOKEN}' > ~/.npmrc
-    - yarn publish --access=public

package/default.env

@@ -1 +0,0 @@
-CONTENTFUL_CDA_TOKEN=cda-token-base64-encoded

package/lib/config.js

@@ -1,19 +0,0 @@
-const config = {
-  APOLITICAL: {
-    WEBSITES: {
-      BETA: 'https://beta.apolitical.co',
-      LIVE: 'https://apolitical.co',
-      RC: 'https://rc.apolitical.co',
-    },
-  },
-  GCP: {
-    ENVIRONMENTS: {
-      BETA: 'beta',
-      RC: 'rc',
-      LIVE: 'live',
-    },
-    PROJECT_ID: 'hazel-tea-194609',
-  },
-};
-
-export default config;

package/lib/helpers/context.js

@@ -1,51 +0,0 @@
-import config from '../config';
-
-const {
-  APOLITICAL: { WEBSITES },
-  GCP: { ENVIRONMENTS, PROJECT_ID },
-} = config;
-
-const decodeBase64 = (value) =>
-  value && Buffer.from(value, 'base64').toString('ascii');
-
-const getEnvironment = (origin) => {
-  let environment;
-  switch (origin) {
-    case WEBSITES.BETA:
-      environment = ENVIRONMENTS.BETA;
-      break;
-    case WEBSITES.LIVE:
-      environment = ENVIRONMENTS.LIVE;
-      break;
-    case WEBSITES.RC:
-      environment = ENVIRONMENTS.RC;
-      break;
-    default:
-      environment = ENVIRONMENTS.BETA;
-  }
-  return environment;
-};
-
-let context = {
-  key: null,
-  environment: getEnvironment(),
-  projectId: PROJECT_ID,
-};
-
-export const setContext = ({
-  accessToken,
-  environment,
-  origin,
-  projectId,
-  serviceName,
-  isEncodedToken = true,
-}) => {
-  context.key = isEncodedToken ? decodeBase64(accessToken) : accessToken;
-  context.environment = environment || getEnvironment(origin);
-  context.projectId = projectId || PROJECT_ID;
-  if (serviceName) {
-    context.service = `${serviceName}:${context.environment}`;
-  }
-};
-
-export const getContext = () => context;

package/lib/helpers/index.js

@@ -1 +0,0 @@
-export { getContext, setContext } from './context';

package/lib/index.js

@@ -1,21 +0,0 @@
-import StackdriverErrorReporter from 'stackdriver-errors-js';
-
-import { getContext } from './helpers';
-
-export const reportError = async (error, userId) => {
-  try {
-    // Create error handler
-    const errorHandler = new StackdriverErrorReporter();
-    errorHandler.start(getContext());
-    if (userId) {
-      errorHandler.setUser(userId);
-    }
-    // Report error to GCP
-    await errorHandler.report(error);
-  } catch (err) {
-    // Something went wrong
-    console.warn(`Cannot report error: ${err.message}`);
-  }
-};
-
-export { setContext } from './helpers';

package/test/unit/__snapshots__/lib.spec.js.snap

@@ -1,10 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`Apolitical Error Reporting Report Error should use context 1`] = `
-Object {
-  "environment": "live",
-  "key": "some-key",
-  "projectId": "hazel-tea-194609",
-  "service": "some-service:live",
-}
-`;

package/test/unit/lib.spec.js

@@ -1,70 +0,0 @@
-const mockStart = jest.fn();
-const mockSetUser = jest.fn();
-const mockReport = jest.fn();
-
-jest.mock('stackdriver-errors-js', () => {
-  class StackdriverErrorReporter {
-    constructor() {
-      this.start = mockStart;
-      this.setUser = mockSetUser;
-      this.report = mockReport;
-    }
-  }
-  return StackdriverErrorReporter;
-});
-
-jest.mock('stackdriver-errors-js');
-
-import { setContext, reportError } from '../../lib';
-
-describe('Apolitical Error Reporting', () => {
-  beforeAll(() => {
-    setContext({
-      accessToken: 'c29tZS1rZXk=',
-      serviceName: 'some-service',
-      origin: 'https://apolitical.co',
-    });
-  });
-
-  describe('Report Error', () => {
-    test('should report error', async () => {
-      await reportError(new Error('Something went wrong'));
-      expect(mockReport).toHaveBeenCalledTimes(1);
-    });
-
-    test('should use context', async () => {
-      await reportError(new Error('Something went wrong'));
-      expect(mockStart).toHaveBeenCalledTimes(1);
-      expect(mockStart.mock.calls[0][0]).toMatchSnapshot();
-    });
-
-    test('should set user', async () => {
-      await reportError(new Error('Something went wrong'), 'some-user');
-      expect(mockSetUser).toHaveBeenCalledTimes(1);
-      expect(mockSetUser.mock.calls[0][0]).toEqual('some-user');
-    });
-
-    describe('Error handling', () => {
-      const { warn } = console;
-      const mockWarn = jest.fn();
-
-      beforeAll(() => {
-        delete console.warn;
-        console.warn = mockWarn;
-      });
-
-      afterAll(() => {
-        console.warn = warn;
-      });
-
-      test('should catch error', async () => {
-        mockReport.mockRejectedValueOnce(new Error('Some other error'));
-        await reportError(new Error('Something went wrong'), 'some-user');
-        expect(mockWarn).toHaveBeenCalledTimes(1);
-        expect(mockWarn.mock.calls[0][0]).toEqual(
-          'Cannot report error: Some other error'
-        );
-      });
-    });
-  });
-});

package/webpack.config.js

@@ -1,28 +0,0 @@
-'use strict';
-
-const path = require('path');
-
-module.exports = {
-  mode: 'production',
-  entry: {
-    index: path.resolve(__dirname, 'lib', 'index.js'),
-  },
-  output: {
-    path: path.resolve(__dirname, 'build'),
-    filename: 'index.js',
-    library: {
-      name: 'ApoliticalErrorReporting',
-      type: 'umd',
-    },
-    globalObject: 'this',
-  },
-  externals: {
-    ['stackdriver-errors-js']: 'stackdriver-errors-js',
-  },
-  optimization: {
-    splitChunks: {
-      chunks: 'all',
-    },
-    minimize: true,
-  },
-};