feat: add user groups to api

README.md

@@ -33,4 +33,4 @@ The current code base is geared towards a Janelia deployment, but we are working
 
 - [fileglancer-central](https://github.com/JaneliaSciComp/fileglancer-central) - Central server managing access to a shared database and other resources
 - [fileglancer-hub](https://github.com/JaneliaSciComp/fileglancer-hub) - Deployment of Fileglancer into JupyterHub
-- [fileglancer-user-docs](https://github.com/JaneliaSciComp/fileglancer-docs) - User guide
+- [fileglancer-docs](https://github.com/JaneliaSciComp/fileglancer-docs) - User guide

docs/Development.md

@@ -96,9 +96,16 @@ pixi run test-frontend
 
 This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
 More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
-More information are provided within the [ui-tests](../ui-tests/README.md) README.
 
-To execute the UI integration test, run:
+To execute the UI integration tests:
+
+Install test dependencies (needed only once):
+
+```bash
+pixi run npm --prefix ui-tests npx playwright install
+```
+
+Then run the tests with:
 
 ```bash
 pixi run ui-test

fileglancer/handlers.py

@@ -2,6 +2,8 @@
 import json
 import requests
 import re
+import grp
+import pwd
 from datetime import datetime, timezone
 from abc import ABC
 from mimetypes import guess_type
@@ -52,10 +54,11 @@ def _get_mounted_filestore(fsp):
     except FileNotFoundError:
         return None
     return filestore
-
+    
 
 class BaseHandler(APIHandler):
     _home_file_share_path_cache = {}
+    _groups_cache = {}
 
     def get_current_user(self):
         """
@@ -98,6 +101,36 @@ def get_home_file_share_path_name(self):
         return None
 
 
+    def get_user_groups(self):
+        """
+        Get the groups for the current user.
+
+        Returns:
+            list: List of group names the user belongs to.
+        """
+        username = self.get_current_user()
+
+        if username in self._groups_cache:
+            return self._groups_cache[username]
+
+        try:
+            user_info = pwd.getpwnam(username)
+            user_groups = []
+            all_groups = grp.getgrall()  # Get all groups on the system
+            for group in all_groups:
+                if username in group.gr_mem:  # Check if user is a member of this group
+                    user_groups.append(group.gr_name)
+            primary_group = grp.getgrgid(user_info.pw_gid).gr_name
+            if primary_group not in user_groups: # Add primary group if not already included
+                user_groups.append(primary_group)
+            self._groups_cache[username] = user_groups
+            return user_groups
+        except Exception as e:
+            self.log.error(f"Error getting groups for user {username}: {str(e)}")
+            self._groups_cache[username] = []
+            return []
+
+
 class StreamingProxy(BaseHandler):
     """
     API handler for proxying responses from the central server
@@ -132,6 +165,7 @@ class FileSharePathsHandler(BaseHandler):
     def get(self):
         self.log.info("GET /api/fileglancer/file-share-paths")
         file_share_paths = get_fsp_manager(self.settings).get_file_share_paths()
+
         self.set_header('Content-Type', 'application/json')
         self.set_status(200)
         # Convert Pydantic objects to dicts before JSON serialization
@@ -140,7 +174,6 @@ def get(self):
         self.finish()
 
 
-
 class FileShareHandler(BaseHandler, ABC):
     """
     Abstract base handler for endpoints that use the Filestore class.
@@ -1028,11 +1061,13 @@ def get(self):
         username = self.get_current_user()
         home_fsp_name = self.get_home_file_share_path_name()
         home_directory_name = os.path.basename(self.get_home_directory_path())
-        self.log.info(f"GET /api/fileglancer/profile username={username} home_fsp_name={home_fsp_name} home_directory_name={home_directory_name}")
+        groups = self.get_user_groups()
+        self.log.info(f"GET /api/fileglancer/profile username={username} home_fsp_name={home_fsp_name} home_directory_name={home_directory_name} groups={groups}")
         response = {
             "username": username,
             "homeFileSharePathName": home_fsp_name,
             "homeDirectoryName": home_directory_name,
+            "groups": groups,
         }
         try:
             self.set_status(200)

src/__tests__/test-utils.tsx

@@ -14,6 +14,7 @@ import { OpenFavoritesProvider } from '@/contexts/OpenFavoritesContext';
 import { TicketProvider } from '@/contexts/TicketsContext';
 import { ProfileContextProvider } from '@/contexts/ProfileContext';
 import { ExternalBucketProvider } from '@/contexts/ExternalBucketContext';
+import { CentralServerHealthProvider } from '@/contexts/CentralServerHealthContext';
 import ErrorFallback from '@/components/ErrorFallback';
 
 interface CustomRenderOptions extends Omit<RenderOptions, 'wrapper'> {
@@ -39,21 +40,23 @@ const FileBrowserTestingWrapper = ({
 const Browse = ({ children }: { children: React.ReactNode }) => {
   return (
     <CookiesProvider>
-      <ZonesAndFspMapContextProvider>
-        <OpenFavoritesProvider>
-          <FileBrowserTestingWrapper>
-            <PreferencesProvider>
-              <ExternalBucketProvider>
-                <ProxiedPathProvider>
-                  <ProfileContextProvider>
-                    <TicketProvider>{children}</TicketProvider>
-                  </ProfileContextProvider>
-                </ProxiedPathProvider>
-              </ExternalBucketProvider>
-            </PreferencesProvider>
-          </FileBrowserTestingWrapper>
-        </OpenFavoritesProvider>
-      </ZonesAndFspMapContextProvider>
+      <CentralServerHealthProvider>
+        <ZonesAndFspMapContextProvider>
+          <OpenFavoritesProvider>
+            <FileBrowserTestingWrapper>
+              <PreferencesProvider>
+                <ExternalBucketProvider>
+                  <ProxiedPathProvider>
+                    <ProfileContextProvider>
+                      <TicketProvider>{children}</TicketProvider>
+                    </ProfileContextProvider>
+                  </ProxiedPathProvider>
+                </ExternalBucketProvider>
+              </PreferencesProvider>
+            </FileBrowserTestingWrapper>
+          </OpenFavoritesProvider>
+        </ZonesAndFspMapContextProvider>
+      </CentralServerHealthProvider>
     </CookiesProvider>
   );
 };

src/components/Preferences.tsx

@@ -11,11 +11,13 @@ export default function Preferences() {
     pathPreference,
     handlePathPreferenceSubmit,
     hideDotFiles,
+    isFilteredByGroups,
     toggleHideDotFiles,
     disableNeuroglancerStateGeneration,
     toggleDisableNeuroglancerStateGeneration,
     disableHeuristicalLayerTypeDetection,
-    toggleDisableHeuristicalLayerTypeDetection
+    toggleDisableHeuristicalLayerTypeDetection,
+    toggleFilterByGroups
   } = usePreferencesContext();
 
   return (
@@ -124,6 +126,34 @@ export default function Preferences() {
           <Typography className="font-semibold">Options:</Typography>
         </Card.Header>
         <Card.Body className="flex flex-col gap-4 pb-4">
+          <div className="flex items-center gap-2">
+            <input
+              checked={isFilteredByGroups}
+              className="icon-small checked:accent-secondary-light"
+              id="is_filtered_by_groups"
+              onChange={async () => {
+                const result = await toggleFilterByGroups();
+                if (result.success) {
+                  toast.success(
+                    !isFilteredByGroups
+                      ? 'Only Zones for groups you have membership in are now visible'
+                      : 'All Zones are now visible'
+                  );
+                } else {
+                  toast.error(result.error);
+                }
+              }}
+              type="checkbox"
+            />
+            <Typography
+              as="label"
+              className="text-foreground"
+              htmlFor="is_filtered_by_groups"
+            >
+              Display Zones for your groups only
+            </Typography>
+          </div>
+
           <div className="flex items-center gap-2">
             <input
               checked={hideDotFiles}

src/components/ui/Sidebar/FavoritesBrowser.tsx

@@ -75,10 +75,10 @@ export default function FavoritesBrowser({
           displayFolders.length === 0 ? (
             <div className="px-4 py-6 text-center">
               <Typography className="text-sm text-gray-500">
-                No favorites match your filter.
+                No favorites match your filter '{searchQuery}'
               </Typography>
               <Typography className="text-xs text-gray-400 mt-1">
-                Try broadening your search to see more results.
+                Try broadening your search to see more results
               </Typography>
             </div>
           ) : (

src/components/ui/Sidebar/Sidebar.tsx

@@ -4,7 +4,7 @@ import { HiOutlineFunnel, HiXMark } from 'react-icons/hi2';
 
 import FavoritesBrowser from './FavoritesBrowser';
 import ZonesBrowser from './ZonesBrowser';
-import useSearchFilter from '@/hooks/useSearchFilter';
+import useFilteredZonesAndFavorites from '@/hooks/useFilteredZonesAndFavorites';
 
 export default function Sidebar() {
   const {
@@ -15,7 +15,8 @@ export default function Sidebar() {
     filteredZoneFavorites,
     filteredFileSharePathFavorites,
     filteredFolderFavorites
-  } = useSearchFilter();
+  } = useFilteredZonesAndFavorites();
+
   return (
     <Card className="min-w-full h-full overflow-hidden rounded-none bg-surface shadow-lg flex flex-col pl-3">
       <div className="my-3 short:my-1 relative">

src/components/ui/Sidebar/ZonesBrowser.tsx

@@ -4,9 +4,11 @@ import { HiSquares2X2 } from 'react-icons/hi2';
 
 import { ZonesAndFileSharePathsMap } from '@/shared.types';
 import { useZoneAndFspMapContext } from '@/contexts/ZonesAndFspMapContext';
+import { usePreferencesContext } from '@/contexts/PreferencesContext';
 import useOpenZones from '@/hooks/useOpenZones';
 import Zone from './Zone';
 import { SidebarItemSkeleton } from '@/components/ui/widgets/Loaders';
+import { Link } from 'react-router';
 
 export default function ZonesBrowser({
   searchQuery,
@@ -17,6 +19,7 @@ export default function ZonesBrowser({
 }) {
   const { zonesAndFileSharePathsMap, areZoneDataLoading } =
     useZoneAndFspMapContext();
+  const { isFilteredByGroups } = usePreferencesContext();
   const { openZones, toggleOpenZones } = useOpenZones();
 
   const displayZones: ZonesAndFileSharePathsMap =
@@ -58,10 +61,10 @@ export default function ZonesBrowser({
             Object.keys(displayZones).length === 0 ? (
               <div className="px-4 py-6 text-center">
                 <Typography className="text-sm text-gray-500">
-                  No zones match your filter.
+                  No zones match your filter '{searchQuery}'
                 </Typography>
                 <Typography className="text-xs text-gray-400 mt-1">
-                  Try broadening your search to see more results.
+                  Try broadening your search to see more results
                 </Typography>
               </div>
             ) : (
@@ -78,6 +81,36 @@ export default function ZonesBrowser({
                 }
               })
             )}
+
+            <div className="px-4 py-6 text-center">
+              {isFilteredByGroups ? (
+                <>
+                  <Typography className="text-sm text-gray-500">
+                    Viewing Zones for your groups only
+                  </Typography>
+                  <Typography className="text-xs text-gray-400 mt-1">
+                    Modify your{' '}
+                    <Link className="text-primary underline" to="/preferences">
+                      preferences
+                    </Link>{' '}
+                    to see all Zones
+                  </Typography>
+                </>
+              ) : (
+                <>
+                  <Typography className="text-sm text-gray-500">
+                    Viewing all Zones
+                  </Typography>
+                  <Typography className="text-xs text-gray-400 mt-1">
+                    Modify your{' '}
+                    <Link className="text-primary underline" to="/preferences">
+                      preferences
+                    </Link>{' '}
+                    to see Zones for your groups only
+                  </Typography>
+                </>
+              )}
+            </div>
           </List>
         )}
       </Collapse>