Merge pull request #1496 from FZJ-INM1-BDA/staging

xgui3783 · web-flow · commit 46039ec65347 · 2025-05-28T11:51:21.000+02:00
v2.14.21
diff --git a/.github/workflows/deploy-helm.yml b/.github/workflows/deploy-helm.yml
@@ -63,6 +63,7 @@ jobs:
           --history-max 3 \
           --reuse-values \
           --set image.tag=${{ inputs.IMAGE_TAG }} \
+          --set envObj.OVERWRITE_API_ENDPOINT="https://siibra-api-rc.apps.ebrains.eu/v3_0" \
           --set podAnnotations.image-digest=${{ inputs.IMAGE_DIGEST }} \
           ${{ inputs.DEPLOYMENT_NAME }} .helm/siibra-explorer/ \
         || helm --kubeconfig=$kubecfg_path \
diff --git a/.helm/siibra-explorer/Chart.yaml b/.helm/siibra-explorer/Chart.yaml
@@ -15,10 +15,10 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.6
+version: 0.1.7
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "2.14.19"
+appVersion: "2.14.21"
diff --git a/.helm/siibra-explorer/values.yaml b/.helm/siibra-explorer/values.yaml
@@ -87,6 +87,6 @@ tolerations: []
 affinity: {}
 
 envObj:
-  OVERWRITE_SPATIAL_ENDPOINT: https://siibra-spatial-backend.apps.tc.humanbrainproject.eu
+  OVERWRITE_SPATIAL_ENDPOINT: https://siibra-spatial-backend.apps.ebrains.eu
   HOST_PATHNAME: /viewer
   OVERWRITE_API_ENDPOINT: https://siibra-api.apps.ebrains.eu/v3_0
diff --git a/backend/app/sane_url.py b/backend/app/sane_url.py
@@ -145,6 +145,9 @@ def delete(self, key: str):
 async def get_short(short_id:str, request: Request):
     accept = request.headers.get("Accept", "")
     is_browser = "text/html" in accept
+    headers = {
+        "Vary": "accept"
+    }
     try:
         existing_json: Dict[str, Any] = data_proxy_store.get(short_id)
         if is_browser:
@@ -157,17 +160,17 @@ async def get_short(short_id:str, request: Request):
 
             extra_routes_str = "" if len(extra_routes) == 0 else ("/" + "/".join(extra_routes))
 
-            return RedirectResponse(f"{HOST_PATHNAME}/#{hashed_path}{extra_routes_str}")
-        return JSONResponse(existing_json)
+            return RedirectResponse(f"{HOST_PATHNAME}/#{hashed_path}{extra_routes_str}", headers=headers)
+        return JSONResponse(existing_json, headers=headers)
     except DataproxyStore.NotFound as e:
         if is_browser:
             request.session[ERROR_KEY] = f"Short ID {short_id} not found."
-            return RedirectResponse(HOST_PATHNAME or "/")
+            return RedirectResponse(HOST_PATHNAME or "/", headers=headers)
         raise HTTPException(404, str(e))
     except DataproxyStore.GenericException as e:
         if is_browser:
             request.session[ERROR_KEY] = f"Error: {str(e)}"
-            return RedirectResponse(HOST_PATHNAME or "/")
+            return RedirectResponse(HOST_PATHNAME or "/", headers=headers)
         raise HTTPException(500, str(e))
 
 
diff --git a/codemeta.json b/codemeta.json
@@ -91,7 +91,7 @@
     ],
     "codeRepository": "git+https://github.com/fzj-inm1-bda/siibra-explorer.git",
     "dateCreated": "2024-08-28",
-    "dateModified": "2025-05-23",
+    "dateModified": "2025-05-28",
     "datePublished": "2019-04-26",
     "description": "`siibra-explorer` is a browser based 3D viewer for exploring brain atlases that cover different spatial resolutions and modalities. It is built around an interactive 3D view of the brain displaying a unique selection of detailed templates and parcellation maps for the human, macaque, rat or mouse brain, including BigBrain as a microscopic resolution human brain model at its full resolution of 20 micrometers. ",
     "license": "https://spdx.org/licenses/Apache-2.0",
