Gandalf/sofarr
Public Access
0
0
Fork 0
Code Issues 1 Pull Requests Actions 1 Packages Projects Releases 59 Wiki Activity

BUG: Frontend build/packaging fragility (custom Vite output + incomplete Dockerfile copy) #66

New Issue
Closed
opened 2026-05-28 11:40:28 +01:00 by Gandalf · 0 comments
Gandalf commented 2026-05-28 11:40:28 +01:00
Owner
Copy Link
Copy Source

Description:

The frontend build and Docker packaging process (client/vite.config.js + Dockerfile) is fragile and has already caused non-functional UI in v1.7.30. While partially improved in v1.7.31, it remains at risk of regression and does not follow standard practices.

Detailed Investigation Findings (release/1.7.31)

1. Non-Standard Vite Configuration

  • build.outDir: '../public' (instead of standard dist/).
  • Custom rollupOptions.input: { main: './src/main.js' } + forced entryFileNames: 'app.js'.
  • client/index.html still references /src/main.jsx (non-existent file) — the build process must rewrite it, but this is brittle.
  • emptyOutDir: false + committed build artifacts in public/ (index.html, app.js, style.css) create version control and reproducibility problems.

2. Dockerfile Packaging Issues (Improved but Still Fragile)

  • Pre-1.7.31: Only copied /app/public/app.js from client-build stage → missing processed index.html, CSS, and other assets.
  • v1.7.31 fix: Added full public/ copy, but still relies on the custom Vite output being perfect.
  • No clean separation between source client/ and build output.

3. Runtime Serving (server/app.js)

  • Manual index.html patching for CSP nonce + express.static works, but depends on the build producing a correct index.html with the right <script src="/app.js">.

Impact:

  • UI was completely broken in v1.7.30.
  • Any future change to Vite config or build process can silently break the Docker image.
  • Makes local development vs production parity difficult.

Proposed Solution / Fix Plan:

  1. Switch to standard Vite setup: output to dist/, let Vite handle index.html processing normally.
  2. Update Dockerfile:
    • Build stage → COPY --from=client-build /app/dist ./public
    • Remove committed build artifacts from public/.
  3. Update package.json scripts to support npm run build at root level.
  4. Add a CI step that builds the Docker image and smoke-tests the UI (curl + check for expected assets / no console errors).

Cross-Dependencies:

  • A broken frontend affects display of all features (webhooks, queue, Ombi, download clients, SSE). This ticket is a prerequisite for users to actually see fixes from #61 (season packs) and the webhook reliability ticket.

Suggested Labels:
Kind/Bug, Priority: Medium, Area/Frontend, Area/Docker, Compat/Non-Breaking

Affected Versions: v1.7.21 – v1.7.31 (major breakage in 1.7.30).

**Description:** The frontend build and Docker packaging process (`client/vite.config.js` + `Dockerfile`) is fragile and has already caused non-functional UI in v1.7.30. While partially improved in v1.7.31, it remains at risk of regression and does not follow standard practices. ### Detailed Investigation Findings (release/1.7.31) **1. Non-Standard Vite Configuration** - `build.outDir: '../public'` (instead of standard `dist/`). - Custom `rollupOptions.input: { main: './src/main.js' }` + forced `entryFileNames: 'app.js'`. - `client/index.html` still references `/src/main.jsx` (non-existent file) — the build process must rewrite it, but this is brittle. - `emptyOutDir: false` + committed build artifacts in `public/` (index.html, app.js, style.css) create version control and reproducibility problems. **2. Dockerfile Packaging Issues (Improved but Still Fragile)** - Pre-1.7.31: Only copied `/app/public/app.js` from client-build stage → missing processed `index.html`, CSS, and other assets. - v1.7.31 fix: Added full `public/` copy, but still relies on the custom Vite output being perfect. - No clean separation between source `client/` and build output. **3. Runtime Serving (`server/app.js`)** - Manual `index.html` patching for CSP nonce + `express.static` works, but depends on the build producing a correct `index.html` with the right `<script src="/app.js">`. **Impact:** - UI was completely broken in v1.7.30. - Any future change to Vite config or build process can silently break the Docker image. - Makes local development vs production parity difficult. **Proposed Solution / Fix Plan:** 1. Switch to standard Vite setup: output to `dist/`, let Vite handle `index.html` processing normally. 2. Update Dockerfile: - Build stage → `COPY --from=client-build /app/dist ./public` - Remove committed build artifacts from `public/`. 3. Update `package.json` scripts to support `npm run build` at root level. 4. Add a CI step that builds the Docker image and smoke-tests the UI (curl + check for expected assets / no console errors). **Cross-Dependencies:** - A broken frontend affects display of **all** features (webhooks, queue, Ombi, download clients, SSE). This ticket is a prerequisite for users to actually see fixes from #61 (season packs) and the webhook reliability ticket. **Suggested Labels:** Kind/Bug, Priority: Medium, Area/Frontend, Area/Docker, Compat/Non-Breaking **Affected Versions:** v1.7.21 – v1.7.31 (major breakage in 1.7.30).
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Area/Docker
Docker image and container packaging
 Area/Download Clients
Download client integrations
 Area/Frontend
Client-side UI and build tooling
 Area/History
History and completed downloads views
 Area/Logging
Log streaming, file handling, and debug infrastructure
 Area/Matching
Matching and correlation logic
 Area/Proxy
Upstream service proxy routes
 Area/SSE
Server-Sent Events and real-time streaming
 Area/Webhooks
Webhook processing and reliability
 Compat/Breaking
Breaking change that won't be backward compatible
 Compat/Non-Breaking
Non-breaking compatibility change
 Kind/Bug
Something is not working
 Kind/Documentation
Documentation changes
 Kind/Enhancement
Improve existing functionality
 Kind/Feature
New functionality
 Kind/Security
This is security issue
 Kind/Testing
Issue or pull request related to testing
Priority
Critical
1
The priority is critical
Priority
High
2
The priority is high
Priority
Low
4
The priority is low
Priority
Medium
3
The priority is medium
Reviewed
Confirmed
1
Issue has been confirmed
Reviewed
Duplicate
2
This issue or pull request already exists
Reviewed
Invalid
3
Invalid issue
Reviewed
Won't Fix
3
This issue won't be fixed
Status
Abandoned
3
Somebody has started to work on this but abandoned work
Status
Blocked
1
Something is blocking this issue or pull request
Status
Need More Info
2
Feedback is required to reproduce issue or to continue work
No Label Area/Docker Area/Frontend Compat/Non-Breaking Kind/Bug
Priority
Medium
3
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
Gandalf
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Gandalf/sofarr#66
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?