gcf-common-lib 0.35.0 → 0.36.0

package/src/utils.js

@@ -1,84 +1,105 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.timeoutAfter = timeoutAfter;
-exports.delay = delay;
-exports.ms = ms;
-exports.sec = sec;
-exports.indexToA1 = indexToA1;
-exports.A1ToIndex = A1ToIndex;
-exports.colNumToA1 = colNumToA1;
-exports.A1ToColNum = A1ToColNum;
-exports.safeJsonParse = safeJsonParse;
-/**
- *
- * @param seconds Google function v1 timeout limit (max: 9 min)
- */
-async function timeoutAfter(seconds = 540) {
-    return new Promise((resolve, reject) => setTimeout(() => reject(new Error(`${seconds} seconds timeout exceeded`)), seconds * 1000));
-}
-async function delay(seconds) {
-    return new Promise(resolve => setTimeout(() => resolve(), seconds * 1000));
-}
-function ms(o) {
-    return sec(o) * 1000;
-}
-function sec(o) {
-    const multiMap = {};
-    multiMap.s = 1;
-    multiMap.m = multiMap.s * 60;
-    multiMap.h = multiMap.m * 60;
-    multiMap.d = multiMap.h * 24;
-    multiMap.w = multiMap.d * 7;
-    return Object.entries(o)
-        .map(([k, v]) => (multiMap[k] ?? 0) * (v ?? 0))
-        .reduce((sum, v) => sum + v, 0);
-}
-function indexToA1(idx) {
-    return colNumToA1(idx + 1);
-}
-function A1ToIndex(value) {
-    return A1ToColNum(value) - 1;
-}
-function colNumToA1(columnNumber) {
-    const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
-    // To store result (Excel column name)
-    const charIdxArr = [];
-    while (columnNumber > 0) {
-        // Find remainder
-        const rem = columnNumber % chars.length;
-        // If remainder is 0, then a
-        // 'Z' must be there in output
-        if (rem === 0) {
-            charIdxArr.push(chars.length - 1);
-            columnNumber = Math.floor(columnNumber / chars.length) - 1;
-        }
-        else {
-            // If remainder is non-zero
-            charIdxArr.push(rem - 1);
-            columnNumber = Math.floor(columnNumber / chars.length);
-        }
-    }
-    // Reverse the string and print result
-    return charIdxArr
-        .reverse()
-        .map(n => chars[n])
-        .join('');
-}
-function A1ToColNum(value) {
-    const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
-    let result = 0;
-    // eslint-disable-next-line unicorn/no-for-loop
-    for (let i = 0; i < value.length; i++) {
-        result *= chars.length;
-        result += chars.indexOf(value[i]) + 1;
-    }
-    return result;
-}
-function safeJsonParse(value, fallbackValue) {
-    try {
-        return JSON.parse(value);
-    }
-    catch {
-        return fallbackValue;
-    }
-}
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.timeoutAfter = timeoutAfter;
+exports.delay = delay;
+exports.ms = ms;
+exports.sec = sec;
+exports.indexToA1 = indexToA1;
+exports.A1ToIndex = A1ToIndex;
+exports.colNumToA1 = colNumToA1;
+exports.A1ToColNum = A1ToColNum;
+exports.safeJsonParse = safeJsonParse;
+exports.isStrictlyNumeric = isStrictlyNumeric;
+exports.strictNumber = strictNumber;
+const isString_1 = __importDefault(require("lodash/isString"));
+/**
+ *
+ * @param seconds Google function v1 timeout limit (max: 9 min)
+ */
+async function timeoutAfter(seconds = 540) {
+    return new Promise((resolve, reject) => setTimeout(() => reject(new Error(`${seconds} seconds timeout exceeded`)), seconds * 1000));
+}
+async function delay(seconds) {
+    return new Promise(resolve => setTimeout(() => resolve(), seconds * 1000));
+}
+function ms(o) {
+    return sec(o) * 1000;
+}
+function sec(o) {
+    const multiMap = {};
+    multiMap.s = 1;
+    multiMap.m = multiMap.s * 60;
+    multiMap.h = multiMap.m * 60;
+    multiMap.d = multiMap.h * 24;
+    multiMap.w = multiMap.d * 7;
+    return Object.entries(o)
+        .map(([k, v]) => (multiMap[k] ?? 0) * (v ?? 0))
+        .reduce((sum, v) => sum + v, 0);
+}
+function indexToA1(idx) {
+    return colNumToA1(idx + 1);
+}
+function A1ToIndex(value) {
+    return A1ToColNum(value) - 1;
+}
+function colNumToA1(columnNumber) {
+    const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
+    // To store result (Excel column name)
+    const charIdxArr = [];
+    while (columnNumber > 0) {
+        // Find remainder
+        const rem = columnNumber % chars.length;
+        // If remainder is 0, then a
+        // 'Z' must be there in output
+        if (rem === 0) {
+            charIdxArr.push(chars.length - 1);
+            columnNumber = Math.floor(columnNumber / chars.length) - 1;
+        }
+        else {
+            // If remainder is non-zero
+            charIdxArr.push(rem - 1);
+            columnNumber = Math.floor(columnNumber / chars.length);
+        }
+    }
+    // Reverse the string and print result
+    return charIdxArr
+        .reverse()
+        .map(n => chars[n])
+        .join('');
+}
+function A1ToColNum(value) {
+    const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
+    let result = 0;
+    // eslint-disable-next-line unicorn/no-for-loop
+    for (let i = 0; i < value.length; i++) {
+        result *= chars.length;
+        result += chars.indexOf(value[i]) + 1;
+    }
+    return result;
+}
+function safeJsonParse(value, fallbackValue) {
+    try {
+        return JSON.parse(value);
+    }
+    catch {
+        return fallbackValue;
+    }
+}
+function isStrictlyNumeric(val) {
+    val = '' + val;
+    if ((0, isString_1.default)(val) && val.trim() === '') {
+        return false;
+    }
+    const num = Number(val);
+    return !Number.isNaN(num) && Number.isFinite(num);
+}
+function strictNumber(num) {
+    num = '' + num;
+    if (!isStrictlyNumeric(num)) {
+        return Number.NaN;
+    }
+    return Number(num);
+}

