@terreno/api 0.0.1

package/dist/notifiers/slackNotifier.test.js

@@ -0,0 +1,259 @@
+"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 __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 __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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var bun_test_1 = require("bun:test");
+var Sentry = __importStar(require("@sentry/node"));
+var axios_1 = __importDefault(require("axios"));
+var slackNotifier_1 = require("./slackNotifier");
+(0, bun_test_1.describe)("sendToSlack", function () {
+    var mockAxiosPost;
+    var ORIGINAL_ENV = process.env;
+    (0, bun_test_1.beforeEach)(function () {
+        mockAxiosPost = (0, bun_test_1.spyOn)(axios_1.default, "post").mockResolvedValue({ status: 200 });
+        process.env = __assign({}, ORIGINAL_ENV);
+        process.env.SLACK_WEBHOOKS = undefined;
+        Sentry.captureException.mockClear();
+        Sentry.captureMessage.mockClear();
+    });
+    (0, bun_test_1.afterEach)(function () {
+        mockAxiosPost.mockRestore();
+    });
+    (0, bun_test_1.afterAll)(function () {
+        process.env = ORIGINAL_ENV;
+    });
+    (0, bun_test_1.it)("returns early when SLACK_WEBHOOKS is missing", function () { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, (0, slackNotifier_1.sendToSlack)("hello")];
+                case 1:
+                    _a.sent();
+                    (0, bun_test_1.expect)(mockAxiosPost.mock.calls.length).toBe(0);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("posts to default webhook with plain text", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var callArgs, _a, url, payload;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    process.env.SLACK_WEBHOOKS = JSON.stringify({ default: "https://slack.example/webhook" });
+                    mockAxiosPost.mockResolvedValue({ status: 200 });
+                    return [4 /*yield*/, (0, slackNotifier_1.sendToSlack)("hello world")];
+                case 1:
+                    _b.sent();
+                    (0, bun_test_1.expect)(mockAxiosPost.mock.calls.length).toBe(1);
+                    callArgs = mockAxiosPost.mock.calls[0];
+                    (0, bun_test_1.expect)(Array.isArray(callArgs)).toBe(true);
+                    _a = __read(callArgs, 2), url = _a[0], payload = _a[1];
+                    (0, bun_test_1.expect)(url).toBe("https://slack.example/webhook");
+                    (0, bun_test_1.expect)(payload).toEqual({ text: "hello world" });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("posts to a specific channel when provided", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var callArgs, _a, url, payload;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    process.env.SLACK_WEBHOOKS = JSON.stringify({
+                        default: "https://slack.example/default",
+                        ops: "https://slack.example/ops",
+                    });
+                    mockAxiosPost.mockResolvedValue({ status: 200 });
+                    return [4 /*yield*/, (0, slackNotifier_1.sendToSlack)("ops msg", { slackChannel: "ops" })];
+                case 1:
+                    _b.sent();
+                    callArgs = mockAxiosPost.mock.calls[0];
+                    (0, bun_test_1.expect)(Array.isArray(callArgs)).toBe(true);
+                    _a = __read(callArgs, 2), url = _a[0], payload = _a[1];
+                    (0, bun_test_1.expect)(url).toBe("https://slack.example/ops");
+                    (0, bun_test_1.expect)(payload).toEqual({ text: "ops msg" });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("falls back to default when channel not found", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var callArgs, _a, url, payload;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    process.env.SLACK_WEBHOOKS = JSON.stringify({
+                        default: "https://slack.example/default",
+                    });
+                    mockAxiosPost.mockResolvedValue({ status: 200 });
+                    return [4 /*yield*/, (0, slackNotifier_1.sendToSlack)("missing channel", { slackChannel: "unknown" })];
+                case 1:
+                    _b.sent();
+                    callArgs = mockAxiosPost.mock.calls[0];
+                    (0, bun_test_1.expect)(Array.isArray(callArgs)).toBe(true);
+                    _a = __read(callArgs, 2), url = _a[0], payload = _a[1];
+                    (0, bun_test_1.expect)(url).toBe("https://slack.example/default");
+                    (0, bun_test_1.expect)(payload).toEqual({ text: "missing channel" });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("prefixes message with [ENV] when env provided", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var callArgs, _a, payload;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    process.env.SLACK_WEBHOOKS = JSON.stringify({
+                        default: "https://slack.example/default",
+                    });
+                    mockAxiosPost.mockResolvedValue({ status: 200 });
+                    return [4 /*yield*/, (0, slackNotifier_1.sendToSlack)("status ok", { env: "stg" })];
+                case 1:
+                    _b.sent();
+                    callArgs = mockAxiosPost.mock.calls[0];
+                    (0, bun_test_1.expect)(Array.isArray(callArgs)).toBe(true);
+                    _a = __read(callArgs, 2), payload = _a[1];
+                    (0, bun_test_1.expect)(payload).toEqual({ text: "[STG] status ok" });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("captures error and throws APIError when shouldThrow=true", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var error_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    process.env.SLACK_WEBHOOKS = JSON.stringify({
+                        default: "https://slack.example/default",
+                    });
+                    mockAxiosPost.mockRejectedValue(new Error("slack down"));
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, (0, slackNotifier_1.sendToSlack)("err", { shouldThrow: true })];
+                case 2:
+                    _a.sent();
+                    throw new Error("Expected sendToSlack to throw APIError");
+                case 3:
+                    error_1 = _a.sent();
+                    (0, bun_test_1.expect)(error_1.name).toBe("APIError");
+                    (0, bun_test_1.expect)(error_1.title).toMatch(/Error posting to slack/i);
+                    return [3 /*break*/, 4];
+                case 4:
+                    (0, bun_test_1.expect)(mockAxiosPost.mock.calls.length).toBe(1);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("captures error and does not throw when shouldThrow=false", function () { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    process.env.SLACK_WEBHOOKS = JSON.stringify({
+                        default: "https://slack.example/default",
+                    });
+                    mockAxiosPost.mockRejectedValue(new Error("slack intermittent"));
+                    return [4 /*yield*/, (0, slackNotifier_1.sendToSlack)("err", { shouldThrow: false })];
+                case 1:
+                    _a.sent();
+                    (0, bun_test_1.expect)(mockAxiosPost.mock.calls.length).toBe(1);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});

package/dist/notifiers/zoomNotifier.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Sends a rich formatted message to a Zoom chat channel via webhook.
+ *
+ * @param message - Message content with header, body, and optional subheader
+ * @param message.header - Main header text for the message
+ * @param message.body - Body text content
+ * @param message.subheader - Optional subheader text displayed below the main header
+ * @param options - Configuration options
+ * @param options.channel - The Zoom channel to post to (defaults to "default")
+ * @param options.shouldThrow - If true, throws an APIError on failure; otherwise logs and continues
+ * @param options.env - Optional environment prefix (e.g., "stg", "prod") prepended to header
+ *
+ * @remarks
+ * Requires ZOOM_CHAT_WEBHOOKS environment variable containing JSON with channel configurations:
+ * ```json
+ * {
+ *   "default": {"channel": "webhook_url", "verificationToken": "token"},
+ *   "ops": {"channel": "webhook_url", "verificationToken": "token"}
+ * }
+ * ```
+ *
+ * Falls back to "default" channel if specified channel not found.
+ * Logs errors to Sentry and logger when webhook is missing or request fails.
+ * Uses Zoom's rich message format (format=full) with structured header and body.
+ */
+export declare function sendToZoom({ header, body, subheader }: {
+    header: string;
+    body: string;
+    subheader?: string;
+}, { channel, shouldThrow, env }: {
+    channel: string;
+    shouldThrow?: boolean;
+    env?: string;
+}): Promise<void>;

package/dist/notifiers/zoomNotifier.js

@@ -0,0 +1,181 @@
+"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.sendToZoom = sendToZoom;
+var Sentry = __importStar(require("@sentry/node"));
+var axios_1 = __importDefault(require("axios"));
+var errors_1 = require("../errors");
+var logger_1 = require("../logger");
+/**
+ * Sends a rich formatted message to a Zoom chat channel via webhook.
+ *
+ * @param message - Message content with header, body, and optional subheader
+ * @param message.header - Main header text for the message
+ * @param message.body - Body text content
+ * @param message.subheader - Optional subheader text displayed below the main header
+ * @param options - Configuration options
+ * @param options.channel - The Zoom channel to post to (defaults to "default")
+ * @param options.shouldThrow - If true, throws an APIError on failure; otherwise logs and continues
+ * @param options.env - Optional environment prefix (e.g., "stg", "prod") prepended to header
+ *
+ * @remarks
+ * Requires ZOOM_CHAT_WEBHOOKS environment variable containing JSON with channel configurations:
+ * ```json
+ * {
+ *   "default": {"channel": "webhook_url", "verificationToken": "token"},
+ *   "ops": {"channel": "webhook_url", "verificationToken": "token"}
+ * }
+ * ```
+ *
+ * Falls back to "default" channel if specified channel not found.
+ * Logs errors to Sentry and logger when webhook is missing or request fails.
+ * Uses Zoom's rich message format (format=full) with structured header and body.
+ */
+function sendToZoom(_a, _b) {
+    return __awaiter(this, arguments, void 0, function (_c, _d) {
+        var zoomWebhooksString, msg, zoomWebhooks, zoomChannel, zoomWebhookUrl, msg, zoomToken, msg, messageBody, error_1;
+        var _e, _f, _g, _h, _j, _k, _l, _m;
+        var header = _c.header, body = _c.body, subheader = _c.subheader;
+        var channel = _d.channel, _o = _d.shouldThrow, shouldThrow = _o === void 0 ? false : _o, env = _d.env;
+        return __generator(this, function (_p) {
+            switch (_p.label) {
+                case 0:
+                    zoomWebhooksString = process.env.ZOOM_CHAT_WEBHOOKS;
+                    if (!zoomWebhooksString) {
+                        msg = "ZOOM_CHAT_WEBHOOKS not set. Zoom message not sent";
+                        Sentry.captureException(new Error(msg));
+                        logger_1.logger.error(msg);
+                        return [2 /*return*/];
+                    }
+                    zoomWebhooks = JSON.parse(zoomWebhooksString !== null && zoomWebhooksString !== void 0 ? zoomWebhooksString : "{}");
+                    zoomChannel = channel !== null && channel !== void 0 ? channel : "default";
+                    zoomWebhookUrl = (_f = (_e = zoomWebhooks[zoomChannel]) === null || _e === void 0 ? void 0 : _e.channel) !== null && _f !== void 0 ? _f : (_g = zoomWebhooks.default) === null || _g === void 0 ? void 0 : _g.channel;
+                    if (!zoomWebhookUrl) {
+                        msg = "No webhook url set in env for ".concat(zoomChannel, ". Zoom message not sent");
+                        Sentry.captureException(new Error(msg));
+                        logger_1.logger.error(msg);
+                        return [2 /*return*/];
+                    }
+                    zoomToken = (_j = (_h = zoomWebhooks[zoomChannel]) === null || _h === void 0 ? void 0 : _h.verificationToken) !== null && _j !== void 0 ? _j : (_k = zoomWebhooks.default) === null || _k === void 0 ? void 0 : _k.verificationToken;
+                    if (!zoomToken) {
+                        msg = "No verification token set in env for ".concat(zoomChannel, ". Zoom message not sent");
+                        Sentry.captureException(new Error(msg));
+                        logger_1.logger.error(msg);
+                        return [2 /*return*/];
+                    }
+                    messageBody = {
+                        body: [
+                            {
+                                text: body,
+                                type: "message",
+                            },
+                        ],
+                        head: {
+                            text: env ? "[".concat(env.toUpperCase(), "] ").concat(header) : header,
+                        },
+                    };
+                    // Add subheader if provided
+                    if (subheader) {
+                        messageBody.head.sub_head = {
+                            text: subheader,
+                        };
+                    }
+                    _p.label = 1;
+                case 1:
+                    _p.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, axios_1.default.post("".concat(zoomWebhookUrl, "?format=full"), { content: messageBody }, {
+                            headers: {
+                                Authorization: zoomToken,
+                                "Content-Type": "application/json",
+                            },
+                        })];
+                case 2:
+                    _p.sent();
+                    return [3 /*break*/, 4];
+                case 3:
+                    error_1 = _p.sent();
+                    logger_1.logger.error("Error posting to Zoom: ".concat((_l = error_1.text) !== null && _l !== void 0 ? _l : error_1.message));
+                    Sentry.captureException(error_1);
+                    if (shouldThrow) {
+                        throw new errors_1.APIError({
+                            status: 500,
+                            title: "Error posting to Zoom: ".concat((_m = error_1.text) !== null && _m !== void 0 ? _m : error_1.message),
+                        });
+                    }
+                    return [3 /*break*/, 4];
+                case 4: return [2 /*return*/];
+            }
+        });
+    });
+}

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

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