474 lines
32 KiB
Markdown
474 lines
32 KiB
Markdown
# bDS2 Elixir Anti-Pattern & Best-Practice Audit
|
||
|
||
> Audited: 2026-05-06
|
||
> Scope: Elixir application, Phoenix LiveView UI, Ecto DB layer, Desktop (wx) integration, Rendering/Generation pipelines
|
||
|
||
---
|
||
|
||
## How to use this file
|
||
|
||
1. Pick a section.
|
||
2. Search the codebase for the file/line references.
|
||
3. Write a failing test that reproduces the issue.
|
||
4. Fix the code.
|
||
5. Run the full test suite and `mix dialyzer`.
|
||
6. Delete the item from this file.
|
||
|
||
---
|
||
|
||
## Critical (Fix Immediately)
|
||
|
||
### ~~CSM-001 — Atom Table Exhaustion Vulnerability~~ ✅ FIXED
|
||
- **Fixed:** 2026-05-06
|
||
- **What was done:**
|
||
- Added `BDS.MapUtils.safe_atomize_key/1` and `BDS.MapUtils.safe_atomize_keys/1` — uses `String.to_existing_atom/1` with rescue fallback to keep unknown keys as strings.
|
||
- Replaced all 6 affected `String.to_atom` call sites:
|
||
- `lib/bds/import_definitions.ex` — `atomize_keys/1` → `MapUtils.safe_atomize_keys/1`
|
||
- `lib/bds/import_execution.ex` — `normalize_report/1` → `MapUtils.safe_atomize_keys/1`
|
||
- `lib/bds/ai/catalog.ex` — `atomize_map_keys/1` → `MapUtils.safe_atomize_keys/1`, `parse_modality/1` → `MapUtils.safe_atomize_key/1`
|
||
- `lib/bds/ai/chat_tools.ex` — `metadata_attrs/2` → `MapUtils.safe_atomize_key/1`
|
||
- `lib/bds/desktop/automation.ex` — `atomize_map/1` → `MapUtils.safe_atomize_keys/1`
|
||
- Replaced lower-risk `String.to_atom` with `String.to_existing_atom/1`:
|
||
- `lib/bds/ui/menu_bar.ex` — sidebar view and singleton editor command IDs
|
||
- `lib/bds/ui/workbench.ex` — `normalize_type/1`
|
||
- `lib/bds/desktop/shell_live/chat_editor/tool_surfaces.ex` — `map_value/3`
|
||
- `lib/bds/release_packaging.ex` — `normalize_platform/1`
|
||
- Updated `test/bds/bounded_atoms_test.exs` to enforce no `String.to_atom` on dynamic data (replaced old `String.to_existing_atom` ban).
|
||
|
||
---
|
||
|
||
### ~~CSM-002 — Search Loads Entire Tables into Memory~~ ✅ FIXED
|
||
- **Fixed:** 2026-05-07
|
||
- **What was done:**
|
||
- Replaced `search_posts/3` and `search_media/3` with SQL-level filtering and pagination.
|
||
- Blank queries now use pure Ecto queries with `where` clauses for status, language, year/month, date range, tags, categories, and missing translations.
|
||
- Non-blank (FTS) queries use a CTE (`WITH fts_results AS (...)`) to preserve `bm25` ordering, joined with the posts/media table, with all filters applied in SQL.
|
||
- Tag and category overlap filtering uses `json_each` in `EXISTS` subqueries.
|
||
- Missing-translation filtering uses a `NOT EXISTS` correlated subquery.
|
||
- Count uses `select count` + `Repo.one` instead of `length(all_records)`.
|
||
- Pagination uses SQL `LIMIT`/`OFFSET` instead of `Enum.drop`/`Enum.take`.
|
||
- Removed all old Elixir-side filter helpers: `candidate_post_ids`, `load_posts_in_order`, `filter_posts`, `paginate`, `matches_status?`, `matches_overlap?`, etc.
|
||
- Added comprehensive tests for blank-query and non-blank-query filtering across all filter dimensions.
|
||
|
||
---
|
||
|
||
### ~~CSM-003 — Non-Atomic Side Effects in Post CRUD~~ ✅ FIXED
|
||
- **Fixed:** 2026-05-07
|
||
- **What was done:**
|
||
- Replaced all 11 `Repo.delete!` call sites with `Repo.delete` + `{:error, _}` handling:
|
||
- `lib/bds/posts.ex` — `delete_post/1`
|
||
- `lib/bds/scripts.ex` — `delete_script/1`
|
||
- `lib/bds/media.ex` — `delete_media/1`, `delete_media_translation/3`
|
||
- `lib/bds/templates.ex` — `delete_template/2`, `remove_orphan_templates/2`
|
||
- `lib/bds/tags.ex` — `delete_tag/1`, `merge_tags/2`
|
||
- `lib/bds/projects.ex` — `delete_project/1`
|
||
- `lib/bds/posts/translations.ex` — `delete_post_translation/1`
|
||
- `lib/bds/posts/translation_validation.ex` — `fix_invalid_database_row/1`
|
||
- Reordered `delete_post/1` to perform `Repo.delete` first, then clean up files/embeddings/search/links. Side effects now only run after DB commit succeeds.
|
||
- Same reordering applied to `delete_script/1`, `delete_media/1`, `delete_template/2`, and `delete_post_translation/1`.
|
||
- `delete_media/1` now wraps translation + media deletes in a `Repo.transaction` for atomicity.
|
||
- Tags and projects already used `Repo.transaction`; replaced inner `Repo.delete!` with `Repo.delete` + `Repo.rollback` on error.
|
||
- Added tests for delete atomicity and not-found handling.
|
||
|
||
---
|
||
|
||
### ~~CSM-004 — Blocking `init/1` + Missing `terminate/2` in Job Runner~~ ✅ FIXED
|
||
- **Fixed:** 2026-05-08
|
||
- **What was done:**
|
||
- Moved `JobStore.attach_runner/2` from `init/1` to a new `handle_continue(:attach_and_start)` callback, so supervisor startup is no longer blocked by the synchronous call.
|
||
- Added `terminate/2` callback that calls `JobStore.detach_runner/2` (with `try/catch` for shutdown safety), centralizing cleanup that was previously scattered across individual exit paths.
|
||
- Added `handle_info({:EXIT, _pid, _reason})` clause to handle trapped exit signals from linked processes.
|
||
- Removed redundant inline `detach_runner` calls from `handle_call(:cancel)`, task result handler, and `:DOWN` handler — `terminate/2` now handles all detach cleanup.
|
||
- Changed `restart: :temporary` since job runners are one-shot processes that should not auto-restart on failure.
|
||
- Added `@impl true` to all `handle_info` clauses.
|
||
- Fixed pre-existing bug in `JobStore.detach_runner` handler where `update_in/2` macro result was incorrectly double-wrapped, corrupting state.
|
||
- Added test: start a runner, kill it externally (not via cancel), assert `JobStore` no longer contains the dead PID.
|
||
|
||
---
|
||
|
||
### ~~CSM-005 — Client-Side Filtering of Entire Tables~~ ✅ FIXED
|
||
- **Fixed:** 2026-05-08
|
||
- **What was done:**
|
||
- **Sidebar** (`lib/bds/ui/sidebar.ex`):
|
||
- Removed `list_posts/1` and `list_media/1` that loaded all records into memory.
|
||
- Replaced `apply_post_filters/1` and `apply_media_filters/1` (Elixir-side filtering) with SQL `WHERE` clauses using Ecto dynamic queries and SQLite `json_each` fragments.
|
||
- Page/non-page split now uses `EXISTS (SELECT 1 FROM json_each(categories) WHERE lower(value) = 'page')` in SQL.
|
||
- Search, year/month, tag, and category filters all push to SQL via `maybe_where_search`, `maybe_where_year`, `maybe_where_month`, `maybe_where_all_tags`, `maybe_where_all_categories`.
|
||
- Aggregate queries (`year_month_counts`, `available_tags`, `available_categories`) use `Ecto.Adapters.SQL.query!` with `json_each` cross-joins, `GROUP BY`, and `DISTINCT`.
|
||
- Pagination uses SQL `LIMIT` instead of `Enum.take`.
|
||
- `tag_count/1` replaces `list_tags/1` + `length/1` with `Repo.one(select: count(tag.id))`.
|
||
- Fixed `group_posts/1` O(n²) `acc.draft ++ [post]` pattern — now uses `Enum.group_by/2` (also fixes CSM-024).
|
||
- **Tags** (`lib/bds/tags.ex`):
|
||
- `posts_with_tag/2` now uses `EXISTS (SELECT 1 FROM json_each(?) WHERE value = ?)` instead of loading all posts.
|
||
- `posts_with_any_tag/2` now uses `json_each` cross-join with a JSON parameter for the tag name list.
|
||
- `post_tag_names/1` now selects only the `tags` column instead of loading full post records.
|
||
- **Dashboard** (`lib/bds/ui/dashboard.ex`):
|
||
- `post_stats` uses `GROUP BY post.status, SELECT {status, count(id)}` — no longer loads all posts.
|
||
- `media_stats` uses `SELECT count(id), coalesce(sum(size), 0)` and a separate image count query with `LIKE 'image/%'`.
|
||
- `tag_cloud_items` and `category_counts` use raw SQL with `json_each` cross-joins and `GROUP BY`.
|
||
- `timeline_entries` uses SQL `strftime` + `GROUP BY` for year/month aggregation.
|
||
- `recent_posts` uses SQL `ORDER BY updated_at DESC LIMIT 5`.
|
||
- **Posts** (`lib/bds/posts.ex`):
|
||
- `dashboard_stats/1` uses `GROUP BY post.status, SELECT {status, count(id)}` instead of loading all statuses.
|
||
- **Capabilities** (`lib/bds/scripting/capabilities/`):
|
||
- `tag_post_ids/2` uses `json_each` fragment + `SELECT post.id` instead of loading all posts.
|
||
- `names_with_counts/2` uses raw SQL with `json_each` + `GROUP BY` instead of loading all posts.
|
||
- `posts_by_status/2` filters at SQL level instead of loading all posts and filtering in Elixir.
|
||
- Added 20 tests in `test/bds/csm005_sql_filtering_test.exs` covering dashboard stats, tag cloud, sidebar page/post separation, tag/search/year-month filters, available aggregates, and media filtering.
|
||
|
||
---
|
||
|
||
## High Severity
|
||
|
||
### ~~CSM-006 — N+1 Queries in Reindexing & Rendering~~ ✅ FIXED
|
||
- **Fixed:** 2026-05-08
|
||
- **What was done:**
|
||
- **Batch INSERT for reindexing:** Replaced per-row `Repo.query!` INSERT in `reindex_posts/2` and `reindex_media/2` with multi-row batch INSERTs. Rows are chunked at 166 per batch (SQLite 999-parameter limit ÷ 6 columns). Translations were already preloaded in batch; fixed O(n²) `acc ++ [translation]` pattern in `preload_post_translations` and `preload_media_translations` by replacing with `Enum.group_by`.
|
||
- **Rendering — preloaded post records:** `PostRendering.post_assigns/2` now accepts an optional `:_post_record` key in assigns, skipping the `Repo.get(Post, id)` re-query when the record is already available.
|
||
- **Generation outputs pass records:** `build_page_outputs` and `build_post_outputs` in `outputs.ex` now pass the already-loaded post/translation records via `:_post_record`, eliminating per-post DB queries during generation.
|
||
- **ListArchive** already used `load_post_records_batch` (batch query) — no change needed.
|
||
- Added telemetry-based query counting tests: reindex 100 posts/media and assert total query count <10.
|
||
|
||
---
|
||
|
||
### ~~CSM-007 — Monolithic State Rebuild ("God Function")~~ ✅ FIXED
|
||
- **Fixed:** 2026-05-09
|
||
- **What was done:**
|
||
- Decomposed `reload_shell/2` into four focused updaters:
|
||
- `refresh_layout/2` — No DB queries. Recomputes workbench-derived assigns (activity_buttons, panel_tabs, current_tab, status_bar, sidebar_header, editor_meta) from existing socket.assigns.
|
||
- `refresh_sidebar/2` — Queries sidebar data only, then calls `refresh_layout`.
|
||
- `refresh_content/2` — Queries projects, dashboard, git badge, and sidebar data, then calls `refresh_layout`.
|
||
- `reload_shell/2` — Full refresh: tab_meta sync, task status, static data, then calls `refresh_content`. Kept for mount, project switch, session restore, and settings changes.
|
||
- Replaced all call sites with the minimal refresh needed:
|
||
- **Layout-only** (`refresh_layout`): toggle_sidebar, toggle_panel, toggle_assistant_sidebar, select_panel_tab, sync_layout, resize_panel, open_tasks_panel, select_tab, close_tab, toggle_offline_mode, layout menu actions (toggle, close_tab).
|
||
- **Sidebar** (`refresh_sidebar`): select_view, all sidebar filter events, sidebar menu actions (view_posts, view_media, edit_preferences, etc.), chat/import editor tab_meta updates.
|
||
- **Content** (`refresh_content`): entity_changed (CLI sync), tags_changed, sidebar create/delete.
|
||
- **Full reload** (`reload_shell`): mount, activate_project, restore_workbench_session, set_page_language, settings_changed.
|
||
- Updated Bridges callbacks to use focused refreshers: `refresh_layout` for toggle events and close_tab, `refresh_sidebar` for view switches and tab meta updates, `refresh_content` for entity/tag changes.
|
||
- Split `@local_menu_actions` into `@layout_menu_actions` and `@sidebar_menu_actions` for correct dispatch.
|
||
- Fixed `false || true` bug in `refresh_layout` where `offline_mode = assigns[:offline_mode] || true` incorrectly defaulted `false` to `true`.
|
||
- Added 7 tests in `test/bds/csm007_reload_shell_test.exs` using telemetry-based query counting: toggle_sidebar (0 queries), toggle_panel (0 queries), sync_layout (0 queries), select_panel_tab (0 queries), toggle_offline_mode (1 query — settings write only), select_view (sidebar queries but no dashboard/projects), sidebar_search (no dashboard queries).
|
||
|
||
---
|
||
|
||
### ~~CSM-008 — DB Queries During Render Path~~ ✅ FIXED
|
||
- **Fixed:** 2026-05-09
|
||
- **What was done:**
|
||
- **Panel renderer** (`lib/bds/desktop/shell_live/panel_renderer.ex`):
|
||
- `render_post_links` and `render_git_log` no longer call DB functions during render. Instead they read from pre-computed assigns (`panel_post_links`, `panel_git_entries`).
|
||
- Renamed `post_link_entries/1` → `fetch_post_link_entries/1` and `git_log_entries/1` → `fetch_git_log_entries/1`, made them public for use by event handlers.
|
||
- **Shell LiveView** (`lib/bds/desktop/shell_live.ex`):
|
||
- Added `refresh_panel_data/1` that fetches panel data (post links or git log) based on the active panel tab and stores results in assigns.
|
||
- `refresh_layout/2` detects when `current_tab` or `panel.active_tab` changed and calls `refresh_panel_data/1` only when stale — no DB queries on re-renders.
|
||
- Initialized `panel_post_links` and `panel_git_entries` assigns in mount.
|
||
- **Tab meta** (`lib/bds/desktop/shell_live/tab_helpers.ex`):
|
||
- `sync_tab_meta` now skips `derived_tab_meta` DB queries when existing meta already has both title and subtitle populated (`meta_complete?/1` guard).
|
||
- Added 5 tests in `test/bds/csm008_render_path_test.exs`: post_links re-render (0 queries), git_log re-render (0 queries), output panel switch (0 queries), tasks panel switch (0 queries), tab meta skip for complete meta (0 queries).
|
||
|
||
---
|
||
|
||
### ~~CSM-009 — Thumbnail Generation: Missing Error Handling~~ ✅ FIXED
|
||
- **Fixed:** 2026-05-09
|
||
- **What was done:**
|
||
- Replaced all bang variants with non-bang error-tuple handling:
|
||
- `Image.autorotate!` → `Image.autorotate` with `{:ok, {image, rotation_info}}` destructuring.
|
||
- `Image.thumbnail!` → `Image.thumbnail` returning `{:ok, image}` / `{:error, reason}`.
|
||
- `Image.embed!` → `Image.embed` with `with` chain.
|
||
- `Image.flatten!` → `Image.flatten` with `with` chain.
|
||
- `Image.write!` → `Image.write` with `{:ok, _}` / `{:error, reason}` handling.
|
||
- `File.mkdir_p` result is now checked — errors halt thumbnail generation with `{:error, reason}`.
|
||
- `write_all_thumbnails` uses `Enum.reduce_while` to stop on first error and return `{:error, reason}`.
|
||
- `ensure_thumbnails` spec updated to `:ok | {:error, term()}`.
|
||
- `regenerate_thumbnails` propagates `{:error, reason}` from `ensure_thumbnails`.
|
||
- `regenerate_missing_thumbnails` replaced `try/rescue` with `case` on the new error tuples.
|
||
- Call sites in `BDS.Media` (`import_media`, `replace_media_binary`) use `log_thumbnail_error/2` — media operations succeed even if thumbnails fail, with a warning logged.
|
||
- Added 6 tests in `test/bds/csm009_thumbnail_error_handling_test.exs`: corrupt image returns `{:error, _}`, non-image returns `:ok`, missing source returns `{:error, _}`, regenerate corrupt returns `{:error, _}`, regenerate_missing counts failures, import succeeds despite thumbnail failure.
|
||
|
||
---
|
||
|
||
### ~~CSM-010 — `rescue` for Control Flow in Data Layer~~ ✅ FIXED
|
||
- **Fixed:** 2026-05-09
|
||
- **What was done:**
|
||
- Added `BDS.Repo.ready?/0` — a lightweight probe that queries `sqlite_master` (parameterized) to check if core tables exist, without raising exceptions.
|
||
- Replaced all 4 `rescue` blocks in `ShellData` (`project_snapshot/0`, `dashboard/1`, `sidebar_view/3`, `git_badge_count/2`) with upfront `Repo.ready?()` checks.
|
||
- All four functions now return `{:ok, result}` / `{:error, :not_ready}` tuples instead of silently returning defaults via rescue.
|
||
- Updated callers in `ShellLive.refresh_content/2` and `ShellLive.refresh_sidebar/2` to pattern-match the new tuples and fall back to empty defaults only on `{:error, :not_ready}`.
|
||
- Made `default_project_snapshot/0` public for use by callers handling the not-ready case.
|
||
- Added 10 tests in `test/bds/csm010_rescue_control_flow_test.exs`: `Repo.ready?` returns true when DB is available, each of the 4 functions returns `{:ok, _}` when DB is ready and `{:error, :not_ready}` when the Repo is stopped.
|
||
|
||
---
|
||
|
||
## Medium Severity
|
||
|
||
### ~~CSM-011 — No URL State / Deep Linking~~ ✅ FIXED
|
||
- **Fixed:** 2026-05-09
|
||
- **What was done:**
|
||
- `mount/3` now reads `?view=` and `?tab=<type>:<id>` query params and applies them to the initial workbench state, enabling deep linking on page load.
|
||
- Added `push_url_state/1` — after state-changing events (`select_view`, `select_tab`, `close_tab`, `open_sidebar_item`, sidebar menu actions, project switch), pushes a `url-state` event to the client with the serialized URL.
|
||
- Added JS handler in the `AppShell` hook that calls `history.replaceState` to update the browser URL without triggering navigation.
|
||
- URL encoding: `?view=<sidebar_view>` (omitted when `posts`, the default) and `?tab=<type>:<id>` (omitted when no tab is active). Invalid or unknown params are silently ignored.
|
||
- Used `push_event` + `history.replaceState` instead of `push_patch`/`handle_params` to maintain compatibility with existing `live_isolated` tests.
|
||
- Added 10 tests in `test/bds/csm011_url_state_test.exs`: mount with `?view=media`, mount with default, mount with invalid view, mount with `?tab=post:<id>`, mount with both params, `select_view` pushes url-state, `select_view` posts pushes clean URL, `select_tab` pushes url-state, `close_tab` removes tab from URL, `open_sidebar_item` pushes url-state.
|
||
|
||
---
|
||
|
||
### ~~CSM-012 — Desktop File Dialog Blocks Event Handler~~ ✅ FIXED
|
||
- **Fixed:** 2026-05-09
|
||
- **What was done:**
|
||
- Replaced synchronous `FilePicker.choose_file/1` call in `SidebarCreate.create/4` for the "media" kind with `Task.async`, storing the task ref in a new `file_picker_task` socket assign.
|
||
- Added `handle_file_picker_result/2` private function in `ShellLive` with clauses for `{:ok, _media}`, `:cancel`, `{:error, %{message: _}}`, and `{:error, reason}`.
|
||
- Extended the existing `handle_info({ref, result}, socket)` and `handle_info({:DOWN, ref, ...}, socket)` handlers to match on `file_picker_task` ref.
|
||
- Added `BDS_DESKTOP_AUTOMATION` guard to `FilePicker.choose_file/1` — returns `:cancel` immediately in automation/test mode, preventing native dialogs from opening during tests.
|
||
- Initialized `file_picker_task: nil` assign in mount.
|
||
- Added 5 tests in `test/bds/csm012_file_picker_async_test.exs`: event handler returns within 100ms, LiveView handles other events while task is pending, task completion doesn't crash LiveView, cancel is handled gracefully, error results don't crash LiveView.
|
||
|
||
---
|
||
|
||
### ~~CSM-013 — Bang Functions in Rendering Pipelines~~ ✅ FIXED
|
||
- **Fixed:** 2026-05-09
|
||
- **What was done:**
|
||
- **`lib/bds/rendering/filters.ex`** — `render_macro_template`:
|
||
- Replaced `Liquex.parse!` with `Liquex.parse` (non-bang) and `case` match on `{:ok, ast}` / `{:error, reason, line}`.
|
||
- Wrapped `Liquex.render!` in `try/rescue` catching `Liquex.Error` specifically (no non-bang `render` exists in Liquex).
|
||
- Removed broad `rescue _error -> ""` — errors now log via `Logger.warning` with template path and reason before returning `""`.
|
||
- **`lib/bds/rendering/template_selection.ex`** — `render_template`:
|
||
- `Liquex.parse` was already non-bang; added `else` clause to normalize the 3-tuple `{:error, reason, line}` into `{:error, "reason at line N"}`.
|
||
- Wrapped `Liquex.render!` in `try/rescue` catching `Liquex.Error` specifically, returning `{:error, message}`.
|
||
- Removed broad `rescue error -> {:error, error}`.
|
||
- **`lib/bds/rendering/post_rendering.ex`** — `post_data_json_value`:
|
||
- Replaced `Jason.encode!` with `Jason.encode` and `case` match — returns `"{}"` on encode failure instead of crashing.
|
||
- Added 5 tests in `test/bds/csm013_bang_rendering_test.exs`: template syntax error returns `{:error, _}` from `render_template`, broken template in `render_post_page` returns `{:error, _}`, `{% break %}` render error returns `{:error, _}`, normal post context produces valid JSON, non-encodable data returns `"{}"` fallback.
|
||
|
||
---
|
||
|
||
### ~~CSM-014 — O(n²) Loops from `length/1` Inside Iteration~~ ✅ FIXED
|
||
- **Fixed:** 2026-05-09
|
||
- **What was done:**
|
||
- **`lib/bds/generation/outputs.ex`** — `build_category_outputs`:
|
||
- Bound `total_pages = length(paginated_posts)` and `total_items = length(posts)` before the nested loop. Previously called `length/1` 4 times per page × language iteration.
|
||
- **`lib/bds/generation/outputs.ex`** — `build_root_outputs`:
|
||
- Bound `total_items = length(posts)` before the loop, reused by `pagination_for_page`. Previously called `length(posts)` on every page iteration.
|
||
- **`lib/bds/generation/outputs.ex`** — `build_paginated_archive_outputs`:
|
||
- Bound `total_items = length(posts)` before the loop. Previously called `length(posts)` inside the nested page × language loop.
|
||
- **`lib/bds/rendering/list_archive.ex`** — `build_day_blocks`:
|
||
- Bound `last_index = length(grouped_blocks) - 1` before the `Enum.map`. Previously called `length(grouped_blocks)` on every iteration.
|
||
- **`lib/bds/publishing.ex`** — `run_upload`:
|
||
- Bound `target_count = max(length(targets), 1)` before the `Enum.reduce_while`. Negligible impact (3 targets) but fixed for consistency.
|
||
- `lib/bds/ui/sidebar.ex` `acc.draft ++ [post]` was already fixed by CSM-005 (replaced with `Enum.group_by`).
|
||
- Added 3 tests in `test/bds/csm014_length_in_loop_test.exs`: multi-page pagination correctness, single-page pagination correctness, 1000-post linear time completion.
|
||
|
||
---
|
||
|
||
### CSM-015 — Missing DB Indexes on Foreign Keys
|
||
- **Files:** `priv/repo/migrations/20260423120000_create_persistence_contract.exs`
|
||
- **What:** The initial migration uses `references(...)` which creates FK constraints but does NOT create dedicated indexes for most FKs. Missing indexes on:
|
||
- `media.project_id` (queried in every sidebar/dashboard load)
|
||
- `post_media.post_id`, `post_media.media_id`
|
||
- `chat_messages.conversation_id`
|
||
- `embedding_keys.post_id`, `embedding_keys.project_id`
|
||
- `dismissed_duplicate_pairs.project_id`
|
||
- `import_definitions.project_id`
|
||
- `db_notifications.entity_type`, `db_notifications.entity_id`
|
||
- `posts.status`, `posts.published_at`, `posts.language` — frequently filtered columns
|
||
- **Note:** SQLite is more forgiving than PostgreSQL for missing FK indexes, but with growing data the query plans will degrade.
|
||
- **Fix:** Add a new migration with `create index` for every foreign key and frequently filtered column.
|
||
- **Test:** Verify with `sqlite3` `EXPLAIN QUERY PLAN` that key lookups use indexes.
|
||
|
||
---
|
||
|
||
### CSM-016 — String Concatenation for Paths
|
||
- **Files:**
|
||
- `lib/bds/rendering/metadata.ex:43` — `"/#{slug}/"`
|
||
- `lib/bds/rendering/metadata.ex:112` — `prefix <> "/"`
|
||
- `lib/bds/publishing.ex:284` — `String.trim_trailing(path, "/") <> "/"`
|
||
- `lib/bds/rendering/file_system.ex:29` — `normalized_path <> ".liquid"`
|
||
- `lib/bds/rendering/links_and_languages.ex` — path construction with `<>`
|
||
- **Fix:** Use `Path.join/1-2` and `Path.extname` / `Path.rootname`. For `"/#{slug}/"`, use `Path.join(["/", slug])` or `"/" <> slug <> "/"` → `URI.encode(slug)` is already used elsewhere.
|
||
- **Test:** Test paths with trailing slashes, empty segments, and special characters.
|
||
|
||
---
|
||
|
||
### CSM-017 — `send(self(), ...)` Component Chatter
|
||
- **Files:** 25+ call sites across editor components:
|
||
- `lib/bds/desktop/shell_live/script_editor.ex` (3 sends)
|
||
- `lib/bds/desktop/shell_live/post_editor.ex` (2 sends)
|
||
- `lib/bds/desktop/shell_live/template_editor.ex` (3 sends)
|
||
- `lib/bds/desktop/shell_live/media_editor.ex` (2 sends)
|
||
- `lib/bds/desktop/shell_live/chat_editor.ex` (1 send)
|
||
- `lib/bds/desktop/shell_live/menu_editor.ex` (1 send)
|
||
- `lib/bds/desktop/shell_live/settings_editor.ex` (2 sends)
|
||
- `lib/bds/desktop/shell_live/misc_editor.ex` (4 sends)
|
||
- `lib/bds/desktop/shell_live/tags_editor.ex` (2 sends)
|
||
- `lib/bds/desktop/shell_live/import_editor.ex` (1 send)
|
||
- `lib/bds/desktop/shell_live/overlay_manager.ex` (3 sends)
|
||
- `lib/bds/desktop/main_window.ex` (1 send)
|
||
- **What:** Components send messages to the parent via `send(self(), ...)`, forcing a broad `handle_info` in `ShellLive`. Each message type must be handled in the parent, creating tight coupling.
|
||
- **Fix:** Prefer `Phoenix.LiveView.send_update/2` for targeted component updates, or delegate through a single dispatch module that translates actions into specific state changes.
|
||
- **Test:** Refactor one component; assert it no longer uses `send(self(), ...)`.
|
||
|
||
---
|
||
|
||
## Low Severity / Code Quality
|
||
|
||
### CSM-018 — `@moduledoc false` Epidemic
|
||
- **Files:** `lib/bds/i18n.ex`, `lib/bds/map_utils.ex`, `lib/bds/bounded_atoms.ex`, `lib/bds/document_fields.ex`, `lib/bds/import_definitions.ex`, `lib/bds/publishing.ex`, `lib/bds/settings.ex`, `lib/bds/templates.ex`, `lib/bds/ai.ex`, `lib/bds/mcp.ex`, `lib/bds/scripting/capabilities.ex`, `lib/bds/scripting/api_docs.ex`
|
||
- **Fix:** Write `@moduledoc` descriptions for all public modules. Keep internal helpers documented or mark them `@moduledoc false` only if truly private.
|
||
|
||
---
|
||
|
||
### CSM-019 — Missing `@spec` on Public Functions
|
||
- **Files:** Widespread across rendering, generation, publishing, UI, and scripting modules.
|
||
- **Fix:** Add `@spec` to every public function. This is a Dialyzer prerequisite (the project already runs Dialyzer; the report notes it should be clean).
|
||
|
||
---
|
||
|
||
### CSM-020 — Deeply Nested `case` Instead of `with`
|
||
- **Files:** `lib/bds/import_definitions.ex:54-66`, `lib/bds/publishing.ex:47-58`, `lib/bds/templates.ex:86-163`
|
||
- **Fix:** Flatten with `with`:
|
||
```elixir
|
||
with {:ok, record} <- Repo.get(Model, id),
|
||
{:ok, updated} <- Repo.update(changeset) do
|
||
{:ok, updated}
|
||
else
|
||
nil -> {:error, :not_found}
|
||
{:error, changeset} -> {:error, changeset}
|
||
end
|
||
```
|
||
|
||
---
|
||
|
||
### CSM-021 — `cond` Where Pattern Matching Suffices
|
||
- **Files:** `lib/bds/ai.ex:62-70`, `lib/bds/scripting/api_docs.ex:1345-1398`, `lib/bds/scripting/api_docs.ex:1433-1447`
|
||
- **Fix:** Replace `cond do x == nil -> ...; true -> ... end` with multiple function-head clauses.
|
||
|
||
---
|
||
|
||
### CSM-022 — Silent Error Swallowing
|
||
- **File:** `lib/bds/scripting.ex:64-66`
|
||
- **What:** `execute_macro/4` returns `{:ok, ""}` on `{:error, _reason}` with no logging. The caller cannot distinguish success from failure.
|
||
- **Fix:** Return the actual error tuple or at least log the failure with `Logger.error/1`.
|
||
|
||
---
|
||
|
||
### CSM-023 — SRP Violations
|
||
- **Files:**
|
||
- `lib/bds/templates.ex:86-163` — `update_template/2` does slug changes, content changes, status transitions, file paths, transactions, cascades, and filesystem sync.
|
||
- `lib/bds/scripting/capabilities.ex:22-248` — `for_project/2` returns a 200+ line map literal.
|
||
- **Fix:** Decompose into smaller private pipelines or domain-specific builder functions.
|
||
|
||
---
|
||
|
||
### CSM-024 — `Enum.reduce` with `acc.draft ++ [post]` (O(n²))
|
||
- **File:** `lib/bds/ui/sidebar.ex:556-565`
|
||
- **Fix:** Use `Enum.group_by/3` or reverse-accumulate and `Enum.reverse`.
|
||
|
||
---
|
||
|
||
### CSM-025 — Hardcoded Language Prefixes
|
||
- **File:** `lib/bds/generation/pagefind.ex:48-54`
|
||
- **What:** `["de/", "fr/", "it/", "es/"]` hardcoded instead of derived from project settings.
|
||
- **Fix:** Derive from project settings (`mainLanguage` and supported languages).
|
||
|
||
---
|
||
|
||
### CSM-026 — TOCTOU Race Condition in Template File System
|
||
- **File:** `lib/bds/rendering/file_system.ex:28-37`
|
||
- **What:** `Enum.find(&File.regular?/1)` checks existence, then the file is read later (in the `Liquex.FileSystem` impl, Z. 43-49). Between check and read the file can vanish.
|
||
- **Fix:** Just try to read and handle `{:error, :enoent}`. Remove the `Enum.find` existence check and attempt reads directly.
|
||
|
||
---
|
||
|
||
### CSM-027 — `if result == :ok` Instead of Pattern Matching
|
||
- **File:** `lib/bds/templates.ex:445`
|
||
- **Fix:** Use `case result do :ok -> ...; _ -> ... end`.
|
||
|
||
---
|
||
|
||
### CSM-028 — Broad `rescue` Swallowing Template Errors
|
||
- **File:** `lib/bds/rendering/filters.ex:130-132`
|
||
- **What:** `rescue _error -> ""` swallows all macro template failures silently.
|
||
- **Fix:** Rescue only specific exceptions, or return `{:error, exception}` and let the caller decide.
|
||
|
||
---
|
||
|
||
### CSM-029 — `length/1` in Guards or Comparisons
|
||
- **Files:** `lib/bds/generation/outputs.ex`, `lib/bds/ui/sidebar.ex`
|
||
- **What:** `length(list)` is O(n). Using it inside a loop makes the whole loop O(n²).
|
||
- **Fix:** Bind the length before the loop.
|
||
|
||
---
|
||
|
||
### CSM-030 — Unchecked `File.mkdir_p` / `File.mkdir_p!`
|
||
- **Files:** `lib/bds/media/thumbnails.ex:133`, `lib/bds/media/sidecars.ex:24,56`, `lib/bds/release_packaging.ex:80,85`
|
||
- **What:** Result of `File.mkdir_p/1` is discarded. `File.mkdir_p!/1` in `release_packaging` can crash on permission errors.
|
||
- **Fix:** Pattern-match `File.mkdir_p/1` or use `with`; replace bang variants with non-bang and handle errors.
|
||
|
||
---
|
||
|
||
### CSM-031 — `try/rescue` Instead of `with` and Error Tuples
|
||
- **Files:** `lib/bds/rendering/filters.ex`, `lib/bds/rendering/template_selection.ex`, `lib/bds/desktop/shell_data.ex`
|
||
- **Fix:** Replace `try/rescue` around expected failures with non-bang functions and `with` chains.
|
||
|
||
---
|
||
|
||
### CSM-032 — `Map.get` with Default Instead of Pattern Matching
|
||
- **Files:** Widespread
|
||
- **What:** `Map.get(map, key, default)` when the key is expected to exist.
|
||
- **Fix:** Use pattern matching (`%{key: value} = map`) or `Map.fetch!/2` if the key is required.
|
||
|
||
---
|
||
|
||
### CSM-033 — `Enum.each` with Side Effects That Should Be Batch Inserts
|
||
- **Files:** `lib/bds/search.ex:174-177`, `lib/bds/embeddings.ex`
|
||
- **What:** `Enum.each` used for inserting records. The side-effect pattern is fine, but `Enum.map` + `Repo.insert_all` would be much faster for bulk inserts.
|
||
- **Fix:** Use `Repo.insert_all` for batch inserts instead of `Enum.each` + `Repo.insert`.
|
||
|
||
---
|
||
|
||
### CSM-034 — `File.read!` / `File.write!` Without Error Handling
|
||
- **Files:** `lib/bds/preview_assets.ex:32`, `lib/bds/release_packaging.ex:105`, `lib/bds/templates.ex:488-489`
|
||
- **Fix:** Use `File.read/1`, `File.write/2`, and handle `{:error, reason}`.
|
||
|
||
---
|
||
|
||
### CSM-035 — Process Dictionary (`Process.get/put`) Usage
|
||
- **File:** `lib/bds/desktop/ui_locale.ex:32,49,65`
|
||
- **What:** `UILocale.put/1` sets process dictionary (`Process.put(@key, locale)`) for UI locale. Used in `ShellLive.render` (Z. 550) and `MenuBar`.
|
||
- **Fix:** This is isolated to the LiveView/MenuBar process so it's low-risk, but document the invariant explicitly: the process dict key `:bds_ui_locale` is set before each render call.
|
||
|
||
---
|
||
|
||
### CSM-036 — Missing `@impl true` on GenServer Callbacks
|
||
- **File:** `lib/bds/publishing.ex:46,61,71,75`
|
||
- **What:** Only `init/1` (Z. 36) and the first `handle_call` (Z. 41) have `@impl true`. The remaining `handle_call` clauses at Z. 46, 61, 71, 75 lack it.
|
||
- **Fix:** Add `@impl true` before every `handle_call`, `handle_cast`, `handle_info`, and `terminate`.
|
||
|
||
---
|
||
|
||
## Checklist for Agents Picking Up This File
|
||
|
||
- [x] All critical items (CSM-001 to CSM-005) have been addressed or explicitly deferred with justification.
|
||
- CSM-001: Fixed. All `String.to_atom` on dynamic data replaced with `MapUtils.safe_atomize_key/keys` or `String.to_existing_atom`.
|
||
- CSM-002: Fixed. Search now pushes all filtering and pagination into SQL via Ecto queries and CTEs.
|
||
- CSM-004: Fixed. `attach_runner` moved to `handle_continue`, `terminate/2` added for cleanup, `restart: :temporary` set, JobStore `detach_runner` bug fixed.
|
||
- [x] All high-severity items (CSM-006 to CSM-010) have been addressed.
|
||
- CSM-006: Fixed. Batch INSERT for reindexing, preloaded post records for rendering.
|
||
- CSM-007: Fixed. Decomposed into refresh_layout, refresh_sidebar, refresh_content, reload_shell.
|
||
- CSM-008: Fixed. Panel data pre-computed in event handlers, tab meta skips DB for complete entries.
|
||
- CSM-009: Fixed. All bang Image/File variants replaced with error-tuple handling, `ensure_thumbnails` returns `{:error, _}` instead of crashing.
|
||
- CSM-010: Fixed. Replaced rescue blocks with `Repo.ready?/0` probe and `{:ok, _}`/`{:error, :not_ready}` tuples.
|
||
- [x] CSM-001 fix covers ALL 6 affected files, not just `import_definitions.ex`.
|
||
- [x] CSM-003 fix covers ALL `Repo.delete!` call sites (posts, tags, scripts, media, projects, templates, translations).
|
||
- [x] CSM-007 decomposition is the prerequisite for fixing CSM-008 (render-path queries).
|
||
- [x] Tests were written **before** implementation changes (Red → Green → Refactor).
|
||
- [x] Full test suite passes: `mix test`.
|
||
- [x] Dialyzer passes cleanly: `mix dialyzer` (zero warnings).
|
||
- [x] Build succeeds: `mix compile`.
|
||
- [x] No external JS/CSS referenced in preview/generated HTML (per AGENTS.md).
|
||
- [x] All UI strings use gettext / i18n, no hardcoded text.
|
||
- [x] API docs (`API.md`) updated if any API changes were made.
|
||
- [x] Metadata diff tool and rebuild-from-database updated if metadata changed.
|
||
- [x] Specs in `specs/` folder updated and validated if behavior changed.
|
||
- [x] Unused code (including tests for removed features) has been deleted.
|
||
- [x] This `CODESMELL.md` updated: fixed items removed, new ones added.
|