Feat: Improvements to the migrations CLI and workflow #8060

thetutlage · 2024-07-10T10:47:16Z

FIXES: CORE-2495
FIXES: CORE-2482

Breaking change

This PR revamps the migration commands to work as per the new setup. Here's how the migrations will run and revert moving forward.

The run command will continue to work as it is. I have to redo the CLI UI for it, but the behavior will remain the same.
The revert command can only be used for specific modules. You can no longer revert migrations without specifying the module name. Here's the reasoning for that.

The goal of the revert command is to undo mistakes during development. We should not confuse revert with rollback, where the later one is used to rollback the database state to a previous version.

Since, the revert command intent is highly tied to development and that too within a specific module, you will have to run it against a module as well. There is no global revert anymore.

Changelog

This PR revamps the migrations workflow and the CLI output entirely. Here's a summary of the changes.

The commands remains the same as npx medusa migrations run and npx medusa migrations revert
The CLI output has been changed to be more visually appealing and add separate migrations logs for each module with a line break.

Breaking changes

The revert command has a breaking change that it requires one or more module names to perform the revert. It means, the action revert is not valid at the global/app level. It must be executed on a specific module.

If you are developing a custom module, you can run the revert command for it as follows.

# helloWorld is the moduleName
npx medusa migrations revert helloWorld

vercel · 2024-07-10T10:47:20Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
medusa-dashboard	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 11, 2024 11:04am

6 Skipped Deployments

Name	Status	Preview	Updated (UTC)
api-reference	⬜️ Ignored (Inspect)		Jul 11, 2024 11:04am
api-reference-v2	⬜️ Ignored (Inspect)	Visit Preview	Jul 11, 2024 11:04am
docs-ui	⬜️ Ignored (Inspect)	Visit Preview	Jul 11, 2024 11:04am
docs-v2	⬜️ Ignored (Inspect)	Visit Preview	Jul 11, 2024 11:04am
medusa-docs	⬜️ Ignored (Inspect)	Visit Preview	Jul 11, 2024 11:04am
resources-docs	⬜️ Ignored (Inspect)	Visit Preview	Jul 11, 2024 11:04am

changeset-bot · 2024-07-10T10:47:21Z

⚠️ No Changeset found

Latest commit: 30d4e47

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

…scripts

thetutlage · 2024-07-10T12:04:21Z

Amazed that tests are passing already 🙄

thetutlage · 2024-07-11T05:09:51Z

/snapshot-this

thetutlage · 2024-07-11T05:31:52Z

THE PR IS AVAILABLE FOR REVIEW. BUT, DO NOT MERGE.

thetutlage · 2024-07-11T05:32:57Z

/snapshot-this

thetutlage · 2024-07-11T06:57:05Z

/snapshot-this

github-actions · 2024-07-11T07:08:21Z

🚀 A snapshot release has been made for this PR

Test the snapshots by updating your package.json with the newly published versions:

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add [email protected]

yarn add @medusajs/[email protected]

