gcf-common-lib 0.7.0 → 0.8.0

package/index.js

@@ -36,17 +36,20 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GcfCommon = void 0;
+exports.GcfCommon = exports.storage = exports.pubSub = void 0;
+var lodash_1 = require("lodash");
 var storage_1 = require("@google-cloud/storage");
 var pubsub_1 = require("@google-cloud/pubsub");
-var lodash_1 = require("lodash");
+var utils_1 = require("./utils");
+exports.pubSub = new pubsub_1.PubSub();
+exports.storage = new storage_1.Storage();
 var GcfCommon = /** @class */ (function () {
     function GcfCommon() {
     }
     /**
      *
-     * @param {!Object} event Event payload.
-     * @param {!Object} context Metadata for the event.
+     * @param {!TEvent} event Event payload.
+     * @param {!TContext} context Metadata for the event.
      * @param handler
      * @param timeout Seconds
      */
@@ -56,7 +59,7 @@ var GcfCommon = /** @class */ (function () {
             var _this = this;
             return __generator(this, function (_a) {
                 return [2 /*return*/, Promise.race([
-                        this.delay(535),
+                        (0, utils_1.timeoutAfter)(timeout),
                         handler(event, context),
                     ])
                         .then(function (res) { return __awaiter(_this, void 0, void 0, function () {
@@ -73,14 +76,20 @@ var GcfCommon = /** @class */ (function () {
                         });
                     }); })
                         .catch(function (err) { return __awaiter(_this, void 0, void 0, function () {
-                        var fname, dataJSON;
+                        var fname, response;
                         var _a, _b;
                         return __generator(this, function (_c) {
                             switch (_c.label) {
                                 case 0:
                                     fname = (_b = (_a = process === null || process === void 0 ? void 0 : process.env) === null || _a === void 0 ? void 0 : _a.K_SERVICE) !== null && _b !== void 0 ? _b : 'UNKNOWN';
-                                    dataJSON = { error: { name: err.name, message: "GCF [" + fname + "]: " + err.message, stack: err.stack } };
-                                    return [4 /*yield*/, this.publish(event, context, dataJSON).catch(lodash_1.noop)];
+                                    response = {
+                                        error: {
+                                            name: err.name,
+                                            message: "GCF [" + fname + "]: " + err.message,
+                                            stack: err.stack,
+                                        },
+                                    };
+                                    return [4 /*yield*/, this.publish(event, context, response).catch(lodash_1.noop)];
                                 case 1:
                                     _c.sent();
                                     throw err;
@@ -90,12 +99,6 @@ var GcfCommon = /** @class */ (function () {
             });
         });
     };
-    /**
-     *
-     * @param {!Object} event Event payload.
-     * @param {!Object} context Metadata for the event.
-     * @param json
-     */
     GcfCommon.publish = function (event, context, json) {
         return __awaiter(this, void 0, void 0, function () {
             var topic;
@@ -113,23 +116,16 @@ var GcfCommon = /** @class */ (function () {
             });
         });
     };
-    /**
-     *
-     * @param {!Object} event Event payload.
-     * @param {!Object} context Metadata for the event.
-     */
     GcfCommon.getTopic = function (event, context) {
         var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function () {
-            var pubSub, topicName, storage, file, meta, topic;
+            var topicName, file, meta, topic;
             return __generator(this, function (_d) {
                 switch (_d.label) {
                     case 0:
-                        pubSub = new pubsub_1.PubSub();
                         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')) return [3 /*break*/, 2];
-                        storage = new storage_1.Storage();
-                        file = storage.bucket(event.bucket).file(event.name);
+                        file = exports.storage.bucket(event.bucket).file(event.name);
                         return [4 /*yield*/, file.getMetadata()];
                     case 1:
                         meta = (_d.sent())[0];
@@ -138,7 +134,7 @@ var GcfCommon = /** @class */ (function () {
                         _d.label = 2;
                     case 2:
                         if (!!(0, lodash_1.isEmpty)(topicName)) return [3 /*break*/, 4];
-                        topic = pubSub.topic(topicName);
+                        topic = exports.pubSub.topic(topicName);
                         return [4 /*yield*/, topic.setMetadata({ labels: { date: topicName.split('__')[1] } })];
                     case 3:
                         _d.sent();
@@ -148,23 +144,17 @@ var GcfCommon = /** @class */ (function () {
             });
         });
     };
-    /**
-     *
-     * @param {!Object} event Event payload.
-     * @param {!Object} context Metadata for the event.
-     */
     GcfCommon.getOptions = function (event, context) {
         var _a, _b, _c, _d, _e;
         return __awaiter(this, void 0, void 0, function () {
-            var storage, file, meta;
+            var file, meta;
             return __generator(this, function (_f) {
                 switch (_f.label) {
                     case 0:
                         if (!((_a = event === null || event === void 0 ? void 0 : event.metadata) === null || _a === void 0 ? void 0 : _a.options)) return [3 /*break*/, 1];
                         return [2 /*return*/, JSON.parse((_c = (_b = event === null || event === void 0 ? void 0 : event.metadata) === null || _b === void 0 ? void 0 : _b.options) !== null && _c !== void 0 ? _c : '{}')];
                     case 1:
-                        storage = new storage_1.Storage();
-                        file = storage.bucket(event.bucket).file(event.name);
+                        file = exports.storage.bucket(event.bucket).file(event.name);
                         return [4 /*yield*/, file.getMetadata()];
                     case 2:
                         meta = (_f.sent())[0];
@@ -173,60 +163,6 @@ var GcfCommon = /** @class */ (function () {
             });
         });
     };
-    /**
-     *
-     * @param s Google function time limit (max: 9 min)
-     */
-    GcfCommon.delay = function (s) {
-        if (s === void 0) { s = 540; }
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                return [2 /*return*/, new Promise(function (resolve, reject) {
-                        setTimeout(function () {
-                            reject(new Error(s + " seconds timeout exceeded"));
-                        }, s * 1000);
-                    })];
-            });
-        });
-    };
-    //
-    GcfCommon.indexToA1 = function (idx) {
-        return this.colNumToA1(idx + 1);
-    };
-    GcfCommon.colNumToA1 = function (columnNumber) {
-        var chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
-        // To store result (Excel column name)
-        var charIdxArr = [];
-        while (columnNumber > 0) {
-            // Find remainder
-            var 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(function (n) { return chars[n]; }).join('');
-    };
-    GcfCommon.A1ToIndex = function (value) {
-        return this.A1ToColNum(value) - 1;
-    };
-    GcfCommon.A1ToColNum = function (value) {
-        var chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
-        var result = 0;
-        // tslint:disable-next-line:prefer-for-of
-        for (var i = 0; i < value.length; i++) {
-            result *= chars.length;
-            result += chars.indexOf(value[i]) + 1;
-        }
-        return result;
-    };
     return GcfCommon;
 }());
 exports.GcfCommon = GcfCommon;

package/index.ts

@@ -1,19 +1,68 @@
-import {File, Storage} from '@google-cloud/storage';
-import {PubSub, Topic} from '@google-cloud/pubsub';
 import {isEmpty, noop} from 'lodash';
+import {File, Storage} from "@google-cloud/storage";
+import {PubSub} from "@google-cloud/pubsub";
+import {timeoutAfter} from "./utils";
+
+export type TEvent = {
+    bucket: string;
+    contentType: string;
+    crc32c: string;
+    etag: string;
+    generation: string;
+    id: string;
+    kind: string; // 'storage#object'
+    md5Hash: string;
+    mediaLink: string;
+    metadata: { [key: string]: string, topic: string, options?: any };
+    metageneration: string;
+    name: string;
+    selfLink: string;
+    size: string;
+    storageClass: string;
+    timeCreated: string;
+    timeStorageClassUpdated: string;
+    updated: string;
+}
+
+export type TContext = {
+    eventId: string;
+    timestamp: string;
+    eventType: string; // 'google.storage.object.finalize'
+    resource: {
+        service: string; // 'storage.googleapis.com'
+        name: string;
+        type: string; // 'storage#object'
+    }
+}
+
+export type TResponse = {
+    error?: {
+        name: string,
+        message: string,
+        stack: string,
+    }
+}
+
+export const pubSub = new PubSub();
+export const storage = new Storage();
 
 export class GcfCommon {
 
     /**
      *
-     * @param {!Object} event Event payload.
-     * @param {!Object} context Metadata for the event.
+     * @param {!TEvent} event Event payload.
+     * @param {!TContext} context Metadata for the event.
      * @param handler
      * @param timeout Seconds
      */
-    static async process(event, context, handler: (event, context) => Promise<any>, timeout = 535) {
+    static async process<T>(
+        event: TEvent,
+        context: TContext,
+        handler: (event: TEvent, context: TContext) => Promise<T>,
+        timeout = 535,
+    ) {
         return Promise.race([
-            this.delay(535),
+            timeoutAfter(timeout),
             handler(event, context),
         ])
             .then(async (res: any) => {
@@ -22,38 +71,31 @@ export class GcfCommon {
             })
             .catch(async (err: Error) => {
                 const fname = process?.env?.K_SERVICE ?? 'UNKNOWN';
-                const dataJSON = {error: {name: err.name, message: `GCF [${fname}]: ${err.message}`, stack: err.stack}};
-                await this.publish(event, context, dataJSON).catch(noop);
+                const response: TResponse = {
+                    error: {
+                        name: err.name,
+                        message: `GCF [${fname}]: ${err.message}`,
+                        stack: err.stack,
+                    },
+                };
+                await this.publish(event, context, response).catch(noop);
                 throw err;
             })
             ;
     }
 
-    /**
-     *
-     * @param {!Object} event Event payload.
-     * @param {!Object} context Metadata for the event.
-     * @param json
-     */
-    static async publish(event, context, json) {
+    static async publish(event: TEvent, context: TContext, json: TResponse) {
         const topic = await this.getTopic(event, context);
         console.log('publish:', topic?.name, json);
         if (topic) return await topic.publishMessage({json});
     }
 
-    /**
-     *
-     * @param {!Object} event Event payload.
-     * @param {!Object} context Metadata for the event.
-     */
-    static async getTopic(event, context): Promise<Topic | undefined> {
-        const pubSub = new PubSub();
+    static async getTopic(event: TEvent, context: TContext) {
 
         /** t_{GUID}__{YYYY-MM-DD} */
         let topicName: string | undefined = event?.metadata?.topic;
 
         if (!topicName && context?.resource?.type === 'storage#object') {
-            const storage = new Storage();
             const file: File = storage.bucket(event.bucket).file(event.name);
             const [meta] = await file.getMetadata();
             topicName = meta?.metadata?.topic;
@@ -67,77 +109,13 @@ export class GcfCommon {
         }
     }
 
-    /**
-     *
-     * @param {!Object} event Event payload.
-     * @param {!Object} context Metadata for the event.
-     */
-    static async getOptions(event, context) {
+    static async getOptions(event: TEvent, context: TContext) {
         if (event?.metadata?.options) {
             return JSON.parse(event?.metadata?.options ?? '{}');
         } else {
-            const storage = new Storage();
             const file: File = storage.bucket(event.bucket).file(event.name);
             const [meta] = await file.getMetadata();
             return JSON.parse(meta?.metadata?.options ?? '{}');
         }
     }
-
-    /**
-     *
-     * @param s Google function time limit (max: 9 min)
-     */
-    static async delay(s: number = 540) {
-        return new Promise<undefined>((resolve, reject) => {
-            setTimeout(() => {
-                reject(new Error(`${s} seconds timeout exceeded`));
-            }, s * 1000);
-        });
-    }
-
-    //
-
-    static indexToA1(idx: number) {
-        return this.colNumToA1(idx + 1);
-    }
-
-    static 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('');
-    }
-
-    static A1ToIndex(value: string) {
-        return this.A1ToColNum(value) - 1;
-    }
-
-    static A1ToColNum(value: string) {
-        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;
-        }
-        return result;
-    }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gcf-common-lib",
   "description": "",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "publishConfig": {
     "access": "public",
     "branches": [

package/utils.js

@@ -0,0 +1,114 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+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) {
+    if (seconds === void 0) { seconds = 540; }
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            return [2 /*return*/, new Promise(function (resolve, reject) {
+                    setTimeout(function () {
+                        reject(new Error(seconds + " seconds timeout exceeded"));
+                    }, seconds * 1000);
+                })];
+        });
+    });
+}
+exports.timeoutAfter = timeoutAfter;
+//
+function indexToA1(idx) {
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            return [2 /*return*/, this.colNumToA1(idx + 1)];
+        });
+    });
+}
+exports.indexToA1 = indexToA1;
+function colNumToA1(columnNumber) {
+    return __awaiter(this, void 0, void 0, function () {
+        var chars, charIdxArr, rem;
+        return __generator(this, function (_a) {
+            chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
+            charIdxArr = [];
+            while (columnNumber > 0) {
+                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 [2 /*return*/, charIdxArr.reverse().map(function (n) { return chars[n]; }).join('')];
+        });
+    });
+}
+exports.colNumToA1 = colNumToA1;
+function A1ToIndex(value) {
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            return [2 /*return*/, this.A1ToColNum(value) - 1];
+        });
+    });
+}
+exports.A1ToIndex = A1ToIndex;
+function A1ToColNum(value) {
+    return __awaiter(this, void 0, void 0, function () {
+        var chars, result, i;
+        return __generator(this, function (_a) {
+            chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
+            result = 0;
+            // tslint:disable-next-line:prefer-for-of
+            for (i = 0; i < value.length; i++) {
+                result *= chars.length;
+                result += chars.indexOf(value[i]) + 1;
+            }
+            return [2 /*return*/, result];
+        });
+    });
+}
+exports.A1ToColNum = A1ToColNum;

package/utils.ts

@@ -0,0 +1,57 @@
+/**
+ *
+ * @param seconds Google function timeout limit (max: 9 min)
+ */
+export async function timeoutAfter(seconds: number = 540) {
+    return new Promise<undefined>((resolve, reject) => {
+        setTimeout(() => {
+            reject(new Error(`${seconds} seconds timeout exceeded`));
+        }, seconds * 1000);
+    });
+}
+
+//
+
+export async function indexToA1(idx: number) {
+    return this.colNumToA1(idx + 1);
+}
+
+export async 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 async function A1ToIndex(value: string) {
+    return this.A1ToColNum(value) - 1;
+}
+
+export async function A1ToColNum(value: string) {
+    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;
+    }
+    return result;
+}