Skip to content
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

Shuixi/cleanup superset #11036

Closed
wants to merge 10 commits into from

Conversation

llance
Copy link
Contributor

@llance llance commented Jul 30, 2024

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • 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.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

Summary by CodeRabbit

  • New Features

    • Introduced support for data ingestion from the Preset platform.
    • Added new classes for configuring and managing data ingestion from Preset.
    • Implemented an immediate login feature for the Superset data source upon instantiation.
  • Bug Fixes

    • Enhanced state management and processing during data ingestion.
  • Tests

    • Added integration tests for the new Preset data ingestion source.
    • Introduced unit tests for the configuration class related to Preset.
  • Documentation

    • New structured JSON files created to represent metadata snapshots for dashboards and charts.

Copy link
Contributor

coderabbitai bot commented Jul 30, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The recent updates introduce a new data ingestion source for the Preset.io platform, significantly enhancing the metadata ingestion functionality. Key additions include a configuration class and source class tailored to interact with the Preset API. Integration and unit tests have also been implemented to ensure reliability, streamlining data management and improving analytics and governance within data workflows.

Changes

File(s) Change Summary
metadata-ingestion/setup.py, .../ingestion/source/preset.py Added PresetSource class and configuration for integrating with Preset.io, expanding data ingestion capabilities.
.../ingestion/source/superset.py Introduced a login method in SupersetSource to automate authentication during initialization.
.../integration/preset/golden_test_ingest.json, .../golden_test_stateful_ingest.json Created JSON files defining snapshots for dashboards and charts, enhancing metadata representation.
.../integration/preset/test_preset.py Developed integration tests for both standard and stateful ingestion processes with the Preset API.
.../unit/test_preset_source.py Established unit tests for PresetConfig to validate configuration handling and default values.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PresetSource
    participant PresetAPI

    User->>PresetSource: Initialize ingestion
    PresetSource->>PresetSource: Setup configuration
    PresetSource->>PresetSource: Call login()
    PresetSource->>PresetAPI: Authenticate
    PresetAPI-->>PresetSource: Return access token
    PresetSource->>PresetAPI: Fetch data
    PresetAPI-->>PresetSource: Provide data
    PresetSource->>User: Complete ingestion
Loading

🐇 In the meadow bright, I hop with glee,
New sources of data, how fun they’ll be!
Preset and Superset, hand in hand,
Together they help us understand.
With tests in place, our worries fade,
Let’s celebrate the changes made! 🎉


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.

@github-actions github-actions bot added ingestion PR or Issue related to the ingestion of metadata community-contribution PR or Issue raised by member(s) of DataHub Community labels Jul 30, 2024
@llance
Copy link
Contributor Author

llance commented Jul 30, 2024

duplicate of #10954

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community-contribution PR or Issue raised by member(s) of DataHub Community ingestion PR or Issue related to the ingestion of metadata
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants