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

#843 - Use JS sort method to sort migrations by name #844

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

#843 - Use JS sort method to sort migrations by name #844

wants to merge 7 commits into from

Conversation

DavesBorges
Copy link
Contributor

Simple fix to #843. Now javascript sort function is used to both sort the executed migrations and the migrations to be executed.

Closes #843

@vercel Vercel
Copy link

vercel bot commented Jan 15, 2024 •
edited

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

Name Status Preview Comments Updated (UTC)
kysely ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 21, 2024 10:18am

@koskimas
Copy link
Member

This now breaks the sorting by timestamp. Out-of-order migrations can be executed in different order than the name order. That's why the primary ordering is by timestamp.

@DavesBorges
Copy link
Contributor Author

Then perhaps choose the sort method based on allowUnordered migrations?

@koskimas
Copy link
Member

Then perhaps choose the sort method based on allowUnordered migrations?

All you need to do is sort using the same logic as the SQL. Sort by timestamp and if the timestamps are equal, sort by name.

@DavesBorges DavesBorges marked this pull request as draft January 15, 2024 16:42
@DavesBorges
Copy link
Contributor Author

@koskimas I will add more tests for the out of order migration because the current tests didn't break when I ordered the executed migrations only by name

@DavesBorges
kysely-org#843 - test when migrating down with allowUnorderedMigratio…
055e5a1 
…ns enabled

This is needed to test if migrating down works when
the up migrations were not executed in alphabetical order
@DavesBorges DavesBorges marked this pull request as ready for review January 17, 2024 18:51
@DavesBorges
Copy link
Contributor Author

@koskimas I've found out why the tests haven't broken with allowUnordereMigrations enabled. The reason was the test migrations name were already in alphabetical order so I've added a test case where the migrations name are not in order to test that when migrating down it determines the migration order using the timestamps.

igalklebanov
igalklebanov reviewed Apr 21, 2024
View reviewed changes
src/migration/migrator.ts
return executedMigrations
.sort((a, b) => {
if (a.timestamp === b.timestamp) {
return a.name < b.name ? -1 : 1
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change to localeCompare.

igalklebanov
igalklebanov reviewed Apr 21, 2024
View reviewed changes
test/node/src/migration.test.ts
Comment on lines +852 to +863
let originalToIsoString: typeof Date.prototype.toISOString

before(() => {
originalToIsoString = Date.prototype.toISOString
const defaultDateIsoString = new Date(2024, 0, 11).toISOString()
Date.prototype.toISOString = () => defaultDateIsoString
})

after(() => {
// Reset to originalToIsoString function so that upcoming tests are not affected
Date.prototype.toISOString = originalToIsoString
})
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not clean, too coupled with implementation detail.
Use sinon fake timers instead to freeze time in a predictable way.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@koskimas koskimas koskimas left review comments

@igalklebanov igalklebanov igalklebanov left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Postgres migrateUp sometimes failing if migration name has a "-" character
3 participants
@DavesBorges @koskimas @igalklebanov