Road to v5

[zoriya]

This is the list of things to do before we can release v5. Priorities are between P0 and P3 :

• P0 is a must-have for kyoo to run (so requirements for first alpha version)
• P1 is a blocker for final v5 release. Probably a breaking change we need to tackle before we stabilize the api/database.
• P2 are nice to have, not blocking for the final v5 release but most of them would have been implemented before

Front:

• P0 Migrate from next+expo to a single expo project
  • gave up one, it was too buggy. for now expo only
  • auth page
  • browse page
  • movies details page
  • series details page
  • collections page Add collections support #1321
  • search page Add back search logic #1142
  • home page Update home page for v5 #1234
  • watch/playback page Player rewrite #1020
    • scrubber Reimplement scrubber #1325
    • watch status update Send front progress events to api via websockets #1229
    • subtitle/audio language preference Implement language preferences for audio/sub #1232
  • settings Add settings page #1143
  • admin pages
    • video mapping for series Implement admin video mapper #1350
    • unmapped videos
    • users
    • current stream sessions
  • info page Add back info page #1115
• P0 Update everything for new APIs
• P1 Reimplement SSR (since Migrate to expo only (no next) PART 1 #763 disabled it)
• P1 Virtualize lists on the web (maybe legends-list? Virtualize lists on the web #270)
• P2 Redesign logo/colors Redesign: new theme/logo/guidelines #1295
• P3 complete visual update (started in Feat/uniwind #1282)
• P3 switch to tailwind (Switch to nativewind/tailwind #268)
• P3 display staff list
• P3 Add history page
• P3 Add user stats page

Scanner:

• P0 finish & merge Scanner rework for v5 #923
• P0 extensively test the new scanner & fix all kind of bugs
• P1 Implement & use tvdb for all series by default Add support for tvdb on scanner #1260
• P1 Implement support for AnimeList Improved anime detection (Like Attack on Titan Season 3 Part 2 12.mkv) #466
• P1 If AnimeList support is not enough, implement back thexem support
• P1 Implement back metadata refresh
• P1 Use mTLS to communicate with the api (not an api key and going through the gateway)
• P1 Add a route to see scan progress (number of items in queue + failures) Lots of api fixes + error api for scanner #1201
• P2 Add /search route to search series on online providers
• P2 Manual matching (select a show from the list on metadata mismatch)
• P2 Manual metadata refresh (for a specific show)
• P2 Manual show add (from search results, not from video)

Api:

• P1 Rework score to have one score value per metadata provider (it doesn't make sense to mix & match them)
• P1 Ensure responses are normalized (remove extra fields) Cleanup response properly #1258
• P3 Implement websockets for playback Create a websocket based API #81
• P3 Implement websockets for metadata updates Create a websocket based API #81
• P3 Implement back scrubbing (old autosync module)

Auth:

• P1 Respec (need help)
  • Tackle the phantom-token issue that bother k8s ppl due to traefik chart: v5 update #884
  • Can we just have a basic service for 0 dependencies and allow users to replace it with authentik/dex/whatever for more features?
  • Should it work as a gateway just to keep phantom tokens?

Transcoder:

• P0 Verify JWTs & expose service (not behind the api anymore) Handle jwt validation in the transcoder #1018
• P1 Have the distributed transcode pipeline spec ready Added distributed transcoding and playback design doc #914
• P2 Actually allow distributed transcoding

Repo cleanup:

• Delete old code (v4 back...) Delete v4 backend + docker fixes #1116
• Delete autosync module remove autosync files #1241
• Update docs
• Update readme/screenshots (with redesign) + proper clients timeline
• Tend to issues (close questions, duplicates, rename them when needed...)
• Merge docker-compose.yaml and docker-compose.build.yaml (maybe also with the .dev.yaml if Watch different command/entrypoint docker/compose#12835 is available by then)
• Enable renovate automerge (i'm tired of manually merging them)
• Add healthchecks on all services Add /health & /ready for every service #1147
• Remove all deprecated stuff, check TODOs

Follow up of #597

[acelinkio]

Following up on auth & kubernetes. I don't think too much effort needs to be invested. GatewayAPI has grown a lot in this last year in terms of maturity and adding features. The current approach is getting directly addressed by GatewayAPI specs.

Last month the spec was made for handing ExternalAuth kubernetes-sigs/gateway-api#4001 using GatewayAPI. Since there is now a specification, more gatewayapi controllers are aiming to include that feature.

Cilium's is already working to add that feature. cilium/cilium#23797
EnvoyGateway already supports this approach. https://gateway.envoyproxy.io/contributions/design/security-policy/
Traefik gateway controller supports the legacy approach using extensions. https://doc.traefik.io/traefik/reference/routing-configuration/kubernetes/gateway-api/#using-traefik-middleware-as-httproute-filter

We can continue deploying Traefik as the middlewareproxy with Kyoo while more users adopt gatewayapi and gatewayapi controllers support the ExternalAuth feature.