CI test hangs, local tests pass

[charlieforward9]

I have a workflow file that calls npx vitest --coverage.enabled true. When I run this command locally, my tests pass and I see a coverage report within 40 seconds, however, when I push the changes to GH, the workflow runs indefinitely, hanging and providing me with no information or timeout.

Please advise on how to debug this. This is my test config:

test: {
    browser: {
      enabled: true,
      name: "chromium",
      provider: "playwright",
      headless: true,
      viewport: { width: 1280, height: 720 }, 
    },
    setupFiles: ["src/tests/mocks/setup.ts"],
    coverage: {
      provider: "v8",
      reporter: ["text", "json-summary", "json", "html"],
      include: ["src/**/*"], 
      exclude: ["src/tests/*", "**/__tests__/*"], 
      thresholds: {
        autoUpdate: true,
      },
      reportOnFailure: true,
    },
    server: {
      deps: {
        inline: ["aws-amplify", "@aws-amplify"],
      },
    },
  },

Problem persists on v2 and v3

[AriPerkkio]

So on CI the tests pass but it gets stuck while reporting coverage?

Maybe the overwritten coverage.exclude here is picking unexpected files on CI? Try using the approach mentioned in documentation: https://vitest.dev/config/#coverage-exclude

- import { defineConfig } from 'vitest/config'
+ import { coverageConfigDefaults, defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    coverage: {
-      exclude: ["src/tests/*", "**/__tests__/*"], 
+      exclude: ["src/tests/*", "**/__tests__/*", ...coverageConfigDefaults.exclude], 
    },
  },
})

[charlieforward9]

Thank you for the assistance. I am not clear where this environment variable DEBUG=vitest:coverage should be going, and I cannot find any docs on it. Can you please help me understand where it should go.

[AriPerkkio]

If you are running your code on Linux or Mac on the CI, you can use following in your package.json:

{
  "scripts": {
-    "test": "vitest"
+    "test": "DEBUG=vitest:coverage vitest"
  }
}

[charlieforward9]

runs-on: ubuntu-latest

I tried this, but no luck. It seems like it hanging before it reaches the coverage report, the last log I see before it hangs is related to tests, not the coverage, and its never the same log, always a different final line before freezing.

There are a few spots in my test suite where I've had to mock a print() dialog from popping up, but seeing that does not show up anymore and hang my local tests, I cant imagine that is still the problem.

Are there any other work arounds / debug approaches I could try?

[AriPerkkio]

I would recommend to start narrowing down the root cause into a minimal reproduction. Remove coverage, remove test files one-by-one until it doesn't fail anymore. Without seeing the code this is pretty much just guessing.

[charlieforward9]

Removing coverage got the CI script to finish. With all tests passing on CI without coverage, I restored the coverage.enabled true flag, and it once again, hangs.

The last lines that are logged before it hangs are the pretty standard looking ✅ chromium ... [x]ms, and then it just stays there. Nothing about starting coverage, etc to explore.

Even with the DEBUG variable, I am not seeing any logs regarding why it is hanging, and like before it does not hang at all on local coverage runs.

Is your recommendation to still remove test files? I have a bit too many to count, so avoiding this step would be preferred, knowing they all pass without coverage.