@moreapp/common-nodejs 0.2.0 → 0.4.0

package/README.md

@@ -1,11 +1,6 @@
-# Notification service
+# MoreApp Common NodeJS
 
-# Direnv
-
-`direnv` loads the `.envrc` file automatically
-This loads Sparkpost secrets via `kubectl`
-
-**NOTE:** make sure the dev-cluster in `kubectx` is named `dev`!
+.. TODO
 
 # Pre-commit hooks
 

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./tracer";
+export * from "./logger";
+export * from "./utils";

package/{build/src → dist}/index.js

@@ -14,4 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./tracer"), exports);
+__exportStar(require("./logger"), exports);
 __exportStar(require("./utils"), exports);

package/dist/logger.d.ts

@@ -0,0 +1 @@
+export declare const logger: import("winston").Logger;

package/dist/logger.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const winston_1 = require("winston");
+const entry_1 = require("@google-cloud/logging/build/src/entry");
+const stackdriverTracingFormat = (0, winston_1.format)((info) => {
+    if (info["trace_id"] && info["span_id"]) {
+        info[entry_1.TRACE_KEY] = info["trace_id"];
+        info[entry_1.SPAN_ID_KEY] = info["span_id"];
+        info[entry_1.TRACE_SAMPLED_KEY] = true;
+    }
+    return info;
+});
+exports.logger = (0, winston_1.createLogger)({
+    level: "info",
+    transports: [new winston_1.transports.Console()],
+    format: winston_1.format.combine(stackdriverTracingFormat(), winston_1.format.json()),
+});

package/dist/tracer.d.ts

@@ -0,0 +1,2 @@
+import * as types from "@opentelemetry/instrumentation/build/src/types";
+export declare const tracer: (serviceName: string, instrumentations: types.Instrumentation[]) => void;

package/dist/tracer.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tracer = void 0;
+const opentelemetry_cloud_trace_exporter_1 = require("@google-cloud/opentelemetry-cloud-trace-exporter");
+const instrumentation_1 = require("@opentelemetry/instrumentation");
+const instrumentation_dns_1 = require("@opentelemetry/instrumentation-dns");
+const instrumentation_http_1 = require("@opentelemetry/instrumentation-http");
+const instrumentation_express_1 = require("@opentelemetry/instrumentation-express");
+const instrumentation_winston_1 = require("@opentelemetry/instrumentation-winston");
+const sdk_trace_node_1 = require("@opentelemetry/sdk-trace-node");
+const sdk_trace_base_1 = require("@opentelemetry/sdk-trace-base");
+const resources_1 = require("@opentelemetry/resources");
+const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
+const propagator_b3_1 = require("@opentelemetry/propagator-b3");
+const utils_1 = require("./utils");
+const tracer = (serviceName, instrumentations) => {
+    const provider = new sdk_trace_node_1.NodeTracerProvider({
+        resource: new resources_1.Resource({
+            [semantic_conventions_1.SemanticResourceAttributes.SERVICE_NAME]: serviceName,
+            [semantic_conventions_1.SemanticResourceAttributes.SERVICE_INSTANCE_ID]: (0, utils_1.environmentVariable)("HOSTNAME", "local"),
+        }),
+    });
+    provider.register({
+        propagator: new propagator_b3_1.B3Propagator({
+            injectEncoding: propagator_b3_1.B3InjectEncoding.MULTI_HEADER,
+        }),
+    });
+    (0, instrumentation_1.registerInstrumentations)({
+        instrumentations: [
+            new instrumentation_dns_1.DnsInstrumentation(),
+            new instrumentation_http_1.HttpInstrumentation({
+                ignoreIncomingRequestHook: (_req) => {
+                    // Disable instrumentation for incoming requests, handled by ExpressInstrumentation below
+                    return true;
+                },
+            }),
+            new instrumentation_express_1.ExpressInstrumentation(),
+            new instrumentation_winston_1.WinstonInstrumentation(),
+            ...instrumentations,
+        ],
+    });
+    if (process.env["STACKDRIVER_TRACING_ENABLED"] === "true") {
+        const exporter = new opentelemetry_cloud_trace_exporter_1.TraceExporter({
+            resourceFilter: /^service\./,
+        });
+        provider.addSpanProcessor(new sdk_trace_base_1.BatchSpanProcessor(exporter));
+    }
+};
+exports.tracer = tracer;

