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

feat: add parallel bulk processing #1568

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

Conversation

altitude
Copy link
Member

No description provided.

Signed-off-by: Clément Salaün <[email protected]>
@altitude altitude requested a review from a team as a code owner June 20, 2024 17:03
@altitude altitude marked this pull request as draft June 20, 2024 17:03
Copy link
Contributor

coderabbitai bot commented Jun 20, 2024

Walkthrough

The modifications enhance the ProcessBulk function by adding concurrency support through a new parallel parameter and introducing a helper function, processBulkElement, to handle individual bulk elements. These changes enable the bulk processing to be executed either sequentially or in parallel, improving performance flexibility.

Changes

Files Change Summary
components/ledger/internal/api/v2/bulk.go Added concurrency handling, refactored ProcessBulk, introduced processBulkElement, adjusted imports.
components/ledger/internal/api/v2/controllers_… Updated bulkHandler to pass the new parallel parameter to ProcessBulk.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Controller
    participant Backend
    participant Ledger

    Client ->> Controller: Send bulk request
    Controller ->> Backend: Extract ledger
    Controller ->> Ledger: Call ProcessBulk with `parallel` parameter

    alt Sequential Processing
        Ledger ->> Ledger: Process each element in order
    else Parallel Processing
        Ledger ->> Ledger: Process elements concurrently
    end

    Ledger ->> Controller: Return results
    Controller ->> Client: Send response
Loading

Poem

A code's transformation, swift and bright,
Bulk tasks now split, day or night. 🌙🌞
Parallel paths, efficiency's call,
Ledger stands strong, handling all. 💪
Within the code, progress flows,
Each element, in harmony, goes. 🚀


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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Outside diff range and nitpick comments (1)
components/ledger/internal/api/v2/bulk.go (1)

172-231: Excellent implementation of parallel processing. Consider adding a timeout mechanism to prevent potential deadlocks or long-running goroutines.

Implementing a timeout can be done using a context.WithTimeout to ensure that all goroutines complete within a reasonable timeframe.

ctx, cancel := context.WithTimeout(ctx, 30*time.Second)
defer cancel()
...
if ctx.Err() == context.DeadlineExceeded {
    return nil, true, fmt.Errorf("processing timed out")
}
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5cf1aa5 and 95296aa.

Files selected for processing (2)
  • components/ledger/internal/api/v2/bulk.go (2 hunks)
  • components/ledger/internal/api/v2/controllers_bulk.go (1 hunks)
Additional comments not posted (1)
components/ledger/internal/api/v2/controllers_bulk.go (1)

20-26: LGTM! Ensure proper error handling and testing for the new parallel processing feature.

Verification successful

The bulkHandler function implementation includes error handling for the ProcessBulk call, which now includes the parallel parameter. The function checks for errors and handles them appropriately by setting the HTTP status to BadRequest if an error occurs.

  • bulkHandler function:
    • Decodes the request body into Bulk struct.
    • Calls ProcessBulk with the parallel parameter.
    • Checks for errors (err != nil || errorsInBulk).
    • Sets BadRequest status if errors are present.
    • Encodes the response or panics if encoding fails.

The error handling appears to be in place for the parallel processing feature.

Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify error handling for parallel processing in `bulkHandler`.

# Test: Search for error handling patterns in `bulkHandler`.
rg --type go $'bulkHandler' 'components/ledger/internal/api/v2/controllers_bulk.go'

Length of output: 139



Script:

#!/bin/bash
# Description: Extract the full implementation of `bulkHandler` to verify error handling for parallel processing.

# Search for the complete implementation of `bulkHandler` function.
ast-grep --lang go --pattern $'func bulkHandler($_, $_) {
  $$$
}'

Length of output: 2302

Comment on lines +44 to +170
} else {
return nil, "", tx
}
case ActionAddMetadata:
type addMetadataRequest struct {
TargetType string `json:"targetType"`
TargetID json.RawMessage `json:"targetId"`
Metadata metadata.Metadata `json:"metadata"`
}
req := &addMetadataRequest{}
if err := json.Unmarshal(element.Data, req); err != nil {
return fmt.Errorf("error parsing element %d: %s", i, err), "", nil
}

var targetID any
switch req.TargetType {
case ledger.MetaTargetTypeAccount:
targetID = ""
case ledger.MetaTargetTypeTransaction:
targetID = big.NewInt(0)
}
if err := json.Unmarshal(req.TargetID, &targetID); err != nil {
return err, "", nil
}

if err := l.SaveMeta(ctx, parameters, req.TargetType, targetID, req.Metadata); err != nil {
var code string
switch {
case command.IsSaveMetaError(err, command.ErrSaveMetaCodeTransactionNotFound):
code = sharedapi.ErrorCodeNotFound
default:
code = sharedapi.ErrorInternal
}
return err, code, nil
} else {
return nil, "", nil
}
case ActionRevertTransaction:
type revertTransactionRequest struct {
ID *big.Int `json:"id"`
Force bool `json:"force"`
AtEffectiveDate bool `json:"atEffectiveDate"`
}
req := &revertTransactionRequest{}
if err := json.Unmarshal(element.Data, req); err != nil {
return fmt.Errorf("error parsing element %d: %s", i, err), "", nil
}

tx, err := l.RevertTransaction(ctx, parameters, req.ID, req.Force, req.AtEffectiveDate)
if err != nil {
var code string
switch {
case engine.IsCommandError(err):
code = ErrValidation
default:
code = sharedapi.ErrorInternal
}
return err, code, nil
} else {
return nil, "", tx
}
case ActionDeleteMetadata:
type deleteMetadataRequest struct {
TargetType string `json:"targetType"`
TargetID json.RawMessage `json:"targetId"`
Key string `json:"key"`
}
req := &deleteMetadataRequest{}
if err := json.Unmarshal(element.Data, req); err != nil {
return err, "", nil
}

var targetID any
switch req.TargetType {
case ledger.MetaTargetTypeAccount:
targetID = ""
case ledger.MetaTargetTypeTransaction:
targetID = big.NewInt(0)
}
if err := json.Unmarshal(req.TargetID, &targetID); err != nil {
return err, "", nil
}

err := l.DeleteMetadata(ctx, parameters, req.TargetType, targetID, req.Key)
if err != nil {
var code string
switch {
case command.IsDeleteMetaError(err, command.ErrSaveMetaCodeTransactionNotFound):
code = sharedapi.ErrorCodeNotFound
default:
code = sharedapi.ErrorInternal
}
return err, code, nil
} else {
return nil, "", nil
}
}

return fmt.Errorf("unknown action %s", element.Action), "", nil
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well-structured function for processing individual bulk elements. Consider adding detailed logging for each action type to improve traceability.

+ import "log"

  switch element.Action {
  case ActionCreateTransaction:
+   log.Printf("Processing transaction: %s", element.IdempotencyKey)
    ...
  case ActionAddMetadata:
+   log.Printf("Adding metadata: %s", element.IdempotencyKey)
    ...
  case ActionRevertTransaction:
+   log.Printf("Reverting transaction: %s", element.IdempotencyKey)
    ...
  case ActionDeleteMetadata:
+   log.Printf("Deleting metadata: %s", element.IdempotencyKey)
    ...
  }

Committable suggestion was skipped due to low confidence.

errorsInBulk = true
}

var bulkSuccess = func(index int, action string, data any) {
ret[index] = Result{
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since you allow parallelism, you need to use a lock on the ret variable

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

Successfully merging this pull request may close these issues.

3 participants