@apolitical/sdk 0.0.1-beta.3

package/.gitlab-ci.yml

@@ -0,0 +1,25 @@
+# External jobs
+include:
+  - project: 'apolitical/templates/gitlab-pipelines'
+    ref: master
+    file: 'Node-Testing.gitlab-ci.yml'
+
+stages:
+  - cache
+  - test
+  - publish
+
+# Publish jobs
+
+publish-module:
+  stage: publish
+  image: node:12.20.1-alpine3.11
+  extends: .yarn-install
+  only:
+    - tags
+    - /^v\d+\.\d+\.\d+$/
+  before_script:
+    - yarn build
+  script:
+    - echo '//registry.npmjs.org/:_authToken=${NPM_TOKEN}' > ~/.npmrc
+    - yarn publish --access=public

package/.husky/pre-commit

@@ -0,0 +1,8 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn lint-format 
+
+yarn build
+
+yarn test

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+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.1] - 2021-01-18
+### Added
+- Initial setup

package/README.md

@@ -0,0 +1,48 @@
+# Apolitical SDK
+
+Browser library to interact with Apolitical's APIs
+
+## Requirements
+
+Requires the following to run:
+
+- [node.js][node] 12.20.1+
+- [yarn][yarn]
+
+[node]: https://nodejs.org/en/download/
+[yarn]: https://classic.yarnpkg.com/en/docs/install
+
+## Installation
+
+Install with `yarn`:
+
+```sh
+yarn add @apolitical/sdk
+```
+
+## Available Scripts
+
+In the project directory, you can run:
+### `yarn run test`
+
+Runs the test (and the interactive mode can be enabled with `--watchAll`).
+
+### `yarn build`
+
+Builds the library for production to the `build` folder.
+It correctly bundles the code on production mode and optimizes the build for the best performance.
+
+### `yarn publish`
+
+Publishes the library to NPM.
+
+## Usage
+
+The recommended way to use `@apolitical/sdk` is to use the provided functionality:
+
+```js
+const { ping } = require('@apolitical/sdk');
+
+const result = ping();
+console.log(result);
+```

package/build/index.js

@@ -0,0 +1 @@
+!function(e,r){"object"==typeof exports&&"object"==typeof module?module.exports=r(require("axios"),require("@apolitical/error-reporting")):"function"==typeof define&&define.amd?define(["axios","@apolitical/error-reporting"],r):"object"==typeof exports?exports.ApoliticalSDK=r(require("axios"),require("@apolitical/error-reporting")):e.ApoliticalSDK=r(e.axios,e["@apolitical/error-reporting"])}(this,(function(e,r){return function(){"use strict";var t={30:function(e){e.exports=r},300:function(r){r.exports=e}},o={};function n(e){var r=o[e];if(void 0!==r)return r.exports;var i=o[e]={exports:{}};return t[e](i,i.exports,n),i.exports}n.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return n.d(r,{a:r}),r},n.d=function(e,r){for(var t in r)n.o(r,t)&&!n.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:r[t]})},n.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},n.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var i={};return function(){n.r(i),n.d(i,{default:function(){return c}});var e=n(300),r=n.n(e),t=n(30);const{APIS:{BACKEND_TEMPLATE:{BASE_URL:o,ENDPOINTS:{DUMMY:a}}}}={APIS:{BACKEND_TEMPLATE:{BASE_URL:"/api/backend-template",ENDPOINTS:{DUMMY:"/dummy"}}}};var c={setContext:({origin:e,gcpErrorsApiKey:r,serviceName:o})=>{(0,t.setContext)({origin:e,accessToken:r,serviceName:o})},template:{ping:async()=>{let e=null;try{({data:e}=await r().get(`${o}${a}`))}catch(e){(async e=>{let r="Error at Apolitical SDK: ";e.response?r+=JSON.stringify(e.response):e.request?r+=JSON.stringify(e.request):r+=e.message,console.warn(r);try{await(0,t.reportError)(new Error(r))}catch(e){console.warn(`Cannot report error: ${e.message}`)}})(e)}return e}}}}(),i}()}));

package/lib/apis/template.js

@@ -0,0 +1,27 @@
+import axios from 'axios';
+
+import config from '../config';
+import { handleError } from '../errors';
+
+const {
+  APIS: {
+    BACKEND_TEMPLATE: {
+      BASE_URL,
+      ENDPOINTS: { DUMMY },
+    },
+  },
+} = config;
+
+/*
+ * Returns a random number after calling the Backend Template
+ * @return {Object} data - JSON object returned by the API
+ */
+export const ping = async () => {
+  let data = null;
+  try {
+    ({ data } = await axios.get(`${BASE_URL}${DUMMY}`));
+  } catch (error) {
+    handleError(error);
+  }
+  return data;
+};

