diff --git a/.gitignore b/.gitignore index dbcc6364ed..8695a3d148 100644 --- a/.gitignore +++ b/.gitignore @@ -20,6 +20,7 @@ designsafe/templates/react-assets.html designsafe.env mysql.env rabbitmq.env +ngrok.env rabbitmq.conf mysql.cnf @@ -35,6 +36,7 @@ designsafe/apps/dashboard/templates/designsafe/apps/dashboard/index.html designsafe/apps/notifications/templates/designsafe/apps/notifications/index.html designsafe/apps/nco/templates/designsafe/apps/nco/nco_index.html designsafe/apps/nco/templates/designsafe/apps/nco/ttc_grants.html +designsafe/apps/onboarding/templates/designsafe/apps/onboarding/index.html # local config files conf/elasticsearch/logging.yml diff --git a/.pylintrc b/.pylintrc index d8f0f80226..3458e31246 100644 --- a/.pylintrc +++ b/.pylintrc @@ -52,7 +52,7 @@ ignore=CVS,tests.py # ignore-list. The regex matches against paths and can be in Posix or Windows # format. Because '\\' represents the directory delimiter on Windows systems, # it can't be used as an escape character. -ignore-paths=^.*migrations/.*$,^.*_tests/.*$,^.*unit_test.*$ +ignore-paths=^.*migrations/.*$,^.*_tests/.*$,^.*unit_test.*$,^.*test_.*$ # Files or directories matching the regular expression patterns are skipped. # The regex matches against base names, not paths. The default value ignores diff --git a/Makefile b/Makefile index 0104e5c8b2..dc85626ec1 100644 --- a/Makefile +++ b/Makefile @@ -1,3 +1,9 @@ +NGROK_ENV_FILE = ./conf/env_files/ngrok.env +ifeq ("$(wildcard $(NGROK_ENV_FILE))","") + NGROK_ENV_FILE = ./conf/env_files/ngrok.sample.env +endif + + .PHONY: build build: docker compose -f ./conf/docker/docker-compose.yml build @@ -8,16 +14,16 @@ build-dev: .PHONY: start start: - docker compose -f ./conf/docker/docker-compose-dev.all.debug.yml up + docker compose --env-file $(NGROK_ENV_FILE) -f ./conf/docker/docker-compose-dev.all.debug.yml up .PHONY: stop stop: - docker compose -f ./conf/docker/docker-compose-dev.all.debug.yml down + docker compose --env-file $(NGROK_ENV_FILE) -f ./conf/docker/docker-compose-dev.all.debug.yml down .PHONY: start-m1 start-m1: - docker compose -f ./conf/docker/docker-compose-dev.all.debug.m1.yml up + docker compose --env-file $(NGROK_ENV_FILE) -f ./conf/docker/docker-compose-dev.all.debug.m1.yml up .PHONY: stop-m1 stop-m1: - docker compose -f ./conf/docker/docker-compose-dev.all.debug.m1.yml down + docker compose --env-file $(NGROK_ENV_FILE) -f ./conf/docker/docker-compose-dev.all.debug.m1.yml down diff --git a/README.md b/README.md index b2e91f8b7a..58dc9bc4b8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,3 @@ -[![Build Status](https://travis-ci.org/DesignSafe-CI/portal.svg?branch=master)](https://travis-ci.org/DesignSafe-CI/portal) -[![codecov](https://codecov.io/gh/DesignSafe-CI/portal/branch/master/graph/badge.svg)](https://codecov.io/gh/DesignSafe-CI/portal) - # DesignSafe-CI Portal ## Prequisites for running the portal application @@ -11,8 +8,8 @@ on. - [Install Docker][3] - [Install Docker Compose][4] -- [Install Make][12] -- [Node.js][13] 16.x +- [Install Make][11] +- [Node.js][12] 20.x If you are on a Mac or a Windows machine, the recommended method is to install [Docker Desktop][5], which will install both Docker and Docker Compose, which is required to run Docker on Mac/Windows hosts. @@ -35,18 +32,23 @@ If you are on a Mac or a Windows machine, the recommended method is to install Required variables: - `DJANGO_DEBUG`: should be set to `True` for development - - `DJANGO_SECRET`: should be changed for production + - `DJANGO_SECRET_KEY`: should be changed for production - `TAS_*`: should be set to enable direct access to `django.contrib.admin` - - `AGAVE_*`: should be set to enable Agave API integration (authentication, etc.) + - `TAPIS_*`: should be set to enable Tapis API integration (authentication, etc.) - `RT_*`: should be set to enable ticketing Make a copy of [rabbitmq.sample.env](conf/env_files/rabbitmq.sample.env) then rename it to `rabbitmq.env`. - Make a copy of [external_resource_secrets.sample.py](designsafe/settings/external_resource_secrets.sample.py) - and rename it to `external_resource_secrets.py`. +3. Configure ngrok + + a. Install [ngrok](https://ngrok.com/docs/getting-started/), and create an ngrok account. + + b. Copy [conf/env_files/ngrok.sample.env](conf/env_files/ngrok.sample.env) to `conf/env_files/ngrok.env`. -3. Build the containers and frontend packages + c. In `conf/env_files/ngrok.env`, set the `NGROK_AUTHTOKEN` and `NGROK_DOMAIN` variables using your authtoken and static ngrok domain found in your [ngrok dashboard](https://dashboard.ngrok.com/). + +4. Build the containers and frontend packages 1. Containers: ```sh @@ -72,7 +74,7 @@ If you are on a Mac or a Windows machine, the recommended method is to install npm run start ``` -4. Start local containers +5. Start local containers ``` $ make start @@ -89,11 +91,11 @@ If you are on a Mac or a Windows machine, the recommended method is to install $ ./manage.py createsuperuser ``` -5. Setup local access to the portal: +6. Setup local access to the portal: Add a record to your local hosts file for `127.0.0.1 designsafe.dev` ``` - sudo vim /etc/hosts + $ sudo vim /etc/hosts ``` Now you can navigate to [designsafe.dev](designsafe.dev) in your browser. @@ -178,11 +180,10 @@ See the [DesignSafe Styles Reference][7] for style reference and custom CSS docu ### Updating Python dependencies -For simplicity the Dockerfile uses a `requirements.txt` exported from Poetry. To add a new dependency: +This project uses [Python Poetry](https://python-poetry.org/docs/) to manage dependencies. To add a new dependency: 1. Run `poetry add $NEW_DEPENDENCY`. -2. Run `poetry export > requirements.txt --dev --without-hashes` in the repository root. -3. Rebuild the dev image with `docker-compose -f conf/docker/docker-compose.yml build` +2. Rebuild the dev image with `make build-dev` ## Testing @@ -200,16 +201,14 @@ Django tests should be written according to standard [Django testing procedures] You can run Django tests with the following command: ```shell -$ docker exec -it des_django pytest designsafe +$ docker exec -it des_django pytest -ra designsafe ``` ### Frontend tests -Frontend tests are [Jasmine][9] tests executed using the [Karma engine][10]. Testing -guidelines can be found in the [AngularJS Developer Guide on Unit Testing][11]. +Frontend tests are [Vitest][9] tests executed using [Nx][10]. -To run frontend tests, ensure that all scripts and test scripts are configured in -[`karma-conf.js`](karma-conf.js) and then run the command: +To run frontend tests, run the command: ```shell $ npm run test @@ -217,47 +216,31 @@ $ npm run test ## Development setup -Use `docker-compose` to run the portal in development. The default compose file, -[`docker-compose.yml`](docker-compose.yml) runs the main django server in development +Use `docker compose` to run the portal in development. The default compose file, +[`docker-compose.yml`](conf/docker/docker-compose.yml) runs the main django server in development mode with a redis service for websockets support. You can optionally enable the EF sites for testing. ```shell -$ docker-compose -f conf/docker/docker-compose.yml build -$ docker-compose -f conf/docker/docker-compose-dev.all.debug.yml up -$ npm run dev +$ make build-dev +$ make start +$ npm run start +$ docker run -v `pwd`:`pwd` -w `pwd` -it node:16 /bin/bash -c "npm run dev" ``` When using this compose file, your Tapis Client should be configured with a `callback_url` of `http://$DOCKER_HOST_IP:8000/auth/tapis/callback/`. -For developing some services, e.g. Box.com integration, https support is required. To -enable an Nginx http proxy run using the [`docker-compose-http.yml`](docker-compose-http.yml) -file. This file configures the same services as the default compose file, but it also sets -up an Nginx proxy secured by a self-signed certificate. ```shell $ docker-compose -f docker-compose-http.yml build $ docker-compose -f docker-compose-http.yml up ``` -### Agave filesystem setup -1. Delete all of the old metadata objects using this command: - - `metadata-list Q '{"name": "designsafe metadata"}' | while read x; do metadata-delete $x; done;` -2. Run `dsapi/agave/tools/bin/walker.py` to create the metadata objects for the existing files in your FS. - - `python portal/dsapi/agave/tools/bin/walker.py ` - - `base_folder` is your username, if you want to fix everything under your home dir. - - `command`: - - `files`: Walk through the files and print their path. - - `meta`: Walk through the metadata objs in a filesystem-like manner and print their path. - - `files-fix`: Check if there's a meta obj for every file, if not create the meta obj. - - `meta-fix`: Check if there's a file for every meta obj, if not delete the meta obj. ## Production setup -Production deployment is managed by ansible. See https://github.com/designsafe-ci/ansible. +Production deployment is managed by Camino. See https://github.com/TACC/Camino. [1]: https://docs.docker.com/ @@ -267,8 +250,7 @@ Production deployment is managed by ansible. See https://github.com/designsafe-c [5]: https://docs.docker.com/desktop/ [7]: https://github.com/DesignSafe-CI/portal/wiki/CSS-Styles-Reference [8]: https://docs.djangoproject.com/en/dev/topics/testing/ -[9]: http://jasmine.github.io/1.3/introduction.html -[10]: http://karma-runner.github.io/0.12/intro/installation.html -[11]: https://docs.angularjs.org/guide/unit-testing -[12]: https://www.gnu.org/software/make/ -[13]: https://nodejs.org/ +[9]: https://vitest.dev/ +[10]: https://nx.dev/getting-started/intro +[11]: https://www.gnu.org/software/make/ +[12]: https://nodejs.org/ diff --git a/client/modules/_hooks/src/datafiles/projects/types.ts b/client/modules/_hooks/src/datafiles/projects/types.ts index 29f27e6813..55415964e2 100644 --- a/client/modules/_hooks/src/datafiles/projects/types.ts +++ b/client/modules/_hooks/src/datafiles/projects/types.ts @@ -160,6 +160,7 @@ export type TPreviewTreeData = { uuid: string; value: TEntityValue; order: number; + version?: number; publicationDate?: string; children: TPreviewTreeData[]; }; diff --git a/client/modules/_hooks/src/index.ts b/client/modules/_hooks/src/index.ts index 9cc3682b42..d67631ac08 100644 --- a/client/modules/_hooks/src/index.ts +++ b/client/modules/_hooks/src/index.ts @@ -5,3 +5,4 @@ export * from './workspace'; export * from './datafiles'; export * from './systems'; export * from './notifications'; +export * from './onboarding'; diff --git a/client/modules/_hooks/src/notifications/useNotifications.ts b/client/modules/_hooks/src/notifications/useNotifications.ts index 566a0633ed..cfbcebe900 100644 --- a/client/modules/_hooks/src/notifications/useNotifications.ts +++ b/client/modules/_hooks/src/notifications/useNotifications.ts @@ -6,7 +6,11 @@ import { } from '@tanstack/react-query'; import apiClient from '../apiClient'; -type TPortalEventType = 'data_depot' | 'job' | 'interactive_session_ready'; +type TPortalEventType = + | 'data_depot' + | 'job' + | 'interactive_session_ready' + | 'markAllNotificationsAsRead'; export type TJobStatusNotification = { action_link: string; diff --git a/client/modules/_hooks/src/onboarding/index.ts b/client/modules/_hooks/src/onboarding/index.ts new file mode 100644 index 0000000000..1d5717cfd4 --- /dev/null +++ b/client/modules/_hooks/src/onboarding/index.ts @@ -0,0 +1,2 @@ +export * from './useOnboarding'; +export * from './types'; diff --git a/client/modules/_hooks/src/onboarding/types.ts b/client/modules/_hooks/src/onboarding/types.ts new file mode 100644 index 0000000000..ba32bd3199 --- /dev/null +++ b/client/modules/_hooks/src/onboarding/types.ts @@ -0,0 +1,51 @@ +export type TSetupStepEvent = { + step: string; + username: string; + state: string; + time: string; + message: string; + data?: { + setupComplete: boolean; + } | null; +}; + +export type TOnboardingStep = { + step: string; + displayName: string; + description: string; + userConfirm: string; + staffApprove: string; + staffDeny: string; + state?: string | null; + events: TSetupStepEvent[]; + data?: { + userlink?: { + url: string; + text: string; + }; + } | null; + customStatus?: string | null; +}; + +export type TOnboardingUser = { + username: string; + email: string; + firstName: string; + lastName: string; + isStaff: boolean; + setupComplete: boolean; + steps: TOnboardingStep[]; +}; + +export type TOnboardingAdminList = { + users: TOnboardingUser[]; + total: number; + totalSteps: number; +}; + +export type TOnboardingAdminActions = + | 'staff_approve' + | 'staff_deny' + | 'user_confirm' + | 'complete' + | 'reset'; diff --git a/client/modules/_hooks/src/onboarding/useOnboarding.ts b/client/modules/_hooks/src/onboarding/useOnboarding.ts new file mode 100644 index 0000000000..29373547f8 --- /dev/null +++ b/client/modules/_hooks/src/onboarding/useOnboarding.ts @@ -0,0 +1,113 @@ +import { useQuery, useMutation, useSuspenseQuery } from '@tanstack/react-query'; +import { useSearchParams } from 'react-router-dom'; +import { + TOnboardingUser, + TOnboardingAdminList, + TSetupStepEvent, + TOnboardingAdminActions, +} from './types'; +import apiClient, { type TApiError } from '../apiClient'; + +export type TOnboardingAdminParams = { + showIncompleteOnly?: boolean; + q?: string; + limit?: number; + page?: number; + orderBy?: string; +}; + +type TOnboardingActionBody = { + step: string; + action: TOnboardingAdminActions; +}; + +type TGetOnboardingAdminListResponse = { + response: TOnboardingAdminList; + status: number; +}; + +type TGetOnboardingUserResponse = { + response: TOnboardingUser; + status: number; +}; + +type TSendOnboardingActionResponse = { + response: TSetupStepEvent; + status: number; +}; + +async function getOnboardingAdminList(params: TOnboardingAdminParams) { + const res = await apiClient.get( + `api/onboarding/admin/`, + { + params, + } + ); + return res.data.response; +} + +async function getOnboardingUser(username: string) { + const res = await apiClient.get( + `api/onboarding/user/${username}` + ); + return res.data.response; +} + +async function sendOnboardingAction( + body: TOnboardingActionBody, + username?: string +) { + const res = await apiClient.post( + `api/onboarding/user/${username}/`, + body + ); + return res.data.response; +} + +const getOnboardingAdminListQuery = (queryParams: TOnboardingAdminParams) => ({ + queryKey: ['onboarding', 'adminList', queryParams], + queryFn: () => getOnboardingAdminList(queryParams), +}); +export function useGetOnboardingAdminList() { + const [searchParams] = useSearchParams(); + const q = searchParams.get('q') || undefined; + const showIncompleteOnly = searchParams.get('showIncompleteOnly') || 'false'; + const limit = searchParams.get('limit') || '20'; + const page = searchParams.get('page') || '1'; + const orderBy = searchParams.get('orderBy') || undefined; + return useQuery( + getOnboardingAdminListQuery({ + q, + showIncompleteOnly: showIncompleteOnly === 'true', + limit: +limit, + page: +page, + orderBy, + }) + ); +} + +const getOnboardingUserQuery = (username: string) => ({ + queryKey: ['onboarding', 'user', username], + queryFn: () => getOnboardingUser(username), +}); +export function useGetOnboardingUser(username: string) { + return useQuery(getOnboardingUserQuery(username)); +} +export const useGetOnboardingUserSuspense = (username: string) => { + return useSuspenseQuery(getOnboardingUserQuery(username)); +}; + +export function useSendOnboardingAction() { + return useMutation({ + mutationFn: ({ + body, + username, + }: { + body: TOnboardingActionBody; + username: string; + }) => { + return sendOnboardingAction(body, username); + }, + onError: (err: TApiError) => err, + }); +} diff --git a/client/modules/_hooks/src/useAuthenticatedUser.ts b/client/modules/_hooks/src/useAuthenticatedUser.ts index 794e20176a..88cd0e307d 100644 --- a/client/modules/_hooks/src/useAuthenticatedUser.ts +++ b/client/modules/_hooks/src/useAuthenticatedUser.ts @@ -5,6 +5,8 @@ export type TUser = { email: string; institution: string; homedir: string; + isStaff: boolean; + setupComplete: boolean; }; declare global { diff --git a/client/modules/_hooks/src/workspace/index.ts b/client/modules/_hooks/src/workspace/index.ts index d9b8661bcc..94e373286a 100644 --- a/client/modules/_hooks/src/workspace/index.ts +++ b/client/modules/_hooks/src/workspace/index.ts @@ -18,3 +18,4 @@ export * from './useGetJobs'; export * from './usePostJobs'; export * from './types'; export * from './useGetAllocations'; +export * from './useInteractiveModalContext'; diff --git a/client/modules/_hooks/src/workspace/types.ts b/client/modules/_hooks/src/workspace/types.ts index 9d73e2ef6a..c7832906e8 100644 --- a/client/modules/_hooks/src/workspace/types.ts +++ b/client/modules/_hooks/src/workspace/types.ts @@ -1,6 +1,7 @@ export type TParameterSetNotes = { isHidden?: boolean; fieldType?: string; + inputType?: string; validator?: { regex: string; message: string; @@ -113,6 +114,8 @@ export type TTapisApp = { queueFilter?: string[]; hideQueue?: boolean; hideAllocation?: boolean; + hideMaxMinutes?: boolean; + jobLaunchDescription?: string; }; uuid: string; deleted: boolean; @@ -191,7 +194,7 @@ export type TTapisJob = { stageAppTransactionId?: string; status: string; subscriptions: string; - tags: string[]; + tags: string[] | null; tapisQueue: string; tenant: string; uuid: string; diff --git a/client/modules/_hooks/src/workspace/useInteractiveModalContext.ts b/client/modules/_hooks/src/workspace/useInteractiveModalContext.ts new file mode 100644 index 0000000000..f896c28bf4 --- /dev/null +++ b/client/modules/_hooks/src/workspace/useInteractiveModalContext.ts @@ -0,0 +1,21 @@ +import React, { createContext, useContext } from 'react'; + +type TInteractiveModalDetails = { + show: boolean; + interactiveSessionLink?: string; + message?: string; + openedBySubmit?: boolean; + uuid?: string; +}; + +export type TInteractiveModalContext = [ + TInteractiveModalDetails, + React.Dispatch> +]; + +export const InteractiveModalContext = + createContext(null); + +export const useInteractiveModalContext = () => { + return useContext(InteractiveModalContext); +}; diff --git a/client/modules/_test-fixtures/src/fixtures/onboarding/onboarding-admin-listing.json b/client/modules/_test-fixtures/src/fixtures/onboarding/onboarding-admin-listing.json new file mode 100644 index 0000000000..de44f662ce --- /dev/null +++ b/client/modules/_test-fixtures/src/fixtures/onboarding/onboarding-admin-listing.json @@ -0,0 +1,220 @@ +{ + "status": 200, + "response": { + "users": [ + { + "username": "testuser2", + "lastName": "last2", + "firstName": "first2", + "email": "first2last2@university.edu", + "isStaff": false, + "steps": [ + { + "step": "designsafe.apps.onboarding.steps.project_membership.ProjectMembershipStep", + "displayName": "Checking Project Membership", + "description": "This confirms if you have access to the project. If not, request access and\n wait for the system administrator’s approval.", + "userConfirm": "Request Project Access", + "staffApprove": "Add to DesignSafe project", + "staffDeny": "Deny Project Access Request", + "state": "completed", + "events": [ + { + "step": "designsafe.apps.onboarding.steps.project_membership.ProjectMembershipStep", + "username": "testuser2", + "state": "completed", + "time": "2024-10-16 22:36:52.769105+00:00", + "message": "You have the required project membership to access this portal.", + "data": null + }, + { + "step": "designsafe.apps.onboarding.steps.project_membership.ProjectMembershipStep", + "username": "testuser2", + "state": "processing", + "time": "2024-10-16 22:36:51.250723+00:00", + "message": "Beginning automated processing", + "data": null + }, + { + "step": "designsafe.apps.onboarding.steps.project_membership.ProjectMembershipStep", + "username": "testuser2", + "state": "pending", + "time": "2024-10-16 22:10:27.244633+00:00", + "message": "Awaiting project membership check", + "data": null + } + ], + "data": null + }, + { + "step": "designsafe.apps.onboarding.steps.allocation.AllocationStep", + "displayName": "Allocations", + "description": "Accessing your allocations. If unsuccessful, verify the PI has added you to the allocations for this project.", + "userConfirm": "Confirm", + "staffApprove": "Approve", + "staffDeny": "Deny", + "state": "completed", + "events": [ + { + "step": "designsafe.apps.onboarding.steps.allocation.AllocationStep", + "username": "testuser2", + "state": "completed", + "time": "2024-10-16 22:36:45.804477+00:00", + "message": "Allocations retrieved", + "data": { + "hosts": { + "ls6.tacc.utexas.edu": [ + "TACC-ACI", + "APCD-dev", + "PT2050-DataX", + "DesignSafe-Community", + "IBN22007", + "DesignSafe-DCV", + "DesignSafe-Corral", + "TACC-ACI-CIC", + "DS-HPC1", + "A2CPS" + ], + "data.tacc.utexas.edu": [ + "NeuroNex-3DEM", + "TACC-ACI", + "DesignSafe-Corral" + ], + "ranch.tacc.utexas.edu": ["DesignSafe-Community"], + "vista.tacc.utexas.edu": [ + "TACC-ACI", + "DesignSafe-Corral", + "TACC-ACI-CIC" + ], + "frontera.tacc.utexas.edu": [ + "TACC-ACI", + "DesignSafe-Community", + "DesignSafe-DCV", + "DesignSafe-Corral", + "TACC-ACI-CIC", + "A2CPS", + "DS-HPC1" + ], + "stampede3.tacc.utexas.edu": [ + "TACC-ACI", + "DesignSafe-Community", + "DesignSafe-DCV", + "DesignSafe-Corral", + "TACC-ACI-CIC", + "DS-HPC1" + ] + } + } + }, + { + "step": "designsafe.apps.onboarding.steps.allocation.AllocationStep", + "username": "testuser2", + "state": "processing", + "time": "2024-10-16 22:36:43.466479+00:00", + "message": "Retrieving your allocations", + "data": null + }, + { + "step": "designsafe.apps.onboarding.steps.allocation.AllocationStep", + "username": "testuser2", + "state": "processing", + "time": "2024-10-16 22:36:43.355484+00:00", + "message": "Beginning automated processing", + "data": null + }, + { + "step": "designsafe.apps.onboarding.steps.allocation.AllocationStep", + "username": "testuser2", + "state": "pending", + "time": "2024-10-16 22:36:43.156603+00:00", + "message": "Awaiting allocation retrieval", + "data": null + } + ], + "data": null + }, + { + "step": "designsafe.apps.onboarding.steps.system_access_v3.SystemAccessStepV3", + "displayName": "System Access", + "description": "Setting up access to TACC storage and execution systems. No action required.", + "userConfirm": "Confirm", + "staffApprove": "Approve", + "staffDeny": "Deny", + "state": "completed", + "events": [ + { + "step": "designsafe.apps.onboarding.steps.system_access_v3.SystemAccessStepV3", + "username": "testuser2", + "state": "completed", + "time": "2024-10-16 22:36:50.968677+00:00", + "message": "User is processed.", + "data": null + }, + { + "step": "designsafe.apps.onboarding.steps.system_access_v3.SystemAccessStepV3", + "username": "testuser2", + "state": "processing", + "time": "2024-10-16 22:36:50.851077+00:00", + "message": "Credentials already created for system: cloud.data", + "data": null + }, + { + "step": "designsafe.apps.onboarding.steps.system_access_v3.SystemAccessStepV3", + "username": "testuser2", + "state": "processing", + "time": "2024-10-16 22:36:47.644630+00:00", + "message": "Successfully granted permissions for system: frontera", + "data": null + }, + { + "step": "designsafe.apps.onboarding.steps.system_access_v3.SystemAccessStepV3", + "username": "testuser2", + "state": "processing", + "time": "2024-10-16 22:36:47.065659+00:00", + "message": "Successfully granted permissions for system: stampede3", + "data": null + }, + { + "step": "designsafe.apps.onboarding.steps.system_access_v3.SystemAccessStepV3", + "username": "testuser2", + "state": "processing", + "time": "2024-10-16 22:36:46.605071+00:00", + "message": "Successfully granted permissions for system: cloud.data", + "data": null + }, + { + "step": "designsafe.apps.onboarding.steps.system_access_v3.SystemAccessStepV3", + "username": "testuser2", + "state": "processing", + "time": "2024-10-16 22:36:45.956481+00:00", + "message": "Processing system access for user sal", + "data": null + }, + { + "step": "designsafe.apps.onboarding.steps.system_access_v3.SystemAccessStepV3", + "username": "testuser2", + "state": "processing", + "time": "2024-10-16 22:36:45.883764+00:00", + "message": "Beginning automated processing", + "data": null + }, + { + "step": "designsafe.apps.onboarding.steps.system_access_v3.SystemAccessStepV3", + "username": "testuser2", + "state": "pending", + "time": "2024-10-16 22:10:26.862693+00:00", + "message": "Awaiting TACC systems access.", + "data": null + } + ], + "data": null + } + ], + "setupComplete": true + } + ], + "offset": 0, + "limit": 4, + "total": 400, + "totalSteps": 3 + } +} diff --git a/client/modules/_test-fixtures/src/index.ts b/client/modules/_test-fixtures/src/index.ts index b0fb7efd96..a55a8c75d4 100644 --- a/client/modules/_test-fixtures/src/index.ts +++ b/client/modules/_test-fixtures/src/index.ts @@ -1,3 +1,4 @@ export * from './server'; export * from './render'; export { default as appsListingJson } from './fixtures/workspace/apps-tray-listing.json'; +export { default as onboardingAdminListingJson } from './fixtures/onboarding/onboarding-admin-listing.json'; diff --git a/client/modules/datafiles/src/DatafilesToolbar/DatafilesToolbar.spec.tsx b/client/modules/datafiles/src/DatafilesToolbar/DatafilesToolbar.spec.tsx new file mode 100644 index 0000000000..d9293cb5d2 --- /dev/null +++ b/client/modules/datafiles/src/DatafilesToolbar/DatafilesToolbar.spec.tsx @@ -0,0 +1,225 @@ +import { getToolbarRules } from './DatafilesToolbar'; +import { TFileListing } from '@client/hooks'; + +export const fileFixtures = { + txtFile: { + system: 'project-9876543210668535791-242ac118-0001-012', + name: 'test.txt', + path: '/test.txt', + format: 'raw', + type: 'file', + mimeType: 'text/plain', + lastModified: '2024-10-03T19:44:11Z', + length: 10000, + permissions: 'READ', + } as TFileListing, + + anotherTxtFile: { + system: 'project-9876543210668535791-242ac118-0001-012', + name: 'another_test.txt', + path: '/another_test.txt', + format: 'raw', + type: 'file', + mimeType: 'text/plain', + lastModified: '2024-10-03T19:44:11Z', + length: 10000, + permissions: 'READ', + } as TFileListing, + + hazmapperFile: { + system: 'project-9876543210668535791-242ac118-0001-012', + name: 'test.hazmapper', + path: '/test.hazmapper', + format: 'raw', + type: 'file', + mimeType: '', + lastModified: '2024-10-04T00:50:22Z', + length: 100, + permissions: 'READ', + } as TFileListing, + + subDirectory: { + system: 'project-9876543210668535791-242ac118-0001-012', + name: 'test', + path: '/test', + format: 'folder', + type: 'dir', + mimeType: '', + lastModified: '2024-10-03T19:44:51Z', + length: 4096, + permissions: 'READ', + } as TFileListing, +}; + +describe('getToolbarRules', () => { + const USER_WORK_SYSTEM = 'user_work_system'; + + test('should disable all buttons when no files are selected', () => { + const selectedFiles: TFileListing[] = []; + const isAuthenticated = true; + const isReadOnly = false; + const system = 'other_system'; + + const rules = getToolbarRules( + selectedFiles, + isReadOnly, + isAuthenticated, + system, + USER_WORK_SYSTEM + ); + + expect(rules.canPreview).toBe(false); + expect(rules.canRename).toBe(false); + expect(rules.canCopy).toBe(false); + expect(rules.canMove).toBe(false); + expect(rules.canTrash).toBe(false); + expect(rules.canDownload).toBe(false); + }); + + test('should enable all buttons when single "normal" file selected', () => { + const selectedFiles: TFileListing[] = [fileFixtures.txtFile]; + + const isAuthenticated = true; + const isReadOnly = false; + const system = 'other_system'; + + const rules = getToolbarRules( + selectedFiles, + isReadOnly, + isAuthenticated, + system, + USER_WORK_SYSTEM + ); + + expect(rules.canPreview).toBe(true); + expect(rules.canRename).toBe(true); + expect(rules.canCopy).toBe(true); + expect(rules.canMove).toBe(true); + expect(rules.canTrash).toBe(true); + expect(rules.canDownload).toBe(true); + }); + + test('should disable all buttons except preview when single hazmapper file selected', () => { + const selectedFiles: TFileListing[] = [fileFixtures.hazmapperFile]; + + const isAuthenticated = true; + const isReadOnly = false; + const system = 'other_system'; + + const rules = getToolbarRules( + selectedFiles, + isReadOnly, + isAuthenticated, + system, + USER_WORK_SYSTEM + ); + + expect(rules.canPreview).toBe(true); + expect(rules.canRename).toBe(false); + expect(rules.canCopy).toBe(false); + expect(rules.canMove).toBe(false); + expect(rules.canTrash).toBe(false); + expect(rules.canDownload).toBe(false); + }); + + test('should enable all buttons except rename + preview when multiple "normal" files selected', () => { + const selectedFiles: TFileListing[] = [ + fileFixtures.txtFile, + fileFixtures.anotherTxtFile, + ]; + + const isAuthenticated = true; + const isReadOnly = false; + const system = 'other_system'; + + const rules = getToolbarRules( + selectedFiles, + isReadOnly, + isAuthenticated, + system, + USER_WORK_SYSTEM + ); + + expect(rules.canPreview).toBe(false); + expect(rules.canRename).toBe(false); + expect(rules.canCopy).toBe(true); + expect(rules.canMove).toBe(true); + expect(rules.canTrash).toBe(true); + expect(rules.canDownload).toBe(true); + }); + + test('should disable all buttons when a .hazmapper file is part of multiple selection', () => { + const selectedFiles: TFileListing[] = [ + fileFixtures.txtFile, + fileFixtures.hazmapperFile, + ]; + + const isAuthenticated = true; + const isReadOnly = false; + const system = 'other_system'; + + const rules = getToolbarRules( + selectedFiles, + isReadOnly, + isAuthenticated, + system, + USER_WORK_SYSTEM + ); + + expect(rules.canPreview).toBe(false); + expect(rules.canRename).toBe(false); + expect(rules.canCopy).toBe(false); + expect(rules.canMove).toBe(false); + expect(rules.canTrash).toBe(false); + expect(rules.canDownload).toBe(false); + }); + + test('should disable all buttons except preview/download when single selection but not authenticated', () => { + const selectedFiles: TFileListing[] = [fileFixtures.txtFile]; + + const isAuthenticated = false; + const isReadOnly = false; + const system = 'other_system'; + + const rules = getToolbarRules( + selectedFiles, + isReadOnly, + isAuthenticated, + system, + USER_WORK_SYSTEM + ); + + expect(rules.canPreview).toBe(true); + expect(rules.canRename).toBe(false); + expect(rules.canCopy).toBe(false); + expect(rules.canMove).toBe(false); + expect(rules.canTrash).toBe(false); + expect(rules.canDownload).toBe(true); + }); + + test('should disable all buttons except download when multiple selection but not authenticated', () => { + const selectedFiles: TFileListing[] = [ + fileFixtures.txtFile, + fileFixtures.anotherTxtFile, + ]; + + const isAuthenticated = false; + const isReadOnly = false; + const system = 'other_system'; + + const rules = getToolbarRules( + selectedFiles, + isReadOnly, + isAuthenticated, + system, + USER_WORK_SYSTEM + ); + + expect(rules.canPreview).toBe(false); + expect(rules.canRename).toBe(false); + expect(rules.canCopy).toBe(false); + expect(rules.canMove).toBe(false); + expect(rules.canTrash).toBe(false); + expect(rules.canDownload).toBe(true); + }); +}); diff --git a/client/modules/datafiles/src/DatafilesToolbar/DatafilesToolbar.tsx b/client/modules/datafiles/src/DatafilesToolbar/DatafilesToolbar.tsx index 3bc79721e1..47309fc5f5 100644 --- a/client/modules/datafiles/src/DatafilesToolbar/DatafilesToolbar.tsx +++ b/client/modules/datafiles/src/DatafilesToolbar/DatafilesToolbar.tsx @@ -7,12 +7,65 @@ import { USER_WORK_SYSTEM, useSelectedFiles, useSelectedFilesForSystem, + TFileListing, } from '@client/hooks'; import DatafilesModal from '../DatafilesModal/DatafilesModal'; import TrashButton from './TrashButton'; import { Button, ButtonProps, ConfigProvider, ThemeConfig } from 'antd'; import { useMatches, useParams } from 'react-router-dom'; +type ToolbarRules = { + canPreview: boolean; + canRename: boolean; + canCopy: boolean; + canMove: boolean; + canTrash: boolean; + canDownload: boolean; +}; + +/** + * Get the rules for enabling or disabling toolbar buttons based on the selected files, user permissions, + * system, and read-only mode. + */ +export function getToolbarRules( + selectedFiles: TFileListing[], + isReadOnly: boolean, + isAuthenticated: boolean, + system: string, + USER_WORK_SYSTEM: string +): ToolbarRules { + const notContainingHazmapperFile = selectedFiles.every( + (file) => !file.path.endsWith('.hazmapper') + ); + + return { + canPreview: selectedFiles.length === 1 && selectedFiles[0].type === 'file', + canRename: + isAuthenticated && + selectedFiles.length === 1 && + !isReadOnly && + notContainingHazmapperFile, + canCopy: + isAuthenticated && + selectedFiles.length >= 1 && + notContainingHazmapperFile, + canMove: + isAuthenticated && + selectedFiles.length >= 1 && + !isReadOnly && + notContainingHazmapperFile, + canTrash: + isAuthenticated && + selectedFiles.length >= 1 && + !isReadOnly && + notContainingHazmapperFile, + canDownload: + selectedFiles.length >= 1 && + system !== USER_WORK_SYSTEM && + notContainingHazmapperFile, + }; +} + const toolbarTheme: ThemeConfig = { components: { Button: { @@ -41,10 +94,10 @@ export const DatafilesToolbar: React.FC<{ searchInput?: React.ReactNode }> = ({ const { user } = useAuthenticatedUser(); const matches = useMatches(); - const isProjects = matches.find((m) => m.id === 'project'); - const isPublished = matches.find((m) => m.id === 'published'); - const isEntityListing = matches.find((m) => m.id === 'entity-listing'); - const isNees = matches.find((m) => m.id === 'nees'); + const isProjects = !!matches.find((m) => m.id === 'project'); + const isPublished = !!matches.find((m) => m.id === 'published'); + const isEntityListing = !!matches.find((m) => m.id === 'entity-listing'); + const isNees = !!matches.find((m) => m.id === 'nees'); const isReadOnly = isPublished || isNees || system === 'designsafe.storage.community'; @@ -82,32 +135,14 @@ export const DatafilesToolbar: React.FC<{ searchInput?: React.ReactNode }> = ({ : listingSelectedFiles; const rules = useMemo( - function () { - // Rules for which toolbar buttons are active for a given selection. - return { - canPreview: - selectedFiles.length === 1 && selectedFiles[0].type === 'file', - canRename: - user && - selectedFiles.length === 1 && - !isReadOnly && - !selectedFiles[0].path.endsWith('.hazmapper'), - canCopy: - user && - selectedFiles.length >= 1 && - !selectedFiles[0].path.endsWith('.hazmapper'), - canTrash: - user && - selectedFiles.length >= 1 && - !isReadOnly && - !selectedFiles[0].path.endsWith('.hazmapper'), - // Disable downloads from frontera.work until we have a non-flaky mount on ds-download. - canDownload: - selectedFiles.length >= 1 && - system !== USER_WORK_SYSTEM && - !selectedFiles[0].path.endsWith('.hazmapper'), - }; - }, + () => + getToolbarRules( + selectedFiles, + isReadOnly, + !!user, + system, + USER_WORK_SYSTEM + ), [selectedFiles, isReadOnly, user, system] ); @@ -138,7 +173,7 @@ export const DatafilesToolbar: React.FC<{ searchInput?: React.ReactNode }> = ({ {({ onClick }) => ( diff --git a/client/modules/datafiles/src/nees/NeesDetails.tsx b/client/modules/datafiles/src/nees/NeesDetails.tsx index c1f057af53..9118a7e319 100644 --- a/client/modules/datafiles/src/nees/NeesDetails.tsx +++ b/client/modules/datafiles/src/nees/NeesDetails.tsx @@ -346,13 +346,17 @@ export const NeesDetails: React.FC<{ neesId: string }> = ({ neesId }) => { Sponsors {neesProjectData?.sponsor - ? neesProjectData?.sponsor?.map((u) => ( -
- - {u.name} - -
- )) + ? neesProjectData?.sponsor?.map((u) => + u.url != 'None' ? ( +
+ + {u.name} + +
+ ) : ( +
{u.name}
+ ) + ) : 'No Sponsors Listed'} diff --git a/client/modules/datafiles/src/projects/ProjectCitation/ProjectCitation.tsx b/client/modules/datafiles/src/projects/ProjectCitation/ProjectCitation.tsx index 28c9fe72e7..2bd28c938a 100644 --- a/client/modules/datafiles/src/projects/ProjectCitation/ProjectCitation.tsx +++ b/client/modules/datafiles/src/projects/ProjectCitation/ProjectCitation.tsx @@ -14,7 +14,9 @@ export const ProjectCitation: React.FC<{ const { data } = useProjectDetail(projectId); const entityDetails = data?.entities.find((e) => e.uuid === entityUuid); const authors = - entityDetails?.value.authors?.filter((a) => a.fname && a.lname) ?? []; + entityDetails?.value.authors?.filter( + (a) => a.fname && a.lname && a.authorship !== false + ) ?? []; if (!data || !entityDetails) return null; return (
@@ -44,7 +46,8 @@ export const PublishedCitation: React.FC<{ (child) => child.uuid === entityUuid && child.version === version ); - const authors = entityDetails?.value.authors ?? []; + const authors = + entityDetails?.value.authors?.filter((a) => a.authorship !== false) ?? []; if (!data || !entityDetails) return null; const doi = @@ -64,8 +67,8 @@ export const PublishedCitation: React.FC<{ ) .join(', ')}{' '} ({new Date(entityDetails.publicationDate).getFullYear()}). " - {entityDetails.value.title}", in {data.baseProject.title}. - DesignSafe-CI.{' '} + {entityDetails.value.title}", in {data.baseProject.title} + {(version ?? 1) > 1 && [Version {version}]}. DesignSafe-CI.{' '} {doi && ( ) : ( - + )}
{citationMetrics && ( diff --git a/client/modules/onboarding/.babelrc b/client/modules/onboarding/.babelrc new file mode 100644 index 0000000000..1ea870ead4 --- /dev/null +++ b/client/modules/onboarding/.babelrc @@ -0,0 +1,12 @@ +{ + "presets": [ + [ + "@nx/react/babel", + { + "runtime": "automatic", + "useBuiltIns": "usage" + } + ] + ], + "plugins": [] +} diff --git a/client/modules/onboarding/.eslintrc.json b/client/modules/onboarding/.eslintrc.json new file mode 100644 index 0000000000..3ebb9c6f3a --- /dev/null +++ b/client/modules/onboarding/.eslintrc.json @@ -0,0 +1,18 @@ +{ + "extends": ["plugin:@nx/react", "../../.eslintrc.base.json"], + "ignorePatterns": ["!**/*"], + "overrides": [ + { + "files": ["*.ts", "*.tsx", "*.js", "*.jsx"], + "rules": {} + }, + { + "files": ["*.ts", "*.tsx"], + "rules": {} + }, + { + "files": ["*.js", "*.jsx"], + "rules": {} + } + ] +} diff --git a/client/modules/onboarding/README.md b/client/modules/onboarding/README.md new file mode 100644 index 0000000000..459dd2f5b2 --- /dev/null +++ b/client/modules/onboarding/README.md @@ -0,0 +1,7 @@ +# onboarding + +This library was generated with [Nx](https://nx.dev). + +## Running unit tests + +Run `nx test onboarding` to execute the unit tests via [Vitest](https://vitest.dev/). diff --git a/client/modules/onboarding/project.json b/client/modules/onboarding/project.json new file mode 100644 index 0000000000..261f1ba5a4 --- /dev/null +++ b/client/modules/onboarding/project.json @@ -0,0 +1,20 @@ +{ + "name": "onboarding", + "$schema": "../../node_modules/nx/schemas/project-schema.json", + "sourceRoot": "modules/onboarding/src", + "projectType": "library", + "tags": [], + "targets": { + "lint": { + "executor": "@nx/eslint:lint", + "outputs": ["{options.outputFile}"] + }, + "test": { + "executor": "@nx/vite:test", + "outputs": ["{options.reportsDirectory}"], + "options": { + "reportsDirectory": "../../coverage/modules/onboarding" + } + } + } +} diff --git a/client/modules/onboarding/src/OnboardingActions/OnboardingActions.module.css b/client/modules/onboarding/src/OnboardingActions/OnboardingActions.module.css new file mode 100644 index 0000000000..d83946f5ae --- /dev/null +++ b/client/modules/onboarding/src/OnboardingActions/OnboardingActions.module.css @@ -0,0 +1,21 @@ +.root { + display: flex; + align-items: center; + justify-content: space-between; + flex-grow: 1; +} + +.action { + padding-bottom: 0; + padding-top: 0; + font-weight: bold; +} +.onboarding-action__loading { + display: inline-block; + width: auto; +} + +.onboarding-action__loading .inline { + width: 16px; + height: 16px; +} diff --git a/client/modules/onboarding/src/OnboardingActions/OnboardingActions.tsx b/client/modules/onboarding/src/OnboardingActions/OnboardingActions.tsx new file mode 100644 index 0000000000..dae8bcf51b --- /dev/null +++ b/client/modules/onboarding/src/OnboardingActions/OnboardingActions.tsx @@ -0,0 +1,132 @@ +import React from 'react'; +import { useParams } from 'react-router-dom'; +import { Alert, Spin } from 'antd'; +import { SecondaryButton } from '@client/common-components'; +import { + TOnboardingStep, + useAuthenticatedUser, + useSendOnboardingAction, +} from '@client/hooks'; +import styles from './OnboardingActions.module.css'; + +const OnboardingActions = ({ step }: { step: TOnboardingStep }) => { + const { user: authenticatedUser } = useAuthenticatedUser(); + const params = useParams(); + const { + mutate: sendOnboardingAction, + isPending, + error, + } = useSendOnboardingAction(); + + // If the route loaded shows we are viewing a different user + // (such as an admin viewing a user) then pull the username for + // actions from the route. Otherwise, use the username of whomever is logged in + const username = params.username || (authenticatedUser?.username as string); + + if (error) { + return ( + + ); + } + + return ( + <> + {isPending ? : null} + + {authenticatedUser?.isStaff && step.state === 'staffwait' ? ( + + + sendOnboardingAction({ + body: { action: 'staff_approve', step: step.step }, + username, + }) + } + > + {step.staffApprove} + +     + + sendOnboardingAction({ + body: { action: 'staff_deny', step: step.step }, + username, + }) + } + > + {step.staffDeny} + + + ) : null} + {step.state === 'userwait' ? ( + step.data?.userlink ? ( + + {step.data?.userlink?.text} + + ) : ( + + sendOnboardingAction({ + body: { action: 'user_confirm', step: step.step }, + username, + }) + } + > + {step.userConfirm} + + ) + ) : null} + {authenticatedUser?.isStaff ? ( + + + sendOnboardingAction({ + body: { action: 'reset', step: step.step }, + username, + }) + } + > + Admin Reset + +     + + sendOnboardingAction({ + body: { action: 'complete', step: step.step }, + username, + }) + } + > + Admin Skip + + + ) : null} + + + ); +}; + +export default OnboardingActions; diff --git a/client/modules/onboarding/src/OnboardingAdminSearchbar/OnboardingAdminSearchbar.module.css b/client/modules/onboarding/src/OnboardingAdminSearchbar/OnboardingAdminSearchbar.module.css new file mode 100644 index 0000000000..72a68f9397 --- /dev/null +++ b/client/modules/onboarding/src/OnboardingAdminSearchbar/OnboardingAdminSearchbar.module.css @@ -0,0 +1,62 @@ +.container { + display: flex; + flex-direction: row; + align-items: center; +} + +/* Children */ + +/* Each direct child except the last */ +.container > *:not(:last-child) { + margin-right: 20px; /* 20px design * 1.2 design-to-app ratio */ +} +.query-fieldset { + width: 560px; /* 70px + 396px design * 1.2 design-to-app ratio */ +} +/* Ensure `.clear-button` text does not wrap at (arbitrary) 1280px laptop width */ +/* WARN: Non-standard un-documented first-party breakpoint */ +@media (max-width: 1700px) { + .query-fieldset { + width: 360px; + } +} + +@media (max-width: 768px) { + .query-fieldset { + width: 260px; + } +} +/* FP-563: Support count in status message */ +.summary-fieldset { + /* No styles necessary, but defining class for consistency */ +} +/* NOTE: Whenever filter and/or status message are restored, this selector must select the rightmost element of those */ +.clear-button { + /* .filter-fieldset { */ + margin-left: auto; /* this is how to "justify-self" on flex children */ +} +.clear-button { + /* composes: c-button--as-link from '../../styles/components/c-button.css'; */ + + /* RFC: This style might be best provided from an external yet-to-be-created class for table-top nav links */ + font-weight: bold; +} + +/* Children (of `-fieldset`) */ + +.input { + /* composes: form-control from '../../styles/components/bootstrap.form.css'; */ +} +.output { + /* … */ +} + +/* Hacks */ + +.container, +.submit-button, +.clear-button, +.input { + /* RFE: This style should be inherited from cascade of global styles */ + font-size: 0.75rem; /* 12px (16px design * 1.2 design-to-app ratio) */ +} diff --git a/client/modules/onboarding/src/OnboardingAdminSearchbar/OnboardingAdminSearchbar.tsx b/client/modules/onboarding/src/OnboardingAdminSearchbar/OnboardingAdminSearchbar.tsx new file mode 100644 index 0000000000..7f74e7a920 --- /dev/null +++ b/client/modules/onboarding/src/OnboardingAdminSearchbar/OnboardingAdminSearchbar.tsx @@ -0,0 +1,57 @@ +import React, { useEffect, useState } from 'react'; +import { SearchOutlined } from '@ant-design/icons'; +import { Form, Input } from 'antd'; +import { useSearchParams } from 'react-router-dom'; +import { SecondaryButton } from '@client/common-components'; +// import styles from './OnboardingAdminSearchbar.module.css'; + +export const OnboardingAdminSearchbar: React.FC<{ disabled: boolean }> = ({ + disabled, +}) => { + const [form] = Form.useForm(); + const [searchParams, setSearchParams] = useSearchParams(); + const [query, setQuery] = useState(searchParams.get('q')); + const onSubmit = (queryString: string) => { + const newSearchParams = searchParams; + if (queryString) { + newSearchParams.set('q', queryString); + } else { + newSearchParams.delete('q'); + } + newSearchParams.delete('page'); + + setSearchParams(newSearchParams); + }; + + useEffect(() => {}, [searchParams, query]); + + return ( +
onSubmit(data.query)} + form={form} + name="onboarding_search" + style={{ display: 'inline-flex' }} + disabled={disabled} + > + + + + } + > + { + form.resetFields(); + setQuery(null); + searchParams.set('page', '1'); + searchParams.delete('q'); + setSearchParams(searchParams); + }} + > + Clear Search + +
+ ); +}; diff --git a/client/modules/onboarding/src/OnboardingEventLogModal/OnboardingEventLogModal.module.css b/client/modules/onboarding/src/OnboardingEventLogModal/OnboardingEventLogModal.module.css new file mode 100644 index 0000000000..958f10d5b9 --- /dev/null +++ b/client/modules/onboarding/src/OnboardingEventLogModal/OnboardingEventLogModal.module.css @@ -0,0 +1,22 @@ +.event-list > div { + padding: 1em; + margin-left: 1em; + margin-right: 1em; +} + +.log-detail { + margin-left: 1em; +} + +.event-list { + max-height: 30em; + overflow-y: scroll; +} + +.event-list > div:nth-child(even) { + background-color: var(--global-color-primary--x-light); +} + +.event-list > div:not(:last-child) { + border-bottom: 1px solid var(--global-color-primary--dark); +} diff --git a/client/modules/onboarding/src/OnboardingEventLogModal/OnboardingEventLogModal.tsx b/client/modules/onboarding/src/OnboardingEventLogModal/OnboardingEventLogModal.tsx new file mode 100644 index 0000000000..f7d300a673 --- /dev/null +++ b/client/modules/onboarding/src/OnboardingEventLogModal/OnboardingEventLogModal.tsx @@ -0,0 +1,32 @@ +import React from 'react'; +import { Modal } from 'antd'; +import { formatDateTime } from '@client/workspace'; +import { TOnboardingStep, TOnboardingUser } from '@client/hooks'; +import styles from './OnboardingEventLogModal.module.css'; + +export const OnboardingEventLogModal: React.FC<{ + params: { + user: TOnboardingUser; + step: TOnboardingStep; + }; + handleCancel: () => void; +}> = ({ params: { user, step }, handleCancel }) => { + return ( + +
+ {step.events.map((event) => ( +
+
{formatDateTime(new Date(event.time))}
+
{event.message}
+
+ ))} +
+ + ); +}; diff --git a/client/modules/onboarding/src/OnboardingStatus/OnboardingStatus.module.css b/client/modules/onboarding/src/OnboardingStatus/OnboardingStatus.module.css new file mode 100644 index 0000000000..2dfd35420c --- /dev/null +++ b/client/modules/onboarding/src/OnboardingStatus/OnboardingStatus.module.css @@ -0,0 +1,12 @@ +.root { + overflow: hidden; +} + +.processing { + display: flex; + align-items: center; +} + +.processing > * { + margin-right: 0.5em; +} diff --git a/client/modules/onboarding/src/OnboardingStatus/OnboardingStatus.spec.tsx b/client/modules/onboarding/src/OnboardingStatus/OnboardingStatus.spec.tsx new file mode 100644 index 0000000000..22321ac2b1 --- /dev/null +++ b/client/modules/onboarding/src/OnboardingStatus/OnboardingStatus.spec.tsx @@ -0,0 +1,99 @@ +import { render } from '@client/test-fixtures'; +import { OnboardingStatus } from './OnboardingStatus'; +import { TOnboardingStep } from '@client/hooks'; +import { describe, it, expect } from 'vitest'; + +describe('OnboardingStatus Component', () => { + const renderComponent = (step: TOnboardingStep) => + render(); + + it('should render Preparing tag for pending state', () => { + const step = { state: 'pending' } as TOnboardingStep; + const { getByText } = renderComponent(step); + expect(getByText('Preparing')).toBeTruthy(); + }); + + it('should render Waiting for Staff Approval tag for staffwait state', () => { + const step = { state: 'staffwait' } as TOnboardingStep; + const { getByText } = renderComponent(step); + expect(getByText('Waiting for Staff Approval')).toBeTruthy(); + }); + + it('should render Waiting for User tag for userwait state', () => { + const step = { state: 'userwait' } as TOnboardingStep; + const { getByText } = renderComponent(step); + expect(getByText('Waiting for User')).toBeTruthy(); + }); + + it('should render Unsuccessful tag for failed state', () => { + const step = { state: 'failed' } as TOnboardingStep; + const { getByText } = renderComponent(step); + expect(getByText('Unsuccessful')).toBeTruthy(); + }); + + it('should render Unsuccessful tag for error state', () => { + const step = { state: 'error' } as TOnboardingStep; + const { getByText } = renderComponent(step); + expect(getByText('Unsuccessful')).toBeTruthy(); + }); + + it('should render Unavailable tag for null state', () => { + const step = { state: null } as TOnboardingStep; + const { getByText } = renderComponent(step); + expect(getByText('Unavailable')).toBeTruthy(); + }); + + it('should render Completed tag for completed state', () => { + const step = { state: 'completed' } as TOnboardingStep; + const { getByText } = renderComponent(step); + expect(getByText('Completed')).toBeTruthy(); + }); + + it('should render Processing tag and Spin for processing state', () => { + const step = { state: 'processing' } as TOnboardingStep; + const { getByText, container } = renderComponent(step); + expect(getByText('Processing')).toBeTruthy(); + expect(container.querySelector('.ant-spin')).toBeTruthy(); + }); + + it('should render custom status if customStatus is present', () => { + const step = { + state: 'pending', + customStatus: 'Custom Status', + } as TOnboardingStep; + const { getByText } = renderComponent(step); + expect(getByText('Custom Status')).toBeTruthy(); + }); + + it('should render default tag for unknown state', () => { + const step = { state: 'unknown' } as TOnboardingStep; + const { getByText } = renderComponent(step); + expect(getByText('unknown')).toBeTruthy(); + }); + + it('should render null if no state is provided', () => { + const step = {} as TOnboardingStep; + const { container } = renderComponent(step); + expect(container.firstChild).toBeNull(); + }); + + it('should render correct color for each state', () => { + const states = [ + { state: 'pending', color: 'blue' }, + { state: 'staffwait', color: 'blue' }, + { state: 'userwait', color: 'gold' }, + { state: 'failed', color: 'red' }, + { state: 'error', color: 'red' }, + { state: null, color: 'volcano' }, + { state: 'completed', color: 'green' }, + { state: 'processing', color: 'blue' }, + ]; + + states.forEach(({ state, color }) => { + const step = { state } as TOnboardingStep; + const { container } = renderComponent(step); + const tag = container.querySelector('.ant-tag'); + expect(Object.values(tag?.classList || {})).toContain(`ant-tag-${color}`); + }); + }); +}); diff --git a/client/modules/onboarding/src/OnboardingStatus/OnboardingStatus.tsx b/client/modules/onboarding/src/OnboardingStatus/OnboardingStatus.tsx new file mode 100644 index 0000000000..96b5fd0c20 --- /dev/null +++ b/client/modules/onboarding/src/OnboardingStatus/OnboardingStatus.tsx @@ -0,0 +1,68 @@ +import React from 'react'; +import { Tag, Spin } from 'antd'; +import { TOnboardingStep } from '@client/hooks'; +import styles from './OnboardingStatus.module.css'; + +const getContents = (step: TOnboardingStep) => { + let color = ''; + switch (step.state) { + case 'processing': + case 'pending': + color = 'blue'; + break; + case 'failed': + case 'error': + color = 'red'; + break; + case 'staffwait': + case 'userwait': + color = 'gold'; + break; + case 'completed': + color = 'green'; + break; + case null: + color = 'volcano'; + break; + default: + color = 'blue'; + } + if ('customStatus' in step) { + return {step.customStatus}; + } + switch (step.state) { + case 'pending': + return Preparing; + case 'staffwait': + return Waiting for Staff Approval; + case 'userwait': + return Waiting for User; + case 'failed': + case 'error': + return Unsuccessful; + case null: + return Unavailable; + case 'completed': + return Completed; + case 'processing': + return ( + + Processing + + + ); + default: + if (step.state) { + return {step.state}; + } + return null; + } +}; + +export const OnboardingStatus = ({ step }: { step: TOnboardingStep }) => { + const contents = getContents(step); + if (!contents) { + return null; + } + return {getContents(step)}; +}; diff --git a/client/modules/onboarding/src/OnboardingStep/OnboardingStep.module.css b/client/modules/onboarding/src/OnboardingStep/OnboardingStep.module.css new file mode 100644 index 0000000000..a1d6277863 --- /dev/null +++ b/client/modules/onboarding/src/OnboardingStep/OnboardingStep.module.css @@ -0,0 +1,23 @@ +.root { + padding-top: 1em; + padding-bottom: 1em; + margin-bottom: 1em; + border-bottom: 1px solid var(--global-color-primary--normal); +} + +.name { + font-weight: bold; +} + +.description { + padding-bottom: 1em; +} + +.status { + display: flex; + align-items: center; +} + +.disabled { + color: var(--global-color-primary--light); +} diff --git a/client/modules/onboarding/src/OnboardingStep/OnboardingStep.tsx b/client/modules/onboarding/src/OnboardingStep/OnboardingStep.tsx new file mode 100644 index 0000000000..5353ee6e99 --- /dev/null +++ b/client/modules/onboarding/src/OnboardingStep/OnboardingStep.tsx @@ -0,0 +1,22 @@ +import React from 'react'; +import parse from 'html-react-parser'; +import { OnboardingStatus } from '../OnboardingStatus/OnboardingStatus'; +import OnboardingActions from '../OnboardingActions/OnboardingActions'; +import { TOnboardingStep } from '@client/hooks'; +import styles from './OnboardingStep.module.css'; + +export const OnboardingStep = ({ step }: { step: TOnboardingStep }) => { + const styleName = `${styles.root} ${ + step.state === styles.pending ? 'disabled' : '' + }`; + return ( +
+
{step.displayName}
+
{parse(step.description)}
+
+ + +
+
+ ); +}; diff --git a/client/modules/onboarding/src/index.ts b/client/modules/onboarding/src/index.ts new file mode 100644 index 0000000000..2bfb5de63d --- /dev/null +++ b/client/modules/onboarding/src/index.ts @@ -0,0 +1,4 @@ +export * from './OnboardingStep/OnboardingStep'; +export * from './OnboardingStatus/OnboardingStatus'; +export * from './OnboardingEventLogModal/OnboardingEventLogModal'; +export * from './OnboardingAdminSearchbar/OnboardingAdminSearchbar'; diff --git a/client/modules/onboarding/src/vitest.setup.ts b/client/modules/onboarding/src/vitest.setup.ts new file mode 100644 index 0000000000..5e646e1a35 --- /dev/null +++ b/client/modules/onboarding/src/vitest.setup.ts @@ -0,0 +1,6 @@ +import { beforeAll, afterEach, afterAll } from 'vitest'; +import { server } from '@client/test-fixtures'; + +beforeAll(() => server.listen()); +afterEach(() => server.resetHandlers()); +afterAll(() => server.close()); diff --git a/client/modules/onboarding/tsconfig.json b/client/modules/onboarding/tsconfig.json new file mode 100644 index 0000000000..424447ef63 --- /dev/null +++ b/client/modules/onboarding/tsconfig.json @@ -0,0 +1,20 @@ +{ + "compilerOptions": { + "jsx": "react-jsx", + "allowJs": false, + "esModuleInterop": false, + "allowSyntheticDefaultImports": true, + "strict": true + }, + "files": [], + "include": [], + "references": [ + { + "path": "./tsconfig.lib.json" + }, + { + "path": "./tsconfig.spec.json" + } + ], + "extends": "../../tsconfig.json" +} diff --git a/client/modules/onboarding/tsconfig.lib.json b/client/modules/onboarding/tsconfig.lib.json new file mode 100644 index 0000000000..a6ed0a0c2b --- /dev/null +++ b/client/modules/onboarding/tsconfig.lib.json @@ -0,0 +1,23 @@ +{ + "extends": "./tsconfig.json", + "compilerOptions": { + "outDir": "../../dist/out-tsc", + "types": [ + "node", + + "@nx/react/typings/cssmodule.d.ts", + "@nx/react/typings/image.d.ts" + ] + }, + "exclude": [ + "**/*.spec.ts", + "**/*.test.ts", + "**/*.spec.tsx", + "**/*.test.tsx", + "**/*.spec.js", + "**/*.test.js", + "**/*.spec.jsx", + "**/*.test.jsx" + ], + "include": ["src/**/*.js", "src/**/*.jsx", "src/**/*.ts", "src/**/*.tsx"] +} diff --git a/client/modules/onboarding/tsconfig.spec.json b/client/modules/onboarding/tsconfig.spec.json new file mode 100644 index 0000000000..3c002c215a --- /dev/null +++ b/client/modules/onboarding/tsconfig.spec.json @@ -0,0 +1,26 @@ +{ + "extends": "./tsconfig.json", + "compilerOptions": { + "outDir": "../../dist/out-tsc", + "types": [ + "vitest/globals", + "vitest/importMeta", + "vite/client", + "node", + "vitest" + ] + }, + "include": [ + "vite.config.ts", + "vitest.config.ts", + "src/**/*.test.ts", + "src/**/*.spec.ts", + "src/**/*.test.tsx", + "src/**/*.spec.tsx", + "src/**/*.test.js", + "src/**/*.spec.js", + "src/**/*.test.jsx", + "src/**/*.spec.jsx", + "src/**/*.d.ts" + ] +} diff --git a/client/modules/onboarding/vite.config.ts b/client/modules/onboarding/vite.config.ts new file mode 100644 index 0000000000..9f808f7aa0 --- /dev/null +++ b/client/modules/onboarding/vite.config.ts @@ -0,0 +1,28 @@ +import { defineConfig } from 'vite'; +import react from '@vitejs/plugin-react'; +import { nxViteTsPaths } from '@nx/vite/plugins/nx-tsconfig-paths.plugin'; + +export default defineConfig({ + root: __dirname, + cacheDir: '../../node_modules/.vite/modules/onboarding', + + plugins: [react(), nxViteTsPaths()], + + // Uncomment this if you are using workers. + // worker: { + // plugins: [ nxViteTsPaths() ], + // }, + + test: { + globals: true, + cache: { dir: '../../node_modules/.vitest' }, + environment: 'jsdom', + include: ['src/**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'], + reporters: ['default'], + setupFiles: ['./src/vitest.setup.ts'], + coverage: { + reportsDirectory: '../../coverage/modules/onboarding', + provider: 'v8', + }, + }, +}); diff --git a/client/modules/workspace/src/AppsSubmissionDetails/AppsSubmissionDetails.tsx b/client/modules/workspace/src/AppsSubmissionDetails/AppsSubmissionDetails.tsx index f0a423b161..eb29f70f93 100644 --- a/client/modules/workspace/src/AppsSubmissionDetails/AppsSubmissionDetails.tsx +++ b/client/modules/workspace/src/AppsSubmissionDetails/AppsSubmissionDetails.tsx @@ -12,7 +12,7 @@ import { import { useFormContext, useWatch, FieldValues } from 'react-hook-form'; import { z, ZodTypeAny } from 'zod'; import { TField, fieldDisplayOrder } from '../AppsWizard/AppsFormSchema'; -import { PrimaryButton } from '@client/common-components'; +import { JobSubmitButton } from '../JobSubmitButton/JobSubmitButton'; import styles from './AppsSubmissionDetails.module.css'; import { TTapisApp } from '@client/hooks'; @@ -255,14 +255,11 @@ export const AppsSubmissionDetails: React.FC<{ style={itemStyle} className={styles.root} extra={ - - Submit Job - + interactive={definition.notes.isInteractive} + /> } /> diff --git a/client/modules/workspace/src/AppsSubmissionForm/AppsSubmissionForm.tsx b/client/modules/workspace/src/AppsSubmissionForm/AppsSubmissionForm.tsx index a78684f15a..92eda37da7 100644 --- a/client/modules/workspace/src/AppsSubmissionForm/AppsSubmissionForm.tsx +++ b/client/modules/workspace/src/AppsSubmissionForm/AppsSubmissionForm.tsx @@ -1,10 +1,11 @@ import React, { useState, useEffect, useMemo, useCallback } from 'react'; import { NavLink } from 'react-router-dom'; -import { Layout, Form, Col, Row, Alert, Button } from 'antd'; +import { Layout, Form, Col, Row, Alert, Button, Space } from 'antd'; import { z } from 'zod'; import { useForm, FormProvider } from 'react-hook-form'; import { Link } from 'react-router-dom'; import { zodResolver } from '@hookform/resolvers/zod'; +import { JobSubmitButton } from '../JobSubmitButton/JobSubmitButton'; import { useGetAppsSuspense, useGetJobSuspense, @@ -19,6 +20,8 @@ import { TJobBody, useGetAllocationsSuspense, TTapisJob, + useInteractiveModalContext, + TInteractiveModalContext, } from '@client/hooks'; import { AppsSubmissionDetails } from '../AppsSubmissionDetails/AppsSubmissionDetails'; import { AppsWizard } from '../AppsWizard/AppsWizard'; @@ -73,6 +76,9 @@ export const AppsSubmissionForm: React.FC = () => { data: TTapisJob; }; + const [, setInteractiveModalDetails] = + useInteractiveModalContext() as TInteractiveModalContext; + const { definition, license, defaultSystemNeedsKeys } = app; const defaultStorageHost = defaultStorageSystem.host; @@ -174,12 +180,14 @@ export const AppsSubmissionForm: React.FC = () => { type FieldNameUnion = keyof typeof fieldValues; const getSteps = (): TStep => { - const formSteps: TStep = { - configuration: getConfigurationStep(configuration.fields), - ...(definition.notes.isInteractive - ? {} - : { outputs: getOutputsStep(outputs.fields) }), - }; + const formSteps: TStep = {}; + + if (configuration.fields && Object.keys(configuration.fields).length) { + formSteps.configuration = getConfigurationStep(configuration.fields); + } + if (!definition.notes.isInteractive) { + formSteps.outputs = getOutputsStep(outputs.fields); + } if (fileInputs.fields && Object.keys(fileInputs.fields).length) { formSteps.inputs = getInputsStep(fileInputs.fields); } @@ -217,16 +225,16 @@ export const AppsSubmissionForm: React.FC = () => { outputs: outputs.fields, }); - const initialSteps = useMemo( - () => getSteps(), - [ - fileInputs.fields, - parameterSet.fields, - configuration.fields, - outputs.fields, - fields, - ] - ); + const initialSteps = useMemo(() => { + const steps = getSteps(); + return Object.keys(steps).length > 0 ? steps : {}; + }, [ + fileInputs.fields, + parameterSet.fields, + configuration.fields, + outputs.fields, + fields, + ]); const getInitialCurrentStep = (steps: TStep) => { if (steps.inputs) return 'inputs'; @@ -311,23 +319,25 @@ export const AppsSubmissionForm: React.FC = () => { } // Note: currently configuration is the only - // step that needs. This can be more generic + // step that needs update. This can be more generic // in future if the fields shape is same between // Step and Submission Detail View (mostly related to env vars) useEffect(() => { - const updatedConfigurationStep = getConfigurationStep( - fields.configuration as { [key: string]: TField } - ); + if (configuration.fields && Object.keys(configuration.fields).length) { + const updatedConfigurationStep = getConfigurationStep( + fields.configuration as { [key: string]: TField } + ); - const updatedSteps: TStep = { - ...steps, - configuration: { - ...steps.configuration, - ...updatedConfigurationStep, - }, - }; + const updatedSteps: TStep = { + ...steps, + configuration: { + ...steps.configuration, + ...updatedConfigurationStep, + }, + }; - setSteps(updatedSteps); + setSteps(updatedSteps); + } }, [fields]); // next step transition does not block on invalid fields @@ -368,6 +378,13 @@ export const AppsSubmissionForm: React.FC = () => { setPushKeysSystem(submitResult.execSys); } else if (isSuccess) { reset(initialValues); + if (definition.notes.isInteractive) { + setInteractiveModalDetails({ + show: true, + openedBySubmit: true, + uuid: submitResult.uuid, + }); + } } }, [submitResult]); @@ -516,20 +533,22 @@ export const AppsSubmissionForm: React.FC = () => { return ( <> - {submitResult && !submitResult.execSys && ( - - Job submitted successfully. Monitor its progress in{' '} - Job Status. - - } - type="success" - closable - showIcon - style={{ marginBottom: '1rem' }} - /> - )} + {submitResult && + !submitResult.execSys && + !definition.notes.isInteractive && ( + + Job submitted successfully. Monitor its progress in{' '} + Job Status. + + } + type="success" + closable + showIcon + style={{ marginBottom: '1rem' }} + /> + )} {missingAllocation && ( { >
- - - - - - + {Object.keys(steps || {}).length === 0 ? ( + + +
+ {isSuccess ? ( + + Session has been launched. You can view status in{' '} + Job Status. + + ) : ( + definition.notes.jobLaunchDescription ?? + 'This job is pre-configured. No input is necessary to submit the job.' + )} +
+
+ +
+ + + ) : ( + <> + + + + + + + + )}
diff --git a/client/modules/workspace/src/AppsWizard/AppsFormSchema.ts b/client/modules/workspace/src/AppsWizard/AppsFormSchema.ts index 4a04a58181..625d4a9814 100644 --- a/client/modules/workspace/src/AppsWizard/AppsFormSchema.ts +++ b/client/modules/workspace/src/AppsWizard/AppsFormSchema.ts @@ -19,6 +19,7 @@ import { getExecSystemsFromApp, getExecSystemFromId, getAppQueueValues, + getAppRuntimeLabel, getQueueValueForExecSystem, getQueueMaxMinutes, isAppTypeBATCH, @@ -56,8 +57,7 @@ export type TField = { parameterSet?: string; description?: string; options?: TFieldOptions[]; - tapisFile?: boolean; - tapisFileSelectionMode?: string; + fileSettings?: TAppFileSettings; placeholder?: string; readOnly?: boolean; }; @@ -96,7 +96,7 @@ export type TAppFormSchema = { }; }; -export const inputFileRegex = /^tapis:\/\/(?[^/]+)/; +export const tapisInputFileRegex = /^tapis:\/\/(?[^/]+)/; export const fieldDisplayOrder: Record = { configuration: [ @@ -109,6 +109,14 @@ export const fieldDisplayOrder: Record = { outputs: ['name', 'archiveSystemId', 'archiveSystemDir'], }; +export type TAppFilePathRepresentation = 'FullTapisPath' | 'NameOnly'; +export type TAppFileSelectionMode = 'both' | 'file' | 'directory'; + +export type TAppFileSettings = { + fileNameRepresentation: TAppFilePathRepresentation; + fileSelectionMode: TAppFileSelectionMode; +}; + // See https://github.com/colinhacks/zod/issues/310 for Zod issue const emptyStringToUndefined = z.literal('').transform(() => undefined); function asOptionalField(schema: T) { @@ -135,10 +143,13 @@ export const getConfigurationSchema = ( ); } - configurationSchema['maxMinutes'] = getMaxMinutesValidation( - definition, - queue - ); + if (!definition.notes.hideMaxMinutes) { + configurationSchema['maxMinutes'] = getMaxMinutesValidation( + definition, + queue + ); + } + if (!definition.notes.hideNodeCountAndCoresPerNode) { configurationSchema['nodeCount'] = getNodeCountValidation( definition, @@ -177,7 +188,9 @@ export const getConfigurationFields = ( if (definition.jobType === 'BATCH' && !definition.notes.hideQueue) { configurationFields['execSystemLogicalQueue'] = { - description: 'Select the queue this job will execute on.', + description: `Select the queue this ${getAppRuntimeLabel( + definition + )} will execute on.`, label: 'Queue', name: 'configuration.execSystemLogicalQueue', key: 'configuration.execSystemLogicalQueue', @@ -192,8 +205,9 @@ export const getConfigurationFields = ( if (definition.jobType === 'BATCH' && !definition.notes.hideAllocation) { configurationFields['allocation'] = { - description: - 'Select the project allocation you would like to use with this job submission.', + description: `Select the project allocation you would like to use with this ${getAppRuntimeLabel( + definition + )} submission.`, label: 'Allocation', name: 'configuration.allocation', key: 'configuration.allocation', @@ -209,18 +223,27 @@ export const getConfigurationFields = ( }; } - configurationFields['maxMinutes'] = { - description: `The maximum number of minutes you expect this job to run for. Maximum possible is ${getQueueMaxMinutes( - definition, - defaultExecSystem, - queue?.name - )} minutes. After this amount of time your job will end. Shorter run times result in shorter queue wait times.`, - label: 'Maximum Job Runtime (minutes)', - name: 'configuration.maxMinutes', - key: 'configuration.maxMinutes', - required: true, - type: 'number', - }; + if (!definition.notes.hideMaxMinutes) { + configurationFields['maxMinutes'] = { + description: `The maximum number of minutes you expect this ${getAppRuntimeLabel( + definition + )} to run for. Maximum possible is ${getQueueMaxMinutes( + definition, + defaultExecSystem, + queue?.name + )} minutes. After this amount of time your ${getAppRuntimeLabel( + definition + )} will end. Shorter run times result in shorter queue wait times.`, + label: `Maximum ${getAppRuntimeLabel( + definition, + true + )} Runtime (minutes)`, + name: 'configuration.maxMinutes', + key: 'configuration.maxMinutes', + required: true, + type: 'number', + }; + } if (!definition.notes.hideNodeCountAndCoresPerNode) { configurationFields['nodeCount'] = { @@ -316,6 +339,12 @@ const FormSchema = ( name: `parameters.${parameterSet}.${label}`, key: paramId, type: 'text', + ...(param.notes?.inputType === 'fileInput' && { + fileSettings: { + fileNameRepresentation: 'NameOnly', + fileSelectionMode: 'file', + }, + }), }; if (param.notes?.enum_values) { @@ -399,11 +428,14 @@ const FormSchema = ( required: input.inputMode === 'REQUIRED', name: `inputs.${input.name}`, key: `inputs.${input.name}`, - tapisFile: true, type: 'text', placeholder: 'Browse Data Files', readOnly: input.inputMode === 'FIXED', - tapisFileSelectionMode: input.notes?.selectionMode ?? 'both', + fileSettings: { + fileNameRepresentation: 'FullTapisPath', + fileSelectionMode: + (input.notes?.selectionMode as TAppFileSelectionMode) ?? 'both', + }, }; appFields.fileInputs.schema[input.name] = z.string(); @@ -493,8 +525,10 @@ const FormSchema = ( : ''; } - appFields.configuration.defaults['maxMinutes'] = - definition.jobAttributes.maxMinutes; + if (!definition.notes.hideMaxMinutes) { + appFields.configuration.defaults['maxMinutes'] = + definition.jobAttributes.maxMinutes; + } if (!definition.notes.hideNodeCountAndCoresPerNode) { appFields.configuration.defaults['nodeCount'] = diff --git a/client/modules/workspace/src/AppsWizard/FormField.tsx b/client/modules/workspace/src/AppsWizard/FormField.tsx index 1ec10262f0..8979c0b017 100644 --- a/client/modules/workspace/src/AppsWizard/FormField.tsx +++ b/client/modules/workspace/src/AppsWizard/FormField.tsx @@ -2,30 +2,32 @@ import React, { useState, useEffect } from 'react'; import { Button, Form, Input, Select } from 'antd'; import { FormItem } from 'react-hook-form-antd'; import { useFormContext, useWatch } from 'react-hook-form'; -import { TFieldOptions, inputFileRegex } from '../AppsWizard/AppsFormSchema'; +import { + TFieldOptions, + tapisInputFileRegex, + TAppFileSettings, +} from '../AppsWizard/AppsFormSchema'; import { SecondaryButton } from '@client/common-components'; import { SelectModal } from '../SelectModal/SelectModal'; export const FormField: React.FC<{ name: string; - tapisFile?: boolean; parameterSet?: string; description?: string; label: string; required?: boolean; type: string; - tapisFileSelectionMode?: string; + fileSettings?: TAppFileSettings; placeholder?: string; options?: TFieldOptions[]; }> = ({ name, - tapisFile = false, parameterSet = null, description, label, required = false, type, - tapisFileSelectionMode = null, + fileSettings = null, ...props }) => { const { resetField, control, getValues, setValue, trigger } = @@ -39,16 +41,17 @@ export const FormField: React.FC<{ setIsModalOpen(true); }; useEffect(() => { - if (tapisFile) { + setStorageSystem(null); + + if (fileSettings?.fileNameRepresentation === 'FullTapisPath') { const inputFileValue = getValues(name); - const match = inputFileValue?.match(inputFileRegex); - if (match && match.groups) { + const match = inputFileValue?.match(tapisInputFileRegex); + + if (match?.groups) { setStorageSystem(match.groups.storageSystem); - } else { - setStorageSystem(null); } } - }, [tapisFile, name, fieldState]); + }, [fileSettings, name, fieldState]); if (parameterSet) { parameterSetLabel = ( @@ -89,7 +92,7 @@ export const FormField: React.FC<{ /> ) : (
- {tapisFile && ( + {fileSettings && ( Select @@ -133,11 +136,11 @@ export const FormField: React.FC<{ {/* Select Modal has Form and input which cause state sharing with above FormItem So, SelectModal is outside FormItem. */} - {tapisFile && ( + {fileSettings && ( setIsModalOpen(false)} onSelect={(value: string) => { diff --git a/client/modules/workspace/src/InteractiveSessionModal/InteractiveSessionModal.module.css b/client/modules/workspace/src/InteractiveSessionModal/InteractiveSessionModal.module.css index 06d6f18f3f..9a64708802 100644 --- a/client/modules/workspace/src/InteractiveSessionModal/InteractiveSessionModal.module.css +++ b/client/modules/workspace/src/InteractiveSessionModal/InteractiveSessionModal.module.css @@ -1,13 +1,8 @@ -.session-modal-header { - background-color: #f4f4f4; - h5 { - font-weight: normal; - } -} - .session-modal-body { display: flex; flex-direction: column; + margin-bottom: 25px; + min-height: 225px; & > * { margin: 0.4rem; } @@ -17,3 +12,7 @@ color: grey; font-style: italic; } + +.icon { + margin-left: 10px; +} diff --git a/client/modules/workspace/src/InteractiveSessionModal/InteractiveSessionModal.tsx b/client/modules/workspace/src/InteractiveSessionModal/InteractiveSessionModal.tsx index d184d61a55..0b30e0f59e 100644 --- a/client/modules/workspace/src/InteractiveSessionModal/InteractiveSessionModal.tsx +++ b/client/modules/workspace/src/InteractiveSessionModal/InteractiveSessionModal.tsx @@ -1,41 +1,82 @@ -import { Modal } from 'antd'; import React from 'react'; -import { PrimaryButton } from '@client/common-components'; +import { Modal } from 'antd'; +import { PrimaryButton, Icon } from '@client/common-components'; +import { + useInteractiveModalContext, + TInteractiveModalContext, +} from '@client/hooks'; import styles from './InteractiveSessionModal.module.css'; -export const InteractiveSessionModal: React.FC<{ - isOpen: boolean; - interactiveSessionLink: string; - message?: string; - onCancel: VoidFunction; -}> = ({ isOpen, interactiveSessionLink, message, onCancel }) => { +export const InteractiveSessionModal = () => { + const [interactiveModalDetails, setInteractiveModalDetails] = + useInteractiveModalContext() as TInteractiveModalContext; + + const { interactiveSessionLink, message, openedBySubmit, show } = + interactiveModalDetails; + return ( Open Session} - width="500px" - open={isOpen} - footer={ - - Connect - + title={ +

+ Interactive Session is {interactiveSessionLink ? 'Ready' : 'Queueing'} +

+ } + width="650px" + open={show} + footer={null} + onCancel={() => + setInteractiveModalDetails({ + show: false, + }) } - onCancel={onCancel} >
- - Click the button below to connect to the interactive session. - +
+ + Connect + {interactiveSessionLink && ( + + )} + +
+ {openedBySubmit && !interactiveSessionLink && ( + + While you wait, you can either: +
    +
  • Keep this pop-up open and wait to connect.
    • +
  • + Close this pop-up and wait for a notification via{' '} + Job Status. +
    • +
+ + )} {message && {message}} - To end the job, quit the application within the session. - - Files may take some time to appear in the output location after the - job has ended. - - - For security purposes, this is the URL that the connect button will - open: - - {interactiveSessionLink} + {interactiveSessionLink && ( + <> + + To end the job, quit the application within the session. + + + Files may take some time to appear in the output location after + the job has ended. + + + For security purposes, this is the URL that the connect button + will open: + + {interactiveSessionLink} + + )}
); diff --git a/client/modules/workspace/src/JobSubmitButton/JobSubmitButton.tsx b/client/modules/workspace/src/JobSubmitButton/JobSubmitButton.tsx new file mode 100644 index 0000000000..e66428b24c --- /dev/null +++ b/client/modules/workspace/src/JobSubmitButton/JobSubmitButton.tsx @@ -0,0 +1,21 @@ +import React from 'react'; +import { PrimaryButton } from '@client/common-components'; + +export const JobSubmitButton: React.FC<{ + loading: boolean; + interactive: boolean | undefined; + disabled?: boolean; + success?: boolean; +}> = ({ loading, interactive, disabled = false, success = false }) => { + return ( + + {interactive ? 'Launch Session' : 'Submit Job'} + {success && } + + ); +}; diff --git a/client/modules/workspace/src/JobsDetailModal/JobsDetailModal.tsx b/client/modules/workspace/src/JobsDetailModal/JobsDetailModal.tsx index e4bc16be9a..9fa9ff0cd0 100644 --- a/client/modules/workspace/src/JobsDetailModal/JobsDetailModal.tsx +++ b/client/modules/workspace/src/JobsDetailModal/JobsDetailModal.tsx @@ -80,6 +80,7 @@ export const JobsDetailModalBody: React.FC<{ > ), ...(jobData.remoteOutcome && { 'Remote Outcome': jobData.remoteOutcome }), + ...(jobData.remoteJobId && { 'Remote Job ID': jobData.remoteJobId }), }; if (jobData.remoteOutcome) { @@ -235,7 +236,7 @@ export const JobsDetailModalBody: React.FC<{ (isInteractiveJob(jobData) ? ( @@ -296,21 +297,19 @@ export const JobsDetailModal: React.FC<{ uuid: string }> = ({ uuid }) => { -
- Job Detail: {uuid} - {jobData && ( -
-
Job UUID:
-
{jobData.uuid}
-
Application:
-
{JSON.parse(jobData.notes).label || jobData.appId}
-
System:
-
{jobData.execSystemId}
-
- )} -
- +
+ Job Detail: {uuid} + {jobData && ( +
+
Job UUID:
+
{jobData.uuid}
+
Application:
+
{JSON.parse(jobData.notes).label || jobData.appId}
+
System:
+
{jobData.execSystemId}
+
+ )} +
} width="60%" open={isModalOpen} diff --git a/client/modules/workspace/src/JobsListing/JobsListing.tsx b/client/modules/workspace/src/JobsListing/JobsListing.tsx index d2dcf3404d..398d69cf4a 100644 --- a/client/modules/workspace/src/JobsListing/JobsListing.tsx +++ b/client/modules/workspace/src/JobsListing/JobsListing.tsx @@ -1,4 +1,5 @@ -import React, { useMemo, useState, useEffect } from 'react'; +import React, { useMemo, useEffect } from 'react'; +import useWebSocket from 'react-use-websocket'; import { TableProps, Row, Flex, Button as AntButton } from 'antd'; import type { ButtonSize } from 'antd/es/button'; import { useQueryClient } from '@tanstack/react-query'; @@ -12,6 +13,8 @@ import { TJobPostOperations, useReadNotifications, TGetNotificationsResponse, + useInteractiveModalContext, + TInteractiveModalContext, } from '@client/hooks'; import { JobsListingTable, @@ -25,7 +28,6 @@ import { isInteractiveJob, isTerminalState, } from '../utils'; -import { InteractiveSessionModal } from '../InteractiveSessionModal'; import styles from './JobsListing.module.css'; import { formatDateTimeFromValue } from '../utils/timeFormat'; import { JobsReuseInputsButton } from '../JobsReuseInputsButton/JobsReuseInputsButton'; @@ -58,16 +60,24 @@ export const JobActionButton: React.FC<{ const InteractiveSessionButtons: React.FC<{ uuid: string; - interactiveSessionLink: string; + interactiveSessionLink?: string; message?: string; }> = ({ uuid, interactiveSessionLink, message }) => { - const [interactiveModalState, setInteractiveModalState] = useState(false); + const [, setInteractiveModalDetails] = + useInteractiveModalContext() as TInteractiveModalContext; return ( <> setInteractiveModalState(true)} + onClick={() => + setInteractiveModalDetails({ + show: true, + interactiveSessionLink, + message, + uuid: uuid, + }) + } > Open @@ -77,12 +87,6 @@ const InteractiveSessionButtons: React.FC<{ title="End" size="small" /> - setInteractiveModalState(false)} - /> ); }; @@ -96,12 +100,16 @@ export const JobsListing: React.FC> = ({ markRead: false, }); const { mutate: readNotifications } = useReadNotifications(); + const { sendMessage } = useWebSocket( + `wss://${window.location.host}/ws/websockets/` + ); // mark all as read on component mount useEffect(() => { readNotifications({ eventTypes: ['interactive_session_ready', 'job'], }); + sendMessage('markAllNotificationsAsRead'); // update unread count state queryClient.setQueryData( @@ -170,7 +178,7 @@ export const JobsListing: React.FC> = ({ ) : ( @@ -242,9 +250,5 @@ export const JobsListing: React.FC> = ({ [interactiveSessionNotifs] ); - return ( - <> - - - ); + return ; }; diff --git a/client/modules/workspace/src/JobsListing/JobsListingTable/JobsListingTable.tsx b/client/modules/workspace/src/JobsListing/JobsListingTable/JobsListingTable.tsx index d3d11deb8e..4cffd2b64f 100644 --- a/client/modules/workspace/src/JobsListing/JobsListingTable/JobsListingTable.tsx +++ b/client/modules/workspace/src/JobsListing/JobsListingTable/JobsListingTable.tsx @@ -91,9 +91,11 @@ export const JobsListingTable: React.FC< isLoading, ]); - const lastNotificationJobUUID = lastMessage - ? (JSON.parse(lastMessage.data) as TJobStatusNotification).extra.uuid - : ''; + const lastMessageJSON = lastMessage?.data + ? (JSON.parse(lastMessage.data) as TJobStatusNotification) + : null; + const lastNotificationJobUUID = + lastMessageJSON?.event_type === 'job' ? lastMessageJSON.extra.uuid : ''; const unreadJobUUIDs = unreadNotifs?.notifs.map((x) => x.extra.uuid) ?? []; /* RENDER THE TABLE */ diff --git a/client/modules/workspace/src/SelectModal/SelectModal.tsx b/client/modules/workspace/src/SelectModal/SelectModal.tsx index fbbb4906f2..01a6cdd719 100644 --- a/client/modules/workspace/src/SelectModal/SelectModal.tsx +++ b/client/modules/workspace/src/SelectModal/SelectModal.tsx @@ -23,6 +23,8 @@ import { TFileListing, } from '@client/hooks'; +import { TAppFileSettings } from '../AppsWizard/AppsFormSchema'; + import { BaseFileListingBreadcrumb, FileListingTable, @@ -152,7 +154,7 @@ const getParentFolder = ( function getFilesColumns( api: string, path: string, - selectionMode: string, + appFileSettings: TAppFileSettings, searchTerm: string | null, clearSearchTerm: () => void, selectionCallback: (path: string) => void, @@ -233,9 +235,11 @@ function getFilesColumns( title: '', render: (_, record, index) => { const selectionModeAllowed = - (record.type === 'dir' && selectionMode === 'directory') || - (record.type === 'file' && selectionMode === 'file') || - selectionMode === 'both'; + (record.type === 'dir' && + appFileSettings.fileSelectionMode === 'directory') || + (record.type === 'file' && + appFileSettings.fileSelectionMode === 'file') || + appFileSettings.fileSelectionMode === 'both'; const isNotRoot = index > 0 || record.system.startsWith(projectPrefix) || @@ -244,9 +248,15 @@ function getFilesColumns( return shouldRenderSelectButton ? ( - selectionCallback(`${api}://${record.system}${record.path}`) - } + onClick={() => { + const lastPartOfPath = record.path.split('/').pop() ?? ''; + const filePath = + appFileSettings.fileNameRepresentation === 'FullTapisPath' + ? `${api}://${record.system}${record.path}` + : lastPartOfPath; + + selectionCallback(filePath); + }} > Select @@ -259,11 +269,11 @@ function getFilesColumns( export const SelectModal: React.FC<{ inputLabel: string; system: string | null; - selectionMode: string; + appFileSettings: TAppFileSettings; isOpen: boolean; onClose: () => void; onSelect: (value: string) => void; -}> = ({ inputLabel, system, selectionMode, isOpen, onClose, onSelect }) => { +}> = ({ inputLabel, system, appFileSettings, isOpen, onClose, onSelect }) => { const [isModalOpen, setIsModalOpen] = useState(false); const [searchTerm, setSearchTerm] = useState(null); const [form] = Form.useForm(); @@ -420,7 +430,7 @@ export const SelectModal: React.FC<{ getFilesColumns( selectedApi, selectedPath, - selectionMode, + appFileSettings, searchTerm, clearSearchTerm, (selection: string) => selectCallback(selection), @@ -435,7 +445,7 @@ export const SelectModal: React.FC<{ selectedSystem, selectedPath, systemLabel, - selectionMode, + appFileSettings, selectCallback, ] ); diff --git a/client/modules/workspace/src/Toast/Notifications.module.css b/client/modules/workspace/src/Toast/Notifications.module.css index 44beb6563c..44ca35802c 100644 --- a/client/modules/workspace/src/Toast/Notifications.module.css +++ b/client/modules/workspace/src/Toast/Notifications.module.css @@ -1,3 +1,13 @@ +.root { + cursor: pointer; + background: #f4f4f4; + border: 1px solid #222222; + &:hover { + border-color: #5695c4; + background: #aac7ff; + } +} + .toast-is-error { color: #eb6e6e; } diff --git a/client/modules/workspace/src/Toast/Toast.tsx b/client/modules/workspace/src/Toast/Toast.tsx index 1956cd1102..b8941eb95c 100644 --- a/client/modules/workspace/src/Toast/Toast.tsx +++ b/client/modules/workspace/src/Toast/Toast.tsx @@ -1,11 +1,17 @@ import React, { useEffect } from 'react'; import useWebSocket from 'react-use-websocket'; import { useQueryClient } from '@tanstack/react-query'; -import { notification } from 'antd'; +import { notification, Flex } from 'antd'; +import { RightOutlined } from '@ant-design/icons'; import { useNavigate } from 'react-router-dom'; import { Icon } from '@client/common-components'; -import { TJobStatusNotification } from '@client/hooks'; -import { getToastMessage } from '../utils'; +import { + TJobStatusNotification, + TGetNotificationsResponse, + useInteractiveModalContext, + TInteractiveModalContext, +} from '@client/hooks'; +import { getToastMessage, isTerminalState } from '../utils'; import styles from './Notifications.module.css'; const Notifications = () => { @@ -14,36 +20,82 @@ const Notifications = () => { ); const [api, contextHolder] = notification.useNotification({ maxCount: 1 }); + const [interactiveModalDetails, setInteractiveModalDetails] = + useInteractiveModalContext() as TInteractiveModalContext; const queryClient = useQueryClient(); const navigate = useNavigate(); const handleNotification = (notification: TJobStatusNotification) => { - if ( - notification.event_type === 'job' || - notification.event_type === 'interactive_session_ready' - ) { - queryClient.invalidateQueries({ - queryKey: ['workspace', 'notifications'], - }); - queryClient.invalidateQueries({ - queryKey: ['workspace', 'jobsListing'], - }); - api.open({ - message: getToastMessage(notification), - placement: 'bottomLeft', - icon: , - className: `${ - notification.extra.status === 'FAILED' && styles['toast-is-error'] - }`, - closeIcon: false, - duration: 5, - onClick: () => { - navigate('/history'); - }, - style: { cursor: 'pointer' }, - }); + switch (notification.event_type) { + case 'interactive_session_ready': + if (interactiveModalDetails.show) { + setInteractiveModalDetails({ + ...interactiveModalDetails, + interactiveSessionLink: notification.action_link, + message: notification.message, + }); + } + /* falls through */ + case 'job': + queryClient.invalidateQueries({ + queryKey: ['workspace', 'notifications'], + }); + queryClient.invalidateQueries({ + queryKey: ['workspace', 'jobsListing'], + }); + api.open({ + message: ( + + {getToastMessage(notification)} + + + ), + placement: 'bottomLeft', + icon: , + className: `${ + notification.extra.status === 'FAILED' && styles['toast-is-error'] + } ${styles.root}`, + closeIcon: false, + duration: 5, + onClick: () => { + navigate('/history'); + }, + }); + + // close interactive session modal if job is ended + if ( + isTerminalState(notification.extra.status) && + notification.extra.uuid === interactiveModalDetails.uuid + ) { + setInteractiveModalDetails({ + show: false, + }); + } + + break; + case 'markAllNotificationsAsRead': + // update unread count state + queryClient.setQueryData( + [ + 'workspace', + 'notifications', + { + eventTypes: ['interactive_session_ready', 'job'], + read: false, + markRead: false, + }, + ], + (oldData: TGetNotificationsResponse) => { + return { + ...oldData, + notifs: [], + unread: 0, + }; + } + ); + break; } }; @@ -53,7 +105,7 @@ const Notifications = () => { } }, [lastMessage]); - return <>{contextHolder}; + return contextHolder; }; export default Notifications; diff --git a/client/modules/workspace/src/index.ts b/client/modules/workspace/src/index.ts index 694e66c4f2..826f4ff469 100644 --- a/client/modules/workspace/src/index.ts +++ b/client/modules/workspace/src/index.ts @@ -9,3 +9,4 @@ export * from './SystemsPushKeysModal/SystemsPushKeysModal'; export * from './Toast'; export * from './utils'; export * from './constants'; +export * from './InteractiveSessionModal'; diff --git a/client/modules/workspace/src/utils/apps.ts b/client/modules/workspace/src/utils/apps.ts index e8da75d452..99925b9e2c 100644 --- a/client/modules/workspace/src/utils/apps.ts +++ b/client/modules/workspace/src/utils/apps.ts @@ -508,3 +508,24 @@ export const getOnDemandEnvVariables = ( ); return includeOnDemandVars; }; + +/** + * Returns 'interactive session' as app type if it is interactive, otherwise 'job' + * + * @param definition - TTapisApp + * @param titleCase - boolean, default is false. + * @returns string + */ +export const getAppRuntimeLabel = ( + definition: TTapisApp, + titleCase: boolean = false +): string => { + const label = definition.notes.isInteractive ? 'interactive session' : 'job'; + + return titleCase + ? label + .split(' ') + .map((word) => word.charAt(0).toUpperCase() + word.slice(1)) + .join(' ') + : label; +}; diff --git a/client/modules/workspace/src/utils/index.ts b/client/modules/workspace/src/utils/index.ts index c882054cfb..f859596cb7 100644 --- a/client/modules/workspace/src/utils/index.ts +++ b/client/modules/workspace/src/utils/index.ts @@ -3,3 +3,4 @@ export * from './systems'; export * from './apps'; export * from './truncateMiddle'; export * from './notifications'; +export * from './timeFormat'; diff --git a/client/modules/workspace/src/utils/jobs.ts b/client/modules/workspace/src/utils/jobs.ts index 89b58a00fd..3915fe9923 100644 --- a/client/modules/workspace/src/utils/jobs.ts +++ b/client/modules/workspace/src/utils/jobs.ts @@ -68,7 +68,7 @@ export function getOutputPath(job: TTapisJob) { } export function isInteractiveJob(job: TTapisJob) { - return job.tags.includes('isInteractive'); + return job.tags?.includes('isInteractive'); } export function getJobInteractiveSessionInfo( diff --git a/client/src/datafiles/layouts/DataFilesBaseLayout.tsx b/client/src/datafiles/layouts/DataFilesBaseLayout.tsx index e2ba4c4c71..50fac4cb95 100644 --- a/client/src/datafiles/layouts/DataFilesBaseLayout.tsx +++ b/client/src/datafiles/layouts/DataFilesBaseLayout.tsx @@ -12,6 +12,11 @@ const { Sider } = Layout; const DataFilesRoot: React.FC = () => { const { user } = useAuthenticatedUser(); + + if (user && !user.setupComplete) { + window.location.replace(`${window.location.origin}/onboarding/setup`); + } + const defaultPath = user?.username ? '/tapis/designsafe.storage.default' : '/public/designsafe.storage.published'; diff --git a/client/src/datafiles/layouts/published/PublishedDetailLayout.tsx b/client/src/datafiles/layouts/published/PublishedDetailLayout.tsx index 2de053ad81..0319b8f218 100644 --- a/client/src/datafiles/layouts/published/PublishedDetailLayout.tsx +++ b/client/src/datafiles/layouts/published/PublishedDetailLayout.tsx @@ -50,6 +50,11 @@ export const PublishedDetailLayout: React.FC = () => { const { data, isError } = usePublicationDetail(projectId ?? ''); const { allVersions } = usePublicationVersions(projectId ?? ''); const version = (projectId ?? '').split('v')[1]; + const selectedVersion = + version || + searchParams.get('version') || + Math.max(...allVersions).toString(); + useEffect(() => { if (version) { const newSearchParams = new URLSearchParams(searchParams); @@ -62,11 +67,6 @@ export const PublishedDetailLayout: React.FC = () => { useEffect(() => { if (!data) return; - const selectedVersion = - version || - searchParams.get('version') || - Math.max(...allVersions).toString(); - data?.baseProject.projectType !== 'other' && apiClient.get( `/api/datafiles/tapis/public/listing/designsafe.storage.published/${projectId}${ @@ -75,7 +75,7 @@ export const PublishedDetailLayout: React.FC = () => { : '' }` ); - }, [data, allVersions, searchParams, version, projectId]); + }, [data, selectedVersion, searchParams, projectId]); if (isError) { return ( @@ -171,6 +171,7 @@ export const PublishedDetailLayout: React.FC = () => {
diff --git a/client/src/main.tsx b/client/src/main.tsx index ecba772410..3aa5fc4f8e 100644 --- a/client/src/main.tsx +++ b/client/src/main.tsx @@ -5,6 +5,7 @@ import { RouterProvider } from 'react-router-dom'; import { QueryClient, QueryClientProvider } from '@tanstack/react-query'; import workspaceRouter from './workspace/workspaceRouter'; import datafilesRouter from './datafiles/datafilesRouter'; +import onboardingRouter from './onboarding/onboardingRouter'; import { ConfigProvider, ThemeConfig } from 'antd'; const queryClient = new QueryClient(); @@ -73,3 +74,17 @@ if (datafilesElement) { ); } + +const onboardingElement = document.getElementById('onboarding-root'); +if (onboardingElement) { + const onboardingRoot = ReactDOM.createRoot(onboardingElement as HTMLElement); + onboardingRoot.render( + + + + + + + + ); +} diff --git a/client/src/onboarding/layouts/OnboardingAdminLayout.module.css b/client/src/onboarding/layouts/OnboardingAdminLayout.module.css new file mode 100644 index 0000000000..e8944ba27a --- /dev/null +++ b/client/src/onboarding/layouts/OnboardingAdminLayout.module.css @@ -0,0 +1,248 @@ +.truncate-with-ellipsis { + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; +} + +/* Required to constrain table within flex box */ +.root { + position: relative; +} + +.container { + display: flex; + flex-direction: column; + padding: 20px 40px 20px 20px; + position: absolute; + max-height: 100%; + width: 100%; + height: 100%; +} + +.container-header { + display: flex; + justify-content: space-between; + align-items: baseline; + border-bottom: 1px solid #707070; + padding-bottom: 8px; + margin-bottom: 1.5em; + + @media (max-width: 768px) { + flex-direction: column; + align-items: flex-start; + } +} + +.search-checkbox-container { + display: flex; + align-items: center; + justify-content: space-between; + + @media (max-width: 990px) { + flex-direction: column; + align-items: flex-start; + } +} + +.checkbox-label-container { + display: flex; + align-items: center; + font-size: 14px; + margin: 0 0 0 20px; + + @media (max-width: 768px) { + margin-left: 0; + margin-top: 20px; + } + + @media (max-width: 991px) { + margin-left: 0; + margin-top: 10px; + } +} + +.label { + font-weight: bold; + margin: 0 0 0 10px; +} +.paginator-container { + width: 100%; + display: flex; + justify-content: center; + margin-top: 1em; +} + +.user-container { + flex-grow: 0; + overflow-y: scroll; + position: relative; +} + +.users { + --cell-horizontal-padding: 0.35em; /* horizontal cell padding for inter-column buffer */ + --cell-vertical-padding: 0.35em; + /* TODO: After, FP-103, use `composes:` not `@extend` */ + height: 100%; + align-items: stretch; + width: 100%; + overflow-y: scroll; + font-size: 14px; + + thead { + user-select: none; + color: var(--global-color-primary--x-dark); + border-bottom: 1px solid #707070; + + .-sort-asc, + .sort-desc { + color: var(--global-color-primary--xx-dark); + } + + /* Match horizontal padding of `td` elements in table to align properly */ + th { + padding: var(--cell-vertical-padding) var(--cell-horizontal-padding); + + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; + } + } + td { + padding: var(--cell-vertical-padding) var(--cell-horizontal-padding); + } +} + +.user > td { + /* Difference between tall unwrapped cell height and basic text cell height */ + --greatest-height-diff: 4.78px; /* value obtained form live render */ + /* FAQ: We want only the top space, not the top & bottom space combined */ + --vertical-offset: calc(var(--greatest-height-diff) / 2); +} +.user > td:not(.has-wrappable-content) { + /* Tweak `vertical-align`'s `top` to look like `middle` when nothing wraps */ + padding-top: calc(var(--cell-horizontal-padding) + var(--vertical-offset)); + vertical-align: top; +} +.user > td:not(.has-wrappable-content):not(.status) { + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; +} +.user:nth-child(4n), +.user:nth-child(4n-1) > td:not(.staffwait) { + background-color: #f4f4f4; +} + +.username { + display: inline-block; /* needed to make margin-top work with span */ + margin-top: 5px; /* adjust value as needed to create more space between fullname and username */ + font-weight: bold; +} + +/* HACK: This selector has knowledge of sibling component's internal markup */ +/* FAQ: Because we cannot pass `className`to via */ +/* FAQ: Because has a superfluous root element */ +.status > span > span /* i.e. 's */ { + white-space: nowrap; +} + +.reset { + /* … */ +} + +.approve-container { + i { + font-size: 14px; + } + + --vertical-buffer: 0.125em; /* vertical space between wrapped buttons */ + + /* Add space above all buttons to match space below each */ + padding-top: var(--vertical-buffer); + /* Remove space above and bellow buttons */ + margin-top: calc(-1 * var(--vertical-buffer)); + margin-bottom: calc(-1 * var(--vertical-buffer)); +} + +.approve { + display: inline; /* Do not use `inline-block` because value was `flex` */ + /* Add space below each button */ + margin-bottom: var(--vertical-buffer); + + font-size: 14px; + border-radius: 0; + padding-top: 0; + padding-bottom: 0; +} + +.approve:not(:last-child) { + margin-right: 1em; +} + +.approve > *:nth-child(1) { + margin-right: 0.5em; +} + +.action-link { + padding: 0; + + font-size: 14px; +} +.action-link:not(:first-child) { + margin-left: 0.25em; +} +.action-link:not(:last-child) { + margin-right: 0.25em; +} + +.highlightCell:has(> *.staffwait) { + background-color: #e6f4ff; +} + +.users { + table-layout: fixed; + + col:nth-child(1) { + width: 12%; + } + col:nth-child(2) { + width: 14%; + } + col:nth-child(3) { + width: 27%; + } + th:nth-child(4) { + width: 33%; + } + col:nth-child(4) { + width: 18%; + } + col:nth-child(5) { + width: 15%; + } + col:nth-child(6) { + width: 14%; + } +} + +.no-users-placeholder { + display: flex; + align-items: center; + justify-content: center; + height: 90%; +} + +/* NOTE: Mimicked on: DataFiles, DataFilesProjectsList, DataFilesProjectFileListing */ +.root-placeholder { + flex-grow: 1; + + display: flex; + align-items: center; + justify-content: center; +} + +.onboarding-admin__action-spinner .inline { + width: 10px; + height: 10px; + font-size: 14px; +} diff --git a/client/src/onboarding/layouts/OnboardingAdminLayout.tsx b/client/src/onboarding/layouts/OnboardingAdminLayout.tsx new file mode 100644 index 0000000000..2abd2e1a23 --- /dev/null +++ b/client/src/onboarding/layouts/OnboardingAdminLayout.tsx @@ -0,0 +1,418 @@ +import React, { useState, useEffect } from 'react'; +import { + Alert, + Layout, + Checkbox, + Table, + TableColumnType, + Dropdown, + Space, + Typography, + Flex, +} from 'antd'; +import type { MenuProps } from 'antd'; +import { CheckOutlined, CloseOutlined, DownOutlined } from '@ant-design/icons'; +import { useSearchParams } from 'react-router-dom'; +import { SecondaryButton, Spinner } from '@client/common-components'; +import { + OnboardingStatus, + OnboardingEventLogModal, + OnboardingAdminSearchbar, +} from '@client/onboarding'; +import styles from './OnboardingAdminLayout.module.css'; +import { + TOnboardingStep, + TOnboardingUser, + useSendOnboardingAction, + useGetOnboardingAdminList, + TOnboardingAdminList, +} from '@client/hooks'; + +const OnboardingApproveActions: React.FC<{ + step: TOnboardingStep; + username: string; +}> = ({ step, username }) => { + const { + mutate: sendOnboardingAction, + isPending, + variables, + } = useSendOnboardingAction(); + + return ( +
+ + sendOnboardingAction({ + body: { action: 'staff_approve', step: step.step }, + username, + }) + } + loading={isPending && variables?.body.action === 'staff_approve'} + disabled={isPending && variables?.body.action === 'staff_deny'} + icon={} + > + Approve + + + sendOnboardingAction({ + body: { action: 'staff_deny', step: step.step }, + username, + }) + } + loading={isPending && variables?.body.action === 'staff_deny'} + disabled={isPending && variables?.body.action === 'staff_approve'} + icon={} + > + Deny + +
+ ); +}; + +const OnboardingResetLinks: React.FC<{ + step: TOnboardingStep; + username: string; +}> = ({ step, username }) => { + const { + mutate: sendOnboardingAction, + isPending, + variables, + } = useSendOnboardingAction(); + + return ( +
+ + sendOnboardingAction({ + body: { action: 'reset', step: step.step }, + username, + }) + } + loading={isPending && variables?.body.action === 'reset'} + > + Reset + + | + + sendOnboardingAction({ + body: { action: 'complete', step: step.step }, + username, + }) + } + loading={isPending && variables?.body.action === 'complete'} + > + Skip + +
+ ); +}; + +const OnboardingAdminList: React.FC<{ + data: TOnboardingAdminList; + viewLogCallback: (user: TOnboardingUser, step: TOnboardingStep) => void; +}> = ({ data, viewLogCallback }) => { + const [searchParams, setSearchParams] = useSearchParams(); + + type TOnboardingAdminTableRowData = { + user: TOnboardingUser; + step: TOnboardingStep; + index: number; + }; + + const columns: TableColumnType[] = [ + { + title: 'User', + dataIndex: 'user', + className: styles.highlightCell, + render: (user: TOnboardingUser, record) => ( + + {`${user.firstName} ${user.lastName}`} +
+ {user.username} + + ), + onCell: (record) => ({ + rowSpan: record.index === 0 ? record.user.steps.length : 0, + }), + }, + { + title: 'Step', + dataIndex: 'step', + className: styles.highlightCell, + render: (step: TOnboardingStep) => ( + + {step.displayName} + + ), + }, + { + title: 'Status', + dataIndex: 'step', + key: 'status', + className: styles.highlightCell, + render: (step: TOnboardingStep) => ( + + + + ), + }, + { + title: 'Administrative Actions', + dataIndex: 'step', + key: 'actions', + className: styles.highlightCell, + render: (step: TOnboardingStep, record) => ( + + + {step.state === 'staffwait' && ( + + )} + + ), + }, + { + title: 'Log', + dataIndex: 'step', + key: 'log', + className: styles.highlightCell, + render: (step: TOnboardingStep, record) => ( + + viewLogCallback(record.user, step)} + > + View Log + + + ), + }, + ]; + + const { users, total, totalSteps } = data; + + const dataSource: TOnboardingAdminTableRowData[] = []; + users.forEach((user) => { + user.steps.forEach((step, index) => { + return dataSource.push({ user, step, index }); + }); + }); + + return ( + <> + + { + searchParams.set('page', page.toString()); + setSearchParams(searchParams); + }, + }} + sticky + /> + + ); +}; + +const OnboardingAdminTable: React.FC<{ + data?: TOnboardingAdminList; + isLoading: boolean; + isError: boolean; +}> = ({ data, isLoading, isError }) => { + const [eventLogModalParams, setEventLogModalParams] = useState<{ + user: TOnboardingUser; + step: TOnboardingStep; + } | null>(null); + + // Update modal step data if the user is updated + useEffect(() => { + if (eventLogModalParams?.user && data) { + setEventLogModalParams({ + user: eventLogModalParams.user, + step: + data.users + .find((user) => user.username === eventLogModalParams.user.username) + ?.steps.find( + (step) => step.step === eventLogModalParams.step.step + ) || eventLogModalParams.step, + }); + } + }, [data]); + + if (isLoading) { + return ; + } + if (isError || !data) { + return ( +
+ +
+ ); + } + + const viewLogCallback = (user: TOnboardingUser, step: TOnboardingStep) => + setEventLogModalParams({ user, step }); + + const { users } = data; + + return ( + <> + {users.length === 0 && ( +
+ +
+ )} +
+ {users.length > 0 && ( + + )} +
+ {eventLogModalParams && ( + setEventLogModalParams(null)} + /> + )} + + ); +}; + +const OnboardingAdminLayout = () => { + const [searchParams, setSearchParams] = useSearchParams(); + const { data, isError, isLoading } = useGetOnboardingAdminList(); + + useEffect(() => {}, [searchParams]); + + const toggleShowIncomplete = () => { + const showIncompleteOnly = searchParams.get('showIncompleteOnly'); + const newSearchParams = searchParams; + if (!showIncompleteOnly) { + newSearchParams.set('showIncompleteOnly', 'true'); + } else { + newSearchParams.delete('showIncompleteOnly'); + newSearchParams.delete('page'); + } + + setSearchParams(newSearchParams); + }; + + const { Header } = Layout; + const headerStyle = { + background: 'transparent', + paddingLeft: 0, + paddingRight: 0, + borderBottom: '1px solid #707070', + fontSize: 16, + }; + + const setOrderBy = (orderBy: string) => { + searchParams.set('orderBy', orderBy); + setSearchParams(searchParams); + }; + + const orderByItems: MenuProps['items'] = [ + { + key: 'default', + label: 'Default (Date Joined, Incomplete, Last Name, First Name)', + }, + { + key: 'last_name', + label: 'Last Name (A-Z)', + }, + { + key: 'first_name', + label: 'First Name (A-Z)', + }, + { + key: '-date_joined', + label: 'Date Joined (Newest First)', + }, + { + key: 'profile__setup_complete', + label: 'Setup Complete (Incomplete First)', + }, + ]; + + return ( + + +
Administrator Controls
+
+ + + setOrderBy(key), + }} + > + + + Order By + + + + + + +
+ + + + ); +}; + +export default OnboardingAdminLayout; diff --git a/client/src/onboarding/layouts/OnboardingBaseLayout.tsx b/client/src/onboarding/layouts/OnboardingBaseLayout.tsx new file mode 100644 index 0000000000..e50b2652e2 --- /dev/null +++ b/client/src/onboarding/layouts/OnboardingBaseLayout.tsx @@ -0,0 +1,26 @@ +import React from 'react'; +import { Outlet } from 'react-router-dom'; +import { Flex, Layout } from 'antd'; +import OnboardingWebsocketHandler from './OnboardingWebsocketHandler'; + +const OnboardingRoot: React.FC = () => { + return ( + + + + + + + ); +}; + +export default OnboardingRoot; diff --git a/client/src/onboarding/layouts/OnboardingUserLayout.module.css b/client/src/onboarding/layouts/OnboardingUserLayout.module.css new file mode 100644 index 0000000000..ae8590744d --- /dev/null +++ b/client/src/onboarding/layouts/OnboardingUserLayout.module.css @@ -0,0 +1,10 @@ +.access { + text-align: right; +} + +.content { + padding-bottom: 1em; +} +.content > * { + max-width: 768px; /* ~640px design * 1.2 design-to-app ratio */ +} diff --git a/client/src/onboarding/layouts/OnboardingUserLayout.tsx b/client/src/onboarding/layouts/OnboardingUserLayout.tsx new file mode 100644 index 0000000000..ffb785420d --- /dev/null +++ b/client/src/onboarding/layouts/OnboardingUserLayout.tsx @@ -0,0 +1,56 @@ +import React from 'react'; +import { useParams, Link } from 'react-router-dom'; +import { Layout, Space } from 'antd'; +import { PrimaryButton } from '@client/common-components'; +import { OnboardingStep } from '@client/onboarding'; +import { + useAuthenticatedUser, + useGetOnboardingUserSuspense, +} from '@client/hooks'; +import styles from './OnboardingUserLayout.module.css'; + +export const OnboardingUserLayout: React.FC = () => { + const { user: authenticatedUser } = useAuthenticatedUser(); + const { username } = useParams(); + const { data: onboardingUser } = useGetOnboardingUserSuspense( + username || (authenticatedUser?.username as string) + ); + + const { Header } = Layout; + const headerStyle = { + background: 'transparent', + paddingLeft: 0, + paddingRight: 0, + borderBottom: '1px solid #707070', + fontSize: 16, + }; + + return ( + + +
+ {authenticatedUser?.isStaff + ? `Onboarding Administration for ${onboardingUser.username} - ${onboardingUser.lastName}, ${onboardingUser.firstName}` + : 'The following steps must be completed before accessing the portal'} +
+ <> + {onboardingUser.steps.map((step) => ( + + ))} +
+ + Get Help + +      + + Continue + +
+ + + + ); +}; diff --git a/client/src/onboarding/layouts/OnboardingWebsocketHandler.tsx b/client/src/onboarding/layouts/OnboardingWebsocketHandler.tsx new file mode 100644 index 0000000000..5e94c4d0e1 --- /dev/null +++ b/client/src/onboarding/layouts/OnboardingWebsocketHandler.tsx @@ -0,0 +1,75 @@ +import { useEffect } from 'react'; +import useWebSocket from 'react-use-websocket'; +import { useQueryClient } from '@tanstack/react-query'; +import { + TSetupStepEvent, + TOnboardingUser, + TOnboardingAdminList, +} from '@client/hooks'; + +function updateAdminUsersFromEvent( + oldData: TOnboardingAdminList, + event: TSetupStepEvent +) { + return { + ...oldData, + users: oldData.users.map((user) => + user.username === event.username + ? { ...updateUserFromEvent(user, event) } + : user + ), + }; +} + +function updateUserFromEvent(oldData: TOnboardingUser, event: TSetupStepEvent) { + return { + ...oldData, + setupComplete: !!event.data?.setupComplete, + steps: [ + ...oldData.steps.map((step) => { + if (step.step === event.step) { + return { + ...step, + state: event.state, + events: [event, ...step.events], + }; + } + return step; + }), + ], + }; +} + +const OnboardingWebsocketHandler = () => { + const { lastMessage } = useWebSocket( + `wss://${window.location.host}/ws/websockets/` + ); + const queryClient = useQueryClient(); + const processSetupEvent = (event: TSetupStepEvent) => { + queryClient.setQueriesData( + { queryKey: ['onboarding', 'adminList'], exact: false }, + (oldData) => + (oldData as TOnboardingAdminList)?.users + ? updateAdminUsersFromEvent(oldData as TOnboardingAdminList, event) + : oldData + ); + queryClient.setQueryData( + ['onboarding', 'user', event.username], + (oldData: TOnboardingUser) => + oldData ? updateUserFromEvent(oldData, event) : oldData + ); + }; + + useEffect(() => { + if (lastMessage !== null) { + const event = JSON.parse(lastMessage.data); + if (event.event_type === 'setup_event') { + processSetupEvent(event.setup_event); + } + } + }, [lastMessage]); + + return null; +}; + +export default OnboardingWebsocketHandler; diff --git a/client/src/onboarding/onboardingRouter.tsx b/client/src/onboarding/onboardingRouter.tsx new file mode 100644 index 0000000000..7eb65f5c94 --- /dev/null +++ b/client/src/onboarding/onboardingRouter.tsx @@ -0,0 +1,49 @@ +import { Suspense } from 'react'; +import { Layout } from 'antd'; +import { createBrowserRouter, Navigate } from 'react-router-dom'; +import { Spinner } from '@client/common-components'; +import OnboardingAdminLayout from './layouts/OnboardingAdminLayout'; +import { OnboardingUserLayout } from './layouts/OnboardingUserLayout'; +import OnboardingBaseLayout from './layouts/OnboardingBaseLayout'; + +const onboardingRouter = createBrowserRouter( + [ + { + id: 'root', + path: '/', + element: , + children: [ + { + path: '', + element: , + }, + { + id: 'admin', + path: 'admin', + element: , + }, + { + path: `setup/:username?`, + element: ( + + + + } + > + + + ), + }, + { + path: '*', + element: , + }, + ], + }, + ], + { basename: '/onboarding' } +); + +export default onboardingRouter; diff --git a/client/src/workspace/layouts/AppsViewLayout.tsx b/client/src/workspace/layouts/AppsViewLayout.tsx index b78563fd94..ee3ebf0d67 100644 --- a/client/src/workspace/layouts/AppsViewLayout.tsx +++ b/client/src/workspace/layouts/AppsViewLayout.tsx @@ -51,6 +51,7 @@ export const AppsViewLayout: React.FC = () => { View User Guide @@ -59,7 +60,9 @@ export const AppsViewLayout: React.FC = () => { {htmlApp ? ( -
+
{parse(htmlApp.html as string)}
) : ( diff --git a/client/src/workspace/layouts/WorkspaceBaseLayout.tsx b/client/src/workspace/layouts/WorkspaceBaseLayout.tsx index e364998a03..35fa21ce7a 100644 --- a/client/src/workspace/layouts/WorkspaceBaseLayout.tsx +++ b/client/src/workspace/layouts/WorkspaceBaseLayout.tsx @@ -1,4 +1,4 @@ -import React from 'react'; +import React, { useState } from 'react'; import { Outlet } from 'react-router-dom'; import { Flex, Layout } from 'antd'; import { @@ -7,6 +7,7 @@ import { useGetAppParams, AppsBreadcrumb, Toast, + InteractiveSessionModal, } from '@client/workspace'; import { Spinner } from '@client/common-components'; import { @@ -14,6 +15,8 @@ import { useAppsListing, usePrefetchGetSystems, usePrefetchGetAllocations, + InteractiveModalContext, + useAuthenticatedUser, } from '@client/hooks'; import styles from './layout.module.css'; @@ -23,8 +26,16 @@ const WorkspaceRoot: React.FC = () => { usePrefetchGetApps(useGetAppParams()); usePrefetchGetSystems(); usePrefetchGetAllocations(); + const { user } = useAuthenticatedUser(); + + if (user && !user.setupComplete) { + window.location.replace(`${window.location.origin}/onboarding/setup`); + } const { data, isLoading } = useAppsListing(); + const [interactiveModalDetails, setInteractiveModalDetails] = useState({ + show: false, + }); if (!data || isLoading) return ( @@ -41,7 +52,9 @@ const WorkspaceRoot: React.FC = () => { }; return ( - <> + { - + + ); }; diff --git a/client/src/workspace/layouts/layout.module.css b/client/src/workspace/layouts/layout.module.css index 2668643dac..dc48d3cc45 100644 --- a/client/src/workspace/layouts/layout.module.css +++ b/client/src/workspace/layouts/layout.module.css @@ -14,6 +14,12 @@ overflow: auto; } +.html-app-container { + & p { + margin-block: 1em 2em; + } +} + .appDetail-placeholder-message { display: flex; justify-content: center; diff --git a/client/src/workspace/workspaceRouter.tsx b/client/src/workspace/workspaceRouter.tsx index d9b3bf7c95..ad21288298 100644 --- a/client/src/workspace/workspaceRouter.tsx +++ b/client/src/workspace/workspaceRouter.tsx @@ -7,6 +7,13 @@ import { JobsListingLayout } from './layouts/JobsListingLayout'; import { AppsViewLayout } from './layouts/AppsViewLayout'; import { AppsPlaceholderLayout } from './layouts/AppsPlaceholderLayout'; +const getBaseName = () => { + if (window.location.pathname.startsWith('/rw/workspace')) { + return '/rw/workspace'; + } + return '/workspace'; +}; + const workspaceRouter = createBrowserRouter( [ { @@ -44,7 +51,7 @@ const workspaceRouter = createBrowserRouter( ], }, ], - { basename: '/rw/workspace' } + { basename: getBaseName() } ); export default workspaceRouter; diff --git a/client/tsconfig.base.json b/client/tsconfig.base.json index c66e21b834..613b2c6399 100644 --- a/client/tsconfig.base.json +++ b/client/tsconfig.base.json @@ -18,6 +18,7 @@ "@client/common-components": ["modules/_common_components/src/index.ts"], "@client/datafiles": ["modules/datafiles/src/index.ts"], "@client/hooks": ["modules/_hooks/src/index.ts"], + "@client/onboarding": ["modules/onboarding/src/index.ts"], "@client/test-fixtures": ["modules/_test-fixtures/src/index.ts"], "@client/workspace": ["modules/workspace/src/index.ts"] } diff --git a/conf/docker/docker-compose-dev.all.debug.m1.yml b/conf/docker/docker-compose-dev.all.debug.m1.yml index edbe69b19c..8337c2219f 100644 --- a/conf/docker/docker-compose-dev.all.debug.m1.yml +++ b/conf/docker/docker-compose-dev.all.debug.m1.yml @@ -77,7 +77,10 @@ services: django: image: designsafeci/portal:tapis-v3 - env_file: ../env_files/designsafe.env + env_file: + - path: ../env_files/designsafe.env + - path: ../env_files/ngrok.env + required: false links: - memcached:memcached - rabbitmq:rabbitmq @@ -98,7 +101,10 @@ services: websockets: image: designsafeci/portal:tapis-v3 - env_file: ../env_files/designsafe.env + env_file: + - path: ../env_files/designsafe.env + - path: ../env_files/ngrok.env + required: false volumes: - ../../.:/srv/www/designsafe - ../../data/media:/srv/www/designsafe/media @@ -108,7 +114,10 @@ services: workers: image: designsafeci/portal:tapis-v3 - env_file: ../env_files/designsafe.env + env_file: + - path: ../env_files/designsafe.env + - path: ../env_files/ngrok.env + required: false links: - memcached:memcached - rabbitmq:rabbitmq @@ -125,6 +134,20 @@ services: container_name: des_workers hostname: des_workers + ngrok: + image: ngrok/ngrok:latest + platform: "linux/amd64" + environment: + NGROK_AUTHTOKEN: ${NGROK_AUTHTOKEN} + command: + - "http" + - --url=${NGROK_DOMAIN} + - "https://host.docker.internal:443" + ports: + - 4040:4040 + container_name: des_ngrok + hostname: des_ngrok + volumes: redis_data_v3: des_postgres_data_v3: diff --git a/conf/docker/docker-compose-dev.all.debug.yml b/conf/docker/docker-compose-dev.all.debug.yml index 22d5c62155..9fb100962a 100644 --- a/conf/docker/docker-compose-dev.all.debug.yml +++ b/conf/docker/docker-compose-dev.all.debug.yml @@ -73,7 +73,10 @@ services: django: image: designsafeci/portal:tapis-v3 - env_file: ../env_files/designsafe.env + env_file: + - path: ../env_files/designsafe.env + - path: ../env_files/ngrok.env + required: false links: - memcached:memcached - rabbitmq:rabbitmq @@ -94,7 +97,10 @@ services: websockets: image: designsafeci/portal:tapis-v3 - env_file: ../env_files/designsafe.env + env_file: + - path: ../env_files/designsafe.env + - path: ../env_files/ngrok.env + required: false volumes: - ../../.:/srv/www/designsafe - ../../data/media:/srv/www/designsafe/media @@ -104,7 +110,10 @@ services: workers: image: designsafeci/portal:tapis-v3 - env_file: ../env_files/designsafe.env + env_file: + - path: ../env_files/designsafe.env + - path: ../env_files/ngrok.env + required: false links: - memcached:memcached - rabbitmq:rabbitmq @@ -121,6 +130,19 @@ services: container_name: des_workers hostname: des_workers + ngrok: + image: ngrok/ngrok:latest + environment: + NGROK_AUTHTOKEN: ${NGROK_AUTHTOKEN} + command: + - "http" + - --url=${NGROK_DOMAIN} + - "https://host.docker.internal:443" + ports: + - 4040:4040 + container_name: des_ngrok + hostname: des_ngrok + volumes: redis_data_v3: des_postgres_data_v3: diff --git a/conf/env_files/designsafe.sample.env b/conf/env_files/designsafe.sample.env index 5c13942f68..6c9d2824f4 100644 --- a/conf/env_files/designsafe.sample.env +++ b/conf/env_files/designsafe.sample.env @@ -1,5 +1,10 @@ ### -# Set to "True" to enable Django DEBUG mode. +# Set to `True` to enable React (e.g. the Workspace) +# +RENDER_REACT=True + +### +# Set to `True` to enable Django DEBUG mode. # https://docs.djangoproject.com/en/2.2/ref/settings/#std:setting-DEBUG # DJANGO_DEBUG=True @@ -80,7 +85,6 @@ AGAVE_CLIENT_SECRET= AGAVE_SUPER_TOKEN= AGAVE_STORAGE_SYSTEM= -AGAVE_WORKING_SYSTEM= AGAVE_JWT_PUBKEY= AGAVE_JWT_ISSUER= AGAVE_JWT_HEADER= @@ -189,3 +193,12 @@ MONGO_USER= MONGO_PASS= MONGO_HOST= MONGO_DB= + +## +# Miscellaneous +# + +DATACITE_USER= +DATACITE_PASS= +DATACITE_URL= +DATACITE_SHOULDER= diff --git a/conf/env_files/ngrok.sample.env b/conf/env_files/ngrok.sample.env new file mode 100644 index 0000000000..65ae75620a --- /dev/null +++ b/conf/env_files/ngrok.sample.env @@ -0,0 +1,5 @@ +# Get authtoken from https://dashboard.ngrok.com/get-started/your-authtoken +NGROK_AUTHTOKEN=your_ngrok_authtoken + +# Get static domain from https://dashboard.ngrok.com/domains +NGROK_DOMAIN=your-ngrok-subdomain.ngrok-free.app diff --git a/designsafe/apps/accounts/migrations/0022_designsafeprofile_setup_complete.py b/designsafe/apps/accounts/migrations/0022_designsafeprofile_setup_complete.py new file mode 100644 index 0000000000..a9181c2f51 --- /dev/null +++ b/designsafe/apps/accounts/migrations/0022_designsafeprofile_setup_complete.py @@ -0,0 +1,17 @@ +# Generated by Django 4.2.11 on 2024-10-15 23:05 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + dependencies = [ + ("designsafe_accounts", "0021_designsafeprofile_homedir"), + ] + + operations = [ + migrations.AddField( + model_name="designsafeprofile", + name="setup_complete", + field=models.BooleanField(default=False), + ), + ] diff --git a/designsafe/apps/accounts/models.py b/designsafe/apps/accounts/models.py index 33ef9d1d0a..ddd0ce232a 100644 --- a/designsafe/apps/accounts/models.py +++ b/designsafe/apps/accounts/models.py @@ -79,6 +79,9 @@ class DesignSafeProfile(models.Model): update_required = models.BooleanField(default=True) last_updated = models.DateTimeField(auto_now=True, null=True) + # Default to False. If PORTAL_USER_ACCOUNT_SETUP_STEPS is empty, setup_complete will be set to True on first login + setup_complete = models.BooleanField(default=False) + def send_mail(self, subject, body=None): send_mail(subject, body, diff --git a/designsafe/apps/accounts/templates/designsafe/apps/accounts/base.html b/designsafe/apps/accounts/templates/designsafe/apps/accounts/base.html index e0c074ed59..b70f0557f4 100644 --- a/designsafe/apps/accounts/templates/designsafe/apps/accounts/base.html +++ b/designsafe/apps/accounts/templates/designsafe/apps/accounts/base.html @@ -9,7 +9,7 @@

{{title}}

    {% url 'designsafe_accounts:manage_profile' as item_url %} -
  • Account Profile
    • +
  • Manage Account
    • {% url 'designsafe_accounts:manage_authentication' as item_url %}
  • Authentication
    • diff --git a/designsafe/apps/accounts/templates/designsafe/apps/accounts/profile.html b/designsafe/apps/accounts/templates/designsafe/apps/accounts/profile.html index 85ba529baf..0f41e9f442 100644 --- a/designsafe/apps/accounts/templates/designsafe/apps/accounts/profile.html +++ b/designsafe/apps/accounts/templates/designsafe/apps/accounts/profile.html @@ -1,11 +1,11 @@ {% extends "designsafe/apps/accounts/base.html" %} -{% block title %}Account Profile{% endblock %} +{% block title %}Manage Account{% endblock %} {% block panel_content %}
    -

    Account Profile

    +

    Manage Account

    diff --git a/designsafe/apps/accounts/urls.py b/designsafe/apps/accounts/urls.py index 18e1585e55..7d54f11d58 100644 --- a/designsafe/apps/accounts/urls.py +++ b/designsafe/apps/accounts/urls.py @@ -30,7 +30,7 @@ def menu_items(**kwargs): if 'type' in kwargs and kwargs['type'] == 'account': return [ { - 'label': _('Account Profile'), + 'label': _('Manage Account'), 'url': reverse('designsafe_accounts:index'), 'children': [], }, diff --git a/designsafe/apps/accounts/views.py b/designsafe/apps/accounts/views.py index 346fb04764..44e7f2988e 100644 --- a/designsafe/apps/accounts/views.py +++ b/designsafe/apps/accounts/views.py @@ -11,12 +11,10 @@ from designsafe.apps.accounts import forms, integrations from designsafe.apps.accounts.models import (NEESUser, DesignSafeProfile, NotificationPreferences) -from designsafe.apps.auth.tasks import check_or_configure_system_and_user_directory, get_systems_to_configure from designsafe.apps.accounts.tasks import create_report from pytas.http import TASClient from pytas.models import User as TASUser import logging -import json import requests import re from termsandconditions.models import TermsAndConditions @@ -49,7 +47,7 @@ def manage_profile(request): logger.info('exception e:{} {}'.format(type(e), e)) context = { - 'title': 'Account Profile', + 'title': 'Manage Account', 'profile': user_profile, 'ds_profile': ds_profile, 'demographics': demographics, @@ -353,7 +351,7 @@ def profile_edit(request): form = forms.UserProfileForm(initial=tas_user) context = { - 'title': 'Account Profile', + 'title': 'Manage Account', 'form': form, 'pro_form': pro_form } @@ -467,12 +465,6 @@ def email_confirmation(request, code=None): user = tas.get_user(username=username) if tas.verify_user(user['id'], code, password=password): logger.info('TAS Account activation succeeded.') - systems_to_configure = get_systems_to_configure(username) - for system in systems_to_configure: - check_or_configure_system_and_user_directory.apply_async(args=(user.username, - system["system_id"], - system["path"], - system["create_path"])) return HttpResponseRedirect(reverse('designsafe_accounts:manage_profile')) else: messages.error(request, @@ -481,7 +473,7 @@ def email_confirmation(request, code=None): 'open a support ticket.') form = forms.EmailConfirmationForm( initial={'code': code, 'username': username}) - except: + except Exception: logger.exception('TAS Account activation failed') form.add_error('__all__', 'Account activation failed. Please confirm your ' diff --git a/designsafe/apps/api/notifications/receivers.py b/designsafe/apps/api/notifications/receivers.py index 316840a699..2b7c564157 100644 --- a/designsafe/apps/api/notifications/receivers.py +++ b/designsafe/apps/api/notifications/receivers.py @@ -1,52 +1,70 @@ +"""Signal receivers for notifications""" + +import logging +import json +from django.db.models.signals import post_save from django.dispatch import receiver +from django.contrib.auth import get_user_model from asgiref.sync import async_to_sync from channels.layers import get_channel_layer -from django.db.models.signals import post_save from designsafe.apps.api.notifications.models import Notification, Broadcast -import logging -import json +from designsafe.apps.onboarding.models import SetupEvent + logger = logging.getLogger(__name__) -WEBSOCKETS_FACILITY = 'websockets' +WEBSOCKETS_FACILITY = "websockets" + + +@receiver(post_save, sender=Notification, dispatch_uid="notification_msg") +def send_notification_ws(instance, created, **kwargs): + """Send a websocket message to the user when a new notification is created.""" -@receiver(post_save, sender=Notification, dispatch_uid='notification_msg') -def send_notification_ws(sender, instance, created, **kwargs): - #Only send WS message if it's a new notification not if we're updating. - logger.debug('receiver received something.') if not created: return - try: - channel_layer = get_channel_layer() - instance_dict = json.dumps(instance.to_dict()) - logger.debug(instance_dict) - async_to_sync(channel_layer.group_send)(f"ds_{instance.user}", {"type": "ds.notification", "message": instance_dict}) + channel_layer = get_channel_layer() + instance_dict = json.dumps(instance.to_dict()) + async_to_sync(channel_layer.group_send)( + f"ds_{instance.user}", {"type": "ds.notification", "message": instance_dict} + ) - # logger.debug('WS socket msg sent: {}'.format(instance_dict)) - except Exception as e: - # logger.debug('Exception sending websocket message', - # exc_info=True, - # extra = instance.to_dict()) - logger.debug('Exception sending websocket message', - exc_info=True) - return -@receiver(post_save, sender=Broadcast, dispatch_uid='broadcast_msg') -def send_broadcast_ws(sender, instance, created, **kwargs): +@receiver(post_save, sender=Broadcast, dispatch_uid="broadcast_msg") +def send_broadcast_ws(instance, created, **kwargs): + """Send a websocket message to all users when a new broadcast is created.""" + if not created: return - try: - event_type, user, body = decompose_message(instance) - #rp = RedisPublisher(facility = WEBSOCKETS_FACILITY,broadcast=True) - channel_layer = get_channel_layer() - instance_dict = json.dumps(instance.to_dict()) - - async_to_sync(channel_layer.group_send)("ds_broadcast", {"type": "ds.notification", "message": instance_dict}) - logger.debug('WS socket msg sent: {}'.format(instance_dict)) - except Exception as e: - logger.debug('Exception sending websocket message', - exc_info=True, - extra = instance.to_dict()) - return + + channel_layer = get_channel_layer() + instance_dict = json.dumps(instance.to_dict()) + + async_to_sync(channel_layer.group_send)( + "ds_broadcast", {"type": "ds.notification", "message": instance_dict} + ) + + +@receiver(post_save, sender=SetupEvent, dispatch_uid="setup_event") +def send_setup_event(instance, **kwargs): + """Send a websocket message to the user and all staff when a new setup event is created.""" + + logger.info("Sending setup event through websocket") + setup_event = instance + + # All staff will receive websocket notifications so they can see + # setup event updates for users they are administering + receiving_users = list(get_user_model().objects.all().filter(is_staff=True)) + + channel_layer = get_channel_layer() + + # Add the setup_event's user to the notification list + receiving_users.append(setup_event.user) + + data = {"event_type": "setup_event", "setup_event": setup_event.to_dict()} + for user in set(receiving_users): + async_to_sync(channel_layer.group_send)( + f"ds_{user.username}", + {"type": "ds.notification", "message": json.dumps(data)}, + ) diff --git a/designsafe/apps/api/projects_v2/elasticsearch.py b/designsafe/apps/api/projects_v2/elasticsearch.py new file mode 100644 index 0000000000..bb11a770ec --- /dev/null +++ b/designsafe/apps/api/projects_v2/elasticsearch.py @@ -0,0 +1,43 @@ +"""Elasticsearch model for published works""" + +from elasticsearch_dsl import Document +from elasticsearch.exceptions import NotFoundError +import networkx as nx +from django.conf import settings +from designsafe.apps.api.projects_v2.models import ProjectMetadata +from designsafe.apps.api.projects_v2.operations.project_publish_operations import ( + add_values_to_tree, +) + + +class IndexedProject(Document): + """Elasticsearch model for published works""" + + # pylint: disable=too-few-public-methods + class Index: + """Index meta settings""" + + name = settings.ES_INDICES["projects_v2"]["alias"] + + +def index_project(project_id): + """Util to index a project by its project ID""" + project_meta = ProjectMetadata.get_project_by_id(project_id) + project_tree = add_values_to_tree(project_id) + project_json = nx.node_link_data(project_tree) + try: + pub_es = IndexedProject.get(project_id) + pub_es.update(**project_json, uuid=project_meta.uuid, value=project_meta.value) + + except NotFoundError: + pub_es = IndexedProject( + **project_json, uuid=project_meta.uuid, value=project_meta.value + ) + pub_es.meta["id"] = project_id + pub_es.save() + + +def reindex_projects(): + """Reindex all projects""" + for prj in ProjectMetadata.objects.filter(name="designsafe.project"): + index_project(prj.project_id) diff --git a/designsafe/apps/api/projects_v2/operations/project_email_operations.py b/designsafe/apps/api/projects_v2/operations/project_email_operations.py new file mode 100644 index 0000000000..7420122707 --- /dev/null +++ b/designsafe/apps/api/projects_v2/operations/project_email_operations.py @@ -0,0 +1,36 @@ +"""Utilities to email users/staff in response to project lifecycle changes.""" + +from typing import Optional +from django.conf import settings +from django.core.mail import send_mail + + +def send_project_permissions_alert(project_id: str, version: Optional[int], error: str): + """ + Alert dev team when a project has encountered a permission error during publication. + """ + prj_admins = settings.DEV_PROJECT_ADMINS_EMAIL + for admin in prj_admins: + email_body = f""" +

    Hello,

    +

    + The following project has encountered a permission error during publication: +
    + {project_id} - revision {version} +
    +

    +

    + The error is as follows:
    + {error} +

    + + This is a programmatically generated message. Do NOT reply to this message. + """ + + send_mail( + "DesignSafe Alert: Published Project has missing files/folders", + email_body, + settings.DEFAULT_FROM_EMAIL, + [admin], + html_message=email_body, + ) diff --git a/designsafe/apps/api/projects_v2/operations/project_publish_operations.py b/designsafe/apps/api/projects_v2/operations/project_publish_operations.py index ea001db0c0..26f4b9c253 100644 --- a/designsafe/apps/api/projects_v2/operations/project_publish_operations.py +++ b/designsafe/apps/api/projects_v2/operations/project_publish_operations.py @@ -25,6 +25,9 @@ from designsafe.apps.api.projects_v2.operations.project_archive_operations import ( archive_publication_async, ) +from designsafe.apps.api.projects_v2.operations.project_email_operations import ( + send_project_permissions_alert, +) from designsafe.apps.api.publications_v2.models import Publication from designsafe.apps.api.publications_v2.elasticsearch import index_publication from designsafe.apps.data.tasks import agave_indexer @@ -420,6 +423,11 @@ def copy_publication_files( }, queue="indexing", ) + + except PermissionError as exc: + logger.error(exc) + send_project_permissions_alert(project_id, version, str(exc)) + finally: os.chmod("/corral-repl/tacc/NHERI/published", 0o555) diff --git a/designsafe/apps/api/projects_v2/operations/project_system_operations.py b/designsafe/apps/api/projects_v2/operations/project_system_operations.py index bf10a61a09..3be39c7379 100644 --- a/designsafe/apps/api/projects_v2/operations/project_system_operations.py +++ b/designsafe/apps/api/projects_v2/operations/project_system_operations.py @@ -10,9 +10,6 @@ from designsafe.libs.common.context_managers import AsyncTaskContext -# from portal.apps.onboarding.steps.system_access_v3 import create_system_credentials, register_public_key - - logger = logging.getLogger(__name__) @@ -155,30 +152,39 @@ def setup_project_file_system(project_uuid: str, users: list[str]): # User creates the system and adds their credential resp = create_workspace_system(service_client, project_uuid) - for username in users: - add_user_to_project_async.apply_async(args=[project_uuid, username]) + # Add tg458981 to ensure it can read externally transferred data + acl_users = ["tg458981", *users] + + add_users_to_project_async.apply_async(args=[project_uuid, acl_users]) return resp -def add_user_to_project(project_uuid: str, username: str, set_acls=True): +def add_user_to_project(project_uuid: str, username: str): """ Give a user POSIX and Tapis permissions on a workspace system. """ service_client = service_account() system_id = f"project-{project_uuid}" logger.debug("Adding user %s to system %s", username, system_id) - if set_acls: - job_res = submit_workspace_acls_job(username, project_uuid, action="add") - logger.debug( - "Submitted workspace ACL job %s with UUID %s", job_res.name, job_res.uuid - ) + service_client.systems.shareSystem(systemId=system_id, users=[username]) set_workspace_permissions(service_client, username, system_id, role="writer") return project_uuid +def add_users_to_project(project_uuid: str, usernames: list[str]): + """Add multiple users to a project and set their ACLs using a single Tapis job.""" + for username in usernames: + add_user_to_project(project_uuid, username) + + job_res = submit_workspace_acls_job(",".join(usernames), project_uuid, action="add") + logger.debug( + "Submitted workspace ACL job %s with UUID %s", job_res.name, job_res.uuid + ) + + def remove_user_from_project(project_uuid: str, username: str): """ Unshare the system and remove all permissions and credentials. @@ -186,10 +192,6 @@ def remove_user_from_project(project_uuid: str, username: str): service_client = service_account() system_id = f"project-{project_uuid}" logger.debug("Removing user %s from system %s", username, system_id) - job_res = submit_workspace_acls_job(username, project_uuid, action="remove") - logger.debug( - "Submitted workspace ACL job %s with UUID %s", job_res.name, job_res.uuid - ) service_client.systems.unShareSystem(systemId=system_id, users=[username]) service_client.systems.revokeUserPerms( @@ -202,20 +204,33 @@ def remove_user_from_project(project_uuid: str, username: str): return project_uuid +def remove_users_from_project(project_uuid: str, usernames: list[str]): + """Remove multiple users from project, setting ACLs using a single Tapis job.""" + for username in usernames: + remove_user_from_project(project_uuid, username) + + acl_usernames = ",".join(usernames) + + job_res = submit_workspace_acls_job(acl_usernames, project_uuid, action="remove") + logger.debug( + "Submitted workspace ACL job %s with UUID %s", job_res.name, job_res.uuid + ) + + ########################################## # ASYNC TASKS FOR USER ADDITION/REMOVAL ########################################## @shared_task(bind=True) -def add_user_to_project_async(self, project_uuid: str, username: str): +def add_users_to_project_async(self, project_uuid: str, usernames: list[str]): """Async wrapper around add_user_to_project""" with AsyncTaskContext(): - add_user_to_project(project_uuid, username) + add_users_to_project(project_uuid, usernames) @shared_task(bind=True) -def remove_user_from_project_async(self, project_uuid: str, username: str): +def remove_users_from_project_async(self, project_uuid: str, usernames: str): """Async wrapper around remove_user_from_project""" with AsyncTaskContext(): - remove_user_from_project(project_uuid, username) + remove_users_from_project(project_uuid, usernames) diff --git a/designsafe/apps/api/projects_v2/tasks.py b/designsafe/apps/api/projects_v2/tasks.py index 02dc6df42b..dcdebaf4e4 100644 --- a/designsafe/apps/api/projects_v2/tasks.py +++ b/designsafe/apps/api/projects_v2/tasks.py @@ -7,8 +7,8 @@ # pylint: disable=unused-import from designsafe.apps.api.projects_v2.operations.project_system_operations import ( - add_user_to_project_async, - remove_user_from_project_async, + add_users_to_project_async, + remove_users_from_project_async, ) from designsafe.apps.api.projects_v2.models.project_metadata import ProjectMetadata from designsafe.apps.api.projects_v2.operations.project_publish_operations import ( @@ -18,6 +18,7 @@ from designsafe.apps.api.projects_v2.operations.project_archive_operations import ( archive_publication_async, ) +from designsafe.apps.api.projects_v2.elasticsearch import reindex_projects from designsafe.libs.common.context_managers import AsyncTaskContext @@ -65,3 +66,10 @@ def alert_sensitive_data(project_id, username): [admin], html_message=email_body, ) + + +@shared_task() +def reindex_projects_async(): + """Async wrapper around project reindex util""" + with AsyncTaskContext(): + reindex_projects() diff --git a/designsafe/apps/api/projects_v2/views.py b/designsafe/apps/api/projects_v2/views.py index 884d22bc57..e48352c6e7 100644 --- a/designsafe/apps/api/projects_v2/views.py +++ b/designsafe/apps/api/projects_v2/views.py @@ -43,14 +43,16 @@ from designsafe.apps.api.projects_v2.operations.project_system_operations import ( increment_workspace_count, setup_project_file_system, - add_user_to_project_async, - remove_user_from_project_async, + add_users_to_project_async, + remove_users_from_project_async, ) from designsafe.apps.api.projects_v2.schema_models.base import FileObj from designsafe.apps.api.decorators import tapis_jwt_login +from designsafe.apps.api.utils import get_client_ip logger = logging.getLogger(__name__) +metrics = logging.getLogger("metrics") def check_project_admin_group(user) -> bool: @@ -101,6 +103,18 @@ def get(self, request: HttpRequest): # user = get_user_model().objects.get(username="ds_admin") user = request.user + metrics.info( + "Projects", + extra={ + "user": request.user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "projects.listing", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": {}, + }, + ) + if not request.user.is_authenticated: raise ApiException("Unauthenticated user", status=401) @@ -133,6 +147,18 @@ def post(self, request: HttpRequest): metadata_value = req_body.get("value", {}) # Projects are initialized as type None + metrics.info( + "Projects", + extra={ + "user": request.user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "projects.create", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": {"body": req_body}, + }, + ) + # increment project count prj_number = increment_workspace_count() # create metadata and graph @@ -156,6 +182,19 @@ class ProjectInstanceView(BaseApiView): def get(self, request: HttpRequest, project_id: str): """Return all project metadata for a project ID""" user = request.user + + metrics.info( + "Projects", + extra={ + "user": request.user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "projects.detail", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": {"project_id": project_id}, + }, + ) + if not request.user.is_authenticated: raise ApiException("Unauthenticated user", status=401) @@ -182,6 +221,19 @@ def put(self, request: HttpRequest, project_id: str): # Get the new value from the request data req_body = json.loads(request.body) + + metrics.info( + "Projects", + extra={ + "user": request.user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "projects.change_project_type", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": {"project_id": project, "body": req_body}, + }, + ) + new_value = req_body.get("value", {}) sensitive_data_option = req_body.get("sensitiveData", False) if sensitive_data_option: @@ -195,10 +247,10 @@ def put(self, request: HttpRequest, project_id: str): BaseProject.model_validate(project.value), BaseProject.model_validate(updated_project.value), ) - for user_to_add in users_to_add: - add_user_to_project_async.apply_async([project.uuid, user_to_add]) - for user_to_remove in users_to_remove: - remove_user_from_project_async.apply_async([project.uuid, user_to_remove]) + if users_to_add: + add_users_to_project_async.apply_async([project.uuid, users_to_add]) + if users_to_remove: + remove_users_from_project_async.apply_async([project.uuid, users_to_remove]) return JsonResponse({"result": "OK"}) @@ -212,6 +264,19 @@ def patch(self, request: HttpRequest, project_id: str): project = get_project_for_user(project_id, user) request_body = json.loads(request.body).get("patchMetadata", {}) + + metrics.info( + "Projects", + extra={ + "user": request.user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "projects.patch_project", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": {"project_id": project, "body": request_body}, + }, + ) + prev_metadata = BaseProject.model_validate(project.value) updated_project = patch_metadata(project.uuid, request_body) updated_metadata = BaseProject.model_validate(updated_project.value) @@ -219,10 +284,10 @@ def patch(self, request: HttpRequest, project_id: str): users_to_add, users_to_remove = get_changed_users( prev_metadata, updated_metadata ) - for user_to_add in users_to_add: - add_user_to_project_async.apply_async([project.uuid, user_to_add]) - for user_to_remove in users_to_remove: - remove_user_from_project_async.apply_async([project.uuid, user_to_remove]) + if users_to_add: + add_users_to_project_async.apply_async([project.uuid, users_to_add]) + if users_to_remove: + remove_users_from_project_async.apply_async([project.uuid, users_to_remove]) return JsonResponse({"result": "OK"}) @@ -240,6 +305,19 @@ def patch(self, request: HttpRequest, entity_uuid: str): get_project_for_user(entity_meta.base_project.project_id, user) request_body = json.loads(request.body).get("patchMetadata", {}) + + metrics.info( + "Projects", + extra={ + "user": request.user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "projects.patch_metadata", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": {"entity_uuid": entity_uuid, "body": request_body}, + }, + ) + logger.debug(request_body) patch_metadata(entity_uuid, request_body) return JsonResponse({"result": "OK"}) @@ -250,6 +328,18 @@ def delete(self, request: HttpRequest, entity_uuid: str): if not request.user.is_authenticated: raise ApiException("Unauthenticated user", status=401) + metrics.info( + "Projects", + extra={ + "user": request.user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "projects.delete_entity", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": {"entity_uuid": entity_uuid}, + }, + ) + entity_meta = ProjectMetadata.objects.get(uuid=entity_uuid) get_project_for_user(entity_meta.base_project.project_id, user) @@ -274,6 +364,19 @@ def post(self, request: HttpRequest, project_id: str): ) from exc req_body = json.loads(request.body) + + metrics.info( + "Projects", + extra={ + "user": request.user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "projects.create_entity", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": {"project_id": project_id, "body": req_body}, + }, + ) + value = req_body.get("value", {}) name = req_body.get("name", "") @@ -314,6 +417,18 @@ def put(self, request: HttpRequest, project_id: str): node_id = request_body.get("nodeId") order = request_body.get("order") + metrics.info( + "Projects", + extra={ + "user": request.user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "projects.reorder_entities", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": {"project_id": project_id, "body": request_body}, + }, + ) + if not node_id or order is None: raise ApiException("Node ID and new order must be specified", status=400) @@ -337,6 +452,22 @@ def post(self, request: HttpRequest, project_id, node_id): user = request.user entity_uuid = request_body.get("uuid") + metrics.info( + "Projects", + extra={ + "user": request.user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "projects.delete_entity", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": { + "project_id": project_id, + "node_id": node_id, + "body": request_body, + }, + }, + ) + if not entity_uuid: raise ApiException("Entity UUID must be provided", status=400) @@ -357,6 +488,19 @@ def post(self, request: HttpRequest, project_id, node_id): def delete(self, request: HttpRequest, project_id, node_id): """Remove a node from the project tree.""" user = request.user + + metrics.info( + "Projects", + extra={ + "user": request.user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "projects.remove_node", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": {"project_id": project_id, "node_id": node_id}, + }, + ) + if not request.user.is_authenticated: raise ApiException("Unauthenticated user", status=401) @@ -387,6 +531,22 @@ def patch(self, request: HttpRequest, project_id, entity_uuid): user = request.user + metrics.info( + "Projects", + extra={ + "user": request.user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "projects.patch_files", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": { + "project_id": project_id, + "entity_uuid": entity_uuid, + "body": file_obj_data, + }, + }, + ) + if not entity_uuid: raise ApiException("Entity UUID must be provided", status=400) @@ -422,6 +582,22 @@ def put(self, request: HttpRequest, project_id, entity_uuid): user = request.user + metrics.info( + "Projects", + extra={ + "user": request.user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "projects.put_files", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": { + "project_id": project_id, + "entity_uuid": entity_uuid, + "body": file_obj_data, + }, + }, + ) + if not entity_uuid: raise ApiException("Entity UUID must be provided", status=400) @@ -444,6 +620,22 @@ def delete(self, request: HttpRequest, project_id, entity_uuid, file_path): """Remove the association between a file and an entity.""" user = request.user + metrics.info( + "Projects", + extra={ + "user": request.user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "projects.remove_file", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": { + "project_id": project_id, + "entity_uuid": entity_uuid, + "file_path": file_path, + }, + }, + ) + if not entity_uuid: raise ApiException("Entity UUID must be provided", status=400) @@ -472,6 +664,22 @@ def put(self, request: HttpRequest, project_id, entity_uuid, file_path): user = request.user + metrics.info( + "Projects", + extra={ + "user": request.user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "projects.set_file_tags", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": { + "project_id": project_id, + "entity_uuid": entity_uuid, + "body": tag_names, + }, + }, + ) + if not entity_uuid: raise ApiException("Entity UUID must be provided", status=400) @@ -497,6 +705,21 @@ class ProjectEntityValidateView(BaseApiView): def post(self, request: HttpRequest, project_id): """validate a selection of entities to check publication-readiness.""" user = request.user + + metrics.info( + "Projects", + extra={ + "user": request.user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "projects.validate_entities", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": { + "project_id": project_id, + }, + }, + ) + if not request.user.is_authenticated: raise ApiException("Unauthenticated user", status=401) diff --git a/designsafe/apps/api/publications_v2/elasticsearch.py b/designsafe/apps/api/publications_v2/elasticsearch.py index ca0fa34351..fd18e2f3d2 100644 --- a/designsafe/apps/api/publications_v2/elasticsearch.py +++ b/designsafe/apps/api/publications_v2/elasticsearch.py @@ -21,9 +21,9 @@ def index_publication(project_id): pub = Publication.objects.get(project_id=project_id) try: pub_es = IndexedPublication.get(project_id) - pub_es.update(**pub.tree) + pub_es.update(**pub.tree, created=pub.created) except NotFoundError: - pub_es = IndexedPublication(**pub.tree) + pub_es = IndexedPublication(**pub.tree, created=pub.created) pub_es.meta["id"] = project_id pub_es.save() diff --git a/designsafe/apps/api/publications_v2/views.py b/designsafe/apps/api/publications_v2/views.py index 3209a77929..39293262de 100644 --- a/designsafe/apps/api/publications_v2/views.py +++ b/designsafe/apps/api/publications_v2/views.py @@ -12,8 +12,10 @@ amend_publication_async, ) from designsafe.apps.api.projects_v2.views import get_project_for_user +from designsafe.apps.api.utils import get_client_ip logger = logging.getLogger(__name__) +metrics = logging.getLogger("metrics") def handle_search(query_opts: dict, offset=0, limit=100): @@ -173,6 +175,18 @@ def get(self, request: HttpRequest): "data-type": request.GET.get("data-type", None), } + metrics.info( + "Publications", + extra={ + "user": request.user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "publications.listing", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": {"query": query_opts}, + }, + ) + has_query = any(query_opts.values()) if has_query: hits, total = handle_search(query_opts, offset, limit) @@ -218,6 +232,18 @@ def get(self, request: HttpRequest, project_id, version=None): except Publication.DoesNotExist as exc: raise ApiException(status=404, message="Publication not found.") from exc + metrics.info( + "Publications", + extra={ + "user": request.user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "publications.detail", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": {"project_id": project_id}, + }, + ) + pub_tree: nx.DiGraph = nx.node_link_graph(pub_meta.tree) file_tags = [] for file_tag_arr in [ @@ -243,6 +269,18 @@ def post(self, request: HttpRequest): request_body = json.loads(request.body) logger.debug(request_body) + metrics.info( + "Publications", + extra={ + "user": request.user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "publications.publish", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": {"body": request_body}, + }, + ) + project_id = request_body.get("projectId", None) entities_to_publish = request_body.get("entityUuids", None) @@ -266,6 +304,18 @@ def post(self, request: HttpRequest): request_body = json.loads(request.body) logger.debug(request_body) + metrics.info( + "Publications", + extra={ + "user": request.user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "publications.version", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": {"body": request_body}, + }, + ) + project_id = request_body.get("projectId", None) entities_to_publish = request_body.get("entityUuids", None) version_info = request_body.get("versionInfo", None) @@ -298,6 +348,18 @@ def post(self, request: HttpRequest): request_body = json.loads(request.body) logger.debug(request_body) + metrics.info( + "Publications", + extra={ + "user": request.user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "publications.amend", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": {"body": request_body}, + }, + ) + project_id = request_body.get("projectId", None) if not project_id: diff --git a/designsafe/apps/api/systems/utils.py b/designsafe/apps/api/systems/utils.py index 984efeba77..e6f1fea32d 100644 --- a/designsafe/apps/api/systems/utils.py +++ b/designsafe/apps/api/systems/utils.py @@ -34,7 +34,7 @@ def add_pub_key_to_resource( :param str hostname: Resource's hostname :param int port: Port to use for ssh connection - :raises: :class:`~portal.apps.accounts.managers.` + :raises: :class:`~designsafe.apps.accounts.managers.` """ success = True diff --git a/designsafe/apps/api/systems/views.py b/designsafe/apps/api/systems/views.py index 12bbbe9397..7597621115 100644 --- a/designsafe/apps/api/systems/views.py +++ b/designsafe/apps/api/systems/views.py @@ -7,7 +7,7 @@ import json from django.http import JsonResponse from designsafe.apps.api.views import AuthenticatedApiView -from designsafe.utils.system_access import create_system_credentials +from designsafe.apps.onboarding.steps.system_access_v3 import create_system_credentials from designsafe.utils.encryption import createKeyPair from .utils import add_pub_key_to_resource diff --git a/designsafe/apps/workspace/api/tas_to_tacc_resources.json b/designsafe/apps/api/users/tas_to_tacc_resources.json similarity index 94% rename from designsafe/apps/workspace/api/tas_to_tacc_resources.json rename to designsafe/apps/api/users/tas_to_tacc_resources.json index 5671063e38..9f610ede0c 100644 --- a/designsafe/apps/workspace/api/tas_to_tacc_resources.json +++ b/designsafe/apps/api/users/tas_to_tacc_resources.json @@ -73,5 +73,10 @@ "name": "Longhorn", "host": "longhorn.tacc.utexas.edu", "type": "HPC" + }, + "Vista": { + "name": "Vista", + "host": "vista.tacc.utexas.edu", + "type": "HPC" } -} \ No newline at end of file +} diff --git a/designsafe/apps/workspace/api/tasks.py b/designsafe/apps/api/users/tasks.py similarity index 73% rename from designsafe/apps/workspace/api/tasks.py rename to designsafe/apps/api/users/tasks.py index e458d17972..415c8bb61e 100644 --- a/designsafe/apps/workspace/api/tasks.py +++ b/designsafe/apps/api/users/tasks.py @@ -1,9 +1,7 @@ -""" -Workspace tasks -""" +""" Celery tasks for users api """ from celery import shared_task -from .views import _get_latest_allocations +from .utils import _get_latest_allocations @shared_task(bind=True, max_retries=3, queue="indexing") diff --git a/designsafe/apps/api/users/utils.py b/designsafe/apps/api/users/utils.py index bd51e92e52..3d93baa099 100644 --- a/designsafe/apps/api/users/utils.py +++ b/designsafe/apps/api/users/utils.py @@ -1,6 +1,13 @@ +"""Utility functions for user API""" + import logging +import json from pytas.http import TASClient +from django.conf import settings from django.db.models import Q +from django.core.exceptions import ObjectDoesNotExist +from django.contrib.auth import get_user_model +from designsafe.apps.workspace.models.allocations import UserAllocations logger = logging.getLogger(__name__) @@ -42,5 +49,87 @@ def q_to_model_queries(q): query = Q(email__icontains=q) query |= Q(first_name__icontains=q) query |= Q(last_name__icontains=q) + query |= Q(username__icontains=q) return query + + +def _get_tas_allocations(username): + """Returns user allocations on TACC resources + + : returns: allocations + : rtype: dict + """ + + tas_client = TASClient( + baseURL=settings.TAS_URL, + credentials={ + "username": settings.TAS_CLIENT_KEY, + "password": settings.TAS_CLIENT_SECRET, + }, + ) + tas_projects = tas_client.projects_for_user(username) + + with open( + "designsafe/apps/api/users/tas_to_tacc_resources.json", encoding="utf-8" + ) as file: + tas_to_tacc_resources = json.load(file) + + hosts = {} + + for tas_proj in tas_projects: + # Each project from tas has an array of length 1 for its allocations + alloc = tas_proj["allocations"][0] + charge_code = tas_proj["chargeCode"] + if alloc["resource"] in tas_to_tacc_resources: + resource = dict(tas_to_tacc_resources[alloc["resource"]]) + resource["allocation"] = dict(alloc) + + # Separate active and inactive allocations and make single entry for each project + if resource["allocation"]["status"] == "Active": + if ( + resource["host"] in hosts + and charge_code not in hosts[resource["host"]] + ): + hosts[resource["host"]].append(charge_code) + elif resource["host"] not in hosts: + hosts[resource["host"]] = [charge_code] + return { + "hosts": hosts, + } + + +def _get_latest_allocations(username): + """ + Creates or updates allocations cache for a given user and returns new allocations + """ + user = get_user_model().objects.get(username=username) + allocations = _get_tas_allocations(username) + UserAllocations.objects.update_or_create(user=user, defaults={"value": allocations}) + return allocations + + +def get_allocations(user, force=False): + """ + Returns indexed allocation data stored in Django DB, or fetches + allocations from TAS and stores them. + Parameters + ---------- + user: User object + TACC username to fetch allocations for. + force: bool + Returns + ------- + dict + """ + username = user.username + try: + if force: + logger.info(f"Forcing TAS allocation retrieval for user:{username}") + raise ObjectDoesNotExist + result = {"hosts": {}} + result.update(UserAllocations.objects.get(user=user).value) + return result + except ObjectDoesNotExist: + # Fall back to getting allocations from TAS + return _get_latest_allocations(username) diff --git a/designsafe/apps/api/users/views.py b/designsafe/apps/api/users/views.py index 0ffa7a833c..39a0a646f5 100644 --- a/designsafe/apps/api/users/views.py +++ b/designsafe/apps/api/users/views.py @@ -4,23 +4,32 @@ from designsafe.apps.api.users import utils as users_utils from django.contrib.auth import get_user_model from django.forms.models import model_to_dict -from django.http import HttpResponseNotFound, JsonResponse, HttpResponse, HttpRequest +from django.http import HttpResponseNotFound, JsonResponse, HttpRequest from django.views.generic.base import View from django.core.exceptions import ObjectDoesNotExist from pytas.http import TASClient from designsafe.apps.api.views import BaseApiView, ApiException from designsafe.apps.data.models.elasticsearch import IndexedFile, IndexedPublication from designsafe.libs.elasticsearch.utils import new_es_client -from elasticsearch_dsl import Q, Search +from elasticsearch_dsl import Q logger = logging.getLogger(__name__) + def check_public_availability(username): es_client = new_es_client() - query = Q({'multi_match': {'fields': ['project.value.teamMembers', - 'project.value.coPis', - 'project.value.pi'], - 'query': username}}) + query = Q( + { + "multi_match": { + "fields": [ + "project.value.teamMembers", + "project.value.coPis", + "project.value.pi", + ], + "query": username, + } + } + ) res = IndexedPublication.search(using=es_client).filter(query).execute() return res.hits.total.value > 0 @@ -29,15 +38,21 @@ class UsageView(SecureMixin, View): def get(self, request): current_user = request.user - q = IndexedFile.search()\ - .query('bool', must=[Q("prefix", **{"path._exact": '/' + current_user.username})])\ - .extra(size=0) - q.aggs.metric('total_storage_bytes', 'sum', field="length") + q = ( + IndexedFile.search() + .query( + "bool", + must=[Q("prefix", **{"path._exact": "/" + current_user.username})], + ) + .extra(size=0) + ) + q.aggs.metric("total_storage_bytes", "sum", field="length") result = q.execute() agg = result.to_dict()["aggregations"] out = {"total_storage_bytes": agg["total_storage_bytes"]["value"]} return JsonResponse(out) + class AuthenticatedView(View): def get(self, request): @@ -56,15 +71,15 @@ def get(self, request): } return JsonResponse(out) - return JsonResponse({'message': 'Unauthorized'}, status=401) + return JsonResponse({"message": "Unauthorized"}, status=401) class SearchView(View): def get(self, request): - resp_fields = ['first_name', 'last_name', 'email', 'username'] + resp_fields = ["first_name", "last_name", "email", "username"] model = get_user_model() - q = request.GET.get('username') + q = request.GET.get("username") # Do not return user details if the user is not part of a public project. if not request.user.is_authenticated and not check_public_availability(q): @@ -73,23 +88,21 @@ def get(self, request): if q: try: user = model.objects.get(username=q) - except ObjectDoesNotExist as err: + except ObjectDoesNotExist: return HttpResponseNotFound() res_dict = { - 'first_name': user.first_name, - 'last_name': user.last_name, - 'email': user.email, - 'username': user.username, + "first_name": user.first_name, + "last_name": user.last_name, + "email": user.email, + "username": user.username, } - if(user.profile.orcid_id): - res_dict['orcid_id'] = user.profile.orcid_id + if user.profile.orcid_id: + res_dict["orcid_id"] = user.profile.orcid_id try: user_tas = TASClient().get_user(username=q) - res_dict['profile'] = { - 'institution': user_tas['institution'] - } - except Exception as err: - logger.info('No Profile.') + res_dict["profile"] = {"institution": user_tas["institution"]} + except Exception: + logger.info("No Profile.") return JsonResponse(res_dict) @@ -97,8 +110,8 @@ def get(self, request): if not request.user.is_authenticated: return JsonResponse({}) - q = request.GET.get('q') - role = request.GET.get('role') + q = request.GET.get("q") + role = request.GET.get("role") user_rs = model.objects.filter() if q: query = users_utils.q_to_model_queries(q) @@ -123,6 +136,7 @@ def get(self, request): class ProjectUserView(BaseApiView): """View for handling search for project users""" + def get(self, request: HttpRequest): """retrieve a user by their exact TACC username.""" if not request.user.is_authenticated: @@ -130,21 +144,25 @@ def get(self, request: HttpRequest): username_query = request.GET.get("q") user_match = get_user_model().objects.filter(username__iexact=username_query) - user_resp = [{"fname": u.first_name, - "lname": u.last_name, - "inst": u.profile.institution, - "email": u.email, - "username": u.username} for u in user_match] + user_resp = [ + { + "fname": u.first_name, + "lname": u.last_name, + "inst": u.profile.institution, + "email": u.email, + "username": u.username, + } + for u in user_match + ] return JsonResponse({"result": user_resp}) - class PublicView(View): def get(self, request): model = get_user_model() - nl = json.loads(request.GET.get('usernames')) + nl = json.loads(request.GET.get("usernames")) res_list = [] @@ -152,7 +170,9 @@ def get(self, request): users = [] for username in nl: # Do not return user details if the user is not part of a public project. - if not request.user.is_authenticated and not check_public_availability(username): + if not request.user.is_authenticated and not check_public_availability( + username + ): continue try: users.append(model.objects.get(username=username)) @@ -161,13 +181,13 @@ def get(self, request): for user in users: data = { - 'fname': user.first_name, - 'lname': user.last_name, - 'username': user.username, - 'email': user.email, + "fname": user.first_name, + "lname": user.last_name, + "username": user.username, + "email": user.email, } res_list.append(data) - except ObjectDoesNotExist as err: + except ObjectDoesNotExist: return HttpResponseNotFound() res_dict = {"userData": res_list} diff --git a/designsafe/apps/auth/backends_unit_test.py b/designsafe/apps/auth/backends_unit_test.py index f02d3e4680..7a22b6d267 100644 --- a/designsafe/apps/auth/backends_unit_test.py +++ b/designsafe/apps/auth/backends_unit_test.py @@ -1,9 +1,10 @@ import pytest from django.contrib.auth import get_user_model from mock import Mock -from designsafe.apps.auth.backends import TapisOAuthBackend from tapipy.tapis import TapisResult from tapipy.errors import BaseTapyException +from designsafe.apps.auth.backends import TapisOAuthBackend +from designsafe.apps.auth.views import launch_setup_checks pytestmark = pytest.mark.django_db @@ -38,12 +39,11 @@ def update_institution_from_tas_mock(mocker): yield mocker.patch("designsafe.apps.auth.backends.update_institution_from_tas") -# def test_launch_setup_checks(mocker, regular_user, settings): -# mocker.patch("designsafe.apps.auth.views.new_user_setup_check") -# mock_execute = mocker.patch("designsafe.apps.auth.views.execute_setup_steps") -# regular_user.profile.setup_complete = False -# launch_setup_checks(regular_user) -# mock_execute.apply_async.assert_called_with(args=["username"]) +def test_launch_setup_checks(mocker, regular_user, settings): + mocker.patch("designsafe.apps.auth.views.new_user_setup_check") + mock_execute = mocker.patch("designsafe.apps.auth.views.execute_setup_steps") + launch_setup_checks(regular_user) + mock_execute.apply_async.assert_called_with(args=["username"]) def test_bad_backend_params(tapis_mock): diff --git a/designsafe/apps/auth/tasks.py b/designsafe/apps/auth/tasks.py index 26eb935be3..af3c504e26 100644 --- a/designsafe/apps/auth/tasks.py +++ b/designsafe/apps/auth/tasks.py @@ -1,106 +1,38 @@ +""" Celery tasks for user onboarding and other user-related tasks. """ + +import logging from datetime import datetime, timedelta -import requests from django.conf import settings from django.contrib.auth import get_user_model -from django.core.exceptions import ObjectDoesNotExist from django.core.mail import send_mail -from designsafe.apps.api.agave import get_service_account_client, get_tg458981_client -from designsafe.apps.api.tasks import agave_indexer -from designsafe.apps.api.notifications.models import Notification from celery import shared_task -from django.contrib.auth import get_user_model from pytas.http import TASClient -from tapipy.errors import NotFoundError, BaseTapyException -from designsafe.utils.system_access import register_public_key, create_system_credentials -from designsafe.utils.encryption import createKeyPair -from django.contrib.auth import get_user_model -import logging - - +from designsafe.apps.api.notifications.models import Notification logger = logging.getLogger(__name__) -def get_systems_to_configure(username): - """ Get systems to configure either during startup or for new user """ - - systems = [] - for system in settings.TAPIS_SYSTEMS_TO_CONFIGURE: - system_copy = system.copy() - system_copy['path'] = system_copy['path'].format(username=username) - systems.append(system_copy) - return systems - - -@shared_task(default_retry_delay=30, max_retries=3, queue='onboarding', bind=True) -def check_or_configure_system_and_user_directory(self, username, system_id, path, create_path): - try: - user_client = get_user_model().objects.get(username=username).tapis_oauth.client - user_client.files.listFiles( - systemId=system_id, path=path - ) - logger.info(f"System Works: " - f"Checked and there is no need to configure system:{system_id} path:{path} for {username}") - return - except ObjectDoesNotExist: - # User is missing; handling email confirmation process where user has not logged in - logger.info(f"New User: " - f"Checked and there is a need to configure system:{system_id} path:{path} for {username} ") - except BaseTapyException as e: - logger.info(f"Unable to list system/files: " - f"Checked and there is a need to configure system:{system_id} path:{path} for {username}: {e}") - - try: - if create_path: - tg458981_client = get_tg458981_client() - try: - # User tg account to check if path exists - tg458981_client.files.listFiles(systemId=system_id, path=path) - logger.info(f"Directory for user={username} on system={system_id}/{path} exists and works. ") - except NotFoundError: - logger.info("Creating the directory for user=%s then going to run setfacl on system=%s path=%s", - username, - system_id, - path) - - tg458981_client.files.mkdir(systemId=system_id, path=path) - tg458981_client.files.setFacl( - systemId=system_id, - path=path, - operation="ADD", - recursionMethod="PHYSICAL", - aclString=f"d:u:{username}:rwX,u:{username}:rwX,d:u:tg458981:rwX,u:tg458981:rwX,d:o::---,o::---,d:m::rwX,m::rwX", - ) - agave_indexer.apply_async( - kwargs={"systemId": system_id, "filePath": path, "recurse": False}, - queue="indexing", - ) - - # create keys, push to key service and use as credential for Tapis system - logger.info("Creating credentials for user=%s on system=%s", username, system_id) - (private_key, public_key) = createKeyPair() - register_public_key(username, public_key, system_id) - service_account = get_service_account_client() - create_system_credentials(service_account, - username, - public_key, - private_key, - system_id) - except BaseTapyException as exc: - logger.exception('Failed to configure system (i.e. create directory, set acl, create credentials).', - extra={'user': username, - 'systemId': system_id, - 'path': path}) - raise self.retry(exc=exc) - - @shared_task(default_retry_delay=30, max_retries=3) def new_user_alert(username): user = get_user_model().objects.get(username=username) - send_mail('New User in DesignSafe, need Slack', 'Username: ' + user.username + '\n' + - 'Email: ' + user.email + '\n' + - 'Name: ' + user.first_name + ' ' + user.last_name + '\n' + - 'Id: ' + str(user.id) + '\n', - settings.DEFAULT_FROM_EMAIL, settings.NEW_ACCOUNT_ALERT_EMAILS.split(','),) + send_mail( + "New User in DesignSafe, need Slack", + "Username: " + + user.username + + "\n" + + "Email: " + + user.email + + "\n" + + "Name: " + + user.first_name + + " " + + user.last_name + + "\n" + + "Id: " + + str(user.id) + + "\n", + settings.DEFAULT_FROM_EMAIL, + settings.NEW_ACCOUNT_ALERT_EMAILS.split(","), + ) # Auto-add user to TRAM allocation # tram_headers = {"tram-services-key": settings.TRAM_SERVICES_KEY} @@ -127,5 +59,5 @@ def update_institution_from_tas(self, username): tas_model = TASClient().get_user(username=username) except Exception as exc: raise self.retry(exc=exc) - user_model.profile.institution = tas_model.get('institution', None) + user_model.profile.institution = tas_model.get("institution", None) user_model.profile.save() diff --git a/designsafe/apps/auth/test_tasks.py b/designsafe/apps/auth/test_tasks.py new file mode 100644 index 0000000000..1eb3fb8e9d --- /dev/null +++ b/designsafe/apps/auth/test_tasks.py @@ -0,0 +1,54 @@ +import pytest +from unittest import mock + + +@pytest.fixture +def mock_get_user_model(authenticated_user): + with mock.patch("designsafe.apps.auth.tasks.get_user_model") as mock_get_user_model: + mock_get_user_model().objects.get.return_value = authenticated_user + yield mock_get_user_model + + +@pytest.fixture +def mock_get_tg458981_client(): + with mock.patch( + "designsafe.apps.auth.tasks.get_tg458981_client" + ) as mock_get_tg458981_client: + yield mock_get_tg458981_client + + +@pytest.fixture +def mock_get_service_account_client(): + with mock.patch( + "designsafe.apps.auth.tasks.get_service_account_client" + ) as mock_get_service_account_client: + yield mock_get_service_account_client + + +@pytest.fixture +def mock_createKeyPair(): + with mock.patch("designsafe.apps.auth.tasks.createKeyPair") as mock_createKeyPair: + mock_createKeyPair.return_value = ("private_key", "public_key") + yield mock_createKeyPair + + +@pytest.fixture +def mock_register_public_key(): + with mock.patch( + "designsafe.apps.auth.tasks.register_public_key" + ) as mock_register_public_key: + yield mock_register_public_key + + +@pytest.fixture +def mock_create_system_credentials(): + with mock.patch( + "designsafe.apps.auth.tasks.create_system_credentials" + ) as mock_create_system_credentials: + yield mock_create_system_credentials + + +@pytest.fixture +def mock_agave_indexer(): + with mock.patch("designsafe.apps.auth.tasks.agave_indexer") as mock_agave_indexer: + yield mock_agave_indexer diff --git a/designsafe/apps/auth/urls.py b/designsafe/apps/auth/urls.py index aa75734711..fc956002c4 100644 --- a/designsafe/apps/auth/urls.py +++ b/designsafe/apps/auth/urls.py @@ -1,5 +1,5 @@ """ -.. module:: portal.apps.auth.urls +.. module:: designsafe.apps.auth.urls :synopsis: Auth URLs """ @@ -8,7 +8,7 @@ app_name = "designsafe_auth" urlpatterns = [ - path('', views.tapis_oauth, name="login"), + path("", views.tapis_oauth, name="login"), path("logged-out/", views.logged_out, name="logout"), path("tapis/", views.tapis_oauth, name="tapis_oauth"), path("tapis/callback/", views.tapis_oauth_callback, name="tapis_oauth_callback"), diff --git a/designsafe/apps/auth/views.py b/designsafe/apps/auth/views.py index 31cd958ba2..50d70be207 100644 --- a/designsafe/apps/auth/views.py +++ b/designsafe/apps/auth/views.py @@ -12,12 +12,10 @@ from django.urls import reverse from django.http import HttpResponseRedirect, HttpResponseBadRequest from django.shortcuts import render -from designsafe.apps.auth.tasks import ( - check_or_configure_system_and_user_directory, - get_systems_to_configure, -) -from designsafe.apps.workspace.api.tasks import cache_allocations +from designsafe.apps.api.users.tasks import cache_allocations +from designsafe.apps.api.utils import get_client_ip from designsafe.apps.auth.tasks import new_user_alert +from designsafe.apps.onboarding.execute import execute_setup_steps, new_user_setup_check from .models import TapisOAuthToken logger = logging.getLogger(__name__) @@ -71,19 +69,20 @@ def tapis_oauth(request): def launch_setup_checks(user): """Perform any onboarding checks or non-onboarding steps that may spawn celery tasks""" - logger.info("Starting tasks to check or configure systems for %s", user.username) - for system in get_systems_to_configure(user.username): - check_or_configure_system_and_user_directory.apply_async( - args=( - user.username, - system["system_id"], - system["path"], - system["create_path"], - ), - queue="files", + + # Check onboarding settings + new_user_setup_check(user) + if not user.profile.setup_complete: + logger.info("Executing onboarding setup steps for %s", user.username) + execute_setup_steps.apply_async(args=[user.username]) + return HttpResponseRedirect(reverse("designsafe_onboarding:user")) + else: + logger.info( + "Already onboarded, running non-onboarding steps (e.g. update cached " + "allocation information) for %s", + user.username, ) - logger.info("Creating/updating cached allocation information for %s", user.username) - cache_allocations.apply_async(args=(user.username,)) + cache_allocations.apply_async(args=(user.username,)) def tapis_oauth_callback(request): @@ -132,12 +131,26 @@ def tapis_oauth_callback(request): user = authenticate(backend="tapis", token=token_data["access_token"]) if user: - _, created = TapisOAuthToken.objects.update_or_create(user=user, defaults={**token_data}) + _, created = TapisOAuthToken.objects.update_or_create( + user=user, defaults={**token_data} + ) if created: new_user_alert.apply_async(args=(user.username,)) login(request, user) launch_setup_checks(user) + + METRICS.info( + "Auth", + extra={ + "user": user.username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": "LOGIN", + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": {}, + }, + ) else: messages.error( request, diff --git a/designsafe/apps/auth/views_unit_test.py b/designsafe/apps/auth/views_unit_test.py index fbbc149d07..ce62a2f397 100644 --- a/designsafe/apps/auth/views_unit_test.py +++ b/designsafe/apps/auth/views_unit_test.py @@ -3,9 +3,8 @@ import pytest from django.conf import settings from django.urls import reverse +from designsafe.apps.auth.views import launch_setup_checks -# TODOV3: Onboarding Tests https://tacc-main.atlassian.net/browse/DES-2822 -# from portal.apps.auth.views import launch_setup_checks TEST_STATE = "ABCDEFG123456" @@ -75,20 +74,29 @@ def test_tapis_callback_mismatched_state(client): assert response.status_code == 400 -# TODOV3: Onboarding Tests https://tacc-main.atlassian.net/browse/DES-2822 -# def test_launch_setup_checks(regular_user, mocker): -# mock_execute_setup_steps = mocker.patch( -# "portal.apps.auth.views.execute_setup_steps" -# ) -# launch_setup_checks(regular_user) -# mock_execute_setup_steps.apply_async.assert_called_with( -# args=[regular_user.username] -# ) +def test_launch_setup_checks(regular_user, mocker): + mock_execute_setup_steps = mocker.patch( + "designsafe.apps.auth.views.execute_setup_steps" + ) + mock_new_user_setup_check = mocker.patch( + "designsafe.apps.auth.views.new_user_setup_check" + ) + launch_setup_checks(regular_user) + mock_new_user_setup_check.assert_called_with(regular_user) + mock_execute_setup_steps.apply_async.assert_called_with( + args=[regular_user.username] + ) -# TODOV3: Onboarding Tests https://tacc-main.atlassian.net/browse/DES-2822 -# def test_launch_setup_checks_already_onboarded(regular_user, mocker): -# regular_user.profile.setup_complete = True -# mock_index_allocations = mocker.patch("portal.apps.auth.views.index_allocations") -# launch_setup_checks(regular_user) -# mock_index_allocations.apply_async.assert_called_with(args=[regular_user.username]) +def test_launch_setup_checks_already_onboarded(regular_user, mocker): + regular_user.profile.setup_complete = True + mocker.patch("designsafe.apps.auth.views.new_user_setup_check") + mock_execute_setup_steps = mocker.patch( + "designsafe.apps.auth.views.execute_setup_steps" + ) + mock_cache_allocations = mocker.patch( + "designsafe.apps.auth.views.cache_allocations" + ) + launch_setup_checks(regular_user) + mock_cache_allocations.apply_async.assert_called_with(args=(regular_user.username,)) + mock_execute_setup_steps.apply_async.assert_not_called() diff --git a/designsafe/apps/box_integration/tests/test_views.py b/designsafe/apps/box_integration/tests/test_views.py index eac35a7de6..eb9396659c 100644 --- a/designsafe/apps/box_integration/tests/test_views.py +++ b/designsafe/apps/box_integration/tests/test_views.py @@ -1,12 +1,13 @@ from django.test import TestCase -from django.contrib.auth import get_user_model, signals +from django.contrib.auth import get_user_model from django.urls import reverse +from unittest import skip from boxsdk.object.user import User from designsafe.apps.box_integration.models import BoxUserToken -from designsafe.apps.auth.signals import on_user_logged_in import mock +@skip('This test is not working') class BoxInitializationTestCase(TestCase): fixtures = ['user-data.json'] @@ -16,9 +17,6 @@ def setUp(self): user.set_password('password') user.save() - # disconnect user_logged_in signal - signals.user_logged_in.disconnect(on_user_logged_in) - def test_index_view_not_enabled(self): """ Should render as not enabled @@ -84,6 +82,7 @@ def test_oauth2_callback(self, m_box_oauth_authenticate, m_user_get): 'Box.com as DS User (ds_user@designsafe-ci.org)') +@skip('This test is not working') class BoxDisconnectTestCase(TestCase): fixtures = ['user-data.json', 'box-user-token.json'] @@ -93,9 +92,6 @@ def setUp(self): user.set_password('password') user.save() - # disconnect user_logged_in signal - signals.user_logged_in.disconnect(on_user_logged_in) - def test_disconnect(self): """ Test disconnecting Box.com. diff --git a/designsafe/apps/djangoRT/fixtures/ticket_detail.txt b/designsafe/apps/djangoRT/fixtures/ticket_detail.txt index 798c1605d2..5d4abe26bd 100644 --- a/designsafe/apps/djangoRT/fixtures/ticket_detail.txt +++ b/designsafe/apps/djangoRT/fixtures/ticket_detail.txt @@ -22,5 +22,4 @@ LastUpdated: Sun Feb 28 01:01:24 2016 TimeEstimated: 0 TimeWorked: 0 TimeLeft: 0 -CF.{Resource}: - +CF.{Resource}: diff --git a/designsafe/apps/djangoRT/fixtures/users.json b/designsafe/apps/djangoRT/fixtures/users.json deleted file mode 100644 index fc280b2a03..0000000000 --- a/designsafe/apps/djangoRT/fixtures/users.json +++ /dev/null @@ -1,38 +0,0 @@ -[ - { - "fields": { - "username": "ds_admin", - "first_name": "DesignSafe", - "last_name": "Admin", - "is_active": true, - "is_superuser": true, - "is_staff": true, - "last_login": "2016-03-01T00:00:00.000Z", - "groups": [], - "user_permissions": [], - "password": "", - "email": "admin@designsafe-ci.org", - "date_joined": "2016-03-01T00:00:00.000Z" - }, - "model": "auth.user", - "pk": 1 - }, - { - "fields": { - "username": "ds_user", - "first_name": "DesignSafe", - "last_name": "User", - "is_active": true, - "is_superuser": false, - "is_staff": false, - "last_login": "2016-03-01T00:00:00.000Z", - "groups": [], - "user_permissions": [], - "password": "", - "email": "user@designsafe-ci.org", - "date_joined": "2016-03-01T00:00:00.000Z" - }, - "model": "auth.user", - "pk": 2 - } -] diff --git a/designsafe/apps/djangoRT/forms.py b/designsafe/apps/djangoRT/forms.py index a3f468a805..51b5e0aee3 100755 --- a/designsafe/apps/djangoRT/forms.py +++ b/designsafe/apps/djangoRT/forms.py @@ -34,7 +34,6 @@ class BaseTicketForm(forms.Form): """ first_name = forms.CharField(widget=forms.TextInput(), max_length=255, required=True) last_name = forms.CharField(widget=forms.TextInput(), max_length=255, required=True) - email = forms.EmailField(widget=forms.EmailInput(), required=True) subject = forms.CharField(widget=forms.TextInput(), max_length=255, required=True) category_choices = (('', 'Choose one'),) + settings.TICKET_CATEGORIES diff --git a/designsafe/apps/djangoRT/tests.py b/designsafe/apps/djangoRT/tests.py index 000162171b..1cc247e61a 100755 --- a/designsafe/apps/djangoRT/tests.py +++ b/designsafe/apps/djangoRT/tests.py @@ -1,222 +1,100 @@ -from django.test import TestCase +import pytest from django.urls import reverse -from django.contrib.auth import get_user_model, signals -from unittest import skip -import mock -import requests_mock -@skip("anonymous tickets disabled due to spam.") -class AnonymousViewTests(TestCase): +@pytest.mark.django_db +def test_index(client, authenticated_user): """ - Almost all views by anonymous trigger a redirect. However, anonymous CAN create - tickets. The create ticket view for anonymous includes a Captcha field, so ensure - that form subclass is activated. + For authenticated users, the default/index view redirects to the mytickets view. """ + resp = client.get(reverse("djangoRT:index")) + assert resp.status_code == 302 + assert resp.url == reverse("djangoRT:mytickets") - def test_index(self): - """ - For anonymous users, the default/index view redirects to the ticketcreate view. - :return: - """ - resp = self.client.get(reverse('djangoRT:index')) - self.assertRedirects(resp, reverse('djangoRT:ticketcreate')) - def test_my_tickets(self): - requested_url = reverse('djangoRT:mytickets') - resp = self.client.get(requested_url) - expected_redirect = reverse('login') + '?next=' + requested_url - self.assertRedirects(resp, expected_redirect, target_status_code=302) +@pytest.mark.django_db +def test_mytickets_none(client, authenticated_user, requests_mock): + requests_mock.post("/REST/1.0/", text="RT/4.2.1 200 Ok") + with open("designsafe/apps/djangoRT/fixtures/user_tickets_resp.txt") as f: + requests_mock.get("/REST/1.0/search/ticket?format=l", text=f.read()) - def test_detail(self): - requested_url = reverse('djangoRT:ticketdetail', args=[999]) - resp = self.client.get(requested_url) - expected_redirect = reverse('login') + '?next=' + requested_url - self.assertRedirects(resp, expected_redirect, target_status_code=302) + resp = client.get(reverse("djangoRT:mytickets")) + assert "No tickets to display!" in resp.content.decode() - def test_create(self): - resp = self.client.get(reverse('djangoRT:ticketcreate')) - self.assertEqual(resp.status_code, 200) - def test_create_with_error_context(self): - query = 'error_page=/page/that/failed&http_referer=https://www.google.com' - resp = self.client.get(reverse('djangoRT:ticketcreate') + '?' + query) +@pytest.mark.django_db +def test_mytickets_resolved(client, authenticated_user, requests_mock): + requests_mock.post("/REST/1.0/", text="RT/4.2.1 200 Ok") + with open("designsafe/apps/djangoRT/fixtures/user_tickets_resolved_resp.txt") as f: + requests_mock.get("/REST/1.0/search/ticket?format=l", text=f.read()) - self.assertContains(resp, '', html=True) - self.assertContains(resp, '', html=True) + resp = client.get(reverse("djangoRT:mytickets") + "?show_resolved=1") + assert "No tickets to display!" not in resp.content.decode() - def test_reply(self): - requested_url = reverse('djangoRT:ticketreply', args=[999]) - resp = self.client.get(requested_url) - expected_redirect = reverse('login') + '?next=' + requested_url - self.assertRedirects(resp, expected_redirect, target_status_code=302) - def test_close(self): - requested_url = reverse('djangoRT:ticketclose', args=[999]) - resp = self.client.get(requested_url) - expected_redirect = reverse('login') + '?next=' + requested_url - self.assertRedirects(resp, expected_redirect, target_status_code=302) +@pytest.mark.django_db +def test_detail(client, authenticated_user, requests_mock): + requests_mock.post("/REST/1.0/", text="RT/4.2.1 200 Ok") + ticket_id = 29152 + with open("designsafe/apps/djangoRT/fixtures/ticket_detail.txt") as f: + requests_mock.get(f"/REST/1.0/ticket/{ticket_id}/show", text=f.read()) + with open("designsafe/apps/djangoRT/fixtures/ticket_history.txt") as f: + requests_mock.get(f"/REST/1.0/ticket/{ticket_id}/history", text=f.read()) - def test_attachment(self): - requested_url = reverse('djangoRT:ticketattachment', args=[999, 1001]) - resp = self.client.get(requested_url) - expected_redirect = reverse('login') + '?next=' + requested_url - self.assertRedirects(resp, expected_redirect, target_status_code=302) + resp = client.get(reverse("djangoRT:ticketdetail", args=[ticket_id])) + assert "Test Post, Please Ignore" in resp.content.decode() -class AuthenticatedViewTests(TestCase): +@pytest.mark.django_db +def test_create(client, authenticated_user): + resp = client.get(reverse("djangoRT:ticketcreate")) + assert "Captcha" not in resp.content.decode() - fixtures = ['users.json'] - def setUp(self): - # set password for users - user = get_user_model().objects.get(pk=2) - user.set_password('password') - user.save() +@pytest.mark.django_db +def test_create_with_error_context(client, authenticated_user): + query = "error_page=/page/that/failed&http_referer=https://www.google.com" + resp = client.get(reverse("djangoRT:ticketcreate") + "?" + query) - # disconnect user_logged_in signal + assert "Captcha" not in resp.content.decode() + assert ( + '' + in resp.content.decode() + ) + assert ( + '' + in resp.content.decode() + ) - def test_index(self): - """ - For authenticated users, the default/index view redirects to the mytickets view. - :return: - """ - # log user in - self.client.login(username='ds_user', password='password') +@pytest.mark.django_db +def test_reply(client, authenticated_user, requests_mock): + requests_mock.post("/REST/1.0/", text="RT/4.2.1 200 Ok") + ticket_id = 29152 + with open("designsafe/apps/djangoRT/fixtures/ticket_detail.txt") as f: + requests_mock.get(f"/REST/1.0/ticket/{ticket_id}/show", text=f.read()) - resp = self.client.get(reverse('djangoRT:index')) - self.assertRedirects(resp, reverse('djangoRT:mytickets'), - fetch_redirect_response=False) + resp = client.get(reverse("djangoRT:ticketreply", args=[ticket_id])) + assert f"Reply to #{ticket_id}" in resp.content.decode() - @requests_mock.Mocker() - def test_mytickets_none(self, req_mock): - # log user in - self.client.login(username='ds_user', password='password') +@pytest.mark.django_db +def test_reopen(client, authenticated_user, requests_mock): + requests_mock.post("/REST/1.0/", text="RT/4.2.1 200 Ok") + ticket_id = 29152 + with open("designsafe/apps/djangoRT/fixtures/ticket_detail_resolved.txt") as f: + requests_mock.get(f"/REST/1.0/ticket/{ticket_id}/show", text=f.read()) - # mock login - req_mock.post('/REST/1.0/', text='RT/4.2.1 200 Ok') + resp = client.get(reverse("djangoRT:ticketreply", args=[ticket_id])) + assert f"Reopen #{ticket_id}" in resp.content.decode() - # mock ticket query - with open('designsafe/apps/djangoRT/fixtures/user_tickets_resp.txt') as f: - req_mock.get('/REST/1.0/search/ticket?format=l', text=f.read()) - resp = self.client.get(reverse('djangoRT:mytickets')) - self.assertContains(resp, 'No tickets to display!') +@pytest.mark.django_db +def test_close(client, authenticated_user, requests_mock): + requests_mock.post("/REST/1.0/", text="RT/4.2.1 200 Ok") + ticket_id = 29152 + with open("designsafe/apps/djangoRT/fixtures/ticket_detail.txt") as f: + requests_mock.get(f"/REST/1.0/ticket/{ticket_id}/show", text=f.read()) - @requests_mock.Mocker() - def test_mytickets_resolved(self, req_mock): - - # log user in - self.client.login(username='ds_user', password='password') - - # mock login - req_mock.post('/REST/1.0/', text='RT/4.2.1 200 Ok') - - # mock ticket query - with open('designsafe/apps/djangoRT/fixtures/user_tickets_resolved_resp.txt') as f: - req_mock.get('/REST/1.0/search/ticket?format=l', text=f.read()) - - resp = self.client.get(reverse('djangoRT:mytickets') + '?show_resolved=1') - self.assertNotContains(resp, 'No tickets to display!') - - @requests_mock.Mocker() - def test_detail(self, req_mock): - # log user in - self.client.login(username='ds_user', password='password') - - # mock login - req_mock.post('/REST/1.0/', text='RT/4.2.1 200 Ok') - - ticket_id = 29152 - - # mock ticket request - with open('designsafe/apps/djangoRT/fixtures/ticket_detail.txt') as f: - req_mock.get('/REST/1.0/ticket/{}/show'.format(ticket_id), text=f.read()) - - # mock ticket history - with open('designsafe/apps/djangoRT/fixtures/ticket_history.txt') as f: - req_mock.get('/REST/1.0/ticket/{}/history'.format(ticket_id), text=f.read()) - - resp = self.client.get(reverse('djangoRT:ticketdetail', args=[ticket_id])) - self.assertContains(resp, 'Test Post, Please Ignore') - - def test_create(self): - # log user in - self.client.login(username='ds_user', password='password') - - resp = self.client.get(reverse('djangoRT:ticketcreate')) - self.assertNotContains(resp, 'Captcha') - - def test_create_with_error_context(self): - # log user in - self.client.login(username='ds_user', password='password') - - query = 'error_page=/page/that/failed&http_referer=https://www.google.com' - resp = self.client.get(reverse('djangoRT:ticketcreate') + '?' + query) - - self.assertNotContains(resp, 'Captcha') - self.assertContains(resp, '', html=True) - self.assertContains(resp, '', html=True) - - @requests_mock.Mocker() - def test_reply(self, req_mock): - # log user in - self.client.login(username='ds_user', password='password') - - # mock login - req_mock.post('/REST/1.0/', text='RT/4.2.1 200 Ok') - - ticket_id = 29152 - - # mock ticket request - with open('designsafe/apps/djangoRT/fixtures/ticket_detail.txt') as f: - req_mock.get('/REST/1.0/ticket/{}/show'.format(ticket_id), text=f.read()) - - resp = self.client.get(reverse('djangoRT:ticketreply', args=[ticket_id])) - self.assertContains(resp, 'Reply to #{}'.format(ticket_id)) - - @requests_mock.Mocker() - def test_reopen(self, req_mock): - # log user in - self.client.login(username='ds_user', password='password') - - # mock login - req_mock.post('/REST/1.0/', text='RT/4.2.1 200 Ok') - - ticket_id = 29152 - - # mock ticket request - with open('designsafe/apps/djangoRT/fixtures/ticket_detail_resolved.txt') as f: - req_mock.get('/REST/1.0/ticket/{}/show'.format(ticket_id), text=f.read()) - - resp = self.client.get(reverse('djangoRT:ticketreply', args=[ticket_id])) - self.assertContains(resp, 'Reopen #{}'.format(ticket_id)) - - @requests_mock.Mocker() - def test_close(self, req_mock): - # log user in - self.client.login(username='ds_user', password='password') - - # mock login - req_mock.post('/REST/1.0/', text='RT/4.2.1 200 Ok') - - ticket_id = 29152 - - # mock ticket request - with open('designsafe/apps/djangoRT/fixtures/ticket_detail.txt') as f: - req_mock.get('/REST/1.0/ticket/{}/show'.format(ticket_id), text=f.read()) - - resp = self.client.get(reverse('djangoRT:ticketclose', args=[ticket_id])) - self.assertContains(resp, 'Close #{}'.format(ticket_id)) - - - @skip("TODO implement attachment test - @mrhanlon; 2016-08-10") - def test_attachment(self): - # TODO - pass + resp = client.get(reverse("djangoRT:ticketclose", args=[ticket_id])) + assert f"Close #{ticket_id}" in resp.content.decode() diff --git a/designsafe/apps/djangoRT/views.py b/designsafe/apps/djangoRT/views.py index 9ecbe785c7..a26d252f1b 100755 --- a/designsafe/apps/djangoRT/views.py +++ b/designsafe/apps/djangoRT/views.py @@ -5,6 +5,7 @@ from designsafe.apps.djangoRT import rtUtil, forms, rtModels from django.contrib.auth.decorators import login_required from django.contrib import messages +from django.core.files.base import ContentFile from django.conf import settings from designsafe.apps.api.exceptions import ApiException from designsafe.apps.api.views import BaseApiView @@ -73,7 +74,8 @@ def ticketcreate(request): requestor_meta = '%s %s <%s>' % ( form.cleaned_data['first_name'], form.cleaned_data['last_name'], - form.cleaned_data['email']) + request.user.email + ) meta = ( ('Opened by', request.user), @@ -95,7 +97,7 @@ def ticketcreate(request): ticket = rtModels.Ticket(subject=form.cleaned_data['subject'], problem_description="\n ".join(ticket_body.splitlines()), - requestor=form.cleaned_data['email'], + requestor=request.user.email, cc=form.cleaned_data.get('cc', '')) logger.debug('Creating ticket for user: %s' % form.cleaned_data) @@ -105,12 +107,12 @@ def ticketcreate(request): if ticket_id > -1: messages.success(request, 'Your ticket has been submitted.') if 'attachment' in request.FILES: + f = request.FILES['attachment'] rt.replyToTicket( ticket_id, - files=([request.FILES['attachment'].name, - request.FILES['attachment'], - mimetypes.guess_type(request.FILES['attachment'].name)], - )) + files=[(f.name, + ContentFile(f.read()), f.content_type) + ]) if request.user.is_authenticated: return HttpResponseRedirect(reverse('djangoRT:ticketdetail', @@ -163,8 +165,8 @@ def ticketreply(request, ticketId): ( request.FILES['attachment'].name, request.FILES['attachment'], - mimetypes.guess_type(request.FILES['attachment'].name), - )) + request.FILES['attachment'].content_type), + ) if rt.replyToTicket(ticketId, text=reply_text, files=attachments): return HttpResponseRedirect(reverse('djangoRT:ticketdetail', args=[ticketId])) diff --git a/designsafe/apps/nco/managers/ttc_grants.py b/designsafe/apps/nco/managers/ttc_grants.py index f36b0f1948..2f0e30e004 100644 --- a/designsafe/apps/nco/managers/ttc_grants.py +++ b/designsafe/apps/nco/managers/ttc_grants.py @@ -42,9 +42,10 @@ def ttc_grants(self, params=None): query['Type'] = params['grant_type'] if params['text_search']: query['$or'] = [ - {'Title': {'$regex': params['text_search']}}, - {'Abstract': {'$regex': params['text_search']}}, - {'PiName': {'$regex': params['text_search']}}, + {'Title': {'$regex': params['text_search'], '$options': 'i'}}, + {'Abstract': {'$regex': params['text_search'], '$options': 'i'}}, + {'PiName': {'$regex': params['text_search'], '$options': 'i'}}, + {'CoPiNames': {'$regex': params['text_search'], '$options': 'i'}}, ] #get the grants list diff --git a/designsafe/apps/onboarding/__init__.py b/designsafe/apps/onboarding/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/designsafe/apps/onboarding/api/__init__.py b/designsafe/apps/onboarding/api/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/designsafe/apps/onboarding/api/urls.py b/designsafe/apps/onboarding/api/urls.py new file mode 100644 index 0000000000..ecda14042d --- /dev/null +++ b/designsafe/apps/onboarding/api/urls.py @@ -0,0 +1,12 @@ +""" URL routing for the onboarding API. """ + +from django.urls import path +from designsafe.apps.onboarding.api import views + + +app_name = "onboarding_api" +urlpatterns = [ + path("user/", views.SetupStepView.as_view(), name="user_self_view"), + path("user//", views.SetupStepView.as_view(), name="user_view"), + path("admin/", views.SetupAdminView.as_view(), name="user_admin"), +] diff --git a/designsafe/apps/onboarding/api/views.py b/designsafe/apps/onboarding/api/views.py new file mode 100644 index 0000000000..218cf40f77 --- /dev/null +++ b/designsafe/apps/onboarding/api/views.py @@ -0,0 +1,323 @@ +""""API views for the Onboarding app.""" + +import logging +import json +import math +from django.conf import settings +from django.http import ( + Http404, + JsonResponse, + HttpResponseBadRequest, +) +from django.contrib.auth import get_user_model +from django.contrib.admin.views.decorators import staff_member_required +from django.core.exceptions import PermissionDenied, ObjectDoesNotExist +from django.utils.decorators import method_decorator +from designsafe.apps.api.views import AuthenticatedApiView +from designsafe.apps.api.users.utils import q_to_model_queries +from designsafe.apps.onboarding.models import SetupEvent, SetupEventEncoder +from designsafe.apps.onboarding.execute import ( + log_setup_state, + load_setup_step, + execute_single_step, + execute_setup_steps, +) +from designsafe.apps.onboarding.state import SetupState + +logger = logging.getLogger(__name__) + + +def get_user_onboarding(user): + """Get a user's onboarding status""" + # Result dictionary for user + result = { + "username": user.username, + "lastName": user.last_name, + "firstName": user.first_name, + "email": user.email, + "isStaff": user.is_staff, + "steps": [], + "setupComplete": user.profile.setup_complete, + } + + # Populate steps list in result dictionary, in order of + # steps as listed in PORTAL_USER_ACCOUNT_SETUP_STEPS + account_setup_steps = getattr(settings, "PORTAL_USER_ACCOUNT_SETUP_STEPS", []) + for step in account_setup_steps: + # Get step events in descending order of time + step_events = ( + SetupEvent.objects.all() + .filter(user=user, step=step["step"]) + .order_by("-time") + ) + + step_instance = load_setup_step(user, step["step"]) + + # Upon retrieving step data such as viewing the Onboarding page, + # If a step has the 'retry' setting set to True and the step is not completed, + # retry the step with asynchronous processing. + if ( + "retry" in step + and step["retry"] + and step_instance.state != SetupState.PENDING + and step_instance.state != SetupState.COMPLETED + ): + step_instance.state = SetupState.PROCESSING + execute_single_step.apply_async(args=[user.username, step["step"]]) + logger.info("Retrying setup step %s for %s", step["step"], user.username) + + step_data = { + "step": step["step"], + "displayName": step_instance.display_name(), + "description": step_instance.description(), + "userConfirm": step_instance.user_confirm, + "staffApprove": step_instance.staff_approve, + "staffDeny": step_instance.staff_deny, + "state": step_instance.state, + "events": list(step_events), + "data": None, + } + custom_status = step_instance.custom_status() + if custom_status: + step_data["customStatus"] = custom_status + + if step_instance.last_event: + step_data["data"] = step_instance.last_event.data + + # Append all events. SetupEventEncoder will serialize + # SetupEvent objects later + result["steps"].append(step_data) + + return result + + +class SetupStepView(AuthenticatedApiView): + """View for managing user setup steps""" + + def _get_user_parameter(self, request, username): + """ + Validate request for action on a username + + Staff should be able to act on any user, but non-staff users + should only be able to act on themselves. + """ + # A user should only be able to retrieve info about themselves. + # A staff member should be able to retrieve anyone. + if username != request.user.username and not request.user.is_staff: + raise PermissionDenied + + user = None + try: + user = get_user_model().objects.get(username=username) + except get_user_model().DoesNotExist as exc: + raise Http404 from exc + + return user + + def get(self, request, username=None): + """ + View for returning a user's setup step events. + + Result structure will be: + + { + ... + user info + ... + "setupComplete" : true | false, + "steps" : [ + { + "step" : "step1", + "state" : "pending", + "events" : [ + SetupEvent, SetupEvent... + ] + }, + ... + ] + } + + Where step dictionaries are in matching order of PORTAL_USER_ACCOUNT_SETUP_STEPS + """ + if username is None: + username = request.user.username + + user = self._get_user_parameter(request, username) + + result = get_user_onboarding(user) + + return JsonResponse( + { + "status": 200, + "response": result, + }, + encoder=SetupEventEncoder, + ) + + def complete(self, request, setup_step): + """ + Move any step to COMPLETED + """ + if not request.user.is_staff: + raise PermissionDenied + setup_step.state = SetupState.COMPLETED + setup_step.log( + f"{setup_step.display_name()} marked complete by {request.user.username}" + ) + + def reset(self, request, setup_step): + """ + Call prepare() for the step. This should set it to its initial state. + """ + if not request.user.is_staff: + raise PermissionDenied + setup_step.log(f"{setup_step.display_name()} reset by {request.user.username}") + + # Mark the user's setup_complete as False + setup_step.user.profile.setup_complete = False + setup_step.user.profile.save() + log_setup_state( + setup_step.user, + f"{setup_step.user.username} setup marked incomplete, due to reset of {setup_step.step_name()}", + ) + setup_step.prepare() + + def client_action(self, request, setup_step, action, data): + """ + Call client_action on a setup step + """ + setup_step.log( + f"{action} action on {setup_step.step_name()} by {request.user.username}" + ) + setup_step.client_action(action, data, request) + + def post(self, request, username): + """ + Action handler for manipulating a user's setup step state. + POST data from the client includes: + + { + "action" : "staff_approve" | "staff_deny" | "user_confirm" | + "set_state" | "reset" + "step" : SetupStep module and classname, + "data" : an optional dictionary of data to send to the action + } + + ..return: A JsonResponse with the last_event for the user's SetupStep, + reflecting state change + """ + if username is None: + username = request.user.username + + # Get the user object requested in the route parameter + user = self._get_user_parameter(request, username) + + # Get POST action data + step_name = None + action = None + data = None + + try: + request_data = json.loads(request.body) + step_name = request_data["step"] + action = request_data["action"] + if "data" in request_data: + data = request_data["data"] + except (json.JSONDecodeError, KeyError): + logger.exception("Error parsing POST data") + return HttpResponseBadRequest() + + # Instantiate the step instance requested by the POST, from the SetupEvent model. + setup_step = load_setup_step(user, step_name) + + # Call action handler + if action == "reset": + self.reset(request, setup_step) + elif action == "complete": + self.complete(request, setup_step) + else: + self.client_action(request, setup_step, action, data) + + # If no exception was generated from any of the above actions, continue. + # Retry executing the setup queue for this user + execute_setup_steps.apply_async(args=[user.username]) + + # Serialize and send back the last event on this step + return JsonResponse( + { + "status": 200, + "response": setup_step.last_event, + }, + encoder=SetupEventEncoder, + ) + + +@method_decorator(staff_member_required, name="dispatch") +class SetupAdminView(AuthenticatedApiView): + """Admin view for managing user setup steps""" + + # pylint: disable=too-many-locals + def get(self, request): + """Get all users for page and their setup steps""" + + page = int(request.GET.get("page", 1)) + limit = int(request.GET.get("limit", 20)) + show_incomplete_only = request.GET.get("showIncompleteOnly", "False").lower() + query = request.GET.get("q", None) + order_by = request.GET.get("orderBy", None) + + users = [] + filter_args = {} + + # Filter users based on the showIncompleteOnly parameter + if show_incomplete_only == "true": + filter_args["profile__setup_complete"] = False + + # Get users, with most recently joined users that do not have setup_complete, first + if query: + query = q_to_model_queries(query) + results = get_user_model().objects.filter(query, **filter_args) + else: + results = get_user_model().objects.filter(**filter_args) + + if order_by and order_by in [ + "-date_joined", + "profile__setup_complete", + "last_name", + "first_name", + ]: + results = results.order_by(order_by) + else: + results = results.order_by( + "-date_joined", "profile__setup_complete", "last_name", "first_name" + ) + + # Uncomment this line to simulate many user results + # results = list(results) * 105 + + total = math.ceil(len(results) / limit) + offset = (page - 1) * limit + users_in_page = results[offset : limit * page] # noqa: E203 + account_setup_steps = getattr(settings, "PORTAL_USER_ACCOUNT_SETUP_STEPS", []) + + # Assemble an array with the User data we care about + for user in users_in_page: + try: + users.append(get_user_onboarding(user)) + except ObjectDoesNotExist as err: + # If a user does not have a DesignSafeProfile, skip it + logger.info(err) + + response = { + "users": users, + "total": total, + "totalSteps": len(account_setup_steps), + } + + return JsonResponse( + { + "status": 200, + "response": response, + }, + encoder=SetupEventEncoder, + ) diff --git a/designsafe/apps/onboarding/api/views_unit_test.py b/designsafe/apps/onboarding/api/views_unit_test.py new file mode 100644 index 0000000000..3e1b753aa4 --- /dev/null +++ b/designsafe/apps/onboarding/api/views_unit_test.py @@ -0,0 +1,323 @@ +import pytest +import logging +import json +from mock import MagicMock +from django.http import JsonResponse +from django.db.models import signals +from designsafe.apps.onboarding.models import SetupEvent +from designsafe.apps.onboarding.state import SetupState +from designsafe.apps.onboarding.api.views import SetupStepView, get_user_onboarding + +logger = logging.getLogger(__name__) + +pytestmark = pytest.mark.django_db + + +@pytest.fixture(autouse=True) +def disconnect_signal(): + yield signals.post_save.disconnect(sender=SetupEvent, dispatch_uid="setup_event") + + +@pytest.fixture(autouse=True) +def mocked_executor(mocker): + yield mocker.patch("designsafe.apps.onboarding.api.views.execute_setup_steps") + + +@pytest.fixture(autouse=True) +def mocked_log_setup_state(mocker): + yield mocker.patch("designsafe.apps.onboarding.api.views.log_setup_state") + + +@pytest.fixture(autouse=True) +def mocked_get_tas_client(mocker): + yield mocker.patch( + "designsafe.apps.onboarding.steps.project_membership.ProjectMembershipStep.get_tas_client" + ) + + +""" +SetupStepView tests +""" + + +def test_get_user_unauthenticated_forbidden(client, regular_user): + response = client.get("/api/onboarding/user/{}/".format(regular_user.username)) + assert response.status_code == 401 + + +def test_get_other_user_forbidden(client, authenticated_user, staff_user): + response = client.get("/api/onboarding/user/{}/".format(staff_user.username)) + assert response.status_code == 403 + + +def test_get_user_as_staff(client, authenticated_staff, regular_user): + response = client.get("/api/onboarding/user/{}/".format(regular_user.username)) + assert response.status_code == 200 + result = json.loads(response.content)["response"] + assert result["username"] == regular_user.username + assert len(result["steps"][0]["events"]) == 0 + + +def test_get_user_as_staff_with_steps( + settings, authenticated_staff, client, mock_steps +): + response = client.get("/api/onboarding/user/username", follow=True) + result = response.json()["response"] + + # Make sure result json is correct. + assert result["username"] == "username" + assert len(result["steps"][0]["events"]) == 2 + + +def test_get_non_existent_user_as_staff(client, authenticated_staff): + response = client.get("/api/onboarding/user/non_existent_user/") + assert response.status_code == 404 + + +def test_get_user_as_user(client, settings, authenticated_user, mock_steps): + # A user should be able to retrieve their own setup event info + response = client.get( + "/api/onboarding/user/{}".format(authenticated_user.username), follow=True + ) + result = response.json()["response"] + + result = json.loads(response.content)["response"] + assert result["username"] == authenticated_user.username + assert "steps" in result + assert ( + result["steps"][0]["step"] + == "designsafe.apps.onboarding.steps.test_steps.MockStep" + ) + assert result["steps"][0]["displayName"] == "Mock Step" + assert result["steps"][0]["state"] == SetupState.COMPLETED + assert len(result["steps"][0]["events"]) == 2 + + +def test_retry_step(client, settings, authenticated_user, mock_retry_step, mocker): + mock_execute_single_step = mocker.patch( + "designsafe.apps.onboarding.api.views.execute_single_step" + ) + response = client.get( + "/api/onboarding/user/{}".format(authenticated_user.username), follow=True + ) + mock_execute_single_step.apply_async.assert_called_with( + args=[ + authenticated_user.username, + "designsafe.apps.onboarding.steps.test_steps.MockStep", + ] + ) + result = json.loads(response.content)["response"] + assert result["username"] == authenticated_user.username + assert "steps" in result + assert ( + result["steps"][0]["step"] + == "designsafe.apps.onboarding.steps.test_steps.MockStep" + ) + assert result["steps"][0]["state"] == SetupState.PROCESSING + + +def test_incomplete_post(client, authenticated_user): + # post should return HttpResponseBadRequest (400) if fields are missing + response = client.post( + "/api/onboarding/user/{}/".format(authenticated_user), + content_type="application/json", + data=json.dumps({"action": "user_confirm"}), + ) + assert response.status_code == 400 + + response = client.post( + "/api/onboarding/user/{}/".format(authenticated_user), + content_type="application/json", + data=json.dumps({"step": "setupstep"}), + ) + assert response.status_code == 400 + + +def test_client_action(regular_user, rf): + view = SetupStepView() + mock_step = MagicMock() + mock_step.step_name.return_value = "Mock Step" + request = rf.post("/api/onboarding/user/username") + request.user = regular_user + view.client_action(request, mock_step, "user_confirm", None) + mock_step.log.assert_called() + mock_step.client_action.assert_called_with("user_confirm", None, request) + + +def test_reset_not_staff(client, authenticated_user): + response = client.post( + "/api/onboarding/user/{}/".format(authenticated_user.username), + content_type="application/json", + data=json.dumps( + { + "action": "reset", + "step": "designsafe.apps.onboarding.steps.test_steps.MockStep", + } + ), + ) + assert response.status_code == 403 + + +def test_reset(rf, staff_user, regular_user, mocked_log_setup_state): + # The reset function should call prepare on a step + # and flag the user's setup_complete as False + view = SetupStepView() + request = rf.post("/api/onboarding/user/username") + request.user = staff_user + mock_step = MagicMock() + mock_step.user = regular_user + + # Call reset function + view.reset(request, mock_step) + + mock_step.prepare.assert_called() + mock_step.log.assert_called() + mocked_log_setup_state.assert_called() + assert not mock_step.user.profile.setup_complete + + +def test_complete_not_staff(client, authenticated_user): + response = client.post( + "/api/onboarding/user/{}/".format(authenticated_user.username), + content_type="application/json", + data=json.dumps( + { + "action": "complete", + "step": "designsafe.apps.onboarding.steps.test_steps.MockStep", + } + ), + ) + assert response.status_code == 403 + + +def test_complete( + client, authenticated_staff, regular_user, mock_steps, mocked_executor +): + response = client.post( + "/api/onboarding/user/{}/".format(regular_user.username), + content_type="application/json", + data=json.dumps( + { + "action": "complete", + "step": "designsafe.apps.onboarding.steps.test_steps.MockStep", + } + ), + ) + + # set_state should have put MockStep in COMPLETED, as per request + events = [event for event in SetupEvent.objects.all()] + assert events[-1].step == "designsafe.apps.onboarding.steps.test_steps.MockStep" + assert events[-1].state == SetupState.COMPLETED + + # execute_setup_steps should have been run + mocked_executor.apply_async.assert_called_with(args=[regular_user.username]) + last_event = json.loads(response.content)["response"] + assert last_event["state"] == SetupState.COMPLETED + + +""" +SetupAdminView tests +""" + + +def test_admin_route(client, authenticated_staff): + # If the user is authenticated and is_staff, then the route should + # return a JsonResponse + response = client.get("/api/onboarding/admin/") + assert isinstance(response, JsonResponse) + + +def test_admin_route_is_protected(authenticated_user, client): + # Test to make sure route is protected + # If the user is not staff, then the route should return a redirect to admin login + response = client.get("/api/onboarding/admin/", follow=False) + assert response.status_code == 302 + + +def test_get_user_onboarding(mock_steps, regular_user): + # Test retrieving a user's events + result = get_user_onboarding(regular_user) + assert ( + result["steps"][0]["step"] + == "designsafe.apps.onboarding.steps.test_steps.MockStep" + ) + + +def test_get_no_profile(client, authenticated_staff, regular_user): + # Test that no object is returned for a user with no profile + regular_user.profile.delete() + response = client.get("/api/onboarding/admin/") + response_data = json.loads(response.content)["response"] + + # regular_user should not appear in results + assert not any( + [ + True + for user in response_data["users"] + if user["username"] == regular_user.username + ] + ) + + +def test_get(client, authenticated_staff, regular_user, mock_steps): + regular_user.profile.setup_complete = False + regular_user.profile.save() + + authenticated_staff.profile.setup_complete = True + authenticated_staff.profile.save() + + # Make a request without 'showIncompleteOnly' parameter + response = client.get("/api/onboarding/admin/") + result = json.loads(response.content)["response"] + + users = result["users"] + + # Make a request with 'showIncompleteOnly' parameter set to true + response_incomplete_users = client.get( + "/api/onboarding/admin/?showIncompleteOnly=true" + ) + result_incomplete_users = json.loads(response_incomplete_users.content)["response"] + + users_incomplete = result_incomplete_users["users"] + + # Assertions without 'showIncompleteOnly' + # The first result should be the regular_user, since they have not completed setup + assert users[0]["username"] == regular_user.username + + # User regular_user's last event should be MockStep + assert ( + users[0]["steps"][0]["step"] + == "designsafe.apps.onboarding.steps.test_steps.MockStep" + ) + + # There should be two users returned + assert len(users) == 2 + + # Assertions with 'showIncompleteOnly=true' + assert users_incomplete[0]["username"] == regular_user.username + assert ( + users_incomplete[0]["steps"][0]["step"] + == "designsafe.apps.onboarding.steps.test_steps.MockStep" + ) + + # There should be one user since only one user has setup_complete = True + assert len(users_incomplete) == 1 + + +def test_get_search(client, authenticated_staff, regular_user, mock_steps): + response = client.get("/api/onboarding/admin/?q=Firstname") + result = json.loads(response.content)["response"] + + users = result["users"] + + # The first result should be the regular_user, since they have not completed setup + assert users[0]["username"] == regular_user.username + + # User regular_user's last event should be MockStep + assert ( + users[0]["steps"][0]["step"] + == "designsafe.apps.onboarding.steps.test_steps.MockStep" + ) + + # There should be two users returned + assert len(users) == 1 diff --git a/designsafe/apps/onboarding/apps.py b/designsafe/apps/onboarding/apps.py new file mode 100644 index 0000000000..ed4697c5da --- /dev/null +++ b/designsafe/apps/onboarding/apps.py @@ -0,0 +1,9 @@ +""" Django app configuration for onboarding app. """ + +from django.apps import AppConfig + + +class OnboardingConfig(AppConfig): + """Django app configuration for onboarding app.""" + + name = "designsafe.apps.onboarding" diff --git a/designsafe/apps/onboarding/conftest.py b/designsafe/apps/onboarding/conftest.py new file mode 100644 index 0000000000..a258003ffd --- /dev/null +++ b/designsafe/apps/onboarding/conftest.py @@ -0,0 +1,46 @@ +""" Pytest fixtures for the onboarding app. """ + +import pytest +from designsafe.apps.onboarding.models import SetupEvent +from designsafe.apps.onboarding.state import SetupState + + +@pytest.fixture +def mock_steps(regular_user, settings): + """Mock steps for testing.""" + settings.PORTAL_USER_ACCOUNT_SETUP_STEPS = [ + {"step": "designsafe.apps.onboarding.steps.test_steps.MockStep"} + ] + pending_step = SetupEvent.objects.create( + user=regular_user, + step="designsafe.apps.onboarding.steps.test_steps.MockStep", + state=SetupState.PENDING, + message="message", + ) + + completed_step = SetupEvent.objects.create( + user=regular_user, + step="designsafe.apps.onboarding.steps.test_steps.MockStep", + state=SetupState.COMPLETED, + message="message", + ) + yield (pending_step, completed_step) + + +@pytest.fixture +def mock_retry_step(regular_user, settings): + """Mock a step that needs to be retried.""" + settings.PORTAL_USER_ACCOUNT_SETUP_STEPS = [ + { + "step": "designsafe.apps.onboarding.steps.test_steps.MockStep", + "retry": True, + "settings": {}, + } + ] + retry_step = SetupEvent.objects.create( + user=regular_user, + step="designsafe.apps.onboarding.steps.test_steps.MockStep", + state=SetupState.USERWAIT, + message="message", + ) + yield retry_step diff --git a/designsafe/apps/onboarding/execute.py b/designsafe/apps/onboarding/execute.py new file mode 100644 index 0000000000..34892985c4 --- /dev/null +++ b/designsafe/apps/onboarding/execute.py @@ -0,0 +1,130 @@ +"""Methods for executing setup steps for a user.""" + +import logging +from inspect import isclass +from importlib import import_module +from celery import shared_task +from django.conf import settings +from django.contrib.auth import get_user_model +from designsafe.apps.onboarding.state import SetupState +from designsafe.apps.onboarding.models import SetupEvent +from designsafe.apps.onboarding.steps.abstract import AbstractStep +from designsafe.apps.accounts.models import DesignSafeProfile + +logger = logging.getLogger(__name__) + + +class StepExecuteException(Exception): + """ + Exception raised when setup step processing + is interrupted + """ + + def __init__(self, message): + super().__init__(message) + + +def new_user_setup_check(user): + """Check if a user has completed setup steps""" + extra_steps = getattr(settings, "PORTAL_USER_ACCOUNT_SETUP_STEPS", []) + if len(extra_steps) == 0: + logger.info("No extra setup steps for user %s", user.username) + profile = DesignSafeProfile.objects.get(user=user) + profile.setup_complete = True + profile.save() + else: + logger.info("Preparing onboarding steps for user %s", user.username) + prepare_setup_steps(user) + + +def log_setup_state(user, message): + """Log the state of a user's setup""" + # Create an event log for a user completing setup. + # This will also signal the front end + SetupEvent.objects.create( + user=user, + step="designsafe.apps.onboarding.execute.execute_setup_steps", + state=( + SetupState.COMPLETED if user.profile.setup_complete else SetupState.FAILED + ), + message=message, + data={"setupComplete": user.profile.setup_complete}, + ) + + +def load_setup_step(user, step): + """Load a setup step class from a string""" + module_str, callable_str = step.rsplit(".", 1) + module = import_module(module_str) + call = getattr(module, callable_str) + if not isclass(call): + raise ValueError(f"Setup step {step} is not a class") + setup_step = call(user) + if not isinstance(setup_step, AbstractStep): + raise ValueError(f"Setup step {step} is not a subclass of AbstractStep") + return setup_step + + +def prepare_setup_steps(user): + """ + Set the initial state of all setup steps for a given user + """ + extra_steps = getattr(settings, "PORTAL_USER_ACCOUNT_SETUP_STEPS", []) + for step in extra_steps: + setup_step = load_setup_step(user, step["step"]) + if setup_step.last_event is None: + setup_step.prepare() + + +def process_setup_step(setup_step): + """Process a setup step""" + setup_step.state = SetupState.PROCESSING + setup_step.log("Beginning automated processing") + try: + setup_step.process() + except Exception as err: # pylint: disable=broad-except + logger.exception("Problem processing setup step") + setup_step.state = SetupState.ERROR + setup_step.log(f"Exception: {str(err)}") + + +@shared_task() +def execute_setup_steps(username): + """Execute all setup steps for a user""" + + user = get_user_model().objects.get(username=username) + + extra_steps = getattr(settings, "PORTAL_USER_ACCOUNT_SETUP_STEPS", []) + for step in extra_steps: + # Restore state of this setup step for this user + setup_step = load_setup_step(user, step["step"]) + # Run step, if waiting for automatic execution + # should have this state + if setup_step.state == SetupState.PENDING: + process_setup_step(setup_step) + # If step is not COMPLETED either from this execution or a prior + # one, then it could be in USERWAIT, STAFFWAIT or FAIL + # at which point we should raise an execption + if setup_step.state != SetupState.COMPLETED: + raise StepExecuteException(setup_step) + + # If execution was not interrupted by a StepExecuteException, such as + # a step failing to reach the COMPLETED state, mark the user as setup_complete + user.profile.setup_complete = True + user.profile.save() + log_setup_state(user, f"{user.username} setup is now complete") + + +@shared_task() +def execute_single_step(username, step_name): + """Execute a single setup step for a user""" + + user = get_user_model().objects.get(username=username) + # Process specified setup step + setup_step = load_setup_step(user, step_name) + process_setup_step(setup_step) + # If execution was not interrupted after processing this step, i.e. + # if it completed successfully, continue executing the rest of the onboarding + # steps + if setup_step.state == SetupState.COMPLETED: + execute_setup_steps(username) diff --git a/designsafe/apps/onboarding/execute_unit_test.py b/designsafe/apps/onboarding/execute_unit_test.py new file mode 100644 index 0000000000..8bb771981d --- /dev/null +++ b/designsafe/apps/onboarding/execute_unit_test.py @@ -0,0 +1,374 @@ +import pytest +from mock import MagicMock +from django.db.models import signals +from designsafe.apps.onboarding.steps.test_steps import MockProcessingCompleteStep +from designsafe.apps.accounts.models import DesignSafeProfile +from designsafe.apps.onboarding.models import SetupEvent +from designsafe.apps.onboarding.state import SetupState +from designsafe.apps.onboarding.execute import ( + execute_setup_steps, + execute_single_step, + prepare_setup_steps, + load_setup_step, + log_setup_state, + new_user_setup_check, + StepExecuteException, +) + + +pytestmark = pytest.mark.django_db + + +@pytest.fixture(autouse=True) +def disconnect_signal(): + yield signals.post_save.disconnect(sender=SetupEvent, dispatch_uid="setup_event") + + +@pytest.fixture +def mock_event_create(mocker): + yield mocker.patch( + "designsafe.apps.onboarding.execute.SetupEvent.objects.create", autospec=True + ) + + +def test_log_setup_state_complete(authenticated_user, mock_event_create): + """ + Test that a SetupEvent is logged for setting the user's setup_complete flag to True + """ + authenticated_user.profile.setup_complete = True + log_setup_state(authenticated_user, "test message") + mock_event_create.assert_called_with( + user=authenticated_user, + step="designsafe.apps.onboarding.execute.execute_setup_steps", + state=SetupState.COMPLETED, + message="test message", + data={"setupComplete": True}, + ) + + +def test_log_setup_state_incomplete(authenticated_user, mock_event_create): + """ + Test that a SetupEvent is logged for setting the user's setup_complete flag to False + """ + authenticated_user.profile.setup_complete = False + log_setup_state(authenticated_user, "test message") + mock_event_create.assert_called_with( + user=authenticated_user, + step="designsafe.apps.onboarding.execute.execute_setup_steps", + state=SetupState.FAILED, + message="test message", + data={"setupComplete": False}, + ) + + +def test_prepare_setup_steps(authenticated_user, mocker, settings): + """ + Test that a step is loaded and prepared for a user that does not have step history + """ + settings.PORTAL_USER_ACCOUNT_SETUP_STEPS = [{"step": "TestStep"}] + mock_step = MagicMock(last_event=None) + mock_loader = mocker.patch("designsafe.apps.onboarding.execute.load_setup_step") + mock_loader.return_value = mock_step + prepare_setup_steps(authenticated_user) + mock_loader.assert_called_with(authenticated_user, "TestStep") + mock_step.prepare.assert_called() + + +def test_step_loader(authenticated_user): + """ + Test the dynamic step loader + """ + step = load_setup_step( + authenticated_user, + "designsafe.apps.onboarding.steps.test_steps.MockProcessingCompleteStep", + ) + assert step is not None + + +def test_invalid_step_function(authenticated_user): + """ + Test an invalid configuration that passes a function instead of a class + + This may occur due to a legacy setting "designsafe.apps.accounts.steps.step_one" + """ + with pytest.raises(ValueError): + load_setup_step( + authenticated_user, + "designsafe.apps.onboarding.steps.test_steps.mock_invalid_step_function", + ) + + +def test_invalid_step_class(authenticated_user): + """ + Test an invalid configuration that passes a class that is not + a child of AbstractStep + + This may occur due to a legacy setting "designsafe.apps.accounts.steps.StepThree" + """ + with pytest.raises(ValueError): + load_setup_step( + authenticated_user, + "designsafe.apps.onboarding.steps.test_steps.MockInvalidStepClass", + ) + + +def test_successful_step(settings, authenticated_user, mocker): + """ + Test that a step that completes successfully is executed without error + """ + settings.PORTAL_USER_ACCOUNT_SETUP_STEPS = [ + { + "step": "designsafe.apps.onboarding.steps.test_steps.MockProcessingCompleteStep" + } + ] + mock_log_setup_state = mocker.patch( + "designsafe.apps.onboarding.execute.log_setup_state" + ) + + prepare_setup_steps(authenticated_user) + execute_setup_steps(authenticated_user.username) + + # Last event should be COMPLETED for MockPendingCompleteStep + setup_event = ( + SetupEvent.objects.all() + .filter( + step="designsafe.apps.onboarding.steps.test_steps.MockProcessingCompleteStep", + user=authenticated_user, + ) + .latest("time") + ) + assert setup_event.message == "Completed" + + # After last event has completed, setup_complete should be true for user + profile_result = DesignSafeProfile.objects.all().filter(user=authenticated_user)[0] + assert profile_result.setup_complete + + mock_log_setup_state.assert_called() + + +def test_fail_step(settings, authenticated_user): + """ + Test that a step that fails halts execution. + + MockProcessingFailStep should invoke and leave an event, + but MockProcessingCompleteStep (which occurs after in the mock setting) + should not execute due to the previous step failing. + """ + settings.PORTAL_USER_ACCOUNT_SETUP_STEPS = [ + {"step": "designsafe.apps.onboarding.steps.test_steps.MockProcessingFailStep"}, + { + "step": "designsafe.apps.onboarding.steps.test_steps.MockProcessingCompleteStep" + }, + ] + with pytest.raises(StepExecuteException): + prepare_setup_steps(authenticated_user) + execute_setup_steps(authenticated_user.username) + + setup_events = SetupEvent.objects.all() + assert len(setup_events) == 4 + setup_event = SetupEvent.objects.all()[3] + assert ( + setup_event.step + == "designsafe.apps.onboarding.steps.test_steps.MockProcessingFailStep" + ) + assert setup_event.message == "Failure" + profile = DesignSafeProfile.objects.get(user=authenticated_user) + assert not profile.setup_complete + + +def test_error_step(settings, authenticated_user): + """ + Assert that when a setup step causes an error that the error is logged + """ + settings.PORTAL_USER_ACCOUNT_SETUP_STEPS = [ + {"step": "designsafe.apps.onboarding.steps.test_steps.MockErrorStep"} + ] + with pytest.raises(StepExecuteException): + prepare_setup_steps(authenticated_user) + execute_setup_steps(authenticated_user.username) + + exception_event = SetupEvent.objects.all().filter( + user=authenticated_user, + step="designsafe.apps.onboarding.steps.test_steps.MockErrorStep", + state=SetupState.ERROR, + )[0] + assert exception_event.message == "Exception: MockErrorStep" + + +def test_userwait_step(settings, authenticated_user): + """ + Test that a step in USERWAIT (or really any state that is not PENDING) + prevents the rest of the steps from executing + + MockUserWaitStep.prepare should invoke and leave an event, + but MockPendingCompleteStep (which occurs after in the mock setting) + should not execute due to the first one not being "COMPLETE". + """ + settings.PORTAL_USER_ACCOUNT_SETUP_STEPS = [ + {"step": "designsafe.apps.onboarding.steps.test_steps.MockUserStep"}, + { + "step": "designsafe.apps.onboarding.steps.test_steps.MockProcessingCompleteStep" + }, + ] + with pytest.raises(StepExecuteException): + prepare_setup_steps(authenticated_user) + execute_setup_steps(authenticated_user.username) + + # Setup event log should not progress due to first + # step being USERWAIT + setup_events = SetupEvent.objects.all() + assert len(setup_events) == 2 + setup_event = SetupEvent.objects.all()[1] + assert ( + setup_event.step + == "designsafe.apps.onboarding.steps.test_steps.MockProcessingCompleteStep" + ) + assert setup_event.state == SetupState.PENDING + + +def test_sequence(settings, authenticated_user): + """ + Test that execution continues when a step completes + + MockProcessingCompleteStep should complete successfully and log an event. + MockProcessingFailStep should execute and fail, and leave a log event. + """ + settings.PORTAL_USER_ACCOUNT_SETUP_STEPS = [ + { + "step": "designsafe.apps.onboarding.steps.test_steps.MockProcessingCompleteStep" + }, + {"step": "designsafe.apps.onboarding.steps.test_steps.MockProcessingFailStep"}, + ] + with pytest.raises(StepExecuteException): + prepare_setup_steps(authenticated_user) + execute_setup_steps(authenticated_user.username) + + setup_events = SetupEvent.objects.all() + assert len(setup_events) == 6 + assert ( + setup_events[2].step + == "designsafe.apps.onboarding.steps.test_steps.MockProcessingCompleteStep" + ) + assert setup_events[2].state == SetupState.PROCESSING + assert ( + setup_events[3].step + == "designsafe.apps.onboarding.steps.test_steps.MockProcessingCompleteStep" + ) + assert setup_events[3].state == SetupState.COMPLETED + assert ( + setup_events[4].step + == "designsafe.apps.onboarding.steps.test_steps.MockProcessingFailStep" + ) + assert setup_events[4].state == SetupState.PROCESSING + assert ( + setup_events[5].step + == "designsafe.apps.onboarding.steps.test_steps.MockProcessingFailStep" + ) + assert setup_events[5].state == SetupState.FAILED + + +def test_sequence_with_history(settings, authenticated_user): + """ + Test that execution skips a previously completed step + + MockProcessingFailStep should execute and fail, and leave a log event. + There should be two log events + """ + + settings.PORTAL_USER_ACCOUNT_SETUP_STEPS = [ + { + "step": "designsafe.apps.onboarding.steps.test_steps.MockProcessingCompleteStep" + }, + {"step": "designsafe.apps.onboarding.steps.test_steps.MockProcessingFailStep"}, + ] + + # Artificially fail MockProcessingCompleteStep + mock_complete_step = MockProcessingCompleteStep(authenticated_user) + mock_complete_step.fail("Mock Failure") + + # Artificially execute MockProcessingCompleteStep + # The latest event instance should be a success, + # therefore the step should be skipped in the future + mock_complete_step = MockProcessingCompleteStep(authenticated_user) + mock_complete_step.process() + + # The previous two transactions should create a history with two steps + setup_events = SetupEvent.objects.all() + assert len(setup_events) == 2 + + # A new event should be generated for MockProcessingFail + prepare_setup_steps(authenticated_user) + setup_events = SetupEvent.objects.all() + assert len(setup_events) == 3 + + with pytest.raises(StepExecuteException): + execute_setup_steps(authenticated_user.username) + + # Executing should now generate more events + setup_events = SetupEvent.objects.all() + assert len(setup_events) == 5 + + # MockPendingCompleteStep should appear in the log exactly twice + complete_events = SetupEvent.objects.all().filter( + step="designsafe.apps.onboarding.steps.test_steps.MockProcessingCompleteStep" + ) + assert len(complete_events) == 2 + + # Last event should be MockPendingFailStep + assert ( + setup_events[4].step + == "designsafe.apps.onboarding.steps.test_steps.MockProcessingFailStep" + ) + assert setup_events[4].state == SetupState.FAILED + + +def test_no_setup_steps(settings, authenticated_user): + """ + Assert that when there are no setup steps, a user is flagged as setup_complete + """ + settings.PORTAL_USER_ACCOUNT_SETUP_STEPS = [] + new_user_setup_check(authenticated_user) + profile = DesignSafeProfile.objects.get(user=authenticated_user) + assert profile.setup_complete + + +def test_setup_steps_prepared_from_list(settings, authenticated_user, mocker): + """ + Assert that when there are setup steps, they are prepared for a user + """ + settings.PORTAL_USER_ACCOUNT_SETUP_STEPS = ["onboarding.step"] + mock_prepare = mocker.patch( + "designsafe.apps.onboarding.execute.prepare_setup_steps" + ) + new_user_setup_check(authenticated_user) + mock_prepare.assert_called_with(authenticated_user) + + +def test_execute_single_step(mocker, authenticated_user): + """ + Test that the single step executor triggers a follow up execution of + the rest of the step queue + """ + mock_execute = mocker.patch( + "designsafe.apps.onboarding.execute.execute_setup_steps" + ) + execute_single_step( + authenticated_user.username, + "designsafe.apps.onboarding.steps.test_steps.MockProcessingCompleteStep", + ) + mock_execute.assert_called_with(authenticated_user.username) + + +def test_execute_single_step_does_not_complete(mocker, authenticated_user): + """ + Test that the single step executor does not trigger a follow up execution of + the rest of the step queue if the step does not complete + """ + mock_execute = mocker.patch( + "designsafe.apps.onboarding.execute.execute_setup_steps" + ) + execute_single_step( + authenticated_user.username, + "designsafe.apps.onboarding.steps.test_steps.MockUserStep", + ) + mock_execute.assert_not_called() diff --git a/designsafe/apps/onboarding/migrations/0001_initial.py b/designsafe/apps/onboarding/migrations/0001_initial.py new file mode 100644 index 0000000000..dd426c2f30 --- /dev/null +++ b/designsafe/apps/onboarding/migrations/0001_initial.py @@ -0,0 +1,43 @@ +# Generated by Django 4.2.11 on 2024-10-15 23:05 + +from django.conf import settings +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + initial = True + + dependencies = [ + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ] + + operations = [ + migrations.CreateModel( + name="SetupEvent", + fields=[ + ( + "id", + models.AutoField( + auto_created=True, + primary_key=True, + serialize=False, + verbose_name="ID", + ), + ), + ("time", models.DateTimeField(auto_now_add=True)), + ("step", models.CharField(max_length=300)), + ("state", models.CharField(max_length=16)), + ("message", models.CharField(max_length=300)), + ("data", models.JSONField(null=True)), + ( + "user", + models.ForeignKey( + on_delete=django.db.models.deletion.CASCADE, + related_name="+", + to=settings.AUTH_USER_MODEL, + ), + ), + ], + ), + ] diff --git a/designsafe/apps/onboarding/migrations/__init__.py b/designsafe/apps/onboarding/migrations/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/designsafe/apps/onboarding/models.py b/designsafe/apps/onboarding/models.py new file mode 100644 index 0000000000..28ea73f814 --- /dev/null +++ b/designsafe/apps/onboarding/models.py @@ -0,0 +1,57 @@ +"""Onboarding models.""" + +from django.db import models +from django.conf import settings +from django.core.serializers.json import DjangoJSONEncoder + + +class SetupEvent(models.Model): + """Setup Events + + A log of events for setup steps + """ + + user = models.ForeignKey( + settings.AUTH_USER_MODEL, related_name="+", on_delete=models.CASCADE + ) + + # Auto increment auto add timestamp for event + time = models.DateTimeField(auto_now_add=True) + + # Name of SetupStep class, i.e. designsafe.apps.onboarding.steps.access.RequestAccessStep + step = models.CharField(max_length=300) + + # Short name for setup state, defined per SetupState class. + # "pending", "failed", "completed" etc + state = models.CharField(max_length=16) + + # Detailed setup message + message = models.CharField(max_length=300) + + # JSON Data + data = models.JSONField(null=True) + + def __str__(self): + return f"{self.user.username} {self.time} {self.step} ({self.state}) - {self.message} ({self.data})" + + def to_dict(self): + """Return a dictionary representation of the event""" + return { + "step": self.step, + "username": self.user.username, + "state": self.state, + "time": str(self.time), + "message": self.message, + "data": self.data, + } + + +class SetupEventEncoder(DjangoJSONEncoder): + """Custom JSON Encoder for SetupEvent objects""" + + def default(self, o): + if isinstance(o, SetupEvent): + event = o + return event.to_dict() + + return super().default(o) diff --git a/designsafe/apps/onboarding/models_unit_test.py b/designsafe/apps/onboarding/models_unit_test.py new file mode 100644 index 0000000000..0c2d3d74d3 --- /dev/null +++ b/designsafe/apps/onboarding/models_unit_test.py @@ -0,0 +1,39 @@ +from designsafe.apps.onboarding.state import SetupState +from designsafe.apps.onboarding.models import SetupEvent +from django.db.models import signals +import pytest + + +pytestmark = pytest.mark.django_db + + +@pytest.fixture(autouse=True) +def disconnect_signal(): + yield signals.post_save.disconnect(sender=SetupEvent, dispatch_uid="setup_event") + + +@pytest.fixture +def onboarding_event(authenticated_user): + event = SetupEvent.objects.create( + user=authenticated_user, + state=SetupState.PENDING, + step="TestStep", + message="test message", + ) + yield event + + +def test_onboarding_model(authenticated_user, onboarding_event): + event = SetupEvent.objects.all()[0] + assert event.user == authenticated_user + assert event.state == SetupState.PENDING + assert event.step == "TestStep" + assert event.message == "test message" + + +def test_unicode(authenticated_user, onboarding_event): + event_str = str(onboarding_event) + assert authenticated_user.username in event_str + assert "TestStep" in event_str + assert SetupState.PENDING in event_str + assert "test message" in event_str diff --git a/designsafe/apps/onboarding/state.py b/designsafe/apps/onboarding/state.py new file mode 100644 index 0000000000..159ce72c74 --- /dev/null +++ b/designsafe/apps/onboarding/state.py @@ -0,0 +1,40 @@ +""" State definitions for onboarding steps """ + + +# pylint: disable=too-few-public-methods +class SetupState: + """State definitions for onboarding steps""" + + # Steps in PENDING will be have their process methods called + # by designsafe.apps.onboarding.execute.execute_setup_steps + PENDING = "pending" + + # Steps in PROCESSING have had their process methods invoked + # by designsafe.apps.onboarding.execute.execute_setup_steps + PROCESSING = "processing" + + # Steps in FAILED state will display as a failure in the client + # They may be set to FAILED by calling the fail method + FAILED = "failed" + + # Steps in COMPLETED state will cause the next step to be + # checked for automated processing + # by designsafe.apps.onboarding.execute.execute_setup_steps + COMPLETED = "completed" + + # Steps in USERWAIT state will show a Confirm button in the + # client to the user, allowing them to confirm an action. + # Once they have pressed the Confirm button, the client + # will send "user_confirm" to the step's client_action method + USERWAIT = "userwait" + + # Steps in STAFFWAIT state will show an "Approve" and "Deny" + # action to staff users, allowing them to approve or deny + # a portal onboarding step. The client will send + # "staff_approve" or "staff_deny" to the step's client_action method + STAFFWAIT = "staffwait" + + # Steps in ERROR have been processed in execute_setup_steps but + # generated an exception. This state will also cause the front end + # to display a "submit a ticket" link to the user + ERROR = "error" diff --git a/designsafe/apps/onboarding/steps/__init__.py b/designsafe/apps/onboarding/steps/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/designsafe/apps/onboarding/steps/abstract.py b/designsafe/apps/onboarding/steps/abstract.py new file mode 100644 index 0000000000..c4946ee07e --- /dev/null +++ b/designsafe/apps/onboarding/steps/abstract.py @@ -0,0 +1,139 @@ +"""Abstract class for user setup steps.""" + +from abc import ABCMeta, abstractmethod +from six import add_metaclass +from django.conf import settings +from designsafe.apps.onboarding.models import SetupEvent +from designsafe.apps.onboarding.state import SetupState + + +# pylint: disable=too-many-instance-attributes +@add_metaclass(ABCMeta) +class AbstractStep: + """ + An abstract class that allows user setup steps to be structured + with a state machine. + """ + + def __init__(self, user): + self.state = None + self.user = user + self.user_confirm = "Confirm" + self.staff_approve = "Approve" + self.staff_deny = "Deny" + self.last_event = None + self.events = [] + + try: + steps = settings.PORTAL_USER_ACCOUNT_SETUP_STEPS + step_dict = next( + (step for step in steps if step["step"] == self.step_name()), {} + ) + self.settings = step_dict["settings"] + except KeyError: + self.settings = None + + try: + # Restore event history + self.events = list( + SetupEvent.objects.filter(user=user, step=self.step_name()).order_by( + "time" + ) + ) + + self.last_event = self.events[-1] if len(self.events) > 0 else None + self.state = self.last_event.state + except (IndexError, AttributeError): + pass + + def log(self, message, data=None): + """ + Log current state of setup step. This must be called by subclasses and any method that + needs to set the state of the setup step for this user. + """ + self.last_event = SetupEvent.objects.create( + user=self.user, + step=self.step_name(), + state=self.state, + message=message, + data=data, + ) + self.events.append(self.last_event) + + def fail(self, message, data=None): + """ + Mark this setup step as failed. + """ + self.state = SetupState.FAILED + self.log(message, data) + + def complete(self, message, data=None): + """ + Mark this setup step as completed + """ + self.state = SetupState.COMPLETED + self.log(message, data) + + def __str__(self): + return f"<{self.step_name()} for {self.user.username} is {self.state}>" + + def step_name(self): + """Return the full name of the step class""" + return f"{self.__module__}.{self.__class__.__name__}" + + @abstractmethod + def display_name(self): + """ + Called when displaying this step in the client. Should return a string + that is a friendly name for a step. + """ + return NotImplemented + + @abstractmethod + def description(self): + """ + Called when displaying this step in the client. Should return a string + that is a detailed description for a step. + """ + return NotImplemented + + def custom_status(self): + """ + Called when displaying this step in the client. Should return a string + that displays a custom status + """ + return None + + @abstractmethod + def prepare(self): + """ + Called during profile setup in designsafe.apps.accounts.managers.accounts.setup + if no log data exists for this step. Child implementations should perform + any pre-processing, then set state to PENDING, USERWAIT or STAFFWAIT and + call self.log with a message to save this state. + + Also called when a staff user invokes the reset action from the client + """ + return NotImplemented + + def client_action(self, action, data, request): + """ + Called by designsafe.apps.onboarding.api.views.SetupStepView.post + + Child implementations should override this to handle interactions with + the front-end client, and should call complete, fail, or log. + The child implementation should check the identity of request.user before + allowing execution of an action + + ..param: action can be "user_confirm" | "staff_approve" | "staff_deny" + """ + + def process(self): + """ + Called by designsafe.apps.onboarding.execute.execute_setup_steps if + state is SetupState.PENDING. execute_setup_steps will put the step + in the PROCESSING state before this method is called. + + Child implementations should override this to handle long processing + calls. + """ diff --git a/designsafe/apps/onboarding/steps/abstract_unit_test.py b/designsafe/apps/onboarding/steps/abstract_unit_test.py new file mode 100644 index 0000000000..93ff1425a0 --- /dev/null +++ b/designsafe/apps/onboarding/steps/abstract_unit_test.py @@ -0,0 +1,88 @@ +from designsafe.apps.onboarding.models import SetupEvent +from designsafe.apps.onboarding.state import SetupState +from django.db.models import signals +from designsafe.apps.onboarding.steps.test_steps import MockStep +import pytest + + +@pytest.fixture(autouse=True) +def disconnect_signal(): + yield signals.post_save.disconnect(sender=SetupEvent, dispatch_uid="setup_event") + + +@pytest.fixture +def mock_step(settings, regular_user): + yield MockStep(regular_user) + + +def test_init_not_event(mock_step): + assert mock_step.last_event is None + assert len(mock_step.events) == 0 + + +def test_step_name(mock_step): + assert ( + mock_step.step_name() == "designsafe.apps.onboarding.steps.test_steps.MockStep" + ) + + +def test_log(mock_step, regular_user): + mock_step.state = SetupState.PENDING + mock_step.log("test event") + events = SetupEvent.objects.all().filter(user=regular_user) + assert events[0].message == "test event" + assert events[0].state == SetupState.PENDING + + +def test_init_with_event(mock_step, regular_user): + mock_step.state = SetupState.PENDING + mock_step.log("event 1") + mock_step.state = SetupState.COMPLETED + mock_step.log("event 2") + + # Re-initialize the step to load last event + mock_step = MockStep(regular_user) + assert mock_step.last_event.state == SetupState.COMPLETED + assert len(mock_step.events) == 2 + + +def test_complete(mock_step): + mock_step.complete("Completed") + assert mock_step.state == SetupState.COMPLETED + assert mock_step.last_event.state == SetupState.COMPLETED + assert SetupEvent.objects.all()[0].message == "Completed" + + +def test_fail(mock_step): + mock_step.fail("Failure") + assert mock_step.state == SetupState.FAILED + assert mock_step.last_event.state == SetupState.FAILED + assert SetupEvent.objects.all()[0].message == "Failure" + + +def test_str(mock_step): + mock_step.state = SetupState.PENDING + assert ( + str(mock_step) + == "" + ) + + +def test_settings(mock_step): + assert mock_step.settings == {"key": "value"} + + +def test_step_missing(regular_user, settings): + settings.PORTAL_USER_ACCOUNT_SETUP_STEPS = [] + mock_step = MockStep(regular_user) + assert mock_step.settings is None + + +def test_step_setting_missing(regular_user, settings): + settings.PORTAL_USER_ACCOUNT_SETUP_STEPS = [ + { + "step": "designsafe.apps.onboarding.steps.test_steps.MockStep", + } + ] + mock_step = MockStep(regular_user) + assert mock_step.settings is None diff --git a/designsafe/apps/onboarding/steps/access.py b/designsafe/apps/onboarding/steps/access.py new file mode 100644 index 0000000000..068e4e4a98 --- /dev/null +++ b/designsafe/apps/onboarding/steps/access.py @@ -0,0 +1,54 @@ +"""Request Access Step for Onboarding.""" + +from designsafe.apps.onboarding.state import SetupState +from designsafe.apps.onboarding.steps.abstract import AbstractStep + + +class RequestAccessStep(AbstractStep): + """Request Access Step for Onboarding.""" + + def __init__(self, user): + """ + Call super class constructor + """ + super().__init__(user) + self.user_confirm = "Request Portal Access" + self.staff_approve = "Grant Portal Access" + self.staff_deny = "Deny Access Request" + + def display_name(self): + return "Requesting Access" + + def description(self): + return """This notifies a system administrator of your request to access the portal. + After sending the request, wait for their approval.""" + + def prepare(self): + super().prepare() + self.state = SetupState.PENDING + self.log("Waiting for access check") + + def process(self): + self.state = SetupState.USERWAIT + self.log("Please click Request Portal Access and then wait for staff approval.") + + def custom_status(self): + if self.state == SetupState.COMPLETED: + return "Access Granted" + return None + + def client_action(self, action, data, request): + if action == "user_confirm" and request.user == self.user: + self.state = SetupState.STAFFWAIT + self.log("Please wait for staff approval") + return + + if not request.user.is_staff: + return + + if action == "staff_approve": + self.complete(f"Portal access request approved by {request.user.username}") + elif action == "staff_deny": + self.fail("Portal access request has not been approved.") + else: + self.fail(f"Invalid client action {action}") diff --git a/designsafe/apps/onboarding/steps/access_unit_test.py b/designsafe/apps/onboarding/steps/access_unit_test.py new file mode 100644 index 0000000000..db21f95c34 --- /dev/null +++ b/designsafe/apps/onboarding/steps/access_unit_test.py @@ -0,0 +1,60 @@ +from django.test import TestCase, RequestFactory +from django.contrib.auth import get_user_model +from mock import patch, ANY +from designsafe.apps.onboarding.state import SetupState +from designsafe.apps.onboarding.steps.access import RequestAccessStep +import pytest + + +@pytest.mark.django_db(transaction=True) +class TestRequestAccessStep(TestCase): + def setUp(self): + super(TestRequestAccessStep, self).setUp() + + # Create a test user + User = get_user_model() + self.user = User.objects.create_user("test", "test@test.com", "test") + + self.staff = User.objects.create_user("staff", "staff@staff.com", "staff") + self.staff.is_staff = True + + def tearDown(self): + super(TestRequestAccessStep, self).tearDown() + + @patch("designsafe.apps.onboarding.steps.access.RequestAccessStep.log") + def test_prepare(self, mock_log): + # prepare should log a STAFFWAIT state + step = RequestAccessStep(self.user) + step.prepare() + self.assertEqual(step.state, SetupState.PENDING) + mock_log.assert_called_with(ANY) + + @patch("designsafe.apps.onboarding.steps.access.RequestAccessStep.fail") + @patch("designsafe.apps.onboarding.steps.access.RequestAccessStep.complete") + def test_not_staff(self, mock_complete, mock_fail): + step = RequestAccessStep(self.user) + request = RequestFactory().post("/api/setup/test") + request.user = self.user + step.client_action("staff_approve", None, request) + mock_complete.assert_not_called() + mock_fail.assert_not_called() + + @patch("designsafe.apps.onboarding.steps.access.RequestAccessStep.complete") + def test_staff_approve(self, mock_complete): + # staff_approve should log a COMPLETED state + step = RequestAccessStep(self.user) + request = RequestFactory().post("/api/setup/test") + request.user = self.staff + step.client_action("staff_approve", None, request) + mock_complete.assert_called_with(ANY) + + @patch("designsafe.apps.onboarding.steps.access.RequestAccessStep.fail") + def test_fail_actions(self, mock_fail): + # staff_approve should log a FAILED state + step = RequestAccessStep(self.user) + request = RequestFactory().post("/api/setup/test") + request.user = self.staff + step.client_action("staff_deny", None, request) + mock_fail.assert_called_with(ANY) + step.client_action("invalid", None, request) + mock_fail.assert_called_with(ANY) diff --git a/designsafe/apps/onboarding/steps/allocation.py b/designsafe/apps/onboarding/steps/allocation.py new file mode 100644 index 0000000000..3d3dff3877 --- /dev/null +++ b/designsafe/apps/onboarding/steps/allocation.py @@ -0,0 +1,35 @@ +"""Allocation step for Onboarding.""" + +from designsafe.apps.onboarding.steps.abstract import AbstractStep +from designsafe.apps.onboarding.state import SetupState +from designsafe.apps.api.users.utils import get_allocations + + +class AllocationStep(AbstractStep): + """Allocation Access Step for Onboarding.""" + + def display_name(self): + return "Allocations" + + def description(self): + return """Accessing your allocations. If unsuccessful, verify the PI has added you to the allocations for this project.""" + + def prepare(self): + self.state = SetupState.PENDING + self.log("Awaiting allocation retrieval") + + def client_action(self, action, data, request): + if action == "user_confirm" and request.user.username == self.user.username: + self.prepare() + + def process(self): + self.state = SetupState.PROCESSING + self.log("Retrieving your allocations") + + # Force allocation retrieval from TAS and refresh elasticsearch + allocations = get_allocations(self.user, force=True) + if not allocations.get("hosts"): + self.state = SetupState.USERWAIT + self.log(f"User {self.user.username} does not have any allocations") + else: + self.complete("Allocations retrieved", data=allocations) diff --git a/designsafe/apps/onboarding/steps/allocation_unit_test.py b/designsafe/apps/onboarding/steps/allocation_unit_test.py new file mode 100644 index 0000000000..ed03eddd18 --- /dev/null +++ b/designsafe/apps/onboarding/steps/allocation_unit_test.py @@ -0,0 +1,58 @@ +from designsafe.apps.onboarding.steps.allocation import AllocationStep +from mock import ANY +import pytest + + +@pytest.fixture +def get_allocations_mock(mocker): + get_allocations = mocker.patch( + "designsafe.apps.onboarding.steps.allocation.get_allocations" + ) + get_allocations.return_value = { + "hosts": {"allocation": []}, + } + yield get_allocations + + +@pytest.fixture +def get_allocations_failure_mock(mocker): + get_allocations = mocker.patch( + "designsafe.apps.onboarding.steps.allocation.get_allocations" + ) + get_allocations.return_value = { + "hosts": {}, + } + yield get_allocations + + +@pytest.fixture +def allocation_step_complete_mock(mocker): + yield mocker.patch.object(AllocationStep, "complete") + + +@pytest.fixture +def allocation_step_log_mock(mocker): + yield mocker.patch.object(AllocationStep, "log") + + +def test_get_allocations( + regular_user, get_allocations_mock, allocation_step_complete_mock +): + step = AllocationStep(regular_user) + step.process() + get_allocations_mock.assert_called_with(regular_user, force=True) + allocation_step_complete_mock.assert_called_with( + "Allocations retrieved", + data={ + "hosts": {"allocation": []}, + }, + ) + + +def test_get_allocations_failure( + regular_user, get_allocations_failure_mock, allocation_step_log_mock +): + step = AllocationStep(regular_user) + step.process() + get_allocations_failure_mock.assert_called_with(regular_user, force=True) + allocation_step_log_mock.assert_called_with(ANY) diff --git a/designsafe/apps/onboarding/steps/project_membership.py b/designsafe/apps/onboarding/steps/project_membership.py new file mode 100644 index 0000000000..c5b79d2e53 --- /dev/null +++ b/designsafe/apps/onboarding/steps/project_membership.py @@ -0,0 +1,217 @@ +"""Project Membership Step for Onboarding.""" + +import logging +from requests.auth import HTTPBasicAuth +from django.conf import settings +from pytas.http import TASClient +from rt import Rt +from designsafe.apps.onboarding.steps.abstract import AbstractStep +from designsafe.apps.onboarding.state import SetupState + + +logger = logging.getLogger(__name__) + + +class ProjectMembershipStep(AbstractStep): + """Project Membership Step for Onboarding""" + + def __init__(self, user): + """ + Call super class constructor + """ + super().__init__(user) + self.project = self.get_tas_project() + self.user_confirm = "Request Project Access" + self.staff_approve = f"Add to {self.project['title']}" + self.staff_deny = "Deny Project Access Request" + + def get_tas_client(self): + """Get a TAS client""" + tas_client = TASClient( + baseURL=settings.TAS_URL, + credentials={ + "username": settings.TAS_CLIENT_KEY, + "password": settings.TAS_CLIENT_SECRET, + }, + ) + return tas_client + + def get_tas_project(self): + """Get a TAS project""" + return self.get_tas_client().project(self.settings["project_sql_id"]) + + def description(self): + if self.settings is not None and "description" in self.settings: + return self.settings["description"] + return """This confirms if you have access to the project. If not, request access and + wait for the system administrator’s approval.""" + + def display_name(self): + return "Checking Project Membership" + + def prepare(self): + """Prepare the step""" + self.state = SetupState.PENDING + self.log("Awaiting project membership check") + + def get_tracker(self): + """Get a RT client""" + return Rt( + settings.DJANGO_RT["RT_HOST"], + settings.DJANGO_RT["RT_UN"], + settings.DJANGO_RT["RT_PW"], + http_auth=HTTPBasicAuth( + settings.DJANGO_RT["RT_UN"], settings.DJANGO_RT["RT_PW"] + ), + ) + + def is_project_member(self): + """Check if the user is a member of the project in TAS""" + username = self.user.username + tas_client = self.get_tas_client() + project_users = tas_client.get_project_users(self.settings["project_sql_id"]) + return any(u["username"] == username for u in project_users) + + def send_project_request(self, request): + """Send a project request to the RT system""" + tracker = self.get_tracker() + ticket_text = f""" + User {self.user.username} is requesting membership on the {self.project["title"]} project. + Please visit {request.build_absolute_uri(f'/onboarding/setup/{self.user.username}')} + to complete this request. + """ + + try: + if tracker.login(): + result = tracker.create_ticket( + Queue=self.settings.get("rt_queue") or "Accounts", + Subject=f"{self.project['title']} Project Membership Request for {self.user.username}", + Text=ticket_text, + Requestor=self.user.email, + CF_resource=self.settings.get("rt_tag") or "", + ) + tracker.logout() + + if not result: + raise Exception( # pylint: disable=broad-exception-raised + "Could not create ticket" + ) + + self.state = SetupState.STAFFWAIT + self.log( + "Thank you for your request. It will be reviewed by TACC staff.", + data={"ticket": result}, + ) + else: + raise Exception( # pylint: disable=broad-exception-raised + "Could not log in to RT" + ) + except Exception as err: # pylint: disable=broad-except + logger.exception( + msg="Could not create ticket on behalf of user during ProjectMembershipStep" + ) + logger.error(err.args) + self.fail( + "We were unable to submit a portal access request ticket on your behalf." + ) + + def add_to_project(self): + """Add the user to the TAS project""" + tas_client = self.get_tas_client() + # Project number is not the GID number, but the primary key + # in the database for the project record. + # When viewing a project in tas.tacc.utexas.edu, you should see "?id=xxxxx" + # in the address bar. This is the SQL ID + try: + tas_client.add_project_user( + self.settings["project_sql_id"], self.user.username + ) + except Exception as exc: # pylint: disable=broad-except + reason = str(exc) + if "is already a member" in reason: + self.complete( + f"{self.user.username} is already a member of the {self.project['title']}" + ) + else: + self.fail( + f"{self.user.username} could not be added to {self.project['title']} due to error {reason}" + ) + raise exc + + def deny_project_request(self): + """Deny a project request and close the ticket""" + ticket_id = None + for event in self.events: + if event.data and "ticket" in event.data: + ticket_id = event.data["ticket"] + tracker = self.get_tracker() + request_text = f"""Your request for membership on the {self.project["title"]} project has been + denied. If you believe this is an error, please submit a help ticket. + """ + if tracker.login(): + tracker.reply(ticket_id, text=request_text) + tracker.comment( + ticket_id, + text=f"User was not added to the {self.project['title']} TAS Project (GID {self.project['gid']}) at https://{settings.SESSION_COOKIE_DOMAIN}", + ) + tracker.edit_ticket(ticket_id, Status="resolved") + else: + self.fail(f"The portal was unable to close RT Ticket {ticket_id}") + + def close_project_request(self): + """Close the project request RT ticket""" + ticket_id = None + for event in self.events: + if event.data and "ticket" in event.data: + ticket_id = event.data["ticket"] + tracker = self.get_tracker() + request_text = f"""Your request for membership on the {self.project["title"]} project has been + granted. Please login at https://{settings.SESSION_COOKIE_DOMAIN}/onboarding/setup to continue setting up your account. + """ + if tracker.login(): + tracker.reply(ticket_id, text=request_text) + tracker.comment( + ticket_id, + text=f"User has been added to the {self.project['title']} TAS Project (GID {self.project['gid']}) via https://{settings.SESSION_COOKIE_DOMAIN}", + ) + tracker.edit_ticket(ticket_id, Status="resolved") + else: + self.fail(f"The portal was unable to close RT Ticket {ticket_id}") + + def process(self): + if self.is_project_member(): + self.complete( + "You have the required project membership to access this portal." + ) + else: + self.state = SetupState.USERWAIT + data = None + if self.settings is not None and "userlink" in self.settings: + data = {"userlink": self.settings["userlink"]} + self.log("Please confirm your request to use this portal.", data=data) + + def client_action(self, action, data, request): + if action == "user_confirm": + self.send_project_request(request) + return + + if request.user.is_staff and action == "staff_approve": + try: + self.add_to_project() + self.close_project_request() + self.complete( + f"Portal access request approved by {request.user.username}" + ) + except Exception as err: # pylint: disable=broad-except + logger.exception( + msg=f"Error during staff_approve on {self.step_name()}" + ) + logger.error(err.args) + self.fail( + "An error occurred while trying to add this user to the project" + ) + elif action == "staff_deny": + self.deny_project_request() + self.fail("Portal access request has not been approved.") + else: + self.fail(f"Invalid client action {action}") diff --git a/designsafe/apps/onboarding/steps/project_membership_unit_test.py b/designsafe/apps/onboarding/steps/project_membership_unit_test.py new file mode 100644 index 0000000000..d51cb8474d --- /dev/null +++ b/designsafe/apps/onboarding/steps/project_membership_unit_test.py @@ -0,0 +1,196 @@ +from django.conf import settings +from designsafe.apps.onboarding.steps.project_membership import ProjectMembershipStep +from designsafe.apps.onboarding.models import SetupEvent +from mock import MagicMock, ANY +import pytest +import json +import os + + +@pytest.fixture +def tas_client(mocker): + with open( + os.path.join(settings.BASE_DIR, "designsafe/fixtures/tas/tas_project.json") + ) as f: + tas_project = json.load(f) + with open( + os.path.join( + settings.BASE_DIR, "designsafe/fixtures/tas/tas_project_users.json" + ) + ) as f: + tas_project_users = json.load(f) + tas_client_mock = mocker.patch( + "designsafe.apps.onboarding.steps.project_membership.TASClient", autospec=True + ) + tas_client_mock.return_value.project.return_value = tas_project + tas_client_mock.return_value.get_project_users.return_value = tas_project_users + yield tas_client_mock + + +@pytest.fixture +def mock_rt(mocker): + mock_tracker = mocker.patch( + "designsafe.apps.onboarding.steps.project_membership.ProjectMembershipStep.get_tracker" + ) + mock_tracker.return_value.login.return_value = True + yield mock_tracker + + +@pytest.fixture +def project_membership_step(settings, regular_user, tas_client, mock_rt): + settings.PORTAL_USER_ACCOUNT_SETUP_STEPS = [ + { + "step": "designsafe.apps.onboarding.steps.project_membership.ProjectMembershipStep", + "settings": {"project_sql_id": 12345}, + } + ] + step = ProjectMembershipStep(regular_user) + yield step + + +@pytest.fixture +def project_membership_step_with_userlink(settings, regular_user, tas_client): + settings.PORTAL_USER_ACCOUNT_SETUP_STEPS = [ + { + "step": "designsafe.apps.onboarding.steps.project_membership.ProjectMembershipStep", + "settings": { + "project_sql_id": 12345, + "userlink": {"url": "/", "text": "Request Access"}, + }, + "retry": True, + } + ] + step = ProjectMembershipStep(regular_user) + yield step + + +@pytest.fixture +def project_membership_log(mocker): + yield mocker.patch.object(ProjectMembershipStep, "log") + + +@pytest.fixture +def project_membership_fail(mocker): + yield mocker.patch.object(ProjectMembershipStep, "fail") + + +@pytest.fixture +def project_membership_complete(mocker): + yield mocker.patch.object(ProjectMembershipStep, "complete") + + +def test_is_project_member(tas_client, project_membership_step): + assert project_membership_step.is_project_member() + tas_client.return_value.get_project_users.return_value = [] + assert not project_membership_step.is_project_member() + + +def test_process_user_is_member( + monkeypatch, project_membership_step, project_membership_complete +): + def mock_is_project_member(): + return True + + monkeypatch.setattr( + project_membership_step, "is_project_member", mock_is_project_member + ) + project_membership_step.process() + project_membership_complete.assert_called_with( + "You have the required project membership to access this portal." + ) + + +def test_process_user_is_not_member( + monkeypatch, project_membership_step, project_membership_log +): + def mock_is_project_member(): + return False + + monkeypatch.setattr( + project_membership_step, "is_project_member", mock_is_project_member + ) + project_membership_step.process() + project_membership_log.assert_called_with( + "Please confirm your request to use this portal.", data=None + ) + + +def test_process_userlink( + monkeypatch, project_membership_step_with_userlink, project_membership_log +): + def mock_is_project_member(): + return False + + monkeypatch.setattr( + project_membership_step_with_userlink, + "is_project_member", + mock_is_project_member, + ) + project_membership_step_with_userlink.process() + project_membership_log.assert_called_with( + "Please confirm your request to use this portal.", + data={"userlink": {"url": "/", "text": "Request Access"}}, + ) + + +def test_send_project_request( + rf, project_membership_step, project_membership_log, mock_rt, regular_user +): + request = rf.get("https://cep.dev/") + request.user = regular_user + project_membership_step.send_project_request(request) + mock_rt.return_value.create_ticket.assert_called() + + +def test_add_to_project(regular_user, project_membership_step, tas_client): + project_membership_step.add_to_project() + tas_client.return_value.add_project_user.assert_called_with( + 12345, regular_user.username + ) + + +def test_close_project_request(regular_user, project_membership_step, mock_rt): + project_membership_step.events = [ + SetupEvent(user=regular_user), + SetupEvent(user=regular_user, data={}), + SetupEvent(user=regular_user, data={"ticket": "1234"}), + SetupEvent(user=regular_user, data={"ticket": "12345"}), + ] + project_membership_step.close_project_request() + mock_rt.return_value.reply.assert_called_with("12345", text=ANY) + mock_rt.return_value.comment.assert_called_with("12345", text=ANY) + mock_rt.return_value.edit_ticket.assert_called_with("12345", Status="resolved") + + +def test_client_action( + regular_user, rf, monkeypatch, project_membership_step, project_membership_complete +): + request = rf.get("/api/onboarding") + request.user = regular_user + mock_send = MagicMock() + mock_add = MagicMock() + mock_close = MagicMock() + monkeypatch.setattr(project_membership_step, "send_project_request", mock_send) + monkeypatch.setattr(project_membership_step, "add_to_project", mock_add) + monkeypatch.setattr(project_membership_step, "close_project_request", mock_close) + project_membership_step.client_action("user_confirm", {}, request) + mock_send.assert_called_with(request) + request.user.is_staff = True + project_membership_step.client_action("staff_approve", {}, request) + mock_add.assert_called_with() + mock_close.assert_called_with() + project_membership_complete.assert_called_with(ANY) + + +def test_client_action_fail( + rf, regular_user, monkeypatch, project_membership_step, project_membership_fail +): + mock_add = MagicMock(side_effect=Exception("Mock exception", "Mock reason")) + monkeypatch.setattr(project_membership_step, "add_to_project", mock_add) + request = rf.get("/api/onboarding") + request.user = regular_user + request.user.is_staff = True + project_membership_step.client_action("staff_approve", {}, request) + project_membership_fail.assert_called_with( + "An error occurred while trying to add this user to the project" + ) diff --git a/designsafe/apps/onboarding/steps/system_access.py b/designsafe/apps/onboarding/steps/system_access.py new file mode 100644 index 0000000000..24e6c6b184 --- /dev/null +++ b/designsafe/apps/onboarding/steps/system_access.py @@ -0,0 +1,57 @@ +"""System Allocation Access Step for Onboarding.""" + +import logging +from designsafe.apps.onboarding.state import SetupState +from designsafe.apps.api.users.utils import get_allocations +from .project_membership import ProjectMembershipStep + +logger = logging.getLogger(__name__) + + +class SystemAccessStep(ProjectMembershipStep): + """System Access Step for Onboarding.""" + + def __init__(self, user): + """ + Call super class constructor + """ + super().__init__(user) + self.user_confirm = "Request System Access" + self.staff_deny = "Deny System Access Request" + + def display_name(self): + return "Checking System Access" + + def description(self): + return """This confirms if you have access to the required HPC systems to + access this portal. If not, request access and wait for the + system administrator’s approval.""" + + def prepare(self): + self.state = SetupState.PENDING + self.log("Awaiting system access check") + + def has_required_systems(self): + """Check if the user has the required systems for accessing the portal.""" + + systems = self.settings["required_systems"] + if len(systems) == 0: + return True + + resources = [] + try: + resources = get_allocations(self.user)["hosts"].keys() + # If the intersection of the set of systems and resources has + # items, the user has the necessary allocation + return len(set(systems).intersection(resources)) > 0 + except Exception as exc: # pylint: disable=broad-except + logger.error(exc) + self.fail("We were unable to retrieve your allocations.") + return False + + def process(self): + if self.has_required_systems() or self.is_project_member(): + self.complete("You have the required systems for accessing this portal") + else: + self.state = SetupState.USERWAIT + self.log("Please confirm your request to use this portal.") diff --git a/designsafe/apps/onboarding/steps/system_access_unit_test.py b/designsafe/apps/onboarding/steps/system_access_unit_test.py new file mode 100644 index 0000000000..6cad3c5ea2 --- /dev/null +++ b/designsafe/apps/onboarding/steps/system_access_unit_test.py @@ -0,0 +1,49 @@ +from django.conf import settings +from designsafe.apps.onboarding.steps.system_access import SystemAccessStep +import pytest +import json +import os + + +@pytest.fixture +def tas_client(mocker): + with open( + os.path.join(settings.BASE_DIR, "designsafe/fixtures/tas/tas_project.json") + ) as f: + tas_project = json.load(f) + tas_client_mock = mocker.patch( + "designsafe.apps.onboarding.steps.project_membership.TASClient", autospec=True + ) + tas_client_mock.return_value.project.return_value = tas_project + tas_client_mock.return_value.projects_for_user.return_value = [tas_project] + yield tas_client_mock + + +@pytest.fixture +def mock_user_allocations(mocker): + yield mocker.patch( + "designsafe.apps.onboarding.steps.system_access.get_allocations", autospec=True + ) + + +@pytest.fixture +def system_access_step(settings, regular_user, tas_client, mock_user_allocations): + settings.PORTAL_USER_ACCOUNT_SETUP_STEPS = [ + { + "step": "designsafe.apps.onboarding.steps.system_access.SystemAccessStep", + "settings": { + "required_systems": [ + "stampede2.tacc.utexas.edu", + "ls5.tacc.utexas.edu", + ], + "project_sql_id": 12345, + }, + } + ] + step = SystemAccessStep(regular_user) + yield step + + +def test_not_has_required_systems(system_access_step, mock_user_allocations): + mock_user_allocations.return_value = {"hosts": {}} + assert not system_access_step.has_required_systems() diff --git a/designsafe/apps/onboarding/steps/system_access_v3.py b/designsafe/apps/onboarding/steps/system_access_v3.py new file mode 100644 index 0000000000..6d179f82ea --- /dev/null +++ b/designsafe/apps/onboarding/steps/system_access_v3.py @@ -0,0 +1,185 @@ +"""System Access Step for Onboarding.""" + +import logging +import requests +from requests.exceptions import HTTPError +from django.conf import settings +from tapipy.errors import ( + NotFoundError, + BaseTapyException, + ForbiddenError, + UnauthorizedError, +) +from designsafe.apps.onboarding.steps.abstract import AbstractStep +from designsafe.apps.onboarding.state import SetupState +from designsafe.utils.encryption import createKeyPair +from designsafe.apps.api.agave import get_service_account_client, get_tg458981_client +from designsafe.apps.api.tasks import agave_indexer +from designsafe.libs.common.decorators import retry + + +logger = logging.getLogger(__name__) + + +# retry for 5 minutes to account for allocation propagation +@retry(UnauthorizedError, tries=-1, max_time=5 * 60) +def create_system_credentials( # pylint: disable=too-many-arguments + client, + username, + public_key, + private_key, + system_id, + skipCredentialCheck=False, # pylint: disable=invalid-name + **kwargs, +) -> int: + """ + Set an RSA key pair as the user's auth credential on a Tapis system. + """ + logger.info(f"Creating user credential for {username} on Tapis system {system_id}") + data = {"privateKey": private_key, "publicKey": public_key} + client.systems.createUserCredential( + systemId=system_id, + userName=username, + skipCredentialCheck=skipCredentialCheck, + **data, + ) + + +def register_public_key( + username, publicKey, system_id # pylint: disable=invalid-name +) -> int: + """ + Push a public key to the Key Service API. + """ + url = "https://api.tacc.utexas.edu/keys/v2/" + username + headers = {"Authorization": f"Bearer {settings.KEY_SERVICE_TOKEN}"} + data = {"key_value": publicKey, "tags": [{"name": "system", "value": system_id}]} + response = requests.post(url, json=data, headers=headers, timeout=60) + response.raise_for_status() + return response.status_code + + +def set_user_permissions(user, system_id): + """Apply read/write/execute permissions to files and read permissions on the system.""" + logger.info(f"Adding {user.username} permissions to Tapis system {system_id}") + client = get_service_account_client() + client.systems.grantUserPerms( + systemId=system_id, userName=user.username, permissions=["READ"] + ) + client.files.grantPermissions( + systemId=system_id, path="/", username=user.username, permission="MODIFY" + ) + + +def create_path_and_permissions(system_id, path, username) -> None: + """Create a path and set permissions for a user on a system.""" + + tg458981_client = get_tg458981_client() + + # Create directory, resolves NotFoundError + tg458981_client.files.mkdir(systemId=system_id, path=path) + + # Set ACLs, resolves UnauthorizedError and ForbiddenError + tg458981_client.files.setFacl( + systemId=system_id, + path=path, + operation="ADD", + recursionMethod="PHYSICAL", + aclString=f"d:u:{username}:rwX,u:{username}:rwX,d:u:tg458981:rwX,u:tg458981:rwX,d:o::---,o::---,d:m::rwX,m::rwX", + ) + agave_indexer.apply_async( + kwargs={"systemId": system_id, "filePath": path, "recurse": False}, + queue="indexing", + ) + + +class SystemAccessStepV3(AbstractStep): + """System Access Step for Onboarding.""" + + def display_name(self): + return "System Access" + + def description(self): + return "Setting up access to TACC storage and execution systems. No action required." + + def prepare(self): + self.state = SetupState.PENDING + self.log("Awaiting TACC systems access.") + + # retry for 5 minutes to account for setfacl and allocation propagation + @retry(UnauthorizedError, tries=10, max_time=5 * 60) + def check_system(self, system_id, path="/", **kwargs) -> None: + """ + Check whether a user already has access to a storage system by attempting a listing. + """ + self.user.tapis_oauth.client.files.listFiles(systemId=system_id, path=path) + + def process(self): + self.log(f"Processing system access for user {self.user.username}") + for system in self.settings.get("access_systems") or []: + try: + set_user_permissions(self.user, system) + self.log(f"Successfully granted permissions for system: {system}") + except BaseTapyException as exc: + logger.error(exc) + self.fail(f"Failed to grant permissions for system: {system}") + + for system in self.settings.get("credentials_systems") or []: + try: + self.check_system(system, skip_retry=True) + self.log(f"Credentials already created for system: {system}") + continue + except BaseTapyException: + self.log(f"Creating credentials for system: {system}") + + (priv, pub) = createKeyPair() + + try: + register_public_key(self.user.username, pub, system) + self.log(f"Successfully registered public key for system: {system}") + except HTTPError as exc: + logger.error(exc) + self.fail( + f"Failed to register public key with key service for system: {system}" + ) + + try: + create_system_credentials( + self.user.tapis_oauth.client, self.user.username, pub, priv, system + ) + self.log(f"Successfully created credentials for system: {system}") + except BaseTapyException as exc: + logger.error(exc) + self.fail(f"Failed to create credentials for system: {system}") + + for system in self.settings.get("create_path_systems") or []: + system_id = system["system_id"] + path = system["path"].format(username=self.user.username) + try: + self.check_system(system_id, path, skip_retry=True) + self.log( + f"Path and permissions already created for system: {system_id} and path: {path} for user: {self.user.username}" + ) + continue + except (NotFoundError, ForbiddenError, UnauthorizedError): + logger.info( + "Ensuring directory exists for user=%s then going to run setfacl on system=%s path=%s", + self.user.username, + system_id, + path, + ) + self.log(f"Creating directory tapis://{system_id}/{path} for user") + + create_path_and_permissions(system_id, path, self.user.username) + + # Check if the path with permissions was created successfully + self.check_system(system_id, path) + + except BaseTapyException as exc: + logger.error(exc) + self.fail( + f"Failed to create path and permissions for system:{system} path:{path} for {self.user.username}" + ) + + if self.state != SetupState.FAILED: + self.complete("User is processed.") diff --git a/designsafe/apps/onboarding/steps/test_steps.py b/designsafe/apps/onboarding/steps/test_steps.py new file mode 100644 index 0000000000..7447c0cc98 --- /dev/null +++ b/designsafe/apps/onboarding/steps/test_steps.py @@ -0,0 +1,160 @@ +from mock import MagicMock +from designsafe.apps.onboarding.state import SetupState +from designsafe.apps.onboarding.steps.abstract import AbstractStep + + +class MockStep(AbstractStep): + """ + Fixture for testing AbstractStep, that + simply calls spy methods + """ + + def __init__(self, user): + self.prepare_spy = MagicMock() + super().__init__(user) + + def display_name(self): + return "Mock Step" + + def description(self): + return "Long description for a mock step" + + def prepare(self): + self.prepare_spy() + + +class MockProcessingCompleteStep(AbstractStep): + """ + Fixture for testing automated processing steps that complete successfully + """ + + def __init__(self, user): + super().__init__(user) + self.process_spy = MagicMock() + + def prepare(self): + self.state = SetupState.PENDING + self.log("Pending") + + def display_name(self): + return "Mock Processing Complete Step" + + def description(self): + return "Long description of a mock step that automatically processes then completes" + + def process(self): + self.complete("Completed") + self.process_spy() + + +class MockProcessingFailStep(AbstractStep): + """ + Fixture for testing automated processing steps that fail + """ + + def __init__(self, user): + super().__init__(user) + self.process_spy = MagicMock() + + def prepare(self): + self.state = SetupState.PENDING + self.log("Pending") + + def display_name(self): + return "Mock Processing Fail Step" + + def description(self): + return "Long description of a mock step that automatically processes then fails" + + def process(self): + self.fail("Failure") + self.process_spy() + + +class MockUserStep(AbstractStep): + """ + Fixture for testing steps that block for client action + from the user + """ + + def __init__(self, user): + super().__init__(user) + self.client_action_spy = MagicMock() + + def prepare(self): + self.state = SetupState.USERWAIT + self.log("Waiting for user") + + def display_name(self): + return "Mock User Wait Step" + + def description(self): + return "Long description of a mock step that waits for user interaction" + + def client_action(self, action, data, request): + if action == "user_confirm" and request.user is self.user: + self.complete("Complete") + self.client_action_spy(action, data, request) + + +class MockStaffStep(AbstractStep): + """ + Fixture for testing AbstractStaffSteps + """ + + def __init__(self, user): + super().__init__(user) + self.staff_approve_spy = MagicMock() + self.staff_deny_spy = MagicMock() + + def prepare(self): + self.state = SetupState.STAFFWAIT + self.log("Waiting for staff") + + def display_name(self): + return "Mock Staff Wait Step" + + def description(self): + return "Long description of a mock step that waits for staff approval or denial" + + def client_action(self, action, data, request): + if not request.user.is_staff: + return + + if action == "staff_approve": + self.complete("Approved by {user}".format(user=request.user.username)) + self.staff_approve_spy(action, data, request) + elif action == "staff_deny": + self.fail("Denied by {user}".format(user=request.user.username)) + self.staff_deny_spy(action, data, request) + + +class MockErrorStep(AbstractStep): + """ + Fixture for testing steps that generate exceptions + """ + + def __init__(self, user): + super().__init__(user) + + def prepare(self): + self.state = SetupState.PENDING + self.log("Pending") + + def display_name(self): + return "Mock Error Step" + + def description(self): + return "Long description of a mock step that results in error upon processing" + + def process(self): + raise Exception("MockErrorStep") + + +class MockInvalidStepClass: + def __init__(self, user): + pass + + +def mock_invalid_step_function(): + pass diff --git a/designsafe/apps/onboarding/templates/designsafe/apps/onboarding/index.j2 b/designsafe/apps/onboarding/templates/designsafe/apps/onboarding/index.j2 new file mode 100644 index 0000000000..6da365c964 --- /dev/null +++ b/designsafe/apps/onboarding/templates/designsafe/apps/onboarding/index.j2 @@ -0,0 +1,24 @@ +{% extends "base_angular.html" %} +{% load cms_tags static sekizai_tags%} +{% block title %}Onboarding{% endblock %} +{% block content %} + +
    + +{% addtoblock "react_assets" %} +{% if debug and react_flag %} + + + +{% else %} +{% include "react-assets.html" %} +{% endif %} +{% endaddtoblock %} + +{% endblock %} diff --git a/designsafe/apps/onboarding/urls.py b/designsafe/apps/onboarding/urls.py new file mode 100644 index 0000000000..a5554205b9 --- /dev/null +++ b/designsafe/apps/onboarding/urls.py @@ -0,0 +1,10 @@ +"""URLs for the Onboarding app.""" + +from django.urls import re_path, path +from designsafe.apps.onboarding.views import OnboardingView + +app_name = "workbench" +urlpatterns = [ + re_path("^", OnboardingView.as_view(), name="user"), + path("admin", OnboardingView.as_view(), name="admin"), +] diff --git a/designsafe/apps/onboarding/views.py b/designsafe/apps/onboarding/views.py new file mode 100644 index 0000000000..e86da1e4df --- /dev/null +++ b/designsafe/apps/onboarding/views.py @@ -0,0 +1,18 @@ +"""Views for Onboarding""" + +from django.views.generic.base import TemplateView +from django.utils.decorators import method_decorator +from django.views.decorators.csrf import ensure_csrf_cookie +from django.contrib.auth.decorators import login_required + + +@method_decorator(login_required, name="dispatch") +class OnboardingView(TemplateView): + """Onboarding View""" + + template_name = "designsafe/apps/onboarding/index.html" + + @method_decorator(ensure_csrf_cookie) + def dispatch(self, request, *args, **kwargs): + """Overwrite dispatch to ensure csrf cookie""" + return super().dispatch(request, *args, **kwargs) diff --git a/designsafe/apps/signals/websocket_consumers.py b/designsafe/apps/signals/websocket_consumers.py index 2353bad28e..d762a13aff 100644 --- a/designsafe/apps/signals/websocket_consumers.py +++ b/designsafe/apps/signals/websocket_consumers.py @@ -1,28 +1,37 @@ -import json +"""Websocket consumers""" -from channels.generic.websocket import WebsocketConsumer, AsyncWebsocketConsumer +import json +from channels.generic.websocket import AsyncWebsocketConsumer +from channels.layers import get_channel_layer class DesignsafeWebsocketConsumer(AsyncWebsocketConsumer): + """Websocket consumer for DesignSafe notifications""" + async def connect(self): - self.user_channel = f"ds_{self.scope['user']}" - self.broadcast_channel = "ds_broadcast" await self.channel_layer.group_add( - self.user_channel, self.channel_name + f"ds_{self.scope['user']}", self.channel_name ) await self.accept() - async def disconnect(self, close_code): - await self.channel_layer.group_discard( - self.user_channel, self.channel_name - ) + async def disconnect(self, code): await self.channel_layer.group_discard( - self.broadcast_channel, self.channel_name + f"ds_{self.scope['user']}", self.channel_name ) + await self.channel_layer.group_discard("ds_broadcast", self.channel_name) - async def receive(self, text_data): - pass + async def receive(self, text_data=None, bytes_data=None): + if text_data == "markAllNotificationsAsRead": + channel_layer = get_channel_layer() + await channel_layer.group_send( + f"ds_{self.scope['user']}", + { + "type": "ds_notification", + "message": json.dumps({"event_type": "markAllNotificationsAsRead"}), + }, + ) async def ds_notification(self, event): + """Send notification to user""" message = event["message"] await self.send(text_data=message) diff --git a/designsafe/apps/webhooks/views.py b/designsafe/apps/webhooks/views.py index 389289e54c..47b6bfd694 100644 --- a/designsafe/apps/webhooks/views.py +++ b/designsafe/apps/webhooks/views.py @@ -173,7 +173,6 @@ def post(self, request, *args, **kwargs): Notification.EVENT_TYPE: event_type, Notification.STATUS: Notification.INFO, Notification.USER: job_owner, - Notification.MESSAGE: "Ready to view.", Notification.ACTION_LINK: address, } diff --git a/designsafe/apps/workspace/api/views.py b/designsafe/apps/workspace/api/views.py index c6bdf76acd..f8e38339c3 100644 --- a/designsafe/apps/workspace/api/views.py +++ b/designsafe/apps/workspace/api/views.py @@ -5,14 +5,13 @@ import logging import json +from urllib.parse import urlparse from django.http import JsonResponse from django.conf import settings from django.core.exceptions import ObjectDoesNotExist from django.db.models import F, Count from django.db.models.lookups import GreaterThan -from django.contrib.auth import get_user_model from django.urls import reverse -from pytas.http import TASClient from tapipy.errors import InternalServerError, UnauthorizedError from designsafe.apps.api.exceptions import ApiException from designsafe.apps.api.users.utils import get_user_data @@ -25,7 +24,7 @@ AppTrayCategory, AppVariant, ) -from designsafe.apps.workspace.models.allocations import UserAllocations +from designsafe.apps.api.users.utils import get_allocations from designsafe.apps.workspace.api.utils import check_job_for_timeout @@ -113,61 +112,6 @@ def _get_app(app_id, app_version, user): return data -def _get_tas_allocations(username): - """Returns user allocations on TACC resources - - : returns: allocations - : rtype: dict - """ - - tas_client = TASClient( - baseURL=settings.TAS_URL, - credentials={ - "username": settings.TAS_CLIENT_KEY, - "password": settings.TAS_CLIENT_SECRET, - }, - ) - tas_projects = tas_client.projects_for_user(username) - - with open( - "designsafe/apps/workspace/api/tas_to_tacc_resources.json", encoding="utf-8" - ) as file: - tas_to_tacc_resources = json.load(file) - - hosts = {} - - for tas_proj in tas_projects: - # Each project from tas has an array of length 1 for its allocations - alloc = tas_proj["allocations"][0] - charge_code = tas_proj["chargeCode"] - if alloc["resource"] in tas_to_tacc_resources: - resource = dict(tas_to_tacc_resources[alloc["resource"]]) - resource["allocation"] = dict(alloc) - - # Separate active and inactive allocations and make single entry for each project - if resource["allocation"]["status"] == "Active": - if ( - resource["host"] in hosts - and charge_code not in hosts[resource["host"]] - ): - hosts[resource["host"]].append(charge_code) - elif resource["host"] not in hosts: - hosts[resource["host"]] = [charge_code] - return { - "hosts": hosts, - } - - -def _get_latest_allocations(username): - """ - Creates or updates allocations cache for a given user and returns new allocations - """ - user = get_user_model().objects.get(username=username) - allocations = _get_tas_allocations(username) - UserAllocations.objects.update_or_create(user=user, defaults={"value": allocations}) - return allocations - - def test_system_needs_keys(tapis, system_id): """Tests a Tapis system by making a file listing call. @@ -231,7 +175,7 @@ def get(self, request, *args, **kwargs): extra={ "user": request.user.username, "sessionId": getattr(request.session, "session_key", ""), - "operation": "getAppsView", + "operation": "getApp", "agent": request.META.get("HTTP_USER_AGENT"), "ip": get_client_ip(request), "info": {"query": request.GET.dict()}, @@ -511,7 +455,7 @@ def get(self, request, *args, **kwargs): extra={ "user": request.user.username, "sessionId": getattr(request.session, "session_key", ""), - "operation": "getAppsTrayView", + "operation": "getApps", "agent": request.META.get("HTTP_USER_AGENT"), "ip": get_client_ip(request), "info": {"query": request.GET.dict()}, @@ -589,7 +533,6 @@ def get(self, request, operation=None): extra={ "user": request.user.username, "sessionId": getattr(request.session, "session_key", ""), - "view": "JobsView", "operation": operation, "agent": request.META.get("HTTP_USER_AGENT"), "ip": get_client_ip(request), @@ -694,7 +637,6 @@ def delete(self, request, *args, **kwargs): extra={ "user": request.user.username, "sessionId": getattr(request.session, "session_key", ""), - "view": "JobsView", "operation": "delete", "agent": request.META.get("HTTP_USER_AGENT"), "ip": get_client_ip(request), @@ -725,9 +667,9 @@ def _submit_job(self, request, body, tapis, username): if not job_post.get("archiveSystemId"): job_post["archiveSystemId"] = settings.AGAVE_STORAGE_SYSTEM if not job_post.get("archiveSystemDir"): - job_post[ - "archiveSystemDir" - ] = f"{username}/tapis-jobs-archive/${{JobCreateDate}}/${{JobName}}-${{JobUUID}}" + job_post["archiveSystemDir"] = ( + f"{username}/tapis-jobs-archive/${{JobCreateDate}}/${{JobName}}-${{JobUUID}}" + ) # Check for and set license environment variable if app requires one lic_type = body.get("licenseType") @@ -758,14 +700,18 @@ def _submit_job(self, request, body, tapis, username): return {"execSys": system_needs_keys} if settings.DEBUG: - wh_base_url = settings.WEBHOOK_POST_URL + reverse( + parsed_url = urlparse(settings.NGROK_DOMAIN) + if not parsed_url.scheme: + webhook_base_url = f"https://{settings.NGROK_DOMAIN}" + else: + webhook_base_url = settings.NGROK_DOMAIN + + interactive_wh_url = webhook_base_url + reverse( "webhooks:interactive_wh_handler" ) - jobs_wh_url = settings.WEBHOOK_POST_URL + reverse( - "webhooks:jobs_wh_handler" - ) + jobs_wh_url = webhook_base_url + reverse("webhooks:jobs_wh_handler") else: - wh_base_url = request.build_absolute_uri( + interactive_wh_url = request.build_absolute_uri( reverse("webhooks:interactive_wh_handler") ) jobs_wh_url = request.build_absolute_uri( @@ -785,7 +731,7 @@ def _submit_job(self, request, body, tapis, username): projects = request.user.projects.order_by("-last_updated") entry["value"] = " ".join( f"{project.uuid},{project.value['projectId'] if project.value['projectId'] != 'None' else project.uuid}" - for project in projects[:settings.USER_PROJECTS_LIMIT] + for project in projects[: settings.USER_PROJECTS_LIMIT] ) job_post["parameterSet"]["envVariables"] = env_variables break @@ -795,7 +741,7 @@ def _submit_job(self, request, body, tapis, username): # Add webhook URL environment variable for interactive apps job_post["parameterSet"]["envVariables"] = job_post["parameterSet"].get( "envVariables", [] - ) + [{"key": "_INTERACTIVE_WEBHOOK_URL", "value": wh_base_url}] + ) + [{"key": "_INTERACTIVE_WEBHOOK_URL", "value": interactive_wh_url}] job_post["tags"].append("isInteractive") # Make sure $HOME/.tap directory exists for user when running interactive apps on TACC HPC Systems @@ -843,19 +789,6 @@ def post(self, request, *args, **kwargs): status=400, ) - METRICS.info( - "Jobs", - extra={ - "user": username, - "sessionId": getattr(request.session, "session_key", ""), - "view": "JobsView", - "operation": operation, - "agent": request.META.get("HTTP_USER_AGENT"), - "ip": get_client_ip(request), - "info": {"body": body}, - }, - ) - if operation != "submitJob": job_uuid = body.get("uuid") if job_uuid is None: @@ -864,18 +797,26 @@ def post(self, request, *args, **kwargs): status=400, ) tapis_operation = getattr(tapis.jobs, operation) - data = tapis_operation(jobUuid=job_uuid) + response = tapis_operation(jobUuid=job_uuid) - return JsonResponse( - { - "status": 200, - "response": data, - }, - encoder=BaseTapisResultSerializer, - ) + else: + # submit job + response = self._submit_job(request, body, tapis, username) - # submit job - response = self._submit_job(request, body, tapis, username) + METRICS.info( + "Jobs", + extra={ + "user": username, + "sessionId": getattr(request.session, "session_key", ""), + "operation": operation, + "agent": request.META.get("HTTP_USER_AGENT"), + "ip": get_client_ip(request), + "info": { + "body": body, + "response": response.__dict__ if response else None, + }, + }, + ) return JsonResponse( { @@ -889,37 +830,13 @@ def post(self, request, *args, **kwargs): class AllocationsView(AuthenticatedApiView): """Allocations API View""" - def _get_allocations(self, user, force=False): - """ - Returns indexed allocation data stored in Django DB, or fetches - allocations from TAS and stores them. - Parameters - ---------- - username: str - TACC username to fetch allocations for. - Returns - ------- - dict - """ - username = user.username - try: - if force: - logger.info(f"Forcing TAS allocation retrieval for user:{username}") - raise ObjectDoesNotExist - result = {"hosts": {}} - result.update(UserAllocations.objects.get(user=user).value) - return result - except ObjectDoesNotExist: - # Fall back to getting allocations from TAS - return _get_latest_allocations(username) - def get(self, request): """Returns active user allocations on TACC resources : returns: {'response': {'active': allocations, 'portal_alloc': settings.PORTAL_ALLOCATION, 'inactive': inactive, 'hosts': hosts}} : rtype: dict """ - data = self._get_allocations(request.user) + data = get_allocations(request.user) # Exclude allocation based on allocation setting list. for host, allocations in data["hosts"].items(): data["hosts"][host] = [ diff --git a/designsafe/apps/workspace/models/app_entries.py b/designsafe/apps/workspace/models/app_entries.py index f8cf2938ae..1477572aff 100644 --- a/designsafe/apps/workspace/models/app_entries.py +++ b/designsafe/apps/workspace/models/app_entries.py @@ -233,8 +233,8 @@ def href(self): """Retrieve the app's URL in the Tools & Applications space""" if self.external_href: return self.external_href - - app_href = f"/rw/workspace/{self.app_id}" + + app_href = f"/workspace/{self.app_id}" if self.version: app_href += f"?appVersion={self.version}" return app_href diff --git a/designsafe/apps/workspace/urls.py b/designsafe/apps/workspace/urls.py index 362316ed6a..00cc09812a 100644 --- a/designsafe/apps/workspace/urls.py +++ b/designsafe/apps/workspace/urls.py @@ -4,5 +4,6 @@ from designsafe.apps.workspace import views urlpatterns = [ + re_path('history', views.WorkspaceView.as_view(), name="history"), re_path('^', views.WorkspaceView.as_view(), name="workspace"), ] diff --git a/designsafe/celery.py b/designsafe/celery.py index f17916f129..3bfa860ef0 100644 --- a/designsafe/celery.py +++ b/designsafe/celery.py @@ -31,7 +31,7 @@ 'schedule': crontab(minute=0, hour=0), }, 'reindex_projects': { - 'task': 'designsafe.apps.api.tasks.reindex_projects', + 'task': 'designsafe.apps.api.projects_v2.tasks.reindex_projects_async', 'schedule': crontab(hour=0, minute=0) }, 'clear_old_notifications': { diff --git a/designsafe/conftest.py b/designsafe/conftest.py index d32b49dc54..603bd2be35 100644 --- a/designsafe/conftest.py +++ b/designsafe/conftest.py @@ -6,6 +6,7 @@ from unittest.mock import patch from django.conf import settings from designsafe.apps.auth.models import TapisOAuthToken +from designsafe.apps.accounts.models import DesignSafeProfile @pytest.fixture @@ -24,7 +25,7 @@ def regular_user(django_user_model, mock_tapis_client): password="password", first_name="Firstname", last_name="Lastname", - email="user@user.com", + email="user@designsafe-ci.org", ) user = django_user_model.objects.get(username="username") TapisOAuthToken.objects.create( @@ -34,6 +35,7 @@ def regular_user(django_user_model, mock_tapis_client): expires_in=14400, created=1523633447, ) + DesignSafeProfile.objects.create(user=user) yield user @@ -41,12 +43,12 @@ def regular_user(django_user_model, mock_tapis_client): @pytest.fixture def regular_user_using_jwt(regular_user, client): """Fixture for regular user who is using jwt for authenticated requests""" - with patch('designsafe.apps.api.decorators.Tapis') as mock_tapis: + with patch("designsafe.apps.api.decorators.Tapis") as mock_tapis: # Mock the Tapis's validate_token method within the tapis_jwt_login decorator mock_validate_token = mock_tapis.return_value.validate_token mock_validate_token.return_value = {"tapis/username": regular_user.username} - client.defaults['HTTP_X_TAPIS_TOKEN'] = 'fake_token_string' + client.defaults["HTTP_X_TAPIS_TOKEN"] = "fake_token_string" yield client @@ -80,3 +82,26 @@ def tapis_tokens_create_mock(): "r", ) ) + + +@pytest.fixture +def staff_user(django_user_model, mock_tapis_client): + django_user_model.objects.create_user(username="staff", password="password") + user = django_user_model.objects.get(username="staff") + user.is_staff = True + user.save() + TapisOAuthToken.objects.create( + user=user, + access_token="1234fsf", + refresh_token="123123123", + expires_in=14400, + created=1523633447, + ) + DesignSafeProfile.objects.create(user=user) + yield user + + +@pytest.fixture +def authenticated_staff(client, staff_user): + client.force_login(staff_user) + return staff_user diff --git a/designsafe/fixtures/tas/tas_add_user_to_project.json b/designsafe/fixtures/tas/tas_add_user_to_project.json new file mode 100644 index 0000000000..5e213e4631 --- /dev/null +++ b/designsafe/fixtures/tas/tas_add_user_to_project.json @@ -0,0 +1,68 @@ +{ + "status": "success", + "message": null, + "result": { + "id": 11111, + "title": "My Test Project", + "description": "A test project for allocations requests.", + "chargeCode": "My-Test-Project", + "gid": 22222, + "source": null, + "fieldId": 92, + "field": "Software Development", + "typeId": 2, + "type": "Startup", + "piId": 333333, + "pi": { + "id": 333333, + "username": "username", + "email": "username@something.com", + "firstName": "First", + "lastName": "Last", + "institution": "University of Texas at Austin (UT) (UT Austin)", + "institutionId": 1, + "department": null, + "departmentId": 0, + "country": "United States", + "countryId": 230, + "citizenship": "United States", + "citizenshipId": 230, + "piEligibility": "Eligible", + "source": "Standard", + "phone": "512123456", + "title": "Center Non-Researcher Staff", + "uid": 444444, + "homeDirectory": "01234/username", + "gid": 555555, + "emailConfirmations": [] + }, + "allocations": [ + { + "id": 66666, + "start": "2021-08-24T05:00:00Z", + "end": "2021-12-31T06:00:00Z", + "status": "Active", + "justification": "Admin-created allocation.", + "decisionSummary": "created test allocation for TACC staff", + "dateRequested": "2021-08-24T21:10:11Z", + "dateReviewed": "2021-08-24T21:10:11Z", + "computeRequested": 500, + "computeAllocated": 500, + "storageRequested": 0, + "storageAllocated": 0, + "memoryRequested": 0, + "memoryAllocated": 0, + "resourceId": 56, + "resource": "Frontera", + "projectId": 42237, + "project": "My-Test-Project", + "requestorId": 333333, + "requestor": "User Name", + "reviewerId": 0, + "reviewer": null, + "computeUsed": 0.0 + } + ], + "nickname": null + } +} \ No newline at end of file diff --git a/designsafe/fixtures/tas/tas_add_user_to_project_error.json b/designsafe/fixtures/tas/tas_add_user_to_project_error.json new file mode 100644 index 0000000000..5764bcd246 --- /dev/null +++ b/designsafe/fixtures/tas/tas_add_user_to_project_error.json @@ -0,0 +1,5 @@ +{ + "status": "error", + "message": "Cannot add user. User username is already a member of project 42237", + "result": null +} \ No newline at end of file diff --git a/designsafe/fixtures/tas/tas_delete_user_from_project.json b/designsafe/fixtures/tas/tas_delete_user_from_project.json new file mode 100644 index 0000000000..24916e8593 --- /dev/null +++ b/designsafe/fixtures/tas/tas_delete_user_from_project.json @@ -0,0 +1,68 @@ +{ + "status": "success", + "message": null, + "result": { + "id": 11111, + "title": "My Test Project", + "description": "A test project for allocations requests.", + "chargeCode": "My-Test-Project", + "gid": 22222, + "source": null, + "fieldId": 92, + "field": "Software Development", + "typeId": 2, + "type": "Startup", + "piId": 333333, + "pi": { + "id": 333333, + "username": "username", + "email": "username@something.com", + "firstName": "First", + "lastName": "Last", + "institution": "University of Texas at Austin (UT) (UT Austin)", + "institutionId": 1, + "department": null, + "departmentId": 0, + "country": "United States", + "countryId": 230, + "citizenship": "United States", + "citizenshipId": 230, + "piEligibility": "Eligible", + "source": "Standard", + "phone": "512123456", + "title": "Center Non-Researcher Staff", + "uid": 444444, + "homeDirectory": "01234/username", + "gid": 555555, + "emailConfirmations": [] + }, + "allocations": [ + { + "id": 66666, + "start": "2021-08-24T05:00:00Z", + "end": "2021-12-31T06:00:00Z", + "status": "Active", + "justification": "Admin-created allocation.", + "decisionSummary": "created test allocation for TACC staff", + "dateRequested": "2021-08-24T21:10:11Z", + "dateReviewed": "2021-08-24T21:10:11Z", + "computeRequested": 500, + "computeAllocated": 500, + "storageRequested": 0, + "storageAllocated": 0, + "memoryRequested": 0, + "memoryAllocated": 0, + "resourceId": 56, + "resource": "Frontera", + "projectId": 42237, + "project": "My-Test-Project", + "requestorId": 333333, + "requestor": "User Name", + "reviewerId": 0, + "reviewer": null, + "computeUsed": 0.0 + } + ], + "nickname": null + } +} \ No newline at end of file diff --git a/designsafe/fixtures/tas/tas_delete_user_from_project_error.json b/designsafe/fixtures/tas/tas_delete_user_from_project_error.json new file mode 100644 index 0000000000..5764bcd246 --- /dev/null +++ b/designsafe/fixtures/tas/tas_delete_user_from_project_error.json @@ -0,0 +1,5 @@ +{ + "status": "error", + "message": "Cannot add user. User username is already a member of project 42237", + "result": null +} \ No newline at end of file diff --git a/designsafe/fixtures/tas/tas_project.json b/designsafe/fixtures/tas/tas_project.json new file mode 100644 index 0000000000..ba80e3412b --- /dev/null +++ b/designsafe/fixtures/tas/tas_project.json @@ -0,0 +1,64 @@ +{ + "id": 12345, + "title": "WMA-Stampede2-Test", + "description": "Project Description", + "chargeCode": "WMA-Stampede2-Test", + "gid": 123456, + "source": null, + "fieldId": 76, + "field": "Software Engineering", + "typeId": 2, + "type": "Startup", + "piId": 123456, + "pi": { + "id": 123456, + "username": "pi_username", + "email": "pi_username@email.com", + "firstName": "First", + "lastName": "Last", + "institution": "University of Texas at Austin", + "institutionId": 1, + "department": "Texas Advanced Computing Center", + "departmentId": 127, + "country": "United States", + "countryId": 230, + "citizenship": "United States", + "citizenshipId": 230, + "piEligibility": "Eligible", + "source": "Standard", + "phone": "1234567890", + "title": "Center Non-Researcher Staff", + "uid": 123456, + "homeDirectory": "12345/pi_username", + "gid": 123456, + "emailConfirmations": [] + }, + "allocations": [ + { + "id": 60643, + "start": "2018-10-23T05:00:00Z", + "end": "2019-03-31T05:00:00Z", + "status": "Inactive", + "justification": "Project Justification", + "decisionSummary": "Decision Summary", + "dateRequested": "2018-10-23T15:39:39Z", + "dateReviewed": "2018-10-23T17:06:32Z", + "computeRequested": 100, + "computeAllocated": 100, + "storageRequested": 0, + "storageAllocated": 0, + "memoryRequested": 0, + "memoryAllocated": 0, + "resourceId": 49, + "resource": "Stampede4", + "projectId": 39726, + "project": "WMA-Stampede2-Test", + "requestorId": 171476, + "requestor": "pi_username", + "reviewerId": 0, + "reviewer": null, + "computeUsed": 0 + } + ], + "nickname": null +} \ No newline at end of file diff --git a/designsafe/fixtures/tas/tas_project_users.json b/designsafe/fixtures/tas/tas_project_users.json new file mode 100644 index 0000000000..af3e657eb7 --- /dev/null +++ b/designsafe/fixtures/tas/tas_project_users.json @@ -0,0 +1,26 @@ +[ + { + "email": "pi_user@username.com", + "firstName": "PILastname", + "id": 1234567, + "lastName": "PIFirstname", + "role": "PI", + "username": "username" + }, + { + "email": "deleage_user@username.com", + "firstName": "DelegateLastname", + "id": 123456, + "lastName": "DelegateFirstname", + "role": "Delegate", + "username": "username" + }, + { + "email": "user@username.com", + "firstName": "Lastname", + "id": 12345, + "lastName": "Firstname", + "role": "Standard", + "username": "username" + } +] \ No newline at end of file diff --git a/designsafe/fixtures/tas/tas_user.json b/designsafe/fixtures/tas/tas_user.json new file mode 100644 index 0000000000..b1c59bc4d9 --- /dev/null +++ b/designsafe/fixtures/tas/tas_user.json @@ -0,0 +1,23 @@ +{ + "id": 123456, + "username": "username", + "email": "user@username.com", + "firstName": "Firstname", + "lastName": "Lastname", + "institution": "University of Texas at Austin", + "institutionId": 1, + "department": "Texas Advanced Computing Center", + "departmentId": 127, + "country": "United States", + "countryId": 230, + "citizenship": "United States", + "citizenshipId": 230, + "piEligibility": "Eligible", + "source": "Standard", + "phone": "5125125125", + "title": "Center Non-Researcher Staff", + "uid": 123456, + "homeDirectory": "01234/username", + "gid": 456789, + "emailConfirmations": [] +} \ No newline at end of file diff --git a/designsafe/fixtures/tas/tas_user_with_underscore.json b/designsafe/fixtures/tas/tas_user_with_underscore.json new file mode 100644 index 0000000000..f8419ecad4 --- /dev/null +++ b/designsafe/fixtures/tas/tas_user_with_underscore.json @@ -0,0 +1,23 @@ +{ + "id": 123456, + "username": "user_name", + "email": "user_name@username.com", + "firstName": "Firstname2", + "lastName": "Lastname2", + "institution": "University of Texas at Austin", + "institutionId": 1, + "department": "Texas Advanced Computing Center", + "departmentId": 127, + "country": "United States", + "countryId": 230, + "citizenship": "United States", + "citizenshipId": 230, + "piEligibility": "Eligible", + "source": "Standard", + "phone": "5125125125", + "title": "Center Non-Researcher Staff", + "uid": 123456, + "homeDirectory": "01234/user_name", + "gid": 456789, + "emailConfirmations": [] +} \ No newline at end of file diff --git a/designsafe/fixtures/user-data.json b/designsafe/fixtures/user-data.json index 5d1cb1c5db..534603d667 100644 --- a/designsafe/fixtures/user-data.json +++ b/designsafe/fixtures/user-data.json @@ -99,5 +99,13 @@ }, "model": "designsafe_accounts.notificationpreferences", "pk": 1 + }, + { + "model": "designsafe_accounts.designsafeprofile", + "pk": 1, + "fields": { + "user": 1, + "setup_complete": true + } } ] diff --git a/designsafe/libs/common/decorators.py b/designsafe/libs/common/decorators.py index d02a15d4eb..ca964af780 100644 --- a/designsafe/libs/common/decorators.py +++ b/designsafe/libs/common/decorators.py @@ -24,33 +24,35 @@ def new_func(*args, **kwargs): warnings.warn( "Call to deprecated function {}.".format(func.__name__), category=DeprecationWarning, - stacklevel=2 + stacklevel=2, ) return func(*args, **kwargs) + return new_func + def profile(func): @functools.wraps(func) def decorated_function(*args, **kwargs): - if getattr(settings, 'PORTAL_PROFILE', False): + if getattr(settings, "PORTAL_PROFILE", False): prf = cProfile.Profile() prf.enable() resp = func(*args, **kwargs) prf.disable() - stats_dirpath = os.path.join(os.path.dirname(__file__), '../../../stats') + stats_dirpath = os.path.join(os.path.dirname(__file__), "../../../stats") spec = inspect.getargspec(func) - if spec.args and spec.args[0] == 'self': + if spec.args and spec.args[0] == "self": _self = args[0] clsname = _self.__class__.__name__ modulename = _self.__module__ funcname = func.__name__ - filename = '{}.{}.{}'.format(modulename, clsname, funcname) + filename = "{}.{}.{}".format(modulename, clsname, funcname) request = args[1] else: modulename = func.__module__ funcname = func.__name__ - filename = '{}.{}'.format(modulename, funcname) + filename = "{}.{}".format(modulename, funcname) request = args[0] filename = re.sub(r"[^a-zA-Z0-9\_\-]", "_", filename) @@ -59,15 +61,15 @@ def decorated_function(*args, **kwargs): if not os.path.isdir(stats_dirpath): os.mkdir(stats_dirpath) - if os.path.isfile(filepath + '.stats'): - filename += '_{}'.format(str(time.time())) + if os.path.isfile(filepath + ".stats"): + filename += "_{}".format(str(time.time())) filepath = os.path.join(stats_dirpath, filename) - filepath_prof = filepath + '.prof' - filepath_stats = filepath + '.stats' + filepath_prof = filepath + ".prof" + filepath_stats = filepath + ".stats" prf.dump_stats(filepath_prof) - with open(filepath_stats, 'w+') as flo: + with open(filepath_stats, "w+") as flo: if isinstance(request, HttpRequest): flo.write( """Request path: {path} @@ -76,9 +78,10 @@ def decorated_function(*args, **kwargs): """.format( path=request.path, post=request.POST.dict(), - get=request.GET.dict()) + get=request.GET.dict(), ) - prfs = pstats.Stats(prf, stream=flo).sort_stats('cumtime') + ) + prfs = pstats.Stats(prf, stream=flo).sort_stats("cumtime") prfs.print_stats() else: resp = func(*args, **kwargs) @@ -86,3 +89,48 @@ def decorated_function(*args, **kwargs): return resp return decorated_function + + +def retry(exc: Exception, tries=4, delay=3, backoff=2, max_time=10 * 60): + """ + A decorator that retries a function call with exponential backoff in case of an exception. + + Note: Pass skip_retry=True to the function to skip the retry logic. + + Args: + exc (Exception): The exception to catch and retry on. + tries (int, optional): The maximum number of attempts. Defaults to 4. + delay (int, optional): The initial delay between retries in seconds. Defaults to 3. + backoff (int, optional): The multiplier applied to the delay after each retry. Defaults to 2. + max_time (int, optional): The maximum time to retry in seconds. Defaults to 10*60 == 10 minutes. + + Returns: + function: A decorator that wraps the function with retry logic. + + Example: + @retry(ValueError, tries=3, delay=2, backoff=2, max_time=5*60) + def test_function(): + # function implementation + """ + + def deco_retry(func): + + @functools.wraps(func) + def f_retry(*args, **kwargs): + if kwargs.get("skip_retry"): + return func(*args, **kwargs) + mtries, mdelay, mmax_time = tries, delay, max_time + while mtries and mmax_time > 0: + try: + return func(*args, **kwargs) + except exc: + logger.warning(f"{str(exc)}, Retrying in {mdelay} seconds...") + time.sleep(mdelay) + mtries -= 1 + mdelay *= backoff + mmax_time -= mdelay + return func(*args, **kwargs) + + return f_retry + + return deco_retry diff --git a/designsafe/middleware.py b/designsafe/middleware.py index 0f2a5e7387..266103d53f 100644 --- a/designsafe/middleware.py +++ b/designsafe/middleware.py @@ -30,7 +30,7 @@ class DesignsafeProfileUpdateMiddleware(MiddlewareMixin): def process_request(self, request): blocked_path = request.path.startswith( - ("/data", "/applications", "/rw/workspace", "/recon-portal", "/dashboard") + ("/data", "/applications", "/rw/workspace", "/workspace", "/recon-portal", "/dashboard") ) if request.user.is_authenticated and request.user.profile.update_required and blocked_path: messages.warning( @@ -65,7 +65,7 @@ def process_request(self, request): 'Use is required for continued use of DesignSafe ' 'resources.' % accept_url) return None - + class SiteMessageMiddleware(MiddlewareMixin): def process_request(self, request): diff --git a/designsafe/settings/celery_settings.py.orig b/designsafe/settings/celery_settings.py.orig deleted file mode 100644 index 1b4e976f5d..0000000000 --- a/designsafe/settings/celery_settings.py.orig +++ /dev/null @@ -1,48 +0,0 @@ -""" -# Celery settings -""" -import os -from kombu import Exchange, Queue -#BROKER_URL = 'redis://redis:6379/0' -BROKER_URL_PROTOCOL = os.environ.get('BROKER_URL_PROTOCOL', 'amqp://') -BROKER_URL_USERNAME = os.environ.get('BROKER_URL_USERNAME', 'username') -BROKER_URL_PWD = os.environ.get('BROKER_URL_PWD', 'pwd') -BROKER_URL_HOST = os.environ.get('BROKER_URL_HOST', 'localhost') -BROKER_URL_PORT = os.environ.get('BROKER_URL_PORT', '123') -BROKER_URL_VHOST = os.environ.get('BROKER_URL_VHOST', 'vhost') -BROKER_URL = ''.join([BROKER_URL_PROTOCOL, BROKER_URL_USERNAME, ':', - BROKER_URL_PWD, '@', BROKER_URL_HOST, ':', - BROKER_URL_PORT, '/', BROKER_URL_VHOST]) -#BROKER_URL = 'amqp://designsafe:pwd@rabbitmq:5672//' -CELERY_RESULT_BACKEND_PROTOCOL = os.environ.get('CELERY_RESULT_BACKEND_PROTOCOL', 'redis://') -CELERY_RESULT_BACKEND_USERNAME = os.environ.get('CELERY_RESULT_BACKEND_USERNAME', 'username') -CELERY_RESULT_BACKEND_PWD = os.environ.get('CELERY_RESULT_BACKEND_PWD', 'pwd') -CELERY_RESULT_BACKEND_HOST = os.environ.get('CELERY_RESULT_BACKEND_HOST', 'localhost') -CELERY_RESULT_BACKEND_PORT = os.environ.get('CELERY_RESULT_BACKEND_PORT', '1234') -CELERY_RESULT_BACKEND_DB = os.environ.get('CELERY_RESULT_BACKEND_DB', '0') -CELERY_RESULT_BACKEND = ''.join([CELERY_RESULT_BACKEND_PROTOCOL, - CELERY_RESULT_BACKEND_HOST, ':', CELERY_RESULT_BACKEND_PORT, - '/', CELERY_RESULT_BACKEND_DB]) - -CELERY_ACCEPT_CONTENT = ['json'] -CELERY_TASK_SERIALIZER = 'json' -CELERY_RESULT_SERIALIZER = 'json' -CELERYD_HIJACK_ROOT_LOGGER = False -CELERYD_LOG_FORMAT = '[DJANGO] $(processName)s %(levelname)s %(asctime)s %(module)s '\ - '%(name)s.%(funcName)s:%(lineno)s: %(message)s' -#CELERY_ANOTATIONS = {'designsafe.apps.api.tasks.reindex_agave': {'time_limit': 60 * 15}} - - -CELERY_DEFAULT_EXCHANGE_TYPE = 'direct' -CELERY_QUEUES = ( - Queue('default', Exchange('default'), routing_key='default'), - #Use to queue indexing tasks - Queue('indexing', Exchange('io'), routing_key='io.indexing'), - #Use to queue tasks which handle files - Queue('files', Exchange('io'), routing_key='io.files'), - #Use to queue tasks which mainly call external APIs - Queue('api', Exchange('api'), routing_key='api.agave'), - ) -CELERY_DEFAULT_QUEUE = 'default' -CELERY_DEFAULT_EXCHANGE = 'default' -CELERY_DEFAULT_ROUTING_KEY = 'default' diff --git a/designsafe/settings/common_settings.py b/designsafe/settings/common_settings.py index 5eb78f58f7..047ae1324f 100644 --- a/designsafe/settings/common_settings.py +++ b/designsafe/settings/common_settings.py @@ -112,6 +112,7 @@ 'designsafe.apps.search', 'designsafe.apps.geo', 'designsafe.apps.rapid', + 'designsafe.apps.onboarding', #haystack integration 'haystack' @@ -427,7 +428,7 @@ 'metrics': { 'format': '[METRICS] %(levelname)s %(module)s %(name)s.%(funcName)s:%(lineno)s:' ' %(message)s user=%(user)s ip=%(ip)s agent=%(agent)s sessionId=%(sessionId)s op=%(operation)s' - ' info=%(info)s' + ' info=%(info)s timestamp=%(asctime)s portal=designsafe tenant=designsafe' }, }, 'handlers': { @@ -534,7 +535,6 @@ AGAVE_TOKEN_SESSION_ID = os.environ.get('AGAVE_TOKEN_SESSION_ID', 'agave_token') AGAVE_STORAGE_SYSTEM = os.environ.get('AGAVE_STORAGE_SYSTEM') -AGAVE_WORKING_SYSTEM = os.environ.get('AGAVE_WORKING_SYSTEM', 'designsafe.storage.frontera.work') AGAVE_JWT_PUBKEY = os.environ.get('AGAVE_JWT_PUBKEY') AGAVE_JWT_ISSUER = os.environ.get('AGAVE_JWT_ISSUER') @@ -545,12 +545,6 @@ AGAVE_USER_STORE_ID = os.environ.get('AGAVE_USER_STORE_ID', 'TACC') AGAVE_USE_SANDBOX = os.environ.get('AGAVE_USE_SANDBOX', 'False').lower() == 'true' -TAPIS_SYSTEMS_TO_CONFIGURE = [ - {"system_id": AGAVE_STORAGE_SYSTEM, "path": "{username}", "create_path": True}, - {"system_id": AGAVE_WORKING_SYSTEM, "path": "{username}", "create_path": True}, - {"system_id": "cloud.data", "path": "/ ", "create_path": False}, -] - # Tapis Client Configuration PORTAL_ADMIN_USERNAME = os.environ.get('PORTAL_ADMIN_USERNAME') TAPIS_TENANT_BASEURL = os.environ.get('TAPIS_TENANT_BASEURL') @@ -673,7 +667,7 @@ '.java', '.js', '.less', '.m', '.make', '.md', '.ml', '.mm', '.msg', '.php', '.pl', '.properties', '.py', '.rb', '.sass', '.scala', '.script', '.sh', '.sml', '.sql', '.txt', '.vi', '.vim', '.xml', '.xsd', '.xsl', '.yaml', '.yml', '.tcl', - '.json', '.out', '.err', '.geojson', '.do', '.sas', '.hazmapper' + '.json', '.out', '.err', '.geojson', '.do', '.sas', '.hazmapper', ".log" ] SUPPORTED_OBJECT_PREVIEW_EXTS = [ @@ -709,7 +703,31 @@ FEDORA_CONTAINER= os.environ.get('FEDORA_CONTAINER', 'designsafe-publications-dev') CSRF_TRUSTED_ORIGINS = [f"https://{os.environ.get('SESSION_COOKIE_DOMAIN')}"] -WEBHOOK_POST_URL = os.environ.get('WEBHOOK_POST_URL', '') +NGROK_DOMAIN = os.environ.get('NGROK_DOMAIN', os.environ.get('WEBHOOK_POST_URL', '')) STAFF_VPN_IP_PREFIX = os.environ.get("STAFF_VPN_IP_PREFIX", "129.114") USER_PROJECTS_LIMIT = os.environ.get("USER_PROJECTS_LIMIT", 500) + +# Onboarding +PORTAL_USER_ACCOUNT_SETUP_STEPS = [ + { + "step": "designsafe.apps.onboarding.steps.project_membership.ProjectMembershipStep", + "settings": { + "project_sql_id": 34076, # project id for DesignSafe-Corral + "rt_queue": "DesignSafe-ci", + }, + }, + { + "step": "designsafe.apps.onboarding.steps.allocation.AllocationStep", + "settings": {}, + }, + { + "step": "designsafe.apps.onboarding.steps.system_access_v3.SystemAccessStepV3", + "settings": { + "credentials_systems": ["cloud.data", "designsafe.storage.default"], + "create_path_systems": [ + {"system_id": "designsafe.storage.default", "path": "{username}"} + ], + }, + }, +] diff --git a/designsafe/settings/elasticsearch_settings.py b/designsafe/settings/elasticsearch_settings.py index ab3613d66a..3e45cfbf46 100644 --- a/designsafe/settings/elasticsearch_settings.py +++ b/designsafe/settings/elasticsearch_settings.py @@ -48,6 +48,11 @@ 'document': 'designsafe.apps.api.publications_v2.elasticsearch.IndexedPublication', 'kwargs': {} }, + 'projects_v2': { + 'alias': ES_INDEX_PREFIX.format('projects_v2'), + 'document': 'designsafe.apps.api.projects_v2.elasticsearch.IndexedProject', + 'kwargs': {"index.mapping.ignore_malformed": True} # Squash malformed date fields + }, 'web_content': { 'alias': ES_INDEX_PREFIX.format('web-content'), 'document': 'designsafe.apps.data.models.elasticsearch.IndexedCMSPage', diff --git a/designsafe/settings/external_resource_secrets.sample.py b/designsafe/settings/external_resource_secrets.sample.py deleted file mode 100644 index 09b002818a..0000000000 --- a/designsafe/settings/external_resource_secrets.sample.py +++ /dev/null @@ -1,8 +0,0 @@ -### -# Secrets for Google Auth flow -# - -GOOGLE_OAUTH2_CLIENT_SECRET = "CHANGE_ME" -GOOGLE_OAUTH2_CLIENT_ID = "CHANGE_ME" - -WEBHOOK_POST_URL = "CHANGE_ME" \ No newline at end of file diff --git a/designsafe/settings/test_settings.py b/designsafe/settings/test_settings.py index 4ba86fb0ba..d62cde6bdc 100644 --- a/designsafe/settings/test_settings.py +++ b/designsafe/settings/test_settings.py @@ -44,7 +44,7 @@ INSTALLED_APPS = ( - + 'daphne', 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', @@ -110,6 +110,7 @@ 'designsafe.apps.search', 'designsafe.apps.geo', 'designsafe.apps.rapid', + 'designsafe.apps.onboarding', #haystack integration # 'haystack' @@ -451,7 +452,6 @@ AGAVE_TOKEN_SESSION_ID = os.environ.get('AGAVE_TOKEN_SESSION_ID', 'agave_token') AGAVE_SUPER_TOKEN = os.environ.get('AGAVE_SUPER_TOKEN') AGAVE_STORAGE_SYSTEM = os.environ.get('AGAVE_STORAGE_SYSTEM') -AGAVE_WORKING_SYSTEM = os.environ.get('AGAVE_WORKING_SYSTEM') AGAVE_JWT_PUBKEY = os.environ.get('AGAVE_JWT_PUBKEY') AGAVE_JWT_ISSUER = os.environ.get('AGAVE_JWT_ISSUER') @@ -512,7 +512,7 @@ GOOGLE_OAUTH2_CLIENT_SECRET = "CHANGE_ME" GOOGLE_OAUTH2_CLIENT_ID = "CHANGE_ME" -WEBHOOK_POST_URL = "http://8cb9afb3.ngrok.io" +NGROK_DOMAIN = "https://8cb9afb3.ngrok.io" # Box sync BOX_APP_CLIENT_ID = 'boxappclientid' @@ -549,13 +549,6 @@ AGAVE_CLIENT_SECRET = 'example_com_client_secret' AGAVE_SUPER_TOKEN = 'example_com_client_token' AGAVE_STORAGE_SYSTEM = 'storage.example.com' -AGAVE_WORKING_SYSTEM = 'storage.example.work' - -TAPIS_SYSTEMS_TO_CONFIGURE = [ - {"system_id": AGAVE_STORAGE_SYSTEM, "path": "{username}", "create_path": True}, - {"system_id": AGAVE_WORKING_SYSTEM, "path": "{username}", "create_path": True}, - {"system_id": "cloud.data", "path": "/ ", "create_path": False}, -] # Tapis Client Configuration PORTAL_ADMIN_USERNAME = '' @@ -633,6 +626,20 @@ }, } +# Channels +WSGI_APPLICATION = 'designsafe.wsgi.application' +ASGI_APPLICATION = 'designsafe.asgi.application' +CHANNEL_LAYERS = { + "default": { + "BACKEND": "channels_redis.core.RedisChannelLayer", + "CONFIG": { + "hosts": [(os.environ.get('WS_BACKEND_HOST'), + os.environ.get('WS_BACKEND_PORT'))], + }, + }, +} + + PORTAL_DATA_DEPOT_MANAGERS = { 'agave': 'designsafe.apps.api.agave.filemanager.private_data.PrivateDataFileManager', 'shared': 'designsafe.apps.api.agave.filemanager.shared_data.SharedDataFileManager', @@ -700,6 +707,11 @@ 'document': 'designsafe.apps.api.publications_v2.elasticsearch.IndexedPublication', 'kwargs': {} }, + 'projects_v2': { + 'alias': ES_INDEX_PREFIX.format('projects_v2'), + 'document': 'designsafe.apps.api.projects_v2.elasticsearch.IndexedProject', + 'kwargs': {"index.mapping.ignore_malformed": True} # Squash malformed date fields + }, 'web_content': { 'alias': ES_INDEX_PREFIX.format('web-content'), 'document': 'designsafe.apps.data.models.elasticsearch.IndexedCMSPage', @@ -774,3 +786,26 @@ FEDORA_USERNAME = '' FEDORA_PASSWORD = '' FEDORA_CONTAINER= 'designsafe-publications-dev' + +# Onboarding +PORTAL_USER_ACCOUNT_SETUP_STEPS = [ + { + 'step': 'designsafe.apps.onboarding.steps.test_steps.MockStep', + 'settings': { + 'key': 'value' + } + } +] + +# TAS Authentication. +TAS_URL = 'https://test.com' +TAS_CLIENT_KEY = 'test' +TAS_CLIENT_SECRET = 'test' + +# Redmine Tracker Authentication. +RT_URL = 'test' +RT_HOST = 'https://test.com' +RT_UN = 'test' +RT_PW = 'test' +RT_QUEUE = 'test' +RT_TAG = 'test_tag' diff --git a/designsafe/static/scripts/dashboard/components/dashboard/dashboard.component.html b/designsafe/static/scripts/dashboard/components/dashboard/dashboard.component.html index 45340a215d..fefc8cf223 100644 --- a/designsafe/static/scripts/dashboard/components/dashboard/dashboard.component.html +++ b/designsafe/static/scripts/dashboard/components/dashboard/dashboard.component.html @@ -37,7 +37,7 @@
    Quick Links
    - +
    @@ -114,7 +114,7 @@

    Notifications {{$ctrl. {{note.datetime | date}}

    - {{note.message}} + {{note.event_type === 'interactive_session_ready' ? 'Ready to view' : note.message}}
    diff --git a/designsafe/static/scripts/nco/components/nco-ttc-grants/nco-ttc-grants.template.html b/designsafe/static/scripts/nco/components/nco-ttc-grants/nco-ttc-grants.template.html index 88f6818a46..12f7636b60 100644 --- a/designsafe/static/scripts/nco/components/nco-ttc-grants/nco-ttc-grants.template.html +++ b/designsafe/static/scripts/nco/components/nco-ttc-grants/nco-ttc-grants.template.html @@ -36,7 +36,7 @@
    - +
    @@ -82,4 +82,4 @@
View Details
-
+
\ No newline at end of file diff --git a/designsafe/static/scripts/ng-designsafe/components/notification-badge/notification-badge.component.html b/designsafe/static/scripts/ng-designsafe/components/notification-badge/notification-badge.component.html index bd706a3cba..dfd2466a21 100644 --- a/designsafe/static/scripts/ng-designsafe/components/notification-badge/notification-badge.component.html +++ b/designsafe/static/scripts/ng-designsafe/components/notification-badge/notification-badge.component.html @@ -1,17 +1,18 @@ -