test: use GH workflow for e2e test of create amplify #636

0618 · 2023-11-13T16:25:28Z

Issue #, if available:

Description of changes:

This is a followup PR of #533

Use GH Workflow Matrix to run test-e2e/create_amplify.test.ts with different Package Managers
Temporarily use Env Var as an indicator of Package Managers

Note:

Modern Yarn x Node 18/20 fails for [Bug?]: chain loader yarnpkg/berry#4694 and [Bug?]: Yarns patching of the fs module subtly breaks in node >20.5.1 yarnpkg/berry#5951 , so we use Node 19 in this PR. However, Node 19 is already deprecated. I wonder if we should test Node 20 (exclude Modern Yarn) and Node 19 only for Modern Yarn?

Test: https://github.com/aws-amplify/amplify-backend/actions/runs/6856166344

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

changeset-bot · 2023-11-13T16:25:32Z

🦋 Changeset detected

Latest commit: 065f589

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@aws-amplify/integration-tests	Patch
create-amplify	Patch

Not sure what this means? Click here to learn what changesets are.

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

0618 · 2023-11-13T16:27:35Z

.github/workflows/poc-e2e-flow-test.yml

-
-      - name: yarn-stable-create-amplify-project
-        if: matrix.pkg-manager == 'yarn-stable'
+          node-version: 19


Not using ./.github/actions/setup_node because we want to use nodejs 19.

Question:

Modern Yarn x Node 18/20 fails for yarnpkg/berry#4694 and yarnpkg/berry#5951 , so we use Node 19 in this PR.

However, Node 19 is already deprecated. I wonder if we should test Node 20 (exclude Modern Yarn) and Node 19 only for Modern Yarn? (We don't want to test all of them because that'd be too many combinations. e.g. 3 os x 3 package managers x 2 node version = 18)

We shouldn't test against deprecated versions of node at all

Modern Yarn only works with Node 19 for us 🙁 Do we want to say that we don't support Modern Yarn?

that means node version should become part of test matrix.
Can yarn run on 20 ?

That's fine but it means we need to be able [packagemanager, version] declararatively at some point to be flexible here.

Yea, GH workflow matrix can do that. Let me update the PR

We probably need some guidance from the product team about which versions of yarn we support. 4 versions seems like 2 too many :). Also, our unofficial policy is to target support for LTS node versions and not other versions.

Yarn 2-4 are all modern yarn, which are similar and so different from yarn 2 that we need to treat yarn 1 and yarn 2+ as 2 different versions.

For now we just test modern yarn + Node 19. We'll move to Node 20 once yarnpkg/berry#5961 is released.

0618 · 2023-11-13T16:37:38Z

packages/integration-tests/src/test-e2e/create_amplify.test.ts

    const { stdout } = await execa('npm', ['config', 'get', 'cache']);
    const npxCacheLocation = path.join(stdout.toString().trim(), '_npx');

    if (existsSync(npxCacheLocation)) {
      await fs.rm(npxCacheLocation, { recursive: true });
    }
