@pagerduty/backstage-plugin-backend 0.10.3 → 0.12.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @pagerduty/backstage-plugin-backend
 
+## 0.12.0
+
+### Minor Changes
+
+- ae2a9c3: Refactor the service mappings screen and add an auto-matching functionality to mass map PagerDuty service to Backstage entities
+
+### Patch Changes
+
+- Updated dependencies [ae2a9c3]
+  - @pagerduty/backstage-plugin-common@0.3.0
+
+## 0.11.0
+
+### Minor Changes
+
+- dae278a: Add auto-matching algorithm for mapping PagerDuty services to Backstage components
+
+### Patch Changes
+
+- 821f4e2: Include x-pagerduty-client header in PagerDuty API requests
+- 47afbbc: Make changesets mandatory for all the packages
+- Updated dependencies [47afbbc]
+  - @pagerduty/backstage-plugin-common@0.2.6
+
 ## 0.10.3
 
 ### Patch Changes

package/dist/apis/pagerduty.cjs.js

@@ -12,25 +12,33 @@ var fetch__default = /*#__PURE__*/_interopDefaultCompat(fetch);
 const EndpointConfig = {};
 let fallbackEndpointConfig;
 let isLegacyConfig = false;
-function setFallbackEndpointConfig(account) {
+const SubdomainConfig = {};
+let fallbackSubdomain;
+function setFallbackAccountConfig(account) {
   fallbackEndpointConfig = {
     eventsBaseUrl: account.eventsBaseUrl ?? "https://events.pagerduty.com/v2",
     apiBaseUrl: account.apiBaseUrl ?? "https://api.pagerduty.com"
   };
+  if (account.oauth?.subDomain) {
+    fallbackSubdomain = account.oauth.subDomain;
+  }
 }
-function insertEndpointConfig(account) {
+function insertAccountConfig(account) {
   EndpointConfig[account.id] = {
     eventsBaseUrl: account.eventsBaseUrl ?? "https://events.pagerduty.com/v2",
     apiBaseUrl: account.apiBaseUrl ?? "https://api.pagerduty.com"
   };
+  if (account.oauth?.subDomain) {
+    SubdomainConfig[account.id] = account.oauth.subDomain;
+  }
 }
 function loadPagerDutyEndpointsFromConfig(config, logger) {
-  if (config.getOptional("pagerDuty.accounts")) {
+  const accounts = config.getOptional("pagerDuty.accounts");
+  if (accounts) {
     logger.debug(
       `New accounts configuration detected. Loading PagerDuty endpoints from config.`
     );
     isLegacyConfig = false;
-    const accounts = config.getOptional("pagerDuty.accounts");
     if (accounts?.length === 1) {
       logger.debug(
         `Single account configuration detected. Loading PagerDuty endpoints from config to 'default'.`
@@ -39,15 +47,18 @@ function loadPagerDutyEndpointsFromConfig(config, logger) {
         eventsBaseUrl: accounts[0].eventsBaseUrl !== void 0 ? accounts[0].eventsBaseUrl : "https://events.pagerduty.com/v2",
         apiBaseUrl: accounts[0].apiBaseUrl !== void 0 ? accounts[0].apiBaseUrl : "https://api.pagerduty.com"
       };
+      if (accounts[0].oauth?.subDomain) {
+        SubdomainConfig.default = accounts[0].oauth.subDomain;
+      }
     } else {
       logger.debug(
         `Multiple account configuration detected. Loading PagerDuty endpoints from config.`
       );
       accounts?.forEach((account) => {
         if (account.isDefault) {
-          setFallbackEndpointConfig(account);
+          setFallbackAccountConfig(account);
         }
-        insertEndpointConfig(account);
+        insertAccountConfig(account);
       });
     }
   } else {
@@ -57,6 +68,10 @@ function loadPagerDutyEndpointsFromConfig(config, logger) {
       eventsBaseUrl: config.getOptionalString("pagerDuty.eventsBaseUrl") !== void 0 ? config.getString("pagerDuty.eventsBaseUrl") : "https://events.pagerduty.com/v2",
       apiBaseUrl: config.getOptionalString("pagerDuty.apiBaseUrl") !== void 0 ? config.getString("pagerDuty.apiBaseUrl") : "https://api.pagerduty.com"
     };
+    const legacySubdomain = config.getOptionalString("pagerDuty.oauth.subDomain");
+    if (legacySubdomain) {
+      SubdomainConfig.default = legacySubdomain;
+    }
   }
 }
 function getApiBaseUrl(account) {
@@ -68,15 +83,30 @@ function getApiBaseUrl(account) {
   }
   return fallbackEndpointConfig.apiBaseUrl;
 }
+function getSubdomain(account) {
+  if (isLegacyConfig === true) {
+    return SubdomainConfig.default;
+  }
+  if (account && account !== "default") {
+    return SubdomainConfig[account] ?? fallbackSubdomain ?? SubdomainConfig.default;
+  }
+  return fallbackSubdomain ?? SubdomainConfig.default;
+}
+async function getDefaultHeaders(account) {
+  const subdomain = getSubdomain(account);
+  const clientHeader = `"Backstage" <https://${subdomain}.backstage.com>`;
+  return {
+    Authorization: await auth.getAuthToken(account),
+    Accept: "application/vnd.pagerduty+json;version=2",
+    "Content-Type": "application/json",
+    "X-PagerDuty-Client": clientHeader
+  };
+}
 async function addServiceRelationsToService(serviceRelations, account) {
   let response;
   const options = {
     method: "POST",
-    headers: {
-      Authorization: await auth.getAuthToken(account),
-      Accept: "application/vnd.pagerduty+json;version=2",
-      "Content-Type": "application/json"
-    },
+    headers: await getDefaultHeaders(account),
     body: JSON.stringify({
       relationships: serviceRelations
     })
@@ -131,11 +161,7 @@ async function removeServiceRelationsFromService(serviceRelations, account) {
   let response;
   const options = {
     method: "POST",
-    headers: {
-      Authorization: await auth.getAuthToken(account),
-      Accept: "application/vnd.pagerduty+json;version=2",
-      "Content-Type": "application/json"
-    },
+    headers: await getDefaultHeaders(account),
     body: JSON.stringify({
       relationships: serviceRelations
     })
@@ -190,11 +216,7 @@ async function getServiceRelationshipsById(serviceId, account) {
   let response;
   const options = {
     method: "GET",
-    headers: {
-      Authorization: await auth.getAuthToken(account),
-      Accept: "application/vnd.pagerduty+json;version=2",
-      "Content-Type": "application/json"
-    }
+    headers: await getDefaultHeaders(account)
   };
   const apiBaseUrl = getApiBaseUrl(account);
   const baseUrl = `${apiBaseUrl}/service_dependencies/technical_services/${serviceId}`;
@@ -247,11 +269,7 @@ async function getEscalationPolicies(offset, limit, account) {
   const params = `total=true&sort_by=name&offset=${offset}&limit=${limit}`;
   const options = {
     method: "GET",
-    headers: {
-      Authorization: await auth.getAuthToken(account),
-      Accept: "application/vnd.pagerduty+json;version=2",
-      "Content-Type": "application/json"
-    }
+    headers: await getDefaultHeaders(account)
   };
   const apiBaseUrl = getApiBaseUrl(account);
   const baseUrl = `${apiBaseUrl}/escalation_policies`;
@@ -332,9 +350,9 @@ async function getAllEscalationPolicies() {
   );
   return results;
 }
-async function getOncallUsers(escalationPolicy, account) {
+async function getTeams(offset, limit, account) {
   let response;
-  const params = `time_zone=UTC&include[]=users&escalation_policy_ids[]=${escalationPolicy}`;
+  const params = `total=true&sort_by=name&offset=${offset}&limit=${limit}`;
   const options = {
     method: "GET",
     headers: {
@@ -344,6 +362,88 @@ async function getOncallUsers(escalationPolicy, account) {
     }
   };
   const apiBaseUrl = getApiBaseUrl(account);
+  const baseUrl = `${apiBaseUrl}/teams`;
+  try {
+    response = await fetchWithRetries(`${baseUrl}?${params}`, options);
+  } catch (error) {
+    throw new Error(`Failed to retrieve teams: ${error}`);
+  }
+  if (response.status >= 500) {
+    throw new backstagePluginCommon.HttpError(
+      `Failed to list teams. PagerDuty API returned a server error. Retrying with the same arguments will not work.`,
+      response.status
+    );
+  }
+  switch (response.status) {
+    case 400:
+      throw new backstagePluginCommon.HttpError(
+        "Failed to list teams. Caller provided invalid arguments.",
+        400
+      );
+    case 401:
+      throw new backstagePluginCommon.HttpError(
+        "Failed to list teams. Caller did not supply credentials or did not provide the correct credentials.",
+        401
+      );
+    case 403:
+      throw new backstagePluginCommon.HttpError(
+        "Failed to list teams. Caller is not authorized to view the requested resource.",
+        403
+      );
+    case 429:
+      throw new backstagePluginCommon.HttpError("Failed to list teams. Rate limit exceeded.", 429);
+  }
+  let result;
+  try {
+    result = await response.json();
+    return [result.more ?? false, result.teams];
+  } catch (error) {
+    throw new backstagePluginCommon.HttpError(`Failed to parse team information: ${error}`, 500);
+  }
+}
+async function getAllTeams(account) {
+  const limit = 50;
+  let offset = 0;
+  let moreResults = false;
+  let results = [];
+  const accountsToFetch = account ? [account] : Object.keys(EndpointConfig);
+  await Promise.all(
+    accountsToFetch.map(async (acc) => {
+      try {
+        offset = 0;
+        do {
+          const res = await getTeams(offset, limit, acc);
+          res[1].forEach((team) => {
+            team.account = acc;
+          });
+          results = results.concat(res[1]);
+          if (res[0] === true) {
+            moreResults = true;
+            offset += limit;
+          } else {
+            moreResults = false;
+          }
+        } while (moreResults === true);
+      } catch (error) {
+        if (error instanceof backstagePluginCommon.HttpError) {
+          throw error;
+        } else {
+          throw new backstagePluginCommon.HttpError(`${error}`, 500);
+        }
+      }
+    })
+  );
+  results.sort((a, b) => a.name.localeCompare(b.name));
+  return results;
+}
+async function getOncallUsers(escalationPolicy, account) {
+  let response;
+  const params = `time_zone=UTC&include[]=users&escalation_policy_ids[]=${escalationPolicy}`;
+  const options = {
+    method: "GET",
+    headers: await getDefaultHeaders(account)
+  };
+  const apiBaseUrl = getApiBaseUrl(account);
   const baseUrl = `${apiBaseUrl}/oncalls`;
   try {
     response = await fetchWithRetries(`${baseUrl}?${params}`, options);
@@ -405,14 +505,9 @@ async function getOncallUsers(escalationPolicy, account) {
 async function getServiceById(serviceId, account) {
   let response;
   const params = `time_zone=UTC&include[]=integrations&include[]=escalation_policies`;
-  const token = await auth.getAuthToken(account);
   const options = {
     method: "GET",
-    headers: {
-      Authorization: token,
-      Accept: "application/vnd.pagerduty+json;version=2",
-      "Content-Type": "application/json"
-    }
+    headers: await getDefaultHeaders(account)
   };
   const apiBaseUrl = getApiBaseUrl(account);
   const baseUrl = `${apiBaseUrl}/services`;
@@ -460,9 +555,8 @@ async function getServiceById(serviceId, account) {
     throw new backstagePluginCommon.HttpError(`Failed to parse service information: ${error}`, 500);
   }
 }
-async function getServiceByIntegrationKey(integrationKey, account) {
+async function getSerivcesByIdsAndAccount(serviceIds, account) {
   let response;
-  const params = `query=${integrationKey}&time_zone=UTC&include[]=integrations&include[]=escalation_policies`;
   const token = await auth.getAuthToken(account);
   const options = {
     method: "GET",
@@ -474,6 +568,59 @@ async function getServiceByIntegrationKey(integrationKey, account) {
   };
   const apiBaseUrl = getApiBaseUrl(account);
   const baseUrl = `${apiBaseUrl}/services`;
+  try {
+    response = await fetchWithRetries(
+      `${baseUrl}?id[]=${serviceIds.join("&id[]=")}`,
+      options
+    );
+  } catch (error) {
+    throw new Error(`Failed to retrieve service: ${error}`);
+  }
+  if (response.status >= 500) {
+    throw new backstagePluginCommon.HttpError(
+      `Failed to get service. PagerDuty API returned a server error. Retrying with the same arguments will not work.`,
+      response.status
+    );
+  }
+  switch (response.status) {
+    case 400:
+      throw new backstagePluginCommon.HttpError(
+        "Failed to get service. Caller provided invalid arguments.",
+        400
+      );
+    case 401:
+      throw new backstagePluginCommon.HttpError(
+        "Failed to get service. Caller did not supply credentials or did not provide the correct credentials.",
+        401
+      );
+    case 403:
+      throw new backstagePluginCommon.HttpError(
+        "Failed to get service. Caller is not authorized to view the requested resource.",
+        403
+      );
+    case 404:
+      throw new backstagePluginCommon.HttpError(
+        "Failed to get service. The requested resource was not found.",
+        404
+      );
+  }
+  let result;
+  try {
+    result = await response.json();
+    return result.services ?? [];
+  } catch (error) {
+    throw new backstagePluginCommon.HttpError(`Failed to parse service information: ${error}`, 500);
+  }
+}
+async function getServiceByIntegrationKey(integrationKey, account) {
+  let response;
+  const params = `query=${integrationKey}&time_zone=UTC&include[]=integrations&include[]=escalation_policies`;
+  const options = {
+    method: "GET",
+    headers: await getDefaultHeaders(account)
+  };
+  const apiBaseUrl = getApiBaseUrl(account);
+  const baseUrl = `${apiBaseUrl}/services`;
   try {
     response = await fetchWithRetries(`${baseUrl}?${params}`, options);
   } catch (error) {
@@ -521,12 +668,79 @@ 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);
+    })
+  );
+  return services;
+}
 async function getAllServices() {
   const allServices = [];
   await Promise.all(
     Object.entries(EndpointConfig).map(async ([account, _]) => {
       let response;
       const params = `time_zone=UTC&include[]=integrations&include[]=escalation_policies&include[]=teams&total=true`;
+      const options = {
+        method: "GET",
+        headers: await getDefaultHeaders(account)
+      };
+      const apiBaseUrl = getApiBaseUrl(account);
+      const baseUrl = `${apiBaseUrl}/services`;
+      let offset = 0;
+      const limit = 50;
+      let result;
+      try {
+        do {
+          const paginatedUrl = `${baseUrl}?${params}&offset=${offset}&limit=${limit}`;
+          response = await fetchWithRetries(paginatedUrl, options);
+          if (response.status >= 500) {
+            throw new backstagePluginCommon.HttpError(
+              `Failed to get services. PagerDuty API returned a server error. Retrying with the same arguments will not work.`,
+              response.status
+            );
+          }
+          switch (response.status) {
+            case 400:
+              throw new backstagePluginCommon.HttpError(
+                "Failed to get services. Caller provided invalid arguments.",
+                400
+              );
+            case 401:
+              throw new backstagePluginCommon.HttpError(
+                "Failed to get services. Caller did not supply credentials or did not provide the correct credentials.",
+                401
+              );
+            case 403:
+              throw new backstagePluginCommon.HttpError(
+                "Failed to get services. Caller is not authorized to view the requested resource.",
+                403
+              );
+            default:
+              break;
+          }
+          result = await response.json();
+          result.services.forEach((service) => {
+            service.account = account;
+          });
+          allServices.push(...result.services);
+          offset += limit;
+        } while (offset < result.total);
+      } catch (error) {
+        throw error;
+      }
+    })
+  );
+  return allServices;
+}
+async function getServicesByPartialName(partialName) {
+  const allServices = [];
+  await Promise.all(
+    Object.entries(EndpointConfig).map(async ([account, _]) => {
+      let response;
+      const params = `query=${encodeURIComponent(partialName)}&time_zone=UTC&include[]=integrations&include[]=escalation_policies&include[]=teams&total=true`;
       const token = await auth.getAuthToken(account);
       const options = {
         method: "GET",
@@ -584,16 +798,77 @@ async function getAllServices() {
   );
   return allServices;
 }
+async function getFilteredServices(teamIds, query, maxLimit, account) {
+  const allServices = [];
+  const limit = maxLimit;
+  const accountsToFetch = account ? [account] : Object.keys(EndpointConfig);
+  await Promise.all(
+    accountsToFetch.map(async (acc) => {
+      let response;
+      let params = `time_zone=UTC&limit=${limit}`;
+      if (teamIds && teamIds.length > 0) {
+        const teamIdsParam = teamIds.map((id) => `team_ids[]=${id}`).join("&");
+        params += `&${teamIdsParam}`;
+      }
+      if (query && query.trim() !== "") {
+        params += `&query=${encodeURIComponent(query.trim())}`;
+      }
+      const token = await auth.getAuthToken(acc);
+      const options = {
+        method: "GET",
+        headers: {
+          Authorization: token,
+          Accept: "application/vnd.pagerduty+json;version=2",
+          "Content-Type": "application/json"
+        }
+      };
+      const apiBaseUrl = getApiBaseUrl(acc);
+      const baseUrl = `${apiBaseUrl}/services`;
+      try {
+        response = await fetchWithRetries(`${baseUrl}?${params}`, options);
+        if (response.status >= 500) {
+          throw new backstagePluginCommon.HttpError(
+            `Failed to get services. PagerDuty API returned a server error. Retrying with the same arguments will not work.`,
+            response.status
+          );
+        }
+        switch (response.status) {
+          case 400:
+            throw new backstagePluginCommon.HttpError(
+              "Failed to get services. Caller provided invalid arguments.",
+              400
+            );
+          case 401:
+            throw new backstagePluginCommon.HttpError(
+              "Failed to get services. Caller did not supply credentials or did not provide the correct credentials.",
+              401
+            );
+          case 403:
+            throw new backstagePluginCommon.HttpError(
+              "Failed to get services. Caller is not authorized to view the requested resource.",
+              403
+            );
+          default:
+            break;
+        }
+        const result = await response.json();
+        result.services.forEach((service) => {
+          service.account = acc;
+        });
+        allServices.push(...result.services);
+      } catch (error) {
+        throw error;
+      }
+    })
+  );
+  return allServices;
+}
 async function getChangeEvents(serviceId, account) {
   let response;
   const params = `limit=5&time_zone=UTC&sort_by=timestamp`;
   const options = {
     method: "GET",
-    headers: {
-      Authorization: await auth.getAuthToken(account),
-      Accept: "application/vnd.pagerduty+json;version=2",
-      "Content-Type": "application/json"
-    }
+    headers: await getDefaultHeaders(account)
   };
   const apiBaseUrl = getApiBaseUrl(account);
   const baseUrl = `${apiBaseUrl}/services`;
@@ -649,11 +924,7 @@ async function getIncidents(serviceId, account) {
   const params = `time_zone=UTC&sort_by=created_at&statuses[]=triggered&statuses[]=acknowledged&service_ids[]=${serviceId}`;
   const options = {
     method: "GET",
-    headers: {
-      Authorization: await auth.getAuthToken(account),
-      Accept: "application/vnd.pagerduty+json;version=2",
-      "Content-Type": "application/json"
-    }
+    headers: await getDefaultHeaders(account)
   };
   const apiBaseUrl = getApiBaseUrl(account);
   const baseUrl = `${apiBaseUrl}/incidents`;
@@ -707,11 +978,7 @@ async function getServiceStandards(serviceId, account) {
   let response;
   const options = {
     method: "GET",
-    headers: {
-      Authorization: await auth.getAuthToken(account),
-      Accept: "application/vnd.pagerduty+json;version=2",
-      "Content-Type": "application/json"
-    }
+    headers: await getDefaultHeaders(account)
   };
   const apiBaseUrl = getApiBaseUrl(account);
   const baseUrl = `${apiBaseUrl}/standards/scores/technical_services/${serviceId}`;
@@ -768,11 +1035,7 @@ async function getServiceMetrics(serviceId, account) {
   });
   const options = {
     method: "POST",
-    headers: {
-      Authorization: await auth.getAuthToken(account),
-      Accept: "application/vnd.pagerduty+json;version=2",
-      "Content-Type": "application/json"
-    },
+    headers: await getDefaultHeaders(account),
     body
   };
   const apiBaseUrl = getApiBaseUrl(account);
@@ -818,7 +1081,6 @@ async function createServiceIntegration({
   let response;
   const apiBaseUrl = getApiBaseUrl(account);
   const baseUrl = `${apiBaseUrl}/services`;
-  const token = await auth.getAuthToken(account);
   const options = {
     method: "POST",
     body: JSON.stringify({
@@ -834,11 +1096,7 @@ async function createServiceIntegration({
         }
       }
     }),
-    headers: {
-      Authorization: token,
-      Accept: "application/vnd.pagerduty+json;version=2",
-      "Content-Type": "application/json"
-    }
+    headers: await getDefaultHeaders(account)
   };
   try {
     response = await fetchWithRetries(
@@ -906,16 +1164,21 @@ exports.createServiceIntegration = createServiceIntegration;
 exports.fetchWithRetries = fetchWithRetries;
 exports.getAllEscalationPolicies = getAllEscalationPolicies;
 exports.getAllServices = getAllServices;
+exports.getAllTeams = getAllTeams;
 exports.getChangeEvents = getChangeEvents;
+exports.getFilteredServices = getFilteredServices;
 exports.getIncidents = getIncidents;
 exports.getOncallUsers = getOncallUsers;
+exports.getSerivcesByIdsAndAccount = getSerivcesByIdsAndAccount;
 exports.getServiceById = getServiceById;
 exports.getServiceByIntegrationKey = getServiceByIntegrationKey;
 exports.getServiceMetrics = getServiceMetrics;
 exports.getServiceRelationshipsById = getServiceRelationshipsById;
 exports.getServiceStandards = getServiceStandards;
-exports.insertEndpointConfig = insertEndpointConfig;
+exports.getServicesByIds = getServicesByIds;
+exports.getServicesByPartialName = getServicesByPartialName;
+exports.insertAccountConfig = insertAccountConfig;
 exports.loadPagerDutyEndpointsFromConfig = loadPagerDutyEndpointsFromConfig;
 exports.removeServiceRelationsFromService = removeServiceRelationsFromService;
-exports.setFallbackEndpointConfig = setFallbackEndpointConfig;
+exports.setFallbackAccountConfig = setFallbackAccountConfig;
 //# sourceMappingURL=pagerduty.cjs.js.map