akka/akka-http

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

Open

#927 opened on Mar 5, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Scala (1,311 stars) (598 forks)batch import
1 - triagedhelp wantedt:coret:java

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

Tech stack
scala
Domain
backend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Scala programmingAkka HTTP module structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Locate the `ws.Message` class in the Akka HTTP repository. Identify the Java DSL methods that are currently public and change their visibility to `private[akka]` to hide them from Scala while keeping them accessible from Java. Verify that the change is binary compatible. No linked PRs exist, and the issue has one comment that may provide additional context.