fix: create placeholder metrics for failed legacy->cloud translations#15
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughMetrics migration now recovers from MAQL transformation failures by generating placeholder MAQL, tagging affected metrics as errors, and adding tests and fixtures for an unresolved-identifier case. The coding standards header also now uses a year placeholder. ChangesPlaceholder MAQL error handling
Estimated code review effort: 3 (Moderate) | ~20 minutes Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
src/gooddata_legacy2cloud/metrics/utils.py (1)
44-59: 📐 Maintainability & Code Quality | 🔵 TrivialDocstring missing Args/Returns sections.
build_placeholder_maqlis a new public helper (used cross-module bycloud_metric.py) but its docstring omits theArgs/Returnssections mandated for public APIs.📝 Suggested docstring
""" - Comments out the original MAQL, optionally appends a labeled note, and adds a - SQRT(-1) placeholder expression so the metric can still be created in Cloud. + Comments out the original MAQL, optionally appends a labeled note, and adds a + SQRT(-1) placeholder expression so the metric can still be created in Cloud. + + Args: + original_maql: The Legacy MAQL expression that could not be translated. + extra_message: Optional additional note (e.g. exception text) to include. + error_label: Label to prefix `extra_message` with. Ignored if falsy. + + Returns: + The commented-out placeholder MAQL string. """As per coding guidelines, "Public APIs (entry points and Builder methods) must use Google-style docstrings with Args, Returns, and Raises sections."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/gooddata_legacy2cloud/metrics/utils.py` around lines 44 - 59, The public helper build_placeholder_maql is missing the required Google-style docstring sections. Update its docstring in utils.py to include clear Args and Returns entries for original_maql, extra_message, and error_label, and describe the returned placeholder MAQL string; keep the existing behavior unchanged and make the docstring consistent with other public APIs used by cloud_metric.py.Source: Coding guidelines
src/gooddata_legacy2cloud/metrics/cloud_metric.py (1)
92-97: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winException logged without traceback.
logger.error("Metric '%s': %s", self.meta["title"], e)drops the stack trace, making it harder to diagnose why a legacy MAQL transformation failed in production. Uselogger.exception(...)(or passexc_info=True) inside theexceptblock to retain the traceback.♻️ Suggested fix
- logger.error("Metric '%s': %s", self.meta["title"], e) + logger.exception("Metric '%s': %s", self.meta["title"], e)🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/gooddata_legacy2cloud/metrics/cloud_metric.py` around lines 92 - 97, The exception handling in the cloud metric transformation path logs the failure without a traceback. Update the except block in the CloudMetric transformation flow to use logger.exception or logger.error with exc_info=True so the stack trace is preserved when legacy MAQL transformation fails. Keep the existing context from self.meta["title"] and the caught exception, but ensure the logger call in this error path records full exception details.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/gooddata_legacy2cloud/metrics/utils.py`:
- Around line 79-94: The MAQL error handling in metrics/utils.py assumes
json.loads(error_response.text) always returns an object, but valid JSON can
also be a string, number, or list, causing .get("detail", ...) to fail. Update
the error parsing in the build_placeholder_maql path to verify the parsed value
is a dict before reading detail, and otherwise fall back to the raw response
text. Add coverage around the error_response handling to include a non-object
JSON body so the behavior stays stable.
---
Nitpick comments:
In `@src/gooddata_legacy2cloud/metrics/cloud_metric.py`:
- Around line 92-97: The exception handling in the cloud metric transformation
path logs the failure without a traceback. Update the except block in the
CloudMetric transformation flow to use logger.exception or logger.error with
exc_info=True so the stack trace is preserved when legacy MAQL transformation
fails. Keep the existing context from self.meta["title"] and the caught
exception, but ensure the logger call in this error path records full exception
details.
In `@src/gooddata_legacy2cloud/metrics/utils.py`:
- Around line 44-59: The public helper build_placeholder_maql is missing the
required Google-style docstring sections. Update its docstring in utils.py to
include clear Args and Returns entries for original_maql, extra_message, and
error_label, and describe the returned placeholder MAQL string; keep the
existing behavior unchanged and make the docstring consistent with other public
APIs used by cloud_metric.py.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 973919f5-dcbb-4c75-8c9e-8ed580b7f5ab
📒 Files selected for processing (7)
src/gooddata_legacy2cloud/metrics/cloud_metric.pysrc/gooddata_legacy2cloud/metrics/utils.pytests/data/metrics/legacy_objects/objects_by_uri.jsontests/data/metrics/test_cases/with_unresolved_identifier_cloud.jsontests/data/metrics/test_cases/with_unresolved_identifier_legacy.jsontests/test_metrics.pytests/test_metrics_utils.py
… to Cloud JIRA: SVS-1335
janmatzek
force-pushed
the
jmat/SVS-1335-metrics-migration-omits-to-create-metrics-in-cloud-it-does-not-create-error-sqrt-1-placeholder-for-some-cases-with-computed-attributes
branch
from
163034d to
fa75f62
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
tests/test_metrics_utils.py (1)
16-143: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winAdd return type hints to test functions.
None of the test functions declare a return type annotation. As per coding guidelines, "Add comprehensive type hints to all new Python code, including parameter types, return types, and class attributes" applies to all new Python code, including tests.
♻️ Example fix pattern
-def test_comment_out_lines_prefixes_every_line(): +def test_comment_out_lines_prefixes_every_line() -> None: assert comment_out_lines("first line\nsecond line") == "`#first` line\n#second line"Apply the same
-> Noneannotation to all other test functions in this file.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@tests/test_metrics_utils.py` around lines 16 - 143, The test functions in this module are missing return type annotations, so update each test such as test_comment_out_lines_prefixes_every_line, test_build_placeholder_maql_without_extra_message, and the other test_* functions to explicitly declare a None return type. Keep the existing assertions unchanged and apply the same -> None annotation consistently across all test functions in the file.Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@tests/test_metrics_utils.py`:
- Line 1: The Python file header year is incorrect, so update the first-line
copyright notice to match the required GoodData standard. Replace the existing
`# (C) 2026 GoodData Corporation` header with the literal `# (C) 2025 GoodData
Corporation` at the top of `tests/test_metrics_utils.py`, keeping it as the
first line of the file.
---
Nitpick comments:
In `@tests/test_metrics_utils.py`:
- Around line 16-143: The test functions in this module are missing return type
annotations, so update each test such as
test_comment_out_lines_prefixes_every_line,
test_build_placeholder_maql_without_extra_message, and the other test_*
functions to explicitly declare a None return type. Keep the existing assertions
unchanged and apply the same -> None annotation consistently across all test
functions in the file.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 7467e9a2-635b-4178-b6d5-af1affede70c
📒 Files selected for processing (7)
src/gooddata_legacy2cloud/metrics/cloud_metric.pysrc/gooddata_legacy2cloud/metrics/utils.pytests/data/metrics/legacy_objects/objects_by_uri.jsontests/data/metrics/test_cases/with_unresolved_identifier_cloud.jsontests/data/metrics/test_cases/with_unresolved_identifier_legacy.jsontests/test_metrics.pytests/test_metrics_utils.py
✅ Files skipped from review due to trivial changes (3)
- tests/data/metrics/test_cases/with_unresolved_identifier_legacy.json
- tests/data/metrics/legacy_objects/objects_by_uri.json
- tests/test_metrics.py
🚧 Files skipped from review as they are similar to previous changes (3)
- tests/data/metrics/test_cases/with_unresolved_identifier_cloud.json
- src/gooddata_legacy2cloud/metrics/cloud_metric.py
- src/gooddata_legacy2cloud/metrics/utils.py
JIRA: trivial
Tomkess
approved these changes
Jul 3, 2026
janmatzek
deleted the
jmat/SVS-1335-metrics-migration-omits-to-create-metrics-in-cloud-it-does-not-create-error-sqrt-1-placeholder-for-some-cases-with-computed-attributes
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
JIRA: SVS-1335
Summary by CodeRabbit
SELECT SQRT(-1)) so migration can proceed.{year}placeholder.