Keep fields specified by `@unmask` for use with Apollo Client data masking #10163

jerelmiller · 2024-10-04T21:41:22Z

Description

Provide support for @unmask with inlineFragmentTypes: "mask" so that these fields are available in the TypeScript type. This provides compatibility with Apollo Client's data masking feature that will be released in the upcoming 3.12 release.

Related #10162
Related apollographql/apollo-client#12085

Type of change

Please delete options that are not relevant.

New feature (non-breaking change which adds functionality)
expected)

Screenshots/Sandbox (if appropriate/relevant):

See the data masking RFC for more details on the feature in Apollo Client.

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Added unit tests

Test Environment:

OS:
@graphql-codegen/...:
NodeJS:

Checklist:

I have followed the CONTRIBUTING doc and the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been merged and published in downstream modules

Further comments

I'm opening this as a draft to discuss the idea with the maintainers. This is a continuation of our conversation in Slack 🙂.

changeset-bot · 2024-10-04T21:41:26Z

🦋 Changeset detected

Latest commit: 5035012

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 9 packages

Name	Type
@graphql-codegen/visitor-plugin-common	Minor
@graphql-codegen/typescript-operations	Minor
@graphql-codegen/typescript-document-nodes	Patch
@graphql-codegen/gql-tag-operations	Patch
@graphql-codegen/typescript-resolvers	Patch
@graphql-codegen/typed-document-node	Patch
@graphql-codegen/typescript	Patch
@graphql-codegen/graphql-modules-preset	Patch
@graphql-codegen/client-preset	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

packages/plugins/typescript/operations/tests/ts-documents.spec.ts

eddeee888 · 2024-10-16T13:20:32Z

packages/plugins/other/visitor-plugin-common/src/selection-set-to-object.ts

+        if (!selectionNode.fragmentDirectives?.some(d => d.name.value === 'unmask')) {
+          continue;
+        }


What should happen if inlineFragmentTypes='combine' is used with @unmask?
Should we just target the 'mask' scenario in this PR?

Yes I think so. mask is the only one that removes fields from generated type correct?

I can probably be a bit more explicit here if need be that this should only be combined with unmask.

eddeee888 · 2024-10-16T13:25:57Z

Should we update the doc for inlineFragmentTypes to mention the mask option and how it might interact with Apollo's @unmask?

graphql-code-generator/packages/plugins/other/visitor-plugin-common/src/base-visitor.ts

Lines 362 to 365 in 1bed87b

    
              * @description Whether fragment types should be inlined into other operations. 
        
              * "inline" is the default behavior and will perform deep inlining fragment types within operation type definitions. 
        
              * "combine" is the previous behavior that uses fragment type references without inlining the types (and might cause issues with deeply nested fragment that uses list types). 
        
              *

eddeee888 · 2024-10-16T13:58:44Z

Could you please run yarn changeset and follow the prompts?
It'd publish an alpha version once that file is committed and pushed.

jerelmiller · 2024-10-19T02:35:21Z

Should we update the doc for inlineFragmentTypes to mention the mask option and how it might interact with Apollo's @unmask?

Yes definitely! I'll add that change as well.

.changeset/twelve-windows-give.md

jerelmiller · 2024-11-04T20:03:44Z

packages/plugins/other/visitor-plugin-common/src/base-documents-visitor.ts

+   *  };
+   *  export default config;
+   */
+  customDirectives?: CustomDirectivesConfig;


Here is the new config option to enable the new apolloUnmask directive. Let me know if there is a better place for these.

packages/plugins/other/visitor-plugin-common/src/base-visitor.ts

jerelmiller · 2024-11-04T21:16:12Z

@eddeee888 apologies for taking so long to get back to this! I'm finally back from all my conference travel and vacation. This should be ready to go on my end so please let me know if anything else needs tweaked. I'm holding off on the support for @deprecated with @unmask(mode: "migrate") for now and hope to come back to it. At this point though I think its a bit more work than I anticipated (happy to be proven wrong) and its far less important than having support for @unmask on its own.

Looking forward to landing this sometime soon!

eddeee888 · 2024-11-12T11:09:55Z

Hi @jerelmiller , could you help fix this prettier issue? https://github.com/dotansimha/graphql-code-generator/actions/runs/11671752015/job/32751535165?pr=10163#step:4:11

We are very close to done, thank you for pushing it forward!

