separate transport-specific streaming logic out #189

phryneas · 2024-02-05T14:06:17Z

See a lot of comments further down :)

github-actions · 2024-02-08T13:09:48Z

A new release has been made for this PR. You can install it with npm i @apollo/experimental-nextjs-app-support@0.0.0-commit-fac6765.

phryneas · 2024-02-08T16:42:06Z

/release:pr

github-actions · 2024-02-08T16:43:10Z

A new release has been made for this PR. You can install it with npm i @apollo/experimental-nextjs-app-support@0.0.0-commit-c266287.

phryneas

This should be in a good state to be reviewed.

In a second PR, I'm gonna split this up into multiple actual packages, but this is more than enough for one PR.

phryneas · 2024-02-09T16:40:24Z

package/src/combined.ts

+export * from "./rsc/index.js";
+export * from "./ssr/index.js";
+
+export {};


This only exists for TypeScript types - I can't export types * here, as from a TypeScript perspective we are actually importing values from this file, although the js artefact here is never used.
After splitting up the packages, I'll make sure that the artefact is deleted, but right now this bundling detail doesn't matter.

Would it be worth adding this as a code comment? I know I'm going to forget this in 6 months 😂

Good call! I added a comment over in #193

phryneas · 2024-02-09T16:41:37Z

package/package.json

  "typesVersions": {
    "*": {
      "ssr": [
-        "./dist/ssr/index.d.ts"
+        "./dist/ssr/next.ssr.d.ts"
      ],
      "rsc": [
        "./dist/rsc/index.d.ts"
+      ],
+      "manual": [
+        "./dist/ssr/manual.d.ts"
+      ],
+      "core": [
+        "./dist/combined.d.ts"
      ]
    }
  },
+  "typings": "./dist/combined.d.ts",


These are the types that will actually be picked up by TypeScript, since Next.js projects use moduleResolution: node in their tsconfig.json, although node16 would be more correct (and pick up theexports above).

phryneas · 2024-02-09T16:42:56Z

package/src/rsc/registerApolloClient.tsx

-import type { ApolloClient } from "@apollo/client";
-import * as React from "react";
+import type { ApolloClient } from "@apollo/client/index.js";
+import { cache } from "react";


Note to self: for this to work with rehackt instead (which would be more consistent), rehackt's RSC bundling needs to be slightly modified.

A fight for another day.

Was this the 0.5.0 release over there?

Yeah, but I also drop out rehackt as a dependency for this in the next PR :)

package/src/ssr/ExperimentalReact/ExperimentalReactDataTransport.tsx

phryneas · 2024-02-09T16:45:26Z

package/src/ssr/Manual/ManualDataTransport.tsx

+const buildManualDataTransportSSRImpl = ({
+  useInsertHtml,
+}: BuildArgs): DataTransportProviderImplementation<HydrationContextOptions> =>


This is the abstraction that will be shared by Next.js, Redwood and probably any other framework until React adds some primitives for this.

phryneas · 2024-02-09T16:46:45Z

package/src/ssr/Manual/ManualDataTransport.tsx

+      });
+    }
+
+    registerDispatchRequestStarted!((options: WatchQueryOptions) => {


These can be !ed with confidence since they will always be passed in in the SSR build - they will just not be present in the browser build, but this is the SSR implementation of ManualDataTransport

phryneas · 2024-02-09T16:58:06Z

package/src/ssr/NextJs/index.ts

+      const insertHtml = useContext(ServerInsertedHTMLContext);
+      if (!insertHtml) {
+        throw new Error(
+          "ApolloNextAppProvider cannot be used outside of the Next App Router!"
+        );
+      }
+      return insertHtml;


This is all the code that's truly Next.js specific.

phryneas · 2024-02-09T17:07:16Z

/release:pr

github-actions · 2024-02-09T17:08:34Z

A new release has been made for this PR. You can install it with npm i @apollo/experimental-nextjs-app-support@0.0.0-commit-b271305.

luchillo17 · 2024-02-13T14:27:40Z

I've started checking out these changes and there's a lot to look at, but I see the description of the PR is very small, it would be nice to know what is the reason this PR exists, the title doesn't tell me much, is it a refactor for DRY principles? or is there a functional change in how data and/or UI are streamed to the client side?

phryneas · 2024-02-13T15:59:14Z

@luchillo17 We are in the process of separating this package into two separate ones - one more generic @apollo/client-react-streaming and the more specific @apollo/experimental-nextjs-app-support. This is necessary because other frameworks (e.g. RedwoodJs) are now adapting streaming SSR, and we want to add easier support for those.

This is the first of multiple PRs, and the follow-up PR with the actual package split is going over in #193

Honestly, I get that this is a lot, and you really don't need to review all of it - but it would be very helpful if you could give the feedback if jest keeps working for you as this progresses along :)

jerelmiller

I'm not going to pretend I understand all of this 100% but I've learned a lot looking through this. I like a lot of the refactoring that has been done here and think this is a solid base moving forward. I've held this up long enough though, so I'll continue to dig deeper on my own! Incredible work 🎉

jerelmiller · 2024-02-16T05:57:31Z

package/package.json

+    },
+    "./manual": {
+      "require": {
+        "types": "./dist/manual.ssr.d.cts",


TIL there is a .cts extension

jerelmiller · 2024-02-16T06:08:46Z

package/src/rsc/registerApolloClient.tsx

-import type { ApolloClient } from "@apollo/client";
-import * as React from "react";
+import type { ApolloClient } from "@apollo/client/index.js";
+import { cache } from "react";


Was this the 0.5.0 release over there?

jerelmiller · 2024-02-16T06:13:05Z

package/src/ssr/AccumulateMultipartResponsesLink.test.ts

    results: [],
    error: undefined,
    complete: false,
  });

-  vi.advanceTimersByTime(100);
+  mock.timers.tick(100);


Neat! I didn't realize node had built in mock timers

jerelmiller · 2024-02-16T06:30:07Z

package/src/ssr/useTransportValue.tsx

-      }
-      if (id in store) value = store[id] as T;
-    }
+  const dataTransport = useContext(DataTransportContext);


