0.9.0 (8) documentation updates and "branded" error messages #240

phryneas · 2024-03-13T13:54:28Z

This PR contains documentation updates and "branded" error messages to ensure that error messages match the package that has been imported.

relativeci · 2024-03-13T13:58:53Z

Job #34: Bundle Size — 1.01MiB (+0.04%).

2638231(current) vs b63b501 main#30(baseline)

Warning

Bundle contains 1 duplicate package – View duplicate packages

Bundle metrics

4 changes

1 regression

1 improvement

	Current Job #34	Baseline Job #30
Initial JS	`890.09KiB`(`+0.05%`)	`889.69KiB`
Initial CSS	`0B`	`0B`
Cache Invalidation	`35.03%`	`21.01%`
Chunks	`24`	`24`
Assets	`45`	`45`
Modules	`512`(`+0.2%`)	`511`
Duplicate Modules	`30`	`30`
Duplicate Code	`1.29%`(`-0.77%`)	`1.3%`
Packages	`29`	`29`
Duplicate Packages	`1`	`1`

Bundle size by type

1 change

1 regression

	Current Job #34	Baseline Job #30
JS	`1023.35KiB` (`+0.04%`)	`1022.95KiB`
Other	`5.99KiB`	`5.99KiB`

View job #34 report View pr/0.8-docs branch activity View project dashboard

see microsoft/rushstack#4578

phryneas · 2024-03-15T13:49:38Z

.github/workflows/docs.yml

+      - name: Commit changes back
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: "Update Docs"
+          push_options: ""
+          skip_dirty_check: false


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

phryneas · 2024-03-15T13:53:39Z

docs/client-react-streaming.md

+
+## 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.


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.

phryneas · 2024-03-15T13:55:21Z

integration-test/jest/src/hooks.test.jsx

@@ -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;


Since the class hierarchy of ApolloClient has changed a bit with this PR, this test had to get a bit more complicated.

phryneas · 2024-03-15T14:11:03Z

packages/client-react-streaming/src/importErrors.test.tsx

@@ -0,0 +1,101 @@
+import assert from "node:assert";


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.

But I just tried it out, just in case:
One works:

The other one doesn't yet - I'll get back on that.

Looking better now!

phryneas · 2024-03-15T14:13:49Z

packages/experimental-nextjs-app-support/api-extractor.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @packageDocumentation


Nothing here yet, but we have a very long README.

phryneas · 2024-03-15T14:14:36Z

/release:pr

github-actions · 2024-03-15T14:16:11Z

A new release has been made for this PR. You can install the package you need using one of

npm i @apollo/experimental-nextjs-app-support@0.0.0-commit-4fc1615
npm i @apollo/client-react-streaming@0.0.0-commit-4fc1615

phryneas · 2024-03-15T14:34:39Z

/release:pr

github-actions · 2024-03-15T14:36:17Z

A new release has been made for this PR. You can install the package you need using one of

npm i @apollo/experimental-nextjs-app-support@0.0.0-commit-e67a320
npm i @apollo/client-react-streaming@0.0.0-commit-e67a320

github-actions · 2024-03-15T16:04:47Z

size-limit report 📦

Path	Size
{ ApolloNextAppProvider, NextSSRApolloClient, NextSSRInMemoryCache } from '@apollo/experimental-nextjs-app-support/ssr' (Browser ESM)	7.78 KB (0%)
{ WrapApolloProvider, ApolloClient, InMemoryCache } from '@apollo/client-react-streaming' (Browser ESM)	1.4 KB (0%)
{ buildManualDataTransport } from '@apollo/client-react-streaming/manual-transport' (Browser ESM)	6.24 KB (0%)
@apollo/client-react-streaming (Browser ESM)	2.11 KB (0%)
@apollo/client-react-streaming (SSR ESM)	1.72 KB (0%)
@apollo/client-react-streaming (RSC ESM)	1020 B (0%)
@apollo/client-react-streaming/manual-transport (Browser ESM)	6.42 KB (0%)
@apollo/client-react-streaming/manual-transport (SSR ESM)	6.32 KB (0%)
@apollo/experimental-nextjs-app-support/ssr (Browser ESM)	8.39 KB (0%)
@apollo/experimental-nextjs-app-support/ssr (SSR ESM)	8.3 KB (0%)
@apollo/experimental-nextjs-app-support/ssr (RSC ESM)	839 B (0%)
@apollo/experimental-nextjs-app-support/rsc (RSC ESM)	261 B (0%)