yarn add [email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add [email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add [email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

yarn add @medusajs/[email protected]

Latest commit: f460348

adrien2p

💪

adrien2p · 2024-07-11T07:22:28Z

packages/core/modules-sdk/src/medusa-app.ts

-  const applyMigration = async (linkModuleOptions, revert = false) => {
-    for (const moduleName of Object.keys(allModules)) {
-      const moduleResolution = MedusaModule.getModuleResolutions(moduleName)
+  const applyMigration = async ({


suggestion: As we discussed, we can probably move this one outside the main function wdyt?

Uses sharedContainer and sharedConfig from the upper scope. Should we pass them down as parameters?

I think so, just to lighten this function a bit to simplify reading and understanding

packages/core/modules-sdk/src/medusa-app.ts

packages/core/modules-sdk/src/medusa-module.ts

packages/medusa/src/commands/migrate.ts

thetutlage · 2024-07-11T07:33:11Z

This is how the output looks like. I wish we could use a better logger for the CLI commands. Winston feels more like an app logger than a visually appealing logger

adrien2p · 2024-07-11T07:33:48Z

This is how the output looks like. I wish we could use a better logger for the CLI commands. Winston feels more like an app logger than a visually appealing logger

Lovely :)

we might need to remove service from all the modules key cc @olivermrbl :)

thetutlage · 2024-07-11T08:00:52Z

@olivermrbl Can be improved a lot, we need a visual logger for CLI commands and ditch Winston. Will get onto refactoring CLI output someday 💪

srindom · 2024-07-11T08:13:24Z

@thetutlage - in production envs the logger uses a json format. Maybe we want to test that the output isn't filled with these types of outputs:

{ "level": "info", "message": "-------------------...." }

adrien2p · 2024-07-11T08:24:29Z

@thetutlage - in production envs the logger uses a json format. Maybe we want to test that the output isn't filled with these types of outputs:
{ "level": "info", "message": "-------------------...." }

Do you think it would be problematic to have few spaces at the beginning of the message?

thetutlage · 2024-07-11T09:05:58Z

@srindom Yes, it will be filled with that.

The ideal solution is to have helpers for these sort of outputs that has different behavior when the output is JSON.

But for now, either we have to remove these lines or apply a filter when these logs are consumed by a logging service.

adrien2p · 2024-07-11T09:08:01Z

Yes and I believe our logger can have a custom handler for message and strip the space on front of it

thetutlage · 2024-07-11T09:20:09Z

srindom · 2024-07-11T09:24:10Z

It shouldn't block this PR, but think it would be good for us to look into a way to specify that a log message is just for aesthetic purposes - we could maybe just use the silly log level for it, but let's leave that for another time :)

thetutlage · 2024-07-11T10:19:40Z

Alright. We are ready to merge this PR. I have updated the description explaining the breaking change.

thetutlage · 2024-07-11T10:19:56Z

CC @olivermrbl @adrien2p Ready to be re-reviewed and merged

packages/cli/medusa-cli/src/create-cli.ts

packages/core/utils/src/modules-sdk/migration-scripts/migration-down.ts

olivermrbl · 2024-07-11T11:16:22Z

@thetutlage, upon merging a PR, can I get you to prefix the commit message (and ideally the PR title) with a tag indicating the PR type feat, fix, chore, or docs? 💪

thetutlage · 2024-07-11T11:19:47Z

@olivermrbl Sure. Should this one be refactor?

olivermrbl · 2024-07-11T11:21:10Z

@thetutlage, we don't have refactor, so I think we should go with feat for now. It is used to group the changes in the release notes and right now we have the following sections:

Features
Bugs
Chores
Documentation

thetutlage · 2024-07-11T11:21:51Z

Cool!

olivermrbl · 2024-07-11T11:37:40Z

Very nit, but can you use the lowercased version hehe. Just for consistency 😅

feat: first iteration of commands implementation

96409dd

github-actions bot added the team: medusa label Jul 10, 2024

fix: missing modules check logic

837e9cd

vercel bot deployed to Preview – medusa-dashboard July 10, 2024 11:05 View deployment

refactor: use mikroOrmCreateConnection helper when running migration …

becd20c

…scripts

vercel bot deployed to Preview – medusa-dashboard July 10, 2024 11:53 View deployment

Merge branch 'develop' into feat/implement-migration-commands

e0ef8f7

vercel bot deployed to Preview – medusa-dashboard July 11, 2024 04:31 View deployment

refactor: remove unused imports

30625a2

vercel bot deployed to Preview – medusa-dashboard July 11, 2024 04:40 View deployment

thetutlage marked this pull request as ready for review July 11, 2024 05:26

thetutlage requested a review from a team as a code owner July 11, 2024 05:26

thetutlage requested review from sradevski, riqwan and olivermrbl July 11, 2024 05:26

feat: improve CLI logs when executing migrations

7d13c12

vercel bot deployed to Preview – medusa-dashboard July 11, 2024 06:57 View deployment

thetutlage added the has: breaking changes label Jul 11, 2024

adrien2p approved these changes Jul 11, 2024

View reviewed changes

refactor: visually improve migrations logs

8acf3c5

thetutlage added 2 commits July 11, 2024 13:37

refactor: improvements to cli args parsing

078a9d8

Merge branch 'develop' into feat/implement-migration-commands

92e3f9a

vercel bot deployed to Preview – medusa-dashboard July 11, 2024 08:09 View deployment

feat: properly handle unknown modules error and display suggestions

4cc0aa6

vercel bot deployed to Preview – medusa-dashboard July 11, 2024 09:03 View deployment

Merge branch 'develop' into feat/implement-migration-commands

e5e37d8

vercel bot deployed to Preview – medusa-dashboard July 11, 2024 09:13 View deployment

adrien2p approved these changes Jul 11, 2024

View reviewed changes

packages/cli/medusa-cli/src/create-cli.ts Show resolved Hide resolved

packages/core/utils/src/modules-sdk/migration-scripts/migration-down.ts Outdated Show resolved Hide resolved

refactor: use dash instead of underscore for line breaks

d753e54

vercel bot deployed to Preview – medusa-dashboard July 11, 2024 10:59 View deployment

Merge branch 'develop' into feat/implement-migration-commands

30d4e47

vercel bot deployed to Preview – medusa-dashboard July 11, 2024 11:04 View deployment

thetutlage changed the title ~~First iteration of commands implementation~~ Feat: First iteration of commands implementation Jul 11, 2024

thetutlage merged commit 45c573b into develop Jul 11, 2024
23 checks passed

thetutlage changed the title ~~Feat: First iteration of commands implementation~~ Feat: Improvements to the migrations CLI and workflow Jul 11, 2024

thetutlage deleted the feat/implement-migration-commands branch July 11, 2024 11:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: Improvements to the migrations CLI and workflow #8060

Feat: Improvements to the migrations CLI and workflow #8060

thetutlage commented Jul 10, 2024 •

edited

Loading

vercel bot commented Jul 10, 2024 •

edited

Loading

changeset-bot bot commented Jul 10, 2024 •

edited

Loading

thetutlage commented Jul 10, 2024

thetutlage commented Jul 11, 2024

thetutlage commented Jul 11, 2024

thetutlage commented Jul 11, 2024

thetutlage commented Jul 11, 2024

github-actions bot commented Jul 11, 2024

adrien2p left a comment

adrien2p Jul 11, 2024

thetutlage Jul 11, 2024

adrien2p Jul 11, 2024

thetutlage commented Jul 11, 2024

adrien2p commented Jul 11, 2024 •

edited

Loading

thetutlage commented Jul 11, 2024

srindom commented Jul 11, 2024 •

edited

Loading

adrien2p commented Jul 11, 2024

thetutlage commented Jul 11, 2024

adrien2p commented Jul 11, 2024

thetutlage commented Jul 11, 2024

srindom commented Jul 11, 2024

thetutlage commented Jul 11, 2024

thetutlage commented Jul 11, 2024

olivermrbl commented Jul 11, 2024 •

edited

Loading

thetutlage commented Jul 11, 2024 •

edited

Loading

olivermrbl commented Jul 11, 2024 •

edited

Loading

thetutlage commented Jul 11, 2024

olivermrbl commented Jul 11, 2024

Feat: Improvements to the migrations CLI and workflow #8060

Feat: Improvements to the migrations CLI and workflow #8060

Conversation

thetutlage commented Jul 10, 2024 • edited Loading

Changelog

Breaking changes

vercel bot commented Jul 10, 2024 • edited Loading

changeset-bot bot commented Jul 10, 2024 • edited Loading

⚠️ No Changeset found

thetutlage commented Jul 10, 2024

thetutlage commented Jul 11, 2024

thetutlage commented Jul 11, 2024

thetutlage commented Jul 11, 2024

thetutlage commented Jul 11, 2024

github-actions bot commented Jul 11, 2024

🚀 A snapshot release has been made for this PR

adrien2p left a comment

Choose a reason for hiding this comment

adrien2p Jul 11, 2024

Choose a reason for hiding this comment

thetutlage Jul 11, 2024

Choose a reason for hiding this comment

adrien2p Jul 11, 2024

Choose a reason for hiding this comment

thetutlage commented Jul 11, 2024

adrien2p commented Jul 11, 2024 • edited Loading

thetutlage commented Jul 11, 2024

srindom commented Jul 11, 2024 • edited Loading

adrien2p commented Jul 11, 2024

thetutlage commented Jul 11, 2024

adrien2p commented Jul 11, 2024

thetutlage commented Jul 11, 2024

srindom commented Jul 11, 2024

thetutlage commented Jul 11, 2024

thetutlage commented Jul 11, 2024

olivermrbl commented Jul 11, 2024 • edited Loading

thetutlage commented Jul 11, 2024 • edited Loading

olivermrbl commented Jul 11, 2024 • edited Loading

thetutlage commented Jul 11, 2024

olivermrbl commented Jul 11, 2024

thetutlage commented Jul 10, 2024 •

edited

Loading

vercel bot commented Jul 10, 2024 •

edited

Loading

changeset-bot bot commented Jul 10, 2024 •

edited

Loading

adrien2p commented Jul 11, 2024 •

edited

Loading

srindom commented Jul 11, 2024 •

edited

Loading

olivermrbl commented Jul 11, 2024 •

edited

Loading

thetutlage commented Jul 11, 2024 •

edited

Loading

olivermrbl commented Jul 11, 2024 •

edited

Loading