Further implementation, switched to ReactQuery v5

backend/src/backend/primary/exceptions.py

@@ -0,0 +1,4 @@
+class ResultNotMatchingExpectations(Exception):
+    def __init__(self, message: str):
+        self.message = message
+        super().__init__(self.message)

backend/src/backend/primary/main.py

@@ -1,7 +1,8 @@
 import datetime
 import logging
 
-from fastapi import FastAPI
+from fastapi import FastAPI, Request
+from fastapi.responses import JSONResponse
 from fastapi.routing import APIRoute
 from fastapi.responses import ORJSONResponse
 from uvicorn.middleware.proxy_headers import ProxyHeadersMiddleware
@@ -24,6 +25,7 @@
 from .routers.surface_polygons.router import router as surface_polygons_router
 from .routers.graph.router import router as graph_router
 from .routers.observations.router import router as observations_router
+from .exceptions import ResultNotMatchingExpectations
 
 logging.basicConfig(
     level=logging.WARNING,
@@ -83,3 +85,15 @@ def custom_generate_unique_id(route: APIRoute) -> str:
 @app.get("/")
 async def root() -> str:
     return f"Backend is alive at this time: {datetime.datetime.now()}"
+
+@app.exception_handler(Exception)
+async def exception_handler(request: Request, exc: Exception):
+    if isinstance(exc, ResultNotMatchingExpectations):
+        return JSONResponse(
+            status_code=404,
+            content={"message": exc.message},
+        )
+    return JSONResponse(
+        status_code=500,
+        content={"message": exc},
+    )

backend/src/backend/primary/routers/inplace_volumetrics/router.py

@@ -12,25 +12,26 @@
 
 from src.backend.auth.auth_helper import AuthHelper
 
+from src.backend.primary.exceptions import ResultNotMatchingExpectations
+
 
 router = APIRouter()
 
 
-@router.get("/table_names_and_descriptions/", tags=["inplace_volumetrics"])
-async def get_table_names_and_descriptions(
+@router.get("/table_names_and_metadata/", tags=["inplace_volumetrics"])
+async def get_table_names_and_metadata(
     # fmt:off
     authenticated_user: AuthenticatedUser = Depends(AuthHelper.get_authenticated_user),
     case_uuid: str = Query(description="Sumo case uuid"),
     ensemble_name: str = Query(description="Ensemble name"),
     # fmt:on
 ) -> List[InplaceVolumetricsTableMetaData]:
     """Get all volumetric tables for a given ensemble."""
-
     access = await InplaceVolumetricsAccess.from_case_uuid(
         authenticated_user.get_sumo_access_token(), case_uuid, ensemble_name
     )
-    table_names = access.get_table_names_and_metadata()
-    return table_names
+    table_names_and_metadata = await access.get_table_names_and_metadata()
+    return table_names_and_metadata
 
 
 @router.post("/realizations_response/", tags=["inplace_volumetrics"])

backend/src/services/sumo_access/inplace_volumetrics_access.py

@@ -57,14 +57,14 @@ def has_value(cls, value: str) -> bool:
 class InplaceVolumetricsCategoricalMetaData(BaseModel):
     name: str
     unique_values: List[Union[str, int, float]]
-    model_config = ConfigDict(from_attributes=True)
+    model_config = ConfigDict(from_attributes=True) # Might be removed
 
 
 class InplaceVolumetricsTableMetaData(BaseModel):
     name: str
     categorical_column_metadata: List[InplaceVolumetricsCategoricalMetaData]
     numerical_column_names: List[str]
-    model_config = ConfigDict(from_attributes=True)
+    model_config = ConfigDict(from_attributes=True) # Might be removed
 
 
 class InplaceVolumetricsAccess(SumoEnsemble):
@@ -73,11 +73,12 @@ async def get_table_names_and_metadata(self) -> List[InplaceVolumetricsTableMeta
         vol_table_collections: TableCollection = self._case.tables.filter(
             aggregation="collection", tagname="vol", iteration=self._iteration_name
         )
+
         vol_tables_metadata = []
-        async for vol_table_name in vol_table_collections.names:
+        async for vol_table in vol_table_collections:
             vol_table_collection: TableCollection = self._case.tables.filter(
                 aggregation="collection",
-                name=vol_table_name,
+                name=vol_table.name,
                 tagname="vol",
                 iteration=self._iteration_name,
             )
@@ -86,7 +87,7 @@ async def get_table_names_and_metadata(self) -> List[InplaceVolumetricsTableMeta
                 for col in vol_table_collection.columns
                 if PossibleInplaceVolumetricsNumericalColumnNames.has_value(col)
             ]
-            first_numerical_column_table = self.get_table(vol_table_name, numerical_column_names[0])
+            first_numerical_column_table = self.get_table(vol_table.name, numerical_column_names[0])
             categorical_column_metadata = [
                 InplaceVolumetricsCategoricalMetaData(
                     name=col,
@@ -96,7 +97,7 @@ async def get_table_names_and_metadata(self) -> List[InplaceVolumetricsTableMeta
                 if PossibleInplaceVolumetricsCategoricalColumnNames.has_value(col)
             ]
             vol_table_metadata = InplaceVolumetricsTableMetaData(
-                name=vol_table_name,
+                name=vol_table.name,
                 categorical_column_metadata=categorical_column_metadata,
                 numerical_column_names=numerical_column_names,
             )

frontend/package.json

@@ -18,8 +18,8 @@
         "@headlessui/react": "^1.7.8",
         "@mui/base": "^5.0.0-beta.3",
         "@mui/icons-material": "^5.14.9",
-        "@tanstack/react-query": "^4.24.10",
-        "@tanstack/react-query-devtools": "^4.24.12",
+        "@tanstack/react-query": "^5.0.5",
+        "@tanstack/react-query-devtools": "^5.4.2",
         "@webviz/subsurface-viewer": "^0.3.1",
         "@webviz/well-completions-plot": "^0.0.1-alpha.1",
         "animate.css": "^4.1.1",

frontend/src/App.tsx

@@ -26,10 +26,7 @@ function App() {
 
         const storedEnsembleIdents = workbench.current.maybeLoadEnsembleSetFromLocalStorage();
         if (storedEnsembleIdents) {
-            workbench.current.getGuiMessageBroker().setState(GuiState.LoadingEnsembleSet, true);
-            workbench.current.loadAndSetupEnsembleSetInSession(queryClient, storedEnsembleIdents).then(() => {
-                workbench.current.getGuiMessageBroker().setState(GuiState.LoadingEnsembleSet, false);
-            });
+            workbench.current.loadAndSetupEnsembleSetInSession(queryClient, storedEnsembleIdents);
         }
 
         return function handleUnmount() {

frontend/src/api/services/InplaceVolumetricsService.ts

@@ -13,20 +13,20 @@ export class InplaceVolumetricsService {
     constructor(public readonly httpRequest: BaseHttpRequest) {}
 
     /**
-     * Get Table Names And Descriptions
+     * Get Table Names And Metadata
      * Get all volumetric tables for a given ensemble.
      * @param caseUuid Sumo case uuid
      * @param ensembleName Ensemble name
      * @returns InplaceVolumetricsTableMetaData Successful Response
      * @throws ApiError
      */
-    public getTableNamesAndDescriptions(
+    public getTableNamesAndMetadata(
         caseUuid: string,
         ensembleName: string,
     ): CancelablePromise<Array<InplaceVolumetricsTableMetaData>> {
         return this.httpRequest.request({
             method: 'GET',
-            url: '/inplace_volumetrics/table_names_and_descriptions/',
+            url: '/inplace_volumetrics/table_names_and_metadata/',
             query: {
                 'case_uuid': caseUuid,
                 'ensemble_name': ensembleName,

frontend/src/framework/GuiMessageBroker.ts

@@ -15,7 +15,6 @@ export enum DrawerContent {
 export enum GuiState {
     DrawerContent = "drawerContent",
     SettingsPanelWidthInPercent = "settingsPanelWidthInPercent",
-    LoadingEnsembleSet = "loadingEnsembleSet",
     ActiveModuleInstanceId = "activeModuleInstanceId",
     DataChannelConnectionLayerVisible = "dataChannelConnectionLayerVisible",
 }
@@ -69,15 +68,13 @@ export type GuiEventPayloads = {
 type GuiStateValueTypes = {
     [GuiState.DrawerContent]: DrawerContent;
     [GuiState.SettingsPanelWidthInPercent]: number;
-    [GuiState.LoadingEnsembleSet]: boolean;
     [GuiState.ActiveModuleInstanceId]: string;
     [GuiState.DataChannelConnectionLayerVisible]: boolean;
 };
 
 const defaultStates: Map<GuiState, any> = new Map();
 defaultStates.set(GuiState.DrawerContent, DrawerContent.ModuleSettings);
 defaultStates.set(GuiState.SettingsPanelWidthInPercent, 30);
-defaultStates.set(GuiState.LoadingEnsembleSet, false);
 defaultStates.set(GuiState.ActiveModuleInstanceId, "");
 
 const persistentStates: GuiState[] = [GuiState.SettingsPanelWidthInPercent];

frontend/src/framework/Workbench.ts

@@ -224,6 +224,7 @@ export class Workbench {
         }
 
         console.debug("loadAndSetupEnsembleSetInSession - starting load");
+        this._workbenchSession.setEnsembleSetLoadingState(true);
         const newEnsembleSet = await loadEnsembleSetMetadataFromBackend(queryClient, ensembleIdentsToLoad);
         console.debug("loadAndSetupEnsembleSetInSession - loading done");