@backstage/plugin-search-backend-module-explore 0.0.0-nightly-20230323021924

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# @backstage/plugin-search-backend-module-explore
+
+## 0.0.0-nightly-20230323021924
+
+### Minor Changes
+
+- 01ae205352e: Package introduced to export search backend modules that can be used with the new backend system to extend search with plugin specific functionality, such as collators. For documentation on how to migrate, check out the [how to migrate to the new backend system guide](../docs/features/search/how-to-guides.md#how-to-migrate-to-use-search-together-with-the-new-backend-system).
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.0.0-nightly-20230323021924
+  - @backstage/plugin-search-backend-node@0.0.0-nightly-20230323021924
+  - @backstage/backend-plugin-api@0.0.0-nightly-20230323021924
+  - @backstage/backend-tasks@0.0.0-nightly-20230323021924
+  - @backstage/config@1.0.7
+  - @backstage/plugin-explore-common@0.0.1
+  - @backstage/plugin-search-common@1.2.2

package/README.md

@@ -0,0 +1,41 @@
+# search-backend-module-explore
+
+> 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.
+
+## Example
+
+### Use default schedule
+
+```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();
+```
+
+### Use custom schedule
+
+```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 schedule = {
+  frequency: { minutes: 10 },
+  timeout: { minutes: 15 },
+  initialDelay: { seconds: 3 },
+};
+
+const backend = createBackend();
+backend.add(searchPlugin());
+backend.add(searchModuleExploreCollator({ schedule }));
+backend.start();
+```

package/alpha/package.json

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

package/dist/alpha.cjs.js

@@ -0,0 +1,47 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+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');
+
+const searchModuleExploreCollator = backendPluginApi.createBackendModule(
+  (options) => ({
+    moduleId: "exploreCollator",
+    pluginId: "search",
+    register(env) {
+      env.registerInit({
+        deps: {
+          config: backendPluginApi.coreServices.config,
+          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)
+            })
+          });
+        }
+      });
+    }
+  })
+);
+
+exports.searchModuleExploreCollator = searchModuleExploreCollator;
+//# sourceMappingURL=alpha.cjs.js.map

package/dist/alpha.cjs.js.map

@@ -0,0 +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.config,\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,MAAA;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;;;;"}

package/dist/alpha.d.ts

@@ -0,0 +1,18 @@
+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}.
+ */
+declare type SearchModuleExploreCollatorOptions = Omit<ToolDocumentCollatorFactoryOptions, 'logger' | 'discovery'> & {
+    schedule?: TaskScheduleDefinition;
+};
+/**
+ * @alpha
+ * Search backend module for the Explore index.
+ */
+declare const searchModuleExploreCollator: (options?: SearchModuleExploreCollatorOptions | undefined) => _backstage_backend_plugin_api.BackendFeature;
+
+export { SearchModuleExploreCollatorOptions, searchModuleExploreCollator };

package/dist/index.cjs.js

