refactor: deduplicate article payload serialization

[IceCodeNew]

Summary

• extract one stateless article payload serializer with a stable dict return type
• reuse it for new, deferred, and historical article groups
• preserve historical filtering, field names, and article order with direct regression coverage

Validation

• focused service tests: 32 passed
• full branch coverage: 561 passed; misses remain 15 and partials remain 7
• prek run --all-files passed
• CodeRabbit CLI review completed with no findings

Summary by CodeRabbit

• Refactor

  • Improved consistency in how briefing articles are serialized across new, deferred, and historical article sections.
  • Preserved existing article details, including publication timestamps and verbatim status.

• Tests

  • Added coverage verifying consistent article serialization and correct filtering of historical articles.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f1f4210d-a0a2-44d0-a6fa-ba2e768f51da

📥 Commits

Reviewing files that changed from the base of the PR and between 2cacd43 and 4bedff8.

📒 Files selected for processing (2)

• tests/test_service.py
• weather_briefing/service.py

---

📝 Walkthrough

Walkthrough

Article payload serialization is centralized in a private helper, and _build_payload uses it for new, deferred, and historical articles. Parametrized tests verify serialized fields, timestamp formatting, verbatim flags, and historical article filtering.

Changes

Article payload serialization

Layer / File(s)	Summary
Article serialization helper weather_briefing/service.py	Adds _serialize_article to produce the standardized article dictionary, including ISO-formatted publication timestamps and the verbatim flag.
Payload integration and validation weather_briefing/service.py, tests/test_service.py	Uses the helper for new, deferred, and eligible historical articles; adds parametrized coverage for serialized fields and historical ID filtering.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: consolidating duplicate article payload serialization logic.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch codex/deduplicate-article-payload

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.64%. Comparing base (2cacd43) to head (4bedff8).
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@           Coverage Diff           @@
##           master      #45   +/-   ##
=======================================
  Coverage   99.63%   99.64%           
=======================================
  Files          38       38           
  Lines        6092     6115   +23     
  Branches      331      331           
=======================================
+ Hits         6070     6093   +23     
  Misses         15       15           
  Partials        7        7           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

[IceCodeNew]

/config

[IceCodeNew]

/agentic_review

[qodo-code-review]

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

[qodo-code-review]

PR Summary by Qodo

Deduplicate article payload serialization via shared serializer + regression test

✨ Enhancement 🧪 Tests 🕐 10-20 Minutes

AI Description

• Extract shared article-to-dict serializer for consistent payload structure across article groups.
• Reuse serializer for new, deferred, and historical articles while preserving historical filtering.
• Add regression test covering stable fields, ordering, and briefing vs forecast inclusion.

Diagram

graph TD
  Tests["tests/test_service.py"] --> Svc["BriefingService._build_payload"] --> Ser["_serialize_article()"] --> Payload["Briefing payload dict"] --> LLM["LLMProvider.parse_result"]
  Article["Article model"] --> Ser["_serialize_article()"]
  Svc["BriefingService._build_payload"] --> HistFilter["Historical filter (verbatim/forecast)"] --> Payload["Briefing payload dict"]

Loading

High-Level Assessment

The following are alternative approaches to this PR:

1. Move serializer onto the Article model (e.g., Article.to_payload_dict)

• ➕ Keeps serialization close to the data shape and discoverable for reuse
• ➕ Avoids service module accumulating formatting helpers
• ➖ Couples domain model to a specific external payload contract
• ➖ Harder to vary output shape per consumer without additional parameters

2. Introduce a TypedDict (or protocol) for the serialized payload shape

• ➕ Stronger static guarantees around field names and value types
• ➕ Makes the payload contract explicit for future changes
• ➖ More typing boilerplate for a small helper
• ➖ Doesn’t materially change runtime behavior; mostly improves maintainability

Recommendation: The extracted stateless helper in the service module is a good fit for this PR’s goal: deduplicate logic while preserving the existing payload contract and historical filtering semantics. If additional consumers of the same serialization emerge, consider promoting the dict shape to a TypedDict to lock the contract down further; moving the serializer onto the Article model is less desirable unless the payload format becomes a true domain-level concern.

Files changed (2) +77 / -33

Refactor (1) +15 / -33

service.pyExtract and reuse shared article payload serializer in _build_payload +15/-33

Extract and reuse shared article payload serializer in _build_payload

• Introduces a single _serialize_article(Article) helper that returns a stable dict payload shape. Replaces duplicated inline dict comprehensions for new, deferred, and historical articles with the helper while retaining the historical filter condition.

weather_briefing/service.py

Tests (1) +62 / -0

test_service.pyAdd regression coverage for consistent article group serialization +62/-0

Add regression coverage for consistent article group serialization

• Adds a parametrized unit test that builds a payload for both briefing and forecast modes and asserts that new, deferred, and historical article groups serialize to the same dict shape. The test also verifies that historical inclusion rules differ by mode (verbatim-only for briefing; all for forecast) while preserving ordering.

tests/test_service.py

[qodo-code-review]

Code review by qodo was updated up to the latest commit 4bedff8