1.0.0: Stable API release

[adamkewley]

Due to various personal circumstances, I am planning to spin my development contribution to Jobson and Jobson UI's down to ~2 hours per week from late-2018.

For comparison, Jobson was initially developed as a work project (+ spare-time, ~50-65 h/wk) over 3 months, which was mostly decreased to a spare-time only (~15 h/wk) project in early 2018. For various personal reasons, I cannot guarantee the same level of commitment in 2019 and I anticipate that I will only be able to dedicate ~2 h/wk on average, which is enough time to:

• Maintain the project (dependencies, bugs, cleaning)
• Handle PRs (if they come)

Unfortunately, it's not enough time for me to implement major feature additions in a reasonable time frame (< 1 month).

I scheduled a 1.0.0 release of Jobson for late 2018. This was so that there was a ~12 month window to ensure the specified design (CLI, API, specs) were suitable for solving the problem (making job systems). After running Jobson in prod for ~14 months, I'm happy to announce that I encountered no major breaking changes or issues with the system. Other developers are also reporting that Jobson is doing what's prescribed - although without all the features they would like it to have.

1.0.0

v1 will focus on keeping what's currently there stable and easy to maintain. Changes for 1.0.0 will be non-breaking.

Planned Build/Project Changes

• Engine internals will be refactored
  • jobson-ui is already refactored ready for 1.0.0 (js ->Typescript) and has latest versions of all dependencies
  • jobson will be refactored, including tests, and have all dependencies updated to make maintenance development easier
• jobson and jobson-ui will be merged into one project:
  • The jobson-ui project will be merged into this repo as a submodule, so that a single build can produce the server and UI artifacts
  • This makes versioning, matching, and integrating (e.g. into docker images) the two components easier
• HTTP API documentation will be statically generated as swagger.json and Swagger UI artifacts (see issue)
  • This allows devs to view the API documentation without needing to boot an actual server, and removes messy dependencies from jobson
• Documentation will be refactored into Sphinx (rather than Jekyll), to make it easier to edit and navigate (previously: was a custom thing)
  • Auth docs (see issue)
• Job Queue persistence (see issue)

Features that won't be implemented (see roadmap)

• OAuth2 support
• Authorization
• Execution hooks (see issue
• Execution triggers
• Job system tests (spec testing)
• Unified output API
• Windows Support
• Jobs pagination metadata (total pages, etc.)
• Job attempts (see issue)
• Dynamic number of job outputs (see issue)
• Symlinking job outputs (see issue)
• Job progress monitoring (see issue)
• Collect job outputs as the job runs (see issue)
• Execution triggers (see issue)
• Pluggable job schedulers (see issue)

[adamkewley]

Note (from 1.0.0 dev, for future dev): write system tests that detect warnings in the logs. There shouldn't be any warnings for a valid configuration, but deployments that use Java 9/10 generate classloader warnings because Java 9+ deprecated loads of libraries that Jobson's libraries use. Those would be handy to catch in a test suite so I can fix them before they hit prod.

[adamkewley]

This is now done, but I need to clean up the README etc. with some quickstart guides for new developers to read

[adamkewley]

This is now done. The outstanding features that were dropped from 1.0.0 will be moved into a new "feature list" that will be open for future (1.x.x) patches. I will also import issues from jobson-ui into that feature list as "dropped" features/bugfixes