@backstage/backend-defaults 0.5.1-next.1 → 0.5.1

package/dist/entrypoints/scheduler/database/migrateBackendTasks.cjs.js

@@ -0,0 +1,18 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var tables = require('./tables.cjs.js');
+
+async function migrateBackendTasks(knex) {
+  const migrationsDir = backendPluginApi.resolvePackagePath(
+    "@backstage/backend-defaults",
+    "migrations/scheduler"
+  );
+  await knex.migrate.latest({
+    directory: migrationsDir,
+    tableName: tables.DB_MIGRATIONS_TABLE
+  });
+}
+
+exports.migrateBackendTasks = migrateBackendTasks;
+//# sourceMappingURL=migrateBackendTasks.cjs.js.map

package/dist/entrypoints/scheduler/database/migrateBackendTasks.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrateBackendTasks.cjs.js","sources":["../../../../src/entrypoints/scheduler/database/migrateBackendTasks.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { resolvePackagePath } from '@backstage/backend-plugin-api';\nimport { Knex } from 'knex';\nimport { DB_MIGRATIONS_TABLE } from './tables';\n\nexport async function migrateBackendTasks(knex: Knex): Promise<void> {\n  const migrationsDir = resolvePackagePath(\n    '@backstage/backend-defaults',\n    'migrations/scheduler',\n  );\n\n  await knex.migrate.latest({\n    directory: migrationsDir,\n    tableName: DB_MIGRATIONS_TABLE,\n  });\n}\n"],"names":["resolvePackagePath","DB_MIGRATIONS_TABLE"],"mappings":";;;;;AAoBA,eAAsB,oBAAoB,IAA2B,EAAA;AACnE,EAAA,MAAM,aAAgB,GAAAA,mCAAA;AAAA,IACpB,6BAAA;AAAA,IACA,sBAAA;AAAA,GACF,CAAA;AAEA,EAAM,MAAA,IAAA,CAAK,QAAQ,MAAO,CAAA;AAAA,IACxB,SAAW,EAAA,aAAA;AAAA,IACX,SAAW,EAAAC,0BAAA;AAAA,GACZ,CAAA,CAAA;AACH;;;;"}

package/dist/entrypoints/scheduler/database/tables.cjs.js

@@ -0,0 +1,8 @@
+'use strict';
+
+const DB_MIGRATIONS_TABLE = "backstage_backend_tasks__knex_migrations";
+const DB_TASKS_TABLE = "backstage_backend_tasks__tasks";
+
+exports.DB_MIGRATIONS_TABLE = DB_MIGRATIONS_TABLE;
+exports.DB_TASKS_TABLE = DB_TASKS_TABLE;
+//# sourceMappingURL=tables.cjs.js.map

package/dist/entrypoints/scheduler/database/tables.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tables.cjs.js","sources":["../../../../src/entrypoints/scheduler/database/tables.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport const DB_MIGRATIONS_TABLE = 'backstage_backend_tasks__knex_migrations';\nexport const DB_TASKS_TABLE = 'backstage_backend_tasks__tasks';\n\nexport type DbTasksRow = {\n  id: string;\n  settings_json: string;\n  next_run_start_at: Date;\n  current_run_ticket?: string;\n  current_run_started_at?: Date | string;\n  current_run_expires_at?: Date | string;\n};\n"],"names":[],"mappings":";;AAgBO,MAAM,mBAAsB,GAAA,2CAAA;AAC5B,MAAM,cAAiB,GAAA;;;;;"}

package/dist/entrypoints/scheduler/lib/DefaultSchedulerService.cjs.js

@@ -0,0 +1,37 @@
+'use strict';
+
+var lodash = require('lodash');
+var luxon = require('luxon');
+var migrateBackendTasks = require('../database/migrateBackendTasks.cjs.js');
+var PluginTaskSchedulerImpl = require('./PluginTaskSchedulerImpl.cjs.js');
+var PluginTaskSchedulerJanitor = require('./PluginTaskSchedulerJanitor.cjs.js');
+
+class DefaultSchedulerService {
+  static create(options) {
+    const databaseFactory = lodash.once(async () => {
+      const knex = await options.database.getClient();
+      if (!options.database.migrations?.skip) {
+        await migrateBackendTasks.migrateBackendTasks(knex);
+      }
+      if (process.env.NODE_ENV !== "test") {
+        const abortController = new AbortController();
+        const janitor = new PluginTaskSchedulerJanitor.PluginTaskSchedulerJanitor({
+          knex,
+          waitBetweenRuns: luxon.Duration.fromObject({ minutes: 1 }),
+          logger: options.logger
+        });
+        options.rootLifecycle?.addShutdownHook(() => abortController.abort());
+        janitor.start(abortController.signal);
+      }
+      return knex;
+    });
+    return new PluginTaskSchedulerImpl.PluginTaskSchedulerImpl(
+      databaseFactory,
+      options.logger,
+      options.rootLifecycle
+    );
+  }
+}
+
+exports.DefaultSchedulerService = DefaultSchedulerService;
+//# sourceMappingURL=DefaultSchedulerService.cjs.js.map

