Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update dependency umzug to v3 #4610

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update dependency umzug to v3 #4610

wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Aug 21, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
umzug ^2.3.0 -> ^3.0.0 age adoption passing confidence

Release Notes

sequelize/umzug (umzug)

v3.8.1

Compare Source

What's Changed

New Contributors

Full Changelog: sequelize/umzug@v3.8.0...v3.8.1

v3.8.0

Compare Source

What's Changed

Full Changelog: sequelize/umzug@v3.7.0...v3.8.0

v3.7.0

Compare Source

  • create: allow specifying content directly 543a45d

v3.6.1

Compare Source

v3.6.0

Compare Source

What's Changed

New Contributors

Full Changelog: sequelize/umzug@v3.5.1...v3.6.0

v3.5.1

Compare Source

v3.5.0

Compare Source

What's Changed

Full Changelog: sequelize/umzug@v3.4.0...v3.5.0

v3.4.0

Compare Source

What's Changed

New Contributors

Full Changelog: sequelize/umzug@v3.3.1...v3.4.0

v3.3.1

Compare Source

Amended release notes from 3.3.0 (and comparison with v3.2.1):

What's Changed

v3.3.0

Compare Source

⚠️ ⚠️ ⚠️ This version is deprecated, please use 3.3.1 - but note that #​602 was reverted and is not included in 3.3.1 ⚠️ ⚠️ ⚠️

Original release notes

What's Changed

New Contributors

Full Changelog: sequelize/umzug@v3.2.1...v3.3.0

v3.2.1

Compare Source

What's Changed

Full Changelog: sequelize/umzug@v3.2.0...v3.2.1

v3.2.0

Compare Source

What's Changed

Full Changelog: sequelize/umzug@v3.1.2...v3.2.0

v3.1.2

Compare Source

What's Changed

Full Changelog: sequelize/umzug@v3.1.1...v3.1.2

v3.1.1

Compare Source

v3.1.0

Compare Source

What's Changed

See https://github.com/sequelize/umzug/discussions/545

Full Changelog: sequelize/umzug@v3.0.0...v3.1.0

v3.0.0

Compare Source

Major release with some breaking changes since v2.x, see migration guide here: https://github.com/sequelize/umzug#upgrading-from-v2x

Several new features, including a new built-in CLI, typescript support, templating, improved events, logging and error messages, and more.

Find usage examples under https://github.com/sequelize/umzug/tree/master/examples

Migration guide at time of writing copied here for covenience:

Upgrading from v2.x

The Umzug class should be imported as a named import, i.e. import { Umzug } from 'umzug'.

The MigrationMeta type, which is returned by umzug.executed() and umzug.pending(), no longer has a file property - it has a name and optional path - since migrations are not necessarily bound to files on the file system.

The migrations.glob parameter replaces path, pattern and traverseDirectories. It can be used, in combination with cwd and ignore to do much more flexible file lookups. See https://npmjs.com/package/glob for more information on the syntax.

The migrations.resolve parameter replaces customResolver. Explicit support for wrap and nameFormatter has been removed - these can be easily implemented in a resolve function.

The constructor option logging is replaced by logger to allow for warn and error messages in future. NodeJS's global console object can be passed to this. To disable logging, replace logging: false with logger: undefined.

