NatLabRockies / NatLabRockies/OpenStudio-server

Performance: optimize /analyses.json for faster console load

Open
#837 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
58
Forks
27
PR merge metrics
No merged PRs in 30d

Description

Summary

The management console is bottlenecked by large /analyses.json responses. We should reduce payload size and server processing time to improve total page load.

Proposed work

  • Add pagination/incremental loading support for analyses listing
  • Provide a compact list response shape for UI list views
  • Add conditional request support (ETag / If-None-Match, optionally Last-Modified)
  • Add server-side caching for expensive analyses list generation

Acceptance criteria

  • Endpoint supports paginated queries with documented defaults/limits
  • Compact mode returns only list-view-required fields
  • ETag works correctly (304 on unchanged content)
  • p95 endpoint latency and payload transfer size are measurably reduced on realistic datasets

Context

Helm/EKS-side traffic and resilience tuning has already been added in NatLabRockies/openstudio-server-helm; this issue targets app/API-level bottlenecks that infra changes alone cannot solve.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the /analyses.json endpoint and measuring baseline p95 latency and response size on realistic datasets. Review how the analyses list is generated and identify the API and documentation entry points involved. Done means pagination, compact responses, conditional requests, and caching meet the stated acceptance criteria with measurable performance improvements.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api, backend, performance
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.