Mercurial > p > roundup > code
comparison doc/upgrading.txt @ 5971:e5acd1843517
- issue2550926 - Original author adding a second message shouldn't set
status to 'chatting'.
Updates to jinja and classic tracker's statusauditor.py and new
config.ini for the detectors. Also updated upgrading.txt.
Tested classic tracker using demo.py. Test cases:
value set to false: second update sets to chatting
value set to true: update by new user sets to chatting, update by
creator of issues leaves it at unread.
missing config value in config.ini: error about missing value
value set to non-boolean: error message reports bad value with valid
values.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Thu, 07 Nov 2019 18:35:33 -0500 |
| parents | 9a980675105d |
| children | fe334430ca07 |
comparison
equal
deleted
inserted
replaced
| 5970:11a9c5b2efd4 | 5971:e5acd1843517 |
|---|---|
| 148 had 140MB of file/message data and 2500 issues with a slow 5400RPM | 148 had 140MB of file/message data and 2500 issues with a slow 5400RPM |
| 149 SATA drive. Using native indexing with sqlite took about 45 | 149 SATA drive. Using native indexing with sqlite took about 45 |
| 150 minutes. Using whoosh took about 2 hours. Using xapian took about 6 | 150 minutes. Using whoosh took about 2 hours. Using xapian took about 6 |
| 151 hours. All examples were with Python 2. Anecdotal evidence shows | 151 hours. All examples were with Python 2. Anecdotal evidence shows |
| 152 Python 3 is faster, but YMMV. | 152 Python 3 is faster, but YMMV. |
| 153 | |
| 154 Merge improvements in statusauditor.py | |
| 155 -------------------------------------- | |
| 156 | |
| 157 By default the detector statusauditor.py will change the status from | |
| 158 "unread" to "chatting" when a second message is added to an issue. | |
| 159 The distributed classic and jinja templates implement this feature in | |
| 160 their copies of ``detectors/statusauditor.py``. | |
| 161 | |
| 162 This can be a problem. Consider a person sending email to create an | |
| 163 issue. Then the person sends a followup message to add some additional | |
| 164 information to the issue. The followup message will trigger the status | |
| 165 change from "unread" to "chatting". This is misleading since the | |
| 166 person is "chatting" with themselves. | |
| 167 | |
| 168 Statusauditor.py has been enhanced to prevent the status from changing | |
| 169 to "chatting" until a second user (person) adds a message. If you | |
| 170 want this functionality, you need to merge the distributed | |
| 171 statusauditor.py with your tracker's statusauditor.py. If you have not | |
| 172 customized your tracker's statusauditor.py, copy the one from the | |
| 173 distibuted template. In addition to the python file, you also must | |
| 174 copy/merge the distributed ``detectors/config.ini`` into your | |
| 175 tracker's detectors directory. Most people can copy | |
| 176 ``detectors/config.ini`` from the distributed templates as they won't | |
| 177 have a ``detectors/config.ini`` file. (Note this is | |
| 178 ``detectors/config.ini`` do not confuse it with the main | |
| 179 ``config.ini`` file at the root of the tracker home.) | |
| 180 | |
| 181 This enhancement is disabled by default. Enable it by changing the | |
| 182 value in ``detectors/config.ini`` from: | |
| 183 | |
| 184 chatting_requires_two_users = False | |
| 185 | |
| 186 to | |
| 187 | |
| 188 chatting_requires_two_users = True | |
| 189 | |
| 190 (the values ``no`` and ``yes`` can also be used). Restart the tracker | |
| 191 to enable the change. | |
| 192 | |
| 193 If you don't do this quite right you will see one of two error | |
| 194 messages in the web interface when you try to update an issue with a | |
| 195 message:: | |
| 196 | |
| 197 Edit Error: Unsupported configuration option: Option | |
| 198 STATUSAUDITOR_CHATTING_REQUIRES_TWO_USERS not found in | |
| 199 detectors/config.ini. | |
| 200 Contact tracker admin to fix. | |
| 201 | |
| 202 This happens if detectors/config.ini is not found or is missing the | |
| 203 ``chatting_requires_two_users`` option in the ``statusauditor`` | |
| 204 section. | |
| 205 | |
| 206 If you have an incorrect value (say you use ``T`` rather than | |
| 207 ``True``) you see a different error:: | |
| 208 | |
| 209 Edit Error: Invalid value for | |
| 210 DETECTOR::STATUSAUDITOR_CHATTING_REQUIRES_TWO_USERS: 'T' | |
| 211 Allowed values: yes, no | |
| 212 | |
| 213 to fix this set the value to ``yes`` (True) or ``no`` (False). | |
| 214 | |
| 153 | 215 |
| 154 Migrating from 1.5.1 to 1.6.0 | 216 Migrating from 1.5.1 to 1.6.0 |
| 155 ============================= | 217 ============================= |
| 156 | 218 |
| 157 Update tracker config file | 219 Update tracker config file |