RSC: vite externalConditions (#9333)

.github/actions/actionsLib.mjs

@@ -1,6 +1,7 @@
 /* eslint-env node */
 // @ts-check
 
+import fs from 'node:fs'
 import path from 'node:path'
 import { fileURLToPath } from 'node:url'
 
@@ -98,3 +99,69 @@ export async function createCacheKeys({ baseKeyPrefix, distKeyPrefix }) {
     distKey
   }
 }
+
+/**
+ * @callback ExecInProject
+ * @param {string} commandLine command to execute (can include additional args). Must be correctly escaped.
+ * @param {Omit<ExecOptions, "cwd">=} options exec options.  See ExecOptions
+ * @returns {Promise<unknown>} exit code
+ */
+
+/**
+ * @param {string} testProjectPath
+ * @param {string} fixtureName
+ * @param {Object} core
+ * @param {(key: string, value: string) => void} core.setOutput
+ * @param {ExecInProject} execInProject
+ * @returns {Promise<void>}
+ */
+export async function setUpRscTestProject(
+  testProjectPath,
+  fixtureName,
+  core,
+  execInProject
+) {
+  core.setOutput('test-project-path', testProjectPath)
+
+  console.log('rwPath', REDWOOD_FRAMEWORK_PATH)
+  console.log('testProjectPath', testProjectPath)
+
+  const fixturePath = path.join(
+    REDWOOD_FRAMEWORK_PATH,
+    '__fixtures__',
+    fixtureName
+  )
+  const rwBinPath = path.join(
+    REDWOOD_FRAMEWORK_PATH,
+    'packages/cli/dist/index.js'
+  )
+  const rwfwBinPath = path.join(
+    REDWOOD_FRAMEWORK_PATH,
+    'packages/cli/dist/rwfw.js'
+  )
+
+  console.log(`Creating project at ${testProjectPath}`)
+  console.log()
+  fs.cpSync(fixturePath, testProjectPath, { recursive: true })
+
+  console.log(`Adding framework dependencies to ${testProjectPath}`)
+  await projectDeps(testProjectPath)
+  console.log()
+
+  console.log(`Installing node_modules in ${testProjectPath}`)
+  await execInProject('yarn install')
+
+  console.log(`Building project in ${testProjectPath}`)
+  await execInProject(`node ${rwBinPath} build -v`)
+  console.log()
+
+  console.log(`Copying over framework files to ${testProjectPath}`)
+  await execInProject(`node ${rwfwBinPath} project:copy`, {
+    env: { RWFW_PATH: REDWOOD_FRAMEWORK_PATH },
+  })
+  console.log()
+
+  // await cache.saveCache([testProjectPath], dependenciesKey)
+  // console.log(`Cache saved with key: ${dependenciesKey}`)
+}
+

.github/actions/rsc_related_changes/rsc_related_changes.mjs

