Sign upLogin

resource-watch/adapter-gfw

View on GitHub
Star

Showing 10 of 10 total issues

Function init has 64 lines of code (exceeds 25 allowed). Consider refactoring.
Open

const init: () => Promise<IInit> = async (): Promise<IInit> => {
    return new Promise((resolve: (value: IInit | PromiseLike<IInit>) => void,
    ) => {
        const app: Koa = new Koa();
Severity: Major
Found in src/app.ts - About 2 hrs to fix

    Function toSQLMiddleware has 53 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    const toSQLMiddleware: (ctx: Context, next: Next) => Promise<void> = async (
    ctx: Context,
    next: Next,
) => {
    const options: RequestToMicroserviceOptions & request.OptionsWithUri = {
    Severity: Major
    Found in src/routes/gfw.router.ts - About 2 hrs to fix

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

      export class DatasetNotFound extends Error {
    status: number;

    constructor(message: string) {
        super(message);
      Severity: Major
      Found in src/errors/datasetNotFound.error.ts and 1 other location - About 1 hr to fix
      src/errors/microserviceConnection.error.ts on lines 1..10

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

      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

      export class MicroserviceConnectionError extends Error {
    status: number;

    constructor(message: string) {
        super(message);
      Severity: Major
      Found in src/errors/microserviceConnection.error.ts and 1 other location - About 1 hr to fix
      src/errors/datasetNotFound.error.ts on lines 1..10

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

      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 executeQuery has 45 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          static async executeQuery(
        urlDataset: string,
        sqlQuery: string,
        download: boolean,
        format: string,
      Severity: Minor
      Found in src/services/gfw.service.ts - About 1 hr to fix

        Function registerDataset has 38 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            static async registerDataset(ctx: Context): Promise<void> {
        logger.info('Registering dataset with data', ctx.request.body);
        try {
            await GfwService.getFields(ctx.request.body.connector.connectorUrl);
            await RWAPIMicroservice.requestToMicroservice({
        Severity: Minor
        Found in src/routes/gfw.router.ts - About 1 hr to fix

          Function download has 37 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              static async download(ctx: Context): Promise<void> {
        try {
            const format: string = ctx.query.format
                ? (ctx.query.format as string)
                : 'csv';
          Severity: Minor
          Found in src/routes/gfw.router.ts - About 1 hr to fix

            Function toSQLMiddleware has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
            Open

            const toSQLMiddleware: (ctx: Context, next: Next) => Promise<void> = async (
    ctx: Context,
    next: Next,
) => {
    const options: RequestToMicroserviceOptions & request.OptionsWithUri = {
            Severity: Minor
            Found in src/routes/gfw.router.ts - About 1 hr 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 executeQuery has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
            Open

                static async executeQuery(
        urlDataset: string,
        sqlQuery: string,
        download: boolean,
        format: string,
            Severity: Minor
            Found in src/services/gfw.service.ts - About 1 hr 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 download has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
            Open

                static async download(ctx: Context): Promise<void> {
        try {
            const format: string = ctx.query.format
                ? (ctx.query.format as string)
                : 'csv';
            Severity: Minor
            Found in src/routes/gfw.router.ts - About 35 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