reactioncommerce / api-migrations

This project tracks current desired versions for all tracks used by the default Reaction Platform.

API Migrations

This project tracks current desired versions for all tracks used by the default Reaction Platform. You can fork it to get started but you will likely diverge as you add, remove, and change the Reaction API plugins you use.

This repo was created by following these instructions. If you don't want to fork this, you can build your own data version tracking project using those steps.

Prerequisites

You must have NodeJS 14.17.4 installed globally.

Local Development Usage

1. Fork/clone this repo.

2. Check out the tag that corresponds to your version of Reaction Platform. (Only 3.0.0 and higher are supported.)

3. npm install

4. Then to see a report of necessary migrations for your local MongoDB database and optionally run them:

   MONGO_URL=mongodb://localhost:27017/reaction npx migrator migrate

   Use a different MONGO_URL to run them on a different database.

   Refer to https://github.com/reactioncommerce/migrator docs for other commands. Prefix them with npx.

5. Try to start your API service. If there are database version errors thrown on startup, then change the versions or add/remove tracks in migrator.config.js as necessary based on whatever those errors are asking for. Then repeat the previous step. (If you've added new tracks, you'll need to npm install the latest version of those packages first.) Keep doing this until the API service starts.

Migrating Deployment Databases

Option 1: You can follow the above "Local Development Usage" instructions but specify a remote database if you want. Migrations will run on your computer, which may not be very fast or reliable.

Option 2: You can set up a CI task for this repo:

1. Create different configuration files for each deployed environment. For example, migrator.config-staging.js for the "staging" environment.
2. Add the necessary MONGO_URLs to your CI environment/secrets.
3. When config file changes are merged to the main branch, run npx migrator migrate <env> -y as a CI task with MONGO_URL set to the correct database for that environment. Do this for each Reaction environment (database) you have.
   • Ensure that your CI Docker image uses at least the version of Node that's in the .nvmrc file.

Why does this repo exist?

This repo serves a few purposes:

• A place to npm install the @reactioncommerce/migrator package and all packages that contain migrations
• A central place to capture the desired/required data version for each release of the Reaction system, and for each individual Reaction component

In some monolith apps that you may be familiar with, the app's codebase repo serves as the place for migrations, too. But there are at least two reasons why we can't do that with Reaction:

• Reaction consists of many plugins and microservices, each of which owns their own data versioning. Running migrations in 10 different places would not be a good user experience.
• When you check out a particular release of a Reaction API component, you don't have any of the down migrations from future releases available. To run down migrations, you always need the latest migration code.

Adding a migration to an API plugin package

To add a migration to an API plugin package, there are four main steps:

1. Add the migration code in the plugin package, in a migrations folder alongside the src folder.
2. Add export { default as migrations } from "./migrations/index.js"; in your plugin entry point file.
3. Add the latest version of the @reactioncommerce/db-version-check NPM package as a dependency.
4. Add and register a preStartup function in the plugin source. In it, call doesDatabaseVersionMatch to prevent API startup if the data isn't compatible with the code.

These steps are explained in more detail here, and you can look at the simple-authorization plugin code for an example to follow.

IMPORTANT: If the plugin you added a migration to is one that is built in to the stock Reaction API releases, then at the same time you bump the plugin package version in https://github.com/reactioncommerce/reaction trunk branch, you must also update the data version in the trunk branch of migrator.config.js in this repo.

Developer Certificate of Origin

We use the Developer Certificate of Origin (DCO) in lieu of a Contributor License Agreement for all contributions to Reaction Commerce open source projects. We request that contributors agree to the terms of the DCO and indicate that agreement by signing-off all commits made to Reaction Commerce projects by adding a line with your name and email address to every Git commit message contributed:

Signed-off-by: Jane Doe <[email protected]>

You can sign-off your commit automatically with Git by using git commit -s if you have your user.name and user.email set as part of your Git configuration.

We ask that you use your real full name (please no anonymous contributions or pseudonyms) and a real email address. By signing-off your commit you are certifying that you have the right to submit it under the Apache 2.0 License.

We use the Probot DCO GitHub app to check for DCO sign-offs of every commit.

If you forget to sign-off your commits, the DCO bot will remind you and give you detailed instructions for how to amend your commits to add a signature.

License

Copyright 2020 Reaction Commerce

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and limitations under the License.

api-migrations's Issues

Missing dependencies

The following dependencies are missing when I run migrate:

• path-parser
• lodash._baseiteratee
• lodash._baseuniq

NPM errors attempting to install [email protected]

Current setup instructions call for use of NPM to install dependencies. However, when this package is pulled today it errors during installation on macOS it errors attempting to install [email protected]. This issue occurs even with the current Node version specified by the repo's NVM config file (12.14.1). I was able to work around the issue using yarn instead of NPM to install dependencies and run migrations successfully.

I'm opening this issue in the off-chance anyone else is having this issue. But I don't think there's anything actionable here other than document the workaround used (which was Yarn for Node dependency installation). Please feel free to re-open if this issue seems more systemic.

Remove NVM dependency

README states NVM is required if node version 12.x isn't installed.

Please update manifest to use engines instead and remove the .nvmrc file as it's not necessary. If desired, retain instructions for old NVM-based installation methods.

https://docs.npmjs.com/cli/v6/configuring-npm/package-json#engines