Skip to content

fix: Allow SessionTokenAuthenticator to be created as a subcomponent to a custom component #500

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

hai-ld
Copy link

@hai-ld hai-ld commented Apr 21, 2025

Change name argument in the function create_session_token_authenticator to a keyword-only argument so that it can be injected via $parameters. Other name arguments in the same module are already keyword-only.

Example manifest

base_requester:
  type: HttpRequester
  url_base: ...
  authenticator:
    type: CustomAuthenticator
    hmac_key: "{{ config[\"hmac_key\"] }}"
    class_name: source_declarative_manifest.components.SigningAuthenticator
    token_authenticator:
      type: SessionTokenAuthenticator
      $parameters:
        name: some_name
      login_requester:
        type: HttpRequester
        url_base: ...
        authenticator:
          type: NoAuth
        http_method: GET
        request_parameters:
          app_key: "{{ config['client_id'] }}"
          app_secret: "{{ config['client_secret'] }}"
          grant_type: refresh_token
          refresh_token: "{{ config['refresh_token'] }}"
        request_headers: {}
      session_token_path:
        - access_token
      expiration_duration: PT1H
      request_authentication:
        type: ApiKey
        inject_into:
          type: RequestOption
          field_name: x-access-token
          inject_into: header

For context, SigningAuthenticator will leverage SessionTokenAuthenticator to refresh the access token in __call__, then signs the request according to the API provider's spec. Composition seems to be a hassle-free approach compared to inheritance.

Summary by CodeRabbit

  • Refactor
    • Improved method parameter handling for session token authenticator creation to require explicit keyword usage for certain arguments.

…custom component

Change `name` argument in the function `create_session_token_authenticator` to a keyword-only argument so that it can be injected via `$parameters`. Other `name` arguments in the same module are already keyword-only.
Copy link
Contributor

coderabbitai bot commented Apr 21, 2025

📝 Walkthrough

Walkthrough

The change updates the method signature of create_session_token_authenticator in the ModelToComponentFactory class. The name parameter, which was previously a positional argument, is now required to be passed as a keyword argument. No internal logic or return type modifications were made to the method.

Changes

File Change Summary
airbyte_cdk/sources/declarative/parsers/model_to_component_factory.py Made the name parameter of create_session_token_authenticator a keyword-only argument.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant ModelToComponentFactory

    Caller->>ModelToComponentFactory: create_session_token_authenticator(model, config, name=...)
    ModelToComponentFactory-->>Caller: Returns ApiKeyAuthenticator or BearerAuthenticator
Loading

Would you like to update any related documentation or usage examples to reflect the new keyword-only requirement for the name parameter, wdyt?

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 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 b148ca5 and 3961049.

📒 Files selected for processing (1)
  • airbyte_cdk/sources/declarative/parsers/model_to_component_factory.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Pytest (All, Python 3.11, Ubuntu)
  • GitHub Check: SDM Docker Image Build
  • GitHub Check: Pytest (All, Python 3.10, Ubuntu)
  • GitHub Check: Pytest (Fast)
🔇 Additional comments (1)
airbyte_cdk/sources/declarative/parsers/model_to_component_factory.py (1)

911-913:

❓ Verification inconclusive

Signature update looks good but double-check invocation sites
We’ve made name keyword-only to match other factory methods. Could we verify that every internal call to create_session_token_authenticator passes name= explicitly? wdyt?


🏁 Script executed:

#!/bin/bash
# Verify all calls use the 'name' keyword
rg -n "create_session_token_authenticator" -C2

Length of output: 1381


Verify name keyword usage in factory dispatch
I see the mapping entry for SessionTokenAuthenticatorModel -> create_session_token_authenticator at line 625, but no direct calls to that method. Could you confirm that the generic dispatch in this file always forwards name= into create_session_token_authenticator? For example, grep for its invocation in the factory’s dispatcher to ensure no positional arguments slip through. wdyt?

– airbyte_cdk/sources/declarative/parsers/model_to_component_factory.py:625 (mapping entry)
– Inspect the dispatch method (e.g., the generic create_* or create_component implementation) to verify the name kwarg is passed along.

✨ 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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

@hai-ld hai-ld changed the title Allow SessionTokenAuthenticator to be created as a subcomponent to a custom component fix: Allow SessionTokenAuthenticator to be created as a subcomponent to a custom component Apr 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant