senecajs/seneca-telemetry-newrelic

View on GitHub

Showing 16 of 16 total issues

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

    return new Promise((resolve, reject) => {
      eventsClient.send(eventBatch, (err: any, res: any, body: any) => {
        const response = {
          err: null,
          statusCode: null,
Severity: Major
Found in src/events-collector.ts and 1 other location - About 4 hrs to fix
src/metrics-collector.ts on lines 45..60

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

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

    return new Promise((resolve, reject) => {
      metricsClient.send(batch, (err: any, res: any, body: any) => {
        const response = {
          err: null,
          statusCode: null,
Severity: Major
Found in src/metrics-collector.ts and 1 other location - About 4 hrs to fix
src/events-collector.ts on lines 13..28

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

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

Function newrelic has 63 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function newrelic(this: any, options: NewRelicOptions) {
    const isPluginEnabled = options && options.enabled

    if(!isPluginEnabled) {
      return
Severity: Major
Found in src/newrelic.ts - About 2 hrs to fix

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

      async function metric_count_handler(this: any, msg: any) {
        const { name, value, attributes } = msg;
        const countMetrics = new CountMetric(name, value, attributes || {});
        const batch = _metricBatchBuilder(countMetrics);
        return _sendBatch(batch);
    Severity: Major
    Found in src/metrics-collector.ts and 1 other location - About 2 hrs to fix
    src/metrics-collector.ts on lines 17..22

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

    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

      async function metric_gauge_handler(this: any, msg: any) {
        const { name, value, attributes } = msg;
        const gaugeMetric = new GaugeMetric(name, value, attributes || {});
        const batch = _metricBatchBuilder(gaugeMetric);
        return _sendBatch(batch);
    Severity: Major
    Found in src/metrics-collector.ts and 1 other location - About 2 hrs to fix
    src/metrics-collector.ts on lines 10..15

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

    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

    Function MetricsCollector has 52 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export function MetricsCollector(metricApiKey: string) {
      const metricsClient = new MetricClient({
        apiKey: metricApiKey,
      });
    
    
    Severity: Major
    Found in src/metrics-collector.ts - About 2 hrs to fix

      Function preload has 45 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      function preload(this: any, opts: any) {
        const seneca = this;
        const { options }: { options: NewRelicOptions } = opts;
        const isPluginEnabled = options && options.enabled
      
      
      Severity: Minor
      Found in src/newrelic.ts - About 1 hr to fix

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

          seneca.order.inward.add((spec: Spec) => {
            if (segmentIsEnabled) {
              addSegment(spec);
            }
            if (tracingCollector) {
        Severity: Major
        Found in src/newrelic.ts and 1 other location - About 1 hr to fix
        src/newrelic.ts on lines 95..102

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

        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

          seneca.order.outward.add((spec: Spec) => {
            if (segmentIsEnabled) {
              endSegment(spec);
            }
            if (tracingCollector) {
        Severity: Major
        Found in src/newrelic.ts and 1 other location - About 1 hr to fix
        src/newrelic.ts on lines 86..93

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

        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

        Function sendTracing has 31 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          sendTracing(spec: TelemetrySpecMetadata): Promise<string|void|boolean> {
            return new Promise((resolve, reject) => {
              const spanBatch = new SpanBatch();
        
              const span = new Span(
        Severity: Minor
        Found in src/tracing-collector.ts - About 1 hr to fix

          Function addSegment has 29 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

          function addSegment(spec: Spec) {
            if (spec.ctx.actdef?.func) {
              const { ctx, data } = spec
              const pattern = ctx.actdef.pattern
              const origfunc = ctx.actdef.func
          Severity: Minor
          Found in src/newrelic.ts - About 1 hr to fix

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

              if (eventsIsEnabled) {
                if (!options.events?.accountApiKey) {
                  throw new Error("Please provide accountApiKey parameter to Events API");
                }
                this.events_api_key = options.events.accountApiKey;
            Severity: Minor
            Found in src/newrelic.ts and 1 other location - About 45 mins to fix
            src/newrelic.ts on lines 104..109

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

            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

              if (metricsIsEnabled) {
                if (!options.metrics?.accountApiKey) {
                  throw new Error("Please provide accountApiKey parameter to Metrics API");
                }
                this.metrics_api_key = options.metrics.accountApiKey;
            Severity: Minor
            Found in src/newrelic.ts and 1 other location - About 45 mins to fix
            src/newrelic.ts on lines 111..116

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

            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

            Function preload has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
            Open

            function preload(this: any, opts: any) {
              const seneca = this;
              const { options }: { options: NewRelicOptions } = opts;
              const isPluginEnabled = options && options.enabled
            
            
            Severity: Minor
            Found in src/newrelic.ts - 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

            Function _updateSpecList has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
            Open

              async _updateSpecList(specMetadata: TelemetrySpecMetadata) {
                const spec = this.specList.find((s) => s.mi_id === specMetadata.mi_id);
                if (spec) {
                  Object.assign(spec, specMetadata);
                  if (spec.manualEndTime && spec.manualStartTime && !spec.dispatched) {
            Severity: Minor
            Found in src/tracing-collector.ts - 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

            Function MetricsCollector has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

            export function MetricsCollector(metricApiKey: string) {
              const metricsClient = new MetricClient({
                apiKey: metricApiKey,
              });
            
            
            Severity: Minor
            Found in src/metrics-collector.ts - 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

            Severity
            Category
            Status
            Source
            Language