Test --include options

src/commands/query.mjs

@@ -13,7 +13,6 @@ import {
 } from "../lib/errors.mjs";
 import {
   formatError,
-  formatQueryInfo,
   formatQueryResponse,
   getSecret,
 } from "../lib/fauna-client.mjs";
@@ -71,6 +70,7 @@ const resolveInput = (argv) => {
 };
 
 async function queryCommand(argv) {
+  const formatQueryInfo = container.resolve("formatQueryInfo");
   const logger = container.resolve("logger");
 
   // Run validation here instead of via check for more control over output

src/commands/shell.mjs

@@ -12,11 +12,7 @@
   validateDatabaseOrSecret,
   yargsWithCommonConfigurableQueryOptions,
 } from "../lib/command-helpers.mjs";
-import {
-  formatQueryInfo,
-  formatQueryResponse,
-  getSecret,
-} from "../lib/fauna-client.mjs";
+import { formatQueryResponse, getSecret } from "../lib/fauna-client.mjs";
 import { clearHistoryStorage, initHistoryStorage } from "../lib/file-util.mjs";
 
 async function shellCommand(argv) {
@@ -39,7 +35,7 @@
     prompt: `${argv.database || ""}> `,
     ignoreUndefined: true,
     preview: argv.apiVersion !== "10",
     // TODO: integrate with fql-analyzer for completions
     completer: argv.apiVersion === "10" ? () => [] : undefined,
     output: container.resolve("stdoutStream"),
     input: container.resolve("stdinStream"),
@@ -150,8 +146,9 @@
 
 // caches the logger, client, and performQuery for subsequent shell calls
 async function buildCustomEval(argv) {
-  const runQueryFromString = container.resolve("runQueryFromString");
   const formatError = container.resolve("formatError");
+  const formatQueryInfo = container.resolve("formatQueryInfo");
+  const runQueryFromString = container.resolve("runQueryFromString");
 
   return async (cmd, ctx, _filename, cb) => {
     try {

src/config/setup-container.mjs

@@ -22,6 +22,7 @@ import { makeRetryableFaunaRequest } from "../lib/db.mjs";
 import * as faunaV10 from "../lib/fauna.mjs";
 import {
   formatError,
+  formatQueryInfo,
   isQueryable,
   runQueryFromString,
 } from "../lib/fauna-client.mjs";
@@ -98,6 +99,7 @@ export const injectables = {
   // utilities for interacting with Fauna
   runQueryFromString: awilix.asValue(runQueryFromString),
   formatError: awilix.asValue(formatError),
+  formatQueryInfo: awilix.asValue(formatQueryInfo),
   faunaClientV10: awilix.asValue(faunaV10),
   faunaClientV4: awilix.asValue(faunaV4),
   isQueryable: awilix.asValue(isQueryable),

src/config/setup-test-container.mjs

@@ -11,6 +11,7 @@ import { f, InMemoryWritableStream } from "../../test/helpers.mjs";
 import { parseYargs } from "../cli.mjs";
 import { makeRetryableFaunaRequest } from "../lib/db.mjs";
 import * as faunaClientV10 from "../lib/fauna.mjs";
+import { formatQueryInfo } from "../lib/fauna-client.mjs";
 import * as faunaClientV4 from "../lib/faunadb.mjs";
 import buildLogger from "../lib/logger.mjs";
 import { injectables, setupCommonContainer } from "./setup-container.mjs";
@@ -106,6 +107,7 @@ export function setupTestContainer() {
     runQueryFromString: awilix.asValue(stub().resolves({})),
     isQueryable: awilix.asValue(stub().resolves()),
     formatError: awilix.asValue(stub()),
+    formatQueryInfo: awilix.asValue(spy(formatQueryInfo)),
     faunaClientV10: awilix.asValue({
       getClient: stub(),
       runQuery: stub(),

test/query.mjs

@@ -6,6 +6,7 @@ import sinon from "sinon";
 
 import { run } from "../src/cli.mjs";
 import { setupTestContainer as setupContainer } from "../src/config/setup-test-container.mjs";
+import { QUERY_INFO_CHOICES } from "../src/lib/command-helpers.mjs";
 import { NETWORK_ERROR_MESSAGE } from "../src/lib/errors.mjs";
 import { colorize } from "../src/lib/formatting/colorize.mjs";
 import {
@@ -321,9 +322,44 @@ describe("query", function () {
     });
 
     // Add FormatQueryInfo to container in order to test which options are were passed
-    it.skip("can set the include option to an array");
-    it.skip("can specify '--include all' to set all include options");
-    it.skip("can specify '--include none' to set no include options");
+    it("can set the include option to '[summary]' by default", async function () {
+      const formatQueryInfo = container.resolve("formatQueryInfo");
+
+      await run(`query "foo" --secret=foo`, container);
+
+      expect(formatQueryInfo.getCall(0).args[1].include).to.deep.equal([
+        "summary",
+      ]);
+    });
+
+    it("can set the include option to an array", async function () {
+      const formatQueryInfo = container.resolve("formatQueryInfo");
+
+      await run(`query "foo" --secret=foo --include summary stats`, container);
+
+      expect(formatQueryInfo.getCall(0).args[1].include).to.deep.equal([
+        "summary",
+        "stats",
+      ]);
+    });
+
+    it("can specify '--include all' to set all include options", async function () {
+      const formatQueryInfo = container.resolve("formatQueryInfo");
+
+      await run(`query "foo" --secret=foo --include all`, container);
+
+      expect(formatQueryInfo.getCall(0).args[1].include).to.deep.equal(
+        QUERY_INFO_CHOICES,
+      );
+    });
+
+    it("can specify '--include none' to set no include options", async function () {
+      const formatQueryInfo = container.resolve("formatQueryInfo");
+
+      await run(`query "foo" --secret=foo --include none`, container);
+
+      expect(formatQueryInfo).to.not.be.called;
+    });
 
     it("displays summary by default", async function () {
       runQueryFromString.resolves({