[FOLIO-636] Update stripes-docker role in folio-ansible to post UI module descriptors Created: 24/May/17  Updated: 12/Nov/18  Resolved: 07/Jul/17

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Task Priority: P2
Reporter: Wayne Schneider Assignee: John Malconian
Resolution: Done Votes: 0
Labels: ci, sprint16, sprint17
Remaining Estimate: Not Specified
Time Spent: 2 days, 1 hour, 30 minutes
Original estimate: Not Specified

Issue links:
Blocks
blocks FOLIO-572 Create continuous integration demo Closed
is blocked by STCOR-12 package2md.js generates invalid modul... Closed
is blocked by FOLIO-683 Decide where to define VHLPs and how ... Closed
is blocked by STCOR-5 Tool to generate UI modules' ModuleDe... Closed
Relates
relates to UIIT-35 Add okapiInterfaces and permissionset... Closed
relates to MODUSERBL-9 "Can create user" does not include us... Closed
Sprint:

 Comments   
Comment by Jakub Skoczen [ 13/Jun/17 ]

Wayne, can we prioritize this item for sprint16?

Also, let me just confirm what the result of this work would be: the MDs stored in the root directory of each ui- module would be POSTed to the Okapi instance when the FOLIO distribution is deployed. This means Okapi will be available to load meta-data for UI modules, validate dependencies and load any permission/permission sets defined. Correct?

Comment by Mike Taylor [ 13/Jun/17 ]

Once the UI modules' ModuleDescriptor.json files contain definition of high-level permissions, the VM-building code in folio-ansible can obtain the relevant MDs and insert the permissions that they define. It may be very simple to do this, just by loading the MDs into Okapi, which possibly knows already how to insert the defined permissions.

One slight problem with this: it requires folio-ansible to know the set of supported UI modules (and their versions) at build time. In general, we in the UI development team run newer versions of the UI modules against a fixed back-end provided by the folio-backend-auth VM: in that situation, we will not have access to any new or modified high-level permissions in the working versions of the UI modules. That may not be the end of the world.

Comment by Mike Taylor [ 13/Jun/17 ]

For this to work, we will need to add permissions to ui-users' package.json ( FOLIO-683 Closed ) and create and use a tool to generate UI modules' ModuleDescriptor.json from that file ( STCOR-5 Closed ).

Comment by Mike Taylor [ 13/Jun/17 ]

Once this is working for Users, we can expand to the other UI modules.

Comment by Mike Taylor [ 13/Jun/17 ]

This will give us a better generic way to solve problems such as MODUSERSBL-9 ("Can create user" does not include usergroups.collection.get resulting in an error popup).

Comment by Jakub Skoczen [ 22/Jun/17 ]

Wayne Schneider what's the progress here? This is becoming critical now in light of the issue like UIU-100 Closed .

Comment by Wayne Schneider [ 22/Jun/17 ]

Mike Taylor – Has this feature been extended to the other UI modules that need it (Items and Scan)?

Comment by Mike Taylor [ 22/Jun/17 ]

The facilities are not specific to any module. But at the moment, only ui-users contains okapiInterfaces dependencies (as far as I know).

Comment by Jakub Skoczen [ 23/Jun/17 ]

Guys, I have not idea what "okapiInterfaces" are, but the bottom line is that each ui- repo should come with a Module Descriptor – where are we on that?

Comment by Mike Taylor [ 23/Jun/17 ]

It's done. The three main UI modules (users, items, scan) all now have an okapiInterfaces section in their package-file declaring their dependencies on back-end interfaces provided via Okapi. (I'll do the same for ui-organization and ui-developer today.) The stripes-core/util/package2md.js script transforms these package files into module descriptors. Wayne will then use these in some way – I don't know the details – to configure the back-end. (It may be as simple as inserting them into Okapi.)

Comment by Wayne Schneider [ 26/Jun/17 ]

The module descriptors generated by package2md.js create ids for the modules that are unfortunately invalid for Okapi – e.g. @folio/users-2.7.1-SNAPSHOT.324. In my testing, Okapi accepts neither the @folio/ prefix nor the -SNAPSHOT.324 suffix. Created and linked issue STCOR-12 Closed .

Comment by Wayne Schneider [ 27/Jun/17 ]

Work is complete in branch FOLIO-636 Closed of folio-ansible

Comment by Wayne Schneider [ 07/Jul/17 ]

Merged into master of folio-ansible

Comment by Wayne Schneider [ 10/Jul/17 ]

Made a few modifications:

Generated at Thu Feb 08 23:07:14 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.