Games: Benchmarking

Mix.install([
  {:jason, "~> 1.4"},
  {:kino, "~> 0.8.0", override: true},
  {:youtube, github: "brooklinjazz/youtube"},
  {:hidden_cell, github: "brooklinjazz/hidden_cell"}
])

Navigation

Return Home Report An Issue

Games: Benchmarking

In your existing Games project, you’re going to benchmark your Wordle application.

First, add Benchee to your existing list of dependencies.

You’re going to run benchmarks in your ExUnit test suite. Since benchmarks are usually expensive, you’ll create a custom :benchmark tag and exclude this tag from tests in test_helper.exs.

You should be able to run benchmarks using the --only=benchmark or the --include=benchmark flag.

mix test --only=benchmark

Benchmark the Games.Wordle.feedback/2 function you previously created. Refactor your solution and try to optimize its performance.

Mark As Completed

file_name = Path.basename(Regex.replace(~r/#.+/, __ENV__.file, ""), ".livemd")

save_name =
  case Path.basename(__DIR__) do
    "reading" -> "games_benchmarking_reading"
    "exercises" -> "games_benchmarking_exercise"
  end

progress_path = __DIR__ <> "/../progress.json"
existing_progress = File.read!(progress_path) |> Jason.decode!()

default = Map.get(existing_progress, save_name, false)

form =
  Kino.Control.form(
    [
      completed: input = Kino.Input.checkbox("Mark As Completed", default: default)
    ],
    report_changes: true
  )

Task.async(fn ->
  for %{data: %{completed: completed}} <- Kino.Control.stream(form) do
    File.write!(
      progress_path,
      Jason.encode!(Map.put(existing_progress, save_name, completed), pretty: true)
    )
  end
end)

form

Commit Your Progress

Run the following in your command line from the curriculum folder to track and save your progress in a Git commit. Ensure that you do not already have undesired or unrelated changes by running git status or by checking the source control tab in Visual Studio Code.

$ git checkout -b games-benchmarking-exercise
$ git add .
$ git commit -m "finish games benchmarking exercise"
$ git push origin games-benchmarking-exercise

Create a pull request from your games-benchmarking-exercise branch to your solutions branch. Please do not create a pull request to the DockYard Academy repository as this will spam our PR tracker.

DockYard Academy Students Only:

Notify your teacher by including @BrooklinJazz in your PR description to get feedback. You (or your teacher) may merge your PR into your solutions branch after review.

If you are interested in joining the next academy cohort, sign up here to receive more news when it is available.

Up Next