better exception logging

aarhusstadsarkiv · Oct 4, 2024 · 17679ad · 17679ad
1 parent aa18ecd
commit 17679ad
Show file tree

Hide file tree

Showing 12 changed files with 54 additions and 48 deletions.
diff --git a/example-config-aarhus/hooks.py b/example-config-aarhus/hooks.py
@@ -68,8 +68,8 @@ async def after_login_success(self, response: dict) -> dict:
 
                 await bookmarks.bookmarks_insert_many(user_id, bookmarks_from_file)
                 await cache.cache_set(cache_key, True)
-        except Exception as e:
-            log.exception(e)
+        except Exception:
+            log.exception("Error importing bookmarks")
             raise OpenAwsException(500, "Error importing bookmarks")
 
         return response
@@ -82,9 +82,12 @@ async def after_login_failure(self, response: dict) -> dict:
         form = await request.form()
         username = str(form.get("email"))
         if _user_mail_exists(username):
+            user_message = """Kære bruger. Du er tilknyttet det gamle system.
+    Men da vi er overgået til et nyt system, skal du oprette en ny bruger.
+    Hvis du bruger samme email vil systemet ved første login forsøge at importere data fra det gamle system."""
             raise OpenAwsException(
                 401,
-                "Kære bruger. Du er tilknyttet det gamle system. Men da vi er overgået til et nyt system, skal du oprette en ny bruger. Hvis du bruger samme email vil systemet ved første login forsøge at importere data fra det gamle system.",
+                user_message,
             )
         return response
 

diff --git a/example-config-demo/hooks.py b/example-config-demo/hooks.py
@@ -112,8 +112,8 @@ async def after_login_success(self, response: dict) -> dict:
 
                 await bookmarks.bookmarks_insert_many(user_id, bookmarks_from_file)
                 await cache.cache_set(cache_key, True)
-        except Exception as e:
-            log.exception(e)
+        except Exception:
+            log.exception("Error importing bookmarks")
             raise OpenAwsException(500, "Error importing bookmarks")
 
         return response
@@ -126,9 +126,12 @@ async def after_login_failure(self, response: dict) -> dict:
         form = await request.form()
         username = str(form.get("email"))
         if _user_mail_exists(username):
+            user_message = """Kære bruger. Du er tilknyttet det gamle system.
+    Men da vi er overgået til et nyt system, skal du oprette en ny bruger.
+    Hvis du bruger samme email vil systemet ved første login forsøge at importere data fra det gamle system."""
             raise OpenAwsException(
                 401,
-                "Kære bruger. Du er tilknyttet det gamle system. Men da vi er overgået til et nyt system, skal du oprette en ny bruger. Hvis du bruger samme email vil systemet ved første login forsøge at importere data fra det gamle system.",
+                user_message,
             )
         return response
 

diff --git a/example-config-teater/hooks.py b/example-config-teater/hooks.py
@@ -19,8 +19,8 @@ def _alter_people(context: dict) -> dict:
         people_id = people_id.lstrip("0")
         context["query_str_display"] = "people=" + people_id
 
-    except KeyError as e:
-        log.exception(e)
+    except KeyError:
+        log.exception("KeyError")
 
     return context
 
@@ -37,8 +37,8 @@ def _alter_events(context: dict) -> dict:
         event_id = event_id.lstrip("0")
         context["query_str_display"] = "events=" + event_id
 
-    except KeyError as e:
-        log.exception(e)
+    except KeyError:
+        log.exception("KeyError")
 
     return context
 

diff --git a/resources_port/run.py b/resources_port/run.py
@@ -72,8 +72,8 @@ async def main():
             resource = await api_port.proxies_get_resource(type=resource_type, id=str(id))
             resource = utf8_fix(resource)
             save_resource(id, resource)
-        except Exception as e:
-            log.exception(e)
+        except Exception:
+            log.exception("Error getting resource")
             id = id + iteration_add
             continue
 

diff --git a/stadsarkiv_client/core/date_format.py b/stadsarkiv_client/core/date_format.py
@@ -32,8 +32,8 @@ def date_format(date_string: str) -> str:
         date = datetime.strptime(date_string, date_format)
         formatted_date = format_datetime(date, format="d. MMMM y HH:mm", locale="da_DK")
         return formatted_date
-    except Exception as e:
-        log.exception(e)
+    except Exception:
+        log.exception("Error in date_format")
         return date_string
 
 
@@ -44,6 +44,6 @@ def date_format_day(date_string: str) -> str:
         date = datetime.strptime(date_string, date_format)
         formatted_date = format_date(date, format="d. MMMM y", locale="da_DK")
         return formatted_date
-    except Exception as e:
-        log.exception(e)
+    except Exception:
+        log.exception("Error in date_format_day")
         return date_string
diff --git a/stadsarkiv_client/endpoints/endpoints_admin.py b/stadsarkiv_client/endpoints/endpoints_admin.py
@@ -57,8 +57,8 @@ async def admin_users_patch(request: Request):
         flash.set_message(request, translate("User has been updated"), type="success")
         return RedirectResponse(url=redirect_url, status_code=302)
 
