Skip to content

Commit

Permalink
Improve comment
Browse files Browse the repository at this point in the history
Thanks to @salvo_sf_fan
  • Loading branch information
ppigazzini committed Feb 28, 2024
1 parent 9af4606 commit 4bee31b
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions server/fishtest/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,15 @@
Important note
==============
All APIs that rely on get_run() should be served from a single Fishtest instance.
It's essential to note that validate_request() can also utilize get_run().
Therefore, any APIs using self.validate_request("/api/<route>") could also
requires to be served from the same Fishtest instance.
If other instances require information about runs, they should directly query the database.
However, please be aware that this information might be slightly outdated,
depending on how frequently the main instance flushes its run cache.
All APIs that rely on the `run_cache` of `rundb.get_run()`
must be served from the main Fishtest instance.
Note that `self.validate_request("/api/<route>")`
uses `rundb.get_run()` under some conditions.
If other Fishtest instances need information about runs,
they should query the database directly.
However, keep in mind that this information might be slightly outdated.
This depends on how frequently the main instance flushes its `run_cache`.
"""

WORKER_VERSION = 230
Expand Down

0 comments on commit 4bee31b

Please sign in to comment.