@backstage/plugin-catalog-backend-module-gitlab 0.3.15 → 0.3.16

package/CHANGELOG.md

@@ -1,5 +1,57 @@
 # @backstage/plugin-catalog-backend-module-gitlab
 
+## 0.3.16
+
+### Patch Changes
+
+- a70377d: Added events support for `GitlabDiscoveryEntityProvider` and `GitlabOrgDiscoveryEntityProvider`.
+- Updated dependencies
+  - @backstage/plugin-catalog-node@1.12.0
+  - @backstage/catalog-model@1.5.0
+  - @backstage/backend-common@0.22.0
+  - @backstage/backend-plugin-api@0.6.18
+  - @backstage/backend-tasks@0.5.23
+  - @backstage/plugin-events-node@0.3.4
+  - @backstage/integration@1.11.0
+  - @backstage/plugin-catalog-common@1.0.23
+
+## 0.3.15-next.4
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-node@1.12.0-next.2
+  - @backstage/backend-common@0.22.0-next.2
+  - @backstage/plugin-events-node@0.3.4-next.2
+  - @backstage/integration@1.11.0-next.0
+
+## 0.3.15-next.3
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.22.0-next.1
+  - @backstage/backend-tasks@0.5.23-next.1
+  - @backstage/plugin-events-node@0.3.4-next.1
+  - @backstage/plugin-catalog-node@1.11.2-next.1
+  - @backstage/backend-plugin-api@0.6.18-next.1
+
+## 0.3.15-next.2
+
+### Patch Changes
+
+- a70377d: Added events support for `GitlabDiscoveryEntityProvider` and `GitlabOrgDiscoveryEntityProvider`.
+- Updated dependencies
+  - @backstage/catalog-model@1.5.0-next.0
+  - @backstage/backend-common@0.21.8-next.0
+  - @backstage/backend-plugin-api@0.6.18-next.0
+  - @backstage/plugin-catalog-common@1.0.23-next.0
+  - @backstage/plugin-catalog-node@1.11.2-next.0
+  - @backstage/backend-tasks@0.5.23-next.0
+  - @backstage/config@1.2.0
+  - @backstage/integration@1.10.0
+  - @backstage/plugin-events-node@0.3.4-next.0
+
 ## 0.3.15
 
 ### Patch Changes
@@ -385,8 +437,8 @@
 
   ref:
 
-  https://docs.gitlab.com/ee/user/enterprise_user/#get-users-email-addresses-through-the-api
-  https://docs.gitlab.com/ee/api/members.html#limitations
+  <https://docs.gitlab.com/ee/user/enterprise_user/#get-users-email-addresses-through-the-api>
+  <https://docs.gitlab.com/ee/api/members.html#limitations>
 
 - 890e3b5ad4: Make sure to include the error message when ingestion fails
 - 0b55f773a7: Removed some unused dependencies
@@ -417,8 +469,8 @@
 
   ref:
 
-  https://docs.gitlab.com/ee/user/enterprise_user/#get-users-email-addresses-through-the-api
-  https://docs.gitlab.com/ee/api/members.html#limitations
+  <https://docs.gitlab.com/ee/user/enterprise_user/#get-users-email-addresses-through-the-api>
+  <https://docs.gitlab.com/ee/api/members.html#limitations>
 
 - 0b55f773a7: Removed some unused dependencies
 - Updated dependencies
@@ -1211,7 +1263,7 @@
 - 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
+  <https://backstage.io/docs/integrations/gitlab/discovery>
 
 - 4c9f7847e4: Updated dependency `msw` to `^0.48.0` while moving it to be a dev dependency.
 - Updated dependencies
@@ -1250,7 +1302,7 @@
 - 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
+  <https://backstage.io/docs/integrations/gitlab/discovery>
 
 - Updated dependencies
   - @backstage/backend-common@0.16.0-next.0

package/alpha/package.json

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

package/dist/alpha.cjs.js

