Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature: Support defer and stream GraphQL Directives in RedwoodRealtime #9235

Merged
merged 25 commits into from
Oct 31, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
af0d080
Adds useDeferStream to Realtime
dthyresson Sep 25, 2023
801990c
Don't overwrite the result with just data and errors to support repea…
dthyresson Sep 25, 2023
ee4a4ea
change option to enableDeferStream
dthyresson Sep 25, 2023
f1a6c8a
Adds defer and stream examples to RT setup
dthyresson Sep 25, 2023
ba27ce4
Rework defer and stream example templates
dthyresson Sep 25, 2023
1423fc8
countdown example now uses Repeater
dthyresson Sep 25, 2023
fd7966a
Merge branch 'main' into dt-realtime-defer-stream
dthyresson Sep 25, 2023
8fc3e19
Merge branch 'main' into dt-realtime-defer-stream
dthyresson Oct 16, 2023
fdf42b0
Documents realtime and defer and stream
dthyresson Oct 16, 2023
471cb34
clarify docs of SSE and serverful deploy
dthyresson Oct 16, 2023
8bb557b
Merge branch 'main' into dt-realtime-defer-stream
dthyresson Oct 20, 2023
5332b66
Updates realtime config docs
dthyresson Oct 20, 2023
561b2ab
Support schema coordinates. Adds enable defer to template
dthyresson Oct 23, 2023
ef65e05
Merge branch 'main' into dt-realtime-defer-stream
dthyresson Oct 23, 2023
53b2b7c
Update docs/docs/realtime.md
dthyresson Oct 31, 2023
5244e11
Update docs/docs/realtime.md
dthyresson Oct 31, 2023
bdf80bd
Remove duplicate enableDeferStream
dthyresson Oct 31, 2023
7576e9d
Update docs/docs/realtime.md
dthyresson Oct 31, 2023
7f1081b
Update docs/docs/realtime.md
dthyresson Oct 31, 2023
d8e0432
Update docs/docs/realtime.md
dthyresson Oct 31, 2023
83e4211
Update docs/docs/realtime.md
dthyresson Oct 31, 2023
b7748db
Delete packages/cli/src/commands/experimental/templates/defer/.keep
dthyresson Oct 31, 2023
c476f75
Delete packages/cli/src/commands/experimental/templates/stream/.keep
dthyresson Oct 31, 2023
41d4b16
Merge branch 'main' into dt-realtime-defer-stream
dthyresson Oct 31, 2023
8489f2d
Adds examples for stream and defer in docs
dthyresson Oct 31, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Support schema coordinates. Adds enable defer to template
  • Loading branch information
dthyresson committed Oct 23, 2023
commit 561b2ab976ac5c170aa094623b78ca1899385d5e
10 changes: 6 additions & 4 deletions docs/docs/realtime.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,10 +142,13 @@ You can now remove the GraphQL handler function that resides in `api/functions/g
By default, RedwoodJS realtime configures an in-memory store for the Pub Sub client used with subscriptions and live query invalidation.

Realtime supports in-memory and Redis stores:

- In-memory stores are useful for development and testing.
- Redis stores are useful for production.

Configure a Redis store in:
To enable defer and streaming, set `enableDeferStream` to true.

Configure a Redis store and defer and stream in:

```ts
// api/lib/realtime.ts
Expand Down Expand Up @@ -190,6 +193,8 @@ export const realtime: RedwoodRealtimeOptions = {
// if using a Redis store
// store: { redis: { publishClient, subscribeClient } },
},
// To enable defer and streaming, set to true.
// enableDeferStream: true,
}
```

Expand All @@ -214,9 +219,6 @@ When the query is: `auctions: [Auction!]! @requireAuth`:

* `"Query.auctions"`




## Subscriptions

RedwoodJS has a first-class developer experience for GraphQL subscriptions.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,6 @@ export const realtime: RedwoodRealtimeOptions = {
// if using a Redis store
// store: { redis: { publishClient, subscribeClient } },
},
// To enable defer and streaming, set to true.
// enableDeferStream: true,
}
Loading