Clean up build scripts #12305

phryneas · 2025-01-24T15:11:49Z

The goal of this PR is to move the build scripts to TS,
use node with --experimental-strip-types instead of ts-node
and unify all the helpers we have in "scripts" - we are in a jungle
of "node run calls more node run".

That should give us a starting point to grok what our current build
actually does and which parts of it we need to modernize.

…ld.ts`

changeset-bot · 2025-01-24T15:11:53Z

⚠️ No Changeset found

Latest commit: 2b77df6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

svc-apollo-docs · 2025-01-24T15:11:54Z

⚠️ Docs preview not attached to branch

The preview was not built because the PR's base branch release-4.0 is not in the list of sources.

An Apollo team member can comment one of the following commands to dictate which branch to attach the preview to:

!docs set-base-branch version-2.6
!docs set-base-branch main

Build ID: 8bc0a4ada48596c908f45249

netlify · 2025-01-24T15:12:54Z

✅ Deploy Preview for apollo-client-docs ready!

Name	Link
🔨 Latest commit	`2b77df6`
🔍 Latest deploy log	https://app.netlify.com/sites/apollo-client-docs/deploys/679c901f4c52a30008474344
😎 Deploy Preview	https://deploy-preview-12305--apollo-client-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

pkg-pr-new · 2025-01-24T15:23:24Z

npm i https://pkg.pr.new/@apollo/client@12305

commit: 2b77df6

github-actions · 2025-01-24T15:23:55Z

size-limit report 📦

Path	Size
dist/apollo-client.min.cjs	33.47 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs"	41.41 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" (production)	38.72 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js"	36.15 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" (production)	33.55 KB (0%)
import { ApolloProvider } from "dist/react/index.js"	1.26 KB (0%)
import { ApolloProvider } from "dist/react/index.js" (production)	1.24 KB (0%)
import { useQuery } from "dist/react/index.js"	5.12 KB (0%)
import { useQuery } from "dist/react/index.js" (production)	4.21 KB (0%)
import { useLazyQuery } from "dist/react/index.js"	5.61 KB (0%)
import { useLazyQuery } from "dist/react/index.js" (production)	4.68 KB (0%)
import { useMutation } from "dist/react/index.js"	3.62 KB (0%)
import { useMutation } from "dist/react/index.js" (production)	2.84 KB (0%)
import { useSubscription } from "dist/react/index.js"	4.43 KB (0%)
import { useSubscription } from "dist/react/index.js" (production)	3.48 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js"	5.51 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" (production)	4.17 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js"	5.01 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" (production)	3.66 KB (0%)
import { useLoadableQuery } from "dist/react/index.js"	5.09 KB (0%)
import { useLoadableQuery } from "dist/react/index.js" (production)	3.74 KB (0%)
import { useReadQuery } from "dist/react/index.js"	3.41 KB (0%)
import { useReadQuery } from "dist/react/index.js" (production)	3.35 KB (0%)
import { useFragment } from "dist/react/index.js"	2.01 KB (0%)
import { useFragment } from "dist/react/index.js" (production)	1.95 KB (0%)

phryneas · 2025-01-24T15:33:19Z

package.json

-  "engines": {
-    "npm": "^7.20.3 || ^8.0.0 || ^9.0.0 || ^10.0.0"


The engines field was kinda weird as we can tell our consumers which runtime Apollo Client works in, but it doesn't make any sense to prescribe which package manager it works in.

We can also never drop anything from that list without a major. Removing it. We might add a node field here to indicate actual runtime compatibility, but that's not a concern for this PR and I'm not sure if we should.

phryneas · 2025-01-24T15:37:17Z

package.json

    "changeset-publish": "npm run build && npm run prepdist:changesets && cd dist && changeset publish",
    "changeset-check": "changeset status --verbose --since=origin/main",
    "pkg-pr-new-publish": "npm run build && cd dist && pkg-pr-new publish --no-template --compact",
    "changeset-version": "changeset version && npm i",
    "update-size-limits": "size-limit --json | jq '. | map(select(.sizeLimit) | { key: .name, value: .size}) | from_entries' | tee .new-size-limits.json; mv .new-size-limits.json .size-limits.json"
  },
-  "engines": {
-    "npm": "^7.20.3 || ^8.0.0 || ^9.0.0 || ^10.0.0"
+  "devEngines": {


Instead I'm adding a devEngines field which allows us to specify which tooling should be used to develop Apollo Client - we don't need to be backwards compatible here but can bump it from time to time.

Starting with node 22.6 and the npm version that was released alongside with it here, as that's the node version that introduced --experimental-strip-types.

We could also go for 23.6 to unflag it (here and everywhere else) - I'm open for discussion :)

I'm down for 23.6. I just ran the build script with that version installed with no issues, so might as well go for it.

phryneas · 2025-01-27T13:15:09Z

package.json

-    "update-version": "node config/version.js update",
-    "verify-version": "node config/version.js verify",
-    "invariants": "ts-node-script config/processInvariants.ts",
-    "sourcemaps": "ts-node-script config/rewriteSourceMaps.ts",
-    "rollup": "rollup -c ./config/rollup.config.js",
-    "prepdist": "node ./config/prepareDist.js",
-    "prepdist:changesets": "ts-node-script config/prepareChangesetsRelease.ts",
-    "postprocess-dist": "ts-node-script config/postprocessDist.ts",


Most of these were called by postbuild, but we never called them manually on the CLI, so I removed them here.

prepdist:changesets and inline-inherit-doc were inlined further down in the commands that call them.

phryneas · 2025-01-27T13:16:06Z

config/build.ts

+const allSteps = Object.assign({}, buildSteps, additionalSteps);
+
+const runSteps = args.values.step.flatMap((step) =>
+  step === "build" ? Object.keys(buildSteps) : [step]


Calling this with --step=build is a shorthand for the normal build steps - that makes it possible to call it with --step=build --step=prepareChangesetsRelease instead of being forced to use a much longer command.

phryneas · 2025-01-28T10:49:57Z

patches/jest-config+29.7.0.patch

+-    if (isTS) {
+    if (isTS && !process.features.typescript) {


See jestjs/jest#15480

jerelmiller

Good stuff! Thanks for modernizing these

move from ts-node to node --experimental-strip-types, create `bui…

