Add researcher codes

- backend - add ResearchGroup model with 6-digit id code for users to use when signing up - add checkdigit dependency to add checksum to code - add full_data_access flag to users if they should have research access to all data - admin frontend users tab - add reseach_group_id & full_data_access to table - add button to add create a research code for a researcher - frontend - add ResearchCodeInput input which checks the entered code checksum is valid - add optional code input to user signup, remove role selection - make url for signup /signup - add optional code e.g. /signup/123451 to allow researchers to send sign-up links to their users with code pre-filled - add cdigit dependency to validate codes - resolves #185
ssciwr · Dec 5, 2024 · 524782a · 524782a
1 parent 7713251
commit 524782a
Show file tree

Hide file tree

Showing 20 changed files with 370 additions and 68 deletions.
diff --git a/frontend/Dockerfile b/frontend/Dockerfile
@@ -9,13 +9,15 @@ WORKDIR /app
 
 COPY package*.json ./
 
+COPY pnpm-lock.yaml ./
+
 RUN npm install -g pnpm && pnpm install
 
 COPY . .
 
 RUN echo "VITE_MONDEY_API_URL=${MONDEY_API_URL}" > .env && pnpm run build
 
-FROM nginx:1.27.1
+FROM nginx:1.27.3
 
 COPY --from=builder /app/build /usr/share/nginx/html
 

diff --git a/frontend/package.json b/frontend/package.json
@@ -38,6 +38,7 @@
 	"dependencies": {
 		"@hey-api/client-fetch": "0.4.3",
 		"@unovis/ts": "1.5.0-beta.0",
+		"cdigit": "^4.0.2",
 		"iso-639-1": "3.1.3",
 		"svelte-dnd-action": "^0.9.52",
 		"svelte-i18n": "^4.0.1"

diff --git a/frontend/pnpm-lock.yaml b/frontend/pnpm-lock.yaml
diff --git a/frontend/src/lib/client/schemas.gen.ts b/frontend/src/lib/client/schemas.gen.ts
@@ -832,6 +832,18 @@ export const QuestionTextPublicSchema = {
     title: 'QuestionTextPublic'
 } as const;
 
+export const ResearchGroupSchema = {
+    properties: {
+        id: {
+            type: 'integer',
+            title: 'Id'
+        }
+    },
+    type: 'object',
+    required: ['id'],
+    title: 'ResearchGroup'
+} as const;
+
 export const SubmittedMilestoneImagePublicSchema = {
     properties: {
         id: {
@@ -937,6 +949,30 @@ export const UserCreateSchema = {
             ],
             title: 'Is Researcher',
             default: false
+        },
+        full_data_access: {
+            anyOf: [
+                {
+                    type: 'boolean'
+                },
+                {
+                    type: 'null'
+                }
+            ],
+            title: 'Full Data Access',
+            default: false
+        },
+        research_group_id: {
+            anyOf: [
+                {
+                    type: 'integer'
+                },
+                {
+                    type: 'null'
+                }
+            ],
+            title: 'Research Group Id',
+            default: 0
         }
     },
     type: 'object',
@@ -1098,10 +1134,18 @@ export const UserReadSchema = {
         is_researcher: {
             type: 'boolean',
             title: 'Is Researcher'
+        },
+        full_data_access: {
+            type: 'boolean',
+            title: 'Full Data Access'
+        },
+        research_group_id: {
+            type: 'integer',
+            title: 'Research Group Id'
         }
     },
     type: 'object',
-    required: ['id', 'email', 'is_researcher'],
+    required: ['id', 'email', 'is_researcher', 'full_data_access', 'research_group_id'],
     title: 'UserRead'
 } as const;
 
@@ -1173,6 +1217,28 @@ export const UserUpdateSchema = {
                 }
             ],
             title: 'Is Researcher'
