zmorris248 commented 7 months ago

Overview

This pull request merges our work on refactoring the job_monitoring_application to refer to 'studies' instead of 'jobs'. It includes a renaming of all references to a 'job' to a 'study' in the frontend, backend, and trackerapi as well as the orthanc_data_logger that uses trackerapi.

Migrations were run to change the event table column 'job_id' to 'study_id', add the 'studies' table to the db, and delete the 'jobs' table.

These refactorings make our app more coherent and are more in line with real world medical imaging applications.

Implementation

Migrations to the database
Refactoring in frontend, backend, trackerapi, and orthanc_data_logging.py

Testing

All tests related to 'jobs' were either changed or rewritten to test the 'studies' in all modules of the application.

Problems Faced

Figuring out the best way to make incremental changes in the right order was challenging at first. Our initial attempt at this failed, but we learned from it and adapted. The process we found to be the best:

Run migrations to add what we need to the database in modular steps
starting with the backend, add to the testing suite to test the new functionality coming (this is in line with Red-Green-Refactor)
Add to the backend until the tests pass
Now that the new implementation works, delete the old functionality that is no longer needed in a similar step by step manner. Delete each module that uses it, delete the tests, and then finally run migrations to remove any unneeded parts of the data base.
Repeat this process with frontend, trackerapi, etc...

Notes

Closes #113

zmorris248 commented 7 months ago

It seems that sonarcloud doesn't like the duplicated code that is in our testing suite. I think that we either need to adjust its expectations or figure out how to exclude certain libraries from its analysis. Thoughts?

powersaudrey25 commented 7 months ago

It seems that sonarcloud doesn't like the duplicated code that is in our testing suite. I think that we either need to adjust its expectations or figure out how to exclude certain libraries from its analysis. Thoughts?

We can probably use a fixture or something similar I will look into it.

powersaudrey25 commented 7 months ago

It seems that sonarcloud doesn't like the duplicated code that is in our testing suite. I think that we either need to adjust its expectations or figure out how to exclude certain libraries from its analysis. Thoughts?

We can probably use a fixture or something similar I will look into it.

added a fixture should be good now