Add support for per-user quotas, by allowing a fake collab name "private" which is expanded to "private-{username}"

Author: apdavison

api/simqueue/globals.py

@@ -26,3 +26,5 @@
     "Spikey": 1.0,
     "Demo": 1.0,
 }
+
+PRIVATE_SPACE = "private"

api/simqueue/oauth.py

@@ -7,6 +7,7 @@
 from fastapi import Security, HTTPException, status as status_codes
 
 from . import settings, db
+from .globals import PRIVATE_SPACE
 
 
 logger = logging.getLogger("simqueue")
@@ -75,6 +76,8 @@ def username(self):
         return self.preferred_username
 
     async def can_view(self, collab):
+        if collab == f"{PRIVATE_SPACE}-{self.username}":
+            return True
         # first of all, check team permissions
         target_team_names = {
             role: f"collab-{collab}-{role}" for role in ("viewer", "editor", "administrator")
@@ -91,6 +94,8 @@ async def can_view(self, collab):
             return collab_info.get("isPublic", False)
 
     def can_edit(self, collab):
+        if collab == f"{PRIVATE_SPACE}-{self.username}":
+            return True
         target_team_names = {
             role: f"collab-{collab}-{role}" for role in ("editor", "administrator")
         }
@@ -99,7 +104,7 @@ def can_edit(self, collab):
                 return True
 
     def get_collabs(self, access=["viewer", "editor", "administrator"]):
-        collabs = set()
+        collabs = set()  # do we add "private" to this set?
         for team_access in self.roles.get("team", []):
             # note, if team information is missing from userinfo that means
             # the user is not a member of any collab

api/simqueue/utils.py

@@ -8,7 +8,7 @@
 
 from .data_models import ProjectStatus, ResourceUsage
 from . import db, settings
-from .globals import RESOURCE_USAGE_UNITS, PROVIDER_QUEUE_NAMES, DEMO_QUOTA_SIZES
+from .globals import RESOURCE_USAGE_UNITS, PROVIDER_QUEUE_NAMES, DEMO_QUOTA_SIZES, PRIVATE_SPACE
 
 logger = logging.getLogger("simqueue")
 
@@ -29,7 +29,13 @@ async def check_quotas(collab: str, hardware_platform: str, user: str = None):
 
     If the collab has never had a quota for the given platform and , but a username `user` is specified,
     then a new test/demo quota will be created with the owner set to `user`.
+
+    If the collab is set to the special value "private", then we generate a fake collab name based
+    on the username. This allows users to access the platform without needing to create a real collab.
+    Results generated with such private access are not available to others.
     """
+    if user is not None and collab == PRIVATE_SPACE:
+        collab = f"{PRIVATE_SPACE}-{user.username}"
     available_quotas = await get_available_quotas(collab, hardware_platform)
     if len(available_quotas) == 0 and user is not None and hardware_platform in DEMO_QUOTA_SIZES:
         # if this collab has never had a quota for this platform, we create a default test quota