A bit more advanced users' activity logging

northwestwitch commented 3 weeks ago

This PR adds a functionality or fixes a bug.

Closes #4758 - The logging to file is independent from the existing system logging

Testing on cg-vm1 server (Clinical Genomics Stockholm)

**Prepare for testing** 1. Make sure the PR is pushed and available on [Docker Hub](https://hub.docker.com/repository/docker/clinicalgenomics/scout-server-stage) 1. Fist book your testing time using the Pax software available at [https://pax.scilifelab.se/](https://pax.scilifelab.se). The resource you are going to call dibs on is `scout-stage` and the server is `cg-vm1`. 1. `ssh @cg-vm1.scilifelab.se` 1. `sudo -iu hiseq.clinical` 1. `ssh localhost` 1. (optional) Find out which scout branch is currently deployed on cg-vm1: `podman ps` 1. Stop the service with current deployed branch: `systemctl --user stop scout.target` 1. Start the scout service with the branch to test: `systemctl --user start scout@` 1. Make sure the branch is deployed: `systemctl --user status scout.target` 1. After testing is done, repeat procedure at [https://pax.scilifelab.se/](https://pax.scilifelab.se), which will release the allocated resource (`scout-stage`) to be used for testing by other users.

Testing on hasta server (Clinical Genomics Stockholm)

**Prepare for testing** 1. `ssh @hasta.scilifelab.se` 1. Book your testing time using the Pax software. `us; paxa -u -s hasta -r scout-stage`. You can also use the WSGI Pax app available at [https://pax.scilifelab.se/](https://pax.scilifelab.se). 1. (optional) Find out which scout branch is currently deployed on cg-vm1: `conda activate S_scout; pip freeze | grep scout-browser` 1. Deploy the branch to test: `bash /home/proj/production/servers/resources/hasta.scilifelab.se/update-tool-stage.sh -e S_scout -t scout -b ` 1. Make sure the branch is deployed: `us; scout --version` 1. After testing is done, repeat the `paxa` procedure, which will release the allocated resource (`scout-stage`) to be used for testing by other users.

How to test:

Deploy this branch on cg-vm1
Deploy also this branch of servers ---> https://github.com/Clinical-Genomics/servers/pull/1448
Restart scout service stage
Go inside the scout container on cg-vm1 (podman exec -it <container-id> /bin/bash ) and make sure logs have been written to this following file --> /home/worker/scout_users_activity.log

Expected outcome:

Your user should be logged out and you must agree to be monitored before being able to log in again

Review:

[x] code approved by DN
[x] tests executed by CR, DN

codecov[bot] commented 3 weeks ago

Codecov Report

Attention: Patch coverage is 56.66667% with 13 lines in your changes missing coverage. Please review.

Project coverage is 84.17%. Comparing base (3ce6b1d) to head (6228dd3). Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
scout/server/app.py	60.00%	8 Missing :warning:
scout/server/blueprints/login/views.py	50.00%	5 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #4830 +/- ## ========================================== - Coverage 84.21% 84.17% -0.05% ========================================== Files 318 318 Lines 19251 19276 +25 ========================================== + Hits 16213 16226 +13 - Misses 3038 3050 +12 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

northwestwitch commented 3 weeks ago

While this seems to work OK locally (haven't tested n stage yet), It feels like I need to add the setting howto on the documentation. I think there should also be some notification to the users asking if they agree that their browsing will be recorded. For instance if the scout config contains the specific settings. log out all users and make them log in again after agreeing to the thing?

dnil commented 3 weeks ago

While this seems to work OK locally (haven't tested n stage yet), It feels like I need to add the setting howto on the documentation. I think there should also be some notification to the users asking if they agree that their browsing will be recorded. For instance if the scout config contains the specific settings. log out all users and make them log in again after agreeing to the thing?

Yes, for most hospitals/users the event log, representing our user action audit trail, will be the important part anyway. But this is straightforward enough, and with an option to enable it should be all good. Info to the users is a Good Thing. We can add an info on the landing page, describing this, the event audit log, web server logs and the user land cookies used to keep the user logged in, link the user to their google Oauth2 or LDAP identification, and temporarily store internal file permission requests like alignment files and tracks!