gcf-common-lib 0.10.0 → 0.12.1

package/index.js

@@ -8,17 +8,28 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GcfCommon = exports.storage = exports.pubSub = void 0;
 const pubsub_1 = require("@google-cloud/pubsub");
 const secret_manager_1 = require("@google-cloud/secret-manager");
 const storage_1 = require("@google-cloud/storage");
-const lodash_1 = require("lodash");
+const isEmpty_1 = __importDefault(require("lodash/isEmpty"));
+const noop_1 = __importDefault(require("lodash/noop"));
 const utils_1 = require("./utils");
 exports.pubSub = new pubsub_1.PubSub();
 exports.storage = new storage_1.Storage();
 const secretClient = new secret_manager_1.SecretManagerServiceClient();
 class GcfCommon {
+    /**
+     *
+     * @param {!TEvent} event Event payload.
+     * @param {!TContext} context Metadata for the event.
+     * @param handler
+     * @param timeout Seconds
+     */
     static process(event, context, handler, timeout = 535) {
         return __awaiter(this, void 0, void 0, function* () {
             return Promise.race([
@@ -26,6 +37,7 @@ class GcfCommon {
                 handler(event, context),
             ])
                 .then((res) => __awaiter(this, void 0, void 0, function* () {
+                // console.log('res:', res);
                 yield this.publish(event, context, res !== null && res !== void 0 ? res : {});
             }))
                 .catch((err) => __awaiter(this, void 0, void 0, function* () {
@@ -38,7 +50,7 @@ class GcfCommon {
                         stack: err.stack,
                     },
                 };
-                yield this.publish(event, context, response).catch(lodash_1.noop);
+                yield this.publish(event, context, response).catch(noop_1.default);
                 throw err;
             }));
         });
@@ -52,16 +64,25 @@ class GcfCommon {
         });
     }
     static getTopic(event, context) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
