@terreno/api 0.0.1

package/dist/logger.js

@@ -0,0 +1,249 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = exports.winstonLogger = void 0;
+exports.setupLogging = setupLogging;
+var node_fs_1 = __importDefault(require("node:fs"));
+var node_util_1 = require("node:util");
+var Sentry = __importStar(require("@sentry/node"));
+var winston_1 = __importDefault(require("winston"));
+function isPrimitive(val) {
+    return val === null || (typeof val !== "object" && typeof val !== "function");
+}
+function formatWithInspect(val) {
+    var prefix = isPrimitive(val) ? "" : "\n";
+    var shouldFormat = typeof val !== "string";
+    return prefix + (shouldFormat ? (0, node_util_1.inspect)(val, { colors: true, depth: null }) : val);
+}
+// Winston doesn't operate like console.log by default, e.g. `logger.error('error',
+// error)` only prints the message and no args. Add handling for all the args,
+// while also supporting splat logging.
+function printf(timestamp) {
+    if (timestamp === void 0) { timestamp = false; }
+    return function (info) {
+        var msg = formatWithInspect(info.message);
+        var splatArgs = (info[Symbol.for("splat")] || []);
+        var rest = splatArgs.map(function (data) { return formatWithInspect(data); }).join(" ");
+        if (timestamp) {
+            return "".concat(info.timestamp, " - ").concat(info.level, ": ").concat(msg, " ").concat(rest);
+        }
+        return "".concat(info.level, ": ").concat(msg, " ").concat(rest);
+    };
+}
+// Setup a global, default rejection handler.
+winston_1.default.add(new winston_1.default.transports.Console({
+    debugStdout: true,
+    format: winston_1.default.format.combine(winston_1.default.format.colorize(), winston_1.default.format.simple(), winston_1.default.format.printf(printf(false))),
+    handleExceptions: true,
+    handleRejections: true,
+    level: "error",
+}));
+// Setup a default console logger.
+exports.winstonLogger = winston_1.default.createLogger({
+    level: "debug",
+    transports: [
+        new winston_1.default.transports.Console({
+            debugStdout: true,
+            format: winston_1.default.format.combine(winston_1.default.format.colorize(), winston_1.default.format.simple(), winston_1.default.format.printf(printf(false))),
+            handleExceptions: true,
+            handleRejections: true,
+            level: "debug",
+        }),
+    ],
+});
+// Helper function to send logs to Sentry if enabled
+function sendToSentry(message, level) {
+    if (process.env.USE_SENTRY_LOGGING === "true" && Sentry.logger) {
+        Sentry.logger[level](message);
+    }
+}
+exports.logger = {
+    // simple way to log a caught exception. e.g. promise().catch(logger.catch)
+    catch: function (e) {
+        var errorMsg = "Caught: ".concat(e === null || e === void 0 ? void 0 : e.message, " ").concat(e === null || e === void 0 ? void 0 : e.stack);
+        exports.winstonLogger.error(errorMsg);
+        if (process.env.USE_SENTRY_LOGGING === "true") {
+            if (e instanceof Error) {
+                Sentry.captureException(e);
+            }
+            else if (Sentry.logger) {
+                Sentry.logger.error(errorMsg);
+            }
+        }
+    },
+    debug: function (msg) {
+        var args = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            args[_i - 1] = arguments[_i];
+        }
+        exports.winstonLogger.debug.apply(exports.winstonLogger, __spreadArray([msg], __read(args), false));
+        sendToSentry(msg, "debug");
+    },
+    error: function (msg) {
+        var args = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            args[_i - 1] = arguments[_i];
+        }
+        exports.winstonLogger.error.apply(exports.winstonLogger, __spreadArray([msg], __read(args), false));
+        sendToSentry(msg, "error");
+    },
+    info: function (msg) {
+        var args = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            args[_i - 1] = arguments[_i];
+        }
+        exports.winstonLogger.info.apply(exports.winstonLogger, __spreadArray([msg], __read(args), false));
+        sendToSentry(msg, "info");
+    },
+    warn: function (msg) {
+        var args = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            args[_i - 1] = arguments[_i];
+        }
+        exports.winstonLogger.warn.apply(exports.winstonLogger, __spreadArray([msg], __read(args), false));
+        sendToSentry(msg, "warn");
+    },
+};
+function setupLogging(options) {
+    var _a, e_1, _b;
+    var _c, _d;
+    exports.winstonLogger.clear();
+    if (!(options === null || options === void 0 ? void 0 : options.disableConsoleLogging)) {
+        var formats = [winston_1.default.format.simple()];
+        if (!(options === null || options === void 0 ? void 0 : options.disableConsoleColors)) {
+            formats.push(winston_1.default.format.colorize());
+        }
+        formats.push(winston_1.default.format.printf(printf(options === null || options === void 0 ? void 0 : options.showConsoleTimestamps)));
+        exports.winstonLogger.add(new winston_1.default.transports.Console({
+            debugStdout: !(options === null || options === void 0 ? void 0 : options.level) || (options === null || options === void 0 ? void 0 : options.level) === "debug",
+            format: (_a = winston_1.default.format).combine.apply(_a, __spreadArray([], __read(formats), false)),
+            level: (_c = options === null || options === void 0 ? void 0 : options.level) !== null && _c !== void 0 ? _c : "debug",
+        }));
+    }
+    if (!(options === null || options === void 0 ? void 0 : options.disableFileLogging)) {
+        var logDirectory = (_d = options === null || options === void 0 ? void 0 : options.logDirectory) !== null && _d !== void 0 ? _d : "./log";
+        if (!node_fs_1.default.existsSync(logDirectory)) {
+            node_fs_1.default.mkdirSync(logDirectory, { recursive: true });
+        }
+        var FILE_LOG_DEFAULTS = {
+            colorize: false,
+            compress: true,
+            dirname: logDirectory,
+            format: winston_1.default.format.simple(),
+            // 30 days of retention
+            maxFiles: 30,
+            // 50MB max file size
+            maxSize: 1024 * 1024 * 50,
+            // Only readable by server user
+            options: { mode: 384 },
+        };
+        exports.winstonLogger.add(new winston_1.default.transports.Stream(__assign(__assign({}, FILE_LOG_DEFAULTS), { handleExceptions: true, level: "error", 
+            // Use stream so we can open log in append mode rather than overwriting.
+            stream: node_fs_1.default.createWriteStream("error.log", { flags: "a" }) })));
+        exports.winstonLogger.add(new winston_1.default.transports.Stream(__assign(__assign({}, FILE_LOG_DEFAULTS), { level: "info", 
+            // Use stream so we can open log in append mode rather than overwriting.
+            stream: node_fs_1.default.createWriteStream("out.log", { flags: "a" }) })));
+        if (!(options === null || options === void 0 ? void 0 : options.level) || (options === null || options === void 0 ? void 0 : options.level) === "debug") {
+            exports.winstonLogger.add(new winston_1.default.transports.Stream(__assign(__assign({}, FILE_LOG_DEFAULTS), { level: "debug", 
+                // Use stream so we can open log in append mode rather than overwriting.
+                stream: node_fs_1.default.createWriteStream("debug.log", { flags: "a" }) })));
+        }
+    }
+    if (options === null || options === void 0 ? void 0 : options.transports) {
+        try {
+            for (var _e = __values(options.transports), _f = _e.next(); !_f.done; _f = _e.next()) {
+                var transport = _f.value;
+                exports.winstonLogger.add(transport);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (_f && !_f.done && (_b = _e.return)) _b.call(_e);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+    }
+}

package/dist/middleware.d.ts

@@ -0,0 +1,10 @@
+import type { NextFunction, Request, Response } from "express";
+/**
+ * Express middleware that captures the app version from the request header
+ * and adds it as a tag to the current Sentry scope.
+ *
+ * This allows filtering Sentry errors by app version.
+ *
+ * Expected header: `App-Version`
+ */
+export declare function sentryAppVersionMiddleware(req: Request, _res: Response, next: NextFunction): void;

package/dist/middleware.js

@@ -0,0 +1,52 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sentryAppVersionMiddleware = sentryAppVersionMiddleware;
+var Sentry = __importStar(require("@sentry/node"));
+/**
+ * Express middleware that captures the app version from the request header
+ * and adds it as a tag to the current Sentry scope.
+ *
+ * This allows filtering Sentry errors by app version.
+ *
+ * Expected header: `App-Version`
+ */
+function sentryAppVersionMiddleware(req, _res, next) {
+    var appVersion = req.get("App-Version");
+    if (appVersion) {
+        Sentry.getCurrentScope().setTag("app_version", appVersion);
+    }
+    next();
+}

package/dist/notifiers/googleChatNotifier.d.ts

@@ -0,0 +1,5 @@
+export declare function sendToGoogleChat(messageText: string, { channel, shouldThrow, env }?: {
+    channel?: string;
+    shouldThrow?: boolean;
+    env?: string;
+}): Promise<void>;

package/dist/notifiers/googleChatNotifier.js

@@ -0,0 +1,130 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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 = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["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 (g && (g = 0, op[0] && (_ = 0)), _) 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 };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendToGoogleChat = sendToGoogleChat;
+var Sentry = __importStar(require("@sentry/node"));
+var axios_1 = __importDefault(require("axios"));
+var errors_1 = require("../errors");
+var logger_1 = require("../logger");
+function sendToGoogleChat(messageText_1) {
+    return __awaiter(this, arguments, void 0, function (messageText, _a) {
+        var chatWebhooksString, msg, chatWebhooks, chatChannel, chatWebhookUrl, msg, formattedMessageText, error_1;
+        var _b, _c, _d;
+        var _e = _a === void 0 ? {} : _a, channel = _e.channel, _f = _e.shouldThrow, shouldThrow = _f === void 0 ? false : _f, env = _e.env;
+        return __generator(this, function (_g) {
+            switch (_g.label) {
+                case 0:
+                    chatWebhooksString = process.env.GOOGLE_CHAT_WEBHOOKS;
+                    if (!chatWebhooksString) {
+                        msg = "GOOGLE_CHAT_WEBHOOKS not set. Google Chat message not sent";
+                        Sentry.captureException(new Error(msg));
+                        logger_1.logger.error(msg);
+                        return [2 /*return*/];
+                    }
+                    chatWebhooks = JSON.parse(chatWebhooksString !== null && chatWebhooksString !== void 0 ? chatWebhooksString : "{}");
+                    chatChannel = channel !== null && channel !== void 0 ? channel : "default";
+                    chatWebhookUrl = (_b = chatWebhooks[chatChannel]) !== null && _b !== void 0 ? _b : chatWebhooks.default;
+                    if (!chatWebhookUrl) {
+                        msg = "No webhook url set in env for ".concat(chatChannel, ". Google Chat message not sent");
+                        Sentry.captureException(new Error(msg));
+                        logger_1.logger.error(msg);
+                        return [2 /*return*/];
+                    }
+                    formattedMessageText = messageText;
+                    if (env) {
+                        formattedMessageText = "[".concat(env.toUpperCase(), "] ").concat(messageText);
+                    }
+                    _g.label = 1;
+                case 1:
+                    _g.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, axios_1.default.post(chatWebhookUrl, { text: formattedMessageText })];
+                case 2:
+                    _g.sent();
+                    return [3 /*break*/, 4];
+                case 3:
+                    error_1 = _g.sent();
+                    logger_1.logger.error("Error posting to Google Chat: ".concat((_c = error_1.text) !== null && _c !== void 0 ? _c : error_1.message));
+                    Sentry.captureException(error_1);
+                    if (shouldThrow) {
+                        throw new errors_1.APIError({
+                            status: 500,
+                            title: "Error posting to Google Chat: ".concat((_d = error_1.text) !== null && _d !== void 0 ? _d : error_1.message),
+                        });
+                    }
+                    return [3 /*break*/, 4];
+                case 4: return [2 /*return*/];
+            }
+        });
+    });
+}

package/dist/notifiers/googleChatNotifier.test.d.ts

@@ -0,0 +1 @@
+export {};