fix: populate results_sample when dbt sample_data is dict-shaped

[orenniapete]

Fixes #2269

Problem

The EDR report shows failure row counts but no example rows for dbt_test failures, even though rows exist in dbt_test__audit and test_result_rows.

Root cause

TestsAPI._get_test_result_from_test_result_db_row hard-cast sample_data to list. Some dbt-core / elementary-dbt-package version combinations (confirmed with dbt-core 1.11.5 + elementary 0.22.0 vs 0.24.0) return sample rows wrapped in a dict such as {"rows": [...]} instead of as a bare list. The cast silently produced None, leaving results_sample empty in the serialized report payload, so the report UI had nothing to render.

Fix

Added TestsAPI._normalize_results_sample() which handles both payload shapes:

• list → passed through unchanged (no behaviour change for existing users)
• dict with a known wrapper key (rows, sample_rows, results_sample, data) → the rows list is extracted

disable_samples is fully respected in both cases.

Files changed

File	Change
elementary/monitor/api/tests/tests.py	Add _normalize_results_sample(); replace hard cast(list) with it
tests/mocks/fetchers/tests_fetcher_mock.py	Add two mock dbt rows — one with list sample_data, one with dict sample_data
tests/unit/monitor/api/tests/test_tests_api.py	13 new tests covering the normalizer, result builder, and full serialization path

All 15 tests in the file pass.

Summary by CodeRabbit

• Bug Fixes

  • Enhanced test result sample data handling to support multiple input formats, fixing an issue where certain sample data was not properly displayed in test results.

• Tests

  • Added comprehensive test coverage for sample data normalization, including tests for multiple data format scenarios and edge cases.

[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: 3b8ef7b8-48c7-42f1-b11d-66cd87cf3bd7

📥 Commits

Reviewing files that changed from the base of the PR and between 9cc84dd and 0537d7b.

📒 Files selected for processing (3)

• elementary/monitor/api/tests/tests.py
• tests/mocks/fetchers/tests_fetcher_mock.py
• tests/unit/monitor/api/tests/test_tests_api.py

---

📝 Walkthrough

Walkthrough

This PR fixes issue #2269 by adding a _normalize_results_sample helper that handles sample_data payloads arriving in either list or dict-wrapped formats (with keys like rows, sample_rows, results_sample, or data). The fix is integrated into test result processing and covered by comprehensive unit and integration tests using mock data in both formats.

Changes

Sample Data Normalization

Layer / File(s)	Summary
Sample data normalization method and integration elementary/monitor/api/tests/tests.py	Adds _normalize_results_sample helper that accepts sample_data as a list or unwraps it from dict wrappers via recognized keys, returning None for unrecognized shapes. Integrates the helper into _get_test_result_from_test_result_db_row to replace direct casting, and removes the unused cast import from typing.
Unit and integration tests with mock data tests/mocks/fetchers/tests_fetcher_mock.py, tests/unit/monitor/api/tests/test_tests_api.py	Adds mock test rows with list-shaped and dict-wrapped sample_data formats; introduces _make_dbt_row helper for test construction; validates _normalize_results_sample behavior across list, dict, None, and unknown-dict cases; tests results_sample population and suppression in _get_test_result_from_test_result_db_row; includes end-to-end integration test verifying get_test_results output includes sample rows from dict-shaped payloads.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested reviewers

• ofek1weiss

Poem

🐰 A rabbit hops through dict and list,
Unwrapping samples never missed,
Rows and data, wrapped so tight,
Now normalized, all feeling right,
Sample data shines in test reports bright!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 52.94% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically describes the main change: fixing population of results_sample when dbt sample_data is in dict shape rather than list form.
Linked Issues check	✅ Passed	The PR directly addresses issue #2269 by adding normalization logic to handle both list and dict-shaped sample_data, restoring sample rows display in EDR reports as required.
Out of Scope Changes check	✅ Passed	All changes are directly scoped to fixing the sample_data handling issue: the normalizer function, mock test rows, and comprehensive unit tests all align with issue #2269 objectives.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.

---

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 and usage tips.}