+        },
+        full_data_access: {
+            anyOf: [
+                {
+                    type: 'boolean'
+                },
+                {
+                    type: 'null'
+                }
+            ],
+            title: 'Full Data Access'
+        },
+        research_group_id: {
+            anyOf: [
+                {
+                    type: 'integer'
+                },
+                {
+                    type: 'null'
+                }
+            ],
+            title: 'Research Group Id'
         }
     },
     type: 'object',

diff --git a/frontend/src/lib/client/services.gen.ts b/frontend/src/lib/client/services.gen.ts
@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
 import { createClient, createConfig, type Options, formDataBodySerializer, urlSearchParamsBodySerializer } from '@hey-api/client-fetch';
-import type { GetLanguagesError, GetLanguagesResponse, GetMilestonesError, GetMilestonesResponse, GetMilestoneData, GetMilestoneError, GetMilestoneResponse, GetMilestoneGroupsData, GetMilestoneGroupsError, GetMilestoneGroupsResponse, SubmitMilestoneImageData, SubmitMilestoneImageError, SubmitMilestoneImageResponse, GetUserQuestionsError, GetUserQuestionsResponse, GetChildQuestionsError, GetChildQuestionsResponse, CreateLanguageData, CreateLanguageError, CreateLanguageResponse, DeleteLanguageData, DeleteLanguageError, DeleteLanguageResponse, UpdateI18NData, UpdateI18NError, UpdateI18NResponse, GetMilestoneGroupsAdminError, GetMilestoneGroupsAdminResponse, CreateMilestoneGroupAdminError, CreateMilestoneGroupAdminResponse, UpdateMilestoneGroupAdminData, UpdateMilestoneGroupAdminError, UpdateMilestoneGroupAdminResponse, DeleteMilestoneGroupAdminData, DeleteMilestoneGroupAdminError, DeleteMilestoneGroupAdminResponse, OrderMilestoneGroupsAdminData, OrderMilestoneGroupsAdminError, OrderMilestoneGroupsAdminResponse, UploadMilestoneGroupImageData, UploadMilestoneGroupImageError, UploadMilestoneGroupImageResponse, CreateMilestoneData, CreateMilestoneError, CreateMilestoneResponse, UpdateMilestoneData, UpdateMilestoneError, UpdateMilestoneResponse, DeleteMilestoneData, DeleteMilestoneError, DeleteMilestoneResponse, OrderMilestonesAdminData, OrderMilestonesAdminError, OrderMilestonesAdminResponse, UploadMilestoneImageData, UploadMilestoneImageError, UploadMilestoneImageResponse, DeleteMilestoneImageData, DeleteMilestoneImageError, DeleteMilestoneImageResponse, GetSubmittedMilestoneImagesError, GetSubmittedMilestoneImagesResponse, ApproveSubmittedMilestoneImageData, ApproveSubmittedMilestoneImageError, ApproveSubmittedMilestoneImageResponse, DeleteSubmittedMilestoneImageData, DeleteSubmittedMilestoneImageError, DeleteSubmittedMilestoneImageResponse, GetMilestoneAgeScoresData, GetMilestoneAgeScoresError, GetMilestoneAgeScoresResponse, GetUserQuestionsAdminError, GetUserQuestionsAdminResponse, UpdateUserQuestionData, UpdateUserQuestionError, UpdateUserQuestionResponse, CreateUserQuestionError, CreateUserQuestionResponse, DeleteUserQuestionData, DeleteUserQuestionError, DeleteUserQuestionResponse, OrderUserQuestionsAdminData, OrderUserQuestionsAdminError, OrderUserQuestionsAdminResponse, GetChildQuestionsAdminError, GetChildQuestionsAdminResponse, UpdateChildQuestionData, UpdateChildQuestionError, UpdateChildQuestionResponse, CreateChildQuestionError, CreateChildQuestionResponse, DeleteChildQuestionData, DeleteChildQuestionError, DeleteChildQuestionResponse, OrderChildQuestionsAdminData, OrderChildQuestionsAdminError, OrderChildQuestionsAdminResponse, GetUsersError, GetUsersResponse, UsersCurrentUserError, UsersCurrentUserResponse, UsersPatchCurrentUserData, UsersPatchCurrentUserError, UsersPatchCurrentUserResponse, UsersUserData, UsersUserError, UsersUserResponse, UsersPatchUserData, UsersPatchUserError, UsersPatchUserResponse, UsersDeleteUserData, UsersDeleteUserError, UsersDeleteUserResponse, GetChildrenError, GetChildrenResponse, UpdateChildData, UpdateChildError, UpdateChildResponse, CreateChildData, CreateChildError, CreateChildResponse, GetChildData, GetChildError, GetChildResponse, DeleteChildData, DeleteChildError, DeleteChildResponse, GetChildImageData, GetChildImageError, GetChildImageResponse, UploadChildImageData, UploadChildImageError, UploadChildImageResponse, DeleteChildImageData, DeleteChildImageError, DeleteChildImageResponse, GetCurrentMilestoneAnswerSessionData, GetCurrentMilestoneAnswerSessionError, GetCurrentMilestoneAnswerSessionResponse, UpdateMilestoneAnswerData, UpdateMilestoneAnswerError, UpdateMilestoneAnswerResponse, GetCurrentUserAnswersError, GetCurrentUserAnswersResponse, UpdateCurrentUserAnswersData, UpdateCurrentUserAnswersError, UpdateCurrentUserAnswersResponse, GetCurrentChildAnswersData, GetCurrentChildAnswersError, GetCurrentChildAnswersResponse, UpdateCurrentChildAnswersData, UpdateCurrentChildAnswersError, UpdateCurrentChildAnswersResponse, AuthCookieLoginData, AuthCookieLoginError, AuthCookieLoginResponse, AuthCookieLogoutError, AuthCookieLogoutResponse, RegisterRegisterData, RegisterRegisterError, RegisterRegisterResponse, ResetForgotPasswordData, ResetForgotPasswordError, ResetForgotPasswordResponse, ResetResetPasswordData, ResetResetPasswordError, ResetResetPasswordResponse, VerifyRequestTokenData, VerifyRequestTokenError, VerifyRequestTokenResponse, VerifyVerifyData, VerifyVerifyError, VerifyVerifyResponse, AuthError, AuthResponse } from './types.gen';
+import type { GetLanguagesError, GetLanguagesResponse, GetMilestonesError, GetMilestonesResponse, GetMilestoneData, GetMilestoneError, GetMilestoneResponse, GetMilestoneGroupsData, GetMilestoneGroupsError, GetMilestoneGroupsResponse, SubmitMilestoneImageData, SubmitMilestoneImageError, SubmitMilestoneImageResponse, GetUserQuestionsError, GetUserQuestionsResponse, GetChildQuestionsError, GetChildQuestionsResponse, CreateLanguageData, CreateLanguageError, CreateLanguageResponse, DeleteLanguageData, DeleteLanguageError, DeleteLanguageResponse, UpdateI18NData, UpdateI18NError, UpdateI18NResponse, GetMilestoneGroupsAdminError, GetMilestoneGroupsAdminResponse, CreateMilestoneGroupAdminError, CreateMilestoneGroupAdminResponse, UpdateMilestoneGroupAdminData, UpdateMilestoneGroupAdminError, UpdateMilestoneGroupAdminResponse, DeleteMilestoneGroupAdminData, DeleteMilestoneGroupAdminError, DeleteMilestoneGroupAdminResponse, OrderMilestoneGroupsAdminData, OrderMilestoneGroupsAdminError, OrderMilestoneGroupsAdminResponse, UploadMilestoneGroupImageData, UploadMilestoneGroupImageError, UploadMilestoneGroupImageResponse, CreateMilestoneData, CreateMilestoneError, CreateMilestoneResponse, UpdateMilestoneData, UpdateMilestoneError, UpdateMilestoneResponse, DeleteMilestoneData, DeleteMilestoneError, DeleteMilestoneResponse, OrderMilestonesAdminData, OrderMilestonesAdminError, OrderMilestonesAdminResponse, UploadMilestoneImageData, UploadMilestoneImageError, UploadMilestoneImageResponse, DeleteMilestoneImageData, DeleteMilestoneImageError, DeleteMilestoneImageResponse, GetSubmittedMilestoneImagesError, GetSubmittedMilestoneImagesResponse, ApproveSubmittedMilestoneImageData, ApproveSubmittedMilestoneImageError, ApproveSubmittedMilestoneImageResponse, DeleteSubmittedMilestoneImageData, DeleteSubmittedMilestoneImageError, DeleteSubmittedMilestoneImageResponse, GetMilestoneAgeScoresData, GetMilestoneAgeScoresError, GetMilestoneAgeScoresResponse, GetUserQuestionsAdminError, GetUserQuestionsAdminResponse, UpdateUserQuestionData, UpdateUserQuestionError, UpdateUserQuestionResponse, CreateUserQuestionError, CreateUserQuestionResponse, DeleteUserQuestionData, DeleteUserQuestionError, DeleteUserQuestionResponse, OrderUserQuestionsAdminData, OrderUserQuestionsAdminError, OrderUserQuestionsAdminResponse, GetChildQuestionsAdminError, GetChildQuestionsAdminResponse, UpdateChildQuestionData, UpdateChildQuestionError, UpdateChildQuestionResponse, CreateChildQuestionError, CreateChildQuestionResponse, DeleteChildQuestionData, DeleteChildQuestionError, DeleteChildQuestionResponse, OrderChildQuestionsAdminData, OrderChildQuestionsAdminError, OrderChildQuestionsAdminResponse, GetUsersError, GetUsersResponse, GetResearchGroupsError, GetResearchGroupsResponse, CreateResearchGroupData, CreateResearchGroupError, CreateResearchGroupResponse, DeleteResearchGroupData, DeleteResearchGroupError, DeleteResearchGroupResponse, UsersCurrentUserError, UsersCurrentUserResponse, UsersPatchCurrentUserData, UsersPatchCurrentUserError, UsersPatchCurrentUserResponse, UsersUserData, UsersUserError, UsersUserResponse, UsersPatchUserData, UsersPatchUserError, UsersPatchUserResponse, UsersDeleteUserData, UsersDeleteUserError, UsersDeleteUserResponse, GetChildrenError, GetChildrenResponse, UpdateChildData, UpdateChildError, UpdateChildResponse, CreateChildData, CreateChildError, CreateChildResponse, GetChildData, GetChildError, GetChildResponse, DeleteChildData, DeleteChildError, DeleteChildResponse, GetChildImageData, GetChildImageError, GetChildImageResponse, UploadChildImageData, UploadChildImageError, UploadChildImageResponse, DeleteChildImageData, DeleteChildImageError, DeleteChildImageResponse, GetCurrentMilestoneAnswerSessionData, GetCurrentMilestoneAnswerSessionError, GetCurrentMilestoneAnswerSessionResponse, UpdateMilestoneAnswerData, UpdateMilestoneAnswerError, UpdateMilestoneAnswerResponse, GetCurrentUserAnswersError, GetCurrentUserAnswersResponse, UpdateCurrentUserAnswersData, UpdateCurrentUserAnswersError, UpdateCurrentUserAnswersResponse, GetCurrentChildAnswersData, GetCurrentChildAnswersError, GetCurrentChildAnswersResponse, UpdateCurrentChildAnswersData, UpdateCurrentChildAnswersError, UpdateCurrentChildAnswersResponse, AuthCookieLoginData, AuthCookieLoginError, AuthCookieLoginResponse, AuthCookieLogoutError, AuthCookieLogoutResponse, RegisterRegisterData, RegisterRegisterError, RegisterRegisterResponse, ResetForgotPasswordData, ResetForgotPasswordError, ResetForgotPasswordResponse, ResetResetPasswordData, ResetResetPasswordError, ResetResetPasswordResponse, VerifyRequestTokenData, VerifyRequestTokenError, VerifyRequestTokenResponse, VerifyVerifyData, VerifyVerifyError, VerifyVerifyResponse, AuthError, AuthResponse } from './types.gen';
 
 export const client = createClient(createConfig());
 
