Full names

.github/CONTRIBUTING.md

@@ -2,8 +2,8 @@
 
 1. Create a new directory in the `gateways` folder with the name of the new gateway.
 2. Prepare the `install.sh` script that will install the necessary dependencies, the gateway itself.
-3. Create the `run.sh` script that will start the gateway. See an example using [supergraph.graphql](../gateways/grafbase/run.sh) and [subgraphs information](../gateways/cosmo/run.sh).
-4. Add the `gateway.json` file with the necessary information about the gateway. See an example [here](../gateways/hive/gateway.json).
+3. Create the `run.sh` script that will start the gateway. See an example using [supergraph.graphql](../gateways/grafbase-gateway/run.sh) and [subgraphs information](../gateways/cosmo-router/run.sh).
+4. Add the `gateway.json` file with the necessary information about the gateway. See an example [here](../gateways/hive-gateway/gateway.json).
 5. The `.gitignore` should be created as well to avoid committing unnecessary files.
 6. Execute `make test-[name of the gateway]` to test your gateway.
 7. Run `make summary` to include your gateway in the results.

.github/workflows/ci.yaml

@@ -28,7 +28,7 @@ jobs:
         run: make install
 
       - name: Test
-        run: npm start -- test --cwd ./gateways/hive --run-script ./run.sh  --reporter tap --graphql http://127.0.0.1:4000/graphql --healthcheck http://127.0.0.1:4000/healthcheck --exit-on-fail
+        run: npm start -- test --cwd ./gateways/hive-gateway --run-script ./run.sh  --reporter tap --graphql http://127.0.0.1:4000/graphql --healthcheck http://127.0.0.1:4000/healthcheck --exit-on-fail
 
   gateways:
     runs-on: ubuntu-latest

README.md

@@ -83,10 +83,10 @@ You can run the tests for a specific gateway by running the following command:
 ```bash
 make test-[name of the gateway]
 
-make test-grafbase
-make test-cosmo
-make test-hive
-make test-router
+make test-grafbase-gateway
+make test-cosmo-router
+make test-hive-gateway
+make test-apollo-router
 ```
 
 ### Running a gateway for a single test suite

REPORT.md

@@ -17,7 +17,7 @@ Take a closer look at the results for each gateway.
 
 You can look at the full list of tests [here](./src/test-suites/). Every test id corresponds to a directory in the `src/test-suites` folder.
 
-<a id="hive"></a>
+<a id="hive-gateway"></a>
 
 ### Hive Gateway
 
@@ -108,7 +108,7 @@ You can look at the full list of tests [here](./src/test-suites/). Every test id
 <pre>🟢🟢🟢🟢🟢🟢🟢🟢</pre>
 </details>
 
-<a id="router"></a>
+<a id="apollo-router"></a>
 
 ### Apollo Router
 
@@ -290,7 +290,7 @@ You can look at the full list of tests [here](./src/test-suites/). Every test id
 <pre>🟢🟢🟢🟢🟢🟢🟢🟢</pre>
 </details>
 
-<a id="router-native"></a>
+<a id="apollo-router-native"></a>
 
 ### Apollo Router (native QP)
 
@@ -381,7 +381,7 @@ You can look at the full list of tests [here](./src/test-suites/). Every test id
 <pre>🟢🟢🟢🟢🟢🟢🟢🟢</pre>
 </details>
 
-<a id="cosmo"></a>
+<a id="cosmo-router"></a>
 
 ### Cosmo Router
 
@@ -472,7 +472,7 @@ You can look at the full list of tests [here](./src/test-suites/). Every test id
 <pre>❌❌❌❌❌❌❌❌</pre>
 </details>
 
-<a id="grafbase"></a>
+<a id="grafbase-gateway"></a>
 
 ### Grafbase Gateway
 

gateways/apollo-router-native/install.sh

@@ -0,0 +1 @@
+curl -sSL https://router.apollo.dev/download/nix/v2.0.0-alpha.3 | sh

gateways/apollo-router-native/run.sh

@@ -0,0 +1,2 @@
+npm start supergraph -- --cwd ./gateways/apollo-router-native --test $1
+./router --supergraph supergraph.graphql --config router.yaml

gateways/apollo-router/install.sh

@@ -0,0 +1 @@
+curl -sSL https://router.apollo.dev/download/nix/v2.0.0-alpha.3 | sh

gateways/apollo-router/run.sh

@@ -0,0 +1,2 @@
+npm start supergraph -- --cwd ./gateways/apollo-router --test $1
+./router --supergraph supergraph.graphql --config router.yaml

gateways/cosmo/run.sh → gateways/cosmo-router/run.sh

@@ -1,4 +1,4 @@
-npm start subgraphs -- --cwd ./gateways/cosmo --test $1
+npm start subgraphs -- --cwd ./gateways/cosmo-router --test $1
 npx tsx ./wgc.js
 npx wgc router compose -i compose.yaml -o config.json
 ./cosmo

gateways/grafbase/run.sh → gateways/grafbase-gateway/run.sh

