allow close frames to have no close code or reason

Author: the-mikedavis

CHANGELOG.md

@@ -6,6 +6,14 @@ The format is based on [Keep a
 Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.1.1 - 2021-07-01
+
+### Fixed
+
+- Close frame codes and reasons are now nillable instead of defaulted
+  - The WebSocket spec does not require that a code and reason be included
+    for all close frames
+
 ## 0.1.0 - 2021-06-30
 
 ### Added

lib/mint/web_socket.ex

@@ -135,7 +135,7 @@ defmodule Mint.WebSocket do
 
   * `:ping` - shorthand for `{:ping, ""}`
   * `:pong` - shorthand for `{:pong, ""}`
-  * `:close` - shorthand for `{:close, 1_000, ""}`
+  * `:close` - shorthand for `{:close, nil, nil}`
 
   These may be passed to `encode/2`.
 
@@ -192,7 +192,7 @@ defmodule Mint.WebSocket do
           | {:binary, binary()}
           | {:ping, binary()}
           | {:pong, binary()}
-          | {:close, code :: non_neg_integer(), reason :: binary()}
+          | {:close, code :: non_neg_integer() | nil, reason :: binary() | nil}
 
   @doc """
   Requests that a connection be upgraded to the WebSocket protocol

lib/mint/web_socket/frame.ex

@@ -92,6 +92,10 @@ defmodule Mint.WebSocket.Frame do
     >>
   end
 
+  defp payload(close(code: nil, reason: nil)) do
+    <<>>
+  end
+
   defp payload(close(code: code, reason: reason)) do
     code = code || 1_000
     reason = reason || ""
@@ -381,17 +385,14 @@ defmodule Mint.WebSocket.Frame do
   def translate(pong(data: data)), do: {:pong, data}
 
   def translate(:close) do
-    translate({:close, 1_000, ""})
+    translate({:close, nil, nil})
   end
 
-  def translate({:close, code, reason})
-      when is_integer(code) and is_binary(reason) do
+  def translate({:close, code, reason}) do
     close(mask: new_mask(), code: code, reason: reason, data: <<>>)
   end
 
   def translate(close(code: code, reason: reason)) do
-    code = code || 1_000
-    reason = reason || ""
     {:close, code, reason}
   end