@@ -29,6 +29,8 @@ async function main() {
       changedFile.startsWith('tasks/smoke-tests/rsc/') ||
       changedFile.startsWith('tasks/smoke-tests/rsa/') ||
       changedFile.startsWith('tasks/smoke-tests/basePlaywright.config.ts') ||
+      changedFile.startsWith('.github/actions/set-up-rsa-project/') ||
+      changedFile.startsWith('.github/actions/set-up-rsc-external-packages-project/') ||
       changedFile.startsWith('.github/actions/set-up-rsc-project/') ||
       changedFile.startsWith('github/actions/rsc_related_changes/') ||
       changedFile.startsWith('packages/internal/') ||

.github/actions/set-up-rsc-from-fixture/README.md → .github/actions/set-up-rsa-project/README.md

@@ -12,17 +12,18 @@ Go into the github actions folder
 `cd .github/actions`
 
 Then run the following command to execute the action
-`node set-up-rsc-from-fixture/setUpRscFixtureLocally.mjs`
+`node set-up-rsa-project/setUpRsaProjectLocally.mjs`
 
 ## Design
 
-The main logic of the action is in the `setUpRscFixture.mjs` file. To be able
-to run that code both on GitHub and locally it uses dependency injection. The
-injection is done by `setupRscFixtureLocally.mjs` for when you want to run
-the action on your own machine and by `setupRscFixtureGitHib.mjs` when it's
+The main logic of the action is in the `../actionsLib.mjs` file. To be able to
+run that code both on GitHub and locally it uses dependency injection. The
+injection is done by `setupRsaProjectLocally.mjs` for when you want to run the
+action on your own machine and by `setupRsaProjectGitHib.mjs` when it's
 triggered by GitHub CI.
 
 When doing further changes to the code here it's very important to keep the
 DI scripts as light on logic as possible. Ideally all logic is kept to
-`setUpRscFixture.mjs` so that the same logic is used both locally and on
-GitHub.
+`../actionsLib.mjs` so that the same logic is used both locally and on GitHub.
+Do note though that more actions share that code, so make sure not to break
+the other actions when making changes there.

.github/actions/set-up-rsa-project/action.yaml

@@ -0,0 +1,10 @@
+name: Set up RSA test project from fixture
+description: Sets up an RSA project for smoke-tests
+
+runs:
+  using: node20
+  main: 'setUpRsaProjectGitHub.mjs'
+
+outputs:
+  test-project-path:
+    description: Path to the test project

.github/actions/set-up-rsc-from-fixture/package.json → .github/actions/set-up-rsa-project/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "set-up-rsc-fixture",
+  "name": "set-up-rsa-project",
   "version": "0.0.0",
   "private": true,
   "type": "module"

.github/actions/set-up-rsa-project/setUpRsaProjectGitHub.mjs

@@ -0,0 +1,22 @@
+/* eslint-env node */
+// @ts-check
+
+import path from 'node:path'
+
+import core from '@actions/core'
+
+import { createExecWithEnvInCwd, setUpRscTestProject } from '../actionsLib.mjs'
+
+const testProjectAndFixtureName = 'test-project-rsa'
+const testProjectPath = path.join(
+  path.dirname(process.cwd()),
+  testProjectAndFixtureName
+)
+const execInProject = createExecWithEnvInCwd(testProjectPath)
+
+setUpRscTestProject(
+  testProjectPath,
+  testProjectAndFixtureName,
+  core,
+  execInProject
+)

.github/actions/set-up-rsc-from-fixture/setUpRscFromFixtureLocally.mjs → .github/actions/set-up-rsa-project/setUpRsaProjectLocally.mjs

@@ -6,7 +6,7 @@ import path from 'node:path'
 
 import execa from 'execa'
 
-import { main } from './setUpRscFromFixture.mjs'
+import { setUpRscTestProject } from '../actionsLib.mjs'
 
 class ExecaError extends Error {
   stdout
@@ -71,9 +71,12 @@ function getExecaOptions(cwd, env = {}) {
   }
 }
 
-const rsaProjectPath = path.join(
+const testProjectAndFixtureName = 'test-project-rsa'
+
+const testProjectPath = path.join(
   os.tmpdir(),
-  'redwood-rsa-project',
+  'redwood',
+  testProjectAndFixtureName,
   // ":" is problematic with paths
   new Date().toISOString().split(':').join('-')
 )
@@ -96,8 +99,13 @@ function execInProject(commandLine, options) {
   return exec(
     commandLine,
     undefined,
-    getExecaOptions(rsaProjectPath, options?.env)
+    getExecaOptions(testProjectPath, options?.env)
   )
 }
 
-main(rsaProjectPath, core, execInProject)
+setUpRscTestProject(
+  testProjectPath,
+  testProjectAndFixtureName,
+  core,
+  execInProject
+)

.github/actions/set-up-rsc-external-packages-project/README.md

@@ -0,0 +1,29 @@
+# GitHub action to copy a template RSC project to use for testing
+
+This action copies a RW project with Streaming SSR and RSC support already set
+up. It's used for RSC smoke tests.
+
+It copies the `__fixtures__/test-project-rsc-external-packages` project, runs
+`yarn install` and `project:copy`. Finally it builds the rw app.
+
+## Testing/running locally
+
+Go into the github actions folder
+`cd .github/actions`
+
+Then run the following command to execute the action
+`node set-up-rsc-external-packages-project/setUpRscExternalPackagesProjectLocally.mjs`
+
+## Design
+
+The main logic of the action is in the `../actionsLib.mjs` file. To be able to
+run that code both on GitHub and locally it uses dependency injection. The
+injection is done by `setupRscExternalPackagesProjectLocally.mjs` for when you
+want to run the action on your own machine and by
+`setupRscExternalPackagesProjectGitHib.mjs` when it's triggered by GitHub CI.
+
+When doing further changes to the code here it's very important to keep the
+DI scripts as light on logic as possible. Ideally all logic is kept to
+`../actionsLib.mjs` so that the same logic is used both locally and on GitHub.
+Do note though that more actions share that code, so make sure not to break
+the other actions when making changes there.

.github/actions/set-up-rsc-external-packages-project/action.yaml

@@ -0,0 +1,10 @@
+name: Set up RSC test project with external packages from fixture
+description: Sets up an RSC project that imports external packages for smoke-tests
+
+runs:
+  using: node20
+  main: 'setUpRscExternalPackagesProjectGitHub.mjs'
+
+outputs:
+  test-project-path:
+    description: Path to the test project

.github/actions/set-up-rsc-external-packages-project/jsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "noEmit": true,
+    "esModuleInterop": true,
+    "target": "esnext",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "skipLibCheck": false,
+    "jsx": "react-jsx"
+  },
+}

