fix Connected to undefined message (#284)

* fix Connected to undefined message ENG-5604 * add connection message to all commands ENG-5630 This will display the endpoint and database being connected to when ever a CLI command is executed. * fix tests * allow cmds to opt out of connection info For eval, we currently output json. Entering a log line can make the output invalid json and could possibly break tooling people have around it. This allows commands to opt out of the connection info logging.
fauna · Oct 10, 2023 · c87a0c9 · c87a0c9
1 parent 759b993
commit c87a0c9
Show file tree

Hide file tree

Showing 7 changed files with 71 additions and 40 deletions.
diff --git a/src/commands/eval.js b/src/commands/eval.js
@@ -55,6 +55,8 @@ async function writeFormattedOutput(file, data, format) {
 class EvalCommand extends FaunaCommand {
   static description = "Evaluate the given query.";
 
+  outputConnectionInfo = false;
+
   async run() {
     const queryFromStdin = this.flags.stdin;
     let queriesFile = this.flags.file;
@@ -71,7 +73,10 @@ class EvalCommand extends FaunaCommand {
 
     try {
       const { client } = await (dbname
-        ? this.ensureDbScopeClient({ scope: dbname, version: this.flags.version })
+        ? this.ensureDbScopeClient({
+            scope: dbname,
+            version: this.flags.version,
+          })
         : this.getClient({ version: this.flags.version }));
 
       const readQuery = queryFromStdin || queriesFile !== undefined;

diff --git a/src/commands/shell.js b/src/commands/shell.js
@@ -1,5 +1,5 @@
 const FaunaCommand = require("../lib/fauna-command.js").default;
-const { runQueries, stringifyEndpoint } = require("../lib/misc.js");
+const { runQueries } = require("../lib/misc.js");
 const faunadb = require("faunadb");
 const { Flags, Args } = require("@oclif/core");
 const q = faunadb.query;
@@ -41,9 +41,6 @@ class ShellCommand extends EvalCommand {
       this.log(`Starting shell for database ${db_path}`);
     }
 
-    this.log(
-      `Connected to ${stringifyEndpoint(this.connection.connectionOptions)}`
-    );
     this.log("Type Ctrl+D or .exit to exit the shell");
 
     this.repl = repl.start({

diff --git a/src/lib/config/index.ts b/src/lib/config/index.ts
@@ -120,6 +120,11 @@ export type ShellOpts = {
 export type EndpointConfig = {
   secret: string;
   url: string;
+  /** this is currently just used for messaging purposes, the secret
+   * in this config will already contain the database path if needed.
+   */
+  database?: string;
+  name?: string;
   graphqlHost: string;
   graphqlPort: number;
 };

diff --git a/src/lib/config/root-config.ts b/src/lib/config/root-config.ts
@@ -1,4 +1,4 @@
-import { Config, InvalidConfigError } from ".";
+import { Config, EndpointConfig, InvalidConfigError } from ".";
 import fs from "fs";
 const ini = require("ini");
 
@@ -23,13 +23,13 @@ export class RootConfig {
       this.endpoints = Object.fromEntries<Endpoint>(
         config
           .objectsIn("endpoint")
-          .map(([k, v]) => [k, Endpoint.fromConfig(v)])
+          .map(([k, v]) => [k, Endpoint.fromConfig(k, v)])
       );
     } else {
       this.endpoints = Object.fromEntries<Endpoint>(
         config
           .allObjectsWhere((k) => k !== "default")
-          .map(([k, v]) => [k, Endpoint.fromConfig(v)])
+          .map(([k, v]) => [k, Endpoint.fromConfig(k, v)])
       );
     }
 
@@ -101,14 +101,16 @@ export class RootConfig {
  * - An optional GraphQL port. This is the port to use for GraphQL requests. It defaults to `443`.
  */
 export class Endpoint {
+  name?: string;
   secret: string;
   url: string;
 
   graphqlHost: string;
   graphqlPort: number;
 
-  static fromConfig(config: Config) {
+  static fromConfig(name: string, config: Config) {
     return new Endpoint({
+      name: name,
       secret: config.str("secret"),
       url: Endpoint.getURLFromConfig(config),
 
@@ -118,41 +120,40 @@ export class Endpoint {
   }
 
   constructor(opts: {
+    name?: string;
     secret: string;
     url?: string;
     graphqlHost?: string;
     graphqlPort?: number;
   }) {
+    this.name = opts.name;
     this.secret = opts.secret;
     this.url = opts.url ?? "https://db.fauna.com";
 
     this.graphqlHost = opts.graphqlHost ?? "graphql.fauna.com";
     this.graphqlPort = opts.graphqlPort ?? 443;
   }
 
-  makeScopedEndpoint(
-    scope?: string,
-    role?: string
-  ): {
-    secret: string;
-    url: string;
-    graphqlHost: string;
-    graphqlPort: number;
-  } {
+  makeScopedEndpoint(databaseScope?: string, role?: string): EndpointConfig {
     let appendedRoleStr = "";
     if (role) {
       appendedRoleStr = `:${role}`;
-    } else if (scope) {
+    } else if (databaseScope) {
       appendedRoleStr = ":admin";
     }
 
-    const secret = this.secret + (scope ? `:${scope}` : "") + appendedRoleStr;
+    const secret =
+      this.secret +
+      (databaseScope ? `:${databaseScope}` : "") +
+      appendedRoleStr;
 
     return {
       secret,
+      name: this.name,
       url: this.url,
       graphqlHost: this.graphqlHost,
       graphqlPort: this.graphqlPort,
+      database: databaseScope,
     };
   }
 

diff --git a/src/lib/fauna-command.js b/src/lib/fauna-command.js
@@ -1,6 +1,5 @@
 import { Command, Flags } from "@oclif/core";
 import { ShellConfig } from "./config";
-import { stringifyEndpoint } from "./misc";
 import { query as q, errors, Client } from "faunadb";
 import { green } from "chalk";
 import FaunaClient from "./fauna-client";
@@ -12,6 +11,13 @@ import fetch from "node-fetch";
 class FaunaCommand extends Command {
   clients = {};
 
+  /**
+   * This is used to determine if the command should log the connection info.
+   * We currently want to avoid doing this for eval since it can lead to the
+   * response not being JSON parseable.
+   */
+  outputConnectionInfo = true;
+
   /**
    * During init we parse the flags and arguments and assign them
    * to the `flags` and `args` member variables.
@@ -84,16 +90,37 @@ class FaunaCommand extends Command {
 
   mapConnectionError({ err, connectionOptions }) {
     if (err instanceof errors.Unauthorized) {
-      return this.error(
-        `Could not Connect to ${stringifyEndpoint(
-          connectionOptions
-        )} Unauthorized Secret`
+      this.error(
+        `Could not Connect to ${connectionOptions.url} Unauthorized Secret`
       );
     }
-    return this.error(err);
+    this.error(err);
   }
 
   async getClient({ dbScope, role, version } = {}) {
+    const logConnectionMessage = (connectionOptions) => {
+      if (this.outputConnectionInfo) {
+        let connectedMessage;
+        if (connectionOptions.name !== undefined) {
+          connectedMessage = `Connected to endpoint: ${connectionOptions.name}`;
+          if (
+            connectionOptions.database !== undefined &&
+            connectionOptions.database !== ""
+          ) {
+            connectedMessage += ` database: ${connectionOptions.database}`;
+          }
+        } else if (
+          connectionOptions.database !== undefined &&
+          connectionOptions.database !== ""
+        ) {
+          connectedMessage = `Connected to database: ${connectionOptions.database}`;
+        }
+        if (connectedMessage !== undefined) {
+          this.log(connectedMessage);
+        }
+      }
+    };
+
     if (version === "4" || version === undefined) {
       // construct v4 client
       let connectionOptions;
@@ -128,9 +155,10 @@ class FaunaCommand extends Command {
 
         const hashKey = [dbScope, role].join("_");
         this.clients[hashKey] = { client, connectionOptions };
+        logConnectionMessage(connectionOptions);
         return this.clients[hashKey];
       } catch (err) {
-        return this.mapConnectionError({ err, connectionOptions });
+        this.mapConnectionError({ err, connectionOptions });
       }
     } else {
       // construct v10 client
@@ -156,9 +184,10 @@ class FaunaCommand extends Command {
           client,
           connectionOptions,
         };
+        logConnectionMessage(connectionOptions);
         return this.clients[hashKey];
       } catch (err) {
-        return this.mapConnectionError({ err, connectionOptions });
+        this.mapConnectionError({ err, connectionOptions });
       }
     }
   }

diff --git a/src/lib/misc.js b/src/lib/misc.js
@@ -382,15 +382,3 @@ export function runQueries(expressions, client) {
     return promiseSerial(wrapQueries(expressions, client));
   }
 }
-
-export function stringifyEndpoint(endpoint) {
-  var res = "";
-  if (endpoint.scheme) {
-    res += endpoint.scheme + "://";
-  }
-  res += endpoint.domain;
-  if (endpoint.port) {
-    res += ":" + endpoint.port;
-  }
-  return res;
-}
diff --git a/test/commands/endpoint.test.ts b/test/commands/endpoint.test.ts
@@ -55,13 +55,15 @@ describe("endpoint:add", () => {
           "my-endpoint": {
             url: "http://bar.baz",
             secret: "fn3333",
+            name: "my-endpoint",
             // These graphql bits are only saved if they differ from the
             // default.
             graphqlHost: "graphql.fauna.com",
             graphqlPort: 443,
           },
           foobar: {
             url: "http://foo.baz",
+            name: undefined,
             secret: "fn1234",
             graphqlHost: "graphql.fauna.com",
             graphqlPort: 443,
@@ -106,6 +108,7 @@ describe("endpoint:add", () => {
           "my-endpoint": {
             url: "http://bar.baz",
             secret: "fn3333",
+            name: "my-endpoint",
             // These graphql bits are only saved if they differ from the
             // default.
             graphqlHost: "graphql.fauna.com",
@@ -114,6 +117,7 @@ describe("endpoint:add", () => {
           foobar: {
             url: "http://foo.baz",
             secret: "fn1234",
+            name: undefined,
             graphqlHost: "graphql.fauna.com",
             graphqlPort: 443,
           },
@@ -180,6 +184,7 @@ describe("endpoint:remove", () => {
           "my-endpoint": {
             url: "http://bar.baz",
             secret: "fn3333",
+            name: "my-endpoint",
             // These graphql bits are only saved if they differ from the
             // default.
             graphqlHost: "graphql.fauna.com",
@@ -218,6 +223,7 @@ describe("endpoint:remove", () => {
           "other-endpoint": {
             url: "http://bar.baz",
             secret: "fn3333",
+            name: "other-endpoint",
             // These graphql bits are only saved if they differ from the
             // default.
             graphqlHost: "graphql.fauna.com",