package/src/utils.ts

@@ -1,88 +1,110 @@
-import Dict = NodeJS.Dict;
-
-/**
- *
- * @param seconds Google function v1 timeout limit (max: 9 min)
- */
-export async function timeoutAfter(seconds: number = 540) {
-  return new Promise<void>((resolve, reject) =>
-    setTimeout(() => reject(new Error(`${seconds} seconds timeout exceeded`)), seconds * 1000),
-  );
-}
-
-export async function delay(seconds: number) {
-  return new Promise<void>(resolve => setTimeout(() => resolve(), seconds * 1000));
-}
-
-export function ms(o: { w?: number; d?: number; h?: number; m?: number; s?: number }) {
-  return sec(o) * 1000;
-}
-
-export function sec(o: { w?: number; d?: number; h?: number; m?: number; s?: number }) {
-  const multiMap: any = {};
-  multiMap.s = 1;
-  multiMap.m = multiMap.s * 60;
-  multiMap.h = multiMap.m * 60;
-  multiMap.d = multiMap.h * 24;
-  multiMap.w = multiMap.d * 7;
-
-  return Object.entries(o)
-    .map(([k, v]) => (multiMap[k] ?? 0) * (v ?? 0))
-    .reduce((sum, v) => sum + v, 0);
-}
-
-export function indexToA1(idx: number) {
-  return colNumToA1(idx + 1);
-}
-
-export function A1ToIndex(value: string) {
-  return A1ToColNum(value) - 1;
-}
-
-export function colNumToA1(columnNumber: number) {
-  const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
-
-  // To store result (Excel column name)
-  const charIdxArr: number[] = [];
-
-  while (columnNumber > 0) {
-    // Find remainder
-    const rem = columnNumber % chars.length;
-
-    // If remainder is 0, then a
-    // 'Z' must be there in output
-    if (rem === 0) {
-      charIdxArr.push(chars.length - 1);
-      columnNumber = Math.floor(columnNumber / chars.length) - 1;
-    } else {
-      // If remainder is non-zero
-      charIdxArr.push(rem - 1);
-      columnNumber = Math.floor(columnNumber / chars.length);
-    }
-  }
-
-  // Reverse the string and print result
-  return charIdxArr
-    .reverse()
-    .map(n => chars[n])
-    .join('');
-}
-
-export function A1ToColNum(value: string) {
-  const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
-  let result = 0;
-  // eslint-disable-next-line unicorn/no-for-loop
-  for (let i = 0; i < value.length; i++) {
-    result *= chars.length;
-    result += chars.indexOf(value[i]) + 1;
-  }
-  return result;
-}
-
-export function safeJsonParse<T = Dict<any>>(value: string, fallbackValue?: T) {
-  try {
-    return JSON.parse(value) as T;
-  } catch {
-    return fallbackValue;
-  }
-}
+import Dict = NodeJS.Dict;
+import isString from 'lodash/isString';
+
+/**
+ *
+ * @param seconds Google function v1 timeout limit (max: 9 min)
+ */
+export async function timeoutAfter(seconds: number = 540) {
+  return new Promise<void>((resolve, reject) =>
+    setTimeout(() => reject(new Error(`${seconds} seconds timeout exceeded`)), seconds * 1000),
+  );
+}
+
+export async function delay(seconds: number) {
+  return new Promise<void>(resolve => setTimeout(() => resolve(), seconds * 1000));
+}
+
+export function ms(o: { w?: number; d?: number; h?: number; m?: number; s?: number }) {
+  return sec(o) * 1000;
+}
+
+export function sec(o: { w?: number; d?: number; h?: number; m?: number; s?: number }) {
+  const multiMap: any = {};
+  multiMap.s = 1;
+  multiMap.m = multiMap.s * 60;
+  multiMap.h = multiMap.m * 60;
+  multiMap.d = multiMap.h * 24;
+  multiMap.w = multiMap.d * 7;
+
+  return Object.entries(o)
+    .map(([k, v]) => (multiMap[k] ?? 0) * (v ?? 0))
+    .reduce((sum, v) => sum + v, 0);
+}
+
+export function indexToA1(idx: number) {
+  return colNumToA1(idx + 1);
+}
+
+export function A1ToIndex(value: string) {
+  return A1ToColNum(value) - 1;
+}
+
+export function colNumToA1(columnNumber: number) {
+  const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
+
+  // To store result (Excel column name)
+  const charIdxArr: number[] = [];
+
+  while (columnNumber > 0) {
+    // Find remainder
+    const rem = columnNumber % chars.length;
+
+    // If remainder is 0, then a
+    // 'Z' must be there in output
+    if (rem === 0) {
+      charIdxArr.push(chars.length - 1);
+      columnNumber = Math.floor(columnNumber / chars.length) - 1;
+    } else {
+      // If remainder is non-zero
+      charIdxArr.push(rem - 1);
+      columnNumber = Math.floor(columnNumber / chars.length);
+    }
+  }
+
+  // Reverse the string and print result
+  return charIdxArr
+    .reverse()
+    .map(n => chars[n])
+    .join('');
+}
+
+export function A1ToColNum(value: string) {
+  const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
+  let result = 0;
+  // eslint-disable-next-line unicorn/no-for-loop
+  for (let i = 0; i < value.length; i++) {
+    result *= chars.length;
+    result += chars.indexOf(value[i]) + 1;
+  }
+  return result;
+}
+
+export function safeJsonParse<T = Dict<any>>(value: string, fallbackValue?: T) {
+  try {
+    return JSON.parse(value) as T;
+  } catch {
+    return fallbackValue;
+  }
+}
+
+export function isStrictlyNumeric(val: any) {
+  val = '' + val;
+
+  if (isString(val) && val.trim() === '') {
+    return false;
+  }
+
+  const num = Number(val);
+  return !Number.isNaN(num) && Number.isFinite(num);
+}
+
+export function strictNumber(num: any) {
+  num = '' + num;
+
+  if (!isStrictlyNumeric(num)) {
+    return Number.NaN;
+  }
+
+  return Number(num);
+}

