Refactor scenario creation related function so that creator info is contained in the DTO and now get scenario by id also returns creator info

Author: Kanakanajm

api/src/api/app/apis/scenarios_api.py

@@ -45,10 +45,13 @@ async def create_scenario(
     scenario: Scenario = Body(None, description="")
 ) -> ID:
     """Create a new scenario to be simulated."""
+
+    # Tag creator info
+    scenario.creator_user_id = request.state.user.userId if request.state.user else None
+    scenario.creator_org_id = request.state.realm if request.state.realm else None
+    
     return await controller.create_scenario(
-        scenario,
-        request.state.user.userId if request.state.user else None,
-        request.state.realm if request.state.realm else None
+        scenario
     )
 
 

api/src/api/app/controller/scenario_controller.py

@@ -61,14 +61,12 @@ class ScenarioController:
 
     async def create_scenario(
         self,
-        scenario: Optional[Scenario],
-        userId: Optional[str],
-        orgId: Optional[str]
+        scenario: Optional[Scenario]
     ) -> ID:
         """Create a new scenario to be simulated."""
         if not scenario:
             raise HTTPException(status_code=500, detail="No scenario provided")
-        return scenario_create(scenario, userId, orgId)
+        return scenario_create(scenario)
 
 
     async def delete_scenario(

api/src/api/app/db/models.py

@@ -28,8 +28,8 @@ class Scenario(SQLModel, table=True):
     timestampSubmitted: Optional[datetime] = Field(default=None, nullable=True)
     timestampSimulated: Optional[datetime] = Field(default=None, nullable=True)
 
-    userId: Optional[str] = Field(default=None, nullable=True) # Created by user
-    orgId: Optional[str] = Field(default=None, nullable=True) # Created by user's LHA/Organization
+    creatorUserId: Optional[uuid.UUID] = Field(default=None, nullable=True)
+    creatorOrgId: Optional[str] = Field(default=None, nullable=True)
 
 class ParameterDefinition(SQLModel, table=True):
     id: Optional[uuid.UUID] = Field(default_factory=uuid.uuid4, primary_key=True, nullable=False)

api/src/api/app/db/tasks.py

@@ -412,7 +412,7 @@ def parameter_definition_delete(id: StrictStr) -> None:
 
 
 ## Scenarios ##
-def scenario_create(scenario: Scenario, userId: Optional[str], orgId: Optional[str]) -> ID:
+def scenario_create(scenario: Scenario) -> ID:
     scenario_obj = db.Scenario(
         name=scenario.name,
         description=scenario.description,
@@ -423,8 +423,8 @@ def scenario_create(scenario: Scenario, userId: Optional[str], orgId: Optional[s
         percentiles=','.join([str(perc) for perc in scenario.percentiles]) if scenario.percentiles else '50',
         timestampSubmitted=datetime.now(),
         timestampSimulated=None,
-        userId=userId,
-        orgId=orgId
+        creatorUserId=scenario.creator_user_id,
+        creatorOrgId=scenario.creator_org_id
     )
     with next(get_session()) as session:
         nested_dict = lambda: defaultdict(nested_dict)
@@ -538,6 +538,8 @@ def scenario_get_by_id(id: StrictStr) -> Scenario:
         percentiles=[int(perc) for perc in scenario.percentiles.split(',')] if scenario.percentiles else [50],
         timestampSubmitted=scenario.timestampSubmitted,
         timestampSimulated=scenario.timestampSimulated,
+        creator_user_id=str(scenario.creatorUserId),
+        creator_org_id=scenario.creatorOrgId
     )
 
 def scenario_get_all() -> List[ReducedScenario]:

api/src/api/app/models/scenario.py

@@ -49,6 +49,9 @@ class Scenario(BaseModel):
     timestamp_simulated: Optional[datetime] = Field(default=None, alias="timestampSimulated", description="Timestamp when the scenario was finished simulating and data is available")
     __properties: ClassVar[List[str]] = ["id", "name", "description", "startDate", "endDate", "modelId", "modelParameters", "nodeListId", "linkedInterventions", "percentiles", "timestampSubmitted", "timestampSimulated"]
 
+    creator_user_id: Optional[str] = None
+    creator_org_id: Optional[str] = None
+
     model_config = {
         "populate_by_name": True,
         "validate_assignment": True,