I like this refactor 💯

package/src/ssr/Manual/ManualDataTransport.tsx

package/src/ssr/WrappedInMemoryCache.tsx

jerelmiller · 2024-02-17T00:15:40Z

package/src/ssr/WrappedApolloClient.test.tsx

+
+    assert.ok(attemptedRenderCount > 0);
+    assert.ok(finishedRenderCount > 0);
+  }


Sorry if this is a naive question, but does the cache play any role here? As in, do we need to check the cache to make sure the result made it in the cache?

Doesn't hurt - I've added another assertion :)

Co-authored-by: Jerel Miller <jerelmiller@gmail.com>

dac09 · 2024-02-19T11:17:56Z

🥳🥳🥳🥳🥳

separate transport-specific streaming logic out

dee59cc

This comment was marked as outdated.

Sign in to view

phryneas added 6 commits February 5, 2024 15:36

move specific exports to next folder

4f29479

bundling

cbba73f

fix up integration test: wait until hydration could finish

5f6d1d5

remove useStaticValueRef/useTransportValue split

e88f985

adjust imports

f2db28b

switch to node test runner, tests for rsc/ssr/browser

7146cdb

This comment was marked as outdated.

Sign in to view

phryneas mentioned this pull request Feb 8, 2024

SuperJson Jest SWC run issue #184

Open

fixup

d748e4d

This comment was marked as outdated.

Sign in to view

more fixup

ff7e466

This comment was marked as outdated.

Sign in to view

Merge branch 'main' into pr/generalized-package

1c76bcc

This comment was marked as outdated.

Sign in to view

Merge remote-tracking branch 'origin/main' into pr/generalized-package

aab86af

This comment was marked as outdated.

Sign in to view

fixup

fac6765

This comment was marked as outdated.

Sign in to view

lots of very fiddly packaging details

c266287

phryneas added 2 commits February 8, 2024 19:07

test hook->transport (ssr) and transport->hook (browser)

b7618d1

move readyState test into transport

b5e57ec

phryneas added 7 commits February 9, 2024 17:19

readability

3b8ddcb

remove old package from test matrix

7736df9

remove accidentally committed file

51e2f60

change Next to Manual in a few places

0285f2f

rename variable

a72a03b

remove comment

3d68b35

remove console.log

b271305

phryneas commented Feb 9, 2024

View reviewed changes

phryneas marked this pull request as ready for review February 9, 2024 17:07

phryneas requested a review from a team as a code owner February 9, 2024 17:07

better output for failing integration tests

69169cf

phryneas changed the title ~~separate transport-specific streaming logic out into separate packages~~ separate transport-specific streaming logic out Feb 12, 2024

This was referenced Feb 14, 2024

reduce repetition by reordering exports phryneas/rehackt#5

Merged

async registerApolloClient ? #195

Open

jerelmiller approved these changes Feb 17, 2024

View reviewed changes

phryneas and others added 4 commits February 19, 2024 11:46

Update package/src/ssr/WrappedInMemoryCache.tsx

e3436d0

Co-authored-by: Jerel Miller <jerelmiller@gmail.com>

Update package/src/ssr/Manual/ManualDataTransport.tsx

d06fa6d

Co-authored-by: Jerel Miller <jerelmiller@gmail.com>

add test assertion on cache contents

52e123a

remove syntax error

f285762

phryneas merged commit 7c2ca9e into main Feb 19, 2024
9 checks passed

phryneas deleted the pr/generalized-package branch February 19, 2024 10:58

separate transport-specific streaming logic out #189

separate transport-specific streaming logic out #189

Conversation

phryneas commented Feb 5, 2024 • edited Loading

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

github-actions bot commented Feb 8, 2024

phryneas commented Feb 8, 2024

github-actions bot commented Feb 8, 2024

phryneas 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

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 Feb 9, 2024

github-actions bot commented Feb 9, 2024

luchillo17 commented Feb 13, 2024 • edited Loading

phryneas commented Feb 13, 2024 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dac09 commented Feb 19, 2024

phryneas commented Feb 5, 2024 •

edited

Loading

luchillo17 commented Feb 13, 2024 •

edited

Loading

phryneas commented Feb 13, 2024 •

edited

Loading