gcf-common-lib 0.35.0 → 0.36.0

package/test/metadata.test.ts

@@ -0,0 +1,78 @@
+import { describe, it } from 'node:test';
+import assert from 'node:assert/strict';
+import { GcfCommon, TGSEvent, TPayload, TContext, TPSEvent } from '../src';
+
+describe('GcfCommon.getMetadataOrAttribute', () => {
+  it('extracts metadata from GCS finalize event', () => {
+    const event: TGSEvent = {
+      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: TContext = {
+      eventId: '1',
+      timestamp: `${Date.now()}`,
+      eventType: 'google.storage.object.finalize',
+      resource: {
+        name: 'file.txt',
+        service: 'storage.googleapis.com',
+        type: 'storage#object',
+      },
+    };
+
+    const payload: TPayload<TGSEvent> = { event, context };
+    const res = GcfCommon.getMetadataOrAttribute(payload);
+    assert.deepEqual(res, { a: '1', env: 'test' });
+  });
+
+  it('extracts attributes from Pub/Sub event', () => {
+    const event: TPSEvent = {
+      '@type': 'type.googleapis.com/google.pubsub.v1.PubsubMessage',
+      json: { ok: 1 },
+      attributes: { action: 'y', request_id: 'r1' },
+    };
+    const context: TContext = {
+      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: TPayload<TPSEvent> = { event, context };
+    const res = GcfCommon.getMetadataOrAttribute(payload);
+    assert.deepEqual(res, { x: 'y', request_id: 'r1' });
+  });
+
+  it('extracts attributes from HTTP-like request body', () => {
+    const payload: TPayload = {
+      request: { body: { message: { attributes: { foo: 'bar', queue: '' }, data: 'ZGF0YQ==' } } } as any,
+    };
+    const res = GcfCommon.getMetadataOrAttribute(payload);
+    assert.deepEqual(res, { foo: 'bar', queue: '' });
+  });
+
+  it('returns empty object if no context and no request', () => {
+    const payload: TPayload = {};
+    const res = GcfCommon.getMetadataOrAttribute(payload);
+    assert.deepEqual(res, {});
+  });
+});

package/test/sample.test.js

@@ -0,0 +1,12 @@
+const { describe, it } = require('node:test');
+const assert = require('node:assert/strict');
+
+describe('sample', () => {
+  it('adds numbers', () => {
+    assert.equal(1 + 1, 2);
+  });
+  it('async works', async () => {
+    const v = await Promise.resolve('ok');
+    assert.equal(v, 'ok');
+  });
+});

package/test/test.js

@@ -1,25 +1,30 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const node_test_1 = require("node:test");
-const src_1 = require("../src");
-(0, node_test_1.describe)('test', () => {
-    const event = {
-        '@type': 'type.googleapis.com/google.pubsub.v1.PubsubMessage',
-        json: { foo: 'bar' },
-        attributes: { topic: 'test', env: 'test', options: '{}' },
-    };
-    const context = {
-        eventId: '1',
-        timestamp: `${Date.now()}`,
-        eventType: 'google.pubsub.topic.publish',
-        resource: {
-            name: 'test',
-            service: 'pubsub.googleapis.com',
-            type: 'type.googleapis.com/google.pubsub.v1.PubsubMessage',
-        },
-    };
-    (0, node_test_1.it)('test', async () => {
-        const res = await src_1.GcfCommon.process({ event, context }, async (p) => p.event?.data);
-        console.log(res);
-    });
-});
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_test_1 = require("node:test");
+const src_1 = require("../src");
+(0, node_test_1.describe)('test', () => {
+    const INTEGRATION_PUBSUB = process.env.INTEGRATION_PUBSUB === '1';
+    const event = {
+        '@type': 'type.googleapis.com/google.pubsub.v1.PubsubMessage',
+        json: { foo: 'bar' },
+        attributes: {
+            ...(INTEGRATION_PUBSUB ? { topic: 'test' } : {}),
+            env: 'test',
+            options: '{}',
+        },
+    };
+    const context = {
+        eventId: '1',
+        timestamp: `${Date.now()}`,
+        eventType: 'google.pubsub.topic.publish',
+        resource: {
+            name: 'test',
+            service: 'pubsub.googleapis.com',
+            type: 'type.googleapis.com/google.pubsub.v1.PubsubMessage',
+        },
+    };
+    (0, node_test_1.it)('test', async () => {
+        const res = await src_1.GcfCommon.process({ event, context }, async (p) => p.event?.data);
+        console.log(res);
+    });
+});

package/test/test.ts

@@ -1,26 +1,32 @@
-import { describe, it } from 'node:test';
-import { GcfCommon, TContext, TEvent } from '../src';
-
-describe('test', () => {
-  const event: TEvent = {
-    '@type': 'type.googleapis.com/google.pubsub.v1.PubsubMessage',
-    json: { foo: 'bar' },
-    attributes: { topic: 'test', env: 'test', options: '{}' },
-  };
-
-  const context: TContext = {
-    eventId: '1',
-    timestamp: `${Date.now()}`,
-    eventType: 'google.pubsub.topic.publish',
-    resource: {
-      name: 'test',
-      service: 'pubsub.googleapis.com',
-      type: 'type.googleapis.com/google.pubsub.v1.PubsubMessage',
-    },
-  };
-
-  it('test', async () => {
-    const res = await GcfCommon.process({ event, context }, async p => p.event?.data);
-    console.log(res);
-  });
-});
+import { describe, it } from 'node:test';
+import { GcfCommon, TContext, TEvent } from '../src';
+
+describe('test', () => {
+  const INTEGRATION_PUBSUB = process.env.INTEGRATION_PUBSUB === '1';
+
+  const event: TEvent = {
+    '@type': 'type.googleapis.com/google.pubsub.v1.PubsubMessage',
+    json: { foo: 'bar' },
+    attributes: {
+      ...(INTEGRATION_PUBSUB ? { topic: 'test' } : {}),
+      env: 'test',
+      options: '{}',
+    },
+  };
+
+  const context: TContext = {
+    eventId: '1',
+    timestamp: `${Date.now()}`,
+    eventType: 'google.pubsub.topic.publish',
+    resource: {
+      name: 'test',
+      service: 'pubsub.googleapis.com',
+      type: 'type.googleapis.com/google.pubsub.v1.PubsubMessage',
+    },
+  };
+
+  it('test', async () => {
+    const res = await GcfCommon.process({ event, context }, async p => p.event?.data);
+    console.log(res);
+  });
+});

package/test/ts-tests.test.js

@@ -0,0 +1,8 @@
+import { describe, it } from 'node:test';
+import assert from 'node:assert/strict';
+
+describe('ts tests harness noop', () => {
+  it('runs', () => {
+    assert.equal(1, 1);
+  });
+});

package/test/utils.test.js

@@ -0,0 +1,43 @@
+"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)('utils', () => {
+    (0, node_test_1.it)('sec and ms calculations', () => {
+        strict_1.default.equal((0, src_1.sec)({ s: 30 }), 30);
+        strict_1.default.equal((0, src_1.sec)({ m: 1 }), 60);
+        strict_1.default.equal((0, src_1.sec)({ m: 1, s: 30 }), 90);
+        strict_1.default.equal((0, src_1.sec)({ h: 1 }), 60 * 60);
+        strict_1.default.equal((0, src_1.sec)({ d: 1 }), 24 * 60 * 60);
+        strict_1.default.equal((0, src_1.sec)({ w: 1 }), 7 * 24 * 60 * 60);
+        strict_1.default.equal((0, src_1.ms)({ s: 1 }), 1e3);
+        strict_1.default.equal((0, src_1.ms)({ m: 1, s: 30 }), 90 * 1e3);
+    });
+    (0, node_test_1.it)('A1 conversions (index/colNum <-> A1)', () => {
+        strict_1.default.equal((0, src_1.indexToA1)(0), 'A');
+        strict_1.default.equal((0, src_1.indexToA1)(25), 'Z');
+        strict_1.default.equal((0, src_1.indexToA1)(26), 'AA');
+        strict_1.default.equal((0, src_1.A1ToIndex)('A'), 0);
+        strict_1.default.equal((0, src_1.A1ToIndex)('Z'), 25);
+        strict_1.default.equal((0, src_1.A1ToIndex)('AA'), 26);
+        strict_1.default.equal((0, src_1.colNumToA1)(1), 'A');
+        strict_1.default.equal((0, src_1.colNumToA1)(26), 'Z');
+        strict_1.default.equal((0, src_1.colNumToA1)(27), 'AA');
+        strict_1.default.equal((0, src_1.A1ToColNum)('A'), 1);
+        strict_1.default.equal((0, src_1.A1ToColNum)('Z'), 26);
+        strict_1.default.equal((0, src_1.A1ToColNum)('AA'), 27);
+    });
+    (0, node_test_1.it)('safeJsonParse handles valid, invalid, and no-fallback cases', () => {
+        const parsed = (0, src_1.safeJsonParse)('{"a":1}', {});
+        strict_1.default.deepEqual(parsed, { a: 1 });
+        const fallback = { ok: true };
+        const invalid = (0, src_1.safeJsonParse)('not-json', fallback);
+        strict_1.default.equal(invalid, fallback);
+        const noFallback = (0, src_1.safeJsonParse)('not-json');
+        strict_1.default.equal(noFallback, undefined);
+    });
+});

