Add support for defer and stream directives (Feedback is welcome) #2839

IvanGoncharov · 2020-11-05T14:10:17Z

The implementation in this pull request is a reference implementation of the specification proposal outlined in graphql/graphql-spec#742. It is no longer compatible with with the @defer and @stream implementation in Relay.

This branch is published to npm as version graphql@15.4.0-experimental-stream-defer.1 under the tag graphql@experimental-stream-defer. We encourage anyone interested in this feature to try out this version and report any feedback, issues, or potential improvements to the API. This feedback will help the working group gain confidence to move forward with standardization.

Developed and maintained by @lilianammmatos @robrichard

Depends on #2757

Continued in new pr: #3659

src/graphql.d.ts

yaacovCR · 2020-12-31T04:24:31Z

Hi team! Thanks again for all the hard work, a quick, tiny suggestion:

graphql-js/src/index.d.ts

Lines 54 to 58 in 163f62a

    
           specifiedDirectives, 
        
           GraphQLIncludeDirective, 
        
           GraphQLSkipDirective, 
        
           GraphQLDeprecatedDirective, 
        
           GraphQLSpecifiedByDirective,

Maybe add:

  GraphQLDeferDirective,
  GraphQLSkipDirective,

Currently my editor automatically has me importing from graphql/type, which has the change:

graphql-js/src/type/index.d.ts

Lines 125 to 131 in 163f62a

    
           specifiedDirectives, 
        
           GraphQLIncludeDirective, 
        
           GraphQLSkipDirective, 
        
           GraphQLDeferDirective, 
        
           GraphQLStreamDirective, 
        
           GraphQLDeprecatedDirective, 
        
           GraphQLSpecifiedByDirective,

robrichard · 2020-12-31T20:03:33Z

@yaacovCR thanks, updated now.

linux-foundation-easycla · 2021-02-09T16:56:19Z

The committers are authorized under a signed CLA.

✅ Rob Richard (665e256, efc6c73, 0c6129e, 35e25a4, df690d3, b062f1b)
✅ Liliana Matos (e2c0ebd)

yaacovCR · 2021-03-16T17:51:59Z

cross-posting #2848 (comment)

I believe this is a bug in the Set<Promise<result>> => AsyncIterableIterator<result> functionality

robrichard · 2021-03-16T20:54:24Z

@yaacovCR I think this is a bug. The dispatcher is not expecting next() to be called before the previous next() is resolved. I'll take a look when I have some time.

yaacovCR · 2021-03-19T21:29:52Z

#2975

KatFishSnake · 2021-05-14T00:21:13Z

Any updates here?, anyways we can track the progress?

@IvanGoncharov what is blocking you guys from merging it?

acao · 2021-06-01T02:27:34Z

@KatFishSnake they were waiting for the typescript migration, and as I understand, will be releasing with graphql@16. So once all the conflicts are reconciled here it should be close! I can't decide whether this leaves RFC myself but I can imagine it will.

acao · 2021-06-01T03:50:06Z

So, I began the process of converting this PR to typescript and got most of the way through the third commit!!

I'm going to go to sleep and enjoy more of my vacation, but I just wanted to confirm that this will be a somewhat involved & worthwhile effort just for the language conversion work. If someone can start on this effort now and see it through that would be rad! Converting flow to typescript isn't as hard as it sounds I promise!

then, as I understand, there are incoming spec changes? or was that to just the transport spec?

CC @robrichard @freiksenet @IvanGoncharov @leebyron @saihaj

github-actions · 2022-04-27T18:50:43Z

@github-actions publish-pr-on-npm

@robrichard The latest changes of this PR are available on NPM as
graphql@16.4.0-canary.pr.2839.e3a8069cfaa6406186314b62aced6487f417a2e6
Note: no gurantees provided so please use your own discretion.

Also you can depend on latest version built from this PR:
npm install --save graphql@canary-pr-2839

n1ru4l · 2022-05-23T06:30:13Z

@robrichard Can you please rebase upon main and release a new canary?

github-actions · 2022-05-23T18:44:29Z

@github-actions publish-pr-on-npm

@robrichard The latest changes of this PR are available on NPM as
graphql@17.0.0-alpha.1.canary.pr.2839.db4d0cdea30214fb7bb00724b7827708ca5de8a5
Note: no gurantees provided so please use your own discretion.

Also you can depend on latest version built from this PR:
npm install --save graphql@canary-pr-2839

# Conflicts: # src/execution/execute.ts # src/validation/index.d.ts # src/validation/index.ts

# Conflicts: # src/subscription/subscribe.ts

# Conflicts: # src/execution/execute.ts

* fix(race): concurrent next calls * refactor test * use invariant * disable eslint error * fix

robrichard · 2022-06-23T19:02:26Z

Continuing in new PR #3659

IvanGoncharov added spec RFC Implementation of a proposed change to the GraphQL specification PR: feature 🚀 requires increase of "minor" version number labels Nov 5, 2020

IvanGoncharov changed the title ~~Add support for defer and stream directives (Feedback is welcomed)~~ Add support for defer and stream directives (Feedback is welcome) Nov 5, 2020

robrichard force-pushed the defer-stream branch from dec5554 to 163f62a Compare November 18, 2020 01:23

tgriesser reviewed Dec 5, 2020

View reviewed changes

src/graphql.d.ts Outdated Show resolved Hide resolved

tgriesser mentioned this pull request Dec 7, 2020

Placeholder issue for feedback on @defer & @stream proposal #2848

Closed

edno mentioned this pull request Dec 7, 2020