package/test/gcf-common.process.test.js

@@ -0,0 +1,63 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_test_1 = require("node:test");
+const strict_1 = __importDefault(require("node:assert/strict"));
+const src_1 = require("../src");
+(0, node_test_1.describe)('GcfCommon.process (no network I/O)', () => {
+    (0, node_test_1.it)('calls response with handler result on success and returns value', async () => {
+        const payload = {
+            event: {
+                '@type': 'type.googleapis.com/google.pubsub.v1.PubsubMessage',
+                json: { ok: 1 },
+                attributes: {},
+            },
+            context: undefined,
+        };
+        const calls = [];
+        const original = src_1.GcfCommon.response;
+        src_1.GcfCommon.response = async (_p, json, attributes) => {
+            calls.push({ json, attributes });
+        };
+        try {
+            const result = await src_1.GcfCommon.process(payload, async () => ({ result: 42 }));
+            strict_1.default.deepEqual(result, { result: 42 });
+            strict_1.default.equal(calls.length, 1);
+            strict_1.default.deepEqual(calls[0]?.json, { result: 42 });
+            strict_1.default.equal(calls[0]?.attributes, undefined);
+        }
+        finally {
+            src_1.GcfCommon.response = original;
+        }
+    });
+    (0, node_test_1.it)('calls response with buildResponse(error) and rethrows on error', async () => {
+        const payload = {
+            event: {
+                '@type': 'type.googleapis.com/google.pubsub.v1.PubsubMessage',
+                json: { ok: 1 },
+                attributes: {},
+            },
+            context: undefined,
+        };
+        const calls = [];
+        const original = src_1.GcfCommon.response;
+        src_1.GcfCommon.response = async (_p, json, attributes) => {
+            calls.push({ json, attributes });
+        };
+        try {
+            await strict_1.default.rejects(() => src_1.GcfCommon.process(payload, async () => { throw new Error('boom'); }), /boom/);
+            strict_1.default.equal(calls.length, 1);
+            const call = calls[0];
+            strict_1.default.ok(call?.json?.error);
+            strict_1.default.equal(call?.json?.error?.name, 'Error');
+            strict_1.default.match(call?.json?.error?.message ?? '', /^GCF \[/);
+            strict_1.default.match(call?.json?.error?.message ?? '', /boom/);
+            strict_1.default.deepEqual(call?.attributes, { error: '1' });
+        }
+        finally {
+            src_1.GcfCommon.response = original;
+        }
+    });
+});

package/test/gcf-common.process.test.ts

@@ -0,0 +1,65 @@
+import { describe, it } from 'node:test';
+import assert from 'node:assert/strict';
+import { GcfCommon, TPayload, TResponse, TPSEvent } from '../src';
+
+describe('GcfCommon.process (no network I/O)', () => {
+  it('calls response with handler result on success and returns value', async () => {
+    const payload: TPayload<TPSEvent> = {
+      event: {
+        '@type': 'type.googleapis.com/google.pubsub.v1.PubsubMessage',
+        json: { ok: 1 },
+        attributes: {},
+      },
+      context: undefined,
+    };
+
+    const calls: Array<{ json?: TResponse; attributes?: Record<string, any> }> = [];
+    const original = GcfCommon.response;
+    GcfCommon.response = async (_p, json, attributes) => {
+      calls.push({ json, attributes });
+    };
+
+    try {
+      const result = await GcfCommon.process(payload, async () => ({ result: 42 }));
+      assert.deepEqual(result, { result: 42 });
+      assert.equal(calls.length, 1);
+      assert.deepEqual(calls[0]?.json, { result: 42 });
+      assert.equal(calls[0]?.attributes, undefined);
+    } finally {
+      GcfCommon.response = original;
+    }
+  });
+
+  it('calls response with buildResponse(error) and rethrows on error', async () => {
+    const payload: TPayload<TPSEvent> = {
+      event: {
+        '@type': 'type.googleapis.com/google.pubsub.v1.PubsubMessage',
+        json: { ok: 1 },
+        attributes: {},
+      },
+      context: undefined,
+    };
+
+    const calls: Array<{ json?: TResponse; attributes?: Record<string, any> }> = [];
+    const original = GcfCommon.response;
+    GcfCommon.response = async (_p, json, attributes) => {
+      calls.push({ json, attributes });
+    };
+
+    try {
+      await assert.rejects(
+        () => GcfCommon.process(payload, async () => { throw new Error('boom'); }),
+        /boom/,
+      );
+      assert.equal(calls.length, 1);
+      const call = calls[0];
+      assert.ok(call?.json?.error);
+      assert.equal(call?.json?.error?.name, 'Error');
+      assert.match(call?.json?.error?.message ?? '', /^GCF \[/);
+      assert.match(call?.json?.error?.message ?? '', /boom/);
+      assert.deepEqual(call?.attributes, { error: '1' });
+    } finally {
+      GcfCommon.response = original;
+    }
+  });
+});

package/test/metadata.test.js

@@ -0,0 +1,77 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_test_1 = require("node:test");
+const strict_1 = __importDefault(require("node:assert/strict"));
+const src_1 = require("../src");
+(0, node_test_1.describe)('GcfCommon.getMetadataOrAttribute', () => {
+    (0, node_test_1.it)('extracts metadata from GCS finalize event', () => {
+        const event = {
+            bucket: 'b',
+            contentType: 'text/plain',
+            crc32c: 'x',
+            etag: 'e',
+            generation: '1',
+            id: 'id',
+            kind: 'storage#object',
+            md5Hash: 'm',
+            mediaLink: 'ml',
+            metadata: { action: '1', env: 'test' },
+            metageneration: '1',
+            name: 'file.txt',
+            selfLink: 'sl',
+            size: '10',
+            storageClass: 'sc',
+            timeCreated: new Date().toISOString(),
+            timeStorageClassUpdated: new Date().toISOString(),
+            updated: new Date().toISOString(),
+        };
+        const context = {
+            eventId: '1',
+            timestamp: `${Date.now()}`,
+            eventType: 'google.storage.object.finalize',
+            resource: {
+                name: 'file.txt',
+                service: 'storage.googleapis.com',
+                type: 'storage#object',
+            },
+        };
+        const payload = { event, context };
+        const res = src_1.GcfCommon.getMetadataOrAttribute(payload);
+        strict_1.default.deepEqual(res, { a: '1', env: 'test' });
+    });
+    (0, node_test_1.it)('extracts attributes from Pub/Sub event', () => {
+        const event = {
+            '@type': 'type.googleapis.com/google.pubsub.v1.PubsubMessage',
+            json: { ok: 1 },
+            attributes: { action: 'y', request_id: 'r1' },
+        };
+        const context = {
+            eventId: '2',
+            timestamp: `${Date.now()}`,
+            eventType: 'google.pubsub.topic.publish',
+            resource: {
+                name: 'topic',
+                service: 'pubsub.googleapis.com',
+                type: 'type.googleapis.com/google.pubsub.v1.PubsubMessage',
+            },
+        };
+        const payload = { event, context };
+        const res = src_1.GcfCommon.getMetadataOrAttribute(payload);
+        strict_1.default.deepEqual(res, { x: 'y', request_id: 'r1' });
+    });
+    (0, node_test_1.it)('extracts attributes from HTTP-like request body', () => {
+        const payload = {
+            request: { body: { message: { attributes: { foo: 'bar', queue: '' }, data: 'ZGF0YQ==' } } },
+        };
+        const res = src_1.GcfCommon.getMetadataOrAttribute(payload);
+        strict_1.default.deepEqual(res, { foo: 'bar', queue: '' });
+    });
+    (0, node_test_1.it)('returns empty object if no context and no request', () => {
+        const payload = {};
+        const res = src_1.GcfCommon.getMetadataOrAttribute(payload);
+        strict_1.default.deepEqual(res, {});
+    });
+});