@honeybadger-io/js 6.7.2 → 6.8.0

package/dist/server/check-ins-sync-exec.js

@@ -193,7 +193,6 @@ var CheckIn = /** @class */ (function () {
         this.gracePeriod = props.gracePeriod;
         this.cronSchedule = props.cronSchedule;
         this.cronTimezone = props.cronTimezone;
-        this.projectId = props.projectId;
         this.deleted = false;
     }
     CheckIn.prototype.isDeleted = function () {
@@ -203,39 +202,36 @@ var CheckIn = /** @class */ (function () {
         this.deleted = true;
     };
     CheckIn.prototype.validate = function () {
-        if (!this.projectId) {
-            throw new Error('projectId is required for each check-in');
-        }
-        if (!this.name) {
-            throw new Error('name is required for each check-in');
+        if (!this.slug) {
+            throw new Error('slug is required for each check-in');
         }
         if (!this.scheduleType) {
             throw new Error('scheduleType is required for each check-in');
         }
         if (!['simple', 'cron'].includes(this.scheduleType)) {
-            throw new Error("".concat(this.name, " [scheduleType] must be \"simple\" or \"cron\""));
+            throw new Error("".concat(this.slug, " [scheduleType] must be \"simple\" or \"cron\""));
         }
         if (this.scheduleType === 'simple' && !this.reportPeriod) {
-            throw new Error("".concat(this.name, " [reportPeriod] is required for simple check-ins"));
+            throw new Error("".concat(this.slug, " [reportPeriod] is required for simple check-ins"));
         }
         if (this.scheduleType === 'cron' && !this.cronSchedule) {
-            throw new Error("".concat(this.name, " [cronSchedule] is required for cron check-ins"));
+            throw new Error("".concat(this.slug, " [cronSchedule] is required for cron check-ins"));
         }
     };
     CheckIn.prototype.asRequestPayload = function () {
-        var _a, _b, _c;
+        var _a, _b;
         var payload = {
             name: this.name,
             schedule_type: this.scheduleType,
-            slug: (_a = this.slug) !== null && _a !== void 0 ? _a : '',
-            grace_period: (_b = this.gracePeriod) !== null && _b !== void 0 ? _b : '' // default is empty string
+            slug: this.slug,
+            grace_period: (_a = this.gracePeriod) !== null && _a !== void 0 ? _a : '' // default is empty string
         };
         if (this.scheduleType === 'simple') {
             payload.report_period = this.reportPeriod;
         }
         else {
             payload.cron_schedule = this.cronSchedule;
-            payload.cron_timezone = (_c = this.cronTimezone) !== null && _c !== void 0 ? _c : ''; // default is empty string
+            payload.cron_timezone = (_b = this.cronTimezone) !== null && _b !== void 0 ? _b : ''; // default is empty string
         }
         return payload;
     };
@@ -243,21 +239,25 @@ var CheckIn = /** @class */ (function () {
      * Compares two check-ins, usually the one from the API and the one from the config file.
      * If the one in the config file does not match the check-in from the API,
      * then we issue an update request.
+     *
+     * `name`, `gracePeriod` and `cronTimezone` are optional fields that are automatically
+     * set to a value from the server if one is not provided,
+     * so we ignore their values if they are not set locally.
      */
     CheckIn.prototype.isInSync = function (other) {
-        var _a, _b, _c, _d, _e, _f;
-        return this.name === other.name
-            && this.projectId === other.projectId
+        var ignoreNameCheck = this.name === undefined;
+        var ignoreGracePeriodCheck = this.gracePeriod === undefined;
+        var ignoreCronTimezoneCheck = this.cronTimezone === undefined;
+        return this.slug === other.slug
             && this.scheduleType === other.scheduleType
             && this.reportPeriod === other.reportPeriod
             && this.cronSchedule === other.cronSchedule
-            && ((_a = this.slug) !== null && _a !== void 0 ? _a : '') === ((_b = other.slug) !== null && _b !== void 0 ? _b : '')
-            && ((_c = this.gracePeriod) !== null && _c !== void 0 ? _c : '') === ((_d = other.gracePeriod) !== null && _d !== void 0 ? _d : '')
-            && ((_e = this.cronTimezone) !== null && _e !== void 0 ? _e : '') === ((_f = other.cronTimezone) !== null && _f !== void 0 ? _f : '');
+            && (ignoreNameCheck || this.name === other.name)
+            && (ignoreGracePeriodCheck || this.gracePeriod === other.gracePeriod)
+            && (ignoreCronTimezoneCheck || this.cronTimezone === other.cronTimezone);
     };
-    CheckIn.fromResponsePayload = function (projectId, payload) {
+    CheckIn.fromResponsePayload = function (payload) {
         return new CheckIn({
-            projectId: projectId,
             id: payload.id,
             name: payload.name,
             slug: payload.slug,
@@ -317,17 +317,40 @@ var CheckInsClient = /** @class */ (function () {
         this.transport = transport;
         this.config = config;
         this.logger = config.logger;
-        this.cache = {};
     }
+    CheckInsClient.prototype.getProjectId = function (projectApiKey) {
+        var _a;
+        return __awaiter$2(this, void 0, void 0, function () {
+            var response, data;
+            return __generator$2(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        if (!this.config.personalAuthToken || this.config.personalAuthToken === '') {
+                            throw new Error('personalAuthToken is required');
+                        }
+                        return [4 /*yield*/, this.transport.send({
+                                method: 'GET',
+                                headers: this.getHeaders(),
+                                endpoint: "".concat(this.BASE_URL, "/v2/project_keys/").concat(projectApiKey),
+                                logger: this.logger,
+                            })];
+                    case 1:
+                        response = _b.sent();
+                        if (response.statusCode !== 200) {
+                            throw new Error("Failed to fetch project[".concat(projectApiKey, "]: ").concat(this.getErrorMessage(response.body)));
+                        }
+                        data = JSON.parse(response.body);
+                        return [2 /*return*/, (_a = data === null || data === void 0 ? void 0 : data.project) === null || _a === void 0 ? void 0 : _a.id];
+                }
+            });
+        });
+    };
     CheckInsClient.prototype.listForProject = function (projectId) {
         return __awaiter$2(this, void 0, void 0, function () {
-            var response, data, checkIns;
+            var response, data;
             return __generator$2(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        if (this.cache[projectId]) {
-                            return [2 /*return*/, this.cache[projectId]];
-                        }
                         if (!this.config.personalAuthToken || this.config.personalAuthToken === '') {
                             throw new Error('personalAuthToken is required');
                         }
@@ -343,16 +366,14 @@ var CheckInsClient = /** @class */ (function () {
                             throw new Error("Failed to fetch checkins for project[".concat(projectId, "]: ").concat(this.getErrorMessage(response.body)));
                         }
                         data = JSON.parse(response.body);
-                        checkIns = data.results.map(function (checkin) { return check_in_1$1.CheckIn.fromResponsePayload(projectId, checkin); });
-                        this.cache[projectId] = checkIns;
-                        return [2 /*return*/, checkIns];
+                        return [2 /*return*/, data.results.map(function (checkin) { return check_in_1$1.CheckIn.fromResponsePayload(checkin); })];
                 }
             });
         });
     };
     CheckInsClient.prototype.get = function (projectId, checkInId) {
         return __awaiter$2(this, void 0, void 0, function () {
-            var response, data, checkIn;
+            var response, data;
             return __generator$2(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -371,16 +392,14 @@ var CheckInsClient = /** @class */ (function () {
                             throw new Error("Failed to fetch check-in[".concat(checkInId, "] for project[").concat(projectId, "]: ").concat(this.getErrorMessage(response.body)));
                         }
                         data = JSON.parse(response.body);
-                        checkIn = check_in_1$1.CheckIn.fromResponsePayload(projectId, data);
-                        checkIn.projectId = projectId;
-                        return [2 /*return*/, checkIn];
+                        return [2 /*return*/, check_in_1$1.CheckIn.fromResponsePayload(data)];
                 }
             });
         });
     };
-    CheckInsClient.prototype.create = function (checkIn) {
+    CheckInsClient.prototype.create = function (projectId, checkIn) {
         return __awaiter$2(this, void 0, void 0, function () {
-            var response, data, result;
+            var response, data;
             return __generator$2(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -390,23 +409,21 @@ var CheckInsClient = /** @class */ (function () {
                         return [4 /*yield*/, this.transport.send({
                                 method: 'POST',
                                 headers: this.getHeaders(),
-                                endpoint: "".concat(this.BASE_URL, "/v2/projects/").concat(checkIn.projectId, "/check_ins"),
+                                endpoint: "".concat(this.BASE_URL, "/v2/projects/").concat(projectId, "/check_ins"),
                                 logger: this.logger,
                             }, { check_in: checkIn.asRequestPayload() })];
                     case 1:
                         response = _a.sent();
                         if (response.statusCode !== 201) {
-                            throw new Error("Failed to create check-in[".concat(checkIn.name, "] for project[").concat(checkIn.projectId, "]: ").concat(this.getErrorMessage(response.body)));
+                            throw new Error("Failed to create check-in[".concat(checkIn.slug, "] for project[").concat(projectId, "]: ").concat(this.getErrorMessage(response.body)));
                         }
                         data = JSON.parse(response.body);
-                        result = check_in_1$1.CheckIn.fromResponsePayload(checkIn.projectId, data);
-                        result.projectId = checkIn.projectId;
-                        return [2 /*return*/, result];
+                        return [2 /*return*/, check_in_1$1.CheckIn.fromResponsePayload(data)];
                 }
             });
         });
     };
-    CheckInsClient.prototype.update = function (checkIn) {
+    CheckInsClient.prototype.update = function (projectId, checkIn) {
         return __awaiter$2(this, void 0, void 0, function () {
             var response;
             return __generator$2(this, function (_a) {
@@ -418,20 +435,20 @@ var CheckInsClient = /** @class */ (function () {
                         return [4 /*yield*/, this.transport.send({
                                 method: 'PUT',
                                 headers: this.getHeaders(),
-                                endpoint: "".concat(this.BASE_URL, "/v2/projects/").concat(checkIn.projectId, "/check_ins/").concat(checkIn.id),
+                                endpoint: "".concat(this.BASE_URL, "/v2/projects/").concat(projectId, "/check_ins/").concat(checkIn.id),
                                 logger: this.logger,
                             }, { check_in: checkIn.asRequestPayload() })];
                     case 1:
                         response = _a.sent();
                         if (response.statusCode !== 204) {
-                            throw new Error("Failed to update checkin[".concat(checkIn.name, "] for project[").concat(checkIn.projectId, "]: ").concat(this.getErrorMessage(response.body)));
+                            throw new Error("Failed to update checkin[".concat(checkIn.slug, "] for project[").concat(projectId, "]: ").concat(this.getErrorMessage(response.body)));
                         }
                         return [2 /*return*/, checkIn];
                 }
             });
         });
     };
-    CheckInsClient.prototype.remove = function (checkIn) {
+    CheckInsClient.prototype.remove = function (projectId, checkIn) {
         return __awaiter$2(this, void 0, void 0, function () {
             var response;
             return __generator$2(this, function (_a) {
@@ -443,13 +460,13 @@ var CheckInsClient = /** @class */ (function () {
                         return [4 /*yield*/, this.transport.send({
                                 method: 'DELETE',
                                 headers: this.getHeaders(),
-                                endpoint: "".concat(this.BASE_URL, "/v2/projects/").concat(checkIn.projectId, "/check_ins/").concat(checkIn.id),
+                                endpoint: "".concat(this.BASE_URL, "/v2/projects/").concat(projectId, "/check_ins/").concat(checkIn.id),
                                 logger: this.logger,
                             })];
                     case 1:
                         response = _a.sent();
                         if (response.statusCode !== 204) {
-                            throw new Error("Failed to remove checkin[".concat(checkIn.name, "] for project[").concat(checkIn.projectId, "]: ").concat(this.getErrorMessage(response.body)));
+                            throw new Error("Failed to remove checkin[".concat(checkIn.slug, "] for project[").concat(projectId, "]: ").concat(this.getErrorMessage(response.body)));
                         }
                         return [2 /*return*/];
                 }
@@ -646,36 +663,48 @@ var transport_1 = transport;
 var check_in_1 = checkIn;
 var CheckInsManager$1 = /** @class */ (function () {
     function CheckInsManager(config, client) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e;
         this.config = {
             debug: (_a = config.debug) !== null && _a !== void 0 ? _a : false,
-            personalAuthToken: (_b = config.personalAuthToken) !== null && _b !== void 0 ? _b : undefined,
-            checkins: (_c = config.checkins) !== null && _c !== void 0 ? _c : [],
-            logger: (_d = config.logger) !== null && _d !== void 0 ? _d : console,
+            apiKey: (_b = config.apiKey) !== null && _b !== void 0 ? _b : undefined,
+            personalAuthToken: (_c = config.personalAuthToken) !== null && _c !== void 0 ? _c : undefined,
+            checkins: (_d = config.checkins) !== null && _d !== void 0 ? _d : [],
+            logger: (_e = config.logger) !== null && _e !== void 0 ? _e : console,
         };
         var transport = new transport_1.ServerTransport();
         this.logger = core_1.Util.logger(this);
         this.client = client !== null && client !== void 0 ? client : new client_1.CheckInsClient({
+            apiKey: config.apiKey,
             personalAuthToken: config.personalAuthToken,
             logger: this.logger
         }, transport);
     }
     CheckInsManager.prototype.sync = function () {
         return __awaiter$1(this, void 0, void 0, function () {
-            var localCheckIns, createdOrUpdated, removed;
+            var localCheckIns, projectId, remoteCheckIns, createdOrUpdated, removed;
             return __generator$1(this, function (_a) {
                 switch (_a.label) {
                     case 0:
+                        // check if api key is set
+                        if (!this.config.apiKey || this.config.apiKey === '') {
+                            throw new Error('apiKey is required');
+                        }
                         // check if personal auth token is set
                         if (!this.config.personalAuthToken || this.config.personalAuthToken === '') {
                             throw new Error('personalAuthToken is required');
                         }
                         localCheckIns = this.getLocalCheckIns();
-                        return [4 /*yield*/, this.createOrUpdate(localCheckIns)];
+                        return [4 /*yield*/, this.client.getProjectId(this.config.apiKey)];
                     case 1:
-                        createdOrUpdated = _a.sent();
-                        return [4 /*yield*/, this.remove(localCheckIns)];
+                        projectId = _a.sent();
+                        return [4 /*yield*/, this.client.listForProject(projectId)];
                     case 2:
+                        remoteCheckIns = _a.sent();
+                        return [4 /*yield*/, this.createOrUpdate(projectId, localCheckIns, remoteCheckIns)];
+                    case 3:
+                        createdOrUpdated = _a.sent();
+                        return [4 /*yield*/, this.remove(projectId, localCheckIns, remoteCheckIns)];
+                    case 4:
                         removed = _a.sent();
                         return [2 /*return*/, __spreadArray(__spreadArray([], createdOrUpdated, true), removed, true)];
                 }
@@ -689,16 +718,15 @@ var CheckInsManager$1 = /** @class */ (function () {
             checkIn.validate();
             return checkIn;
         });
-        // validate that we have unique check-in names
-        // throw error if there are check-ins with the same name and project id
-        var checkInNames = localCheckIns.map(function (checkIn) { return "".concat(checkIn.projectId, "_").concat(checkIn.name); });
-        var uniqueCheckInNames = new Set(checkInNames);
-        if (checkInNames.length !== uniqueCheckInNames.size) {
-            throw new Error('check-in names must be unique per project');
+        // validate that we have unique check-in slugs
+        var checkInSlugs = localCheckIns.map(function (checkIn) { return checkIn.slug; });
+        var uniqueCheckInSlugs = new Set(checkInSlugs);
+        if (checkInSlugs.length !== uniqueCheckInSlugs.size) {
+            throw new Error('check-in slugs must be unique');
         }
         return localCheckIns;
     };
-    CheckInsManager.prototype.createOrUpdate = function (localCheckIns) {
+    CheckInsManager.prototype.createOrUpdate = function (projectId, localCheckIns, remoteCheckIns) {
         return __awaiter$1(this, void 0, void 0, function () {
             var results, _loop_1, this_1, _i, localCheckIns_1, localCheckIn;
             return __generator$1(this, function (_a) {
@@ -706,34 +734,32 @@ var CheckInsManager$1 = /** @class */ (function () {
                     case 0:
                         results = [];
                         _loop_1 = function (localCheckIn) {
-                            var projectCheckIns, remoteCheckIn, _b, _c, _d, _e;
+                            var remoteCheckIn, _b, _c, _d, _e;
                             return __generator$1(this, function (_f) {
                                 switch (_f.label) {
-                                    case 0: return [4 /*yield*/, this_1.client.listForProject(localCheckIn.projectId)];
-                                    case 1:
-                                        projectCheckIns = _f.sent();
-                                        remoteCheckIn = projectCheckIns.find(function (checkIn) {
-                                            return checkIn.name === localCheckIn.name;
+                                    case 0:
+                                        remoteCheckIn = remoteCheckIns.find(function (checkIn) {
+                                            return checkIn.slug === localCheckIn.slug;
                                         });
-                                        if (!!remoteCheckIn) return [3 /*break*/, 3];
+                                        if (!!remoteCheckIn) return [3 /*break*/, 2];
                                         _c = (_b = results).push;
-                                        return [4 /*yield*/, this_1.client.create(localCheckIn)];
-                                    case 2:
+                                        return [4 /*yield*/, this_1.client.create(projectId, localCheckIn)];
+                                    case 1:
                                         _c.apply(_b, [_f.sent()]);
-                                        return [3 /*break*/, 6];
-                                    case 3:
-                                        if (!!localCheckIn.isInSync(remoteCheckIn)) return [3 /*break*/, 5];
+                                        return [3 /*break*/, 5];
+                                    case 2:
+                                        if (!!localCheckIn.isInSync(remoteCheckIn)) return [3 /*break*/, 4];
                                         localCheckIn.id = remoteCheckIn.id;
                                         _e = (_d = results).push;
-                                        return [4 /*yield*/, this_1.client.update(localCheckIn)];
-                                    case 4:
+                                        return [4 /*yield*/, this_1.client.update(projectId, localCheckIn)];
+                                    case 3:
                                         _e.apply(_d, [_f.sent()]);
-                                        return [3 /*break*/, 6];
-                                    case 5:
+                                        return [3 /*break*/, 5];
+                                    case 4:
                                         // no change - still need to add to results
                                         results.push(remoteCheckIn);
-                                        _f.label = 6;
-                                    case 6: return [2 /*return*/];
+                                        _f.label = 5;
+                                    case 5: return [2 /*return*/];
                                 }
                             });
                         };
@@ -755,37 +781,27 @@ var CheckInsManager$1 = /** @class */ (function () {
             });
         });
     };
-    CheckInsManager.prototype.remove = function (localCheckIns) {
+    CheckInsManager.prototype.remove = function (projectId, localCheckIns, remoteCheckIns) {
         return __awaiter$1(this, void 0, void 0, function () {
-            var projectIds, remoteCheckInsPerProject, allRemoteCheckIns, checkInsToRemove;
+            var checkInsToRemove;
             var _this = this;
             return __generator$1(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        projectIds = Array.from(new Set(localCheckIns.map(function (checkIn) { return checkIn.projectId; })));
-                        return [4 /*yield*/, Promise.all(projectIds.map(function (projectId) {
-                                return _this.client.listForProject(projectId);
-                            }))];
-                    case 1:
-                        remoteCheckInsPerProject = _a.sent();
-                        allRemoteCheckIns = remoteCheckInsPerProject.flat();
-                        checkInsToRemove = allRemoteCheckIns.filter(function (remoteCheckIn) {
-                            return !localCheckIns.find(function (localCheckIn) {
-                                return localCheckIn.name === remoteCheckIn.name;
-                            });
+                checkInsToRemove = remoteCheckIns.filter(function (remoteCheckIn) {
+                    return !localCheckIns.find(function (localCheckIn) {
+                        return localCheckIn.slug === remoteCheckIn.slug;
+                    });
+                });
+                return [2 /*return*/, Promise.all(checkInsToRemove.map(function (checkIn) { return __awaiter$1(_this, void 0, void 0, function () {
+                        return __generator$1(this, function (_a) {
+                            switch (_a.label) {
+                                case 0: return [4 /*yield*/, this.client.remove(projectId, checkIn)];
+                                case 1:
+                                    _a.sent();
+                                    checkIn.markAsDeleted();
+                                    return [2 /*return*/, checkIn];
+                            }
                         });
-                        return [2 /*return*/, Promise.all(checkInsToRemove.map(function (checkIn) { return __awaiter$1(_this, void 0, void 0, function () {
-                                return __generator$1(this, function (_a) {
-                                    switch (_a.label) {
-                                        case 0: return [4 /*yield*/, this.client.remove(checkIn)];
-                                        case 1:
-                                            _a.sent();
-                                            checkIn.markAsDeleted();
-                                            return [2 /*return*/, checkIn];
-                                    }
-                                });
-                            }); }))];
-                }
+                    }); }))];
             });
         });
     };