TCR-39-ui-serials-management evaluation

module_evaluations/TCR-39_2024_02_27-ui-serials-management.MD

@@ -0,0 +1,78 @@
+# Module acceptance criteria template
+
+## Module Name
+ui-serials-management
+
+## How to use this form
+When performing a technical evaluation of a module, create a copy of this document and use the conventions below to indicate the status of each criterion.  The evaluation results should be placed in the [module_evaluations](https://github.com/folio-org/tech-council/tree/master/module_evaluations) directory and should conform to the following naming convention: `{JIRA Key}_YYYY-MM-DD-{module name}.MD`, e.g. `TCR-1_2021-11-17-mod-foo.MD`.  The date here is used to differentiate between initial and potential re-evaluation(s).  It should be the date when the evaluation results file was created.
+
+* [x] ACCEPTABLE
+* [x] ~INAPPLICABLE~
+* [ ] UNACCEPTABLE
+  * comments on what was evaluated/not evaluated, why a criterion failed
+
+## [Criteria](https://github.com/folio-org/tech-council/blob/7b10294a5c1c10c7e1a7c5b9f99f04bf07630f06/MODULE_ACCEPTANCE_CRITERIA.MD)
+
+## Administrative
+* [X] Listed by the Product Council on [Functionality Evaluated by the PC](https://wiki.folio.org/display/PC/Functionality+Evaluated+by+the+PC) with a positive evaluation result.
+
+## Shared/Common
+* [X] Uses Apache 2.0 license
+* [X] Module build MUST produce a valid module descriptor
+* [X] Module descriptor MUST include interface requirements for all consumed APIs
+  * Lists serials-management interface.  in constants/endpoints.js, also requires orders/*, organizations/*, several others.
+* [ ] Third party dependencies use an Apache 2.0 compatible license
+  * ASF excludes:
+    * GPL-3.0
+    * GPL-3.0-or-later
+  * ASF lists as questionable / depending on how it's used:
+    * CC-BY-4.0
+    * MPL-2.0
+  * Unknown:
+    * Custom: https://github.com/dominictarr/event-stream
+  * **However** none of these are problems with ui-serials-management in particular, see TCR Process Improvements below.  So I think this may be a TC process problem, not a problem of this module.
+* [X] In order to ensure reproducible builds, snapshot versions of build-time dependencies should not be referenced.
+* [X] Installation documentation is included
+  * -_note: read more at https://github.com/folio-org/mod-search/blob/master/README.md_
+  * The documentation README is included but is (I think) incorrect.  You cannot "serve ui-serials-management by itself" because the find-po-line plugin is a dependency.
+* [X] Personal data form is completed, accurate, and provided as `PERSONAL_DATA_DISCLOSURE.md` file
+* [X] Sensitive and environment-specific information is not checked into git repository
+* [X] Module is written in a language and framework from the [officially supported technologies](https://wiki.folio.org/display/TC/Officially+Supported+Technologies) page[^1]
+* [X] Module only uses FOLIO interfaces already provided by previously accepted modules _e.g. a UI module cannot be accepted that relies on an interface only provided by a back end module that hasn't been accepted yet_
+* [X] Module gracefully handles the absence of third party systems or related configuration
+* [ ] Sonarqube hasn't identified any security issues, major code smells or excessive (>3%) duplication (6); and any disabled or intentionally ignored rules/recommendations are reasonably justified.
+  * See [Rule Customization](https://dev.folio.org/guides/code-analysis/#rule-customization) details. 
+  * No security issues, and duplication is below 3%.
+  * Master branch shows [15 major code smells (and 2 critical)](https://sonarcloud.io/project/issues?impactSeverities=HIGH&resolved=false&types=CODE_SMELL&id=org.folio%3Aui-serials-management)
+* [X] Uses [officially supported](https://wiki.folio.org/display/TC/Officially+Supported+Technologies) build tools[^1]
+* [ ] Unit tests have 80% coverage or greater, and are based on [officially supported technologies](https://wiki.folio.org/display/TC/Officially+Supported+Technologies)[^1]
+  * 56.6% coverage
+
+## Frontend
+* [X] If provided, End-to-end tests must be written in an [officially supported technology](https://wiki.folio.org/display/TC/Officially+Supported+Technologies)[^1]
+  * -_note: while it's strongly recommended that modules implement integration tests, it's not a requirement_
+  * -_note: these tests are defined in https://github.com/folio-org/stripes-testing_
+  * no end-to-end tests written
+* [X] Have i18n support via react-intl and an `en.json` file with English texts
+* [ ] Have WCAG 2.1 AA compliance as measured by a current major version of axe DevTools Chrome Extension
+  * Compliant except for two issues that are Stripes framework-level issues.  From the self-eval:
+>  * We have addressed the majority of issues reported by the axe DevTools Chrome Extension. However there are still two outstanding issues, both of the same type (MCL rows generating the issue: "Certain ARIA roles must contain particular children"):
+    * UISER-71
+    * UISER-75
+> * We see this issue in other MCLs in Folio, for example: Calendar settings -> Current calendar assignments and we believe there is the need for changes to Stripes to support MCLs that do not provide linkable row/row elements. If this is something we can fix in the application we will do so. If a Stripes level fix is required we will work with the Stripes team to work out the fix
+* [X] Use the Stripes version of referred on the [Officially Supported Technologies](https://wiki.folio.org/display/TC/Officially+Supported+Technologies) page[^1]
+* [X] Follow relevant existing UI layouts, patterns and norms
+  * -_note: read more about current practices at [https://ux.folio.org/docs/all-guidelines/](https://ux.folio.org/docs/all-guidelines/)_
+  * e.g. Saving state when navigating between apps (or confirming that you'll lose the state)
+* [X] Must work in the latest version of Chrome (the supported runtime environment) at the time of evaluation
+
+## TCR Process Improvements
+[_Please include here any suggestions that you feel might improve the TCR Processes._]
+
+* Module descriptor check should link to https://dev.folio.org/guides/module-descriptor/
+
+* The reason that the criterion about third-party license dependencies fails is not actually about ui-serials-management; rather it depends on several standard Stripes dependencies that themselves include these issues.  I [wrote up the problem in #stripes](https://folio-project.slack.com/archives/C210UCHQ9/p1709571130512069) and got various helpful feedback.  From TC discussion on 2024-03-24, this should be considered during the next round of TCR Improvements.  
+
+* For backend modules, we should require that they deploy successfully as part of the vagrant snapshot build.  Currently mod-serials-management doesn't deploy correctly in vagrant, which means that ui-serials-management has to be tested against the reference environment OKAPI.  That's not a deal-breaker but it's not ideal.  
+
+[^1]: Refer to the [Officially Supported Technologies](https://wiki.folio.org/display/TC/Officially+Supported+Technologies) page for the most recent ACTIVE release.