Add stack flag to FaunaCommand (#305)

* Add stack flag to FaunaCommand * Update README * Fix schema commands not getting the right secret
fauna · Oct 13, 2023 · 86c1b38 · 86c1b38
1 parent 0d24e18
commit 86c1b38
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -516,14 +516,15 @@ Create a database.
 
 USAGE
   $ fauna create-database DBNAME [--url <value>] [--timeout <value>]
-    [--secret <value>] [--endpoint <value>]
+    [--secret <value>] [--endpoint <value>] [--stack <value>]
 
 ARGUMENTS
   DBNAME  database name
 
 FLAGS
   --endpoint=<value>  Connection endpoint, from ~/.fauna-shell
   --secret=<value>    Secret key. Overrides the `secret` in ~/.fauna-shell
+  --stack=<value>     Stack to use, from a Fauna project
   --timeout=<value>   Connection timeout in milliseconds
   --url=<value>       Database URL. Overrides the `url` in ~/.fauna-shell
 
@@ -551,7 +552,7 @@ Create a key for the specified database.
 
 USAGE
   $ fauna create-key DBNAME [ROLE] [--url <value>] [--timeout <value>]
-    [--secret <value>] [--endpoint <value>]
+    [--secret <value>] [--endpoint <value>] [--stack <value>]
 
 ARGUMENTS
   DBNAME  database name
@@ -560,6 +561,7 @@ ARGUMENTS
 FLAGS
   --endpoint=<value>  Connection endpoint, from ~/.fauna-shell
   --secret=<value>    Secret key. Overrides the `secret` in ~/.fauna-shell
+  --stack=<value>     Stack to use, from a Fauna project
   --timeout=<value>   Connection timeout in milliseconds
   --url=<value>       Database URL. Overrides the `url` in ~/.fauna-shell
 
@@ -584,14 +586,15 @@ Delete a database.
 
 USAGE
   $ fauna delete-database DBNAME [--url <value>] [--timeout <value>]
-    [--secret <value>] [--endpoint <value>]
+    [--secret <value>] [--endpoint <value>] [--stack <value>]
 
 ARGUMENTS
   DBNAME  database name
 
 FLAGS
   --endpoint=<value>  Connection endpoint, from ~/.fauna-shell
   --secret=<value>    Secret key. Overrides the `secret` in ~/.fauna-shell
+  --stack=<value>     Stack to use, from a Fauna project
   --timeout=<value>   Connection timeout in milliseconds
   --url=<value>       Database URL. Overrides the `url` in ~/.fauna-shell
 
@@ -616,14 +619,15 @@ Delete a key.
 
 USAGE
   $ fauna delete-key KEYNAME [--url <value>] [--timeout <value>]
-    [--secret <value>] [--endpoint <value>]
+    [--secret <value>] [--endpoint <value>] [--stack <value>]
 
 ARGUMENTS
   KEYNAME  key name
 
 FLAGS
   --endpoint=<value>  Connection endpoint, from ~/.fauna-shell
   --secret=<value>    Secret key. Overrides the `secret` in ~/.fauna-shell
+  --stack=<value>     Stack to use, from a Fauna project
   --timeout=<value>   Connection timeout in milliseconds
   --url=<value>       Database URL. Overrides the `url` in ~/.fauna-shell
 
@@ -765,9 +769,9 @@ Evaluate the given query.
 
 USAGE
   $ fauna eval [DBNAME] [QUERY] [--url <value>] [--timeout
-    <value>] [--secret <value>] [--endpoint <value>] [--file <value>] [--stdin]
-    [--output <value>] [--format json|json-tagged|shell] [--version 4|10]
-    [--typecheck]
+    <value>] [--secret <value>] [--endpoint <value>] [--stack <value>] [--file
+    <value>] [--stdin] [--output <value>] [--format json|json-tagged|shell]
+    [--version 4|10] [--typecheck]
 
 ARGUMENTS
   DBNAME  Database name
@@ -780,6 +784,7 @@ FLAGS
                       <options: json|json-tagged|shell>
   --output=<value>    File to write output to
   --secret=<value>    Secret key. Overrides the `secret` in ~/.fauna-shell