+  } else if (packageManagerExecutable.startsWith('yarn')) {
+    if (packageManagerExecutable === 'yarn-stable') {
+      await execa('yarn', ['set', 'version', 'stable'], execaOptions);


Have to set up yarn to the modern version because it's in a newly created tempDir, in which yarn default to be v1.x

sobolk · 2023-11-13T20:24:40Z

packages/integration-tests/src/test-e2e/create_amplify.test.ts


-    // nuke the npx cache to ensure we are installing packages from the npm proxy
+const packageManagerSetup = async (


at some point this will need to be shared between test files, so worth extracting class PackageManagerConfigurator or something like this in separate file.

In general I'd suggest to start packing all these package manager customization behind some abstractions. They don't have to be perfect at this stage but should drive component breakdown, so later changes to get this to main will be easier.

Good idea. Added to the todo list #533

sobolk · 2023-11-13T20:26:49Z

packages/create-amplify/src/tsconfig_initializer.ts

+  private readonly executableName = !process.env.PACKAGE_MANAGER_EXECUTABLE
+    ? 'npx'
+    : process.env.PACKAGE_MANAGER_EXECUTABLE === 'yarn-stable'
+    ? 'yarn'
+    : process.env.PACKAGE_MANAGER_EXECUTABLE; // TODO: replace `process.env.PACKAGE_MANAGER_EXECUTABLE` with `getPackageManagerName()` once the test infra is ready.


similar comment, here, it might be worth starting to package these things behind some abstraction. Keep env var as a mechanism, but figure out how rest of create-amplify is gonna interact with this.

Since my next step is to get rid of env var and use a getPackageManager function, it's not necessary to refactor the env var here. Right?

Yes. On the branch, you decide when and how to take this suggestion (as well as the other one).

…amplify-backend#636

* feat: create amplify skip prompts for `--yes` option (#507) * feat: add env ci support * test: update unit tests * feat: create amplify --yes option * chore: remove un-used code * feat: support Panage Manager env var * chore: add comments * chore: remove env.CI * chore: update changeset * chore: rename PACKAGE_MANAGER_EXECUTABLE * fix: tests * fix npm -> npx * feat: init e2e test workflow for Package Manager Support (#533) * test: init e2e flow test * fix GH hash * use dynamic pkg manager * setup nodejs with npm * setup more pkg managers * install pkg managers * fix yarn1 and change step name * fix yarn1 * fix yarn1 * split yarn1 into 2 steps * fix yarn1 * fix yarn1 win * exclude bun on windows * yarn1 windows * setup yarn3 * yarn3 * yarn3 yarnPath * yarn use 3rd party action * try yarn3 * set yarn 3.6.x * set yarn berry * set yarn stable and pass --yes * feat: add env ci support * test: update unit tests * feat: create amplify --yes option * chore: remove un-used code * feat: support Panage Manager env var * chore: add comments * chore: remove env.CI * chore: update changeset * chore: rename PACKAGE_MANAGER_EXECUTABLE * fix: tests * use Env Var PACKAGE_MANAGER_EXECUTABLE * fix npm -> npx, remove bun * fix npm -> npx * change -- --yes * chore: update package.lock * chore: remove @Alpha * fix: clean up yarn * fix: change yarn1 to yarn * chore: rename yarn step * chore: use env * fix: yarn-stable env var * add comments * chore: update sample app with new imports (#541) * feat: use "use client"; directive in generated react components (#540) * fix: flatten prop types auth (#534) * fix: flatten auth login with types * chore: update snapshots * chore: update api * chore: add changeset * chore: add TODO --------- Co-authored-by: Amplifiyer <[email protected]> Co-authored-by: Spencer Stolworthy <[email protected]> Co-authored-by: awsluja <[email protected]> * fix: pnpm init and env var (#563) * fix: npm_project_initializer to use env var * fix: pnpm init * chore: update package.lock * chore: update package.lock * test: use GH workflow for e2e test of create amplify (#636) * feat: setup GH workflow for create amplify * chore: changeset * fix: add pkg type for modern yarn * fix npm install * feat: test Node v20 and Node v19 * feat: test Node v20 and yarn-stable with Node 19 * feat: exclude yarn-stable * feat: include node 20 and exclude node 19 * feat: use node 20 for others, use node 19 for yarn-stable * chore: add TODO to use Node 20 * fix: e2e tests (#771) * chore: change branch to poc/pms-create-amplify * fix: gitIgnore test * fix: refactor e2e for pms * chore: update package.lock * chore: update package.lock * temp: refactor * temp: run 1 test * temp: fix npx * temp: install packages for yarn * temp: update initial_project_file_generator * temp: install ts for yarn * temp: ignore node_modules and yarn.lock * temp: create yarn.lock for yarn stable * temp: fix yarn-stable init * temp: fix --help * fix: assert for gitignore * chore: change yarn stable install * fix: not install yarn stable globally * add @yarnpkg/sdks base * yarn stable use node-modules * remove emoji * remove @yarnpkg/sdks * yarn stable use node 18.18 * yarn stable use node 20 * chore: re-enable all tests * Revert "chore: re-enable all tests" This reverts commit f7a167b. * chore: uncomment test * chore: enable all initialStatues * test: change concurrencyLevel for yarn and yarn stable * add yarn-stable to test fails fast * chore: update changeset * chore: change workflow trigger * chore: yarn not install typescript in root folder * chore: update package.lock * Revert "chore: yarn not install typescript in root folder" This reverts commit 0d83dd0. * chore: remove comment * chore: fix typo * chore: rename yarn-classic and yarn modern * fix(create_amplify.test): after merge main * fix the concurrency for yarn classic and modern, and fix expect * feat: package manager support create amplify (#793) * chore: update package.lock * init * feat: dynamically get package manager * chore: change workflow trigger * chore: change workflow trigger * chore: rename npm functions * chore: update output log * fix: pnpm cache clear command * chore: refactor packageManager * fix: remove pnpm store * chore: create package_manager file * chore: change workflow trigger * chore: refactor PackageManager Controller and Initializer * fix: update types * chore: refactor to use factory * chore: remove try catch from the controllers * chore: change type * chore: use abstract class * fix tests * fix: PackageManagerBase * chore: refactor PackageManagerControllerFactory * chore: refactor packageJsonExists * chore: cleanup code * fix: projectJsonExists * remove package_manager file * chore: refactor package_manager props into package manager controllers * chore: rename packageManagerControllerFactory * chore: make projectRoot, userAgent, getPackageManagerName private * chore: refactor ensureInitialized * chore: refactor PackageManagerController to extend PackageManagerControllerFactory * Revert "chore: refactor PackageManagerController to extend PackageManagerControllerFactory" This reverts commit 7ddc64f. * chore: refactor to inject PackageManagerControllerFactory to xPackageManagerController * chore: move initialProjectFileGenerator to packageManagerController * fix: initializeAMplifyFolder * fix: generateInitialProjectFiles * fix: template path * chore: refactor getPackageManagerController yarn-modern * chore: create getWelcomeMessage * Revert "chore: refactor getPackageManagerController yarn-modern" This reverts commit 28da8a9. * chore: refactor generateInitialProjectFiles for yarn-modern * chore: cleanup code * chore: remove PackageManagerControllerFactory index * chore: remove ensureInitialized * Revert "chore: remove ensureInitialized" This reverts commit 96483ce. * Revert "Revert "chore: remove ensureInitialized"" This reverts commit 7c59c80. * temp: add initializeProject to PackageManagerController * temp: revert InitialProjectFileGenerator * fix: InitialProjectFileGenerator * test: restore initial_project_file_generator * move installDependencies and getWelcomeMessage to PackageManagerController * add addLockFile * add JSDocs and resolve some review comments * fix: create_amplify.test * chore: add addTypescript * chore: refactor generateInitialProjectFiles * Update packages/create-amplify/src/package-manager-controller/package_manager_controller_factory.ts Co-authored-by: Edward Foyle <[email protected]> * chore: refactor generateInitialProjectFiles again * chore: refactor welcomeMessage * test: add package_manager_controller_factory * test: fix test types * chore: comments update * chore: handle process.env.npm_config_user_agent undefined * chore: move addLockFile and addTypescript into initializeTsConfig * test: refactor packageManagerControllerFactory * fix: yarn initializeTsConfig * fix: yarn modern initializeTsConfig * fix: amplify_project_creator test * chore: refactor contructor * chore: update package.lock * fix: pnpm init, remove --debug, etc * test: add test for NpmPackageManagerController * fix build error * chore: refactor NpmPackageManagerController * test: add test for xPackageManagerController * chore: convert fs to fsp * fix yarn modern --------- Co-authored-by: Edward Foyle <[email protected]> * chore: update package-lock * test: add deploy test (#901) * chore: add e2e_flow.test * add deploy test but don't work * comment out deploy test * fix: e2e test assert * chore: update package.lock * add deploy test * use before and after * change amplifyCli to execa * change test trigger * Revert "change amplifyCli to execa" This reverts commit 9f85439. * setupProfile * Revert "Revert "change amplifyCli to execa"" This reverts commit 4950b7d. * remove fail test and initialStates * install @aws-amplify/backend-deployer * chore: update changeset * chore: set nodeLinker in test project * fix execaOptions syntax error * fix: npx in cdk deployer * chore: update changeset * fix: yarn modern build * chore: update package-lock * chore: remove some asserts * chore: remove synth * install packages to fix yarn * remove create-amplify help * simplify before and after * remove one packageManagerSetup * refactor packageManagerSetup * fix yarn- * move yarn add to setupPackageManager * fix type error * Revert "fix type error" and "move yarn add to setupPackageManager" This reverts commit d88ef61. * try fix pnpm for windows by adding @AWS-SDK+credential-providers * remove the pnpm patch * add nodir to dictionary * move setupPackageManager to a new file * rename PACKAGE_MANAGER_EXECUTABLE to PACKAGE_MANAGER * refactor packageManagerSetup to use switch * refactor packageManagerSetup to initializeX * use beforeEach and afterEach * add TODO comment * temp * simplify yarn-modern treatments * misc changes * add TODO comments * exclude pnpm on windows * Revert "exclude pnpm on windows" This reverts commit dd7b423. * exclude pnpm on windows * resolve review comments * fix syntax error * address review comments * move this.packageManager logic to ctor * fix yarn-modern * add packageManagerCli and packageManagerExecutable * fix yarn * address review comments * rename package_manager_sanity_check * update workflow yml * chore: update package-lock * move npm proxy to before and after * change comments * feat(backend-deploy): use packageManagerController (#947) * fix logger * fix logLevel * change workflow trigger to include poc/pms-cli-core * move package_manager_controller to cli-core * chore: update changeset * move npm_config_user_agent to getPackageManagerName and add runWithPackageManager * fix build error * modify executeWithDebugLogger * add getPackageManagerCommandArgs * refactor cdk_deployer to use package manager * install cli-core * fix execaChildProcess type * use PackageManagerControllerFactory in cdkDeployer * fix amplify/amplify path * chore: update API.md * clean up package-manager-controller export * update API.md * add type PackageManagerController * use PackageManagerController type from plugin-types * rename PackageManagerControllerBase and use plugin-types * change workflow trigger to exclude poc/pms-cli-core * refactor BackendDeployerFactory to take PackageManagerController * clean up getPackageManagerCommandArgs * add projectRoot and rename packageManagerControllerBase file * set projectRoot default value * rename execute_with_debugger_logger * use execa Options * Revert "use execa Options" This reverts commit 30cd61e. * rename executeChildProcessWithPackageManager to executeCommand * make BackendDeployerFactory param mandatory * make BackendDeployerFactory param mandatory * remove DependencyType * remove @aws-amplify/platform-core from cli-core * remove some default projectRoot * remove all default projectRoot * inject printer to factory * update package-lock * fix cli-core version in backend-deployer * move @aws-amplify/cli-core to devDep * add getCommand * change execa option type * change projectRoot to private * rename projectRoot to cwd * change ./ to cwd * remove @aws-amplify/cli-core from backend-deployer * patch dependencies_validator for execa * fix getCommand, cdk_deployer.test, amplify_project_creator.test * fix initial_project_file_generator.test * fix executeWithDebugLogger test * fix YarnModernPackageManagerController test * fix packageManagerControllerFactory test * fix lint error * Update packages/cli-core/src/package-manager-controller/package_manager_controller_factory.ts Co-authored-by: Kamil Sobol <[email protected]> * remove never used packageManagerExecutable * update changeset * feat: add Package Manager test to health_checks (#968) * add package-manager-tests to health-checks * remove poc-e2e-flow-test * add run_package_manager_tests_tests condition * fix run_package_manager_tests_tests condition * remove amplify-backend_windows-latest_8-core * use re-usable action for run-e2e * Revert "remove amplify-backend_windows-latest_8-core" This reverts commit 547834a. * Revert "use re-usable action for run-e2e" This reverts commit 3159e01. * revert re-usable action * Update .changeset/new-timers-warn.md Co-authored-by: Kamil Sobol <[email protected]> * clean up commented code * use amplify-backend_windows-latest_8-core * Update .changeset/new-timers-warn.md Co-authored-by: Edward Foyle <[email protected]> * remove inaccurate JSdoc * remove integration-tests from changeset --------- Co-authored-by: Amplifiyer <[email protected]> Co-authored-by: Spencer Stolworthy <[email protected]> Co-authored-by: awsluja <[email protected]> Co-authored-by: Edward Foyle <[email protected]> Co-authored-by: Kamil Sobol <[email protected]>

0618 added 6 commits November 10, 2023 14:34

feat: setup GH workflow for create amplify

250c753

chore: changeset

23e320a

Merge branch 'update-package-lock' into poc/e2e-create-amplify

910c682

fix: add pkg type for modern yarn

fcc7e54

Merge branch 'poc/package-manager-support' into poc/e2e-create-amplify

a7cb11b

fix npm install

827a51a

0618 requested review from edwardfoyle, sobolk and Amplifiyer as code owners November 13, 2023 16:25

0618 mentioned this pull request Nov 13, 2023

feat: init e2e test workflow for Package Manager Support #533

Merged

7 tasks

0618 commented Nov 13, 2023

View reviewed changes

0618 added 4 commits November 13, 2023 11:32

feat: test Node v20 and Node v19

52ba97a

feat: test Node v20 and yarn-stable with Node 19

6e6fe30

feat: exclude yarn-stable

f82dfe1

feat: include node 20 and exclude node 19

39b5811

sobolk approved these changes Nov 13, 2023

View reviewed changes

0618 added 2 commits November 13, 2023 12:38

feat: use node 20 for others, use node 19 for yarn-stable

c0b304a

chore: add TODO to use Node 20

065f589

edwardfoyle approved these changes Nov 13, 2023

View reviewed changes

0618 merged commit c34a987 into poc/package-manager-support Nov 13, 2023
16 checks passed

0618 deleted the poc/e2e-create-amplify branch November 13, 2023 22:32

MorrisonCole added a commit to MorrisonCole/morrisoncole.co.uk that referenced this pull request Dec 6, 2023

fix: use node 19 for deployment (18 seems to be broken - aws-amplify/…

c3a4a14

…amplify-backend#636

0618 mentioned this pull request Jan 30, 2024

feat: package manager support #960

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: use GH workflow for e2e test of create amplify #636

test: use GH workflow for e2e test of create amplify #636

0618 commented Nov 13, 2023 •

edited

Loading

changeset-bot bot commented Nov 13, 2023 •

edited

Loading

0618 Nov 13, 2023

0618 Nov 13, 2023

edwardfoyle Nov 13, 2023

0618 Nov 13, 2023

sobolk Nov 13, 2023

sobolk Nov 13, 2023

0618 Nov 13, 2023

edwardfoyle Nov 13, 2023

0618 Nov 13, 2023

0618 Nov 13, 2023

0618 Nov 13, 2023

sobolk Nov 13, 2023

0618 Nov 13, 2023

sobolk Nov 13, 2023

0618 Nov 13, 2023

sobolk Nov 13, 2023


		// nuke the npx cache to ensure we are installing packages from the npm proxy
		const packageManagerSetup = async (

test: use GH workflow for e2e test of create amplify #636

test: use GH workflow for e2e test of create amplify #636

Conversation

0618 commented Nov 13, 2023 • edited Loading

changeset-bot bot commented Nov 13, 2023 • edited Loading

🦋 Changeset detected

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

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

0618 commented Nov 13, 2023 •

edited

Loading

changeset-bot bot commented Nov 13, 2023 •

edited

Loading