akka/akka-http

Java DSL methods on ws.Message should be hidden from Scala

Open

#927 opened on Mar 5, 2017

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Scala (598 forks)batch import
1 - triagedhelp wantedt:coret:java

Repository metrics

Stars
 (1,311 stars)
PR merge metrics
 (Avg merge 1d 10h) (2 merged PRs in 30d)

Description

The Scala DSL requires pattern matching to deal with TextMessage vs. BinaryMessage. Calling the content-assisted options leads to the Java side of things with mystifying error messages and lots of head scratching (e.g. folding over the stream with Scala 2.11 and being told that Function2 is expected where I am clearly supplying a 2-ary lambda expression).

The Java DSL methods are just misleading and should not show up on the Scala type. This can be achieved by making them private[akka], which translates to public for Java and is binary compatible.

It might be desirable to either document this better or add methods for the Scala DSL as well.

Contributor guide

Research direction
Investigate the ws.Message class in Akka HTTP to identify which Java DSL methods need to be hidden from Scala. Look at how to apply the `private[akka]` access modifier to those methods while maintaining binary compatibility. Check existing tests for ws.Message to ensure changes don't break anything. Consider adding Scala DSL methods if needed.
Tech stack
scalajava
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ScalaAkka HTTP
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65