cli
cli copied to clipboard
sequelize
ESM & sequelize db:migrate
It would be great if sequelize-cli supports migrations in ESM way.
What you are doing?
// db/migrations/20220924162319-create-test.js
export async function up(queryInterface, Sequelize) {
await queryInterface.createTable('test', {
id: {
type: Sequelize.DataTypes.INTEGER,
allowNull: false,
autoIncrement: true,
primaryKey: true,
},
createdAt: {
allowNull: false,
type: Sequelize.DataTypes.DATE,
},
updatedAt: {
allowNull: false,
type: Sequelize.DataTypes.DATE,
}
});
}
export function down(queryInterface, Sequelize) {
return queryInterface.dropTable('test');
}
npx sequelize db:migrate
What do you expect to happen?
Migration works.
What is actually happening?
npx sequelize db:migrate
Sequelize CLI [Node: 16.16.0, CLI: 6.4.1, ORM: 6.23.0]
Loaded configuration file "db/config.js".
== 20220924162319-create-test: migrating =======
ERROR: require() of ES Module /test/db/migrations/20220924162319-create-test.js from /test/node_modules/umzug/lib/migration.js not supported.
Instead change the require of 20220924162319-create-test.js in /test/node_modules/umzug/lib/migration.js to a dynamic import() which is available in all CommonJS modules.
Output, either JSON or SQL
Dialect: postgres Database version: 12 Sequelize CLI version: 6.4.1 Sequelize version: 6.23.0
Replacing: return require(this.path); with return import(this.path); solves it for ES Modules.
Monkey patch from the original issue works...
@bobber205 sequelize-cli uses pretty old 2.3.0 umzug module:
https://github.com/sequelize/umzug/blob/v2.3.0/src/migration.js#L68
sequelize-cli uses pretty old 2.3.0
umzugmodule:https://github.com/sequelize/umzug/blob/v2.3.0/src/migration.js#L68
Indeed. We will update to the latest umzug release in v7 of the CLI.
As a temporary workaround to not have to rename generated migration files to .cjs, in your migrations folder, create a package.json file with contents
{
"type": "commonjs"
}
or, since commonjs is the default, simply
{}
This tricks Node into thinking that your migration folder is a commonjs package, and allows you to use `npx sequelize migration:create` and `npx sequelize db:migrate` the same way as you'd use it in a commonjs project.
sequelize-cli uses pretty old 2.3.0
umzugmodule: https://github.com/sequelize/umzug/blob/v2.3.0/src/migration.js#L68Indeed. We will update to the latest
umzugrelease in v7 of the CLI.
Hey @WikiRik, can you provide an expected timeline for when v7 will be released?
@taslangraham not yet, we'll start work when sequelize v7 is in beta (which we expect in the next month or so)
Does this provide a solution? https://github.com/sequelize/cli/pull/982
If so, how would an ESM .sequelizerc look?
There's also this docs change, but it doesn't mention .sequelizerc https://github.com/sequelize/sequelize/pull/13669/commits/81534441313f83bde446b2be6e88a7fa363e142d
It's been over 9 months that this issue is going on now.
Not supporting ESM is a real deal-breaker for many people as ESM is superior to CJS in many ways that are now common knowledge.
If you need help migrating to a newer version of umzug I would be happy to help by opening a PR.
umzug 2.3.0 is now over 3 years old, it's most likely no longer being maintained. It's becoming critical to update this dependency.
In any case, just let me know if you need a PR to move to ESM-first with a secondary CJS build. I would be happy to help if this can fast-track this problem for everyone.
We're currently planning a full rewrite from scratch of the CLI for v7, but we're happy to review PRs to upgrade umzug and allow ESM builds if it does not have any breaking changes
We're currently planning a full rewrite from scratch of the CLI for v7, but we're happy to review PRs to upgrade umzug and allow ESM builds if it does not have any breaking changes
I understand that, you mentioned it on January 3rd. The thing is, it's not tied to the CLI, so the full rewrite will not solve the issue.
The problem lies within umzug itself. Even in it's current state, it is still written and built using CJS. Since umzug is using a dynamic require, a rewrite of umzug is necessary.
Unfortunately, this issue is affecting more thant Sequelize. Several ORMs are using umzug and reporting the same problem. It's relatively widespread.
Since Sequelize seems to also be maintaining umzug, would you be open to a PR migrating it to ESM-first?
umzug is indeed under our organization, but it is being maintained by @mmkal
Please open an issue there if changes need to be made to umzug first
Umzug still uses require and is commonjs by default, but it supports import(...) via a custom resolver. So if sequelize-cli wants to do things this way it should be possible already. @WikiRik there's a demo of this in the umzug repo under the examples/ folder.
FWIW I've done as others have suggested and renamed my migration files to end with .cjs instead of .js in my "type": "module", project and things are working well. Annoying but easy enough to workaround.
@bobber205 It doesn't work if migration files in ESM 😆
Hey good afternon
did you resolved this issue? i have the same problema when im deploying
Umzug now fully supports esm. This repo will need to update. It's a major version update with several breaking changes, the version this repo uses is about four years old. The umzug repo has docs on how to update to v3. @WikiRik may know more about if anyone is already working on this.
Upgrade to umzug v3 will happen with v7 of the CLI which will also support v7 of sequelize. No ETA or roadmap yet, but we'll work on it once we release the first v7 beta
@WikiRik @mmkal at least I won't be switching to sequelize v7 for a few more years. Almost all code is already in ESM format, so it would be very convenient to update the umzug library for sequelize version v6 too.
With the community we might be able to accommodate for using both v2 and v3 of umzug in cli v6, but since umzug v3 does have its breaking changes we as maintainers will give limited attention to including it in v6. We will of course help out in making the upgrade process to v7 smoother and better documented
A sample code for who, like me, prefer to have everything in ESM. This code allows you to keep migrations in ESM and not use sequelize cli at all.
// migrator.js
import path from 'node:path';
import { pathToFileURL } from 'node:url';
import sequelize from './db/index.js';
import {
SequelizeStorage,
Umzug,
} from 'umzug';
const umzug = new Umzug({
migrations: {
glob: ['db/migrations/*.js', {
cwd: path.dirname(import.meta.url.replace('file://', '')),
}],
resolve(params) {
const getModule = () => import(pathToFileURL(params.path));
return {
name: params.name,
path: params.path,
up: async upParams => (await getModule()).up(upParams),
down: async downParams => (await getModule()).down(downParams),
};
},
},
context: { sequelize },
storage: new SequelizeStorage({ sequelize }),
logger: console,
});
await umzug.runAsCLI();
console.log('done');
await sequelize.close();
"scripts": {
"migrate": "node migrator.js up",
"migrate:down": "node migrator.js down"
},
try importing babel , it worked for me
https://sequelize.org/docs/v6/other-topics/migrations/#using-babel
