@moreapp/common-nodejs 0.5.0 → 0.7.0

package/README.md

@@ -5,3 +5,17 @@ A collection of shared NodeJS code.
 # Pre-commit hooks
 
 Run `yarn prepare` once to install Git hooks, doing lints and prettier formatting
+
+## Usage
+
+### 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.
+
+Put the following snippet on the first line of the entrypoint file.
+
+```
+require("@moreapp/common-nodejs/dist/tracer").tracer(<service_name>, {});
+```

package/dist/MoreAppClient.d.ts

@@ -15,8 +15,8 @@ export default class MoreAppClient {
     private readonly client;
     constructor(options: Options);
     getBinary(path: string): Promise<BinaryFile>;
-    get(path: string): Promise<any>;
-    post(path: string, payload: Record<string, any>): Promise<any>;
+    get<T>(path: string): Promise<T>;
+    post<T>(path: string, payload: Record<string, any>): Promise<T>;
     delete(path: string): Promise<any>;
 }
 export {};

package/dist/MoreAppClient.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const axios_1 = __importDefault(require("axios"));
+const content_disposition_parser_1 = __importDefault(require("content-disposition-parser"));
 class MoreAppClient {
     constructor(options) {
         this.client = axios_1.default.create({
@@ -48,11 +49,5 @@ class MoreAppClient {
 exports.default = MoreAppClient;
 function getFilename(res) {
     const contentDispositionHeader = res.headers["content-disposition"];
-    if (contentDispositionHeader) {
-        const execParts = /filename="(.*)"/gi.exec(contentDispositionHeader);
-        if (execParts && execParts.length > 1) {
-            return execParts[1];
-        }
-    }
-    return undefined;
+    return (0, content_disposition_parser_1.default)(contentDispositionHeader)?.filename;
 }

package/dist/MoreAppClient.test.js

@@ -13,7 +13,7 @@ test("download binary file", async () => {
         .matchHeader("x-more-seal", "my-seal")
         .reply(200, file, {
         "Content-Type": "image/jpg",
-        "content-disposition": 'filename="my-photo.jpg"',
+        "content-disposition": 'attachment; filename="my-photo.jpg"',
     });
     const client = new MoreAppClient_1.default({
         serviceName: "Common Test",
@@ -44,3 +44,36 @@ test("unable to connect", async () => {
     });
     await expect(client.getBinary("/download")).rejects.toThrowError("getaddrinfo ENOTFOUND non-existing.moreapp.com");
 });
+const client = new MoreAppClient_1.default({
+    serviceName: "Common Test",
+    prefix: "https://api.moreapp.com",
+    seal: "my-seal",
+});
+test("Handle non existing file", async () => {
+    const apiMock = (0, nock_1.default)("https://api.moreapp.com").get("/download").reply(404);
+    await expect(client.getBinary("/download")).rejects.toThrow("Request failed with status code 404");
+    apiMock.done();
+});
+test("Handle missing 'content-type' header", async () => {
+    const apiMock = (0, nock_1.default)("https://api.moreapp.com").get("/download").reply(200);
+    const binaryFile = await client.getBinary("/download");
+    expect(binaryFile).not.toBeNull();
+    expect(binaryFile.contentType).toBe("unknown");
+    apiMock.done();
+});
+test("Handle missing 'content-disposition' header", async () => {
+    const apiMock = (0, nock_1.default)("https://api.moreapp.com").get("/download").reply(200);
+    const binaryFile = await client.getBinary("/download");
+    expect(binaryFile).not.toBeNull();
+    expect(binaryFile.filename).toBeUndefined();
+    apiMock.done();
+});
+test("Handle invalid 'content-disposition' header", async () => {
+    const apiMock = (0, nock_1.default)("https://api.moreapp.com").get("/download").reply(200, {}, {
+        "content-disposition": "filename=my-photo.png",
+    });
+    const binaryFile = await client.getBinary("/download");
+    expect(binaryFile).not.toBeNull();
+    expect(binaryFile.filename).toBeUndefined();
+    apiMock.done();
+});

package/dist/tracer.d.ts

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

package/dist/tracer.js

@@ -1,19 +1,35 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.tracer = void 0;
+const api_1 = require("@opentelemetry/api");
+const sdk_trace_node_1 = require("@opentelemetry/sdk-trace-node");
 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, extraInstrumentations) => {
+const tracer = (serviceName, { http = {
+    portsToInstrument: [3000],
+}, extraInstrumentations = [], debug = false, }) => {
+    (0, instrumentation_1.registerInstrumentations)({
+        instrumentations: [
+            new instrumentation_dns_1.DnsInstrumentation(),
+            new instrumentation_http_1.HttpInstrumentation({
+                ignoreIncomingRequestHook: (req) => {
+                    return !http.portsToInstrument.includes(req.socket.localPort || 0);
+                },
+            }),
+            new instrumentation_express_1.ExpressInstrumentation(),
+            new instrumentation_winston_1.WinstonInstrumentation(),
+            ...(extraInstrumentations || []),
+        ],
+    });
     const provider = new sdk_trace_node_1.NodeTracerProvider({
         resource: new resources_1.Resource({
             [semantic_conventions_1.SemanticResourceAttributes.SERVICE_NAME]: serviceName,
@@ -25,25 +41,15 @@ const tracer = (serviceName, extraInstrumentations) => {
             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(),
-            ...extraInstrumentations,
-        ],
-    });
     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));
     }
+    if (debug) {
+        api_1.diag.setLogger(new api_1.DiagConsoleLogger(), api_1.DiagLogLevel.DEBUG);
+        provider.addSpanProcessor(new sdk_trace_base_1.BatchSpanProcessor(new sdk_trace_node_1.ConsoleSpanExporter()));
+    }
 };
 exports.tracer = tracer;

package/dist/types.d.ts

@@ -3,20 +3,21 @@ import { FormVersionFieldSchema, SubmissionSchema } from "./schema";
 export declare type Submission = z.infer<typeof SubmissionSchema>;
 export declare type FormVersionField = z.infer<typeof FormVersionFieldSchema>;
 export declare type IntegrationTestResponse = {
-    status: "VALID" | "SUCCESS";
+    status: "VALID";
 } | {
     status: "INVALID";
     globalError: string;
     fieldErrors?: Record<string, any>;
 };
 export declare type IntegrationHandleResponse = {
-    status: "VALID" | "SUCCESS";
+    status: "SUCCESS";
     files?: {
         type: string;
         name: string;
         data: string;
     }[];
+    data: Record<string, any>;
 } | {
-    status: "INVALID";
+    status: "ERROR";
     message: string;
 };

package/dist/utils.d.ts

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

package/dist/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.currentTraceId = exports.environmentVariable = void 0;
+exports.isValidEmail = 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) {
@@ -15,3 +15,8 @@ function currentTraceId() {
     return (0, context_utils_1.getSpanContext)(api_1.context.active())?.traceId;
 }
 exports.currentTraceId = currentTraceId;
+const validEmailPattern = /^[A-Z0-9._&%+-]+@[A-Z0-9.-]+\.[A-Z]{2,}$/i;
+function isValidEmail(email) {
+    return validEmailPattern.test(email);
+}
+exports.isValidEmail = isValidEmail;

package/dist/utils.test.js

@@ -13,3 +13,13 @@ describe("environmentVariable", () => {
         expect(() => (0, utils_1.environmentVariable)("COMMONS_NODEJS_TEST_NON_EXISTING")).toThrow("Missing environment variable 'COMMONS_NODEJS_TEST_NON_EXISTING'");
     });
 });
+describe("isValidEmail", () => {
+    test("Should return true on valid email addresses", () => {
+        expect((0, utils_1.isValidEmail)("john@example.com")).toBe(true);
+        expect((0, utils_1.isValidEmail)("sbe-vsv.ch@schindler.com")).toEqual(true);
+    });
+    test("Should return false on invalid email addresses", () => {
+        expect((0, utils_1.isValidEmail)("john")).toBe(false);
+        expect((0, utils_1.isValidEmail)("john@example")).toBe(false);
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moreapp/common-nodejs",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "license": "UNLICENSED",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -29,6 +29,7 @@
     "@opentelemetry/sdk-node": "0.36.1",
     "@opentelemetry/sdk-trace-node": "1.10.1",
     "axios": "1.3.4",
+    "content-disposition-parser": "1.0.2",
     "date-and-time": "2.4.3",
     "winston": "3.8.2",
     "zod": "3.21.4"