Skip to content

Docs/jest warning frontend tests#1148

Open
JITENDRAGAHERWAR03 wants to merge 4 commits intoAOSSIE-Org:mainfrom
JITENDRAGAHERWAR03:docs/jest-warning-frontend-tests
Open

Docs/jest warning frontend tests#1148
JITENDRAGAHERWAR03 wants to merge 4 commits intoAOSSIE-Org:mainfrom
JITENDRAGAHERWAR03:docs/jest-warning-frontend-tests

Conversation

@JITENDRAGAHERWAR03
Copy link

@JITENDRAGAHERWAR03 JITENDRAGAHERWAR03 commented Feb 4, 2026

Summary

Adds documentation clarifying a common Jest warning that appears after successful frontend test runs.

Details

When running frontend tests, Jest may print the warning:

“Jest did not exit one second after the test run has completed.”

All tests still pass successfully, and the application functions as expected. This warning is typically caused by open async handles such as timers, watchers, or dev-server related processes and does not indicate a test failure.

Without clarification, this message can confuse new contributors into thinking the test suite or setup is broken.

This PR adds a short troubleshooting note explaining:

  • Why the warning appears
  • When it is safe to ignore
  • How contributors can optionally debug it using --detectOpenHandles

Scope

  • 📄 Documentation only
  • ❌ No code changes

Testing

  • Frontend tests executed successfully on Windows 11

Related Issue

Closes #1137

Summary by CodeRabbit

  • Documentation
    • Clarified that ONNX Runtime warnings on Windows 11 are harmless and do not indicate compatibility problems; added guidance so users can safely ignore the message.
    • Documented Jest’s non-fatal “did not exit” warning after frontend tests, explained possible causes, and added debugging guidance (e.g., running tests with --detectOpenHandles).

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 4, 2026

📝 Walkthrough

Walkthrough

Added two documentation notes to the Manual Setup Guide: one clarifying an innocuous ONNX Runtime warning on Windows 11, and one explaining a non-failing Jest "did not exit one second" warning and how to debug it.

Changes

Cohort / File(s) Summary
Documentation
docs/Manual_Setup_Guide.md
Added a note about an OS-version warning from ONNX Runtime on Windows 11 (harmless) and a note about Jest printing "did not exit one second" after successful frontend tests, including a debugging hint (npm test -- --detectOpenHandles).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I hopped through lines of docs so spry,
Two tiny warnings caught my eye,
ONNX and Jest now clear and bright,
Tests still pass — hop on, delight! 🥕

🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Out of Scope Changes check ⚠️ Warning The ONNX Runtime Windows 11 warning documentation is out of scope relative to the stated objectives which focus solely on Jest warning documentation. Consider removing the ONNX Runtime section or creating a separate PR, as it is unrelated to issue #1137.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title partially relates to the changeset, focusing on Jest warning and frontend tests, but omits the ONNX Runtime warning documentation also added.
Linked Issues check ✅ Passed All objectives from issue #1137 are met: Jest warning is explained, causes are documented, expected outcome is clarified, and debugging guidance is provided.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In `@docs/Manual_Setup_Guide.md`:
- Line 183: The markdown heading "### ONNX Runtime warning on Windows 11 (safe
to ignore)" has leading spaces; remove the leading spaces so the heading starts
at column 0 (i.e., change the line to begin with "### ONNX Runtime warning on
Windows 11 (safe to ignore)") to comply with Markdown conventions and fix the
indentation.
- Line 203: Update the compound modifier "dev-server related" to the hyphenated
form "dev-server-related" in the sentence containing "open async handles such as
timers, watchers, or dev-server related processes" so the phrase reads
"...timers, watchers, or dev-server-related processes."; edit the Markdown line
where that phrase appears and ensure spacing and punctuation remain correct.
🧹 Nitpick comments (1)
docs/Manual_Setup_Guide.md (1)

207-207: Format the npm command as a code block.

For consistency with other commands in the documentation, the npm command should be formatted as a code block.

📝 Proposed fix
 For debugging purposes, contributors can optionally run:
-npm test -- --detectOpenHandles
+```bash
+npm test -- --detectOpenHandles
+```


For other systems, consult your distribution's documentation.

### ONNX Runtime warning on Windows 11 (safe to ignore)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix heading indentation.

The heading has leading spaces, which violates markdown conventions. Headings should start at the beginning of the line (column 0).

📝 Proposed fix
-  ### ONNX Runtime warning on Windows 11 (safe to ignore)
+### ONNX Runtime warning on Windows 11 (safe to ignore)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### ONNX Runtime warning on Windows 11 (safe to ignore)
### ONNX Runtime warning on Windows 11 (safe to ignore)
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)

[warning] 183-183: Headings must start at the beginning of the line

(MD023, heading-start-left)

🤖 Prompt for AI Agents
In `@docs/Manual_Setup_Guide.md` at line 183, The markdown heading "### ONNX
Runtime warning on Windows 11 (safe to ignore)" has leading spaces; remove the
leading spaces so the heading starts at column 0 (i.e., change the line to begin
with "### ONNX Runtime warning on Windows 11 (safe to ignore)") to comply with
Markdown conventions and fix the indentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC: Jest warning shown after successful frontend tests (“Jest did not exit one second after the test run”)

1 participant