comparing b2bc217aa3a6d7a86de15e0f6716c8f0753afd6e and main on hauleth.dev/esl_hn

config/config.exs

···

       6
       6
        
       

     

       7
       7
        
       import Config

     

       8
       8
        
       

     

       9
       9
       +
       config :mime, :types, %{

     

       10
       10
       +
         "text/event-stream" => ["sse"]

     

       11
       11
       +
       }

     

       12
       12
       +
       

     

       9
       13
        
       config :esl_hn,

     

       10
       14
        
         generators: [timestamp_type: :utc_datetime]

     

       11
       15

config/dev.exs

···

       11
       11
        
           "TQ20YLfpm8CWUZ0wvMVvXwKLjOdxb6//anr3iafpvW15LKlsoMez2OFUTifz0gxs",

     

       12
       12
        
         watchers: []

     

       13
       13
        
       

     

       14
       14
       +
       config :esl_hn, refresh: :timer.seconds(5)

     

       15
       15
       +
       

     

       14
       16
        
       # ## SSL Support

     

       15
       17
        
       #

     

       16
       18
        
       # In order to use HTTPS in development, a self-signed

+3 -3

config/runtime.exs

···

       15
       15
        
         config :esl_hn, EslHnWeb.Endpoint, server: true

     

       16
       16
        
       end

     

       17
       17
        
       

     

       18
       18
       -
       config :esl_hn,

     

       19
       19
       -
         refresh: CR.duration("ESL_HN_REFRESH", {:minutes, 5})

     

       20
       20
       -
       

     

       21
       18
        
       if config_env() == :prod do

     

       19
       19
       +
         config :esl_hn,

     

       20
       20
       +
           refresh: CR.duration("ESL_HN_REFRESH", {:minutes, 5})

     

       21
       21
       +
       

     

       22
       22
        
         secret_key_base =

     

       23
       23
        
           System.get_env("SECRET_KEY_BASE") ||

     

       24
       24
        
             raise """

+5 -2

config/test.exs

···

       3
       3
        
       # We don't run a server during test. If one is required,

     

       4
       4
        
       # you can enable the server option below.

     

       5
       5
        
       config :esl_hn, EslHnWeb.Endpoint,

     

       6
       6
       -
         http: [ip: {127, 0, 0, 1}, port: 4002],

     

       6
       6
       +
         http: [ip: {127, 0, 0, 1}, port: 0],

     

       7
       7
        
         secret_key_base:

     

       8
       8
        
           "6iR9shI35kN7Xr5bOLgBVMHXTZQS49Gwu82WW4rsr0uhaia7D+NjfNrhhvcOp4rr",

     

       9
       9
       -
         server: false

     

       9
       9
       +
         server: true

     

       10
       10
       +
       

     

       11
       11
       +
       # Disable main refresher in tests

     

       12
       12
       +
       config :esl_hn, refresh: 0

     

       10
       13
        
       

     

       11
       14
        
       # Print only warnings and errors during test

     

       12
       15
        
       config :logger, level: :warning

lib/esl_hn/application.ex

···

       5
       5
        
       

     

       6
       6
        
         @impl true

     

       7
       7
        
         def start(_type, _args) do

     

       8
       8
       +
           refresh = Application.fetch_env!(:esl_hn, :refresh)

     

       9
       9
       +
       

     

       8
       10
        
           children = [

     

       9
       11
        
             EslHnWeb.Telemetry,

     

       10
       12
        
             {Phoenix.PubSub, name: EslHn.PubSub},

     

       11
       13
        
             {EslHn.Cache, name: EslHn},

     

       14
       14
       +
             {EslHn.Refresher, refresh: refresh, cache: {EslHn.Cache, EslHn}},

     

       12
       15
        
             EslHnWeb.Endpoint

     

       13
       16
        
           ]

     

       14
       17

+57 -10

lib/esl_hn/cache.ex

···

       1
       1
        
       defmodule EslHn.Cache do

     

       2
       2
       +
         @moduledoc """

     

       3
       3
       +
         Simple cache implementation using ETS tables

     

       4
       4
       +
         """

     

       5
       5
       +
       

     

       2
       6
        
         use GenServer

     

       3
       7
        
       

     

       4
       8
        
         def start_link(opts) do

     
···

       9
       13
        
           end

     

       10
       14
        
         end

     

       11
       15
        
       

     

       16
       16
       +
         @doc """

     

       17
       17
       +
         Fetch data from cache

     

       18
       18
       +
         """

     

       12
       19
        
         def fetch(tid, key) do

     

       13
       13
       -
           case :ets.lookup(tid, key) do

     

       14
       14
       -
             [{^key, data}] -> {:ok, data}

     

       15
       15
       -
             _ -> :error

     

       16
       16
       -
           end

     

       20
       20
       +
           meta = %{key: key, tid: tid}

     

       21
       21
       +
       

     

       22
       22
       +
           :telemetry.span([:esl_hn, :cache, :fetch], meta, fn ->

     

       23
       23
       +
             case :ets.lookup(tid, key) do

     

       24
       24
       +
               [{^key, data}] -> {{:ok, data}, %{hit: 1}, meta}

     

       25
       25
       +
               _ -> {:error, %{miss: 1}, meta}

     

       26
       26
       +
             end

     

       27
       27
       +
           end)

     

       17
       28
        
         end

     

       18
       29
        
       

     

       30
       30
       +
         @doc """

     

       31
       31
       +
         Get data from cache and returns `default` when value isn't present

     

       32
       32
       +
         """

     

       19
       33
        
         def get(tid, key, default \\ nil) do

     

       20
       34
        
           case fetch(tid, key) do

     

       21
       35
        
             {:ok, val} -> val

     
···

       23
       37
        
           end

     

       24
       38
        
         end

     

       25
       39
        
       

     

       40
       40
       +
         @doc """

     

       41
       41
       +
         Write `data` to cache under `key`

     

       42
       42
       +
         """

     

       26
       43
        
         def write(tid, key, data) do

     

       27
       27
       -
           true = :ets.insert(tid, {key, data})

     

       44
       44
       +
           meta = %{key: key, tid: tid}

     

       28
       45
        
       

     

       29
       29
       -
           :ok

     

       46
       46
       +
           :telemetry.span([:esl_hn, :cache, :write], meta, fn ->

     

       47
       47
       +
             true = :ets.insert(tid, {key, data})

     

       48
       48
       +
       

     

       49
       49
       +
             {:ok, %{count: 1}, meta}

     

       50
       50
       +
           end)

     

       30
       51
        
         end

     

       31
       52
        
       

     

       53
       53
       +
         @doc """

     

       54
       54
       +
         Bulk write to cache

     

       55
       55
       +
         """

     

       32
       56
        
         def write_all(tid, data) do

     

       33
       33
       -
           true = :ets.insert(tid, data)

     

       57
       57
       +
           meta = %{tid: tid}

     

       58
       58
       +
       

     

       59
       59
       +
           :telemetry.span([:esl_hn, :cache, :write], meta, fn ->

     

       60
       60
       +
             true = :ets.insert(tid, data)

     

       61
       61
       +
       

     

       62
       62
       +
             {:ok, %{count: length(data)}, meta}

     

       63
       63
       +
           end)

     

       64
       64
       +
         end

     

       65
       65
       +
       

     

       66
       66
       +
         @doc """

     

       67
       67
       +
         Remove value under given key from cache

     

       68
       68
       +
         """

     

       69
       69
       +
         def prune(tid, key) do

     

       70
       70
       +
           :ets.delete(tid, key)

     

       34
       71
        
       

     

       35
       72
        
           :ok

     

       36
       73
        
         end

     

       37
       74
        
       

     

       38
       38
       -
         def prune(tid, id), do: :ets.delete(tid, id)

     

       75
       75
       +
         @doc """

     

       76
       76
       +
         Bulk removal of values from cache

     

       77
       77
       +
         """

     

       78
       78
       +
         def prune_all(tid, keys) do

     

       79
       79
       +
           for key <- keys, do: :ets.delete(tid, key)

     

       39
       80
        
       

     

       40
       40
       -
         def prune_all(tid, ids) do

     

       41
       41
       -
           for id <- ids, do: :ets.delete(tid, id)

     

       81
       81
       +
           :ok

     

       82
       82
       +
         end

     

       83
       83
       +
       

     

       84
       84
       +
         @doc """

     

       85
       85
       +
         Remove all cached data

     

       86
       86
       +
         """

     

       87
       87
       +
         def flush(tid) do

     

       88
       88
       +
           :ets.delete_all_objects(tid)

     

       42
       89
        
       

     

       43
       90
        
           :ok

     

       44
       91
        
         end

+15

lib/esl_hn/config_reader.ex

···

       6
       6
        
         something like that

     

       7
       7
        
         """

     

       8
       8
        
       

     

       9
       9
       +
         @doc """

     

       10
       10
       +
         Fetch duration from environment variable `name`

     

       11
       11
       +
       

     

       12
       12
       +
         The return value will be in milliseconds.

     

       13
       13
       +
       

     

       14
       14
       +
         Supported formats are:

     

       15
       15
       +
         - `{integer}` - number of milliseconds in duration

     

       16
       16
       +
         - `{integer}(s|m|h)` - number of seconds|minutes|hours in duration

     

       17
       17
       +
       

     

       18
       18
       +
         If environment variable is not set, then it will use `default` value.

     

       19
       19
       +
         """

     

       20
       20
       +
         @spec duration(name :: String.t(), default :: duration) :: non_neg_integer()

     

       21
       21
       +
               when duration:

     

       22
       22
       +
                      non_neg_integer()

     

       23
       23
       +
                      | {:seconds | :minutes | :hours, non_neg_integer()}

     

       9
       24
        
         def duration(name, default) do

     

       10
       25
        
           case System.fetch_env(name) do

     

       11
       26
        
             :error -> default

