Skip to content

Feature/grip optim#88

Merged
matthewpeterkort merged 25 commits intoohsu-developfrom
feature/grip-optim
Mar 31, 2026
Merged

Feature/grip optim#88
matthewpeterkort merged 25 commits intoohsu-developfrom
feature/grip-optim

Conversation

@matthewpeterkort
Copy link
Copy Markdown
Collaborator

@matthewpeterkort matthewpeterkort commented Mar 13, 2026

Tiny PR related to release helm on prod.
Release PR

@bwalsh
Copy link
Copy Markdown
Collaborator

bwalsh commented Mar 31, 2026

ADR: Gecko Left Navigation Updates for feature/grip-optim

  • Status: Accepted
  • Date: 2026-03-31
  • Branch: feature/grip-optim
  • Compared Against: ohsu-develop
  • Scope: All effective branch changes

Context

This ADR documents the net/effective changes introduced by this branch relative to ohsu-develop.

Branch comparison shows one modified file:

  • helm/gecko/files/init-data/nav.json

Net diff size:

  • 1 file changed
  • 8 insertions, 1 deletion

Decision

Update Gecko navigation configuration to improve route correctness and expose query functionality.

Change 1: Correct Directory Structure route

In helm/gecko/files/init-data/nav.json:

  • title: Directory Structure
  • href: changed from /Miller to /Browser

Change 2: Add GraphQL Query navigation entry

In helm/gecko/files/init-data/nav.json, add a new left-nav entry:

  • title: GraphQL Query
  • description: Query graph databases via a web interface
  • icon: /icons/query.svg
  • href: /Query
  • perms: null

Rationale

  • /Browser aligns the Directory Structure menu item with the intended browser route.
  • Adding GraphQL Query makes graph query tooling directly discoverable from the main navigation.
  • Keeping perms: null matches the existing access pattern used by peer nav items in this file.

Consequences

  • Users selecting Directory Structure now land on /Browser instead of /Miller.
  • Users gain a new top-level entry to access /Query.
  • Deployments that consume this nav seed data will present the updated left navigation after init/update.

Alternatives Considered

  • Keep /Miller route: rejected due to route naming/intent mismatch.
  • Do not add GraphQL nav item: rejected because it keeps query functionality less discoverable.

@bwalsh
Copy link
Copy Markdown
Collaborator

bwalsh commented Mar 31, 2026

PR Review: feature/grip-optim vs ohsu-develop

Scope Reviewed

  • helm/gecko/files/init-data/nav.json

Findings (ordered by severity)

Medium

  1. No automated validation for route-level nav changes
    • File/lines: helm/gecko/files/init-data/nav.json:59, helm/gecko/files/init-data/nav.json:80
    • Why this matters (testability/maintenance): This PR changes one existing route target (/Miller -> /Browser) and introduces a new route (/Query) with no automated guard that these links remain valid after future refactors. Without a test or CI check, link regressions are likely to be caught only in manual QA or production.
    • Recommendation: Add one lightweight automated check, for example:
      • a CI script that validates leftnav[*].href values against an allowed route manifest, or
      • an e2e smoke test asserting each left-nav item returns a successful page load.

Readability Review

  • JSON structure remains clean and consistent with neighboring nav entries.
  • New GraphQL Query item is easy to understand from title/description and follows existing key conventions.

Maintenance Review

  • Change size is small and localized (single file), which lowers maintenance cost.
  • Main long-term risk is route drift; adding the single automated check above would materially improve maintainability.

Validation Performed

  • Verified effective PR diff scope with git branch diff commands.
  • Parsed JSON successfully:
    • python3 -m json.tool helm/gecko/files/init-data/nav.json

Open Questions

  1. Is there an existing route contract/source-of-truth for Gecko pages that leftnav can validate against in CI?
  2. Confirm: Should /Query be visible to all users (perms: null), or should it be permission-gated like other potentially sensitive views?

@matthewpeterkort matthewpeterkort merged commit 44d7419 into ohsu-develop Mar 31, 2026
1 check passed
@matthewpeterkort matthewpeterkort deleted the feature/grip-optim branch March 31, 2026 22:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants