livepeer / livepeer/studio

tech debt: api routing silliness

Open
#186 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

tech debt
Dominant language
TypeScript
Stars
88
Forks
37
PR merge metrics
No merged PRs in 30d

Description

I made a few last minute changes to get API things routing to the worker or upstream server as appropriate. https://github.com/livepeer/livepeerjs/blob/master/packages/api/src/app-router.js#L134

These are pretty ugly. Let's figure out a better way to configure this, probably by having a single list of path-to-regexp strings that control which route goes where.

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 at packages/api/src/app-router.js around line 134 and review how API paths are currently routed to the worker or upstream server. Read the linked path-to-regexp documentation to understand the proposed route patterns. Done means replacing the scattered routing configuration with a single list that consistently controls where each route goes.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
api, backend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.