-
Notifications
You must be signed in to change notification settings - Fork 32
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
0.9.0 (8) documentation updates and "branded" error messages #240
Conversation
Job #34: Bundle Size — 1.01MiB (+0.04%).Warning Bundle contains 1 duplicate package – View duplicate packages Bundle metrics
Bundle size by type
View job #34 report View pr/0.8-docs branch activity View project dashboard |
- name: Commit changes back | ||
uses: stefanzweifel/git-auto-commit-action@v5 | ||
with: | ||
commit_message: "Update Docs" | ||
push_options: "" | ||
skip_dirty_check: false |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This builds the docs folder and re-commits it to main
if any changes are necessary.
I tried building to HTML with the intention of deploying to GH pages, but that would require us to also come up with a design for those pages, while "markdown on GitHub" already has some kind of familiar frame around it.
.yarn/patches/@microsoft-api-documenter-npm-7.23.37-51bf9d9d16.patch
Outdated
Show resolved
Hide resolved
|
||
## client-react-streaming package | ||
|
||
This package provides building blocks to create framework-level integration of Apollo Client with React's streaming SSR. See the \[@<!-- -->apollo/experimental-nextjs-app-support\](https://github.com/apollographql/apollo-client-nextjs/tree/main/packages/experimental-nextjs-app-support) package as an example. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For some reason, some of the Markdown links from comments are escaped like this.
It's not pretty, but tbh., I'm fine with it.
@@ -24,7 +24,17 @@ afterEach(resetNextSSRApolloSingletons); | |||
* data from the server to the browser. | |||
*/ | |||
test("uses the browser build", () => { | |||
expect(NextSSRApolloClient.name).toBe("ApolloClientBrowserImpl"); | |||
let foundPrototype = false; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since the class hierarchy of ApolloClient
has changed a bit with this PR, this test had to get a bit more complicated.
@@ -0,0 +1,101 @@ | |||
import assert from "node:assert"; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't have a test setup over in @apollo/experimental-nextjs-app-support
, so we're testing this only over in this package.
Long-term it might be a good idea to mirror the test over there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@@ -0,0 +1,6 @@ | |||
/** | |||
* @packageDocumentation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nothing here yet, but we have a very long README.
/release:pr |
A new release has been made for this PR. You can install the package you need using one of
|
/release:pr |
A new release has been made for this PR. You can install the package you need using one of
|
size-limit report 📦
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry this took me so long to finish up! Looking awesome!
* | ||
* While this Data Transport enables streaming SSR, it has some conceptual drawbacks: | ||
* | ||
* - It does not have a way of keeping your connection open if your application already finished, but there are still ongoing queries that might need to be awaited transported over. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* - It does not have a way of keeping your connection open if your application already finished, but there are still ongoing queries that might need to be awaited transported over. | |
* - It does not have a way of keeping your connection open if your application already finished, but there are still ongoing queries that might need to be transported over. |
* | ||
* - It does not have a way of keeping your connection open if your application already finished, but there are still ongoing queries that might need to be awaited transported over. | ||
* - This can happen if a component renders `useBackgroundQuery`, but does not read the `queryRef` with `useReadQuery` | ||
* - These "cut off" queries will be restarted in the Browser once the browser's `load` event happens |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* - These "cut off" queries will be restarted in the Browser once the browser's `load` event happens | |
* - These "cut off" queries will be restarted in the browser once the browser's `load` event happens |
* - In this, case, older data from the server might overwrite newer data in the browser. | ||
* - This is minimized by simulating ongoing queries in the browser once the information of a started query is transported over. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* - In this, case, older data from the server might overwrite newer data in the browser. | |
* - This is minimized by simulating ongoing queries in the browser once the information of a started query is transported over. | |
* - In this, case, older data from the server might overwrite newer data in the browser. This is minimized by simulating ongoing queries in the browser once the information of a started query is transported over. |
The 2nd sentence feels more like a continuation of the third, not so much its own point, so I think combining these makes sense.
This PR contains documentation updates and "branded" error messages to ensure that error messages match the package that has been imported.