@digitraffic/common 2022.10.31-3 → 2022.11.1-1

package/.eslintrc.json

@@ -1,27 +0,0 @@
-{
-  "env": {
-    "browser": false,
-    "commonjs": true,
-    "es2021": true
-  },
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "project": ["./tsconfig.eslint.json"]
-  },
-  "plugins": ["@typescript-eslint"],
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/eslint-recommended",
-    "plugin:@typescript-eslint/recommended",
-    //    "plugin:@typescript-eslint/recommended-requiring-type-checking",
-    //    "plugin:@typescript-eslint/strict",
-    "prettier"
-  ],
-  "rules": {
-    "@typescript-eslint/no-extraneous-class": "off",
-    "@typescript-eslint/no-non-null-assertion": "error",
-    "@typescript-eslint/non-nullable-type-assertion-style": "error",
-    "@typescript-eslint/no-throw-literal": "error",
-    "@typescript-eslint/no-explicit-any": "error"
-  }
-}

package/.github/CODEOWNERS

@@ -1,2 +0,0 @@
-# These owners will be the default owners for everything in the repo.
-* @teijosol @jouniso @teemu-solita @jkhaak-solita @solita-ijunnone @mattihe

package/.github/workflows/build.yml

@@ -1,36 +0,0 @@
-name: Build
-on: [push]
-jobs:
-  build:
-    if: github.event.repo.name != 'tmfg/digitraffic-common'
-    runs-on: ubuntu-20.04
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Setup Node.js
-        uses: actions/setup-node@v2
-        with:
-          node-version: '14'
-      - name: Compile
-        run: |
-          yarn
-          yarn build
-      - name: Run tests
-        run: |
-          yarn test >> $GITHUB_STEP_SUMMARY
-      - name: Test Report
-        uses: dorny/test-reporter@v1
-        if: success() || failure()
-        with:
-          name: Jest test report
-          reporter: jest-junit
-          path: junit.xml
-      - name: Notify Slack
-        if: failure()
-        uses: 8398a7/action-slack@v3
-        with:
-          status: failure
-          text: FAILED digitraffic-common build
-          fields: repo, job, took
-        env:
-          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}

package/.github/workflows/eslint.yml

@@ -1,38 +0,0 @@
-name: ESLint
-
-on: [push]
-
-jobs:
-  lint:
-    runs-on: ubuntu-22.04
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: "14"
-
-      - name: Install packages
-        run: yarn install --frozen-lock
-
-      - name: Create ESLint reports for affected projects
-        id: report
-        run: yarn eslint-report -- -o ${{ github.ref_name }}/report.html
-        continue-on-error: true
-
-      - name: Publish report
-        id: publish-reports
-        uses: tmfg/digitraffic-actions@gh-pages-publish/v1
-        with:
-          GH_PAGES_BRANCH: gh-pages
-          FILE_PATH: ${{ github.ref_name }}/report.html
-          COMMIT_MESSAGE: ESLint report in branch $CURRENT_BRANCH
-          LINK_TEXT: ESLint report
-
-      - name: Fail on ESLint errors
-        run: |
-          if [[ "${{ steps.report.outcome }}" == "failure" || "${{ steps.report-affected.outcome }}" == "failure" ]]; then exit 1; else exit 0; fi

package/.github/workflows/mirror.yml

@@ -1,15 +0,0 @@
-name: 'Mirror repo to public'
-on:
-  push:
-    branches:
-      - master
-jobs:
-  Mirror-action:
-    if: github.repository != 'tmfg/digitraffic-common'
-    runs-on: ubuntu-latest
-    steps:
-      - name: Mirror
-        uses: tmfg/digitraffic-actions@mirror/v1
-        with:
-          mirror-repo: git@github.com:tmfg/digitraffic-common.git
-          ssh-private-key: ${{ secrets.SSH_MIRROR_KEY }}

package/.gitignore

