task/WP-930: Audit Trails UI #1594

erikriv16 · 2025-07-15T18:18:42Z

Overview:

This PR introduces an Audit Data Trails admin page that allows users to look up recent session activity by entering a username. It retrieves the most recent session and displays all associated actions across multiple portals.

PR Status:

Ready.
Work in Progress.
Hold.

Related Jira tickets:

WP-930

Summary of Changes:

Created a new admin view under the Designsafe portal for audit trail lookups
Implemented backend logic to:
- Retrieve the most recent session for a given username
- Query all associated audit actions tied to that session across portals
- Basic frontend added with search input and results display
- Placeholder for future file search integration

Testing Steps:

Get updated designsafe.env from stache with Audit Trails secrets
From the top-right dropdown menu, select "Audit Trails Admin"
For testing purposes:
- Enter the username "joyce_cywu" to generate a populated example
- To test other users, comment out the second query in portal/designsafe/apps/audit/views.py
Confirm that audit actions from the most recent session are being fetched and displayed correctly

UI Photos:

Notes:

…ounts", not sure if supposed to follow same way other tab on there are created or make something completely new, have UI set up in html under "terms and conditions" in manage account section.

… Changed names on dropdown menu for type of search, implemented username auto-search dropdown menu capability for easier selection, added css file for AuditTrials.tsx

…ing point if mess up

erikriv16 · 2025-07-15T18:47:49Z

Need recommendation if I should create new hook files to handle getting the query information from the functions in audit/views.py, maybe like a useUserAudit.ts for the username search and a useFileAudit.ts for the file search. Also if I should ignore most of the missing module docstring errors I'm getting on serverside linting because other apps.py and urls.py in the codebase don't have them at all.

designsafe/apps/accounts/urls.py

designsafe/apps/accounts/templates/designsafe/apps/accounts/base.html

designsafe/apps/audit/apps.py

designsafe/apps/audit/urls.py

designsafe/apps/audit/views.py

designsafe/templates/includes/header.html

designsafe/urls.py

client/src/audit/AuditTrail.tsx

rstijerina · 2025-07-16T18:54:18Z

Need recommendation if I should create new hook files to handle getting the query information from the functions in audit/views.py, maybe like a useUserAudit.ts for the username search and a useFileAudit.ts for the file search. Also if I should ignore most of the missing module docstring errors I'm getting on serverside linting because other apps.py and urls.py in the codebase don't have them at all.

Yes, new hooks would be good.

Serverside linting is r.e. trailing whitespace and missing newlines:

 ************* Module designsafe.apps.audit.__init__
designsafe/apps/audit/__init__.py:1:0: C0304: Final newline missing (missing-final-newline)
************* Module designsafe.apps.audit.apps
designsafe/apps/audit/apps.py:8:43: C0303: Trailing whitespace (trailing-whitespace)
designsafe/apps/audit/apps.py:4:0: C0115: Missing class docstring (missing-class-docstring)
************* Module designsafe.apps.audit.urls
designsafe/apps/audit/urls.py:10:0: C0304: Final newline missing (missing-final-newline)
************* Module designsafe.apps.audit.views
designsafe/apps/audit/views.py:49:0: C0303: Trailing whitespace (trailing-whitespace)
designsafe/apps/audit/views.py:116:0: C0303: Trailing whitespace (trailing-whitespace)
designsafe/apps/audit/views.py:120:0: C0304: Final newline missing (missing-final-newline)
designsafe/apps/audit/views.py:56:11: W0718: Catching too general exception Exception (broad-exception-caught)
designsafe/apps/audit/views.py:118:11: W0718: Catching too general exception Exception (broad-exception-caught)

client/src/audit/AuditTrail.tsx

conf/nginx/certificates/-

…tsxm removed unnecessary files

…se.html Co-authored-by: Sal Tijerina <[email protected]>

fnets

This is looking super clean, and easy to read! Thanks so much!

I think what we need now is some unit testing and to address the linting errors that are popping up. You can usually check these locally by running the same script that github actions does (npx nx format:check and pylint)

