Merge pull request #39 from DeterminateSystems/preflight

Add checkin behavior which preflights the IDS backend
DeterminateSystems · Jun 3, 2024 · fe64ba3 · fe64ba3
2 parents 9d66d2c + c22367f
commit fe64ba3
Show file tree

Hide file tree

Showing 7 changed files with 321 additions and 12 deletions.
diff --git a/dist/index.d.ts b/dist/index.d.ts
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/Untitled-1 b/src/Untitled-1
diff --git a/src/check-in.ts b/src/check-in.ts
@@ -0,0 +1,36 @@
+export type CheckIn = {
+  status: StatusSummary | null;
+  options: { [k: string]: Feature };
+};
+
+export type StatusSummary = {
+  page: Page;
+  incidents: Incident[];
+  scheduled_maintenances: Maintenance[];
+};
+
+export type Page = {
+  name: string;
+  url: string;
+};
+
+export type Incident = {
+  name: string;
+  status: string;
+  impact: string;
+  shortlink: string;
+};
+
+export type Maintenance = {
+  name: string;
+  status: string;
+  impact: string;
+  shortlink: string;
+  scheduled_for: string;
+  scheduled_until: string;
+};
+
+export type Feature = {
+  variant: boolean | string;
+  payload?: string;
+};
diff --git a/src/ids-host.ts b/src/ids-host.ts
@@ -41,7 +41,7 @@ export class IdsHost {
     this.prioritizedURLs = urls;
   }
 
-  async getRootUrl(): Promise<URL> {
+  async getDynamicRootUrl(): Promise<URL | undefined> {
     const idsHost = process.env["IDS_HOST"];
     if (idsHost !== undefined) {
       try {
@@ -64,12 +64,22 @@ export class IdsHost {
     }
 
     if (url === undefined) {
-      url = new URL(DEFAULT_IDS_HOST);
+      return undefined;
+    } else {
+      // This is a load-bearing `new URL(url)` so that callers can't mutate
+      // getRootUrl's return value.
+      return new URL(url);
+    }
+  }
+
+  async getRootUrl(): Promise<URL> {
+    const url = await this.getDynamicRootUrl();
+
+    if (url === undefined) {
+      return new URL(DEFAULT_IDS_HOST);
     }
 
-    // This is a load-bearing `new URL(url)` so that callers can't mutate
-    // getRootUrl's return value.
-    return new URL(url);
+    return url;
   }
 
   async getDiagnosticsUrl(): Promise<URL | undefined> {