Skip to content
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

Fix #299: Updated Troubleshooting docs #300

Merged
merged 4 commits into from
Apr 3, 2024
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions Troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ Here are some general troubleshooting tips for Oppia. The platform specific tips
- [No Module functools\_lru\_cache](#no-module-functools_lru_cache)
- [No Module appengine.api](#no-module-appengineapi)
- [ModuleNotFoundError: No module named \_bz2](#modulenotfounderror-no-module-named-_bz2)
- [Subprocess.CalledProcessError: Command 'yarn install --pure-lockfile' returned non-zero exit status 1](#subprocesscalledprocesserror-command-yarn-install---pure-lockfile-returned-non-zero-exit-status-1)

- [Mac OS](#mac-os)
- [Python 2 is not available](#python-2-is-not-available-1)
- [Error: alert\_on\_exit() -\> Iterator\[None\]](#error-alert_on_exit---iteratornone)
Expand Down Expand Up @@ -404,6 +406,34 @@ If this error occurs within a virtual environment, try reinstalling the libs by
1. Install bz2 headers. Use the command `sudo apt-get install libbz2-dev` on Ubuntu.
2. Install Python 3 again so that the bz2 library gets included in `~/.pyenv/versions/3.8.15/lib/python3.8/`. Use the command `pyenv install 3.8.15`.

### Subprocess.CalledProcessError: Command 'yarn install --pure-lockfile' returned non-zero exit status 1

If you get error like this when running ``python -m scripts.start``:
```
Traceback (most recent call last):
Copy link
Member

Choose a reason for hiding this comment

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

This is the traceback, can you add a few lines of preceding error logs as well, maybe around 6-7 lines.

Because if you see these discussions oppia/oppia#17425, oppia/oppia#18428, oppia/oppia#14814, these all have this same error but different reasons to why it occurred and thus different solutions.

Copy link
Member Author

Choose a reason for hiding this comment

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

@Ash-2k3 The error log I pasted here is from this comment. Can you please tell me if there is a way to reproduce these errors? I am not sure about the exact error logs I encountered as it has been a month and I can't recall them precisely.

Copy link
Member

Choose a reason for hiding this comment

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

I am not sure what to do in this case, maybe apart from your changes, let's provide links to these issues that I mentioned and ask them to follow those, if your solution didn't work for them ? wdyt

Copy link
Member Author

Choose a reason for hiding this comment

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

@Ash-2k3 After my solution ends I will put a note telling that this is very generalized solution, if this solution doesn't work well with folks so they can look the issues listed below!! how about this?

Copy link
Member

Choose a reason for hiding this comment

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

Sounds good, thanks!

Copy link
Member Author

Choose a reason for hiding this comment

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

Done!

File "/home/hardik/.pyenv/versions/3.8.15/lib/python3.8/runpy.py", line 194, in _run_module_as_main
return _run_code(code, main_globals, None,
File "/home/hardik/.pyenv/versions/3.8.15/lib/python3.8/runpy.py", line 87, in _run_code
exec(code, run_globals)
File "/home/hardik/opensource/oppia/scripts/start.py", line 33, in <module>
install_third_party_libs.main()
File "/home/hardik/opensource/oppia/scripts/install_third_party_libs.py", line 234, in main
subprocess.check_call([get_yarn_command(), 'install', '--pure-lockfile'])
File "/home/hardik/.pyenv/versions/3.8.15/lib/python3.8/subprocess.py", line 364, in check_call
raise CalledProcessError(retcode, cmd)
subprocess.CalledProcessError: Command '['yarn', 'install', '--pure-lockfile']' returned non-zero exit status 1.
```
- In ``opensource/`` i.e parent folder of ``oppia/``, run below commands :
```
sudo apt install cmdtest
```

```
npm install yarn
```
> Note :- This solution is generalized, if doesn't solves your problem kindly check similar discussions listed below [oppia/oppia#17425](https://github.com/oppia/oppia/discussions/17425), [oppia/oppia#18428](https://github.com/oppia/oppia/discussions/18428), [oppia/oppia#14814](https://github.com/oppia/oppia/discussions/14814)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
> Note :- This solution is generalized, if doesn't solves your problem kindly check similar discussions listed below [oppia/oppia#17425](https://github.com/oppia/oppia/discussions/17425), [oppia/oppia#18428](https://github.com/oppia/oppia/discussions/18428), [oppia/oppia#14814](https://github.com/oppia/oppia/discussions/14814)
> Note :- If the above solution doesn't work, please go through the following answered discussions and try the solution mentioned there. [oppia/oppia#17425](https://github.com/oppia/oppia/discussions/17425), [oppia/oppia#18428](https://github.com/oppia/oppia/discussions/18428), [oppia/oppia#14814](https://github.com/oppia/oppia/discussions/14814)

Copy link
Member Author

Choose a reason for hiding this comment

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

Done!



## Mac OS

### Python 2 is not available
Expand Down
Loading