@@ -4,14 +4,16 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var alpha = require('@backstage/plugin-catalog-node/alpha');
-var GitlabDiscoveryEntityProvider = require('./cjs/GitlabDiscoveryEntityProvider-CfW32ioU.cjs.js');
+var pluginEventsNode = require('@backstage/plugin-events-node');
+var GitlabDiscoveryEntityProvider = require('./cjs/GitlabDiscoveryEntityProvider-OBHXu4pm.cjs.js');
 require('@backstage/catalog-model');
 require('@backstage/integration');
 require('lodash');
 require('uuid');
-require('node-fetch');
 require('@backstage/backend-tasks');
+require('node-fetch');
 require('@backstage/plugin-catalog-node');
+require('path');
 
 const catalogModuleGitlabDiscoveryEntityProvider = backendPluginApi.createBackendModule({
   pluginId: "catalog",
@@ -22,15 +24,16 @@ const catalogModuleGitlabDiscoveryEntityProvider = backendPluginApi.createBacken
         config: backendPluginApi.coreServices.rootConfig,
         catalog: alpha.catalogProcessingExtensionPoint,
         logger: backendPluginApi.coreServices.logger,
-        scheduler: backendPluginApi.coreServices.scheduler
+        scheduler: backendPluginApi.coreServices.scheduler,
+        events: pluginEventsNode.eventsServiceRef
       },
-      async init({ config, catalog, logger, scheduler }) {
-        catalog.addEntityProvider(
-          GitlabDiscoveryEntityProvider.GitlabDiscoveryEntityProvider.fromConfig(config, {
-            logger,
-            scheduler
-          })
-        );
+      async init({ config, catalog, logger, scheduler, events }) {
+        const gitlabDiscoveryEntityProvider = GitlabDiscoveryEntityProvider.GitlabDiscoveryEntityProvider.fromConfig(config, {
+          logger,
+          events,
+          scheduler
+        });
+        catalog.addEntityProvider(gitlabDiscoveryEntityProvider);
       }
     });
   }

