fix(data-migrate): provide option to use db in dist instead of src

[jtoar]

Note This is not breaking; merely additive.

Fixes #8059. This PR:

1. separates the data migrate commands (up and install) into yargs-metadata and handler files (just a chore step to align with the rest of the CLI commands)
2. makes it so that yarn rw data-migrate up can run using the lib/db in dist instead of src:

yarn rw data-migrate up --import-strategy "dist"

Right now, yarn rw data-migrate up imports db from api/src/lib. I think the logic is, we use the require hook anyway to run the migration scripts, so we may as well use it to import the db from api/src/lib too. But we now realize that api/src may not always be available.

@razzeee I want to confirm this solves your use case in case you're set up is different than I thought. Now api/src/lib/db no longer needs to be available, but api/dist/lib/db does.

[replay-io]

18 replays were recorded for 02659dc.

0 Failed

18 Passed

• useAuth hook, auth redirects checks

  locator.waitFor: Target closed
  =========================== logs ===========================
  waiting for locator('text=Username `testuser@bazinga.com` already in use') to be visible
  ============================================================

• Check that a specific blog post is prerendered
• Check that about is prerendered
• Check that homepage is prerendered
• Check that meta-tags are rendering the correct dynamic data
• Check that rehydration works for page not wrapped in Set
• Check that rehydration works for page with Cell in Set
• Check that rehydration works for page with code split chunks
• Check that you can navigate from home page to specific blog post
• Waterfall prerendering (nested cells)
• RBAC: Admin user should be able to delete contacts
• RBAC: Should not be able to delete contact as non-admin user

  locator.waitFor: Target closed
  =========================== logs ===========================
  waiting for locator('text=Username `admin@bazinga.com` already in use') to be visible
  ============================================================

• Smoke test with dev server
• Smoke test with rw serve
• Loads Cell mocks when Cell is nested in another story
• Loads Cell Stories
• Loads MDX Stories
• Mocks current user, and updates UI while dev server is running

View test run on Replay ↗︎

[razzeee]

This sounds like a step forward, I think.

I'm wondering, if it would improve things, if we would be able to pass a path, like prisma does to the schema. But I'm unsure. (It probably only saves you from changing folders when using a global install of rw)

[jtoar]

@razzeee would the path be to the dataMigrations directory?

[razzeee]

I think it should be the path to the dist? unless it would work with the dataMigration folder only. if I could pass that path, I would assume, I would be able to only copy that folder to a machine and be able to run stuff, which probably won't work?

[jtoar]

@razzeee the rw CLI already supports the --cwd flag and RWJS_CWD env var; maybe what you want to do already works via one of them?

rw --cwd path/to/project data-migrate up
# or
RWJS_CWD=path/to/project rw data-migrate up

Just in case I still don't understand, here's what data-migrate up expects:

• api/dist (which is just used as a check to make sure api is built)
• api/dist/lib/db.js (to get the Prisma client)
• api/dataMigrations (has the data migrations to run)

I could still think about a --dist-path flag though if that's better, which would be the path to api/dist.

[razzeee]

Yeah, I think --dist-path is what I would be looking for in that situation. For e.g. if I decided to name that folder something that is not dist or want to call it from a different path than I'm on right now.

[jtoar]

Ok @razzeee I think this is gtg but let me run it by a few others first

[jtoar]

@razzeee I just released this PR in an RC: 5.2.3-rc.3+ddbd1f431. You can upgrade to it via yarn rw upgrade -t rc. The hash after the + may not be there, but it shouldn't matter. Would love to know if this fixes it for you

[razzeee]

@jtoar I tried to validate this, but I seem to run into something unrelated. I can't access the deployed frontend anymore, after deploying with my (partly) reverted changes. Haven't really looked at db migrations due to that.

Anyway, spend enough time on this for this week, I can probably have another go next week.

[jtoar]

No worries I appreciate you trying!

[jtoar]

@razzeee this just landed in v5.2.4, so no need to upgrade to an RC to try it out