New add env command (#1944)

Author: MillanWangGadget

.changeset/smooth-rice-rhyme.md

@@ -0,0 +1,5 @@
+---
+"ggt": minor
+---
+
+New `ggt add env` command has been added to allow for environment creation.

README.md

@@ -243,6 +243,8 @@ Usage
 
   ggt add field <model_path>/<field_name>:<field_type>
 
+  ggt add environment <env_name> [options]
+
 Options
   -e, --env <env_name> Selects the environment to add to. Default set on ".gadget/sync.json"
 
@@ -253,6 +255,9 @@ Examples
   Add a new model 'post' with 2 new 'string' type fields 'title' and 'body':
   $ ggt add model post title:string body:string
 
+  Add a new 'boolean' type field 'published' to an existing model
+  ggt add field post/published:boolean
+
   Add new action 'publish' to the 'post' model:
   ggt add action model/post/publish
 
@@ -262,8 +267,8 @@ Examples
   Add a new route 'howdy'
   ggt add route GET howdy
 
-  Add a new 'boolean' type field 'published' to an existing model
-  ggt add field post/published:boolean
+  Clone the `development` environment into a new `staging` environment
+  $ ggt add environment staging --environment development
 ```
 
 ### `ggt open`

spec/commands/__snapshots__/root.spec.ts.snap

@@ -26,6 +26,9 @@ Examples
   Add a new model 'post' with 2 new 'string' type fields 'title' and 'body':
   $ ggt add model post title:string body:string
 
+  Add a new 'boolean' type field 'published' to an existing model
+  ggt add field post/published:boolean
+
   Add new action 'publish' to the 'post' model:
   ggt add action model/post/publish
 
@@ -35,8 +38,8 @@ Examples
   Add a new route 'howdy'
   ggt add route GET howdy
 
-  Add a new 'boolean' type field 'published' to an existing model
-  ggt add field post/published:boolean
+  Clone the \`development\` environment into a new \`staging\` environment
+  ggt add environment staging --environment development
 "
 `;
 
@@ -66,6 +69,9 @@ Examples
   Add a new model 'post' with 2 new 'string' type fields 'title' and 'body':
   $ ggt add model post title:string body:string
 
+  Add a new 'boolean' type field 'published' to an existing model
+  ggt add field post/published:boolean
+
   Add new action 'publish' to the 'post' model:
   ggt add action model/post/publish
 
@@ -75,8 +81,8 @@ Examples
   Add a new route 'howdy'
   ggt add route GET howdy
 
-  Add a new 'boolean' type field 'published' to an existing model
-  ggt add field post/published:boolean
+  Clone the \`development\` environment into a new \`staging\` environment
+  ggt add environment staging --environment development
 "
 `;
 

spec/commands/add.spec.ts

@@ -1,8 +1,10 @@
 import { beforeEach, describe, expect, it } from "vitest";
+import { EnvironmentStatus } from "../../src/__generated__/graphql.js";
 import * as add from "../../src/commands/add.js";
 import { GADGET_GLOBAL_ACTIONS_QUERY, GADGET_META_MODELS_QUERY } from "../../src/services/app/api/operation.js";
 import {
   CREATE_ACTION_MUTATION,
+  CREATE_ENVIRONMENT_MUTATION,
   CREATE_MODEL_FIELDS_MUTATION,
   CREATE_MODEL_MUTATION,
   CREATE_ROUTE_MUTATION,
@@ -203,4 +205,23 @@ describe("add", () => {
         `);
     });
   });
+
+  describe("environments", () => {
+    it("can add an environment with `add env`", async () => {
+      nockEditResponse({
+        operation: CREATE_ENVIRONMENT_MUTATION,
+        response: { data: { createEnvironment: { slug: "development2", status: EnvironmentStatus.Active } } },
+        expectVariables: { environment: { slug: "development2", sourceSlug: "development" } },
+      });
+      await add.run(testCtx, makeArgs(add.args, "add", "env", "development2"));
+    });
+    it("can add an environment with `add environment`", async () => {
+      nockEditResponse({
+        operation: CREATE_ENVIRONMENT_MUTATION,
+        response: { data: { createEnvironment: { slug: "development2", status: EnvironmentStatus.Active } } },
+        expectVariables: { environment: { slug: "development2", sourceSlug: "development" } },
+      });
+      await add.run(testCtx, makeArgs(add.args, "add", "environment", "development2"));
+    });
+  });
 });

src/__generated__/graphql.ts

@@ -4,6 +4,7 @@ import terminalLink from "terminal-link";
 import { getGlobalActions, getModels } from "../services/app/app.js";
 import {
   CREATE_ACTION_MUTATION,
+  CREATE_ENVIRONMENT_MUTATION,
   CREATE_MODEL_FIELDS_MUTATION,
   CREATE_MODEL_MUTATION,
   CREATE_ROUTE_MUTATION,
@@ -49,9 +50,7 @@ export class AddClientError extends GGTError {
 export type AddArgs = typeof args;
 export type AddArgsResult = ArgsDefinitionResult<AddArgs>;
 
-export const args = {
-  ...SyncJsonArgs,
-};
+export const args = { ...SyncJsonArgs };
 
 export const usage: Usage = () => {
   return sprint`
@@ -80,6 +79,9 @@ export const usage: Usage = () => {
     Add a new model 'post' with 2 new 'string' type fields 'title' and 'body':
     {cyanBright $ ggt add model post title:string body:string}
 
+    Add a new 'boolean' type field 'published' to an existing model
+    {cyanBright ggt add field post/published:boolean}
+
     Add new action 'publish' to the 'post' model:
     {cyanBright ggt add action model/post/publish}
 
@@ -89,8 +91,8 @@ export const usage: Usage = () => {
     Add a new route 'howdy'
     {cyanBright ggt add route GET howdy}
 
-    Add a new 'boolean' type field 'published' to an existing model
-    {cyanBright ggt add field post/published:boolean}
+    Clone the \`development\` environment into a new \`staging\` environment
+    {cyanBright ggt add environment staging --environment development}
   `;
 };
 
@@ -107,12 +109,8 @@ export const run: Run<AddArgs> = async (ctx, args) => {
   if (!hashes.inSync) {
     await filesync.merge(ctx, {
       hashes,
-      printEnvironmentChangesOptions: {
-        limit: 5,
-      },
-      printLocalChangesOptions: {
-        limit: 5,
-      },
+      printEnvironmentChangesOptions: { limit: 5 },
+      printLocalChangesOptions: { limit: 5 },
       quietly: true,
     });
   }
@@ -132,6 +130,10 @@ export const run: Run<AddArgs> = async (ctx, args) => {
     case "field":
       await fieldSubCommand(ctx, { args, filesync });
       break;
+    case "environment":
+    case "env":
+      await envSubCommand(ctx, { args, filesync });
+      break;
     default:
       println(usage(ctx));
       return;
@@ -189,10 +191,7 @@ const modelSubCommand = async (ctx: Context, { args, filesync }: { args: AddArgs
         mutation: CREATE_MODEL_MUTATION,
         variables: {
           path: modelApiIdentifier,
-          fields: modelFieldsList.map((fields) => ({
-            name: fields.name,
-            fieldType: fields.fieldType,
-          })),
+          fields: modelFieldsList.map((fields) => ({ name: fields.name, fieldType: fields.fieldType })),
         },
       })
     ).createModel;
@@ -206,11 +205,7 @@ const modelSubCommand = async (ctx: Context, { args, filesync }: { args: AddArgs
 
   println({ ensureEmptyLineAbove: true, content: chalk.gray("New model created in environment.") });
 
-  await filesync.writeToLocalFilesystem(ctx, {
-    filesVersion: result.remoteFilesVersion,
-    files: result.changed,
-    delete: [],
-  });
+  await filesync.writeToLocalFilesystem(ctx, { filesVersion: result.remoteFilesVersion, files: result.changed, delete: [] });
 
   const modelPrintout = terminalLink.isSupported
     ? terminalLink(
@@ -294,11 +289,7 @@ const actionSubCommand = async (ctx: Context, { args, filesync }: { args: AddArg
       })
     ).createAction;
 
-    await filesync.writeToLocalFilesystem(ctx, {
-      filesVersion: result.remoteFilesVersion,
-      files: result.changed,
-      delete: [],
-    });
+    await filesync.writeToLocalFilesystem(ctx, { filesVersion: result.remoteFilesVersion, files: result.changed, delete: [] });
   } catch (error) {
     if (error instanceof ClientError) {
       throw new AddClientError(error);
@@ -307,10 +298,7 @@ const actionSubCommand = async (ctx: Context, { args, filesync }: { args: AddArg
     }
   }
 
-  println({
-    ensureEmptyLineAbove: true,
-    content: `Action ${chalk.cyanBright(path)} added successfully.`,
-  });
+  println({ ensureEmptyLineAbove: true, content: `Action ${chalk.cyanBright(path)} added successfully.` });
 };
 
 const routeSubCommand = async (ctx: Context, { args, filesync }: { args: AddArgsResult; filesync: FileSync }): Promise<void> => {
@@ -333,18 +321,10 @@ const routeSubCommand = async (ctx: Context, { args, filesync }: { args: AddArgs
   }
 
   try {
-    const result = (
-      await syncJson.edit.mutate({
-        mutation: CREATE_ROUTE_MUTATION,
-        variables: { method: routeMethod, path: routePath },
-      })
-    ).createRoute;
+    const result = (await syncJson.edit.mutate({ mutation: CREATE_ROUTE_MUTATION, variables: { method: routeMethod, path: routePath } }))
+      .createRoute;
 
-    await filesync.writeToLocalFilesystem(ctx, {
-      filesVersion: result.remoteFilesVersion,
-      files: result.changed,
-      delete: [],
-    });
+    await filesync.writeToLocalFilesystem(ctx, { filesVersion: result.remoteFilesVersion, files: result.changed, delete: [] });
   } catch (error) {
     if (error instanceof ClientError) {
       throw new AddClientError(error);
@@ -353,10 +333,7 @@ const routeSubCommand = async (ctx: Context, { args, filesync }: { args: AddArgs
     }
   }
 
-  println({
-    ensureEmptyLineAbove: true,
-    content: `Route ${chalk.cyanBright(routePath)} added successfully.`,
-  });
+  println({ ensureEmptyLineAbove: true, content: `Route ${chalk.cyanBright(routePath)} added successfully.` });
 };
 
 const fieldSubCommand = async (ctx: Context, { args, filesync }: { args: AddArgsResult; filesync: FileSync }): Promise<void> => {
@@ -400,18 +377,31 @@ const fieldSubCommand = async (ctx: Context, { args, filesync }: { args: AddArgs
         variables: {
           // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
           path: splitPathAndField[0]!,
-          fields: modelFieldsList.map((field) => ({
-            name: field.name,
-            fieldType: field.fieldType,
-          })),
+          fields: modelFieldsList.map((field) => ({ name: field.name, fieldType: field.fieldType })),
         },
       })
     ).createModelFields;
 
-    await filesync.writeToLocalFilesystem(ctx, {
-      filesVersion: result.remoteFilesVersion,
-      files: result.changed,
-      delete: [],
+    await filesync.writeToLocalFilesystem(ctx, { filesVersion: result.remoteFilesVersion, files: result.changed, delete: [] });
+  } catch (error) {
+    if (error instanceof ClientError) {
+      throw new AddClientError(error);
+    } else {
+      throw error;
+    }
+  }
+
+  println({ ensureEmptyLineAbove: true, content: `Field ${chalk.cyanBright(modelFieldsList[0]?.name)} added successfully.` });
+};
+
+const envSubCommand = async (ctx: Context, { args, filesync }: { args: AddArgsResult; filesync: FileSync }): Promise<void> => {
+  const syncJson = filesync.syncJson;
+  const newEnvName = args._[1] ?? makeDefaultEnvName();
+
+  try {
+    await syncJson.edit.mutate({
+      mutation: CREATE_ENVIRONMENT_MUTATION,
+      variables: { environment: { slug: newEnvName, sourceSlug: syncJson.environment.name } },
     });
   } catch (error) {
     if (error instanceof ClientError) {
@@ -421,8 +411,33 @@ const fieldSubCommand = async (ctx: Context, { args, filesync }: { args: AddArgs
     }
   }
 
-  println({
-    ensureEmptyLineAbove: true,
-    content: `Field ${chalk.cyanBright(modelFieldsList[0]?.name)} added successfully.`,
+  println({ ensureEmptyLineAbove: true, content: `Environment ${chalk.cyanBright(newEnvName)} added successfully.` });
+
+  // Try to switch to newly made env
+  const pullFromNewEnvSyncJson = await SyncJson.load(ctx, {
+    command: "pull",
+    args: { _: [], "--app": undefined, "--allow-unknown-directory": undefined, "--allow-different-app": undefined, "--env": newEnvName },
+    directory: await loadSyncJsonDirectory(process.cwd()),
   });
+  if (pullFromNewEnvSyncJson) {
+    const filesync = new FileSync(syncJson);
+    const hashes = await filesync.hashes(ctx);
+    if (hashes.environmentChangesToPull.size === 0) {
+      println({ ensureEmptyLineAbove: true, content: "Nothing to pull." });
+      return;
+    }
+    if (hashes.localChangesToPush.size > 0) {
+      // show them the local changes they will discard
+      await filesync.print(ctx, { hashes });
+    }
+    await filesync.pull(ctx, { hashes, force: true });
+  }
+};
+
+/**
+ * Creates a default environment name based on the current date and time.
+ */
+const makeDefaultEnvName = (): string => {
+  const currentDate = new Date();
+  return `env-${currentDate.toISOString().slice(0, 10).replace(/-/g, "")}-${currentDate.toLocaleTimeString("en-US", { hour12: false }).replace(/:/g, "")}`;
 };