@@ -0,0 +1,50 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var fetch = require('node-fetch');
+var stream = require('stream');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var fetch__default = /*#__PURE__*/_interopDefaultLegacy(fetch);
+
+class ToolDocumentCollatorFactory {
+  constructor(options) {
+    this.type = "tools";
+    this.discovery = options.discovery;
+    this.logger = options.logger;
+  }
+  static fromConfig(_config, options) {
+    return new ToolDocumentCollatorFactory(options);
+  }
+  async getCollator() {
+    return stream.Readable.from(this.execute());
+  }
+  async *execute() {
+    this.logger.info("Starting collation of explore tools");
+    const tools = await this.fetchTools();
+    for (const tool of tools) {
+      yield {
+        ...tool,
+        text: tool.description,
+        location: tool.url
+      };
+    }
+    this.logger.info("Finished collation of explore tools");
+  }
+  async fetchTools() {
+    const baseUrl = await this.discovery.getBaseUrl("explore");
+    const response = await fetch__default["default"](`${baseUrl}/tools`);
+    if (!response.ok) {
+      throw new Error(
+        `Failed to explore fetch tools, ${response.status}: ${response.statusText}`
+      );
+    }
+    const data = await response.json();
+    return data.tools;
+  }
+}
+
+exports.ToolDocumentCollatorFactory = ToolDocumentCollatorFactory;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/collators/ToolDocumentCollatorFactory.ts"],"sourcesContent":["/*\n * Copyright 2022 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\nimport { PluginEndpointDiscovery } from '@backstage/backend-common';\nimport { Config } from '@backstage/config';\nimport { ExploreTool } from '@backstage/plugin-explore-common';\nimport {\n  DocumentCollatorFactory,\n  IndexableDocument,\n} from '@backstage/plugin-search-common';\nimport fetch from 'node-fetch';\nimport { Readable } from 'stream';\nimport { Logger } from 'winston';\n\n/**\n * Extended IndexableDocument with explore tool specific properties\n *\n * @public\n */\nexport interface ToolDocument extends IndexableDocument, ExploreTool {}\n\n/**\n * The options for the {@link ToolDocumentCollatorFactory}.\n *\n * @public\n */\nexport type ToolDocumentCollatorFactoryOptions = {\n  discovery: PluginEndpointDiscovery;\n  logger: Logger;\n};\n\n/**\n * Search collator responsible for collecting explore tools to index.\n *\n * @public\n */\nexport class ToolDocumentCollatorFactory implements DocumentCollatorFactory {\n  public readonly type: string = 'tools';\n\n  private readonly discovery: PluginEndpointDiscovery;\n  private readonly logger: Logger;\n\n  private constructor(options: ToolDocumentCollatorFactoryOptions) {\n    this.discovery = options.discovery;\n    this.logger = options.logger;\n  }\n\n  static fromConfig(\n    _config: Config,\n    options: ToolDocumentCollatorFactoryOptions,\n  ) {\n    return new ToolDocumentCollatorFactory(options);\n  }\n\n  async getCollator() {\n    return Readable.from(this.execute());\n  }\n\n  async *execute(): AsyncGenerator<ToolDocument> {\n    this.logger.info('Starting collation of explore tools');\n\n    const tools = await this.fetchTools();\n\n    for (const tool of tools) {\n      yield {\n        ...tool,\n        text: tool.description,\n        location: tool.url,\n      };\n    }\n\n    this.logger.info('Finished collation of explore tools');\n  }\n\n  private async fetchTools() {\n    const baseUrl = await this.discovery.getBaseUrl('explore');\n    const response = await fetch(`${baseUrl}/tools`);\n\n    if (!response.ok) {\n      throw new Error(\n        `Failed to explore fetch tools, ${response.status}: ${response.statusText}`,\n      );\n    }\n\n    const data = await response.json();\n    return data.tools;\n  }\n}\n"],"names":["Readable","fetch"],"mappings":";;;;;;;;;;;AAiDO,MAAM,2BAA+D,CAAA;AAAA,EAMlE,YAAY,OAA6C,EAAA;AALjE,IAAA,IAAA,CAAgB,IAAe,GAAA,OAAA,CAAA;AAM7B,IAAA,IAAA,CAAK,YAAY,OAAQ,CAAA,SAAA,CAAA;AACzB,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AAAA,GACxB;AAAA,EAEA,OAAO,UACL,CAAA,OAAA,EACA,OACA,EAAA;AACA,IAAO,OAAA,IAAI,4BAA4B,OAAO,CAAA,CAAA;AAAA,GAChD;AAAA,EAEA,MAAM,WAAc,GAAA;AAClB,IAAA,OAAOA,eAAS,CAAA,IAAA,CAAK,IAAK,CAAA,OAAA,EAAS,CAAA,CAAA;AAAA,GACrC;AAAA,EAEA,OAAO,OAAwC,GAAA;AAC7C,IAAK,IAAA,CAAA,MAAA,CAAO,KAAK,qCAAqC,CAAA,CAAA;AAEtD,IAAM,MAAA,KAAA,GAAQ,MAAM,IAAA,CAAK,UAAW,EAAA,CAAA;AAEpC,IAAA,KAAA,MAAW,QAAQ,KAAO,EAAA;AACxB,MAAM,MAAA;AAAA,QACJ,GAAG,IAAA;AAAA,QACH,MAAM,IAAK,CAAA,WAAA;AAAA,QACX,UAAU,IAAK,CAAA,GAAA;AAAA,OACjB,CAAA;AAAA,KACF;AAEA,IAAK,IAAA,CAAA,MAAA,CAAO,KAAK,qCAAqC,CAAA,CAAA;AAAA,GACxD;AAAA,EAEA,MAAc,UAAa,GAAA;AACzB,IAAA,MAAM,OAAU,GAAA,MAAM,IAAK,CAAA,SAAA,CAAU,WAAW,SAAS,CAAA,CAAA;AACzD,IAAA,MAAM,QAAW,GAAA,MAAMC,yBAAM,CAAA,CAAA,EAAG,OAAe,CAAA,MAAA,CAAA,CAAA,CAAA;AAE/C,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,+BAAA,EAAkC,QAAS,CAAA,MAAA,CAAA,EAAA,EAAW,QAAS,CAAA,UAAA,CAAA,CAAA;AAAA,OACjE,CAAA;AAAA,KACF;AAEA,IAAM,MAAA,IAAA,GAAO,MAAM,QAAA,CAAS,IAAK,EAAA,CAAA;AACjC,IAAA,OAAO,IAAK,CAAA,KAAA,CAAA;AAAA,GACd;AACF;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,41 @@
+/// <reference types="node" />
+import { PluginEndpointDiscovery } from '@backstage/backend-common';
+import { Config } from '@backstage/config';
+import { ExploreTool } from '@backstage/plugin-explore-common';
+import { IndexableDocument, DocumentCollatorFactory } from '@backstage/plugin-search-common';
+import { Readable } from 'stream';
+import { Logger } from 'winston';
+
+/**
+ * Extended IndexableDocument with explore tool specific properties
+ *
+ * @public
+ */
+interface ToolDocument extends IndexableDocument, ExploreTool {
+}
+/**
+ * The options for the {@link ToolDocumentCollatorFactory}.
+ *
+ * @public
+ */
+declare type ToolDocumentCollatorFactoryOptions = {
+    discovery: PluginEndpointDiscovery;
+    logger: Logger;
+};
+/**
+ * Search collator responsible for collecting explore tools to index.
+ *
+ * @public
+ */
+declare class ToolDocumentCollatorFactory implements DocumentCollatorFactory {
+    readonly type: string;
+    private readonly discovery;
+    private readonly logger;
+    private constructor();
+    static fromConfig(_config: Config, options: ToolDocumentCollatorFactoryOptions): ToolDocumentCollatorFactory;
+    getCollator(): Promise<Readable>;
+    execute(): AsyncGenerator<ToolDocument>;
+    private fetchTools;
+}
+
+export { ToolDocument, ToolDocumentCollatorFactory, ToolDocumentCollatorFactoryOptions };

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@backstage/plugin-search-backend-module-explore",
+  "description": "A module for the search backend that exports explore modules",
+  "version": "0.0.0-nightly-20230323021924",
+  "main": "./dist/index.cjs.js",
+  "types": "./dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.cjs.js"
+    },
+    "./alpha": {
+      "require": "./dist/alpha.cjs.js",
+      "types": "./dist/alpha.d.ts",
+      "default": "./dist/alpha.cjs.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "backstage": {
+    "role": "backend-plugin-module"
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "clean": "backstage-cli package clean"
+  },
+  "dependencies": {
+    "@backstage/backend-common": "^0.0.0-nightly-20230323021924",
+    "@backstage/backend-plugin-api": "^0.0.0-nightly-20230323021924",
+    "@backstage/backend-tasks": "^0.0.0-nightly-20230323021924",
+    "@backstage/config": "^1.0.7",
+    "@backstage/plugin-explore-common": "^0.0.1",
+    "@backstage/plugin-search-backend-node": "^0.0.0-nightly-20230323021924",
+    "@backstage/plugin-search-common": "^1.2.2",
+    "node-fetch": "^2.6.7",
+    "winston": "^3.2.1"
+  },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "^0.0.0-nightly-20230323021924",
+    "@backstage/cli": "^0.0.0-nightly-20230323021924"
+  },
+  "files": [
+    "dist",
+    "alpha"
+  ]
+}