fix: swallow "no data today" 404/409 in changed-* endpoints

Author: Julian Kath

src/stats_can/scwds.py

@@ -139,13 +139,24 @@ def get_changed_cube_list(date: dt.date | None = None) -> list[ChangedCube]:
     Returns
     -------
     :
-        list of changed cubes, one for each table and when it was updated
+        list of changed cubes, one for each table and when it was updated.
+        Returns an empty list when ``date`` is the current day but the daily
+        release window has not opened yet (the API returns HTTP 409 in that
+        case). HTTP 404 (e.g. for a future ``date``) is propagated as it
+        indicates a caller error.
     """
     if date is None:
         date = dt.date.today()
-    return _fetch_and_validate(
-        url=f"{SC_URL}getChangedCubeList/{date}", schema=list[ChangedCube]
-    )
+    try:
+        return _fetch_and_validate(
+            url=f"{SC_URL}getChangedCubeList/{date}", schema=list[ChangedCube]
+        )
+    except requests.HTTPError as exc:
+        # 409 means "today's release window hasn't opened yet" -- a normal
+        # condition, not an error. 404 (future date) is still a real error.
+        if exc.response is not None and exc.response.status_code == 409:
+            return []
+        raise
 
 
 def get_cube_metadata(tables: str | list[str]) -> list[CubeMetadata]:
@@ -245,7 +256,11 @@ def get_changed_series_data_from_cube_pid_coord(
     -------
     :
         One :class:`VectorData` per requested pair, in the order returned
-        by the API.
+        by the API. Returns an empty list when none of the requested pairs
+        have changes today (the API returns HTTP 404 in that case). Note
+        that the API does not distinguish "valid pair but unchanged" from
+        "invalid pair" -- both produce a 404. Use
+        :func:`get_series_info_from_cube_pid_coord` to validate a pair.
     """
     if isinstance(pairs, tuple):
         pairs = [pairs]
@@ -257,9 +272,14 @@ def get_changed_series_data_from_cube_pid_coord(
         }
         for product_id, coord in pairs
     ]