@@ -390,6 +390,36 @@ export const getUsers = <ThrowOnError extends boolean = false>(options?: Options
     });
 };
 
+/**
+ * Get Research Groups
+ */
+export const getResearchGroups = <ThrowOnError extends boolean = false>(options?: Options<unknown, ThrowOnError>) => {
+    return (options?.client ?? client).get<GetResearchGroupsResponse, GetResearchGroupsError, ThrowOnError>({
+        ...options,
+        url: '/admin/research-groups/'
+    });
+};
+
+/**
+ * Create Research Group
+ */
+export const createResearchGroup = <ThrowOnError extends boolean = false>(options: Options<CreateResearchGroupData, ThrowOnError>) => {
+    return (options?.client ?? client).post<CreateResearchGroupResponse, CreateResearchGroupError, ThrowOnError>({
+        ...options,
+        url: '/admin/research-groups/{user_id}'
+    });
+};
+
+/**
+ * Delete Research Group
+ */
+export const deleteResearchGroup = <ThrowOnError extends boolean = false>(options: Options<DeleteResearchGroupData, ThrowOnError>) => {
+    return (options?.client ?? client).delete<DeleteResearchGroupResponse, DeleteResearchGroupError, ThrowOnError>({
+        ...options,
+        url: '/admin/research-groups/{research_group_id}'
+    });
+};
+
 /**
  * Users:Current User
  */

