Categorize audit logs by log type #5063
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rgraber
force-pushed
the
TASK-955-add-log-type
branch
from
0e92ebb
to
8846b48
Compare
rgraber
force-pushed
the
TASK-955-add-log-type
branch
from
8846b48
to
efd0593
Compare
noliveleger
requested changes
Aug 21, 2024
| USER_MANAGEMENT = 'user-management' | ||
| ASSET_MANAGEMENT = 'asset-management' | ||
| SUBMISSION_MANAGEMENT = 'submission-management' | ||
|
|
There was a problem hiding this comment.
PEP-8: 2 blank lines between classes ;-)
kobo/apps/audit_log/models.py
Outdated
| @@ -48,6 +57,7 @@ class AuditLog(models.Model): | |||
| db_index=True | |||
| ) | |||
| user_uid = models.CharField(db_index=True, max_length=UUID_LENGTH + 1) # 1 is prefix length | |||
| log_type = models.CharField(choices=AuditType.choices) | |||
There was a problem hiding this comment.
is it a criteria we are going to (often) use to narrow down query? I think I would use db_index=True?
What do you think?
| @@ -31,7 +31,7 @@ def test_delete_user(self): | |||
|
|
|||
| # Create dummy logs for someuser | |||
| audit_log = AuditLog.objects.create( | |||
| app_label='foo', model_name='bar', object_id=1, user=someuser | |||
| app_label='foo', model_name='bar', object_id=1, user=someuser, log_type=AuditType.ACCESS, | |||
There was a problem hiding this comment.
It seems to be over the 80 characters per line limit?
kobo/apps/trash_bin/utils.py
Outdated
| @@ -138,6 +139,7 @@ def move_to_trash( | |||
| **{fk_field_name: obj_dict['pk']}, | |||
| ) | |||
| ) | |||
| log_type = AuditType.USER_MANAGEMENT if related_model._meta.model_name == 'user' else AuditType.ASSET_MANAGEMENT | |||
There was a problem hiding this comment.
Please reformat to keep 80-ish characters per line ;-)
kobo/apps/trash_bin/utils.py
Outdated
| @@ -217,6 +220,7 @@ def put_back( | |||
|
|
|||
| if del_pto_count != len(obj_ids): | |||
| raise TrashTaskInProgressError | |||
| log_type = AuditType.USER_MANAGEMENT if related_model._meta.model_name == 'user' else AuditType.ASSET_MANAGEMENT | |||
There was a problem hiding this comment.
Please reformat to keep 80-ish characters per line ;-)
| @@ -789,7 +789,7 @@ def test_audit_log_on_delete(self): | |||
| model_name, | |||
| ) = self.asset.deployment.submission_model.get_app_label_and_model_name() | |||
| audit_log_count = AuditLog.objects.filter( | |||
| user=self.someuser, app_label=app_label, model_name=model_name | |||
| user=self.someuser, app_label=app_label, model_name=model_name, log_type=AuditType.SUBMISSION_MANAGEMENT, | |||
There was a problem hiding this comment.
Please reformat to keep 80-ish characters per line ;-)
| @@ -799,7 +799,8 @@ def test_audit_log_on_delete(self): | |||
| # All submissions have been deleted and should be logged | |||
| deleted_submission_ids = AuditLog.objects.values_list( | |||
| 'pk', flat=True | |||
| ).filter(user=self.someuser, app_label=app_label, model_name=model_name) | |||
| ).filter(user=self.someuser, app_label=app_label, model_name=model_name, | |||
There was a problem hiding this comment.
Does not seem to be black-formatted?
rgraber
force-pushed
the
TASK-955-add-log-type
branch
from
adadc56
to
643bbc6
Compare
noliveleger
approved these changes
Aug 21, 2024
| ), | ||
| preserve_default=False, |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
Description
Distinguish audit logs pertaining to different categories (access, user management, submission management, project history, data editing, and asset management).
Notes
Adds a new log_type field to the AuditLog model (and a sql query to backfill any existing audit logs). This will allow us to better filter the endpoints to get only access logs, only project history logs, etc. No change is made to the endpoint, that will be done in other PRs, but the model change will make that easier down the road.
The categories to backfill the existing audit logs for everything but access logs may end up being changed in the future but are good enough approximations for now. Since we are currently only logging deletes/put-back for assets, submissions, and users, the categories in the runsql should cover all existing audit logs and allow us to make the field not-nullable.