bcgov/citz-imb-staff-purchasing-reimbursement

View on GitHub

Showing 34 of 45 total issues

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

const itemSchema = z.object({
  supplier: nameSchema,
  purchaseDate: datePickerSchema,
  cost: z.number().nonnegative().max(10000),
});
Severity: Major
Found in api/schemas/chefRequestSchema.ts and 1 other location - About 1 hr to fix
app/src/schemas/chefRequestSchema.ts on lines 16..20

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

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 getRequestByID has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

export const getRequestByID = async (req: Request, res: Response) => {
  const { id } = req.params;
  const { TESTING } = Constants;

  // Projection to get everything except a file's data
Severity: Minor
Found in api/controllers/requests-api-controller.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 getRequestsByIDIR has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

export const getRequestsByIDIR = async (req: Request, res: Response) => {
  const { minimal, idir } = req.query;
  const { TESTING } = Constants;

  if (!TESTING) {
Severity: Minor
Found in api/controllers/requests-api-controller.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

Avoid too many return statements within this function.
Open

          return data.sort((a, b) => a.submissionDate.localeCompare(b.submissionDate));
Severity: Major
Found in app/src/components/custom/tables/RequestsTable.tsx - About 30 mins to fix

    Avoid too many return statements within this function.
    Open

              return data.sort((a, b) =>
                convertStateToStatus(b.state).localeCompare(convertStateToStatus(a.state)),
              );
    Severity: Major
    Found in app/src/components/custom/tables/RequestsTable.tsx - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

          return res.status(400).send('Request could not be processed.');
      Severity: Major
      Found in api/controllers/requests-api-controller.ts - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

                return false;
        Severity: Major
        Found in app/src/components/custom/tables/RequestsTable.tsx - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                    return data; // Should already be sorted descending from API.
          Severity: Major
          Found in app/src/components/custom/tables/RequestsTable.tsx - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                      return data.sort((a, b) =>
                        convertStateToStatus(a.state).localeCompare(convertStateToStatus(b.state)),
                      );
            Severity: Major
            Found in app/src/components/custom/tables/RequestsTable.tsx - About 30 mins to fix

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

              const nameSchema = z
                .string()
                .min(2)
                .max(64)
                .regex(/^[a-zA-Z]+(([',. -][a-zA-Z ])?[a-zA-Z]*)*$/)
              Severity: Minor
              Found in app/src/schemas/chefRequestSchema.ts and 1 other location - About 30 mins to fix
              api/schemas/chefRequestSchema.ts on lines 3..8

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

              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

                try {
                  idSchema.parse(id);
                } catch (e) {
                  return res.status(400).send('ID was malformed. Cannot complete request.');
                }
              Severity: Minor
              Found in api/controllers/requests-api-controller.ts and 1 other location - About 30 mins to fix
              api/controllers/requests-api-controller.ts on lines 362..366

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

              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

              const nameSchema = z
                .string()
                .min(2)
                .max(64)
                .regex(/^[a-zA-Z]+(([',. -][a-zA-Z ])?[a-zA-Z]*)*$/)
              Severity: Minor
              Found in api/schemas/chefRequestSchema.ts and 1 other location - About 30 mins to fix
              app/src/schemas/chefRequestSchema.ts on lines 3..8

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

              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

                try {
                  idSchema.parse(id);
                } catch (e) {
                  return res.status(400).send('ID was malformed. Cannot complete request.');
                }
              Severity: Minor
              Found in api/controllers/requests-api-controller.ts and 1 other location - About 30 mins to fix
              api/controllers/requests-api-controller.ts on lines 165..169

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

              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 getAllRequests has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
              Open

              export const getAllRequests = async (req: Request, res: Response) => {
                const { minimal, before, after } = req.query;
                const latestPossibleDate = '3000-01-01';
                const earliestPossibleDate = '1970-01-01';
                // Query will filter out by date, but only if provided.
              Severity: Minor
              Found in api/controllers/requests-api-controller.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