Sign upLogin

xmidt-org/caduceus

View on GitHub
Star

Showing 44 of 44 total issues

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

    osf := OutboundSenderFactory{
        Sender:            sw.sender,
        CutOffPeriod:      sw.cutOffPeriod,
        NumWorkers:        sw.numWorkersPerSender,
        QueueSize:         sw.queueSizePerSender,
Severity: Minor
Found in senderWrapper.go and 1 other location - About 35 mins to fix
senderWrapper.go on lines 89..101

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

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

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

func (obs *CaduceusOutboundSender) Update(wh ancla.InternalWebhook) (err error) {

    // Validate the failure URL, if present
    if "" != wh.Webhook.FailureURL {
        if _, err = url.ParseRequestURI(wh.Webhook.FailureURL); nil != err {
Severity: Minor
Found in outboundSender.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

exported type SenderConfig should have comment or be unexported
Open

type SenderConfig struct {
Severity: Minor
Found in caduceus_type.go by golint

exported function Metrics should have comment or be unexported
Open

func Metrics() []xmetrics.Metric {
Severity: Minor
Found in metrics.go by golint

exported type SenderWrapper should have comment or be unexported
Open

type SenderWrapper interface {
Severity: Minor
Found in senderWrapper.go by golint

exported var GitCommit should have comment or be unexported
Open

    GitCommit = "undefined"
Severity: Minor
Found in main.go by golint

error strings should not be capitalized or end with punctuation or a newline
Open

        err = errors.New("Linger must be positive.")
Severity: Minor
Found in senderWrapper.go by golint

error strings should not be capitalized or end with punctuation or a newline
Open

        err = errors.New("events must not be empty.")
Severity: Minor
Found in outboundSender.go by golint

exported type RequestHandler should have comment or be unexported
Open

type RequestHandler interface {
Severity: Minor
Found in caduceus_type.go by golint

exported function NewPrimaryHandler should have comment or be unexported
Open

func NewPrimaryHandler(l *zap.Logger, v *viper.Viper, registry xmetrics.Registry, sw *ServerHandler, webhookSvc ancla.Service, router *mux.Router, prevVersionSupport bool) (*mux.Router, error) {
Severity: Minor
Found in primaryHandler.go by golint

exported function AnclaHelperMetrics should have comment or be unexported
Open

func AnclaHelperMetrics() []xmetrics.Metric {
Severity: Minor
Found in anclaHelper.go by golint

exported type CaduceusMetricsRegistry should have comment or be unexported
Open

type CaduceusMetricsRegistry interface {
Severity: Minor
Found in caduceus_type.go by golint

2: cannot find package "github.com/xmidt-org/ancla" in any of:
Open

    "github.com/xmidt-org/ancla"
Severity: Minor
Found in anclaHelper.go by govet

exported function NewHelperMeasures should have comment or be unexported
Open

func NewHelperMeasures(p xmetrics.Registry) ancla.Measures {
Severity: Minor
Found in anclaHelper.go by golint

exported function NewMetricWrapperMeasures should have comment or be unexported
Open

func NewMetricWrapperMeasures(m CaduceusMetricsRegistry) metrics.Histogram {
Severity: Minor
Found in metrics.go by golint

exported type OutboundSender should have comment or be unexported
Open

type OutboundSender interface {
Severity: Minor
Found in outboundSender.go by golint

comment on exported type CaduceusConfig should be of the form "CaduceusConfig ..." (with optional leading article)
Open

// Below is the struct we're using to contain the data from a provided config file
Severity: Minor
Found in caduceus_type.go by golint

error should be the last type when returning multiple items
Open

func printVersion(f *pflag.FlagSet, arguments []string) (error, bool) {
Severity: Minor
Found in main.go by golint

exported method CaduceusHandler.HandleRequest should have comment or be unexported
Open

func (ch *CaduceusHandler) HandleRequest(workerID int, msg *wrp.Message) {
Severity: Minor
Found in caduceus_type.go by golint

exported const ErrorRequestBodyCounter should have comment (or a comment on this block) or be unexported
Open

    ErrorRequestBodyCounter         = "error_request_body_count"
Severity: Minor
Found in metrics.go by golint
Severity
Category
Status
Source
Language