@@ -1,29 +0,0 @@
-*
-
-!.husky/
-!.husky/pre-commit
-!/.editorconfig
-!/.eslintignore
-!/.eslintrc.json
-!/.gitignore
-!/.prettierrc.json
-!/jest.config.js
-!/LICENSE
-!/package.json
-!/README.md
-!/tsconfig.json
-!/tsconfig.eslint.json
-!/yarn.lock
-
-!src/
-!src/**/
-!src/**/*.ts
-
-!test/
-!test/**/
-!test/**/*.ts
-
-!.github/
-!.github/**/
-!.github/workflows/**/**.yml
-!.github/CODEOWNERS

package/.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-yarn lint-staged

package/.prettierrc.json

@@ -1,10 +0,0 @@
-{
-  "overrides": [
-    {
-      "files": ["*.json", "*.yml", "*.yaml"],
-      "options": {
-        "tabWidth": 2
-      }
-    }
-  ]
-}

package/jest.config.js

@@ -1,15 +0,0 @@
-module.exports = {
-    roots: [
-        '<rootDir>/test',
-    ],
-    testMatch: [
-        '**/*.test.ts',
-    ],
-    testResultsProcessor: 'jest-junit',
-    preset: 'ts-jest',
-    coverageThreshold: {
-        global: {
-            lines: 70,
-        },
-    },
-}

package/test/marine/id_utils.test.ts

@@ -1,57 +0,0 @@
-import * as IdUtils from '../../src/marine/id_utils';
-import {getRandomNumber} from "../../src/test/testutils";
-
-describe('IdUtils tests', () => {
-
-    test('isValidLOCODE - success', () => {
-        expect(IdUtils.isValidLOCODE('FILOL')).toBe(true);
-    });
-
-    test('isValidLOCODE - fail with non-finnish prefix', () => {
-        expect(IdUtils.isValidLOCODE('SEABS')).toBe(false);
-    });
-
-    test('isValidLOCODE - fail with numbers', () => {
-        expect(IdUtils.isValidLOCODE('FIAA1')).toBe(false);
-    });
-
-    test('isValidIMO - successful checksum - ship TRANSMAR', () => {
-        expect(IdUtils.isValidIMO(9167332)).toBe(true);
-    });
-
-    test('isValidIMO - successful checksum - ship ANNIKA B', () => {
-        expect(IdUtils.isValidIMO(9213715)).toBe(true);
-    });
-
-    test('isValidIMO - successful checksum - ship X PRESS ELBE', () => {
-        expect(IdUtils.isValidIMO(9483669)).toBe(true);
-    });
-
-    test('isValidIMO - successful checksum - ship SILVERFORS', () => {
-        expect(IdUtils.isValidIMO(8322765)).toBe(true);
-    });
-
-    test('isValidIMO - invalid checksum', () => {
-        expect(IdUtils.isValidIMO(8322766)).toBe(false);
-    });
-
-    test('isValidIMO - fail with number smaller than 1000000', () => {
-        expect(IdUtils.isValidIMO(getRandomNumber(0, 1000000 - 1))).toBe(false);
-    });
-
-    test('isValidIMO - fail with number larger than 9999999', () => {
-        expect(IdUtils.isValidIMO(getRandomNumber(9999999 + 1, 99999999))).toBe(false);
-    });
-
-    test('isValidMMSI - success', () => {
-        expect(IdUtils.isValidMMSI(230927000)).toBe(true);
-    });
-
-    test('isValidMMSI - fail with number smaller than 100000000', () => {
-        expect(IdUtils.isValidMMSI(getRandomNumber(0, 100000000 - 1))).toBe(false);
-    });
-
-    test('isValidMMSI - fail with number larger than 999999999', () => {
-        expect(IdUtils.isValidMMSI(getRandomNumber(999999999 + 1, 9999999999))).toBe(false);
-    });
-});

package/test/promise/promise.test.ts

