remove feature flag around Rover projects (#215)

Co-authored-by: Dylan Anthony <[email protected]>
apollographql · Sep 27, 2024 · 15f0104 · 15f0104
1 parent 2e56f42
commit 15f0104
Show file tree

Hide file tree

Showing 7 changed files with 164 additions and 157 deletions.
diff --git a/images/marketplace/federation-directive-hover.png b/images/marketplace/federation-directive-hover.png
diff --git a/schemas/apollo.config.schema.json b/schemas/apollo.config.schema.json
@@ -4,14 +4,31 @@
       "$ref": "#/definitions/baseConfig"
     },
     {
-      "type": "object",
-      "properties": {
-        "client": {
-          "$ref": "#/definitions/clientConfig"
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "client": {
+              "$ref": "#/definitions/clientConfig"
+            }
+          },
+          "required": [
+            "client"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "rover": {
+              "$ref": "#/definitions/roverConfig"
+            }
+          },
+          "required": [
+            "rover"
+          ],
+          "additionalProperties": false
         }
-      },
-      "required": [
-        "client"
       ]
     }
   ],
@@ -146,6 +163,36 @@
       "additionalProperties": false,
       "description": "Configuration for a Client project."
     },
+    "roverConfig": {
+      "type": "object",
+      "properties": {
+        "bin": {
+          "type": "string",
+          "description": "The path to your Rover binary. If omitted, will look in PATH."
+        },
+        "profile": {
+          "type": "string",
+          "description": "The name of the profile to use."
+        },
+        "supergraphConfig": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "The path to your `supergraph.yaml` file. \nDefaults to a `supergraph.yaml` in the folder of your `apollo.config.json`, if there is one."
+        },
+        "extraArgs": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "default": [],
+          "description": "Extra arguments to pass to the Rover CLI."
+        }
+      },
+      "additionalProperties": false,
+      "description": "Configuration for a federated project."
+    },
     "engineConfig": {
       "type": "object",
       "properties": {
@@ -173,6 +220,9 @@
         "client": {
           "description": "Configuration for a Client project."
         },
+        "rover": {
+          "description": "Configuration for a federated project."
+        },
         "service": {
           "description": "This option is no longer supported, please remove it from your configuration file."
         }

diff --git a/src/__e2e__/runTests.js b/src/__e2e__/runTests.js
@@ -18,7 +18,6 @@ async function main() {
     const TEST_PORT = 7096;
     process.env.APOLLO_ENGINE_ENDPOINT = "http://localhost:7096/apollo";
     process.env.MOCK_SERVER_PORT = String(TEST_PORT);
-    process.env.APOLLO_FEATURE_FLAGS = "rover";
     disposables.push(
       ...(await Promise.all([
         runMockServer(TEST_PORT, false, loadDefaultMocks),

diff --git a/src/build.js b/src/build.js
@@ -68,7 +68,7 @@ const buildJsonSchemaPlugin = {
       const {
         configSchema,
         clientConfig,
-        // roverConfig,
+        roverConfig,
         engineConfig,
         baseConfig,
         // @ts-ignore
@@ -78,7 +78,7 @@ const buildJsonSchemaPlugin = {
         errorMessages: true,
         definitions: {
           clientConfig,
-          //roverConfig,
+          roverConfig,
           engineConfig,
           baseConfig,
         },

diff --git a/src/language-server/config/__tests__/loadConfig.ts b/src/language-server/config/__tests__/loadConfig.ts
@@ -1,24 +1,8 @@
-let { loadConfig } = require("../");
-let { ClientConfig, RoverConfig } = require("../config");
+import { loadConfig } from "../";
+import { ClientConfig, RoverConfig } from "../config";
 import * as path from "path";
 import * as fs from "fs";
 
-async function withFeatureFlags(flags: string, fn: () => void) {
-  const FF = process.env.APOLLO_FEATURE_FLAGS;
-  try {
-    process.env.APOLLO_FEATURE_FLAGS = flags;
-    jest.resetModules();
-    ({ loadConfig } = require("../"));
-    ({ ClientConfig, RoverConfig } = require("../config"));
-    return await fn();
-  } finally {
-    process.env.APOLLO_FEATURE_FLAGS = FF;
-    jest.resetModules();
-    ({ loadConfig } = require("../"));
-    ({ ClientConfig, RoverConfig } = require("../config"));
-  }
-}
-
 const makeNestedDir = (dir: string) => {
   if (fs.existsSync(dir)) return;
 
@@ -109,25 +93,24 @@ Object {
 `);
     });
 
-    it("loads with rover defaults from different dir", () =>
-      withFeatureFlags("rover", async () => {
-        writeFilesToDir(dir, {
-          "apollo.config.js": `
+    it("loads with rover defaults from different dir", async () => {
+      writeFilesToDir(dir, {
+        "apollo.config.js": `
           module.exports = {
             rover: {
             }
           }
         `,
+      });
+      fs.mkdirSync(`${dir}/bin`);
+      fs.writeFileSync(`${dir}/bin/rover`, "", { mode: 0o755 });
+      let oldPath = process.env.PATH;
+      process.env.PATH = `${dir}/bin:${oldPath}`;
+      try {
+        const config = await loadConfig({
+          configPath: dirPath,
         });
-        fs.mkdirSync(`${dir}/bin`);
-        fs.writeFileSync(`${dir}/bin/rover`, "", { mode: 0o755 });
-        let oldPath = process.env.PATH;
-        process.env.PATH = `${dir}/bin:${oldPath}`;
-        try {
-          const config = await loadConfig({
-            configPath: dirPath,
-          });
-          expect(config?.rawConfig).toMatchInlineSnapshot(`
+        expect(config?.rawConfig).toMatchInlineSnapshot(`
 Object {
   "engine": Object {
     "endpoint": "https://graphql.api.apollographql.com/api/graphql",
@@ -138,10 +121,10 @@ Object {
   },
 }
 `);
-        } finally {
-          process.env.PATH = oldPath;
-        }
-      }));
+      } finally {
+        process.env.PATH = oldPath;
+      }
+    });
 
     it("[deprecated] loads config from package.json", async () => {
       writeFilesToDir(dir, {
@@ -280,7 +263,6 @@ client:
 
       await loadConfig({
         configPath: dirPath,
-        requireConfig: true, // this is what we're testing
       });
 
       expect(spy).toHaveBeenCalledWith(
@@ -299,7 +281,7 @@ client:
       }).catch((e: any) => e);
 
       expect(error.message).toMatch(
-        /Config needs to contain a 'client' field./i,
+        /Config needs to contain either 'client' or 'rover' fields/i,
       );
     });
   });
@@ -374,18 +356,17 @@ client:
       expect(config).toBeInstanceOf(ClientConfig);
     });
 
-    it("infers rover projects from config", () =>
-      withFeatureFlags("rover", async () => {
-        writeFilesToDir(dir, {
-          "apollo.config.js": `module.exports = { rover: { bin: "/usr/bin/env" } }`,
-        });
+    it("infers rover projects from config", async () => {
+      writeFilesToDir(dir, {
+        "apollo.config.js": `module.exports = { rover: { bin: "/usr/bin/env" } }`,
+      });
 
-        const config = await loadConfig({
-          configPath: dirPath,
-        });
+      const config = await loadConfig({
+        configPath: dirPath,
+      });
 
-        expect(config).toBeInstanceOf(RoverConfig);
-      }));
+      expect(config).toBeInstanceOf(RoverConfig);
+    });
   });
 
   describe("service name", () => {