added notes about rq worker return values

freedomofpress · Apr 2, 2019 · dfde2be · dfde2be
1 parent 6e43c3b
commit dfde2be
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 0 deletions.
diff --git a/securedrop/rm.py b/securedrop/rm.py
@@ -21,4 +21,5 @@
 
 def srm(fn):
     subprocess.check_call(['srm', '-r', fn])
+    # We need to return a non-`None` value so the rq worker writes this back to Redis
     return "success"
diff --git a/securedrop/store.py b/securedrop/store.py
@@ -216,6 +216,7 @@ def queued_add_checksum_for_file(db_model, model_id, file_path, db_uri):
     session = sessionmaker(bind=create_engine(db_uri))()
     db_obj = session.query(db_model).filter_by(id=model_id).one()
     add_checksum_for_file(session, db_obj, file_path)
+    # We need to return a non-`None` value so the rq worker writes this back to Redis
     return "success"
 
 

diff --git a/securedrop/tests/utils/async.py b/securedrop/tests/utils/async.py
@@ -4,6 +4,7 @@
 """
 import time
 
+# This is an arbitarily defined value in the SD codebase and not something from rqworker
 REDIS_SUCCESS_RETURN_VALUE = 'success'