.github/actions/set-up-rsc-external-packages-project/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "set-up-rsc-external-packages-project",
+  "version": "0.0.0",
+  "private": true,
+  "type": "module"
+}

.github/actions/set-up-rsc-external-packages-project/setUpRscExternalPackagesProjectGitHub.mjs

@@ -0,0 +1,22 @@
+/* eslint-env node */
+// @ts-check
+
+import path from 'node:path'
+
+import core from '@actions/core'
+
+import { createExecWithEnvInCwd, setUpRscTestProject } from '../actionsLib.mjs'
+
+const testProjectAndFixtureName = 'test-project-rsc-external-packages'
+const testProjectPath = path.join(
+  path.dirname(process.cwd()),
+  testProjectAndFixtureName
+)
+const execInProject = createExecWithEnvInCwd(testProjectPath)
+
+setUpRscTestProject(
+  testProjectPath,
+  testProjectAndFixtureName,
+  core,
+  execInProject
+)

.github/actions/set-up-rsc-external-packages-project/setUpRscExternalPackagesProjectLocally.mjs

@@ -0,0 +1,111 @@
+/* eslint-env node */
+// @ts-check
+
+import os from 'node:os'
+import path from 'node:path'
+
+import execa from 'execa'
+
+import { setUpRscTestProject } from '../actionsLib.mjs'
+
+class ExecaError extends Error {
+  stdout
+  stderr
+  exitCode
+
+  constructor({ stdout, stderr, exitCode }) {
+    super(`execa failed with exit code ${exitCode}`)
+    this.stdout = stdout
+    this.stderr = stderr
+    this.exitCode = exitCode
+  }
+}
+
+/**
+ * @template [EncodingType=string]
+ * @typedef {import('execa').Options<EncodingType>} ExecaOptions<T>
+ */
+
+/**
+ * @typedef {{
+ *   env?: Record<string, string>
+ * }} ExecOptions
+ */
+
+/**
+ * @param {string} commandLine command to execute (can include additional args). Must be correctly escaped.
+ * @param {string[]=} args arguments for tool. Escaping is handled by the lib.
+ * @param {ExecOptions=} options exec options.  See ExecOptions
+ */
+async function exec(commandLine, args, options) {
+  return execa(commandLine, args, options)
+    .then(({ stdout, stderr, exitCode }) => {
+      if (exitCode !== 0) {
+        throw new ExecaError({ stdout, stderr, exitCode })
+      }
+    })
+    .catch((error) => {
+      if (error instanceof ExecaError) {
+        // Rethrow ExecaError
+        throw error
+      } else {
+        const { stdout, stderr, exitCode } = error
+        console.log('error', error)
+        throw new ExecaError({ stdout, stderr, exitCode })
+      }
+    })
+}
+
+/**
+ * @param {string} cwd
+ * @param {Record<string, string>=} env
+ * @returns {ExecaOptions<string>}
+ */
+function getExecaOptions(cwd, env = {}) {
+  return {
+    shell: true,
+    stdio: 'inherit',
+    cleanup: true,
+    cwd,
+    env,
+  }
+}
+
+const testProjectAndFixtureName = 'test-project-rsc-external-packages'
+
+const testProjectPath = path.join(
+  os.tmpdir(),
+  'redwood',
+  testProjectAndFixtureName,
+  // ":" is problematic with paths
+  new Date().toISOString().split(':').join('-')
+)
+
+// Mock for @actions/core
+const core = {
+  setOutput: () => {},
+}
+
+/**
+ * Exec a command.
+ * Output will be streamed to the live console.
+ * Returns promise with return code
+ *
+ * @param {string} commandLine command to execute (can include additional args). Must be correctly escaped.
+ * @param {ExecOptions=} options exec options.  See ExecOptions
+ * @returns {Promise<unknown>} exit code
+ */
+function execInProject(commandLine, options) {
+  return exec(
+    commandLine,
+    undefined,
+    getExecaOptions(testProjectPath, options?.env)
+  )
+}
+
+setUpRscTestProject(
+  testProjectPath,
+  testProjectAndFixtureName,
+  core,
+  execInProject
+)