@@ -1,143 +0,0 @@
-import {getRandomInteger} from "../../src/test/testutils";
-import {retry, RetryLogError} from "../../src/utils/retry";
-
-describe('Promise utils tests', () => {
-
-    test('retry - no retries', async () => {
-        const fn = jest.fn().mockResolvedValue(1);
-
-        const ret = await retry(fn, 0, RetryLogError.NO_LOGGING);
-
-        expect(ret).toBe(1);
-        expect(fn.mock.calls.length).toBe(1);
-    });
-
-    test('retry - error with n+1 retries', async () => {
-        const fn = jest.fn().mockRejectedValue('error');
-        const retries = getRandomInteger(1, 10);
-
-        try {
-            await retry(fn, retries, RetryLogError.NO_LOGGING);
-        } catch {
-            // ignore
-        } finally {
-            expect(fn.mock.calls.length).toBe(retries + 1);
-        }
-    });
-
-    test('retry - no error with n+1 retries', async () => {
-        const fn = jest.fn().mockResolvedValue(1);
-        const retries = getRandomInteger(1, 10);
-
-        const ret = await retry(fn, retries, RetryLogError.NO_LOGGING);
-
-        expect(ret).toBe(1);
-        expect(fn.mock.calls.length).toBe(1);
-    });
-
-    test('retry - errors with no error logging', async () => {
-        const fn = jest.fn().mockRejectedValue('error');
-        const consoleErrorSpy = jest.spyOn(global.console, 'error').mockImplementation();
-
-        try {
-            await retry(fn, getRandomInteger(0, 10), RetryLogError.NO_LOGGING);
-        } catch {
-            // ignore
-        } finally {
-            expect(consoleErrorSpy).toHaveBeenCalledTimes(0);
-            consoleErrorSpy.mockRestore();
-        }
-    });
-
-    test('retry - no retries with error logging', async () => {
-        const fn = jest.fn().mockRejectedValue('error');
-        const consoleErrorSpy = jest.spyOn(global.console, 'error').mockImplementation();
-
-        try {
-            await retry(fn, 0, RetryLogError.LOG_ALL_AS_ERRORS);
-        } catch {
-            // ignore
-        } finally {
-            expect(consoleErrorSpy).toHaveBeenCalledTimes(1);
-            consoleErrorSpy.mockRestore();
-        }
-    });
-
-    test('retry - retries with error logging', async () => {
-        const fn = jest.fn().mockRejectedValue('error');
-        const retries = getRandomInteger(1, 10);
-        const consoleErrorSpy = jest.spyOn(global.console, 'error').mockImplementation();
-
-        try {
-            await retry(fn, retries, RetryLogError.LOG_ALL_AS_ERRORS);
-        } catch {
-            // ignore
-        } finally {
-            expect(consoleErrorSpy).toHaveBeenCalledTimes(retries + 1);
-            consoleErrorSpy.mockRestore();
-        }
-    });
-
-    test('retry - exceeded retry count throws error', async () => {
-        const fn = jest.fn().mockRejectedValue('error');
-
-        await expect(() => retry(fn, 3, RetryLogError.LOG_ALL_AS_ERRORS)).rejects.toThrow();
-    });
-
-    test('retry - defaults', async () => {
-        const fn = jest.fn().mockRejectedValue('error');
-        const consoleErrorSpy = jest.spyOn(global.console, 'error').mockImplementation();
-
-        try {
-            await retry(fn);
-        } catch {
-            // ignore
-        } finally {
-            expect(fn.mock.calls.length).toBe(3 + 1);
-            expect(consoleErrorSpy).toHaveBeenCalledTimes(1); // last retry
-        }
-    });
-
-    test('retry - NaN throws error', async () => {
-        const fn = jest.fn();
-
-        await expect(() => retry(fn, NaN, RetryLogError.NO_LOGGING)).rejects.toThrow();
-    });
-
-    test('retry - Infinity throws error', async () => {
-        const fn = jest.fn();
-
-        await expect(() => retry(fn, Infinity, RetryLogError.NO_LOGGING)).rejects.toThrow();
-    });
-
-    test('retry - exceeded maximum retry count throws error', async () => {
-        const fn = jest.fn();
-
-        await expect(() => retry(fn, getRandomInteger(101, 1000000), RetryLogError.NO_LOGGING)).rejects.toThrow();
-    });
-
-    test('retry - use without mocks without retry', async () => {
-        const val = 1;
-        const fn = () => Promise.resolve(val);
-
-        const ret = await retry(fn);
-
-        expect(ret).toBe(val);
-    });
-
-    test('retry - use without mocks with retry', async () => {
-        let i = 0;
-        const val = 1;
-        const fn = () => {
-            if (i < 3) {
-                i++;
-                throw new Error('not yet');
-            }
-            return Promise.resolve(val);
-        };
-
-        const ret = await retry(fn);
-
-        expect(ret).toBe(val);
-    });
-});