-            let topicName = (_a = event === null || event === void 0 ? void 0 : event.metadata) === null || _a === void 0 ? void 0 : _a.topic;
-            if (!topicName && ((_b = context === null || context === void 0 ? void 0 : context.resource) === null || _b === void 0 ? void 0 : _b.type) === 'storage#object') {
-                const file = exports.storage.bucket(event.bucket).file(event.name);
-                const [meta] = yield file.getMetadata();
-                topicName = (_c = meta === null || meta === void 0 ? void 0 : meta.metadata) === null || _c === void 0 ? void 0 : _c.topic;
-                console.log('topic:', topicName);
+            /** t_{GUID}__{YYYY-MM-DD} */
+            let topicName;
+            if ((context === null || context === void 0 ? void 0 : context.eventType) === 'google.storage.object.finalize') {
+                const gsEvent = event;
+                topicName = (_a = gsEvent === null || gsEvent === void 0 ? void 0 : gsEvent.metadata) === null || _a === void 0 ? void 0 : _a.topic;
+                if (!topicName && ((_b = context === null || context === void 0 ? void 0 : context.resource) === null || _b === void 0 ? void 0 : _b.type) === 'storage#object') {
+                    const file = exports.storage.bucket(gsEvent.bucket).file(gsEvent.name);
+                    const [meta] = yield file.getMetadata();
+                    topicName = (_c = meta === null || meta === void 0 ? void 0 : meta.metadata) === null || _c === void 0 ? void 0 : _c.topic;
+                    console.log('topic:', topicName);
+                }
+            }
+            else if ((context === null || context === void 0 ? void 0 : context.eventType) === 'google.pubsub.topic.publish') {
+                const psEvent = event;
+                topicName = (_d = psEvent.data) === null || _d === void 0 ? void 0 : _d.topic;
             }
-            if (topicName && !(0, lodash_1.isEmpty)(topicName)) {
+            if (topicName && !(0, isEmpty_1.default)(topicName)) {
                 const topic = exports.pubSub.topic(topicName);
                 yield topic.setMetadata({ labels: { date: topicName.split('__')[1] } });
                 return topic;

package/index.ts

@@ -1,10 +1,11 @@
 import {PubSub} from "@google-cloud/pubsub";
 import {SecretManagerServiceClient} from "@google-cloud/secret-manager";
 import {File, Storage} from "@google-cloud/storage";
-import {isEmpty, noop} from 'lodash';
+import isEmpty from "lodash/isEmpty";
+import noop from "lodash/noop";
 import {timeoutAfter} from "./utils";
 
-export type TEvent = {
+export type TGSEvent = {
     bucket: string;
     contentType: string;
     crc32c: string;
@@ -25,14 +26,22 @@ export type TEvent = {
     updated: string;
 }
 
+export type TPSEvent = {
+    '@type': string; // 'type.googleapis.com/google.pubsub.v1.PubsubMessage'
+    attributes?: string | null;
+    data: string | { [k: string]: any };
+}
+
+export type TEvent = TGSEvent | TPSEvent;
+
 export type TContext = {
     eventId: string;
     timestamp: string;
-    eventType: string; // 'google.storage.object.finalize'
+    eventType: 'google.storage.object.finalize' | 'google.pubsub.topic.publish';
     resource: {
-        service: string; // 'storage.googleapis.com'
+        service: 'storage.googleapis.com' | 'pubsub.googleapis.com';
         name: string;
-        type: string; // 'storage#object'
+        type: string; // 'storage#object' | 'type.googleapis.com/google.pubsub.v1.PubsubMessage'
     }
 }
 
@@ -95,13 +104,22 @@ export class GcfCommon {
     static async getTopic(event: TEvent, context: TContext) {
 
         /** t_{GUID}__{YYYY-MM-DD} */
-        let topicName: string | undefined = event?.metadata?.topic;
+        let topicName: string | undefined;
 
-        if (!topicName && context?.resource?.type === 'storage#object') {
-            const file: File = storage.bucket(event.bucket).file(event.name);
-            const [meta] = await file.getMetadata();
-            topicName = meta?.metadata?.topic;
-            console.log('topic:', topicName);
+        if (context?.eventType === 'google.storage.object.finalize') {
+            const gsEvent = event as TGSEvent;
+
+            topicName = gsEvent?.metadata?.topic;
+
+            if (!topicName && context?.resource?.type === 'storage#object') {
+                const file: File = storage.bucket(gsEvent.bucket).file(gsEvent.name);
+                const [meta] = await file.getMetadata();
+                topicName = meta?.metadata?.topic;
+                console.log('topic:', topicName);
+            }
+        } else if (context?.eventType === 'google.pubsub.topic.publish') {
+            const psEvent = event as TPSEvent;
+            topicName = (psEvent.data as any)?.topic;
         }
 
         if (topicName && !isEmpty(topicName)) {
@@ -111,7 +129,7 @@ export class GcfCommon {
         }
     }
 
-    static async getOptions(event: TEvent, context: TContext) {
+    static async getOptions(event: TGSEvent, context: TContext) {
         if (event?.metadata?.options) {
             return JSON.parse(event?.metadata?.options ?? '{}');
         } else {

package/package.json

@@ -1,14 +1,17 @@
 {
   "name": "gcf-common-lib",
   "description": "",
-  "version": "0.10.0",
+  "version": "0.12.1",
   "publishConfig": {
     "access": "public",
     "branches": [
       "master"
     ]
   },
-  "engines": {},
+  "engines": {
+    "node": "14",
+    "npm": "8"
+  },
   "scripts": {
     "test": "echo \"Error: no test specified\" || exit 0"
   },
@@ -17,16 +20,15 @@
     "url": "https://github.com/TopTechnologies/gcf-common.git"
   },
   "dependencies": {
-    "@google-cloud/pubsub": "^2.18.5",
-    "@google-cloud/secret-manager": "^3.10.1",
-    "@google-cloud/storage": "^5.18.0",
+    "@google-cloud/pubsub": "^2.19.0",
+    "@google-cloud/secret-manager": "^3.11.0",
+    "@google-cloud/storage": "^5.18.2",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
     "@tsconfig/node14": "^1.0.1",
-    "@types/lodash": "^4.14.178"
+    "@types/lodash": "^4.14.179"
   },
-  "keywords": [],
   "author": "alert83@gmail.com",
   "license": "MIT"
 }

package/tsconfig.json

@@ -2,28 +2,15 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "@tsconfig/node14/tsconfig.json",
   "compilerOptions": {
-    "allowJs": false,
-    "removeComments": true,
-    "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "isolatedModules": false,
-    "emitDecoratorMetadata": true,
-    "experimentalDecorators": true,
-    "module": "commonjs",
     "moduleResolution": "node",
     "target": "ES6",
-    "typeRoots": [
-      "node_modules/@types"
-    ],
     "lib": [
       "ES2018",
       "ES2019",
       "ES2020",
       "ES2021",
       "ESNext"
-    ],
-    "types": [],
-    "plugins": []
+    ]
   },
   "exclude": [
     "node_modules/**",

package/utils.js

@@ -10,6 +10,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.A1ToColNum = exports.A1ToIndex = exports.colNumToA1 = exports.indexToA1 = exports.timeoutAfter = void 0;
+/**
+ *
+ * @param seconds Google function timeout limit (max: 9 min)
+ */
 function timeoutAfter(seconds = 540) {
     return __awaiter(this, void 0, void 0, function* () {
         return new Promise((resolve, reject) => {
@@ -20,24 +24,30 @@ function timeoutAfter(seconds = 540) {
     });
 }
 exports.timeoutAfter = timeoutAfter;
+//
 function indexToA1(idx) {
     return colNumToA1(idx + 1);
 }
 exports.indexToA1 = indexToA1;
 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 {
+        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('');
 }
 exports.colNumToA1 = colNumToA1;
@@ -48,6 +58,7 @@ exports.A1ToIndex = A1ToIndex;
 function A1ToColNum(value) {
     const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
     let result = 0;
+    // tslint:disable-next-line:prefer-for-of
     for (let i = 0; i < value.length; i++) {
         result *= chars.length;
         result += chars.indexOf(value[i]) + 1;