package/dist/alpha.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.cjs.js","sources":["../src/module/catalogModuleGitlabDiscoveryEntityProvider.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\nimport { GitlabDiscoveryEntityProvider } from '../providers';\n\n/**\n * Registers the GitlabDiscoveryEntityProvider with the catalog processing extension point.\n *\n * @alpha\n */\nexport const catalogModuleGitlabDiscoveryEntityProvider = createBackendModule({\n  pluginId: 'catalog',\n  moduleId: 'gitlab-discovery-entity-provider',\n  register(env) {\n    env.registerInit({\n      deps: {\n        config: coreServices.rootConfig,\n        catalog: catalogProcessingExtensionPoint,\n        logger: coreServices.logger,\n        scheduler: coreServices.scheduler,\n      },\n      async init({ config, catalog, logger, scheduler }) {\n        catalog.addEntityProvider(\n          GitlabDiscoveryEntityProvider.fromConfig(config, {\n            logger,\n            scheduler,\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","coreServices","catalogProcessingExtensionPoint","GitlabDiscoveryEntityProvider"],"mappings":";;;;;;;;;;;;;;;AA4BO,MAAM,6CAA6CA,oCAAoB,CAAA;AAAA,EAC5E,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,kCAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,OAAS,EAAAC,qCAAA;AAAA,QACT,QAAQD,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,OAC1B;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,QAAQ,OAAS,EAAA,MAAA,EAAQ,WAAa,EAAA;AACjD,QAAQ,OAAA,CAAA,iBAAA;AAAA,UACNE,2DAAA,CAA8B,WAAW,MAAQ,EAAA;AAAA,YAC/C,MAAA;AAAA,YACA,SAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}
+{"version":3,"file":"alpha.cjs.js","sources":["../src/module/catalogModuleGitlabDiscoveryEntityProvider.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\nimport { eventsServiceRef } from '@backstage/plugin-events-node';\nimport { GitlabDiscoveryEntityProvider } from '../providers';\n\n/**\n * Registers the GitlabDiscoveryEntityProvider with the catalog processing extension point.\n *\n * @alpha\n */\n\nexport const catalogModuleGitlabDiscoveryEntityProvider = createBackendModule({\n  pluginId: 'catalog',\n  moduleId: 'gitlab-discovery-entity-provider',\n  register(env) {\n    env.registerInit({\n      deps: {\n        config: coreServices.rootConfig,\n        catalog: catalogProcessingExtensionPoint,\n        logger: coreServices.logger,\n        scheduler: coreServices.scheduler,\n        events: eventsServiceRef,\n      },\n      async init({ config, catalog, logger, scheduler, events }) {\n        const gitlabDiscoveryEntityProvider =\n          GitlabDiscoveryEntityProvider.fromConfig(config, {\n            logger,\n            events,\n            scheduler,\n          });\n        catalog.addEntityProvider(gitlabDiscoveryEntityProvider);\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","coreServices","catalogProcessingExtensionPoint","eventsServiceRef","GitlabDiscoveryEntityProvider"],"mappings":";;;;;;;;;;;;;;;;;AA8BO,MAAM,6CAA6CA,oCAAoB,CAAA;AAAA,EAC5E,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,kCAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,OAAS,EAAAC,qCAAA;AAAA,QACT,QAAQD,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,MAAQ,EAAAE,iCAAA;AAAA,OACV;AAAA,MACA,MAAM,KAAK,EAAE,MAAA,EAAQ,SAAS,MAAQ,EAAA,SAAA,EAAW,QAAU,EAAA;AACzD,QAAM,MAAA,6BAAA,GACJC,2DAA8B,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,UAC/C,MAAA;AAAA,UACA,MAAA;AAAA,UACA,SAAA;AAAA,SACD,CAAA,CAAA;AACH,QAAA,OAAA,CAAQ,kBAAkB,6BAA6B,CAAA,CAAA;AAAA,OACzD;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}

package/dist/cjs/{GitlabDiscoveryEntityProvider-CfW32ioU.cjs.js → GitlabDiscoveryEntityProvider-OBHXu4pm.cjs.js}

@@ -3,8 +3,9 @@
 var integration = require('@backstage/integration');
 var pluginCatalogNode = require('@backstage/plugin-catalog-node');
 var uuid = require('uuid');
-var fetch = require('node-fetch');
 var backendTasks = require('@backstage/backend-tasks');
+var fetch = require('node-fetch');
+var path = require('path');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -28,6 +29,55 @@ function _interopNamespaceCompat(e) {
 
 var uuid__namespace = /*#__PURE__*/_interopNamespaceCompat(uuid);
 var fetch__default = /*#__PURE__*/_interopDefaultCompat(fetch);
+var path__namespace = /*#__PURE__*/_interopNamespaceCompat(path);
+
+function readGitlabConfig(id, config) {
+  var _a, _b, _c, _d, _e, _f, _g, _h, _i;
+  const group = (_a = config.getOptionalString("group")) != null ? _a : "";
+  const host = config.getString("host");
+  const branch = config.getOptionalString("branch");
+  const fallbackBranch = (_b = config.getOptionalString("fallbackBranch")) != null ? _b : "master";
+  const catalogFile = (_c = config.getOptionalString("entityFilename")) != null ? _c : "catalog-info.yaml";
+  const projectPattern = new RegExp(
+    (_d = config.getOptionalString("projectPattern")) != null ? _d : /[\s\S]*/
+  );
+  const userPattern = new RegExp(
+    (_e = config.getOptionalString("userPattern")) != null ? _e : /[\s\S]*/
+  );
+  const groupPattern = new RegExp(
+    (_f = config.getOptionalString("groupPattern")) != null ? _f : /[\s\S]*/
+  );
+  const orgEnabled = (_g = config.getOptionalBoolean("orgEnabled")) != null ? _g : false;
+  const allowInherited = (_h = config.getOptionalBoolean("allowInherited")) != null ? _h : false;
+  const skipForkedRepos = (_i = config.getOptionalBoolean("skipForkedRepos")) != null ? _i : false;
+  const schedule = config.has("schedule") ? backendTasks.readTaskScheduleDefinitionFromConfig(config.getConfig("schedule")) : void 0;
+  return {
+    id,
+    group,
+    branch,
+    fallbackBranch,
+    host,
+    catalogFile,
+    projectPattern,
+    userPattern,
+    groupPattern,
+    schedule,
+    orgEnabled,
+    allowInherited,
+    skipForkedRepos
+  };
+}
+function readGitlabConfigs(config) {
+  const configs = [];
+  const providerConfigs = config.getOptionalConfig("catalog.providers.gitlab");
+  if (!providerConfigs) {
+    return configs;
+  }
+  for (const id of providerConfigs.keys()) {
+    configs.push(readGitlabConfig(id, providerConfigs.getConfig(id)));
+  }
+  return configs;
+}
 
 var __defProp$1 = Object.defineProperty;
 var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
@@ -60,6 +110,21 @@ class GitLabClient {
     }
     return this.pagedRequest(`/projects`, options);
   }
+  async getProjectById(projectId, options) {
+    const response = await this.nonPagedRequest(
+      `/projects/${projectId}`,
+      options
+    );
+    return response;
+  }
+  async getGroupById(groupId, options) {
+    const response = await this.nonPagedRequest(`/groups/${groupId}`, options);
+    return response;
+  }
+  async getUserById(userId, options) {
+    const response = await this.nonPagedRequest(`/users/${userId}`, options);
+    return response;
+  }
   async listUsers(options) {
     return this.pagedRequest(`/users?`, {
       ...options,
@@ -279,8 +344,11 @@ class GitLabClient {
   async pagedRequest(endpoint, options) {
     const request = new URL(`${this.config.apiBaseUrl}${endpoint}`);
     for (const key in options) {
-      if (options[key] !== void 0 && options[key] !== "") {
-        request.searchParams.append(key, options[key].toString());
+      if (options.hasOwnProperty(key)) {
+        const value = options[key];
+        if (value !== void 0 && value !== "") {
+          request.searchParams.append(key, value.toString());
+        }
       }
     }
     this.logger.debug(`Fetching: ${request.toString()}`);
@@ -301,6 +369,27 @@ class GitLabClient {
       };
     });
   }
+  async nonPagedRequest(endpoint, options) {
+    const request = new URL(`${this.config.apiBaseUrl}${endpoint}`);
+    for (const key in options) {
+      if (options.hasOwnProperty(key)) {
+        const value = options[key];
+        if (value !== void 0 && value !== "") {
+          request.searchParams.append(key, value.toString());
+        }
+      }
+    }
+    const response = await fetch__default.default(
+      request.toString(),
+      integration.getGitLabRequestOptions(this.config)
+    );
+    if (!response.ok) {
+      throw new Error(
+        `Unexpected response when fetching ${request.toString()}. Expected 200 but got ${response.status} - ${response.statusText}`
+      );
+    }
+    return response.json();
+  }
 }
 async function* paginated(request, options) {
   let res;
@@ -313,71 +402,38 @@ async function* paginated(request, options) {
   } while (res.nextPage);
 }
 
-function readGitlabConfig(id, config) {
-  var _a, _b, _c, _d, _e, _f, _g, _h;
-  const group = (_a = config.getOptionalString("group")) != null ? _a : "";
-  const host = config.getString("host");
-  const branch = config.getOptionalString("branch");
-  const fallbackBranch = (_b = config.getOptionalString("fallbackBranch")) != null ? _b : "master";
-  const catalogFile = (_c = config.getOptionalString("entityFilename")) != null ? _c : "catalog-info.yaml";
-  const projectPattern = new RegExp(
-    (_d = config.getOptionalString("projectPattern")) != null ? _d : /[\s\S]*/
-  );
-  const userPattern = new RegExp(
-    (_e = config.getOptionalString("userPattern")) != null ? _e : /[\s\S]*/
-  );
-  const groupPattern = new RegExp(
-    (_f = config.getOptionalString("groupPattern")) != null ? _f : /[\s\S]*/
-  );
-  const orgEnabled = (_g = config.getOptionalBoolean("orgEnabled")) != null ? _g : false;
-  const skipForkedRepos = (_h = config.getOptionalBoolean("skipForkedRepos")) != null ? _h : false;
-  const schedule = config.has("schedule") ? backendTasks.readTaskScheduleDefinitionFromConfig(config.getConfig("schedule")) : void 0;
-  return {
-    id,
-    group,
-    branch,
-    fallbackBranch,
-    host,
-    catalogFile,
-    projectPattern,
-    userPattern,
-    groupPattern,
-    schedule,
-    orgEnabled,
-    skipForkedRepos
-  };
-}
-function readGitlabConfigs(config) {
-  const configs = [];
-  const providerConfigs = config.getOptionalConfig("catalog.providers.gitlab");
-  if (!providerConfigs) {
-    return configs;
-  }
-  for (const id of providerConfigs.keys()) {
-    configs.push(readGitlabConfig(id, providerConfigs.getConfig(id)));
-  }
-  return configs;
-}
-
 var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField = (obj, key, value) => {
   __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
+const TOPIC_REPO_PUSH = "gitlab.push";
 class GitlabDiscoveryEntityProvider {
+  /**
+   * Constructs a GitlabDiscoveryEntityProvider instance.
+   *
+   * @param options - Configuration options including config, integration, logger, and taskRunner.
+   */
   constructor(options) {
     __publicField(this, "config");
     __publicField(this, "integration");
     __publicField(this, "logger");
     __publicField(this, "scheduleFn");
     __publicField(this, "connection");
+    __publicField(this, "events");
+    __publicField(this, "gitLabClient");
     this.config = options.config;
     this.integration = options.integration;
     this.logger = options.logger.child({
       target: this.getProviderName()
     });
     this.scheduleFn = this.createScheduleFn(options.taskRunner);
+    this.events = options.events;
+    this.gitLabClient = new GitLabClient({
+      config: this.integration.config,
+      logger: this.logger
+    });
   }
   static fromConfig(config, options) {
     if (!options.schedule && !options.scheduler) {
@@ -417,7 +473,25 @@ class GitlabDiscoveryEntityProvider {
   async connect(connection) {
     this.connection = connection;
     await this.scheduleFn();
+    if (this.events) {
+      await this.events.subscribe({
+        id: this.getProviderName(),
+        topics: [TOPIC_REPO_PUSH],
+        onEvent: async (params) => {
+          if (params.topic !== TOPIC_REPO_PUSH) {
+            return;
+          }
+          await this.onRepoPush(params.eventPayload);
+        }
+      });
+    }
   }
+  /**
+   * Creates a scheduled task runner for refreshing the entity provider.
+   *
+   * @param taskRunner - The task runner instance.
+   * @returns The scheduled function.
+   */
   createScheduleFn(taskRunner) {
     return async () => {
       const taskId = `${this.getProviderName()}:refresh`;
@@ -441,19 +515,19 @@ class GitlabDiscoveryEntityProvider {
       });
     };
   }
+  /**
+   * Performs a full scan on the GitLab instance searching for locations to be ingested
+   *
+   * @param logger - The logger instance for logging.
+   */
   async refresh(logger) {
-    var _a, _b, _c, _d;
     if (!this.connection) {
       throw new Error(
         `Gitlab discovery connection not initialized for ${this.getProviderName()}`
       );
     }
-    const client = new GitLabClient({
-      config: this.integration.config,
-      logger
-    });
     const projects = paginated(
-      (options) => client.listProjects(options),
+      (options) => this.gitLabClient.listProjects(options),
       {
         archived: false,
         group: this.config.group,
@@ -466,27 +540,15 @@ class GitlabDiscoveryEntityProvider {
       matches: []
     };
     for await (const project of projects) {
-      if (!this.config.projectPattern.test((_a = project.path_with_namespace) != null ? _a : "")) {
-        continue;
-      }
-      res.scanned++;
-      if (this.config.skipForkedRepos && project.hasOwnProperty("forked_from_project")) {
-        continue;
-      }
-      if (!this.config.branch && this.config.fallbackBranch === "*" && project.default_branch === void 0) {
-        continue;
-      }
-      const project_branch = (_c = (_b = this.config.branch) != null ? _b : project.default_branch) != null ? _c : this.config.fallbackBranch;
-      const projectHasFile = await client.hasFile(
-        (_d = project.path_with_namespace) != null ? _d : "",
-        project_branch,
-        this.config.catalogFile
-      );
-      if (projectHasFile) {
+      if (await this.shouldProcessProject(project, this.gitLabClient)) {
+        res.scanned++;
         res.matches.push(project);
       }
     }
     const locations = res.matches.map((p) => this.createLocationSpec(p));
+    logger.info(
+      `Processed ${locations.length} from scanned ${res.scanned} projects.`
+    );
     await this.connection.applyMutation({
       type: "full",
       entities: locations.map((location) => ({
@@ -504,10 +566,184 @@ class GitlabDiscoveryEntityProvider {
       presence: "optional"
     };
   }
+  /**
+   * Handles the "gitlab.push" event.
+   *
+   * @param event - The push event payload.
+   */
+  async onRepoPush(event) {
+    var _a, _b;
+    if (!this.connection) {
+      throw new Error(
+        `Gitlab discovery connection not initialized for ${this.getProviderName()}`
+      );
+    }
+    this.logger.info(
+      `Received push event for ${event.project.path_with_namespace}`
+    );
+    const project = await this.gitLabClient.getProjectById(event.project_id);
+    if (!project) {
+      this.logger.debug(
+        `Ignoring push event for ${event.project.path_with_namespace}`
+      );
+      return;
+    }
+    if (!await this.shouldProcessProject(project, this.gitLabClient)) {
+      this.logger.debug(`Skipping event ${event.project.path_with_namespace}`);
+      return;
+    }
+    const added = this.getFilesMatchingConfig(
+      event,
+      "added",
+      this.config.catalogFile
+    );
+    const removed = this.getFilesMatchingConfig(
+      event,
+      "removed",
+      this.config.catalogFile
+    );
+    const modified = this.getFilesMatchingConfig(
+      event,
+      "modified",
+      this.config.catalogFile
+    );
+    const addedEntities = this.createLocationSpecCommitedFiles(
+      event.project,
+      added
+    );
+    const removedEntities = this.createLocationSpecCommitedFiles(
+      event.project,
+      removed
+    );
+    if (addedEntities.length > 0 || removedEntities.length > 0) {
+      await this.connection.applyMutation({
+        type: "delta",
+        added: this.toDeferredEntities(
+          addedEntities.map((entity) => entity.target)
+        ),
+        removed: this.toDeferredEntities(
+          removedEntities.map((entity) => entity.target)
+        )
+      });
+    }
+    if (modified.length > 0) {
+      const projectBranch = (_b = (_a = this.config.branch) != null ? _a : event.project.default_branch) != null ? _b : this.config.fallbackBranch;
+      await this.connection.refresh({
+        keys: [
+          ...modified.map(
+            (filePath) => `url:${event.project.web_url}/-/tree/${projectBranch}/${filePath}`
+          ),
+          ...modified.map(
+            (filePath) => `url:${event.project.web_url}/-/blob/${projectBranch}/${filePath}`
+          )
+        ]
+      });
+    }
+    this.logger.info(
+      `Processed GitLab push event from ${event.project.web_url}: added ${added.length} - removed ${removed.length} - modified ${modified.length}`
+    );
+  }
+  /**
+   * Gets files matching the specified commit action and catalog file name.
+   *
+   * @param event - The push event payload.
+   * @param action - The action type ('added', 'removed', or 'modified').
+   * @param catalogFile - The catalog file name.
+   * @returns An array of file paths.
+   */
+  getFilesMatchingConfig(event, action, catalogFile) {
+    if (!event.commits) {
+      return [];
+    }
+    const matchingFiles = event.commits.flatMap(
+      (element) => element[action].filter(
+        (file) => path__namespace.basename(file) === catalogFile
+      )
+    );
+    if (matchingFiles.length === 0) {
+      this.logger.debug(
+        `No files matching '${catalogFile}' found in the commits.`
+      );
+    }
+    return matchingFiles;
+  }
+  /**
+   * Creates Backstage location specs for committed files.
+   *
+   * @param project - The GitLab project information.
+   * @param addedFiles - The array of added file paths.
+   * @returns An array of location specs.
+   */
+  createLocationSpecCommitedFiles(project, addedFiles) {
+    var _a, _b;
+    const projectBranch = (_b = (_a = this.config.branch) != null ? _a : project.default_branch) != null ? _b : this.config.fallbackBranch;
+    const matchingFiles = addedFiles.filter(
+      (file) => path__namespace.basename(file) === this.config.catalogFile
+    );
+    const locationSpecs = matchingFiles.map((file) => ({
+      type: "url",
+      target: `${project.web_url}/-/blob/${projectBranch}/${file}`,
+      presence: "optional"
+    }));
+    return locationSpecs;
+  }
+  /**
+   * Converts a target URL to a LocationSpec object.
+   *
+   * @param {string} target - The target URL to be converted.
+   * @returns {LocationSpec} The LocationSpec object representing the URL.
+   */
+  toLocationSpec(target) {
+    return {
+      type: "url",
+      target,
+      presence: "optional"
+    };
+  }
+  toDeferredEntities(targets) {
+    return targets.map((target) => {
+      const location = this.toLocationSpec(target);
+      return pluginCatalogNode.locationSpecToLocationEntity({ location });
+    }).map((entity) => {
+      return {
+        locationKey: this.getProviderName(),
+        entity
+      };
+    });
+  }
+  async shouldProcessProject(project, client) {
+    var _a, _b, _c, _d, _e;
+    if (!this.config.projectPattern.test((_a = project.path_with_namespace) != null ? _a : "")) {
+      this.logger.debug(
+        `Skipping project ${project.path_with_namespace} as it does not match the project pattern ${this.config.projectPattern}.`
+      );
+      return false;
+    }
+    if (this.config.group && !project.path_with_namespace.startsWith(`${this.config.group}/`)) {
+      this.logger.debug(
+        `Skipping project ${project.path_with_namespace} as it does not match the group pattern ${this.config.group}.`
+      );
+      return false;
+    }
+    if (this.config.skipForkedRepos && project.hasOwnProperty("forked_from_project")) {
+      this.logger.debug(
+        `Skipping project ${project.path_with_namespace} as it is a forked project.`
+      );
+      return false;
+    }
+    const customFallbackBranch = this.config.fallbackBranch !== "master" ? this.config.fallbackBranch : void 0;
+    const project_branch = (_d = (_c = (_b = this.config.branch) != null ? _b : customFallbackBranch) != null ? _c : project.default_branch) != null ? _d : this.config.fallbackBranch;
+    const hasFile = await client.hasFile(
+      (_e = project.path_with_namespace) != null ? _e : "",
+      project_branch,
+      this.config.catalogFile
+    );
+    return hasFile;
+  }
 }
 
 exports.GitLabClient = GitLabClient;
 exports.GitlabDiscoveryEntityProvider = GitlabDiscoveryEntityProvider;
 exports.paginated = paginated;
 exports.readGitlabConfigs = readGitlabConfigs;
-//# sourceMappingURL=GitlabDiscoveryEntityProvider-CfW32ioU.cjs.js.map
+//# sourceMappingURL=GitlabDiscoveryEntityProvider-OBHXu4pm.cjs.js.map