fix(SinkStatus): make finalized filters perfect negations of each other

Author: aolieman

sc_audit/views/sink_status.py

@@ -9,7 +9,7 @@
 from typing import Any, Literal
 
 import pandas as pd
-from sqlalchemy import Select, or_, select
+from sqlalchemy import Select, exists, not_, select
 from sqlalchemy.orm import contains_eager, selectinload
 
 from sc_audit.db_schema.association import SinkStatus
@@ -90,13 +90,17 @@ def construct_stx_query(
         before_dt = dt.datetime(before_date.year, before_date.month, before_date.day)
         q_txs = q_txs.where(SinkingTx.created_at < before_dt)
 
-    if finalized is not None:
-        q_txs = q_txs.outerjoin(SinkStatus)
     if finalized is False:
-        # not_ and in_ do not work here because NULL and false are treated differently
-        q_txs = q_txs.where(or_(SinkStatus.finalized == None, SinkStatus.finalized == False))
+        # filter on sink txs without any SinkStatus with finalized=True
+        # this clause needs to be the perfect negation of `finalized is True`
+        q_txs = q_txs.where(
+            not_(exists().where(
+                SinkStatus.sinking_tx_hash == SinkingTx.hash, SinkStatus.finalized == True
+            ).correlate(SinkingTx))
+        )
     elif finalized is True:
-        q_txs = q_txs.where(SinkStatus.finalized == True)
+        # select sink txs that have at least one SinkStatus with finalized=True
+        q_txs = q_txs.outerjoin(SinkStatus).where(SinkStatus.finalized == True)
 
     return q_txs
 

tests/test_views.py

@@ -125,7 +125,9 @@ def test_construct_query_finalized(self):
             before_date=None,
             finalized=False
         )
-        assert "WHERE sink_status.finalized IS NULL OR sink_status.finalized = false" in str(stxq)
+        assert str(stxq).replace(' \n', '').endswith(
+            "WHERE NOT (EXISTS (SELECT *FROM sink_statusWHERE sink_status.sinking_tx_hash = sinking_txs.hash AND sink_status.finalized = true))"
+        )
 
 
 class TestSinkStatusView:
@@ -174,10 +176,13 @@ def test_sink_status_finalized_true(self, mock_session_with_associations):
 
     def test_sink_status_finalized_false(self, mock_session_with_associations):
         txdf = sink_status_view.view_sinking_txs(finalized=False)
-        assert len(txdf) == 2
+        assert len(txdf) == 3
         assert txdf.statuses.map(add_amount_filled).sum() == Decimal('1.985')
-        assert txdf.carbon_amount.sum() == Decimal('3.298')
-        assert not any(txdf.statuses.astype(bool))
+        assert txdf.carbon_amount.sum() == Decimal('5.283')
+        # expect the last tx to have a sink status with finalized=False
+        assert len(txdf[txdf.statuses.astype(bool) == True]) == 1
+        assert len(txdf.statuses.iloc[-1]) == 1
+        assert txdf.statuses.iloc[-1][0]['finalized'] == False
 
     def test_sink_status_pagination_asc(self, mock_session_with_associations):
         txdf = sink_status_view.view_sinking_txs(limit=2, order='asc')