suri-framework/trail

Fix Sock handlers to return a state

Open

#1 opened on Jan 23, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)OCaml (9 forks)github user discovery
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (44 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently they don't, and they should be closer to the return values used by Elixir's WebSock.ex:

@type handle_result() ::
  {:push, messages(), state()}
  | {:reply, term(), messages(), state()}
  | {:ok, state()}
  | {:stop, {:shutdown, :restart} | term(), state()}
  | {:stop, term(), close_detail(), state()}
  | {:stop, term(), close_detail(), messages(), state()}

Implementation notes

We can start with just push, ok, and stop.

Contributor guide

Research direction
Review the Sock module's handler functions and the WebSock type reference. Implement the return tuple variants for push, ok, and stop as described.
Tech stack
None
Domain
backend
Issue type
Feature
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
OCamlGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75