package/test/secrets/dbsecret.test.ts

@@ -1,59 +0,0 @@
-import {mockSecret, stubSecretsManager} from "../../src/test/secrets-manager";
-
-import * as sinon from 'sinon';
-
-const SECRET_ID = "test_secret";
-const SECRET_WITH_PREFIX = {
-    "prefix.value" : "value",
-    "prefix.name" : "name",
-    "wrong.value" : "value",
-};
-const SECRET_EMPTY = {};
-
-stubSecretsManager();
-
-import {GenericSecret, withSecret, withSecretAndPrefix} from "../../src/aws/runtime/secrets/secret";
-
-describe('secret - test', () => {
-    afterEach(() => {
-        sinon.restore();
-    });
-
-    test('getSecret - no secret', async () => {
-        mockSecret(null);
-
-        await expect(async () => {
-            await withSecret(SECRET_ID, () => {
-                // do nothing
-            });
-        }).rejects.toThrowError("No secret found!");
-    });
-
-    test('getSecret - empty secret', async () => {
-        mockSecret(SECRET_EMPTY);
-
-        await withSecret(SECRET_ID,  (secret: GenericSecret) => {
-            expect(secret).toEqual(SECRET_EMPTY);
-        });
-    });
-
-    test('getSecret - no prefix', async () => {
-        mockSecret(SECRET_WITH_PREFIX);
-
-        await withSecret(SECRET_ID,  (secret: GenericSecret) => {
-            expect(secret).toEqual(SECRET_WITH_PREFIX);
-        });
-    });
-
-    test('getSecret - with prefix', async () => {
-        mockSecret(SECRET_WITH_PREFIX);
-
-        await withSecretAndPrefix(SECRET_ID, 'prefix',  (secret: GenericSecret) => {
-            expect(secret).toEqual({
-                value: "value",
-                name: "name",
-            });
-        });
-
-    });
-});

package/test/secrets/secret-holder.test.ts

