Skip to content

fix: update log in DpathValidator #625

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 27, 2025
Merged

Conversation

pnilan
Copy link
Contributor

@pnilan pnilan commented Jun 27, 2025

What

  • Updates log for clarity and appropriate log level

Summary by CodeRabbit

  • Style
    • Updated log messages for validation to provide clearer information when a key is not found, and adjusted the log level from warning to info.

Important

Auto-merge enabled.

This PR is set to merge automatically when all requirements are met.

@github-actions github-actions bot added bug Something isn't working security labels Jun 27, 2025
@pnilan pnilan marked this pull request as ready for review June 27, 2025 22:14
@Copilot Copilot AI review requested due to automatic review settings June 27, 2025 22:14
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the log messages in DpathValidator for improved clarity and adjusts the log level from warning to info.

  • Change log level in except blocks from warning to info
  • Update log message text for both list and singular key error validations
Comments suppressed due to low confidence (2)

airbyte_cdk/sources/declarative/validators/dpath_validator.py:56

  • Switching the log level from warning to info reduces alert visibility. Please confirm that this change aligns with our error monitoring strategy to ensure key errors are adequately tracked in production.
                logger.info(f"Validation skipped. Key not found: {e}")

airbyte_cdk/sources/declarative/validators/dpath_validator.py:64

  • Switching the log level from warning to info reduces alert visibility. Please confirm that this change aligns with our error monitoring strategy to ensure key errors are adequately tracked in production.
                logger.info(f"Validation skipped. Key not found: {e}")

Copy link
Contributor

coderabbitai bot commented Jun 27, 2025

📝 Walkthrough

Walkthrough

The logging level for KeyError exceptions in the dpath_validator.py file was changed from warning to info, and the log message was updated to indicate that validation was skipped due to a missing key. The control flow and method behavior remain unchanged.

Changes

File(s) Change Summary
airbyte_cdk/sources/declarative/validators/dpath_validator.py Changed log level for KeyError from warning to info and updated the log message text.

Possibly related PRs

Suggested labels

airbyte-python-cdk

Would you like to consider these labels, or is there another you think fits better? Wdyt?

✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
airbyte_cdk/sources/declarative/validators/dpath_validator.py (1)

55-57: Consider downgrading to debug and deduplicating the log statement, wdyt?

KeyError is an entirely expected control-flow outcome when optional fields are absent; emitting it at info may add noise for users polling INFO logs. A debug level (or even silencing it) would still allow troubleshooting while keeping default logs clean.
Additionally, the identical message appears in both wildcard and non-wildcard branches—extracting it into a small helper (or logging once before early-returning) could DRY things up.

-                logger.info(f"Validation skipped. Key not found: {e}")
+                logger.debug("Validation skipped. Key not found: %s", e)

This change would also leverage the logger’s lazy string interpolation.
Happy to open a follow-up patch if you agree!

Also applies to: 63-65

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4629a12 and 270902a.

📒 Files selected for processing (1)
  • airbyte_cdk/sources/declarative/validators/dpath_validator.py (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: ChristoGrab
PR: airbytehq/airbyte-python-cdk#58
File: airbyte_cdk/sources/declarative/yaml_declarative_source.py:0-0
Timestamp: 2024-11-18T23:40:06.391Z
Learning: When modifying the `YamlDeclarativeSource` class in `airbyte_cdk/sources/declarative/yaml_declarative_source.py`, avoid introducing breaking changes like altering method signatures within the scope of unrelated PRs. Such changes should be addressed separately to minimize impact on existing implementations.
🧬 Code Graph Analysis (1)
airbyte_cdk/sources/declarative/validators/dpath_validator.py (3)
unit_tests/sources/declarative/validators/test_dpath_validator.py (1)
  • validate (18-22)
airbyte_cdk/sources/declarative/validators/validation_strategy.py (1)
  • validate (15-22)
airbyte_cdk/sources/declarative/validators/validator.py (1)
  • validate (11-18)
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: Check: source-pokeapi
  • GitHub Check: Check: source-amplitude
  • GitHub Check: Check: source-intercom
  • GitHub Check: Check: source-hardcoded-records
  • GitHub Check: Check: source-shopify
  • GitHub Check: Pytest (All, Python 3.10, Ubuntu)
  • GitHub Check: Pytest (All, Python 3.11, Ubuntu)
  • GitHub Check: SDM Docker Image Build
  • GitHub Check: Pytest (Fast)

@pnilan pnilan enabled auto-merge (squash) June 27, 2025 22:17
Copy link

PyTest Results (Fast)

3 676 tests  ±0   3 665 ✅ ±0   6m 25s ⏱️ ±0s
    1 suites ±0      11 💤 ±0 
    1 files   ±0       0 ❌ ±0 

Results for commit 270902a. ± Comparison against base commit 4629a12.

Copy link

PyTest Results (Full)

3 679 tests  ±0   3 668 ✅ ±0   17m 57s ⏱️ -5s
    1 suites ±0      11 💤 ±0 
    1 files   ±0       0 ❌ ±0 

Results for commit 270902a. ± Comparison against base commit 4629a12.

@pnilan pnilan merged commit 5824a5e into main Jun 27, 2025
29 checks passed
@pnilan pnilan deleted the pnilan/fix/dpathvalidator-log branch June 27, 2025 22:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working security
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant