Merge pull request #862 from fractal-analytics-platform/server-2.17-changes2

Adapted to user/settings changes (fractal-server 2.17)

Author: zonia3000

.github/workflows/documentation.yaml

@@ -23,7 +23,7 @@ jobs:
           cache: pip
 
       - name: Install dependencies
-        run: python -m pip install -r docs/doc-requirements.txt
+        run: python -m pip install -r docs/requirements.txt
 
       - name: MKDocs build
         run: mkdocs build --config-file mkdocs.yml --strict

CHANGELOG.md

@@ -6,11 +6,14 @@
 * Added more keywords to match SLURM errors (\#843).
 * Fixed bug in sandbox pages (\#839);
 * Displayed all kinds of recent task activities in tasks management page. (\#835);
-* Managed resources and profiles (\#845):
+* Managed resources and profiles (\#845, \#862):
     * Added new admin pages for resources and profiles;
     * Updated admin user pages to associate users with profiles;
     * Updated admin settings page;
     * Merged "My Profile" and "My settings" pages;
+* Merged user settings into user (\#862);
+* Adapted to OAuth2 changes (\#862);
+* Handled user without profile as not verified users (\#862);
 
 # 1.20.0
 

__tests__/mock/mock-types.js

@@ -12,6 +12,8 @@ export function mockUser(fields = {}) {
 		group_ids_names: [],
 		oauth_accounts: [],
 		profile_id: 1,
+		project_dir: '/tmp',
+		slurm_accounts: [],
 		...fields
 	};
 }

__tests__/v2/CreateDatasetModal.test.js

@@ -44,7 +44,7 @@ function mockFetch(project_dir) {
 		status: 200,
 		json: () =>
 			new Promise((resolve) => {
-				if (url === '/api/auth/current-user/settings') {
+				if (url === '/api/auth/current-user') {
 					resolve({
 						project_dir
 					});

__tests__/v2/TaskGroupActivities.test.js

@@ -102,6 +102,8 @@ describe('TaskGroupActivities', () => {
 						group_ids_names: [],
 						oauth_accounts: [],
 						profile_id: 1,
+						project_dir: '/tmp',
+						slurm_accounts: []
 					}
 				]
 			}

__tests__/v2/UserEditor.test.js

@@ -39,35 +39,27 @@ import UserEditor from '../../src/lib/components/v2/admin/UserEditor.svelte';
 describe('UserEditor', () => {
 	beforeEach(() => {
 		/** @type {import('vitest').Mock} */ (fetch).mockClear();
+		mockResourcesAndProfiles();
 	});
 
 	const selectedUser = mockUser();
 
-	/**
-	 * @type {() => Promise<Response>}
-	 */
-	const mockSaveUser = vi.fn();
-
 	it('Update settings - success', async () => {
-		const mockRequest = mockSettingsUpdate({
-			ok: true,
-			status: 200,
-			json: () =>
-				new Promise((resolve) =>
-					resolve({
-						slurm_accounts: [],
-						project_dir: '/path/to/project/dir'
-					})
-				)
-		});
-
 		const user = userEvent.setup();
 
+		const mockSaveUser = vi.fn(async (u) => {
+			return /** @type {Response} */ ({
+				ok: true,
+				status: 200,
+				json: () => new Promise((resolve) => resolve(u))
+			});
+		});
+
 		render(UserEditor, {
 			props: {
 				runnerBackend: 'slurm_sudo',
-				user: selectedUser,
-				settings: {
+				user: {
+					...selectedUser,
 					slurm_accounts: [],
 					project_dir: null
 				},
@@ -79,42 +71,41 @@ describe('UserEditor', () => {
 		await user.click(screen.getByRole('button', { name: 'Save' }));
 		await screen.findByText('User successfully updated');
 
-		expect(mockRequest).toHaveBeenCalledWith(
-			expect.anything(),
+		expect(mockSaveUser).toHaveBeenCalledWith(
 			expect.objectContaining({
-				body: JSON.stringify({
-					slurm_accounts: [],
-					project_dir: '/path/to/project/dir'
-				})
+				slurm_accounts: [],
+				project_dir: '/path/to/project/dir'
 			})
 		);
 	});
 
 	it('Update settings - validation error', async () => {
-		const mockRequest = mockSettingsUpdate({
-			ok: false,
-			status: 422,
-			json: () =>
-				new Promise((resolve) =>
-					resolve({
-						detail: [
-							{
-								loc: ['body', 'project_dir'],
-								msg: 'mocked_error',
-								type: 'value_error'
-							}
-						]
-					})
-				)
-		});
-
 		const user = userEvent.setup();
 
+		const mockSaveUser = vi.fn(async () => {
+			return /** @type {Response} */ ({
+				ok: false,
+				status: 422,
+				json: () =>
+					new Promise((resolve) =>
+						resolve({
+							detail: [
+								{
+									loc: ['body', 'project_dir'],
+									msg: 'mocked_error',
+									type: 'value_error'
+								}
+							]
+						})
+					)
+			});
+		});
+
 		render(UserEditor, {
 			props: {
 				runnerBackend: 'slurm_sudo',
-				user: selectedUser,
-				settings: {
+				user: {
+					...selectedUser,
 					slurm_accounts: [],
 					project_dir: null
 				},
@@ -126,37 +117,30 @@ describe('UserEditor', () => {
 		await user.click(screen.getByRole('button', { name: 'Save' }));
 		await screen.findByText('mocked_error');
 
-		expect(mockRequest).toHaveBeenCalledWith(
-			expect.anything(),
+		expect(mockSaveUser).toHaveBeenCalledWith(
 			expect.objectContaining({
-				body: JSON.stringify({
-					slurm_accounts: [],
-					project_dir: 'xxx'
-				})
+				slurm_accounts: [],
+				project_dir: 'xxx'
 			})
 		);
 	});
 
 	it('Update settings - add slurm accounts', async () => {
-		const mockRequest = mockSettingsUpdate({
-			ok: true,
-			status: 200,
-			json: () =>
-				new Promise((resolve) =>
-					resolve({
-						slurm_accounts: ['foo', 'bar'],
-						project_dir: '/path/to/project/dir'
-					})
-				)
+		const mockSaveUser = vi.fn(async (u) => {
+			return /** @type {Response} */ ({
+				ok: true,
+				status: 200,
+				json: () => new Promise((resolve) => resolve(u))
+			});
 		});
 
 		const user = userEvent.setup();
 
 		render(UserEditor, {
 			props: {
 				runnerBackend: 'slurm_sudo',
-				user: selectedUser,
-				settings: {
+				user: {
+					...selectedUser,
 					slurm_accounts: [],
 					project_dir: '/path/to/project/dir'
 				},
@@ -174,37 +158,30 @@ describe('UserEditor', () => {
 		await user.click(screen.getByRole('button', { name: 'Save' }));
 		await screen.findByText('User successfully updated');
 
-		expect(mockRequest).toHaveBeenCalledWith(
-			expect.anything(),
+		expect(mockSaveUser).toHaveBeenCalledWith(
 			expect.objectContaining({
-				body: JSON.stringify({
-					slurm_accounts: ['foo', 'bar'],
-					project_dir: '/path/to/project/dir'
-				})
+				slurm_accounts: ['foo', 'bar'],
+				project_dir: '/path/to/project/dir'
 			})
 		);
 	});
 
 	it('Update settings - remove slurm account', async () => {
-		const mockRequest = mockSettingsUpdate({
-			ok: true,
-			status: 200,
-			json: () =>
-				new Promise((resolve) =>
-					resolve({
-						slurm_accounts: ['foo', 'bar'],
-						project_dir: '/path/to/project/dir'
-					})
-				)
+		const mockSaveUser = vi.fn(async (u) => {
+			return /** @type {Response} */ ({
+				ok: true,
+				status: 200,
+				json: () => new Promise((resolve) => resolve(u))
+			});
 		});
 
 		const user = userEvent.setup();
 
 		render(UserEditor, {
 			props: {
 				runnerBackend: 'slurm_sudo',
-				user: selectedUser,
-				settings: {
+				user: {
+					...selectedUser,
 					slurm_accounts: ['foo', 'bar'],
 					project_dir: '/path/to/project/dir'
 				},
@@ -219,19 +196,16 @@ describe('UserEditor', () => {
 		await user.click(screen.getByRole('button', { name: 'Save' }));
 		await screen.findByText('User successfully updated');
 
-		expect(mockRequest).toHaveBeenCalledWith(
-			expect.anything(),
+		expect(mockSaveUser).toHaveBeenCalledWith(
 			expect.objectContaining({
-				body: JSON.stringify({
-					slurm_accounts: ['foo'],
-					project_dir: '/path/to/project/dir'
-				})
+				slurm_accounts: ['foo'],
+				project_dir: '/path/to/project/dir'
 			})
 		);
 	});
 });
 
-function mockSettingsUpdate(updateSettings) {
+function mockResourcesAndProfiles() {
 	return /** @type {import('vitest').Mock} */ (fetch)
 		.mockResolvedValueOnce({
 			ok: true,
@@ -250,6 +224,5 @@ function mockSettingsUpdate(updateSettings) {
 			status: 200,
 			// mock profiles
 			json: () => new Promise((resolve) => resolve([{ id: 1 }]))
-		})
-		.mockResolvedValue(updateSettings);
+		});
 }

__tests__/v2/workflow_page.test.js

@@ -80,7 +80,7 @@ describe('Workflow page', () => {
 								status: 'failed',
 								log: 'Exception error occurred while creating job folder and subfolders.\nOriginal error: test'
 							};
-						case '/api/auth/current-user/settings':
+						case '/api/auth/current-user':
 							return { slurm_accounts: [] };
 						case '/api/v2/project/1/workflow/1/version-update-candidates':
 							return [];

components/src/lib/types/api.d.ts

@@ -11,18 +11,15 @@ export type User = {
 	profile_id: number | null;
 	password?: string;
 	group_ids_names: Array<[number, string]> | null;
+	project_dir: string | null;
+	slurm_accounts: string[];
 	oauth_accounts: Array<{
 		id: number;
 		account_email: string;
 		oauth_name: string;
 	}>;
 };
 
-export type UserSettings = {
-	slurm_accounts: string[];
-	project_dir: string | null;
-};
-
 export type ProfileInfo = {
 	has_profile: boolean;
 	resource_name: string | null;

docs/development/docs.md

@@ -5,7 +5,7 @@ Here are the instructions to serve the documentation on localhost:8001:
 ```bash
 python -m venv venv
 source venv/bin/activate
-python -m pip install -r docs/doc-requirements.txt
+python -m pip install -r docs/requirements.txt
 mkdocs serve --dev-addr localhost:8001
 ```