@@ -1,143 +0,0 @@
-import { mockSecret, stubSecretsManager } from "../../src/test/secrets-manager";
-
-import * as sinon from "sinon";
-
-const SECRET_WITH_PREFIX = {
-    "prefix.value": "value",
-    "prefix.name": "name",
-    "wrong.value": "value",
-    username: "DB_USER",
-};
-const SECRET_EMPTY = {};
-
-const stubSM = stubSecretsManager();
-
-import { SecretHolder } from "../../src/aws/runtime/secrets/secret-holder";
-import { DatabaseEnvironmentKeys } from "../../src/aws/runtime/secrets/dbsecret";
-
-describe("SecretHolder - tests", () => {
-    beforeEach(() => {
-        process.env["SECRET_ID"] = "test-id";
-    });
-
-    afterEach(() => {
-        sinon.restore();
-        sinon.reset();
-        delete process.env[DatabaseEnvironmentKeys.DB_USER];
-    });
-
-    test("get - no secret", async () => {
-        mockSecret(null);
-
-        const holder = SecretHolder.create();
-        await expect(async () => {
-            await holder.get();
-        }).rejects.toThrowError("No secret found!");
-    });
-
-    test("get - empty secret", async () => {
-        mockSecret(SECRET_EMPTY);
-
-        const holder = SecretHolder.create();
-        const secret = await holder.get();
-
-        expect(secret).toEqual(SECRET_EMPTY);
-    });
-
-    test("get - no prefix", async () => {
-        mockSecret(SECRET_WITH_PREFIX);
-
-        const holder = SecretHolder.create();
-        const secret = await holder.get();
-
-        expect(secret).toEqual(SECRET_WITH_PREFIX);
-    });
-
-    test("get - check keys - not found", async () => {
-        mockSecret(SECRET_WITH_PREFIX);
-
-        const holder = SecretHolder.create("", ["not_found"]);
-        await expect(async () => {
-            await holder.get();
-        }).rejects.toThrow();
-    });
-
-    test("get - check keys - found", async () => {
-        mockSecret(SECRET_WITH_PREFIX);
-
-        const holder = SecretHolder.create("", ["prefix.value", "username"]);
-
-        await holder.get();
-    });
-
-    test("setDatabaseCredentials - no prefix", async () => {
-        mockSecret(SECRET_WITH_PREFIX);
-
-        const holder = SecretHolder.create();
-        expect(process.env[DatabaseEnvironmentKeys.DB_USER]).toBeUndefined();
-
-        await holder.setDatabaseCredentials();
-        expect(process.env[DatabaseEnvironmentKeys.DB_USER]).toEqual(
-            SECRET_WITH_PREFIX.username
-        );
-    });
-
-    test("setDatabaseCredentials - with prefix", async () => {
-        mockSecret(SECRET_WITH_PREFIX);
-
-        const holder = SecretHolder.create("prefix");
-        expect(process.env[DatabaseEnvironmentKeys.DB_USER]).toBeUndefined();
-
-        await holder.setDatabaseCredentials();
-        expect(process.env[DatabaseEnvironmentKeys.DB_USER]).toEqual(
-            SECRET_WITH_PREFIX.username
-        );
-    });
-
-    test("getSecret - with prefix", async () => {
-        mockSecret(SECRET_WITH_PREFIX);
-
-        const holder = SecretHolder.create("prefix");
-        const secret = await holder.get();
-
-        expect(secret).toEqual({
-            value: "value",
-            name: "name",
-        });
-    });
-
-    test("get - ttl - do not fetch", async () => {
-        mockSecret(SECRET_WITH_PREFIX);
-
-        const holder = SecretHolder.create();
-
-        const callCount = stubSM.callCount;
-
-        await holder.get();
-        expect(stubSM.callCount).toEqual(callCount + 1);
-
-        // gets cached secret
-        await holder.get();
-        expect(stubSM.callCount).toEqual(callCount + 1);
-    });
-
-    test("get - ttl - fetch", async () => {
-        mockSecret(SECRET_WITH_PREFIX);
-
-        const holder = new SecretHolder("", "", [], {
-            ttl: 1,
-        });
-
-        const callCount = stubSM.callCount;
-
-        await holder.get();
-        expect(stubSM.callCount).toEqual(callCount + 1);
-
-        // cache expires, fetches secret again
-        const start = Date.now();
-        while (Date.now() < start + 2000);
-
-        await holder.get();
-        expect(stubSM.callCount).toEqual(callCount + 2);
-    });
-});

package/test/secrets/secret.test.ts

@@ -1,49 +0,0 @@
-import {mockSecret, stubSecretsManager} from "../../src/test/secrets-manager";
-
-import * as sinon from 'sinon';
-
-const SECRET_ID = "test_secret";
-const SECRET_WITH_PREFIX = {
-    "prefix.value" : "value",
-    "prefix.name" : "name",
-    "wrong.value" : "value",
-};
-const SECRET_EMPTY = {};
-
-stubSecretsManager();
-
-import {getSecret} from "../../src/aws/runtime/secrets/secret";
-
-describe('secret - test', () => {
-    afterEach(() => {
-        sinon.restore();
-    });
-
-    test('getSecret - no secret', async () => {
-        mockSecret(null);
-        await expect(async () => {
-            await getSecret(SECRET_ID, '');
-        }).rejects.toThrowError("No secret found!");
-    });
-
-    test('getSecret - empty secret', async () => {
-        mockSecret(SECRET_EMPTY);
-        const secret = await getSecret(SECRET_ID, '');
-        expect(secret).toEqual(SECRET_EMPTY);
-    });
-
-    test('getSecret - no prefix', async () => {
-        mockSecret(SECRET_WITH_PREFIX);
-        const secret = await getSecret(SECRET_ID, '');
-        expect(secret).toEqual(SECRET_WITH_PREFIX);
-    });
-
-    test('getSecret - with prefix', async () => {
-        mockSecret(SECRET_WITH_PREFIX);
-        const secret = await getSecret(SECRET_ID, 'prefix');
-        expect(secret).toEqual({
-            value: "value",
-            name: "name",
-        });
-    });
-});