package/test/utils.test.ts

@@ -0,0 +1,47 @@
+import { describe, it } from 'node:test';
+import assert from 'node:assert/strict';
+import { ms, sec, indexToA1, A1ToIndex, colNumToA1, A1ToColNum, safeJsonParse } from '../src';
+
+describe('utils', () => {
+  it('sec and ms calculations', () => {
+    assert.equal(sec({ s: 30 }), 30);
+    assert.equal(sec({ m: 1 }), 60);
+    assert.equal(sec({ m: 1, s: 30 }), 90);
+    assert.equal(sec({ h: 1 }), 60 * 60);
+    assert.equal(sec({ d: 1 }), 24 * 60 * 60);
+    assert.equal(sec({ w: 1 }), 7 * 24 * 60 * 60);
+
+    assert.equal(ms({ s: 1 }), 1e3);
+    assert.equal(ms({ m: 1, s: 30 }), 90 * 1e3);
+  });
+
+  it('A1 conversions (index/colNum <-> A1)', () => {
+    assert.equal(indexToA1(0), 'A');
+    assert.equal(indexToA1(25), 'Z');
+    assert.equal(indexToA1(26), 'AA');
+
+    assert.equal(A1ToIndex('A'), 0);
+    assert.equal(A1ToIndex('Z'), 25);
+    assert.equal(A1ToIndex('AA'), 26);
+
+    assert.equal(colNumToA1(1), 'A');
+    assert.equal(colNumToA1(26), 'Z');
+    assert.equal(colNumToA1(27), 'AA');
+
+    assert.equal(A1ToColNum('A'), 1);
+    assert.equal(A1ToColNum('Z'), 26);
+    assert.equal(A1ToColNum('AA'), 27);
+  });
+
+  it('safeJsonParse handles valid, invalid, and no-fallback cases', () => {
+    const parsed = safeJsonParse('{"a":1}', {} as any);
+    assert.deepEqual(parsed, { a: 1 });
+
+    const fallback = { ok: true } as const;
+    const invalid = safeJsonParse('not-json', fallback);
+    assert.equal(invalid, fallback);
+
+    const noFallback = safeJsonParse('not-json');
+    assert.equal(noFallback, undefined);
+  });
+});

