[WIP] Work on using external modules #158

freiksenet · 2024-12-11T16:52:07Z

No description provided.

netlify · 2024-12-11T16:52:27Z

❌ Deploy Preview for grats failed.

Name	Link
🔨 Latest commit	`fda55a0`
🔍 Latest deploy log	https://app.netlify.com/sites/grats/deploys/676164129eaf5400086da19f

src/GraphQLAstExtensions.ts

captbaritone · 2024-12-11T19:24:00Z

TODO.md

+  - [ ] reenable global validations
+- [ ] "modular" mode? like no full schema, but parts of schema but with full validation by resolving it?
+- [ ] all tests to add fixtures for metadata/resolver map
+- [ ] pluggable module resolution - too many variables there, use filepath by default, let users customize it


In theory we only need this path in order to perform validation (is that right?). I wonder if there is a TypeScript API which will let us use the same (or most of) TypeScript's implementation of module resolution. I would need to avoid expecting the file to have a .js/.ts/.mjs/etc extension, but maybe something like that is exposed? I suspect that would be sufficient we could find something like that.

I did see this: https://github.com/microsoft/TypeScript/blob/6a00bd2422ffa46c13ac8ff81d7b4b1157e60ba7/src/server/project.ts#L484

Which could be a good place to start looking.

I'm not sure any non-ts files are included in how the typescript resolves it. There is also the whole story of "lib" in package.json and stuff like this. Ultimately there is no "well-known" spot for the GraphQL files, so it feels like it all might just break weirdly. I will experiment on this ofc, but I feel that there might not be an easy solution.

captbaritone · 2024-12-11T19:24:26Z

TODO.md

+- [ ] Read SDL to actually do validation
+  - [ ] reenable global validations
+- [ ] "modular" mode? like no full schema, but parts of schema but with full validation by resolving it?
+- [ ] all tests to add fixtures for metadata/resolver map


I'm onboard with this. Happy to have this as a separate PR if you want to merge that first.

captbaritone · 2024-12-11T19:26:06Z

TODO.md

+- [ ] all imported types (so support interfaces etc)
+- [ ] Read SDL to actually do validation
+  - [ ] reenable global validations
+- [ ] "modular" mode? like no full schema, but parts of schema but with full validation by resolving it?


Copy pasting from chat:

So I'm realizing it's not rational to expect Grats to own emitting the final GraphQLSchema object if you have external types. Those types will have resolvers that Grats can't know about. So, I think if you use @gqlExternal we must assume that Grats is going to be producing a schema slice, and the consumer will be responsible for stiching it togehter with the other schemas. That could be done with resolver maps or graphql-tools schema merge.

In short, I think as soon as you use @gqlExternal you are implicitly opting into modular mode. We will validate against the full schema, but only emit SDL/resolver maps/GraphQLSchema for the part of the schema that Grats owns.

I think I have a setup that should work - you can only have gqlExternal in resolver mode and it does full validation, but only generates for local types.

captbaritone · 2024-12-11T19:30:44Z

src/tests/fixtures/externals/nonGratsPackageWrapper.ts

+import {
+  SomeType as _SomeType,
+  SomeInterface as _SomeInterface,
+} from "./nonGratsPackage.ignore";


One thing I'd like to add eventually is the ability for a fixture file to model multiple files. I did something similar for Relay:

Example: https://github.com/facebook/relay/blob/main/compiler/crates/relay-compiler/tests/relay_compiler_integration/fixtures/client_mutation_extension.input
Implemented here: https://github.com/facebook/relay/blob/main/compiler/crates/graphql-test-helpers/src/project_fixture.rs

I think that would help for tests like this which need to encode relationships between different files.

Will work in a separate PR, together with test fixes.

…port

freiksenet · 2024-12-16T10:31:14Z

@captbaritone Could you approve the workflow for me?

captbaritone · 2024-12-16T14:50:13Z

@captbaritone Could you approve the workflow for me?

Done

captbaritone

Overall looks good! Left some observations/ideas inline, but the overall approach looks good!