+  --stack=<value>     Stack to use, from a Fauna project
   --stdin             Read file input from stdin. Writes to stdout by default
   --timeout=<value>   Connection timeout in milliseconds
   --typecheck         Enable typechecking
@@ -855,9 +860,9 @@ Import data to Fauna.
 
 USAGE
   $ fauna import --path <value> [--url <value>] [--timeout <value>]
-    [--secret <value>] [--endpoint <value>] [--db <value>] [--collection
-    <value>] [--type <value>] [--append] [--allow-short-rows] [--dry-run]
-    [--treat-empty-csv-cells-as empty|null]
+    [--secret <value>] [--endpoint <value>] [--stack <value>] [--db <value>]
+    [--collection <value>] [--type <value>] [--append] [--allow-short-rows]
+    [--dry-run] [--treat-empty-csv-cells-as empty|null]
 
 FLAGS
   --allow-short-rows
@@ -888,6 +893,9 @@ FLAGS
   --secret=<value>
       Secret key. Overrides the `secret` in ~/.fauna-shell
 
+  --stack=<value>
+      Stack to use, from a Fauna project
+
   --timeout=<value>
       Connection timeout in milliseconds
 
@@ -977,11 +985,12 @@ List child databases in the current database.
 
 USAGE
   $ fauna list-databases [--url <value>] [--timeout <value>] [--secret
-    <value>] [--endpoint <value>]
+    <value>] [--endpoint <value>] [--stack <value>]
 
 FLAGS
   --endpoint=<value>  Connection endpoint, from ~/.fauna-shell
   --secret=<value>    Secret key. Overrides the `secret` in ~/.fauna-shell
+  --stack=<value>     Stack to use, from a Fauna project
   --timeout=<value>   Connection timeout in milliseconds
   --url=<value>       Database URL. Overrides the `url` in ~/.fauna-shell
 
@@ -1006,11 +1015,12 @@ List keys in the current database.
 
 USAGE
   $ fauna list-keys [--url <value>] [--timeout <value>] [--secret
-    <value>] [--endpoint <value>]
+    <value>] [--endpoint <value>] [--stack <value>]
 
 FLAGS
   --endpoint=<value>  Connection endpoint, from ~/.fauna-shell
   --secret=<value>    Secret key. Overrides the `secret` in ~/.fauna-shell
+  --stack=<value>     Stack to use, from a Fauna project
   --timeout=<value>   Connection timeout in milliseconds
   --url=<value>       Database URL. Overrides the `url` in ~/.fauna-shell
 
@@ -1071,13 +1081,14 @@ Print the diff between local and remote schema.
 
 USAGE
   $ fauna schema diff [--url <value>] [--timeout <value>] [--secret
-    <value>] [--endpoint <value>] [--dir <value>]
+    <value>] [--endpoint <value>] [--stack <value>] [--dir <value>]
 
 FLAGS
   --dir=<value>       The directory of .fsl files to push. Defaults to the
                       directory of `.fauna-project`
   --endpoint=<value>  Connection endpoint, from ~/.fauna-shell
   --secret=<value>    Secret key. Overrides the `secret` in ~/.fauna-shell
+  --stack=<value>     Stack to use, from a Fauna project
   --timeout=<value>   Connection timeout in milliseconds
   --url=<value>       Database URL. Overrides the `url` in ~/.fauna-shell
 
@@ -1111,14 +1122,15 @@ Push the current project's .fsl files to Fauna.
 
 USAGE
   $ fauna schema push [--url <value>] [--timeout <value>] [--secret
-    <value>] [--endpoint <value>] [--dir <value>] [--force]
+    <value>] [--endpoint <value>] [--stack <value>] [--dir <value>] [--force]
 
 FLAGS
   --dir=<value>       The directory of .fsl files to push. Defaults to the
                       directory of `.fauna-project`
   --endpoint=<value>  Connection endpoint, from ~/.fauna-shell
   --force             Push the change without a diff or schema version check
   --secret=<value>    Secret key. Overrides the `secret` in ~/.fauna-shell
