@backstage/plugin-search-backend-module-explore 0.1.4-next.1 → 0.1.4

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @backstage/plugin-search-backend-module-explore
 
+## 0.1.4
+
+### Patch Changes
+
+- 629cbd194a87: Use `coreServices.rootConfig` instead of `coreService.config`
+- 29f77f923c71: Ensure that all services are dependency injected into the module instead of taken from options
+- 12a8c94eda8d: Add package repository and homepage metadata
+- 6694e79ab396: Breaking change for the alpha export moved `schedule` from module options into app-config for the new backend system. You can now pass in a `TaskScheduleDefinitionConfig` through the `search.collators.explore.schedule` configuration key.
+- Updated dependencies
+  - @backstage/backend-common@0.19.2
+  - @backstage/backend-plugin-api@0.6.0
+  - @backstage/plugin-search-backend-node@1.2.4
+  - @backstage/backend-tasks@0.5.5
+  - @backstage/config@1.0.8
+  - @backstage/plugin-explore-common@0.0.1
+  - @backstage/plugin-search-common@1.2.5
+
+## 0.1.4-next.2
+
+### Patch Changes
+
+- 29f77f923c71: Ensure that all services are dependency injected into the module instead of taken from options
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.6.0-next.2
+  - @backstage/backend-tasks@0.5.5-next.2
+  - @backstage/backend-common@0.19.2-next.2
+  - @backstage/plugin-search-backend-node@1.2.4-next.2
+
 ## 0.1.4-next.1
 
 ### Patch Changes

package/README.md

@@ -2,47 +2,36 @@
 
 > DISCLAIMER: The new backend system is in alpha, and so are the search backend module support for the new backend system. We don't recommend you to migrate your backend installations to the new system yet. But if you want to experiment, you can find getting started guides below.
 
