Bump permissions interface from 5.5 to 5.6 for module replaces

Description

Upgrading to Nolana to Orchid-GA fails when the upgrade from mod-data-import-converter-storage to mod-di-converter-storage (rename!) is executed before the upgrade from mod-permissions.

Reason: The module rename requires the Orchid version of mod-permissions.

Error:

Fix: Add a dependency to ModuleDescriptors to enforce the upgrade order:

  • Bump mod-permissions' permissions interface from 5.5 to 5.6.

  • Add a permissions 5.6 dependency to mod-di-converter-storage.

Describe issue impact on business

Upgrading from Nolana to Orchid-GA fails when the upgrade from mod-data-import-converter-storage to mod-di-converter-storage (rename!) is executed before the upgrade of mod-permissions. The mod-di-converter-storage rename contributes to this issue. Okapi determines the upgrade order based on the dependencies declared in module's ModuleDescriptor, however, we missed to add the dependency required for the rename.

What institutions are affected? (field “Effected Institutions” in Jira to be populated)

All institutions that change the module list provided on https://github.com/folio-org/platform-complete because they install more modules or less modules can be affected.

What is the workaround if exists?

No workaround, Okapi uses the same upgrade order (deterministic order) for a given module list so the upgrade will always fail (or will always succeed if the order is correct by chance).

What areas will be impacted by fix (i.e. what areas need to be retested)

Only Okapi's dependency resolution that runs during upgrade is affected because no code is changed. No need to test other areas.

Brief explanation of technical implementation and the level of effort (in workdays) and technical risk (low/medium/high)

Expand ModuleDescriptor, for details see above.

Effort: Less than 1 workday.

Brief explanation of testing required and level of effort (in workdays). Provide test plan agreed with by QA Manager and PO.

No testing needed because only the upgrade is affected.

What is the roll back plan in case the fix does not work?

Institution reinstalls the Nolana backup and doesn't migrate to Orchid.

CSP Request Details

Approved by RMS group at 06/12

CSP Rejection Details

None

Potential Workaround

None

Checklist

hide

TestRail: Results

Activity

Show:
Done

Details

Assignee

Reporter

Priority

Story Points

Sprint

Development Team

Core: Platform

Fix versions

Release

Orchid (R1 2023) Service Patch #2

RCA Group

Implementation coding issue

CSP Approved

Yes

Affected releases

Poppy (R2 2023)
Orchid (R1 2023)

Affected Institution

GBV

TestRail: Cases

Open TestRail: Cases

TestRail: Runs

Open TestRail: Runs

Created April 21, 2023 at 11:48 AM
Updated June 12, 2023 at 1:11 PM
Resolved April 26, 2023 at 6:40 AM
TestRail: Cases
TestRail: Runs