Refactor Account API support and container management (#556)

* Support v2 account API error shapes
* Update account client to support v2 api calls
* Move container to a singleton in config rather than cli
* Wire clientId/clientSecret argv through to OAuthClient

src/cli.mjs

@@ -13,21 +13,19 @@ import loginCommand from "./commands/login.mjs";
 import queryCommand from "./commands/query.mjs";
 import schemaCommand from "./commands/schema/schema.mjs";
 import shellCommand from "./commands/shell.mjs";
+import { container, setContainer } from "./config/container.mjs";
 import { buildCredentials } from "./lib/auth/credentials.mjs";
 import { getDbCompletions, getProfileCompletions } from "./lib/completions.mjs";
 import { configParser } from "./lib/config/config.mjs";
 import { handleParseYargsError } from "./lib/errors.mjs";
 import {
+  applyAccountUrl,
   applyLocalArg,
   checkForUpdates,
   fixPaths,
   logArgv,
 } from "./lib/middleware.mjs";
 
-/** @typedef {import('awilix').AwilixContainer<import('./config/setup-container.mjs').modifiedInjectables> } cliContainer */
-
-/** @type {cliContainer} */
-export let container;
 /** @type {import('yargs').Argv} */
 export let builtYargs;
 
@@ -36,10 +34,11 @@ const __dirname = path.dirname(__filename);
 
 /**
  * @param {string|string[]} _argvInput - The command string provided by the user or test. Parsed by yargs into an argv object.
- * @param {cliContainer} _container - A built and ready for use awilix container with registered injectables.
+ * @param {import('./config/container.mjs').container} container - A built and ready for use awilix container with registered injectables.
  */
-export async function run(_argvInput, _container) {
-  container = _container;
+export async function run(_argvInput, container) {
+  setContainer(container);
+
   const argvInput = _argvInput;
   const logger = container.resolve("logger");
   const parseYargs = container.resolve("parseYargs");
@@ -111,7 +110,10 @@ function buildYargs(argvInput) {
     .env("FAUNA")
     .config("config", configParser.bind(null, argvInput))
     .middleware([checkForUpdates, logArgv], true)
-    .middleware([applyLocalArg, fixPaths, buildCredentials], false)
+    .middleware(
+      [applyLocalArg, fixPaths, applyAccountUrl, buildCredentials],
+      false,
+    )
     .command(queryCommand)
     .command(shellCommand)
     .command(loginCommand)

src/commands/database/create.mjs

@@ -1,7 +1,7 @@
 //@ts-check
 import { ServiceError } from "fauna";
 
-import { container } from "../../cli.mjs";
+import { container } from "../../config/container.mjs";
 import { CommandError } from "../../lib/errors.mjs";
 import { faunaToCommandError } from "../../lib/fauna.mjs";
 import { getSecret, retryInvalidCredsOnce } from "../../lib/fauna-client.mjs";

src/commands/database/delete.mjs

@@ -2,7 +2,7 @@
 
 import { ServiceError } from "fauna";
 
-import { container } from "../../cli.mjs";
+import { container } from "../../config/container.mjs";
 import { CommandError } from "../../lib/errors.mjs";
 import { faunaToCommandError } from "../../lib/fauna.mjs";
 import { getSecret, retryInvalidCredsOnce } from "../../lib/fauna-client.mjs";

src/commands/database/list.mjs

@@ -1,15 +1,14 @@
 //@ts-check
 import chalk from "chalk";
 
-import { container } from "../../cli.mjs";
+import { container } from "../../config/container.mjs";
 import { faunaToCommandError } from "../../lib/fauna.mjs";
-import { FaunaAccountClient } from "../../lib/fauna-account-client.mjs";
 import { colorize, Format } from "../../lib/formatting/colorize.mjs";
 
 async function listDatabasesWithAccountAPI(argv) {
   const { pageSize, database } = argv;
-  const accountClient = new FaunaAccountClient();
-  const response = await accountClient.listDatabases({
+  const { listDatabases } = container.resolve("accountAPI");
+  const response = await listDatabases({
     pageSize,
     path: database,
   });

src/commands/local.mjs

@@ -1,8 +1,8 @@
 import chalk from "chalk";
 import { AbortError } from "fauna";
 
-import { container } from "../cli.mjs";
 import { pushSchema } from "../commands/schema/push.mjs";
+import { container } from "../config/container.mjs";
 import { ensureContainerRunning } from "../lib/docker-containers.mjs";
 import { CommandError, ValidationError } from "../lib/errors.mjs";
 import { colorize, Format } from "../lib/formatting/colorize.mjs";

src/commands/login.mjs

@@ -1,7 +1,7 @@
 //@ts-check
 
-import { container } from "../cli.mjs";
-import { FaunaAccountClient } from "../lib/fauna-account-client.mjs";
+import { container } from "../config/container.mjs";
+import { getToken, startOAuthRequest } from "../lib/account-api.mjs";
 
 async function doLogin(argv) {
   const logger = container.resolve("logger");
@@ -13,16 +13,29 @@ async function doLogin(argv) {
   const credentials = container.resolve("credentials");
   const oAuth = container.resolve("oauthClient");
   oAuth.server.on("ready", async () => {
-    const authCodeParams = oAuth.getOAuthParams();
-    const dashboardOAuthURL =
-      await FaunaAccountClient.startOAuthRequest(authCodeParams);
+    const authCodeParams = oAuth.getOAuthParams({ clientId: argv.clientId });
+    const dashboardOAuthURL = await startOAuthRequest(authCodeParams);
     open(dashboardOAuthURL);
     logger.stdout(`To login, open your browser to:\n${dashboardOAuthURL}`);
   });
   oAuth.server.on("auth_code_received", async () => {
     try {
-      const tokenParams = oAuth.getTokenParams();
-      const accessToken = await FaunaAccountClient.getToken(tokenParams);
+      const { clientId, clientSecret, authCode, redirectURI, codeVerifier } =
+        oAuth.getTokenParams({
+          clientId: argv.clientId,
+          clientSecret: argv.clientSecret,
+        });
+
+      /* eslint-disable camelcase */
+      const accessToken = await getToken({
+        client_id: clientId,
+        client_secret: clientSecret,
+        code: authCode,
+        redirect_uri: redirectURI,
+        code_verifier: codeVerifier,
+      });
+      /* eslint-enable camelcase */
+
       await credentials.login(accessToken);
     } catch (err) {
       logger.stderr(err);

src/commands/query.mjs

@@ -1,6 +1,6 @@
 //@ts-check
 
-import { container } from "../cli.mjs";
+import { container } from "../config/container.mjs";
 import {
   CommandError,
   isUnknownError,

src/commands/schema/abandon.mjs

@@ -1,6 +1,6 @@
 //@ts-check
 
-import { container } from "../../cli.mjs";
+import { container } from "../../config/container.mjs";
 import { CommandError } from "../../lib/errors.mjs";
 import { getSecret } from "../../lib/fauna-client.mjs";
 

src/commands/schema/commit.mjs

@@ -1,6 +1,6 @@
 //@ts-check
 
-import { container } from "../../cli.mjs";
+import { container } from "../../config/container.mjs";
 import { CommandError } from "../../lib/errors.mjs";
 import { getSecret } from "../../lib/fauna-client.mjs";
 

src/commands/schema/diff.mjs

@@ -2,7 +2,7 @@
 
 import chalk from "chalk";
 
-import { container } from "../../cli.mjs";
+import { container } from "../../config/container.mjs";
 import { ValidationError } from "../../lib/errors.mjs";
 import { getSecret } from "../../lib/fauna-client.mjs";
 import { reformatFSL } from "../../lib/schema.mjs";

src/commands/schema/pull.mjs

@@ -1,6 +1,6 @@
 //@ts-check
 
-import { container } from "../../cli.mjs";
+import { container } from "../../config/container.mjs";
 import { getSecret } from "../../lib/fauna-client.mjs";
 import { LOCAL_SCHEMA_OPTIONS } from "./schema.mjs";
 

src/commands/schema/push.mjs

@@ -2,7 +2,7 @@
 
 import path from "path";
 
-import { container } from "../../cli.mjs";
+import { container } from "../../config/container.mjs";
 import { ValidationError } from "../../lib/errors.mjs";
 import { getSecret } from "../../lib/fauna-client.mjs";
 import { reformatFSL } from "../../lib/schema.mjs";

src/commands/schema/status.mjs

@@ -3,7 +3,7 @@
 import chalk from "chalk";
 import path from "path";
 
-import { container } from "../../cli.mjs";
+import { container } from "../../config/container.mjs";
 import { CommandError } from "../../lib/errors.mjs";
 import { getSecret } from "../../lib/fauna-client.mjs";
 import { reformatFSL } from "../../lib/schema.mjs";

src/commands/shell.mjs

@@ -5,7 +5,7 @@ import repl from "node:repl";
 
 import * as esprima from "esprima";
 
-import { container } from "../cli.mjs";
+import { container } from "../config/container.mjs";
 import { formatQueryResponse, getSecret } from "../lib/fauna-client.mjs";
 import { clearHistoryStorage, initHistoryStorage } from "../lib/file-util.mjs";
 import { validateDatabaseOrSecret } from "../lib/middleware.mjs";

src/config/container.mjs

@@ -0,0 +1,10 @@
+/** @typedef {import('awilix').AwilixContainer<import('./config/setup-container.mjs').modifiedInjectables> } container */
+/** @type {container} */
+export let container;
+
+/**
+ * @param {container} newContainer - The new container to set.
+ */
+export const setContainer = (newContainer) => {
+  container = newContainer;
+};

src/config/setup-container.mjs

@@ -15,10 +15,10 @@ import open from "open";
 import updateNotifier from "update-notifier";
 
 import { parseYargs } from "../cli.mjs";
-import { makeAccountRequest } from "../lib/account.mjs";
+import accountAPI from "../lib/account-api.mjs";
 import { Credentials } from "../lib/auth/credentials.mjs";
 import OAuthClient from "../lib/auth/oauth-client.mjs";
-import { makeRetryableFaunaRequest } from "../lib/db.mjs";
+import { makeRetryableFaunaRequest } from "../lib/core-api.mjs";
 import * as faunaV10 from "../lib/fauna.mjs";
 import {
   formatError,
@@ -73,7 +73,6 @@ export const injectables = {
   updateNotifier: awilix.asValue(updateNotifier),
   fauna: awilix.asValue(fauna),
   faunadb: awilix.asValue(faunadb),
-  codeToAnsi: awilix.asValue(codeToAnsi),
 
   // generic lib (homemade utilities)
   parseYargs: awilix.asValue(parseYargs),
@@ -86,8 +85,9 @@ export const injectables = {
     },
     { lifetime: Lifetime.SINGLETON },
   ),
+  codeToAnsi: awilix.asValue(codeToAnsi),
   oauthClient: awilix.asClass(OAuthClient, { lifetime: Lifetime.SCOPED }),
-  makeAccountRequest: awilix.asValue(makeAccountRequest),
+  accountAPI: awilix.asValue(accountAPI),
   makeFaunaRequest: awilix.asValue(makeRetryableFaunaRequest),
   errorHandler: awilix.asValue((_error, exitCode) => exit(exitCode)),
 
@@ -96,6 +96,7 @@ export const injectables = {
   credentials: awilix.asClass(Credentials, {
     lifetime: Lifetime.SINGLETON,
   }),
+
   // utilities for interacting with Fauna
   runQueryFromString: awilix.asValue(runQueryFromString),
   formatError: awilix.asValue(formatError),

src/config/setup-test-container.mjs

@@ -9,7 +9,7 @@ import { spy, stub } from "sinon";
 
 import { f, InMemoryWritableStream } from "../../test/helpers.mjs";
 import { parseYargs } from "../cli.mjs";
-import { makeRetryableFaunaRequest } from "../lib/db.mjs";
+import { makeRetryableFaunaRequest } from "../lib/core-api.mjs";
 import * as faunaClientV10 from "../lib/fauna.mjs";
 import { formatQueryInfo } from "../lib/fauna-client.mjs";
 import * as faunaClientV4 from "../lib/faunadb.mjs";
@@ -79,11 +79,6 @@ export function setupTestContainer() {
     }),
     codeToAnsi: awilix.asValue(stub().returnsArg(0)),
     logger: awilix.asFunction((cradle) => spy(buildLogger(cradle))).singleton(),
-    AccountClient: awilix.asValue(() => ({
-      startOAuthRequest: stub(),
-      getToken: stub(),
-      getSession: stub(),
-    })),
     oauthClient: awilix.asFunction(stub()),
     docker: awilix.asValue({
       createContainer: stub(),
@@ -96,6 +91,12 @@ export function setupTestContainer() {
       pull: stub(),
     }),
     credentials: awilix.asClass(stub()).singleton(),
+    accountAPI: awilix.asValue({
+      listDatabases: stub(),
+      createKey: stub(),
+      refreshSession: stub(),
+      getSession: stub(),
+    }),
     errorHandler: awilix.asValue((error, exitCode) => {
       error.code = exitCode;
       throw error;
@@ -104,7 +105,6 @@ export function setupTestContainer() {
     fetch: awilix.asValue(stub().resolves(f({}))),
     gatherFSL: awilix.asValue(stub().resolves([])),
     makeFaunaRequest: awilix.asValue(spy(makeRetryableFaunaRequest)),
-    makeAccountRequest: awilix.asValue(stub()),
     runQueryFromString: awilix.asValue(stub().resolves({})),
     isQueryable: awilix.asValue(stub().resolves()),
     formatError: awilix.asValue(stub()),