@pagerduty/backstage-plugin-backend 0.13.0 → 0.14.0

package/dist/services/syncLogsCleanup.cjs.js

@@ -0,0 +1,77 @@
+'use strict';
+
+const DEFAULTS = {
+  enabled: true,
+  retentionDays: 30,
+  maxRows: 5e5,
+  frequencyMinutes: 15,
+  batchSize: 1e4,
+  maxBatchesPerRun: 500
+};
+const CONFIG_ROOT = "pagerDuty.customFieldsSyncLogs";
+const SYNC_LOGS_CLEANUP_TASK_ID = "pagerduty-custom-field-sync-logs-cleanup";
+const SYNC_LOGS_CLEANUP_TIMEOUT_MINUTES = 10;
+const SYNC_LOGS_CLEANUP_INITIAL_DELAY_MINUTES = 1;
+function readSyncLogsCleanupConfig(config) {
+  const clamp = (value, fallback, min) => Math.max(Math.floor(value ?? fallback), min);
+  return {
+    enabled: config.getOptionalBoolean(`${CONFIG_ROOT}.cleanup.enabled`) ?? DEFAULTS.enabled,
+    retentionDays: clamp(
+      config.getOptionalNumber(`${CONFIG_ROOT}.retentionDays`),
+      DEFAULTS.retentionDays,
+      1
+    ),
+    maxRows: clamp(
+      config.getOptionalNumber(`${CONFIG_ROOT}.maxRows`),
+      DEFAULTS.maxRows,
+      1e3
+    ),
+    frequencyMinutes: clamp(
+      config.getOptionalNumber(`${CONFIG_ROOT}.cleanup.frequencyMinutes`),
+      DEFAULTS.frequencyMinutes,
+      1
+    ),
+    batchSize: clamp(
+      config.getOptionalNumber(`${CONFIG_ROOT}.cleanup.batchSize`),
+      DEFAULTS.batchSize,
+      100
+    ),
+    maxBatchesPerRun: clamp(
+      config.getOptionalNumber(`${CONFIG_ROOT}.cleanup.maxBatchesPerRun`),
+      DEFAULTS.maxBatchesPerRun,
+      1
+    )
+  };
+}
+async function runSyncLogsCleanup(options) {
+  const { store, logger, cleanupConfig } = options;
+  const startedAt = Date.now();
+  try {
+    const result = await store.cleanupSyncLogs({
+      olderThanDays: cleanupConfig.retentionDays,
+      maxRows: cleanupConfig.maxRows,
+      batchSize: cleanupConfig.batchSize,
+      maxBatchesPerRun: cleanupConfig.maxBatchesPerRun
+    });
+    const durationMs = Date.now() - startedAt;
+    logger.info(
+      `Sync log cleanup: deleted ${result.deletedByAge} expired and ${result.deletedByCap} over-cap row(s) in ${result.batchesUsed} batch(es) (${durationMs}ms)`
+    );
+    if (result.batchesUsed >= cleanupConfig.maxBatchesPerRun) {
+      logger.warn(
+        `Sync log cleanup exhausted its batch budget (${cleanupConfig.maxBatchesPerRun} batches of ${cleanupConfig.batchSize}); a backlog remains. To catch up faster, increase pagerDuty.customFieldsSyncLogs.cleanup.maxBatchesPerRun or decrease pagerDuty.customFieldsSyncLogs.cleanup.frequencyMinutes.`
+      );
+    }
+  } catch (error) {
+    logger.error(
+      `Sync log cleanup failed: ${error instanceof Error ? error.message : String(error)}`
+    );
+  }
+}
+
+exports.SYNC_LOGS_CLEANUP_INITIAL_DELAY_MINUTES = SYNC_LOGS_CLEANUP_INITIAL_DELAY_MINUTES;
+exports.SYNC_LOGS_CLEANUP_TASK_ID = SYNC_LOGS_CLEANUP_TASK_ID;
+exports.SYNC_LOGS_CLEANUP_TIMEOUT_MINUTES = SYNC_LOGS_CLEANUP_TIMEOUT_MINUTES;
+exports.readSyncLogsCleanupConfig = readSyncLogsCleanupConfig;
+exports.runSyncLogsCleanup = runSyncLogsCleanup;
+//# sourceMappingURL=syncLogsCleanup.cjs.js.map