+  --stack=<value>     Stack to use, from a Fauna project
   --timeout=<value>   Connection timeout in milliseconds
   --url=<value>       Database URL. Overrides the `url` in ~/.fauna-shell
 
@@ -1149,7 +1161,7 @@ Pull a database schema's .fsl files into the current project.
 
 USAGE
   $ fauna schema pull [--url <value>] [--timeout <value>] [--secret
-    <value>] [--endpoint <value>] [--dir <value>] [--delete]
+    <value>] [--endpoint <value>] [--stack <value>] [--dir <value>] [--delete]
 
 FLAGS
   --delete            Delete .fsl files in the target directory that are not
@@ -1158,6 +1170,7 @@ FLAGS
                       directory of `.fauna-project`
   --endpoint=<value>  Connection endpoint, from ~/.fauna-shell
   --secret=<value>    Secret key. Overrides the `secret` in ~/.fauna-shell
+  --stack=<value>     Stack to use, from a Fauna project
   --timeout=<value>   Connection timeout in milliseconds
   --url=<value>       Database URL. Overrides the `url` in ~/.fauna-shell
 
@@ -1177,8 +1190,9 @@ Start an interactive shell.
 
 USAGE
   $ fauna shell [DB_PATH] [--url <value>] [--timeout <value>]
-    [--secret <value>] [--endpoint <value>] [--file <value>] [--stdin] [--output
-    <value>] [--format json|json-tagged|shell] [--version 4|10] [--typecheck]
+    [--secret <value>] [--endpoint <value>] [--stack <value>] [--file <value>]
+    [--stdin] [--output <value>] [--format json|json-tagged|shell] [--version
+    4|10] [--typecheck]
 
 ARGUMENTS
   DB_PATH  Database path
@@ -1190,6 +1204,7 @@ FLAGS
                       <options: json|json-tagged|shell>
   --output=<value>    File to write output to
   --secret=<value>    Secret key. Overrides the `secret` in ~/.fauna-shell
+  --stack=<value>     Stack to use, from a Fauna project
   --stdin             Read file input from stdin. Writes to stdout by default
   --timeout=<value>   Connection timeout in milliseconds
   --typecheck         Enable typechecking
@@ -1289,8 +1304,8 @@ Upload GraphQL schema.
 
 USAGE
   $ fauna upload-graphql-schema GRAPHQLFILEPATH [--url <value>] [--timeout <value>]
-    [--secret <value>] [--endpoint <value>] [--graphqlHost <value>]
-    [--graphqlPort <value>] [--mode merge|override|replace]
+    [--secret <value>] [--endpoint <value>] [--stack <value>] [--graphqlHost
+    <value>] [--graphqlPort <value>] [--mode merge|override|replace]
 
 ARGUMENTS
   GRAPHQLFILEPATH  Path to GraphQL schema
@@ -1302,6 +1317,7 @@ FLAGS
   --mode=<option>        [default: merge] Upload mode
                          <options: merge|override|replace>
   --secret=<value>       Secret key. Overrides the `secret` in ~/.fauna-shell
+  --stack=<value>        Stack to use, from a Fauna project
   --timeout=<value>      Connection timeout in milliseconds
   --url=<value>          Database URL. Overrides the `url` in ~/.fauna-shell
 

diff --git a/src/lib/fauna-command.js b/src/lib/fauna-command.js
@@ -282,6 +282,9 @@ FaunaCommand.flags = {
   endpoint: Flags.string({
     description: "Connection endpoint, from ~/.fauna-shell",
   }),
+  stack: Flags.string({
+    description: "Stack to use, from a Fauna project",
+  }),
 };
 
 export default FaunaCommand;
diff --git a/src/lib/schema-command.ts b/src/lib/schema-command.ts
@@ -21,13 +21,11 @@ export default abstract class SchemaCommand extends FaunaCommand {
   };
 
   async fetchsetup() {
-    const {
-      connectionOptions: { url, secret },
-    } = await this.getClient();
+    const { connectionOptions } = await this.getClient();
 
     return {
-      url,
-      secret,
+      url: connectionOptions.url,
+      secret: connectionOptions.secret.buildSecret(),
     };
   }