paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 43 Packages Projects Releases Wiki Activity
Files
cf5cc4c8a0bdf30fc1c777c348eef0cc514b4563
backstage/packages/backend-tasks/CHANGELOG.md
T
github-actions[bot] 356906bab8 Version Packages (next)
2023-11-28 13:37:18 +00:00

26 KiB
Raw Blame History

@backstage/backend-tasks

0.5.13-next.1

Patch Changes

0.5.13-next.0

Patch Changes

  • d8f488aaa8: Allow tasks to run more often that the default work check interval, which is 5 seconds.
  • Updated dependencies

0.5.12

Patch Changes

  • 013611b42e: knex has been bumped to major version 3 and better-sqlite3 to major version 9, which deprecate node 16 support.
  • Updated dependencies

0.5.12-next.2

Patch Changes

0.5.12-next.1

Patch Changes

0.5.12-next.0

Patch Changes

0.5.11

Patch Changes

  • 5db102bfdf: Instrument backend-tasks with some counters and histograms for duration.

    backend_tasks.task.runs.count: Counter with the total number of times a task has been run. backend_tasks.task.runs.duration: Histogram with the run durations for each task.

    Both these metrics have come with result taskId and scope labels for finer grained grouping.

  • ddd76ac98d: Fix bug where backend tasks that are defined with HumanDuration are immediately triggered on application startup

  • Updated dependencies

0.5.11-next.2

Patch Changes

  • Updated dependencies

0.5.10-next.1

Patch Changes

  • 5db102bfdf: Instrument backend-tasks with some counters and histograms for duration.

    backend_tasks.task.runs.count: Counter with the total number of times a task has been run. backend_tasks.task.runs.duration: Histogram with the run durations for each task.

    Both these metrics have come with result taskId and scope labels for finer grained grouping.

  • ddd76ac98d: Fix bug where backend tasks that are defined with HumanDuration are immediately triggered on application startup

  • Updated dependencies

0.5.10-next.0

Patch Changes

0.5.8

Patch Changes

  • 8fd91547cd: When starting a task that existed before, with a faster schedule than it previously had, the task will now correctly obey the faster schedule immediately. Before this fix, the new schedule was only obeyed after the next pending (according to the old schedule) run had completed.
  • 62f448edb0: Use readDurationFromConfig from the config package
  • 74604806aa: Avoid starting task janitor in tests.
  • cfc3ca6ce0: Changes needed to support MySQL
  • 814feeed73: Update to handle invalid luxon values
  • Updated dependencies

0.5.8-next.3

Patch Changes

  • Updated dependencies

0.5.8-next.2

Patch Changes

0.5.8-next.1

Patch Changes

  • 62f448edb0: Use readDurationFromConfig from the config package
  • Updated dependencies

0.5.7-next.0

Patch Changes

0.5.5

Patch Changes

  • dfd1b6b2fc: Make readTaskScheduleDefinitionFromConfig properly handle bad inputs
  • Updated dependencies

0.5.5-next.2

Patch Changes

0.5.5-next.1

Patch Changes

0.5.5-next.0

Patch Changes

0.5.4

Patch Changes

0.5.4-next.0

Patch Changes

0.5.3

Patch Changes

0.5.3-next.2

Patch Changes

0.5.3-next.1

Patch Changes

0.5.3-next.0

Patch Changes

0.5.2

Patch Changes

0.5.2-next.1

Patch Changes

0.5.2-next.0

Patch Changes

0.5.1

Patch Changes

0.5.1-next.2

Patch Changes

0.5.1-next.1

Patch Changes

0.5.1-next.0

Patch Changes

0.5.0

Minor Changes

  • 1578276708: add functionality to get descriptions from the scheduler for triggering

Patch Changes

  • f0685193ef: Added the adapted query to mysql and sqlite3 databases to not returning warning on logs
  • 482dae5de1: Updated link to docs.
  • Updated dependencies

0.5.0-next.2

Minor Changes

  • 1578276708: add functionality to get descriptions from the scheduler for triggering

Patch Changes

0.4.4-next.1

Patch Changes

0.4.4-next.0

Patch Changes

  • f0685193ef: Added the adapted query to mysql and sqlite3 databases to not returning warning on logs
  • Updated dependencies

0.4.3

Patch Changes

0.4.3-next.2

Patch Changes

0.4.3-next.1

Patch Changes

0.4.3-next.0

Patch Changes

0.4.1

