synapsecns/sanguine

View on GitHub
services/rfq/relayer/service/handlers.go

Summary

Maintainability
D
1 day
Test Coverage

Method Relayer.handleBridgeRequestedLog has 83 lines of code (exceeds 50 allowed). Consider refactoring.
Open

func (r *Relayer) handleBridgeRequestedLog(parentCtx context.Context, req *fastbridge.FastBridgeBridgeRequested, chainID uint64) (err error) {
    ctx, span := r.metrics.Tracer().Start(parentCtx, "handleBridgeRequestedLog", trace.WithAttributes(
        attribute.String("transaction_id", hexutil.Encode(req.TransactionId[:])),
    ))

Severity: Major
Found in services/rfq/relayer/service/handlers.go - About 2 hrs to fix

    Method QuoteRequestHandler.handleProofPosted has 70 lines of code (exceeds 50 allowed). Consider refactoring.
    Open

    func (q *QuoteRequestHandler) handleProofPosted(ctx context.Context, span trace.Span, request reldb.QuoteRequest) (err error) {
        // we shouldnt' check the claim yet
        if !q.shouldCheckClaim(request) {
            return nil
        }
    Severity: Minor
    Found in services/rfq/relayer/service/handlers.go - About 1 hr to fix

      Method QuoteRequestHandler.handleProofPosted has 17 return statements (exceeds 4 allowed).
      Open

      func (q *QuoteRequestHandler) handleProofPosted(ctx context.Context, span trace.Span, request reldb.QuoteRequest) (err error) {
          // we shouldnt' check the claim yet
          if !q.shouldCheckClaim(request) {
              return nil
          }
      Severity: Major
      Found in services/rfq/relayer/service/handlers.go - About 1 hr to fix

        Method QuoteRequestHandler.commitPendingBalance has 63 lines of code (exceeds 50 allowed). Consider refactoring.
        Open

        func (q *QuoteRequestHandler) commitPendingBalance(ctx context.Context, span trace.Span, request *reldb.QuoteRequest) (err error) {
            // lock the consumed balance
            key := getBalanceMtxKey(q.Dest.ChainID, request.Transaction.DestToken)
            span.SetAttributes(attribute.String("balance_lock_key", key))
            unlocker, ok := q.balanceMtx.TryLock(key)
        Severity: Minor
        Found in services/rfq/relayer/service/handlers.go - About 1 hr to fix

          Method QuoteRequestHandler.commitPendingBalance has 13 return statements (exceeds 4 allowed).
          Open

          func (q *QuoteRequestHandler) commitPendingBalance(ctx context.Context, span trace.Span, request *reldb.QuoteRequest) (err error) {
              // lock the consumed balance
              key := getBalanceMtxKey(q.Dest.ChainID, request.Transaction.DestToken)
              span.SetAttributes(attribute.String("balance_lock_key", key))
              unlocker, ok := q.balanceMtx.TryLock(key)
          Severity: Major
          Found in services/rfq/relayer/service/handlers.go - About 1 hr to fix

            Method Relayer.handleBridgeRequestedLog has 13 return statements (exceeds 4 allowed).
            Open

            func (r *Relayer) handleBridgeRequestedLog(parentCtx context.Context, req *fastbridge.FastBridgeBridgeRequested, chainID uint64) (err error) {
                ctx, span := r.metrics.Tracer().Start(parentCtx, "handleBridgeRequestedLog", trace.WithAttributes(
                    attribute.String("transaction_id", hexutil.Encode(req.TransactionId[:])),
                ))
            
            
            Severity: Major
            Found in services/rfq/relayer/service/handlers.go - About 1 hr to fix

              Method QuoteRequestHandler.handleRelayCompleted has 9 return statements (exceeds 4 allowed).
              Open

              func (q *QuoteRequestHandler) handleRelayCompleted(ctx context.Context, span trace.Span, request reldb.QuoteRequest) (err error) {
                  // fetch the block of the relay transaction to confirm that it has been finalized
                  relayBlockNumber, err := q.getRelayBlockNumber(ctx, request)
                  if err != nil {
                      // relay tx must have gotten reorged; mark as RelayRaceLost
              Severity: Major
              Found in services/rfq/relayer/service/handlers.go - About 55 mins to fix

                Method QuoteRequestHandler.handleSeen has 7 return statements (exceeds 4 allowed).
                Open

                func (q *QuoteRequestHandler) handleSeen(ctx context.Context, span trace.Span, request reldb.QuoteRequest) (err error) {
                    shouldProcess, err := q.Quoter.ShouldProcess(ctx, request)
                    if err != nil {
                        // will retry later
                        return fmt.Errorf("could not determine if should process: %w", err)
                Severity: Major
                Found in services/rfq/relayer/service/handlers.go - About 45 mins to fix

                  Method QuoteRequestHandler.handleCommitPending has 7 return statements (exceeds 4 allowed).
                  Open

                  func (q *QuoteRequestHandler) handleCommitPending(ctx context.Context, span trace.Span, request reldb.QuoteRequest) (err error) {
                      earliestConfirmBlock := request.BlockNumber + q.Origin.Confirmations
                  
                      latestBlock := q.Origin.LatestBlock()
                      shouldContinue := latestBlock >= earliestConfirmBlock
                  Severity: Major
                  Found in services/rfq/relayer/service/handlers.go - About 45 mins to fix

                    Method QuoteRequestHandler.getRelayBlockNumber has 6 return statements (exceeds 4 allowed).
                    Open

                    func (q *QuoteRequestHandler) getRelayBlockNumber(ctx context.Context, request reldb.QuoteRequest) (blockNumber uint64, err error) {
                        // fetch the transaction receipt for corresponding tx hash
                        var receipt *types.Receipt
                        err = retry.WithBackoff(ctx, func(context.Context) error {
                            receipt, err = q.Dest.Client.TransactionReceipt(ctx, request.DestTxHash)
                    Severity: Major
                    Found in services/rfq/relayer/service/handlers.go - About 40 mins to fix

                      Method Relayer.handleRelayLog has 5 return statements (exceeds 4 allowed).
                      Open

                      func (r *Relayer) handleRelayLog(parentCtx context.Context, req *fastbridge.FastBridgeBridgeRelayed) (err error) {
                          ctx, span := r.metrics.Tracer().Start(parentCtx, "handleRelayLog",
                              trace.WithAttributes(attribute.String("transaction_id", hexutil.Encode(req.TransactionId[:]))),
                          )
                          defer func() {
                      Severity: Major
                      Found in services/rfq/relayer/service/handlers.go - About 35 mins to fix

                        Method QuoteRequestHandler.handleProofPosted has a Cognitive Complexity of 21 (exceeds 20 allowed). Consider refactoring.
                        Open

                        func (q *QuoteRequestHandler) handleProofPosted(ctx context.Context, span trace.Span, request reldb.QuoteRequest) (err error) {
                            // we shouldnt' check the claim yet
                            if !q.shouldCheckClaim(request) {
                                return nil
                            }
                        Severity: Minor
                        Found in services/rfq/relayer/service/handlers.go - About 25 mins to fix

                        Cognitive Complexity

                        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

                        A method's cognitive complexity is based on a few simple rules:

                        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
                        • Code is considered more complex for each "break in the linear flow of the code"
                        • Code is considered more complex when "flow breaking structures are nested"

                        Further reading

                        Similar blocks of code found in 2 locations. Consider refactoring.
                        Open

                            _, err = q.Origin.SubmitTransaction(ctx, func(transactor *bind.TransactOpts) (tx *types.Transaction, err error) {
                                tx, err = q.Origin.Bridge.Prove(transactor, request.RawRequest, request.DestTxHash)
                                if err != nil {
                                    return nil, fmt.Errorf("could not relay: %w", err)
                                }
                        Severity: Minor
                        Found in services/rfq/relayer/service/handlers.go and 1 other location - About 45 mins to fix
                        services/rfq/relayer/service/handlers.go on lines 595..601

                        Duplicated Code

                        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                        Tuning

                        This issue has a mass of 116.

                        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                        Refactorings

                        Further Reading

                        Similar blocks of code found in 2 locations. Consider refactoring.
                        Open

                            _, err = q.Origin.SubmitTransaction(ctx, func(transactor *bind.TransactOpts) (tx *types.Transaction, err error) {
                                tx, err = q.Origin.Bridge.Claim(transactor, request.RawRequest, transactor.From)
                                if err != nil {
                                    return nil, fmt.Errorf("could not relay: %w", err)
                                }
                        Severity: Minor
                        Found in services/rfq/relayer/service/handlers.go and 1 other location - About 45 mins to fix
                        services/rfq/relayer/service/handlers.go on lines 450..457

                        Duplicated Code

                        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                        Tuning

                        This issue has a mass of 116.

                        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                        Refactorings

                        Further Reading

                        There are no issues that match your filters.

                        Category
                        Status