aprs.me/lib/aprsme_web/live/map_live/historical_loader.ex
Graham McIntire b86153cd27
Fix all mix credo --strict warnings (188 → 0)
- Replace apply/2 with direct fully-qualified calls in movement_test
- Fix assert_receive timeouts < 1000ms across 8 test files
- Move nested import statements to module-level scope
- Fix tests with no assertions and add missing doctest
- Replace weak type assertions with specific value checks
- Fix conditional assertions and length/1 expensive patterns
- Disable inappropriate Jump.CredoChecks.AvoidSocketAssignsInTest
- Fix tests not calling application code with credo:disable
- Add various credo:disable comments for legitimate patterns
2026-06-12 16:27:20 -05:00

488 lines
17 KiB
Elixir

defmodule AprsmeWeb.MapLive.HistoricalLoader do
@moduledoc """
Handles progressive loading of historical APRS packets.
"""
import Phoenix.Component, only: [assign: 3]
alias Aprsme.Packets
alias AprsmeWeb.Live.Shared.CoordinateUtils
alias AprsmeWeb.Live.Shared.PacketUtils, as: SharedPacketUtils
alias AprsmeWeb.MapLive.DataBuilder
alias AprsmeWeb.MapLive.DisplayManager
alias AprsmeWeb.MapLive.RfPath
alias Phoenix.LiveView
alias Phoenix.LiveView.Socket
require Logger
@max_historical_packets 5000
# Viewport-based loading limits by zoom level
@zoom_packet_limits %{
# Very low zoom (world/continent view) - show only major stations
(1..5) => 100,
# Low zoom (country/state view) - show moderate amount
(6..8) => 500,
# Medium zoom (city view) - show more detail
(9..11) => 1500,
# High zoom (neighborhood view) - show most packets
(12..14) => 3000,
# Very high zoom (street view) - show all available
(15..20) => 5000
}
@doc """
Start progressive historical loading based on zoom level.
"""
@spec start_progressive_historical_loading(Socket.t()) :: Socket.t()
def start_progressive_historical_loading(socket) do
Logger.debug("HistoricalLoader: Starting progressive historical loading")
Logger.debug(
"start_progressive_historical_loading called with zoom: #{socket.assigns.map_zoom}, bounds: #{inspect(socket.assigns.map_bounds)}"
)
# If we're already loading, just update the generation to cancel old requests
if socket.assigns[:historical_loading] do
Logger.debug("Already loading historical data, cancelling previous load")
end
# Increment generation to invalidate any in-flight loads
new_generation = socket.assigns.loading_generation + 1
# Cancel any pending batch tasks
socket = cancel_pending_loads(socket)
# Add a failsafe timeout to prevent infinite loading
Process.send_after(self(), {:historical_loading_timeout, new_generation}, 30_000)
# For high zoom levels, load everything in one batch for maximum speed
zoom = socket.assigns.map_zoom || 5
if zoom >= 10 do
# High zoom - load everything at once for maximum speed
Logger.debug("High zoom (#{zoom}), loading in single batch")
socket
|> assign(:loading_batch, 0)
|> assign(:total_batches, 1)
|> assign(:historical_loading, true)
|> assign(:loading_generation, new_generation)
|> assign(:historical_cursor, nil)
|> load_historical_batch(0, new_generation)
else
# Low zoom - use progressive loading to prevent overwhelming.
# Batches are keyset-paginated via :historical_cursor, so they MUST run
# sequentially — each batch's cursor comes from the tail of the previous
# batch. Subsequent batches are scheduled from process_loaded_packets/4
# (and the empty-batch branch) after the previous batch completes.
total_batches = calculate_batch_count_for_zoom(zoom)
socket
|> assign(:loading_batch, 0)
|> assign(:total_batches, total_batches)
|> assign(:historical_loading, true)
|> assign(:loading_generation, new_generation)
|> assign(:historical_cursor, nil)
|> load_historical_batch(0, new_generation)
end
end
@doc """
Load a specific historical batch.
"""
@spec load_historical_batch(Socket.t(), integer(), integer() | nil) :: Socket.t()
def load_historical_batch(socket, batch_offset, nil) do
# No generation provided — always load (backward compatibility)
do_load_historical_batch(socket, batch_offset)
end
def load_historical_batch(socket, batch_offset, generation) do
if generation == socket.assigns.loading_generation do
do_load_historical_batch(socket, batch_offset)
else
# Stale request, skip
socket
end
end
@doc """
Cancel pending batch load tasks.
"""
@spec cancel_pending_loads(Socket.t()) :: Socket.t()
def cancel_pending_loads(socket) do
# Cancel any pending batch load messages
Enum.each(socket.assigns.pending_batch_tasks, &Process.cancel_timer/1)
assign(socket, :pending_batch_tasks, [])
end
# Private functions
defp get_packet_limit_for_zoom(zoom) do
@zoom_packet_limits
|> Enum.find(fn {range, _} -> zoom in range end)
|> case do
{_, limit} -> limit
nil -> @max_historical_packets
end
end
defp do_load_historical_batch(%{assigns: %{map_bounds: nil}} = socket, _batch_offset), do: socket
defp do_load_historical_batch(%{assigns: %{map_bounds: bounds}} = socket, batch_offset) do
bounds_list = [
bounds.west,
bounds.south,
bounds.east,
bounds.north
]
# Calculate zoom-based batch size - higher zoom = smaller batches for faster response
zoom = socket.assigns.map_zoom || 5
batch_size = calculate_batch_size_for_zoom(zoom)
# Track cumulative packets loaded so far (batch_offset * batch_size is the
# pre-keyset approximation; we stop when we've fetched at least
# max_packets_for_zoom rows.)
packets_so_far = batch_offset * batch_size
# Get total packet limit based on zoom level
max_packets_for_zoom = get_packet_limit_for_zoom(zoom)
# Check if we've reached the zoom-based limit
if packets_so_far >= max_packets_for_zoom do
finish_historical_loading(socket)
else
# Adjust batch size if it would exceed the limit
adjusted_batch_size = min(batch_size, max_packets_for_zoom - packets_so_far)
query_params = %{
bounds: bounds_list,
limit: adjusted_batch_size,
cursor: socket.assigns[:historical_cursor],
zoom: zoom,
callsign: socket.assigns.tracked_callsign,
hours_back: socket.assigns.historical_hours || "1"
}
historical_packets = query_historical_packets(query_params, batch_offset)
if Enum.any?(historical_packets) do
# Process this batch and send to frontend
packet_data_list =
try do
# Filter out packets with invalid coordinates before processing
valid_packets = Enum.filter(historical_packets, &packet_has_valid_coordinates?/1)
if length(valid_packets) < length(historical_packets) do
Logger.debug(
"Filtered out #{length(historical_packets) - length(valid_packets)} packets with invalid coordinates"
)
end
DataBuilder.build_packet_data_list(valid_packets)
rescue
e ->
Logger.error("Error building packet data list: #{inspect(e)}")
[]
end
# If tracking a callsign and this is the first batch, also load RF path stations
socket = maybe_load_rf_path_stations(socket, batch_offset, historical_packets)
# Advance the cursor to the last packet returned (packets are ordered
# received_at DESC, id DESC, so the tail is the next page's boundary).
socket = advance_historical_cursor(socket, historical_packets)
# Signal "there may be more" when the batch was fully saturated; an
# under-full batch means we've drained the result set for this window.
has_more = length(historical_packets) >= adjusted_batch_size
process_loaded_packets(socket, historical_packets, packet_data_list, batch_offset, has_more)
else
# No packets found - handle this as a completed batch to prevent infinite loading
Logger.debug(
"No historical packets found for batch #{batch_offset}, hours_back: #{Map.get(socket.assigns, :historical_hours, "1")}, callsign: #{Map.get(socket.assigns, :tracked_callsign, "")}"
)
# Empty batch → we've drained the window; stop regardless of batch count.
socket =
socket
|> assign(:loading_batch, batch_offset + 1)
|> update_loading_status(true)
# Process any pending bounds update
handle_pending_bounds(socket, true)
end
end
end
# Extract the next keyset cursor from the last packet in the list.
defp advance_historical_cursor(socket, packets) do
case List.last(packets) do
nil ->
socket
last ->
received_at = get_cursor_field(last, :received_at)
id = get_cursor_field(last, :id)
if is_struct(received_at, DateTime) and is_binary(id) do
assign(socket, :historical_cursor, %{received_at: received_at, id: id})
else
socket
end
end
end
defp get_cursor_field(packet, key) when is_map(packet) do
Map.get(packet, key) || Map.get(packet, to_string(key))
end
defp query_historical_packets(query_params, batch_offset) do
packets_module = Application.get_env(:aprsme, :packets_module, Packets)
try do
if packets_module == Packets do
params = build_query_params(query_params)
Logger.debug("HistoricalLoader: Querying packets with params: #{inspect(params)}")
recent_packets = Packets.get_recent_packets_for_map(params)
Logger.debug("HistoricalLoader: Got #{length(recent_packets)} packets")
maybe_include_latest_packet(recent_packets, query_params.callsign, batch_offset)
else
# Fallback for testing
packets_module.get_recent_packets(%{
bounds: query_params.bounds,
limit: query_params.limit,
cursor: query_params.cursor
})
end
rescue
error ->
Logger.error("Error loading historical packets: #{inspect(error)}")
send(self(), {:show_error, "Failed to load historical data. Please try again."})
[]
end
end
defp build_query_params(query_params) do
historical_hours = SharedPacketUtils.parse_historical_hours(query_params.hours_back)
params = %{
bounds: query_params.bounds,
limit: query_params.limit,
cursor: query_params.cursor,
zoom: query_params.zoom,
hours_back: historical_hours
}
if query_params.callsign == "" do
params
else
Map.put(params, :callsign, query_params.callsign)
end
end
defp maybe_include_latest_packet(recent_packets, "", _batch_offset), do: recent_packets
defp maybe_include_latest_packet(recent_packets, callsign, 0) do
latest_packet = Packets.get_latest_packet_for_callsign(callsign)
if latest_packet && not Enum.any?(recent_packets, &(&1.id == latest_packet.id)) do
[latest_packet | recent_packets]
else
recent_packets
end
end
defp maybe_include_latest_packet(recent_packets, _callsign, _batch_offset), do: recent_packets
defp process_loaded_packets(socket, _historical_packets, [], _batch_offset, _has_more), do: socket
defp process_loaded_packets(socket, historical_packets, packet_data_list, batch_offset, has_more) do
# Check zoom level to decide between heat map and markers
total_batches = socket.assigns.total_batches || 4
# A batch is final when: we've hit the configured batch count, or the
# result set has been fully drained (has_more = false).
is_final_batch = batch_offset >= total_batches - 1 or not has_more
socket = handle_zoom_based_display(socket, historical_packets, packet_data_list, is_final_batch, batch_offset)
# Update progress for user feedback
socket = assign(socket, :loading_batch, batch_offset + 1)
# Mark loading as complete if this was the final batch
socket = update_loading_status(socket, is_final_batch)
# Schedule the next batch if there's more to load. Batches run sequentially
# because each inherits the :historical_cursor advanced by the previous one.
socket = maybe_schedule_next_batch(socket, batch_offset, is_final_batch)
# Process any pending bounds update if loading is complete
handle_pending_bounds(socket, is_final_batch)
end
defp maybe_schedule_next_batch(socket, _batch_offset, true), do: socket
defp maybe_schedule_next_batch(socket, batch_offset, false) do
next_batch = batch_offset + 1
generation = socket.assigns.loading_generation
timer_ref = Process.send_after(self(), {:load_historical_batch, next_batch, generation}, 50)
assign(socket, :pending_batch_tasks, [timer_ref | socket.assigns.pending_batch_tasks])
end
# Handle low zoom (heat map)
defp handle_zoom_based_display(
%{assigns: %{map_zoom: zoom}} = socket,
historical_packets,
_packet_data_list,
is_final_batch,
_batch_offset
)
when zoom <= 8 do
# For heat maps, store historical packets and update heat map when all batches are loaded
new_historical = add_packets_to_historical(socket.assigns.historical_packets, historical_packets)
# Apply memory limit
new_historical = apply_memory_limit(new_historical, @max_historical_packets)
socket = assign(socket, :historical_packets, new_historical)
# If this is the final batch, update the heat map
if is_final_batch do
send_heat_map_for_current_bounds(socket)
else
socket
end
end
# Handle high zoom (markers)
defp handle_zoom_based_display(socket, _historical_packets, packet_data_list, is_final_batch, batch_offset) do
Logger.debug(
"HistoricalLoader: Pushing #{length(packet_data_list)} packets to client, batch #{batch_offset}, is_final: #{is_final_batch}"
)
# Use LiveView's efficient push_event for incremental updates
LiveView.push_event(socket, "add_historical_packets_batch", %{
packets: packet_data_list,
batch: batch_offset,
is_final: is_final_batch
})
end
defp add_packets_to_historical(existing_historical, new_packets) do
Enum.reduce(new_packets, existing_historical, fn packet, acc ->
key = get_packet_key(packet)
Map.put(acc, key, packet)
end)
end
defp get_packet_key(%{id: id}), do: to_string(id)
defp get_packet_key(%{"id" => id}), do: to_string(id)
defp apply_memory_limit(packets, limit) when map_size(packets) > limit do
SharedPacketUtils.prune_oldest_packets(packets, limit)
end
defp apply_memory_limit(packets, _limit), do: packets
defp update_loading_status(socket, true), do: assign(socket, :historical_loading, false)
defp update_loading_status(socket, false), do: socket
defp handle_pending_bounds(%{assigns: %{pending_bounds: pending}} = socket, true) when not is_nil(pending) do
send(self(), {:process_pending_bounds})
socket
end
defp handle_pending_bounds(socket, _), do: socket
# Consolidated zoom-based loading parameters
@spec get_loading_params_for_zoom(integer()) :: {batch_size :: integer(), batch_count :: integer()}
# Very zoomed in - load everything at once, minimal batches
defp get_loading_params_for_zoom(zoom) when zoom >= 15, do: {500, 2}
# Moderately zoomed in
defp get_loading_params_for_zoom(zoom) when zoom >= 12, do: {500, 3}
# High zoom - still load a lot
defp get_loading_params_for_zoom(zoom) when zoom >= 10, do: {500, 4}
# Medium zoom
defp get_loading_params_for_zoom(zoom) when zoom >= 8, do: {100, 4}
# Zoomed out
defp get_loading_params_for_zoom(zoom) when zoom >= 5, do: {75, 5}
# Very zoomed out - smaller batches, more of them
defp get_loading_params_for_zoom(_), do: {50, 5}
@spec calculate_batch_size_for_zoom(integer()) :: 50 | 75 | 100 | 500
defp calculate_batch_size_for_zoom(zoom) do
{batch_size, _} = get_loading_params_for_zoom(zoom)
batch_size
end
@spec calculate_batch_count_for_zoom(integer()) :: 2 | 3 | 4 | 5
defp calculate_batch_count_for_zoom(zoom) do
{_, batch_count} = get_loading_params_for_zoom(zoom)
batch_count
end
# All packet data building functions have been moved to AprsmeWeb.MapLive.DataBuilder
# Placeholder for heat map function - this should be moved to DisplayManager
defp finish_historical_loading(socket) do
socket
|> assign(:historical_loading, false)
|> assign(:loading_batch, socket.assigns.total_batches)
|> then(fn s ->
if s.assigns.pending_bounds do
send(self(), {:process_pending_bounds})
end
s
end)
end
defp send_heat_map_for_current_bounds(socket) do
DisplayManager.send_heat_map_for_current_bounds(socket)
end
defp maybe_load_rf_path_stations(socket, batch_offset, historical_packets) do
if socket.assigns.tracked_callsign != "" and batch_offset == 0 do
load_rf_path_stations(socket, historical_packets)
else
socket
end
end
defp load_rf_path_stations(socket, packets) do
# Extract unique RF path stations from all packets
rf_path_stations =
packets
|> Enum.flat_map(fn packet ->
path = Map.get(packet, :path, "")
RfPath.parse_rf_path(path)
end)
|> Enum.uniq()
|> Enum.reject(&(&1 == ""))
# Limit to prevent too many queries
|> Enum.take(20)
_ =
if Enum.any?(rf_path_stations) do
# Schedule loading of RF path station packets
Process.send_after(self(), {:load_rf_path_station_packets, rf_path_stations}, 100)
end
socket
end
defp packet_has_valid_coordinates?(packet) do
{lat, lon, _} = CoordinateUtils.get_coordinates(packet)
# Range checks ensure finite values; infinity would be outside these ranges
is_number(lat) and is_number(lon) and
lat >= -90 and lat <= 90 and lon >= -180 and lon <= 180
end
end