Multiple Clients

[peterdudfield]

We want to upgrade the datamodel so we can have multiple clients viewing different sites.

Detailed Description

Currently, we have one client, that has all the sites attached to it.

We want to be able to do the following

1. one user - can add or view one site
2. one user, can add or view multiple sites
3. Two users (for example from the sample company), want to look at one site
4. Two users, wanting to look at multiple sites (could be added by another user). Any user from site group can add a site.
5. OCF user want to see everything (admin)

Datamodel proposal:

  graph TD;
      User-- N:1 -->SiteGroup;
      SiteGroup-- N:N -->Site;

• One user is in one sitegroup. Each site group can have multiple users.
• Each sitegroup contains multiple sites. One site can be in multiple sitegroups

1. one user - one site

  graph TD;
      A(User=Alice)-->B(SiteGroup=Alice1);
      B --> C(Site);

2. one user - two sites

  graph TD;
      A(User=Alice)-->B(SiteGroup=Alice1);
      B --> C1(Site1);
B --> C2(Site2);

3. Two users - one site

  graph TD;
      A1(User=Alice)-->B(SiteGroup);
A2(User=Bob)-->B(SiteGroup);
      B --> C1(Site1);

4. Two users - two site

  graph TD;
      A1(User=Alice)-->B(SiteGroup);
A2(User=Bob)-->B(SiteGroup);
      B --> C1(Site1);
B --> C2(Site2);

5. OCF can see everything

  graph TD;
      A1(User=Alice)-->B(SiteGroup1);
A2(User=Bob)-->B(SiteGroup1);
A3(User=OCF)-->B2(SiteGroup2);
      B --> C1(Site1);
B --> C2(Site2);
      B2 --> C1(Site1);
B2 --> C2(Site2);
B2 --> C3(Site3);

Context

• Soon we will have more than one customer on the site project
• There maybe some public sites, but we can assign them a sitegroup

Possible Implementation

• [x] Remove Client table in code
• [x] Add SiteGroup table
• [x] Add 'User' table, - see example here
• [x] Create User to SiteGroup relationship similar to this
• [x] Create Site to SiteGroup relationship similar to this
• [x] Add migration for this change
• [x] Add test that go through 1. to 5. above
• [x] Update API get sites read function - https://github.com/openclimatefix/pv-site-api/pull/99
• [x] Update API to add user if not in db, also make dummy site group - https://github.com/openclimatefix/pv-site-api/pull/99
• [x] Upgrade forecasts and db clean up - https://github.com/openclimatefix/pv-site-production/pull/66
• [x] Run migrations - remove client data
• [x] Make sure OCF can see all sites
• [x] Add tools on Analaysis dashboard too - add site to site group, add user to site group - https://github.com/openclimatefix/uk-analysis-dashboard/issues/39
• [x] Upgrade PVConsumer - https://github.com/openclimatefix/PVConsumer/pull/70

dev

• [x] Upgrade datamodel db to 0.1.35
• [x] Upgrade api to 1.0.0
• [x] Upgrade forecasts 1.0.0
• [x] PVconsumer 1.0.0

pro

• [x] Upgrade datamodel db to 0.1.35
• [x] Upgrade api to 1.0.0
• [x] Upgrade forecasts 1.0.0
• [x] PVconsumer 1.0.0

[peterdudfield]

@braddf @devsjc I've written this up here.

Please add comments and questions on here (if you have any).

Note: sql relationships are sometimes hard, so happy to help out with that

[peterdudfield]

https://stackoverflow.com/questions/5756559/how-to-build-many-to-many-relations-using-sqlalchemy-a-good-example

[peterdudfield]

I'm gona close this despite one task being open, but thats is stand alone

[peterdudfield]

Would be good to move some of these mermaid diagrams to the readme.md