@pagerduty/backstage-plugin-backend 0.13.0 → 0.14.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @pagerduty/backstage-plugin-backend
 
+## 0.14.0
+
+### Minor Changes
+
+- bee64f1: Release the service mappings feature
+
+### Patch Changes
+
+- Updated dependencies [bee64f1]
+  - @pagerduty/backstage-plugin-common@0.5.0
+
 ## 0.13.0
 
 ### Minor Changes

package/config.d.ts

@@ -50,5 +50,48 @@ export interface Config {
      * @deepVisibility secret
      */
     accounts?: PagerDutyAccountConfig[];
+    /**
+     * Optional retention and cleanup settings for custom field sync logs.
+     * @visibility backend
+     */
+    customFieldsSyncLogs?: {
+      /**
+       * Number of days to keep sync logs before they are deleted. Defaults to 30.
+       * @visibility backend
+       */
+      retentionDays?: number;
+      /**
+       * Maximum number of sync log rows to keep across all accounts; the
+       * oldest rows beyond this count are deleted. Defaults to 500000.
+       * @visibility backend
+       */
+      maxRows?: number;
+      /**
+       * Settings for the scheduled cleanup task.
+       * @visibility backend
+       */
+      cleanup?: {
+        /**
+         * Whether the scheduled cleanup task runs. Defaults to true.
+         * @visibility backend
+         */
+        enabled?: boolean;
+        /**
+         * How often the cleanup task runs, in minutes. Defaults to 15.
+         * @visibility backend
+         */
+        frequencyMinutes?: number;
+        /**
+         * Number of rows deleted per batch. Defaults to 10000.
+         * @visibility backend
+         */
+        batchSize?: number;
+        /**
+         * Maximum number of delete batches per run. Defaults to 500.
+         * @visibility backend
+         */
+        maxBatchesPerRun?: number;
+      };
+    };
   };
 }

package/dist/apis/pagerduty.cjs.js

@@ -102,6 +102,31 @@ async function getDefaultHeaders(account) {
     "X-PagerDuty-Client": clientHeader
   };
 }