package/dist/services/syncLogsCleanup.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"syncLogsCleanup.cjs.js","sources":["../../src/services/syncLogsCleanup.ts"],"sourcesContent":["import {\n  LoggerService,\n  RootConfigService,\n} from '@backstage/backend-plugin-api';\nimport { PagerDutyBackendStore } from '../db';\n\nexport interface SyncLogsCleanupConfig {\n  enabled: boolean;\n  retentionDays: number;\n  maxRows: number;\n  frequencyMinutes: number;\n  batchSize: number;\n  maxBatchesPerRun: number;\n}\n\nconst DEFAULTS: SyncLogsCleanupConfig = {\n  enabled: true,\n  retentionDays: 30,\n  maxRows: 500_000,\n  frequencyMinutes: 15,\n  batchSize: 10_000,\n  maxBatchesPerRun: 500,\n};\n\nconst CONFIG_ROOT = 'pagerDuty.customFieldsSyncLogs';\n\nexport const SYNC_LOGS_CLEANUP_TASK_ID =\n  'pagerduty-custom-field-sync-logs-cleanup';\nexport const SYNC_LOGS_CLEANUP_TIMEOUT_MINUTES = 10;\nexport const SYNC_LOGS_CLEANUP_INITIAL_DELAY_MINUTES = 1;\n\nexport function readSyncLogsCleanupConfig(\n  config: RootConfigService,\n): SyncLogsCleanupConfig {\n  const clamp = (value: number | undefined, fallback: number, min: number) =>\n    Math.max(Math.floor(value ?? fallback), min);\n\n  return {\n    enabled:\n      config.getOptionalBoolean(`${CONFIG_ROOT}.cleanup.enabled`) ??\n      DEFAULTS.enabled,\n    retentionDays: clamp(\n      config.getOptionalNumber(`${CONFIG_ROOT}.retentionDays`),\n      DEFAULTS.retentionDays,\n      1,\n    ),\n    maxRows: clamp(\n      config.getOptionalNumber(`${CONFIG_ROOT}.maxRows`),\n      DEFAULTS.maxRows,\n      1000,\n    ),\n    frequencyMinutes: clamp(\n      config.getOptionalNumber(`${CONFIG_ROOT}.cleanup.frequencyMinutes`),\n      DEFAULTS.frequencyMinutes,\n      1,\n    ),\n    batchSize: clamp(\n      config.getOptionalNumber(`${CONFIG_ROOT}.cleanup.batchSize`),\n      DEFAULTS.batchSize,\n      100,\n    ),\n    maxBatchesPerRun: clamp(\n      config.getOptionalNumber(`${CONFIG_ROOT}.cleanup.maxBatchesPerRun`),\n      DEFAULTS.maxBatchesPerRun,\n      1,\n    ),\n  };\n}\n\nexport async function runSyncLogsCleanup(options: {\n  store: PagerDutyBackendStore;\n  logger: LoggerService;\n  cleanupConfig: SyncLogsCleanupConfig;\n}): Promise<void> {\n  const { store, logger, cleanupConfig } = options;\n  const startedAt = Date.now();\n\n  try {\n    const result = await store.cleanupSyncLogs({\n      olderThanDays: cleanupConfig.retentionDays,\n      maxRows: cleanupConfig.maxRows,\n      batchSize: cleanupConfig.batchSize,\n      maxBatchesPerRun: cleanupConfig.maxBatchesPerRun,\n    });\n\n    const durationMs = Date.now() - startedAt;\n    logger.info(\n      `Sync log cleanup: deleted ${result.deletedByAge} expired and ${result.deletedByCap} over-cap row(s) in ${result.batchesUsed} batch(es) (${durationMs}ms)`,\n    );\n\n    if (result.batchesUsed >= cleanupConfig.maxBatchesPerRun) {\n      logger.warn(\n        `Sync log cleanup exhausted its batch budget (${cleanupConfig.maxBatchesPerRun} batches of ${cleanupConfig.batchSize}); ` +\n          `a backlog remains. To catch up faster, increase pagerDuty.customFieldsSyncLogs.cleanup.maxBatchesPerRun ` +\n          `or decrease pagerDuty.customFieldsSyncLogs.cleanup.frequencyMinutes.`,\n      );\n    }\n  } catch (error) {\n    // A failed cleanup must never crash the backend; the scheduler retries on\n    // the next cycle.\n    logger.error(\n      `Sync log cleanup failed: ${\n        error instanceof Error ? error.message : String(error)\n      }`,\n    );\n  }\n}\n"],"names":[],"mappings":";;AAeA,MAAM,QAAA,GAAkC;AAAA,EACtC,OAAA,EAAS,IAAA;AAAA,EACT,aAAA,EAAe,EAAA;AAAA,EACf,OAAA,EAAS,GAAA;AAAA,EACT,gBAAA,EAAkB,EAAA;AAAA,EAClB,SAAA,EAAW,GAAA;AAAA,EACX,gBAAA,EAAkB;AACpB,CAAA;AAEA,MAAM,WAAA,GAAc,gCAAA;AAEb,MAAM,yBAAA,GACX;AACK,MAAM,iCAAA,GAAoC;AAC1C,MAAM,uCAAA,GAA0C;AAEhD,SAAS,0BACd,MAAA,EACuB;AACvB,EAAA,MAAM,KAAA,GAAQ,CAAC,KAAA,EAA2B,QAAA,EAAkB,GAAA,KAC1D,IAAA,CAAK,GAAA,CAAI,IAAA,CAAK,KAAA,CAAM,KAAA,IAAS,QAAQ,CAAA,EAAG,GAAG,CAAA;AAE7C,EAAA,OAAO;AAAA,IACL,SACE,MAAA,CAAO,kBAAA,CAAmB,GAAG,WAAW,CAAA,gBAAA,CAAkB,KAC1D,QAAA,CAAS,OAAA;AAAA,IACX,aAAA,EAAe,KAAA;AAAA,MACb,MAAA,CAAO,iBAAA,CAAkB,CAAA,EAAG,WAAW,CAAA,cAAA,CAAgB,CAAA;AAAA,MACvD,QAAA,CAAS,aAAA;AAAA,MACT;AAAA,KACF;AAAA,IACA,OAAA,EAAS,KAAA;AAAA,MACP,MAAA,CAAO,iBAAA,CAAkB,CAAA,EAAG,WAAW,CAAA,QAAA,CAAU,CAAA;AAAA,MACjD,QAAA,CAAS,OAAA;AAAA,MACT;AAAA,KACF;AAAA,IACA,gBAAA,EAAkB,KAAA;AAAA,MAChB,MAAA,CAAO,iBAAA,CAAkB,CAAA,EAAG,WAAW,CAAA,yBAAA,CAA2B,CAAA;AAAA,MAClE,QAAA,CAAS,gBAAA;AAAA,MACT;AAAA,KACF;AAAA,IACA,SAAA,EAAW,KAAA;AAAA,MACT,MAAA,CAAO,iBAAA,CAAkB,CAAA,EAAG,WAAW,CAAA,kBAAA,CAAoB,CAAA;AAAA,MAC3D,QAAA,CAAS,SAAA;AAAA,MACT;AAAA,KACF;AAAA,IACA,gBAAA,EAAkB,KAAA;AAAA,MAChB,MAAA,CAAO,iBAAA,CAAkB,CAAA,EAAG,WAAW,CAAA,yBAAA,CAA2B,CAAA;AAAA,MAClE,QAAA,CAAS,gBAAA;AAAA,MACT;AAAA;AACF,GACF;AACF;AAEA,eAAsB,mBAAmB,OAAA,EAIvB;AAChB,EAAA,MAAM,EAAE,KAAA,EAAO,MAAA,EAAQ,aAAA,EAAc,GAAI,OAAA;AACzC,EAAA,MAAM,SAAA,GAAY,KAAK,GAAA,EAAI;AAE3B,EAAA,IAAI;AACF,IAAA,MAAM,MAAA,GAAS,MAAM,KAAA,CAAM,eAAA,CAAgB;AAAA,MACzC,eAAe,aAAA,CAAc,aAAA;AAAA,MAC7B,SAAS,aAAA,CAAc,OAAA;AAAA,MACvB,WAAW,aAAA,CAAc,SAAA;AAAA,MACzB,kBAAkB,aAAA,CAAc;AAAA,KACjC,CAAA;AAED,IAAA,MAAM,UAAA,GAAa,IAAA,CAAK,GAAA,EAAI,GAAI,SAAA;AAChC,IAAA,MAAA,CAAO,IAAA;AAAA,MACL,CAAA,0BAAA,EAA6B,MAAA,CAAO,YAAY,CAAA,aAAA,EAAgB,MAAA,CAAO,YAAY,CAAA,oBAAA,EAAuB,MAAA,CAAO,WAAW,CAAA,YAAA,EAAe,UAAU,CAAA,GAAA;AAAA,KACvJ;AAEA,IAAA,IAAI,MAAA,CAAO,WAAA,IAAe,aAAA,CAAc,gBAAA,EAAkB;AACxD,MAAA,MAAA,CAAO,IAAA;AAAA,QACL,CAAA,6CAAA,EAAgD,aAAA,CAAc,gBAAgB,CAAA,YAAA,EAAe,cAAc,SAAS,CAAA,+KAAA;AAAA,OAGtH;AAAA,IACF;AAAA,EACF,SAAS,KAAA,EAAO;AAGd,IAAA,MAAA,CAAO,KAAA;AAAA,MACL,4BACE,KAAA,YAAiB,KAAA,GAAQ,MAAM,OAAA,GAAU,MAAA,CAAO,KAAK,CACvD,CAAA;AAAA,KACF;AAAA,EACF;AACF;;;;;;;;"}

