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

package/CHANGELOG.md

@@ -0,0 +1,22 @@
+# @backstage/plugin-search-backend-module-techdocs
+
+## 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/catalog-client@1.4.0
+  - @backstage/catalog-model@1.2.1
+  - @backstage/config@1.0.7
+  - @backstage/plugin-catalog-common@1.0.12
+  - @backstage/plugin-permission-common@0.7.4
+  - @backstage/plugin-search-common@1.2.2
+  - @backstage/plugin-techdocs-node@0.0.0-nightly-20230323021924

package/README.md

@@ -0,0 +1,41 @@
+# search-backend-module-techdocs
+
+> 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 techdocs 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 { searchModuleTechDocsCollator } from '@backstage/plugin-search-backend-module-techdocs/alpha';
+
+const backend = createBackend();
+backend.add(searchPlugin());
+backend.add(searchModuleTechDocsCollator());
+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 { searchModuleTechDocsCollator } from '@backstage/plugin-search-backend-module-techdocs/alpha';
+
+const schedule = {
+  frequency: { minutes: 10 },
+  timeout: { minutes: 15 },
+  initialDelay: { seconds: 3 },
+};
+
+const backend = createBackend();
+backend.add(searchPlugin());
+backend.add(searchModuleTechDocsCollator({ schedule }));
+backend.start();
+```

package/alpha/package.json

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

package/dist/alpha.cjs.js

@@ -0,0 +1,56 @@
+'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 pluginSearchBackendModuleTechdocs = require('@backstage/plugin-search-backend-module-techdocs');
+
+const searchModuleTechDocsCollator = backendPluginApi.createBackendModule(
+  (options) => ({
+    moduleId: "techDocsCollator",
+    pluginId: "search",
+    register(env) {
+      env.registerInit({
+        deps: {
+          config: backendPluginApi.coreServices.config,
+          logger: backendPluginApi.coreServices.logger,
+          discovery: backendPluginApi.coreServices.discovery,
+          tokenManager: backendPluginApi.coreServices.tokenManager,
+          scheduler: backendPluginApi.coreServices.scheduler,
+          indexRegistry: alpha.searchIndexRegistryExtensionPoint
+        },
+        async init({
+          config,
+          logger,
+          discovery,
+          tokenManager,
+          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: pluginSearchBackendModuleTechdocs.DefaultTechDocsCollatorFactory.fromConfig(config, {
+              ...options,
+              discovery,
+              tokenManager,
+              logger: backendCommon.loggerToWinstonLogger(logger)
+            })
+          });
+        }
+      });
+    }
+  })
+);
+
+exports.searchModuleTechDocsCollator = searchModuleTechDocsCollator;
+//# 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 TechDocs 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  DefaultTechDocsCollatorFactory,\n  TechDocsCollatorFactoryOptions,\n} from '@backstage/plugin-search-backend-module-techdocs';\n\n/**\n * @alpha\n * Options for {@link searchModuleTechDocsCollator}.\n */\nexport type SearchModuleTechDocsCollatorOptions = Omit<\n  TechDocsCollatorFactoryOptions,\n  'logger' | 'discovery' | 'tokenManager'\n> & {\n  schedule?: TaskScheduleDefinition;\n};\n\n/**\n * @alpha\n * Search backend module for the TechDocs index.\n */\nexport const searchModuleTechDocsCollator = createBackendModule(\n  (options?: SearchModuleTechDocsCollatorOptions) => ({\n    moduleId: 'techDocsCollator',\n    pluginId: 'search',\n    register(env) {\n      env.registerInit({\n        deps: {\n          config: coreServices.config,\n          logger: coreServices.logger,\n          discovery: coreServices.discovery,\n          tokenManager: coreServices.tokenManager,\n          scheduler: coreServices.scheduler,\n          indexRegistry: searchIndexRegistryExtensionPoint,\n        },\n        async init({\n          config,\n          logger,\n          discovery,\n          tokenManager,\n          scheduler,\n          indexRegistry,\n        }) {\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: DefaultTechDocsCollatorFactory.fromConfig(config, {\n              ...options,\n              discovery,\n              tokenManager,\n              logger: loggerToWinstonLogger(logger),\n            }),\n          });\n        },\n      });\n    },\n  }),\n);\n"],"names":["createBackendModule","coreServices","searchIndexRegistryExtensionPoint","DefaultTechDocsCollatorFactory","loggerToWinstonLogger"],"mappings":";;;;;;;;;AAiDO,MAAM,4BAA+B,GAAAA,oCAAA;AAAA,EAC1C,CAAC,OAAmD,MAAA;AAAA,IAClD,QAAU,EAAA,kBAAA;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,cAAcA,6BAAa,CAAA,YAAA;AAAA,UAC3B,WAAWA,6BAAa,CAAA,SAAA;AAAA,UACxB,aAAe,EAAAC,uCAAA;AAAA,SACjB;AAAA,QACA,MAAM,IAAK,CAAA;AAAA,UACT,MAAA;AAAA,UACA,MAAA;AAAA,UACA,SAAA;AAAA,UACA,YAAA;AAAA,UACA,SAAA;AAAA,UACA,aAAA;AAAA,SACC,EAAA;AAtEX,UAAA,IAAA,EAAA,CAAA;AAuEU,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,gEAA+B,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,cACzD,GAAG,OAAA;AAAA,cACH,SAAA;AAAA,cACA,YAAA;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 { TechDocsCollatorFactoryOptions } from '@backstage/plugin-search-backend-module-techdocs';
+
+/**
+ * @alpha
+ * Options for {@link searchModuleTechDocsCollator}.
+ */
+declare type SearchModuleTechDocsCollatorOptions = Omit<TechDocsCollatorFactoryOptions, 'logger' | 'discovery' | 'tokenManager'> & {
+    schedule?: TaskScheduleDefinition;
+};
+/**
+ * @alpha
+ * Search backend module for the TechDocs index.
+ */
+declare const searchModuleTechDocsCollator: (options?: SearchModuleTechDocsCollatorOptions | undefined) => _backstage_backend_plugin_api.BackendFeature;
+
+export { SearchModuleTechDocsCollatorOptions, searchModuleTechDocsCollator };

package/dist/index.cjs.js

@@ -0,0 +1,168 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var catalogClient = require('@backstage/catalog-client');
+var catalogModel = require('@backstage/catalog-model');
+var alpha = require('@backstage/plugin-catalog-common/alpha');
+var unescape = require('lodash/unescape');
+var fetch = require('node-fetch');
+var pLimit = require('p-limit');
+var stream = require('stream');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var unescape__default = /*#__PURE__*/_interopDefaultLegacy(unescape);
+var fetch__default = /*#__PURE__*/_interopDefaultLegacy(fetch);
+var pLimit__default = /*#__PURE__*/_interopDefaultLegacy(pLimit);
+
+class DefaultTechDocsCollatorFactory {
+  constructor(options) {
+    this.type = "techdocs";
+    this.visibilityPermission = alpha.catalogEntityReadPermission;
+    var _a, _b;
+    this.discovery = options.discovery;
+    this.locationTemplate = options.locationTemplate || "/docs/:namespace/:kind/:name/:path";
+    this.logger = options.logger.child({ documentType: this.type });
+    this.catalogClient = options.catalogClient || new catalogClient.CatalogClient({ discoveryApi: options.discovery });
+    this.parallelismLimit = (_a = options.parallelismLimit) != null ? _a : 10;
+    this.legacyPathCasing = (_b = options.legacyPathCasing) != null ? _b : false;
+    this.tokenManager = options.tokenManager;
+  }
+  static fromConfig(config, options) {
+    const legacyPathCasing = config.getOptionalBoolean(
+      "techdocs.legacyUseCaseSensitiveTripletPaths"
+    ) || false;
+    return new DefaultTechDocsCollatorFactory({ ...options, legacyPathCasing });
+  }
+  async getCollator() {
+    return stream.Readable.from(this.execute());
+  }
+  async *execute() {
+    const limit = pLimit__default["default"](this.parallelismLimit);
+    const techDocsBaseUrl = await this.discovery.getBaseUrl("techdocs");
+    const { token } = await this.tokenManager.getToken();
+    let entitiesRetrieved = 0;
+    let moreEntitiesToGet = true;
+    const batchSize = this.parallelismLimit * 50;
+    while (moreEntitiesToGet) {
+      const entities = (await this.catalogClient.getEntities(
+        {
+          filter: {
+            "metadata.annotations.backstage.io/techdocs-ref": catalogClient.CATALOG_FILTER_EXISTS
+          },
+          fields: [
+            "kind",
+            "namespace",
+            "metadata.annotations",
+            "metadata.name",
+            "metadata.title",
+            "metadata.namespace",
+            "spec.type",
+            "spec.lifecycle",
+            "relations"
+          ],
+          limit: batchSize,
+          offset: entitiesRetrieved
+        },
+        { token }
+      )).items;
+      moreEntitiesToGet = entities.length === batchSize;
+      entitiesRetrieved += entities.length;
+      const docPromises = entities.filter((it) => {
+        var _a, _b;
+        return (_b = (_a = it.metadata) == null ? void 0 : _a.annotations) == null ? void 0 : _b["backstage.io/techdocs-ref"];
+      }).map(
+        (entity) => limit(async () => {
+          const entityInfo = DefaultTechDocsCollatorFactory.handleEntityInfoCasing(
+            this.legacyPathCasing,
+            {
+              kind: entity.kind,
+              namespace: entity.metadata.namespace || "default",
+              name: entity.metadata.name
+            }
+          );
+          try {
+            const searchIndexResponse = await fetch__default["default"](
+              DefaultTechDocsCollatorFactory.constructDocsIndexUrl(
+                techDocsBaseUrl,
+                entityInfo
+              ),
+              {
+                headers: {
+                  Authorization: `Bearer ${token}`
+                }
+              }
+            );
+            const searchIndex = await Promise.race([
+              searchIndexResponse.json(),
+              new Promise((_resolve, reject) => {
+                setTimeout(() => {
+                  reject("Could not parse JSON in 5 seconds.");
+                }, 5e3);
+              })
+            ]);
+            return searchIndex.docs.map((doc) => {
+              var _a, _b, _c;
+              return {
+                title: unescape__default["default"](doc.title),
+                text: unescape__default["default"](doc.text || ""),
+                location: this.applyArgsToFormat(
+                  this.locationTemplate || "/docs/:namespace/:kind/:name/:path",
+                  {
+                    ...entityInfo,
+                    path: doc.location
+                  }
+                ),
+                path: doc.location,
+                ...entityInfo,
+                entityTitle: entity.metadata.title,
+                componentType: ((_b = (_a = entity.spec) == null ? void 0 : _a.type) == null ? void 0 : _b.toString()) || "other",
+                lifecycle: ((_c = entity.spec) == null ? void 0 : _c.lifecycle) || "",
+                owner: getSimpleEntityOwnerString(entity),
+                authorization: {
+                  resourceRef: catalogModel.stringifyEntityRef(entity)
+                }
+              };
+            });
+          } catch (e) {
+            this.logger.debug(
+              `Failed to retrieve tech docs search index for entity ${entityInfo.namespace}/${entityInfo.kind}/${entityInfo.name}`,
+              e
+            );
+            return [];
+          }
+        })
+      );
+      yield* (await Promise.all(docPromises)).flat();
+    }
+  }
+  applyArgsToFormat(format, args) {
+    let formatted = format;
+    for (const [key, value] of Object.entries(args)) {
+      formatted = formatted.replace(`:${key}`, value);
+    }
+    return formatted;
+  }
+  static constructDocsIndexUrl(techDocsBaseUrl, entityInfo) {
+    return `${techDocsBaseUrl}/static/docs/${entityInfo.namespace}/${entityInfo.kind}/${entityInfo.name}/search/search_index.json`;
+  }
+  static handleEntityInfoCasing(legacyPaths, entityInfo) {
+    return legacyPaths ? entityInfo : Object.entries(entityInfo).reduce((acc, [key, value]) => {
+      return { ...acc, [key]: value.toLocaleLowerCase("en-US") };
+    }, {});
+  }
+}
+function getSimpleEntityOwnerString(entity) {
+  if (entity.relations) {
+    const owner = entity.relations.find((r) => r.type === catalogModel.RELATION_OWNED_BY);
+    if (owner) {
+      const { name } = catalogModel.parseEntityRef(owner.targetRef);
+      return name;
+    }
+  }
+  return "";
+}
+
+exports.DefaultTechDocsCollatorFactory = DefaultTechDocsCollatorFactory;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/collators/DefaultTechDocsCollatorFactory.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 {\n  PluginEndpointDiscovery,\n  TokenManager,\n} from '@backstage/backend-common';\nimport {\n  CatalogApi,\n  CatalogClient,\n  CATALOG_FILTER_EXISTS,\n} from '@backstage/catalog-client';\nimport {\n  Entity,\n  parseEntityRef,\n  RELATION_OWNED_BY,\n  stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport { catalogEntityReadPermission } from '@backstage/plugin-catalog-common/alpha';\nimport { Permission } from '@backstage/plugin-permission-common';\nimport { DocumentCollatorFactory } from '@backstage/plugin-search-common';\nimport { TechDocsDocument } from '@backstage/plugin-techdocs-node';\nimport unescape from 'lodash/unescape';\nimport fetch from 'node-fetch';\nimport pLimit from 'p-limit';\nimport { Readable } from 'stream';\nimport { Logger } from 'winston';\n\ninterface MkSearchIndexDoc {\n  title: string;\n  text: string;\n  location: string;\n}\n\n/**\n * Options to configure the TechDocs collator factory\n *\n * @public\n */\nexport type TechDocsCollatorFactoryOptions = {\n  discovery: PluginEndpointDiscovery;\n  logger: Logger;\n  tokenManager: TokenManager;\n  locationTemplate?: string;\n  catalogClient?: CatalogApi;\n  parallelismLimit?: number;\n  legacyPathCasing?: boolean;\n};\n\ntype EntityInfo = {\n  name: string;\n  namespace: string;\n  kind: string;\n};\n\n/**\n * A search collator factory responsible for gathering and transforming\n * TechDocs documents.\n *\n * @public\n */\nexport class DefaultTechDocsCollatorFactory implements DocumentCollatorFactory {\n  public readonly type: string = 'techdocs';\n  public readonly visibilityPermission: Permission =\n    catalogEntityReadPermission;\n\n  private discovery: PluginEndpointDiscovery;\n  private locationTemplate: string;\n  private readonly logger: Logger;\n  private readonly catalogClient: CatalogApi;\n  private readonly tokenManager: TokenManager;\n  private readonly parallelismLimit: number;\n  private readonly legacyPathCasing: boolean;\n\n  private constructor(options: TechDocsCollatorFactoryOptions) {\n    this.discovery = options.discovery;\n    this.locationTemplate =\n      options.locationTemplate || '/docs/:namespace/:kind/:name/:path';\n    this.logger = options.logger.child({ documentType: this.type });\n    this.catalogClient =\n      options.catalogClient ||\n      new CatalogClient({ discoveryApi: options.discovery });\n    this.parallelismLimit = options.parallelismLimit ?? 10;\n    this.legacyPathCasing = options.legacyPathCasing ?? false;\n    this.tokenManager = options.tokenManager;\n  }\n\n  static fromConfig(config: Config, options: TechDocsCollatorFactoryOptions) {\n    const legacyPathCasing =\n      config.getOptionalBoolean(\n        'techdocs.legacyUseCaseSensitiveTripletPaths',\n      ) || false;\n    return new DefaultTechDocsCollatorFactory({ ...options, legacyPathCasing });\n  }\n\n  async getCollator(): Promise<Readable> {\n    return Readable.from(this.execute());\n  }\n\n  private async *execute(): AsyncGenerator<TechDocsDocument, void, undefined> {\n    const limit = pLimit(this.parallelismLimit);\n    const techDocsBaseUrl = await this.discovery.getBaseUrl('techdocs');\n    const { token } = await this.tokenManager.getToken();\n    let entitiesRetrieved = 0;\n    let moreEntitiesToGet = true;\n\n    // Offset/limit pagination is used on the Catalog Client in order to\n    // limit (and allow some control over) memory used by the search backend\n    // at index-time. The batchSize is calculated as a factor of the given\n    // parallelism limit to simplify configuration.\n    const batchSize = this.parallelismLimit * 50;\n    while (moreEntitiesToGet) {\n      const entities = (\n        await this.catalogClient.getEntities(\n          {\n            filter: {\n              'metadata.annotations.backstage.io/techdocs-ref':\n                CATALOG_FILTER_EXISTS,\n            },\n            fields: [\n              'kind',\n              'namespace',\n              'metadata.annotations',\n              'metadata.name',\n              'metadata.title',\n              'metadata.namespace',\n              'spec.type',\n              'spec.lifecycle',\n              'relations',\n            ],\n            limit: batchSize,\n            offset: entitiesRetrieved,\n          },\n          { token },\n        )\n      ).items;\n\n      // Control looping through entity batches.\n      moreEntitiesToGet = entities.length === batchSize;\n      entitiesRetrieved += entities.length;\n\n      const docPromises = entities\n        .filter(it => it.metadata?.annotations?.['backstage.io/techdocs-ref'])\n        .map((entity: Entity) =>\n          limit(async (): Promise<TechDocsDocument[]> => {\n            const entityInfo =\n              DefaultTechDocsCollatorFactory.handleEntityInfoCasing(\n                this.legacyPathCasing,\n                {\n                  kind: entity.kind,\n                  namespace: entity.metadata.namespace || 'default',\n                  name: entity.metadata.name,\n                },\n              );\n\n            try {\n              const searchIndexResponse = await fetch(\n                DefaultTechDocsCollatorFactory.constructDocsIndexUrl(\n                  techDocsBaseUrl,\n                  entityInfo,\n                ),\n                {\n                  headers: {\n                    Authorization: `Bearer ${token}`,\n                  },\n                },\n              );\n\n              // todo(@backstage/techdocs-core): remove Promise.race() when node-fetch is 3.x+\n              // workaround for fetch().json() hanging in node-fetch@2.x.x, fixed in 3.x.x\n              // https://github.com/node-fetch/node-fetch/issues/665\n              const searchIndex = await Promise.race([\n                searchIndexResponse.json(),\n                new Promise((_resolve, reject) => {\n                  setTimeout(() => {\n                    reject('Could not parse JSON in 5 seconds.');\n                  }, 5000);\n                }),\n              ]);\n\n              return searchIndex.docs.map((doc: MkSearchIndexDoc) => ({\n                title: unescape(doc.title),\n                text: unescape(doc.text || ''),\n                location: this.applyArgsToFormat(\n                  this.locationTemplate || '/docs/:namespace/:kind/:name/:path',\n                  {\n                    ...entityInfo,\n                    path: doc.location,\n                  },\n                ),\n                path: doc.location,\n                ...entityInfo,\n                entityTitle: entity.metadata.title,\n                componentType: entity.spec?.type?.toString() || 'other',\n                lifecycle: (entity.spec?.lifecycle as string) || '',\n                owner: getSimpleEntityOwnerString(entity),\n                authorization: {\n                  resourceRef: stringifyEntityRef(entity),\n                },\n              }));\n            } catch (e) {\n              this.logger.debug(\n                `Failed to retrieve tech docs search index for entity ${entityInfo.namespace}/${entityInfo.kind}/${entityInfo.name}`,\n                e,\n              );\n              return [];\n            }\n          }),\n        );\n      yield* (await Promise.all(docPromises)).flat();\n    }\n  }\n\n  private applyArgsToFormat(\n    format: string,\n    args: Record<string, string>,\n  ): string {\n    let formatted = format;\n    for (const [key, value] of Object.entries(args)) {\n      formatted = formatted.replace(`:${key}`, value);\n    }\n    return formatted;\n  }\n\n  private static constructDocsIndexUrl(\n    techDocsBaseUrl: string,\n    entityInfo: { kind: string; namespace: string; name: string },\n  ) {\n    return `${techDocsBaseUrl}/static/docs/${entityInfo.namespace}/${entityInfo.kind}/${entityInfo.name}/search/search_index.json`;\n  }\n\n  private static handleEntityInfoCasing(\n    legacyPaths: boolean,\n    entityInfo: EntityInfo,\n  ): EntityInfo {\n    return legacyPaths\n      ? entityInfo\n      : Object.entries(entityInfo).reduce((acc, [key, value]) => {\n          return { ...acc, [key]: value.toLocaleLowerCase('en-US') };\n        }, {} as EntityInfo);\n  }\n}\n\nfunction getSimpleEntityOwnerString(entity: Entity): string {\n  if (entity.relations) {\n    const owner = entity.relations.find(r => r.type === RELATION_OWNED_BY);\n    if (owner) {\n      const { name } = parseEntityRef(owner.targetRef);\n      return name;\n    }\n  }\n  return '';\n}\n"],"names":["catalogEntityReadPermission","CatalogClient","Readable","pLimit","CATALOG_FILTER_EXISTS","fetch","unescape","stringifyEntityRef","RELATION_OWNED_BY","parseEntityRef"],"mappings":";;;;;;;;;;;;;;;;;;AA2EO,MAAM,8BAAkE,CAAA;AAAA,EAarE,YAAY,OAAyC,EAAA;AAZ7D,IAAA,IAAA,CAAgB,IAAe,GAAA,UAAA,CAAA;AAC/B,IAAA,IAAA,CAAgB,oBACd,GAAAA,iCAAA,CAAA;AA9EJ,IAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAyFI,IAAA,IAAA,CAAK,YAAY,OAAQ,CAAA,SAAA,CAAA;AACzB,IAAK,IAAA,CAAA,gBAAA,GACH,QAAQ,gBAAoB,IAAA,oCAAA,CAAA;AAC9B,IAAK,IAAA,CAAA,MAAA,GAAS,QAAQ,MAAO,CAAA,KAAA,CAAM,EAAE,YAAc,EAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AAC9D,IAAK,IAAA,CAAA,aAAA,GACH,QAAQ,aACR,IAAA,IAAIC,4BAAc,EAAE,YAAA,EAAc,OAAQ,CAAA,SAAA,EAAW,CAAA,CAAA;AACvD,IAAK,IAAA,CAAA,gBAAA,GAAA,CAAmB,EAAQ,GAAA,OAAA,CAAA,gBAAA,KAAR,IAA4B,GAAA,EAAA,GAAA,EAAA,CAAA;AACpD,IAAK,IAAA,CAAA,gBAAA,GAAA,CAAmB,EAAQ,GAAA,OAAA,CAAA,gBAAA,KAAR,IAA4B,GAAA,EAAA,GAAA,KAAA,CAAA;AACpD,IAAA,IAAA,CAAK,eAAe,OAAQ,CAAA,YAAA,CAAA;AAAA,GAC9B;AAAA,EAEA,OAAO,UAAW,CAAA,MAAA,EAAgB,OAAyC,EAAA;AACzE,IAAA,MAAM,mBACJ,MAAO,CAAA,kBAAA;AAAA,MACL,6CAAA;AAAA,KACG,IAAA,KAAA,CAAA;AACP,IAAA,OAAO,IAAI,8BAA+B,CAAA,EAAE,GAAG,OAAA,EAAS,kBAAkB,CAAA,CAAA;AAAA,GAC5E;AAAA,EAEA,MAAM,WAAiC,GAAA;AACrC,IAAA,OAAOC,eAAS,CAAA,IAAA,CAAK,IAAK,CAAA,OAAA,EAAS,CAAA,CAAA;AAAA,GACrC;AAAA,EAEA,OAAe,OAA6D,GAAA;AAC1E,IAAM,MAAA,KAAA,GAAQC,0BAAO,CAAA,IAAA,CAAK,gBAAgB,CAAA,CAAA;AAC1C,IAAA,MAAM,eAAkB,GAAA,MAAM,IAAK,CAAA,SAAA,CAAU,WAAW,UAAU,CAAA,CAAA;AAClE,IAAA,MAAM,EAAE,KAAM,EAAA,GAAI,MAAM,IAAA,CAAK,aAAa,QAAS,EAAA,CAAA;AACnD,IAAA,IAAI,iBAAoB,GAAA,CAAA,CAAA;AACxB,IAAA,IAAI,iBAAoB,GAAA,IAAA,CAAA;AAMxB,IAAM,MAAA,SAAA,GAAY,KAAK,gBAAmB,GAAA,EAAA,CAAA;AAC1C,IAAA,OAAO,iBAAmB,EAAA;AACxB,MAAM,MAAA,QAAA,GAAA,CACJ,MAAM,IAAA,CAAK,aAAc,CAAA,WAAA;AAAA,QACvB;AAAA,UACE,MAAQ,EAAA;AAAA,YACN,gDACE,EAAAC,mCAAA;AAAA,WACJ;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,MAAA;AAAA,YACA,WAAA;AAAA,YACA,sBAAA;AAAA,YACA,eAAA;AAAA,YACA,gBAAA;AAAA,YACA,oBAAA;AAAA,YACA,WAAA;AAAA,YACA,gBAAA;AAAA,YACA,WAAA;AAAA,WACF;AAAA,UACA,KAAO,EAAA,SAAA;AAAA,UACP,MAAQ,EAAA,iBAAA;AAAA,SACV;AAAA,QACA,EAAE,KAAM,EAAA;AAAA,OAEV,EAAA,KAAA,CAAA;AAGF,MAAA,iBAAA,GAAoB,SAAS,MAAW,KAAA,SAAA,CAAA;AACxC,MAAA,iBAAA,IAAqB,QAAS,CAAA,MAAA,CAAA;AAE9B,MAAM,MAAA,WAAA,GAAc,QACjB,CAAA,MAAA,CAAO,CAAG,EAAA,KAAA;AA5JnB,QAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AA4JsB,QAAG,OAAA,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,EAAA,CAAA,QAAA,KAAH,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,WAAA,KAAb,IAA2B,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,2BAAA,CAAA,CAAA;AAAA,OAA4B,CACpE,CAAA,GAAA;AAAA,QAAI,CAAC,MACJ,KAAA,KAAA,CAAM,YAAyC;AAC7C,UAAA,MAAM,aACJ,8BAA+B,CAAA,sBAAA;AAAA,YAC7B,IAAK,CAAA,gBAAA;AAAA,YACL;AAAA,cACE,MAAM,MAAO,CAAA,IAAA;AAAA,cACb,SAAA,EAAW,MAAO,CAAA,QAAA,CAAS,SAAa,IAAA,SAAA;AAAA,cACxC,IAAA,EAAM,OAAO,QAAS,CAAA,IAAA;AAAA,aACxB;AAAA,WACF,CAAA;AAEF,UAAI,IAAA;AACF,YAAA,MAAM,sBAAsB,MAAMC,yBAAA;AAAA,cAChC,8BAA+B,CAAA,qBAAA;AAAA,gBAC7B,eAAA;AAAA,gBACA,UAAA;AAAA,eACF;AAAA,cACA;AAAA,gBACE,OAAS,EAAA;AAAA,kBACP,eAAe,CAAU,OAAA,EAAA,KAAA,CAAA,CAAA;AAAA,iBAC3B;AAAA,eACF;AAAA,aACF,CAAA;AAKA,YAAM,MAAA,WAAA,GAAc,MAAM,OAAA,CAAQ,IAAK,CAAA;AAAA,cACrC,oBAAoB,IAAK,EAAA;AAAA,cACzB,IAAI,OAAA,CAAQ,CAAC,QAAA,EAAU,MAAW,KAAA;AAChC,gBAAA,UAAA,CAAW,MAAM;AACf,kBAAA,MAAA,CAAO,oCAAoC,CAAA,CAAA;AAAA,mBAC1C,GAAI,CAAA,CAAA;AAAA,eACR,CAAA;AAAA,aACF,CAAA,CAAA;AAED,YAAA,OAAO,WAAY,CAAA,IAAA,CAAK,GAAI,CAAA,CAAC,GAAuB,KAAA;AAlMlE,cAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AAkMsE,cAAA,OAAA;AAAA,gBACtD,KAAA,EAAOC,4BAAS,CAAA,GAAA,CAAI,KAAK,CAAA;AAAA,gBACzB,IAAM,EAAAA,4BAAA,CAAS,GAAI,CAAA,IAAA,IAAQ,EAAE,CAAA;AAAA,gBAC7B,UAAU,IAAK,CAAA,iBAAA;AAAA,kBACb,KAAK,gBAAoB,IAAA,oCAAA;AAAA,kBACzB;AAAA,oBACE,GAAG,UAAA;AAAA,oBACH,MAAM,GAAI,CAAA,QAAA;AAAA,mBACZ;AAAA,iBACF;AAAA,gBACA,MAAM,GAAI,CAAA,QAAA;AAAA,gBACV,GAAG,UAAA;AAAA,gBACH,WAAA,EAAa,OAAO,QAAS,CAAA,KAAA;AAAA,gBAC7B,iBAAe,EAAO,GAAA,CAAA,EAAA,GAAA,MAAA,CAAA,IAAA,KAAP,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,IAAA,KAAb,mBAAmB,QAAc,EAAA,KAAA,OAAA;AAAA,gBAChD,SAAY,EAAA,CAAA,CAAA,EAAA,GAAA,MAAA,CAAO,IAAP,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAa,SAAwB,KAAA,EAAA;AAAA,gBACjD,KAAA,EAAO,2BAA2B,MAAM,CAAA;AAAA,gBACxC,aAAe,EAAA;AAAA,kBACb,WAAA,EAAaC,gCAAmB,MAAM,CAAA;AAAA,iBACxC;AAAA,eACF,CAAA;AAAA,aAAE,CAAA,CAAA;AAAA,mBACK,CAAP,EAAA;AACA,YAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,cACV,CAAwD,qDAAA,EAAA,UAAA,CAAW,SAAa,CAAA,CAAA,EAAA,UAAA,CAAW,QAAQ,UAAW,CAAA,IAAA,CAAA,CAAA;AAAA,cAC9G,CAAA;AAAA,aACF,CAAA;AACA,YAAA,OAAO,EAAC,CAAA;AAAA,WACV;AAAA,SACD,CAAA;AAAA,OACH,CAAA;AACF,MAAA,OAAA,CAAQ,MAAM,OAAA,CAAQ,GAAI,CAAA,WAAW,GAAG,IAAK,EAAA,CAAA;AAAA,KAC/C;AAAA,GACF;AAAA,EAEQ,iBAAA,CACN,QACA,IACQ,EAAA;AACR,IAAA,IAAI,SAAY,GAAA,MAAA,CAAA;AAChB,IAAA,KAAA,MAAW,CAAC,GAAK,EAAA,KAAK,KAAK,MAAO,CAAA,OAAA,CAAQ,IAAI,CAAG,EAAA;AAC/C,MAAA,SAAA,GAAY,SAAU,CAAA,OAAA,CAAQ,CAAI,CAAA,EAAA,GAAA,CAAA,CAAA,EAAO,KAAK,CAAA,CAAA;AAAA,KAChD;AACA,IAAO,OAAA,SAAA,CAAA;AAAA,GACT;AAAA,EAEA,OAAe,qBACb,CAAA,eAAA,EACA,UACA,EAAA;AACA,IAAA,OAAO,GAAG,eAA+B,CAAA,aAAA,EAAA,UAAA,CAAW,SAAa,CAAA,CAAA,EAAA,UAAA,CAAW,QAAQ,UAAW,CAAA,IAAA,CAAA,yBAAA,CAAA,CAAA;AAAA,GACjG;AAAA,EAEA,OAAe,sBACb,CAAA,WAAA,EACA,UACY,EAAA;AACZ,IAAA,OAAO,WACH,GAAA,UAAA,GACA,MAAO,CAAA,OAAA,CAAQ,UAAU,CAAA,CAAE,MAAO,CAAA,CAAC,GAAK,EAAA,CAAC,GAAK,EAAA,KAAK,CAAM,KAAA;AACvD,MAAO,OAAA,EAAE,GAAG,GAAK,EAAA,CAAC,GAAG,GAAG,KAAA,CAAM,iBAAkB,CAAA,OAAO,CAAE,EAAA,CAAA;AAAA,KAC3D,EAAG,EAAgB,CAAA,CAAA;AAAA,GACzB;AACF,CAAA;AAEA,SAAS,2BAA2B,MAAwB,EAAA;AAC1D,EAAA,IAAI,OAAO,SAAW,EAAA;AACpB,IAAA,MAAM,QAAQ,MAAO,CAAA,SAAA,CAAU,KAAK,CAAK,CAAA,KAAA,CAAA,CAAE,SAASC,8BAAiB,CAAA,CAAA;AACrE,IAAA,IAAI,KAAO,EAAA;AACT,MAAA,MAAM,EAAE,IAAA,EAAS,GAAAC,2BAAA,CAAe,MAAM,SAAS,CAAA,CAAA;AAC/C,MAAO,OAAA,IAAA,CAAA;AAAA,KACT;AAAA,GACF;AACA,EAAO,OAAA,EAAA,CAAA;AACT;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,49 @@
+/// <reference types="node" />
+import { PluginEndpointDiscovery, TokenManager } from '@backstage/backend-common';
+import { CatalogApi } from '@backstage/catalog-client';
+import { Config } from '@backstage/config';
+import { Permission } from '@backstage/plugin-permission-common';
+import { DocumentCollatorFactory } from '@backstage/plugin-search-common';
+import { Readable } from 'stream';
+import { Logger } from 'winston';
+
+/**
+ * Options to configure the TechDocs collator factory
+ *
+ * @public
+ */
+declare type TechDocsCollatorFactoryOptions = {
+    discovery: PluginEndpointDiscovery;
+    logger: Logger;
+    tokenManager: TokenManager;
+    locationTemplate?: string;
+    catalogClient?: CatalogApi;
+    parallelismLimit?: number;
+    legacyPathCasing?: boolean;
+};
+/**
+ * A search collator factory responsible for gathering and transforming
+ * TechDocs documents.
+ *
+ * @public
+ */
+declare class DefaultTechDocsCollatorFactory implements DocumentCollatorFactory {
+    readonly type: string;
+    readonly visibilityPermission: Permission;
+    private discovery;
+    private locationTemplate;
+    private readonly logger;
+    private readonly catalogClient;
+    private readonly tokenManager;
+    private readonly parallelismLimit;
+    private readonly legacyPathCasing;
+    private constructor();
+    static fromConfig(config: Config, options: TechDocsCollatorFactoryOptions): DefaultTechDocsCollatorFactory;
+    getCollator(): Promise<Readable>;
+    private execute;
+    private applyArgsToFormat;
+    private static constructDocsIndexUrl;
+    private static handleEntityInfoCasing;
+}
+
+export { DefaultTechDocsCollatorFactory, TechDocsCollatorFactoryOptions };

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@backstage/plugin-search-backend-module-techdocs",
+  "description": "A module for the search backend that exports techdocs 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/catalog-client": "^1.4.0",
+    "@backstage/catalog-model": "^1.2.1",
+    "@backstage/config": "^1.0.7",
+    "@backstage/plugin-catalog-common": "^1.0.12",
+    "@backstage/plugin-permission-common": "^0.7.4",
+    "@backstage/plugin-search-backend-node": "^0.0.0-nightly-20230323021924",
+    "@backstage/plugin-search-common": "^1.2.2",
+    "@backstage/plugin-techdocs-node": "^0.0.0-nightly-20230323021924",
+    "lodash": "^4.17.21",
+    "node-fetch": "^2.6.7",
+    "p-limit": "^3.1.0",
+    "winston": "^3.2.1"
+  },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "^0.0.0-nightly-20230323021924",
+    "@backstage/cli": "^0.0.0-nightly-20230323021924",
+    "msw": "^1.0.0"
+  },
+  "files": [
+    "dist",
+    "alpha"
+  ]
+}