Breaking change to storages: remove string parameter (#​429) b6414ba

  • Custom storage implementations must update logMigration(name) { ... } to logMigration({ name }) { ...}. Likewise with unlogMigration. This is to allow receiving context and path properties in the same arg object.
    Note that this may break external storage implementations too. To adapt, you can just modify or extend the logMigration and unlogMigration implementations (something like logMigration: ({ name }) => oldStorage.logMigration(name)).

Events have moved from the default nodejs EventEmitter to emittery. It has better design for async code, a less bloated API surface and strong types. But, it doesn't allow passing multiple arguments to callbacks, so listeners have to change slightly, as well as .addListener(...) and .removeListener(...) no longer being supported (.on(...) and .off(...) should now be used):

Before:

umzug.on('migrating', (name, m) => console.log({ name, path: m.path }))

After:

umzug.on('migrating', ev => console.log({ name: ev.name, path: ev.path }))

The Umzug#execute method is removed. Use Umzug#up or Umzug#down.

The options for Umguz#up and Umzug#down have changed:

  • umzug.up({ to: 'some-name' }) and umzug.down({ to: 'some-name' }) are still valid.
  • umzug.up({ from: '...' }) and umzug.down({ from: '...' }) are no longer supported. To run migrations out-of-order (which is not generally recommended), you can explicitly use umzug.up({ migrations: ['...'] }) and umzug.down({ migrations: ['...'] }).
  • name matches must be exact. umzug.up({ to: 'some-n' }) will no longer match a migration called some-name.
  • umzug.down({ to: 0 }) is still valid but umzug.up({ to: 0 }) is not.
  • umzug.up({ migrations: ['m1', 'm2'] }) is still valid but the shorthand umzug.up(['m1', 'm2']) has been removed.
  • umzug.down({ migrations: ['m1', 'm2'] }) is still valid but the shorthand umzug.down(['m1', 'm2']) has been removed.
  • umzug.up({ migrations: ['m1', 'already-run'] }) will throw an error, if already-run is not found in the list of pending migrations.
  • umzug.down({ migrations: ['m1', 'has-not-been-run'] }) will throw an error, if has-not-been-run is not found in the list of executed migrations.
  • umzug.up({ migrations: ['m1', 'm2'], rerun: 'ALLOW' }) will re-apply migrations m1 and m2 even if they've already been run.
  • umzug.up({ migrations: ['m1', 'm2'], rerun: 'SKIP' }) will skip migrations m1 and m2 if they've already been run.
  • umzug.down({ migrations: ['m1', 'm2'], rerun: 'ALLOW' }) will "revert" migrations m1 and m2 even if they've never been run.
  • umzug.down({ migrations: ['m1', 'm2'], rerun: 'SKIP' }) will skip reverting migrations m1 and m2 if they haven't been run or are already reverted.
  • umzug.up({ migrations: ['m1', 'does-not-exist', 'm2'] }) will throw an error if the migration name is not found. Note that the error will be thrown and no migrations run unless all migration names are found - whether or not rerun: 'ALLOW' is added.

The context parameter replaces params, and is passed in as a property to migration functions as an options object, alongs side name and path. This means the signature for migrations, which in v2 was (context) => Promise<void>, has changed slightly in v3, to ({ name, path, context }) => Promise<void>.

Handling existing v2-format migrations

The resolve function can also be used to upgrade your umzug version to v3 when you have existing v2-compatible migrations:

const { Umzug } = require('umzug');

const umzug = new Umzug({
  migrations: {
    glob: 'migrations/umzug-v2-format/*.js',
    resolve: ({name, path, context}) => {
      // Adjust the migration from the new signature to the v2 signature, making easier to upgrade to v3
      const migration = require(path)
      return { name, up: async () => migration.up(context), down: async () => migration.down(context) }
    }
  },
  context: sequelize.getQueryInterface(),
  logger: console,
});

Similarly, you no longer need migrationSorting, you can instantiate a new Umzug instance to manipulate migration lists directly:

const { Umzug } = require('umzug');

const parent = new Umzug({
  migrations: { glob: 'migrations/**/*.js' },
  context: sequelize.getQueryInterface(),
})

const umzug = new Umzug({
  ...parent.options,
  migrations: ctx => (await parent.migrations()).sort((a, b) => b.path.localeCompare(a.path))
})

👇 full, generated changelog

What's Changed

New Contributors

Full Changelog: sequelize/umzug@v2.3.0...v3.0.0

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Never, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@rikurauhala rikurauhala added the do not merge Don't merge until issues have been resolved label Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
do not merge Don't merge until issues have been resolved
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@rikurauhala