Enable yarn 3 for Redwood projects

package.json

@@ -21,6 +21,7 @@
     "lint:fix": "yarn lint --fix",
     "project:copy": "node ./tasks/framework-tools/frameworkFilesToProject.mjs",
     "project:deps": "node ./tasks/framework-tools/frameworkDepsToProject.mjs",
+    "project:deps:yarn3": "node ./tasks/framework-tools/frameworkDepsToYarn3Project.mjs",
     "project:sync": "node ./tasks/framework-tools/frameworkSyncToProject.mjs",
     "publish:canary": "lerna publish --force-publish --canary --include-merged-tags --preid canary --dist-tag canary --yes --loglevel verbose",
     "release": "node ./tasks/release/cli.mjs",

packages/api/package.json

@@ -9,6 +9,12 @@
   "license": "MIT",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "bin": {
+    "redwood": "./dist/bins/redwood.js",
+    "rw": "./dist/bins/redwood.js",
+    "rwfw": "./dist/bins/rwfw.js",
+    "tsc": "./dist/bins/tsc.js"
+  },
   "files": [
     "dist",
     "logger",

packages/api/src/bins/redwood.ts

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+import { createRequire } from 'module'
+
+const requireFromCli = createRequire(
+  require.resolve('@redwoodjs/cli/package.json')
+)
+
+const bins = requireFromCli('./package.json')['bin']
+
+// Ensure we run all commands from the base of the RW project
+// even if you invoke from ./web or ./api
+const rwProjectRoot = requireFromCli('./dist/lib/index.js').getPaths().base
+process.chdir(rwProjectRoot)
+
+requireFromCli(bins['redwood'])

packages/api/src/bins/rwfw.ts

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+import { createRequire } from 'module'
+
+const requireFromCli = createRequire(
+  require.resolve('@redwoodjs/cli/package.json')
+)
+
+const bins = requireFromCli('./package.json')['bin']
+
+// Ensure we run all commands from the base of the RW project
+// even if you invoke from ./web or ./api
+const rwProjectRoot = requireFromCli('./dist/lib/index.js').getPaths().base
+process.chdir(rwProjectRoot)
+
+requireFromCli(bins['rwfw'])

packages/api/src/bins/tsc.ts

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+import { createRequire } from 'module'
+
+const requireFromTypeScript = createRequire(
+  require.resolve('typescript/package.json')
+)
+
+const bins = requireFromTypeScript('./package.json')['bin']
+
+requireFromTypeScript(bins['tsc'])

packages/cli/src/commands/__tests__/type-check.test.js

@@ -44,6 +44,12 @@ jest.mock('../../lib', () => {
   }
 })
 
+jest.mock('../../commands/upgrade', () => {
+  return {
+    getCmdMajorVersion: () => 3,
+  }
+})
+
 import path from 'path'
 
 import concurrently from 'concurrently'
