akka/akka-http

document that HTTP route construction must not close over Actor state

Open

#110 opened on Sep 8, 2016

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Scala (598 forks)batch import
1 - triagedhelp wantedsmallt:docs

Repository metrics

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

Description

Issue by rkuhn Thursday Feb 12, 2015 at 20:01 GMT Originally opened as https://github.com/akka/akka/issues/16871

The pattern we show should be inspired by the Props recommendation: build the Route in a function within the companion object to make sure that nothing is pulled in accidentally, all captured values are explicit.

Contributor guide

Research direction
Study the Props pattern in Akka documentation and apply it to route construction. Write documentation explaining that routes should be built in a companion object function to avoid closing over actor state.
Tech stack
scala
Domain
backend
Issue type
Documentation
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.
1-3 hours
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
ScalaAkka
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60