@backstage/plugin-catalog-backend-module-gitlab 0.1.8 → 0.1.9-next.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @backstage/plugin-catalog-backend-module-gitlab
 
+## 0.1.9-next.0
+
+### Patch Changes
+
+- 6bb046bcbe: Add `gitlabDiscoveryEntityProviderCatalogModule` (new backend-plugin-api, alpha).
+- 81cedb5033: `GitlabDiscoveryEntityProvider`: Add option to configure schedule via `app-config.yaml` instead of in code.
+
+  Please find how to configure the schedule at the config at
+  https://backstage.io/docs/integrations/gitlab/discovery
+
+- Updated dependencies
+  - @backstage/backend-common@0.16.0-next.0
+  - @backstage/plugin-catalog-backend@1.5.1-next.0
+  - @backstage/integration@1.4.0-next.0
+  - @backstage/backend-tasks@0.3.7-next.0
+  - @backstage/catalog-model@1.1.3-next.0
+  - @backstage/types@1.0.1-next.0
+  - @backstage/backend-plugin-api@0.1.4-next.0
+  - @backstage/plugin-catalog-node@1.2.1-next.0
+  - @backstage/config@1.0.4-next.0
+  - @backstage/errors@1.1.3-next.0
+
 ## 0.1.8
 
 ### Patch Changes

package/alpha/package.json

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

package/config.d.ts

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2020 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { TaskScheduleDefinitionConfig } from '@backstage/backend-tasks';
+
+export interface Config {
+  catalog?: {
+    providers?: {
+      /**
+       * GitlabDiscoveryEntityProvider configuration
+       */
+      gitlab?: Record<
+        string,
+        {
+          /**
+           * (Required) Gitlab's host name.
+           */
+          host: string;
+          /**
+           * (Optional) Gitlab's group[/subgroup] where the discovery is done.
+           * If not defined the whole project will be scanned.
+           */
+          group?: string;
+          /**
+           * (Optional) Default branch to read the catalog-info.yaml file.
+           * If not set, 'master' will be used.
+           */
+          branch?: string;
+          /**
+           * (Optional) The name used for the catalog file.
+           * If not set, 'catalog-info.yaml' will be used.
+           */
+          entityFilename?: string;
+          /**
+           * (Optional) TaskScheduleDefinition for the refresh.
+           */
+          schedule?: TaskScheduleDefinitionConfig;
+        }
+      >;
+    };
+  };
+}

package/dist/index.alpha.d.ts

@@ -0,0 +1,67 @@
+/**
+ * A Backstage catalog backend module that helps integrate towards GitLab
+ *
+ * @packageDocumentation
+ */
+
+import { BackendFeature } from '@backstage/backend-plugin-api';
+import { CatalogProcessor } from '@backstage/plugin-catalog-backend';
+import { CatalogProcessorEmit } from '@backstage/plugin-catalog-backend';
+import { Config } from '@backstage/config';
+import { EntityProvider } from '@backstage/plugin-catalog-backend';
+import { EntityProviderConnection } from '@backstage/plugin-catalog-backend';
+import { LocationSpec } from '@backstage/plugin-catalog-backend';
+import { Logger } from 'winston';
+import { PluginTaskScheduler } from '@backstage/backend-tasks';
+import { TaskRunner } from '@backstage/backend-tasks';
+
+/**
+ * Discovers entity definition files in the groups of a Gitlab instance.
+ * @public
+ */
+export declare class GitlabDiscoveryEntityProvider implements EntityProvider {
+    private readonly config;
+    private readonly integration;
+    private readonly logger;
+    private readonly scheduleFn;
+    private connection?;
+    static fromConfig(config: Config, options: {
+        logger: Logger;
+        schedule?: TaskRunner;
+        scheduler?: PluginTaskScheduler;
+    }): GitlabDiscoveryEntityProvider[];
+    private constructor();
+    getProviderName(): string;
+    connect(connection: EntityProviderConnection): Promise<void>;
+    private createScheduleFn;
+    refresh(logger: Logger): Promise<void>;
+    private createLocationSpec;
+}
+
+/**
+ * Registers the GitlabDiscoveryEntityProvider with the catalog processing extension point.
+ *
+ * @alpha
+ */
+export declare const gitlabDiscoveryEntityProviderCatalogModule: (options?: undefined) => BackendFeature;
+
+/**
+ * Extracts repositories out of an GitLab instance.
+ * @public
+ */
+export declare class GitLabDiscoveryProcessor implements CatalogProcessor {
+    private readonly integrations;
+    private readonly logger;
+    private readonly cache;
+    private readonly skipReposWithoutExactFileMatch;
+    static fromConfig(config: Config, options: {
+        logger: Logger;
+        skipReposWithoutExactFileMatch?: boolean;
+    }): GitLabDiscoveryProcessor;
+    private constructor();
+    getProcessorName(): string;
+    readLocation(location: LocationSpec, _optional: boolean, emit: CatalogProcessorEmit): Promise<boolean>;
+    private getCacheKey;
+}
+
+export { }

package/dist/index.beta.d.ts

@@ -0,0 +1,62 @@
+/**
+ * A Backstage catalog backend module that helps integrate towards GitLab
+ *
+ * @packageDocumentation
+ */
+
+import { BackendFeature } from '@backstage/backend-plugin-api';
+import { CatalogProcessor } from '@backstage/plugin-catalog-backend';
+import { CatalogProcessorEmit } from '@backstage/plugin-catalog-backend';
+import { Config } from '@backstage/config';
+import { EntityProvider } from '@backstage/plugin-catalog-backend';
+import { EntityProviderConnection } from '@backstage/plugin-catalog-backend';
+import { LocationSpec } from '@backstage/plugin-catalog-backend';
+import { Logger } from 'winston';
+import { PluginTaskScheduler } from '@backstage/backend-tasks';
+import { TaskRunner } from '@backstage/backend-tasks';
+
+/**
+ * Discovers entity definition files in the groups of a Gitlab instance.
+ * @public
+ */
+export declare class GitlabDiscoveryEntityProvider implements EntityProvider {
+    private readonly config;
+    private readonly integration;
+    private readonly logger;
+    private readonly scheduleFn;
+    private connection?;
+    static fromConfig(config: Config, options: {
+        logger: Logger;
+        schedule?: TaskRunner;
+        scheduler?: PluginTaskScheduler;
+    }): GitlabDiscoveryEntityProvider[];
+    private constructor();
+    getProviderName(): string;
+    connect(connection: EntityProviderConnection): Promise<void>;
+    private createScheduleFn;
+    refresh(logger: Logger): Promise<void>;
+    private createLocationSpec;
+}
+
+/* Excluded from this release type: gitlabDiscoveryEntityProviderCatalogModule */
+
+/**
+ * Extracts repositories out of an GitLab instance.
+ * @public
+ */
+export declare class GitLabDiscoveryProcessor implements CatalogProcessor {
+    private readonly integrations;
+    private readonly logger;
+    private readonly cache;
+    private readonly skipReposWithoutExactFileMatch;
+    static fromConfig(config: Config, options: {
+        logger: Logger;
+        skipReposWithoutExactFileMatch?: boolean;
+    }): GitLabDiscoveryProcessor;
+    private constructor();
+    getProcessorName(): string;
+    readLocation(location: LocationSpec, _optional: boolean, emit: CatalogProcessorEmit): Promise<boolean>;
+    private getCacheKey;
+}
+
+export { }

package/dist/index.cjs.js

@@ -6,7 +6,10 @@ var backendCommon = require('@backstage/backend-common');
 var integration = require('@backstage/integration');
 var pluginCatalogBackend = require('@backstage/plugin-catalog-backend');
 var fetch = require('node-fetch');