jerelmiller · 2024-11-12T16:57:44Z

@eddeee888 got the prettier issue fixed in 5035012. I think that should be the last thing missing. Thanks for reviewing! Looking forward to having this in there 🙂

Keep fields specified by @unmask

30eba64

jerelmiller commented Oct 4, 2024

View reviewed changes

packages/plugins/typescript/operations/tests/ts-documents.spec.ts Show resolved Hide resolved

jerelmiller commented Oct 4, 2024

View reviewed changes

packages/plugins/typescript/operations/tests/ts-documents.spec.ts Show resolved Hide resolved

jerelmiller changed the title ~~Keep fields specified by @unmask for use with Apollo Client data masking~~ Keep fields specified by @unmask for use with Apollo Client data masking Oct 4, 2024

eddeee888 reviewed Oct 16, 2024

View reviewed changes

jerelmiller added 4 commits November 4, 2024 12:19

Update documentation for inlineFragmentTypes to mention mask option

585f375

Require apolloUnmask config to handle unmasking

a9aee49

Merge branch 'master' into jerel/apollo-fragment-masking

da07491

Add changeset

cb7e57a

jerelmiller marked this pull request as ready for review November 4, 2024 20:02

jerelmiller commented Nov 4, 2024

View reviewed changes

.changeset/twelve-windows-give.md Outdated Show resolved Hide resolved

jerelmiller commented Nov 4, 2024

View reviewed changes

packages/plugins/other/visitor-plugin-common/src/base-visitor.ts Show resolved Hide resolved

jerelmiller requested a review from eddeee888 November 4, 2024 20:06

jerelmiller mentioned this pull request Nov 7, 2024

[Data masking] Provide support for @unmask in GraphQL Codegen typescript-operations plugin apollographql/apollo-client#12085

Closed

jerelmiller added 2 commits November 12, 2024 09:55

Update packages changed in changeset

5790112

Fix prettier issue

5035012

dotansimha approved these changes Nov 13, 2024

View reviewed changes

eddeee888 merged commit fa64fbf into dotansimha:master Nov 13, 2024
18 checks passed

theguild-bot mentioned this pull request Nov 7, 2024

Upcoming Release Changes #10188

Merged

jerelmiller deleted the jerel/apollo-fragment-masking branch November 13, 2024 15:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Keep fields specified by `@unmask` for use with Apollo Client data masking #10163

Keep fields specified by `@unmask` for use with Apollo Client data masking #10163

jerelmiller commented Oct 4, 2024 •

edited

Loading

changeset-bot bot commented Oct 4, 2024 •

edited

Loading

eddeee888 Oct 16, 2024

jerelmiller Oct 19, 2024

eddeee888 commented Oct 16, 2024

eddeee888 commented Oct 16, 2024

jerelmiller commented Oct 19, 2024

jerelmiller Nov 4, 2024

jerelmiller commented Nov 4, 2024

eddeee888 commented Nov 12, 2024 •

edited

Loading

jerelmiller commented Nov 12, 2024

Keep fields specified by @unmask for use with Apollo Client data masking #10163

Keep fields specified by @unmask for use with Apollo Client data masking #10163

Conversation

jerelmiller commented Oct 4, 2024 • edited Loading

Description

Type of change

Screenshots/Sandbox (if appropriate/relevant):

How Has This Been Tested?

Checklist:

Further comments

changeset-bot bot commented Oct 4, 2024 • edited Loading

🦋 Changeset detected

eddeee888 Oct 16, 2024

Choose a reason for hiding this comment

jerelmiller Oct 19, 2024

Choose a reason for hiding this comment

eddeee888 commented Oct 16, 2024

eddeee888 commented Oct 16, 2024

jerelmiller commented Oct 19, 2024

jerelmiller Nov 4, 2024

Choose a reason for hiding this comment

jerelmiller commented Nov 4, 2024

eddeee888 commented Nov 12, 2024 • edited Loading

jerelmiller commented Nov 12, 2024

Keep fields specified by `@unmask` for use with Apollo Client data masking #10163

Keep fields specified by `@unmask` for use with Apollo Client data masking #10163

jerelmiller commented Oct 4, 2024 •

edited

Loading

changeset-bot bot commented Oct 4, 2024 •

edited

Loading

eddeee888 commented Nov 12, 2024 •

edited

Loading