Skip to content

Refactor/goetl #19

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 4 commits into from
Jan 5, 2025
Merged

Refactor/goetl #19

merged 4 commits into from
Jan 5, 2025

Conversation

ccamel
Copy link
Member

@ccamel ccamel commented Jan 5, 2025

Adopt the teambenny/goetl framework to standardise the extraction process using a pipeline-based approach. This should ensures a more consistent and modular way of handling data extraction tasks in this tool.

Also add the (persistent) flag log_level for better control over logging verbosity.

@ccamel ccamel self-assigned this Jan 5, 2025
Copy link

coderabbitai bot commented Jan 5, 2025

Warning

Rate limit exceeded

@bot-anik has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 29 minutes and 41 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between f34cdf7 and 1cfc352.

⛔ Files ignored due to path filters (3)
  • .golangci.yml is excluded by !**/*.yml
  • go.mod is excluded by !**/*.mod
  • go.sum is excluded by !**/*.sum, !**/*.sum
📒 Files selected for processing (10)
  • cmd/delegators.go (1 hunks)
  • cmd/root.go (2 hunks)
  • pkg/delegators/extract.go (0 hunks)
  • pkg/delegators/payload.go (1 hunks)
  • pkg/delegators/pipeline.go (1 hunks)
  • pkg/delegators/reader.go (1 hunks)
  • pkg/delegators/record.go (0 hunks)
  • pkg/delegators/writer.go (1 hunks)
  • pkg/keeper/keeper.go (7 hunks)
  • pkg/logger/logger.go (1 hunks)

Walkthrough

The pull request introduces a comprehensive refactoring of the delegators extraction process in the application. The changes involve creating a new pipeline-based mechanism for extracting delegator and chain information, replacing the previous direct extraction method. This includes introducing new packages and types for handling data processing, implementing robust error handling, and improving logging capabilities. The modifications span multiple files across the project, focusing on modularizing the extraction process and enhancing overall code structure.

Changes

File Change Summary
cmd/delegators.go Updated to use new pipeline mechanism for delegator extraction
cmd/root.go Added logging configuration with new log level flag and persistent pre-run configuration
pkg/delegators/... Major restructuring:
- Removed extract.go
- Added pipeline.go with new pipeline execution logic
- Added reader.go with data reading capabilities
- Added writer.go for CSV output
- Added payload.go with new data structures
pkg/keeper/keeper.go Enhanced resource management with new Close() method and io.Closer support
pkg/logger/logger.go Implemented new ETL-specific logging mechanism

Sequence Diagram

sequenceDiagram
    participant CLI as CLI Command
    participant Pipeline as Delegators Pipeline
    participant Reader as Data Reader
    participant Writer as CSV Writer
    
    CLI Command->>Pipeline: Initialize Pipeline
    Pipeline->>Reader: Create Delegators Reader
    Pipeline->>Reader: Create Chain Reader
    Pipeline->>Writer: Create CSV Writers
    
    Reader->>Reader: Process Delegator Data
    Reader->>Writer: Write Delegator CSV
    
    Reader->>Reader: Process Chain Metadata
    Reader->>Writer: Write Chain CSV
    
    Pipeline->>Pipeline: Run Pipelines Concurrently
    
    alt Success
        Pipeline-->>CLI Command: Return Nil Error
    else Error
        Pipeline-->>CLI Command: Return Processing Error
    end
Loading

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>, please review it.
    • 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 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. (Beta)
  • @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.

@ccamel ccamel merged commit 5b8177a into main Jan 5, 2025
12 checks passed
@ccamel ccamel deleted the refactor/goetl branch January 5, 2025 15:20
@bot-anik
Copy link
Member

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants