Files
@ 8ad40ef0ea80
Branch filter:
Location: kallithea/docs/usage/troubleshooting.rst - annotation
8ad40ef0ea80
2.3 KiB
text/prs.fallenstein.rst
db: add some PullRequest.query() shortcuts
This makes database query code more explicit and increases readability.
E.g. the function name get_pullrequest_cnt_for_user was bad, because the
concept of "pullrequest for user" is incredibly vague, and could refer
to any kind of association between PRs and users. (Quiz time! Does it
mean that the user is the PR owner, that the user is reviewing, or that
the user has commented on the PR and thus is receiving notifications?)
A descriptive name could be "get_open_pull_request_count_for_reviewer",
because the function is indeed only concerned with reviewers and only
with open pull requests. But at this point, we might as well say
PullRequest.query(reviewer_id=user, include_closed=False).count()
which is only slightly longer, and doesn't require us to write dozens
of little wrapper functions (including, any moment now, a separate
function for listing the PRs instead of counting them).
Note that we're not actually going down an abstraction level by doing
this. We're still operating on the concepts of "pull request", "open"
and "reviewer", and are not leaking database implementation details.
The query() shortcuts are designed so they default to not altering
the query. Any processing requires explicit opt-in by the caller.
This makes database query code more explicit and increases readability.
E.g. the function name get_pullrequest_cnt_for_user was bad, because the
concept of "pullrequest for user" is incredibly vague, and could refer
to any kind of association between PRs and users. (Quiz time! Does it
mean that the user is the PR owner, that the user is reviewing, or that
the user has commented on the PR and thus is receiving notifications?)
A descriptive name could be "get_open_pull_request_count_for_reviewer",
because the function is indeed only concerned with reviewers and only
with open pull requests. But at this point, we might as well say
PullRequest.query(reviewer_id=user, include_closed=False).count()
which is only slightly longer, and doesn't require us to write dozens
of little wrapper functions (including, any moment now, a separate
function for listing the PRs instead of counting them).
Note that we're not actually going down an abstraction level by doing
this. We're still operating on the concepts of "pull request", "open"
and "reviewer", and are not leaking database implementation details.
The query() shortcuts are designed so they default to not altering
the query. Any processing requires explicit opt-in by the caller.
aa90719e8520 aa90719e8520 aa90719e8520 aa90719e8520 aa90719e8520 aa90719e8520 aa90719e8520 4e6dfdb3fa01 8b8edfc25856 aa90719e8520 4e6dfdb3fa01 8b8edfc25856 8b8edfc25856 aa90719e8520 aa90719e8520 4e6dfdb3fa01 4e6dfdb3fa01 aa90719e8520 aa90719e8520 8b8edfc25856 aa90719e8520 4e6dfdb3fa01 4e6dfdb3fa01 8b8edfc25856 8b8edfc25856 aa90719e8520 aa90719e8520 4e6dfdb3fa01 4e6dfdb3fa01 aa90719e8520 aa90719e8520 aa90719e8520 aa90719e8520 aa90719e8520 4e6dfdb3fa01 aa90719e8520 aa90719e8520 aa90719e8520 aa90719e8520 4e6dfdb3fa01 4e6dfdb3fa01 aa90719e8520 aa90719e8520 aa90719e8520 03bbd33bc084 4e6dfdb3fa01 4e6dfdb3fa01 4e6dfdb3fa01 4e6dfdb3fa01 4e6dfdb3fa01 4e6dfdb3fa01 aa90719e8520 aa90719e8520 aa90719e8520 03bbd33bc084 03bbd33bc084 aa90719e8520 af2059eead28 af2059eead28 af2059eead28 03bbd33bc084 4a99684543f7 4a99684543f7 4a99684543f7 4a99684543f7 84d2a9aaa1a4 4e6dfdb3fa01 4a99684543f7 af2059eead28 aa90719e8520 aa90719e8520 aa90719e8520 aa90719e8520 aa90719e8520 aa90719e8520 | .. _troubleshooting:
===============
Troubleshooting
===============
:Q: **Missing static files?**
:A: Make sure either to set the ``static_files = true`` in the .ini file or
double check the root path for your http setup. It should point to
for example:
``/home/my-virtual-python/lib/python2.7/site-packages/kallithea/public``
|
:Q: **Can't install celery/rabbitmq?**
:A: Don't worry. Kallithea works without them, too. No extra setup is required.
Try out the great Celery docs for further help.
|
:Q: **Long lasting push timeouts?**
:A: Make sure you set a longer timeout in your proxy/fcgi settings. Timeouts
are caused by the http server and not Kallithea.
|
:Q: **Large pushes timeouts?**
:A: Make sure you set a proper ``max_body_size`` for the http server. Very often
Apache, Nginx, or other http servers kill the connection due to to large
body.
|
:Q: **Apache doesn't pass basicAuth on pull/push?**
:A: Make sure you added ``WSGIPassAuthorization true``.
|
:Q: **Git fails on push/pull?**
:A: Make sure you're using a WSGI http server that can handle chunked encoding
such as ``waitress`` or ``gunicorn``.
|
:Q: **How can I use hooks in Kallithea?**
:A: It's easy if they are Python hooks: just use advanced link in
hooks section in Admin panel, that works only for Mercurial. If
you want to use Git hooks, just install th proper one in the repository,
e.g., create a file `/gitrepo/hooks/pre-receive`. You can also use
Kallithea-extensions to connect to callback hooks, for both Git
and Mercurial.
|
:Q: **Kallithea is slow for me, how can I make it faster?**
:A: See the :ref:`performance` section.
|
:Q: **UnicodeDecodeError on Apache mod_wsgi**
:A: Please read: https://docs.djangoproject.com/en/dev/howto/deployment/wsgi/modwsgi/#if-you-get-a-unicodeencodeerror.
|
:Q: **Requests hanging on Windows**
:A: Please try out with disabled Antivirus software, there are some known problems with Eset Antivirus. Make sure
you have installed the latest Windows patches (especially KB2789397).
.. _virtualenv: http://pypi.python.org/pypi/virtualenv
.. _python: http://www.python.org/
.. _mercurial: http://mercurial.selenic.com/
.. _celery: http://celeryproject.org/
.. _rabbitmq: http://www.rabbitmq.com/
.. _python-ldap: http://www.python-ldap.org/
|