jerelmiller

Sorry this took me so long to finish up! Looking awesome!

packages/client-react-streaming/src/registerApolloClient.tsx

jerelmiller · 2024-03-21T14:53:31Z

packages/client-react-streaming/src/ManualDataTransport/ManualDataTransport.tsx

+ *
+ * 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.


Suggested change

* - 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.

jerelmiller · 2024-03-21T14:53:52Z

packages/client-react-streaming/src/ManualDataTransport/ManualDataTransport.tsx

+ *
+ * - 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


Suggested change

* - 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

jerelmiller · 2024-03-21T14:54:58Z

packages/client-react-streaming/src/ManualDataTransport/ManualDataTransport.tsx

+ *   - 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.


Suggested change

* - 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.

start documenting all exports

c0715a0

phryneas added 3 commits March 13, 2024 15:04

adjust integration tests to new inheritance

da19a5f

more docs

965ef5e

build docs to GitHub pages

b1a299e

phryneas added this to the 0.9.0 milestone Mar 14, 2024

phryneas changed the title ~~0.10.0 (8) documentation updates and "branded" error messages~~ 0.9.0 (8) documentation updates and "branded" error messages Mar 14, 2024

phryneas added 8 commits March 14, 2024 15:58

more docs

73f9492

forgot comment

f994313

drop HTML/deploy to GH pages

a5d4ab1

add docs markdown

1e64d9b

changes by patched api-documenter

247d226

add patch to @microsoft/api-documenter

444369b

see microsoft/rushstack#4578

update links

fe4cf71

remove repeated config

4fc1615

phryneas commented Mar 15, 2024

View reviewed changes

fix up error message

e67a320

phryneas marked this pull request as ready for review March 15, 2024 14:39

phryneas requested a review from a team as a code owner March 15, 2024 14:39

Merge branch 'main' into pr/0.8-docs

270645d

pin api-documenter version

b238c16

phryneas force-pushed the pr/0.8-docs branch from 88c0037 to b238c16 Compare March 19, 2024 09:37

jerelmiller approved these changes Mar 21, 2024

View reviewed changes

phryneas added 2 commits March 21, 2024 16:15

code review

2638231

Merge branch 'main' into pr/0.8-docs

8d8a717

phryneas merged commit da238f8 into main Mar 21, 2024
4 of 6 checks passed

phryneas deleted the pr/0.8-docs branch March 21, 2024 15:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

0.9.0 (8) documentation updates and "branded" error messages #240

0.9.0 (8) documentation updates and "branded" error messages #240

phryneas commented Mar 13, 2024

relativeci bot commented Mar 13, 2024 •

edited

Loading

phryneas Mar 15, 2024

phryneas Mar 15, 2024

phryneas Mar 15, 2024

phryneas Mar 15, 2024

phryneas Mar 15, 2024

phryneas Mar 15, 2024

phryneas Mar 15, 2024

phryneas commented Mar 15, 2024

github-actions bot commented Mar 15, 2024

phryneas commented Mar 15, 2024

github-actions bot commented Mar 15, 2024

github-actions bot commented Mar 15, 2024 •

edited

Loading

jerelmiller left a comment

jerelmiller Mar 21, 2024

jerelmiller Mar 21, 2024

jerelmiller Mar 21, 2024


		## 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.

	* - 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.

	* - 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.

0.9.0 (8) documentation updates and "branded" error messages #240

0.9.0 (8) documentation updates and "branded" error messages #240

Conversation

phryneas commented Mar 13, 2024

relativeci bot commented Mar 13, 2024 • edited Loading

Job #34: Bundle Size — 1.01MiB (+0.04%).

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

phryneas commented Mar 15, 2024

github-actions bot commented Mar 15, 2024

phryneas commented Mar 15, 2024

github-actions bot commented Mar 15, 2024

github-actions bot commented Mar 15, 2024 • edited Loading

size-limit report 📦

jerelmiller 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

relativeci bot commented Mar 13, 2024 •

edited

Loading

github-actions bot commented Mar 15, 2024 •

edited

Loading