LiveSplit / LiveSplit/SpeedrunComSharp

Optimize Embeds away if the non-embeds are already queried

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

Nobody has claimed this yet.

enhancement
Dominant language
C#
Stars
32
Forks
11
PR merge metrics
No merged PRs in 30d

Description

Embeds seem to be useful as they reduce the amount of API calls needed, but at the same time, they can cause issues with the current Caching implementation, as the elements might already be queried, but the embedded API call has not been done yet. So it causes more queries instead of less queries.

Simply stripping the ?embeds=... from the URL when comparing, doesn't work, because the embedded objects might not be queried yet. If there's more than 1 embedded object that it wants to access, it would cause more queries then. So this isn't really a good solution.

Contributor guide

No contributing guide indexed for this repository

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 current Caching implementation and how request URLs with ?embeds=... are compared. Define behavior for already queried non-embedded objects and multiple embedded objects, then verify that redundant API calls are avoided without skipping required embedded data.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
api, backend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.