xylabs/sdk-meta-server-nodejs

View on GitHub

Showing 11 of 15 total issues

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' })

    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' })

    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)) {

        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' })

          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)

            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' })

            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)

              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

              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