-This package exports explore backend modules responsible for extending search.
+This package exports a module that extends the search backend to also indexing the tools exposed by the [`explore` service](https://github.com/backstage/backstage/tree/master/plugins/explore-backend).
 
-## Example
+## Installation
 
-### Use default schedule
+Add the module package as a dependency:
 
-```tsx
-// packages/backend-next/src/index.ts
-import { createBackend } from '@backstage/backend-defaults';
-import { searchPlugin } from '@backstage/plugin-search-backend/alpha';
-import { searchModuleExploreCollator } from '@backstage/plugin-search-backend-module-explore/alpha';
-
-const backend = createBackend();
-backend.add(searchPlugin());
-backend.add(searchModuleExploreCollator());
-backend.start();
+```bash
+# From your Backstage root directory
+yarn add --cwd packages/backend @backstage/plugin-search-backend-module-explore
 ```
 
-### Use custom schedule
+Add the collator to your backend instance, along with the search plugin itself:
 
 ```tsx
-// packages/backend-next/src/index.ts
+// packages/backend/src/index.ts
 import { createBackend } from '@backstage/backend-defaults';
 import { searchPlugin } from '@backstage/plugin-search-backend/alpha';
 import { searchModuleExploreCollator } from '@backstage/plugin-search-backend-module-explore/alpha';
 
-const schedule = {
-  frequency: { minutes: 10 },
-  timeout: { minutes: 15 },
-  initialDelay: { seconds: 3 },
-};
-
 const backend = createBackend();
 backend.add(searchPlugin());
-backend.add(searchModuleExploreCollator({ schedule }));
+backend.add(searchModuleExploreCollator());
 backend.start();
 ```
 
-### Using Auth Middleware
+You may also want to add configuration parameters to your app-config, for example for controlling the scheduled indexing interval. These parameters should be placed under the `search.collators.explore` key. See [the config definition file](https://github.com/backstage/backstage/blob/master/plugins/search-backend-module-explore/config.d.ts) for more details.
+
+## Using Auth Middleware
 
-If your Backstage instance uses service-to-service authentication you can pass an optional `tokenManager` to the collator factory. This will ensure that the collator makes authenticated requests to the explore backend.
+If your Backstage instance uses service-to-service authentication, the collator will need to have access to a `tokenManager`. This is automatically injected by the collator module when using the new backend system. But if you are using the old backend system, you will want to add it manually to ensure that the collator makes authenticated requests to the explore backend.
 
 ```tsx
 indexBuilder.addCollator({

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-search-backend-module-explore",
-  "version": "0.1.4-next.1",
+  "version": "0.1.4",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/config.d.ts

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { TaskScheduleDefinitionConfig } from '@backstage/backend-tasks';
+
+export interface Config {
+  search?: {
+    collators?: {
+      /**
+       * Configuration options for `@backstage/plugin-search-backend-module-explore`
+       */
+      explore?: {
+        /**
+         * The schedule for how often to run the collation job.
+         */
+        schedule?: TaskScheduleDefinitionConfig;
+      };
+    };
+  };
+}

package/dist/alpha.cjs.js

@@ -6,42 +6,49 @@ var backendPluginApi = require('@backstage/backend-plugin-api');
 var backendCommon = require('@backstage/backend-common');
 var alpha = require('@backstage/plugin-search-backend-node/alpha');
 var pluginSearchBackendModuleExplore = require('@backstage/plugin-search-backend-module-explore');
+var backendTasks = require('@backstage/backend-tasks');
 
-const searchModuleExploreCollator = backendPluginApi.createBackendModule(
-  (options) => ({
-    moduleId: "exploreCollator",
-    pluginId: "search",
-    register(env) {
-      env.registerInit({
-        deps: {
-          config: backendPluginApi.coreServices.rootConfig,
-          logger: backendPluginApi.coreServices.logger,
-          discovery: backendPluginApi.coreServices.discovery,
-          scheduler: backendPluginApi.coreServices.scheduler,
-          indexRegistry: alpha.searchIndexRegistryExtensionPoint
-        },
-        async init({ config, logger, discovery, scheduler, indexRegistry }) {
-          var _a;
-          const defaultSchedule = {
-            frequency: { minutes: 10 },
-            timeout: { minutes: 15 },
-            initialDelay: { seconds: 3 }
-          };
-          indexRegistry.addCollator({
-            schedule: scheduler.createScheduledTaskRunner(
-              (_a = options == null ? void 0 : options.schedule) != null ? _a : defaultSchedule
-            ),
-            factory: pluginSearchBackendModuleExplore.ToolDocumentCollatorFactory.fromConfig(config, {
-              ...options,
-              discovery,
-              logger: backendCommon.loggerToWinstonLogger(logger)
-            })
-          });
-        }
-      });
-    }
-  })
-);
+const searchModuleExploreCollator = backendPluginApi.createBackendModule({
+  moduleId: "exploreCollator",
+  pluginId: "search",
+  register(env) {
+    env.registerInit({
+      deps: {
+        config: backendPluginApi.coreServices.rootConfig,
+        logger: backendPluginApi.coreServices.logger,
+        discovery: backendPluginApi.coreServices.discovery,
+        scheduler: backendPluginApi.coreServices.scheduler,
+        tokenManager: backendPluginApi.coreServices.tokenManager,
+        indexRegistry: alpha.searchIndexRegistryExtensionPoint
+      },
+      async init({
+        config,
+        logger,
+        discovery,
+        scheduler,
+        indexRegistry,
+        tokenManager
+      }) {
+        const defaultSchedule = {
+          frequency: { minutes: 10 },
+          timeout: { minutes: 15 },
+          initialDelay: { seconds: 3 }
+        };
+        const schedule = config.has("search.collators.explore.schedule") ? backendTasks.readTaskScheduleDefinitionFromConfig(
+          config.getConfig("search.collators.explore.schedule")
+        ) : defaultSchedule;
+        indexRegistry.addCollator({
+          schedule: scheduler.createScheduledTaskRunner(schedule),
+          factory: pluginSearchBackendModuleExplore.ToolDocumentCollatorFactory.fromConfig(config, {
+            discovery,
+            logger: backendCommon.loggerToWinstonLogger(logger),
+            tokenManager
+          })
+        });
+      }
+    });
+  }
+});
 
 exports.searchModuleExploreCollator = searchModuleExploreCollator;
 //# sourceMappingURL=alpha.cjs.js.map

package/dist/alpha.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * @packageDocumentation\n * A module for the search backend that exports Explore modules.\n */\n\nimport {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { TaskScheduleDefinition } from '@backstage/backend-tasks';\nimport { loggerToWinstonLogger } from '@backstage/backend-common';\nimport { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\n\nimport {\n  ToolDocumentCollatorFactory,\n  ToolDocumentCollatorFactoryOptions,\n} from '@backstage/plugin-search-backend-module-explore';\n\n/**\n * @alpha\n * Options for {@link searchModuleExploreCollator}.\n */\nexport type SearchModuleExploreCollatorOptions = Omit<\n  ToolDocumentCollatorFactoryOptions,\n  'logger' | 'discovery'\n> & {\n  schedule?: TaskScheduleDefinition;\n};\n\n/**\n * @alpha\n * Search backend module for the Explore index.\n */\nexport const searchModuleExploreCollator = createBackendModule(\n  (options?: SearchModuleExploreCollatorOptions) => ({\n    moduleId: 'exploreCollator',\n    pluginId: 'search',\n    register(env) {\n      env.registerInit({\n        deps: {\n          config: coreServices.rootConfig,\n          logger: coreServices.logger,\n          discovery: coreServices.discovery,\n          scheduler: coreServices.scheduler,\n          indexRegistry: searchIndexRegistryExtensionPoint,\n        },\n        async init({ config, logger, discovery, scheduler, indexRegistry }) {\n          const defaultSchedule = {\n            frequency: { minutes: 10 },\n            timeout: { minutes: 15 },\n            initialDelay: { seconds: 3 },\n          };\n\n          indexRegistry.addCollator({\n            schedule: scheduler.createScheduledTaskRunner(\n              options?.schedule ?? defaultSchedule,\n            ),\n            factory: ToolDocumentCollatorFactory.fromConfig(config, {\n              ...options,\n              discovery,\n              logger: loggerToWinstonLogger(logger),\n            }),\n          });\n        },\n      });\n    },\n  }),\n);\n"],"names":["createBackendModule","coreServices","searchIndexRegistryExtensionPoint","ToolDocumentCollatorFactory","loggerToWinstonLogger"],"mappings":";;;;;;;;;AAiDO,MAAM,2BAA8B,GAAAA,oCAAA;AAAA,EACzC,CAAC,OAAkD,MAAA;AAAA,IACjD,QAAU,EAAA,iBAAA;AAAA,IACV,QAAU,EAAA,QAAA;AAAA,IACV,SAAS,GAAK,EAAA;AACZ,MAAA,GAAA,CAAI,YAAa,CAAA;AAAA,QACf,IAAM,EAAA;AAAA,UACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,UACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,UACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,UACxB,WAAWA,6BAAa,CAAA,SAAA;AAAA,UACxB,aAAe,EAAAC,uCAAA;AAAA,SACjB;AAAA,QACA,MAAM,KAAK,EAAE,MAAA,EAAQ,QAAQ,SAAW,EAAA,SAAA,EAAW,eAAiB,EAAA;AA9D5E,UAAA,IAAA,EAAA,CAAA;AA+DU,UAAA,MAAM,eAAkB,GAAA;AAAA,YACtB,SAAA,EAAW,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,YACzB,OAAA,EAAS,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,YACvB,YAAA,EAAc,EAAE,OAAA,EAAS,CAAE,EAAA;AAAA,WAC7B,CAAA;AAEA,UAAA,aAAA,CAAc,WAAY,CAAA;AAAA,YACxB,UAAU,SAAU,CAAA,yBAAA;AAAA,cAClB,CAAA,EAAA,GAAA,OAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,OAAA,CAAS,aAAT,IAAqB,GAAA,EAAA,GAAA,eAAA;AAAA,aACvB;AAAA,YACA,OAAA,EAASC,4DAA4B,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,cACtD,GAAG,OAAA;AAAA,cACH,SAAA;AAAA,cACA,MAAA,EAAQC,oCAAsB,MAAM,CAAA;AAAA,aACrC,CAAA;AAAA,WACF,CAAA,CAAA;AAAA,SACH;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAAA,GACF,CAAA;AACF;;;;"}
+{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * @packageDocumentation\n * A module for the search backend that exports Explore modules.\n */\n\nimport {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { loggerToWinstonLogger } from '@backstage/backend-common';\nimport { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\n\nimport { ToolDocumentCollatorFactory } from '@backstage/plugin-search-backend-module-explore';\nimport { readTaskScheduleDefinitionFromConfig } from '@backstage/backend-tasks';\n\n/**\n * Search backend module for the Explore index.\n *\n * @alpha\n */\nexport const searchModuleExploreCollator = createBackendModule({\n  moduleId: 'exploreCollator',\n  pluginId: 'search',\n  register(env) {\n    env.registerInit({\n      deps: {\n        config: coreServices.rootConfig,\n        logger: coreServices.logger,\n        discovery: coreServices.discovery,\n        scheduler: coreServices.scheduler,\n        tokenManager: coreServices.tokenManager,\n        indexRegistry: searchIndexRegistryExtensionPoint,\n      },\n      async init({\n        config,\n        logger,\n        discovery,\n        scheduler,\n        indexRegistry,\n        tokenManager,\n      }) {\n        const defaultSchedule = {\n          frequency: { minutes: 10 },\n          timeout: { minutes: 15 },\n          initialDelay: { seconds: 3 },\n        };\n\n        const schedule = config.has('search.collators.explore.schedule')\n          ? readTaskScheduleDefinitionFromConfig(\n              config.getConfig('search.collators.explore.schedule'),\n            )\n          : defaultSchedule;\n\n        indexRegistry.addCollator({\n          schedule: scheduler.createScheduledTaskRunner(schedule),\n          factory: ToolDocumentCollatorFactory.fromConfig(config, {\n            discovery,\n            logger: loggerToWinstonLogger(logger),\n            tokenManager,\n          }),\n        });\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","coreServices","searchIndexRegistryExtensionPoint","readTaskScheduleDefinitionFromConfig","ToolDocumentCollatorFactory","loggerToWinstonLogger"],"mappings":";;;;;;;;;;AAoCO,MAAM,8BAA8BA,oCAAoB,CAAA;AAAA,EAC7D,QAAU,EAAA,iBAAA;AAAA,EACV,QAAU,EAAA,QAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,cAAcA,6BAAa,CAAA,YAAA;AAAA,QAC3B,aAAe,EAAAC,uCAAA;AAAA,OACjB;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,MAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,aAAA;AAAA,QACA,YAAA;AAAA,OACC,EAAA;AACD,QAAA,MAAM,eAAkB,GAAA;AAAA,UACtB,SAAA,EAAW,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,UACzB,OAAA,EAAS,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,UACvB,YAAA,EAAc,EAAE,OAAA,EAAS,CAAE,EAAA;AAAA,SAC7B,CAAA;AAEA,QAAA,MAAM,QAAW,GAAA,MAAA,CAAO,GAAI,CAAA,mCAAmC,CAC3D,GAAAC,iDAAA;AAAA,UACE,MAAA,CAAO,UAAU,mCAAmC,CAAA;AAAA,SAEtD,GAAA,eAAA,CAAA;AAEJ,QAAA,aAAA,CAAc,WAAY,CAAA;AAAA,UACxB,QAAA,EAAU,SAAU,CAAA,yBAAA,CAA0B,QAAQ,CAAA;AAAA,UACtD,OAAA,EAASC,4DAA4B,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,YACtD,SAAA;AAAA,YACA,MAAA,EAAQC,oCAAsB,MAAM,CAAA;AAAA,YACpC,YAAA;AAAA,WACD,CAAA;AAAA,SACF,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}

package/dist/alpha.d.ts

@@ -1,18 +1,10 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { TaskScheduleDefinition } from '@backstage/backend-tasks';
-import { ToolDocumentCollatorFactoryOptions } from '@backstage/plugin-search-backend-module-explore';
 
 /**
- * @alpha
- * Options for {@link searchModuleExploreCollator}.
- */
-type SearchModuleExploreCollatorOptions = Omit<ToolDocumentCollatorFactoryOptions, 'logger' | 'discovery'> & {
-    schedule?: TaskScheduleDefinition;
-};
-/**
- * @alpha
  * Search backend module for the Explore index.
+ *
+ * @alpha
  */
-declare const searchModuleExploreCollator: (options?: SearchModuleExploreCollatorOptions | undefined) => _backstage_backend_plugin_api.BackendFeature;
+declare const searchModuleExploreCollator: () => _backstage_backend_plugin_api.BackendFeature;
 
-export { SearchModuleExploreCollatorOptions, searchModuleExploreCollator };
+export { searchModuleExploreCollator };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-search-backend-module-explore",
   "description": "A module for the search backend that exports explore modules",
-  "version": "0.1.4-next.1",
+  "version": "0.1.4",
   "main": "./dist/index.cjs.js",
   "types": "./dist/index.d.ts",
   "license": "Apache-2.0",
@@ -40,23 +40,25 @@
     "clean": "backstage-cli package clean"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.19.2-next.1",
-    "@backstage/backend-plugin-api": "^0.6.0-next.1",
-    "@backstage/backend-tasks": "^0.5.5-next.1",
+    "@backstage/backend-common": "^0.19.2",
+    "@backstage/backend-plugin-api": "^0.6.0",
+    "@backstage/backend-tasks": "^0.5.5",
     "@backstage/config": "^1.0.8",
     "@backstage/plugin-explore-common": "^0.0.1",
-    "@backstage/plugin-search-backend-node": "^1.2.4-next.1",
+    "@backstage/plugin-search-backend-node": "^1.2.4",
     "@backstage/plugin-search-common": "^1.2.5",
     "node-fetch": "^2.6.7",
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.2.0-next.1",
-    "@backstage/cli": "^0.22.10-next.1",
+    "@backstage/backend-test-utils": "^0.2.0",
+    "@backstage/cli": "^0.22.10",
     "msw": "^1.2.1"
   },
   "files": [
     "dist",
+    "config.d.ts",
     "alpha"
-  ]
+  ],
+  "configSchema": "config.d.ts"
 }