softwaremill / softwaremill/sttp

v4: provide wrapper for v3 backends

Open
#1,772 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
1.5k
Forks
338
Avg merge
8h 59m
Merged PRs (30d)
13

Description

Hi!

As discussed on mastodon, I thought it would be a good idea to provide a translation layer (wrapper) for backends of the v3 client.

This was an issue in the past, during the v2->v3 migration: you had to have two backends in order to smoothly transition from full-v2 to full-v3 usage.

I propose, if possible, to provide a module that allows wrapping any v3 backend (maybe with a limitation of no streaming, if that helps) and get a v4 backend back. That way, there will only be one underlying backend implementation to carry around, and wrapping can happen at the use site instead of when bootstrapping the application.

Note: This is a bystander suggestion, I'm not actively using sttp these days, and probably won't be affected by the migration. This may impact my judgement on how useful/easy to implement this is ;)

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 comparing the v3 and v4 backend interfaces and reviewing the v2-to-v3 migration context described in the issue. Determine whether a wrapper can cover v3 backends, including the proposed no-streaming limitation; done means the compatibility scope and expected behavior are clearly defined.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
backend-api-design
Issue type
Feature
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.