@@ -1,2 +1,2 @@
-npm start supergraph -- --cwd ./gateways/grafbase --test $1
+npm start supergraph -- --cwd ./gateways/grafbase-gateway --test $1
 __GRAFBASE_RUST_LOG=engine_v2=trace ./grafbase-gateway --schema supergraph.graphql --listen-address 127.0.0.1:4000 -c grafbase.toml --log trace

gateways/hive/run.sh → gateways/hive-gateway/run.sh

@@ -1,2 +1,2 @@
-npm start supergraph -- --cwd ./gateways/hive --test $1
+npm start supergraph -- --cwd ./gateways/hive-gateway --test $1
 npx --yes @graphql-hive/[email protected] supergraph supergraph.graphql --port 4000 --fork 1

makefile

@@ -19,6 +19,7 @@ run-$(1):
 	npm start -- start --test $(TEST_SUITE) --cwd ./gateways/$(1) --run-script ./run.sh --graphql $(shell jq -r .graphql ./gateways/$(1)/gateway.json) --healthcheck $(shell jq -r .health ./gateways/$(1)/gateway.json)
 endef
 
+# Install all dependencies of the project and the gateways
 install:
 	npm install
 	@for dir in ./gateways/*; do \
@@ -29,6 +30,7 @@ install:
 		fi; \
 	done
 
+# Start only the subgraphs, no gateway
 subgraphs:
 	npm start -- serve
 
@@ -37,7 +39,9 @@ $(foreach gateway,$(GATEWAY_IDS),$(eval $(call TEST_GATEWAY,$(gateway))))
 $(foreach gateway,$(GATEWAY_IDS),$(eval $(call RUN_GATEWAY,$(gateway))))
 $(foreach gateway,$(GATEWAY_IDS),$(eval $(call TEST_SUITE_GATEWAY,$(gateway))))
 
+# Run the tests for all gateways
 test-all: $(addprefix test-,$(GATEWAY_IDS)) summary
 
+# Update the report
 summary:
 	npm run summary

src/cli.ts

@@ -390,7 +390,7 @@ yargs(hideBin(process.argv))
         result: Array<"." | "X">;
       }> = [];
 
-      process.stdout.write("Running " + ids.length + " tests\n");
+      process.stdout.write("Running " + ids.length + " test suites\n");
 
       if (!existsSync(resolvePath(argv, "./logs"))) {
         mkdirSync(resolvePath(argv, "./logs"));

website/index.html

@@ -222,7 +222,7 @@ <h2 class="text-gray-500 text-lg md:text-xl">
                     </td>
                     <td class="p-4 align-middle">
                       <a
-                        href="https://github.com/the-guild-org/federation-compatibility/tree/main/REPORT.md#hive"
+                        href="https://github.com/the-guild-org/federation-compatibility/tree/main/REPORT.md#hive-gateway"
                         class="text-sky-700 hover:underline"
                         >View report</a
                       >
@@ -252,7 +252,7 @@ <h2 class="text-gray-500 text-lg md:text-xl">
                     </td>
                     <td class="p-4 align-middle">
                       <a
-                        href="https://github.com/the-guild-org/federation-compatibility/tree/main/REPORT.md#router"
+                        href="https://github.com/the-guild-org/federation-compatibility/tree/main/REPORT.md#apollo-router"
                         class="text-sky-700 hover:underline"
                         >View report</a
                       >
@@ -312,7 +312,7 @@ <h2 class="text-gray-500 text-lg md:text-xl">
                     </td>
                     <td class="p-4 align-middle">
                       <a
-                        href="https://github.com/the-guild-org/federation-compatibility/tree/main/REPORT.md#router-native"
+                        href="https://github.com/the-guild-org/federation-compatibility/tree/main/REPORT.md#apollo-router-native"
                         class="text-sky-700 hover:underline"
                         >View report</a
                       >
@@ -342,7 +342,7 @@ <h2 class="text-gray-500 text-lg md:text-xl">
                     </td>
                     <td class="p-4 align-middle">
                       <a
-                        href="https://github.com/the-guild-org/federation-compatibility/tree/main/REPORT.md#cosmo"
+                        href="https://github.com/the-guild-org/federation-compatibility/tree/main/REPORT.md#cosmo-router"
                         class="text-sky-700 hover:underline"
                         >View report</a
                       >
@@ -372,7 +372,7 @@ <h2 class="text-gray-500 text-lg md:text-xl">
                     </td>
                     <td class="p-4 align-middle">
                       <a
-                        href="https://github.com/the-guild-org/federation-compatibility/tree/main/REPORT.md#grafbase"
+                        href="https://github.com/the-guild-org/federation-compatibility/tree/main/REPORT.md#grafbase-gateway"
                         class="text-sky-700 hover:underline"
                         >View report</a
                       >
@@ -516,8 +516,8 @@ <h4 class="text-lg font-semibold pt-4 group" id="methodology">
                   href="https://the-guild.dev/graphql/mesh"
                   title="GraphQL Federation Gateway"
                   >GraphQL Mesh</a
-                > (now Hive Gateway)
-                and
+                >
+                (now Hive Gateway) and
                 <a
                   href="https://the-guild.dev/graphql/hive"
                   title="Open-Source GraphQL Federation Platform: Schema Registry and Observability"