@moreapp/common-nodejs 0.7.3 → 0.7.4

package/README.md

@@ -1,21 +1,47 @@
-# MoreApp Common NodeJS
+# MoreApp Common Node.js
 
-A collection of shared NodeJS code.
+This project contains common code that can be used for our Node.js projects.
 
-# Pre-commit hooks
+## Getting started
 
 Run `yarn prepare` once to install Git hooks, doing lints and prettier formatting
 
-## Usage
+## Project usage
+
+Most code can be used as is, except for tracing, see below.
 
 ### Tracing
 
-Tracing code should always be loaded first, before any other libraries. This is because the OpenTelemetry
-instrumentations monkey patch libraries to add tracing. This will break if the library has been loaded (import/require),
-because the unpatched library will be cached.
+Tracing code should always be loaded (`import`/`require`) first, before any other libraries. This is because the
+OpenTelemetry instrumentations monkey patch libraries to add tracing. Patching has to happen first, because already
+loaded libraries will be cached by the module system.
 
-Put the following snippet on the first line of the entrypoint file.
+The recommended way to do this, is to create a file `instrumentation.ts` with the following content (the extra
+instrumentation is there as an example):
 
 ```
-require("@moreapp/common-nodejs/dist/tracer").tracer(<service_name>, {});
+import { tracer } from "@moreapp/common-nodejs";
+import { MongoDBInstrumentation } from "@opentelemetry/instrumentation-mongodb";
+
+tracer("<SERVICE_NAME>", {
+  extraInstrumentations: [new MongoDBInstrumentation()],
+});
 ```
+
+And then use the `--require` [Node.js CLI option](https://nodejs.org/api/cli.html#-r---require-module) to load this file.
+
+## Creating a new release
+
+Follow the steps below to create a new release:
+
+1. Ensure that the `master` branch has the commits you want to release
+2. Start a new build in Bitbucket Pipelines for the `master` branch with the `create-release` pipeline
+3. Select which type of version bump you want to do
+4. The build will automatically create a new version and publish it to NPM
+
+### Creating a local release
+
+If you want to test new code in other projects, then you can link this repository using `Yarn`.
+
+1. Run `yarn link` in this repository
+2. Run `yarn link @moreapp/common-nodejs` in the project you want to use this repository in

package/dist/tracer.d.ts

@@ -1,8 +1,8 @@
 import * as types from "@opentelemetry/instrumentation/build/src/types";
 export declare const tracer: (serviceName: string, { http, extraInstrumentations, debug, }: {
-    http: {
+    http?: {
         portsToInstrument: number[];
-    };
-    extraInstrumentations: types.Instrumentation[];
-    debug: boolean;
+    } | undefined;
+    extraInstrumentations?: types.Instrumentation[] | undefined;
+    debug?: boolean | undefined;
 }) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moreapp/common-nodejs",
-  "version": "0.7.3",
+  "version": "0.7.4",
   "license": "UNLICENSED",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -22,23 +22,23 @@
     "@google-cloud/opentelemetry-cloud-trace-exporter": "2.0.0",
     "@opentelemetry/api": "1.4.1",
     "@opentelemetry/instrumentation": "0.38.0",
-    "@opentelemetry/instrumentation-dns": "0.31.3",
-    "@opentelemetry/instrumentation-express": "0.32.2",
+    "@opentelemetry/instrumentation-dns": "0.31.5",
+    "@opentelemetry/instrumentation-express": "0.32.4",
     "@opentelemetry/instrumentation-http": "0.38.0",
-    "@opentelemetry/instrumentation-winston": "0.31.2",
+    "@opentelemetry/instrumentation-winston": "0.31.4",
     "@opentelemetry/sdk-node": "0.38.0",
     "@opentelemetry/sdk-trace-node": "1.12.0",
     "axios": "1.4.0",
     "content-disposition-parser": "1.0.2",
-    "date-and-time": "3.0.0",
+    "date-and-time": "3.0.2",
     "winston": "3.8.2",
     "zod": "3.21.4"
   },
   "devDependencies": {
-    "@types/jest": "29.5.1",
-    "@types/node": "18.16.9",
-    "@typescript-eslint/eslint-plugin": "5.59.5",
-    "@typescript-eslint/parser": "5.59.5",
+    "@types/jest": "29.5.3",
+    "@types/node": "18.16.20",
+    "@typescript-eslint/eslint-plugin": "5.59.11",
+    "@typescript-eslint/parser": "5.59.11",
     "eslint": "8.40.0",
     "eslint-config-airbnb-typescript": "17.0.0",
     "eslint-config-prettier": "8.8.0",
@@ -48,10 +48,10 @@
     "jest": "29.5.0",
     "jest-mock-extended": "3.0.4",
     "jest-sonar-reporter": "2.0.0",
-    "lint-staged": "13.2.2",
-    "nock": "13.3.1",
+    "lint-staged": "13.2.3",
+    "nock": "13.3.2",
     "prettier": "2.8.8",
-    "ts-jest": "29.1.0",
+    "ts-jest": "29.1.1",
     "ts-node": "10.9.1",
     "typescript": "5.0.4"
   },