+const SERVICES_CACHE_TTL_MS = 20 * 60 * 1e3;
+const ALL_SERVICES_CACHE_KEY = "pagerduty:services:all";
+const serviceCacheKey = (serviceId, account) => `pagerduty:service:${account || "default"}:${serviceId}`;
+async function readCache(cache, key) {
+  if (!cache) {
+    return void 0;
+  }
+  return await cache.get(key);
+}
+async function writeCache(cache, key, value) {
+  if (!cache) {
+    return;
+  }
+  await cache.set(
+    key,
+    value,
+    { ttl: SERVICES_CACHE_TTL_MS }
+  );
+}
+async function deleteCache(cache, key) {
+  if (!cache) {
+    return;
+  }
+  await cache.delete(key);
+}
 async function addServiceRelationsToService(serviceRelations, account) {
   let response;
   const options = {
@@ -219,7 +244,7 @@ async function getServiceRelationshipsById(serviceId, account) {
     headers: await getDefaultHeaders(account)
   };
   const apiBaseUrl = getApiBaseUrl(account);
-  const baseUrl = `${apiBaseUrl}/service_dependencies/technical_services/${serviceId}`;
+  const baseUrl = `${apiBaseUrl}/service_dependencies/technical_services/${encodeURIComponent(serviceId)}`;
   try {
     response = await fetchWithRetries(baseUrl, options);
   } catch (error) {
@@ -502,7 +527,12 @@ async function getOncallUsers(escalationPolicy, account) {
     throw new backstagePluginCommon.HttpError(`Failed to parse oncall information: ${error}`, 500);
   }
 }
-async function getServiceById(serviceId, account) {
+async function getServiceById(serviceId, account, cache, logger) {
+  const cacheKey = serviceCacheKey(serviceId, account);
+  const cached = await readCache(cache, cacheKey);
+  if (cached) {
+    return cached;
+  }
   let response;
   const params = `time_zone=UTC&include[]=integrations&include[]=escalation_policies`;
   const options = {
@@ -513,7 +543,7 @@ async function getServiceById(serviceId, account) {
   const baseUrl = `${apiBaseUrl}/services`;
   try {
     response = await fetchWithRetries(
-      `${baseUrl}/${serviceId}?${params}`,
+      `${baseUrl}/${encodeURIComponent(serviceId)}?${params}`,
       options
     );
   } catch (error) {
@@ -550,12 +580,21 @@ async function getServiceById(serviceId, account) {
   let result;
   try {
     result = await response.json();
+    await writeCache(cache, serviceCacheKey(serviceId, account), result.service);
     return result.service;
   } catch (error) {
     throw new backstagePluginCommon.HttpError(`Failed to parse service information: ${error}`, 500);
   }
 }
-async function getSerivcesByIdsAndAccount(serviceIds, account) {
+const SERVICE_IDS_BATCH_SIZE = 50;
+const SERVICE_ID_PATTERN = /^[A-Z0-9]{6,}$/;
+function isValidServiceId(id) {
+  if (typeof id !== "string") {
+    return false;
+  }
+  return SERVICE_ID_PATTERN.test(id.trim());
+}
+async function getServicesByIdsBatch(serviceIds, account) {
   let response;
   const token = await auth.getAuthToken(account);
   const options = {
@@ -568,11 +607,11 @@ async function getSerivcesByIdsAndAccount(serviceIds, account) {
   };
   const apiBaseUrl = getApiBaseUrl(account);
   const baseUrl = `${apiBaseUrl}/services`;
+  const params = new URLSearchParams();
+  serviceIds.forEach((id) => params.append("id[]", id));
+  params.append("limit", String(SERVICE_IDS_BATCH_SIZE));
   try {
-    response = await fetchWithRetries(
-      `${baseUrl}?id[]=${serviceIds.join("&id[]=")}`,
-      options
-    );
+    response = await fetchWithRetries(`${baseUrl}?${params}`, options);
   } catch (error) {
     throw new Error(`Failed to retrieve service: ${error}`);
   }
@@ -584,10 +623,7 @@ async function getSerivcesByIdsAndAccount(serviceIds, account) {
   }
   switch (response.status) {
     case 400:
-      throw new backstagePluginCommon.HttpError(
-        "Failed to get service. Caller provided invalid arguments.",
-        400
-      );
+      return [];
     case 401:
       throw new backstagePluginCommon.HttpError(
         "Failed to get service. Caller did not supply credentials or did not provide the correct credentials.",
@@ -612,6 +648,24 @@ async function getSerivcesByIdsAndAccount(serviceIds, account) {
     throw new backstagePluginCommon.HttpError(`Failed to parse service information: ${error}`, 500);
   }
 }
+async function getSerivcesByIdsAndAccount(serviceIds, account) {
+  const sanitizedServiceIds = Array.from(
+    new Set(
+      serviceIds.map((id) => typeof id === "string" ? id.trim() : "").filter((id) => isValidServiceId(id))
+    )
+  );
+  if (sanitizedServiceIds.length === 0) {
+    return [];
+  }
+  const batches = [];
+  for (let i = 0; i < sanitizedServiceIds.length; i += SERVICE_IDS_BATCH_SIZE) {
+    batches.push(sanitizedServiceIds.slice(i, i + SERVICE_IDS_BATCH_SIZE));
+  }
+  const results = await Promise.all(
+    batches.map((batch) => getServicesByIdsBatch(batch, account))
+  );
+  return results.flat();
+}
 async function getServiceByIntegrationKey(integrationKey, account) {
   let response;
   const params = `query=${integrationKey}&time_zone=UTC&include[]=integrations&include[]=escalation_policies`;
@@ -669,15 +723,21 @@ async function getServiceByIntegrationKey(integrationKey, account) {
   return result.services[0];
 }
 async function getServicesByIds(ids) {
-  let services = [];
-  await Promise.all(
-    Object.entries(EndpointConfig).map(async ([account, _]) => {
-      services = await getSerivcesByIdsAndAccount(ids, account);
-    })
+  const servicesPerAccount = await Promise.all(
+    Object.keys(EndpointConfig).map(
+      (account) => getSerivcesByIdsAndAccount(ids, account)
+    )
   );
-  return services;
+  return servicesPerAccount.flat();
 }
-async function getAllServices() {
+async function getAllServices(cache) {
+  const cached = await readCache(
+    cache,
+    ALL_SERVICES_CACHE_KEY
+  );
+  if (cached !== void 0) {
+    return cached;
+  }
   const allServices = [];
   await Promise.all(
     Object.entries(EndpointConfig).map(async ([account, _]) => {
@@ -733,6 +793,12 @@ async function getAllServices() {
       }
     })
   );
+  await writeCache(cache, ALL_SERVICES_CACHE_KEY, allServices);
+  await Promise.all(
+    allServices.map(
+      (service) => writeCache(cache, serviceCacheKey(service.id, service.account), service)
+    )
+  );
   return allServices;
 }
 async function getServicesByPartialName(partialName) {
@@ -874,7 +940,7 @@ async function getChangeEvents(serviceId, account) {
   const baseUrl = `${apiBaseUrl}/services`;
   try {
     response = await fetchWithRetries(
-      `${baseUrl}/${serviceId}/change_events?${params}`,
+      `${baseUrl}/${encodeURIComponent(serviceId)}/change_events?${params}`,
       options
     );
   } catch (error) {
@@ -921,7 +987,7 @@ async function getChangeEvents(serviceId, account) {
 }
 async function getIncidents(serviceId, account) {
   let response;
-  const params = `time_zone=UTC&sort_by=created_at&statuses[]=triggered&statuses[]=acknowledged&service_ids[]=${serviceId}`;
+  const params = `time_zone=UTC&sort_by=created_at&statuses[]=triggered&statuses[]=acknowledged&service_ids[]=${encodeURIComponent(serviceId)}`;
   const options = {
     method: "GET",
     headers: await getDefaultHeaders(account)
@@ -981,7 +1047,7 @@ async function getServiceStandards(serviceId, account) {
     headers: await getDefaultHeaders(account)
   };
   const apiBaseUrl = getApiBaseUrl(account);
-  const baseUrl = `${apiBaseUrl}/standards/scores/technical_services/${serviceId}`;
+  const baseUrl = `${apiBaseUrl}/standards/scores/technical_services/${encodeURIComponent(serviceId)}`;
   try {
     response = await fetchWithRetries(baseUrl, options);
   } catch (error) {
@@ -1076,7 +1142,8 @@ async function getServiceMetrics(serviceId, account) {
 async function createServiceIntegration({
   serviceId,
   vendorId,
-  account
+  account,
+  cache
 }) {
   let response;
   const apiBaseUrl = getApiBaseUrl(account);
@@ -1100,7 +1167,7 @@ async function createServiceIntegration({
   };
   try {
     response = await fetchWithRetries(
-      `${baseUrl}/${serviceId}/integrations`,
+      `${baseUrl}/${encodeURIComponent(serviceId)}/integrations`,
       options
     );
   } catch (error) {
@@ -1132,12 +1199,41 @@ async function createServiceIntegration({
   let result;
   try {
     result = await response.json();
+    await deleteCache(cache, serviceCacheKey(serviceId, account));
+    await deleteCache(cache, ALL_SERVICES_CACHE_KEY);
     return result.integration.integration_key ?? "";
   } catch (error) {
     throw new Error(`Failed to parse service information: ${error}`);
   }
 }
+function getAllowedApiOrigins() {
+  const origins = /* @__PURE__ */ new Set();
+  const addOrigin = (apiBaseUrl) => {
+    if (!apiBaseUrl) {
+      return;
+    }
+    try {
+      origins.add(new URL(apiBaseUrl).origin);
+    } catch {
+    }
+  };
+  Object.values(EndpointConfig).forEach((cfg) => addOrigin(cfg.apiBaseUrl));
+  addOrigin(fallbackEndpointConfig?.apiBaseUrl);
+  origins.add("https://api.pagerduty.com");
+  return origins;
+}
 async function fetchWithRetries(url, options) {
+  let requestOrigin;
+  try {
+    requestOrigin = new URL(url).origin;
+  } catch {
+    throw new Error("Refusing to fetch invalid URL.");
+  }
+  if (!getAllowedApiOrigins().has(requestOrigin)) {
+    throw new Error(
+      `Refusing to fetch URL with disallowed origin: ${requestOrigin}`
+    );
+  }
   let response;
   let error = new Error();
   const maxRetries = 5;
@@ -1158,9 +1254,250 @@ async function fetchWithRetries(url, options) {
     `Failed to fetch data after ${maxRetries} retries. Last error: ${error}`
   );
 }
+async function createCustomField({
+  request,
+  account
+}) {
+  let response;
+  const apiBaseUrl = getApiBaseUrl(account);
+  const baseUrl = `${apiBaseUrl}/services/custom_fields`;
+  const token = await auth.getAuthToken(account);
+  const options = {
+    method: "POST",
+    body: JSON.stringify(request),
+    headers: {
+      Authorization: token,
+      Accept: "application/vnd.pagerduty+json;version=2",
+      "Content-Type": "application/json"
+    }
+  };
+  try {
+    response = await fetchWithRetries(baseUrl, options);
+  } catch (error) {
+    throw new Error(`Failed to create custom field: ${error}`);
+  }
+  if (response.status >= 500) {
+    throw new backstagePluginCommon.HttpError(
+      `Failed to create custom field. PagerDuty API returned a server error.`,
+      response.status
+    );
+  }
+  switch (response.status) {
+    case 400: {
+      const errorData = await response.json().catch(() => ({}));
+      throw new backstagePluginCommon.HttpError(
+        `Failed to create custom field. Invalid arguments: ${JSON.stringify(errorData)}`,
+        400
+      );
+    }
+    case 401:
+      throw new backstagePluginCommon.HttpError(
+        `Failed to create custom field. Invalid credentials provided.`,
+        401
+      );
+    case 403:
+      throw new backstagePluginCommon.HttpError(
+        `Failed to create custom field. Not authorized to perform this action.`,
+        403
+      );
+    case 409: {
+      const errorData = await response.json().catch(() => ({}));
+      throw new backstagePluginCommon.HttpError(
+        `Custom field with this name already exists: ${JSON.stringify(errorData)}`,
+        409
+      );
+    }
+    case 429:
+      throw new backstagePluginCommon.HttpError(`Rate limit exceeded.`, 429);
+  }
+  try {
+    const result = await response.json();
+    return result;
+  } catch (error) {
+    throw new Error(`Failed to parse custom field response: ${error}`);
+  }
+}
+async function updateCustomField({
+  fieldId,
+  request,
+  account
+}) {
+  const apiBaseUrl = getApiBaseUrl(account);
+  const baseUrl = `${apiBaseUrl}/services/custom_fields/${encodeURIComponent(fieldId)}`;
+  const token = await auth.getAuthToken(account);
+  const options = {
+    method: "PUT",
+    body: JSON.stringify(request),
+    headers: {
+      Authorization: token,
+      Accept: "application/vnd.pagerduty+json;version=2",
+      "Content-Type": "application/json"
+    }
+  };
+  let response;
+  try {
+    response = await fetchWithRetries(baseUrl, options);
+  } catch (error) {
+    throw new Error(`Failed to update custom field: ${error}`);
+  }
+  if (response.status >= 500) {
+    throw new backstagePluginCommon.HttpError(
+      `Failed to update custom field. PagerDuty API returned a server error.`,
+      response.status
+    );
+  }
+  switch (response.status) {
+    case 400: {
+      const errorData = await response.json().catch(() => ({}));
+      throw new backstagePluginCommon.HttpError(
+        `Failed to update custom field. Invalid arguments: ${JSON.stringify(errorData)}`,
+        400
+      );
+    }
+    case 401:
+      throw new backstagePluginCommon.HttpError(
+        `Failed to update custom field. Invalid credentials provided.`,
+        401
+      );
+    case 403:
+      throw new backstagePluginCommon.HttpError(
+        `Failed to update custom field. Not authorized to perform this action.`,
+        403
+      );
+    case 404:
+      throw new backstagePluginCommon.HttpError(
+        `Failed to update custom field. Custom field not found.`,
+        404
+      );
+    case 409: {
+      const errorData = await response.json().catch(() => ({}));
+      throw new backstagePluginCommon.HttpError(
+        `Custom field with this name already exists: ${JSON.stringify(errorData)}`,
+        409
+      );
+    }
+    case 429:
+      throw new backstagePluginCommon.HttpError(`Rate limit exceeded.`, 429);
+  }
+  try {
+    const result = await response.json();
+    return result;
+  } catch (error) {
+    throw new Error(`Failed to parse custom field response: ${error}`);
+  }
+}
+async function deleteCustomField({
+  fieldId,
+  account
+}) {
+  const apiBaseUrl = getApiBaseUrl(account);
+  const baseUrl = `${apiBaseUrl}/services/custom_fields/${encodeURIComponent(fieldId)}`;
+  const token = await auth.getAuthToken(account);
+  const options = {
+    method: "DELETE",
+    headers: {
+      Authorization: token,
+      Accept: "application/vnd.pagerduty+json;version=2"
+    }
+  };
+  let response;
+  try {
+    response = await fetchWithRetries(baseUrl, options);
+  } catch (error) {
+    throw new Error(`Failed to delete custom field: ${error}`);
+  }
+  if (response.status >= 500) {
+    throw new backstagePluginCommon.HttpError(
+      `Failed to delete custom field. PagerDuty API returned a server error.`,
+      response.status
+    );
+  }
+  switch (response.status) {
+    case 401:
+      throw new backstagePluginCommon.HttpError(
+        `Failed to delete custom field. Invalid credentials provided.`,
+        401
+      );
+    case 403:
+      throw new backstagePluginCommon.HttpError(
+        `Failed to delete custom field. Caller is not authorized to delete this custom field.`,
+        403
+      );
+    case 404:
+      throw new backstagePluginCommon.HttpError(`Custom field not found.`, 404);
+    case 429:
+      throw new backstagePluginCommon.HttpError(`Rate limit exceeded.`, 429);
+  }
+}
+async function setServiceCustomFieldValues({
+  serviceId,
+  request,
+  account
+}) {
+  const apiBaseUrl = getApiBaseUrl(account);
+  const baseUrl = `${apiBaseUrl}/services/${encodeURIComponent(serviceId)}/custom_fields/values`;
+  const token = await auth.getAuthToken(account);
+  const options = {
+    method: "PUT",
+    body: JSON.stringify(request),
+    headers: {
+      Authorization: token,
+      Accept: "application/vnd.pagerduty+json;version=2",
+      "Content-Type": "application/json"
+    }
+  };
+  let response;
+  try {
+    response = await fetchWithRetries(baseUrl, options);
+  } catch (error) {
+    throw new Error(`Failed to set service custom field values: ${error}`);
+  }
+  if (response.status >= 500) {
+    throw new backstagePluginCommon.HttpError(
+      `Failed to set service custom field values. PagerDuty API returned a server error.`,
+      response.status
+    );
+  }
+  switch (response.status) {
+    case 400: {
+      const errorData = await response.json().catch(() => ({}));
+      throw new backstagePluginCommon.HttpError(
+        `Failed to set service custom field values. Invalid arguments: ${JSON.stringify(errorData)}`,
+        400
+      );
+    }
+    case 401:
+      throw new backstagePluginCommon.HttpError(
+        `Failed to set service custom field values. Invalid credentials provided.`,
+        401
+      );
+    case 403:
+      throw new backstagePluginCommon.HttpError(
+        `Failed to set service custom field values. Not authorized to perform this action.`,
+        403
+      );
+    case 404:
+      throw new backstagePluginCommon.HttpError(
+        `Failed to set service custom field values. Service or custom field not found.`,
+        404
+      );
+    case 429:
+      throw new backstagePluginCommon.HttpError(`Rate limit exceeded.`, 429);
+  }
+  try {
+    const result = await response.json();
+    return result;
+  } catch (error) {
+    throw new Error(
+      `Failed to parse set service custom field values response: ${error}`
+    );
+  }
+}
 
 exports.addServiceRelationsToService = addServiceRelationsToService;
+exports.createCustomField = createCustomField;
 exports.createServiceIntegration = createServiceIntegration;
+exports.deleteCustomField = deleteCustomField;
 exports.fetchWithRetries = fetchWithRetries;
 exports.getAllEscalationPolicies = getAllEscalationPolicies;
 exports.getAllServices = getAllServices;
@@ -1178,7 +1515,10 @@ exports.getServiceStandards = getServiceStandards;
 exports.getServicesByIds = getServicesByIds;
 exports.getServicesByPartialName = getServicesByPartialName;
 exports.insertAccountConfig = insertAccountConfig;
+exports.isValidServiceId = isValidServiceId;
 exports.loadPagerDutyEndpointsFromConfig = loadPagerDutyEndpointsFromConfig;
 exports.removeServiceRelationsFromService = removeServiceRelationsFromService;
 exports.setFallbackAccountConfig = setFallbackAccountConfig;
+exports.setServiceCustomFieldValues = setServiceCustomFieldValues;
+exports.updateCustomField = updateCustomField;
 //# sourceMappingURL=pagerduty.cjs.js.map