feat: Implement @live, @stream, @defer mercurius-js/mercurius#342

Open

robrichard force-pushed the defer-stream branch from 163f62a to dc7f3cf Compare December 31, 2020 20:02

robrichard force-pushed the defer-stream branch 3 times, most recently from cd9c8c6 to 1c4940a Compare January 22, 2021 21:02

Base automatically changed from master to main January 27, 2021 11:10

robrichard force-pushed the defer-stream branch from 1c4940a to b062f1b Compare February 9, 2021 16:56

robrichard force-pushed the defer-stream branch 6 times, most recently from 4be6bf2 to 24330c0 Compare February 16, 2021 14:33

KatFishSnake mentioned this pull request May 14, 2021

[WIP] Add client side support for @defer directive apollographql/apollo-client#3686

Closed

4 tasks

acao mentioned this pull request Jun 1, 2021

feat: support graphql-ws client for GraphiQL IDE graphql/express-graphql#755

Merged

5 tasks

This comment was marked as outdated.

Sign in to view

robrichard force-pushed the defer-stream branch from ecd96a8 to cb48781 Compare April 27, 2022 17:37

This comment has been minimized.

Sign in to view

brainkim mentioned this pull request May 4, 2022

Brian/version 4 defer stream apollographql/apollo-server#6376

Closed

robrichard force-pushed the defer-stream branch 2 times, most recently from a4f9ee7 to a80224a Compare May 5, 2022 14:58

robrichard force-pushed the defer-stream branch from a80224a to 271e438 Compare May 13, 2022 18:49

ardatan mentioned this pull request May 17, 2022

add support for @defer and @stream directives ardatan/graphql-mesh#3892

Closed

robrichard force-pushed the defer-stream branch from 271e438 to cee40c2 Compare May 23, 2022 18:38

This comment has been minimized.

Sign in to view

robrichard force-pushed the defer-stream branch 2 times, most recently from 4e044e4 to 2757d35 Compare May 26, 2022 12:58

robrichard force-pushed the defer-stream branch from 2757d35 to ce56258 Compare June 13, 2022 16:39

robrichard force-pushed the defer-stream branch 2 times, most recently from 5de5c97 to c624531 Compare June 22, 2022 17:32

lilianammmatos and others added 8 commits June 23, 2022 14:21

Add @defer directive to schema

b371e53

Implement support for @defer directive

934cc82

Add @stream directive to schema

d212612

Implement support for @stream directive

2abfffe

# Conflicts: # src/execution/execute.ts # src/validation/index.d.ts # src/validation/index.ts

add defer/stream support for subscriptions (#7)

07c5b61

# Conflicts: # src/subscription/subscribe.ts

Return underlying AsyncIterators when execute result is returned (#2843)

05f1903

# Conflicts: # src/execution/execute.ts

fix(race): concurrent next calls with defer/stream (#2975)

19be33e

* fix(race): concurrent next calls * refactor test * use invariant * disable eslint error * fix

Add defer/stream tutorial

35a28cd

robrichard force-pushed the defer-stream branch from c624531 to 35a28cd Compare June 23, 2022 18:21

robrichard closed this Jun 23, 2022

robrichard mentioned this pull request Jun 23, 2022

Reference implementation of defer and stream spec #3659

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for defer and stream directives (Feedback is welcome) #2839

Add support for defer and stream directives (Feedback is welcome) #2839

IvanGoncharov commented Nov 5, 2020 •

edited by robrichard

Loading

yaacovCR commented Dec 31, 2020

robrichard commented Dec 31, 2020

linux-foundation-easycla bot commented Feb 9, 2021 •

edited

Loading

yaacovCR commented Mar 16, 2021 •

edited

Loading

robrichard commented Mar 16, 2021 •

edited

Loading

yaacovCR commented Mar 19, 2021

KatFishSnake commented May 14, 2021

acao commented Jun 1, 2021 •

edited

Loading

acao commented Jun 1, 2021 •

edited

Loading

This comment was marked as outdated.

This comment has been minimized.

github-actions bot commented Apr 27, 2022

n1ru4l commented May 23, 2022

This comment has been minimized.

github-actions bot commented May 23, 2022

robrichard commented Jun 23, 2022

Add support for defer and stream directives (Feedback is welcome) #2839

Add support for defer and stream directives (Feedback is welcome) #2839

Conversation

IvanGoncharov commented Nov 5, 2020 • edited by robrichard Loading

yaacovCR commented Dec 31, 2020

robrichard commented Dec 31, 2020

linux-foundation-easycla bot commented Feb 9, 2021 • edited Loading

yaacovCR commented Mar 16, 2021 • edited Loading

robrichard commented Mar 16, 2021 • edited Loading

yaacovCR commented Mar 19, 2021

KatFishSnake commented May 14, 2021

acao commented Jun 1, 2021 • edited Loading

acao commented Jun 1, 2021 • edited Loading

This comment was marked as outdated.

This comment has been minimized.

github-actions bot commented Apr 27, 2022

n1ru4l commented May 23, 2022

This comment has been minimized.

github-actions bot commented May 23, 2022

robrichard commented Jun 23, 2022

IvanGoncharov commented Nov 5, 2020 •

edited by robrichard

Loading

linux-foundation-easycla bot commented Feb 9, 2021 •

edited

Loading

yaacovCR commented Mar 16, 2021 •

edited

Loading

robrichard commented Mar 16, 2021 •

edited

Loading

acao commented Jun 1, 2021 •

edited

Loading

acao commented Jun 1, 2021 •

edited

Loading