+15

lib/esl_hn/hn/story.ex

···

       1
       1
        
       defmodule EslHn.Hn.Story do

     

       2
       2
       +
         @moduledoc """

     

       3
       3
       +
         Schema for describing Hacker News stories

     

       4
       4
       +
       

     

       5
       5
       +
         Not all fields for it are currently used.

     

       6
       6
       +
         """

     

       7
       7
       +
       

     

       2
       8
        
         use Ecto.Schema

     

       3
       9
        
       

     

       4
       10
        
         import Ecto.Changeset

     

       5
       11
        
       

     

       6
       12
        
         @primary_key {:id, :integer, []}

     

       13
       13
       +
       

     

       14
       14
       +
         @type id() :: non_neg_integer()

     

       15
       15
       +
       

     

       16
       16
       +
         @type t() :: %__MODULE__{

     

       17
       17
       +
                 id: id(),

     

       18
       18
       +
                 url: String.t() | nil,

     

       19
       19
       +
                 type: atom(),

     

       20
       20
       +
                 text: String.t()

     

       21
       21
       +
               }

     

       7
       22
        
       

     

       8
       23
        
         embedded_schema do

     

       9
       24
        
           # TODO: Make it `URL` structure

+37 -5

lib/esl_hn/hn.ex

···

       1
       1
        
       defmodule EslHn.Hn do

     

       2
       2
       +
         @moduledoc """

     

       3
       3
       +
         Simple HTTP client for Hacker News API

     

       4
       4
       +
         """

     

       5
       5
       +
       

     

       2
       6
        
         alias EslHn.Hn.Story

     

       3
       7
        
       

     

       8
       8
       +
         @type opts() :: keyword()

     

       9
       9
       +
       

     

       10
       10
       +
         @doc """

     

       11
       11
       +
         Fetch list of top stories

     

       12
       12
       +
       

     

       13
       13
       +
         ## Options

     

       14
       14
       +
       

     

       15
       15
       +
         - `:limit` - amount of stories to fetch (defaults to `50`)

     

       16
       16
       +
         """

     

       4
       17
        
         # TODO: Is there a way to limit amount of returned entries in query?

     

       18
       18
       +
         @spec top_stories_ids(opts()) :: {:ok, [Story.id()]} | {:error, term()}

     

       5
       19
        
         def top_stories_ids(opts \\ []) do

     

       6
       20
        
           limit = opts[:limit] || 50

     

       7
       21
        
       

     
···

       10
       24
        
           end

     

       11
       25
        
         end

     

       12
       26
        
       

     

       27
       27
       +
         @doc """

     

       28
       28
       +
         Fetch single story for given ID

     

       29
       29
       +
         """

     

       30
       30
       +
         @spec story(Story.id(), opts()) :: {:ok, Story.t()} | {:error, term()}

     

       13
       31
        
         def story(id, opts \\ []) do

     

       14
       14
       -
           with {:ok, body} <- get("item/#{id}.json", opts) do

     

       32
       32
       +
           with {:ok, body} <- get("item/:id.json", [id: id], opts) do

     

       15
       33
        
             Story.changeset(body)

     

       16
       34
        
             |> Ecto.Changeset.apply_action(:create)

     

       17
       35
        
           end

     

       18
       36
        
         end

     

       19
       37
        
       

     

       38
       38
       +
         @doc """

     

       39
       39
       +
         Fetch stories for IDs in enumerable

     

       40
       40
       +
         """

     

       41
       41
       +
         @spec stories(Enumerable.t(Story.id()), opts()) ::

     

       42
       42
       +
                 {:ok, [Story.t()]} | {:error, term()}

     

       20
       43
        
         def stories(ids, opts \\ []) do

     

       21
       44
        
           ids

     

       22
       45
        
           |> Task.async_stream(&story(&1, opts))

     

       23
       46
        
           |> map_while(fn

     

       24
       47
        
             {:ok, {:ok, data}} -> {:cont, data}

     

       25
       25
       -
             other -> {:halt, other}

     

       48
       48
       +
             {:ok, error} -> {:halt, error}

     

       49
       49
       +
             {:error, reason} -> {:halt, {:error, {:process_error, reason}}}

     

       26
       50
        
           end)

     

       27
       51
        
           |> case do

     

       28
       52
        
             list when is_list(list) -> {:ok, list}

     
···

       32
       56
        
       

     

       33
       57
        
         @base_url URI.new!("https://hacker-news.firebaseio.com/v0/")

     

       34
       58
        
       

     

       35
       35
       -
         defp get(path, opts) do

     

       36
       36
       -
           base_url = opts[:base_url] || @base_url

     

       59
       59
       +
         defp get(path, params \\ [], opts) do

     

       60
       60
       +
           opts =

     

       61
       61
       +
             Keyword.merge(

     

       62
       62
       +
               [

     

       63
       63
       +
                 base_url: @base_url,

     

       64
       64
       +
                 path_params: params

     

       65
       65
       +
               ],

     

       66
       66
       +
               opts

     

       67
       67
       +
             )

     

       37
       68
        
       

     

       38
       38
       -
           Req.new(base_url: base_url)

     

       69
       69
       +
           Req.new(opts)

     

       70
       70
       +
           |> ReqTelemetry.attach()

     

       39
       71
        
           |> Req.get(url: path)

     

       40
       72
        
           |> case do

     

       41
       73
        
             {:ok, %Req.Response{status: 200, body: body}} ->

+72

lib/esl_hn/refresher.ex

···

       1
       1
       +
       defmodule EslHn.Refresher do

     

       2
       2
       +
         @moduledoc """

     

       3
       3
       +
         Module defining process that is responsible for refreshing cached data

     

       4
       4
       +
         """

     

       5
       5
       +
       

     

       6
       6
       +
         use GenServer

     

       7
       7
       +
       

     

       8
       8
       +
         alias EslHn.Hn

     

       9
       9
       +
       

     

       10
       10
       +
         def start_link(opts),

     

       11
       11
       +
           do: GenServer.start_link(__MODULE__, opts)

     

       12
       12
       +
       

     

       13
       13
       +
         @impl true

     

       14
       14
       +
         def init(opts) do

     

       15
       15
       +
           refresh = Access.fetch!(opts, :refresh)

     

       16
       16
       +
           {mod, tid} = Access.fetch!(opts, :cache)

     

       17
       17
       +
           req_opts = Access.get(opts, :req_opts, [])

     

       18
       18
       +
       

     

       19
       19
       +
           if refresh > 0 do

     

       20
       20
       +
             {:ok,

     

       21
       21
       +
              %{

     

       22
       22
       +
                refresh: refresh,

     

       23
       23
       +
                ids: MapSet.new(),

     

       24
       24
       +
                cache: {mod, tid},

     

       25
       25
       +
                req_opts: req_opts

     

       26
       26
       +
              }, {:continue, :refresh}}

     

       27
       27
       +
           else

     

       28
       28
       +
             :ignore

     

       29
       29
       +
           end

     

       30
       30
       +
         end

     

       31
       31
       +
       

     

       32
       32
       +
         @impl true

     

       33
       33
       +
         def handle_info(:refresh, state) do

     

       34
       34
       +
           {:noreply, state, {:continue, :refresh}}

     

       35
       35
       +
         end

     

       36
       36
       +
       

     

       37
       37
       +
         @impl true

     

       38
       38
       +
         def handle_continue(:refresh, state) do

     

       39
       39
       +
           ids = fetch(state)

     

       40
       40
       +
       

     

       41
       41
       +
           Process.send_after(self(), :refresh, state.refresh)

     

       42
       42
       +
       

     

       43
       43
       +
           {:noreply, %{state | ids: ids}}

     

       44
       44
       +
         end

     

       45
       45
       +
       

     

       46
       46
       +
         defp fetch(state) do

     

       47
       47
       +
           {mod, tid} = state.cache

     

       48
       48
       +
       

     

       49
       49
       +
           :telemetry.span([:esl_hn, :refresh], %{cache: mod}, fn ->

     

       50
       50
       +
             with {:ok, ids} <- Hn.top_stories_ids(state.req_opts),

     

       51
       51
       +
                  new_set = MapSet.new(ids),

     

       52
       52
       +
                  new = MapSet.difference(new_set, state.ids),

     

       53
       53
       +
                  old = MapSet.difference(state.ids, new_set),

     

       54
       54
       +
                  {:ok, stories} <- Hn.stories(new, state.req_opts) do

     

       55
       55
       +
               rows =

     

       56
       56
       +
                 for story <- stories, do: {story.id, story}

     

       57
       57
       +
       

     

       58
       58
       +
               :ok = mod.write(tid, :index, ids)

     

       59
       59
       +
               :ok = mod.write_all(tid, rows)

     

       60
       60
       +
               :ok = mod.prune_all(tid, old)

     

       61
       61
       +
       

     

       62
       62
       +
               EslHn.broadcast_new(for story <- stories, story.id in new, do: story)

     

       63
       63
       +
       

     

       64
       64
       +
               {new_set, %{new: MapSet.size(new), old: MapSet.size(old)},

     

       65
       65
       +
                %{cache: mod}}

     

       66
       66
       +
             else

     

       67
       67
       +
               _ ->

     

       68
       68
       +
                 {state.ids, %{failed: 1}, %{cache: mod}}

     

       69
       69
       +
             end

     

       70
       70
       +
           end)

     

       71
       71
       +
         end

     

       72
       72
       +
       end

