From 5dc5f4f8ba7a7e7d4b1891ed9c2d9c7e6e131322 Mon Sep 17 00:00:00 2001
From: Phil Kuang <pkuang@factset.com>
Date: Wed, 3 Apr 2024 22:16:06 -0400
Subject: [PATCH] refactor(collators): allow tokenManager param to be optional

Signed-off-by: Phil Kuang <pkuang@factset.com>
---
 .changeset/wild-seahorses-grin.md                           | 6 ++++++
 plugins/search-backend-module-catalog/api-report.md         | 2 +-
 .../src/collators/DefaultCatalogCollatorFactory.ts          | 4 +---
 plugins/search-backend-module-techdocs/api-report.md        | 2 +-
 .../src/collators/DefaultTechDocsCollatorFactory.ts         | 2 +-
 5 files changed, 10 insertions(+), 6 deletions(-)
 create mode 100644 .changeset/wild-seahorses-grin.md

diff --git a/.changeset/wild-seahorses-grin.md b/.changeset/wild-seahorses-grin.md
new file mode 100644
index 0000000000..94b30a6839
--- /dev/null
+++ b/.changeset/wild-seahorses-grin.md
@@ -0,0 +1,6 @@
+---
+'@backstage/plugin-search-backend-module-techdocs': patch
+'@backstage/plugin-search-backend-module-catalog': patch
+---
+
+Allow the `tokenManager` parameter to be optional when instantiating collator
diff --git a/plugins/search-backend-module-catalog/api-report.md b/plugins/search-backend-module-catalog/api-report.md
index fc19ede2d4..8019ab0aac 100644
--- a/plugins/search-backend-module-catalog/api-report.md
+++ b/plugins/search-backend-module-catalog/api-report.md
@@ -44,7 +44,7 @@ export class DefaultCatalogCollatorFactory implements DocumentCollatorFactory {
 export type DefaultCatalogCollatorFactoryOptions = {
   auth?: AuthService;
   discovery: PluginEndpointDiscovery;
-  tokenManager: TokenManager;
+  tokenManager?: TokenManager;
   locationTemplate?: string;
   filter?: GetEntitiesRequest['filter'];
   batchSize?: number;
diff --git a/plugins/search-backend-module-catalog/src/collators/DefaultCatalogCollatorFactory.ts b/plugins/search-backend-module-catalog/src/collators/DefaultCatalogCollatorFactory.ts
index 166985f2d5..22dcc67233 100644
--- a/plugins/search-backend-module-catalog/src/collators/DefaultCatalogCollatorFactory.ts
+++ b/plugins/search-backend-module-catalog/src/collators/DefaultCatalogCollatorFactory.ts
@@ -40,7 +40,7 @@ import { AuthService } from '@backstage/backend-plugin-api';
 export type DefaultCatalogCollatorFactoryOptions = {
   auth?: AuthService;
   discovery: PluginEndpointDiscovery;
-  tokenManager: TokenManager;
+  tokenManager?: TokenManager;
   /**
    * @deprecated Use the config key `search.collators.catalog.locationTemplate` instead.
    */
@@ -95,7 +95,6 @@ export class DefaultCatalogCollatorFactory implements DocumentCollatorFactory {
       entityTransformer: options.entityTransformer,
       auth: adaptedAuth,
       discovery: options.discovery,
-      tokenManager: options.tokenManager,
       catalogClient: options.catalogClient,
     });
   }
@@ -107,7 +106,6 @@ export class DefaultCatalogCollatorFactory implements DocumentCollatorFactory {
     entityTransformer?: CatalogCollatorEntityTransformer;
     auth: AuthService;
     discovery: PluginEndpointDiscovery;
-    tokenManager: TokenManager;
     catalogClient?: CatalogApi;
   }) {
     const {
diff --git a/plugins/search-backend-module-techdocs/api-report.md b/plugins/search-backend-module-techdocs/api-report.md
index fbdecef2a8..35cf8533cf 100644
--- a/plugins/search-backend-module-techdocs/api-report.md
+++ b/plugins/search-backend-module-techdocs/api-report.md
@@ -45,7 +45,7 @@ export type TechDocsCollatorEntityTransformer = (
 export type TechDocsCollatorFactoryOptions = {
   discovery: PluginEndpointDiscovery;
   logger: LoggerService;
-  tokenManager: TokenManager;
+  tokenManager?: TokenManager;
   auth?: AuthService;
   httpAuth?: HttpAuthService;
   locationTemplate?: string;
diff --git a/plugins/search-backend-module-techdocs/src/collators/DefaultTechDocsCollatorFactory.ts b/plugins/search-backend-module-techdocs/src/collators/DefaultTechDocsCollatorFactory.ts
index ad820e6ad2..10c09d02b2 100644
--- a/plugins/search-backend-module-techdocs/src/collators/DefaultTechDocsCollatorFactory.ts
+++ b/plugins/search-backend-module-techdocs/src/collators/DefaultTechDocsCollatorFactory.ts
@@ -61,7 +61,7 @@ interface MkSearchIndexDoc {
 export type TechDocsCollatorFactoryOptions = {
   discovery: PluginEndpointDiscovery;
   logger: LoggerService;
-  tokenManager: TokenManager;
+  tokenManager?: TokenManager;
   auth?: AuthService;
   httpAuth?: HttpAuthService;
   locationTemplate?: string;