-    return _post_in_chunks(
-        f"{SC_URL}getChangedSeriesDataFromCubePidCoord", body, VectorData
-    )
+    try:
+        return _post_in_chunks(
+            f"{SC_URL}getChangedSeriesDataFromCubePidCoord", body, VectorData
+        )
+    except requests.HTTPError as exc:
+        if exc.response is not None and exc.response.status_code == 404:
+            return []
+        raise
 
 
 def get_changed_series_data_from_vector(
@@ -275,10 +295,22 @@ def get_changed_series_data_from_vector(
     Returns
     -------
     :
-        List of dicts containing changed data for each vector
+        List of dicts containing changed data for each vector. Returns an
+        empty list when none of the requested vectors have changes today
+        (the API returns HTTP 404 in that case). Note that the API does not
+        distinguish "valid vector but unchanged" from "invalid vector" --
+        both produce a 404. Use :func:`get_series_info_from_vector` to
+        validate a vector id.
     """
     body = [{"vectorId": v} for v in parse_vectors(vectors)]
-    return _post_in_chunks(f"{SC_URL}getChangedSeriesDataFromVector", body, VectorData)
+    try:
+        return _post_in_chunks(
+            f"{SC_URL}getChangedSeriesDataFromVector", body, VectorData
+        )
+    except requests.HTTPError as exc:
+        if exc.response is not None and exc.response.status_code == 404:
+            return []
+        raise
 
 
 def get_data_from_cube_pid_coord_and_latest_n_periods(

tests/test_error_handling.py

@@ -408,6 +408,22 @@ def test_chunks_large_input(self):
             scwds.get_changed_series_data_from_cube_pid_coord(pairs)
         assert mocked.call_count == 2
 
+    def test_404_returns_empty_list(self):
+        """HTTP 404 ("no changes today" or invalid pair) should yield ``[]``."""
+        err_resp = MagicMock(spec=requests.Response)
+        err_resp.status_code = 404
+        mock_resp = _mock_response(
+            status_code=404,
+            raise_for_status=requests.exceptions.HTTPError(
+                "404 Not Found", response=err_resp
+            ),
+        )
+        with patch.object(scwds._session, "request", return_value=mock_resp):
+            result = scwds.get_changed_series_data_from_cube_pid_coord(
+                ("35100003", "1.12")
+            )
+        assert result == []
+
 
 class TestGetChangedSeriesDataFromVector:
     """Tests for get_changed_series_data_from_vector."""
@@ -452,6 +468,52 @@ def test_chunks_large_input(self):
             scwds.get_changed_series_data_from_vector(vectors)
         assert mocked.call_count == 2
 
+    def test_404_returns_empty_list(self):
+        """HTTP 404 ("no changes today" or invalid vector) should yield ``[]``."""
+        err_resp = MagicMock(spec=requests.Response)
+        err_resp.status_code = 404
+        mock_resp = _mock_response(
+            status_code=404,
+            raise_for_status=requests.exceptions.HTTPError(
+                "404 Not Found", response=err_resp
+            ),
+        )
+        with patch.object(scwds._session, "request", return_value=mock_resp):
+            result = scwds.get_changed_series_data_from_vector("v32164132")
+        assert result == []
+
+
+class TestGetChangedCubeList:
+    """Tests for get_changed_cube_list status-code handling."""
+
+    def test_409_returns_empty_list(self):
+        """HTTP 409 (release window not open yet) should yield ``[]``."""
+        err_resp = MagicMock(spec=requests.Response)
+        err_resp.status_code = 409
+        mock_resp = _mock_response(
+            status_code=409,
+            raise_for_status=requests.exceptions.HTTPError(
+                "409 Conflict", response=err_resp
+            ),
+        )
+        with patch.object(scwds._session, "request", return_value=mock_resp):
+            result = scwds.get_changed_cube_list()
+        assert result == []
+
+    def test_404_propagates(self):
+        """HTTP 404 (e.g. future date) is a caller error and should raise."""
+        err_resp = MagicMock(spec=requests.Response)
+        err_resp.status_code = 404
+        mock_resp = _mock_response(
+            status_code=404,
+            raise_for_status=requests.exceptions.HTTPError(
+                "404 Not Found", response=err_resp
+            ),
+        )
+        with patch.object(scwds._session, "request", return_value=mock_resp):
+            with pytest.raises(requests.exceptions.HTTPError):
+                scwds.get_changed_cube_list()
+
 
 class TestGetDataFromCubePidCoordAndLatestNPeriods:
     """Tests for get_data_from_cube_pid_coord_and_latest_n_periods."""

tests/test_scwds.py

@@ -90,20 +90,43 @@ def test_gsifv():
 
 
 def test_gcsdfcpc():
-    """Test get changed series data from cube pid coord."""
+    """Test get changed series data from cube pid coord.
+
+    The API returns data only for series that changed today, so this may
+    legitimately come back empty.
+    """
     r = stats_can.scwds.get_changed_series_data_from_cube_pid_coord(
         ("35100003", "1.12")
     )
     assert isinstance(r, list)
-    assert len(r) == 1
-    assert r[0]["productId"] == 35100003
+    if r:
+        assert r[0]["productId"] == 35100003
+
+
+def test_gcsdfcpc_invalid_pair():
+    """Invalid (productId, coordinate) pairs return [] (the API does not
+    distinguish them from valid-but-unchanged pairs -- both come back as 404).
+    """
+    r = stats_can.scwds.get_changed_series_data_from_cube_pid_coord(("99999999", "1"))
+    assert r == []
 
 
 def test_gcsdfv():
-    """Test get get changed series data from vector."""
+    """Test get get changed series data from vector.
+
+    The API returns data only for vectors that changed today, so this may
+    legitimately come back empty.
+    """
     r = stats_can.scwds.get_changed_series_data_from_vector(v)
     assert isinstance(r, list)
-    assert len(r) == 1
+
+
+def test_gcsdfv_invalid_vector():
+    """Invalid vector ids return [] (the API does not distinguish them
+    from valid-but-unchanged vectors -- both come back as 404).
+    """
+    r = stats_can.scwds.get_changed_series_data_from_vector("9")
+    assert r == []
 
 
 def test_gdfcpcalnp():