implemented multi environment support

gadget-inc · Jan 11, 2024 · 1c82a57 · 1c82a57
1 parent effb8b1
commit 1c82a57
Show file tree

Hide file tree

Showing 13 changed files with 276 additions and 83 deletions.
diff --git a/spec/__support__/app.ts b/spec/__support__/app.ts
@@ -4,6 +4,39 @@ import type { App } from "../../src/services/app/app.js";
 import { config } from "../../src/services/config/config.js";
 import { loadCookie } from "../../src/services/http/auth.js";
 
+/**
+ * A test Gadget app to use in tests with multi environment on.
+ */
+export const multiEnvironmentTestApp: App = Object.freeze({
+  id: 1,
+  slug: "test-multi-environment",
+  primaryDomain: "test.gadget.app",
+  hasSplitEnvironments: true,
+  multiEnvironmentEnabled: true,
+  environments: [
+    {
+      id: 1,
+      name: "development",
+      type: "development",
+    },
+    {
+      id: 2,
+      name: "production",
+      type: "production",
+    },
+    {
+      id: 3,
+      name: "cool-environment-development",
+      type: "development",
+    },
+    {
+      id: 4,
+      name: "other-environment-development",
+      type: "development",
+    },
+  ],
+});
+
 /**
  * A test Gadget app to use in tests.
  */