package/tsconfig.json

@@ -1,7 +1,7 @@
-{
-  "$schema": "http://json.schemastore.org/tsconfig",
-  "extends": "@tsconfig/node20/tsconfig.json",
-  "compilerOptions": {
-    "newLine": "crlf",
-  }
-}
+{
+  "$schema": "http://json.schemastore.org/tsconfig",
+  "extends": "@tsconfig/node20/tsconfig.json",
+  "compilerOptions": {
+    "newLine": "crlf",
+  }
+}

package/src/amqp-helper.js

@@ -1,44 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AmqpHelper = void 0;
-const amqplib_1 = require("amqplib");
-const bluebird_1 = __importDefault(require("bluebird"));
-exports.AmqpHelper = {
-    async withAmqpConn(fn, url) {
-        function withDisposer() {
-            return bluebird_1.default.method(async () => {
-                const amqpConn = await (0, amqplib_1.connect)(url);
-                amqpConn.on('close', () => console.info('Amqp connection closed!'));
-                return amqpConn;
-            })().disposer((channelModel, promise) => channelModel.close());
-        }
-        return bluebird_1.default.using(withDisposer(), channelModel => fn(channelModel));
-    },
-    async withAmqpCh(fn, url, useConfirmChannel = false, prefetch = 1) {
-        return exports.AmqpHelper.withAmqpConn(async (channelModel) => {
-            function withDisposer() {
-                return bluebird_1.default.method(async () => {
-                    const ch = useConfirmChannel ? await channelModel.createConfirmChannel() : await channelModel.createChannel();
-                    await ch.prefetch(prefetch);
-                    return ch;
-                })().disposer((ch, promise) => ch.close());
-            }
-            return bluebird_1.default.using(withDisposer(), ch => fn(ch));
-        }, url);
-    },
-    async publishAmqp(ch, exchange, routingKey, json, options) {
-        const payload = Buffer.from(JSON.stringify(json));
-        const keepSending = exchange
-            ? ch.publish(exchange, routingKey, payload, options)
-            : ch.sendToQueue(routingKey, payload, options);
-        if (!keepSending)
-            await new Promise(resolve => ch.once('drain', () => resolve()));
-    },
-    async sendToQueueConfAmqp(ch, queue, json, options) {
-        const payload = Buffer.from(JSON.stringify(json));
-        await new Promise((resolve, reject) => ch.sendToQueue(queue, payload, options, (err, ok) => (err ? reject(err) : resolve(ok))));
-    },
-};