@backstage/plugin-catalog-backend-module-puppetdb 0.2.3-next.1 → 0.2.4-next.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @backstage/plugin-catalog-backend-module-puppetdb
 
+## 0.2.4-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-node@1.14.0-next.0
+  - @backstage/backend-plugin-api@1.0.2-next.0
+  - @backstage/catalog-model@1.7.0
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+
+## 0.2.3
+
+### Patch Changes
+
+- 4b60e0c: Small tweaks to API reports to make them valid
+- Updated dependencies
+  - @backstage/plugin-catalog-node@1.13.1
+  - @backstage/backend-plugin-api@1.0.1
+  - @backstage/catalog-model@1.7.0
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+
 ## 0.2.3-next.1
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-puppetdb__alpha",
-  "version": "0.2.3-next.1",
+  "version": "0.2.4-next.0",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/index.d.ts

@@ -158,11 +158,10 @@ declare class PuppetDbEntityProvider implements EntityProvider {
      * Creates an instance of {@link PuppetDbEntityProvider}.
      *
      * @param config - Configuration of the provider.
-     * @param logger - The instance of a {@link LoggerService}.
-     * @param taskRunner - The instance of {@link SchedulerServiceTaskRunner}.
+     * @param logger - The instance of a {@link @backstage/backend-plugin-api#LoggerService}.
+     * @param taskRunner - The instance of {@link @backstage/backend-plugin-api#SchedulerServiceTaskRunner}.
      * @param transformer - A {@link ResourceTransformer} function.
      *
-     * @private
      */
     private constructor();
     /** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */
@@ -172,9 +171,7 @@ declare class PuppetDbEntityProvider implements EntityProvider {
     /**
      * Creates a function that can be used to schedule a refresh of the catalog.
      *
-     * @param taskRunner - The instance of {@link SchedulerServiceTaskRunner}.
-     *
-     * @private
+     * @param taskRunner - The instance of {@link @backstage/backend-plugin-api#SchedulerServiceTaskRunner}.
      */
     private createScheduleFn;
     /**

package/dist/providers/PuppetDbEntityProvider.cjs.js

@@ -66,11 +66,10 @@ class PuppetDbEntityProvider {
    * Creates an instance of {@link PuppetDbEntityProvider}.
    *
    * @param config - Configuration of the provider.
-   * @param logger - The instance of a {@link LoggerService}.
-   * @param taskRunner - The instance of {@link SchedulerServiceTaskRunner}.
+   * @param logger - The instance of a {@link @backstage/backend-plugin-api#LoggerService}.
+   * @param taskRunner - The instance of {@link @backstage/backend-plugin-api#SchedulerServiceTaskRunner}.
    * @param transformer - A {@link ResourceTransformer} function.
    *
-   * @private
    */
   constructor(config, logger, taskRunner, transformer) {
     this.config = config;
@@ -92,9 +91,7 @@ class PuppetDbEntityProvider {
   /**
    * Creates a function that can be used to schedule a refresh of the catalog.
    *
-   * @param taskRunner - The instance of {@link SchedulerServiceTaskRunner}.
-   *
-   * @private
+   * @param taskRunner - The instance of {@link @backstage/backend-plugin-api#SchedulerServiceTaskRunner}.
    */
   createScheduleFn(taskRunner) {
     return async () => {

package/dist/providers/PuppetDbEntityProvider.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"PuppetDbEntityProvider.cjs.js","sources":["../../src/providers/PuppetDbEntityProvider.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  EntityProvider,\n  EntityProviderConnection,\n} from '@backstage/plugin-catalog-node';\nimport {\n  PuppetDbEntityProviderConfig,\n  readProviderConfigs,\n} from './PuppetDbEntityProviderConfig';\nimport { Config } from '@backstage/config';\nimport * as uuid from 'uuid';\nimport { defaultResourceTransformer, ResourceTransformer } from '../puppet';\nimport {\n  ANNOTATION_LOCATION,\n  ANNOTATION_ORIGIN_LOCATION,\n  Entity,\n} from '@backstage/catalog-model';\nimport { merge } from 'lodash';\nimport { readPuppetNodes } from '../puppet/read';\nimport { ENDPOINT_NODES } from '../puppet/constants';\nimport {\n  SchedulerService,\n  SchedulerServiceTaskRunner,\n  LoggerService,\n} from '@backstage/backend-plugin-api';\n\n/**\n * Reads nodes from [PuppetDB](https://www.puppet.com/docs/puppet/6/puppetdb_overview.html)\n * based on the provided query and registers them as Resource entities in the catalog.\n *\n * @public\n */\nexport class PuppetDbEntityProvider implements EntityProvider {\n  private readonly config: PuppetDbEntityProviderConfig;\n  private readonly logger: LoggerService;\n  private readonly scheduleFn: () => Promise<void>;\n  private readonly transformer: ResourceTransformer;\n  private connection?: EntityProviderConnection;\n\n  /**\n   * Creates instances of {@link PuppetDbEntityProvider} from a configuration.\n   *\n   * @param config - The configuration to read provider information from.\n   * @param deps - The dependencies for  {@link PuppetDbEntityProvider}.\n   *\n   * @returns A list of {@link PuppetDbEntityProvider} instances.\n   */\n  static fromConfig(\n    config: Config,\n    deps: {\n      logger: LoggerService;\n      schedule?: SchedulerServiceTaskRunner;\n      scheduler?: SchedulerService;\n      transformer?: ResourceTransformer;\n    },\n  ): PuppetDbEntityProvider[] {\n    if (!deps.schedule && !deps.scheduler) {\n      throw new Error('Either schedule or scheduler must be provided.');\n    }\n\n    return readProviderConfigs(config).map(providerConfig => {\n      if (!deps.schedule && !providerConfig.schedule) {\n        throw new Error(\n          `No schedule provided neither via code nor config for puppet-provider:${providerConfig.id}.`,\n        );\n      }\n\n      const taskRunner =\n        deps.schedule ??\n        deps.scheduler!.createScheduledTaskRunner(providerConfig.schedule!);\n\n      const transformer = deps.transformer ?? defaultResourceTransformer;\n\n      return new PuppetDbEntityProvider(\n        providerConfig,\n        deps.logger,\n        taskRunner,\n        transformer,\n      );\n    });\n  }\n\n  /**\n   * Creates an instance of {@link PuppetDbEntityProvider}.\n   *\n   * @param config - Configuration of the provider.\n   * @param logger - The instance of a {@link LoggerService}.\n   * @param taskRunner - The instance of {@link SchedulerServiceTaskRunner}.\n   * @param transformer - A {@link ResourceTransformer} function.\n   *\n   * @private\n   */\n  private constructor(\n    config: PuppetDbEntityProviderConfig,\n    logger: LoggerService,\n    taskRunner: SchedulerServiceTaskRunner,\n    transformer: ResourceTransformer,\n  ) {\n    this.config = config;\n    this.logger = logger.child({\n      target: this.getProviderName(),\n    });\n    this.scheduleFn = this.createScheduleFn(taskRunner);\n    this.transformer = transformer;\n  }\n\n  /** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */\n  async connect(connection: EntityProviderConnection): Promise<void> {\n    this.connection = connection;\n    await this.scheduleFn();\n  }\n\n  /** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getProviderName} */\n  getProviderName(): string {\n    return `puppetdb-provider:${this.config.id}`;\n  }\n\n  /**\n   * Creates a function that can be used to schedule a refresh of the catalog.\n   *\n   * @param taskRunner - The instance of {@link SchedulerServiceTaskRunner}.\n   *\n   * @private\n   */\n  private createScheduleFn(\n    taskRunner: SchedulerServiceTaskRunner,\n  ): () => Promise<void> {\n    return async () => {\n      const taskId = `${this.getProviderName()}:refresh`;\n      return taskRunner.run({\n        id: taskId,\n        fn: async () => {\n          const logger = this.logger.child({\n            class: PuppetDbEntityProvider.prototype.constructor.name,\n            taskId,\n            taskInstanceId: uuid.v4(),\n          });\n          try {\n            await this.refresh(logger);\n          } catch (error) {\n            logger.error(\n              `${this.getProviderName()} refresh failed, ${error}`,\n              error,\n            );\n          }\n        },\n      });\n    };\n  }\n\n  /**\n   * Refreshes the catalog by reading nodes from PuppetDB and registering them as Resource Entities.\n   *\n   * @param logger - The instance of a Logger.\n   */\n  async refresh(logger: LoggerService) {\n    if (!this.connection) {\n      throw new Error('Not initialized');\n    }\n\n    const { markReadComplete } = trackProgress(logger);\n    const entities = await readPuppetNodes(this.config, {\n      logger,\n      transformer: this.transformer,\n    });\n    const { markCommitComplete } = markReadComplete(entities);\n\n    await this.connection.applyMutation({\n      type: 'full',\n      entities: [...entities].map(entity => ({\n        locationKey: this.getProviderName(),\n        entity: withLocations(this.config.baseUrl, entity),\n      })),\n    });\n    markCommitComplete(entities);\n  }\n}\n\n/**\n * Ensures the entities have required annotation data.\n *\n * @param baseUrl - The base URL of the PuppetDB instance.\n * @param entity - The entity to add the annotations to.\n *\n * @returns Entity with @{@link ANNOTATION_LOCATION} and @{@link ANNOTATION_ORIGIN_LOCATION} annotations.\n */\nfunction withLocations(baseUrl: string, entity: Entity): Entity {\n  const location = `${baseUrl}/${ENDPOINT_NODES}/${entity.metadata?.name}`;\n\n  return merge(\n    {\n      metadata: {\n        annotations: {\n          [ANNOTATION_LOCATION]: `url:${location}`,\n          [ANNOTATION_ORIGIN_LOCATION]: `url:${location}`,\n        },\n      },\n    },\n    entity,\n  ) as Entity;\n}\n\n/**\n * Tracks the progress of the PuppetDB read and commit operations.\n *\n * @param logger - The instance of a {@link LoggerService}.\n */\nfunction trackProgress(logger: LoggerService) {\n  let timestamp = Date.now();\n\n  function markReadComplete(entities: Entity[]) {\n    const readDuration = ((Date.now() - timestamp) / 1000).toFixed(1);\n    timestamp = Date.now();\n    logger.info(\n      `Read ${entities?.length ?? 0} in ${readDuration} seconds. Committing...`,\n    );\n    return { markCommitComplete };\n  }\n\n  function markCommitComplete(entities: Entity[]) {\n    const commitDuration = ((Date.now() - timestamp) / 1000).toFixed(1);\n    logger.info(\n      `Committed ${entities?.length ?? 0} in ${commitDuration} seconds.`,\n    );\n  }\n\n  return { markReadComplete };\n}\n"],"names":["readProviderConfigs","defaultResourceTransformer","uuid","readPuppetNodes","ENDPOINT_NODES","merge","ANNOTATION_LOCATION","ANNOTATION_ORIGIN_LOCATION"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+CO,MAAM,sBAAiD,CAAA;AAAA,EAC3C,MAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EACA,UAAA,CAAA;AAAA,EACA,WAAA,CAAA;AAAA,EACT,UAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUR,OAAO,UACL,CAAA,MAAA,EACA,IAM0B,EAAA;AAC1B,IAAA,IAAI,CAAC,IAAA,CAAK,QAAY,IAAA,CAAC,KAAK,SAAW,EAAA;AACrC,MAAM,MAAA,IAAI,MAAM,gDAAgD,CAAA,CAAA;AAAA,KAClE;AAEA,IAAA,OAAOA,gDAAoB,CAAA,MAAM,CAAE,CAAA,GAAA,CAAI,CAAkB,cAAA,KAAA;AACvD,MAAA,IAAI,CAAC,IAAA,CAAK,QAAY,IAAA,CAAC,eAAe,QAAU,EAAA;AAC9C,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,qEAAA,EAAwE,eAAe,EAAE,CAAA,CAAA,CAAA;AAAA,SAC3F,CAAA;AAAA,OACF;AAEA,MAAA,MAAM,aACJ,IAAK,CAAA,QAAA,IACL,KAAK,SAAW,CAAA,yBAAA,CAA0B,eAAe,QAAS,CAAA,CAAA;AAEpE,MAAM,MAAA,WAAA,GAAc,KAAK,WAAe,IAAAC,uCAAA,CAAA;AAExC,MAAA,OAAO,IAAI,sBAAA;AAAA,QACT,cAAA;AAAA,QACA,IAAK,CAAA,MAAA;AAAA,QACL,UAAA;AAAA,QACA,WAAA;AAAA,OACF,CAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYQ,WACN,CAAA,MAAA,EACA,MACA,EAAA,UAAA,EACA,WACA,EAAA;AACA,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAK,IAAA,CAAA,MAAA,GAAS,OAAO,KAAM,CAAA;AAAA,MACzB,MAAA,EAAQ,KAAK,eAAgB,EAAA;AAAA,KAC9B,CAAA,CAAA;AACD,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA,CAAA;AAClD,IAAA,IAAA,CAAK,WAAc,GAAA,WAAA,CAAA;AAAA,GACrB;AAAA;AAAA,EAGA,MAAM,QAAQ,UAAqD,EAAA;AACjE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAClB,IAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AAAA,GACxB;AAAA;AAAA,EAGA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,kBAAA,EAAqB,IAAK,CAAA,MAAA,CAAO,EAAE,CAAA,CAAA,CAAA;AAAA,GAC5C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASQ,iBACN,UACqB,EAAA;AACrB,IAAA,OAAO,YAAY;AACjB,MAAA,MAAM,MAAS,GAAA,CAAA,EAAG,IAAK,CAAA,eAAA,EAAiB,CAAA,QAAA,CAAA,CAAA;AACxC,MAAA,OAAO,WAAW,GAAI,CAAA;AAAA,QACpB,EAAI,EAAA,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAM,MAAA,MAAA,GAAS,IAAK,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,YAC/B,KAAA,EAAO,sBAAuB,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YACpD,MAAA;AAAA,YACA,cAAA,EAAgBC,gBAAK,EAAG,EAAA;AAAA,WACzB,CAAA,CAAA;AACD,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA,CAAA;AAAA,mBAClB,KAAO,EAAA;AACd,YAAO,MAAA,CAAA,KAAA;AAAA,cACL,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAC,oBAAoB,KAAK,CAAA,CAAA;AAAA,cAClD,KAAA;AAAA,aACF,CAAA;AAAA,WACF;AAAA,SACF;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,QAAQ,MAAuB,EAAA;AACnC,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAM,MAAA,IAAI,MAAM,iBAAiB,CAAA,CAAA;AAAA,KACnC;AAEA,IAAA,MAAM,EAAE,gBAAA,EAAqB,GAAA,aAAA,CAAc,MAAM,CAAA,CAAA;AACjD,IAAA,MAAM,QAAW,GAAA,MAAMC,oBAAgB,CAAA,IAAA,CAAK,MAAQ,EAAA;AAAA,MAClD,MAAA;AAAA,MACA,aAAa,IAAK,CAAA,WAAA;AAAA,KACnB,CAAA,CAAA;AACD,IAAA,MAAM,EAAE,kBAAA,EAAuB,GAAA,gBAAA,CAAiB,QAAQ,CAAA,CAAA;AAExD,IAAM,MAAA,IAAA,CAAK,WAAW,aAAc,CAAA;AAAA,MAClC,IAAM,EAAA,MAAA;AAAA,MACN,UAAU,CAAC,GAAG,QAAQ,CAAA,CAAE,IAAI,CAAW,MAAA,MAAA;AAAA,QACrC,WAAA,EAAa,KAAK,eAAgB,EAAA;AAAA,QAClC,MAAQ,EAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,SAAS,MAAM,CAAA;AAAA,OACjD,CAAA,CAAA;AAAA,KACH,CAAA,CAAA;AACD,IAAA,kBAAA,CAAmB,QAAQ,CAAA,CAAA;AAAA,GAC7B;AACF,CAAA;AAUA,SAAS,aAAA,CAAc,SAAiB,MAAwB,EAAA;AAC9D,EAAM,MAAA,QAAA,GAAW,GAAG,OAAO,CAAA,CAAA,EAAIC,wBAAc,CAAI,CAAA,EAAA,MAAA,CAAO,UAAU,IAAI,CAAA,CAAA,CAAA;AAEtE,EAAO,OAAAC,YAAA;AAAA,IACL;AAAA,MACE,QAAU,EAAA;AAAA,QACR,WAAa,EAAA;AAAA,UACX,CAACC,gCAAmB,GAAG,CAAA,IAAA,EAAO,QAAQ,CAAA,CAAA;AAAA,UACtC,CAACC,uCAA0B,GAAG,CAAA,IAAA,EAAO,QAAQ,CAAA,CAAA;AAAA,SAC/C;AAAA,OACF;AAAA,KACF;AAAA,IACA,MAAA;AAAA,GACF,CAAA;AACF,CAAA;AAOA,SAAS,cAAc,MAAuB,EAAA;AAC5C,EAAI,IAAA,SAAA,GAAY,KAAK,GAAI,EAAA,CAAA;AAEzB,EAAA,SAAS,iBAAiB,QAAoB,EAAA;AAC5C,IAAA,MAAM,iBAAiB,IAAK,CAAA,GAAA,KAAQ,SAAa,IAAA,GAAA,EAAM,QAAQ,CAAC,CAAA,CAAA;AAChE,IAAA,SAAA,GAAY,KAAK,GAAI,EAAA,CAAA;AACrB,IAAO,MAAA,CAAA,IAAA;AAAA,MACL,CAAQ,KAAA,EAAA,QAAA,EAAU,MAAU,IAAA,CAAC,OAAO,YAAY,CAAA,uBAAA,CAAA;AAAA,KAClD,CAAA;AACA,IAAA,OAAO,EAAE,kBAAmB,EAAA,CAAA;AAAA,GAC9B;AAEA,EAAA,SAAS,mBAAmB,QAAoB,EAAA;AAC9C,IAAA,MAAM,mBAAmB,IAAK,CAAA,GAAA,KAAQ,SAAa,IAAA,GAAA,EAAM,QAAQ,CAAC,CAAA,CAAA;AAClE,IAAO,MAAA,CAAA,IAAA;AAAA,MACL,CAAa,UAAA,EAAA,QAAA,EAAU,MAAU,IAAA,CAAC,OAAO,cAAc,CAAA,SAAA,CAAA;AAAA,KACzD,CAAA;AAAA,GACF;AAEA,EAAA,OAAO,EAAE,gBAAiB,EAAA,CAAA;AAC5B;;;;"}
+{"version":3,"file":"PuppetDbEntityProvider.cjs.js","sources":["../../src/providers/PuppetDbEntityProvider.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  EntityProvider,\n  EntityProviderConnection,\n} from '@backstage/plugin-catalog-node';\nimport {\n  PuppetDbEntityProviderConfig,\n  readProviderConfigs,\n} from './PuppetDbEntityProviderConfig';\nimport { Config } from '@backstage/config';\nimport * as uuid from 'uuid';\nimport { defaultResourceTransformer, ResourceTransformer } from '../puppet';\nimport {\n  ANNOTATION_LOCATION,\n  ANNOTATION_ORIGIN_LOCATION,\n  Entity,\n} from '@backstage/catalog-model';\nimport { merge } from 'lodash';\nimport { readPuppetNodes } from '../puppet/read';\nimport { ENDPOINT_NODES } from '../puppet/constants';\nimport {\n  SchedulerService,\n  SchedulerServiceTaskRunner,\n  LoggerService,\n} from '@backstage/backend-plugin-api';\n\n/**\n * Reads nodes from [PuppetDB](https://www.puppet.com/docs/puppet/6/puppetdb_overview.html)\n * based on the provided query and registers them as Resource entities in the catalog.\n *\n * @public\n */\nexport class PuppetDbEntityProvider implements EntityProvider {\n  private readonly config: PuppetDbEntityProviderConfig;\n  private readonly logger: LoggerService;\n  private readonly scheduleFn: () => Promise<void>;\n  private readonly transformer: ResourceTransformer;\n  private connection?: EntityProviderConnection;\n\n  /**\n   * Creates instances of {@link PuppetDbEntityProvider} from a configuration.\n   *\n   * @param config - The configuration to read provider information from.\n   * @param deps - The dependencies for  {@link PuppetDbEntityProvider}.\n   *\n   * @returns A list of {@link PuppetDbEntityProvider} instances.\n   */\n  static fromConfig(\n    config: Config,\n    deps: {\n      logger: LoggerService;\n      schedule?: SchedulerServiceTaskRunner;\n      scheduler?: SchedulerService;\n      transformer?: ResourceTransformer;\n    },\n  ): PuppetDbEntityProvider[] {\n    if (!deps.schedule && !deps.scheduler) {\n      throw new Error('Either schedule or scheduler must be provided.');\n    }\n\n    return readProviderConfigs(config).map(providerConfig => {\n      if (!deps.schedule && !providerConfig.schedule) {\n        throw new Error(\n          `No schedule provided neither via code nor config for puppet-provider:${providerConfig.id}.`,\n        );\n      }\n\n      const taskRunner =\n        deps.schedule ??\n        deps.scheduler!.createScheduledTaskRunner(providerConfig.schedule!);\n\n      const transformer = deps.transformer ?? defaultResourceTransformer;\n\n      return new PuppetDbEntityProvider(\n        providerConfig,\n        deps.logger,\n        taskRunner,\n        transformer,\n      );\n    });\n  }\n\n  /**\n   * Creates an instance of {@link PuppetDbEntityProvider}.\n   *\n   * @param config - Configuration of the provider.\n   * @param logger - The instance of a {@link @backstage/backend-plugin-api#LoggerService}.\n   * @param taskRunner - The instance of {@link @backstage/backend-plugin-api#SchedulerServiceTaskRunner}.\n   * @param transformer - A {@link ResourceTransformer} function.\n   *\n   */\n  private constructor(\n    config: PuppetDbEntityProviderConfig,\n    logger: LoggerService,\n    taskRunner: SchedulerServiceTaskRunner,\n    transformer: ResourceTransformer,\n  ) {\n    this.config = config;\n    this.logger = logger.child({\n      target: this.getProviderName(),\n    });\n    this.scheduleFn = this.createScheduleFn(taskRunner);\n    this.transformer = transformer;\n  }\n\n  /** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */\n  async connect(connection: EntityProviderConnection): Promise<void> {\n    this.connection = connection;\n    await this.scheduleFn();\n  }\n\n  /** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getProviderName} */\n  getProviderName(): string {\n    return `puppetdb-provider:${this.config.id}`;\n  }\n\n  /**\n   * Creates a function that can be used to schedule a refresh of the catalog.\n   *\n   * @param taskRunner - The instance of {@link @backstage/backend-plugin-api#SchedulerServiceTaskRunner}.\n   */\n  private createScheduleFn(\n    taskRunner: SchedulerServiceTaskRunner,\n  ): () => Promise<void> {\n    return async () => {\n      const taskId = `${this.getProviderName()}:refresh`;\n      return taskRunner.run({\n        id: taskId,\n        fn: async () => {\n          const logger = this.logger.child({\n            class: PuppetDbEntityProvider.prototype.constructor.name,\n            taskId,\n            taskInstanceId: uuid.v4(),\n          });\n          try {\n            await this.refresh(logger);\n          } catch (error) {\n            logger.error(\n              `${this.getProviderName()} refresh failed, ${error}`,\n              error,\n            );\n          }\n        },\n      });\n    };\n  }\n\n  /**\n   * Refreshes the catalog by reading nodes from PuppetDB and registering them as Resource Entities.\n   *\n   * @param logger - The instance of a Logger.\n   */\n  async refresh(logger: LoggerService) {\n    if (!this.connection) {\n      throw new Error('Not initialized');\n    }\n\n    const { markReadComplete } = trackProgress(logger);\n    const entities = await readPuppetNodes(this.config, {\n      logger,\n      transformer: this.transformer,\n    });\n    const { markCommitComplete } = markReadComplete(entities);\n\n    await this.connection.applyMutation({\n      type: 'full',\n      entities: [...entities].map(entity => ({\n        locationKey: this.getProviderName(),\n        entity: withLocations(this.config.baseUrl, entity),\n      })),\n    });\n    markCommitComplete(entities);\n  }\n}\n\n/**\n * Ensures the entities have required annotation data.\n *\n * @param baseUrl - The base URL of the PuppetDB instance.\n * @param entity - The entity to add the annotations to.\n *\n * @returns Entity with @{@link ANNOTATION_LOCATION} and @{@link ANNOTATION_ORIGIN_LOCATION} annotations.\n */\nfunction withLocations(baseUrl: string, entity: Entity): Entity {\n  const location = `${baseUrl}/${ENDPOINT_NODES}/${entity.metadata?.name}`;\n\n  return merge(\n    {\n      metadata: {\n        annotations: {\n          [ANNOTATION_LOCATION]: `url:${location}`,\n          [ANNOTATION_ORIGIN_LOCATION]: `url:${location}`,\n        },\n      },\n    },\n    entity,\n  ) as Entity;\n}\n\n/**\n * Tracks the progress of the PuppetDB read and commit operations.\n *\n * @param logger - The instance of a {@link @backstage/backend-plugin-api#LoggerService}.\n */\nfunction trackProgress(logger: LoggerService) {\n  let timestamp = Date.now();\n\n  function markReadComplete(entities: Entity[]) {\n    const readDuration = ((Date.now() - timestamp) / 1000).toFixed(1);\n    timestamp = Date.now();\n    logger.info(\n      `Read ${entities?.length ?? 0} in ${readDuration} seconds. Committing...`,\n    );\n    return { markCommitComplete };\n  }\n\n  function markCommitComplete(entities: Entity[]) {\n    const commitDuration = ((Date.now() - timestamp) / 1000).toFixed(1);\n    logger.info(\n      `Committed ${entities?.length ?? 0} in ${commitDuration} seconds.`,\n    );\n  }\n\n  return { markReadComplete };\n}\n"],"names":["readProviderConfigs","defaultResourceTransformer","uuid","readPuppetNodes","ENDPOINT_NODES","merge","ANNOTATION_LOCATION","ANNOTATION_ORIGIN_LOCATION"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+CO,MAAM,sBAAiD,CAAA;AAAA,EAC3C,MAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EACA,UAAA,CAAA;AAAA,EACA,WAAA,CAAA;AAAA,EACT,UAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUR,OAAO,UACL,CAAA,MAAA,EACA,IAM0B,EAAA;AAC1B,IAAA,IAAI,CAAC,IAAA,CAAK,QAAY,IAAA,CAAC,KAAK,SAAW,EAAA;AACrC,MAAM,MAAA,IAAI,MAAM,gDAAgD,CAAA,CAAA;AAAA,KAClE;AAEA,IAAA,OAAOA,gDAAoB,CAAA,MAAM,CAAE,CAAA,GAAA,CAAI,CAAkB,cAAA,KAAA;AACvD,MAAA,IAAI,CAAC,IAAA,CAAK,QAAY,IAAA,CAAC,eAAe,QAAU,EAAA;AAC9C,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,qEAAA,EAAwE,eAAe,EAAE,CAAA,CAAA,CAAA;AAAA,SAC3F,CAAA;AAAA,OACF;AAEA,MAAA,MAAM,aACJ,IAAK,CAAA,QAAA,IACL,KAAK,SAAW,CAAA,yBAAA,CAA0B,eAAe,QAAS,CAAA,CAAA;AAEpE,MAAM,MAAA,WAAA,GAAc,KAAK,WAAe,IAAAC,uCAAA,CAAA;AAExC,MAAA,OAAO,IAAI,sBAAA;AAAA,QACT,cAAA;AAAA,QACA,IAAK,CAAA,MAAA;AAAA,QACL,UAAA;AAAA,QACA,WAAA;AAAA,OACF,CAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWQ,WACN,CAAA,MAAA,EACA,MACA,EAAA,UAAA,EACA,WACA,EAAA;AACA,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAK,IAAA,CAAA,MAAA,GAAS,OAAO,KAAM,CAAA;AAAA,MACzB,MAAA,EAAQ,KAAK,eAAgB,EAAA;AAAA,KAC9B,CAAA,CAAA;AACD,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA,CAAA;AAClD,IAAA,IAAA,CAAK,WAAc,GAAA,WAAA,CAAA;AAAA,GACrB;AAAA;AAAA,EAGA,MAAM,QAAQ,UAAqD,EAAA;AACjE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAClB,IAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AAAA,GACxB;AAAA;AAAA,EAGA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,kBAAA,EAAqB,IAAK,CAAA,MAAA,CAAO,EAAE,CAAA,CAAA,CAAA;AAAA,GAC5C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,iBACN,UACqB,EAAA;AACrB,IAAA,OAAO,YAAY;AACjB,MAAA,MAAM,MAAS,GAAA,CAAA,EAAG,IAAK,CAAA,eAAA,EAAiB,CAAA,QAAA,CAAA,CAAA;AACxC,MAAA,OAAO,WAAW,GAAI,CAAA;AAAA,QACpB,EAAI,EAAA,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAM,MAAA,MAAA,GAAS,IAAK,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,YAC/B,KAAA,EAAO,sBAAuB,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YACpD,MAAA;AAAA,YACA,cAAA,EAAgBC,gBAAK,EAAG,EAAA;AAAA,WACzB,CAAA,CAAA;AACD,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA,CAAA;AAAA,mBAClB,KAAO,EAAA;AACd,YAAO,MAAA,CAAA,KAAA;AAAA,cACL,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAC,oBAAoB,KAAK,CAAA,CAAA;AAAA,cAClD,KAAA;AAAA,aACF,CAAA;AAAA,WACF;AAAA,SACF;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,QAAQ,MAAuB,EAAA;AACnC,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAM,MAAA,IAAI,MAAM,iBAAiB,CAAA,CAAA;AAAA,KACnC;AAEA,IAAA,MAAM,EAAE,gBAAA,EAAqB,GAAA,aAAA,CAAc,MAAM,CAAA,CAAA;AACjD,IAAA,MAAM,QAAW,GAAA,MAAMC,oBAAgB,CAAA,IAAA,CAAK,MAAQ,EAAA;AAAA,MAClD,MAAA;AAAA,MACA,aAAa,IAAK,CAAA,WAAA;AAAA,KACnB,CAAA,CAAA;AACD,IAAA,MAAM,EAAE,kBAAA,EAAuB,GAAA,gBAAA,CAAiB,QAAQ,CAAA,CAAA;AAExD,IAAM,MAAA,IAAA,CAAK,WAAW,aAAc,CAAA;AAAA,MAClC,IAAM,EAAA,MAAA;AAAA,MACN,UAAU,CAAC,GAAG,QAAQ,CAAA,CAAE,IAAI,CAAW,MAAA,MAAA;AAAA,QACrC,WAAA,EAAa,KAAK,eAAgB,EAAA;AAAA,QAClC,MAAQ,EAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,SAAS,MAAM,CAAA;AAAA,OACjD,CAAA,CAAA;AAAA,KACH,CAAA,CAAA;AACD,IAAA,kBAAA,CAAmB,QAAQ,CAAA,CAAA;AAAA,GAC7B;AACF,CAAA;AAUA,SAAS,aAAA,CAAc,SAAiB,MAAwB,EAAA;AAC9D,EAAM,MAAA,QAAA,GAAW,GAAG,OAAO,CAAA,CAAA,EAAIC,wBAAc,CAAI,CAAA,EAAA,MAAA,CAAO,UAAU,IAAI,CAAA,CAAA,CAAA;AAEtE,EAAO,OAAAC,YAAA;AAAA,IACL;AAAA,MACE,QAAU,EAAA;AAAA,QACR,WAAa,EAAA;AAAA,UACX,CAACC,gCAAmB,GAAG,CAAA,IAAA,EAAO,QAAQ,CAAA,CAAA;AAAA,UACtC,CAACC,uCAA0B,GAAG,CAAA,IAAA,EAAO,QAAQ,CAAA,CAAA;AAAA,SAC/C;AAAA,OACF;AAAA,KACF;AAAA,IACA,MAAA;AAAA,GACF,CAAA;AACF,CAAA;AAOA,SAAS,cAAc,MAAuB,EAAA;AAC5C,EAAI,IAAA,SAAA,GAAY,KAAK,GAAI,EAAA,CAAA;AAEzB,EAAA,SAAS,iBAAiB,QAAoB,EAAA;AAC5C,IAAA,MAAM,iBAAiB,IAAK,CAAA,GAAA,KAAQ,SAAa,IAAA,GAAA,EAAM,QAAQ,CAAC,CAAA,CAAA;AAChE,IAAA,SAAA,GAAY,KAAK,GAAI,EAAA,CAAA;AACrB,IAAO,MAAA,CAAA,IAAA;AAAA,MACL,CAAQ,KAAA,EAAA,QAAA,EAAU,MAAU,IAAA,CAAC,OAAO,YAAY,CAAA,uBAAA,CAAA;AAAA,KAClD,CAAA;AACA,IAAA,OAAO,EAAE,kBAAmB,EAAA,CAAA;AAAA,GAC9B;AAEA,EAAA,SAAS,mBAAmB,QAAoB,EAAA;AAC9C,IAAA,MAAM,mBAAmB,IAAK,CAAA,GAAA,KAAQ,SAAa,IAAA,GAAA,EAAM,QAAQ,CAAC,CAAA,CAAA;AAClE,IAAO,MAAA,CAAA,IAAA;AAAA,MACL,CAAa,UAAA,EAAA,QAAA,EAAU,MAAU,IAAA,CAAC,OAAO,cAAc,CAAA,SAAA,CAAA;AAAA,KACzD,CAAA;AAAA,GACF;AAEA,EAAA,OAAO,EAAE,gBAAiB,EAAA,CAAA;AAC5B;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-puppetdb",
-  "version": "0.2.3-next.1",
+  "version": "0.2.4-next.0",
   "description": "A Backstage catalog backend module that helps integrate towards PuppetDB",
   "backstage": {
     "role": "backend-plugin-module",
@@ -53,11 +53,11 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "1.0.1-next.1",
+    "@backstage/backend-plugin-api": "1.0.2-next.0",
     "@backstage/catalog-model": "1.7.0",
     "@backstage/config": "1.2.0",
     "@backstage/errors": "1.2.4",
-    "@backstage/plugin-catalog-node": "1.13.1-next.1",
+    "@backstage/plugin-catalog-node": "1.14.0-next.0",
     "@backstage/types": "1.1.1",
     "lodash": "^4.17.21",
     "luxon": "^3.0.0",
@@ -65,8 +65,8 @@
     "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.0.1-next.2",
-    "@backstage/cli": "0.28.0-next.2",
+    "@backstage/backend-test-utils": "1.0.3-next.0",
+    "@backstage/cli": "0.29.0-next.0",
     "@types/lodash": "^4.14.151",
     "msw": "^1.0.0"
   },