chore: reorder inject_into in RequestOption and fix title, description, and defaults in refresh_token_updater #635

lmossman · 2025-07-02T18:36:22Z

Inject Into should be above field name/path, as this makes more conceptual sense in the UI.

I also changed some of the titles, descriptions, and default values in refresh_token_updater to better match what the user should expect in the UI

Summary by CodeRabbit

Refactor
- Updated terminology and descriptions related to token refresh functionality for clarity.
- Simplified default token path configurations by removing redundant prefixes.
- Reorganized request option settings for improved schema consistency.

Copilot

Pull Request Overview

This PR reorders the inject_into property in the RequestOption schema to appear above field_name, making the UI presentation more intuitive. It also removes a duplicate inject_into block elsewhere in the definitions.

Moved the inject_into block to be directly above field_name in the RequestOption definition.
Removed a redundant inject_into entry further down in the schema.

Comments suppressed due to low confidence (2)

airbyte_cdk/sources/declarative/declarative_component_schema.yaml:3421

[nitpick] Consider adding a default value for inject_into to maintain backward compatibility for consumers who don’t explicitly set it.

      inject_into:

airbyte_cdk/sources/declarative/declarative_component_schema.yaml:3434

Since UI behavior depends on this ordering, consider adding or updating a test to verify that inject_into now appears before field_name in the generated schema.

      field_name:

coderabbitai · 2025-07-02T18:38:45Z

📝 Walkthrough

Walkthrough

The schema for the refresh_token_updater under OAuthAuthenticator was updated by renaming its title and adjusting its description. Default paths for token config fields were simplified by removing the "credentials" prefix. In RequestOption, the inject_into property was moved earlier in the properties list to remove duplication. Corresponding model classes were updated accordingly.

Changes

File	Change Summary
airbyte_cdk/sources/declarative/declarative_component_schema.yaml	Renamed `refresh_token_updater` title and updated description; simplified default paths by removing `"credentials"` prefix; moved `inject_into` property earlier in `RequestOption` and removed duplicate.
airbyte_cdk/sources/declarative/models/declarative_component_schema.py	Updated `RefreshTokenUpdater` defaults by removing `"credentials"` prefix; updated `refresh_token_updater` title and description in `OAuthAuthenticator`; moved `inject_into` field in `RequestOption` class earlier in the class definition.

Would you like me to help draft a quick note for the changelog or PR description to highlight these clarifications and tidy-ups? Wdyt?

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d42bdbe and 842ccba.

📒 Files selected for processing (2)

airbyte_cdk/sources/declarative/declarative_component_schema.yaml (5 hunks)
airbyte_cdk/sources/declarative/models/declarative_component_schema.py (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

airbyte_cdk/sources/declarative/models/declarative_component_schema.py
airbyte_cdk/sources/declarative/declarative_component_schema.yaml

⏰ Context from checks skipped due to timeout of 90000ms (4)

GitHub Check: Check: source-shopify
GitHub Check: Pytest (Fast)
GitHub Check: Pytest (All, Python 3.10, Ubuntu)
GitHub Check: Pytest (All, Python 3.11, Ubuntu)

✨ 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.

github-actions · 2025-07-02T18:46:58Z

PyTest Results (Fast)

1 127 tests - 2 558 1 116 ✅ - 2 558 4m 43s ⏱️ - 1m 34s
1 suites ± 0 10 💤 - 1
1 files ± 0 1 ❌ + 1

For more details on these failures, see this check.

Results for commit 842ccba. ± Comparison against base commit cc93e62.

This pull request removes 2558 tests.

unit_tests.sources.declarative.parsers.test_model_to_component_factory ‑ test_api_budget
unit_tests.sources.declarative.parsers.test_model_to_component_factory ‑ test_api_budget_fixed_window_policy
unit_tests.sources.declarative.parsers.test_model_to_component_factory ‑ test_client_side_incremental
unit_tests.sources.declarative.parsers.test_model_to_component_factory ‑ test_client_side_incremental_with_partition_router
unit_tests.sources.declarative.parsers.test_model_to_component_factory ‑ test_config_with_defaults
unit_tests.sources.declarative.parsers.test_model_to_component_factory ‑ test_create_async_retriever
unit_tests.sources.declarative.parsers.test_model_to_component_factory ‑ test_create_composite_error_handler
unit_tests.sources.declarative.parsers.test_model_to_component_factory ‑ test_create_concurrent_cursor_from_datetime_based_cursor[test_no_cursor_granularity_exception]
unit_tests.sources.declarative.parsers.test_model_to_component_factory ‑ test_create_concurrent_cursor_from_datetime_based_cursor[test_no_lookback_window0]
unit_tests.sources.declarative.parsers.test_model_to_component_factory ‑ test_create_concurrent_cursor_from_datetime_based_cursor[test_no_lookback_window1]
…

♻️ This comment has been updated with latest results.

github-actions · 2025-07-02T18:58:49Z

PyTest Results (Full)

3 688 tests ±0 3 676 ✅ - 1 17m 49s ⏱️ -10s
1 suites ±0 11 💤 ±0
1 files ±0 1 ❌ +1

For more details on these failures, see this check.

Results for commit 842ccba. ± Comparison against base commit cc93e62.

♻️ This comment has been updated with latest results.

reorder inject_into in RequestOption

a48742c

Copilot AI review requested due to automatic review settings July 2, 2025 18:36

github-actions bot added the chore label Jul 2, 2025

Copilot AI reviewed Jul 2, 2025

View reviewed changes

coderabbitai bot approved these changes Jul 2, 2025

View reviewed changes

poe assemble

d42bdbe

lmossman requested a review from aldogonzalez8 July 2, 2025 18:40

lmossman added 2 commits July 3, 2025 15:13

fix title, description, and default values for refresh token updater

6670b40

poe assemble and format

842ccba

lmossman changed the title ~~chore: reorder inject_into in RequestOption~~ chore: reorder inject_into in RequestOption and fix title, description, and defaults in refresh_token_updater Jul 3, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: reorder inject_into in RequestOption and fix title, description, and defaults in refresh_token_updater #635

chore: reorder inject_into in RequestOption and fix title, description, and defaults in refresh_token_updater #635

Uh oh!

lmossman commented Jul 2, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

coderabbitai bot commented Jul 2, 2025 •

edited

Loading

Walkthrough

Changes

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

github-actions bot commented Jul 2, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 2, 2025 •

edited

Loading

Uh oh!

Uh oh!

chore: reorder inject_into in RequestOption and fix title, description, and defaults in refresh_token_updater #635

Are you sure you want to change the base?

chore: reorder inject_into in RequestOption and fix title, description, and defaults in refresh_token_updater #635

Uh oh!

Conversation

lmossman commented Jul 2, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

coderabbitai bot commented Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

github-actions bot commented Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PyTest Results (Fast)

Uh oh!

github-actions bot commented Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PyTest Results (Full)

Uh oh!

Uh oh!

lmossman commented Jul 2, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 2, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Jul 2, 2025 •

edited

Loading

github-actions bot commented Jul 2, 2025 •

edited

Loading