@backstage-community/plugin-tech-insights-backend 1.2.3 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @backstage-community/plugin-tech-insights-backend
 
+## 2.0.0
+
+### Major Changes
+
+- c3bbe0f: In order to use UrlReaderService in fact retrievers, UrlReaderService has been added to FactRetrieverContext.
+
+### Minor Changes
+
+- 306121a: Allow tech insights backend to schedule a single job.
+
+### Patch Changes
+
+- Updated dependencies [c3bbe0f]
+  - @backstage-community/plugin-tech-insights-node@2.0.0
+
 ## 1.2.3
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { LoggerService, DatabaseService, DiscoveryService, SchedulerService, AuthService } from '@backstage/backend-plugin-api';
+import { LoggerService, DatabaseService, DiscoveryService, SchedulerService, AuthService, UrlReaderService } from '@backstage/backend-plugin-api';
 import { FactRetrieverRegistry as FactRetrieverRegistry$1, PersistenceContext as PersistenceContext$1, FactRetriever, FactLifecycle, FactRetrieverRegistration, TechInsightCheck, FactChecker, FactCheckerFactory } from '@backstage-community/plugin-tech-insights-node';
 import { HumanDuration } from '@backstage/types';
 import { Duration } from 'luxon';
@@ -77,26 +77,32 @@ declare function createFactRetrieverRegistration(options: FactRetrieverRegistrat
  *
  * FactRetrieverEngine responsible scheduling and running fact retrieval tasks.
  */
-interface FactRetrieverEngine {
+declare abstract class FactRetrieverEngine {
     /**
      * Schedules fact retriever run cycles based on configuration provided in the registration.
      *
      * Default implementation uses backend-tasks to handle scheduling. This function can be called multiple
      * times, where initial calls schedule the tasks and subsequent invocations update the schedules.
      */
-    schedule(): Promise<void>;
+    abstract schedule(): Promise<void>;
+    /**
+     * Schedules single fact retriever run cycles based on configuration provided in the registration.
+     *
+     * Default implementation defers to scheduling all jobs
+     */
+    scheduleJob(_: string): Promise<void>;
     /**
      * Provides possibility to manually run a fact retriever job and construct fact data
      *
      * @param ref - Reference to the task name stored in the executor database. By convention this is the fact retriever id
      */
-    triggerJob(ref: string): Promise<void>;
+    abstract triggerJob(ref: string): Promise<void>;
     /**
      * Exposes fact retriever job configuration information about previous and next runs and schedule
      *
      * @param ref - Reference to the task name stored in the executor database. By convention this is the fact retriever id
      */
-    getJobRegistration(ref: string): Promise<FactRetrieverRegistration>;
+    abstract getJobRegistration(ref: string): Promise<FactRetrieverRegistration>;
 }
 
 /**
@@ -209,6 +215,7 @@ interface TechInsightsOptions<CheckType extends TechInsightCheck, CheckResultTyp
     database: DatabaseService;
     scheduler: SchedulerService;
     auth: AuthService;
+    urlReader: UrlReaderService;
 }
 /**
  * @public
@@ -234,4 +241,4 @@ type TechInsightsContext<CheckType extends TechInsightCheck, CheckResultType ext
  */
 declare const buildTechInsightsContext: <CheckType extends TechInsightCheck, CheckResultType extends CheckResult>(options: TechInsightsOptions<CheckType, CheckResultType>) => Promise<TechInsightsContext<CheckType, CheckResultType>>;
 
-export { type FactRetrieverEngine, type FactRetrieverRegistrationOptions, type FactRetrieverRegistry, type PersistenceContext, type PersistenceContextOptions, type RouterOptions, type TechInsightsContext, type TechInsightsOptions, buildTechInsightsContext, createFactRetrieverRegistration, createRouter, techInsightsPlugin as default, entityMetadataFactRetriever, entityOwnershipFactRetriever, initializePersistenceContext, techdocsFactRetriever };
+export { FactRetrieverEngine, type FactRetrieverRegistrationOptions, type FactRetrieverRegistry, type PersistenceContext, type PersistenceContextOptions, type RouterOptions, type TechInsightsContext, type TechInsightsOptions, buildTechInsightsContext, createFactRetrieverRegistration, createRouter, techInsightsPlugin as default, entityMetadataFactRetriever, entityOwnershipFactRetriever, initializePersistenceContext, techdocsFactRetriever };

package/dist/plugin/plugin.cjs.js

@@ -54,7 +54,8 @@ const techInsightsPlugin = backendPluginApi.createBackendPlugin({
         httpRouter: backendPluginApi.coreServices.httpRouter,
         logger: backendPluginApi.coreServices.logger,
         scheduler: backendPluginApi.coreServices.scheduler,
-        auth: backendPluginApi.coreServices.auth
+        auth: backendPluginApi.coreServices.auth,
+        urlReader: backendPluginApi.coreServices.urlReader
       },
       async init({
         config: config$1,
@@ -63,7 +64,8 @@ const techInsightsPlugin = backendPluginApi.createBackendPlugin({
         httpRouter,
         logger,
         scheduler,
-        auth
+        auth,
+        urlReader
       }) {
         const factRetrievers = Object.entries(
           addedFactRetrievers
@@ -84,7 +86,8 @@ const techInsightsPlugin = backendPluginApi.createBackendPlugin({
           logger,
           persistenceContext,
           scheduler,
-          auth
+          auth,
+          urlReader
         });
         httpRouter.use(
           await router.createRouter({

package/dist/plugin/plugin.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.cjs.js","sources":["../../src/plugin/plugin.ts"],"sourcesContent":["/*\n * Copyright 2024 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  coreServices,\n  createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { CheckResult } from '@backstage-community/plugin-tech-insights-common';\nimport {\n  FactCheckerFactory,\n  FactRetriever,\n  FactRetrieverRegistration,\n  FactRetrieverRegistry,\n  PersistenceContext,\n  TechInsightCheck,\n  techInsightsFactCheckerFactoryExtensionPoint,\n  techInsightsFactRetrieverRegistryExtensionPoint,\n  techInsightsFactRetrieversExtensionPoint,\n  techInsightsPersistenceContextExtensionPoint,\n} from '@backstage-community/plugin-tech-insights-node';\nimport {\n  buildTechInsightsContext,\n  createRouter,\n  entityMetadataFactRetriever,\n  entityOwnershipFactRetriever,\n  techdocsFactRetriever,\n} from '../service';\nimport { createFactRetrieverRegistrationFromConfig } from './config';\n\n/**\n * The tech-insights backend plugin.\n *\n * @public\n */\nexport const techInsightsPlugin = createBackendPlugin({\n  pluginId: 'tech-insights',\n  register(env) {\n    let factCheckerFactory:\n      | FactCheckerFactory<TechInsightCheck, CheckResult>\n      | undefined = undefined;\n    env.registerExtensionPoint(techInsightsFactCheckerFactoryExtensionPoint, {\n      setFactCheckerFactory<\n        CheckType extends TechInsightCheck,\n        CheckResultType extends CheckResult,\n      >(factory: FactCheckerFactory<CheckType, CheckResultType>): void {\n        factCheckerFactory = factory;\n      },\n    });\n\n    let factRetrieverRegistry: FactRetrieverRegistry | undefined = undefined;\n    env.registerExtensionPoint(\n      techInsightsFactRetrieverRegistryExtensionPoint,\n      {\n        setFactRetrieverRegistry(registry: FactRetrieverRegistry): void {\n          factRetrieverRegistry = registry;\n        },\n      },\n    );\n\n    // initialized with built-in fact retrievers\n    // only added as registration if there is config for them\n    const addedFactRetrievers: Record<string, FactRetriever> = {\n      entityMetadataFactRetriever,\n      entityOwnershipFactRetriever,\n      techdocsFactRetriever,\n    };\n    env.registerExtensionPoint(techInsightsFactRetrieversExtensionPoint, {\n      addFactRetrievers(factRetrievers: Record<string, FactRetriever>): void {\n        Object.entries(factRetrievers).forEach(([key, value]) => {\n          addedFactRetrievers[key] = value;\n        });\n      },\n    });\n\n    let persistenceContext: PersistenceContext | undefined = undefined;\n    env.registerExtensionPoint(techInsightsPersistenceContextExtensionPoint, {\n      setPersistenceContext(context: PersistenceContext): void {\n        persistenceContext = context;\n      },\n    });\n\n    env.registerInit({\n      deps: {\n        config: coreServices.rootConfig,\n        database: coreServices.database,\n        discovery: coreServices.discovery,\n        httpRouter: coreServices.httpRouter,\n        logger: coreServices.logger,\n        scheduler: coreServices.scheduler,\n        auth: coreServices.auth,\n      },\n      async init({\n        config,\n        database,\n        discovery,\n        httpRouter,\n        logger,\n        scheduler,\n        auth,\n      }) {\n        const factRetrievers: FactRetrieverRegistration[] = Object.entries(\n          addedFactRetrievers,\n        )\n          .map(([name, factRetriever]) =>\n            createFactRetrieverRegistrationFromConfig(\n              config,\n              name,\n              factRetriever,\n            ),\n          )\n          .filter(registration => registration) as FactRetrieverRegistration[];\n\n        const context = await buildTechInsightsContext({\n          config,\n          database,\n          discovery,\n          factCheckerFactory,\n          factRetrieverRegistry,\n          factRetrievers,\n          logger,\n          persistenceContext,\n          scheduler,\n          auth,\n        });\n\n        httpRouter.use(\n          await createRouter({\n            ...context,\n            config,\n            logger,\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendPlugin","techInsightsFactCheckerFactoryExtensionPoint","techInsightsFactRetrieverRegistryExtensionPoint","entityMetadataFactRetriever","entityOwnershipFactRetriever","techdocsFactRetriever","techInsightsFactRetrieversExtensionPoint","techInsightsPersistenceContextExtensionPoint","coreServices","config","createFactRetrieverRegistrationFromConfig","buildTechInsightsContext","createRouter"],"mappings":";;;;;;;;;;;;AA+CO,MAAM,qBAAqBA,oCAAoB,CAAA;AAAA,EACpD,QAAU,EAAA,eAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,IAAI,kBAEY,GAAA,KAAA,CAAA,CAAA;AAChB,IAAA,GAAA,CAAI,uBAAuBC,mEAA8C,EAAA;AAAA,MACvE,sBAGE,OAA+D,EAAA;AAC/D,QAAqB,kBAAA,GAAA,OAAA,CAAA;AAAA,OACvB;AAAA,KACD,CAAA,CAAA;AAED,IAAA,IAAI,qBAA2D,GAAA,KAAA,CAAA,CAAA;AAC/D,IAAI,GAAA,CAAA,sBAAA;AAAA,MACFC,sEAAA;AAAA,MACA;AAAA,QACE,yBAAyB,QAAuC,EAAA;AAC9D,UAAwB,qBAAA,GAAA,QAAA,CAAA;AAAA,SAC1B;AAAA,OACF;AAAA,KACF,CAAA;AAIA,IAAA,MAAM,mBAAqD,GAAA;AAAA,mCACzDC,uDAAA;AAAA,oCACAC,yDAAA;AAAA,6BACAC,2CAAA;AAAA,KACF,CAAA;AACA,IAAA,GAAA,CAAI,uBAAuBC,+DAA0C,EAAA;AAAA,MACnE,kBAAkB,cAAqD,EAAA;AACrE,QAAO,MAAA,CAAA,OAAA,CAAQ,cAAc,CAAE,CAAA,OAAA,CAAQ,CAAC,CAAC,GAAA,EAAK,KAAK,CAAM,KAAA;AACvD,UAAA,mBAAA,CAAoB,GAAG,CAAI,GAAA,KAAA,CAAA;AAAA,SAC5B,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAED,IAAA,IAAI,kBAAqD,GAAA,KAAA,CAAA,CAAA;AACzD,IAAA,GAAA,CAAI,uBAAuBC,mEAA8C,EAAA;AAAA,MACvE,sBAAsB,OAAmC,EAAA;AACvD,QAAqB,kBAAA,GAAA,OAAA,CAAA;AAAA,OACvB;AAAA,KACD,CAAA,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,YAAYA,6BAAa,CAAA,UAAA;AAAA,QACzB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,MAAMA,6BAAa,CAAA,IAAA;AAAA,OACrB;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,gBACTC,QAAA;AAAA,QACA,QAAA;AAAA,QACA,SAAA;AAAA,QACA,UAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,IAAA;AAAA,OACC,EAAA;AACD,QAAA,MAAM,iBAA8C,MAAO,CAAA,OAAA;AAAA,UACzD,mBAAA;AAAA,SAEC,CAAA,GAAA;AAAA,UAAI,CAAC,CAAC,IAAM,EAAA,aAAa,CACxB,KAAAC,gDAAA;AAAA,YACED,QAAA;AAAA,YACA,IAAA;AAAA,YACA,aAAA;AAAA,WACF;AAAA,SACF,CACC,MAAO,CAAA,CAAA,YAAA,KAAgB,YAAY,CAAA,CAAA;AAEtC,QAAM,MAAA,OAAA,GAAU,MAAME,mDAAyB,CAAA;AAAA,kBAC7CF,QAAA;AAAA,UACA,QAAA;AAAA,UACA,SAAA;AAAA,UACA,kBAAA;AAAA,UACA,qBAAA;AAAA,UACA,cAAA;AAAA,UACA,MAAA;AAAA,UACA,kBAAA;AAAA,UACA,SAAA;AAAA,UACA,IAAA;AAAA,SACD,CAAA,CAAA;AAED,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAMG,mBAAa,CAAA;AAAA,YACjB,GAAG,OAAA;AAAA,oBACHH,QAAA;AAAA,YACA,MAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}
+{"version":3,"file":"plugin.cjs.js","sources":["../../src/plugin/plugin.ts"],"sourcesContent":["/*\n * Copyright 2024 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  coreServices,\n  createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { CheckResult } from '@backstage-community/plugin-tech-insights-common';\nimport {\n  FactCheckerFactory,\n  FactRetriever,\n  FactRetrieverRegistration,\n  FactRetrieverRegistry,\n  PersistenceContext,\n  TechInsightCheck,\n  techInsightsFactCheckerFactoryExtensionPoint,\n  techInsightsFactRetrieverRegistryExtensionPoint,\n  techInsightsFactRetrieversExtensionPoint,\n  techInsightsPersistenceContextExtensionPoint,\n} from '@backstage-community/plugin-tech-insights-node';\nimport {\n  buildTechInsightsContext,\n  createRouter,\n  entityMetadataFactRetriever,\n  entityOwnershipFactRetriever,\n  techdocsFactRetriever,\n} from '../service';\nimport { createFactRetrieverRegistrationFromConfig } from './config';\n\n/**\n * The tech-insights backend plugin.\n *\n * @public\n */\nexport const techInsightsPlugin = createBackendPlugin({\n  pluginId: 'tech-insights',\n  register(env) {\n    let factCheckerFactory:\n      | FactCheckerFactory<TechInsightCheck, CheckResult>\n      | undefined = undefined;\n    env.registerExtensionPoint(techInsightsFactCheckerFactoryExtensionPoint, {\n      setFactCheckerFactory<\n        CheckType extends TechInsightCheck,\n        CheckResultType extends CheckResult,\n      >(factory: FactCheckerFactory<CheckType, CheckResultType>): void {\n        factCheckerFactory = factory;\n      },\n    });\n\n    let factRetrieverRegistry: FactRetrieverRegistry | undefined = undefined;\n    env.registerExtensionPoint(\n      techInsightsFactRetrieverRegistryExtensionPoint,\n      {\n        setFactRetrieverRegistry(registry: FactRetrieverRegistry): void {\n          factRetrieverRegistry = registry;\n        },\n      },\n    );\n\n    // initialized with built-in fact retrievers\n    // only added as registration if there is config for them\n    const addedFactRetrievers: Record<string, FactRetriever> = {\n      entityMetadataFactRetriever,\n      entityOwnershipFactRetriever,\n      techdocsFactRetriever,\n    };\n    env.registerExtensionPoint(techInsightsFactRetrieversExtensionPoint, {\n      addFactRetrievers(factRetrievers: Record<string, FactRetriever>): void {\n        Object.entries(factRetrievers).forEach(([key, value]) => {\n          addedFactRetrievers[key] = value;\n        });\n      },\n    });\n\n    let persistenceContext: PersistenceContext | undefined = undefined;\n    env.registerExtensionPoint(techInsightsPersistenceContextExtensionPoint, {\n      setPersistenceContext(context: PersistenceContext): void {\n        persistenceContext = context;\n      },\n    });\n\n    env.registerInit({\n      deps: {\n        config: coreServices.rootConfig,\n        database: coreServices.database,\n        discovery: coreServices.discovery,\n        httpRouter: coreServices.httpRouter,\n        logger: coreServices.logger,\n        scheduler: coreServices.scheduler,\n        auth: coreServices.auth,\n        urlReader: coreServices.urlReader,\n      },\n      async init({\n        config,\n        database,\n        discovery,\n        httpRouter,\n        logger,\n        scheduler,\n        auth,\n        urlReader,\n      }) {\n        const factRetrievers: FactRetrieverRegistration[] = Object.entries(\n          addedFactRetrievers,\n        )\n          .map(([name, factRetriever]) =>\n            createFactRetrieverRegistrationFromConfig(\n              config,\n              name,\n              factRetriever,\n            ),\n          )\n          .filter(registration => registration) as FactRetrieverRegistration[];\n\n        const context = await buildTechInsightsContext({\n          config,\n          database,\n          discovery,\n          factCheckerFactory,\n          factRetrieverRegistry,\n          factRetrievers,\n          logger,\n          persistenceContext,\n          scheduler,\n          auth,\n          urlReader,\n        });\n\n        httpRouter.use(\n          await createRouter({\n            ...context,\n            config,\n            logger,\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendPlugin","techInsightsFactCheckerFactoryExtensionPoint","techInsightsFactRetrieverRegistryExtensionPoint","entityMetadataFactRetriever","entityOwnershipFactRetriever","techdocsFactRetriever","techInsightsFactRetrieversExtensionPoint","techInsightsPersistenceContextExtensionPoint","coreServices","config","createFactRetrieverRegistrationFromConfig","buildTechInsightsContext","createRouter"],"mappings":";;;;;;;;;;;;AA+CO,MAAM,qBAAqBA,oCAAoB,CAAA;AAAA,EACpD,QAAU,EAAA,eAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,IAAI,kBAEY,GAAA,KAAA,CAAA,CAAA;AAChB,IAAA,GAAA,CAAI,uBAAuBC,mEAA8C,EAAA;AAAA,MACvE,sBAGE,OAA+D,EAAA;AAC/D,QAAqB,kBAAA,GAAA,OAAA,CAAA;AAAA,OACvB;AAAA,KACD,CAAA,CAAA;AAED,IAAA,IAAI,qBAA2D,GAAA,KAAA,CAAA,CAAA;AAC/D,IAAI,GAAA,CAAA,sBAAA;AAAA,MACFC,sEAAA;AAAA,MACA;AAAA,QACE,yBAAyB,QAAuC,EAAA;AAC9D,UAAwB,qBAAA,GAAA,QAAA,CAAA;AAAA,SAC1B;AAAA,OACF;AAAA,KACF,CAAA;AAIA,IAAA,MAAM,mBAAqD,GAAA;AAAA,mCACzDC,uDAAA;AAAA,oCACAC,yDAAA;AAAA,6BACAC,2CAAA;AAAA,KACF,CAAA;AACA,IAAA,GAAA,CAAI,uBAAuBC,+DAA0C,EAAA;AAAA,MACnE,kBAAkB,cAAqD,EAAA;AACrE,QAAO,MAAA,CAAA,OAAA,CAAQ,cAAc,CAAE,CAAA,OAAA,CAAQ,CAAC,CAAC,GAAA,EAAK,KAAK,CAAM,KAAA;AACvD,UAAA,mBAAA,CAAoB,GAAG,CAAI,GAAA,KAAA,CAAA;AAAA,SAC5B,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAED,IAAA,IAAI,kBAAqD,GAAA,KAAA,CAAA,CAAA;AACzD,IAAA,GAAA,CAAI,uBAAuBC,mEAA8C,EAAA;AAAA,MACvE,sBAAsB,OAAmC,EAAA;AACvD,QAAqB,kBAAA,GAAA,OAAA,CAAA;AAAA,OACvB;AAAA,KACD,CAAA,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,YAAYA,6BAAa,CAAA,UAAA;AAAA,QACzB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,MAAMA,6BAAa,CAAA,IAAA;AAAA,QACnB,WAAWA,6BAAa,CAAA,SAAA;AAAA,OAC1B;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,gBACTC,QAAA;AAAA,QACA,QAAA;AAAA,QACA,SAAA;AAAA,QACA,UAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,IAAA;AAAA,QACA,SAAA;AAAA,OACC,EAAA;AACD,QAAA,MAAM,iBAA8C,MAAO,CAAA,OAAA;AAAA,UACzD,mBAAA;AAAA,SAEC,CAAA,GAAA;AAAA,UAAI,CAAC,CAAC,IAAM,EAAA,aAAa,CACxB,KAAAC,gDAAA;AAAA,YACED,QAAA;AAAA,YACA,IAAA;AAAA,YACA,aAAA;AAAA,WACF;AAAA,SACF,CACC,MAAO,CAAA,CAAA,YAAA,KAAgB,YAAY,CAAA,CAAA;AAEtC,QAAM,MAAA,OAAA,GAAU,MAAME,mDAAyB,CAAA;AAAA,kBAC7CF,QAAA;AAAA,UACA,QAAA;AAAA,UACA,SAAA;AAAA,UACA,kBAAA;AAAA,UACA,qBAAA;AAAA,UACA,cAAA;AAAA,UACA,MAAA;AAAA,UACA,kBAAA;AAAA,UACA,SAAA;AAAA,UACA,IAAA;AAAA,UACA,SAAA;AAAA,SACD,CAAA,CAAA;AAED,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAMG,mBAAa,CAAA;AAAA,YACjB,GAAG,OAAA;AAAA,oBACHH,QAAA;AAAA,YACA,MAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}

package/dist/service/fact/FactRetrieverEngine.cjs.js

@@ -45,29 +45,36 @@ class DefaultFactRetrieverEngine {
       defaultInitialDelay
     );
   }
+  async scheduleRegistration(registration) {
+    const { factRetriever, cadence, lifecycle, timeout, initialDelay } = registration;
+    const cronExpression = cadence || this.defaultCadence || randomDailyCron();
+    const timeLimit = timeout || this.defaultTimeout || luxon.Duration.fromObject({ minutes: 5 });
+    const initialDelaySetting = initialDelay || this.defaultInitialDelay || luxon.Duration.fromObject({ seconds: 5 });
+    await this.scheduler.scheduleTask({
+      id: factRetriever.id,
+      frequency: { cron: cronExpression },
+      fn: this.createFactRetrieverHandler(factRetriever, lifecycle),
+      timeout: timeLimit,
+      // We add a delay in order to prevent errors due to the
+      // fact that the backend is not yet online in a cold-start scenario
+      initialDelay: initialDelaySetting
+    });
+  }
+  async scheduleJob(ref) {
+    const registration = await this.factRetrieverRegistry.get(ref);
+    return this.scheduleRegistration(registration);
+  }
   async schedule() {
     const registrations = await this.factRetrieverRegistry.listRegistrations();
     const newRegs = [];
     await Promise.all(
       registrations.map(async (registration) => {
-        const { factRetriever, cadence, lifecycle, timeout, initialDelay } = registration;
-        const cronExpression = cadence || this.defaultCadence || randomDailyCron();
-        const timeLimit = timeout || this.defaultTimeout || luxon.Duration.fromObject({ minutes: 5 });
-        const initialDelaySetting = initialDelay || this.defaultInitialDelay || luxon.Duration.fromObject({ seconds: 5 });
         try {
-          await this.scheduler.scheduleTask({
-            id: factRetriever.id,
-            frequency: { cron: cronExpression },
-            fn: this.createFactRetrieverHandler(factRetriever, lifecycle),
-            timeout: timeLimit,
-            // We add a delay in order to prevent errors due to the
-            // fact that the backend is not yet online in a cold-start scenario
-            initialDelay: initialDelaySetting
-          });
-          newRegs.push(factRetriever.id);
+          await this.scheduleRegistration(registration);
+          newRegs.push(registration.factRetriever.id);
         } catch (e) {
           this.logger.warn(
-            `Failed to schedule fact retriever ${factRetriever.id}, ${e}`
+            `Failed to schedule fact retriever ${registration.factRetriever.id}, ${e}`
           );
         }
       })

package/dist/service/fact/FactRetrieverEngine.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"FactRetrieverEngine.cjs.js","sources":["../../../src/service/fact/FactRetrieverEngine.ts"],"sourcesContent":["/*\n * Copyright 2021 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 */\nimport {\n  FactLifecycle,\n  FactRetriever,\n  FactRetrieverContext,\n  FactRetrieverRegistration,\n  FactRetrieverRegistry,\n  TechInsightFact,\n  TechInsightsStore,\n} from '@backstage-community/plugin-tech-insights-node';\nimport { Duration } from 'luxon';\nimport { LoggerService, SchedulerService } from '@backstage/backend-plugin-api';\n\nfunction randomDailyCron() {\n  const rand = (min: number, max: number) =>\n    Math.floor(Math.random() * (max - min + 1) + min);\n  return `${rand(0, 59)} ${rand(0, 23)} * * *`;\n}\n\nfunction duration(startTimestamp: [number, number]): string {\n  const delta = process.hrtime(startTimestamp);\n  const seconds = delta[0] + delta[1] / 1e9;\n  return `${seconds.toFixed(1)}s`;\n}\n\n/**\n * @public\n *\n * FactRetrieverEngine responsible scheduling and running fact retrieval tasks.\n */\nexport interface FactRetrieverEngine {\n  /**\n   * Schedules fact retriever run cycles based on configuration provided in the registration.\n   *\n   * Default implementation uses backend-tasks to handle scheduling. This function can be called multiple\n   * times, where initial calls schedule the tasks and subsequent invocations update the schedules.\n   */\n  schedule(): Promise<void>;\n\n  /**\n   * Provides possibility to manually run a fact retriever job and construct fact data\n   *\n   * @param ref - Reference to the task name stored in the executor database. By convention this is the fact retriever id\n   */\n  triggerJob(ref: string): Promise<void>;\n\n  /**\n   * Exposes fact retriever job configuration information about previous and next runs and schedule\n   *\n   * @param ref - Reference to the task name stored in the executor database. By convention this is the fact retriever id\n   */\n  getJobRegistration(ref: string): Promise<FactRetrieverRegistration>;\n}\n\nexport class DefaultFactRetrieverEngine implements FactRetrieverEngine {\n  private constructor(\n    private readonly repository: TechInsightsStore,\n    private readonly factRetrieverRegistry: FactRetrieverRegistry,\n    private readonly factRetrieverContext: FactRetrieverContext,\n    private readonly logger: LoggerService,\n    private readonly scheduler: SchedulerService,\n    private readonly defaultCadence?: string,\n    private readonly defaultTimeout?: Duration,\n    private readonly defaultInitialDelay?: Duration,\n  ) {}\n\n  static async create(options: {\n    repository: TechInsightsStore;\n    factRetrieverRegistry: FactRetrieverRegistry;\n    factRetrieverContext: FactRetrieverContext;\n    scheduler: SchedulerService;\n    defaultCadence?: string;\n    defaultTimeout?: Duration;\n    defaultInitialDelay?: Duration;\n  }) {\n    const {\n      repository,\n      factRetrieverRegistry,\n      factRetrieverContext,\n      scheduler,\n      defaultCadence,\n      defaultTimeout,\n      defaultInitialDelay,\n    } = options;\n\n    const retrievers = await factRetrieverRegistry.listRetrievers();\n    await Promise.all(retrievers.map(it => repository.insertFactSchema(it)));\n\n    return new DefaultFactRetrieverEngine(\n      repository,\n      factRetrieverRegistry,\n      factRetrieverContext,\n      factRetrieverContext.logger,\n      scheduler,\n      defaultCadence,\n      defaultTimeout,\n      defaultInitialDelay,\n    );\n  }\n\n  async schedule() {\n    const registrations = await this.factRetrieverRegistry.listRegistrations();\n    const newRegs: string[] = [];\n\n    await Promise.all(\n      registrations.map(async registration => {\n        const { factRetriever, cadence, lifecycle, timeout, initialDelay } =\n          registration;\n        const cronExpression =\n          cadence || this.defaultCadence || randomDailyCron();\n        const timeLimit =\n          timeout || this.defaultTimeout || Duration.fromObject({ minutes: 5 });\n        const initialDelaySetting =\n          initialDelay ||\n          this.defaultInitialDelay ||\n          Duration.fromObject({ seconds: 5 });\n        try {\n          await this.scheduler.scheduleTask({\n            id: factRetriever.id,\n            frequency: { cron: cronExpression },\n            fn: this.createFactRetrieverHandler(factRetriever, lifecycle),\n            timeout: timeLimit,\n            // We add a delay in order to prevent errors due to the\n            // fact that the backend is not yet online in a cold-start scenario\n            initialDelay: initialDelaySetting,\n          });\n          newRegs.push(factRetriever.id);\n        } catch (e) {\n          this.logger.warn(\n            `Failed to schedule fact retriever ${factRetriever.id}, ${e}`,\n          );\n        }\n      }),\n    );\n\n    this.logger.info(\n      `Scheduled ${newRegs.length}/${registrations.length} fact retrievers into the tech-insights engine`,\n    );\n  }\n\n  getJobRegistration(ref: string): Promise<FactRetrieverRegistration> {\n    return this.factRetrieverRegistry.get(ref);\n  }\n\n  async triggerJob(ref: string): Promise<void> {\n    await this.scheduler.triggerTask(ref);\n  }\n\n  private createFactRetrieverHandler(\n    factRetriever: FactRetriever,\n    lifecycle?: FactLifecycle,\n  ) {\n    return async () => {\n      const startTimestamp = process.hrtime();\n      this.logger.info(\n        `Retrieving facts for fact retriever ${factRetriever.id}`,\n      );\n\n      let facts: TechInsightFact[] = [];\n      try {\n        facts = await factRetriever.handler({\n          ...this.factRetrieverContext,\n          logger: this.logger.child({ factRetrieverId: factRetriever.id }),\n          entityFilter: factRetriever.entityFilter,\n        });\n        this.logger.debug(\n          `Retrieved ${facts.length} facts for fact retriever ${\n            factRetriever.id\n          } in ${duration(startTimestamp)}`,\n        );\n      } catch (e) {\n        this.logger.error(\n          `Failed to retrieve facts for retriever ${factRetriever.id}`,\n          e,\n        );\n      }\n\n      try {\n        await this.repository.insertFacts({\n          id: factRetriever.id,\n          facts,\n          lifecycle,\n        });\n        this.logger.info(\n          `Stored ${facts.length} facts for fact retriever ${\n            factRetriever.id\n          } in ${duration(startTimestamp)}`,\n        );\n      } catch (e) {\n        this.logger.warn(\n          `Failed to insert facts for fact retriever ${factRetriever.id}`,\n          e,\n        );\n      }\n    };\n  }\n}\n"],"names":["Duration"],"mappings":";;;;AA2BA,SAAS,eAAkB,GAAA;AACzB,EAAA,MAAM,IAAO,GAAA,CAAC,GAAa,EAAA,GAAA,KACzB,IAAK,CAAA,KAAA,CAAM,IAAK,CAAA,MAAA,EAAY,IAAA,GAAA,GAAM,GAAM,GAAA,CAAA,CAAA,GAAK,GAAG,CAAA,CAAA;AAClD,EAAO,OAAA,CAAA,EAAG,KAAK,CAAG,EAAA,EAAE,CAAC,CAAI,CAAA,EAAA,IAAA,CAAK,CAAG,EAAA,EAAE,CAAC,CAAA,MAAA,CAAA,CAAA;AACtC,CAAA;AAEA,SAAS,SAAS,cAA0C,EAAA;AAC1D,EAAM,MAAA,KAAA,GAAQ,OAAQ,CAAA,MAAA,CAAO,cAAc,CAAA,CAAA;AAC3C,EAAA,MAAM,UAAU,KAAM,CAAA,CAAC,CAAI,GAAA,KAAA,CAAM,CAAC,CAAI,GAAA,GAAA,CAAA;AACtC,EAAA,OAAO,CAAG,EAAA,OAAA,CAAQ,OAAQ,CAAA,CAAC,CAAC,CAAA,CAAA,CAAA,CAAA;AAC9B,CAAA;AA+BO,MAAM,0BAA0D,CAAA;AAAA,EAC7D,WAAA,CACW,YACA,qBACA,EAAA,oBAAA,EACA,QACA,SACA,EAAA,cAAA,EACA,gBACA,mBACjB,EAAA;AARiB,IAAA,IAAA,CAAA,UAAA,GAAA,UAAA,CAAA;AACA,IAAA,IAAA,CAAA,qBAAA,GAAA,qBAAA,CAAA;AACA,IAAA,IAAA,CAAA,oBAAA,GAAA,oBAAA,CAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA,CAAA;AACA,IAAA,IAAA,CAAA,cAAA,GAAA,cAAA,CAAA;AACA,IAAA,IAAA,CAAA,cAAA,GAAA,cAAA,CAAA;AACA,IAAA,IAAA,CAAA,mBAAA,GAAA,mBAAA,CAAA;AAAA,GAChB;AAAA,EAEH,aAAa,OAAO,OAQjB,EAAA;AACD,IAAM,MAAA;AAAA,MACJ,UAAA;AAAA,MACA,qBAAA;AAAA,MACA,oBAAA;AAAA,MACA,SAAA;AAAA,MACA,cAAA;AAAA,MACA,cAAA;AAAA,MACA,mBAAA;AAAA,KACE,GAAA,OAAA,CAAA;AAEJ,IAAM,MAAA,UAAA,GAAa,MAAM,qBAAA,CAAsB,cAAe,EAAA,CAAA;AAC9D,IAAM,MAAA,OAAA,CAAQ,IAAI,UAAW,CAAA,GAAA,CAAI,QAAM,UAAW,CAAA,gBAAA,CAAiB,EAAE,CAAC,CAAC,CAAA,CAAA;AAEvE,IAAA,OAAO,IAAI,0BAAA;AAAA,MACT,UAAA;AAAA,MACA,qBAAA;AAAA,MACA,oBAAA;AAAA,MACA,oBAAqB,CAAA,MAAA;AAAA,MACrB,SAAA;AAAA,MACA,cAAA;AAAA,MACA,cAAA;AAAA,MACA,mBAAA;AAAA,KACF,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,QAAW,GAAA;AACf,IAAA,MAAM,aAAgB,GAAA,MAAM,IAAK,CAAA,qBAAA,CAAsB,iBAAkB,EAAA,CAAA;AACzE,IAAA,MAAM,UAAoB,EAAC,CAAA;AAE3B,IAAA,MAAM,OAAQ,CAAA,GAAA;AAAA,MACZ,aAAA,CAAc,GAAI,CAAA,OAAM,YAAgB,KAAA;AACtC,QAAA,MAAM,EAAE,aAAe,EAAA,OAAA,EAAS,SAAW,EAAA,OAAA,EAAS,cAClD,GAAA,YAAA,CAAA;AACF,QAAA,MAAM,cACJ,GAAA,OAAA,IAAW,IAAK,CAAA,cAAA,IAAkB,eAAgB,EAAA,CAAA;AACpD,QAAM,MAAA,SAAA,GACJ,WAAW,IAAK,CAAA,cAAA,IAAkBA,eAAS,UAAW,CAAA,EAAE,OAAS,EAAA,CAAA,EAAG,CAAA,CAAA;AACtE,QAAM,MAAA,mBAAA,GACJ,gBACA,IAAK,CAAA,mBAAA,IACLA,eAAS,UAAW,CAAA,EAAE,OAAS,EAAA,CAAA,EAAG,CAAA,CAAA;AACpC,QAAI,IAAA;AACF,UAAM,MAAA,IAAA,CAAK,UAAU,YAAa,CAAA;AAAA,YAChC,IAAI,aAAc,CAAA,EAAA;AAAA,YAClB,SAAA,EAAW,EAAE,IAAA,EAAM,cAAe,EAAA;AAAA,YAClC,EAAI,EAAA,IAAA,CAAK,0BAA2B,CAAA,aAAA,EAAe,SAAS,CAAA;AAAA,YAC5D,OAAS,EAAA,SAAA;AAAA;AAAA;AAAA,YAGT,YAAc,EAAA,mBAAA;AAAA,WACf,CAAA,CAAA;AACD,UAAQ,OAAA,CAAA,IAAA,CAAK,cAAc,EAAE,CAAA,CAAA;AAAA,iBACtB,CAAG,EAAA;AACV,UAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,YACV,CAAqC,kCAAA,EAAA,aAAA,CAAc,EAAE,CAAA,EAAA,EAAK,CAAC,CAAA,CAAA;AAAA,WAC7D,CAAA;AAAA,SACF;AAAA,OACD,CAAA;AAAA,KACH,CAAA;AAEA,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,MACV,CAAa,UAAA,EAAA,OAAA,CAAQ,MAAM,CAAA,CAAA,EAAI,cAAc,MAAM,CAAA,8CAAA,CAAA;AAAA,KACrD,CAAA;AAAA,GACF;AAAA,EAEA,mBAAmB,GAAiD,EAAA;AAClE,IAAO,OAAA,IAAA,CAAK,qBAAsB,CAAA,GAAA,CAAI,GAAG,CAAA,CAAA;AAAA,GAC3C;AAAA,EAEA,MAAM,WAAW,GAA4B,EAAA;AAC3C,IAAM,MAAA,IAAA,CAAK,SAAU,CAAA,WAAA,CAAY,GAAG,CAAA,CAAA;AAAA,GACtC;AAAA,EAEQ,0BAAA,CACN,eACA,SACA,EAAA;AACA,IAAA,OAAO,YAAY;AACjB,MAAM,MAAA,cAAA,GAAiB,QAAQ,MAAO,EAAA,CAAA;AACtC,MAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,QACV,CAAA,oCAAA,EAAuC,cAAc,EAAE,CAAA,CAAA;AAAA,OACzD,CAAA;AAEA,MAAA,IAAI,QAA2B,EAAC,CAAA;AAChC,MAAI,IAAA;AACF,QAAQ,KAAA,GAAA,MAAM,cAAc,OAAQ,CAAA;AAAA,UAClC,GAAG,IAAK,CAAA,oBAAA;AAAA,UACR,MAAA,EAAQ,KAAK,MAAO,CAAA,KAAA,CAAM,EAAE,eAAiB,EAAA,aAAA,CAAc,IAAI,CAAA;AAAA,UAC/D,cAAc,aAAc,CAAA,YAAA;AAAA,SAC7B,CAAA,CAAA;AACD,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,CAAA,UAAA,EAAa,MAAM,MAAM,CAAA,0BAAA,EACvB,cAAc,EAChB,CAAA,IAAA,EAAO,QAAS,CAAA,cAAc,CAAC,CAAA,CAAA;AAAA,SACjC,CAAA;AAAA,eACO,CAAG,EAAA;AACV,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,CAAA,uCAAA,EAA0C,cAAc,EAAE,CAAA,CAAA;AAAA,UAC1D,CAAA;AAAA,SACF,CAAA;AAAA,OACF;AAEA,MAAI,IAAA;AACF,QAAM,MAAA,IAAA,CAAK,WAAW,WAAY,CAAA;AAAA,UAChC,IAAI,aAAc,CAAA,EAAA;AAAA,UAClB,KAAA;AAAA,UACA,SAAA;AAAA,SACD,CAAA,CAAA;AACD,QAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,UACV,CAAA,OAAA,EAAU,MAAM,MAAM,CAAA,0BAAA,EACpB,cAAc,EAChB,CAAA,IAAA,EAAO,QAAS,CAAA,cAAc,CAAC,CAAA,CAAA;AAAA,SACjC,CAAA;AAAA,eACO,CAAG,EAAA;AACV,QAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,UACV,CAAA,0CAAA,EAA6C,cAAc,EAAE,CAAA,CAAA;AAAA,UAC7D,CAAA;AAAA,SACF,CAAA;AAAA,OACF;AAAA,KACF,CAAA;AAAA,GACF;AACF;;;;"}
+{"version":3,"file":"FactRetrieverEngine.cjs.js","sources":["../../../src/service/fact/FactRetrieverEngine.ts"],"sourcesContent":["/*\n * Copyright 2021 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 */\nimport {\n  FactLifecycle,\n  FactRetriever,\n  FactRetrieverContext,\n  FactRetrieverRegistration,\n  FactRetrieverRegistry,\n  TechInsightFact,\n  TechInsightsStore,\n} from '@backstage-community/plugin-tech-insights-node';\nimport { Duration } from 'luxon';\nimport { LoggerService, SchedulerService } from '@backstage/backend-plugin-api';\n\nfunction randomDailyCron() {\n  const rand = (min: number, max: number) =>\n    Math.floor(Math.random() * (max - min + 1) + min);\n  return `${rand(0, 59)} ${rand(0, 23)} * * *`;\n}\n\nfunction duration(startTimestamp: [number, number]): string {\n  const delta = process.hrtime(startTimestamp);\n  const seconds = delta[0] + delta[1] / 1e9;\n  return `${seconds.toFixed(1)}s`;\n}\n\n/**\n * @public\n *\n * FactRetrieverEngine responsible scheduling and running fact retrieval tasks.\n */\nexport abstract class FactRetrieverEngine {\n  /**\n   * Schedules fact retriever run cycles based on configuration provided in the registration.\n   *\n   * Default implementation uses backend-tasks to handle scheduling. This function can be called multiple\n   * times, where initial calls schedule the tasks and subsequent invocations update the schedules.\n   */\n  abstract schedule(): Promise<void>;\n\n  /**\n   * Schedules single fact retriever run cycles based on configuration provided in the registration.\n   *\n   * Default implementation defers to scheduling all jobs\n   */\n  async scheduleJob(_: string): Promise<void> {\n    return await this.schedule();\n  }\n\n  /**\n   * Provides possibility to manually run a fact retriever job and construct fact data\n   *\n   * @param ref - Reference to the task name stored in the executor database. By convention this is the fact retriever id\n   */\n  abstract triggerJob(ref: string): Promise<void>;\n\n  /**\n   * Exposes fact retriever job configuration information about previous and next runs and schedule\n   *\n   * @param ref - Reference to the task name stored in the executor database. By convention this is the fact retriever id\n   */\n  abstract getJobRegistration(ref: string): Promise<FactRetrieverRegistration>;\n}\n\nexport class DefaultFactRetrieverEngine implements FactRetrieverEngine {\n  private constructor(\n    private readonly repository: TechInsightsStore,\n    private readonly factRetrieverRegistry: FactRetrieverRegistry,\n    private readonly factRetrieverContext: FactRetrieverContext,\n    private readonly logger: LoggerService,\n    private readonly scheduler: SchedulerService,\n    private readonly defaultCadence?: string,\n    private readonly defaultTimeout?: Duration,\n    private readonly defaultInitialDelay?: Duration,\n  ) {}\n\n  static async create(options: {\n    repository: TechInsightsStore;\n    factRetrieverRegistry: FactRetrieverRegistry;\n    factRetrieverContext: FactRetrieverContext;\n    scheduler: SchedulerService;\n    defaultCadence?: string;\n    defaultTimeout?: Duration;\n    defaultInitialDelay?: Duration;\n  }) {\n    const {\n      repository,\n      factRetrieverRegistry,\n      factRetrieverContext,\n      scheduler,\n      defaultCadence,\n      defaultTimeout,\n      defaultInitialDelay,\n    } = options;\n\n    const retrievers = await factRetrieverRegistry.listRetrievers();\n    await Promise.all(retrievers.map(it => repository.insertFactSchema(it)));\n\n    return new DefaultFactRetrieverEngine(\n      repository,\n      factRetrieverRegistry,\n      factRetrieverContext,\n      factRetrieverContext.logger,\n      scheduler,\n      defaultCadence,\n      defaultTimeout,\n      defaultInitialDelay,\n    );\n  }\n\n  private async scheduleRegistration(registration: FactRetrieverRegistration) {\n    const { factRetriever, cadence, lifecycle, timeout, initialDelay } =\n      registration;\n    const cronExpression = cadence || this.defaultCadence || randomDailyCron();\n    const timeLimit =\n      timeout || this.defaultTimeout || Duration.fromObject({ minutes: 5 });\n    const initialDelaySetting =\n      initialDelay ||\n      this.defaultInitialDelay ||\n      Duration.fromObject({ seconds: 5 });\n\n    await this.scheduler.scheduleTask({\n      id: factRetriever.id,\n      frequency: { cron: cronExpression },\n      fn: this.createFactRetrieverHandler(factRetriever, lifecycle),\n      timeout: timeLimit,\n      // We add a delay in order to prevent errors due to the\n      // fact that the backend is not yet online in a cold-start scenario\n      initialDelay: initialDelaySetting,\n    });\n  }\n\n  async scheduleJob(ref: string): Promise<void> {\n    const registration = await this.factRetrieverRegistry.get(ref);\n    return this.scheduleRegistration(registration);\n  }\n\n  async schedule() {\n    const registrations = await this.factRetrieverRegistry.listRegistrations();\n    const newRegs: string[] = [];\n\n    await Promise.all(\n      registrations.map(async registration => {\n        try {\n          await this.scheduleRegistration(registration);\n          newRegs.push(registration.factRetriever.id);\n        } catch (e) {\n          this.logger.warn(\n            `Failed to schedule fact retriever ${registration.factRetriever.id}, ${e}`,\n          );\n        }\n      }),\n    );\n\n    this.logger.info(\n      `Scheduled ${newRegs.length}/${registrations.length} fact retrievers into the tech-insights engine`,\n    );\n  }\n\n  getJobRegistration(ref: string): Promise<FactRetrieverRegistration> {\n    return this.factRetrieverRegistry.get(ref);\n  }\n\n  async triggerJob(ref: string): Promise<void> {\n    await this.scheduler.triggerTask(ref);\n  }\n\n  private createFactRetrieverHandler(\n    factRetriever: FactRetriever,\n    lifecycle?: FactLifecycle,\n  ) {\n    return async () => {\n      const startTimestamp = process.hrtime();\n      this.logger.info(\n        `Retrieving facts for fact retriever ${factRetriever.id}`,\n      );\n\n      let facts: TechInsightFact[] = [];\n      try {\n        facts = await factRetriever.handler({\n          ...this.factRetrieverContext,\n          logger: this.logger.child({ factRetrieverId: factRetriever.id }),\n          entityFilter: factRetriever.entityFilter,\n        });\n        this.logger.debug(\n          `Retrieved ${facts.length} facts for fact retriever ${\n            factRetriever.id\n          } in ${duration(startTimestamp)}`,\n        );\n      } catch (e) {\n        this.logger.error(\n          `Failed to retrieve facts for retriever ${factRetriever.id}`,\n          e,\n        );\n      }\n\n      try {\n        await this.repository.insertFacts({\n          id: factRetriever.id,\n          facts,\n          lifecycle,\n        });\n        this.logger.info(\n          `Stored ${facts.length} facts for fact retriever ${\n            factRetriever.id\n          } in ${duration(startTimestamp)}`,\n        );\n      } catch (e) {\n        this.logger.warn(\n          `Failed to insert facts for fact retriever ${factRetriever.id}`,\n          e,\n        );\n      }\n    };\n  }\n}\n"],"names":["Duration"],"mappings":";;;;AA2BA,SAAS,eAAkB,GAAA;AACzB,EAAA,MAAM,IAAO,GAAA,CAAC,GAAa,EAAA,GAAA,KACzB,IAAK,CAAA,KAAA,CAAM,IAAK,CAAA,MAAA,EAAY,IAAA,GAAA,GAAM,GAAM,GAAA,CAAA,CAAA,GAAK,GAAG,CAAA,CAAA;AAClD,EAAO,OAAA,CAAA,EAAG,KAAK,CAAG,EAAA,EAAE,CAAC,CAAI,CAAA,EAAA,IAAA,CAAK,CAAG,EAAA,EAAE,CAAC,CAAA,MAAA,CAAA,CAAA;AACtC,CAAA;AAEA,SAAS,SAAS,cAA0C,EAAA;AAC1D,EAAM,MAAA,KAAA,GAAQ,OAAQ,CAAA,MAAA,CAAO,cAAc,CAAA,CAAA;AAC3C,EAAA,MAAM,UAAU,KAAM,CAAA,CAAC,CAAI,GAAA,KAAA,CAAM,CAAC,CAAI,GAAA,GAAA,CAAA;AACtC,EAAA,OAAO,CAAG,EAAA,OAAA,CAAQ,OAAQ,CAAA,CAAC,CAAC,CAAA,CAAA,CAAA,CAAA;AAC9B,CAAA;AAwCO,MAAM,0BAA0D,CAAA;AAAA,EAC7D,WAAA,CACW,YACA,qBACA,EAAA,oBAAA,EACA,QACA,SACA,EAAA,cAAA,EACA,gBACA,mBACjB,EAAA;AARiB,IAAA,IAAA,CAAA,UAAA,GAAA,UAAA,CAAA;AACA,IAAA,IAAA,CAAA,qBAAA,GAAA,qBAAA,CAAA;AACA,IAAA,IAAA,CAAA,oBAAA,GAAA,oBAAA,CAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA,CAAA;AACA,IAAA,IAAA,CAAA,cAAA,GAAA,cAAA,CAAA;AACA,IAAA,IAAA,CAAA,cAAA,GAAA,cAAA,CAAA;AACA,IAAA,IAAA,CAAA,mBAAA,GAAA,mBAAA,CAAA;AAAA,GAChB;AAAA,EAEH,aAAa,OAAO,OAQjB,EAAA;AACD,IAAM,MAAA;AAAA,MACJ,UAAA;AAAA,MACA,qBAAA;AAAA,MACA,oBAAA;AAAA,MACA,SAAA;AAAA,MACA,cAAA;AAAA,MACA,cAAA;AAAA,MACA,mBAAA;AAAA,KACE,GAAA,OAAA,CAAA;AAEJ,IAAM,MAAA,UAAA,GAAa,MAAM,qBAAA,CAAsB,cAAe,EAAA,CAAA;AAC9D,IAAM,MAAA,OAAA,CAAQ,IAAI,UAAW,CAAA,GAAA,CAAI,QAAM,UAAW,CAAA,gBAAA,CAAiB,EAAE,CAAC,CAAC,CAAA,CAAA;AAEvE,IAAA,OAAO,IAAI,0BAAA;AAAA,MACT,UAAA;AAAA,MACA,qBAAA;AAAA,MACA,oBAAA;AAAA,MACA,oBAAqB,CAAA,MAAA;AAAA,MACrB,SAAA;AAAA,MACA,cAAA;AAAA,MACA,cAAA;AAAA,MACA,mBAAA;AAAA,KACF,CAAA;AAAA,GACF;AAAA,EAEA,MAAc,qBAAqB,YAAyC,EAAA;AAC1E,IAAA,MAAM,EAAE,aAAe,EAAA,OAAA,EAAS,SAAW,EAAA,OAAA,EAAS,cAClD,GAAA,YAAA,CAAA;AACF,IAAA,MAAM,cAAiB,GAAA,OAAA,IAAW,IAAK,CAAA,cAAA,IAAkB,eAAgB,EAAA,CAAA;AACzE,IAAM,MAAA,SAAA,GACJ,WAAW,IAAK,CAAA,cAAA,IAAkBA,eAAS,UAAW,CAAA,EAAE,OAAS,EAAA,CAAA,EAAG,CAAA,CAAA;AACtE,IAAM,MAAA,mBAAA,GACJ,gBACA,IAAK,CAAA,mBAAA,IACLA,eAAS,UAAW,CAAA,EAAE,OAAS,EAAA,CAAA,EAAG,CAAA,CAAA;AAEpC,IAAM,MAAA,IAAA,CAAK,UAAU,YAAa,CAAA;AAAA,MAChC,IAAI,aAAc,CAAA,EAAA;AAAA,MAClB,SAAA,EAAW,EAAE,IAAA,EAAM,cAAe,EAAA;AAAA,MAClC,EAAI,EAAA,IAAA,CAAK,0BAA2B,CAAA,aAAA,EAAe,SAAS,CAAA;AAAA,MAC5D,OAAS,EAAA,SAAA;AAAA;AAAA;AAAA,MAGT,YAAc,EAAA,mBAAA;AAAA,KACf,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,MAAM,YAAY,GAA4B,EAAA;AAC5C,IAAA,MAAM,YAAe,GAAA,MAAM,IAAK,CAAA,qBAAA,CAAsB,IAAI,GAAG,CAAA,CAAA;AAC7D,IAAO,OAAA,IAAA,CAAK,qBAAqB,YAAY,CAAA,CAAA;AAAA,GAC/C;AAAA,EAEA,MAAM,QAAW,GAAA;AACf,IAAA,MAAM,aAAgB,GAAA,MAAM,IAAK,CAAA,qBAAA,CAAsB,iBAAkB,EAAA,CAAA;AACzE,IAAA,MAAM,UAAoB,EAAC,CAAA;AAE3B,IAAA,MAAM,OAAQ,CAAA,GAAA;AAAA,MACZ,aAAA,CAAc,GAAI,CAAA,OAAM,YAAgB,KAAA;AACtC,QAAI,IAAA;AACF,UAAM,MAAA,IAAA,CAAK,qBAAqB,YAAY,CAAA,CAAA;AAC5C,UAAQ,OAAA,CAAA,IAAA,CAAK,YAAa,CAAA,aAAA,CAAc,EAAE,CAAA,CAAA;AAAA,iBACnC,CAAG,EAAA;AACV,UAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,YACV,CAAqC,kCAAA,EAAA,YAAA,CAAa,aAAc,CAAA,EAAE,KAAK,CAAC,CAAA,CAAA;AAAA,WAC1E,CAAA;AAAA,SACF;AAAA,OACD,CAAA;AAAA,KACH,CAAA;AAEA,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,MACV,CAAa,UAAA,EAAA,OAAA,CAAQ,MAAM,CAAA,CAAA,EAAI,cAAc,MAAM,CAAA,8CAAA,CAAA;AAAA,KACrD,CAAA;AAAA,GACF;AAAA,EAEA,mBAAmB,GAAiD,EAAA;AAClE,IAAO,OAAA,IAAA,CAAK,qBAAsB,CAAA,GAAA,CAAI,GAAG,CAAA,CAAA;AAAA,GAC3C;AAAA,EAEA,MAAM,WAAW,GAA4B,EAAA;AAC3C,IAAM,MAAA,IAAA,CAAK,SAAU,CAAA,WAAA,CAAY,GAAG,CAAA,CAAA;AAAA,GACtC;AAAA,EAEQ,0BAAA,CACN,eACA,SACA,EAAA;AACA,IAAA,OAAO,YAAY;AACjB,MAAM,MAAA,cAAA,GAAiB,QAAQ,MAAO,EAAA,CAAA;AACtC,MAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,QACV,CAAA,oCAAA,EAAuC,cAAc,EAAE,CAAA,CAAA;AAAA,OACzD,CAAA;AAEA,MAAA,IAAI,QAA2B,EAAC,CAAA;AAChC,MAAI,IAAA;AACF,QAAQ,KAAA,GAAA,MAAM,cAAc,OAAQ,CAAA;AAAA,UAClC,GAAG,IAAK,CAAA,oBAAA;AAAA,UACR,MAAA,EAAQ,KAAK,MAAO,CAAA,KAAA,CAAM,EAAE,eAAiB,EAAA,aAAA,CAAc,IAAI,CAAA;AAAA,UAC/D,cAAc,aAAc,CAAA,YAAA;AAAA,SAC7B,CAAA,CAAA;AACD,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,CAAA,UAAA,EAAa,MAAM,MAAM,CAAA,0BAAA,EACvB,cAAc,EAChB,CAAA,IAAA,EAAO,QAAS,CAAA,cAAc,CAAC,CAAA,CAAA;AAAA,SACjC,CAAA;AAAA,eACO,CAAG,EAAA;AACV,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,CAAA,uCAAA,EAA0C,cAAc,EAAE,CAAA,CAAA;AAAA,UAC1D,CAAA;AAAA,SACF,CAAA;AAAA,OACF;AAEA,MAAI,IAAA;AACF,QAAM,MAAA,IAAA,CAAK,WAAW,WAAY,CAAA;AAAA,UAChC,IAAI,aAAc,CAAA,EAAA;AAAA,UAClB,KAAA;AAAA,UACA,SAAA;AAAA,SACD,CAAA,CAAA;AACD,QAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,UACV,CAAA,OAAA,EAAU,MAAM,MAAM,CAAA,0BAAA,EACpB,cAAc,EAChB,CAAA,IAAA,EAAO,QAAS,CAAA,cAAc,CAAC,CAAA,CAAA;AAAA,SACjC,CAAA;AAAA,eACO,CAAG,EAAA;AACV,QAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,UACV,CAAA,0CAAA,EAA6C,cAAc,EAAE,CAAA,CAAA;AAAA,UAC7D,CAAA;AAAA,SACF,CAAA;AAAA,OACF;AAAA,KACF,CAAA;AAAA,GACF;AACF;;;;"}

package/dist/service/techInsightsContextBuilder.cjs.js

@@ -13,7 +13,8 @@ const buildTechInsightsContext = async (options) => {
     database,
     logger,
     scheduler,
-    auth
+    auth,
+    urlReader
   } = options;
   const buildFactRetrieverRegistry = () => {
     if (!options.factRetrieverRegistry) {
@@ -38,7 +39,8 @@ const buildTechInsightsContext = async (options) => {
       config,
       discovery,
       logger,
-      auth
+      auth,
+      urlReader
     }
   });
   await factRetrieverEngine.schedule();

package/dist/service/techInsightsContextBuilder.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"techInsightsContextBuilder.cjs.js","sources":["../../src/service/techInsightsContextBuilder.ts"],"sourcesContent":["/*\n * Copyright 2021 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  DefaultFactRetrieverEngine,\n  FactRetrieverEngine,\n} from './fact/FactRetrieverEngine';\nimport { DefaultFactRetrieverRegistry } from './fact/FactRetrieverRegistry';\nimport { Config } from '@backstage/config';\nimport {\n  FactChecker,\n  FactCheckerFactory,\n  FactRetrieverRegistration,\n  FactRetrieverRegistry,\n  PersistenceContext,\n  TechInsightCheck,\n} from '@backstage-community/plugin-tech-insights-node';\nimport { initializePersistenceContext } from './persistence';\nimport { CheckResult } from '@backstage-community/plugin-tech-insights-common';\nimport {\n  AuthService,\n  DatabaseService,\n  DiscoveryService,\n  LoggerService,\n  SchedulerService,\n} from '@backstage/backend-plugin-api';\n\n/**\n * @public\n * @typeParam CheckType - Type of the check for the fact checker this builder returns\n * @typeParam CheckResultType - Type of the check result for the fact checker this builder returns\n *\n * Configuration options to initialize TechInsightsBuilder. Generic types params are needed if FactCheckerFactory\n * is included for FactChecker creation.\n */\nexport interface TechInsightsOptions<\n  CheckType extends TechInsightCheck,\n  CheckResultType extends CheckResult,\n> {\n  /**\n   * Optional collection of FactRetrieverRegistrations (required if no factRetrieverRegistry passed in).\n   * Used to register FactRetrievers and their schemas and schedule an execution loop for them.\n   *\n   * Not needed if passing in your own FactRetrieverRegistry implementation. Required otherwise.\n   */\n  factRetrievers?: FactRetrieverRegistration[];\n\n  /**\n   * Optional factory exposing a `construct` method to initialize a FactChecker implementation\n   */\n  factCheckerFactory?: FactCheckerFactory<CheckType, CheckResultType>;\n\n  /**\n   * Optional FactRetrieverRegistry implementation that replaces the default one.\n   *\n   * If passing this in you don't need to pass in factRetrievers also.\n   */\n  factRetrieverRegistry?: FactRetrieverRegistry;\n\n  /**\n   * Optional persistenceContext implementation that replaces the default one.\n   * This can be used to replace underlying database with a more suitable implementation if needed\n   */\n  persistenceContext?: PersistenceContext;\n\n  logger: LoggerService;\n  config: Config;\n  discovery: DiscoveryService;\n  database: DatabaseService;\n  scheduler: SchedulerService;\n  auth: AuthService;\n}\n\n/**\n * @public\n * @typeParam CheckType - Type of the check for the fact checker this builder returns\n * @typeParam CheckResultType - Type of the check result for the fact checker this builder returns\n *\n * A container for exported implementations related to TechInsights.\n * FactChecker is present if an optional FactCheckerFactory is included in the build stage.\n */\nexport type TechInsightsContext<\n  CheckType extends TechInsightCheck,\n  CheckResultType extends CheckResult,\n> = {\n  factChecker?: FactChecker<CheckType, CheckResultType>;\n  persistenceContext: PersistenceContext;\n  factRetrieverEngine: FactRetrieverEngine;\n};\n\n/**\n * @public\n *\n * Constructs needed persistence context, fact retriever engine\n * and optionally fact checker implementations to be used in the tech insights module.\n *\n * @param options - Needed options to construct TechInsightsContext\n * @returns TechInsightsContext with persistence implementations and optionally an implementation of a FactChecker\n */\nexport const buildTechInsightsContext = async <\n  CheckType extends TechInsightCheck,\n  CheckResultType extends CheckResult,\n>(\n  options: TechInsightsOptions<CheckType, CheckResultType>,\n): Promise<TechInsightsContext<CheckType, CheckResultType>> => {\n  const {\n    factRetrievers,\n    factCheckerFactory,\n    config,\n    discovery,\n    database,\n    logger,\n    scheduler,\n    auth,\n  } = options;\n\n  const buildFactRetrieverRegistry = (): FactRetrieverRegistry => {\n    if (!options.factRetrieverRegistry) {\n      if (!factRetrievers) {\n        throw new Error(\n          'Failed to build FactRetrieverRegistry because no factRetrievers found',\n        );\n      }\n      return new DefaultFactRetrieverRegistry(factRetrievers);\n    }\n    return options.factRetrieverRegistry;\n  };\n\n  const factRetrieverRegistry = buildFactRetrieverRegistry();\n\n  const persistenceContext =\n    options.persistenceContext ??\n    (await initializePersistenceContext(database, {\n      logger,\n    }));\n\n  const factRetrieverEngine = await DefaultFactRetrieverEngine.create({\n    scheduler,\n    repository: persistenceContext.techInsightsStore,\n    factRetrieverRegistry,\n    factRetrieverContext: {\n      config,\n      discovery,\n      logger,\n      auth,\n    },\n  });\n\n  await factRetrieverEngine.schedule();\n\n  if (factCheckerFactory) {\n    const factChecker = factCheckerFactory.construct(\n      persistenceContext.techInsightsStore,\n    );\n    return {\n      persistenceContext,\n      factChecker,\n      factRetrieverEngine,\n    };\n  }\n\n  return {\n    persistenceContext,\n    factRetrieverEngine,\n  };\n};\n"],"names":["DefaultFactRetrieverRegistry","persistenceContext","initializePersistenceContext","DefaultFactRetrieverEngine"],"mappings":";;;;;;AAgHa,MAAA,wBAAA,GAA2B,OAItC,OAC6D,KAAA;AAC7D,EAAM,MAAA;AAAA,IACJ,cAAA;AAAA,IACA,kBAAA;AAAA,IACA,MAAA;AAAA,IACA,SAAA;AAAA,IACA,QAAA;AAAA,IACA,MAAA;AAAA,IACA,SAAA;AAAA,IACA,IAAA;AAAA,GACE,GAAA,OAAA,CAAA;AAEJ,EAAA,MAAM,6BAA6B,MAA6B;AAC9D,IAAI,IAAA,CAAC,QAAQ,qBAAuB,EAAA;AAClC,MAAA,IAAI,CAAC,cAAgB,EAAA;AACnB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,uEAAA;AAAA,SACF,CAAA;AAAA,OACF;AACA,MAAO,OAAA,IAAIA,mDAA6B,cAAc,CAAA,CAAA;AAAA,KACxD;AACA,IAAA,OAAO,OAAQ,CAAA,qBAAA,CAAA;AAAA,GACjB,CAAA;AAEA,EAAA,MAAM,wBAAwB,0BAA2B,EAAA,CAAA;AAEzD,EAAA,MAAMC,oBACJ,GAAA,OAAA,CAAQ,kBACP,IAAA,MAAMC,gDAA6B,QAAU,EAAA;AAAA,IAC5C,MAAA;AAAA,GACD,CAAA,CAAA;AAEH,EAAM,MAAA,mBAAA,GAAsB,MAAMC,8CAAA,CAA2B,MAAO,CAAA;AAAA,IAClE,SAAA;AAAA,IACA,YAAYF,oBAAmB,CAAA,iBAAA;AAAA,IAC/B,qBAAA;AAAA,IACA,oBAAsB,EAAA;AAAA,MACpB,MAAA;AAAA,MACA,SAAA;AAAA,MACA,MAAA;AAAA,MACA,IAAA;AAAA,KACF;AAAA,GACD,CAAA,CAAA;AAED,EAAA,MAAM,oBAAoB,QAAS,EAAA,CAAA;AAEnC,EAAA,IAAI,kBAAoB,EAAA;AACtB,IAAA,MAAM,cAAc,kBAAmB,CAAA,SAAA;AAAA,MACrCA,oBAAmB,CAAA,iBAAA;AAAA,KACrB,CAAA;AACA,IAAO,OAAA;AAAA,0BACLA,oBAAA;AAAA,MACA,WAAA;AAAA,MACA,mBAAA;AAAA,KACF,CAAA;AAAA,GACF;AAEA,EAAO,OAAA;AAAA,wBACLA,oBAAA;AAAA,IACA,mBAAA;AAAA,GACF,CAAA;AACF;;;;"}
+{"version":3,"file":"techInsightsContextBuilder.cjs.js","sources":["../../src/service/techInsightsContextBuilder.ts"],"sourcesContent":["/*\n * Copyright 2021 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  DefaultFactRetrieverEngine,\n  FactRetrieverEngine,\n} from './fact/FactRetrieverEngine';\nimport { DefaultFactRetrieverRegistry } from './fact/FactRetrieverRegistry';\nimport { Config } from '@backstage/config';\nimport {\n  FactChecker,\n  FactCheckerFactory,\n  FactRetrieverRegistration,\n  FactRetrieverRegistry,\n  PersistenceContext,\n  TechInsightCheck,\n} from '@backstage-community/plugin-tech-insights-node';\nimport { initializePersistenceContext } from './persistence';\nimport { CheckResult } from '@backstage-community/plugin-tech-insights-common';\nimport {\n  AuthService,\n  DatabaseService,\n  DiscoveryService,\n  LoggerService,\n  SchedulerService,\n  UrlReaderService,\n} from '@backstage/backend-plugin-api';\n\n/**\n * @public\n * @typeParam CheckType - Type of the check for the fact checker this builder returns\n * @typeParam CheckResultType - Type of the check result for the fact checker this builder returns\n *\n * Configuration options to initialize TechInsightsBuilder. Generic types params are needed if FactCheckerFactory\n * is included for FactChecker creation.\n */\nexport interface TechInsightsOptions<\n  CheckType extends TechInsightCheck,\n  CheckResultType extends CheckResult,\n> {\n  /**\n   * Optional collection of FactRetrieverRegistrations (required if no factRetrieverRegistry passed in).\n   * Used to register FactRetrievers and their schemas and schedule an execution loop for them.\n   *\n   * Not needed if passing in your own FactRetrieverRegistry implementation. Required otherwise.\n   */\n  factRetrievers?: FactRetrieverRegistration[];\n\n  /**\n   * Optional factory exposing a `construct` method to initialize a FactChecker implementation\n   */\n  factCheckerFactory?: FactCheckerFactory<CheckType, CheckResultType>;\n\n  /**\n   * Optional FactRetrieverRegistry implementation that replaces the default one.\n   *\n   * If passing this in you don't need to pass in factRetrievers also.\n   */\n  factRetrieverRegistry?: FactRetrieverRegistry;\n\n  /**\n   * Optional persistenceContext implementation that replaces the default one.\n   * This can be used to replace underlying database with a more suitable implementation if needed\n   */\n  persistenceContext?: PersistenceContext;\n\n  logger: LoggerService;\n  config: Config;\n  discovery: DiscoveryService;\n  database: DatabaseService;\n  scheduler: SchedulerService;\n  auth: AuthService;\n  urlReader: UrlReaderService;\n}\n\n/**\n * @public\n * @typeParam CheckType - Type of the check for the fact checker this builder returns\n * @typeParam CheckResultType - Type of the check result for the fact checker this builder returns\n *\n * A container for exported implementations related to TechInsights.\n * FactChecker is present if an optional FactCheckerFactory is included in the build stage.\n */\nexport type TechInsightsContext<\n  CheckType extends TechInsightCheck,\n  CheckResultType extends CheckResult,\n> = {\n  factChecker?: FactChecker<CheckType, CheckResultType>;\n  persistenceContext: PersistenceContext;\n  factRetrieverEngine: FactRetrieverEngine;\n};\n\n/**\n * @public\n *\n * Constructs needed persistence context, fact retriever engine\n * and optionally fact checker implementations to be used in the tech insights module.\n *\n * @param options - Needed options to construct TechInsightsContext\n * @returns TechInsightsContext with persistence implementations and optionally an implementation of a FactChecker\n */\nexport const buildTechInsightsContext = async <\n  CheckType extends TechInsightCheck,\n  CheckResultType extends CheckResult,\n>(\n  options: TechInsightsOptions<CheckType, CheckResultType>,\n): Promise<TechInsightsContext<CheckType, CheckResultType>> => {\n  const {\n    factRetrievers,\n    factCheckerFactory,\n    config,\n    discovery,\n    database,\n    logger,\n    scheduler,\n    auth,\n    urlReader,\n  } = options;\n\n  const buildFactRetrieverRegistry = (): FactRetrieverRegistry => {\n    if (!options.factRetrieverRegistry) {\n      if (!factRetrievers) {\n        throw new Error(\n          'Failed to build FactRetrieverRegistry because no factRetrievers found',\n        );\n      }\n      return new DefaultFactRetrieverRegistry(factRetrievers);\n    }\n    return options.factRetrieverRegistry;\n  };\n\n  const factRetrieverRegistry = buildFactRetrieverRegistry();\n\n  const persistenceContext =\n    options.persistenceContext ??\n    (await initializePersistenceContext(database, {\n      logger,\n    }));\n\n  const factRetrieverEngine = await DefaultFactRetrieverEngine.create({\n    scheduler,\n    repository: persistenceContext.techInsightsStore,\n    factRetrieverRegistry,\n    factRetrieverContext: {\n      config,\n      discovery,\n      logger,\n      auth,\n      urlReader,\n    },\n  });\n\n  await factRetrieverEngine.schedule();\n\n  if (factCheckerFactory) {\n    const factChecker = factCheckerFactory.construct(\n      persistenceContext.techInsightsStore,\n    );\n    return {\n      persistenceContext,\n      factChecker,\n      factRetrieverEngine,\n    };\n  }\n\n  return {\n    persistenceContext,\n    factRetrieverEngine,\n  };\n};\n"],"names":["DefaultFactRetrieverRegistry","persistenceContext","initializePersistenceContext","DefaultFactRetrieverEngine"],"mappings":";;;;;;AAkHa,MAAA,wBAAA,GAA2B,OAItC,OAC6D,KAAA;AAC7D,EAAM,MAAA;AAAA,IACJ,cAAA;AAAA,IACA,kBAAA;AAAA,IACA,MAAA;AAAA,IACA,SAAA;AAAA,IACA,QAAA;AAAA,IACA,MAAA;AAAA,IACA,SAAA;AAAA,IACA,IAAA;AAAA,IACA,SAAA;AAAA,GACE,GAAA,OAAA,CAAA;AAEJ,EAAA,MAAM,6BAA6B,MAA6B;AAC9D,IAAI,IAAA,CAAC,QAAQ,qBAAuB,EAAA;AAClC,MAAA,IAAI,CAAC,cAAgB,EAAA;AACnB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,uEAAA;AAAA,SACF,CAAA;AAAA,OACF;AACA,MAAO,OAAA,IAAIA,mDAA6B,cAAc,CAAA,CAAA;AAAA,KACxD;AACA,IAAA,OAAO,OAAQ,CAAA,qBAAA,CAAA;AAAA,GACjB,CAAA;AAEA,EAAA,MAAM,wBAAwB,0BAA2B,EAAA,CAAA;AAEzD,EAAA,MAAMC,oBACJ,GAAA,OAAA,CAAQ,kBACP,IAAA,MAAMC,gDAA6B,QAAU,EAAA;AAAA,IAC5C,MAAA;AAAA,GACD,CAAA,CAAA;AAEH,EAAM,MAAA,mBAAA,GAAsB,MAAMC,8CAAA,CAA2B,MAAO,CAAA;AAAA,IAClE,SAAA;AAAA,IACA,YAAYF,oBAAmB,CAAA,iBAAA;AAAA,IAC/B,qBAAA;AAAA,IACA,oBAAsB,EAAA;AAAA,MACpB,MAAA;AAAA,MACA,SAAA;AAAA,MACA,MAAA;AAAA,MACA,IAAA;AAAA,MACA,SAAA;AAAA,KACF;AAAA,GACD,CAAA,CAAA;AAED,EAAA,MAAM,oBAAoB,QAAS,EAAA,CAAA;AAEnC,EAAA,IAAI,kBAAoB,EAAA;AACtB,IAAA,MAAM,cAAc,kBAAmB,CAAA,SAAA;AAAA,MACrCA,oBAAmB,CAAA,iBAAA;AAAA,KACrB,CAAA;AACA,IAAO,OAAA;AAAA,0BACLA,oBAAA;AAAA,MACA,WAAA;AAAA,MACA,mBAAA;AAAA,KACF,CAAA;AAAA,GACF;AAEA,EAAO,OAAA;AAAA,wBACLA,oBAAA;AAAA,IACA,mBAAA;AAAA,GACF,CAAA;AACF;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage-community/plugin-tech-insights-backend",
-  "version": "1.2.3",
+  "version": "2.0.0",
   "backstage": {
     "role": "backend-plugin",
     "pluginId": "tech-insights",
@@ -46,7 +46,7 @@
   },
   "dependencies": {
     "@backstage-community/plugin-tech-insights-common": "^0.2.21",
-    "@backstage-community/plugin-tech-insights-node": "^1.0.3",
+    "@backstage-community/plugin-tech-insights-node": "^2.0.0",
     "@backstage/backend-defaults": "^0.5.2",
     "@backstage/backend-plugin-api": "^1.0.1",
     "@backstage/backend-tasks": "^0.6.1",