From b753d22a564249f547c24f601d782acf0c98a82f Mon Sep 17 00:00:00 2001 From: blam Date: Thu, 3 Mar 2022 10:26:49 +0100 Subject: [PATCH] chore: added changeset and added logging Signed-off-by: blam --- .changeset/wild-dolphins-lick.md | 7 +++++++ plugins/catalog-backend/src/service/CatalogBuilder.ts | 8 +++++++- 2 files changed, 14 insertions(+), 1 deletion(-) create mode 100644 .changeset/wild-dolphins-lick.md diff --git a/.changeset/wild-dolphins-lick.md b/.changeset/wild-dolphins-lick.md new file mode 100644 index 0000000000..cdd5827b00 --- /dev/null +++ b/.changeset/wild-dolphins-lick.md @@ -0,0 +1,7 @@ +--- +'@backstage/plugin-catalog-backend': patch +--- + +**DEPRECATION**: Deprecated the `RefreshIntervalFunction` and `createRandomRefreshInterval` in favour of the `ProcessingIntervalFunction` and `createRandomProcessingInterval` type and method respectively. Please migrate to use the new names. + +**DEPRECATION**: Deprecated the `setRefreshInterval` and `setRefreshIntervalSeconds` methods on the `CatalogBuilder` for the new `setProcessingInterval` and `setProcessingIntervalSeconds` methods. Please migrate to use the new names. diff --git a/plugins/catalog-backend/src/service/CatalogBuilder.ts b/plugins/catalog-backend/src/service/CatalogBuilder.ts index ce55bc5937..3d7de6ba95 100644 --- a/plugins/catalog-backend/src/service/CatalogBuilder.ts +++ b/plugins/catalog-backend/src/service/CatalogBuilder.ts @@ -196,7 +196,10 @@ export class CatalogBuilder { * * @deprecated use {@link CatalogBuilder#setProcessingIntervalSeconds} instead */ - setRefreshIntervalSeconds(seconds: number): CatalogBuilder { + setRefreshIntervalSecon0ds(seconds: number): CatalogBuilder { + this.env.logger.warn( + '[DEPRECATION] - CatalogBuilder.setRefreshIntervalSeconds is deprecated. Use CatalogBuilder.setProcessingIntervalSeconds instead.', + ); this.processingInterval = createRandomProcessingInterval({ minSeconds: seconds, maxSeconds: seconds * 1.5, @@ -225,6 +228,9 @@ export class CatalogBuilder { * @deprecated use {@link CatalogBuilder#setProcessingInterval} instead */ setRefreshInterval(refreshInterval: RefreshIntervalFunction): CatalogBuilder { + this.env.logger.warn( + '[DEPRECATION] - CatalogBuilder.setRefreshInterval is deprecated. Use CatalogBuilder.setProcessingInterval instead.', + ); this.processingInterval = refreshInterval; return this; }