package/dist/entrypoints/scheduler/lib/DefaultSchedulerService.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultSchedulerService.cjs.js","sources":["../../../../src/entrypoints/scheduler/lib/DefaultSchedulerService.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  DatabaseService,\n  LoggerService,\n  RootLifecycleService,\n  SchedulerService,\n} from '@backstage/backend-plugin-api';\nimport { once } from 'lodash';\nimport { Duration } from 'luxon';\nimport { migrateBackendTasks } from '../database/migrateBackendTasks';\nimport { PluginTaskSchedulerImpl } from './PluginTaskSchedulerImpl';\nimport { PluginTaskSchedulerJanitor } from './PluginTaskSchedulerJanitor';\n\n/**\n * Default implementation of the task scheduler service.\n *\n * @public\n */\nexport class DefaultSchedulerService {\n  static create(options: {\n    database: DatabaseService;\n    logger: LoggerService;\n    rootLifecycle?: RootLifecycleService;\n  }): SchedulerService {\n    const databaseFactory = once(async () => {\n      const knex = await options.database.getClient();\n\n      if (!options.database.migrations?.skip) {\n        await migrateBackendTasks(knex);\n      }\n\n      if (process.env.NODE_ENV !== 'test') {\n        const abortController = new AbortController();\n        const janitor = new PluginTaskSchedulerJanitor({\n          knex,\n          waitBetweenRuns: Duration.fromObject({ minutes: 1 }),\n          logger: options.logger,\n        });\n\n        options.rootLifecycle?.addShutdownHook(() => abortController.abort());\n        janitor.start(abortController.signal);\n      }\n\n      return knex;\n    });\n\n    return new PluginTaskSchedulerImpl(\n      databaseFactory,\n      options.logger,\n      options.rootLifecycle,\n    );\n  }\n}\n"],"names":["once","migrateBackendTasks","PluginTaskSchedulerJanitor","Duration","PluginTaskSchedulerImpl"],"mappings":";;;;;;;;AAiCO,MAAM,uBAAwB,CAAA;AAAA,EACnC,OAAO,OAAO,OAIO,EAAA;AACnB,IAAM,MAAA,eAAA,GAAkBA,YAAK,YAAY;AACvC,MAAA,MAAM,IAAO,GAAA,MAAM,OAAQ,CAAA,QAAA,CAAS,SAAU,EAAA,CAAA;AAE9C,MAAA,IAAI,CAAC,OAAA,CAAQ,QAAS,CAAA,UAAA,EAAY,IAAM,EAAA;AACtC,QAAA,MAAMC,wCAAoB,IAAI,CAAA,CAAA;AAAA,OAChC;AAEA,MAAI,IAAA,OAAA,CAAQ,GAAI,CAAA,QAAA,KAAa,MAAQ,EAAA;AACnC,QAAM,MAAA,eAAA,GAAkB,IAAI,eAAgB,EAAA,CAAA;AAC5C,QAAM,MAAA,OAAA,GAAU,IAAIC,qDAA2B,CAAA;AAAA,UAC7C,IAAA;AAAA,UACA,iBAAiBC,cAAS,CAAA,UAAA,CAAW,EAAE,OAAA,EAAS,GAAG,CAAA;AAAA,UACnD,QAAQ,OAAQ,CAAA,MAAA;AAAA,SACjB,CAAA,CAAA;AAED,QAAA,OAAA,CAAQ,aAAe,EAAA,eAAA,CAAgB,MAAM,eAAA,CAAgB,OAAO,CAAA,CAAA;AACpE,QAAQ,OAAA,CAAA,KAAA,CAAM,gBAAgB,MAAM,CAAA,CAAA;AAAA,OACtC;AAEA,MAAO,OAAA,IAAA,CAAA;AAAA,KACR,CAAA,CAAA;AAED,IAAA,OAAO,IAAIC,+CAAA;AAAA,MACT,eAAA;AAAA,MACA,OAAQ,CAAA,MAAA;AAAA,MACR,OAAQ,CAAA,aAAA;AAAA,KACV,CAAA;AAAA,GACF;AACF;;;;"}

package/dist/entrypoints/scheduler/lib/LocalTaskWorker.cjs.js

@@ -0,0 +1,105 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+var cron = require('cron');
+var luxon = require('luxon');
+var util = require('./util.cjs.js');
+
+class LocalTaskWorker {
+  constructor(taskId, fn, logger) {
+    this.taskId = taskId;
+    this.fn = fn;
+    this.logger = logger;
+  }
+  abortWait;
+  start(settings, options) {
+    this.logger.info(
+      `Task worker starting: ${this.taskId}, ${JSON.stringify(settings)}`
+    );
+    (async () => {
+      let attemptNum = 1;
+      for (; ; ) {
+        try {
+          if (settings.initialDelayDuration) {
+            await this.sleep(
+              luxon.Duration.fromISO(settings.initialDelayDuration),
+              options.signal
+            );
+          }
+          while (!options.signal.aborted) {
+            const startTime = process.hrtime();
+            await this.runOnce(settings, options.signal);
+            const timeTaken = process.hrtime(startTime);
+            await this.waitUntilNext(
+              settings,
+              (timeTaken[0] + timeTaken[1] / 1e9) * 1e3,
+              options.signal
+            );
+          }
+          this.logger.info(`Task worker finished: ${this.taskId}`);
+          attemptNum = 0;
+          break;
+        } catch (e) {
+          attemptNum += 1;
+          this.logger.warn(
+            `Task worker failed unexpectedly, attempt number ${attemptNum}, ${e}`
+          );
+          await util.sleep(luxon.Duration.fromObject({ seconds: 1 }));
+        }
+      }
+    })();
+  }
+  trigger() {
+    if (!this.abortWait) {
+      throw new errors.ConflictError(`Task ${this.taskId} is currently running`);
+    }
+    this.abortWait.abort();
+  }
+  /**
+   * Makes a single attempt at running the task to completion.
+   */
+  async runOnce(settings, signal) {
+    const taskAbortController = util.delegateAbortController(signal);
+    const timeoutHandle = setTimeout(() => {
+      taskAbortController.abort();
+    }, luxon.Duration.fromISO(settings.timeoutAfterDuration).as("milliseconds"));
+    try {
+      await this.fn(taskAbortController.signal);
+    } catch (e) {
+    }
+    clearTimeout(timeoutHandle);
+    taskAbortController.abort();
+  }
+  /**
+   * Sleeps until it's time to run the task again.
+   */
+  async waitUntilNext(settings, lastRunMillis, signal) {
+    if (signal.aborted) {
+      return;
+    }
+    const isCron = !settings.cadence.startsWith("P");
+    let dt;
+    if (isCron) {
+      const nextRun = +new cron.CronTime(settings.cadence).sendAt().toJSDate();
+      dt = nextRun - Date.now();
+    } else {
+      dt = luxon.Duration.fromISO(settings.cadence).as("milliseconds") - lastRunMillis;
+    }
+    dt = Math.max(dt, 0);
+    this.logger.debug(
+      `task: ${this.taskId} will next occur around ${luxon.DateTime.now().plus(
+        luxon.Duration.fromMillis(dt)
+      )}`
+    );
+    await this.sleep(luxon.Duration.fromMillis(dt), signal);
+  }
+  async sleep(duration, abortSignal) {
+    this.abortWait = util.delegateAbortController(abortSignal);
+    await util.sleep(duration, this.abortWait.signal);
+    this.abortWait.abort();
+    this.abortWait = void 0;
+  }
+}
+
+exports.LocalTaskWorker = LocalTaskWorker;
+//# sourceMappingURL=LocalTaskWorker.cjs.js.map

package/dist/entrypoints/scheduler/lib/LocalTaskWorker.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalTaskWorker.cjs.js","sources":["../../../../src/entrypoints/scheduler/lib/LocalTaskWorker.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { LoggerService } from '@backstage/backend-plugin-api';\nimport { SchedulerServiceTaskFunction } from '@backstage/backend-plugin-api';\nimport { ConflictError } from '@backstage/errors';\nimport { CronTime } from 'cron';\nimport { DateTime, Duration } from 'luxon';\nimport { TaskSettingsV2 } from './types';\nimport { delegateAbortController, sleep } from './util';\n\n/**\n * Implements tasks that run locally without cross-host collaboration.\n *\n * @private\n */\nexport class LocalTaskWorker {\n  private abortWait: AbortController | undefined;\n\n  constructor(\n    private readonly taskId: string,\n    private readonly fn: SchedulerServiceTaskFunction,\n    private readonly logger: LoggerService,\n  ) {}\n\n  start(settings: TaskSettingsV2, options: { signal: AbortSignal }) {\n    this.logger.info(\n      `Task worker starting: ${this.taskId}, ${JSON.stringify(settings)}`,\n    );\n\n    (async () => {\n      let attemptNum = 1;\n      for (;;) {\n        try {\n          if (settings.initialDelayDuration) {\n            await this.sleep(\n              Duration.fromISO(settings.initialDelayDuration),\n              options.signal,\n            );\n          }\n\n          while (!options.signal.aborted) {\n            const startTime = process.hrtime();\n            await this.runOnce(settings, options.signal);\n            const timeTaken = process.hrtime(startTime);\n            await this.waitUntilNext(\n              settings,\n              (timeTaken[0] + timeTaken[1] / 1e9) * 1000,\n              options.signal,\n            );\n          }\n\n          this.logger.info(`Task worker finished: ${this.taskId}`);\n          attemptNum = 0;\n          break;\n        } catch (e) {\n          attemptNum += 1;\n          this.logger.warn(\n            `Task worker failed unexpectedly, attempt number ${attemptNum}, ${e}`,\n          );\n          await sleep(Duration.fromObject({ seconds: 1 }));\n        }\n      }\n    })();\n  }\n\n  trigger(): void {\n    if (!this.abortWait) {\n      throw new ConflictError(`Task ${this.taskId} is currently running`);\n    }\n    this.abortWait.abort();\n  }\n\n  /**\n   * Makes a single attempt at running the task to completion.\n   */\n  private async runOnce(\n    settings: TaskSettingsV2,\n    signal: AbortSignal,\n  ): Promise<void> {\n    // Abort the task execution either if the worker is stopped, or if the\n    // task timeout is hit\n    const taskAbortController = delegateAbortController(signal);\n    const timeoutHandle = setTimeout(() => {\n      taskAbortController.abort();\n    }, Duration.fromISO(settings.timeoutAfterDuration).as('milliseconds'));\n\n    try {\n      await this.fn(taskAbortController.signal);\n    } catch (e) {\n      // ignore intentionally\n    }\n\n    // release resources\n    clearTimeout(timeoutHandle);\n    taskAbortController.abort();\n  }\n\n  /**\n   * Sleeps until it's time to run the task again.\n   */\n  private async waitUntilNext(\n    settings: TaskSettingsV2,\n    lastRunMillis: number,\n    signal: AbortSignal,\n  ) {\n    if (signal.aborted) {\n      return;\n    }\n\n    const isCron = !settings.cadence.startsWith('P');\n    let dt: number;\n\n    if (isCron) {\n      const nextRun = +new CronTime(settings.cadence).sendAt().toJSDate();\n      dt = nextRun - Date.now();\n    } else {\n      dt =\n        Duration.fromISO(settings.cadence).as('milliseconds') - lastRunMillis;\n    }\n\n    dt = Math.max(dt, 0);\n\n    this.logger.debug(\n      `task: ${this.taskId} will next occur around ${DateTime.now().plus(\n        Duration.fromMillis(dt),\n      )}`,\n    );\n\n    await this.sleep(Duration.fromMillis(dt), signal);\n  }\n\n  private async sleep(\n    duration: Duration,\n    abortSignal: AbortSignal,\n  ): Promise<void> {\n    this.abortWait = delegateAbortController(abortSignal);\n    await sleep(duration, this.abortWait.signal);\n    this.abortWait.abort(); // cleans up resources\n    this.abortWait = undefined;\n  }\n}\n"],"names":["Duration","sleep","ConflictError","delegateAbortController","CronTime","DateTime"],"mappings":";;;;;;;AA6BO,MAAM,eAAgB,CAAA;AAAA,EAG3B,WAAA,CACmB,MACA,EAAA,EAAA,EACA,MACjB,EAAA;AAHiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,EAAA,GAAA,EAAA,CAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AAAA,GAChB;AAAA,EANK,SAAA,CAAA;AAAA,EAQR,KAAA,CAAM,UAA0B,OAAkC,EAAA;AAChE,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,MACV,yBAAyB,IAAK,CAAA,MAAM,KAAK,IAAK,CAAA,SAAA,CAAU,QAAQ,CAAC,CAAA,CAAA;AAAA,KACnE,CAAA;AAEA,IAAA,CAAC,YAAY;AACX,MAAA,IAAI,UAAa,GAAA,CAAA,CAAA;AACjB,MAAS,WAAA;AACP,QAAI,IAAA;AACF,UAAA,IAAI,SAAS,oBAAsB,EAAA;AACjC,YAAA,MAAM,IAAK,CAAA,KAAA;AAAA,cACTA,cAAA,CAAS,OAAQ,CAAA,QAAA,CAAS,oBAAoB,CAAA;AAAA,cAC9C,OAAQ,CAAA,MAAA;AAAA,aACV,CAAA;AAAA,WACF;AAEA,UAAO,OAAA,CAAC,OAAQ,CAAA,MAAA,CAAO,OAAS,EAAA;AAC9B,YAAM,MAAA,SAAA,GAAY,QAAQ,MAAO,EAAA,CAAA;AACjC,YAAA,MAAM,IAAK,CAAA,OAAA,CAAQ,QAAU,EAAA,OAAA,CAAQ,MAAM,CAAA,CAAA;AAC3C,YAAM,MAAA,SAAA,GAAY,OAAQ,CAAA,MAAA,CAAO,SAAS,CAAA,CAAA;AAC1C,YAAA,MAAM,IAAK,CAAA,aAAA;AAAA,cACT,QAAA;AAAA,cAAA,CACC,UAAU,CAAC,CAAA,GAAI,SAAU,CAAA,CAAC,IAAI,GAAO,IAAA,GAAA;AAAA,cACtC,OAAQ,CAAA,MAAA;AAAA,aACV,CAAA;AAAA,WACF;AAEA,UAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAAyB,sBAAA,EAAA,IAAA,CAAK,MAAM,CAAE,CAAA,CAAA,CAAA;AACvD,UAAa,UAAA,GAAA,CAAA,CAAA;AACb,UAAA,MAAA;AAAA,iBACO,CAAG,EAAA;AACV,UAAc,UAAA,IAAA,CAAA,CAAA;AACd,UAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,YACV,CAAA,gDAAA,EAAmD,UAAU,CAAA,EAAA,EAAK,CAAC,CAAA,CAAA;AAAA,WACrE,CAAA;AACA,UAAA,MAAMC,WAAMD,cAAS,CAAA,UAAA,CAAW,EAAE,OAAS,EAAA,CAAA,EAAG,CAAC,CAAA,CAAA;AAAA,SACjD;AAAA,OACF;AAAA,KACC,GAAA,CAAA;AAAA,GACL;AAAA,EAEA,OAAgB,GAAA;AACd,IAAI,IAAA,CAAC,KAAK,SAAW,EAAA;AACnB,MAAA,MAAM,IAAIE,oBAAA,CAAc,CAAQ,KAAA,EAAA,IAAA,CAAK,MAAM,CAAuB,qBAAA,CAAA,CAAA,CAAA;AAAA,KACpE;AACA,IAAA,IAAA,CAAK,UAAU,KAAM,EAAA,CAAA;AAAA,GACvB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAc,OACZ,CAAA,QAAA,EACA,MACe,EAAA;AAGf,IAAM,MAAA,mBAAA,GAAsBC,6BAAwB,MAAM,CAAA,CAAA;AAC1D,IAAM,MAAA,aAAA,GAAgB,WAAW,MAAM;AACrC,MAAA,mBAAA,CAAoB,KAAM,EAAA,CAAA;AAAA,KAC5B,EAAGH,eAAS,OAAQ,CAAA,QAAA,CAAS,oBAAoB,CAAE,CAAA,EAAA,CAAG,cAAc,CAAC,CAAA,CAAA;AAErE,IAAI,IAAA;AACF,MAAM,MAAA,IAAA,CAAK,EAAG,CAAA,mBAAA,CAAoB,MAAM,CAAA,CAAA;AAAA,aACjC,CAAG,EAAA;AAAA,KAEZ;AAGA,IAAA,YAAA,CAAa,aAAa,CAAA,CAAA;AAC1B,IAAA,mBAAA,CAAoB,KAAM,EAAA,CAAA;AAAA,GAC5B;AAAA;AAAA;AAAA;AAAA,EAKA,MAAc,aAAA,CACZ,QACA,EAAA,aAAA,EACA,MACA,EAAA;AACA,IAAA,IAAI,OAAO,OAAS,EAAA;AAClB,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,MAAM,MAAS,GAAA,CAAC,QAAS,CAAA,OAAA,CAAQ,WAAW,GAAG,CAAA,CAAA;AAC/C,IAAI,IAAA,EAAA,CAAA;AAEJ,IAAA,IAAI,MAAQ,EAAA;AACV,MAAM,MAAA,OAAA,GAAU,CAAC,IAAII,aAAA,CAAS,SAAS,OAAO,CAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA,CAAA;AAClE,MAAK,EAAA,GAAA,OAAA,GAAU,KAAK,GAAI,EAAA,CAAA;AAAA,KACnB,MAAA;AACL,MAAA,EAAA,GACEJ,eAAS,OAAQ,CAAA,QAAA,CAAS,OAAO,CAAE,CAAA,EAAA,CAAG,cAAc,CAAI,GAAA,aAAA,CAAA;AAAA,KAC5D;AAEA,IAAK,EAAA,GAAA,IAAA,CAAK,GAAI,CAAA,EAAA,EAAI,CAAC,CAAA,CAAA;AAEnB,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACV,SAAS,IAAK,CAAA,MAAM,CAA2B,wBAAA,EAAAK,cAAA,CAAS,KAAM,CAAA,IAAA;AAAA,QAC5DL,cAAA,CAAS,WAAW,EAAE,CAAA;AAAA,OACvB,CAAA,CAAA;AAAA,KACH,CAAA;AAEA,IAAA,MAAM,KAAK,KAAM,CAAAA,cAAA,CAAS,UAAW,CAAA,EAAE,GAAG,MAAM,CAAA,CAAA;AAAA,GAClD;AAAA,EAEA,MAAc,KACZ,CAAA,QAAA,EACA,WACe,EAAA;AACf,IAAK,IAAA,CAAA,SAAA,GAAYG,6BAAwB,WAAW,CAAA,CAAA;AACpD,IAAA,MAAMF,UAAM,CAAA,QAAA,EAAU,IAAK,CAAA,SAAA,CAAU,MAAM,CAAA,CAAA;AAC3C,IAAA,IAAA,CAAK,UAAU,KAAM,EAAA,CAAA;AACrB,IAAA,IAAA,CAAK,SAAY,GAAA,KAAA,CAAA,CAAA;AAAA,GACnB;AACF;;;;"}

package/dist/entrypoints/scheduler/lib/PluginTaskSchedulerImpl.cjs.js

@@ -0,0 +1,138 @@
+'use strict';
+
+var api = require('@opentelemetry/api');
+var luxon = require('luxon');
+var LocalTaskWorker = require('./LocalTaskWorker.cjs.js');
+var TaskWorker = require('./TaskWorker.cjs.js');
+var util = require('./util.cjs.js');
+
+const tracer = api.trace.getTracer(util.TRACER_ID);
+class PluginTaskSchedulerImpl {
+  constructor(databaseFactory, logger, rootLifecycle) {
+    this.databaseFactory = databaseFactory;
+    this.logger = logger;
+    const meter = api.metrics.getMeter("default");
+    this.counter = meter.createCounter("backend_tasks.task.runs.count", {
+      description: "Total number of times a task has been run"
+    });
+    this.duration = meter.createHistogram("backend_tasks.task.runs.duration", {
+      description: "Histogram of task run durations",
+      unit: "seconds"
+    });
+    this.shutdownInitiated = new Promise((shutdownInitiated) => {
+      rootLifecycle?.addShutdownHook(() => shutdownInitiated(true));
+    });
+  }
+  localTasksById = /* @__PURE__ */ new Map();
+  allScheduledTasks = [];
+  shutdownInitiated;
+  counter;
+  duration;
+  async triggerTask(id) {
+    const localTask = this.localTasksById.get(id);
+    if (localTask) {
+      localTask.trigger();
+      return;
+    }
+    const knex = await this.databaseFactory();
+    await TaskWorker.TaskWorker.trigger(knex, id);
+  }
+  async scheduleTask(task) {
+    util.validateId(task.id);
+    const scope = task.scope ?? "global";
+    const settings = {
+      version: 2,
+      cadence: parseDuration(task.frequency),
+      initialDelayDuration: task.initialDelay && parseDuration(task.initialDelay),
+      timeoutAfterDuration: parseDuration(task.timeout)
+    };
+    const abortController = util.delegateAbortController(task.signal);
+    this.shutdownInitiated.then(() => abortController.abort());
+    if (scope === "global") {
+      const knex = await this.databaseFactory();
+      const worker = new TaskWorker.TaskWorker(
+        task.id,
+        this.instrumentedFunction(task, scope),
+        knex,
+        this.logger.child({ task: task.id })
+      );
+      await worker.start(settings, { signal: abortController.signal });
+    } else {
+      const worker = new LocalTaskWorker.LocalTaskWorker(
+        task.id,
+        this.instrumentedFunction(task, scope),
+        this.logger.child({ task: task.id })
+      );
+      worker.start(settings, { signal: abortController.signal });
+      this.localTasksById.set(task.id, worker);
+    }
+    this.allScheduledTasks.push({
+      id: task.id,
+      scope,
+      settings
+    });
+  }
+  createScheduledTaskRunner(schedule) {
+    return {
+      run: async (task) => {
+        await this.scheduleTask({ ...task, ...schedule });
+      }
+    };
+  }
+  async getScheduledTasks() {
+    return this.allScheduledTasks;
+  }
+  instrumentedFunction(task, scope) {
+    return async (abort) => {
+      const labels = {
+        taskId: task.id,
+        scope
+      };
+      this.counter.add(1, { ...labels, result: "started" });
+      const startTime = process.hrtime();
+      try {
+        await tracer.startActiveSpan(`task ${task.id}`, async (span) => {
+          try {
+            span.setAttributes(labels);
+            await task.fn(abort);
+          } catch (error) {
+            if (error instanceof Error) {
+              span.recordException(error);
+            }
+            throw error;
+          } finally {
+            span.end();
+          }
+        });
+        labels.result = "completed";
+      } catch (ex) {
+        labels.result = "failed";
+        throw ex;
+      } finally {
+        const delta = process.hrtime(startTime);
+        const endTime = delta[0] + delta[1] / 1e9;
+        this.counter.add(1, labels);
+        this.duration.record(endTime, labels);
+      }
+    };
+  }
+}
+function parseDuration(frequency) {
+  if (typeof frequency === "object" && "cron" in frequency) {
+    return frequency.cron;
+  }
+  if (typeof frequency === "object" && "trigger" in frequency) {
+    return frequency.trigger;
+  }
+  const parsed = luxon.Duration.isDuration(frequency) ? frequency : luxon.Duration.fromObject(frequency);
+  if (!parsed.isValid) {
+    throw new Error(
+      `Invalid duration, ${parsed.invalidReason}: ${parsed.invalidExplanation}`
+    );
+  }
+  return parsed.toISO();
+}
+
+exports.PluginTaskSchedulerImpl = PluginTaskSchedulerImpl;
+exports.parseDuration = parseDuration;
+//# sourceMappingURL=PluginTaskSchedulerImpl.cjs.js.map

package/dist/entrypoints/scheduler/lib/PluginTaskSchedulerImpl.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PluginTaskSchedulerImpl.cjs.js","sources":["../../../../src/entrypoints/scheduler/lib/PluginTaskSchedulerImpl.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  LoggerService,\n  RootLifecycleService,\n  SchedulerService,\n  SchedulerServiceTaskDescriptor,\n  SchedulerServiceTaskFunction,\n  SchedulerServiceTaskInvocationDefinition,\n  SchedulerServiceTaskRunner,\n  SchedulerServiceTaskScheduleDefinition,\n} from '@backstage/backend-plugin-api';\nimport { Counter, Histogram, metrics, trace } from '@opentelemetry/api';\nimport { Knex } from 'knex';\nimport { Duration } from 'luxon';\nimport { LocalTaskWorker } from './LocalTaskWorker';\nimport { TaskWorker } from './TaskWorker';\nimport { TaskSettingsV2 } from './types';\nimport { delegateAbortController, TRACER_ID, validateId } from './util';\n\nconst tracer = trace.getTracer(TRACER_ID);\n\n/**\n * Implements the actual task management.\n */\nexport class PluginTaskSchedulerImpl implements SchedulerService {\n  private readonly localTasksById = new Map<string, LocalTaskWorker>();\n  private readonly allScheduledTasks: SchedulerServiceTaskDescriptor[] = [];\n  private readonly shutdownInitiated: Promise<boolean>;\n\n  private readonly counter: Counter;\n  private readonly duration: Histogram;\n\n  constructor(\n    private readonly databaseFactory: () => Promise<Knex>,\n    private readonly logger: LoggerService,\n    rootLifecycle?: RootLifecycleService,\n  ) {\n    const meter = metrics.getMeter('default');\n    this.counter = meter.createCounter('backend_tasks.task.runs.count', {\n      description: 'Total number of times a task has been run',\n    });\n    this.duration = meter.createHistogram('backend_tasks.task.runs.duration', {\n      description: 'Histogram of task run durations',\n      unit: 'seconds',\n    });\n    this.shutdownInitiated = new Promise(shutdownInitiated => {\n      rootLifecycle?.addShutdownHook(() => shutdownInitiated(true));\n    });\n  }\n\n  async triggerTask(id: string): Promise<void> {\n    const localTask = this.localTasksById.get(id);\n    if (localTask) {\n      localTask.trigger();\n      return;\n    }\n\n    const knex = await this.databaseFactory();\n    await TaskWorker.trigger(knex, id);\n  }\n\n  async scheduleTask(\n    task: SchedulerServiceTaskScheduleDefinition &\n      SchedulerServiceTaskInvocationDefinition,\n  ): Promise<void> {\n    validateId(task.id);\n    const scope = task.scope ?? 'global';\n\n    const settings: TaskSettingsV2 = {\n      version: 2,\n      cadence: parseDuration(task.frequency),\n      initialDelayDuration:\n        task.initialDelay && parseDuration(task.initialDelay),\n      timeoutAfterDuration: parseDuration(task.timeout),\n    };\n\n    // Delegated abort controller that will abort either when the provided\n    // controller aborts, or when a root lifecycle shutdown happens\n    const abortController = delegateAbortController(task.signal);\n    this.shutdownInitiated.then(() => abortController.abort());\n\n    if (scope === 'global') {\n      const knex = await this.databaseFactory();\n      const worker = new TaskWorker(\n        task.id,\n        this.instrumentedFunction(task, scope),\n        knex,\n        this.logger.child({ task: task.id }),\n      );\n      await worker.start(settings, { signal: abortController.signal });\n    } else {\n      const worker = new LocalTaskWorker(\n        task.id,\n        this.instrumentedFunction(task, scope),\n        this.logger.child({ task: task.id }),\n      );\n      worker.start(settings, { signal: abortController.signal });\n      this.localTasksById.set(task.id, worker);\n    }\n\n    this.allScheduledTasks.push({\n      id: task.id,\n      scope: scope,\n      settings: settings,\n    });\n  }\n\n  createScheduledTaskRunner(\n    schedule: SchedulerServiceTaskScheduleDefinition,\n  ): SchedulerServiceTaskRunner {\n    return {\n      run: async task => {\n        await this.scheduleTask({ ...task, ...schedule });\n      },\n    };\n  }\n\n  async getScheduledTasks(): Promise<SchedulerServiceTaskDescriptor[]> {\n    return this.allScheduledTasks;\n  }\n\n  private instrumentedFunction(\n    task: SchedulerServiceTaskInvocationDefinition,\n    scope: string,\n  ): SchedulerServiceTaskFunction {\n    return async abort => {\n      const labels: Record<string, string> = {\n        taskId: task.id,\n        scope,\n      };\n      this.counter.add(1, { ...labels, result: 'started' });\n\n      const startTime = process.hrtime();\n\n      try {\n        await tracer.startActiveSpan(`task ${task.id}`, async span => {\n          try {\n            span.setAttributes(labels);\n            await task.fn(abort);\n          } catch (error) {\n            if (error instanceof Error) {\n              span.recordException(error);\n            }\n            throw error;\n          } finally {\n            span.end();\n          }\n        });\n        labels.result = 'completed';\n      } catch (ex) {\n        labels.result = 'failed';\n        throw ex;\n      } finally {\n        const delta = process.hrtime(startTime);\n        const endTime = delta[0] + delta[1] / 1e9;\n        this.counter.add(1, labels);\n        this.duration.record(endTime, labels);\n      }\n    };\n  }\n}\n\nexport function parseDuration(\n  frequency: SchedulerServiceTaskScheduleDefinition['frequency'],\n): string {\n  if (typeof frequency === 'object' && 'cron' in frequency) {\n    return frequency.cron;\n  }\n  if (typeof frequency === 'object' && 'trigger' in frequency) {\n    return frequency.trigger;\n  }\n\n  const parsed = Duration.isDuration(frequency)\n    ? frequency\n    : Duration.fromObject(frequency);\n\n  if (!parsed.isValid) {\n    throw new Error(\n      `Invalid duration, ${parsed.invalidReason}: ${parsed.invalidExplanation}`,\n    );\n  }\n\n  return parsed.toISO()!;\n}\n"],"names":["trace","TRACER_ID","metrics","TaskWorker","validateId","delegateAbortController","LocalTaskWorker","Duration"],"mappings":";;;;;;;;AAkCA,MAAM,MAAA,GAASA,SAAM,CAAA,SAAA,CAAUC,cAAS,CAAA,CAAA;AAKjC,MAAM,uBAAoD,CAAA;AAAA,EAQ/D,WAAA,CACmB,eACA,EAAA,MAAA,EACjB,aACA,EAAA;AAHiB,IAAA,IAAA,CAAA,eAAA,GAAA,eAAA,CAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AAGjB,IAAM,MAAA,KAAA,GAAQC,WAAQ,CAAA,QAAA,CAAS,SAAS,CAAA,CAAA;AACxC,IAAK,IAAA,CAAA,OAAA,GAAU,KAAM,CAAA,aAAA,CAAc,+BAAiC,EAAA;AAAA,MAClE,WAAa,EAAA,2CAAA;AAAA,KACd,CAAA,CAAA;AACD,IAAK,IAAA,CAAA,QAAA,GAAW,KAAM,CAAA,eAAA,CAAgB,kCAAoC,EAAA;AAAA,MACxE,WAAa,EAAA,iCAAA;AAAA,MACb,IAAM,EAAA,SAAA;AAAA,KACP,CAAA,CAAA;AACD,IAAK,IAAA,CAAA,iBAAA,GAAoB,IAAI,OAAA,CAAQ,CAAqB,iBAAA,KAAA;AACxD,MAAA,aAAA,EAAe,eAAgB,CAAA,MAAM,iBAAkB,CAAA,IAAI,CAAC,CAAA,CAAA;AAAA,KAC7D,CAAA,CAAA;AAAA,GACH;AAAA,EAvBiB,cAAA,uBAAqB,GAA6B,EAAA,CAAA;AAAA,EAClD,oBAAsD,EAAC,CAAA;AAAA,EACvD,iBAAA,CAAA;AAAA,EAEA,OAAA,CAAA;AAAA,EACA,QAAA,CAAA;AAAA,EAoBjB,MAAM,YAAY,EAA2B,EAAA;AAC3C,IAAA,MAAM,SAAY,GAAA,IAAA,CAAK,cAAe,CAAA,GAAA,CAAI,EAAE,CAAA,CAAA;AAC5C,IAAA,IAAI,SAAW,EAAA;AACb,MAAA,SAAA,CAAU,OAAQ,EAAA,CAAA;AAClB,MAAA,OAAA;AAAA,KACF;AAEA,IAAM,MAAA,IAAA,GAAO,MAAM,IAAA,CAAK,eAAgB,EAAA,CAAA;AACxC,IAAM,MAAAC,qBAAA,CAAW,OAAQ,CAAA,IAAA,EAAM,EAAE,CAAA,CAAA;AAAA,GACnC;AAAA,EAEA,MAAM,aACJ,IAEe,EAAA;AACf,IAAAC,eAAA,CAAW,KAAK,EAAE,CAAA,CAAA;AAClB,IAAM,MAAA,KAAA,GAAQ,KAAK,KAAS,IAAA,QAAA,CAAA;AAE5B,IAAA,MAAM,QAA2B,GAAA;AAAA,MAC/B,OAAS,EAAA,CAAA;AAAA,MACT,OAAA,EAAS,aAAc,CAAA,IAAA,CAAK,SAAS,CAAA;AAAA,MACrC,oBACE,EAAA,IAAA,CAAK,YAAgB,IAAA,aAAA,CAAc,KAAK,YAAY,CAAA;AAAA,MACtD,oBAAA,EAAsB,aAAc,CAAA,IAAA,CAAK,OAAO,CAAA;AAAA,KAClD,CAAA;AAIA,IAAM,MAAA,eAAA,GAAkBC,4BAAwB,CAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AAC3D,IAAA,IAAA,CAAK,iBAAkB,CAAA,IAAA,CAAK,MAAM,eAAA,CAAgB,OAAO,CAAA,CAAA;AAEzD,IAAA,IAAI,UAAU,QAAU,EAAA;AACtB,MAAM,MAAA,IAAA,GAAO,MAAM,IAAA,CAAK,eAAgB,EAAA,CAAA;AACxC,MAAA,MAAM,SAAS,IAAIF,qBAAA;AAAA,QACjB,IAAK,CAAA,EAAA;AAAA,QACL,IAAA,CAAK,oBAAqB,CAAA,IAAA,EAAM,KAAK,CAAA;AAAA,QACrC,IAAA;AAAA,QACA,KAAK,MAAO,CAAA,KAAA,CAAM,EAAE,IAAM,EAAA,IAAA,CAAK,IAAI,CAAA;AAAA,OACrC,CAAA;AACA,MAAA,MAAM,OAAO,KAAM,CAAA,QAAA,EAAU,EAAE,MAAQ,EAAA,eAAA,CAAgB,QAAQ,CAAA,CAAA;AAAA,KAC1D,MAAA;AACL,MAAA,MAAM,SAAS,IAAIG,+BAAA;AAAA,QACjB,IAAK,CAAA,EAAA;AAAA,QACL,IAAA,CAAK,oBAAqB,CAAA,IAAA,EAAM,KAAK,CAAA;AAAA,QACrC,KAAK,MAAO,CAAA,KAAA,CAAM,EAAE,IAAM,EAAA,IAAA,CAAK,IAAI,CAAA;AAAA,OACrC,CAAA;AACA,MAAA,MAAA,CAAO,MAAM,QAAU,EAAA,EAAE,MAAQ,EAAA,eAAA,CAAgB,QAAQ,CAAA,CAAA;AACzD,MAAA,IAAA,CAAK,cAAe,CAAA,GAAA,CAAI,IAAK,CAAA,EAAA,EAAI,MAAM,CAAA,CAAA;AAAA,KACzC;AAEA,IAAA,IAAA,CAAK,kBAAkB,IAAK,CAAA;AAAA,MAC1B,IAAI,IAAK,CAAA,EAAA;AAAA,MACT,KAAA;AAAA,MACA,QAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,0BACE,QAC4B,EAAA;AAC5B,IAAO,OAAA;AAAA,MACL,GAAA,EAAK,OAAM,IAAQ,KAAA;AACjB,QAAA,MAAM,KAAK,YAAa,CAAA,EAAE,GAAG,IAAM,EAAA,GAAG,UAAU,CAAA,CAAA;AAAA,OAClD;AAAA,KACF,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,iBAA+D,GAAA;AACnE,IAAA,OAAO,IAAK,CAAA,iBAAA,CAAA;AAAA,GACd;AAAA,EAEQ,oBAAA,CACN,MACA,KAC8B,EAAA;AAC9B,IAAA,OAAO,OAAM,KAAS,KAAA;AACpB,MAAA,MAAM,MAAiC,GAAA;AAAA,QACrC,QAAQ,IAAK,CAAA,EAAA;AAAA,QACb,KAAA;AAAA,OACF,CAAA;AACA,MAAK,IAAA,CAAA,OAAA,CAAQ,IAAI,CAAG,EAAA,EAAE,GAAG,MAAQ,EAAA,MAAA,EAAQ,WAAW,CAAA,CAAA;AAEpD,MAAM,MAAA,SAAA,GAAY,QAAQ,MAAO,EAAA,CAAA;AAEjC,MAAI,IAAA;AACF,QAAA,MAAM,OAAO,eAAgB,CAAA,CAAA,KAAA,EAAQ,KAAK,EAAE,CAAA,CAAA,EAAI,OAAM,IAAQ,KAAA;AAC5D,UAAI,IAAA;AACF,YAAA,IAAA,CAAK,cAAc,MAAM,CAAA,CAAA;AACzB,YAAM,MAAA,IAAA,CAAK,GAAG,KAAK,CAAA,CAAA;AAAA,mBACZ,KAAO,EAAA;AACd,YAAA,IAAI,iBAAiB,KAAO,EAAA;AAC1B,cAAA,IAAA,CAAK,gBAAgB,KAAK,CAAA,CAAA;AAAA,aAC5B;AACA,YAAM,MAAA,KAAA,CAAA;AAAA,WACN,SAAA;AACA,YAAA,IAAA,CAAK,GAAI,EAAA,CAAA;AAAA,WACX;AAAA,SACD,CAAA,CAAA;AACD,QAAA,MAAA,CAAO,MAAS,GAAA,WAAA,CAAA;AAAA,eACT,EAAI,EAAA;AACX,QAAA,MAAA,CAAO,MAAS,GAAA,QAAA,CAAA;AAChB,QAAM,MAAA,EAAA,CAAA;AAAA,OACN,SAAA;AACA,QAAM,MAAA,KAAA,GAAQ,OAAQ,CAAA,MAAA,CAAO,SAAS,CAAA,CAAA;AACtC,QAAA,MAAM,UAAU,KAAM,CAAA,CAAC,CAAI,GAAA,KAAA,CAAM,CAAC,CAAI,GAAA,GAAA,CAAA;AACtC,QAAK,IAAA,CAAA,OAAA,CAAQ,GAAI,CAAA,CAAA,EAAG,MAAM,CAAA,CAAA;AAC1B,QAAK,IAAA,CAAA,QAAA,CAAS,MAAO,CAAA,OAAA,EAAS,MAAM,CAAA,CAAA;AAAA,OACtC;AAAA,KACF,CAAA;AAAA,GACF;AACF,CAAA;AAEO,SAAS,cACd,SACQ,EAAA;AACR,EAAA,IAAI,OAAO,SAAA,KAAc,QAAY,IAAA,MAAA,IAAU,SAAW,EAAA;AACxD,IAAA,OAAO,SAAU,CAAA,IAAA,CAAA;AAAA,GACnB;AACA,EAAA,IAAI,OAAO,SAAA,KAAc,QAAY,IAAA,SAAA,IAAa,SAAW,EAAA;AAC3D,IAAA,OAAO,SAAU,CAAA,OAAA,CAAA;AAAA,GACnB;AAEA,EAAM,MAAA,MAAA,GAASC,eAAS,UAAW,CAAA,SAAS,IACxC,SACA,GAAAA,cAAA,CAAS,WAAW,SAAS,CAAA,CAAA;AAEjC,EAAI,IAAA,CAAC,OAAO,OAAS,EAAA;AACnB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAqB,kBAAA,EAAA,MAAA,CAAO,aAAa,CAAA,EAAA,EAAK,OAAO,kBAAkB,CAAA,CAAA;AAAA,KACzE,CAAA;AAAA,GACF;AAEA,EAAA,OAAO,OAAO,KAAM,EAAA,CAAA;AACtB;;;;;"}

package/dist/entrypoints/scheduler/lib/PluginTaskSchedulerJanitor.cjs.js

@@ -0,0 +1,59 @@
+'use strict';
+
+var tables = require('../database/tables.cjs.js');
+var util = require('./util.cjs.js');
+
+class PluginTaskSchedulerJanitor {
+  knex;
+  waitBetweenRuns;
+  logger;
+  constructor(options) {
+    this.knex = options.knex;
+    this.waitBetweenRuns = options.waitBetweenRuns;
+    this.logger = options.logger;
+  }
+  async start(abortSignal) {
+    while (!abortSignal?.aborted) {
+      try {
+        await this.runOnce();
+      } catch (e) {
+        this.logger.warn(`Error while performing janitorial tasks, ${e}`);
+      }
+      await util.sleep(this.waitBetweenRuns, abortSignal);
+    }
+  }
+  async runOnce() {
+    const dbNull = this.knex.raw("null");
+    const configClient = this.knex.client.config.client;
+    let tasks;
+    if (configClient.includes("sqlite3") || configClient.includes("mysql")) {
+      tasks = await this.knex(tables.DB_TASKS_TABLE).select("id").where("current_run_expires_at", "<", this.knex.fn.now());
+      await this.knex(tables.DB_TASKS_TABLE).whereIn(
+        "id",
+        tasks.map((t) => t.id)
+      ).update({
+        current_run_ticket: dbNull,
+        current_run_started_at: dbNull,
+        current_run_expires_at: dbNull
+      });
+    } else {
+      tasks = await this.knex(tables.DB_TASKS_TABLE).where("current_run_expires_at", "<", this.knex.fn.now()).update({
+        current_run_ticket: dbNull,
+        current_run_started_at: dbNull,
+        current_run_expires_at: dbNull
+      }).returning(["id"]);
+    }
+    if (typeof tasks === "number") {
+      if (tasks > 0) {
+        this.logger.warn(`${tasks} tasks timed out and were lost`);
+      }
+    } else {
+      for (const { id } of tasks) {
+        this.logger.warn(`Task timed out and was lost: ${id}`);
+      }
+    }
+  }
+}
+
+exports.PluginTaskSchedulerJanitor = PluginTaskSchedulerJanitor;
+//# sourceMappingURL=PluginTaskSchedulerJanitor.cjs.js.map

package/dist/entrypoints/scheduler/lib/PluginTaskSchedulerJanitor.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PluginTaskSchedulerJanitor.cjs.js","sources":["../../../../src/entrypoints/scheduler/lib/PluginTaskSchedulerJanitor.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { LoggerService } from '@backstage/backend-plugin-api';\nimport { Knex } from 'knex';\nimport { Duration } from 'luxon';\nimport { DB_TASKS_TABLE, DbTasksRow } from '../database/tables';\nimport { sleep } from './util';\n\n/**\n * Makes sure to auto-expire and clean up things that time out or for other\n * reasons should not be left lingering.\n */\nexport class PluginTaskSchedulerJanitor {\n  private readonly knex: Knex;\n  private readonly waitBetweenRuns: Duration;\n  private readonly logger: LoggerService;\n\n  constructor(options: {\n    knex: Knex;\n    waitBetweenRuns: Duration;\n    logger: LoggerService;\n  }) {\n    this.knex = options.knex;\n    this.waitBetweenRuns = options.waitBetweenRuns;\n    this.logger = options.logger;\n  }\n\n  async start(abortSignal?: AbortSignal) {\n    while (!abortSignal?.aborted) {\n      try {\n        await this.runOnce();\n      } catch (e) {\n        this.logger.warn(`Error while performing janitorial tasks, ${e}`);\n      }\n\n      await sleep(this.waitBetweenRuns, abortSignal);\n    }\n  }\n\n  private async runOnce() {\n    const dbNull = this.knex.raw('null');\n    const configClient = this.knex.client.config.client;\n\n    let tasks: Array<{ id: string }>;\n    if (configClient.includes('sqlite3') || configClient.includes('mysql')) {\n      tasks = await this.knex<DbTasksRow>(DB_TASKS_TABLE)\n        .select('id')\n        .where('current_run_expires_at', '<', this.knex.fn.now());\n      await this.knex<DbTasksRow>(DB_TASKS_TABLE)\n        .whereIn(\n          'id',\n          tasks.map(t => t.id),\n        )\n        .update({\n          current_run_ticket: dbNull,\n          current_run_started_at: dbNull,\n          current_run_expires_at: dbNull,\n        });\n    } else {\n      tasks = await this.knex<DbTasksRow>(DB_TASKS_TABLE)\n        .where('current_run_expires_at', '<', this.knex.fn.now())\n        .update({\n          current_run_ticket: dbNull,\n          current_run_started_at: dbNull,\n          current_run_expires_at: dbNull,\n        })\n        .returning(['id']);\n    }\n\n    // In rare cases, knex drivers may ignore \"returning\", and return the number\n    // of rows changed instead\n    if (typeof tasks === 'number') {\n      if (tasks > 0) {\n        this.logger.warn(`${tasks} tasks timed out and were lost`);\n      }\n    } else {\n      for (const { id } of tasks) {\n        this.logger.warn(`Task timed out and was lost: ${id}`);\n      }\n    }\n  }\n}\n"],"names":["sleep","DB_TASKS_TABLE"],"mappings":";;;;;AA0BO,MAAM,0BAA2B,CAAA;AAAA,EACrB,IAAA,CAAA;AAAA,EACA,eAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EAEjB,YAAY,OAIT,EAAA;AACD,IAAA,IAAA,CAAK,OAAO,OAAQ,CAAA,IAAA,CAAA;AACpB,IAAA,IAAA,CAAK,kBAAkB,OAAQ,CAAA,eAAA,CAAA;AAC/B,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AAAA,GACxB;AAAA,EAEA,MAAM,MAAM,WAA2B,EAAA;AACrC,IAAO,OAAA,CAAC,aAAa,OAAS,EAAA;AAC5B,MAAI,IAAA;AACF,QAAA,MAAM,KAAK,OAAQ,EAAA,CAAA;AAAA,eACZ,CAAG,EAAA;AACV,QAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAA4C,yCAAA,EAAA,CAAC,CAAE,CAAA,CAAA,CAAA;AAAA,OAClE;AAEA,MAAM,MAAAA,UAAA,CAAM,IAAK,CAAA,eAAA,EAAiB,WAAW,CAAA,CAAA;AAAA,KAC/C;AAAA,GACF;AAAA,EAEA,MAAc,OAAU,GAAA;AACtB,IAAA,MAAM,MAAS,GAAA,IAAA,CAAK,IAAK,CAAA,GAAA,CAAI,MAAM,CAAA,CAAA;AACnC,IAAA,MAAM,YAAe,GAAA,IAAA,CAAK,IAAK,CAAA,MAAA,CAAO,MAAO,CAAA,MAAA,CAAA;AAE7C,IAAI,IAAA,KAAA,CAAA;AACJ,IAAA,IAAI,aAAa,QAAS,CAAA,SAAS,KAAK,YAAa,CAAA,QAAA,CAAS,OAAO,CAAG,EAAA;AACtE,MAAA,KAAA,GAAQ,MAAM,IAAA,CAAK,IAAiB,CAAAC,qBAAc,EAC/C,MAAO,CAAA,IAAI,CACX,CAAA,KAAA,CAAM,0BAA0B,GAAK,EAAA,IAAA,CAAK,IAAK,CAAA,EAAA,CAAG,KAAK,CAAA,CAAA;AAC1D,MAAM,MAAA,IAAA,CAAK,IAAiB,CAAAA,qBAAc,CACvC,CAAA,OAAA;AAAA,QACC,IAAA;AAAA,QACA,KAAM,CAAA,GAAA,CAAI,CAAK,CAAA,KAAA,CAAA,CAAE,EAAE,CAAA;AAAA,QAEpB,MAAO,CAAA;AAAA,QACN,kBAAoB,EAAA,MAAA;AAAA,QACpB,sBAAwB,EAAA,MAAA;AAAA,QACxB,sBAAwB,EAAA,MAAA;AAAA,OACzB,CAAA,CAAA;AAAA,KACE,MAAA;AACL,MAAA,KAAA,GAAQ,MAAM,IAAA,CAAK,IAAiB,CAAAA,qBAAc,EAC/C,KAAM,CAAA,wBAAA,EAA0B,GAAK,EAAA,IAAA,CAAK,IAAK,CAAA,EAAA,CAAG,GAAI,EAAC,EACvD,MAAO,CAAA;AAAA,QACN,kBAAoB,EAAA,MAAA;AAAA,QACpB,sBAAwB,EAAA,MAAA;AAAA,QACxB,sBAAwB,EAAA,MAAA;AAAA,OACzB,CAAA,CACA,SAAU,CAAA,CAAC,IAAI,CAAC,CAAA,CAAA;AAAA,KACrB;AAIA,IAAI,IAAA,OAAO,UAAU,QAAU,EAAA;AAC7B,MAAA,IAAI,QAAQ,CAAG,EAAA;AACb,QAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAAG,EAAA,KAAK,CAAgC,8BAAA,CAAA,CAAA,CAAA;AAAA,OAC3D;AAAA,KACK,MAAA;AACL,MAAW,KAAA,MAAA,EAAE,EAAG,EAAA,IAAK,KAAO,EAAA;AAC1B,QAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAAgC,6BAAA,EAAA,EAAE,CAAE,CAAA,CAAA,CAAA;AAAA,OACvD;AAAA,KACF;AAAA,GACF;AACF;;;;"}