@pagerduty/backstage-plugin-backend 0.11.0 → 0.13.0

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # @pagerduty/backstage-plugin-backend
 
+## 0.13.0
+
+### Minor Changes
+
+- 9941800: Refactor the service mappings screen and add an auto-matching functionality to mass map PagerDuty service to Backstage entities
+- e1f99a7: Remove deprecated @backstage/backend-common library. This is a potential breaking change for users who are still on the old backend system:
+
+  - `createPagerDutyServiceAction(...)` now requires its `config` prop.
+  - `createRouter(...)` now requires its `auth` prop.
+
+  Note that none of this is breaking for users of the new backend system.
+
+### Patch Changes
+
+- ef0af04: Moved to a process/polling based loading of the automatic mapping matches
+- Updated dependencies [9941800]
+- Updated dependencies [ef0af04]
+  - @pagerduty/backstage-plugin-common@0.4.0
+
+## 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

package/dist/apis/pagerduty.cjs.js

@@ -350,6 +350,92 @@ async function getAllEscalationPolicies() {
   );
   return results;
 }
+async function getTeams(offset, limit, account) {
+  let response;
+  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"
+    }
+  };
+  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}`;
@@ -469,6 +555,63 @@ async function getServiceById(serviceId, account) {
     throw new backstagePluginCommon.HttpError(`Failed to parse service information: ${error}`, 500);
   }
 }
+async function getSerivcesByIdsAndAccount(serviceIds, account) {
+  let response;
+  const token = await auth.getAuthToken(account);
+  const options = {
+    method: "GET",
+    headers: {
+      Authorization: token,
+      Accept: "application/vnd.pagerduty+json;version=2",
+      "Content-Type": "application/json"
+    }
+  };
+  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`;
@@ -525,6 +668,15 @@ 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(
@@ -583,6 +735,134 @@ async function getAllServices() {
   );
   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",
+        headers: {
+          Authorization: token,
+          Accept: "application/vnd.pagerduty+json;version=2",
+          "Content-Type": "application/json"
+        }
+      };
+      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 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`;
@@ -884,14 +1164,19 @@ 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.getServicesByIds = getServicesByIds;
+exports.getServicesByPartialName = getServicesByPartialName;
 exports.insertAccountConfig = insertAccountConfig;
 exports.loadPagerDutyEndpointsFromConfig = loadPagerDutyEndpointsFromConfig;
 exports.removeServiceRelationsFromService = removeServiceRelationsFromService;