package/migrations/20260225113251_add_pagerduty_custom_fields_table.js

@@ -0,0 +1,31 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+
+
+exports.up = async function up(knex) {
+  return knex.schema.createTable('pagerduty_custom_fields', table => {
+    table.increments('id').primary();
+    table.string('pagerdutyCustomFieldId').notNullable();
+    table.string('pagerdutyCustomFieldDisplayName').notNullable();
+    table.boolean('pagerdutyCustomFieldEnabled').notNullable().defaultTo(true);
+    table.string('backstageEntityMappingPath').notNullable();
+    table.string('pagerdutySubdomain').notNullable();
+    table.string('description');
+    table.index(['pagerdutyCustomFieldId'], 'pagerduty_custom_field_id_idx');
+    table.dateTime('updatedAt').defaultTo(knex.fn.now());
+    table.dateTime('createdAt').defaultTo(knex.fn.now());
+  });
+};
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = async function down(knex) {
+  await knex.schema.alterTable('pagerduty_custom_fields', table => {
+    table.dropIndex([], 'pagerduty_custom_field_id_idx');
+  });
+  return knex.schema.dropTable('pagerduty_custom_fields');
+};

package/migrations/20260313_add_custom_fields_unique_indexes.js

@@ -0,0 +1,27 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = async function up(knex) {
+  await knex.schema.alterTable('pagerduty_custom_fields', table => {
+    table.unique(
+      ['backstageEntityMappingPath', 'pagerdutySubdomain'],
+      { indexName: 'pagerduty_cf_entitypath_subdomain_unique' },
+    );
+    table.unique(
+      ['pagerdutyCustomFieldDisplayName', 'pagerdutySubdomain'],
+      { indexName: 'pagerduty_cf_displayname_subdomain_unique' },
+    );
+  });
+};
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = async function down(knex) {
+  await knex.schema.alterTable('pagerduty_custom_fields', table => {
+    table.dropUnique([], 'pagerduty_cf_entitypath_subdomain_unique');
+    table.dropUnique([], 'pagerduty_cf_displayname_subdomain_unique');
+  });
+};

