@moreapp/common-nodejs 0.7.5 → 0.7.7

package/dist/tracer.js

@@ -41,7 +41,7 @@ const tracer = (serviceName, { http = {
             injectEncoding: propagator_b3_1.B3InjectEncoding.MULTI_HEADER,
         }),
     });
-    if (process.env["STACKDRIVER_TRACING_ENABLED"] === "true") {
+    if ((0, utils_1.environmentVariable)("STACKDRIVER_TRACING_ENABLED", false)) {
         const exporter = new opentelemetry_cloud_trace_exporter_1.TraceExporter({
             resourceFilter: /^service\./,
         });

package/dist/utils.d.ts

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

package/dist/utils.js

@@ -1,22 +1,53 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 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");
+const lodash_1 = __importDefault(require("lodash"));
 function environmentVariable(key, fallback) {
     const value = process.env[key] || fallback;
-    if (value) {
-        return value.toString();
+    if (value === undefined) {
+        throw new Error(`Missing environment variable '${key}'`);
     }
-    throw new Error(`Missing environment variable '${key}'`);
+    else if (fallback === undefined) {
+        return value;
+    }
+    else if (lodash_1.default.isString(fallback) && lodash_1.default.isString(value)) {
+        return value;
+    }
+    else if (lodash_1.default.isFinite(fallback) && lodash_1.default.isFinite(Number(value))) {
+        return Number(value);
+    }
+    else if (lodash_1.default.isBoolean(fallback) &&
+        (lodash_1.default.isBoolean(value) || value === "true" || value === "false")) {
+        return Boolean(value);
+    }
+    throw new Error(`Wrong type for environment variable '${key}'`);
 }
 exports.environmentVariable = environmentVariable;
 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;
+const emailAddressMaxLength = 254; // https://stackoverflow.com/a/574698
+const emailAddressLocalPattern = /^.+$/;
+const emailAddressDomainPattern = /^(?:[a-z0-9À-ž](?:[a-z0-9À-ž-]{0,61}[a-z0-9À-ž])?\.)+[a-z0-9À-ž][a-z0-9À-ž-]{0,61}[a-z0-9]$/;
+// There are many regex patterns to validate email addresses, but they all have flaws and cannot 100% correctly verify
+// every possible email address. For us, it's more important to avoid the majority of typo's instead of catching every
+// invalid email address. We let our email provider handle and false positives (either by their validation or the fact
+// that the email could not be delivered.
+// ! This code is duplicated in other projects, make sure that changes are made there too (including tests).
 function isValidEmail(email) {
-    return validEmailPattern.test(email);
+    if (email.length > emailAddressMaxLength) {
+        return false;
+    }
+    const [localAddr, domain] = email.split("@");
+    if (localAddr === undefined || domain === undefined) {
+        return false;
+    }
+    return emailAddressLocalPattern.test(localAddr) && emailAddressDomainPattern.test(domain);
 }
 exports.isValidEmail = isValidEmail;

package/dist/utils.test.js

@@ -3,23 +3,58 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("./utils");
 describe("environmentVariable", () => {
     test("Should throw when environment variable does not exist", async () => {
-        process.env["COMMONS_NODEJS_TEST_EXISTING"] = "SOME_VALUE";
-        expect((0, utils_1.environmentVariable)("COMMONS_NODEJS_TEST_EXISTING")).toBe("SOME_VALUE");
+        expect(() => (0, utils_1.environmentVariable)("COMMONS_NODEJS_TEST_NON_EXISTING")).toThrow("Missing environment variable 'COMMONS_NODEJS_TEST_NON_EXISTING'");
     });
-    test("Use fallback value when environment variable does not exist", async () => {
-        expect((0, utils_1.environmentVariable)("COMMONS_NODEJS_TEST_NON_EXISTING", "DEFAULT_VALUE")).toBe("DEFAULT_VALUE");
+    test("Should return fallback value when environment variable does not exist (string)", async () => {
+        expect((0, utils_1.environmentVariable)("COMMONS_NODEJS_TEST_NON_EXISTING", "my-fallback")).toBe("my-fallback");
     });
-    test("Should throw when environment variable does not exist", async () => {
-        expect(() => (0, utils_1.environmentVariable)("COMMONS_NODEJS_TEST_NON_EXISTING")).toThrow("Missing environment variable 'COMMONS_NODEJS_TEST_NON_EXISTING'");
+    test("Should return fallback value when environment variable does not exist (number)", async () => {
+        expect((0, utils_1.environmentVariable)("COMMONS_NODEJS_TEST_NON_EXISTING", 1)).toBe(1);
+    });
+    test("Should return fallback value when environment variable does not exist (boolean)", async () => {
+        expect((0, utils_1.environmentVariable)("COMMONS_NODEJS_TEST_NON_EXISTING", false)).toBe(false);
+    });
+    test("Should return actual value when environment variable exists (string)", async () => {
+        process.env["COMMONS_NODEJS_TEST_EXISTING"] = "actual-value";
+        expect((0, utils_1.environmentVariable)("COMMONS_NODEJS_TEST_EXISTING", "my-fallback")).toBe("actual-value");
+    });
+    test("Should return actual value when environment variable exists (number)", async () => {
+        process.env["COMMONS_NODEJS_TEST_EXISTING"] = "2";
+        expect((0, utils_1.environmentVariable)("COMMONS_NODEJS_TEST_EXISTING", 1)).toBe(2);
+    });
+    test("Should return actual value when environment variable exists (boolean)", async () => {
+        process.env["COMMONS_NODEJS_TEST_EXISTING"] = "true";
+        expect((0, utils_1.environmentVariable)("COMMONS_NODEJS_TEST_EXISTING", false)).toBe(true);
+    });
+    test("should throw when environment variable contains an invalid type (number)", async () => {
+        process.env["COMMONS_NODEJS_TEST_EXISTING"] = "not-a-number";
+        expect(() => (0, utils_1.environmentVariable)("COMMONS_NODEJS_TEST_EXISTING", 1)).toThrow("Wrong type for environment variable 'COMMONS_NODEJS_TEST_EXISTING'");
+    });
+    test("should throw when environment variable contains an invalid type (boolean)", async () => {
+        process.env["COMMONS_NODEJS_TEST_EXISTING"] = "not-a-boolean";
+        expect(() => (0, utils_1.environmentVariable)("COMMONS_NODEJS_TEST_EXISTING", false)).toThrow("Wrong type for environment variable 'COMMONS_NODEJS_TEST_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);
+    describe("Valid email addresses", () => {
+        test("Standard email address", () => expect((0, utils_1.isValidEmail)("a@moreapp.dev")).toBeTruthy());
+        test("Non-alphanumeric characters", () => expect((0, utils_1.isValidEmail)("a+-._&%'@moreapp.dev")).toBeTruthy());
+        test("Shortest email address", () => expect((0, utils_1.isValidEmail)("a@b.co")).toBeTruthy());
+        test("Subdomain", () => expect((0, utils_1.isValidEmail)("a@sub.domain.dev")).toBeTruthy());
+        test("Subdomain with a dash", () => expect((0, utils_1.isValidEmail)("a@sub.dom-ain.dev")).toBeTruthy());
+        test("Long TLD", () => expect((0, utils_1.isValidEmail)("a@b.business")).toBeTruthy());
+        test("Diacritics", () => expect((0, utils_1.isValidEmail)("ẞçäöü@möręæppß.dev")).toBeTruthy());
     });
-    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);
+    describe("Invalid email addresses", () => {
+        test("Missing '@' character and domain", () => expect((0, utils_1.isValidEmail)("john")).toBeFalsy());
+        test("// Multiple '@' characters", () => expect((0, utils_1.isValidEmail)("a@b@moreapp.dev")).toBeFalsy());
+        test("// Empty", () => expect((0, utils_1.isValidEmail)("")).toBeFalsy());
+        test("// Whitespace before/after", () => expect((0, utils_1.isValidEmail)(" a@moreapp.dev ")).toBeFalsy());
+        test("// Newlines, tabs, ..., before/after", () => expect((0, utils_1.isValidEmail)("\n \ta@moreapp.dev\n ")).toBeFalsy());
+        test("// Missing '@' character", () => expect((0, utils_1.isValidEmail)("ab.com")).toBeFalsy());
+        test("// Double dot in domain", () => expect((0, utils_1.isValidEmail)("a@moreapp..com")).toBeFalsy());
+        test("// Too short TLD", () => expect((0, utils_1.isValidEmail)("a@b.c")).toBeFalsy());
+        test("// Missing local part", () => expect((0, utils_1.isValidEmail)("@moreapp.dev")).toBeFalsy());
+        test("// Too long", () => expect((0, utils_1.isValidEmail)("abcdefghijklmnopqrstuvwxyz-abcdefghijklmnopqrstuvwxyz-abcdefghijklmnopqrstuvwxyz-abcdefghijklmnopqrstuvwxyz-abcdefghijklmnopqrstuvwxyz-abcdefghijklmnopqrstuvwxyz-abcdefghijklmnopqrstuvwxyz-abcdefghijklmnopqrstuvwxyz-abcdefghijklmnopqrstuvwxyz-@moreapp.dev")).toBeFalsy());
     });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moreapp/common-nodejs",
-  "version": "0.7.5",
+  "version": "0.7.7",
   "license": "UNLICENSED",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,42 +18,44 @@
     "dist/**/*"
   ],
   "dependencies": {
-    "@google-cloud/logging": "10.4.1",
-    "@google-cloud/opentelemetry-cloud-trace-exporter": "2.0.0",
+    "@google-cloud/logging": "10.5.0",
+    "@google-cloud/opentelemetry-cloud-trace-exporter": "2.1.0",
     "@opentelemetry/api": "1.4.1",
-    "@opentelemetry/instrumentation": "0.38.0",
-    "@opentelemetry/instrumentation-dns": "0.31.5",
-    "@opentelemetry/instrumentation-express": "0.32.4",
-    "@opentelemetry/instrumentation-http": "0.38.0",
-    "@opentelemetry/instrumentation-winston": "0.31.4",
-    "@opentelemetry/sdk-node": "0.38.0",
-    "@opentelemetry/sdk-trace-node": "1.12.0",
-    "axios": "1.4.0",
+    "@opentelemetry/instrumentation": "0.41.2",
+    "@opentelemetry/instrumentation-dns": "0.32.4",
+    "@opentelemetry/instrumentation-express": "0.33.3",
+    "@opentelemetry/instrumentation-http": "0.41.2",
+    "@opentelemetry/instrumentation-winston": "0.32.2",
+    "@opentelemetry/sdk-node": "0.41.2",
+    "@opentelemetry/sdk-trace-node": "1.15.2",
+    "axios": "1.5.1",
     "content-disposition-parser": "1.0.2",
-    "date-and-time": "3.0.2",
-    "winston": "3.8.2",
-    "zod": "3.21.4"
+    "date-and-time": "3.0.3",
+    "lodash": "4.17.21",
+    "winston": "3.10.0",
+    "zod": "3.22.4"
   },
   "devDependencies": {
-    "@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",
-    "eslint-plugin-import": "2.27.5",
+    "@types/jest": "29.5.10",
+    "@types/lodash": "4.14.202",
+    "@types/node": "18.17.19",
+    "@typescript-eslint/eslint-plugin": "5.62.0",
+    "@typescript-eslint/parser": "5.62.0",
+    "eslint": "8.48.0",
+    "eslint-config-airbnb-typescript": "17.1.0",
+    "eslint-config-prettier": "8.10.0",
+    "eslint-plugin-import": "2.28.1",
     "eslint-plugin-prettier": "4.2.1",
     "husky": "8.0.3",
-    "jest": "29.5.0",
-    "jest-mock-extended": "3.0.4",
+    "jest": "29.6.4",
+    "jest-mock-extended": "3.0.5",
     "jest-sonar-reporter": "2.0.0",
-    "lint-staged": "13.2.3",
-    "nock": "13.3.2",
+    "lint-staged": "13.3.0",
+    "nock": "13.3.8",
     "prettier": "2.8.8",
     "ts-jest": "29.1.1",
     "ts-node": "10.9.1",
-    "typescript": "5.0.4"
+    "typescript": "5.2.2"
   },
   "prettier": {
     "printWidth": 100,