-    except Exception as e:
-        log.exception(e)
+    except Exception:
+        log.exception("Error in admin_users_patch")
         flash.set_message(request, translate("User could not be updated."), type="error")
         return RedirectResponse(url=redirect_url, status_code=302)
 

diff --git a/stadsarkiv_client/endpoints/endpoints_auth.py b/stadsarkiv_client/endpoints/endpoints_auth.py
@@ -53,7 +53,7 @@ async def auth_login_post(request: Request):
         flash.set_message(request, str(e), type="error")
 
     except Exception as e:
-        log.exception(e)
+        log.exception("Error in auth_login_post")
         flash.set_message(request, str(e), type="error", use_settings=True)
 
     if next_url:
@@ -80,7 +80,7 @@ async def auth_logout_post(request: Request):
     except OpenAwsException as e:
         flash.set_message(request, str(e), type="error")
     except Exception as e:
-        log.exception(e)
+        log.exception("Error in auth_logout_post")
         flash.set_message(request, str(e), type="error")
 
     return RedirectResponse(url="/auth/login", status_code=302)
@@ -130,7 +130,7 @@ async def auth_register_post(request: Request):
     except OpenAwsException as e:
         return JSONResponse({"message": str(e), "error": True})
     except Exception as e:
-        log.exception(e)
+        log.exception("Error in auth_register_post")
         return JSONResponse({"message": str(e), "error": True})
 
 
@@ -147,7 +147,7 @@ async def auth_verify(request: Request):
     except OpenAwsException as e:
         flash.set_message(request, str(e), type="error")
     except Exception as e:
-        log.exception(e)
+        log.exception("Error in auth_verify")
         flash.set_message(request, str(e), type="error", use_settings=True)
 
     return RedirectResponse(url="/auth/login", status_code=302)
@@ -178,7 +178,7 @@ async def auth_me_get(request: Request):
     except OpenAwsException as e:
         flash.set_message(request, str(e), type="error")
     except Exception as e:
-        log.exception(e)
+        log.exception("Error in auth_me_get")
         flash.set_message(request, str(e), type="error")
         return RedirectResponse(url="/auth/login", status_code=302)
 
@@ -194,7 +194,7 @@ async def auth_orders(request: Request):
     except OpenAwsException as e:
         flash.set_message(request, str(e), type="error")
     except Exception as e:
-        log.exception(e)
+        log.exception("Error in auth_orders")
         flash.set_message(request, str(e), type="error")
         return RedirectResponse(url="/auth/login", status_code=302)
 
@@ -210,7 +210,7 @@ async def auth_search_results(request: Request):
     except OpenAwsException as e:
         flash.set_message(request, str(e), type="error")
     except Exception as e:
-        log.exception(e)
+        log.exception("Error in auth_search_results")
         flash.set_message(request, str(e), type="error")
         return RedirectResponse(url="/auth/login", status_code=302)
 
@@ -232,7 +232,7 @@ async def auth_forgot_password_post(request: Request):
     except OpenAwsException as e:
         flash.set_message(request, str(e), type="error")
     except Exception as e:
-        log.exception(e)
+        log.exception("Error in auth_forgot_password_post")
         flash.set_message(request, str(e), type="error", use_settings=True)
 
     return RedirectResponse(url="/auth/forgot-password", status_code=302)
@@ -258,7 +258,7 @@ async def auth_reset_password_post(request: Request):
     except OpenAwsException as e:
         flash.set_message(request, str(e), type="error")
     except Exception as e:
-        log.exception(e)
+        log.exception("Error in auth_reset_password_post")
         flash.set_message(request, str(e), type="error", use_settings=True)
 
     token = request.path_params["token"]
@@ -277,7 +277,7 @@ async def auth_send_verify_email(request: Request):
     except OpenAwsException as e:
         flash.set_message(request, str(e), type="error")
     except Exception as e:
-        log.exception(e)
+        log.exception("Error in auth_send_verify_email")
         flash.set_message(request, str(e), type="error", use_settings=True)
 
     return RedirectResponse(url="/auth/me", status_code=302)

diff --git a/stadsarkiv_client/endpoints/endpoints_entities.py b/stadsarkiv_client/endpoints/endpoints_entities.py
@@ -27,7 +27,7 @@ async def entities_create(request: Request):
         return templates.TemplateResponse(request, "entities/entities_create.html", context)
 
     except Exception as e:
-        log.exception(e)
+        log.exception("Error in entities_create")
         raise HTTPException(500, detail=str(e), headers=None)
 
 
@@ -92,7 +92,7 @@ async def entities_delete(request: Request):
         return templates.TemplateResponse(request, "entities/entities_delete_soft.html", context)
 
     except Exception as e:
-        log.exception(e)
+        log.exception("Error in entities_delete")
         raise HTTPException(500, detail=str(e), headers=None)
 
 
