Merge branch 'main' into assign_user_to_client

Author: hanaawad24

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.0.53
+current_version = 1.0.54
 commit = True
 tag = True
 message = Bump version: {current_version} → {new_version} [ci skip]

alembic/versions/3c765af43b5a_add_client_user_relationship.py

@@ -0,0 +1,30 @@
+"""Add client-user relationship
+
+Revision ID: 3c765af43b5a
+Revises: 81278a3571b2
+Create Date: 2025-03-19 13:34:08.803237
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '3c765af43b5a'
+down_revision = '81278a3571b2'
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('users', sa.Column('client_uuid', sa.UUID(), nullable=True, comment='The foreign key to the clients table'))
+    op.create_foreign_key(None, 'users', 'clients', ['client_uuid'], ['client_uuid'])
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_constraint(None, 'users', type_='foreignkey')
+    op.drop_column('users', 'client_uuid')
+    # ### end Alembic commands ###

alembic/versions/81278a3571b2_add_probabilistic_values_column_to_.py

@@ -0,0 +1,28 @@
+"""Add probabilistic_values column to forecast value table
+
+Revision ID: 81278a3571b2
+Revises: 42f8f283e2c9
+Create Date: 2025-03-08 12:57:24.464340
+
+"""
+from alembic import op
+import sqlalchemy as sa
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = '81278a3571b2'
+down_revision = '42f8f283e2c9'
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('forecast_values', sa.Column('probabilistic_values', postgresql.JSONB(astext_type=sa.Text()), server_default=sa.text("'{}'"), nullable=False, comment='Probabilistic forecast values, like p10, p50, p90'))
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column('forecast_values', 'probabilistic_values')
+    # ### end Alembic commands ###

pvsite_datamodel/__init__.py

@@ -14,4 +14,4 @@
     UserSQL,
 )
 
-__version__ = "1.0.53"
+__version__ = "1.0.54"

pvsite_datamodel/sqlmodels.py

@@ -58,10 +58,17 @@ class UserSQL(Base, CreatedMixin):
         nullable=False,
         comment="The foreign key to the site_groups table",
     )
+    client_uuid = sa.Column(
+        UUID(as_uuid=True),
+        sa.ForeignKey("clients.client_uuid"),
+        nullable=True,
+        comment="The foreign key to the clients table",
+    )
 
     # Relationships
     site_group: Mapped["SiteGroupSQL"] = relationship("SiteGroupSQL", back_populates="users")
     api_request = relationship("APIRequestSQL", back_populates="user")
+    client: Mapped[Optional["ClientSQL"]] = relationship("ClientSQL", back_populates="users")
 
 
 class SiteGroupSQL(Base, CreatedMixin):
@@ -404,6 +411,13 @@ class ForecastValueSQL(Base, CreatedMixin):
         comment="The ML Model this forcast value belongs to",
     )
 
+    probabilistic_values = sa.Column(
+        JSONB,
+        nullable=False,
+        server_default=sa.text("'{}'"),  # Default to an empty JSON object
+        comment="Probabilistic forecast values, like p10, p50, p90",
+    )
+
     forecast: Mapped["ForecastSQL"] = relationship("ForecastSQL", back_populates="forecast_values")
     ml_model: Mapped[Optional[MLModelSQL]] = relationship(
         "MLModelSQL", back_populates="forecast_values"

pyproject.toml

@@ -7,7 +7,7 @@ readme = "README.md"
 
 [tool.poetry]
 name = "pvsite-datamodel"
-version = "1.0.53"
+version = "1.0.54"
 description = "SDK for interacting with the PVSite database"
 authors = ["Open Climate Fix"]
 readme = "README.md"

tests/read/test_get_latest_forecast_values.py

@@ -15,12 +15,14 @@ def _add_forecast_value(
     horizon_minutes: Optional[int] = None,
     created_utc: Optional[dt.datetime] = None,
     model_name: Optional[str] = None,
+    probabilistic_values: Optional[dict] = None,
 ):
     fv = ForecastValueSQL(
         forecast_uuid=forecast.forecast_uuid,
         forecast_power_kw=power,
         start_utc=ts,
         end_utc=ts + dt.timedelta(minutes=5),
+        probabilistic_values=probabilistic_values if probabilistic_values is not None else {},
     )
     if horizon_minutes:
         fv.forecast_horizon_minutes = horizon_minutes
@@ -367,3 +369,64 @@ def test_get_latest_forecast_values_model_name(db_session, sites):
     )
     assert len(latest_forecast) == 2
     assert len(latest_forecast[s1]) == 0
+
+
+def test_get_latest_forecast_values_probabilistic_value_limit2(db_session, sites):
+    # Retrieve two sites for testing (limit(2))
+    site_uuids = [site.site_uuid for site in db_session.query(SiteSQL.site_uuid).limit(2)]
+    site1, site2 = site_uuids
+
+    forecast_version = "123"
+
+    # Create a forecast for each site
+    forecast1 = ForecastSQL(
+        site_uuid=site1,
+        forecast_version=forecast_version,
+        timestamp_utc=dt.datetime(2000, 1, 1),
+    )
+    forecast2 = ForecastSQL(
+        site_uuid=site2,
+        forecast_version=forecast_version,
+        timestamp_utc=dt.datetime(2000, 1, 1),
+    )
+    db_session.add_all([forecast1, forecast2])
+    db_session.commit()
+
+    d0 = dt.datetime(2000, 1, 1, 0, tzinfo=dt.timezone.utc)
+
+    # For site1: Add a forecast value with explicit probabilistic_values provided
+    prob_values = {"p10": 10, "p50": 50, "p90": 90}
+    _add_forecast_value(
+        db_session, forecast1, power=1.0, ts=d0, horizon_minutes=0, probabilistic_values=prob_values
+    )
+
+    # For site2: Add a forecast value without providing probabilistic_values (defaults to {})
+    _add_forecast_value(
+        db_session,
+        forecast2,
+        power=2.0,
+        ts=d0,
+        horizon_minutes=0,
+    )
+
+    db_session.commit()
+
+    # Retrieve the latest forecast values starting from d0 for both sites
+    latest_forecast = get_latest_forecast_values_by_site(db_session, site_uuids, d0)
+
+    # Verify that forecast values exist for both sites
+    assert site1 in latest_forecast
+    assert site2 in latest_forecast
+    # Expect one forecast value for each site
+    assert len(latest_forecast[site1]) == 1
+    assert len(latest_forecast[site2]) == 1
+
+    # Retrieve the forecast values for each site
+    fv_site1 = latest_forecast[site1][0]
+    fv_site2 = latest_forecast[site2][0]
+
+    # Assert that site1's forecast value has the explicit probabilistic values provided
+    assert fv_site1.probabilistic_values == prob_values
+
+    # Assert that site2's forecast value uses the default (empty dictionary)
+    assert fv_site2.probabilistic_values == {}

tests/write/test_client.py

@@ -44,7 +44,8 @@ def test_assign_site_to_client(db_session):
 def test_assign_user_to_client(db_session):
     """Test to assign a user to a client"""
     user = create_user(
-        session=db_session, user_uuid="123e4567-e89b-12d3-a456-426614174000", user_name="Test User"
+        session=db_session,
+        email="test_user@ocf.org",
     )
 
     client = create_client(session=db_session, client_name="Test Client")

tests/write/test_forecast.py

@@ -35,6 +35,8 @@ def test_insert_forecast_for_existing_site(self, db_session, forecast_valid_inpu
         assert ptypes.is_datetime64_any_dtype(forecast_values_df["end_utc"])
         assert ptypes.is_numeric_dtype(forecast_values_df["forecast_power_kw"])
         assert ptypes.is_numeric_dtype(forecast_values_df["horizon_minutes"])
+        if "probabilistic_values" in forecast_values_df.columns:
+            assert forecast_values_df["probabilistic_values"].dtype == object
 
         insert_forecast_values(
             db_session,
@@ -47,6 +49,11 @@ def test_insert_forecast_for_existing_site(self, db_session, forecast_valid_inpu
         assert db_session.query(ForecastSQL).count() == 1
         assert db_session.query(ForecastValueSQL).count() == 10
 
+        for fv in db_session.query(ForecastValueSQL).all():
+            assert isinstance(fv.probabilistic_values, dict)
+            if "probabilistic_values" not in forecast_values_df.columns:
+                assert fv.probabilistic_values == {}
+
     def test_invalid_forecast_meta(self, db_session, forecast_with_invalid_meta_input):
         """Test function errors on invalid forecast metadata"""
         forecast_meta, forecast_values = forecast_with_invalid_meta_input