client/modules/_hooks/src/audit/useGetRecentSession.ts

client/src/audit/AuditTrail.tsx

designsafe/apps/audit/views.py

fnets

There's some work to be done on these tests, still. But a great start!

designsafe/apps/audit/tests.py

… include (essential-graphrag.pdf, TAPIS_ERROR_ex_file.png) --case insensitive, still need to implement file tracking from submitJob action, need to figure out file tracking on tapis side, and fix small bugs on both ends

…Job included, and try to rework UI into more of a tree like format

designsafe/apps/audit/tests.py

rstijerina

Some really good work here connecting pieces together. I think we can clean it up a bit

rstijerina · 2025-09-11T21:29:55Z

designsafe/templates/includes/header.html

Can you point me to what changed in this file?

rstijerina · 2025-09-11T21:33:46Z

designsafe/apps/audit/views.py

Any reason we don't want to use class based views here? You could use the AuthenticatedApiView, which would cut down on repeated @login_required decorators

rstijerina · 2025-09-11T21:36:12Z

client/src/audit/AuditTrailSessionTable.tsx

+
+      {auditData?.data && auditData.data.length > 0 && (
+        <div className="styles.tableWrapper">
+          <table


In the future, I would suggest using antd's Table component

rstijerina · 2025-09-11T21:37:24Z

client/src/audit/AuditTrailFileTimeline.tsx

+  //using in filetable as well, maybe move to another file?
+  const formatTimestamp = (timestamp: string) => {
+    const date = new Date(timestamp);
+    return date.toLocaleString('en-US', {
+      hour: 'numeric',
+      minute: '2-digit',
+      hour12: true,
+      month: 'numeric',
+      day: 'numeric',
+      year: '2-digit',
+    });
+  };


If duplicated, best to pull out into a util file somewhere, and import from there

I was thinking this too but not sure if it would have been best to pull out to utils, thank you!

rstijerina · 2025-09-11T21:43:54Z

client/src/audit/AuditTrail.tsx

+
+  return (
+    <div>
+      <form onSubmit={onSearch} style={{ marginBottom: 16 }}>


Antd components would give us some nice UI styling for free

rstijerina · 2025-09-11T21:50:30Z

designsafe/apps/audit/views.py

+            FROM public.portal_audit
+            WHERE username = %s
+            ORDER BY timestamp DESC
+            LIMIT 1


Do we only want 1 response?

Yes, here we only limit it to 1 because we only look for the single most recent session.

rstijerina · 2025-09-11T21:51:39Z

designsafe/apps/audit/views.py

+    def get_path_without_filename(full_path):
+        """Extract path without filename"""
+        if not full_path or "." not in full_path.split("/")[-1]:
+            return full_path
+        return "/".join(full_path.rstrip("/").split("/")[:-1])
+
+    def get_filename_from_path(full_path):
+        return full_path.rstrip("/").split("/")[-1].lower()
+
+    def normalize_dir_path(p):


I think we'll want to refactor this to not have nested functions

rstijerina · 2025-09-11T21:52:02Z

designsafe/apps/audit/views.py

+
+
+@login_required
+def get_rename_portal_search(request, filename):


Is this the same as get_upload_portal_search?

No, so this one handles things a little differently, but uses get_upload_portal_search() if the upload row is found to get its full trace.

fnets · 2025-09-15T16:55:14Z

designsafe/settings/test_settings.py

    'designsafe.apps.api.publications_v2',
    'designsafe.apps.api.filemeta',
    'designsafe.apps.accounts',
+    'designsafe.apps.audit',


Since we're not running tests, you'll want to remove this line.

fnets

I would second Sal's comments, and there's a small part of turning off your unit tests that still needs to be done.

TACC Staff and others added 10 commits June 18, 2025 10:36

Adding audit trail to dropdown under Welcome, user! under "manage acc…

d08025a

…ounts", not sure if supposed to follow same way other tab on there are created or make something completely new, have UI set up in html under "terms and conditions" in manage account section.

New audit trails page made

4ae5c54

Returning JSON for most recent session with username as input woring

8d47648

Working UI for recent session, good starting point

6857f50

Added pop-up modal functionality for data column (now named Details),…

8c3e670

… Changed names on dropdown menu for type of search, implemented username auto-search dropdown menu capability for easier selection, added css file for AuditTrials.tsx

Merge remote-tracking branch 'origin/main' into task/WP-930

e6458ca

Added antd modal feature, data at bottom of modal, another good start…

530138a

…ing point if mess up

Merge main into task/WP-930

8077e97

Initial push

2287234

Removed comments

e06ce9e

Delete unnecessary add-ons, linting error fixes

31f2134

rstijerina changed the title ~~Task/WP-930~~ task/WP-930: Audit Trails UI Jul 16, 2025

rstijerina reviewed Jul 16, 2025

View reviewed changes

fnets reviewed Jul 18, 2025

View reviewed changes

client/src/audit/AuditTrail.tsx Outdated Show resolved Hide resolved

fnets reviewed Jul 21, 2025

View reviewed changes

conf/nginx/certificates/- Outdated Show resolved Hide resolved

TACC Staff and others added 3 commits July 22, 2025 11:33

Added extra lines to files, added hooks, minor changes to audittrail.…

4d1876b

…tsxm removed unnecessary files

Update designsafe/apps/accounts/templates/designsafe/apps/accounts/ba…

7ddcc49

…se.html Co-authored-by: Sal Tijerina <[email protected]>

Merge branch 'main' into task/WP-930

12ce212

fnets requested changes Jul 28, 2025

View reviewed changes

client/modules/_hooks/src/audit/useGetRecentSession.ts Outdated Show resolved Hide resolved

client/src/audit/AuditTrail.tsx Outdated Show resolved Hide resolved

client/src/audit/AuditTrail.tsx Outdated Show resolved Hide resolved

designsafe/apps/audit/views.py Outdated Show resolved Hide resolved

jarosenb marked this pull request as draft August 1, 2025 18:27

TACC Staff added 2 commits August 6, 2025 11:38

Fixed react/server side linting errors

76f98e3

Added seperate file for table and added unit tests

fd31273

fnets requested changes Aug 6, 2025

View reviewed changes

designsafe/apps/audit/tests.py Outdated Show resolved Hide resolved

designsafe/apps/audit/tests.py Outdated Show resolved Hide resolved

TACC Staff added 3 commits August 13, 2025 11:21

Another good saving point, going to try to rework search, have submit…

3779d92

…Job included, and try to rework UI into more of a tree like format

Added functioning file search feature

8776e11

fnets reviewed Sep 8, 2025

View reviewed changes

designsafe/apps/audit/tests.py Outdated Show resolved Hide resolved

Removed tests.py, fixed linting errors

2cf8247

TACC Staff added 2 commits September 8, 2025 21:57

Fixed linting errors

0459011

last lint check

d497c04

fnets self-requested a review September 9, 2025 14:33

rstijerina marked this pull request as ready for review September 11, 2025 21:26

Merge branch 'main' into task/WP-930

915d9af

rstijerina reviewed Sep 11, 2025

View reviewed changes

Merge branch 'main' into task/WP-930

c955edb

fnets reviewed Sep 15, 2025

View reviewed changes

fnets self-requested a review September 15, 2025 16:58

fnets reviewed Sep 15, 2025

View reviewed changes



		@login_required
		def get_rename_portal_search(request, filename):

task/WP-930: Audit Trails UI #1594

Are you sure you want to change the base?

task/WP-930: Audit Trails UI #1594

Uh oh!

Conversation

erikriv16 commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview:

PR Status:

Related Jira tickets:

Summary of Changes:

Testing Steps:

UI Photos:

Notes:

Uh oh!

erikriv16 commented Jul 15, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rstijerina commented Jul 16, 2025

Uh oh!

Uh oh!

Uh oh!

fnets left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fnets left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rstijerina left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fnets left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

erikriv16 commented Jul 15, 2025 •

edited

Loading