feat(gateway): Remove internal dep on `schema` from composition #278

trevor-scheer · 2020-11-11T18:02:32Z

In an effort to more fully embrace CSDL within the Apollo ecosystem, this PR expands the Gateway's API to consume CSDL.

Currently, the query planner already depends on CSDL as input. This covers the majority of the Gateway's schema needs. All that remains is an internal dependency on a GraphQLSchema coming from composition.

It's fairly trivial to generate a GraphQLSchema from the CSDL itself, which unlocks the ability to provide CSDL directly to the gateway as input. This means that we can provide CSDL as configuration directly, or in the case of managed federation, host CSDL and significantly simplify the startup process of a managed gateway.

This change does introduce the ability to provide CSDL directly to the Gateway, however the remaining bits are strictly changes to internal details. With this change in place, our infra team can ship the work required to host CSDL which we can in turn depend on and simplify our waterfall of fetches and composition.

federation-js/src/composition/__tests__/composeAndValidate.test.ts

federation-js/src/composition/compose.ts

federation-js/src/composition/composeAndValidate.ts

gateway-js/src/__tests__/queryPlanCucumber.test.ts

gateway-js/src/csdlToSchema.ts

gateway-js/src/index.ts

federation-js/src/composition/utils.ts

abernix

There's a package-lock.json change that seems unexpected, but presuming you back that out or if I'm missing something, and with the addition of a CHANGELOG.md, then LGTM.

(Squash in the end?)

federation-js/src/composition/compose.ts

federation-js/src/composition/composeAndValidate.ts

federation-js/src/composition/utils.ts

package-lock.json

federation-js/src/composition/composeAndValidate.ts

federation-js/src/composition/compose.ts

federation-js/src/composition/composeAndValidate.ts

This commit cuts the gateway over to relying solely on the `composedSdl` output from composition. This unlocks the ability for either a user or Apollo Studio to serve the gateway CSDL instead of each SDL file per service. This is fairly straightforward, as `schema` was only depended on in one place by query plan execution, during the final pass of graphql-js `execute()`. Instead, we now construct a `GraphQLSchema` ourselves from the CSDL. This comes with a caveat: the schema we're creating doesn't have all of the annotations that once existed in the schema that we were using from `composeAndValidate()`. However, this is inconsequential for the way the schema is currently being used during the final execution pass.

keys aren't actually provided on the owner when they should be.

… in Rust. Note: The names and final form of this is subject to change after this lands. None of the changes introduced in this commit are meant to be acted on by users today. This commit: - Introduces a `harmonizer` Rust crate which composes schemas using the existing JavaScript/TypeScript composition function and returns a string representation of the composed schema -- tentatively, known as "CSDL" (composed schema definition language). The name "CSDL" is subject to change. Today, CSDL is already an internal implementation detail which acts as a format that we could pass between the TypeScript runtime and the query planner, which is written in Rust. By providing the mechanism to produce a static CSDL artifact, the gateway can be absolved from the responsibility to create this artifact in an opaque manner at runtime. The ability to pass CSDL into a Gateway as configuration has been possible ever since the landing of #278, though until this commit, there hasn't been a way to produce it. As an implementation detail of the `harmonizer` library, this is accomplished by invoking a [Rollup.js]-bundled [IIFE] of the `@apollo/federation` package, in V8, via the [`deno_core`] V8 bindings. The IIFE JavaScript bundle itself is generated by bundling a (small) stub, native ECMAScript module that depends on `@apollo/federation` and calls its `composeAndValidate` function. The Rollup.js build is invoked via a Rust `build.rs` script ([Build Scripts]). While the intention exists on the team to offer composition and validation written in native Rust, this intermediary is a short-cut that allows us to use the well-tested TypeScript logic that powers Federation today to achieve an immediate "win" without blocking other work while we move toward that future. - Introduces a `harmonizer-cli` that invokes the `harmonize` lib. Again, this will not be the (sole, at least) long-term home for where the production of this artifact will take place. Today, it acts as an easy tool for those interfacing with this project. [Rollup.js]: http://rollupjs.org/ [IIFE]: Instantly Invoked Function Expression [`deno_core`]: https://crates.io/crates/deno_core [Build Scripts]: https://doc.rust-lang.org/cargo/reference/build-scripts.html Co-authored-by: Ashi Krishnan <[email protected]>

… in Rust. Note: The names and final form of this is subject to change after this lands. None of the changes introduced in this commit are meant to be acted on by users today. This commit: - Introduces a `harmonizer` Rust crate which composes schemas using the existing JavaScript/TypeScript composition function and returns a string representation of the composed schema -- tentatively, known as "CSDL" (composed schema definition language). The name "CSDL" is subject to change. Today, CSDL is already an internal implementation detail which acts as a format that we could pass between the TypeScript runtime and the query planner, which is written in Rust. By providing the mechanism to produce a static CSDL artifact, the gateway can be absolved from the responsibility to create this artifact in an opaque manner at runtime. The ability to pass CSDL into a Gateway as configuration has been possible ever since the landing of #278, though until this commit, there hasn't been a way to produce it. As an implementation detail of the `harmonizer` library, this is accomplished by invoking a [Rollup.js]-bundled [IIFE] of the `@apollo/federation` package, in V8, via the [`deno_core`] V8 bindings. The IIFE JavaScript bundle itself is generated by bundling a (small) stub, native ECMAScript module that depends on `@apollo/federation` and calls its `composeAndValidate` function. The Rollup.js build is invoked via a Rust `build.rs` script ([Build Scripts]). While the intention exists on the team to offer composition and validation written in native Rust, this intermediary is a short-cut that allows us to use the well-tested TypeScript logic that powers Federation today to achieve an immediate "win" without blocking other work while we move toward that future. - Introduces a `harmonizer-cli` that invokes the `harmonize` lib. Again, this will not be the (sole, at least) long-term home for where the production of this artifact will take place. Today, it acts as an easy tool for those interfacing with this project. - Sets up and installs Node.js and npm - which are required to build and test this Rust implementation - in our Rust GitHub Actions runs. This builds on the work in: #480 [Rollup.js]: http://rollupjs.org/ [IIFE]: Instantly Invoked Function Expression [`deno_core`]: https://crates.io/crates/deno_core [Build Scripts]: https://doc.rust-lang.org/cargo/reference/build-scripts.html Co-authored-by: Ashi Krishnan <[email protected]>

trevor-scheer requested a review from abernix November 11, 2020 18:02