package/lib/config.js

@@ -0,0 +1,12 @@
+const config = {
+  APIS: {
+    BACKEND_TEMPLATE: {
+      BASE_URL: '/api/backend-template',
+      ENDPOINTS: {
+        DUMMY: '/dummy',
+      },
+    },
+  },
+};
+
+export default config;

package/lib/context.js

@@ -0,0 +1,10 @@
+import { setContext as setErrorContext } from '@apolitical/error-reporting';
+
+export const setContext = ({ origin, gcpErrorsApiKey, serviceName }) => {
+  // Setup error reporting context
+  setErrorContext({
+    origin,
+    accessToken: gcpErrorsApiKey,
+    serviceName,
+  });
+};

package/lib/errors.js

@@ -0,0 +1,23 @@
+import { reportError } from '@apolitical/error-reporting';
+
+export const handleError = async (error) => {
+  let errorMessage = 'Error at Apolitical SDK: ';
+  if (error.response) {
+    // The request was made and the server responded with a status code that falls out of the range of 2xx
+    errorMessage += JSON.stringify(error.response);
+  } else if (error.request) {
+    // The request was made but no response was received
+    errorMessage += JSON.stringify(error.request);
+  } else {
+    // Something happened in setting up the request that triggered an error
+    errorMessage += error.message;
+  }
+  // Log the error (on the client browser)
+  console.warn(errorMessage);
+  // Report the error (to GCP) but prevent exceptions
+  try {
+    await reportError(new Error(errorMessage));
+  } catch (error2) {
+    console.warn(`Cannot report error: ${error2.message}`);
+  }
+};

package/lib/index.js

@@ -0,0 +1,11 @@
+import { ping } from './apis/template';
+import { setContext } from './context';
+
+const sdk = {
+  setContext,
+  template: {
+    ping,
+  },
+};
+
+export default sdk;

package/package.json

@@ -0,0 +1,101 @@
+{
+  "name": "@apolitical/sdk",
+  "version": "0.0.1-beta.3",
+  "description": "Browser library to interact with Apolitical's APIs",
+  "author": "Apolitical Group Limited <engineering@apolitical.co>",
+  "license": "MIT",
+  "main": "build/index.js",
+  "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)'",
+    "lint-format": "lint-staged",
+    "prepare": "husky install"
+  },
+  "keywords": [
+    "JavaScript",
+    "Browser",
+    "SDK"
+  ],
+  "dependencies": {
+    "@apolitical/error-reporting": "0.0.1",
+    "axios": "0.24.0"
+  },
+  "peerDependencies": {
+    "@apolitical/error-reporting": "0.0.1",
+    "axios": "0.24.0"
+  },
+  "devDependencies": {
+    "@apolitical/eslint-config": "0.0.1",
+    "@babel/core": "7.16.7",
+    "babel-eslint": "10.1.0",
+    "babel-loader": "8.2.3",
+    "babel-preset-react-app": "10.0.1",
+    "husky": "7.0.4",
+    "jest": "27.4.7",
+    "jest-junit": "13.0.0",
+    "lint-staged": "12.1.5",
+    "webpack": "5.65.0",
+    "webpack-cli": "4.9.1"
+  },
+  "eslintConfig": {
+    "extends": [
+      "eslint:recommended",
+      "plugin:prettier/recommended",
+      "plugin:jest/recommended"
+    ],
+    "env": {
+      "browser": true,
+      "node": true,
+      "es6": true,
+      "jest": true
+    },
+    "plugins": [
+      "jest"
+    ],
+    "parser": "babel-eslint"
+  },
+  "prettier": "@apolitical/eslint-config/prettier.config",
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all",
+      "ie 11"
+    ]
+  },
+  "jest": {
+    "bail": true,
+    "clearMocks": true,
+    "collectCoverage": true,
+    "collectCoverageFrom": [
+      "<rootDir>/lib/**/*.js"
+    ],
+    "coveragePathIgnorePatterns": [
+      "<rootDir>/node_modules/"
+    ],
+    "setupFiles": [
+      "./test/setupTests.js"
+    ],
+    "reporters": [
+      "default",
+      "jest-junit"
+    ],
+    "testResultsProcessor": "jest-junit"
+  },
+  "babel": {
+    "presets": [
+      "react-app"
+    ]
+  },
+  "engines": {
+    "node": ">=12.20.1"
+  },
+  "lint-staged": {
+    "*.js": "eslint --cache --fix --ignore-path .gitignore",
+    "*.+(js|json)": "prettier --write --ignore-path .gitignore"
+  }
+}

