Skip to content

Debug stopped while try to run server: debug #8313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
2 tasks done
smit9924 opened this issue Aug 17, 2024 · 2 comments
Closed
2 tasks done

Debug stopped while try to run server: debug #8313

smit9924 opened this issue Aug 17, 2024 · 2 comments
Labels
bug Something isn't working documentation Documentation should be updated

Comments

@smit9924
Copy link
Contributor

Actions before raising this issue

  • I searched the existing issues and did not find anything similar.
  • I read/searched the docs

Steps to Reproduce

  1. follow steps one by one mentioned in official documentation to setup development environment.
    Link: https://docs.cvat.ai/docs/contributing/development-environment/
  2. Issue occurs at this step.
    image

While try to run server: debug then getting error popup in VS Code saying "debug stopped" without any error message.
Screenshot 2024-08-11 121755

Expected Behavior

Expected behavior for this steps is to system should start all backed services for CVAT mentioned in launch.json file. And then we should be able to access all APIs in fronted without getting any error.

Possible Solution

I spent a significant amount of time debugging an issue and eventually identified the root cause of the DEBUG STOPPED error popup. The issue arose while setting up the CVAT development environment in WSL (Windows Subsystem for Linux).

1. Debugging the issue:

  • I followed the official CVAT documentation and tried to open VS Code by running the following command: source .env/bin/activate && code

  • However, instead of opening VS Code inside the WSL environment, it opened in another location outside of WSL.

  • When I attempted to run the server:debug , it failed because it couldn't locate the appropriate Python compiler path.

  • The system was mistakenly searching for the compiler in the C drive, which led to the debug process failing and prevented the backend services from starting.

2. Solution

  • To resolve this problem, it is necessary to install the WSL vs code extension authored by Microsoft. To find the extension click here.
    image

  • Once the extension is installed, the server:debug command will run successfully without any errors and all the backed services for CVAT will by up successfully.

3. My Recommendation

  • I recommend that the CVAT documentation include a note specifically for Windows users, advising them to install the WSL VS Code extension when setting up the development environment. This addition would help prevent similar issues for other users and ensure a smoother setup process.

Context

No response

Environment

WSL Ubuntu 22.04 (windows 11)
@smit9924 smit9924 added the bug Something isn't working label Aug 17, 2024
@smit9924
Copy link
Contributor Author

I request mentor to add documentation label to this issue.

smit9924 added a commit to smit9924/cvat that referenced this issue Aug 17, 2024
…ment setup guide (cvat-ai#8313)

- This commit adds a step to the CVAT development setup guide for users working with WSL (Windows Subsystem for Linux). The added instruction guides users to install the VS Code extension for WSL, ensuring that Visual Studio Code opens correctly inside the WSL environment.

- This change addresses an issue where users might encounter a 'DEBUG STOPPED' error if the extension is not installed, improving the overall setup experience.

- Related to issue cvat-ai#8313.
@azhavoro azhavoro added the documentation Documentation should be updated label Aug 19, 2024
azhavoro added a commit that referenced this issue Aug 20, 2024
- This commit adds a step to the CVAT development setup guide for users
working with WSL (Windows Subsystem for Linux). The added instruction
guides users to install the VS Code extension for WSL, ensuring that
Visual Studio Code opens correctly inside the WSL environment.

- This change addresses an issue where users might encounter a 'DEBUG
STOPPED' error if the extension is not installed, improving the overall
setup experience.

- Related to issue #8313.

<!-- Raise an issue to propose your change
(https://github.com/cvat-ai/cvat/issues).
It helps to avoid duplication of efforts from multiple independent
contributors.
Discuss your ideas with maintainers to be sure that changes will be
approved and merged.
Read the [Contribution guide](https://docs.cvat.ai/docs/contributing/).
-->

<!-- Provide a general summary of your changes in the Title above -->

### Motivation and context
<!-- Why is this change required? What problem does it solve? If it
fixes an open
issue, please link to the issue here. Describe your changes in detail,
add
screenshots. -->

### How has this been tested?
<!-- Please describe in detail how you tested your changes.
Include details of your testing environment, and the tests you ran to
see how your change affects other areas of the code, etc. -->

### Checklist
<!-- Go over all the following points, and put an `x` in all the boxes
that apply.
If an item isn't applicable for some reason, then ~~explicitly
strikethrough~~ the whole
line. If you don't do that, GitHub will show incorrect progress for the
pull request.
If you're unsure about any of these, don't hesitate to ask. We're here
to help! -->
- [x] I submit my changes into the `develop` branch
- [ ] I have created a changelog fragment <!-- see top comment in
CHANGELOG.md -->
- [x] I have updated the documentation accordingly
- [ ] I have added tests to cover my changes
- [x] I have linked related issues (see [GitHub docs](

https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword))
- [ ] I have increased versions of npm packages if it is necessary

([cvat-canvas](https://github.com/cvat-ai/cvat/tree/develop/cvat-canvas#versioning),

[cvat-core](https://github.com/cvat-ai/cvat/tree/develop/cvat-core#versioning),

[cvat-data](https://github.com/cvat-ai/cvat/tree/develop/cvat-data#versioning)
and

[cvat-ui](https://github.com/cvat-ai/cvat/tree/develop/cvat-ui#versioning))

### License

- [x] I submit _my code changes_ under the same [MIT License](
https://github.com/cvat-ai/cvat/blob/develop/LICENSE) that covers the
project.
  Feel free to contact the maintainers if that's a concern.


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Documentation**
- Added instructions for installing a Visual Studio Code extension for
WSL to improve the development environment setup.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Andrey Zhavoronkov <[email protected]>
@azhavoro
Copy link
Contributor

Fixed in #8314

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Documentation should be updated
Projects
None yet
Development

No branches or pull requests

2 participants