@@ -127,7 +127,7 @@ async def entities_get_list(request: Request):
         return templates.TemplateResponse(request, "entities/entities_list.html", context)
 
     except Exception as e:
-        log.exception(e)
+        log.exception("Error in entities_get_list")
         raise HTTPException(500, detail=str(e), headers=None)
 
 

diff --git a/stadsarkiv_client/endpoints/endpoints_records.py b/stadsarkiv_client/endpoints/endpoints_records.py
@@ -90,8 +90,8 @@ async def get_prev_record() -> int:
         This can happen if the user uses two tabs and the search result is updated in one tab.
         """
         next_record, prev_record = await asyncio.gather(get_next_record(), get_prev_record())
-    except Exception as e:
-        log.exception(e)
+    except Exception:
+        log.exception("Error in _get_record_pagination")
         return None
 
     # Add the next and previous record to the record pagination dict
@@ -167,5 +167,5 @@ async def get_json(request: Request):
             raise HTTPException(404, detail="type not found", headers=None)
 
     except Exception as e:
-        log.exception(e)
+        log.exception("Error in get_json")
         raise HTTPException(500, detail=str(e), headers=None)
diff --git a/stadsarkiv_client/endpoints/endpoints_relations.py b/stadsarkiv_client/endpoints/endpoints_relations.py
@@ -17,11 +17,11 @@ async def relations_post(request: Request):
         return JSONResponse({"error": False, "message": "Relation er oprettet"})
 
     except OpenAwsException as e:
-        log.exception(e)
+        log.exception("Error in relations_post")
         return JSONResponse({"error": True, "message": e.message})
 
-    except Exception as e:
-        log.exception(e)
+    except Exception:
+        log.exception("Error in relations_post")
         return JSONResponse({"error": True, "message": "Internal Server Error"})
 
 
@@ -38,11 +38,11 @@ async def relations_get(request: Request):
         return JSONResponse(relations_formatted)
 
     except OpenAwsException as e:
-        log.exception(e)
+        log.exception("Error in relations_get")
         return JSONResponse({"error": True, "message": e.message})
 
-    except Exception as e:
-        log.exception(e)
+    except Exception:
+        log.exception("Error in relations_get")
         return JSONResponse({"error": True, "message": "Internal Server Error"})
 
 
@@ -53,9 +53,9 @@ async def relations_delete(request: Request):
         return JSONResponse({"error": False, "message": "Relation er slettet"})
 
     except OpenAwsException as e:
-        log.exception(e)
+        log.exception("Error in relations_delete")
         return JSONResponse({"error": True, "message": e.message})
 
-    except Exception as e:
-        log.exception(e)
+    except Exception:
+        log.exception("Error in relations_delete")
         return JSONResponse({"error": True, "message": "Internal Server Error"})
diff --git a/stadsarkiv_client/endpoints/endpoints_schemas.py b/stadsarkiv_client/endpoints/endpoints_schemas.py
@@ -48,7 +48,7 @@ async def schemas_post(request: Request):
     except JSONDecodeError:
         flash.set_message(request, translate("Invalid JSON in data."), type="error")
     except OpenAwsException as e:
-        log.exception(e)
+        log.exception("Error in schemas_post")
         flash.set_message(request, str(e), type="error")
 
     return RedirectResponse(url="/schemas", status_code=302)
diff --git a/stadsarkiv_client/endpoints/endpoints_user_data.py b/stadsarkiv_client/endpoints/endpoints_user_data.py
@@ -70,7 +70,7 @@ async def auth_bookmarks_get(request: Request):
     except OpenAwsException as e:
         flash.set_message(request, str(e), type="error")
     except Exception as e:
-        log.exception(e)
+        log.exception("Error in auth_bookmarks_get")
         flash.set_message(request, str(e), type="error")
         return RedirectResponse(url="/auth/login", status_code=302)
 
@@ -86,7 +86,7 @@ async def auth_bookmarks_json(request: Request):
         bookmarks_list = [bookmark["bookmark"] for bookmark in bookmarks_db]
         return JSONResponse(bookmarks_list, status_code=200)
     except OpenAwsException as e:
-        log.exception(e)
+        log.exception("Error in auth_bookmarks_json")
         json_data = {"message": str(e), "error": True}
         return JSONResponse(json_data, status_code=400)
 
@@ -111,12 +111,12 @@ async def auth_bookmarks_post(request: Request):
             await bookmarks.bookmarks_insert(user_id, json_data["record_id"])
 
     except OpenAwsException as e:
-        log.exception(e)
+        log.exception("Error in auth_bookmarks_post")
         json_data = {"message": str(e), "error": True}
         return JSONResponse(json_data, status_code=400)
 
     except Exception as e:
-        log.exception(e)
+        log.exception("Error in auth_bookmarks_post")
         json_data = {"message": str(e), "error": True}
         return JSONResponse(json_data, status_code=400)