[syncModule]: draft for V1.0.0

[nathanschwarz]

• [x] create the module
• [x] get the data from the source DB
• [x] map the source data to the CustomerModel | ConnectionModel
• [x] get the data from the target DB (customers and connections) (ours)
• [x] compare the data (customers, connections)
• [x] upsert systematically customer from sourceDB
• [x] if targetDB customer is not in sourceDB erase it
• [x] update connections based on strict match of [address, flat] (toggled, customerId)
• [x] [backend]: run the module through docker socket at specified intervals
• [x] documentation (in code)
• [ ] unit tests
• [ ] [devOps] build the module in docker @yarons

[nathanschwarz]

@yarons what happens if the connection.autoUpdate === false but the customer was removed from the source database. Should we remove and disable both the connection and the user ? Or should we ignore this and throw a warning / error in the logs ?

[nathanschwarz]

@yarons also what should happens if the customer address changes ? Should we disable the connection ?

[nathanschwarz]

@yarons I added html code autogenerated documentation for the syncModule here : backend/syncModule/pdoc it was generated with pydoc3 but its not perfect, part of the text is not formatted correctly (lists) and pydantic.Field.description are not detected. It was a very very fast solution, but you should be able to do more precise documentation later on with sphynx or else.

[yarons]

We're already using MkDocs so Markdown is great for us, we'll just generate the GitHub Pages accordingly.