@@ -12,6 +45,19 @@ export const testApp: App = Object.freeze({
   slug: "test",
   primaryDomain: "test.gadget.app",
   hasSplitEnvironments: true,
+  multiEnvironmentEnabled: false,
+  environments: [
+    {
+      id: 1,
+      name: "development",
+      type: "development",
+    },
+    {
+      id: 2,
+      name: "production",
+      type: "production",
+    },
+  ],
 });
 
 /**
@@ -24,6 +70,8 @@ export const notTestApp: App = Object.freeze({
   slug: "not-test",
   primaryDomain: "not-test.gadget.app",
   hasSplitEnvironments: false,
+  multiEnvironmentEnabled: false,
+  environments: [],
 });
 
 /**
@@ -38,6 +86,6 @@ export const nockTestApps = ({ optional = true, persist = true } = {}): void =>
       expect(cookie).toBeTruthy();
       return value === cookie;
     })
-    .reply(200, [testApp, notTestApp])
+    .reply(200, [testApp, notTestApp, multiEnvironmentTestApp])
     .persist(persist);
 };
diff --git a/spec/__support__/filesync.ts b/spec/__support__/filesync.ts
@@ -206,7 +206,7 @@ export const makeSyncScenario = async ({
     await localDir.loadIgnoreFile();
 
     if (!localFiles[".gadget/sync.json"]) {
-      const syncJson: SyncJson = { app: testApp.slug, filesVersion: "1", mtime: Date.now() + 1 };
+      const syncJson: SyncJson = { app: testApp.slug, environment: "development", filesVersion: "1", mtime: Date.now() + 1 };
       await fs.outputJSON(localDir.absolute(".gadget/sync.json"), syncJson, { spaces: 2 });
     }
   }

diff --git a/spec/commands/list.spec.ts b/spec/commands/list.spec.ts
@@ -17,8 +17,15 @@ describe("list", () => {
   it("lists apps", async () => {
     mock(user, "getUserOrLogin", () => ({ id: 1, email: "[email protected]", name: "Jane Doe" }));
     mock(app, "getApps", () => [
-      { id: 1, slug: "app-a", primaryDomain: "app-a.example.com", hasSplitEnvironments: true },
-      { id: 2, slug: "app-b", primaryDomain: "cool-app.com", hasSplitEnvironments: true },
+      {
+        id: 1,
+        slug: "app-a",
+        primaryDomain: "app-a.example.com",
+        hasSplitEnvironments: true,
+        multiEnvironmentEnabled: true,
+        environments: [],
+      },
+      { id: 2, slug: "app-b", primaryDomain: "cool-app.com", hasSplitEnvironments: true, multiEnvironmentEnabled: true, environments: [] },
     ]);
 
     await command(ctx);

diff --git a/spec/commands/sync.spec.ts b/spec/commands/sync.spec.ts
@@ -77,7 +77,7 @@ describe("sync", () => {
         },
         "localDir": {
           ".gadget/": "",
-          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"filesVersion\\":\\"2\\"}",
+          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"environment\\":\\"development\\",\\"filesVersion\\":\\"2\\"}",
           "file.txt": "file v2",
         },
       }
@@ -113,7 +113,7 @@ describe("sync", () => {
         },
         "localDir": {
           ".gadget/": "",
-          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"filesVersion\\":\\"3\\"}",
+          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"environment\\":\\"development\\",\\"filesVersion\\":\\"3\\"}",
           "file.txt": "file v3",
         },
       }
@@ -153,7 +153,7 @@ describe("sync", () => {
           ".gadget/": "",
           ".gadget/backup/": "",
           ".gadget/backup/file.txt": "file v3",
-          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"filesVersion\\":\\"4\\"}",
+          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"environment\\":\\"development\\",\\"filesVersion\\":\\"4\\"}",
         },
       }
     `);
@@ -197,7 +197,7 @@ describe("sync", () => {
           ".gadget/": "",
           ".gadget/backup/": "",
           ".gadget/backup/file.txt": "file v3",
-          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"filesVersion\\":\\"5\\"}",
+          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"environment\\":\\"development\\",\\"filesVersion\\":\\"5\\"}",
           "directory/": "",
         },
       }
@@ -245,7 +245,7 @@ describe("sync", () => {
           ".gadget/backup/": "",
           ".gadget/backup/directory/": "",
           ".gadget/backup/file.txt": "file v3",
-          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"filesVersion\\":\\"6\\"}",
+          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"environment\\":\\"development\\",\\"filesVersion\\":\\"6\\"}",
         },
       }
     `);
@@ -316,7 +316,7 @@ describe("sync", () => {
           ".gadget/backup/": "",
           ".gadget/backup/directory/": "",
           ".gadget/backup/file.txt": "file v3",
-          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"filesVersion\\":\\"7\\"}",
+          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"environment\\":\\"development\\",\\"filesVersion\\":\\"7\\"}",
           "file1.txt": "file1.txt",
           "file10.txt": "file10.txt",
           "file2.txt": "file2.txt",
@@ -440,7 +440,7 @@ describe("sync", () => {
           ".gadget/backup/": "",
           ".gadget/backup/directory/": "",
           ".gadget/backup/file.txt": "file v3",
-          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"filesVersion\\":\\"7\\"}",
+          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"environment\\":\\"development\\",\\"filesVersion\\":\\"7\\"}",
           "file1.txt": "file1.txt",
           "file10.txt": "file10.txt",
           "file2.txt": "file2.txt",
@@ -576,7 +576,7 @@ describe("sync", () => {
           ".gadget/backup/": "",
           ".gadget/backup/directory/": "",
           ".gadget/backup/file.txt": "file v3",
-          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"filesVersion\\":\\"7\\"}",
+          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"environment\\":\\"development\\",\\"filesVersion\\":\\"7\\"}",
           "file.js": "file v2",
           "file1.txt": "file1.txt",
           "file10.txt": "file10.txt",
@@ -639,7 +639,7 @@ describe("sync", () => {
         },
         "localDir": {
           ".gadget/": "",
-          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"filesVersion\\":\\"2\\"}",
+          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"environment\\":\\"development\\",\\"filesVersion\\":\\"2\\"}",
           ".ignore": "**/tmp",
         },
       }
@@ -680,7 +680,7 @@ describe("sync", () => {
         },
         "localDir": {
           ".gadget/": "",
-          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"filesVersion\\":\\"3\\"}",
+          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"environment\\":\\"development\\",\\"filesVersion\\":\\"3\\"}",
           ".ignore": "**/tmp",
         },
       }
@@ -712,7 +712,7 @@ describe("sync", () => {
         },
         "localDir": {
           ".gadget/": "",
-          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"filesVersion\\":\\"2\\"}",
+          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"environment\\":\\"development\\",\\"filesVersion\\":\\"2\\"}",
           "file.txt": "file v2",
         },
       }
