datahub icon indicating copy to clipboard operation
datahub copied to clipboard

[WIP] feat(cli): Make consistent use of DataHubGraphClientConfig

Open pedro93 opened this issue 1 year ago • 1 comments

Deprecates get_url_and_token() in favor of a more complete option: load_graph_config() that returns a full DatahubClientConfig. This change was then propagated across previous usages of get_url_and_token so that connections to DataHub server from the client respect the full breadth of configuration specified by DatahubClientConfig.

I.e: You can now specify disable_ssl_verification: true in your ~/.datahubenv file so that all cli functions to the server work when ssl certification is disabled.

Checklist

  • [x] The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • [x] Links to related issues (if applicable)
  • [ ] Tests for the changes have been added/updated (if applicable)
  • [ ] Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • [x] For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

pedro93 avatar May 09 '24 09:05 pedro93

This is a GREAT contribution for code quality. @hsheth2 what needs to happen to get this in?

jjoyce0510 avatar Jun 28 '24 21:06 jjoyce0510

Walkthrough

The updates to the Datahub CLI enhance configuration management, particularly with the ~/.datahubenv file, ensuring seamless interaction with SSL settings. The code refactoring improves environment variable management, integrates client instantiation, and simplifies function signatures across various modules. Overall, these modifications enhance usability, flexibility, and security when using the CLI with remote hosts.

Changes

Files Change Summary
docs/how/updating-datahub.md Enhanced configuration management for SSL settings in ~/.datahubenv.
metadata-ingestion/src/datahub/cli/*.py Refactored environment variable management, removed deprecated functions, and improved session handling.
metadata-ingestion/src/datahub/cli/config_utils.py Removed classes for simpler configuration handling.
metadata-ingestion/src/datahub/cli/delete_cli.py Introduced client connection for enhanced metadata deletion.
metadata-ingestion/src/datahub/ingestion/*.py Updated client instantiation and configuration handling across various modules.
metadata-ingestion/src/datahub/upgrade/upgrade.py Refactored server configuration management, making token optional.
smoke-test/tests/*.py Adjusted tests to utilize the new client instantiation methods.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant Environment
    participant DatahubAPI

    User->>CLI: Execute CLI Command
    CLI->>Environment: Read ~/.datahubenv
    Environment-->>CLI: Get Configurations
    CLI->>DatahubAPI: Call with Configurations
    DatahubAPI-->>CLI: Response
    CLI-->>User: Display Result

Assessment against linked issues

Objective Addressed Explanation
Cannot use Datahub CLI with remote host (SSL verification) (#9705)

🐇 In the meadow, changes dance,
New settings grant a second chance.
With SSL now in harmony,
The CLI sings, oh, joy and glee!
Hops of joy for code so bright,
Datahub shines, a guiding light! ✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

coderabbitai[bot] avatar Jul 25 '24 15:07 coderabbitai[bot]