backstage/packages/backend-tasks/CHANGELOG.md

@backstage/backend-tasks

0.3.1

Patch Changes

• 73480846dd: TaskScheduleDefinition has been updated to also accept an options object containing duration information in the form of days, hours, seconds and so on. This allows for scheduling without importing luxon.

  -import { Duration } from 'luxon';
  // omitted other code
  
  const schedule = env.scheduler.createScheduledTaskRunner({
  -  frequency: Duration.fromObject({ minutes: 10 }),
  -  timeout: Duration.fromObject({ minutes: 15 }),
  +  frequency: { minutes: 10 },
  +  timeout: { minutes: 15 },
     // omitted other code
  });
  

• cfd779a9bc: Scheduled tasks now have an optional scope field. If unset, or having the value 'global', the old behavior with cross-worker locking is retained. If having the value 'local', there is no coordination across workers and the behavior is more like setInterval. This can be used to replace usages of runPeriodically helpers.

• ebbec677e1: Correctly set next run time for tasks

• Updated dependencies

  • @backstage/backend-common@0.13.3
  • @backstage/config@1.0.1

0.3.1-next.1

Patch Changes

• 73480846dd: TaskScheduleDefinition has been updated to also accept an options object containing duration information in the form of days, hours, seconds and so on. This allows for scheduling without importing luxon.

  -import { Duration } from 'luxon';
  // omitted other code
  
  const schedule = env.scheduler.createScheduledTaskRunner({
  -  frequency: Duration.fromObject({ minutes: 10 }),
  -  timeout: Duration.fromObject({ minutes: 15 }),
  +  frequency: { minutes: 10 },
  +  timeout: { minutes: 15 },
     // omitted other code
  });
  

• ebbec677e1: Correctly set next run time for tasks

• Updated dependencies

  • @backstage/backend-common@0.13.3-next.2
  • @backstage/config@1.0.1-next.0

0.3.1-next.0

Patch Changes

• cfd779a9bc: Scheduled tasks now have an optional scope field. If unset, or having the value 'global', the old behavior with cross-worker locking is retained. If having the value 'local', there is no coordination across workers and the behavior is more like setInterval. This can be used to replace usages of runPeriodically helpers.
• Updated dependencies
  • @backstage/backend-common@0.13.3-next.0

0.3.0

Minor Changes

• ab008a0988: Adds the ability to manually trigger tasks which are registered

Patch Changes

• bdd2773202: Refactored the internal TaskWorker class to make it easier to test.

• a83babdd63: Fixed the initialDelay parameter of tasks to properly make task workers always wait before the first invocations on startup, not just the very first time that the task is ever created. This behavior is more in line with expectations. Callers to not need to update their code.

  Also clarified in the doc comment for the field that this wait applies only on an individual worker level. That is, if you have a cluster of workers then each individual machine may postpone its first task invocation by the given amount of time to leave room for the service to settle, but other workers may still continue to invoke the task on the regular cadence in the meantime.

• Updated dependencies

  • @backstage/backend-common@0.13.2

0.3.0-next.2

Patch Changes

• a83babdd63: Fixed the initialDelay parameter of tasks to properly make task workers always wait before the first invocations on startup, not just the very first time that the task is ever created. This behavior is more in line with expectations. Callers to not need to update their code.

  Also clarified in the doc comment for the field that this wait applies only on an individual worker level. That is, if you have a cluster of workers then each individual machine may postpone its first task invocation by the given amount of time to leave room for the service to settle, but other workers may still continue to invoke the task on the regular cadence in the meantime.

0.3.0-next.1

Minor Changes

• ab008a0988: Adds the ability to manually trigger tasks which are registered

Patch Changes

• bdd2773202: Refactored the internal TaskWorker class to make it easier to test.
• Updated dependencies
  • @backstage/backend-common@0.13.2-next.1

0.2.2-next.0

Patch Changes

• Updated dependencies
  • @backstage/backend-common@0.13.2-next.0

0.2.1

Patch Changes

• efc73db10c: Use better-sqlite3 instead of @vscode/sqlite3
• Updated dependencies
  • @backstage/backend-common@0.13.1
  • @backstage/config@1.0.0
  • @backstage/errors@1.0.0
  • @backstage/types@1.0.0

0.2.0

Minor Changes

• 9461f73643: BREAKING: The TaskDefinition type has been removed, and replaced by the equal pair TaskScheduleDefinition and TaskInvocationDefinition. The interface for PluginTaskScheduler.scheduleTask stays effectively unchanged, so this only affects you if you use the actual types directly.

  Added the method PluginTaskScheduler.createTaskSchedule, which returns a TaskSchedule wrapper that is convenient to pass down into classes that want to control their task invocations while the caller wants to retain control of the actual schedule chosen.

Patch Changes

• ab7cd7d70e: Do some groundwork for supporting the better-sqlite3 driver, to maybe eventually replace @vscode/sqlite3 (#9912)
• 7290dda9d4: Relaxed the task ID requirement to now support any non-empty string
• ae2ed04076: Add support for cron syntax to configure task frequency - TaskScheduleDefinition.frequency can now be both a Duration and an object on the form { cron: string }, where the latter is expected to be on standard crontab format (e.g. '0 */2 * * *').
• Updated dependencies
  • @backstage/backend-common@0.13.0

0.2.0-next.0

Minor Changes

• 9461f73643: BREAKING: The TaskDefinition type has been removed, and replaced by the equal pair TaskScheduleDefinition and TaskInvocationDefinition. The interface for PluginTaskScheduler.scheduleTask stays effectively unchanged, so this only affects you if you use the actual types directly.

  Added the method PluginTaskScheduler.createTaskSchedule, which returns a TaskSchedule wrapper that is convenient to pass down into classes that want to control their task invocations while the caller wants to retain control of the actual schedule chosen.

Patch Changes

• ab7cd7d70e: Do some groundwork for supporting the better-sqlite3 driver, to maybe eventually replace @vscode/sqlite3 (#9912)
• 7290dda9d4: Relaxed the task ID requirement to now support any non-empty string
• Updated dependencies
  • @backstage/backend-common@0.13.0-next.0

0.1.10

Patch Changes

• Updated dependencies
  • @backstage/backend-common@0.12.0

0.1.9

Patch Changes

• dc97845422: Only output janitor logs when actually timing out tasks
• Updated dependencies
  • @backstage/backend-common@0.11.0

0.1.8

Patch Changes

• Fix for the previous release with missing type declarations.
• Updated dependencies
  • @backstage/backend-common@0.10.9
  • @backstage/config@0.1.15
  • @backstage/errors@0.2.2
  • @backstage/types@0.1.3

0.1.7

Patch Changes

• c77c5c7eb6: Added backstage.role to package.json
• Updated dependencies
  • @backstage/backend-common@0.10.8
  • @backstage/errors@0.2.1
  • @backstage/config@0.1.14
  • @backstage/types@0.1.2

0.1.6

Patch Changes

• 2441d1cf59: chore(deps): bump knex from 0.95.6 to 1.0.2

  This also replaces sqlite3 with @vscode/sqlite3 5.0.7

• Updated dependencies

  • @backstage/backend-common@0.10.7

0.1.6-next.0

Patch Changes

• 2441d1cf59: chore(deps): bump knex from 0.95.6 to 1.0.2

  This also replaces sqlite3 with @vscode/sqlite3 5.0.7

• Updated dependencies

  • @backstage/backend-common@0.10.7-next.0

0.1.5

Patch Changes

• Updated dependencies
  • @backstage/backend-common@0.10.6

0.1.5-next.0

Patch Changes

• Updated dependencies
  • @backstage/backend-common@0.10.6-next.0

0.1.4

Patch Changes

• Updated dependencies
  • @backstage/backend-common@0.10.4
  • @backstage/config@0.1.13

0.1.4-next.0

Patch Changes

• Updated dependencies
  • @backstage/backend-common@0.10.4-next.0
  • @backstage/config@0.1.13-next.0

0.1.3

Patch Changes

• Updated dependencies
  • @backstage/config@0.1.12
  • @backstage/backend-common@0.10.3
  • @backstage/errors@0.2.0

0.1.2

Patch Changes

• e188b37024: Updated README to clarify the following:

  • Dashes cannot be used in the id, changed to an underscore in the example
  • The timeout is required, this was also added to the example
  • Added a note about tasks not running as expected for local development using persistent database

• Updated dependencies

  • @backstage/backend-common@0.10.2

0.1.1

Patch Changes

• Updated dependencies
  • @backstage/backend-common@0.10.0