package/test/__snapshots__/context.spec.js.snap

@@ -0,0 +1,11 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Apolitical SDK Context Set Context should set error reporting context 1`] = `
+Array [
+  Object {
+    "accessToken": "some-gcp-errors-api-key",
+    "origin": "some-origin",
+    "serviceName": "some-service-name",
+  },
+]
+`;

package/test/context.spec.js

@@ -0,0 +1,27 @@
+import { setContext as setErrorContext } from '@apolitical/error-reporting';
+
+import sdk from '../lib';
+
+describe('Apolitical SDK', () => {
+  describe('Context', () => {
+    const { setContext } = sdk;
+
+    describe('Set Context', () => {
+      const options = {
+        origin: 'some-origin',
+        gcpErrorsApiKey: 'some-gcp-errors-api-key',
+        serviceName: 'some-service-name',
+      };
+
+      beforeEach(() => {
+        setErrorContext.mockReturnValue();
+      });
+
+      test('should set error reporting context', () => {
+        setContext(options);
+        expect(setErrorContext).toHaveBeenCalledTimes(1);
+        expect(setErrorContext.mock.calls[0]).toMatchSnapshot();
+      });
+    });
+  });
+});

package/test/errors.spec.js

@@ -0,0 +1,39 @@
+import { reportError } from '@apolitical/error-reporting';
+
+import { handleError } from '../lib/errors';
+
+describe('Apolitical SDK', () => {
+  describe('Errors', () => {
+    describe('Handle Error', () => {
+      beforeEach(() => {
+        reportError.mockResolvedValue();
+      });
+
+      test('should log response error', async () => {
+        await handleError({ response: { data: 'some response' } });
+        expect(console.warn.mock.calls[0][0]).toEqual('Error at Apolitical SDK: {"data":"some response"}');
+      });
+
+      test('should log request error', async () => {
+        await handleError({ request: { data: 'some request' } });
+        expect(console.warn.mock.calls[0][0]).toEqual('Error at Apolitical SDK: {"data":"some request"}');
+      });
+
+      test('should log message error', async () => {
+        await handleError({ message: 'some message' });
+        expect(console.warn.mock.calls[0][0]).toEqual('Error at Apolitical SDK: some message');
+      });
+
+      test('should report error', async () => {
+        await handleError({ message: 'some message' });
+        expect(reportError).toHaveBeenCalledTimes(1);
+      });
+
+      test('should catch errors when reporting', async () => {
+        reportError.mockRejectedValueOnce(new Error('something went wrong'));
+        await handleError({ message: 'some message' });
+        expect(console.warn.mock.calls[1][0]).toEqual('Cannot report error: something went wrong');
+      });
+    });
+  });
+});

package/test/setupTests.js

@@ -0,0 +1,13 @@
+// Mock dependencies
+jest.mock('axios');
+jest.mock('@apolitical/error-reporting', () => {
+  return {
+    reportError: jest.fn(),
+    setContext: jest.fn(),
+  };
+});
+
+// Overrides console error & warn when testing
+// NB: Comment out this line to check errors when testing
+console.error = jest.fn();
+console.warn = jest.fn();

package/test/template.spec.js

@@ -0,0 +1,33 @@
+import axios from 'axios';
+import { reportError } from '@apolitical/error-reporting';
+
+import sdk from '../lib';
+
+describe('Apolitical SDK', () => {
+  describe('Backend Template', () => {
+    const {
+      template: { ping },
+    } = sdk;
+
+    describe('Ping (Dummy Endpoint)', () => {
+      const payload = { data: { result: 123 } };
+
+      beforeEach(() => {
+        reportError.mockResolvedValue();
+        axios.get.mockResolvedValue(payload);
+      });
+
+      test('should return a number', async () => {
+        const { result } = await ping();
+        expect(result).toEqual(expect.any(Number));
+      });
+
+      test('should catch unexpected errors', async () => {
+        axios.get.mockRejectedValueOnce(new Error('something went wrong'));
+        const result = await ping();
+        expect(result).toStrictEqual(null);
+        expect(reportError).toHaveBeenCalledTimes(1);
+      });
+    });
+  });
+});

package/webpack.config.js

@@ -0,0 +1,29 @@
+'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: 'ApoliticalSDK',
+      type: 'umd',
+    },
+    globalObject: 'this',
+  },
+  externals: {
+    axios: 'axios',
+    '@apolitical/error-reporting': '@apolitical/error-reporting',
+  },
+  optimization: {
+    splitChunks: {
+      chunks: 'all',
+    },
+    minimize: true,
+  },
+};