Added dynamic version to DefaultDERControl

Author: joshvote

src/envoy/admin/manager/config.py

@@ -110,7 +110,7 @@ async def update_site_control_default(session: AsyncSession, site_id: int, reque
             return False
 
         if site.default_site_control is None:
-            site.default_site_control = DefaultSiteControl(changed_time=now, site_id=site.site_id)
+            site.default_site_control = DefaultSiteControl(changed_time=now, site_id=site.site_id, version=0)
         else:
             site.default_site_control.changed_time = now
 
@@ -134,6 +134,7 @@ async def update_site_control_default(session: AsyncSession, site_id: int, reque
             )
             site.default_site_control.ramp_rate_percent_per_second = ramp_rate_value
 
+        site.default_site_control.version = site.default_site_control.version + 1
         await session.commit()
 
         await NotificationManager.notify_changed_deleted_entities(SubscriptionResource.DEFAULT_SITE_CONTROL, now)

src/envoy/server/alembic/versions/29a83be2701e_added_defaultsitecontrol_version.py

@@ -0,0 +1,32 @@
+"""added_defaultsitecontrol_version
+
+Revision ID: 29a83be2701e
+Revises: 8ca240a5d8f3
+Create Date: 2025-12-01 15:14:36.070394
+
+"""
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "29a83be2701e"
+down_revision = "8ca240a5d8f3"
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column(
+        "archive_default_site_control", sa.Column("version", sa.INTEGER(), server_default="0", nullable=False)
+    )
+    op.add_column("default_site_control", sa.Column("version", sa.INTEGER(), server_default="0", nullable=False))
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("default_site_control", "version")
+    op.drop_column("archive_default_site_control", "version")
+    # ### end Alembic commands ###

src/envoy/server/manager/derp.py

@@ -258,6 +258,7 @@ def _prefer_left(left: Any, right: Any) -> Any:
 
         if default_site_control is not None:
             return DefaultSiteControl(
+                version=default_site_control.version,
                 import_limit_active_watts=_prefer_left(
                     default_site_control.import_limit_active_watts, default_doe.import_limit_active_watts
                 ),
@@ -275,6 +276,7 @@ def _prefer_left(left: Any, right: Any) -> Any:
                 ),
             )
         return DefaultSiteControl(
+            version=0,
             import_limit_active_watts=default_doe.import_limit_active_watts,
             export_limit_active_watts=default_doe.export_limit_active_watts,
             generation_limit_active_watts=default_doe.generation_limit_active_watts,

src/envoy/server/mapper/csip_aus/doe.py

@@ -161,6 +161,7 @@ def map_to_default_response(
 
         return DefaultDERControl(
             href=DERControlMapper.default_control_href(scope, display_site_id, der_program_id),
+            version=default_doe.version,
             subscribable=SubscribableType.resource_supports_non_conditional_subscriptions,
             mRID=MridMapper.encode_default_doe_mrid(scope),
             setGradW=default_doe.ramp_rate_percent_per_second,

src/envoy/server/model/archive/site.py

@@ -225,6 +225,8 @@ class ArchiveDefaultSiteControl(ArchiveBase):
     created_time: Mapped[datetime] = mapped_column(DateTime(timezone=True))
     changed_time: Mapped[datetime] = mapped_column(DateTime(timezone=True))
 
+    version: Mapped[int] = mapped_column(INTEGER, server_default="0")  # Incremented whenever this record is changed
+
     import_limit_active_watts: Mapped[Optional[Decimal]] = mapped_column(
         DECIMAL(16, original_models.site.DOE_DECIMAL_PLACES), nullable=True
     )  # Constraint on imported active power

src/envoy/server/model/site.py

@@ -401,6 +401,8 @@ class DefaultSiteControl(Base):
     )  # When this record was created
     changed_time: Mapped[datetime] = mapped_column(DateTime(timezone=True), index=True)
 
+    version: Mapped[int] = mapped_column(INTEGER, server_default="0")  # Incremented whenever this record is changed
+
     import_limit_active_watts: Mapped[Optional[Decimal]] = mapped_column(
         DECIMAL(16, DOE_DECIMAL_PLACES), nullable=True
     )  # Constraint on imported active power

tests/integration/admin/test_config.py

@@ -17,9 +17,10 @@
 )
 from envoy_schema.admin.schema.uri import ServerConfigRuntimeUri, SiteControlDefaultConfigUri
 from httpx import AsyncClient
-from sqlalchemy import delete
+from sqlalchemy import delete, select
 
 from envoy.server.model.server import RuntimeServerConfig
+from envoy.server.model.site import DefaultSiteControl
 from tests.integration.response import read_response_body_string
 
 
@@ -112,8 +113,19 @@ async def test_get_update_server_config(admin_client_auth: AsyncClient, pg_base_
 )
 @pytest.mark.anyio
 async def test_get_and_update_site_control_default(
-    admin_client_auth: AsyncClient, site_id: int, expected: Optional[tuple]
+    pg_base_config,
+    admin_client_auth: AsyncClient,
+    site_id: int,
+    expected: Optional[tuple],
 ):
+    version_before = 0
+    async with generate_async_session(pg_base_config) as session:
+        db_record = (
+            await session.execute(select(DefaultSiteControl).where(DefaultSiteControl.site_id == site_id))
+        ).scalar_one_or_none()
+        if db_record:
+            version_before = db_record.version
+
     resp = await admin_client_auth.get(SiteControlDefaultConfigUri.format(site_id=site_id))
     if expected is None:
         assert resp.status_code == HTTPStatus.NOT_FOUND
@@ -161,3 +173,10 @@ async def test_get_and_update_site_control_default(
             config.server_default_generation_limit_watts,
             config.server_default_load_limit_watts,
         )
+
+        # Version number in the DB should be getting updated
+        async with generate_async_session(pg_base_config) as session:
+            db_record = (
+                await session.execute(select(DefaultSiteControl).where(DefaultSiteControl.site_id == site_id))
+            ).scalar_one()
+            assert db_record.version == version_before + 1, "The version field should be updated per update"

tests/unit/admin/manager/test_config.py

@@ -44,6 +44,11 @@ async def test_update_site_control_default_all_vals_update(
     control_request: ControlDefaultRequest,
 ):
     """Tests that the values for existing/new control defaults can be correctly updated"""
+    async with generate_async_session(pg_base_config) as session:
+        version_before = (
+            await session.execute(select(DefaultSiteControl.version).where(DefaultSiteControl.site_id == site_id))
+        ).scalar_one()
+
     async with generate_async_session(pg_base_config) as session:
         await ConfigManager.update_site_control_default(session, site_id, control_request)
 
@@ -56,5 +61,6 @@ async def test_update_site_control_default_all_vals_update(
         assert saved_result.generation_limit_active_watts == control_request.generation_limit_watts.value
         assert saved_result.load_limit_active_watts == control_request.load_limit_watts.value
         assert saved_result.ramp_rate_percent_per_second == control_request.ramp_rate_percent_per_second.value
+        assert saved_result.version == version_before + 1, "This should be incremented as part of the update"
 
     mock_notify_changed_deleted_entities.assert_called_once()

tests/unit/server/manager/test_derp.py

@@ -628,24 +628,24 @@ async def test_fetch_default_doe_controls_for_site_no_global_default(
         (None, None, None),
         (
             DefaultDoeConfiguration(100, 200, 300, 400, 50),
-            DefaultSiteControl(import_limit_active_watts=0, load_limit_active_watts=0),
-            (0, 200, 300, 0, 50),
+            DefaultSiteControl(import_limit_active_watts=0, load_limit_active_watts=0, version=999),
+            (999, 0, 200, 300, 0, 50),
         ),
         (
             DefaultDoeConfiguration(None, 200, 300, None, 50),
-            DefaultSiteControl(import_limit_active_watts=0, load_limit_active_watts=0),
-            (0, 200, 300, 0, 50),
+            DefaultSiteControl(import_limit_active_watts=0, load_limit_active_watts=0, version=888),
+            (888, 0, 200, 300, 0, 50),
         ),
         (
             DefaultDoeConfiguration(None, None, None, None, None),
-            DefaultSiteControl(import_limit_active_watts=0, load_limit_active_watts=0),
-            (0, None, None, 0, None),
+            DefaultSiteControl(import_limit_active_watts=0, load_limit_active_watts=0, version=777),
+            (777, 0, None, None, 0, None),
         ),
         # No site control
         (
             DefaultDoeConfiguration(100, 200, 300, 400, 50),
             None,
-            (100, 200, 300, 400, 50),
+            (0, 100, 200, 300, 400, 50),
         ),
         # Partial site control
         (
@@ -656,8 +656,8 @@ async def test_fetch_default_doe_controls_for_site_no_global_default(
                 load_limit_active_watts=400,
                 ramp_rate_percent_per_second=50,
             ),
-            DefaultSiteControl(import_limit_active_watts=111, load_limit_active_watts=444),
-            (111, 200, 300, 444, 50),
+            DefaultSiteControl(import_limit_active_watts=111, load_limit_active_watts=444, version=555),
+            (555, 111, 200, 300, 444, 50),
         ),
         # Full site control
         (
@@ -674,8 +674,9 @@ async def test_fetch_default_doe_controls_for_site_no_global_default(
                 generation_limit_active_watts=3,
                 load_limit_active_watts=4,
                 ramp_rate_percent_per_second=5,
+                version=6,
             ),
-            (1, 2, 3, 4, 5),
+            (6, 1, 2, 3, 4, 5),
         ),
         (
             None,
@@ -685,8 +686,9 @@ async def test_fetch_default_doe_controls_for_site_no_global_default(
                 generation_limit_active_watts=3,
                 load_limit_active_watts=4,
                 ramp_rate_percent_per_second=5,
+                version=7,
             ),
-            (1, 2, 3, 4, 5),
+            (7, 1, 2, 3, 4, 5),
         ),
     ],
 )
@@ -697,8 +699,9 @@ def test_resolve_default_site_control(default_doe_config, default_site_control,
     if expected is None:
         assert result is None
     else:
-        assert result.import_limit_active_watts == expected[0]
-        assert result.export_limit_active_watts == expected[1]
-        assert result.generation_limit_active_watts == expected[2]
-        assert result.load_limit_active_watts == expected[3]
-        assert result.ramp_rate_percent_per_second == expected[4]
+        assert result.version == expected[0]
+        assert result.import_limit_active_watts == expected[1]
+        assert result.export_limit_active_watts == expected[2]
+        assert result.generation_limit_active_watts == expected[3]
+        assert result.load_limit_active_watts == expected[4]
+        assert result.ramp_rate_percent_per_second == expected[5]

tests/unit/server/mapper/csip_aus/test_doe.py

@@ -177,6 +177,7 @@ def test_map_default_to_response(optional_is_none: bool):
     assert result.href.startswith("/my/prefix/")
     assert f"/{site_id}/" in result.href
     assert f"/{derp_id}/" in result.href
+    assert result.version == doe_default.version
 
     if doe_default.export_limit_active_watts is None:
         assert result.DERControlBase_.opModExpLimW is None