captbaritone · 2024-12-16T20:59:59Z

src/Errors.ts

@@ -607,3 +613,17 @@ export function noTypesDefined() {
 export function tsConfigNotFound(cwd: string) {
  return `Grats: Could not find \`tsconfig.json\` searching in ${cwd}.\n\nSee https://www.typescriptlang.org/download/ for instructors on how to add TypeScript to your project. Then run \`npx tsc --init\` to create a \`tsconfig.json\` file.`;
 }
+
+export function noModuleInGqlExternal() {
+  return `Grats: @gqlExternal must include a module name in double quotes. For example: /** @gqlExternal "myModule" */`;


Diagnostics do not need to be prefixed with Grats:

You do have it in tsConfigNotFound, is that a mistake too?

src/Errors.ts

src/Extractor.ts

src/transforms/addImportedSchemas.ts

captbaritone · 2024-12-16T21:26:00Z

src/utils/Result.ts

+/**
+ * Helper class for chaining together a series of `Result` operations that accepts also promises.
+ */
+export class ResultPipeAsync<T, E> {


Looks like maybe you were able to get away without needing this?

I had to resort to readFileSync, which isn't ideal. Ideally all imports should be resolved asynchronously. I didn't get to fix the actual pipeline because it was more complicated.

I think readFileSync is fine for now. Let's remove this.

src/transforms/mergeExtensions.ts

src/transforms/addImportedSchemas.ts

captbaritone

Looking pretty good! Left some comments. What would you like to do next? Do you need this to merge to further validate, or should we try to work toward stabilizing it?

I think next steps for that would be:

Documentation (both for the tag and for the overall use case probably as an additional subpage of this section.
An example project in the examples directory. Could probably just copy/paste/tweak this one https://github.com/captbaritone/grats/tree/main/examples/incremental-migration

captbaritone · 2025-01-02T16:31:44Z

src/Errors.ts

@@ -153,6 +155,10 @@ export function typeTagOnAliasOfNonObjectOrUnknown() {
  return `Expected \`@${TYPE_TAG}\` type to be an object type literal (\`{ }\`) or \`unknown\`. For example: \`type Foo = { bar: string }\` or \`type Query = unknown\`.`;
 }

+export function nonExternalTypeAlias(tag: AllTags) {
+  return `Expected \`@${tag}\` to be a type alias only if used with \`@${EXTERNAL_TAG}\``;


The constraint here is just that it not be a runtime construct. Can we expand this to also support interfaces?

captbaritone · 2025-01-02T16:38:14Z

src/Errors.ts

+}
+
+export function externalOnWrongNode(existingTag: string) {
+  return `Unexpected \`@${EXTERNAL_TAG}\` on type with \`${existingTag}\`. \`@${EXTERNAL_TAG}\` can only be used on type declarations.`;


"type declaration" here is a bit ambiguous. Does it mean a TypeScript type alias? A GraphQL object type? Maybe it would be clearer (if a bit awkward) to just enumerate the six tags which are valid?

captbaritone · 2025-01-02T18:34:09Z

src/Extractor.ts

+  | typeof UNION_TAG
+  | typeof INPUT_TAG
+  | typeof EXTERNAL_TAG;
+


Can we derive this from ALL_TAGS?

const x = ["A", "B", "C"] as const; type X = typeof x[number]

captbaritone · 2025-01-02T18:35:11Z

src/Extractor.ts

  }

-  // Traverse all nodes, checking each one for its JSDoc tags.
-  // If we find a tag we recognize, we extract the relevant information,
+  // Traverse all nodes, checking each one for its JSDoc tags.  // If we find a tag we recognize, we extract the relevant information,


Suggested change

// Traverse all nodes, checking each one for its JSDoc tags. // If we find a tag we recognize, we extract the relevant information,

// Traverse all nodes, checking each one for its JSDoc tags.

// If we find a tag we recognize, we extract the relevant information,

captbaritone · 2025-01-02T18:37:08Z

src/Extractor.ts

+          }
+          if (


If the feature is not enabled, I think it's better to not report errors related to the feature.

Suggested change

}

if (

} else if (

captbaritone · 2025-01-02T18:39:24Z

src/Extractor.ts

+              E.externalOnWrongNode(
+                ts
+                  .getJSDocTags(node)
+                  .filter((t) => t.tagName.text !== EXTERNAL_TAG)[0].tagName


I think this would also report non-@gql tags, like @deprecated or other non-Grats tags.

captbaritone · 2025-01-02T18:48:19Z

src/lib.ts

@@ -164,7 +170,7 @@ function buildSchemaFromDoc(
  const diagnostics = validateSchema(schema)
    // FIXME: Handle case where query is not defined (no location)
    .filter((e) => e.source && e.locations && e.positions);
-
+  //


Suggested change

//

captbaritone · 2025-01-02T19:01:01Z

src/transforms/addImportedSchemas.ts

+  for (const schemaPath of importedSchemas) {
+    const text = fs.readFileSync(path.resolve(schemaPath), "utf-8");
+    try {
+      const parsedAst = parse(text);


I think we need to pass a Source object here:

captbaritone · 2025-01-02T19:03:06Z

src/utils/Result.ts

+/**
+ * Helper class for chaining together a series of `Result` operations that accepts also promises.
+ */
+export class ResultPipeAsync<T, E> {


I think readFileSync is fine for now. Let's remove this.

WIP

a995481

Fix todo

69bba95

freiksenet commented Dec 11, 2024

View reviewed changes

src/GraphQLAstExtensions.ts Outdated Show resolved Hide resolved

captbaritone reviewed Dec 11, 2024

View reviewed changes

freiksenet added 2 commits December 16, 2024 11:03

Merge remote-tracking branch 'origin/main' into freiksenet/import-sup…

8a1fa3b

…port

Actually usable stuff

a431599

freiksenet added 3 commits December 16, 2024 15:59

Support all types and add tests to them

d9acd95

Add async result pipe

08a8573

Whitespace issues

da25562

captbaritone reviewed Dec 16, 2024

View reviewed changes

freiksenet added 3 commits December 17, 2024 12:10

Add test for empty type

f312118

Minor review comments

58fedca

Cleaner externalModule

fda55a0

captbaritone reviewed Jan 2, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Work on using external modules #158

[WIP] Work on using external modules #158

freiksenet commented Dec 11, 2024

netlify bot commented Dec 11, 2024 •

edited

Loading

captbaritone Dec 11, 2024

freiksenet Dec 16, 2024

captbaritone Dec 11, 2024

captbaritone Dec 11, 2024

freiksenet Dec 16, 2024

captbaritone Dec 11, 2024

freiksenet Dec 16, 2024

freiksenet commented Dec 16, 2024

captbaritone commented Dec 16, 2024

captbaritone left a comment

captbaritone Dec 16, 2024

freiksenet Dec 17, 2024

captbaritone Dec 16, 2024

freiksenet Dec 17, 2024

captbaritone Jan 2, 2025

captbaritone left a comment

captbaritone Jan 2, 2025

captbaritone Jan 2, 2025

captbaritone Jan 2, 2025

captbaritone Jan 2, 2025

captbaritone Jan 2, 2025

captbaritone Jan 2, 2025

captbaritone Jan 2, 2025

captbaritone Jan 2, 2025

captbaritone Jan 2, 2025

	// Traverse all nodes, checking each one for its JSDoc tags. // If we find a tag we recognize, we extract the relevant information,
	// Traverse all nodes, checking each one for its JSDoc tags.
	// If we find a tag we recognize, we extract the relevant information,

[WIP] Work on using external modules #158

Are you sure you want to change the base?

[WIP] Work on using external modules #158

Conversation

freiksenet commented Dec 11, 2024

netlify bot commented Dec 11, 2024 • edited Loading

❌ Deploy Preview for grats failed.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

freiksenet commented Dec 16, 2024

captbaritone commented Dec 16, 2024

captbaritone left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

captbaritone left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netlify bot commented Dec 11, 2024 •

edited

Loading