Fix package dependencies #1489

frandiox · 2023-11-06T02:52:31Z

Trying to fix peer dependencies of our packages here. See comments below.

frandiox · 2023-11-06T02:56:30Z

.changeset/tiny-donkeys-suffer.md

+---
+'skeleton': patch
+---
+
+Since Remix is now a peer dependency of `@shopify/remix-oxygen`, you need to add `@remix-run/server-runtime` to your dependencies with the same version you have for the rest of Remix dependencies.
+
+```diff
+"dependencies": {
+  "@remix-run/react": "2.1.0"
+ "@remix-run/server-runtime": "2.1.0"
+  ...
+}
+```


@remix-run/server-runtime was marked as a peer dependency in #1484. This is not what other Remix adapters do but I agree it makes sense for us since we don't follow the same versioning as other adapters.
The downside is that users should install @remix-run/server-runtime as well as the adapter.

I thought about this, but was worried about a breaking change. But we can just say this is apart of the 2023.10 release of making Remix a peer dep 🙈

Yes this is actually a "bug fix". Luckily it doesn't even break anything because @remix-run/server-runtime is already installed by other Remix packages I think.

frandiox · 2023-11-06T02:59:33Z

packages/cli/package.json

-    "@remix-run/react": "^2.1.0",
-    "@shopify/hydrogen": "2023.10.2",
-    "@shopify/remix-oxygen": "^2.0.0"


These peer dependencies were added because we are using them in virtual routes. That might not be a big enough reason to list them here, let's just remove them for now since the project will execute in the context of the user project where these dependencies should already be installed.

We should test virtual routes in the @next release to make sure this works.

frandiox · 2023-11-06T03:01:40Z

packages/hydrogen/package.json

-  "peerDependenciesMeta": {
-    "@remix-run/server-runtime": {
-      "optional": true
-    },
-    "@remix-run/react": {
-      "optional": true
-    }


I don't think we should mark these as optional. The user should get an error/warning when installing if server-runtime or remix/react are not available since they are core to Hydrogen.

frandiox · 2023-11-06T03:02:28Z

packages/remix-oxygen/package.json

-  "peerDependenciesMeta": {
-    "@remix-run/server-runtime": {
-      "optional": true
-    }


Similar to Hydrogen, server-runtime is core to the remix-oxygen adapter so there should be an error if it's missing.

frandiox · 2023-11-06T03:18:21Z

templates/skeleton/package.json

    "@shopify/cli": "3.50.0",
    "@shopify/cli-hydrogen": "^6.0.0",
-    "@shopify/hydrogen": "^2023.10.0",
-    "@shopify/remix-oxygen": "^2.0.0",
+    "@shopify/hydrogen": "~2023.10.2",


Also, using ^ in our templates for Hydrogen leads to getting new major versions. Better to use ~ for this one, or even pin to our latest release every time. Thoughts?

We just need to make sure a resolved project doesn't have duplicate remix dependencies.

blittle

LGTM, let's merge and test the next release. Specifically make sure that the types from useLoaderData<typeof loader>() resolve properly. That's the server/client boundary that breaks when theirs a mismatch in the server/client runtime versions.

frandiox · 2023-11-07T03:39:23Z

It seems to be working well in @next:

╰─❯ npm run typecheck                

> hydrogen-test@0.0.0-next-8fce70d-20231107025821 typecheck
> tsc --noEmit

I've tried virtual routes, dev and build with npm and pnpm because they both organize node_modules in different ways. It seems to be working well 👍

frandiox added 9 commits November 6, 2023 11:22

Remove unused deps from mini-oxygen

c20128c

Remove peerDeps from cli that are only used in virtual routes

4df855e

Do not import from remix-oxygen in virtual-routes

d309a4e

Do not mark server-runtime as optional peerDep in remix-oxygen

fc29773

Do not mark remix deps as optional peerDeps in hydrogen

f96b9c3

Update package-lock

1ef831f

Add server-runtime as a dependency in user projects

6fcd7c0

Changesets

e035684

Changesets

9ac1067

frandiox requested review from blittle and a team November 6, 2023 02:52

github-actions bot deployed to preview November 6, 2023 02:52 View deployment

frandiox commented Nov 6, 2023

View reviewed changes

Change Hydrogen dependency in templates

dc98fff

frandiox commented Nov 6, 2023

View reviewed changes

github-actions bot deployed to preview November 6, 2023 03:19 View deployment

frandiox mentioned this pull request Nov 6, 2023

Skip Oxygen checks when @shopify/remix-oxygen is not installed #1137

Merged

blittle approved these changes Nov 6, 2023

View reviewed changes

wizardlyhel approved these changes Nov 6, 2023

View reviewed changes

frandiox merged commit 8fce70d into main Nov 7, 2023
9 checks passed

frandiox deleted the fd-fix-deps branch November 7, 2023 02:56

shopify-github-actions-access bot mentioned this pull request Nov 7, 2023

[ci] release 2023-10 #1491

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix package dependencies #1489

Fix package dependencies #1489

frandiox commented Nov 6, 2023

frandiox Nov 6, 2023

blittle Nov 6, 2023

frandiox Nov 7, 2023

frandiox Nov 6, 2023 •

edited

frandiox Nov 6, 2023

frandiox Nov 6, 2023

frandiox Nov 6, 2023

blittle Nov 6, 2023

blittle left a comment

frandiox commented Nov 7, 2023

Fix package dependencies #1489

Fix package dependencies #1489

Conversation

frandiox commented Nov 6, 2023

frandiox Nov 6, 2023

Choose a reason for hiding this comment

blittle Nov 6, 2023

Choose a reason for hiding this comment

frandiox Nov 7, 2023

Choose a reason for hiding this comment

frandiox Nov 6, 2023 • edited

Choose a reason for hiding this comment

frandiox Nov 6, 2023

Choose a reason for hiding this comment

frandiox Nov 6, 2023

Choose a reason for hiding this comment

frandiox Nov 6, 2023

Choose a reason for hiding this comment

blittle Nov 6, 2023

Choose a reason for hiding this comment

blittle left a comment

Choose a reason for hiding this comment

frandiox commented Nov 7, 2023

frandiox Nov 6, 2023 •

edited