Sign upLogin

xylabs/sdk-meta-server-nodejs

View on GitHub
Star

Showing 15 of 15 total issues

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

export const removeQueryParams = (url: string, paramsDict: QueryParamsDict): string => {
  const parsed = new URL(url)
  Object.entries(paramsDict).map(([param, value]) => parsed.searchParams.delete(param, value))
  return parsed.toString()
}
Severity: Major
Found in src/modules/metaServer/lib/uri/queryParams.ts and 1 other location - About 2 hrs to fix
src/modules/metaServer/lib/uri/queryParams.ts on lines 9..13

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

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 const addQueryParams = (url: string, paramsDict: QueryParamsDict): string => {
  const parsed = new URL(url)
  Object.entries(paramsDict).map(([param, value]) => parsed.searchParams.append(param, value))
  return parsed.toString()
}
Severity: Major
Found in src/modules/metaServer/lib/uri/queryParams.ts and 1 other location - About 2 hrs to fix
src/modules/metaServer/lib/uri/queryParams.ts on lines 21..25

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

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

const getLiveSharePageHandler = (opts: ApplicationMiddlewareOptions): MountPathAndMiddleware | undefined => {
  const { baseDir } = opts
  const filePath = join(baseDir, 'xy.config.json')
  console.log(`[liveShare][init] Locating xy.config.json at ${filePath}`)
  if (existsSync(filePath)) {
Severity: Minor
Found in src/modules/metaServer/contentHandlers/liveShare/liveShareHandlers.ts - About 2 hrs 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 getHandler has 41 lines of code (exceeds 25 allowed). Consider refactoring.
Open

const getHandler = (baseDir: string) => {
  // Ensure file containing base HTML exists
  const filePath = join(baseDir, 'index.html')
  assertEx(existsSync(filePath), 'Missing index.html')
  const html = readFileSync(filePath, { encoding: 'utf8' })
Severity: Minor
Found in src/modules/metaServer/contentHandlers/proxyOriginal/proxyOriginal.ts - About 1 hr to fix

    Function getHandler has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
    Open

    const getHandler = (baseDir: string) => {
  // Ensure file containing base HTML exists
  const filePath = join(baseDir, 'index.html')
  assertEx(existsSync(filePath), 'Missing index.html')
  const html = readFileSync(filePath, { encoding: 'utf8' })
    Severity: Minor
    Found in src/modules/metaServer/contentHandlers/proxyOriginal/proxyOriginal.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 useSpaPage has 39 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export const useSpaPage = async <T>(
  url: string,
  pageCallback: (page: Page) => Promise<T> | T,
  browserOptions: Viewport = viewPortDefaults,
  _waitForOptions: WaitForOptions = useSpaPageWaitForOptions,
    Severity: Minor
    Found in src/modules/metaServer/lib/page/usePage/useSpaPage.ts - About 1 hr to fix

      Function getLiveSharePageHandler has 35 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      const getLiveSharePageHandler = (opts: ApplicationMiddlewareOptions): MountPathAndMiddleware | undefined => {
  const { baseDir } = opts
  const filePath = join(baseDir, 'xy.config.json')
  console.log(`[liveShare][init] Locating xy.config.json at ${filePath}`)
  if (existsSync(filePath)) {
      Severity: Minor
      Found in src/modules/metaServer/contentHandlers/liveShare/liveShareHandlers.ts - About 1 hr to fix

        Function getPageHandler has 34 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        const getPageHandler = (baseDir: string) => {
  // Ensure file containing base HTML exists
  const filePath = join(baseDir, 'index.html')
  assertEx(existsSync(filePath), 'Missing index.html')
  const indexHtml = readFileSync(filePath, { encoding: 'utf8' })
        Severity: Minor
        Found in src/modules/metaServer/contentHandlers/liveShare/liveShareHandlers.ts - About 1 hr to fix

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

          const imageHandler: RequestHandler = asyncHandler(async (req, res, next) => {
  try {
    const uri = getUriBehindProxy(req)
    console.log(`[liveShare][imageHandler][${uri}]: called`)
    let imageTask = await imageRepository().findFile(uri)
          Severity: Minor
          Found in src/modules/metaServer/contentHandlers/liveShare/liveShareHandlers.ts - About 1 hr to fix

            Function getPageHandler has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
            Open

            const getPageHandler = (baseDir: string) => {
  // Ensure file containing base HTML exists
  const filePath = join(baseDir, 'index.html')
  assertEx(existsSync(filePath), 'Missing index.html')
  const indexHtml = readFileSync(filePath, { encoding: 'utf8' })
            Severity: Minor
            Found in src/modules/metaServer/contentHandlers/liveShare/liveShareHandlers.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 pageHandler has 27 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

              const pageHandler: RequestHandler = asyncHandler(async (req, res, next) => {
    const adjustedPath = getAdjustedPath(req)
    if (extname(adjustedPath) === '.html') {
      try {
        const uri = getUriBehindProxy(req)
            Severity: Minor
            Found in src/modules/metaServer/contentHandlers/liveShare/liveShareHandlers.ts - About 1 hr to fix

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

              export const useSpaPage = async <T>(
  url: string,
  pageCallback: (page: Page) => Promise<T> | T,
  browserOptions: Viewport = viewPortDefaults,
  _waitForOptions: WaitForOptions = useSpaPageWaitForOptions,
              Severity: Minor
              Found in src/modules/metaServer/lib/page/usePage/useSpaPage.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

              export const isArchivistDomain = (domain: string): domain is ArchivistDomain => {
  return archivistDomains[domain as ArchivistDomain] || false
}
              Severity: Minor
              Found in src/modules/metaServer/lib/domain/isArchivistDomain.ts and 1 other location - About 40 mins to fix
              src/modules/metaServer/lib/domain/isExploreDomain.ts on lines 10..12

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

              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 const isExploreDomain = (domain: string): domain is ExploreDomain => {
  return exploreDomains[domain as ExploreDomain] || false
}
              Severity: Minor
              Found in src/modules/metaServer/lib/domain/isExploreDomain.ts and 1 other location - About 40 mins to fix
              src/modules/metaServer/lib/domain/isArchivistDomain.ts on lines 10..12

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

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

              const imageHandler: RequestHandler = asyncHandler(async (req, res, next) => {
  try {
    const uri = getUriBehindProxy(req)
    console.log(`[liveShare][imageHandler][${uri}]: called`)
    let imageTask = await imageRepository().findFile(uri)
              Severity: Minor
              Found in src/modules/metaServer/contentHandlers/liveShare/liveShareHandlers.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