Skip to content

Conversation

coodos
Copy link
Contributor

@coodos coodos commented Aug 24, 2025

Description of change

Issue Number

Type of change

  • Breaking (any change that would cause existing functionality to not work as expected)
  • New (a change which implements a new feature)
  • Update (a change which updates existing functionality)
  • Fix (a change which fixes an issue)
  • Docs (changes to the documentation)
  • Chore (refactoring, build scripts or anything else that isn't user-facing)

How the change has been tested

Change checklist

  • I have ensured that the CI Checks pass locally
  • I have removed any unnecessary logic
  • My code is well documented
  • I have signed my commits
  • My code follows the pattern of the application
  • I have self reviewed my code

Summary by CodeRabbit

  • New Features
    • Control Panel: New eVault Management view with cache status panel, table layout, improved loading/empty/error states, manual refresh/cache clear, and clearer status badges. Service URLs now use discovered external IPs for NodePort access.
    • EVaults: Smarter caching with background refresh for faster, resilient loads.
    • eVoting App: Added “Group” column to All Polls.
    • API: Group-aware access control—poll fetching and voting now respect group membership.
  • Chores
    • Updated a dependency in the control panel.

@coodos coodos merged commit c196fd6 into main Aug 24, 2025
0 of 3 checks passed
Copy link
Contributor

coderabbitai bot commented Aug 24, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Refactors control panel caching and eVault retrieval with lazy server-only LowDB initialization, background cache refresh, and improved error/UI states. Updates Kubernetes service IP discovery for NodePort URLs. Adds group-aware access control for polls and voting, and exposes poll-group data in API and UI. Also adds a “Group” column in the eVoting app.

Changes

Cohort / File(s) Summary
Control Panel UI: eVault list
infrastructure/control-panel/src/lib/components/EVaultList.svelte
Adds explicit error state, typed cache status, timestamp formatter, table-based eVault view, refined loading/empty states, and reworked load/refresh/clear handlers with try/catch/finally.
Control Panel Cache Service (LowDB lazy init)
infrastructure/control-panel/src/lib/services/cacheService.ts
Converts to lazy, server-only LowDB initialization; introduces browser no-op guards; updates methods to async where needed; adjusts read/write paths and default statuses.
Control Panel eVault Service (cache strategy)
infrastructure/control-panel/src/lib/services/evaultService.ts
Simplifies to cached reads with background refresh; adds forceRefresh/clearCache/getCacheStatus; validates direct fetches; removes per-eVault logs/details/metrics methods.
Control Panel API: eVaults server route
infrastructure/control-panel/src/routes/api/evaults/+server.ts
Replaces static minikube IP with node ExternalIP/InternalIP discovery, with fallbacks and updated logging; NodePort URLs now use discovered external IP.
Dependency adjustment
infrastructure/control-panel/package.json
Changes lowdb dependency version from ^9.1.0 to ^7.0.1.
eVoting Web App: Polls table
platforms/eVoting/src/app/(app)/page.tsx
Adds non-sortable “Group” column; renders group badge or “No group” per row.
eVoting API: Poll controller
platforms/evoting-api/src/controllers/PollController.ts
Uses user-scoped getPollByIdWithAccessCheck; returns 404 on not found or access denied.
eVoting API: Poll service (groups + access)
platforms/evoting-api/src/services/PollService.ts
Augments polls with group data; filters by user memberships; adds getPollByIdWithAccessCheck enforcing group membership for group polls.
eVoting API: Vote service (group checks)
platforms/evoting-api/src/services/VoteService.ts
Adds groupRepository and canUserVote; enforces group-based access in normal and blind voting flows; consolidates user fetch/checks.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant UI as EVaultList.svelte
  participant ES as evaultService
  participant CS as cacheService
  participant API as /api/evaults

  UI->>ES: getEVaults()
  ES->>CS: isCacheStale()
  CS-->>ES: stale?: Promise<boolean>
  alt stale
    ES->>ES: refreshCacheInBackground() async
    ES-->>UI: return cached eVaults
    par Background refresh
      ES->>API: fetchEVaultsDirectly()
      API-->>ES: eVaults[]
      ES->>CS: updateCache(eVaults, fresh)
    end
  else fresh
    ES-->>UI: return cached eVaults
  end

  UI->>ES: forceRefresh()
  ES->>API: fetchEVaultsDirectly()
  API-->>ES: eVaults[]
  ES->>CS: updateCache(eVaults, fresh)
  ES-->>UI: eVaults[]
Loading
sequenceDiagram
  autonumber
  participant S as Server
  participant B as Browser
  participant C as CacheService
  participant DB as LowDB

  Note over B,C: Browser guards
  B->>C: getCachedEVaults()
  C-->>B: [] (no-op)
  B->>C: getCacheStatus()
  C-->>B: {lastUpdated:0,isStale:true,itemCount:0}

  Note over S,C: Lazy init on server
  S->>C: updateCache(data)
  C->>C: init() if needed
  C->>DB: read/write
  DB-->>C: ok
  C-->>S: done
Loading
sequenceDiagram
  autonumber
  participant Route as +server.ts
  participant K8s as kubectl
  participant Nodes as Kubernetes Nodes

  Route->>K8s: get nodes -o json
  K8s-->>Route: nodes list
  alt find ExternalIP
    Route->>Nodes: scan addresses
    Nodes-->>Route: externalIP
  else fallback InternalIP
    Route->>Nodes: scan InternalIP (exclude localhost)
    Nodes-->>Route: internalIP
  else minikube/config
    Route->>K8s: minikube ip or config host
    K8s-->>Route: fallback IP
  end
  Route->>Route: build NodePort URLs with chosen IP
  Route-->>Client: EVaults with service URLs
Loading
sequenceDiagram
  autonumber
  participant Client
  participant Controller as PollController
  participant PS as PollService
  participant VS as VoteService
  participant DB as DB

  Client->>Controller: GET /polls/:id (auth?)
  Controller->>PS: getPollByIdWithAccessCheck(id, userId)
  PS->>DB: load poll + creator
  alt public poll
    PS-->>Controller: poll
  else group poll
    alt userId provided and member
      PS-->>Controller: poll
    else
      PS-->>Controller: null
    end
  end
  Controller-->>Client: 200 or 404

  Client->>VS: create/submit vote (pollId, userId)
  VS->>VS: canUserVote(pollId,userId)
  VS->>DB: check poll/group membership
  alt allowed
    VS-->>Client: proceed
  else denied
    VS-->>Client: error
  end
Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60–90 minutes

Possibly related PRs

  • prototype#179 — Similar NodePort IP discovery changes; both add node External/Internal IP fallbacks vs. fixed Minikube logic.
  • prototype#314 — Touches PollService group membership filtering; overlaps with new access checks added here.
  • prototype#305 — Modifies eVoting backend/frontend around Polls and voting; intersects with controller/service updates in this PR.

Suggested reviewers

  • sosweetham

Poem

A nibble of cache, a hop through the cloud,
I sniff out IPs from a Kubernetes crowd.
Polls gain their groups, votes mind the gate,
Background refresh hums—no need to wait.
With ears up high and logs in sight,
This bunny ships changes swift and light. 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 570904e and 720bb06.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (9)
  • infrastructure/control-panel/package.json (1 hunks)
  • infrastructure/control-panel/src/lib/components/EVaultList.svelte (1 hunks)
  • infrastructure/control-panel/src/lib/services/cacheService.ts (1 hunks)
  • infrastructure/control-panel/src/lib/services/evaultService.ts (1 hunks)
  • infrastructure/control-panel/src/routes/api/evaults/+server.ts (2 hunks)
  • platforms/eVoting/src/app/(app)/page.tsx (2 hunks)
  • platforms/evoting-api/src/controllers/PollController.ts (1 hunks)
  • platforms/evoting-api/src/services/PollService.ts (3 hunks)
  • platforms/evoting-api/src/services/VoteService.ts (6 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/control-panel-refresh

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coodos coodos deleted the fix/control-panel-refresh branch August 24, 2025 21:46
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.

1 participant