@@ -742,7 +742,7 @@ describe("sync", () => {
         },
         "localDir": {
           ".gadget/": "",
-          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"filesVersion\\":\\"3\\"}",
+          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"environment\\":\\"development\\",\\"filesVersion\\":\\"3\\"}",
           "file.txt": "file v3",
         },
       }
@@ -776,7 +776,7 @@ describe("sync", () => {
         },
         "localDir": {
           ".gadget/": "",
-          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"filesVersion\\":\\"4\\"}",
+          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"environment\\":\\"development\\",\\"filesVersion\\":\\"4\\"}",
           "renamed-file.txt": "file v3",
         },
       }
@@ -812,7 +812,7 @@ describe("sync", () => {
         },
         "localDir": {
           ".gadget/": "",
-          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"filesVersion\\":\\"5\\"}",
+          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"environment\\":\\"development\\",\\"filesVersion\\":\\"5\\"}",
         },
       }
     `);
@@ -852,7 +852,7 @@ describe("sync", () => {
         },
         "localDir": {
           ".gadget/": "",
-          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"filesVersion\\":\\"6\\"}",
+          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"environment\\":\\"development\\",\\"filesVersion\\":\\"6\\"}",
           "directory/": "",
         },
       }
@@ -897,7 +897,7 @@ describe("sync", () => {
         },
         "localDir": {
           ".gadget/": "",
-          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"filesVersion\\":\\"7\\"}",
+          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"environment\\":\\"development\\",\\"filesVersion\\":\\"7\\"}",
           "renamed-directory/": "",
         },
       }
@@ -944,7 +944,7 @@ describe("sync", () => {
         },
         "localDir": {
           ".gadget/": "",
-          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"filesVersion\\":\\"8\\"}",
+          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"environment\\":\\"development\\",\\"filesVersion\\":\\"8\\"}",
         },
       }
     `);
@@ -1020,7 +1020,7 @@ describe("sync", () => {
         },
         "localDir": {
           ".gadget/": "",
-          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"filesVersion\\":\\"9\\"}",
+          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"environment\\":\\"development\\",\\"filesVersion\\":\\"9\\"}",
           "file1.txt": "file1.txt",
           "file10.txt": "file10.txt",
           "file2.txt": "file2.txt",
@@ -1065,7 +1065,7 @@ describe("sync", () => {
         },
         "localDir": {
           ".gadget/": "",
-          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"filesVersion\\":\\"2\\"}",
+          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"environment\\":\\"development\\",\\"filesVersion\\":\\"2\\"}",
           "file.txt": "v10",
         },
       }
@@ -1131,7 +1131,7 @@ describe("sync", () => {
         },
         "localDir": {
           ".gadget/": "",
-          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"filesVersion\\":\\"1\\"}",
+          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"environment\\":\\"development\\",\\"filesVersion\\":\\"1\\"}",
           ".ignore": "**/tmp",
           "tmp/": "",
           "tmp/file1.txt": "file1.txt",
@@ -1176,7 +1176,7 @@ describe("sync", () => {
         },
         "localDir": {
           ".gadget/": "",
-          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"filesVersion\\":\\"2\\"}",
+          ".gadget/sync.json": "{\\"app\\":\\"test\\",\\"environment\\":\\"development\\",\\"filesVersion\\":\\"2\\"}",
           ".ignore": "# watch it all",
         },
       }

diff --git a/spec/services/app/arg.spec.ts b/spec/services/app/arg.spec.ts
@@ -12,6 +12,7 @@ describe("AppArg", () => {
     "https://my-app--development.gadget.app",
     "https://my-app.gadget.app/edit",
     "https://my-app.gadget.app/edit/files/routes/GET.js",
+    "https://my-app.gadget.app/edit/cool-new-environment",
   ])("accepts %s", (value) => {
     expect(AppArg(value, "--app")).toEqual("my-app");
   });

diff --git a/spec/services/app/edit.spec.ts b/spec/services/app/edit.spec.ts
@@ -25,6 +25,7 @@ describe("Edit", () => {
     loginTestUser();
     ctx = makeContext();
     ctx.app = testApp;
+    ctx.environment = "development";
   });
 
   it("retries queries when it receives a 500", async () => {