Preparing for version 3.0.0 release - remove references to :decode_sets config option, change JSON codec from Poison to Jason as per ex_aws, update README, add upgraede guide.

darrenklein · darrenklein · commit d644cb9f70d6 · 2020-02-22T09:51:36.000-05:00
diff --git a/README.md b/README.md
@@ -8,19 +8,21 @@ Service module for https://github.com/ex-aws/ex_aws
 ## Installation
 
 The package can be installed by adding `ex_aws_dynamo` to your list of dependencies in `mix.exs`
-along with `:ex_aws` and your preferred JSON codec / http client
+along with `:ex_aws` and your preferred JSON codec and HTTP client:
 
 ```elixir
 def deps do
   [
-    {:ex_aws, "~> 2.0"},
-    {:ex_aws_dynamo, "~> 2.3"},
-    {:poison, "~> 3.0"},
-    {:hackney, "~> 1.9"},
+    {:ex_aws, "~> 2.1"},
+    {:ex_aws_dynamo, "~> 3.0"},
+    {:jason, "~> 1.0"},
+    {:hackney, "~> 1.9"}
   ]
 end
 ```
 
+`ex_aws` currently uses [Jason](https://github.com/michalmuskala/jason) as its default JSON codec - see (ex_aws)[https://github.com/ex-aws/ex_aws] for more information about setting a custom `:json_codec`.
+
 Documentation can be found at [https://hexdocs.pm/ex_aws_dynamo](https://hexdocs.pm/ex_aws_dynamo).
 
 ## Requirements
@@ -29,27 +31,6 @@ Documentation can be found at [https://hexdocs.pm/ex_aws_dynamo](https://hexdocs
 
 If you are running this module against a local development instance of DynamoDB, you'll want to make sure that you have installed at least version `1.11.477` (released 2019-02-06). You can find links to download the latest version [here](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.DownloadingAndRunning.html).
 
-## Configuration
-
-### `decode_sets`
-
-The default behavior of this application is to encode Elixir `MapSet` data to one of DynamoDB's three set types - number set, string set, or binary set; however, those DynamoDB datatypes will be decoded to Elixir `List`. If you wish to decode DynamoDB set types to Elixir `MapSet`, you can set the configuration for this application to include `decode_sets: true`.
-
-For example:
-
-```
-config :ex_aws, :dynamodb,
-  decode_sets: true
-```
-
-## Local testing
-
-This application supports three test commands:
-
-* `mix test` - run the normal test suite
-* `mix test.options` - run the test suite with options enabled (see `config/test_options.exs`)
-* `mix test.all` - run `mix test` and `mix test.options` sequentially
-
 ### Integration tests (optional)
 
 The tests in `test/lib/dynamo/integration_test.exs` will attempt to run against a local instance of DynamoDB - in order to run these tests, you will need both a running local instance of DynamoDB as well as a `config/ddb_local_test.exs` file (.gitignored) formatted like so:
@@ -74,6 +55,8 @@ config :ex_aws, :dynamodb,
 
 Before setting the `:port` and running tests, be aware that `test/lib/dynamo/integration_test.exs` will create and delete tables with the names `"TestUsers"`, `"Test.User"`, `"TestSeveralUsers"`, `"TestFoo"`, `"test_books"`, `"TestUsersWithRange"`, `"TestTransactions"`, `"TestTransactions2"` - test operations may affect your current tables if they share any of those names.
 
+If DynamoDB is not running locally or the config file has not been provided, the integration tests will be skipped.
+
 ## License
 
 The MIT License (MIT)
diff --git a/config/test_options.exs b/config/test_options.exs
diff --git a/lib/ex_aws/dynamo/decoder.ex b/lib/ex_aws/dynamo/decoder.ex
@@ -16,19 +16,11 @@ defmodule ExAws.Dynamo.Decoder do
   end
 
   @doc """
-  Convert dynamo format to elixir
+  Convert Dynamo format to Elixir
 
-  Functions which convert the dynamo style values into normal elixir values.
-  Use these if you just want the dynamo result to look more like elixir without
+  Functions which convert the Dynamo-style values into normal Elixir values.
+  Use these if you just want the Dynamo result to look more like Elixir without
   coercing it into a particular struct.
-
-  By default this will decode various dynamodb sets into lists. If you'd
-  prefer they be decoded into `MapSet`s instead, set `decode_sets: true` in
-  your compile-time (not runtime) configuration:
-
-  ```elixir
-  config :ex_aws, :dynamodb, decode_sets: true
-  ```
   """
   def decode(%{"BOOL" => true}), do: true
   def decode(%{"BOOL" => false}), do: false
@@ -40,22 +32,13 @@ defmodule ExAws.Dynamo.Decoder do
   def decode(%{"S" => value}), do: value
   def decode(%{"M" => value}), do: value |> decode
 
-  if Application.get_env(:ex_aws, :dynamodb, [])[:decode_sets] do
-    def decode(%{"BS" => values}), do: MapSet.new(values)
-    def decode(%{"SS" => values}), do: MapSet.new(values)
+  def decode(%{"BS" => values}), do: MapSet.new(values)
+  def decode(%{"SS" => values}), do: MapSet.new(values)
 
-    def decode(%{"NS" => values}) do
-      values
-      |> Stream.map(&binary_to_number/1)
-      |> Enum.into(MapSet.new())
-    end
-  else
-    def decode(%{"BS" => values}), do: values
-    def decode(%{"SS" => values}), do: values
-
-    def decode(%{"NS" => values}) do
-      Enum.map(values, &binary_to_number/1)
-    end
+  def decode(%{"NS" => values}) do
+    values
+    |> Stream.map(&binary_to_number/1)
+    |> Enum.into(MapSet.new())
   end
 
   def decode(%{"L" => values}) do
diff --git a/mix.exs b/mix.exs
@@ -1,7 +1,7 @@
 defmodule ExAws.Dynamo.Mixfile do
   use Mix.Project
 
-  @version "2.3.4"
+  @version "3.0.0"
   @service "dynamo"
   @url "https://github.com/ex-aws/ex_aws_#{@service}"
   @name __MODULE__ |> Module.split() |> Enum.take(2) |> Enum.join(".")
@@ -16,8 +16,7 @@ defmodule ExAws.Dynamo.Mixfile do
       deps: deps(),
       name: @name,
       package: package(),
-      docs: [main: @name, source_ref: "v#{@version}", source_url: @url],
-      aliases: aliases()
+      docs: [main: @name, source_ref: "v#{@version}", source_url: @url]
     ]
   end
 
@@ -32,7 +31,6 @@ defmodule ExAws.Dynamo.Mixfile do
   end
 
   defp elixirc_paths(:test), do: ["lib", "test/support"]
-  defp elixirc_paths(:test_options), do: ["lib", "test/support"]
   defp elixirc_paths(_), do: ["lib"]
 
   # Run "mix help compile.app" to learn about applications.
@@ -46,40 +44,17 @@ defmodule ExAws.Dynamo.Mixfile do
   defp deps do
     [
       {:ex_doc, ">= 0.0.0", only: :dev},
-      {:hackney, ">= 0.0.0", only: [:dev, :test, :test_options]},
-      {:sweet_xml, ">= 0.0.0", only: [:dev, :test, :test_options]},
-      {:poison, ">= 0.0.0", only: [:dev, :test, :test_options]},
+      {:hackney, ">= 0.0.0", only: [:dev, :test]},
+      {:sweet_xml, ">= 0.0.0", only: [:dev, :test]},
+      {:jason, ">= 0.0.0", only: [:dev, :test]},
       ex_aws()
     ]
   end
 
   defp ex_aws() do
     case System.get_env("AWS") do
       "LOCAL" -> {:ex_aws, path: "../ex_aws"}
-      _ -> {:ex_aws, "~> 2.0"}
+      _ -> {:ex_aws, "~> 2.1"}
     end
   end
-
-  defp aliases do
-    [
-      {:"test.all", [&run_tests/1, "test.options"]},
-      {:"test.options", [&run_options_tests/1]}
-    ]
-  end
-
-  defp run_tests(_) do
-    Mix.shell().cmd(
-      "mix test --color",
-      env: [{"MIX_ENV", "test"}]
-    )
-  end
-
-  defp run_options_tests(_) do
-    IO.puts("\nRunning tests with options enabled...")
-
-    Mix.shell().cmd(
-      "mix test --color",
-      env: [{"MIX_ENV", "test_options"}]
-    )
-  end
 end
diff --git a/mix.lock b/mix.lock
@@ -1,17 +1,18 @@
 %{
-  "certifi": {:hex, :certifi, "2.0.0", "a0c0e475107135f76b8c1d5bc7efb33cd3815cb3cf3dea7aefdd174dabead064", [:rebar3], [], "hexpm"},
-  "earmark": {:hex, :earmark, "1.3.2", "b840562ea3d67795ffbb5bd88940b1bed0ed9fa32834915125ea7d02e35888a5", [:mix], [], "hexpm"},
-  "ex_aws": {:hex, :ex_aws, "2.0.0", "9c83ca070b7ddc1079e61a07ba8d97d9c335888881f841bd54691d34fbf0e116", [:mix], [{:configparser_ex, "~> 2.0", [hex: :configparser_ex, repo: "hexpm", optional: true]}, {:hackney, "1.6.3 or 1.6.5 or 1.7.1 or 1.8.6 or ~> 1.9", [hex: :hackney, repo: "hexpm", optional: true]}, {:jsx, "~> 2.8", [hex: :jsx, repo: "hexpm", optional: true]}, {:poison, ">= 1.2.0", [hex: :poison, repo: "hexpm", optional: true]}, {:sweet_xml, "~> 0.6", [hex: :sweet_xml, repo: "hexpm", optional: true]}, {:xml_builder, "~> 0.1.0", [hex: :xml_builder, repo: "hexpm", optional: true]}], "hexpm"},
-  "ex_doc": {:hex, :ex_doc, "0.20.2", "1bd0dfb0304bade58beb77f20f21ee3558cc3c753743ae0ddbb0fd7ba2912331", [:mix], [{:earmark, "~> 1.3", [hex: :earmark, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.10", [hex: :makeup_elixir, repo: "hexpm", optional: false]}], "hexpm"},
-  "hackney": {:hex, :hackney, "1.9.0", "51c506afc0a365868469dcfc79a9d0b94d896ec741cfd5bd338f49a5ec515bfe", [:rebar3], [{:certifi, "2.0.0", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "5.1.0", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "1.0.1", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "1.0.2", [hex: :mimerl, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "1.1.1", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}], "hexpm"},
-  "idna": {:hex, :idna, "5.1.0", "d72b4effeb324ad5da3cab1767cb16b17939004e789d8c0ad5b70f3cea20c89a", [:rebar3], [{:unicode_util_compat, "0.3.1", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm"},
-  "makeup": {:hex, :makeup, "1.0.0", "671df94cf5a594b739ce03b0d0316aa64312cee2574b6a44becb83cd90fb05dc", [:mix], [{:nimble_parsec, "~> 0.5.0", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm"},
-  "makeup_elixir": {:hex, :makeup_elixir, "0.14.0", "cf8b7c66ad1cff4c14679698d532f0b5d45a3968ffbcbfd590339cb57742f1ae", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm"},
-  "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], [], "hexpm"},
-  "mimerl": {:hex, :mimerl, "1.0.2", "993f9b0e084083405ed8252b99460c4f0563e41729ab42d9074fd5e52439be88", [:rebar3], [], "hexpm"},
-  "nimble_parsec": {:hex, :nimble_parsec, "0.5.0", "90e2eca3d0266e5c53f8fbe0079694740b9c91b6747f2b7e3c5d21966bba8300", [:mix], [], "hexpm"},
-  "poison": {:hex, :poison, "3.1.0", "d9eb636610e096f86f25d9a46f35a9facac35609a7591b3be3326e99a0484665", [:mix], [], "hexpm"},
-  "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.1", "28a4d65b7f59893bc2c7de786dec1e1555bd742d336043fe644ae956c3497fbe", [:make, :rebar], [], "hexpm"},
-  "sweet_xml": {:hex, :sweet_xml, "0.6.5", "dd9cde443212b505d1b5f9758feb2000e66a14d3c449f04c572f3048c66e6697", [:mix], [], "hexpm"},
-  "unicode_util_compat": {:hex, :unicode_util_compat, "0.3.1", "a1f612a7b512638634a603c8f401892afbf99b8ce93a45041f8aaca99cadb85e", [:rebar3], [], "hexpm"},
+  "certifi": {:hex, :certifi, "2.5.1", "867ce347f7c7d78563450a18a6a28a8090331e77fa02380b4a21962a65d36ee5", [:rebar3], [{:parse_trans, "~>3.3", [hex: :parse_trans, repo: "hexpm", optional: false]}], "hexpm", "805abd97539caf89ec6d4732c91e62ba9da0cda51ac462380bbd28ee697a8c42"},
+  "earmark": {:hex, :earmark, "1.3.2", "b840562ea3d67795ffbb5bd88940b1bed0ed9fa32834915125ea7d02e35888a5", [:mix], [], "hexpm", "e3be2bc3ae67781db529b80aa7e7c49904a988596e2dbff897425b48b3581161"},
+  "ex_aws": {:hex, :ex_aws, "2.1.2", "a0f8443556eb527e042c749eb87347d9cd1d13688da4e5354ddee51f99272360", [:mix], [{:configparser_ex, "~> 4.0", [hex: :configparser_ex, repo: "hexpm", optional: true]}, {:hackney, "~> 1.9", [hex: :hackney, repo: "hexpm", optional: true]}, {:jason, "~> 1.1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:jsx, "~> 2.8", [hex: :jsx, repo: "hexpm", optional: true]}, {:sweet_xml, "~> 0.6", [hex: :sweet_xml, repo: "hexpm", optional: true]}], "hexpm", "b1d24a9afa850963ff2874762316744ddcf48e1f9bad416c57b95e1c5a080f11"},
+  "ex_doc": {:hex, :ex_doc, "0.20.2", "1bd0dfb0304bade58beb77f20f21ee3558cc3c753743ae0ddbb0fd7ba2912331", [:mix], [{:earmark, "~> 1.3", [hex: :earmark, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.10", [hex: :makeup_elixir, repo: "hexpm", optional: false]}], "hexpm", "8e24fc8ff9a50b9f557ff020d6c91a03cded7e59ac3e0eec8a27e771430c7d27"},
+  "hackney": {:hex, :hackney, "1.15.2", "07e33c794f8f8964ee86cebec1a8ed88db5070e52e904b8f12209773c1036085", [:rebar3], [{:certifi, "2.5.1", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "6.0.0", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "1.0.1", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "~>1.1", [hex: :mimerl, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "1.1.5", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}], "hexpm", "e0100f8ef7d1124222c11ad362c857d3df7cb5f4204054f9f0f4a728666591fc"},
+  "idna": {:hex, :idna, "6.0.0", "689c46cbcdf3524c44d5f3dde8001f364cd7608a99556d8fbd8239a5798d4c10", [:rebar3], [{:unicode_util_compat, "0.4.1", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "4bdd305eb64e18b0273864920695cb18d7a2021f31a11b9c5fbcd9a253f936e2"},
+  "jason": {:hex, :jason, "1.1.2", "b03dedea67a99223a2eaf9f1264ce37154564de899fd3d8b9a21b1a6fd64afe7", [:mix], [{:decimal, "~> 1.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "fdf843bca858203ae1de16da2ee206f53416bbda5dc8c9e78f43243de4bc3afe"},
+  "makeup": {:hex, :makeup, "1.0.0", "671df94cf5a594b739ce03b0d0316aa64312cee2574b6a44becb83cd90fb05dc", [:mix], [{:nimble_parsec, "~> 0.5.0", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "a10c6eb62cca416019663129699769f0c2ccf39428b3bb3c0cb38c718a0c186d"},
+  "makeup_elixir": {:hex, :makeup_elixir, "0.14.0", "cf8b7c66ad1cff4c14679698d532f0b5d45a3968ffbcbfd590339cb57742f1ae", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "d4b316c7222a85bbaa2fd7c6e90e37e953257ad196dc229505137c5e505e9eff"},
+  "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], [], "hexpm", "69b09adddc4f74a40716ae54d140f93beb0fb8978d8636eaded0c31b6f099f16"},
+  "mimerl": {:hex, :mimerl, "1.2.0", "67e2d3f571088d5cfd3e550c383094b47159f3eee8ffa08e64106cdf5e981be3", [:rebar3], [], "hexpm", "f278585650aa581986264638ebf698f8bb19df297f66ad91b18910dfc6e19323"},
+  "nimble_parsec": {:hex, :nimble_parsec, "0.5.0", "90e2eca3d0266e5c53f8fbe0079694740b9c91b6747f2b7e3c5d21966bba8300", [:mix], [], "hexpm", "5c040b8469c1ff1b10093d3186e2e10dbe483cd73d79ec017993fb3985b8a9b3"},
+  "parse_trans": {:hex, :parse_trans, "3.3.0", "09765507a3c7590a784615cfd421d101aec25098d50b89d7aa1d66646bc571c1", [:rebar3], [], "hexpm", "17ef63abde837ad30680ea7f857dd9e7ced9476cdd7b0394432af4bfc241b960"},
+  "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.5", "6eaf7ad16cb568bb01753dbbd7a95ff8b91c7979482b95f38443fe2c8852a79b", [:make, :mix, :rebar3], [], "hexpm", "13104d7897e38ed7f044c4de953a6c28597d1c952075eb2e328bc6d6f2bfc496"},
+  "sweet_xml": {:hex, :sweet_xml, "0.6.6", "fc3e91ec5dd7c787b6195757fbcf0abc670cee1e4172687b45183032221b66b8", [:mix], [], "hexpm", "2e1ec458f892ffa81f9f8386e3f35a1af6db7a7a37748a64478f13163a1f3573"},
+  "unicode_util_compat": {:hex, :unicode_util_compat, "0.4.1", "d869e4c68901dd9531385bb0c8c40444ebf624e60b6962d95952775cac5e90cd", [:rebar3], [], "hexpm", "1d1848c40487cdb0b30e8ed975e34e025860c02e419cb615d255849f3427439d"},
 }
diff --git a/test/lib/dynamo/decoder_test.exs b/test/lib/dynamo/decoder_test.exs
@@ -3,42 +3,22 @@ defmodule ExAws.Dynamo.DecoderTest do
   alias ExAws.Dynamo.Decoder
   alias ExAws.Dynamo.Encoder
 
-  if Application.get_env(:ex_aws, :dynamodb, [])[:decode_sets] do
-    test "decoder decodes numberset to a mapset of numbers" do
-      assert %{"NS" => ["1", "2", "3"]}
-             |> Decoder.decode() == MapSet.new([1, 2, 3])
+  test "decoder decodes numberset to a mapset of numbers" do
+    assert %{"NS" => ["1", "2", "3"]}
+           |> Decoder.decode() == MapSet.new([1, 2, 3])
 
-      assert %{"NS" => [1, 2, 3]}
-             |> Decoder.decode() == MapSet.new([1, 2, 3])
-    end
-
-    test "decoder decodes stringset to a mapset of strings" do
-      assert %{"SS" => ["foo", "bar", "baz"]}
-             |> Decoder.decode() == MapSet.new(["foo", "bar", "baz"])
-    end
-
-    test "decoder decodes binaryset to a mapset of strings" do
-      assert %{"BS" => ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]}
-             |> Decoder.decode() == MapSet.new(["U3Vubnk=", "UmFpbnk=", "U25vd3k="])
-    end
-  else
-    test "decoder decodes numberset to a list of numbers" do
-      assert %{"NS" => ["1", "2", "3"]}
-             |> Decoder.decode() == [1, 2, 3]
-
-      assert %{"NS" => [1, 2, 3]}
-             |> Decoder.decode() == [1, 2, 3]
-    end
+    assert %{"NS" => [1, 2, 3]}
+           |> Decoder.decode() == MapSet.new([1, 2, 3])
+  end
 
-    test "decoder decodes stringset to a list of strings" do
-      assert %{"SS" => ["foo", "bar", "baz"]}
-             |> Decoder.decode() == ["foo", "bar", "baz"]
-    end
+  test "decoder decodes stringset to a mapset of strings" do
+    assert %{"SS" => ["foo", "bar", "baz"]}
+           |> Decoder.decode() == MapSet.new(["foo", "bar", "baz"])
+  end
 
-    test "decoder decodes binaryset to a list of strings" do
-      assert %{"BS" => ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]}
-             |> Decoder.decode() == ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]
-    end
+  test "decoder decodes binaryset to a mapset of strings" do
+    assert %{"BS" => ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]}
+           |> Decoder.decode() == MapSet.new(["U3Vubnk=", "UmFpbnk=", "U25vd3k="])
   end
 
   test "lists of different types" do
diff --git a/upgrade_guides/v3.md b/upgrade_guides/v3.md
@@ -0,0 +1,11 @@
+# Upgrading from version 2.X.X to version 3.X.X
+
+## MapSet
+
+Prior to version **2.2.0**, **ex_aws_dynamo** was encoding **MapSet** data into one of the three Dynamo set types (number, string, and binary), but was decoding those types into Elixir **List** data. In version **2.2.0**, a PR added a boolean configuration option, `:decode_sets`, that would allow the user to specify that these types should be decoded into **MapSet** as well.
+
+In this major release, Dynamo set types decode to Elixir **MapSet** by default, so the `:decode_sets` configuration option can be removed if it was included. If it this option was not included or was explicitly set to `false`, you'll need to be prepared to handle any decoded Dynamo sets as **MapSet** instead of **List**.
+
+## Jason
+
+Several months ago, `ex_aws` switched its default JSON codec from **Poison** to **Jason** (see https://github.com/ex-aws/ex_aws/pull/658). In this major release, the encoder used for `dev` and `test` environments has been changed to **Jason**, and the README file has been updated to show **Jason** in use instead of **Poison**, and refers the user to the `ex_aws` docs for information about how to provide a custom JSON codec.
