Uploaded image for project: 'Atlas Module'
  1. Atlas Module
  2. ATLAS-190

Remove atlas_version from the Atlas server

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: TBD
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None
    • Complexity:
      Medium

      Description

      The atlas.atlas_version attribute is poorly named and misleading. It was created to hold the version of the module sending data. This was added in case the structure of data sent by the module changed between versions. A better choice would be to store the version of the data (i.e, the schema version) – i.e., if five different versions of the module all send data in the same structure, then the server doesn't care what version of the module was used. We only need to change the data version (sent by the module) when/if we alter the structure of the json sent in atlas.data by the module.

      Since the structure of atlas.data hasn't changed, we can manually reset all Atlas entries to data_version "1" and the server only needs to know how to parse this version of data. If we decide to update the data sent by the module in the future, we can call it version "2" and add some code in the server code to handle the new structure when atlas.data_version is 2.

      Given this is an imagined need, we should eliminate atlas.atlas_version from the database and any references to it in the code. We can introduce a method of storing the version of module data format if/when we ever need it in the future.

        Attachments

          Activity

            People

            Assignee:
            heliostrike Sai Sandeep Mutyala
            Reporter:
            burke Burke Mamlin
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: