Introduce Quokka for automatic lint fixes (defs and line lengths only) (#2293)

This introduces [Quokka](https://github.com/emkguts/quokka), an
automatic formatting tool that respects and fixes issues highlighted by
credo configurations. We use Quokka across multiple apps at Smartrent
and adoption continues to grow. I've personally found it saving me tens
of cumulative hours not having to think about various formatting
idiosyncrasies.

This PR is just a step 1 including only line length fixups. After this
the diffs of each included fixup module will be significantly smaller
(and the wins larger).

Co-authored-by: Josh Kalderimis <[email protected]>

Author: kybishop

.formatter.exs

@@ -1,7 +1,12 @@
 # Used by "mix format"
 [
-  plugins: [Phoenix.LiveView.HTMLFormatter],
-  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{heex,ex,exs}"],
   heex_line_length: 200,
-  import_deps: [:assert_eventually]
+  import_deps: [:assert_eventually],
+  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{heex,ex,exs}"],
+  plugins: [Phoenix.LiveView.HTMLFormatter, Quokka],
+  quokka: [
+    only: [
+      :defs
+    ]
+  ]
 ]

config/runtime.exs

@@ -19,37 +19,29 @@ config :nerves_hub,
   support_email_platform_name: System.get_env("SUPPORT_EMAIL_PLATFORM_NAME", "NervesHub"),
   support_email_address: System.get_env("SUPPORT_EMAIL_ADDRESS"),
   support_email_signoff: System.get_env("SUPPORT_EMAIL_SIGNOFF"),
-  device_endpoint_redirect:
-    System.get_env("DEVICE_ENDPOINT_REDIRECT", "https://docs.nerves-hub.org/"),
-  device_health_days_to_retain:
-    String.to_integer(System.get_env("HEALTH_CHECK_DAYS_TO_RETAIN", "7")),
-  device_health_delete_limit:
-    String.to_integer(System.get_env("DEVICE_HEALTH_DELETE_LIMIT", "100000")),
+  device_endpoint_redirect: System.get_env("DEVICE_ENDPOINT_REDIRECT", "https://docs.nerves-hub.org/"),
+  device_health_days_to_retain: String.to_integer(System.get_env("HEALTH_CHECK_DAYS_TO_RETAIN", "7")),
+  device_health_delete_limit: String.to_integer(System.get_env("DEVICE_HEALTH_DELETE_LIMIT", "100000")),
   device_deployment_change_jitter_seconds:
     String.to_integer(System.get_env("DEVICE_DEPLOYMENT_CHANGE_JITTER_SECONDS", "10")),
   device_last_seen_update_interval_minutes:
     String.to_integer(System.get_env("DEVICE_LAST_SEEN_UPDATE_INTERVAL_MINUTES", "15")),
   device_last_seen_update_interval_jitter_seconds:
     String.to_integer(System.get_env("DEVICE_LAST_SEEN_UPDATE_INTERVAL_JITTER_SECONDS", "300")),
-  device_connection_max_age_days:
-    String.to_integer(System.get_env("DEVICE_CONNECTION_MAX_AGE_DAYS", "14")),
-  device_connection_delete_limit:
-    String.to_integer(System.get_env("DEVICE_CONNECTION_DELETE_LIMIT", "100000")),
+  device_connection_max_age_days: String.to_integer(System.get_env("DEVICE_CONNECTION_MAX_AGE_DAYS", "14")),
+  device_connection_delete_limit: String.to_integer(System.get_env("DEVICE_CONNECTION_DELETE_LIMIT", "100000")),
   deployment_calculator_interval_seconds:
     String.to_integer(System.get_env("DEPLOYMENT_CALCULATOR_INTERVAL_SECONDS", "3600")),
   mapbox_access_token: System.get_env("MAPBOX_ACCESS_TOKEN"),
   dashboard_enabled: System.get_env("DASHBOARD_ENABLED", "false") == "true",
   extension_config: [
     geo: [
       # No interval, fetch geo on device connection by default
-      interval_minutes:
-        System.get_env("FEATURES_GEO_INTERVAL_MINUTES", "0") |> String.to_integer()
+      interval_minutes: System.get_env("FEATURES_GEO_INTERVAL_MINUTES", "0") |> String.to_integer()
     ],
     health: [
-      interval_minutes:
-        System.get_env("FEATURES_HEALTH_INTERVAL_MINUTES", "60") |> String.to_integer(),
-      ui_polling_seconds:
-        System.get_env("FEATURES_HEALTH_UI_POLLING_SECONDS", "60") |> String.to_integer()
+      interval_minutes: System.get_env("FEATURES_HEALTH_INTERVAL_MINUTES", "60") |> String.to_integer(),
+      ui_polling_seconds: System.get_env("FEATURES_HEALTH_UI_POLLING_SECONDS", "60") |> String.to_integer()
     ],
     logging: [
       days_to_keep: String.to_integer(System.get_env("EXTENSIONS_LOGGING_DAYS_TO_KEEP", "3"))
@@ -59,8 +51,7 @@ config :nerves_hub,
 
 config :nerves_hub, :device_socket_drainer,
   batch_size: String.to_integer(System.get_env("DEVICE_SOCKET_DRAINER_BATCH_SIZE", "1000")),
-  batch_interval:
-    String.to_integer(System.get_env("DEVICE_SOCKET_DRAINER_BATCH_INTERVAL", "4000")),
+  batch_interval: String.to_integer(System.get_env("DEVICE_SOCKET_DRAINER_BATCH_INTERVAL", "4000")),
   shutdown: String.to_integer(System.get_env("DEVICE_SOCKET_DRAINER_SHUTDOWN", "30000"))
 
 # only set this in :prod as not to override the :dev config
@@ -298,8 +289,7 @@ if config_env() == :prod do
 
       config :nerves_hub, NervesHub.Uploads.S3, bucket: System.fetch_env!("S3_BUCKET_NAME")
 
-      config :nerves_hub, NervesHub.Firmwares.Upload.S3,
-        bucket: System.fetch_env!("S3_BUCKET_NAME")
+      config :nerves_hub, NervesHub.Firmwares.Upload.S3, bucket: System.fetch_env!("S3_BUCKET_NAME")
 
       if System.get_env("S3_ACCESS_KEY_ID") do
         config :ex_aws, :s3,
@@ -448,8 +438,7 @@ end
 
 config :nerves_hub, :audit_logs,
   enabled: System.get_env("TRUNCATE_AUDIT_LOGS_ENABLED", "false") == "true",
-  default_days_kept:
-    String.to_integer(System.get_env("TRUNCATE_AUDIT_LOGS_DEFAULT_DAYS_KEPT", "30"))
+  default_days_kept: String.to_integer(System.get_env("TRUNCATE_AUDIT_LOGS_DEFAULT_DAYS_KEPT", "30"))
 
 config :nerves_hub, NervesHub.RateLimit,
   limit: System.get_env("DEVICE_CONNECT_RATE_LIMIT", "100") |> String.to_integer()

lib/mix/tasks/gen.metrics.ex

@@ -30,9 +30,8 @@ defmodule Mix.Tasks.NervesHub.Gen.Metrics do
   @doc """
   Runs recursively until current timestamp is less than or equal to ending timestamp
   """
-  def add_metrics(device_id, current_timestamp, ending_timestamp)
-      when current_timestamp <= ending_timestamp,
-      do: save_metrics(device_id, current_timestamp)
+  def add_metrics(device_id, current_timestamp, ending_timestamp) when current_timestamp <= ending_timestamp,
+    do: save_metrics(device_id, current_timestamp)
 
   def add_metrics(device_id, current_timestamp, ending_timestamp) do
     save_metrics(device_id, current_timestamp)

lib/nerves_hub/accounts.ex

@@ -50,9 +50,7 @@ defmodule NervesHub.Accounts do
     deleted_at = DateTime.truncate(DateTime.utc_now(), :second)
 
     Multi.new()
-    |> Multi.update_all(:soft_delete_products, Ecto.assoc(org, :products),
-      set: [deleted_at: deleted_at]
-    )
+    |> Multi.update_all(:soft_delete_products, Ecto.assoc(org, :products), set: [deleted_at: deleted_at])
     |> Multi.update(:soft_delete_org, Org.delete_changeset(org))
     |> Repo.transaction()
     |> case do
@@ -135,8 +133,7 @@ defmodule NervesHub.Accounts do
       {:ok, %{to: ..., body: ...}}
 
   """
-  def deliver_user_password_updated(%User{} = user, reset_url_fun)
-      when is_function(reset_url_fun, 1) do
+  def deliver_user_password_updated(%User{} = user, reset_url_fun) when is_function(reset_url_fun, 1) do
     {encoded_token, user_token} = UserToken.build_hashed_token(user, "reset_password", nil)
     Repo.insert!(user_token)
     UserNotifier.deliver_password_updated(user, reset_url_fun.(encoded_token))
@@ -328,8 +325,7 @@ defmodule NervesHub.Accounts do
       nil
 
   """
-  def get_user_by_email_and_password(email, password)
-      when is_binary(email) and is_binary(password) do
+  def get_user_by_email_and_password(email, password) when is_binary(email) and is_binary(password) do
     user = Repo.get_by(User, email: email)
     if User.valid_password?(user, password), do: user
   end
@@ -929,11 +925,7 @@ defmodule NervesHub.Accounts do
       {:ok, %{to: ..., body: ...}}
 
   """
-  def deliver_user_reset_password_instructions(
-        %User{google_id: google_id} = user,
-        _reset_password_url_fun,
-        login_url
-      )
+  def deliver_user_reset_password_instructions(%User{google_id: google_id} = user, _reset_password_url_fun, login_url)
       when not is_nil(google_id) do
     UserNotifier.deliver_login_with_google_reminder(user, login_url)
   end

lib/nerves_hub/accounts/user.ex

@@ -92,8 +92,7 @@ defmodule NervesHub.Accounts.User do
     |> maybe_add_confirmed_at()
   end
 
-  defp maybe_add_confirmed_at(%{data: %{confirmed_at: confirmed_at}} = changeset)
-       when is_nil(confirmed_at) do
+  defp maybe_add_confirmed_at(%{data: %{confirmed_at: confirmed_at}} = changeset) when is_nil(confirmed_at) do
     now = NaiveDateTime.utc_now() |> NaiveDateTime.truncate(:second)
 
     put_change(changeset, :confirmed_at, now)

lib/nerves_hub/application.ex

@@ -30,10 +30,8 @@ defmodule NervesHub.Application do
           {Task.Supervisor, name: NervesHub.TaskSupervisor},
           {Oban, Application.fetch_env!(:nerves_hub, Oban)},
           NervesHubWeb.Presence,
-          {NervesHub.RateLimit.LogLines,
-           [clean_period: :timer.minutes(5), key_older_than: :timer.hours(1)]},
-          {PartitionSupervisor,
-           child_spec: Task.Supervisor, name: NervesHub.AnalyticsEventsProcessing}
+          {NervesHub.RateLimit.LogLines, [clean_period: :timer.minutes(5), key_older_than: :timer.hours(1)]},
+          {PartitionSupervisor, child_spec: Task.Supervisor, name: NervesHub.AnalyticsEventsProcessing}
         ] ++
         deployments_orchestrator(deploy_env()) ++
         endpoints(deploy_env())
@@ -97,14 +95,12 @@ defmodule NervesHub.Application do
     [
       Supervisor.child_spec(
         {Ecto.Migrator,
-         repos: [NervesHub.Repo],
-         skip: Application.get_env(:nerves_hub, :database_auto_migrator) != true},
+         repos: [NervesHub.Repo], skip: Application.get_env(:nerves_hub, :database_auto_migrator) != true},
         id: :repo_migrator
       ),
       Supervisor.child_spec(
         {Ecto.Migrator,
-         repos: [NervesHub.AnalyticsRepo],
-         skip: Application.get_env(:nerves_hub, :analytics_auto_migrator) != true},
+         repos: [NervesHub.AnalyticsRepo], skip: Application.get_env(:nerves_hub, :analytics_auto_migrator) != true},
         id: :analytics_repo_migrator
       )
     ]

lib/nerves_hub/audit_logs/templates/device_templates.ex

@@ -115,11 +115,7 @@ defmodule NervesHub.AuditLogs.DeviceTemplates do
   end
 
   @spec audit_device_archive_update_triggered(Device.t(), Archive.t(), UUIDv7.t()) :: :ok
-  def audit_device_archive_update_triggered(
-        device,
-        archive,
-        reference_id
-      ) do
+  def audit_device_archive_update_triggered(device, archive, reference_id) do
     description =
       "Archive update triggered for #{device.identifier}. Sending archive #{archive.uuid}."
 

lib/nerves_hub/certificate.ex

@@ -112,8 +112,7 @@ defmodule NervesHub.Certificate do
 
   defp convert_timestamp({:utcTime, timestamp}) do
     <<year::binary-unit(8)-size(2), month::binary-unit(8)-size(2), day::binary-unit(8)-size(2),
-      hour::binary-unit(8)-size(2), minute::binary-unit(8)-size(2),
-      second::binary-unit(8)-size(2), "Z">> = timestamp
+      hour::binary-unit(8)-size(2), minute::binary-unit(8)-size(2), second::binary-unit(8)-size(2), "Z">> = timestamp
 
     NaiveDateTime.new(
       String.to_integer(year) + @era,
@@ -134,8 +133,7 @@ defmodule NervesHub.Certificate do
 
   defp convert_timestamp({:generalTime, timestamp}) do
     <<year::binary-unit(8)-size(4), month::binary-unit(8)-size(2), day::binary-unit(8)-size(2),
-      hour::binary-unit(8)-size(2), minute::binary-unit(8)-size(2),
-      second::binary-unit(8)-size(2), "Z">> = timestamp
+      hour::binary-unit(8)-size(2), minute::binary-unit(8)-size(2), second::binary-unit(8)-size(2), "Z">> = timestamp
 
     NaiveDateTime.new(
       String.to_integer(year),

lib/nerves_hub/devices.ex

@@ -207,8 +207,7 @@ defmodule NervesHub.Devices do
         {:error, :not_found}
 
       device ->
-        {:ok,
-         Repo.preload(device, [:org, :product, :latest_connection, deployment_group: [:firmware]])}
+        {:ok, Repo.preload(device, [:org, :product, :latest_connection, deployment_group: [:firmware]])}
     end
   end
 
@@ -218,8 +217,7 @@ defmodule NervesHub.Devices do
   end
 
   @spec get_device_by_identifier(Org.t(), String.t()) :: {:ok, Device.t()} | {:error, :not_found}
-  def get_device_by_identifier(org, identifier, preload_assoc \\ nil)
-      when is_binary(identifier) do
+  def get_device_by_identifier(org, identifier, preload_assoc \\ nil) when is_binary(identifier) do
     get_device_by_identifier_query(org, identifier, preload_assoc)
     |> Repo.one()
     |> case do
@@ -229,8 +227,7 @@ defmodule NervesHub.Devices do
   end
 
   @spec get_device_by_identifier!(Org.t(), String.t()) :: Device.t()
-  def get_device_by_identifier!(org, identifier, preload_assoc \\ nil)
-      when is_binary(identifier) do
+  def get_device_by_identifier!(org, identifier, preload_assoc \\ nil) when is_binary(identifier) do
     get_device_by_identifier_query(org, identifier, preload_assoc)
     |> Repo.one!()
   end
@@ -442,8 +439,7 @@ defmodule NervesHub.Devices do
     |> get_device_by_certificate()
   end
 
-  def get_device_by_certificate(%DeviceCertificate{device: %Device{} = device}),
-    do: {:ok, Repo.preload(device, :org)}
+  def get_device_by_certificate(%DeviceCertificate{device: %Device{} = device}), do: {:ok, Repo.preload(device, :org)}
 
   def get_device_by_certificate(_), do: {:error, :not_found}
 
@@ -522,8 +518,7 @@ defmodule NervesHub.Devices do
 
   @spec create_ca_certificate_from_x509(Org.t(), X509.Certificate.t(), binary() | nil) ::
           {:ok, CACertificate.t()} | {:error, Ecto.Changeset.t()}
-  def create_ca_certificate_from_x509(%Org{} = org, otp_cert, description \\ nil)
-      when is_tuple(otp_cert) do
+  def create_ca_certificate_from_x509(%Org{} = org, otp_cert, description \\ nil) when is_tuple(otp_cert) do
     {not_before, not_after} = Certificate.get_validity(otp_cert)
 
     params = %{
@@ -624,9 +619,7 @@ defmodule NervesHub.Devices do
     DeploymentGroup
     |> where([dep], dep.product_id == ^product_id)
     |> join(:inner, [dep], dev in Device, on: dev.deployment_id == dep.id)
-    |> join(:inner, [dep, dev], f in Firmware,
-      on: f.uuid == fragment("d1.firmware_metadata->>'uuid'")
-    )
+    |> join(:inner, [dep, dev], f in Firmware, on: f.uuid == fragment("d1.firmware_metadata->>'uuid'"))
     # Exclude the current firmware, we don't need to generate that one
     |> where([dep, dev, f], f.id != dep.firmware_id)
     |> select([dep, dev, f], {f.id, dep.firmware_id})
@@ -639,9 +632,7 @@ defmodule NervesHub.Devices do
     DeploymentGroup
     |> where([dep], dep.id == ^deployment_id)
     |> join(:inner, [dep], dev in Device, on: dev.deployment_id == dep.id)
-    |> join(:inner, [dep, dev], f in Firmware,
-      on: f.uuid == fragment("d1.firmware_metadata->>'uuid'")
-    )
+    |> join(:inner, [dep, dev], f in Firmware, on: f.uuid == fragment("d1.firmware_metadata->>'uuid'"))
     # Exclude the current firmware, we don't need to generate that one
     |> where([dep, dev, f], f.id != dep.firmware_id)
     |> select([dep, dev, f], {f.id, dep.firmware_id})
@@ -1225,8 +1216,7 @@ defmodule NervesHub.Devices do
           DeploymentGroup.t() | non_neg_integer()
         ) ::
           {:ok, %{updated: non_neg_integer(), ignored: non_neg_integer()}}
-  def move_many_to_deployment_group(device_ids, deployment_id)
-      when is_number(deployment_id) do
+  def move_many_to_deployment_group(device_ids, deployment_id) when is_number(deployment_id) do
     deployment_group =
       DeploymentGroup |> where(id: ^deployment_id) |> preload(:firmware) |> Repo.one()
 
@@ -1460,9 +1450,7 @@ defmodule NervesHub.Devices do
     Enum.all?(deployment_group_tags, fn tag -> tag in device_tags end)
   end
 
-  def maybe_copy_firmware_keys(%{firmware_metadata: %{uuid: uuid}, org_id: source}, %Org{
-        id: target
-      }) do
+  def maybe_copy_firmware_keys(%{firmware_metadata: %{uuid: uuid}, org_id: source}, %Org{id: target}) do
     existing_target_keys = from(k in OrgKey, where: [org_id: ^target], select: k.key)
 
     from(
@@ -1541,9 +1529,7 @@ defmodule NervesHub.Devices do
         # Device already has an inflight update, fetch it
         case Repo.get_by(InflightUpdate, device_id: device_id, deployment_id: deployment_group.id) do
           nil ->
-            Logger.error(
-              "An inflight update could not be created or found for the device (#{device_id})"
-            )
+            Logger.error("An inflight update could not be created or found for the device (#{device_id})")
 
             :error
 
@@ -1713,21 +1699,13 @@ defmodule NervesHub.Devices do
   """
   @spec get_delta_or_firmware_url(Device.t(), Firmware.t() | DeploymentGroup.t()) ::
           {:ok, String.t()} | {:error, :failure}
-  def get_delta_or_firmware_url(
-        %Device{} = device,
-        %DeploymentGroup{
-          delta_updatable: true,
-          firmware: target
-        }
-      ) do
+  def get_delta_or_firmware_url(%Device{} = device, %DeploymentGroup{delta_updatable: true, firmware: target}) do
     get_delta_or_firmware_url(device, target)
   end
 
   def get_delta_or_firmware_url(
         %{firmware_metadata: %{uuid: source_uuid}, product_id: product_id} = device,
-        %Firmware{
-          delta_updatable: true
-        } = target
+        %Firmware{delta_updatable: true} = target
       ) do
     # Get firmware delta URL if available but otherwise deliver full firmware
     with {:delta_updatable, true} <-
@@ -1789,10 +1767,7 @@ defmodule NervesHub.Devices do
     end
   end
 
-  def get_delta_or_firmware_url(
-        %Device{firmware_metadata: fw_meta} = device,
-        %DeploymentGroup{firmware: target} = dg
-      ) do
+  def get_delta_or_firmware_url(%Device{firmware_metadata: fw_meta} = device, %DeploymentGroup{firmware: target} = dg) do
     Logger.warning(
       "Delivering full firmware: deltas disabled for deployment group.",
       device_id: device.id,
@@ -1804,10 +1779,7 @@ defmodule NervesHub.Devices do
     Firmwares.get_firmware_url(target)
   end
 
-  def get_delta_or_firmware_url(
-        %Device{firmware_metadata: fw_meta} = device,
-        %Firmware{} = target
-      ) do
+  def get_delta_or_firmware_url(%Device{firmware_metadata: fw_meta} = device, %Firmware{} = target) do
     Logger.warning(
       "Delivering full firmware: deltas disabled for firmware.",
       device_id: device.id,