Patch Changes

  • 3fad4ed40a: Added a new static TaskScheduler.forPlugin method.
  • b99c030f1b: Minor internal refactor to avoid import cycle issue.
  • Updated dependencies

0.4.1-next.1

Patch Changes

  • b99c030f1b: Minor internal refactor to avoid import cycle issue.
  • Updated dependencies

0.4.1-next.0

Patch Changes

0.4.0

Minor Changes

  • de8a975911: Changed to use native AbortController and AbortSignal from Node.js, instead of the one from node-abort-controller. This is possible now that the minimum supported Node.js version of the project is 16.

    Note that their interfaces are very slightly different, but typically not in a way that matters to consumers. If you see any typescript errors as a direct result from this, they are compatible with each other in the ways that we interact with them, and should be possible to type-cast across without ill effects.

Patch Changes

  • b05dcd5530: Move the zod dependency to a version that does not collide with other libraries
  • Updated dependencies

0.4.0-next.3

Patch Changes

  • b05dcd5530: Move the zod dependency to a version that does not collide with other libraries
  • Updated dependencies

0.4.0-next.2

Patch Changes

  • Updated dependencies

0.4.0-next.1

Minor Changes

  • de8a975911: Changed to use native AbortController and AbortSignal from Node.js, instead of the one from node-abort-controller. This is possible now that the minimum supported Node.js version of the project is 16.

    Note that their interfaces are very slightly different, but typically not in a way that matters to consumers. If you see any typescript errors as a direct result from this, they are compatible with each other in the ways that we interact with them, and should be possible to type-cast across without ill effects.

Patch Changes

  • Updated dependencies

0.3.8-next.0

Patch Changes

  • Updated dependencies

0.3.7

Patch Changes

  • 30e43717c7: Deprecated the HumanDuration type, which should now instead be imported from @backstage/types.
  • Updated dependencies

0.3.7-next.1

Patch Changes

  • Updated dependencies

0.3.7-next.0

Patch Changes

  • 30e43717c7: Deprecated the HumanDuration type, which should now instead be imported from @backstage/types.
  • Updated dependencies

0.3.6

Patch Changes

  • d4fea86ea3: Added new function readTaskScheduleDefinitionFromConfig to read TaskScheduleDefinition (aka. schedule) from the Config.
  • Updated dependencies

0.3.6-next.2

Patch Changes

  • d4fea86ea3: Added new function readTaskScheduleDefinitionFromConfig to read TaskScheduleDefinition (aka. schedule) from the Config.
  • Updated dependencies

0.3.6-next.1

Patch Changes

  • Updated dependencies

0.3.6-next.0

Patch Changes

  • Updated dependencies

0.3.5

Patch Changes

0.3.5-next.1

Patch Changes

0.3.5-next.0

Patch Changes

0.3.4

Patch Changes

0.3.4-next.0

Patch Changes

0.3.3

Patch Changes

0.3.3-next.3

Patch Changes

0.3.3-next.2

Patch Changes

0.3.3-next.1

Patch Changes

0.3.3-next.0

Patch Changes

0.3.2

Patch Changes

  • fde10d24f6: Allow tasks that fail to retry on a loop emitting a warning log every time it fails with the amount of attempts it has
  • f7146b516f: Updated dependency cron to ^2.0.0. Updated dependency @types/cron to ^2.0.0.
  • 7f108513b8: Add error logging when a background task throws an error rather than silently swallowing it.
  • Updated dependencies

0.3.2-next.2

Patch Changes

0.3.2-next.1

Patch Changes

  • f7146b516f: Updated dependency cron to ^2.0.0. Updated dependency @types/cron to ^2.0.0.
  • 7f108513b8: Add error logging when a background task throws an error rather than silently swallowing it.
  • Updated dependencies

0.3.2-next.0

Patch Changes

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

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

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

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

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

0.2.2-next.0

Patch Changes

0.2.1

Patch Changes

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

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

0.1.10

Patch Changes

0.1.9

Patch Changes

0.1.8

Patch Changes

  • Fix for the previous release with missing type declarations.
  • Updated dependencies

0.1.7

Patch Changes

0.1.6

Patch Changes

0.1.6-next.0

Patch Changes

0.1.5

Patch Changes

0.1.5-next.0

Patch Changes

0.1.4

Patch Changes

0.1.4-next.0

Patch Changes

0.1.3

Patch Changes

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

0.1.1

Patch Changes

Reference in New Issue View Git Blame Copy Permalink