@@ -70,12 +76,12 @@ test('Should run tsc commands correctly, in order', async () => {
   // Ensure tsc command run correctly for web side
   expect(concurrentlyArgs.commands).toContainEqual({
     cwd: path.join('myBasePath', 'web'),
-    command: 'yarn -s tsc --noEmit --skipLibCheck',
+    command: 'yarn  tsc --noEmit --skipLibCheck',
   })
   // Ensure tsc command run correctly for web side
   expect(concurrentlyArgs.commands).toContainEqual({
     cwd: path.join('myBasePath', 'api'),
-    command: 'yarn -s tsc --noEmit --skipLibCheck',
+    command: 'yarn  tsc --noEmit --skipLibCheck',
   })
   // Ensure we have raw sequential output from tsc
   expect(concurrentlyArgs.options).toEqual({ group: true, raw: true })
@@ -95,9 +101,9 @@ test('Should generate prisma client', async () => {
   // Ensure tsc command run correctly for web side
   expect(concurrentlyArgs.commands).toContainEqual({
     cwd: path.join('myBasePath', 'api'),
-    command: 'yarn -s tsc --noEmit --skipLibCheck',
+    command: 'yarn  tsc --noEmit --skipLibCheck',
   })
-  expect(runCommandTask.mock.results[0].value[0]).toEqual(
-    'yarn prisma generate --schema="../../__fixtures__/example-todo-main/api/prisma"'
+  expect(runCommandTask.mock.results[0].value[0]).toMatch(
+    /.+(\\|\/)prisma(\\|\/)build(\\|\/)index.js.+/
   )
 })

packages/cli/src/commands/build.js

@@ -98,7 +98,7 @@ export const handler = async ({
       `yarn cross-env NODE_ENV=production webpack --config ${require.resolve(
         '@redwoodjs/core/config/webpack.perf.js'
       )}`,
-      { stdio: 'inherit', shell: true }
+      { stdio: 'inherit', shell: true, cwd: rwjsPaths.web.base }
     )
     // We do not want to continue building...
     return
@@ -110,7 +110,7 @@ export const handler = async ({
       `yarn cross-env NODE_ENV=production webpack --config ${require.resolve(
         '@redwoodjs/core/config/webpack.stats.js'
       )}`,
-      { stdio: 'inherit', shell: true }
+      { stdio: 'inherit', shell: true, cwd: rwjsPaths.web.base }
     )
     // We do not want to continue building...
     return

packages/cli/src/commands/setup/deploy/helpers/index.js

@@ -1,3 +1,4 @@
+import { spawnSync } from 'child_process'
 import fs from 'fs'
 import path from 'path'
 
@@ -114,10 +115,14 @@ export const addPackagesTask = ({
       ].filter(Boolean),
     ]
   } else {
+    const { stdout } = spawnSync('yarn', ['--version'])
+
+    const yarnVersion = stdout.toString()
+
     installCommand = [
       'yarn',
       [
-        '-W',
+        yarnVersion.startsWith('1') && '-W',
         'add',
         devDependency && '--dev',
         ...packagesWithSameRWVersion,

packages/cli/src/commands/setup/deploy/providers/serverless.js

@@ -91,10 +91,22 @@ const updateRedwoodTomlTask = () => {
 }
 
 export const handler = async ({ force }) => {
+  const [serverless, serverlessLift, ...rest] = projectDevPackages
+
   const tasks = new Listr(
     [
       addPackagesTask({
-        packages: projectDevPackages,
+        packages: [serverless, ...rest],
+        devDependency: true,
+      }),
+      addPackagesTask({
+        packages: [serverless, serverlessLift],
+        side: 'web',
+        devDependency: true,
+      }),
+      addPackagesTask({
+        packages: [serverless],
+        side: 'api',
         devDependency: true,
       }),
       addFilesTask({

packages/cli/src/commands/setup/ui/libraries/tailwindcss.js

@@ -124,7 +124,9 @@ export const handler = async ({ force, install }) => {
           }
         }
 
-        await execa('yarn', ['tailwindcss', 'init', tailwindConfigPath])
+        await execa('yarn', ['tailwindcss', 'init', tailwindConfigPath], {
+          cwd: rwPaths.web.base,
+        })
 
         // Replace `content`.
         const tailwindConfig = fs.readFileSync(tailwindConfigPath, 'utf-8')

packages/cli/src/commands/type-check.js

@@ -8,6 +8,7 @@ import terminalLink from 'terminal-link'
 import { getProject } from '@redwoodjs/structure'
 import { errorTelemetry } from '@redwoodjs/telemetry'
 
+import { getCmdMajorVersion } from '../commands/upgrade'
 import { getPaths } from '../lib'
 import c from '../lib/colors'
 import { generatePrismaClient } from '../lib/generatePrismaClient'
@@ -55,13 +56,17 @@ export const handler = async ({ sides, verbose, prisma, generate }) => {
   const typeCheck = async () => {
     let conclusiveExitCode = 0
 
+    const yarnVersion = await getCmdMajorVersion('yarn')
+
     const tscForAllSides = sides.map((side) => {
       const projectDir = path.join(getPaths().base, side)
       // -s flag to suppress error output from yarn. For example yarn doc link on non-zero status.
       // Since it'll be printed anyways after the whole execution.
       return {
         cwd: projectDir,
-        command: `yarn -s tsc --noEmit --skipLibCheck`,
+        command: `yarn ${
+          yarnVersion > 1 ? '' : '-s'
+        } tsc --noEmit --skipLibCheck`,
       }
     })
 

packages/cli/src/commands/upgrade.js

@@ -143,13 +143,19 @@ export const handler = async ({ dryRun, tag, verbose, dedupe }) => {
   }
 }
 async function yarnInstall({ verbose }) {
+  const yarnVersion = await getCmdMajorVersion('yarn')
+
   try {
-    await execa('yarn install', ['--force', '--non-interactive'], {
-      shell: true,
-      stdio: verbose ? 'inherit' : 'pipe',
+    await execa(
+      'yarn install',
+      yarnVersion > 1 ? [] : ['--force', '--non-interactive'],
+      {
+        shell: true,
+        stdio: verbose ? 'inherit' : 'pipe',
 
-      cwd: getPaths().base,
-    })
+        cwd: getPaths().base,
+      }
+    )
   } catch (e) {
     throw new Error(
       'Could not finish installation. Please run `yarn install --force`, before continuing'
@@ -253,11 +259,12 @@ async function refreshPrismaClient(task, { verbose }) {
   }
 }
 
-const getCmdMajorVersion = async (command) => {
+export const getCmdMajorVersion = async (command) => {
   // Get current version
   const { stdout } = await execa(command, ['--version'], {
     cwd: getPaths().base,
   })
+
   if (!SEMVER_REGEX.test(stdout)) {
     throw new Error(`Unable to verify ${command} version.`)
   }

packages/cli/src/lib/generatePrismaClient.js

@@ -21,7 +21,7 @@ export const generatePrismaCommand = (schema) => {
   }
 
   return {
-    cmd: 'yarn prisma',
+    cmd: `node "${require.resolve('prisma/build/index.js')}"`,
     args: ['generate', schema && `--schema="${schema}"`],
   }
 }

packages/cli/src/rwfw.js

@@ -47,9 +47,10 @@ if (!command.length || command.some((cmd) => helpCommands.includes(cmd))) {
 }
 
 try {
-  execa.sync('yarn', ['--cwd', absRwFwPath, ...command], {
+  execa.sync('yarn', [...command], {
     stdio: 'inherit',
     shell: true,
+    cwd: absRwFwPath,
     env: {
       RWJS_CWD: projectPath,
     },

packages/codemods/src/codemods/v0.48.x/upgradeYarn/README.md

@@ -0,0 +1,21 @@
+# Upgrade Yarn
+
+This codemod upgrades Redwood projects from yarn 1 to yarn 3.
+
+The first thing it does is enable corepack:
+
+```
+corepack enable
+```
+
+Corepack is a new thing in the Node.js core—it essentially packages yarn with node so that it doesn't have to be installed separately.
+Its only available on node >= `v14.9.0`, so we check for that first.
+
+After enabling corepack, we set the yarn version:
+
+```
+yarn set version stable
+```
+
+Finally, before installing, we have to update `.yarnrc.yml` and `.gitignore`.
+We have to update the `.yarnc.yml` because we only support the `node_modules` install strategy.

packages/codemods/src/codemods/v0.48.x/upgradeYarn/__testfixtures__/default/input/.gitignore

@@ -0,0 +1,13 @@
+.idea
+.DS_Store
+.env
+.netlify
+.redwood
+dev.db*
+dist
+dist-babel
+node_modules
+yarn-error.log
+web/public/mockServiceWorker.js
+web/types/graphql.d.ts
+api/types/graphql.d.ts

packages/codemods/src/codemods/v0.48.x/upgradeYarn/__testfixtures__/default/input/package.json

@@ -0,0 +1,24 @@
+{
+  "private": true,
+  "workspaces": {
+    "packages": [
+      "api",
+      "web",
+      "packages/*"
+    ]
+  },
+  "devDependencies": {
+    "@redwoodjs/core": "0.47.0"
+  },
+  "eslintConfig": {
+    "extends": "@redwoodjs/eslint-config",
+    "root": true
+  },
+  "engines": {
+    "node": ">=14.17 <=16.x",
+    "yarn": ">=1.15 <2"
+  },
+  "prisma": {
+    "seed": "yarn rw exec seed"
+  }
+}

packages/codemods/src/codemods/v0.48.x/upgradeYarn/__testfixtures__/default/output/.gitignore

@@ -0,0 +1,20 @@
+.idea
+.DS_Store
+.env
+.netlify
+.redwood
+dev.db*
+dist
+dist-babel
+node_modules
+yarn-error.log
+web/public/mockServiceWorker.js
+web/types/graphql.d.ts
+api/types/graphql.d.ts
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions

packages/codemods/src/codemods/v0.48.x/upgradeYarn/__testfixtures__/default/output/.yarnrc.yml

@@ -0,0 +1,9 @@
+compressionLevel: 0
+
+enableGlobalCache: true
+
+nmMode: hardlinks-local
+
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-3.2.0.cjs

packages/codemods/src/codemods/v0.48.x/upgradeYarn/__testfixtures__/default/output/package.json

@@ -0,0 +1,25 @@
+{
+  "private": true,
+  "workspaces": {
+    "packages": [
+      "api",
+      "web",
+      "packages/*"
+    ]
+  },
+  "devDependencies": {
+    "@redwoodjs/core": "0.47.0"
+  },
+  "eslintConfig": {
+    "extends": "@redwoodjs/eslint-config",
+    "root": true
+  },
+  "engines": {
+    "node": ">=14.17 <=16.x",
+    "yarn": ">=1.15 <2"
+  },
+  "prisma": {
+    "seed": "yarn rw exec seed"
+  },
+  "packageManager": "[email protected]"
+}