Sign upLogin

LLKennedy/httpgrpc

View on GitHub
Star
client/src/websocket/websocket.ts

Summary

Maintainability
D
2 days
Test Coverage

File websocket.ts has 306 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import { ProtoJSONCompatible, Parser } from "@llkennedy/protoc-gen-tsjson";
import { IMutex, Mutex } from "../common";
import * as uuid from "uuid";

export const EOFMessage = "EOF";
Severity: Minor
Found in client/src/websocket/websocket.ts - About 3 hrs to fix

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

        private async initConnection(): Promise<EstablishedWebsocket<ReqT, ResT>> {
        if (this.initialised) {
            throw new Error("cannot initialise MercuryWebSocket twice");
        }
        this.initialised = true;
    Severity: Major
    Found in client/src/websocket/websocket.ts - About 2 hrs to fix

      MercuryWebSocket has 22 functions (exceeds 20 allowed). Consider refactoring.
      Open

      export class MercuryWebSocket<ReqT extends ProtoJSONCompatible, ResT = any> {
    //#region properties
    /** The logger used for all logs from this class */
    public readonly logger: Logger = console;
    /** The name of this websocket */
      Severity: Minor
      Found in client/src/websocket/websocket.ts - About 2 hrs to fix

        Function messageHandler has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

            private async messageHandler(ev: MessageEvent<any>): Promise<void> {
        if (typeof ev.data === "string" && ev.data === EOFMessage) {
            this.responseBuffer.push(new EOFError());
            this.recvOpen = Promise.resolve(new EOFError());
        } else {
        Severity: Minor
        Found in client/src/websocket/websocket.ts - 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

        Function initConnection has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

            private async initConnection(): Promise<EstablishedWebsocket<ReqT, ResT>> {
        if (this.initialised) {
            throw new Error("cannot initialise MercuryWebSocket twice");
        }
        this.initialised = true;
        Severity: Minor
        Found in client/src/websocket/websocket.ts - 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

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

                newConn.addEventListener("error", async ev => {
            let event = ev;
            try {
                await this.mutex.Run(() => {
                    this.errorHandler(event);
        Severity: Major
        Found in client/src/websocket/websocket.ts and 1 other location - About 2 hrs to fix
        client/src/websocket/websocket.ts on lines 223..232

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

        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

                newConn.addEventListener("close", async ev => {
            let event = ev;
            try {
                await this.mutex.Run(() => {
                    this.closeHandler(event);
        Severity: Major
        Found in client/src/websocket/websocket.ts and 1 other location - About 2 hrs to fix
        client/src/websocket/websocket.ts on lines 233..242

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

        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

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

            addEventListener<K extends keyof WebSocketEventMap>(type: K, listener: (this: WebSocket, ev: WebSocketEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void
        Severity: Major
        Found in client/src/websocket/websocket.ts and 1 other location - About 1 hr to fix
        client/src/websocket/websocket.spec.ts on lines 144..144

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

        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