From a64064f0d3e5e9ec19884d02a45c10bd5a0c0735 Mon Sep 17 00:00:00 2001 From: Morgan Date: Mon, 10 Oct 2022 15:31:43 +0200 Subject: [PATCH 1/3] add optional argument to createRouter to allow injection of CatalogClient to techdocs backend Signed-off-by: Morgan --- plugins/techdocs-backend/src/service/router.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/plugins/techdocs-backend/src/service/router.ts b/plugins/techdocs-backend/src/service/router.ts index ca887efce2..d02d787282 100644 --- a/plugins/techdocs-backend/src/service/router.ts +++ b/plugins/techdocs-backend/src/service/router.ts @@ -58,6 +58,7 @@ export type OutOfTheBoxDeploymentOptions = { cache: PluginCacheManager; docsBuildStrategy?: DocsBuildStrategy; buildLogTransport?: winston.transport; + catalogClient?: CatalogClient; }; /** @@ -74,6 +75,7 @@ export type RecommendedDeploymentOptions = { cache: PluginCacheManager; docsBuildStrategy?: DocsBuildStrategy; buildLogTransport?: winston.transport; + catalogClient?: CatalogClient; }; /** @@ -107,7 +109,7 @@ export async function createRouter( ): Promise { const router = Router(); const { publisher, config, logger, discovery } = options; - const catalogClient = new CatalogClient({ discoveryApi: discovery }); + const catalogClient = options.catalogClient ?? new CatalogClient({ discoveryApi: discovery }); const docsBuildStrategy = options.docsBuildStrategy ?? DefaultDocsBuildStrategy.fromConfig(config); const buildLogTransport = From 7ced1b4076bb06247030a162122c389d4558331f Mon Sep 17 00:00:00 2001 From: Morgan Date: Mon, 10 Oct 2022 15:39:43 +0200 Subject: [PATCH 2/3] add changeset and api-report Signed-off-by: Morgan --- .changeset/techdocs-olive-worms-yell.md | 5 +++++ plugins/techdocs-backend/api-report.md | 3 +++ 2 files changed, 8 insertions(+) create mode 100644 .changeset/techdocs-olive-worms-yell.md diff --git a/.changeset/techdocs-olive-worms-yell.md b/.changeset/techdocs-olive-worms-yell.md new file mode 100644 index 0000000000..cc72b9883b --- /dev/null +++ b/.changeset/techdocs-olive-worms-yell.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-techdocs-backend': minor +--- + +Add optional catalogClient argument to createRouter parameters diff --git a/plugins/techdocs-backend/api-report.md b/plugins/techdocs-backend/api-report.md index 57e5e5170f..1f6aa1d66a 100644 --- a/plugins/techdocs-backend/api-report.md +++ b/plugins/techdocs-backend/api-report.md @@ -6,6 +6,7 @@ /// import { CatalogApi } from '@backstage/catalog-client'; +import { CatalogClient } from '@backstage/catalog-client'; import { Config } from '@backstage/config'; import { DocumentCollatorFactory } from '@backstage/plugin-search-common'; import { Entity } from '@backstage/catalog-model'; @@ -79,6 +80,7 @@ export type OutOfTheBoxDeploymentOptions = { cache: PluginCacheManager; docsBuildStrategy?: DocsBuildStrategy; buildLogTransport?: winston.transport; + catalogClient?: CatalogClient; }; // @public @@ -90,6 +92,7 @@ export type RecommendedDeploymentOptions = { cache: PluginCacheManager; docsBuildStrategy?: DocsBuildStrategy; buildLogTransport?: winston.transport; + catalogClient?: CatalogClient; }; // @public From 847eb6fdcee58624b6e6ddee0348d2d5bbed3de2 Mon Sep 17 00:00:00 2001 From: Morgan Date: Tue, 11 Oct 2022 09:45:50 +0200 Subject: [PATCH 3/3] format and add backticks to changeset file Signed-off-by: Morgan --- .changeset/techdocs-olive-worms-yell.md | 2 +- plugins/techdocs-backend/src/service/router.ts | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.changeset/techdocs-olive-worms-yell.md b/.changeset/techdocs-olive-worms-yell.md index cc72b9883b..66b205fc19 100644 --- a/.changeset/techdocs-olive-worms-yell.md +++ b/.changeset/techdocs-olive-worms-yell.md @@ -2,4 +2,4 @@ '@backstage/plugin-techdocs-backend': minor --- -Add optional catalogClient argument to createRouter parameters +Add optional `catalogClient` argument to `createRoute` parameters diff --git a/plugins/techdocs-backend/src/service/router.ts b/plugins/techdocs-backend/src/service/router.ts index d02d787282..855d8b02f4 100644 --- a/plugins/techdocs-backend/src/service/router.ts +++ b/plugins/techdocs-backend/src/service/router.ts @@ -109,7 +109,8 @@ export async function createRouter( ): Promise { const router = Router(); const { publisher, config, logger, discovery } = options; - const catalogClient = options.catalogClient ?? new CatalogClient({ discoveryApi: discovery }); + const catalogClient = + options.catalogClient ?? new CatalogClient({ discoveryApi: discovery }); const docsBuildStrategy = options.docsBuildStrategy ?? DefaultDocsBuildStrategy.fromConfig(config); const buildLogTransport =