@honeybadger-io/js 6.7.2 → 6.8.0

package/dist/server/honeybadger.js

@@ -1105,7 +1105,7 @@ var Client = /** @class */ (function () {
         this.__notifier = {
             name: '@honeybadger-io/core',
             url: 'https://github.com/honeybadger-io/honeybadger-js/tree/master/packages/core',
-            version: '6.7.2'
+            version: '6.8.0'
         };
         this.config = __assign$1(__assign$1({}, defaults_1.CONFIG), opts);
         this.__initStore();
@@ -2231,7 +2231,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 () {
@@ -2241,39 +2240,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;
     };
@@ -2281,21 +2277,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,
@@ -2355,17 +2355,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(this, void 0, void 0, function () {
+            var response, data;
+            return __generator(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(this, void 0, void 0, function () {
-            var response, data, checkIns;
+            var response, data;
             return __generator(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');
                         }
@@ -2381,16 +2404,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.CheckIn.fromResponsePayload(projectId, checkin); });
-                        this.cache[projectId] = checkIns;
-                        return [2 /*return*/, checkIns];
+                        return [2 /*return*/, data.results.map(function (checkin) { return check_in_1.CheckIn.fromResponsePayload(checkin); })];
                 }
             });
         });
     };
     CheckInsClient.prototype.get = function (projectId, checkInId) {
         return __awaiter(this, void 0, void 0, function () {
-            var response, data, checkIn;
+            var response, data;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -2409,16 +2430,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.CheckIn.fromResponsePayload(projectId, data);
-                        checkIn.projectId = projectId;
-                        return [2 /*return*/, checkIn];
+                        return [2 /*return*/, check_in_1.CheckIn.fromResponsePayload(data)];
                 }
             });
         });
     };
-    CheckInsClient.prototype.create = function (checkIn) {
+    CheckInsClient.prototype.create = function (projectId, checkIn) {
         return __awaiter(this, void 0, void 0, function () {
-            var response, data, result;
+            var response, data;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -2428,23 +2447,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.CheckIn.fromResponsePayload(checkIn.projectId, data);
-                        result.projectId = checkIn.projectId;
-                        return [2 /*return*/, result];
+                        return [2 /*return*/, check_in_1.CheckIn.fromResponsePayload(data)];
                 }
             });
         });
     };
-    CheckInsClient.prototype.update = function (checkIn) {
+    CheckInsClient.prototype.update = function (projectId, checkIn) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
@@ -2456,20 +2473,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(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
@@ -2481,13 +2498,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*/];
                 }
@@ -2654,66 +2671,72 @@ client.CheckInsClient = CheckInsClient;
 	    Honeybadger.prototype.showUserFeedbackForm = function () {
 	        throw new Error('Honeybadger.showUserFeedbackForm() is not supported on the server-side');
 	    };
-	    Honeybadger.prototype.checkIn = function (idOrName) {
+	    Honeybadger.prototype.checkIn = function (idOrSlug) {
 	        return __awaiter(this, void 0, void 0, function () {
-	            var id, err_1;
+	            return __generator(this, function (_a) {
+	                if (this.isCheckInSlug(idOrSlug)) {
+	                    return [2 /*return*/, this.checkInWithSlug(idOrSlug)];
+	                }
+	                return [2 /*return*/, this.checkInWithId(idOrSlug)];
+	            });
+	        });
+	    };
+	    Honeybadger.prototype.checkInWithSlug = function (slug) {
+	        return __awaiter(this, void 0, void 0, function () {
+	            var err_1;
 	            return __generator(this, function (_a) {
 	                switch (_a.label) {
 	                    case 0:
-	                        _a.trys.push([0, 3, , 4]);
-	                        return [4 /*yield*/, this.getCheckInId(idOrName)];
-	                    case 1:
-	                        id = _a.sent();
+	                        _a.trys.push([0, 2, , 3]);
 	                        return [4 /*yield*/, this.__transport
 	                                .send({
 	                                method: 'GET',
-	                                endpoint: endpoint(this.config.endpoint, "v1/check_in/".concat(id)),
+	                                endpoint: endpoint(this.config.endpoint, "v1/check_in/".concat(this.config.apiKey, "/").concat(slug)),
 	                                logger: this.logger,
 	                            })];
-	                    case 2:
+	                    case 1:
 	                        _a.sent();
-	                        this.logger.info('CheckIn sent');
-	                        return [3 /*break*/, 4];
-	                    case 3:
+	                        this.logger.info("Check-In with slug[".concat(slug, "] sent"));
+	                        return [3 /*break*/, 3];
+	                    case 2:
 	                        err_1 = _a.sent();
-	                        this.logger.error("CheckIn[".concat(idOrName, "] failed: an unknown error occurred."), "message=".concat(err_1.message));
-	                        return [3 /*break*/, 4];
-	                    case 4: return [2 /*return*/];
+	                        this.logger.error("CheckIn with slug[".concat(slug, "] failed: an unknown error occurred."), "message=".concat(err_1.message));
+	                        return [3 /*break*/, 3];
+	                    case 3: return [2 /*return*/];
 	                }
 	            });
 	        });
 	    };
-	    Honeybadger.prototype.getCheckInId = function (idOrName) {
+	    Honeybadger.prototype.checkInWithId = function (id) {
 	        return __awaiter(this, void 0, void 0, function () {
-	            var localCheckIn, projectCheckIns, remoteCheckIn;
+	            var err_2;
 	            return __generator(this, function (_a) {
 	                switch (_a.label) {
 	                    case 0:
-	                        if (!this.config.checkins || this.config.checkins.length === 0) {
-	                            return [2 /*return*/, idOrName];
-	                        }
-	                        localCheckIn = this.config.checkins.find(function (c) { return c.name === idOrName; });
-	                        if (!localCheckIn) {
-	                            return [2 /*return*/, idOrName];
-	                        }
-	                        if (localCheckIn.id) {
-	                            return [2 /*return*/, localCheckIn.id];
-	                        }
-	                        return [4 /*yield*/, this.__checkInsClient.listForProject(localCheckIn.projectId)];
+	                        _a.trys.push([0, 2, , 3]);
+	                        return [4 /*yield*/, this.__transport
+	                                .send({
+	                                method: 'GET',
+	                                endpoint: endpoint(this.config.endpoint, "v1/check_in/".concat(id)),
+	                                logger: this.logger,
+	                            })];
 	                    case 1:
-	                        projectCheckIns = _a.sent();
-	                        remoteCheckIn = projectCheckIns.find(function (c) { return c.name === localCheckIn.name; });
-	                        if (!remoteCheckIn) {
-	                            this.logger.debug("Checkin[".concat(idOrName, "] was not found on HB. This should not happen. Was the sync command executed?"));
-	                            return [2 /*return*/, idOrName];
-	                        }
-	                        // store the id in-memory, so subsequent check-ins won't have to call the API
-	                        localCheckIn.id = remoteCheckIn.id;
-	                        return [2 /*return*/, localCheckIn.id];
+	                        _a.sent();
+	                        this.logger.info("Check-In with id[".concat(id, "] sent"));
+	                        return [3 /*break*/, 3];
+	                    case 2:
+	                        err_2 = _a.sent();
+	                        this.logger.error("Check-In with id[".concat(id, "] failed: an unknown error occurred."), "message=".concat(err_2.message));
+	                        return [3 /*break*/, 3];
+	                    case 3: return [2 /*return*/];
 	                }
 	            });
 	        });
 	    };
+	    Honeybadger.prototype.isCheckInSlug = function (idOrSlug) {
+	        var _a, _b;
+	        return (_b = (_a = this.config.checkins) === null || _a === void 0 ? void 0 : _a.some(function (c) { return c.slug === idOrSlug; })) !== null && _b !== void 0 ? _b : false;
+	    };
 	    // This method is intended for web frameworks.
 	    // It allows us to track context for individual requests without leaking to other requests
 	    // by doing two things:
@@ -2746,7 +2769,7 @@ client.CheckInsClient = CheckInsClient;
 	var NOTIFIER = {
 	    name: '@honeybadger-io/js',
 	    url: 'https://github.com/honeybadger-io/honeybadger-js/tree/master/packages/js',
-	    version: '6.7.2'
+	    version: '6.8.0'
 	};
 	var userAgent = function () {
 	    return "Honeybadger JS Server Client ".concat(NOTIFIER.version, ", ").concat(os_1.default.version(), "; ").concat(os_1.default.platform());