diff --git a/frontend/src/lib/client/types.gen.ts b/frontend/src/lib/client/types.gen.ts
@@ -216,6 +216,10 @@ export type QuestionTextPublic = {
     options?: string;
 };
 
+export type ResearchGroup = {
+    id: number;
+};
+
 export type SubmittedMilestoneImagePublic = {
     id: number;
     milestone_id: number;
@@ -235,6 +239,8 @@ export type UserCreate = {
     is_superuser?: (boolean | null);
     is_verified?: (boolean | null);
     is_researcher?: (boolean | null);
+    full_data_access?: (boolean | null);
+    research_group_id?: (number | null);
 };
 
 export type UserQuestionAdmin = {
@@ -274,6 +280,8 @@ export type UserRead = {
     is_superuser?: boolean;
     is_verified?: boolean;
     is_researcher: boolean;
+    full_data_access: boolean;
+    research_group_id: number;
 };
 
 export type UserUpdate = {
@@ -283,6 +291,8 @@ export type UserUpdate = {
     is_superuser?: (boolean | null);
     is_verified?: (boolean | null);
     is_researcher?: (boolean | null);
+    full_data_access?: (boolean | null);
+    research_group_id?: (number | null);
 };
 
 export type ValidationError = {
@@ -579,6 +589,30 @@ export type GetUsersResponse = (Array<UserRead>);
 
 export type GetUsersError = unknown;
 
+export type GetResearchGroupsResponse = (Array<ResearchGroup>);
+
+export type GetResearchGroupsError = unknown;
+
+export type CreateResearchGroupData = {
+    path: {
+        user_id: number;
+    };
+};
+
+export type CreateResearchGroupResponse = (ResearchGroup);
+
+export type CreateResearchGroupError = (HTTPValidationError);
+
+export type DeleteResearchGroupData = {
+    path: {
+        research_group_id: number;
+    };
+};
+
+export type DeleteResearchGroupResponse = (unknown);
+
+export type DeleteResearchGroupError = (HTTPValidationError);
+
 export type UsersCurrentUserResponse = (UserRead);
 
 export type UsersCurrentUserError = (unknown);

diff --git a/frontend/src/lib/components/Admin/Users.svelte b/frontend/src/lib/components/Admin/Users.svelte
@@ -3,6 +3,8 @@
 <script lang="ts">
 import SaveButton from "$lib/components/Admin/SaveButton.svelte";
 import {
+	Alert,
+	Button,
 	Card,
 	Checkbox,
 	Table,
@@ -13,8 +15,12 @@ import {
 	TableHeadCell,
 } from "flowbite-svelte";
 
-import { getUsers, usersPatchUser } from "$lib/client/services.gen";
-import type { UserRead, UserUpdate } from "$lib/client/types.gen";
+import {
+	createResearchGroup,
+	getUsers,
+	usersPatchUser,
+} from "$lib/client/services.gen";
+import type { UserRead } from "$lib/client/types.gen";
 import { onMount } from "svelte";
 import { _ } from "svelte-i18n";
 
@@ -53,6 +59,19 @@ async function updateUser(user: UserRead) {
 	}
 }
 
+async function addResearchGroup(user: UserRead) {
+	const { data, error } = await createResearchGroup({
+		path: {
+			user_id: user.id,
+		},
+	});
+	if (error || !data) {
+		console.log(error);
+	} else {
+		await refreshUsers();
+	}
+}
+
 onMount(async () => {
 	await refreshUsers();
 });
@@ -68,6 +87,8 @@ onMount(async () => {
 			<TableHeadCell>Active</TableHeadCell>
 			<TableHeadCell>Verified</TableHeadCell>
 			<TableHeadCell>Researcher</TableHeadCell>
+			<TableHeadCell>Full data access</TableHeadCell>
+			<TableHeadCell>Research Code</TableHeadCell>
 			<TableHeadCell>Admin</TableHeadCell>
 			<TableHeadCell>{$_('admin.actions')}</TableHeadCell>
 		</TableHead>
@@ -86,6 +107,18 @@ onMount(async () => {
 					<TableBodyCell>
 						<Checkbox bind:checked={user.is_researcher} onchange={() => {saveDisabled[user.id]=false}} />
 					</TableBodyCell>
+					<TableBodyCell>
+						<Checkbox bind:checked={user.full_data_access} onchange={() => {saveDisabled[user.id]=false}} />
+					</TableBodyCell>
+					<TableBodyCell>
+						{#if user.research_group_id > 0}
+						<Alert border={user.is_researcher} color="dark">
+							{user.research_group_id}
+						</Alert>
+							{:else if user.is_researcher}
+							<Button onclick={() => {addResearchGroup(user)}}>Add research code</Button>
+						{/if}
+					</TableBodyCell>
 					<TableBodyCell>
 						<Checkbox bind:checked={user.is_superuser} onchange={() => {saveDisabled[user.id]=false}} />
 					</TableBodyCell>

diff --git a/frontend/src/lib/components/DataInput/ResearchCodeInput.svelte b/frontend/src/lib/components/DataInput/ResearchCodeInput.svelte
@@ -0,0 +1,36 @@
+<svelte:options runes={true} />
+
+<script lang="ts">
+import { verhoeff } from "cdigit";
+import { Input } from "flowbite-svelte";
+import {
+	CheckCircleOutline,
+	ExclamationCircleOutline,
+} from "flowbite-svelte-icons";
+import { onMount } from "svelte";
+
+let {
+	value = $bindable(""),
+	valid = $bindable(verhoeff.validate(value)),
+}: {
+	value: string;
+	valid: boolean;
+} = $props();
+
+function validate(code: string) {
+	valid = code === "" || (code.length === 6 && verhoeff.validate(code));
+}
+
+function oninput(event: Event) {
+	const target = event.target as HTMLInputElement;
+	validate(target.value);
+}
+
+onMount(() => {
+	validate(value);
+});
+</script>
+
+<div class="flex flex-row items-center">
+	<Input type="text" bind:value class="mr-2" {oninput} color={valid ? 'base' : 'red'}/>
+</div>