package/{build/src → dist}/utils.d.ts

@@ -1 +1,2 @@
 export declare function environmentVariable(key: string, fallback?: string | number): string;
+export declare function currentTraceId(): string | undefined;

package/dist/utils.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.currentTraceId = exports.environmentVariable = void 0;
+const context_utils_1 = require("@opentelemetry/api/build/src/trace/context-utils");
+const api_1 = require("@opentelemetry/api");
+function environmentVariable(key, fallback) {
+    const value = process.env[key] || fallback;
+    if (value) {
+        return value.toString();
+    }
+    throw new Error(`Missing environment variable '${key}'`);
+}
+exports.environmentVariable = environmentVariable;
+function currentTraceId() {
+    return (0, context_utils_1.getSpanContext)(api_1.context.active())?.traceId;
+}
+exports.currentTraceId = currentTraceId;

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@moreapp/common-nodejs",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "license": "UNLICENSED",
-  "main": "build/index.js",
-  "types": "build/index.d.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc",
     "test": "jest",
@@ -14,7 +14,22 @@
     "lint:fix": "yarn lint:check --fix",
     "prepare": "husky install"
   },
-  "dependencies": {},
+  "files": [
+    "dist/**/*"
+  ],
+  "dependencies": {
+    "@google-cloud/logging": "10.4.0",
+    "@google-cloud/opentelemetry-cloud-trace-exporter": "2.0.0",
+    "@opentelemetry/api": "1.4.1",
+    "@opentelemetry/instrumentation": "0.36.1",
+    "@opentelemetry/instrumentation-dns": "0.31.2",
+    "@opentelemetry/instrumentation-express": "0.32.1",
+    "@opentelemetry/instrumentation-http": "0.36.1",
+    "@opentelemetry/instrumentation-winston": "0.31.1",
+    "@opentelemetry/sdk-node": "0.36.1",
+    "@opentelemetry/sdk-trace-node": "1.10.1",
+    "winston": "3.8.2"
+  },
   "devDependencies": {
     "@types/jest": "29.2.0",
     "@types/node": "18.11.8",

package/.eslintignore

@@ -1,2 +0,0 @@
-**/*.js
-node_modules

package/.eslintrc.json

@@ -1,19 +0,0 @@
-{
-  "env": {
-    "node": true
-  },
-  "extends": ["plugin:prettier/recommended"],
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "project": ["./tsconfig.json"],
-    "ecmaVersion": 12,
-    "sourceType": "module"
-  },
-  "plugins": ["prettier", "@typescript-eslint"],
-  "rules": {
-    "prettier/prettier": ["error"],
-    "default-case": "off",
-    "@typescript-eslint/switch-exhaustiveness-check": "error"
-  },
-  "ignorePatterns": ["build"]
-}

package/.husky/pre-commit

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

package/.nvmrc

@@ -1 +0,0 @@
-18.12.0

package/.prettierignore

@@ -1 +0,0 @@
-dist

package/bitbucket-pipelines.yml

@@ -1,53 +0,0 @@
-image: node:18.12.0
-
-pipelines:
-  pull-requests:
-    '**':
-      - step:
-          name: Analyse
-          services:
-            - docker
-          caches:
-            - docker
-            - node
-            - sonar
-          script:
-            - yarn install --frozen-lockfile
-            - yarn format:check
-            - yarn lint:check
-            - yarn build
-            - yarn test --coverage --testResultsProcessor=jest-sonar-reporter --detectOpenHandles
-            - pipe: sonarsource/sonarcloud-scan:1.4.0
-              variables:
-                EXTRA_ARGS: '-Dsonar.sources=src -Dsonar.tests=src -Dsonar.test.inclusions="**/*.test.js" -Dsonar.coverage.exclusions="**/node_modules/**,**/*.spec.ts" -Dsonar.javascript.lcov.reportPaths=coverage/lcov.info'
-            - pipe: sonarsource/sonarcloud-quality-gate:0.1.6
-  branches:
-    master:
-      - step:
-          name: "Build"
-          caches:
-            - node
-          script:
-            - yarn --frozen-lockfile
-            - yarn build
-          artifacts:
-            - build/**
-      - step:
-          name: "Publish to NPM"
-          trigger: manual
-          caches:
-            - node
-          script:
-            - npm version minor -m "Upgrade to %s [skip ci]"
-            - git push && git push --tags
-            - pipe: atlassian/npm-publish:0.3.2
-              variables:
-                NPM_TOKEN: $NPM_TOKEN
-                EXTRA_ARGS: "--access public"
-
-definitions:
-  caches:
-    sonar: ~/.sonar/cache
-  services:
-    docker:
-      memory: 2048

package/build/jest.config.d.ts

@@ -1,3 +0,0 @@
-import type { Config } from "@jest/types";
-declare const config: Config.InitialOptions;
-export default config;

package/build/jest.config.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const config = {
-    verbose: true,
-    preset: "ts-jest",
-    testEnvironment: "node",
-    testPathIgnorePatterns: ["/node_modules/", "/dist/"],
-    roots: ["<rootDir>/src"],
-    transform: {
-        "^.+\\.ts?$": "ts-jest",
-    },
-};
-exports.default = config;

package/build/src/index.d.ts

@@ -1 +0,0 @@
-export * from "./utils";

package/build/src/utils.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.environmentVariable = void 0;
-function environmentVariable(key, fallback) {
-    const value = process.env[key] || fallback;
-    if (value) {
-        return value.toString();
-    }
-    throw new Error(`Missing environment variable '${key}'`);
-}
-exports.environmentVariable = environmentVariable;

package/jest.config.ts

@@ -1,14 +0,0 @@
-import type { Config } from "@jest/types";
-
-const config: Config.InitialOptions = {
-  verbose: true,
-  preset: "ts-jest",
-  testEnvironment: "node",
-  testPathIgnorePatterns: ["/node_modules/", "/dist/"],
-  roots: ["<rootDir>/src"],
-  transform: {
-    "^.+\\.ts?$": "ts-jest",
-  },
-};
-
-export default config;

package/sonar-project.properties

@@ -1,5 +0,0 @@
-sonar.sources=src
-sonar.exclusions=src/**/*.test.ts
-sonar.tests=src/**/*.test.ts
-sonar.testExecutionReportPaths=test-report.xml
-sonar.javascript.lcov.reportPaths=coverage/lcov.info

package/src/index.ts

@@ -1 +0,0 @@
-export * from "./utils";

package/src/utils.test.ts

@@ -1,20 +0,0 @@
-import { environmentVariable } from "./utils";
-
-describe("environmentVariable", () => {
-  test("Should throw when environment variable does not exist", async () => {
-    process.env["COMMONS_NODEJS_TEST_EXISTING"] = "SOME_VALUE";
-    expect(environmentVariable("COMMONS_NODEJS_TEST_EXISTING")).toBe("SOME_VALUE");
-  });
-
-  test("Use fallback value when environment variable does not exist", async () => {
-    expect(environmentVariable("COMMONS_NODEJS_TEST_NON_EXISTING", "DEFAULT_VALUE")).toBe(
-      "DEFAULT_VALUE"
-    );
-  });
-
-  test("Should throw when environment variable does not exist", async () => {
-    expect(() => environmentVariable("COMMONS_NODEJS_TEST_NON_EXISTING")).toThrow(
-      "Missing environment variable 'COMMONS_NODEJS_TEST_NON_EXISTING'"
-    );
-  });
-});

package/src/utils.ts

@@ -1,8 +0,0 @@
-export function environmentVariable(key: string, fallback?: string | number): string {
-  const value = process.env[key] || fallback;
-  if (value) {
-    return value.toString();
-  }
-
-  throw new Error(`Missing environment variable '${key}'`);
-}

package/tsconfig.json

@@ -1,24 +0,0 @@
-{
-  "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig.json to read more about this file */
-
-    "lib": ["ES2021"],
-    "module": "commonjs",
-    "target": "ES2021",
-    "outDir": "./build",
-    "strict": true,
-    "declaration": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUncheckedIndexedAccess": true,
-    "noImplicitOverride": true,
-    "noPropertyAccessFromIndexSignature": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    // Required to load JSON files
-    "resolveJsonModule": true
-  }
-}