Handled FRACTAL_DEFAULT_GROUP_NAME environment variable

Author: zonia3000

.env

@@ -23,3 +23,5 @@ FRACTAL_RUNNER_BACKEND=local
 #NEWS_INFO_PATH=/path/to/news.md
 
 BODY_SIZE_LIMIT=5000000
+
+FRACTAL_DEFAULT_GROUP_NAME=All

.env.development

@@ -20,3 +20,5 @@ LOG_LEVEL_CONSOLE=info
 FRACTAL_RUNNER_BACKEND=local
 #WARNING_BANNER_PATH=/path/to/banner.txt
 #NEWS_INFO_PATH=/path/to/news.md
+
+FRACTAL_DEFAULT_GROUP_NAME=All

.github/workflows/end_to_end_tests.yaml

@@ -73,6 +73,7 @@ jobs:
         run: npx playwright test
         env:
           FRACTAL_RUNNER_BACKEND: local
+          FRACTAL_DEFAULT_GROUP_NAME: All
 
       - name: Archive test results
         if: always()

CHANGELOG.md

@@ -16,6 +16,7 @@
 * Handled user without profile as not verified users (\#862);
 * Added support for oneOf and discriminator (\#867);
 * Added resource filter on admin task and task-group pages (\#867);
+* Handled `FRACTAL_DEFAULT_GROUP_NAME` environment variable, to specify if a default group is used (\#870);
 
 # 1.20.0
 

__tests__/user_utilities.test.js

@@ -1,7 +1,7 @@
 import { it, expect } from 'vitest';
 import {
 	sortUsers,
-	sortGroupByNameAllFirstComparator,
+	getSortGroupByNameAllFirstComparator,
 	sortUserToImportSettings
 } from '$lib/components/admin/user_utilities';
 import { mockGroup, mockUser } from './mock/mock-types';
@@ -43,7 +43,7 @@ it('should sort groups by name, but keeping the All group first', () => {
 		mockGroup({ id: 3, name: 'g3' })
 	];
 
-	groups.sort(sortGroupByNameAllFirstComparator);
+	groups.sort(getSortGroupByNameAllFirstComparator('All'));
 
 	expect(groups[0].name).eq('All');
 	expect(groups[1].name).eq('g2');

__tests__/v2/AddSingleTask.test.js

@@ -33,7 +33,8 @@ describe('AddSingleTask', () => {
 		render(AddSingleTask, {
 			props: {
 				user: mockedUser,
-				addNewTasks: vi.fn()
+				addNewTasks: vi.fn(),
+				defaultGroupName: 'All'
 			}
 		});
 
@@ -68,7 +69,8 @@ describe('AddSingleTask', () => {
 		render(AddSingleTask, {
 			props: {
 				user: mockedUser,
-				addNewTasks: vi.fn()
+				addNewTasks: vi.fn(),
+				defaultGroupName: 'All'
 			}
 		});
 

__tests__/v2/TaskCollection.test.js

@@ -62,7 +62,7 @@ describe('TaskCollection', () => {
 			});
 
 		render(TaskCollection, {
-			props: { user: mockedUser }
+			props: { user: mockedUser, defaultGroupName: 'All' }
 		});
 
 		await user.type(screen.getByRole('textbox', { name: 'Package' }), 'test-task');
@@ -94,7 +94,7 @@ describe('TaskCollection', () => {
 			});
 
 		render(TaskCollection, {
-			props: { user: mockedUser }
+			props: { user: mockedUser, defaultGroupName: 'All' }
 		});
 
 		await user.type(screen.getByRole('textbox', { name: 'Package' }), 'test-task');
@@ -124,7 +124,7 @@ describe('TaskCollection', () => {
 			});
 
 		render(TaskCollection, {
-			props: { user: mockedUser }
+			props: { user: mockedUser, defaultGroupName: 'All' }
 		});
 
 		const addPpvBtn = screen.getByRole('button', { name: 'Add pinned package version' });

__tests__/v2/UserEditor.test.js

@@ -63,7 +63,8 @@ describe('UserEditor', () => {
 					slurm_accounts: [],
 					project_dir: null
 				},
-				saveUser: mockSaveUser
+				saveUser: mockSaveUser,
+				defaultGroupName: 'All'
 			}
 		});
 
@@ -109,7 +110,8 @@ describe('UserEditor', () => {
 					slurm_accounts: [],
 					project_dir: null
 				},
-				saveUser: mockSaveUser
+				saveUser: mockSaveUser,
+				defaultGroupName: 'All'
 			}
 		});
 
@@ -144,7 +146,8 @@ describe('UserEditor', () => {
 					slurm_accounts: [],
 					project_dir: '/path/to/project/dir'
 				},
-				saveUser: mockSaveUser
+				saveUser: mockSaveUser,
+				defaultGroupName: 'All'
 			}
 		});
 
@@ -185,7 +188,8 @@ describe('UserEditor', () => {
 					slurm_accounts: ['foo', 'bar'],
 					project_dir: '/path/to/project/dir'
 				},
-				saveUser: mockSaveUser
+				saveUser: mockSaveUser,
+				defaultGroupName: 'All'
 			}
 		});
 

docs/environment-variables.md

@@ -22,6 +22,7 @@ The following environment variables can be used to configure fractal-web.
 * `PUBLIC_FRACTAL_FEATURE_EXPLORER_URL`: URL to Fractal Feature Explorer (e.g. http://localhost:8501 for testing);
 * `WARNING_BANNER_PATH`: specifies the path to a text file containing the warning banner message displayed on the site; the banner is used to inform users about important issues, such as external resources downtime or maintenance alerts; if the variable is empty or unset no banner is displayed;
 * `NEWS_INFO_PATH`: specifies the path to a Markdown file containing the news section of the home page; the title of the section is automatically added; if the variable is empty or unset the news section is not displayed;
+* `FRACTAL_DEFAULT_GROUP_NAME`: specifies if a default group exists; allowed values are `All` or empty string (no default group).
 
 When running directly using `node` command these extra variables can also be configured:
 

docs/quickstart.md

@@ -69,6 +69,7 @@ export FRACTAL_RUNNER_BACKEND=local
 #export AUTH_COOKIE_PATH=/
 #export AUTH_COOKIE_SAME_SITE=lax
 #export PUBLIC_UPDATE_JOBS_INTERVAL=3000
+#export FRACTAL_DEFAULT_GROUP_NAME=
 
 node build/
 ```