alchemiscale icon indicating copy to clipboard operation
alchemiscale copied to clipboard

Add client-server version comparison check for major libraries

Open dotsdl opened this issue 2 years ago • 1 comments

We should add a method to the AlchemiscaleClient that checks local versions of the following packages against those the API service is running with:

  • gufe
  • openfe
  • alchemiscale

We may call this method upon AlchemiscaleClient instantiation to issue warnings if mismatches are identified, especially for non-patch versions.

dotsdl avatar Aug 03 '23 01:08 dotsdl

Speaking with @ianmkenney, we propose:

  • adding the ability for a server administrator to specify the list of modules that versions should be reported for as configuration items in the API settings
  • adding an endpoint to the base API that reports the versions of those modules to the requesting client
  • adding a method to the AlchemiscaleBaseClient that runs on init, hits that API endpoint, and compares module versions reported with those local, issuing warnings where there is a mismatch

Later, we could add version range comparisons, in which server reports both its module versions and acceptable ranges (also configured) of versions for each. Warnings could then be issued by the client if the local version of a module fall outside of the reported acceptable range.

dotsdl avatar Jan 17 '24 18:01 dotsdl