+5 -3

lib/esl_hn.ex

···

       7
       7
        
         if it comes from the database, an external API or others.

     

       8
       8
        
         """

     

       9
       9
        
       

     

       10
       10
       +
         alias EslHn.Cache

     

       11
       11
       +
       

     

       10
       12
        
         def all(page \\ 1, per_page \\ 10) do

     

       11
       13
        
           skip = per_page * (page - 1)

     

       12
       14
        
       

     

       13
       13
       -
           ids = EslHn.Cache.get(EslHn, :index, [])

     

       15
       15
       +
           ids = Cache.get(EslHn, :index, [])

     

       14
       16
        
       

     

       15
       17
        
           ids

     

       16
       18
        
           |> Enum.drop(skip)

     

       17
       19
        
           |> Enum.take(per_page)

     

       18
       18
       -
           |> Enum.map(&story/1)

     

       20
       20
       +
           |> Enum.map(&Cache.get(EslHn, &1))

     

       19
       21
        
         end

     

       20
       22
        
       

     

       21
       23
        
         def story(id) do

     

       22
       22
       -
           EslHn.Cache.get(EslHn, id)

     

       24
       24
       +
           Cache.fetch(EslHn, id)

     

       23
       25
        
         end

     

       24
       26
        
       

     

       25
       27
        
         def broadcast_new(stories) do

+22 -2

lib/esl_hn_web/api/controller.ex

···

       1
       1
        
       defmodule EslHnWeb.API.Controller do

     

       2
       2
       +
         @moduledoc """

     

       3
       3
       +
         Controller for serving HN top stories cache

     

       4
       4
       +
         """

     

       5
       5
       +
       

     

       2
       6
        
         use EslHnWeb, :controller

     

       3
       7
        
       

     

       4
       8
        
         def index(conn, params) do

     
···

       7
       11
        
           render(conn, items: EslHn.all(page))

     

       8
       12
        
         end

     

       9
       13
        
       

     

       10
       10
       -
         def show(conn, %{"id" => _id}) do

     

       11
       11
       -
           render(conn, item: %EslHn.Hn.Story{})

     

       14
       14
       +
         def show(conn, %{"id" => id}) do

     

       15
       15
       +
           with {:ok, id} <- try_int(id),

     

       16
       16
       +
                {:ok, story} <- EslHn.story(id) do

     

       17
       17
       +
             render(conn, item: story)

     

       18
       18
       +
           else

     

       19
       19
       +
             _ ->

     

       20
       20
       +
               conn

     

       21
       21
       +
               |> put_status(:not_found)

     

       22
       22
       +
               |> put_view(EslHnWeb.Error.JSON)

     

       23
       23
       +
               |> render(:"404", %{})

     

       24
       24
       +
           end

     

       12
       25
        
         end

     

       13
       26
        
       

     

       14
       27
        
         defp get_page(nil), do: 1

     

       15
       28
        
       

     

       16
       29
        
         defp get_page(input) do

     

       17
       30
        
           String.to_integer(input)

     

       31
       31
       +
         end

     

       32
       32
       +
       

     

       33
       33
       +
         defp try_int(value) do

     

       34
       34
       +
           case Integer.parse(value) do

     

       35
       35
       +
             {int, ""} -> {:ok, int}

     

       36
       36
       +
             _ -> :error

     

       37
       37
       +
           end

     

       18
       38
        
         end

     

       19
       39
        
       end

lib/esl_hn_web/api/json.ex

···

       1
       1
        
       defmodule EslHnWeb.API.JSON do

     

       2
       2
       +
         @moduledoc """

     

       3
       3
       +
         Simple JSON view into Hacker New stories

     

       4
       4
       +
         """

     

       5
       5
       +
       

     

       2
       6
        
         def index(attrs) do

     

       3
       7
        
           Enum.map(attrs.items, &one/1)

     

       4
       8
        
         end

     
···

       9
       13
        
       

     

       10
       14
        
         defp one(%EslHn.Hn.Story{} = story) do

     

       11
       15
        
           %{

     

       16
       16
       +
             id: story.id,

     

       12
       17
        
             title: story.title,

     

       13
       18
        
             url: story.url,

     

       14
       19
        
             score: story.score

+49

lib/esl_hn_web/api/socket.ex

···

       1
       1
       +
       defmodule EslHnWeb.API.Socket do

     

       2
       2
       +
         @moduledoc """

     

       3
       3
       +
         WebSocket API for serving top stories news

     

       4
       4
       +
         """

     

       5
       5
       +
       

     

       6
       6
       +
         @behaviour Phoenix.Socket.Transport

     

       7
       7
       +
       

     

       8
       8
       +
         alias EslHnWeb.API.JSON, as: View

     

       9
       9
       +
       

     

       10
       10
       +
         @impl true

     

       11
       11
       +
         def child_spec(_opts), do: :ignore

     

       12
       12
       +
       

     

       13
       13
       +
         @impl true

     

       14
       14
       +
         def connect(_connect_info) do

     

       15
       15
       +
           {:ok, []}

     

       16
       16
       +
         end

     

       17
       17
       +
       

     

       18
       18
       +
         @impl true

     

       19
       19
       +
         def init(state) do

     

       20
       20
       +
           # No support for `handle_continue/2` so we need to hack it around

     

       21
       21
       +
           send(self(), :do_init)

     

       22
       22
       +
           EslHn.subscribe_new()

     

       23
       23
       +
       

     

       24
       24
       +
           {:ok, state}

     

       25
       25
       +
         end

     

       26
       26
       +
       

     

       27
       27
       +
         @impl true

     

       28
       28
       +
         def handle_in({_message, _opts}, state) do

     

       29
       29
       +
           # Ignore all incoming messages

     

       30
       30
       +
           {:ok, state}

     

       31
       31
       +
         end

     

       32
       32
       +
       

     

       33
       33
       +
         @impl true

     

       34
       34
       +
         def handle_info(:do_init, state) do

     

       35
       35
       +
           stories = EslHn.all(1, 50)

     

       36
       36
       +
           data = View.index(%{items: stories})

     

       37
       37
       +
       

     

       38
       38
       +
           {:push, {:text, JSON.encode_to_iodata!(data)}, state}

     

       39
       39
       +
         end

     

       40
       40
       +
       

     

       41
       41
       +
         def handle_info({:new_stories, stories}, state) do

     

       42
       42
       +
           data = View.index(%{items: stories})

     

       43
       43
       +
       

     

       44
       44
       +
           {:push, {:text, JSON.encode_to_iodata!(data)}, state}

     

       45
       45
       +
         end

     

       46
       46
       +
       

     

       47
       47
       +
         @impl true

     

       48
       48
       +
         def terminate(_reason, _state), do: :ok

     

       49
       49
       +
       end

lib/esl_hn_web/endpoint.ex

···

       12
       12
        
           websocket: [connect_info: [session: @session_options]],

     

       13
       13
        
           longpoll: [connect_info: [session: @session_options]]

     

       14
       14
        
       

     

       15
       15
       +
         socket "/", EslHnWeb.API.Socket

     

       16
       16
       +
       

     

       15
       17
        
         plug Plug.Static,

     

       16
       18
        
           at: "/",

     

       17
       19
        
           from: :esl_hn,

lib/esl_hn_web/router.ex

···

       9
       9
        
           pipe_through :api

     

       10
       10
        
       

     

       11
       11
        
           get "/", API.Controller, :index

     

       12
       12
       +
           get "/:id", API.Controller, :show

     

       12
       13
        
         end

     

       13
       14
        
       

     

       14
       15
        
         if Application.compile_env(:esl_hn, :dev_routes) do

+13

lib/esl_hn_web/telemetry.ex

···

       47
       47
        
               tags: [:event],

     

       48
       48
        
               unit: {:native, :millisecond}

     

       49
       49
        
             ),

     

       50
       50
       +
             summary("esl_hn.refresh.stop.duration",

     

       51
       51
       +
               unit: {:native, :millisecond}

     

       52
       52
       +
             ),

     

       53
       53
       +
             sum("esl_hn.refresh.stop.new"),

     

       54
       54
       +
             sum("esl_hn.refresh.stop.old"),

     

       55
       55
       +
             counter("esl_hn.refresh.stop.failed"),

     

       56
       56
       +
             sum("esl_hn.cache.fetch.stop.hit"),

     

       57
       57
       +
             sum("esl_hn.cache.fetch.stop.miss"),

     

       58
       58
       +
             sum("esl_hn.cache.write.stop.count"),

     

       59
       59
       +
             summary("req.request.pipeline.stop.duration",

     

       60
       60
       +
               tags: [:url],

     

       61
       61
       +
               unit: {:native, :millisecond}

     

       62
       62
       +
             ),

     

       50
       63
        
       

     

       51
       64
        
             # VM Metrics

     

       52
       65
        
             summary("vm.memory.total", unit: {:byte, :kilobyte}),

+8 -2

mix.exs

···

       16
       16
        
         def application do

     

       17
       17
        
           [

     

       18
       18
        
             mod: {EslHn.Application, []},

     

       19
       19
       -
             extra_applications: [:logger, :runtime_tools]

     

       19
       19
       +
             extra_applications: [:logger, :runtime_tools, :os_mon]

     

       20
       20
        
           ]

     

       21
       21
        
         end

     

       22
       22
        
       

     
···

       30
       30
        
       

     

       31
       31
        
             # HackerNews client

     

       32
       32
        
             {:req, "~> 0.5.15"},

     

       33
       33
       +
             {:req_telemetry,

     

       34
       34
       +
              github: "hauleth/req_telemetry", ref: "template-paths-as-metadata"},

     

       33
       35
        
             {:ecto, "~> 3.13"},

     

       34
       36
        
       

     

       35
       37
        
             # Monitoring

     
···

       39
       41
        
       

     

       40
       42
        
             # Linting

     

       41
       43
        
             {:credo, ">= 0.0.0", only: [:dev]},

     

       44
       44
       +
             {:dialyxir, ">= 0.0.0", only: [:dev]},

     

       42
       45
        
       

     

       43
       46
        
             # Testing

     

       44
       47
        
             {:test_server, "~> 0.1.21", only: [:test]},

     

       45
       45
       -
             {:stream_data, "~> 1.0", only: [:dev, :test]}

     

       48
       48
       +
             {:stream_data, "~> 1.0", only: [:dev, :test]},

     

       49
       49
       +
             # Websocket client for testing custom socket transport, I have no idea how

     

       50
       50
       +
             # ti can test it better

     

       51
       51
       +
             {:fresh, "~> 0.4.4", only: [:test]}

     

       46
       52
        
           ]

     

       47
       53
        
         end

     

       48
       54

mix.lock

···

       4
       4
        
         "castore": {:hex, :castore, "1.0.14", "4582dd7d630b48cf5e1ca8d3d42494db51e406b7ba704e81fbd401866366896a", [:mix], [], "hexpm", "7bc1b65249d31701393edaaac18ec8398d8974d52c647b7904d01b964137b9f4"},

     

       5
       5
        
         "credo": {:hex, :credo, "1.7.12", "9e3c20463de4b5f3f23721527fcaf16722ec815e70ff6c60b86412c695d426c1", [:mix], [{:bunt, "~> 0.2.1 or ~> 1.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:file_system, "~> 0.2 or ~> 1.0", [hex: :file_system, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "8493d45c656c5427d9c729235b99d498bd133421f3e0a683e5c1b561471291e5"},

     

       6
       6
        
         "decimal": {:hex, :decimal, "2.3.0", "3ad6255aa77b4a3c4f818171b12d237500e63525c2fd056699967a3e7ea20f62", [:mix], [], "hexpm", "a4d66355cb29cb47c3cf30e71329e58361cfcb37c34235ef3bf1d7bf3773aeac"},

     

       7
       7
       +
         "dialyxir": {:hex, :dialyxir, "1.4.5", "ca1571ac18e0f88d4ab245f0b60fa31ff1b12cbae2b11bd25d207f865e8ae78a", [:mix], [{:erlex, ">= 0.2.7", [hex: :erlex, repo: "hexpm", optional: false]}], "hexpm", "b0fb08bb8107c750db5c0b324fa2df5ceaa0f9307690ee3c1f6ba5b9eb5d35c3"},

     

       7
       8
        
         "ecto": {:hex, :ecto, "3.13.2", "7d0c0863f3fc8d71d17fc3ad3b9424beae13f02712ad84191a826c7169484f01", [:mix], [{:decimal, "~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "669d9291370513ff56e7b7e7081b7af3283d02e046cf3d403053c557894a0b3e"},

     

       9
       9
       +
         "erlex": {:hex, :erlex, "0.2.7", "810e8725f96ab74d17aac676e748627a07bc87eb950d2b83acd29dc047a30595", [:mix], [], "hexpm", "3ed95f79d1a844c3f6bf0cea61e0d5612a42ce56da9c03f01df538685365efb0"},

     

       8
       10
        
         "file_system": {:hex, :file_system, "1.1.0", "08d232062284546c6c34426997dd7ef6ec9f8bbd090eb91780283c9016840e8f", [:mix], [], "hexpm", "bfcf81244f416871f2a2e15c1b515287faa5db9c6bcf290222206d120b3d43f6"},

     

       9
       11
        
         "finch": {:hex, :finch, "0.20.0", "5330aefb6b010f424dcbbc4615d914e9e3deae40095e73ab0c1bb0968933cadf", [:mix], [{:mime, "~> 1.0 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:mint, "~> 1.6.2 or ~> 1.7", [hex: :mint, repo: "hexpm", optional: false]}, {:nimble_options, "~> 0.4 or ~> 1.0", [hex: :nimble_options, repo: "hexpm", optional: false]}, {:nimble_pool, "~> 1.1", [hex: :nimble_pool, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "2658131a74d051aabfcba936093c903b8e89da9a1b63e430bee62045fa9b2ee2"},

     

       12
       12
       +
         "fresh": {:hex, :fresh, "0.4.4", "9d67a1d97112e70f4dfabd63b40e4b182ef64dfa84a2d9ee175eb4e34591e9f7", [:mix], [{:castore, "~> 1.0", [hex: :castore, repo: "hexpm", optional: false]}, {:mint, "~> 1.5", [hex: :mint, repo: "hexpm", optional: false]}, {:mint_web_socket, "~> 1.0", [hex: :mint_web_socket, repo: "hexpm", optional: false]}], "hexpm", "ba21d3fa0aa77bf18ca397e4c851de7432bb3f9c170a1645a16e09e4bba54315"},

     

       10
       13
        
         "hpax": {:hex, :hpax, "1.0.3", "ed67ef51ad4df91e75cc6a1494f851850c0bd98ebc0be6e81b026e765ee535aa", [:mix], [], "hexpm", "8eab6e1cfa8d5918c2ce4ba43588e894af35dbd8e91e6e55c817bca5847df34a"},

     

       11
       14
        
         "jason": {:hex, :jason, "1.4.4", "b9226785a9aa77b6857ca22832cffa5d5011a667207eb2a0ad56adb5db443b8a", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "c5eb0cab91f094599f94d55bc63409236a8ec69a21a67814529e8d5f6cc90b3b"},

     

       12
       15
        
         "mime": {:hex, :mime, "2.0.7", "b8d739037be7cd402aee1ba0306edfdef982687ee7e9859bee6198c1e7e2f128", [:mix], [], "hexpm", "6171188e399ee16023ffc5b76ce445eb6d9672e2e241d2df6050f3c771e80ccd"},

     

       13
       16
        
         "mint": {:hex, :mint, "1.7.1", "113fdb2b2f3b59e47c7955971854641c61f378549d73e829e1768de90fc1abf1", [:mix], [{:castore, "~> 0.1.0 or ~> 1.0", [hex: :castore, repo: "hexpm", optional: true]}, {:hpax, "~> 0.1.1 or ~> 0.2.0 or ~> 1.0", [hex: :hpax, repo: "hexpm", optional: false]}], "hexpm", "fceba0a4d0f24301ddee3024ae116df1c3f4bb7a563a731f45fdfeb9d39a231b"},

     

       17
       17
       +
         "mint_web_socket": {:hex, :mint_web_socket, "1.0.4", "0b539116dbb3d3f861cdf5e15e269a933cb501c113a14db7001a3157d96ffafd", [:mix], [{:mint, ">= 1.4.1 and < 2.0.0-0", [hex: :mint, repo: "hexpm", optional: false]}], "hexpm", "027d4c5529c45a4ba0ce27a01c0f35f284a5468519c045ca15f43decb360a991"},

     

       14
       18
        
         "nimble_options": {:hex, :nimble_options, "1.1.1", "e3a492d54d85fc3fd7c5baf411d9d2852922f66e69476317787a7b2bb000a61b", [:mix], [], "hexpm", "821b2470ca9442c4b6984882fe9bb0389371b8ddec4d45a9504f00a66f650b44"},

     

       15
       19
        
         "nimble_pool": {:hex, :nimble_pool, "1.1.0", "bf9c29fbdcba3564a8b800d1eeb5a3c58f36e1e11d7b7fb2e084a643f645f06b", [:mix], [], "hexpm", "af2e4e6b34197db81f7aad230c1118eac993acc0dae6bc83bac0126d4ae0813a"},

     

       16
       20
        
         "phoenix": {:hex, :phoenix, "1.7.21", "14ca4f1071a5f65121217d6b57ac5712d1857e40a0833aff7a691b7870fc9a3b", [:mix], [{:castore, ">= 0.0.0", [hex: :castore, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:phoenix_pubsub, "~> 2.1", [hex: :phoenix_pubsub, repo: "hexpm", optional: false]}, {:phoenix_template, "~> 1.0", [hex: :phoenix_template, repo: "hexpm", optional: false]}, {:phoenix_view, "~> 2.0", [hex: :phoenix_view, repo: "hexpm", optional: true]}, {:plug, "~> 1.14", [hex: :plug, repo: "hexpm", optional: false]}, {:plug_cowboy, "~> 2.7", [hex: :plug_cowboy, repo: "hexpm", optional: true]}, {:plug_crypto, "~> 1.2 or ~> 2.0", [hex: :plug_crypto, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}, {:websock_adapter, "~> 0.5.3", [hex: :websock_adapter, repo: "hexpm", optional: false]}], "hexpm", "336dce4f86cba56fed312a7d280bf2282c720abb6074bdb1b61ec8095bdd0bc9"},

     
···

       22
       26
        
         "plug": {:hex, :plug, "1.18.1", "5067f26f7745b7e31bc3368bc1a2b818b9779faa959b49c934c17730efc911cf", [:mix], [{:mime, "~> 1.0 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:plug_crypto, "~> 1.1.1 or ~> 1.2 or ~> 2.0", [hex: :plug_crypto, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4.3 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "57a57db70df2b422b564437d2d33cf8d33cd16339c1edb190cd11b1a3a546cc2"},

     

       23
       27
        
         "plug_crypto": {:hex, :plug_crypto, "2.1.1", "19bda8184399cb24afa10be734f84a16ea0a2bc65054e23a62bb10f06bc89491", [:mix], [], "hexpm", "6470bce6ffe41c8bd497612ffde1a7e4af67f36a15eea5f921af71cf3e11247c"},

     

       24
       28
        
         "req": {:hex, :req, "0.5.15", "662020efb6ea60b9f0e0fac9be88cd7558b53fe51155a2d9899de594f9906ba9", [:mix], [{:brotli, "~> 0.3.1", [hex: :brotli, repo: "hexpm", optional: true]}, {:ezstd, "~> 1.0", [hex: :ezstd, repo: "hexpm", optional: true]}, {:finch, "~> 0.17", [hex: :finch, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}, {:mime, "~> 2.0.6 or ~> 2.1", [hex: :mime, repo: "hexpm", optional: false]}, {:nimble_csv, "~> 1.0", [hex: :nimble_csv, repo: "hexpm", optional: true]}, {:plug, "~> 1.0", [hex: :plug, repo: "hexpm", optional: true]}], "hexpm", "a6513a35fad65467893ced9785457e91693352c70b58bbc045b47e5eb2ef0c53"},

     

       29
       29
       +
         "req_telemetry": {:git, "https://github.com/hauleth/req_telemetry.git", "449ddbc2f409fb2ea9efe4ad2a2b229cd01aa153", [ref: "template-paths-as-metadata"]},

     

       25
       30
        
         "stream_data": {:hex, :stream_data, "1.2.0", "58dd3f9e88afe27dc38bef26fce0c84a9e7a96772b2925c7b32cd2435697a52b", [:mix], [], "hexpm", "eb5c546ee3466920314643edf68943a5b14b32d1da9fe01698dc92b73f89a9ed"},

     

       26
       31
        
         "telemetry": {:hex, :telemetry, "1.3.0", "fedebbae410d715cf8e7062c96a1ef32ec22e764197f70cda73d82778d61e7a2", [:rebar3], [], "hexpm", "7015fc8919dbe63764f4b4b87a95b7c0996bd539e0d499be6ec9d7f3875b79e6"},

     

       27
       32
        
         "telemetry_metrics": {:hex, :telemetry_metrics, "1.1.0", "5bd5f3b5637e0abea0426b947e3ce5dd304f8b3bc6617039e2b5a008adc02f8f", [:mix], [{:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "e7b79e8ddfde70adb6db8a6623d1778ec66401f366e9a8f5dd0955c56bc8ce67"},

+45

test/esl_hn/cache_test.exs

···

       34
       34
        
             end

     

       35
       35
        
           end

     

       36
       36
        
         end

     

       37
       37
       +
       

     

       38
       38
       +
         describe "get/3" do

     

       39
       39
       +
           test "default value for non-existent keys is `nil`" do

     

       40
       40
       +
             assert {:ok, _pid, tid} = start_supervised(@subject)

     

       41
       41
       +
       

     

       42
       42
       +
             assert nil == @subject.get(tid, :non_existent)

     

       43
       43
       +
           end

     

       44
       44
       +
       

     

       45
       45
       +
           property "fetching non-existent data returns default value" do

     

       46
       46
       +
             assert {:ok, _pid, tid} = start_supervised(@subject)

     

       47
       47
       +
       

     

       48
       48
       +
             check all(key <- term(), data <- term()) do

     

       49
       49
       +
               assert data == @subject.get(tid, key, data)

     

       50
       50
       +
             end

     

       51
       51
       +
           end

     

       52
       52
       +
       

     

       53
       53
       +
           property "fetching existing data returns that data" do

     

       54
       54
       +
             assert {:ok, _pid, tid} = start_supervised(@subject)

     

       55
       55
       +
       

     

       56
       56
       +
             check all(key <- term(), data <- term()) do

     

       57
       57
       +
               assert :ok == @subject.write(tid, key, data)

     

       58
       58
       +
       

     

       59
       59
       +
               assert data == @subject.get(tid, key)

     

       60
       60
       +
             end

     

       61
       61
       +
           end

     

       62
       62
       +
         end

     

       63
       63
       +
       

     

       64
       64
       +
         describe "prune/2" do

     

       65
       65
       +
           test "removing non-existent data is no-op" do

     

       66
       66
       +
             assert {:ok, _pid, tid} = start_supervised(@subject)

     

       67
       67
       +
       

     

       68
       68
       +
             assert :ok == @subject.prune(tid, :non_existent)

     

       69
       69
       +
           end

     

       70
       70
       +
       

     

       71
       71
       +
           property "we can read written data" do

     

       72
       72
       +
             assert {:ok, _pid, tid} = start_supervised(@subject)

     

       73
       73
       +
       

     

       74
       74
       +
             check all(key <- term(), data <- term()) do

     

       75
       75
       +
               assert :ok == @subject.write(tid, key, data)

     

       76
       76
       +
               assert {:ok, data} == @subject.fetch(tid, key)

     

       77
       77
       +
               assert :ok == @subject.prune(tid, key)

     

       78
       78
       +
               assert :error == @subject.fetch(tid, key)

     

       79
       79
       +
             end

     

       80
       80
       +
           end

     

       81
       81
       +
         end

     

       37
       82
        
       end

+78

test/esl_hn/hn_test.exs

···

       32
       32
        
             assert {:error, {:http_response, 418, _}} =

     

       33
       33
        
                      @subject.top_stories_ids(base_url: TestServer.url())

     

       34
       34
        
           end

     

       35
       35
       +
       

     

       36
       36
       +
           test "returns error in case of network error" do

     

       37
       37
       +
             assert {:error, _} =

     

       38
       38
       +
                      @subject.top_stories_ids(

     

       39
       39
       +
                        adapter: fn request ->

     

       40
       40
       +
                          {request, %RuntimeError{message: "oops"}}

     

       41
       41
       +
                        end

     

       42
       42
       +
                      )

     

       43
       43
       +
           end

     

       35
       44
        
         end

     

       36
       45
        
       

     

       37
       46
        
         describe "story/2" do

     

       47
       47
       +
           test "returns story on 200 response" do

     

       48
       48
       +
             data = %{

     

       49
       49
       +
               id: 2137,

     

       50
       50
       +
               title: "Foo"

     

       51
       51
       +
             }

     

       52
       52
       +
       

     

       53
       53
       +
             TestServer.add("/item/2137.json",

     

       54
       54
       +
               to: fn conn ->

     

       55
       55
       +
                 Phoenix.Controller.json(conn, data)

     

       56
       56
       +
               end

     

       57
       57
       +
             )

     

       58
       58
       +
       

     

       59
       59
       +
             assert {:ok, %{title: "Foo"}} =

     

       60
       60
       +
                      @subject.story(2137, base_url: TestServer.url())

     

       61
       61
       +
           end

     

       62
       62
       +
       

     

       63
       63
       +
           test "returns error in case of network error" do

     

       64
       64
       +
             assert {:error, _} =

     

       65
       65
       +
                      @subject.story(2137,

     

       66
       66
       +
                        adapter: fn request ->

     

       67
       67
       +
                          {request, %RuntimeError{message: "oops"}}

     

       68
       68
       +
                        end

     

       69
       69
       +
                      )

     

       70
       70
       +
           end

     

       71
       71
       +
         end

     

       72
       72
       +
       

     

       73
       73
       +
         describe "stories/2" do

     

       74
       74
       +
           test "returns stories on 200 response" do

     

       75
       75
       +
             TestServer.add("/item/2137.json",

     

       76
       76
       +
               to: fn conn ->

     

       77
       77
       +
                 Phoenix.Controller.json(conn, %{

     

       78
       78
       +
                   id: 2137,

     

       79
       79
       +
                   title: "Foo"

     

       80
       80
       +
                 })

     

       81
       81
       +
               end

     

       82
       82
       +
             )

     

       83
       83
       +
       

     

       84
       84
       +
             TestServer.add("/item/666.json",

     

       85
       85
       +
               to: fn conn ->

     

       86
       86
       +
                 Phoenix.Controller.json(conn, %{

     

       87
       87
       +
                   id: 666,

     

       88
       88
       +
                   title: "Bar"

     

       89
       89
       +
                 })

     

       90
       90
       +
               end

     

       91
       91
       +
             )

     

       92
       92
       +
       

     

       93
       93
       +
             assert {:ok, [_, _]} =

     

       94
       94
       +
                      @subject.stories([2137, 666], base_url: TestServer.url())

     

       95
       95
       +
           end

     

       96
       96
       +
       

     

       97
       97
       +
           test "returns error if at least one story returns error" do

     

       98
       98
       +
             TestServer.add("/item/2137.json",

     

       99
       99
       +
               to: fn conn ->

     

       100
       100
       +
                 Phoenix.Controller.json(conn, %{

     

       101
       101
       +
                   id: 2137,

     

       102
       102
       +
                   title: "Foo"

     

       103
       103
       +
                 })

     

       104
       104
       +
               end

     

       105
       105
       +
             )

     

       106
       106
       +
       

     

       107
       107
       +
             TestServer.add("/item/666.json",

     

       108
       108
       +
               to: fn conn ->

     

       109
       109
       +
                 Conn.send_resp(conn, 404, "")

     

       110
       110
       +
               end

     

       111
       111
       +
             )

     

       112
       112
       +
       

     

       113
       113
       +
             assert {:error, _} =

     

       114
       114
       +
                      @subject.stories([2137, 666], base_url: TestServer.url())

     

       115
       115
       +
           end

     

       38
       116
        
         end

     

       39
       117
        
       end

+233

test/esl_hn/refresher_test.exs

···

       1
       1
       +
       defmodule EslHn.RefresherTest do

     

       2
       2
       +
         use ExUnit.Case, async: true

     

       3
       3
       +
       

     

       4
       4
       +
         @subject EslHn.Refresher

     

       5
       5
       +
       

     

       6
       6
       +
         doctest @subject

     

       7
       7
       +
       

     

       8
       8
       +
         defmodule CacheMock do

     

       9
       9
       +
           def write(pid, key, data) do

     

       10
       10
       +
             send(pid, {:write, key, data})

     

       11
       11
       +
             :ok

     

       12
       12
       +
           end

     

       13
       13
       +
       

     

       14
       14
       +
           def write_all(pid, data) do

     

       15
       15
       +
             send(pid, {:write_all, data})

     

       16
       16
       +
       

     

       17
       17
       +
             :ok

     

       18
       18
       +
           end

     

       19
       19
       +
       

     

       20
       20
       +
           def prune_all(pid, keys) do

     

       21
       21
       +
             send(pid, {:prune_all, Enum.to_list(keys)})

     

       22
       22
       +
       

     

       23
       23
       +
             :ok

     

       24
       24
       +
           end

     

       25
       25
       +
         end

     

       26
       26
       +
       

     

       27
       27
       +
         test "sends request to fetch top stories on startup" do

     

       28
       28
       +
           this = self()

     

       29
       29
       +
       

     

       30
       30
       +
           TestServer.add("/topstories.json",

     

       31
       31
       +
             to: fn conn ->

     

       32
       32
       +
               send(this, {:http, :topstories})

     

       33
       33
       +
               Phoenix.Controller.json(conn, [])

     

       34
       34
       +
             end

     

       35
       35
       +
           )

     

       36
       36
       +
       

     

       37
       37
       +
           start_subject()

     

       38
       38
       +
       

     

       39
       39
       +
           assert_receive {:http, :topstories}

     

       40
       40
       +
         end

     

       41
       41
       +
       

     

       42
       42
       +
         test "sends requests in periodic manner" do

     

       43
       43
       +
           this = self()

     

       44
       44
       +
       

     

       45
       45
       +
           TestServer.add("/topstories.json",

     

       46
       46
       +
             to: fn conn ->

     

       47
       47
       +
               send(this, {:http, :topstories, 1})

     

       48
       48
       +
               Phoenix.Controller.json(conn, [])

     

       49
       49
       +
             end

     

       50
       50
       +
           )

     

       51
       51
       +
       

     

       52
       52
       +
           TestServer.add("/topstories.json",

     

       53
       53
       +
             to: fn conn ->

     

       54
       54
       +
               send(this, {:http, :topstories, 2})

     

       55
       55
       +
               Phoenix.Controller.json(conn, [])

     

       56
       56
       +
             end

     

       57
       57
       +
           )

     

       58
       58
       +
       

     

       59
       59
       +
           start_subject(refresh: 10)

     

       60
       60
       +
       

     

       61
       61
       +
           assert_receive {:http, :topstories, 1}

     

       62
       62
       +
           assert_receive {:http, :topstories, 2}

     

       63
       63
       +
         end

     

       64
       64
       +
       

     

       65
       65
       +
         test "top stories list is stored in `:index` key" do

     

       66
       66
       +
           TestServer.add("/topstories.json",

     

       67
       67
       +
             to: fn conn -> Phoenix.Controller.json(conn, []) end

     

       68
       68
       +
           )

     

       69
       69
       +
       

     

       70
       70
       +
           start_subject()

     

       71
       71
       +
       

     

       72
       72
       +
           assert_receive {:write, :index, []}

     

       73
       73
       +
         end

     

       74
       74
       +
       

     

       75
       75
       +
         test "stories in response are fetched" do

     

       76
       76
       +
           this = self()

     

       77
       77
       +
       

     

       78
       78
       +
           TestServer.add("/topstories.json",

     

       79
       79
       +
             to: fn conn -> Phoenix.Controller.json(conn, [1]) end

     

       80
       80
       +
           )

     

       81
       81
       +
       

     

       82
       82
       +
           TestServer.add("/item/1.json",

     

       83
       83
       +
             to: fn conn ->

     

       84
       84
       +
               send(this, {:http, :item, 1})

     

       85
       85
       +
               Phoenix.Controller.json(conn, %{title: "Foo"})

     

       86
       86
       +
             end

     

       87
       87
       +
           )

     

       88
       88
       +
       

     

       89
       89
       +
           start_subject()

     

       90
       90
       +
       

     

       91
       91
       +
           assert_receive {:write, :index, [1]}

     

       92
       92
       +
           assert_receive {:http, :item, 1}

     

       93
       93
       +
           assert_receive {:write_all, [{_, story}]}

     

       94
       94
       +
           assert story.title == "Foo"

     

       95
       95
       +
         end

     

       96
       96
       +
       

     

       97
       97
       +
         test "new stories are fetched" do

     

       98
       98
       +
           this = self()

     

       99
       99
       +
       

     

       100
       100
       +
           TestServer.add("/topstories.json",

     

       101
       101
       +
             to: fn conn -> Phoenix.Controller.json(conn, [1]) end

     

       102
       102
       +
           )

     

       103
       103
       +
       

     

       104
       104
       +
           TestServer.add("/item/1.json",

     

       105
       105
       +
             to: fn conn ->

     

       106
       106
       +
               send(this, {:http, :item, 1})

     

       107
       107
       +
               Phoenix.Controller.json(conn, %{id: 1, title: "Foo"})

     

       108
       108
       +
             end

     

       109
       109
       +
           )

     

       110
       110
       +
       

     

       111
       111
       +
           TestServer.add("/topstories.json",

     

       112
       112
       +
             to: fn conn -> Phoenix.Controller.json(conn, [2]) end

     

       113
       113
       +
           )

     

       114
       114
       +
       

     

       115
       115
       +
           TestServer.add("/item/2.json",

     

       116
       116
       +
             to: fn conn ->

     

       117
       117
       +
               send(this, {:http, :item, 2})

     

       118
       118
       +
               Phoenix.Controller.json(conn, %{id: 2, title: "Bar"})

     

       119
       119
       +
             end

     

       120
       120
       +
           )

     

       121
       121
       +
       

     

       122
       122
       +
           start_subject(refresh: 10)

     

       123
       123
       +
       

     

       124
       124
       +
           assert_receive {:http, :item, 2}

     

       125
       125
       +
           assert_receive {:write_all, [{2, _}]}

     

       126
       126
       +
         end

     

       127
       127
       +
       

     

       128
       128
       +
         test "broadcast new stories" do

     

       129
       129
       +
           this = self()

     

       130
       130
       +
       

     

       131
       131
       +
           TestServer.add("/topstories.json",

     

       132
       132
       +
             to: fn conn -> Phoenix.Controller.json(conn, [1]) end

     

       133
       133
       +
           )

     

       134
       134
       +
       

     

       135
       135
       +
           TestServer.add("/item/1.json",

     

       136
       136
       +
             to: fn conn ->

     

       137
       137
       +
               send(this, {:http, :item, 1})

     

       138
       138
       +
               Phoenix.Controller.json(conn, %{id: 1, title: "Foo"})

     

       139
       139
       +
             end

     

       140
       140
       +
           )

     

       141
       141
       +
       

     

       142
       142
       +
           TestServer.add("/topstories.json",

     

       143
       143
       +
             to: fn conn -> Phoenix.Controller.json(conn, [2]) end

     

       144
       144
       +
           )

     

       145
       145
       +
       

     

       146
       146
       +
           TestServer.add("/item/2.json",

     

       147
       147
       +
             to: fn conn ->

     

       148
       148
       +
               send(this, {:http, :item, 2})

     

       149
       149
       +
               Phoenix.Controller.json(conn, %{id: 2, title: "Bar"})

     

       150
       150
       +
             end

     

       151
       151
       +
           )

     

       152
       152
       +
       

     

       153
       153
       +
           start_subject(refresh: 10)

     

       154
       154
       +
       

     

       155
       155
       +
           assert_receive {:http, :item, 1}

     

       156
       156
       +
       

     

       157
       157
       +
           EslHn.subscribe_new()

     

       158
       158
       +
       

     

       159
       159
       +
           assert_receive {:http, :item, 2}

     

       160
       160
       +
           assert_receive {:new_stories, [%{id: 2}]}

     

       161
       161
       +
         end

     

       162
       162
       +
       

     

       163
       163
       +
         test "old stories are pruned" do

     

       164
       164
       +
           TestServer.add("/topstories.json",

     

       165
       165
       +
             to: fn conn -> Phoenix.Controller.json(conn, [1]) end

     

       166
       166
       +
           )

     

       167
       167
       +
       

     

       168
       168
       +
           TestServer.add("/item/1.json",

     

       169
       169
       +
             to: fn conn ->

     

       170
       170
       +
               Phoenix.Controller.json(conn, %{id: 1, title: "Foo"})

     

       171
       171
       +
             end

     

       172
       172
       +
           )

     

       173
       173
       +
       

     

       174
       174
       +
           TestServer.add("/topstories.json",

     

       175
       175
       +
             to: fn conn -> Phoenix.Controller.json(conn, [2]) end

     

       176
       176
       +
           )

     

       177
       177
       +
       

     

       178
       178
       +
           TestServer.add("/item/2.json",

     

       179
       179
       +
             to: fn conn ->

     

       180
       180
       +
               Phoenix.Controller.json(conn, %{id: 2, title: "Bar"})

     

       181
       181
       +
             end

     

       182
       182
       +
           )

     

       183
       183
       +
       

     

       184
       184
       +
           start_subject(refresh: 10)

     

       185
       185
       +
       

     

       186
       186
       +
           assert_receive {:prune_all, [1]}

     

       187
       187
       +
         end

     

       188
       188
       +
       

     

       189
       189
       +
         test "on error response, process is still alive" do

     

       190
       190
       +
           TestServer.add("/topstories.json",

     

       191
       191
       +
             to: fn conn ->

     

       192
       192
       +
               Plug.Conn.send_resp(conn, 404, "")

     

       193
       193
       +
             end

     

       194
       194
       +
           )

     

       195
       195
       +
       

     

       196
       196
       +
           pid = start_subject()

     

       197
       197
       +
       

     

       198
       198
       +
           ref = Process.monitor(pid)

     

       199
       199
       +
       

     

       200
       200
       +
           refute_receive {:DOWN, ^ref, :process, ^pid, _}

     

       201
       201
       +
         end

     

       202
       202
       +
       

     

       203
       203
       +
         test "on error process is still alive" do

     

       204
       204
       +
           TestServer.start()

     

       205
       205
       +
       

     

       206
       206
       +
           pid =

     

       207
       207
       +
             start_subject(

     

       208
       208
       +
               req_opts: [

     

       209
       209
       +
                 base_url: "http://example.invalid"

     

       210
       210
       +
               ]

     

       211
       211
       +
             )

     

       212
       212
       +
       

     

       213
       213
       +
           ref = Process.monitor(pid)

     

       214
       214
       +
       

     

       215
       215
       +
           refute_receive {:DOWN, ^ref, :process, ^pid, _}

     

       216
       216
       +
         end

     

       217
       217
       +
       

     

       218
       218
       +
         defp start_subject(opts \\ []) do

     

       219
       219
       +
           this = self()

     

       220
       220
       +
       

     

       221
       221
       +
           opts =

     

       222
       222
       +
             Keyword.merge(

     

       223
       223
       +
               [

     

       224
       224
       +
                 refresh: 5000,

     

       225
       225
       +
                 cache: {CacheMock, this},

     

       226
       226
       +
                 req_opts: [base_url: TestServer.url()]

     

       227
       227
       +
               ],

     

       228
       228
       +
               opts

     

       229
       229
       +
             )

     

       230
       230
       +
       

     

       231
       231
       +
           start_supervised!({@subject, opts})

     

       232
       232
       +
         end

     

       233
       233
       +
       end

+120

test/esl_hn_web/api/controller_test.exs

···

       1
       1
       +
       defmodule EslHnWeb.Api.ControllerTest do

     

       2
       2
       +
         use EslHnWeb.ConnCase, async: false

     

       3
       3
       +
         use ExUnitProperties

     

       4
       4
       +
       

     

       5
       5
       +
         import EslHn.Test.Data

     

       6
       6
       +
       

     

       7
       7
       +
         alias EslHn.Cache

     

       8
       8
       +
       

     

       9
       9
       +
         setup do

     

       10
       10
       +
           on_exit(fn -> Cache.flush(EslHn) end)

     

       11
       11
       +
         end

     

       12
       12
       +
       

     

       13
       13
       +
         describe "GET /" do

     

       14
       14
       +
           test "with empty cache returns empty list", %{conn: conn} do

     

       15
       15
       +
             resp =

     

       16
       16
       +
               conn

     

       17
       17
       +
               |> get(~p"/")

     

       18
       18
       +
               |> json_response(200)

     

       19
       19
       +
       

     

       20
       20
       +
             assert resp == []

     

       21
       21
       +
           end

     

       22
       22
       +
       

     

       23
       23
       +
           property "with some stories in index these are fetched", %{conn: conn} do

     

       24
       24
       +
             check all(stories <- list_of(story(), max_length: 10)) do

     

       25
       25
       +
               ids = Enum.map(stories, & &1.id)

     

       26
       26
       +
               Cache.write(EslHn, :index, ids)

     

       27
       27
       +
       

     

       28
       28
       +
               Cache.write_all(EslHn, Enum.map(stories, &{&1.id, &1}))

     

       29
       29
       +
       

     

       30
       30
       +
               resp_ids =

     

       31
       31
       +
                 conn

     

       32
       32
       +
                 |> get(~p"/")

     

       33
       33
       +
                 |> json_response(200)

     

       34
       34
       +
                 |> Enum.map(& &1["id"])

     

       35
       35
       +
       

     

       36
       36
       +
               assert Enum.all?(ids, &(&1 in resp_ids))

     

       37
       37
       +
             end

     

       38
       38
       +
           end

     

       39
       39
       +
       

     

       40
       40
       +
           property "return at most 10 elements at once", %{conn: conn} do

     

       41
       41
       +
             check all(stories <- list_of(story())) do

     

       42
       42
       +
               ids = Enum.map(stories, & &1.id)

     

       43
       43
       +
               Cache.write(EslHn, :index, ids)

     

       44
       44
       +
       

     

       45
       45
       +
               Cache.write_all(EslHn, Enum.map(stories, &{&1.id, &1}))

     

       46
       46
       +
       

     

       47
       47
       +
               resp =

     

       48
       48
       +
                 conn

     

       49
       49
       +
                 |> get(~p"/")

     

       50
       50
       +
                 |> json_response(200)

     

       51
       51
       +
       

     

       52
       52
       +
               assert length(resp) <= 10

     

       53
       53
       +
             end

     

       54
       54
       +
           end

     

       55
       55
       +
       

     

       56
       56
       +
           property "if more than 10 elements there are stories on second page", %{

     

       57
       57
       +
             conn: conn

     

       58
       58
       +
           } do

     

       59
       59
       +
             check all(stories <- list_of(story(), min_length: 11)) do

     

       60
       60
       +
               ids = Enum.map(stories, & &1.id)

     

       61
       61
       +
               Cache.write(EslHn, :index, ids)

     

       62
       62
       +
       

     

       63
       63
       +
               Cache.write_all(EslHn, Enum.map(stories, &{&1.id, &1}))

     

       64
       64
       +
       

     

       65
       65
       +
               resp =

     

       66
       66
       +
                 conn

     

       67
       67
       +
                 |> get(~p"/?page=2")

     

       68
       68
       +
                 |> json_response(200)

     

       69
       69
       +
       

     

       70
       70
       +
               assert length(resp) in 1..10

     

       71
       71
       +
             end

     

       72
       72
       +
           end

     

       73
       73
       +
       

     

       74
       74
       +
           property "if requested page is outside of the possible range, returns empty list",

     

       75
       75
       +
                    %{

     

       76
       76
       +
                      conn: conn

     

       77
       77
       +
                    } do

     

       78
       78
       +
             check all(stories <- list_of(story(), max_length: 50)) do

     

       79
       79
       +
               ids = Enum.map(stories, & &1.id)

     

       80
       80
       +
               Cache.write(EslHn, :index, ids)

     

       81
       81
       +
       

     

       82
       82
       +
               Cache.write_all(EslHn, Enum.map(stories, &{&1.id, &1}))

     

       83
       83
       +
       

     

       84
       84
       +
               resp =

     

       85
       85
       +
                 conn

     

       86
       86
       +
                 |> get(~p"/?page=2137")

     

       87
       87
       +
                 |> json_response(200)

     

       88
       88
       +
       

     

       89
       89
       +
               assert resp == []

     

       90
       90
       +
             end

     

       91
       91
       +
           end

     

       92
       92
       +
         end

     

       93
       93
       +
       

     

       94
       94
       +
         describe "GET /:id" do

     

       95
       95
       +
           test "for non-existent story returns 404", %{conn: conn} do

     

       96
       96
       +
             conn

     

       97
       97
       +
             |> get(~p"/2137")

     

       98
       98
       +
             |> json_response(404)

     

       99
       99
       +
           end

     

       100
       100
       +
       

     

       101
       101
       +
           test "for non-integer story ID returns 404", %{conn: conn} do

     

       102
       102
       +
             conn

     

       103
       103
       +
             |> get(~p"/foo-bar")

     

       104
       104
       +
             |> json_response(404)

     

       105
       105
       +
           end

     

       106
       106
       +
       

     

       107
       107
       +
           test "return data for existing story", %{conn: conn} do

     

       108
       108
       +
             Cache.write_all(EslHn, [

     

       109
       109
       +
               {2137, %EslHn.Hn.Story{id: 2137, title: "Foo"}}

     

       110
       110
       +
             ])

     

       111
       111
       +
       

     

       112
       112
       +
             resp =

     

       113
       113
       +
               conn

     

       114
       114
       +
               |> get(~p"/2137")

     

       115
       115
       +
               |> json_response(200)

     

       116
       116
       +
       

     

       117
       117
       +
             assert "Foo" == resp["title"]

     

       118
       118
       +
           end

     

       119
       119
       +
         end

     

       120
       120
       +
       end

+48

test/esl_hn_web/api/json_test.exs

···

       1
       1
       +
       defmodule EslHnWeb.API.JSONTest do

     

       2
       2
       +
         use ExUnit.Case, async: true

     

       3
       3
       +
         use ExUnitProperties

     

       4
       4
       +
       

     

       5
       5
       +
         import EslHn.Test.Data

     

       6
       6
       +
       

     

       7
       7
       +
         @subject EslHnWeb.API.JSON

     

       8
       8
       +
       

     

       9
       9
       +
         doctest @subject

     

       10
       10
       +
       

     

       11
       11
       +
         describe "index/1" do

     

       12
       12
       +
           test "for empty list renders empty list" do

     

       13
       13
       +
             assert [] == @subject.index(%{items: []})

     

       14
       14
       +
           end

     

       15
       15
       +
       

     

       16
       16
       +
           property "length of encoded data is equal to items count" do

     

       17
       17
       +
             check all(stories <- list_of(story())) do

     

       18
       18
       +
               count = length(stories)

     

       19
       19
       +
       

     

       20
       20
       +
               assert count == length(@subject.index(%{items: stories}))

     

       21
       21
       +
             end

     

       22
       22
       +
           end

     

       23
       23
       +
       

     

       24
       24
       +
           property "all IDs are present in result" do

     

       25
       25
       +
             check all(stories <- list_of(story())) do

     

       26
       26
       +
               ids =

     

       27
       27
       +
                 stories

     

       28
       28
       +
                 |> Enum.map(& &1.id)

     

       29
       29
       +
                 |> Enum.sort()

     

       30
       30
       +
       

     

       31
       31
       +
               result =

     

       32
       32
       +
                 @subject.index(%{items: stories})

     

       33
       33
       +
                 |> Enum.map(& &1.id)

     

       34
       34
       +
                 |> Enum.sort()

     

       35
       35
       +
       

     

       36
       36
       +
               assert ids == result

     

       37
       37
       +
             end

     

       38
       38
       +
           end

     

       39
       39
       +
         end

     

       40
       40
       +
       

     

       41
       41
       +
         describe "show/1" do

     

       42
       42
       +
           property "encoded title is the same as input title" do

     

       43
       43
       +
             check all(story <- story()) do

     

       44
       44
       +
               assert story.title == @subject.show(%{item: story}).title

     

       45
       45
       +
             end

     

       46
       46
       +
           end

     

       47
       47
       +
         end

     

       48
       48
       +
       end

+65

test/esl_hn_web/api/socket_test.exs

···

       1
       1
       +
       defmodule EslHnWeb.Api.SocketTest do

     

       2
       2
       +
         use ExUnit.Case, async: false

     

       3
       3
       +
       

     

       4
       4
       +
         import EslHn.Test.Data

     

       5
       5
       +
       

     

       6
       6
       +
         alias EslHn.Cache

     

       7
       7
       +
       

     

       8
       8
       +
         setup do

     

       9
       9
       +
           assert {:ok, {host, port}} = EslHnWeb.Endpoint.server_info(:http)

     

       10
       10
       +
       

     

       11
       11
       +
           on_exit(fn -> Cache.flush(EslHn) end)

     

       12
       12
       +
       

     

       13
       13
       +
           {:ok, host: host, port: port}

     

       14
       14
       +
         end

     

       15
       15
       +
       

     

       16
       16
       +
         defmodule Client do

     

       17
       17
       +
           use Fresh

     

       18
       18
       +
       

     

       19
       19
       +
           def handle_in({:text, data}, {parent, counter}) do

     

       20
       20
       +
             send(parent, {:ws, counter, JSON.decode!(data)})

     

       21
       21
       +
             {:ok, {parent, counter + 1}}

     

       22
       22
       +
           end

     

       23
       23
       +
         end

     

       24
       24
       +
       

     

       25
       25
       +
         test "receive initial list of stories", ctx do

     

       26
       26
       +
           stories = Enum.take(story(), 50)

     

       27
       27
       +
       

     

       28
       28
       +
           ids = Enum.map(stories, & &1.id)

     

       29
       29
       +
           Cache.write(EslHn, :index, ids)

     

       30
       30
       +
       

     

       31
       31
       +
           Cache.write_all(EslHn, Enum.map(stories, &{&1.id, &1}))

     

       32
       32
       +
       

     

       33
       33
       +
           start_supervised!(

     

       34
       34
       +
             {Client, uri: "ws://localhost:#{ctx.port}/websocket", state: {self(), 0}}

     

       35
       35
       +
           )

     

       36
       36
       +
       

     

       37
       37
       +
           assert_receive {:ws, 0, init}

     

       38
       38
       +
       

     

       39
       39
       +
           recv_ids = Enum.map(init, & &1["id"])

     

       40
       40
       +
       

     

       41
       41
       +
           assert Enum.all?(ids, &(&1 in recv_ids))

     

       42
       42
       +
           assert length(recv_ids) == length(ids)

     

       43
       43
       +
         end

     

       44
       44
       +
       

     

       45
       45
       +
         test "broadcasted events are sent over socket", ctx do

     

       46
       46
       +
           start_supervised!(

     

       47
       47
       +
             {Client, uri: "ws://localhost:#{ctx.port}/websocket", state: {self(), 0}}

     

       48
       48
       +
           )

     

       49
       49
       +
       

     

       50
       50
       +
           assert_receive {:ws, 0, []}

     

       51
       51
       +
       

     

       52
       52
       +
           for stories <- Enum.take(StreamData.list_of(story(), min_length: 1), 10) do

     

       53
       53
       +
             ids = Enum.map(stories, & &1.id)

     

       54
       54
       +
       

     

       55
       55
       +
             EslHn.broadcast_new(stories)

     

       56
       56
       +
       

     

       57
       57
       +
             assert_receive {:ws, _, msg}

     

       58
       58
       +
       

     

       59
       59
       +
             recv_ids = Enum.map(msg, & &1["id"])

     

       60
       60
       +
       

     

       61
       61
       +
             assert Enum.all?(ids, &(&1 in recv_ids))

     

       62
       62
       +
             assert length(recv_ids) == length(ids)

     

       63
       63
       +
           end

     

       64
       64
       +
         end

     

       65
       65
       +
       end

+23

test/support/data.ex

···

       1
       1
       +
       defmodule EslHn.Test.Data do

     

       2
       2
       +
         @moduledoc """

     

       3
       3
       +
         Additional `StreamData` generators used during testing

     

       4
       4
       +
         """

     

       5
       5
       +
       

     

       6
       6
       +
         use ExUnitProperties

     

       7
       7
       +
       

     

       8
       8
       +
         alias EslHn.Hn.Story

     

       9
       9
       +
       

     

       10
       10
       +
         def story do

     

       11
       11
       +
           gen all(

     

       12
       12
       +
                 title <- string(:utf8, min_length: 1),

     

       13
       13
       +
                 score <- positive_integer()

     

       14
       14
       +
               ) do

     

       15
       15
       +
             %Story{

     

       16
       16
       +
               id: System.unique_integer([:positive]),

     

       17
       17
       +
               title: title,

     

       18
       18
       +
               score: score,

     

       19
       19
       +
               url: "https://example.com/#{URI.encode(title)}"

     

       20
       20
       +
             }

     

       21
       21
       +
           end

     

       22
       22
       +
         end

     

       23
       23
       +
       end

Compare changes