261622e

…ld.ts`

phryneas added 2 commits January 24, 2025 16:21

remove engines field, specify devEngines

96181a5

adjust node version for CI

ed17d0a

fix up some more syntax

89d4bb7

phryneas commented Jan 24, 2025

View reviewed changes

phryneas added 10 commits January 24, 2025 16:38

prettier

a3c6ff1

adjust precheck, bump minimal lockfile version to 3

1b80b4e

convert jest config to esm

f8152b3

move entryPoints to TS, make it work in mjs and jest

85a4a13

run rollup with ts config

4067869

update a few more node calls

3d6686c

some more typings

ab50228

move all scripts to function invocation

05bfd25

migrate prepareChangestsRelease too

aee764a

remove scripts that are not called manually

cf3bae4

phryneas commented Jan 27, 2025

View reviewed changes

phryneas added 5 commits January 28, 2025 11:15

convert prepareDist to TS

a25730c

migrate precheck.js

f02eb4b

version.js->ts

c00f3cd

use jest ts config

795a432

prettier

c75c83e

phryneas mentioned this pull request Jan 28, 2025

feat(config): if process.features.typescript is set, load jest.config.ts without external loader jestjs/jest#15480

Merged

phryneas commented Jan 28, 2025

View reviewed changes

phryneas added 4 commits January 28, 2025 13:18

dirname.cjs->cts

ad9a12d

Merge remote-tracking branch 'origin/release-4.0' into pr/build-changes

b05822e

dirname-related import fixes

fa398ba

fix up new knip issues

c68ae2c

phryneas marked this pull request as ready for review January 28, 2025 12:41

phryneas requested a review from jerelmiller January 28, 2025 12:42

delete devEngines instead of engines field

62792ef

jerelmiller approved these changes Jan 30, 2025

View reviewed changes

phryneas added 2 commits January 31, 2025 09:49

require node 23.6 instead of 22.6

6f3a7e6

Merge remote-tracking branch 'origin/release-4.0' into pr/build-changes

2b77df6

phryneas merged commit 6585f99 into release-4.0 Jan 31, 2025
48 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Mar 3, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clean up build scripts #12305

Clean up build scripts #12305

phryneas commented Jan 24, 2025

changeset-bot bot commented Jan 24, 2025 •

edited

Loading

svc-apollo-docs commented Jan 24, 2025 •

edited

Loading

netlify bot commented Jan 24, 2025 •

edited

Loading

pkg-pr-new bot commented Jan 24, 2025 •

edited

Loading

github-actions bot commented Jan 24, 2025 •

edited

Loading

phryneas Jan 24, 2025 •

edited

Loading

phryneas Jan 24, 2025

jerelmiller Jan 30, 2025

phryneas Jan 27, 2025

phryneas Jan 27, 2025

phryneas Jan 28, 2025

jerelmiller left a comment

Clean up build scripts #12305

Clean up build scripts #12305

Conversation

phryneas commented Jan 24, 2025

changeset-bot bot commented Jan 24, 2025 • edited Loading

⚠️ No Changeset found

svc-apollo-docs commented Jan 24, 2025 • edited Loading

⚠️ Docs preview not attached to branch

netlify bot commented Jan 24, 2025 • edited Loading

✅ Deploy Preview for apollo-client-docs ready!

pkg-pr-new bot commented Jan 24, 2025 • edited Loading

github-actions bot commented Jan 24, 2025 • edited Loading

size-limit report 📦

phryneas Jan 24, 2025 • edited Loading

Choose a reason for hiding this comment

phryneas Jan 24, 2025

Choose a reason for hiding this comment

jerelmiller Jan 30, 2025

Choose a reason for hiding this comment

phryneas Jan 27, 2025

Choose a reason for hiding this comment

phryneas Jan 27, 2025

Choose a reason for hiding this comment

phryneas Jan 28, 2025

Choose a reason for hiding this comment

jerelmiller left a comment

Choose a reason for hiding this comment

changeset-bot bot commented Jan 24, 2025 •

edited

Loading

svc-apollo-docs commented Jan 24, 2025 •

edited

Loading

netlify bot commented Jan 24, 2025 •

edited

Loading

pkg-pr-new bot commented Jan 24, 2025 •

edited

Loading

github-actions bot commented Jan 24, 2025 •

edited

Loading

phryneas Jan 24, 2025 •

edited

Loading