package/migrations/20260515_add_custom_field_sync_logs_table.js

@@ -0,0 +1,32 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = async function up(knex) {
+  return knex.schema.createTable('pagerduty_custom_field_sync_logs', table => {
+    table.increments('id').primary();
+    table.dateTime('timestamp').notNullable().defaultTo(knex.fn.now());
+    table.string('errorCode').notNullable();
+    table.string('customFieldId').notNullable();
+    table.string('customFieldName').notNullable();
+    table.string('entityPath').notNullable();
+    table.string('serviceId').notNullable();
+    table.string('serviceName').notNullable();
+    table.text('errorMessage').notNullable();
+    table.string('subdomain').notNullable();
+    table.index(['subdomain', 'timestamp'], 'sync_logs_subdomain_timestamp_idx');
+    table.index(['serviceId'], 'sync_logs_service_id_idx');
+  });
+};
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = async function down(knex) {
+  await knex.schema.alterTable('pagerduty_custom_field_sync_logs', table => {
+    table.dropIndex([], 'sync_logs_subdomain_timestamp_idx');
+    table.dropIndex([], 'sync_logs_service_id_idx');
+  });
+  return knex.schema.dropTable('pagerduty_custom_field_sync_logs');
+};

package/migrations/20260612_add_sync_logs_timestamp_index.js

@@ -0,0 +1,19 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = async function up(knex) {
+  return knex.schema.alterTable('pagerduty_custom_field_sync_logs', table => {
+    table.index(['timestamp'], 'sync_logs_timestamp_idx');
+  });
+};
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = async function down(knex) {
+  return knex.schema.alterTable('pagerduty_custom_field_sync_logs', table => {
+    table.dropIndex([], 'sync_logs_timestamp_idx');
+  });
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pagerduty/backstage-plugin-backend",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -37,10 +37,10 @@
     "postpack": "backstage-cli package postpack"
   },
   "dependencies": {
-    "@backstage/backend-defaults": "^0.15.1",
-    "@backstage/backend-plugin-api": "^1.6.2",
-    "@backstage/catalog-client": "^1.12.1",
-    "@pagerduty/backstage-plugin-common": "~0.4.0",
+    "@backstage/backend-defaults": "^0.17.2",
+    "@backstage/backend-plugin-api": "^1.9.1",
+    "@backstage/catalog-client": "^1.15.2",
+    "@pagerduty/backstage-plugin-common": "~0.5.0",
     "@skyra/jaro-winkler": "^1.1.1",
     "@types/express": "^4.17.6",
     "express": "^4.20.0",
@@ -51,8 +51,8 @@
     "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^1.10.4",
-    "@backstage/cli": "^0.35.3",
+    "@backstage/backend-test-utils": "^1.11.3",
+    "@backstage/cli": "^0.36.2",
     "jest-mock": "^30.0.2",
     "supertest": "^7.1.3"
   },