@@ -100,9 +100,9 @@
         "python 3",
         "typescript"
     ],
-    "schema:releaseNotes": "# v2.14.20\n\n## Feature\n\n- Show/Hide delineation now persist in state\n- (experimental) glass brain\n\n## Bugfix\n\n- Fixed some instability of annotation mode. \n\n## Behind the scenes\n\n- Clarified authors & contributors\n- Improve performance by batching adding & removing layers\n- Added text to reflect that annoations will also be shared\n- Enabled viewer config in experimental mode\n",
+    "schema:releaseNotes": "# v2.14.21\n\n## Bugfix\n\n- fix the URL of older versions of explorer incorrectly showing delineation flag\n- fix annotation vary header",
     "runtimePlatform": "docker",
-    "version": "2.14.20",
+    "version": "2.14.21",
     "contIntegration": "https://github.com/FZJ-INM1-BDA/siibra-explorer/actions",
     "codemeta:continuousIntegration": {
         "id": "https://github.com/FZJ-INM1-BDA/siibra-explorer/actions"
diff --git a/docs/releases/v2.14.21.md b/docs/releases/v2.14.21.md
@@ -0,0 +1,6 @@
+# v2.14.21
+
+## Bugfix
+
+- fix the URL of older versions of explorer incorrectly showing delineation flag
+- fix annotation vary header
diff --git a/features/saneurl.feature b/features/saneurl.feature
@@ -62,6 +62,18 @@ Feature: SaneURL a.k.a. URL shortener
         Given <https://atlases.ebrains.eu/viewer-staging/saneUrl/stnr>
         Then Works
     
+    Scenario: Permalink works (PMAP)
+        Given <https://atlases.ebrains.eu/viewer-staging/go/BST_r_MNI152>
+        Then Works
+
+    Scenario: Permalink works (MPM)
+        Given <https://atlases.ebrains.eu/viewer-staging/go/BST_r_MPM_MNI152>
+        Then Works
+    
+    Scenario: Permalink works (no delineation overlay)
+        Given <https://atlases.ebrains.eu/viewer-staging/go/BST_BigBrain_1um>
+        Then Works
+    
 
     Scenario: VIP link works (human)
         Given <https://atlases.ebrains.eu/viewer-staging/human>
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -46,6 +46,7 @@ nav:
     - Plugin API: "advanced/api/README.md"
 
   - Release notes:
+    - v2.14.21: 'releases/v2.14.21.md'
     - v2.14.20: 'releases/v2.14.20.md'
     - v2.14.19: 'releases/v2.14.19.md'
     - v2.14.18: 'releases/v2.14.18.md'
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "siibra-explorer",
-  "version": "2.14.20",
+  "version": "2.14.21",
   "description": "siibra-explorer - explore brain atlases. Based on humanbrainproject/nehuba & google/neuroglancer. Built with angular",
   "scripts": {
     "lint": "eslint src --ext .ts",
@@ -11,7 +11,7 @@
     "watch": "ng build --watch --configuration development",
     "test": "ng test",
     "test-ci": "ng test --progress false --watch false --browsers=ChromeHeadless",
-    "sapi-schema": "curl 'https://siibra-api-stable.apps.hbp.eu/v3_0/openapi.json' | jq > ./src/atlasComponents/sapi/openapi.json && npx openapi-typescript@6.1.0 ./src/atlasComponents/sapi/openapi.json --output ./src/atlasComponents/sapi/schemaV3.ts && eslint ./src/atlasComponents/sapi/schemaV3.ts --no-ignore --fix",
+    "sapi-schema": "curl 'https://siibra-api.ebrains.hbp.eu/v3_0/openapi.json' | jq > ./src/atlasComponents/sapi/openapi.json && npx openapi-typescript@6.1.0 ./src/atlasComponents/sapi/openapi.json --output ./src/atlasComponents/sapi/schemaV3.ts && eslint ./src/atlasComponents/sapi/schemaV3.ts --no-ignore --fix",
     "api-schema": "node src/api/generateSchema.mjs",
     "prepare-release": "node .prepare_release.mjs"
   },
diff --git a/src/routerModule/routeStateTransform.service.ts b/src/routerModule/routeStateTransform.service.ts
@@ -78,7 +78,10 @@ const decodeMiscState = {
 
     const [ octantRemoval, showDelineation ] = decodeBool(array[2])
     returnVal.octantRemoval = octantRemoval
-    returnVal.showDelineation = showDelineation
+
+    // this is to fix the v1 implementation where the showdelineation is accidentally flipped
+    // see https://github.com/FZJ-INM1-BDA/siibra-explorer/blob/b38e7948fc1c3e36f219aaa12c64726b34b5e132/src/routerModule/routeStateTransform.service.ts#L369
+    returnVal.showDelineation = !showDelineation
     
     return returnVal
   },
@@ -108,6 +111,9 @@ const decodeMiscState = {
     
     const returnVal: ViewerCfgStateV2 = {
       ...v1State,
+      // this is to fix the v1 implementation where the showdelineation is accidentally flipped
+      // see https://github.com/FZJ-INM1-BDA/siibra-explorer/blob/b38e7948fc1c3e36f219aaa12c64726b34b5e132/src/routerModule/routeStateTransform.service.ts#L369
+      showDelineation: !v1State.showDelineation,
       auxMeshAlpha: meshAlpha,
       panelOrder: panelOrder.join(""),
     }
@@ -294,7 +300,6 @@ export class RouteStateTransformSvc {
       const { panelMode, panelOrder, showDelineation, octantRemoval, auxMeshAlpha } = !!viewerConfigState
       ? this.decodeMiscState(viewerConfigState)
       : { panelMode: "FOUR_PANEL" as const, panelOrder: "0123", showDelineation: true, octantRemoval: true, auxMeshAlpha: 1.0 }
-  
       returnState['[state.ui]'].panelMode = panelMode
       returnState['[state.ui]'].panelOrder = panelOrder
 
diff --git a/src/util/fn.spec.ts b/src/util/fn.spec.ts
@@ -2,7 +2,7 @@ import { fakeAsync, tick } from '@angular/core/testing'
 import { hot } from 'jasmine-marbles'
 import { Observable, of } from 'rxjs'
 import { switchMap } from 'rxjs/operators'
-import { switchMapWaitFor, bufferUntil, arrayOfPrimitiveEqual } from './fn'
+import { switchMapWaitFor, bufferUntil, arrayOfPrimitiveEqual, encodeBool, decodeBool } from './fn'
 
 describe(`> util/fn.ts`, () => {
 
@@ -127,4 +127,22 @@ describe(`> util/fn.ts`, () => {
       })
     }
   })
+
+  describe("> encode decode bools", () => {
+    const testcases = [
+      [true, true],
+      [false, false],
+      [true, false],
+      [false, true],
+    ]
+    for (const testcase of testcases){
+      it(`> works for ${testcase}`, () => {
+        const encoded = encodeBool(...testcase)
+        const decoded = decodeBool(encoded)
+        expect(
+          decoded.slice(0, testcase.length)
+        ).toEqual(testcase)
+      })
+    }
+  })
 })
diff --git a/src/util/fn.ts b/src/util/fn.ts
@@ -443,7 +443,8 @@ export async function waitFor(predicate: () => boolean) {
     if (predicate()) break
     await wait(16)
   }
-}export function encodeBool(...flags: boolean[]) {
+}
+export function encodeBool(...flags: boolean[]) {
   if (flags.length > 8) {
     throw new Error(`encodeBool can only handle upto 8 bools`)
   }
