Merge pull request #31 from PagerDuty/next

release: 0.4.3
PagerDuty · Feb 22, 2024 · 44e5600 · 44e5600
2 parents a00194c + fb013b7
commit 44e5600
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 10 deletions.
diff --git a/config.d.ts b/config.d.ts
@@ -27,6 +27,11 @@ export interface Config {
          * @visibility frontend
          */
         eventsBaseUrl?: string;
+        /**
+         * Optional API Base URL to override the default.
+         * @visibility frontend
+         */
+        apiBaseUrl?: string;
         /**
          * Optional PagerDuty API Token used in API calls from the backend component.
          * @visibility frontend

diff --git a/src/apis/pagerduty.ts b/src/apis/pagerduty.ts
@@ -20,11 +20,16 @@ import {
     HttpError
 } from '@pagerduty/backstage-plugin-common';
 
+let apiBaseUrl = 'https://api.pagerduty.com';
+export function setAPIBaseUrl(url: string): void {
+    apiBaseUrl = url;
+}
+
 // Supporting custom actions
 export async function createService(name: string, description: string, escalationPolicyId: string, alertGrouping?: string): Promise<CreateServiceResponse> {
     let alertGroupingParameters = "null";
     let response: Response;
-    const baseUrl = 'https://api.pagerduty.com/services';
+    const baseUrl = `${apiBaseUrl}/services`;
 
     // Set default body
     let body = JSON.stringify({
@@ -176,7 +181,7 @@ export async function createService(name: string, description: string, escalatio
 
 export async function createServiceIntegration(serviceId: string, vendorId: string): Promise<string> {
     let response: Response;
-    const baseUrl = 'https://api.pagerduty.com/services';
+    const baseUrl = `${apiBaseUrl}/services`;
     const options: RequestInit = {
         method: 'POST',
         body: JSON.stringify({
@@ -242,7 +247,7 @@ async function getEscalationPolicies(offset: number, limit: number): Promise<[Bo
             'Content-Type': 'application/json',
         },
     };
-    const baseUrl = 'https://api.pagerduty.com/escalation_policies';
+    const baseUrl = `${apiBaseUrl}/escalation_policies`;
 
     try {
         response = await fetch(`${baseUrl}?${params}`, options);
@@ -353,7 +358,7 @@ export async function getOncallUsers(escalationPolicy: string): Promise<PagerDut
             'Content-Type': 'application/json',
         },
     };
-    const baseUrl = 'https://api.pagerduty.com/oncalls';
+    const baseUrl = `${apiBaseUrl}/oncalls`;
 
     try {
         response = await fetch(`${baseUrl}?${params}`, options);
@@ -425,7 +430,7 @@ export async function getServiceById(serviceId: string): Promise<PagerDutyServic
             'Content-Type': 'application/json',
         },
     };
-    const baseUrl = 'https://api.pagerduty.com/services';
+    const baseUrl = `${apiBaseUrl}/services`;
 
     try {
         response = await fetch(`${baseUrl}/${serviceId}?${params}`, options);
@@ -467,7 +472,7 @@ export async function getServiceByIntegrationKey(integrationKey: string): Promis
             'Content-Type': 'application/json',
         },
     };
-    const baseUrl = 'https://api.pagerduty.com/services';
+    const baseUrl = `${apiBaseUrl}/services`;
 
     try {
         response = await fetch(`${baseUrl}?${params}`, options);
@@ -513,7 +518,7 @@ export async function getChangeEvents(serviceId: string): Promise<PagerDutyChang
             'Content-Type': 'application/json',
         },
     };
-    const baseUrl = 'https://api.pagerduty.com/services';
+    const baseUrl = `${apiBaseUrl}/services`;
 
     try {
         response = await fetch(`${baseUrl}/${serviceId}/change_events?${params}`, options);
@@ -556,7 +561,7 @@ export async function getIncidents(serviceId: string): Promise<PagerDutyIncident
             'Content-Type': 'application/json',
         },
     };
-    const baseUrl = 'https://api.pagerduty.com/incidents';
+    const baseUrl = `${apiBaseUrl}/incidents`;
 
     try {
         response = await fetch(`${baseUrl}?${params}`, options);

diff --git a/src/service/router.ts b/src/service/router.ts
@@ -3,7 +3,7 @@ import { Config } from '@backstage/config';
 import express from 'express';
 import Router from 'express-promise-router';
 import { Logger } from 'winston';
-import { getAllEscalationPolicies, getChangeEvents, getIncidents, getOncallUsers, getServiceById, getServiceByIntegrationKey } from '../apis/pagerduty';
+import { getAllEscalationPolicies, getChangeEvents, getIncidents, getOncallUsers, getServiceById, getServiceByIntegrationKey, setAPIBaseUrl } from '../apis/pagerduty';
 import { HttpError, PagerDutyChangeEventsResponse, PagerDutyIncidentsResponse, PagerDutyOnCallUsersResponse, PagerDutyServiceResponse } from '@pagerduty/backstage-plugin-common';
 import { loadAuthConfig } from '../auth/auth';
 
@@ -20,8 +20,12 @@ export async function createRouter(
     // Get authentication Config
     await loadAuthConfig(logger, config);
 
+    // Get the PagerDuty API Base URL from config
+    const baseUrl = config.getOptionalString('pagerDuty.apiBaseUrl') !== undefined ? config.getString('pagerDuty.apiBaseUrl') : 'https://api.pagerduty.com';
+    setAPIBaseUrl(baseUrl);
+
     // Create the router
-    const router = Router();
+    const router = Router();    
     router.use(express.json());
 
     // Add routes