+var backendTasks = require('@backstage/backend-tasks');
 var uuid = require('uuid');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var pluginCatalogNode = require('@backstage/plugin-catalog-node');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -117,13 +120,15 @@ function readGitlabConfig(id, config) {
   const projectPattern = new RegExp(
     (_d = config.getOptionalString("projectPattern")) != null ? _d : /[\s\S]*/
   );
+  const schedule = config.has("schedule") ? backendTasks.readTaskScheduleDefinitionFromConfig(config.getConfig("schedule")) : void 0;
   return {
     id,
     group,
     branch,
     host,
     catalogFile,
-    projectPattern
+    projectPattern,
+    schedule
   };
 }
 function readGitlabConfigs(config) {
@@ -245,21 +250,32 @@ function parseUrl(urlString) {
 
 class GitlabDiscoveryEntityProvider {
   static fromConfig(config, options) {
+    if (!options.schedule && !options.scheduler) {
+      throw new Error("Either schedule or scheduler must be provided.");
+    }
     const providerConfigs = readGitlabConfigs(config);
     const integrations = integration.ScmIntegrations.fromConfig(config).gitlab;
     const providers = [];
     providerConfigs.forEach((providerConfig) => {
+      var _a;
       const integration = integrations.byHost(providerConfig.host);
       if (!integration) {
         throw new Error(
           `No gitlab integration found that matches host ${providerConfig.host}`
         );
       }
+      if (!options.schedule && !providerConfig.schedule) {
+        throw new Error(
+          `No schedule provided neither via code nor config for GitlabDiscoveryEntityProvider:${providerConfig.id}.`
+        );
+      }
+      const taskRunner = (_a = options.schedule) != null ? _a : options.scheduler.createScheduledTaskRunner(providerConfig.schedule);
       providers.push(
         new GitlabDiscoveryEntityProvider({
           ...options,
           config: providerConfig,
-          integration
+          integration,
+          taskRunner
         })
       );
     });
@@ -271,7 +287,7 @@ class GitlabDiscoveryEntityProvider {
     this.logger = options.logger.child({
       target: this.getProviderName()
     });
-    this.scheduleFn = this.createScheduleFn(options.schedule);
+    this.scheduleFn = this.createScheduleFn(options.taskRunner);
   }
   getProviderName() {
     return `GitlabDiscoveryEntityProvider:${this.config.id}`;
@@ -280,10 +296,10 @@ class GitlabDiscoveryEntityProvider {
     this.connection = connection;
     await this.scheduleFn();
   }
-  createScheduleFn(schedule) {
+  createScheduleFn(taskRunner) {
     return async () => {
       const taskId = `${this.getProviderName()}:refresh`;
-      return schedule.run({
+      return taskRunner.run({
         id: taskId,
         fn: async () => {
           const logger = this.logger.child({
@@ -364,6 +380,30 @@ class GitlabDiscoveryEntityProvider {
   }
 }
 
+const gitlabDiscoveryEntityProviderCatalogModule = backendPluginApi.createBackendModule({
+  pluginId: "catalog",
+  moduleId: "gitlabDiscoveryEntityProvider",
+  register(env) {
+    env.registerInit({
+      deps: {
+        config: backendPluginApi.configServiceRef,
+        catalog: pluginCatalogNode.catalogProcessingExtensionPoint,
+        logger: backendPluginApi.loggerServiceRef,
+        scheduler: backendPluginApi.schedulerServiceRef
+      },
+      async init({ config, catalog, logger, scheduler }) {
+        catalog.addEntityProvider(
+          GitlabDiscoveryEntityProvider.fromConfig(config, {
+            logger: backendPluginApi.loggerToWinstonLogger(logger),
+            scheduler
+          })
+        );
+      }
+    });
+  }
+});
+
 exports.GitLabDiscoveryProcessor = GitLabDiscoveryProcessor;
 exports.GitlabDiscoveryEntityProvider = GitlabDiscoveryEntityProvider;
+exports.gitlabDiscoveryEntityProviderCatalogModule = gitlabDiscoveryEntityProviderCatalogModule;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/lib/client.ts","../src/providers/config.ts","../src/GitLabDiscoveryProcessor.ts","../src/providers/GitlabDiscoveryEntityProvider.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 fetch from 'node-fetch';\nimport {\n  getGitLabRequestOptions,\n  GitLabIntegrationConfig,\n} from '@backstage/integration';\nimport { Logger } from 'winston';\n\nexport type ListOptions = {\n  [key: string]: string | number | boolean | undefined;\n  group?: string;\n  per_page?: number | undefined;\n  page?: number | undefined;\n};\n\nexport type PagedResponse<T> = {\n  items: T[];\n  nextPage?: number;\n};\n\nexport class GitLabClient {\n  private readonly config: GitLabIntegrationConfig;\n  private readonly logger: Logger;\n\n  constructor(options: { config: GitLabIntegrationConfig; logger: Logger }) {\n    this.config = options.config;\n    this.logger = options.logger;\n  }\n\n  /**\n   * Indicates whether the client is for a SaaS or self managed GitLab instance.\n   */\n  isSelfManaged(): boolean {\n    return this.config.host !== 'gitlab.com';\n  }\n\n  async listProjects(options?: ListOptions): Promise<PagedResponse<any>> {\n    if (options?.group) {\n      return this.pagedRequest(\n        `/groups/${encodeURIComponent(options?.group)}/projects`,\n        {\n          ...options,\n          include_subgroups: true,\n        },\n      );\n    }\n\n    return this.pagedRequest(`/projects`, options);\n  }\n\n  /**\n   * General existence check.\n   *\n   * @param projectPath - The path to the project\n   * @param branch - The branch used to search\n   * @param filePath - The path to the file\n   */\n  async hasFile(\n    projectPath: string,\n    branch: string,\n    filePath: string,\n  ): Promise<boolean> {\n    const endpoint: string = `/projects/${encodeURIComponent(\n      projectPath,\n    )}/repository/files/${encodeURIComponent(filePath)}`;\n    const request = new URL(`${this.config.apiBaseUrl}${endpoint}`);\n    request.searchParams.append('ref', branch);\n\n    const response = await fetch(request.toString(), {\n      headers: getGitLabRequestOptions(this.config).headers,\n      method: 'HEAD',\n    });\n\n    if (!response.ok) {\n      if (response.status >= 500) {\n        this.logger.debug(\n          `Unexpected response when fetching ${request.toString()}. Expected 200 but got ${\n            response.status\n          } - ${response.statusText}`,\n        );\n      }\n      return false;\n    }\n\n    return true;\n  }\n\n  /**\n   * Performs a request against a given paginated GitLab endpoint.\n   *\n   * This method may be used to perform authenticated REST calls against any\n   * paginated GitLab endpoint which uses X-NEXT-PAGE headers. The return value\n   * can be be used with the {@link paginated} async-generator function to yield\n   * each item from the paged request.\n   *\n   * @see {@link paginated}\n   * @param endpoint - The request endpoint, e.g. /projects.\n   * @param options - Request queryString options which may also include page variables.\n   */\n  async pagedRequest<T = any>(\n    endpoint: string,\n    options?: ListOptions,\n  ): Promise<PagedResponse<T>> {\n    const request = new URL(`${this.config.apiBaseUrl}${endpoint}`);\n    for (const key in options) {\n      if (options[key]) {\n        request.searchParams.append(key, options[key]!.toString());\n      }\n    }\n\n    this.logger.debug(`Fetching: ${request.toString()}`);\n    const response = await fetch(\n      request.toString(),\n      getGitLabRequestOptions(this.config),\n    );\n    if (!response.ok) {\n      throw new Error(\n        `Unexpected response when fetching ${request.toString()}. Expected 200 but got ${\n          response.status\n        } - ${response.statusText}`,\n      );\n    }\n    return response.json().then(items => {\n      const nextPage = response.headers.get('x-next-page');\n\n      return {\n        items,\n        nextPage: nextPage ? Number(nextPage) : null,\n      } as PagedResponse<any>;\n    });\n  }\n}\n\n/**\n * Advances through each page and provides each item from a paginated request.\n *\n * The async generator function yields each item from repeated calls to the\n * provided request function. The generator walks through each available page by\n * setting the page key in the options passed into the request function and\n * making repeated calls until there are no more pages.\n *\n * @see {@link pagedRequest}\n * @param request - Function which returns a PagedResponse to walk through.\n * @param options - Initial ListOptions for the request function.\n */\nexport async function* paginated<T = any>(\n  request: (options: ListOptions) => Promise<PagedResponse<T>>,\n  options: ListOptions,\n) {\n  let res;\n  do {\n    res = await request(options);\n    options.page = res.nextPage;\n    for (const item of res.items) {\n      yield item;\n    }\n  } while (res.nextPage);\n}\n","/*\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 { Config } from '@backstage/config';\nimport { GitlabProviderConfig } from '../lib';\n\n/**\n * Extracts the gitlab config from a config object\n *\n * @public\n *\n * @param id - The provider key\n * @param config - The config object to extract from\n */\nfunction readGitlabConfig(id: string, config: Config): GitlabProviderConfig {\n  const group = config.getOptionalString('group') ?? '';\n  const host = config.getString('host');\n  const branch = config.getOptionalString('branch') ?? 'master';\n  const catalogFile =\n    config.getOptionalString('entityFilename') ?? 'catalog-info.yaml';\n  const projectPattern = new RegExp(\n    config.getOptionalString('projectPattern') ?? /[\\s\\S]*/,\n  );\n\n  return {\n    id,\n    group,\n    branch,\n    host,\n    catalogFile,\n    projectPattern,\n  };\n}\n\n/**\n * Extracts the gitlab config from a config object array\n *\n * @public\n *\n * @param config - The config object to extract from\n */\nexport function readGitlabConfigs(config: Config): GitlabProviderConfig[] {\n  const configs: GitlabProviderConfig[] = [];\n\n  const providerConfigs = config.getOptionalConfig('catalog.providers.gitlab');\n\n  if (!providerConfigs) {\n    return configs;\n  }\n\n  for (const id of providerConfigs.keys()) {\n    configs.push(readGitlabConfig(id, providerConfigs.getConfig(id)));\n  }\n\n  return configs;\n}\n","/*\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  CacheClient,\n  CacheManager,\n  PluginCacheManager,\n} from '@backstage/backend-common';\nimport { Config } from '@backstage/config';\nimport {\n  ScmIntegrationRegistry,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport {\n  CatalogProcessor,\n  CatalogProcessorEmit,\n  LocationSpec,\n  processingResult,\n} from '@backstage/plugin-catalog-backend';\nimport { Logger } from 'winston';\nimport { GitLabClient, GitLabProject, paginated } from './lib';\n\n/**\n * Extracts repositories out of an GitLab instance.\n * @public\n */\nexport class GitLabDiscoveryProcessor implements CatalogProcessor {\n  private readonly integrations: ScmIntegrationRegistry;\n  private readonly logger: Logger;\n  private readonly cache: CacheClient;\n  private readonly skipReposWithoutExactFileMatch: boolean;\n\n  static fromConfig(\n    config: Config,\n    options: { logger: Logger; skipReposWithoutExactFileMatch?: boolean },\n  ): GitLabDiscoveryProcessor {\n    const integrations = ScmIntegrations.fromConfig(config);\n    const pluginCache =\n      CacheManager.fromConfig(config).forPlugin('gitlab-discovery');\n\n    return new GitLabDiscoveryProcessor({\n      ...options,\n      integrations,\n      pluginCache,\n    });\n  }\n\n  private constructor(options: {\n    integrations: ScmIntegrationRegistry;\n    pluginCache: PluginCacheManager;\n    logger: Logger;\n    skipReposWithoutExactFileMatch?: boolean;\n  }) {\n    this.integrations = options.integrations;\n    this.cache = options.pluginCache.getClient();\n    this.logger = options.logger;\n    this.skipReposWithoutExactFileMatch =\n      options.skipReposWithoutExactFileMatch || false;\n  }\n\n  getProcessorName(): string {\n    return 'GitLabDiscoveryProcessor';\n  }\n\n  async readLocation(\n    location: LocationSpec,\n    _optional: boolean,\n    emit: CatalogProcessorEmit,\n  ): Promise<boolean> {\n    if (location.type !== 'gitlab-discovery') {\n      return false;\n    }\n\n    const startTime = new Date();\n    const { group, host, branch, catalogPath } = parseUrl(location.target);\n\n    const integration = this.integrations.gitlab.byUrl(`https://${host}`);\n    if (!integration) {\n      throw new Error(\n        `There is no GitLab integration that matches ${host}. Please add a configuration entry for it under integrations.gitlab`,\n      );\n    }\n\n    const client = new GitLabClient({\n      config: integration.config,\n      logger: this.logger,\n    });\n    this.logger.debug(`Reading GitLab projects from ${location.target}`);\n\n    const lastActivity = (await this.cache.get(this.getCacheKey())) as string;\n    const opts = {\n      group,\n      page: 1,\n      // We check for the existence of lastActivity and only set it if it's present to ensure\n      // that the options doesn't include the key so that the API doesn't receive an empty query parameter.\n      ...(lastActivity && { last_activity_after: lastActivity }),\n    };\n\n    const projects = paginated(options => client.listProjects(options), opts);\n\n    const res: Result = {\n      scanned: 0,\n      matches: [],\n    };\n    for await (const project of projects) {\n      res.scanned++;\n\n      if (project.archived) {\n        continue;\n      }\n\n      if (branch === '*' && project.default_branch === undefined) {\n        continue;\n      }\n\n      if (this.skipReposWithoutExactFileMatch) {\n        const project_branch = branch === '*' ? project.default_branch : branch;\n\n        const projectHasFile: boolean = await client.hasFile(\n          project.path_with_namespace,\n          project_branch,\n          catalogPath,\n        );\n\n        if (!projectHasFile) {\n          continue;\n        }\n      }\n\n      res.matches.push(project);\n    }\n\n    for (const project of res.matches) {\n      const project_branch = branch === '*' ? project.default_branch : branch;\n\n      emit(\n        processingResult.location({\n          type: 'url',\n          // The format expected by the GitLabUrlReader:\n          // https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath\n          //\n          // This unfortunately will trigger another API call in `getGitLabFileFetchUrl` to get the project ID.\n          // The alternative is using the `buildRawUrl` function, which does not support subgroups, so providing a raw\n          // URL here won't work either.\n          target: `${project.web_url}/-/blob/${project_branch}/${catalogPath}`,\n          presence: 'optional',\n        }),\n      );\n    }\n\n    // Save an ISO formatted string in the cache as that's what GitLab expects in the API request.\n    await this.cache.set(this.getCacheKey(), startTime.toISOString());\n\n    const duration = ((Date.now() - startTime.getTime()) / 1000).toFixed(1);\n    this.logger.debug(\n      `Read ${res.scanned} GitLab repositories in ${duration} seconds`,\n    );\n\n    return true;\n  }\n\n  private getCacheKey(): string {\n    return `processors/${this.getProcessorName()}/last-activity`;\n  }\n}\n\ntype Result = {\n  scanned: number;\n  matches: GitLabProject[];\n};\n\n/*\n * Helpers\n */\n\nexport function parseUrl(urlString: string): {\n  group?: string;\n  host: string;\n  branch: string;\n  catalogPath: string;\n} {\n  const url = new URL(urlString);\n  const path = url.pathname.substr(1).split('/');\n\n  // (/group/subgroup)/blob/branch|*/filepath\n  const blobIndex = path.findIndex(p => p === 'blob');\n  if (blobIndex !== -1 && path.length > blobIndex + 2) {\n    const group =\n      blobIndex > 0 ? path.slice(0, blobIndex).join('/') : undefined;\n\n    return {\n      group,\n      host: url.host,\n      branch: decodeURIComponent(path[blobIndex + 1]),\n      catalogPath: decodeURIComponent(path.slice(blobIndex + 2).join('/')),\n    };\n  }\n\n  throw new Error(`Failed to parse ${urlString}`);\n}\n","/*\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 { TaskRunner } from '@backstage/backend-tasks';\nimport { Config } from '@backstage/config';\nimport { GitLabIntegration, ScmIntegrations } from '@backstage/integration';\nimport {\n  EntityProvider,\n  EntityProviderConnection,\n} from '@backstage/plugin-catalog-backend';\nimport { LocationSpec } from '@backstage/plugin-catalog-backend';\nimport { Logger } from 'winston';\nimport {\n  GitLabClient,\n  GitLabProject,\n  GitlabProviderConfig,\n  paginated,\n  readGitlabConfigs,\n} from '../lib';\nimport * as uuid from 'uuid';\nimport { locationSpecToLocationEntity } from '@backstage/plugin-catalog-backend';\n\ntype Result = {\n  scanned: number;\n  matches: GitLabProject[];\n};\n\n/**\n * Discovers entity definition files in the groups of a Gitlab instance.\n * @public\n */\nexport class GitlabDiscoveryEntityProvider implements EntityProvider {\n  private readonly config: GitlabProviderConfig;\n  private readonly integration: GitLabIntegration;\n  private readonly logger: Logger;\n  private readonly scheduleFn: () => Promise<void>;\n  private connection?: EntityProviderConnection;\n\n  static fromConfig(\n    config: Config,\n    options: { logger: Logger; schedule: TaskRunner },\n  ): GitlabDiscoveryEntityProvider[] {\n    const providerConfigs = readGitlabConfigs(config);\n    const integrations = ScmIntegrations.fromConfig(config).gitlab;\n    const providers: GitlabDiscoveryEntityProvider[] = [];\n\n    providerConfigs.forEach(providerConfig => {\n      const integration = integrations.byHost(providerConfig.host);\n      if (!integration) {\n        throw new Error(\n          `No gitlab integration found that matches host ${providerConfig.host}`,\n        );\n      }\n      providers.push(\n        new GitlabDiscoveryEntityProvider({\n          ...options,\n          config: providerConfig,\n          integration,\n        }),\n      );\n    });\n    return providers;\n  }\n\n  private constructor(options: {\n    config: GitlabProviderConfig;\n    integration: GitLabIntegration;\n    logger: Logger;\n    schedule: TaskRunner;\n  }) {\n    this.config = options.config;\n    this.integration = options.integration;\n    this.logger = options.logger.child({\n      target: this.getProviderName(),\n    });\n    this.scheduleFn = this.createScheduleFn(options.schedule);\n  }\n\n  getProviderName(): string {\n    return `GitlabDiscoveryEntityProvider:${this.config.id}`;\n  }\n\n  async connect(connection: EntityProviderConnection): Promise<void> {\n    this.connection = connection;\n    await this.scheduleFn();\n  }\n\n  private createScheduleFn(schedule: TaskRunner): () => Promise<void> {\n    return async () => {\n      const taskId = `${this.getProviderName()}:refresh`;\n      return schedule.run({\n        id: taskId,\n        fn: async () => {\n          const logger = this.logger.child({\n            class: GitlabDiscoveryEntityProvider.prototype.constructor.name,\n            taskId,\n            taskInstanceId: uuid.v4(),\n          });\n\n          try {\n            await this.refresh(logger);\n          } catch (error) {\n            logger.error(error);\n          }\n        },\n      });\n    };\n  }\n\n  async refresh(logger: Logger): Promise<void> {\n    if (!this.connection) {\n      throw new Error(\n        `Gitlab discovery connection not initialized for ${this.getProviderName()}`,\n      );\n    }\n\n    const client = new GitLabClient({\n      config: this.integration.config,\n      logger: logger,\n    });\n\n    const projects = paginated<GitLabProject>(\n      options => client.listProjects(options),\n      {\n        group: this.config.group,\n        page: 1,\n        per_page: 50,\n      },\n    );\n\n    const res: Result = {\n      scanned: 0,\n      matches: [],\n    };\n\n    for await (const project of projects) {\n      if (!this.config.projectPattern.test(project.path_with_namespace ?? '')) {\n        continue;\n      }\n\n      res.scanned++;\n\n      if (project.archived) {\n        continue;\n      }\n\n      if (this.config.branch === '*' && project.default_branch === undefined) {\n        continue;\n      }\n\n      const project_branch = project.default_branch ?? this.config.branch;\n\n      const projectHasFile: boolean = await client.hasFile(\n        project.path_with_namespace ?? '',\n        project_branch,\n        this.config.catalogFile,\n      );\n      if (projectHasFile) {\n        res.matches.push(project);\n      }\n    }\n\n    const locations = res.matches.map(p => this.createLocationSpec(p));\n    await this.connection.applyMutation({\n      type: 'full',\n      entities: locations.map(location => ({\n        locationKey: this.getProviderName(),\n        entity: locationSpecToLocationEntity({ location }),\n      })),\n    });\n  }\n\n  private createLocationSpec(project: GitLabProject): LocationSpec {\n    const project_branch = project.default_branch ?? this.config.branch;\n    return {\n      type: 'url',\n      target: `${project.web_url}/-/blob/${project_branch}/${this.config.catalogFile}`,\n      presence: 'optional',\n    };\n  }\n}\n"],"names":["fetch","getGitLabRequestOptions","ScmIntegrations","CacheManager","processingResult","uuid","locationSpecToLocationEntity"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmCO,MAAM,YAAa,CAAA;AAAA,EAIxB,YAAY,OAA8D,EAAA;AACxE,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AACtB,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AAAA,GACxB;AAAA,EAKA,aAAyB,GAAA;AACvB,IAAO,OAAA,IAAA,CAAK,OAAO,IAAS,KAAA,YAAA,CAAA;AAAA,GAC9B;AAAA,EAEA,MAAM,aAAa,OAAoD,EAAA;AACrE,IAAA,IAAI,mCAAS,KAAO,EAAA;AAClB,MAAA,OAAO,IAAK,CAAA,YAAA;AAAA,QACV,CAAA,QAAA,EAAW,kBAAmB,CAAA,OAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,OAAA,CAAS,KAAK,CAAA,CAAA,SAAA,CAAA;AAAA,QAC5C;AAAA,UACE,GAAG,OAAA;AAAA,UACH,iBAAmB,EAAA,IAAA;AAAA,SACrB;AAAA,OACF,CAAA;AAAA,KACF;AAEA,IAAO,OAAA,IAAA,CAAK,YAAa,CAAA,CAAA,SAAA,CAAA,EAAa,OAAO,CAAA,CAAA;AAAA,GAC/C;AAAA,EASA,MAAM,OAAA,CACJ,WACA,EAAA,MAAA,EACA,QACkB,EAAA;AAClB,IAAA,MAAM,WAAmB,CAAa,UAAA,EAAA,kBAAA;AAAA,MACpC,WAAA;AAAA,KACF,CAAA,kBAAA,EAAsB,mBAAmB,QAAQ,CAAA,CAAA,CAAA,CAAA;AACjD,IAAA,MAAM,UAAU,IAAI,GAAA,CAAI,GAAG,IAAK,CAAA,MAAA,CAAO,aAAa,QAAU,CAAA,CAAA,CAAA,CAAA;AAC9D,IAAQ,OAAA,CAAA,YAAA,CAAa,MAAO,CAAA,KAAA,EAAO,MAAM,CAAA,CAAA;AAEzC,IAAA,MAAM,QAAW,GAAA,MAAMA,yBAAM,CAAA,OAAA,CAAQ,UAAY,EAAA;AAAA,MAC/C,OAAS,EAAAC,mCAAA,CAAwB,IAAK,CAAA,MAAM,CAAE,CAAA,OAAA;AAAA,MAC9C,MAAQ,EAAA,MAAA;AAAA,KACT,CAAA,CAAA;AAED,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAI,IAAA,QAAA,CAAS,UAAU,GAAK,EAAA;AAC1B,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,qCAAqC,OAAQ,CAAA,QAAA,EAC3C,CAAA,uBAAA,EAAA,QAAA,CAAS,YACL,QAAS,CAAA,UAAA,CAAA,CAAA;AAAA,SACjB,CAAA;AAAA,OACF;AACA,MAAO,OAAA,KAAA,CAAA;AAAA,KACT;AAEA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAcA,MAAM,YACJ,CAAA,QAAA,EACA,OAC2B,EAAA;AAC3B,IAAA,MAAM,UAAU,IAAI,GAAA,CAAI,GAAG,IAAK,CAAA,MAAA,CAAO,aAAa,QAAU,CAAA,CAAA,CAAA,CAAA;AAC9D,IAAA,KAAA,MAAW,OAAO,OAAS,EAAA;AACzB,MAAA,IAAI,QAAQ,GAAM,CAAA,EAAA;AAChB,QAAA,OAAA,CAAQ,aAAa,MAAO,CAAA,GAAA,EAAK,OAAQ,CAAA,GAAA,CAAA,CAAM,UAAU,CAAA,CAAA;AAAA,OAC3D;AAAA,KACF;AAEA,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAa,UAAA,EAAA,OAAA,CAAQ,UAAY,CAAA,CAAA,CAAA,CAAA;AACnD,IAAA,MAAM,WAAW,MAAMD,yBAAA;AAAA,MACrB,QAAQ,QAAS,EAAA;AAAA,MACjBC,mCAAA,CAAwB,KAAK,MAAM,CAAA;AAAA,KACrC,CAAA;AACA,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,qCAAqC,OAAQ,CAAA,QAAA,EAC3C,CAAA,uBAAA,EAAA,QAAA,CAAS,YACL,QAAS,CAAA,UAAA,CAAA,CAAA;AAAA,OACjB,CAAA;AAAA,KACF;AACA,IAAA,OAAO,QAAS,CAAA,IAAA,EAAO,CAAA,IAAA,CAAK,CAAS,KAAA,KAAA;AACnC,MAAA,MAAM,QAAW,GAAA,QAAA,CAAS,OAAQ,CAAA,GAAA,CAAI,aAAa,CAAA,CAAA;AAEnD,MAAO,OAAA;AAAA,QACL,KAAA;AAAA,QACA,QAAU,EAAA,QAAA,GAAW,MAAO,CAAA,QAAQ,CAAI,GAAA,IAAA;AAAA,OAC1C,CAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAA;AAcuB,gBAAA,SAAA,CACrB,SACA,OACA,EAAA;AACA,EAAI,IAAA,GAAA,CAAA;AACJ,EAAG,GAAA;AACD,IAAM,GAAA,GAAA,MAAM,QAAQ,OAAO,CAAA,CAAA;AAC3B,IAAA,OAAA,CAAQ,OAAO,GAAI,CAAA,QAAA,CAAA;AACnB,IAAW,KAAA,MAAA,IAAA,IAAQ,IAAI,KAAO,EAAA;AAC5B,MAAM,MAAA,IAAA,CAAA;AAAA,KACR;AAAA,WACO,GAAI,CAAA,QAAA,EAAA;AACf;;ACjJA,SAAS,gBAAA,CAAiB,IAAY,MAAsC,EAAA;AA3B5E,EAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AA4BE,EAAA,MAAM,KAAQ,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAkB,CAAA,OAAO,MAAhC,IAAqC,GAAA,EAAA,GAAA,EAAA,CAAA;AACnD,EAAM,MAAA,IAAA,GAAO,MAAO,CAAA,SAAA,CAAU,MAAM,CAAA,CAAA;AACpC,EAAA,MAAM,MAAS,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAkB,CAAA,QAAQ,MAAjC,IAAsC,GAAA,EAAA,GAAA,QAAA,CAAA;AACrD,EAAA,MAAM,WACJ,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAkB,CAAA,gBAAgB,MAAzC,IAA8C,GAAA,EAAA,GAAA,mBAAA,CAAA;AAChD,EAAA,MAAM,iBAAiB,IAAI,MAAA;AAAA,IAAA,CACzB,EAAO,GAAA,MAAA,CAAA,iBAAA,CAAkB,gBAAgB,CAAA,KAAzC,IAA8C,GAAA,EAAA,GAAA,SAAA;AAAA,GAChD,CAAA;AAEA,EAAO,OAAA;AAAA,IACL,EAAA;AAAA,IACA,KAAA;AAAA,IACA,MAAA;AAAA,IACA,IAAA;AAAA,IACA,WAAA;AAAA,IACA,cAAA;AAAA,GACF,CAAA;AACF,CAAA;AASO,SAAS,kBAAkB,MAAwC,EAAA;AACxE,EAAA,MAAM,UAAkC,EAAC,CAAA;AAEzC,EAAM,MAAA,eAAA,GAAkB,MAAO,CAAA,iBAAA,CAAkB,0BAA0B,CAAA,CAAA;AAE3E,EAAA,IAAI,CAAC,eAAiB,EAAA;AACpB,IAAO,OAAA,OAAA,CAAA;AAAA,GACT;AAEA,EAAW,KAAA,MAAA,EAAA,IAAM,eAAgB,CAAA,IAAA,EAAQ,EAAA;AACvC,IAAA,OAAA,CAAQ,KAAK,gBAAiB,CAAA,EAAA,EAAI,gBAAgB,SAAU,CAAA,EAAE,CAAC,CAAC,CAAA,CAAA;AAAA,GAClE;AAEA,EAAO,OAAA,OAAA,CAAA;AACT;;AC7BO,MAAM,wBAAqD,CAAA;AAAA,EAMhE,OAAO,UACL,CAAA,MAAA,EACA,OAC0B,EAAA;AAC1B,IAAM,MAAA,YAAA,GAAeC,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AACtD,IAAA,MAAM,cACJC,0BAAa,CAAA,UAAA,CAAW,MAAM,CAAA,CAAE,UAAU,kBAAkB,CAAA,CAAA;AAE9D,IAAA,OAAO,IAAI,wBAAyB,CAAA;AAAA,MAClC,GAAG,OAAA;AAAA,MACH,YAAA;AAAA,MACA,WAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,YAAY,OAKjB,EAAA;AACD,IAAA,IAAA,CAAK,eAAe,OAAQ,CAAA,YAAA,CAAA;AAC5B,IAAK,IAAA,CAAA,KAAA,GAAQ,OAAQ,CAAA,WAAA,CAAY,SAAU,EAAA,CAAA;AAC3C,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AACtB,IAAK,IAAA,CAAA,8BAAA,GACH,QAAQ,8BAAkC,IAAA,KAAA,CAAA;AAAA,GAC9C;AAAA,EAEA,gBAA2B,GAAA;AACzB,IAAO,OAAA,0BAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAM,YAAA,CACJ,QACA,EAAA,SAAA,EACA,IACkB,EAAA;AAClB,IAAI,IAAA,QAAA,CAAS,SAAS,kBAAoB,EAAA;AACxC,MAAO,OAAA,KAAA,CAAA;AAAA,KACT;AAEA,IAAM,MAAA,SAAA,GAAY,IAAI,IAAK,EAAA,CAAA;AAC3B,IAAM,MAAA,EAAE,OAAO,IAAM,EAAA,MAAA,EAAQ,aAAgB,GAAA,QAAA,CAAS,SAAS,MAAM,CAAA,CAAA;AAErE,IAAA,MAAM,cAAc,IAAK,CAAA,YAAA,CAAa,MAAO,CAAA,KAAA,CAAM,WAAW,IAAM,CAAA,CAAA,CAAA,CAAA;AACpE,IAAA,IAAI,CAAC,WAAa,EAAA;AAChB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAA+C,4CAAA,EAAA,IAAA,CAAA,mEAAA,CAAA;AAAA,OACjD,CAAA;AAAA,KACF;AAEA,IAAM,MAAA,MAAA,GAAS,IAAI,YAAa,CAAA;AAAA,MAC9B,QAAQ,WAAY,CAAA,MAAA;AAAA,MACpB,QAAQ,IAAK,CAAA,MAAA;AAAA,KACd,CAAA,CAAA;AACD,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAgC,6BAAA,EAAA,QAAA,CAAS,MAAQ,CAAA,CAAA,CAAA,CAAA;AAEnE,IAAA,MAAM,eAAgB,MAAM,IAAA,CAAK,MAAM,GAAI,CAAA,IAAA,CAAK,aAAa,CAAA,CAAA;AAC7D,IAAA,MAAM,IAAO,GAAA;AAAA,MACX,KAAA;AAAA,MACA,IAAM,EAAA,CAAA;AAAA,MAGN,GAAI,YAAA,IAAgB,EAAE,mBAAA,EAAqB,YAAa,EAAA;AAAA,KAC1D,CAAA;AAEA,IAAA,MAAM,WAAW,SAAU,CAAA,CAAA,OAAA,KAAW,OAAO,YAAa,CAAA,OAAO,GAAG,IAAI,CAAA,CAAA;AAExE,IAAA,MAAM,GAAc,GAAA;AAAA,MAClB,OAAS,EAAA,CAAA;AAAA,MACT,SAAS,EAAC;AAAA,KACZ,CAAA;AACA,IAAA,WAAA,MAAiB,WAAW,QAAU,EAAA;AACpC,MAAI,GAAA,CAAA,OAAA,EAAA,CAAA;AAEJ,MAAA,IAAI,QAAQ,QAAU,EAAA;AACpB,QAAA,SAAA;AAAA,OACF;AAEA,MAAA,IAAI,MAAW,KAAA,GAAA,IAAO,OAAQ,CAAA,cAAA,KAAmB,KAAW,CAAA,EAAA;AAC1D,QAAA,SAAA;AAAA,OACF;AAEA,MAAA,IAAI,KAAK,8BAAgC,EAAA;AACvC,QAAA,MAAM,cAAiB,GAAA,MAAA,KAAW,GAAM,GAAA,OAAA,CAAQ,cAAiB,GAAA,MAAA,CAAA;AAEjE,QAAM,MAAA,cAAA,GAA0B,MAAM,MAAO,CAAA,OAAA;AAAA,UAC3C,OAAQ,CAAA,mBAAA;AAAA,UACR,cAAA;AAAA,UACA,WAAA;AAAA,SACF,CAAA;AAEA,QAAA,IAAI,CAAC,cAAgB,EAAA;AACnB,UAAA,SAAA;AAAA,SACF;AAAA,OACF;AAEA,MAAI,GAAA,CAAA,OAAA,CAAQ,KAAK,OAAO,CAAA,CAAA;AAAA,KAC1B;AAEA,IAAW,KAAA,MAAA,OAAA,IAAW,IAAI,OAAS,EAAA;AACjC,MAAA,MAAM,cAAiB,GAAA,MAAA,KAAW,GAAM,GAAA,OAAA,CAAQ,cAAiB,GAAA,MAAA,CAAA;AAEjE,MAAA,IAAA;AAAA,QACEC,sCAAiB,QAAS,CAAA;AAAA,UACxB,IAAM,EAAA,KAAA;AAAA,UAON,MAAQ,EAAA,CAAA,EAAG,OAAQ,CAAA,OAAA,CAAA,QAAA,EAAkB,cAAkB,CAAA,CAAA,EAAA,WAAA,CAAA,CAAA;AAAA,UACvD,QAAU,EAAA,UAAA;AAAA,SACX,CAAA;AAAA,OACH,CAAA;AAAA,KACF;AAGA,IAAM,MAAA,IAAA,CAAK,MAAM,GAAI,CAAA,IAAA,CAAK,aAAe,EAAA,SAAA,CAAU,aAAa,CAAA,CAAA;AAEhE,IAAM,MAAA,QAAA,GAAA,CAAA,CAAa,KAAK,GAAI,EAAA,GAAI,UAAU,OAAQ,EAAA,IAAK,GAAM,EAAA,OAAA,CAAQ,CAAC,CAAA,CAAA;AACtE,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACV,CAAA,KAAA,EAAQ,IAAI,OAAkC,CAAA,wBAAA,EAAA,QAAA,CAAA,QAAA,CAAA;AAAA,KAChD,CAAA;AAEA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAEQ,WAAsB,GAAA;AAC5B,IAAO,OAAA,CAAA,WAAA,EAAc,KAAK,gBAAiB,EAAA,CAAA,cAAA,CAAA,CAAA;AAAA,GAC7C;AACF,CAAA;AAWO,SAAS,SAAS,SAKvB,EAAA;AACA,EAAM,MAAA,GAAA,GAAM,IAAI,GAAA,CAAI,SAAS,CAAA,CAAA;AAC7B,EAAA,MAAM,OAAO,GAAI,CAAA,QAAA,CAAS,OAAO,CAAC,CAAA,CAAE,MAAM,GAAG,CAAA,CAAA;AAG7C,EAAA,MAAM,SAAY,GAAA,IAAA,CAAK,SAAU,CAAA,CAAA,CAAA,KAAK,MAAM,MAAM,CAAA,CAAA;AAClD,EAAA,IAAI,SAAc,KAAA,CAAA,CAAA,IAAM,IAAK,CAAA,MAAA,GAAS,YAAY,CAAG,EAAA;AACnD,IAAM,MAAA,KAAA,GACJ,SAAY,GAAA,CAAA,GAAI,IAAK,CAAA,KAAA,CAAM,GAAG,SAAS,CAAA,CAAE,IAAK,CAAA,GAAG,CAAI,GAAA,KAAA,CAAA,CAAA;AAEvD,IAAO,OAAA;AAAA,MACL,KAAA;AAAA,MACA,MAAM,GAAI,CAAA,IAAA;AAAA,MACV,MAAQ,EAAA,kBAAA,CAAmB,IAAK,CAAA,SAAA,GAAY,CAAE,CAAA,CAAA;AAAA,MAC9C,WAAA,EAAa,mBAAmB,IAAK,CAAA,KAAA,CAAM,YAAY,CAAC,CAAA,CAAE,IAAK,CAAA,GAAG,CAAC,CAAA;AAAA,KACrE,CAAA;AAAA,GACF;AAEA,EAAM,MAAA,IAAI,KAAM,CAAA,CAAA,gBAAA,EAAmB,SAAW,CAAA,CAAA,CAAA,CAAA;AAChD;;ACxKO,MAAM,6BAAwD,CAAA;AAAA,EAOnE,OAAO,UACL,CAAA,MAAA,EACA,OACiC,EAAA;AACjC,IAAM,MAAA,eAAA,GAAkB,kBAAkB,MAAM,CAAA,CAAA;AAChD,IAAA,MAAM,YAAe,GAAAF,2BAAA,CAAgB,UAAW,CAAA,MAAM,CAAE,CAAA,MAAA,CAAA;AACxD,IAAA,MAAM,YAA6C,EAAC,CAAA;AAEpD,IAAA,eAAA,CAAgB,QAAQ,CAAkB,cAAA,KAAA;AACxC,MAAA,MAAM,WAAc,GAAA,YAAA,CAAa,MAAO,CAAA,cAAA,CAAe,IAAI,CAAA,CAAA;AAC3D,MAAA,IAAI,CAAC,WAAa,EAAA;AAChB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,iDAAiD,cAAe,CAAA,IAAA,CAAA,CAAA;AAAA,SAClE,CAAA;AAAA,OACF;AACA,MAAU,SAAA,CAAA,IAAA;AAAA,QACR,IAAI,6BAA8B,CAAA;AAAA,UAChC,GAAG,OAAA;AAAA,UACH,MAAQ,EAAA,cAAA;AAAA,UACR,WAAA;AAAA,SACD,CAAA;AAAA,OACH,CAAA;AAAA,KACD,CAAA,CAAA;AACD,IAAO,OAAA,SAAA,CAAA;AAAA,GACT;AAAA,EAEQ,YAAY,OAKjB,EAAA;AACD,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AACtB,IAAA,IAAA,CAAK,cAAc,OAAQ,CAAA,WAAA,CAAA;AAC3B,IAAK,IAAA,CAAA,MAAA,GAAS,OAAQ,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,MACjC,MAAA,EAAQ,KAAK,eAAgB,EAAA;AAAA,KAC9B,CAAA,CAAA;AACD,IAAA,IAAA,CAAK,UAAa,GAAA,IAAA,CAAK,gBAAiB,CAAA,OAAA,CAAQ,QAAQ,CAAA,CAAA;AAAA,GAC1D;AAAA,EAEA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,8BAAA,EAAiC,KAAK,MAAO,CAAA,EAAA,CAAA,CAAA,CAAA;AAAA,GACtD;AAAA,EAEA,MAAM,QAAQ,UAAqD,EAAA;AACjE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAClB,IAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AAAA,GACxB;AAAA,EAEQ,iBAAiB,QAA2C,EAAA;AAClE,IAAA,OAAO,YAAY;AACjB,MAAM,MAAA,MAAA,GAAS,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAA,CAAA,QAAA,CAAA,CAAA;AACvC,MAAA,OAAO,SAAS,GAAI,CAAA;AAAA,QAClB,EAAI,EAAA,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAM,MAAA,MAAA,GAAS,IAAK,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,YAC/B,KAAA,EAAO,6BAA8B,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YAC3D,MAAA;AAAA,YACA,cAAA,EAAgBG,gBAAK,EAAG,EAAA;AAAA,WACzB,CAAA,CAAA;AAED,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA,CAAA;AAAA,mBAClB,KAAP,EAAA;AACA,YAAA,MAAA,CAAO,MAAM,KAAK,CAAA,CAAA;AAAA,WACpB;AAAA,SACF;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,QAAQ,MAA+B,EAAA;AA1H/C,IAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AA2HI,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,gDAAA,EAAmD,KAAK,eAAgB,EAAA,CAAA,CAAA;AAAA,OAC1E,CAAA;AAAA,KACF;AAEA,IAAM,MAAA,MAAA,GAAS,IAAI,YAAa,CAAA;AAAA,MAC9B,MAAA,EAAQ,KAAK,WAAY,CAAA,MAAA;AAAA,MACzB,MAAA;AAAA,KACD,CAAA,CAAA;AAED,IAAA,MAAM,QAAW,GAAA,SAAA;AAAA,MACf,CAAA,OAAA,KAAW,MAAO,CAAA,YAAA,CAAa,OAAO,CAAA;AAAA,MACtC;AAAA,QACE,KAAA,EAAO,KAAK,MAAO,CAAA,KAAA;AAAA,QACnB,IAAM,EAAA,CAAA;AAAA,QACN,QAAU,EAAA,EAAA;AAAA,OACZ;AAAA,KACF,CAAA;AAEA,IAAA,MAAM,GAAc,GAAA;AAAA,MAClB,OAAS,EAAA,CAAA;AAAA,MACT,SAAS,EAAC;AAAA,KACZ,CAAA;AAEA,IAAA,WAAA,MAAiB,WAAW,QAAU,EAAA;AACpC,MAAI,IAAA,CAAC,KAAK,MAAO,CAAA,cAAA,CAAe,MAAK,EAAQ,GAAA,OAAA,CAAA,mBAAA,KAAR,IAA+B,GAAA,EAAA,GAAA,EAAE,CAAG,EAAA;AACvE,QAAA,SAAA;AAAA,OACF;AAEA,MAAI,GAAA,CAAA,OAAA,EAAA,CAAA;AAEJ,MAAA,IAAI,QAAQ,QAAU,EAAA;AACpB,QAAA,SAAA;AAAA,OACF;AAEA,MAAA,IAAI,KAAK,MAAO,CAAA,MAAA,KAAW,GAAO,IAAA,OAAA,CAAQ,mBAAmB,KAAW,CAAA,EAAA;AACtE,QAAA,SAAA;AAAA,OACF;AAEA,MAAA,MAAM,cAAiB,GAAA,CAAA,EAAA,GAAA,OAAA,CAAQ,cAAR,KAAA,IAAA,GAAA,EAAA,GAA0B,KAAK,MAAO,CAAA,MAAA,CAAA;AAE7D,MAAM,MAAA,cAAA,GAA0B,MAAM,MAAO,CAAA,OAAA;AAAA,QAC3C,CAAA,EAAA,GAAA,OAAA,CAAQ,wBAAR,IAA+B,GAAA,EAAA,GAAA,EAAA;AAAA,QAC/B,cAAA;AAAA,QACA,KAAK,MAAO,CAAA,WAAA;AAAA,OACd,CAAA;AACA,MAAA,IAAI,cAAgB,EAAA;AAClB,QAAI,GAAA,CAAA,OAAA,CAAQ,KAAK,OAAO,CAAA,CAAA;AAAA,OAC1B;AAAA,KACF;AAEA,IAAM,MAAA,SAAA,GAAY,IAAI,OAAQ,CAAA,GAAA,CAAI,OAAK,IAAK,CAAA,kBAAA,CAAmB,CAAC,CAAC,CAAA,CAAA;AACjE,IAAM,MAAA,IAAA,CAAK,WAAW,aAAc,CAAA;AAAA,MAClC,IAAM,EAAA,MAAA;AAAA,MACN,QAAA,EAAU,SAAU,CAAA,GAAA,CAAI,CAAa,QAAA,MAAA;AAAA,QACnC,WAAA,EAAa,KAAK,eAAgB,EAAA;AAAA,QAClC,MAAQ,EAAAC,iDAAA,CAA6B,EAAE,QAAA,EAAU,CAAA;AAAA,OACjD,CAAA,CAAA;AAAA,KACH,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,mBAAmB,OAAsC,EAAA;AAzLnE,IAAA,IAAA,EAAA,CAAA;AA0LI,IAAA,MAAM,cAAiB,GAAA,CAAA,EAAA,GAAA,OAAA,CAAQ,cAAR,KAAA,IAAA,GAAA,EAAA,GAA0B,KAAK,MAAO,CAAA,MAAA,CAAA;AAC7D,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,KAAA;AAAA,MACN,QAAQ,CAAG,EAAA,OAAA,CAAQ,OAAkB,CAAA,QAAA,EAAA,cAAA,CAAA,CAAA,EAAkB,KAAK,MAAO,CAAA,WAAA,CAAA,CAAA;AAAA,MACnE,QAAU,EAAA,UAAA;AAAA,KACZ,CAAA;AAAA,GACF;AACF;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/lib/client.ts","../src/providers/config.ts","../src/GitLabDiscoveryProcessor.ts","../src/providers/GitlabDiscoveryEntityProvider.ts","../src/service/GitlabDiscoveryEntityProviderCatalogModule.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 fetch from 'node-fetch';\nimport {\n  getGitLabRequestOptions,\n  GitLabIntegrationConfig,\n} from '@backstage/integration';\nimport { Logger } from 'winston';\n\nexport type ListOptions = {\n  [key: string]: string | number | boolean | undefined;\n  group?: string;\n  per_page?: number | undefined;\n  page?: number | undefined;\n};\n\nexport type PagedResponse<T> = {\n  items: T[];\n  nextPage?: number;\n};\n\nexport class GitLabClient {\n  private readonly config: GitLabIntegrationConfig;\n  private readonly logger: Logger;\n\n  constructor(options: { config: GitLabIntegrationConfig; logger: Logger }) {\n    this.config = options.config;\n    this.logger = options.logger;\n  }\n\n  /**\n   * Indicates whether the client is for a SaaS or self managed GitLab instance.\n   */\n  isSelfManaged(): boolean {\n    return this.config.host !== 'gitlab.com';\n  }\n\n  async listProjects(options?: ListOptions): Promise<PagedResponse<any>> {\n    if (options?.group) {\n      return this.pagedRequest(\n        `/groups/${encodeURIComponent(options?.group)}/projects`,\n        {\n          ...options,\n          include_subgroups: true,\n        },\n      );\n    }\n\n    return this.pagedRequest(`/projects`, options);\n  }\n\n  /**\n   * General existence check.\n   *\n   * @param projectPath - The path to the project\n   * @param branch - The branch used to search\n   * @param filePath - The path to the file\n   */\n  async hasFile(\n    projectPath: string,\n    branch: string,\n    filePath: string,\n  ): Promise<boolean> {\n    const endpoint: string = `/projects/${encodeURIComponent(\n      projectPath,\n    )}/repository/files/${encodeURIComponent(filePath)}`;\n    const request = new URL(`${this.config.apiBaseUrl}${endpoint}`);\n    request.searchParams.append('ref', branch);\n\n    const response = await fetch(request.toString(), {\n      headers: getGitLabRequestOptions(this.config).headers,\n      method: 'HEAD',\n    });\n\n    if (!response.ok) {\n      if (response.status >= 500) {\n        this.logger.debug(\n          `Unexpected response when fetching ${request.toString()}. Expected 200 but got ${\n            response.status\n          } - ${response.statusText}`,\n        );\n      }\n      return false;\n    }\n\n    return true;\n  }\n\n  /**\n   * Performs a request against a given paginated GitLab endpoint.\n   *\n   * This method may be used to perform authenticated REST calls against any\n   * paginated GitLab endpoint which uses X-NEXT-PAGE headers. The return value\n   * can be be used with the {@link paginated} async-generator function to yield\n   * each item from the paged request.\n   *\n   * @see {@link paginated}\n   * @param endpoint - The request endpoint, e.g. /projects.\n   * @param options - Request queryString options which may also include page variables.\n   */\n  async pagedRequest<T = any>(\n    endpoint: string,\n    options?: ListOptions,\n  ): Promise<PagedResponse<T>> {\n    const request = new URL(`${this.config.apiBaseUrl}${endpoint}`);\n    for (const key in options) {\n      if (options[key]) {\n        request.searchParams.append(key, options[key]!.toString());\n      }\n    }\n\n    this.logger.debug(`Fetching: ${request.toString()}`);\n    const response = await fetch(\n      request.toString(),\n      getGitLabRequestOptions(this.config),\n    );\n    if (!response.ok) {\n      throw new Error(\n        `Unexpected response when fetching ${request.toString()}. Expected 200 but got ${\n          response.status\n        } - ${response.statusText}`,\n      );\n    }\n    return response.json().then(items => {\n      const nextPage = response.headers.get('x-next-page');\n\n      return {\n        items,\n        nextPage: nextPage ? Number(nextPage) : null,\n      } as PagedResponse<any>;\n    });\n  }\n}\n\n/**\n * Advances through each page and provides each item from a paginated request.\n *\n * The async generator function yields each item from repeated calls to the\n * provided request function. The generator walks through each available page by\n * setting the page key in the options passed into the request function and\n * making repeated calls until there are no more pages.\n *\n * @see {@link pagedRequest}\n * @param request - Function which returns a PagedResponse to walk through.\n * @param options - Initial ListOptions for the request function.\n */\nexport async function* paginated<T = any>(\n  request: (options: ListOptions) => Promise<PagedResponse<T>>,\n  options: ListOptions,\n) {\n  let res;\n  do {\n    res = await request(options);\n    options.page = res.nextPage;\n    for (const item of res.items) {\n      yield item;\n    }\n  } while (res.nextPage);\n}\n","/*\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 { readTaskScheduleDefinitionFromConfig } from '@backstage/backend-tasks';\nimport { Config } from '@backstage/config';\nimport { GitlabProviderConfig } from '../lib';\n\n/**\n * Extracts the gitlab config from a config object\n *\n * @public\n *\n * @param id - The provider key\n * @param config - The config object to extract from\n */\nfunction readGitlabConfig(id: string, config: Config): GitlabProviderConfig {\n  const group = config.getOptionalString('group') ?? '';\n  const host = config.getString('host');\n  const branch = config.getOptionalString('branch') ?? 'master';\n  const catalogFile =\n    config.getOptionalString('entityFilename') ?? 'catalog-info.yaml';\n  const projectPattern = new RegExp(\n    config.getOptionalString('projectPattern') ?? /[\\s\\S]*/,\n  );\n\n  const schedule = config.has('schedule')\n    ? readTaskScheduleDefinitionFromConfig(config.getConfig('schedule'))\n    : undefined;\n\n  return {\n    id,\n    group,\n    branch,\n    host,\n    catalogFile,\n    projectPattern,\n    schedule,\n  };\n}\n\n/**\n * Extracts the gitlab config from a config object array\n *\n * @public\n *\n * @param config - The config object to extract from\n */\nexport function readGitlabConfigs(config: Config): GitlabProviderConfig[] {\n  const configs: GitlabProviderConfig[] = [];\n\n  const providerConfigs = config.getOptionalConfig('catalog.providers.gitlab');\n\n  if (!providerConfigs) {\n    return configs;\n  }\n\n  for (const id of providerConfigs.keys()) {\n    configs.push(readGitlabConfig(id, providerConfigs.getConfig(id)));\n  }\n\n  return configs;\n}\n","/*\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  CacheClient,\n  CacheManager,\n  PluginCacheManager,\n} from '@backstage/backend-common';\nimport { Config } from '@backstage/config';\nimport {\n  ScmIntegrationRegistry,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport {\n  CatalogProcessor,\n  CatalogProcessorEmit,\n  LocationSpec,\n  processingResult,\n} from '@backstage/plugin-catalog-backend';\nimport { Logger } from 'winston';\nimport { GitLabClient, GitLabProject, paginated } from './lib';\n\n/**\n * Extracts repositories out of an GitLab instance.\n * @public\n */\nexport class GitLabDiscoveryProcessor implements CatalogProcessor {\n  private readonly integrations: ScmIntegrationRegistry;\n  private readonly logger: Logger;\n  private readonly cache: CacheClient;\n  private readonly skipReposWithoutExactFileMatch: boolean;\n\n  static fromConfig(\n    config: Config,\n    options: { logger: Logger; skipReposWithoutExactFileMatch?: boolean },\n  ): GitLabDiscoveryProcessor {\n    const integrations = ScmIntegrations.fromConfig(config);\n    const pluginCache =\n      CacheManager.fromConfig(config).forPlugin('gitlab-discovery');\n\n    return new GitLabDiscoveryProcessor({\n      ...options,\n      integrations,\n      pluginCache,\n    });\n  }\n\n  private constructor(options: {\n    integrations: ScmIntegrationRegistry;\n    pluginCache: PluginCacheManager;\n    logger: Logger;\n    skipReposWithoutExactFileMatch?: boolean;\n  }) {\n    this.integrations = options.integrations;\n    this.cache = options.pluginCache.getClient();\n    this.logger = options.logger;\n    this.skipReposWithoutExactFileMatch =\n      options.skipReposWithoutExactFileMatch || false;\n  }\n\n  getProcessorName(): string {\n    return 'GitLabDiscoveryProcessor';\n  }\n\n  async readLocation(\n    location: LocationSpec,\n    _optional: boolean,\n    emit: CatalogProcessorEmit,\n  ): Promise<boolean> {\n    if (location.type !== 'gitlab-discovery') {\n      return false;\n    }\n\n    const startTime = new Date();\n    const { group, host, branch, catalogPath } = parseUrl(location.target);\n\n    const integration = this.integrations.gitlab.byUrl(`https://${host}`);\n    if (!integration) {\n      throw new Error(\n        `There is no GitLab integration that matches ${host}. Please add a configuration entry for it under integrations.gitlab`,\n      );\n    }\n\n    const client = new GitLabClient({\n      config: integration.config,\n      logger: this.logger,\n    });\n    this.logger.debug(`Reading GitLab projects from ${location.target}`);\n\n    const lastActivity = (await this.cache.get(this.getCacheKey())) as string;\n    const opts = {\n      group,\n      page: 1,\n      // We check for the existence of lastActivity and only set it if it's present to ensure\n      // that the options doesn't include the key so that the API doesn't receive an empty query parameter.\n      ...(lastActivity && { last_activity_after: lastActivity }),\n    };\n\n    const projects = paginated(options => client.listProjects(options), opts);\n\n    const res: Result = {\n      scanned: 0,\n      matches: [],\n    };\n    for await (const project of projects) {\n      res.scanned++;\n\n      if (project.archived) {\n        continue;\n      }\n\n      if (branch === '*' && project.default_branch === undefined) {\n        continue;\n      }\n\n      if (this.skipReposWithoutExactFileMatch) {\n        const project_branch = branch === '*' ? project.default_branch : branch;\n\n        const projectHasFile: boolean = await client.hasFile(\n          project.path_with_namespace,\n          project_branch,\n          catalogPath,\n        );\n\n        if (!projectHasFile) {\n          continue;\n        }\n      }\n\n      res.matches.push(project);\n    }\n\n    for (const project of res.matches) {\n      const project_branch = branch === '*' ? project.default_branch : branch;\n\n      emit(\n        processingResult.location({\n          type: 'url',\n          // The format expected by the GitLabUrlReader:\n          // https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath\n          //\n          // This unfortunately will trigger another API call in `getGitLabFileFetchUrl` to get the project ID.\n          // The alternative is using the `buildRawUrl` function, which does not support subgroups, so providing a raw\n          // URL here won't work either.\n          target: `${project.web_url}/-/blob/${project_branch}/${catalogPath}`,\n          presence: 'optional',\n        }),\n      );\n    }\n\n    // Save an ISO formatted string in the cache as that's what GitLab expects in the API request.\n    await this.cache.set(this.getCacheKey(), startTime.toISOString());\n\n    const duration = ((Date.now() - startTime.getTime()) / 1000).toFixed(1);\n    this.logger.debug(\n      `Read ${res.scanned} GitLab repositories in ${duration} seconds`,\n    );\n\n    return true;\n  }\n\n  private getCacheKey(): string {\n    return `processors/${this.getProcessorName()}/last-activity`;\n  }\n}\n\ntype Result = {\n  scanned: number;\n  matches: GitLabProject[];\n};\n\n/*\n * Helpers\n */\n\nexport function parseUrl(urlString: string): {\n  group?: string;\n  host: string;\n  branch: string;\n  catalogPath: string;\n} {\n  const url = new URL(urlString);\n  const path = url.pathname.substr(1).split('/');\n\n  // (/group/subgroup)/blob/branch|*/filepath\n  const blobIndex = path.findIndex(p => p === 'blob');\n  if (blobIndex !== -1 && path.length > blobIndex + 2) {\n    const group =\n      blobIndex > 0 ? path.slice(0, blobIndex).join('/') : undefined;\n\n    return {\n      group,\n      host: url.host,\n      branch: decodeURIComponent(path[blobIndex + 1]),\n      catalogPath: decodeURIComponent(path.slice(blobIndex + 2).join('/')),\n    };\n  }\n\n  throw new Error(`Failed to parse ${urlString}`);\n}\n","/*\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 { PluginTaskScheduler, TaskRunner } from '@backstage/backend-tasks';\nimport { Config } from '@backstage/config';\nimport { GitLabIntegration, ScmIntegrations } from '@backstage/integration';\nimport {\n  EntityProvider,\n  EntityProviderConnection,\n  LocationSpec,\n  locationSpecToLocationEntity,\n} from '@backstage/plugin-catalog-backend';\nimport * as uuid from 'uuid';\nimport { Logger } from 'winston';\nimport {\n  GitLabClient,\n  GitLabProject,\n  GitlabProviderConfig,\n  paginated,\n  readGitlabConfigs,\n} from '../lib';\n\ntype Result = {\n  scanned: number;\n  matches: GitLabProject[];\n};\n\n/**\n * Discovers entity definition files in the groups of a Gitlab instance.\n * @public\n */\nexport class GitlabDiscoveryEntityProvider implements EntityProvider {\n  private readonly config: GitlabProviderConfig;\n  private readonly integration: GitLabIntegration;\n  private readonly logger: Logger;\n  private readonly scheduleFn: () => Promise<void>;\n  private connection?: EntityProviderConnection;\n\n  static fromConfig(\n    config: Config,\n    options: {\n      logger: Logger;\n      schedule?: TaskRunner;\n      scheduler?: PluginTaskScheduler;\n    },\n  ): GitlabDiscoveryEntityProvider[] {\n    if (!options.schedule && !options.scheduler) {\n      throw new Error('Either schedule or scheduler must be provided.');\n    }\n\n    const providerConfigs = readGitlabConfigs(config);\n    const integrations = ScmIntegrations.fromConfig(config).gitlab;\n    const providers: GitlabDiscoveryEntityProvider[] = [];\n\n    providerConfigs.forEach(providerConfig => {\n      const integration = integrations.byHost(providerConfig.host);\n      if (!integration) {\n        throw new Error(\n          `No gitlab integration found that matches host ${providerConfig.host}`,\n        );\n      }\n\n      if (!options.schedule && !providerConfig.schedule) {\n        throw new Error(\n          `No schedule provided neither via code nor config for GitlabDiscoveryEntityProvider:${providerConfig.id}.`,\n        );\n      }\n\n      const taskRunner =\n        options.schedule ??\n        options.scheduler!.createScheduledTaskRunner(providerConfig.schedule!);\n\n      providers.push(\n        new GitlabDiscoveryEntityProvider({\n          ...options,\n          config: providerConfig,\n          integration,\n          taskRunner,\n        }),\n      );\n    });\n    return providers;\n  }\n\n  private constructor(options: {\n    config: GitlabProviderConfig;\n    integration: GitLabIntegration;\n    logger: Logger;\n    taskRunner: TaskRunner;\n  }) {\n    this.config = options.config;\n    this.integration = options.integration;\n    this.logger = options.logger.child({\n      target: this.getProviderName(),\n    });\n    this.scheduleFn = this.createScheduleFn(options.taskRunner);\n  }\n\n  getProviderName(): string {\n    return `GitlabDiscoveryEntityProvider:${this.config.id}`;\n  }\n\n  async connect(connection: EntityProviderConnection): Promise<void> {\n    this.connection = connection;\n    await this.scheduleFn();\n  }\n\n  private createScheduleFn(taskRunner: TaskRunner): () => 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: GitlabDiscoveryEntityProvider.prototype.constructor.name,\n            taskId,\n            taskInstanceId: uuid.v4(),\n          });\n\n          try {\n            await this.refresh(logger);\n          } catch (error) {\n            logger.error(error);\n          }\n        },\n      });\n    };\n  }\n\n  async refresh(logger: Logger): Promise<void> {\n    if (!this.connection) {\n      throw new Error(\n        `Gitlab discovery connection not initialized for ${this.getProviderName()}`,\n      );\n    }\n\n    const client = new GitLabClient({\n      config: this.integration.config,\n      logger: logger,\n    });\n\n    const projects = paginated<GitLabProject>(\n      options => client.listProjects(options),\n      {\n        group: this.config.group,\n        page: 1,\n        per_page: 50,\n      },\n    );\n\n    const res: Result = {\n      scanned: 0,\n      matches: [],\n    };\n\n    for await (const project of projects) {\n      if (!this.config.projectPattern.test(project.path_with_namespace ?? '')) {\n        continue;\n      }\n\n      res.scanned++;\n\n      if (project.archived) {\n        continue;\n      }\n\n      if (this.config.branch === '*' && project.default_branch === undefined) {\n        continue;\n      }\n\n      const project_branch = project.default_branch ?? this.config.branch;\n\n      const projectHasFile: boolean = await client.hasFile(\n        project.path_with_namespace ?? '',\n        project_branch,\n        this.config.catalogFile,\n      );\n      if (projectHasFile) {\n        res.matches.push(project);\n      }\n    }\n\n    const locations = res.matches.map(p => this.createLocationSpec(p));\n    await this.connection.applyMutation({\n      type: 'full',\n      entities: locations.map(location => ({\n        locationKey: this.getProviderName(),\n        entity: locationSpecToLocationEntity({ location }),\n      })),\n    });\n  }\n\n  private createLocationSpec(project: GitLabProject): LocationSpec {\n    const project_branch = project.default_branch ?? this.config.branch;\n    return {\n      type: 'url',\n      target: `${project.web_url}/-/blob/${project_branch}/${this.config.catalogFile}`,\n      presence: 'optional',\n    };\n  }\n}\n","/*\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  createBackendModule,\n  loggerToWinstonLogger,\n  configServiceRef,\n  loggerServiceRef,\n  schedulerServiceRef,\n} from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node';\nimport { GitlabDiscoveryEntityProvider } from '../providers';\n\n/**\n * Registers the GitlabDiscoveryEntityProvider with the catalog processing extension point.\n *\n * @alpha\n */\nexport const gitlabDiscoveryEntityProviderCatalogModule = createBackendModule({\n  pluginId: 'catalog',\n  moduleId: 'gitlabDiscoveryEntityProvider',\n  register(env) {\n    env.registerInit({\n      deps: {\n        config: configServiceRef,\n        catalog: catalogProcessingExtensionPoint,\n        logger: loggerServiceRef,\n        scheduler: schedulerServiceRef,\n      },\n      async init({ config, catalog, logger, scheduler }) {\n        catalog.addEntityProvider(\n          GitlabDiscoveryEntityProvider.fromConfig(config, {\n            logger: loggerToWinstonLogger(logger),\n            scheduler,\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["fetch","getGitLabRequestOptions","readTaskScheduleDefinitionFromConfig","ScmIntegrations","CacheManager","processingResult","uuid","locationSpecToLocationEntity","createBackendModule","configServiceRef","catalogProcessingExtensionPoint","loggerServiceRef","schedulerServiceRef","loggerToWinstonLogger"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmCO,MAAM,YAAa,CAAA;AAAA,EAIxB,YAAY,OAA8D,EAAA;AACxE,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AACtB,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AAAA,GACxB;AAAA,EAKA,aAAyB,GAAA;AACvB,IAAO,OAAA,IAAA,CAAK,OAAO,IAAS,KAAA,YAAA,CAAA;AAAA,GAC9B;AAAA,EAEA,MAAM,aAAa,OAAoD,EAAA;AACrE,IAAA,IAAI,mCAAS,KAAO,EAAA;AAClB,MAAA,OAAO,IAAK,CAAA,YAAA;AAAA,QACV,CAAA,QAAA,EAAW,kBAAmB,CAAA,OAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,OAAA,CAAS,KAAK,CAAA,CAAA,SAAA,CAAA;AAAA,QAC5C;AAAA,UACE,GAAG,OAAA;AAAA,UACH,iBAAmB,EAAA,IAAA;AAAA,SACrB;AAAA,OACF,CAAA;AAAA,KACF;AAEA,IAAO,OAAA,IAAA,CAAK,YAAa,CAAA,CAAA,SAAA,CAAA,EAAa,OAAO,CAAA,CAAA;AAAA,GAC/C;AAAA,EASA,MAAM,OAAA,CACJ,WACA,EAAA,MAAA,EACA,QACkB,EAAA;AAClB,IAAA,MAAM,WAAmB,CAAa,UAAA,EAAA,kBAAA;AAAA,MACpC,WAAA;AAAA,KACF,CAAA,kBAAA,EAAsB,mBAAmB,QAAQ,CAAA,CAAA,CAAA,CAAA;AACjD,IAAA,MAAM,UAAU,IAAI,GAAA,CAAI,GAAG,IAAK,CAAA,MAAA,CAAO,aAAa,QAAU,CAAA,CAAA,CAAA,CAAA;AAC9D,IAAQ,OAAA,CAAA,YAAA,CAAa,MAAO,CAAA,KAAA,EAAO,MAAM,CAAA,CAAA;AAEzC,IAAA,MAAM,QAAW,GAAA,MAAMA,yBAAM,CAAA,OAAA,CAAQ,UAAY,EAAA;AAAA,MAC/C,OAAS,EAAAC,mCAAA,CAAwB,IAAK,CAAA,MAAM,CAAE,CAAA,OAAA;AAAA,MAC9C,MAAQ,EAAA,MAAA;AAAA,KACT,CAAA,CAAA;AAED,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAI,IAAA,QAAA,CAAS,UAAU,GAAK,EAAA;AAC1B,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,qCAAqC,OAAQ,CAAA,QAAA,EAC3C,CAAA,uBAAA,EAAA,QAAA,CAAS,YACL,QAAS,CAAA,UAAA,CAAA,CAAA;AAAA,SACjB,CAAA;AAAA,OACF;AACA,MAAO,OAAA,KAAA,CAAA;AAAA,KACT;AAEA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAcA,MAAM,YACJ,CAAA,QAAA,EACA,OAC2B,EAAA;AAC3B,IAAA,MAAM,UAAU,IAAI,GAAA,CAAI,GAAG,IAAK,CAAA,MAAA,CAAO,aAAa,QAAU,CAAA,CAAA,CAAA,CAAA;AAC9D,IAAA,KAAA,MAAW,OAAO,OAAS,EAAA;AACzB,MAAA,IAAI,QAAQ,GAAM,CAAA,EAAA;AAChB,QAAA,OAAA,CAAQ,aAAa,MAAO,CAAA,GAAA,EAAK,OAAQ,CAAA,GAAA,CAAA,CAAM,UAAU,CAAA,CAAA;AAAA,OAC3D;AAAA,KACF;AAEA,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAa,UAAA,EAAA,OAAA,CAAQ,UAAY,CAAA,CAAA,CAAA,CAAA;AACnD,IAAA,MAAM,WAAW,MAAMD,yBAAA;AAAA,MACrB,QAAQ,QAAS,EAAA;AAAA,MACjBC,mCAAA,CAAwB,KAAK,MAAM,CAAA;AAAA,KACrC,CAAA;AACA,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,qCAAqC,OAAQ,CAAA,QAAA,EAC3C,CAAA,uBAAA,EAAA,QAAA,CAAS,YACL,QAAS,CAAA,UAAA,CAAA,CAAA;AAAA,OACjB,CAAA;AAAA,KACF;AACA,IAAA,OAAO,QAAS,CAAA,IAAA,EAAO,CAAA,IAAA,CAAK,CAAS,KAAA,KAAA;AACnC,MAAA,MAAM,QAAW,GAAA,QAAA,CAAS,OAAQ,CAAA,GAAA,CAAI,aAAa,CAAA,CAAA;AAEnD,MAAO,OAAA;AAAA,QACL,KAAA;AAAA,QACA,QAAU,EAAA,QAAA,GAAW,MAAO,CAAA,QAAQ,CAAI,GAAA,IAAA;AAAA,OAC1C,CAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAA;AAcuB,gBAAA,SAAA,CACrB,SACA,OACA,EAAA;AACA,EAAI,IAAA,GAAA,CAAA;AACJ,EAAG,GAAA;AACD,IAAM,GAAA,GAAA,MAAM,QAAQ,OAAO,CAAA,CAAA;AAC3B,IAAA,OAAA,CAAQ,OAAO,GAAI,CAAA,QAAA,CAAA;AACnB,IAAW,KAAA,MAAA,IAAA,IAAQ,IAAI,KAAO,EAAA;AAC5B,MAAM,MAAA,IAAA,CAAA;AAAA,KACR;AAAA,WACO,GAAI,CAAA,QAAA,EAAA;AACf;;AChJA,SAAS,gBAAA,CAAiB,IAAY,MAAsC,EAAA;AA5B5E,EAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AA6BE,EAAA,MAAM,KAAQ,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAkB,CAAA,OAAO,MAAhC,IAAqC,GAAA,EAAA,GAAA,EAAA,CAAA;AACnD,EAAM,MAAA,IAAA,GAAO,MAAO,CAAA,SAAA,CAAU,MAAM,CAAA,CAAA;AACpC,EAAA,MAAM,MAAS,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAkB,CAAA,QAAQ,MAAjC,IAAsC,GAAA,EAAA,GAAA,QAAA,CAAA;AACrD,EAAA,MAAM,WACJ,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAkB,CAAA,gBAAgB,MAAzC,IAA8C,GAAA,EAAA,GAAA,mBAAA,CAAA;AAChD,EAAA,MAAM,iBAAiB,IAAI,MAAA;AAAA,IAAA,CACzB,EAAO,GAAA,MAAA,CAAA,iBAAA,CAAkB,gBAAgB,CAAA,KAAzC,IAA8C,GAAA,EAAA,GAAA,SAAA;AAAA,GAChD,CAAA;AAEA,EAAM,MAAA,QAAA,GAAW,MAAO,CAAA,GAAA,CAAI,UAAU,CAAA,GAClCC,kDAAqC,MAAO,CAAA,SAAA,CAAU,UAAU,CAAC,CACjE,GAAA,KAAA,CAAA,CAAA;AAEJ,EAAO,OAAA;AAAA,IACL,EAAA;AAAA,IACA,KAAA;AAAA,IACA,MAAA;AAAA,IACA,IAAA;AAAA,IACA,WAAA;AAAA,IACA,cAAA;AAAA,IACA,QAAA;AAAA,GACF,CAAA;AACF,CAAA;AASO,SAAS,kBAAkB,MAAwC,EAAA;AACxE,EAAA,MAAM,UAAkC,EAAC,CAAA;AAEzC,EAAM,MAAA,eAAA,GAAkB,MAAO,CAAA,iBAAA,CAAkB,0BAA0B,CAAA,CAAA;AAE3E,EAAA,IAAI,CAAC,eAAiB,EAAA;AACpB,IAAO,OAAA,OAAA,CAAA;AAAA,GACT;AAEA,EAAW,KAAA,MAAA,EAAA,IAAM,eAAgB,CAAA,IAAA,EAAQ,EAAA;AACvC,IAAA,OAAA,CAAQ,KAAK,gBAAiB,CAAA,EAAA,EAAI,gBAAgB,SAAU,CAAA,EAAE,CAAC,CAAC,CAAA,CAAA;AAAA,GAClE;AAEA,EAAO,OAAA,OAAA,CAAA;AACT;;ACnCO,MAAM,wBAAqD,CAAA;AAAA,EAMhE,OAAO,UACL,CAAA,MAAA,EACA,OAC0B,EAAA;AAC1B,IAAM,MAAA,YAAA,GAAeC,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AACtD,IAAA,MAAM,cACJC,0BAAa,CAAA,UAAA,CAAW,MAAM,CAAA,CAAE,UAAU,kBAAkB,CAAA,CAAA;AAE9D,IAAA,OAAO,IAAI,wBAAyB,CAAA;AAAA,MAClC,GAAG,OAAA;AAAA,MACH,YAAA;AAAA,MACA,WAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,YAAY,OAKjB,EAAA;AACD,IAAA,IAAA,CAAK,eAAe,OAAQ,CAAA,YAAA,CAAA;AAC5B,IAAK,IAAA,CAAA,KAAA,GAAQ,OAAQ,CAAA,WAAA,CAAY,SAAU,EAAA,CAAA;AAC3C,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AACtB,IAAK,IAAA,CAAA,8BAAA,GACH,QAAQ,8BAAkC,IAAA,KAAA,CAAA;AAAA,GAC9C;AAAA,EAEA,gBAA2B,GAAA;AACzB,IAAO,OAAA,0BAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAM,YAAA,CACJ,QACA,EAAA,SAAA,EACA,IACkB,EAAA;AAClB,IAAI,IAAA,QAAA,CAAS,SAAS,kBAAoB,EAAA;AACxC,MAAO,OAAA,KAAA,CAAA;AAAA,KACT;AAEA,IAAM,MAAA,SAAA,GAAY,IAAI,IAAK,EAAA,CAAA;AAC3B,IAAM,MAAA,EAAE,OAAO,IAAM,EAAA,MAAA,EAAQ,aAAgB,GAAA,QAAA,CAAS,SAAS,MAAM,CAAA,CAAA;AAErE,IAAA,MAAM,cAAc,IAAK,CAAA,YAAA,CAAa,MAAO,CAAA,KAAA,CAAM,WAAW,IAAM,CAAA,CAAA,CAAA,CAAA;AACpE,IAAA,IAAI,CAAC,WAAa,EAAA;AAChB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAA+C,4CAAA,EAAA,IAAA,CAAA,mEAAA,CAAA;AAAA,OACjD,CAAA;AAAA,KACF;AAEA,IAAM,MAAA,MAAA,GAAS,IAAI,YAAa,CAAA;AAAA,MAC9B,QAAQ,WAAY,CAAA,MAAA;AAAA,MACpB,QAAQ,IAAK,CAAA,MAAA;AAAA,KACd,CAAA,CAAA;AACD,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAgC,6BAAA,EAAA,QAAA,CAAS,MAAQ,CAAA,CAAA,CAAA,CAAA;AAEnE,IAAA,MAAM,eAAgB,MAAM,IAAA,CAAK,MAAM,GAAI,CAAA,IAAA,CAAK,aAAa,CAAA,CAAA;AAC7D,IAAA,MAAM,IAAO,GAAA;AAAA,MACX,KAAA;AAAA,MACA,IAAM,EAAA,CAAA;AAAA,MAGN,GAAI,YAAA,IAAgB,EAAE,mBAAA,EAAqB,YAAa,EAAA;AAAA,KAC1D,CAAA;AAEA,IAAA,MAAM,WAAW,SAAU,CAAA,CAAA,OAAA,KAAW,OAAO,YAAa,CAAA,OAAO,GAAG,IAAI,CAAA,CAAA;AAExE,IAAA,MAAM,GAAc,GAAA;AAAA,MAClB,OAAS,EAAA,CAAA;AAAA,MACT,SAAS,EAAC;AAAA,KACZ,CAAA;AACA,IAAA,WAAA,MAAiB,WAAW,QAAU,EAAA;AACpC,MAAI,GAAA,CAAA,OAAA,EAAA,CAAA;AAEJ,MAAA,IAAI,QAAQ,QAAU,EAAA;AACpB,QAAA,SAAA;AAAA,OACF;AAEA,MAAA,IAAI,MAAW,KAAA,GAAA,IAAO,OAAQ,CAAA,cAAA,KAAmB,KAAW,CAAA,EAAA;AAC1D,QAAA,SAAA;AAAA,OACF;AAEA,MAAA,IAAI,KAAK,8BAAgC,EAAA;AACvC,QAAA,MAAM,cAAiB,GAAA,MAAA,KAAW,GAAM,GAAA,OAAA,CAAQ,cAAiB,GAAA,MAAA,CAAA;AAEjE,QAAM,MAAA,cAAA,GAA0B,MAAM,MAAO,CAAA,OAAA;AAAA,UAC3C,OAAQ,CAAA,mBAAA;AAAA,UACR,cAAA;AAAA,UACA,WAAA;AAAA,SACF,CAAA;AAEA,QAAA,IAAI,CAAC,cAAgB,EAAA;AACnB,UAAA,SAAA;AAAA,SACF;AAAA,OACF;AAEA,MAAI,GAAA,CAAA,OAAA,CAAQ,KAAK,OAAO,CAAA,CAAA;AAAA,KAC1B;AAEA,IAAW,KAAA,MAAA,OAAA,IAAW,IAAI,OAAS,EAAA;AACjC,MAAA,MAAM,cAAiB,GAAA,MAAA,KAAW,GAAM,GAAA,OAAA,CAAQ,cAAiB,GAAA,MAAA,CAAA;AAEjE,MAAA,IAAA;AAAA,QACEC,sCAAiB,QAAS,CAAA;AAAA,UACxB,IAAM,EAAA,KAAA;AAAA,UAON,MAAQ,EAAA,CAAA,EAAG,OAAQ,CAAA,OAAA,CAAA,QAAA,EAAkB,cAAkB,CAAA,CAAA,EAAA,WAAA,CAAA,CAAA;AAAA,UACvD,QAAU,EAAA,UAAA;AAAA,SACX,CAAA;AAAA,OACH,CAAA;AAAA,KACF;AAGA,IAAM,MAAA,IAAA,CAAK,MAAM,GAAI,CAAA,IAAA,CAAK,aAAe,EAAA,SAAA,CAAU,aAAa,CAAA,CAAA;AAEhE,IAAM,MAAA,QAAA,GAAA,CAAA,CAAa,KAAK,GAAI,EAAA,GAAI,UAAU,OAAQ,EAAA,IAAK,GAAM,EAAA,OAAA,CAAQ,CAAC,CAAA,CAAA;AACtE,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACV,CAAA,KAAA,EAAQ,IAAI,OAAkC,CAAA,wBAAA,EAAA,QAAA,CAAA,QAAA,CAAA;AAAA,KAChD,CAAA;AAEA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAEQ,WAAsB,GAAA;AAC5B,IAAO,OAAA,CAAA,WAAA,EAAc,KAAK,gBAAiB,EAAA,CAAA,cAAA,CAAA,CAAA;AAAA,GAC7C;AACF,CAAA;AAWO,SAAS,SAAS,SAKvB,EAAA;AACA,EAAM,MAAA,GAAA,GAAM,IAAI,GAAA,CAAI,SAAS,CAAA,CAAA;AAC7B,EAAA,MAAM,OAAO,GAAI,CAAA,QAAA,CAAS,OAAO,CAAC,CAAA,CAAE,MAAM,GAAG,CAAA,CAAA;AAG7C,EAAA,MAAM,SAAY,GAAA,IAAA,CAAK,SAAU,CAAA,CAAA,CAAA,KAAK,MAAM,MAAM,CAAA,CAAA;AAClD,EAAA,IAAI,SAAc,KAAA,CAAA,CAAA,IAAM,IAAK,CAAA,MAAA,GAAS,YAAY,CAAG,EAAA;AACnD,IAAM,MAAA,KAAA,GACJ,SAAY,GAAA,CAAA,GAAI,IAAK,CAAA,KAAA,CAAM,GAAG,SAAS,CAAA,CAAE,IAAK,CAAA,GAAG,CAAI,GAAA,KAAA,CAAA,CAAA;AAEvD,IAAO,OAAA;AAAA,MACL,KAAA;AAAA,MACA,MAAM,GAAI,CAAA,IAAA;AAAA,MACV,MAAQ,EAAA,kBAAA,CAAmB,IAAK,CAAA,SAAA,GAAY,CAAE,CAAA,CAAA;AAAA,MAC9C,WAAA,EAAa,mBAAmB,IAAK,CAAA,KAAA,CAAM,YAAY,CAAC,CAAA,CAAE,IAAK,CAAA,GAAG,CAAC,CAAA;AAAA,KACrE,CAAA;AAAA,GACF;AAEA,EAAM,MAAA,IAAI,KAAM,CAAA,CAAA,gBAAA,EAAmB,SAAW,CAAA,CAAA,CAAA,CAAA;AAChD;;ACxKO,MAAM,6BAAwD,CAAA;AAAA,EAOnE,OAAO,UACL,CAAA,MAAA,EACA,OAKiC,EAAA;AACjC,IAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,QAAQ,SAAW,EAAA;AAC3C,MAAM,MAAA,IAAI,MAAM,gDAAgD,CAAA,CAAA;AAAA,KAClE;AAEA,IAAM,MAAA,eAAA,GAAkB,kBAAkB,MAAM,CAAA,CAAA;AAChD,IAAA,MAAM,YAAe,GAAAF,2BAAA,CAAgB,UAAW,CAAA,MAAM,CAAE,CAAA,MAAA,CAAA;AACxD,IAAA,MAAM,YAA6C,EAAC,CAAA;AAEpD,IAAA,eAAA,CAAgB,QAAQ,CAAkB,cAAA,KAAA;AAnE9C,MAAA,IAAA,EAAA,CAAA;AAoEM,MAAA,MAAM,WAAc,GAAA,YAAA,CAAa,MAAO,CAAA,cAAA,CAAe,IAAI,CAAA,CAAA;AAC3D,MAAA,IAAI,CAAC,WAAa,EAAA;AAChB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,iDAAiD,cAAe,CAAA,IAAA,CAAA,CAAA;AAAA,SAClE,CAAA;AAAA,OACF;AAEA,MAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,eAAe,QAAU,EAAA;AACjD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,sFAAsF,cAAe,CAAA,EAAA,CAAA,CAAA,CAAA;AAAA,SACvG,CAAA;AAAA,OACF;AAEA,MAAM,MAAA,UAAA,GAAA,CACJ,aAAQ,QAAR,KAAA,IAAA,GAAA,EAAA,GACA,QAAQ,SAAW,CAAA,yBAAA,CAA0B,eAAe,QAAS,CAAA,CAAA;AAEvE,MAAU,SAAA,CAAA,IAAA;AAAA,QACR,IAAI,6BAA8B,CAAA;AAAA,UAChC,GAAG,OAAA;AAAA,UACH,MAAQ,EAAA,cAAA;AAAA,UACR,WAAA;AAAA,UACA,UAAA;AAAA,SACD,CAAA;AAAA,OACH,CAAA;AAAA,KACD,CAAA,CAAA;AACD,IAAO,OAAA,SAAA,CAAA;AAAA,GACT;AAAA,EAEQ,YAAY,OAKjB,EAAA;AACD,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AACtB,IAAA,IAAA,CAAK,cAAc,OAAQ,CAAA,WAAA,CAAA;AAC3B,IAAK,IAAA,CAAA,MAAA,GAAS,OAAQ,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,MACjC,MAAA,EAAQ,KAAK,eAAgB,EAAA;AAAA,KAC9B,CAAA,CAAA;AACD,IAAA,IAAA,CAAK,UAAa,GAAA,IAAA,CAAK,gBAAiB,CAAA,OAAA,CAAQ,UAAU,CAAA,CAAA;AAAA,GAC5D;AAAA,EAEA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,8BAAA,EAAiC,KAAK,MAAO,CAAA,EAAA,CAAA,CAAA,CAAA;AAAA,GACtD;AAAA,EAEA,MAAM,QAAQ,UAAqD,EAAA;AACjE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAClB,IAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AAAA,GACxB;AAAA,EAEQ,iBAAiB,UAA6C,EAAA;AACpE,IAAA,OAAO,YAAY;AACjB,MAAM,MAAA,MAAA,GAAS,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAA,CAAA,QAAA,CAAA,CAAA;AACvC,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,6BAA8B,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YAC3D,MAAA;AAAA,YACA,cAAA,EAAgBG,gBAAK,EAAG,EAAA;AAAA,WACzB,CAAA,CAAA;AAED,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA,CAAA;AAAA,mBAClB,KAAP,EAAA;AACA,YAAA,MAAA,CAAO,MAAM,KAAK,CAAA,CAAA;AAAA,WACpB;AAAA,SACF;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,QAAQ,MAA+B,EAAA;AA9I/C,IAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AA+II,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,gDAAA,EAAmD,KAAK,eAAgB,EAAA,CAAA,CAAA;AAAA,OAC1E,CAAA;AAAA,KACF;AAEA,IAAM,MAAA,MAAA,GAAS,IAAI,YAAa,CAAA;AAAA,MAC9B,MAAA,EAAQ,KAAK,WAAY,CAAA,MAAA;AAAA,MACzB,MAAA;AAAA,KACD,CAAA,CAAA;AAED,IAAA,MAAM,QAAW,GAAA,SAAA;AAAA,MACf,CAAA,OAAA,KAAW,MAAO,CAAA,YAAA,CAAa,OAAO,CAAA;AAAA,MACtC;AAAA,QACE,KAAA,EAAO,KAAK,MAAO,CAAA,KAAA;AAAA,QACnB,IAAM,EAAA,CAAA;AAAA,QACN,QAAU,EAAA,EAAA;AAAA,OACZ;AAAA,KACF,CAAA;AAEA,IAAA,MAAM,GAAc,GAAA;AAAA,MAClB,OAAS,EAAA,CAAA;AAAA,MACT,SAAS,EAAC;AAAA,KACZ,CAAA;AAEA,IAAA,WAAA,MAAiB,WAAW,QAAU,EAAA;AACpC,MAAI,IAAA,CAAC,KAAK,MAAO,CAAA,cAAA,CAAe,MAAK,EAAQ,GAAA,OAAA,CAAA,mBAAA,KAAR,IAA+B,GAAA,EAAA,GAAA,EAAE,CAAG,EAAA;AACvE,QAAA,SAAA;AAAA,OACF;AAEA,MAAI,GAAA,CAAA,OAAA,EAAA,CAAA;AAEJ,MAAA,IAAI,QAAQ,QAAU,EAAA;AACpB,QAAA,SAAA;AAAA,OACF;AAEA,MAAA,IAAI,KAAK,MAAO,CAAA,MAAA,KAAW,GAAO,IAAA,OAAA,CAAQ,mBAAmB,KAAW,CAAA,EAAA;AACtE,QAAA,SAAA;AAAA,OACF;AAEA,MAAA,MAAM,cAAiB,GAAA,CAAA,EAAA,GAAA,OAAA,CAAQ,cAAR,KAAA,IAAA,GAAA,EAAA,GAA0B,KAAK,MAAO,CAAA,MAAA,CAAA;AAE7D,MAAM,MAAA,cAAA,GAA0B,MAAM,MAAO,CAAA,OAAA;AAAA,QAC3C,CAAA,EAAA,GAAA,OAAA,CAAQ,wBAAR,IAA+B,GAAA,EAAA,GAAA,EAAA;AAAA,QAC/B,cAAA;AAAA,QACA,KAAK,MAAO,CAAA,WAAA;AAAA,OACd,CAAA;AACA,MAAA,IAAI,cAAgB,EAAA;AAClB,QAAI,GAAA,CAAA,OAAA,CAAQ,KAAK,OAAO,CAAA,CAAA;AAAA,OAC1B;AAAA,KACF;AAEA,IAAM,MAAA,SAAA,GAAY,IAAI,OAAQ,CAAA,GAAA,CAAI,OAAK,IAAK,CAAA,kBAAA,CAAmB,CAAC,CAAC,CAAA,CAAA;AACjE,IAAM,MAAA,IAAA,CAAK,WAAW,aAAc,CAAA;AAAA,MAClC,IAAM,EAAA,MAAA;AAAA,MACN,QAAA,EAAU,SAAU,CAAA,GAAA,CAAI,CAAa,QAAA,MAAA;AAAA,QACnC,WAAA,EAAa,KAAK,eAAgB,EAAA;AAAA,QAClC,MAAQ,EAAAC,iDAAA,CAA6B,EAAE,QAAA,EAAU,CAAA;AAAA,OACjD,CAAA,CAAA;AAAA,KACH,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,mBAAmB,OAAsC,EAAA;AA7MnE,IAAA,IAAA,EAAA,CAAA;AA8MI,IAAA,MAAM,cAAiB,GAAA,CAAA,EAAA,GAAA,OAAA,CAAQ,cAAR,KAAA,IAAA,GAAA,EAAA,GAA0B,KAAK,MAAO,CAAA,MAAA,CAAA;AAC7D,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,KAAA;AAAA,MACN,QAAQ,CAAG,EAAA,OAAA,CAAQ,OAAkB,CAAA,QAAA,EAAA,cAAA,CAAA,CAAA,EAAkB,KAAK,MAAO,CAAA,WAAA,CAAA,CAAA;AAAA,MACnE,QAAU,EAAA,UAAA;AAAA,KACZ,CAAA;AAAA,GACF;AACF;;ACtLO,MAAM,6CAA6CC,oCAAoB,CAAA;AAAA,EAC5E,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,+BAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,MAAQ,EAAAC,iCAAA;AAAA,QACR,OAAS,EAAAC,iDAAA;AAAA,QACT,MAAQ,EAAAC,iCAAA;AAAA,QACR,SAAW,EAAAC,oCAAA;AAAA,OACb;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,QAAQ,OAAS,EAAA,MAAA,EAAQ,WAAa,EAAA;AACjD,QAAQ,OAAA,CAAA,iBAAA;AAAA,UACN,6BAAA,CAA8B,WAAW,MAAQ,EAAA;AAAA,YAC/C,MAAA,EAAQC,uCAAsB,MAAM,CAAA;AAAA,YACpC,SAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;;"}

package/dist/index.d.ts

@@ -1,32 +1,25 @@
+/**
+ * A Backstage catalog backend module that helps integrate towards GitLab
+ *
+ * @packageDocumentation
+ */
+
+import { BackendFeature } from '@backstage/backend-plugin-api';
+import { CatalogProcessor } from '@backstage/plugin-catalog-backend';
+import { CatalogProcessorEmit } from '@backstage/plugin-catalog-backend';
 import { Config } from '@backstage/config';
-import { CatalogProcessor, LocationSpec, CatalogProcessorEmit, EntityProvider, EntityProviderConnection } from '@backstage/plugin-catalog-backend';
+import { EntityProvider } from '@backstage/plugin-catalog-backend';
+import { EntityProviderConnection } from '@backstage/plugin-catalog-backend';
+import { LocationSpec } from '@backstage/plugin-catalog-backend';
 import { Logger } from 'winston';
+import { PluginTaskScheduler } from '@backstage/backend-tasks';
 import { TaskRunner } from '@backstage/backend-tasks';
 
-/**
- * Extracts repositories out of an GitLab instance.
- * @public
- */
-declare class GitLabDiscoveryProcessor implements CatalogProcessor {
-    private readonly integrations;
-    private readonly logger;
-    private readonly cache;
-    private readonly skipReposWithoutExactFileMatch;
-    static fromConfig(config: Config, options: {
-        logger: Logger;
-        skipReposWithoutExactFileMatch?: boolean;
-    }): GitLabDiscoveryProcessor;
-    private constructor();
-    getProcessorName(): string;
-    readLocation(location: LocationSpec, _optional: boolean, emit: CatalogProcessorEmit): Promise<boolean>;
-    private getCacheKey;
-}
-
 /**
  * Discovers entity definition files in the groups of a Gitlab instance.
  * @public
  */
-declare class GitlabDiscoveryEntityProvider implements EntityProvider {
+export declare class GitlabDiscoveryEntityProvider implements EntityProvider {
     private readonly config;
     private readonly integration;
     private readonly logger;
@@ -34,7 +27,8 @@ declare class GitlabDiscoveryEntityProvider implements EntityProvider {
     private connection?;
     static fromConfig(config: Config, options: {
         logger: Logger;
-        schedule: TaskRunner;
+        schedule?: TaskRunner;
+        scheduler?: PluginTaskScheduler;
     }): GitlabDiscoveryEntityProvider[];
     private constructor();
     getProviderName(): string;
@@ -44,4 +38,25 @@ declare class GitlabDiscoveryEntityProvider implements EntityProvider {
     private createLocationSpec;
 }
 
-export { GitLabDiscoveryProcessor, GitlabDiscoveryEntityProvider };
+/* Excluded from this release type: gitlabDiscoveryEntityProviderCatalogModule */
+
+/**
+ * Extracts repositories out of an GitLab instance.
+ * @public
+ */
+export declare class GitLabDiscoveryProcessor implements CatalogProcessor {
+    private readonly integrations;
+    private readonly logger;
+    private readonly cache;
+    private readonly skipReposWithoutExactFileMatch;
+    static fromConfig(config: Config, options: {
+        logger: Logger;
+        skipReposWithoutExactFileMatch?: boolean;
+    }): GitLabDiscoveryProcessor;
+    private constructor();
+    getProcessorName(): string;
+    readLocation(location: LocationSpec, _optional: boolean, emit: CatalogProcessorEmit): Promise<boolean>;
+    private getCacheKey;
+}
+
+export { }

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-gitlab",
   "description": "A Backstage catalog backend module that helps integrate towards GitLab",
-  "version": "0.1.8",
+  "version": "0.1.9-next.0",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
   "publishConfig": {
     "access": "public",
+    "alphaTypes": "dist/index.alpha.d.ts",
     "main": "dist/index.cjs.js",
     "types": "dist/index.d.ts"
   },
@@ -23,23 +24,25 @@
     "backstage"
   ],
   "scripts": {
-    "build": "backstage-cli package build",
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build --experimental-type-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",
-    "start": "backstage-cli package start"
+    "clean": "backstage-cli package clean"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.15.2",
-    "@backstage/backend-tasks": "^0.3.6",
-    "@backstage/catalog-model": "^1.1.2",
-    "@backstage/config": "^1.0.3",
-    "@backstage/errors": "^1.1.2",
-    "@backstage/integration": "^1.3.2",
-    "@backstage/plugin-catalog-backend": "^1.5.0",
-    "@backstage/types": "^1.0.0",
+    "@backstage/backend-common": "^0.16.0-next.0",
+    "@backstage/backend-plugin-api": "^0.1.4-next.0",
+    "@backstage/backend-tasks": "^0.3.7-next.0",
+    "@backstage/catalog-model": "^1.1.3-next.0",
+    "@backstage/config": "^1.0.4-next.0",
+    "@backstage/errors": "^1.1.3-next.0",
+    "@backstage/integration": "^1.4.0-next.0",
+    "@backstage/plugin-catalog-backend": "^1.5.1-next.0",
+    "@backstage/plugin-catalog-node": "^1.2.1-next.0",
+    "@backstage/types": "^1.0.1-next.0",
     "lodash": "^4.17.21",
     "msw": "^0.47.0",
     "node-fetch": "^2.6.7",
@@ -47,12 +50,16 @@
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.1.29",
-    "@backstage/cli": "^0.20.0",
+    "@backstage/backend-test-utils": "^0.1.30-next.0",
+    "@backstage/cli": "^0.21.0-next.0",
     "@types/lodash": "^4.14.151",
-    "@types/uuid": "^8.0.0"
+    "@types/uuid": "^8.0.0",
+    "luxon": "^3.0.0"
   },
   "files": [
+    "alpha",
+    "config.d.ts",
     "dist"
-  ]
+  ],
+  "configSchema": "config.d.ts"
 }