Defect #31116
Database migrations don't run correctly for plugins when specifying the `VERSION` env variable
| Status: | Closed | Start date: | ||
|---|---|---|---|---|
| Priority: | Normal | Due date: | ||
| Assignee: |  Go MAEDA | % Done: | 0% | |
| Category: | Plugin API | |||
| Target version: | 5.1.0 | |||
| Resolution: | Fixed | Affected version: | 4.0.2 |
Description
tl;dr: When comparing versions, the current_version is set to the core's latest migration instead of the plugin's latest.
Steps to reproduce:
1. Install any plugin with migrations, for example:
cd redmine/plugins git clone https://github.com/ixti/redmine_tags.git bundle install rake redmine:plugins:migrate NAME=redmine_tags
2. Undo the last migration of that plugin:
rake redmine:plugins:migrate NAME=redmine_tags VERSION=20151209153801
3. Migrate to the latest version again, but specifying the version this time:
rake redmine:plugins:migrate NAME=redmine_tags VERSION=20180122193833
Expected behaviour: the 20180122193833 migration is executed.
Actual behaviour: the 20180122193833 is not executed.
This is because redmine core's latest migration is 20180923091603 which is greather that the plugin's 20180122193833.
The attached fix defines a `migrate` method for the `Redmine::Plugin::MigrationContext` class that makes sure to pass along the current plugin's latest migration. Using the default migrate method defined in activerecord executes a `current_version` that looks for the most current migration in the list of all migrations (core and plugins).
Note: I have not run any tests with this patch.
0001-Fixes-plugin-migration-with-specific-version.patch 
(1.75 KB)
redmine-4.0.2.plugin-upgrade.patch
(1.47 KB)
MigrationContext-current_version.patch
(399 Bytes)
Associated revisions
Database migrations don't run correctly for plugins when specifying the `VERSION` env variable (#31116).
Contributed by crypto gopher.
History
#1 Updated by Anonymous almost 4 years ago
Test run available here: https://gitlab.com/sdwolfz/redmine/-/jobs/187237412
Although... I am not sure how to add a test that checks for this exact error.
#2
Updated by Go MAEDA almost 4 years ago
- Category set to Plugin API
- Target version set to Candidate for next major release
#3
Updated by Martijn Vernooij almost 4 years ago
- File redmine-4.0.2.plugin-upgrade.patch added
I noticed the same issue (with 4.0.2 though) and 'fixed' it another way.
#4
Updated by crypto gopher 5 months ago
- File MigrationContext-current_version.patch added
The problem stems from fact, that Redmine::Plugin::MigrationContext does not override current_version() method. So whenever ActiveRecord::MigrationContext.migrate() is executed, it calls ActiveRecord::MigrationContext.current_version() which does not differentiate between Redmine's migrations and plugin's migrations - yielding erroneous result.
The most straightforward change is to override ActiveRecord::MigrationContext.migrate() by using Redmine::Plugin::Migrator.current_version() which already provides required functionality:
class MigrationContext < ActiveRecord::MigrationContext
...
def current_version
Migrator.current_version
end
end
#6
Updated by Go MAEDA 4 months ago
crypto gopher wrote:
The most straightforward change is to override
ActiveRecord::MigrationContext.migrate()by usingRedmine::Plugin::Migrator.current_version()which already provides required functionality:
Thank you for posting the patch.
I wrote a test for your patch as follows. Do you think the following code tests the right way?
diff --git a/test/unit/lib/redmine/plugin_test.rb b/test/unit/lib/redmine/plugin_test.rb
index a5a1b2aa3..24c06240c 100644
--- a/test/unit/lib/redmine/plugin_test.rb
+++ b/test/unit/lib/redmine/plugin_test.rb
@@ -217,4 +217,17 @@ class Redmine::PluginTest < ActiveSupport::TestCase
assert Redmine::Plugin.migrate('foo_plugin')
end
+
+ def test_migration_context_should_override_current_version
+ plugin = @klass.register :foo_plugin do
+ name 'Foo plugin'
+ version '0.0.1'
+ end
+ migration_dir = File.join(@klass.directory, 'db', 'migrate')
+
+ Redmine::Plugin::Migrator.current_plugin = plugin
+ context = Redmine::Plugin::MigrationContext.new(migration_dir, ::ActiveRecord::Base.connection.schema_migration)
+ # current_version should be zero because Foo plugin has no migration
+ assert_equal 0, context.current_version
+ end
end