vorteil/direktiv

View on GitHub
pkg/flow/engine.go

Summary

Maintainability
F
4 days
Test Coverage

File engine.go has 803 lines of code (exceeds 500 allowed). Consider refactoring.
Open

package flow

import (
    "context"
    "encoding/base64"
Severity: Major
Found in pkg/flow/engine.go - About 1 day to fix

    Method engine.runState has a Cognitive Complexity of 54 (exceeds 20 allowed). Consider refactoring.
    Open

    func (engine *engine) runState(ctx context.Context, im *instanceMemory, wakedata []byte, err error) *states.Transition {
        ctx = tracing.AddNamespace(ctx, im.Namespace().Name)
        ctx = tracing.WithTrack(ctx, tracing.BuildInstanceTrack(im.instance))
        ctx, cleanup, err3 := tracing.NewSpan(ctx, "preparing instance for state execution")
        if err != nil {
    Severity: Minor
    Found in pkg/flow/engine.go - About 5 hrs 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

    Method engine.NewInstance has 119 lines of code (exceeds 50 allowed). Consider refactoring.
    Open

    func (engine *engine) NewInstance(ctx context.Context, args *newInstanceArgs) (*instanceMemory, error) {
        ctx = tracing.AddInstanceAttr(ctx, tracing.InstanceAttributes{
            Namespace:    args.Namespace.Name,
            InstanceID:   args.ID.String(),
            Invoker:      args.Invoker,
    Severity: Major
    Found in pkg/flow/engine.go - About 3 hrs to fix

      Method engine.runState has 109 lines of code (exceeds 50 allowed). Consider refactoring.
      Open

      func (engine *engine) runState(ctx context.Context, im *instanceMemory, wakedata []byte, err error) *states.Transition {
          ctx = tracing.AddNamespace(ctx, im.Namespace().Name)
          ctx = tracing.WithTrack(ctx, tracing.BuildInstanceTrack(im.instance))
          ctx, cleanup, err3 := tracing.NewSpan(ctx, "preparing instance for state execution")
          if err != nil {
      Severity: Major
      Found in pkg/flow/engine.go - About 3 hrs to fix

        Method engine.Transition has 82 lines of code (exceeds 50 allowed). Consider refactoring.
        Open

        func (engine *engine) Transition(ctx context.Context, im *instanceMemory, nextState string, attempt int) *states.Transition {
            ctx, cleanup, err := tracing.NewSpan(ctx, "engine transitions: "+nextState)
            if err != nil {
                slog.Debug("transition failed to init telemetry", "error", err)
            }
        Severity: Major
        Found in pkg/flow/engine.go - About 2 hrs to fix

          Method engine.EventsInvoke has 63 lines of code (exceeds 50 allowed). Consider refactoring.
          Open

          func (engine *engine) EventsInvoke(tctx context.Context, workflowID uuid.UUID, events ...*cloudevents.Event) {
              ctx := context.Background()
          
              tx, err := engine.flow.beginSQLTx(ctx)
              if err != nil {
          Severity: Minor
          Found in pkg/flow/engine.go - About 1 hr to fix

            Method engine.Transition has a Cognitive Complexity of 24 (exceeds 20 allowed). Consider refactoring.
            Open

            func (engine *engine) Transition(ctx context.Context, im *instanceMemory, nextState string, attempt int) *states.Transition {
                ctx, cleanup, err := tracing.NewSpan(ctx, "engine transitions: "+nextState)
                if err != nil {
                    slog.Debug("transition failed to init telemetry", "error", err)
                }
            Severity: Minor
            Found in pkg/flow/engine.go - About 55 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

            Method engine.NewInstance has 8 return statements (exceeds 4 allowed).
            Open

            func (engine *engine) NewInstance(ctx context.Context, args *newInstanceArgs) (*instanceMemory, error) {
                ctx = tracing.AddInstanceAttr(ctx, tracing.InstanceAttributes{
                    Namespace:    args.Namespace.Name,
                    InstanceID:   args.ID.String(),
                    Invoker:      args.Invoker,
            Severity: Major
            Found in pkg/flow/engine.go - About 50 mins to fix

              Method engine.NewInstance has a Cognitive Complexity of 23 (exceeds 20 allowed). Consider refactoring.
              Open

              func (engine *engine) NewInstance(ctx context.Context, args *newInstanceArgs) (*instanceMemory, error) {
                  ctx = tracing.AddInstanceAttr(ctx, tracing.InstanceAttributes{
                      Namespace:    args.Namespace.Name,
                      InstanceID:   args.ID.String(),
                      Invoker:      args.Invoker,
              Severity: Minor
              Found in pkg/flow/engine.go - About 45 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

              Method engine.Transition has 7 return statements (exceeds 4 allowed).
              Open

              func (engine *engine) Transition(ctx context.Context, im *instanceMemory, nextState string, attempt int) *states.Transition {
                  ctx, cleanup, err := tracing.NewSpan(ctx, "engine transitions: "+nextState)
                  if err != nil {
                      slog.Debug("transition failed to init telemetry", "error", err)
                  }
              Severity: Major
              Found in pkg/flow/engine.go - About 45 mins to fix

                Method engine.EventsInvoke has 6 return statements (exceeds 4 allowed).
                Open

                func (engine *engine) EventsInvoke(tctx context.Context, workflowID uuid.UUID, events ...*cloudevents.Event) {
                    ctx := context.Background()
                
                    tx, err := engine.flow.beginSQLTx(ctx)
                    if err != nil {
                Severity: Major
                Found in pkg/flow/engine.go - About 40 mins to fix

                  Method engine.subflowInvoke has 5 arguments (exceeds 4 allowed). Consider refactoring.
                  Open

                  func (engine *engine) subflowInvoke(ctx context.Context, pi *enginerefactor.ParentInfo, instance *enginerefactor.Instance, name string, input []byte) (*instanceMemory, error) {
                  Severity: Minor
                  Found in pkg/flow/engine.go - About 35 mins to fix

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

                        loggingCtx := tracing.AddInstanceMemoryAttr(ctx, tracing.InstanceAttributes{
                            Namespace:    im.Namespace().Name,
                            InstanceID:   im.GetInstanceID().String(),
                            Invoker:      im.instance.Instance.Invoker,
                            Callpath:     tracing.CreateCallpath(im.instance),
                    Severity: Major
                    Found in pkg/flow/engine.go and 8 other locations - About 50 mins to fix
                    pkg/flow/engine.go on lines 384..392
                    pkg/flow/engine.go on lines 540..547
                    pkg/flow/engine.go on lines 951..958
                    pkg/flow/engine.go on lines 968..975
                    pkg/flow/instance_messages.go on lines 118..128
                    pkg/flow/scheduling.go on lines 105..112
                    pkg/flow/status.go on lines 48..55
                    pkg/flow/temporary.go on lines 135..142

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

                    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 9 locations. Consider refactoring.
                    Open

                        ctx = tracing.AddInstanceMemoryAttr(ctx, tracing.InstanceAttributes{
                            Namespace:    im.Namespace().Name,
                            InstanceID:   im.GetInstanceID().String(),
                            Invoker:      im.instance.Instance.Invoker,
                            Callpath:     tracing.CreateCallpath(im.instance),
                    Severity: Major
                    Found in pkg/flow/engine.go and 8 other locations - About 50 mins to fix
                    pkg/flow/engine.go on lines 384..392
                    pkg/flow/engine.go on lines 672..679
                    pkg/flow/engine.go on lines 951..958
                    pkg/flow/engine.go on lines 968..975
                    pkg/flow/instance_messages.go on lines 118..128
                    pkg/flow/scheduling.go on lines 105..112
                    pkg/flow/status.go on lines 48..55
                    pkg/flow/temporary.go on lines 135..142

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

                    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 9 locations. Consider refactoring.
                    Open

                        loggingCtx := tracing.AddInstanceMemoryAttr(ctx, tracing.InstanceAttributes{
                            Namespace:    im.Namespace().Name,
                            InstanceID:   im.GetInstanceID().String(),
                            Invoker:      im.instance.Instance.Invoker,
                            Callpath:     tracing.CreateCallpath(im.instance),
                    Severity: Major
                    Found in pkg/flow/engine.go and 8 other locations - About 50 mins to fix
                    pkg/flow/engine.go on lines 384..392
                    pkg/flow/engine.go on lines 540..547
                    pkg/flow/engine.go on lines 672..679
                    pkg/flow/engine.go on lines 951..958
                    pkg/flow/instance_messages.go on lines 118..128
                    pkg/flow/scheduling.go on lines 105..112
                    pkg/flow/status.go on lines 48..55
                    pkg/flow/temporary.go on lines 135..142

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

                    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 9 locations. Consider refactoring.
                    Open

                        ctx = tracing.AddInstanceMemoryAttr(ctx,
                            tracing.InstanceAttributes{
                                Namespace:    im.Namespace().Name,
                                InstanceID:   im.GetInstanceID().String(),
                                Invoker:      im.instance.Instance.Invoker,
                    Severity: Major
                    Found in pkg/flow/engine.go and 8 other locations - About 50 mins to fix
                    pkg/flow/engine.go on lines 540..547
                    pkg/flow/engine.go on lines 672..679
                    pkg/flow/engine.go on lines 951..958
                    pkg/flow/engine.go on lines 968..975
                    pkg/flow/instance_messages.go on lines 118..128
                    pkg/flow/scheduling.go on lines 105..112
                    pkg/flow/status.go on lines 48..55
                    pkg/flow/temporary.go on lines 135..142

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

                    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 9 locations. Consider refactoring.
                    Open

                        loggingCtx := tracing.AddInstanceMemoryAttr(ctx, tracing.InstanceAttributes{
                            Namespace:    im.Namespace().Name,
                            InstanceID:   im.GetInstanceID().String(),
                            Invoker:      im.instance.Instance.Invoker,
                            Callpath:     tracing.CreateCallpath(im.instance),
                    Severity: Major
                    Found in pkg/flow/engine.go and 8 other locations - About 50 mins to fix
                    pkg/flow/engine.go on lines 384..392
                    pkg/flow/engine.go on lines 540..547
                    pkg/flow/engine.go on lines 672..679
                    pkg/flow/engine.go on lines 968..975
                    pkg/flow/instance_messages.go on lines 118..128
                    pkg/flow/scheduling.go on lines 105..112
                    pkg/flow/status.go on lines 48..55
                    pkg/flow/temporary.go on lines 135..142

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

                    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