Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
81 lines
2.4 KiB
Plaintext
81 lines
2.4 KiB
Plaintext
Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
|
|
|
|
const core = require('@sentry/core');
|
|
const common = require('./common.js');
|
|
|
|
/**
|
|
* Wraps the `node-cron` library with check-in monitoring.
|
|
*
|
|
* ```ts
|
|
* import * as Sentry from "@sentry/node";
|
|
* import * as cron from "node-cron";
|
|
*
|
|
* const cronWithCheckIn = Sentry.cron.instrumentNodeCron(cron);
|
|
*
|
|
* cronWithCheckIn.schedule(
|
|
* "* * * * *",
|
|
* () => {
|
|
* console.log("running a task every minute");
|
|
* },
|
|
* { name: "my-cron-job" },
|
|
* );
|
|
* ```
|
|
*/
|
|
function instrumentNodeCron(
|
|
lib,
|
|
monitorConfig = {},
|
|
) {
|
|
return new Proxy(lib, {
|
|
get(target, prop) {
|
|
if (prop === 'schedule' && target.schedule) {
|
|
// When 'get' is called for schedule, return a proxied version of the schedule function
|
|
return new Proxy(target.schedule, {
|
|
apply(target, thisArg, argArray) {
|
|
const [expression, callback, options] = argArray;
|
|
|
|
const name = options?.name;
|
|
const timezone = options?.timezone;
|
|
|
|
if (!name) {
|
|
throw new Error('Missing "name" for scheduled job. A name is required for Sentry check-in monitoring.');
|
|
}
|
|
|
|
const monitoredCallback = async (...args) => {
|
|
return core.withMonitor(
|
|
name,
|
|
async () => {
|
|
// We have to manually catch here and capture the exception because node-cron swallows errors
|
|
// https://github.com/node-cron/node-cron/issues/399
|
|
try {
|
|
return await callback(...args);
|
|
} catch (e) {
|
|
core.captureException(e, {
|
|
mechanism: {
|
|
handled: false,
|
|
type: 'auto.function.node-cron.instrumentNodeCron',
|
|
},
|
|
});
|
|
throw e;
|
|
}
|
|
},
|
|
{
|
|
schedule: { type: 'crontab', value: common.replaceCronNames(expression) },
|
|
timezone,
|
|
...monitorConfig,
|
|
},
|
|
);
|
|
};
|
|
|
|
return target.apply(thisArg, [expression, monitoredCallback, options]);
|
|
},
|
|
});
|
|
} else {
|
|
return target[prop ];
|
|
}
|
|
},
|
|
});
|
|
}
|
|
|
|
exports.instrumentNodeCron = instrumentNodeCron;
|
|
//# sourceMappingURL=node-cron.js.map
|