TAMULib / mod-workflow

Apache License 2.0
0 stars 0 forks source link

Issue 113: Mod Workflow needs to be registered/deployed as a FOLIO module. #117

Closed kaladay closed 11 months ago

kaladay commented 11 months ago

resolves #113 (in theory)

Relocate the Descriptors to the (almost) standard FOLIO location. The descriptors/ directory should be at the base project root but in this specific case with service as a sub-directory the descriptors/ directory must be under service/.

Change the format from @ to $, but there is some concern that we may want @. The current common practices across FOLIO projects is to use the $ variable syntax in the Descriptors. This change is done to be consistent with FOLIO's current practices at large.

This module is again an exceptional case where the project is under service/. The standard ${artifactId} cannot be used because that ends up being workflow-service rather than mod-workflow. Therefore, hard code mod-workflow in places where mod-workflow must be used instead of workflow-service.

Added -XX:MaxRAMPercentage=66.0 for consistency with other projects. Some projects use a value like 85.0. I don't have a realistic clue here on what value to use and I am open to not having this environment variable set at all if a proposal to remove it is given.

Add requirements for proper backend deployment to the Descriptors. This includes environment variables at the memory usage. Update the application.yml to utilize these environment variables where possible.

Remove shade plugin due to inherent problems and bugs. The shade plugin was added during another issue this depends on. After testing and using in this scope, the shade plugin was determined to be problematic. Errors regarding multiple registrations of AttributeConverter have surfaced (in mod-workflow). This is a bug between the shade plugin and hibernate as far as I can tell from my online research.

Default the OKAPI URL to use port 9130.

see: https://dev.folio.org/guides/module-descriptor/ see: https://dev.folio.org/guides/install-backend-module/