From a5013957e40d042638e25f762e86f67b06edab5b Mon Sep 17 00:00:00 2001 From: Roy Jacobs Date: Thu, 2 Sep 2021 15:10:15 +0200 Subject: [PATCH] Update the 'create-app' template to use the new constructor for DefaultCatalogCollator Signed-off-by: Roy Jacobs --- .changeset/fast-wasps-matter.md | 23 +++++++++++++++++++ .../packages/backend/src/plugins/search.ts | 3 ++- 2 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 .changeset/fast-wasps-matter.md diff --git a/.changeset/fast-wasps-matter.md b/.changeset/fast-wasps-matter.md new file mode 100644 index 0000000000..6b6a682a37 --- /dev/null +++ b/.changeset/fast-wasps-matter.md @@ -0,0 +1,23 @@ +--- +'@backstage/create-app': patch +--- + +Updated the search configuration class to use the static `fromConfig`-based constructor for the `DefaultCatalogCollator`. + +To apply this change to an existing app, replace the following line in `search.ts`: + +```diff +-collator: new DefaultCatalogCollator({ discovery }) ++collator: DefaultCatalogCollator.fromConfig(config, { discovery }) +``` + +The `config` parameter was not needed before, so make sure you also add that in the signature of `createPlugin` +in `search.ts`: + +```diff +export default async function createPlugin({ + logger, + discovery, ++ config, +}: PluginEnvironment) { +``` diff --git a/packages/create-app/templates/default-app/packages/backend/src/plugins/search.ts b/packages/create-app/templates/default-app/packages/backend/src/plugins/search.ts index 248ed37ea8..7fc317d23d 100644 --- a/packages/create-app/templates/default-app/packages/backend/src/plugins/search.ts +++ b/packages/create-app/templates/default-app/packages/backend/src/plugins/search.ts @@ -10,6 +10,7 @@ import { DefaultCatalogCollator } from '@backstage/plugin-catalog-backend'; export default async function createPlugin({ logger, discovery, + config, }: PluginEnvironment) { // Initialize a connection to a search engine. const searchEngine = new LunrSearchEngine({ logger }); @@ -19,7 +20,7 @@ export default async function createPlugin({ // particular collator gathers entities from the software catalog. indexBuilder.addCollator({ defaultRefreshIntervalSeconds: 600, - collator: new DefaultCatalogCollator({ discovery }), + collator: DefaultCatalogCollator.fromConfig(config, { discovery }), }); // The scheduler controls when documents are gathered from collators and sent