This page outlines improvements and technical debt that needs to happen to the OpenLMIS-UI. Tickets listed on this page are may not be ready for work, and can actively be picked up once placed on a backlog grooming page.
Resources
When working on OpenLMIS design or user interface issues, please consult the following resources.
- OpenLMIS design documentation outlines OpenLMIS recommended workflows, form layout, and writing guidelines. Individual designs may break these rules, but the OpenLMIS community recommends against this.
- Wire-frame template library which should be used to start mocks-up and quickly work through content designs.
- OpenLMIS Reference-UI Styleguide which illustrates basic UI styles, layouts, and components - along with the working code to generate them. Use this resource if creating hi-fidelity mockups or working OpenLMIS-UI code.
UI Github Repositories
- Dev-UI to v5
Semantically Versioned Repositories
- UI Components to v5.1.1
- UI Layout to v5.0.2
- Auth UI to v5.0.3
- Reference Data UI to v5.2.0
- Requisition UI to v5.1.1
- Fulfillment UI to v5.0.3
- Report UI to v5.0.3
Milestone Versioned Repositories
- Reference UI to v5.0.3
Backlog
Consistency
| Problem | Solution | Tickets |
|---|---|---|
| Inconsistent HTML markup makes it harder for implementers to change large style applications across the OpenLMIS-UI. | Inconsistencies need to be identified and action needs to be taken to:
| OLMIS-2936 - Getting issue details... STATUS |
| Modals look gross, and there are variations in how and when modals are used. |
| |
| Program/Facility filter/select is implemented and used different sections of the OpenLMIS-UI |
| |
| Directions for searching on list pages is not always clear |
| |
It is too easy to click off the modal in the add screen of stock management and loose all the work the user has done | ||
Unit Tests
| ||
| sticky-columns can't be "easily used" | ||
CSS restyling:
| ||
OLMIS-2821 - Getting issue details... STATUS | ||
| As the OpenLMIS-UI evolves, we need to make sure the code base is stable |
| OLMIS-3195 - Getting issue details... STATUS |
| Date Picker implementation is screwy |
| |
| Year selection component – we don't want to rewrite year formatting guidelines.... | OLMIS-3043 - Getting issue details... STATUS | |
| Alert warning is only used once | OLMIS-3080 - Getting issue details... STATUS | |
| OLMIS-3081 - Getting issue details... STATUS |
Performance
| Problem | Solution | Tickets |
|---|---|---|
| The OpenLMIS-UI uses a bunch of libraries and tools to function, but these libraries are large and should be made as small as possible |
|
|
| As the application evolves, we need to make sure the OpenLMIS-UI continues to download and start quickly. |
| |
| Currently the OpenLMIS-UI downloads all functionality regardless of the user who is logging in, or the pages they visit. | Ideally, the user will just download the information they need as they work with subsets of pages. |
|
Offline Support
| Problem | Solution | Tickets |
|---|---|---|
Firefox and other browsers need to be cleared to show the most recent OpenLMIS-UI version. We need design around managing offline assets so new versions can be pushed | AppCache can update detect and notification | OLMIS-3166 - Getting issue details... STATUS |
| The most frequent HTTP request from the UI is to find out if the browser is offline or not. This could be done in a slower and more meaningful way. | Less frequent offline status check (reduce UI bandwidth) |
Extensibility
| Problem | Solution | Tickets |
|---|---|---|
| ||
| There are no supported patterns for extending files | ||
| Extendability of directives is a problem — directive controllers | ||
| Adding of changing constants in OpenLMIS |
| |
| Modals are not DRY - which will make it hard to make global changes to support accessibility and i18n | uh... make them DRY | OLMIS-3003 - Getting issue details... STATUS |
Tooling
| Problem | Solution | Tickets |
|---|---|---|
There are large files that have too much functionality, which makes their classes difficult to extend or change. A large part of the problem is identifying the files that need to be changes and fixing them. | Add some tooling to identify these large files, and make secondary tickets to refactor the files to be smaller
| |
| Jasmine 1.3 is outdated | Update to latest version of Jasmine (Overview of process here) | |
| Scaffolding new modules or file types involves lots of boiler plate |
| |
Set up Javascript linter | ||
| Set up Sass linter | ||
Dgeni-example JSDoc and KSS toolset | OLMIS-2030 - Getting issue details... STATUS | |
| There are requests and needs for OpenLMIS to function as a native application on mobile devices | Cordova Android application compiler | OLMIS-2820 - Getting issue details... STATUS |
Malawi
| Problem | Solution | Tickets |
|---|---|---|
User Input In requisitions, losses and adjustments error messages don't clear until the page is refreshed In requisitions, product grid cells are not shrinking to their minimal size
|
SORTING
Bug?
| |
| Notifications are wacko | ||
Offline Offline is described to be super sensitive. The UI will show that it's in the offline state, when it really isn't.
|
| |
Memory/runtime/wtf
|
| |
Caching
|
| |
WTF
|
| |
| Un-Forking |
Unit Testing
http://docs.openlmis.org/en/latest/conventions/uiCodeConventions.html#unit-testing-guidelines
| Examples | ||
|---|---|---|
| Brittle | Checks markup, not meaning | |
| Set up view that is available in router? | https://github.com/OpenLMIS/openlmis-cce-ui/blob/master/src/cce-edit-inventory-item/edit-inventory-item.html.spec.js#L655-L672 | |
| Testing utils bundled into applicaiton? | https://github.com/OpenLMIS/openlmis-cce-ui/blob/master/src/openlmis-testing-utils/openlmis-testing-utils.module.js |
Misc Notes
Todo list clearing
- Add HTML5 mode to nginx
https://gist.github.com/cjus/b46a243ba610661a7efb - Add postCSS - some styles are not getting poly-filled
- Documentation update for directives and cleaning scope
- Add documentation for layout patterns. Should be markdown eventually – but confluence is good for now
- extra-data component
2017-09-15 Alfred/Dercio/Nick
- Hide as many columns as possible
- In Stock Management Recieve - reason entry isn't needed as there is only one choice, the column should not even show
- There are blank areas from lot/vaccination groups → its weird
- Odoo allows users to define groups of data, remembering the order that a use clicked buttons to create the group
- This made complex data reporting and editing easier
- Make all editable fields in a table required
- Odoo allows users to add additional information to a row in a secondary view (modal-ish)
- Odoo allows devs to configure if the system should do 'live' validation or validate once a form is submitted
- Module development in Odoo, allows an implementer/user to see the packages that are installed – which makes talking and reasoning about the system possible