Merge develop into main for v0.5.1-rc.1 #142

eduardolat · 2025-10-06T05:07:16Z

Summary by CodeRabbit

New Features
- Configurable path prefix for hosting under a subpath via env var; app links, redirects, and static assets honor it.
- Replaced SweetAlert2 with a new lightweight in-app dialog system.
Documentation
- Rebranded to “UFO Backup”; updated README, community landing page, redirects, and automated docs deploy to Cloudflare Pages.
- Added sponsor/support updates.
Chores
- Expanded formatter ignore list; updated asset scanning for styles/scripts.
Tests
- Added validation and path-prefix utility tests.

… logo asset

Introduces configurable path prefix to serve application under subpath (e.g., /pgbackweb) Implements validation for path prefixes in environment variables Updates all redirects and routes to use the configured path prefix This allows deploying the app at a custom URL path while maintaining correct functionality.

Updates tests to properly manage global state: - Uses defer pattern to restore original values after tests - Resets sync.Once to allow multiple SetPathPrefix calls in tests - Removes shouldSkip field from test cases as it's no longer needed

Refactors URL handling to allow serving the app from a subdirectory. Updates all static file paths and dashboard navigation links to use a utility function that prepends the configured path prefix when generating URLs.

Consistently uses the pathutil.BuildPath function to build URLs across various web components instead of hardcoding them.

Replaces string concatenation with fmt.Sprintf for building URLs This ensures consistent and more secure path handling across all dashboard operations like delete, edit, duplicate, etc.

Introduces consistent use of pathutil.BuildPath function for building URLs Adds proper path prefixing to image paths in support project data Improves URL generation across various dashboard components WIP on feature/path-prefix

Adds support for path prefix configuration

…tion

…configuration to include init-dialogs.js for content scanning

…onfirm for consistency

…e Pages

…ty page

… community participation

coderabbitai · 2025-10-06T05:07:39Z

Caution

Review failed

The pull request is closed.

Walkthrough

Adds configurable PBW_PATH_PREFIX support with validation and a pathutil; updates startup, router, and many view files to build routes from the prefix. Replaces SweetAlert2 with a custom dialog module. Adds docs site, redirects, deploy workflow, README rebrand, sponsor updates, and minor static asset/config tweaks.

Changes

Cohort / File(s)	Summary
Env & validation `internal/config/env.go`, `internal/config/env_validate.go`, `internal/validate/path_prefix.go`, `internal/validate/path_prefix_test.go`, `.env.example`	Adds `PBW_PATH_PREFIX` env var, validation rules and tests, and documents the variable in the example.
Path util `internal/util/pathutil/pathutil.go`, `internal/util/pathutil/pathutil_test.go`	New package to Set/Get/BuildPath with sync.Once and tests; centralizes path-prefix handling.
Bootstrap & routing `cmd/app/main.go`, `internal/view/router.go`, `internal/view/web/router.go`	Calls SetPathPrefix at startup, introduces base router group using the prefix, mounts static/api/web routes under that base.
Static assets & global exposure `internal/view/static/static_fs.go`, `internal/view/web/layout/common.go`, `internal/view/web/component/logotype.go`	Static file path building via `BuildPath`, injects `window.PBW_PATH_PREFIX`, and updates logo/static references for prefix.
Middleware, redirects & auth `internal/view/middleware/.go`, `internal/view/web/auth/.go`, `internal/view/web/layout/*`, `internal/view/web/router.go`	Replaces literal redirect/route strings with `pathutil.BuildPath` across auth, middleware, and layout links; adds autofocus in some forms.
Views: dashboard, lists, actions `internal/view/web/dashboard/**` (backups, databases, destinations, executions, restorations, webhooks, profile, ...)	Systematic replacement of literal URLs with `pathutil.BuildPath(...)` for links, forms, HTMX targets, redirects, and button actions.
Dialogs & HTMX integration `internal/view/static/js/app.js`, `internal/view/static/js/init-dialogs.js`, `internal/view/static/js/init-htmx.js`, `internal/view/static/js/init-sweetalert2.js` (removed), `internal/view/static/css/partials/sweetalert2.css` (removed), `internal/view/static/css/style.css`, `tailwind.config.ts`	Removes SweetAlert2, adds custom `initDialogs` module, updates HTMX handlers to use `customAlert/customConfirm`, updates Tailwind content to include new JS.
Docs, redirects & CI deploy `.github/workflows/docs-deploy.yaml`, `docs/index.html`, `docs/_redirects`, `README.md`	Adds Cloudflare Pages deploy workflow, new docs landing page and redirects, README rebranding/copy edits.
Misc `.prettierignore`, `assets/support-project-v1.json`, `internal/view/static/static_fs.go`	Ignore build assets; sponsor JSON reordered/added; static file versioned paths now prefix-aware.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant Start as App Start
  participant Env as Env Loader
  participant Val as validate.PathPrefix
  participant PU as pathutil
  participant Router as Router Init
  participant Browser as Client

  Start->>Env: read PBW_PATH_PREFIX
  Env->>Val: validate prefix
  Val-->>Env: result
  Start->>PU: SetPathPrefix(value)
  Router->>PU: GetPathPrefix()
  Router->>Browser: serve routes under prefix (static, api, web)

sequenceDiagram
  autonumber
  participant User as User
  participant UI as HTMX trigger
  participant Dialog as customConfirm
  participant Server as Backend

  User->>UI: click destructive action
  UI->>Dialog: window.customConfirm(text)
  alt confirmed
    Dialog-->>UI: {isConfirmed: true}
    UI->>Server: HTMX request (DELETE/POST)
    Server-->>UI: response
  else dismissed
    Dialog-->>UI: {isDismissed: true}
  end

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Adds support for path prefix configuration #139 — Implements the same path-prefix feature (env var, validation, pathutil, router and widespread BuildPath updates).
💖 FetchGoat sponsorship #103 — Related sponsor/README edits touching assets/support-project-v1.json and README content.

Poem

In burrows deep I tweak each trail,
I stitch a prefix to every rail.
Sweet alerts hopped off the lawn,
New dialogs greet the dawn.
Docs take flight — UFO Backup, hop on! 🚀🐇

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 17.19% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The provided title clearly describes the primary intent of the pull request, which is merging the develop branch into main for the v0.5.1-rc.1 release, and it is concise, unambiguous, and free of extraneous details.

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8282d9b and 9a2b0e2.

📒 Files selected for processing (1)

.github/workflows/docs-deploy.yaml (1 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 7

🧹 Nitpick comments (3)

internal/view/web/component/support_project.inc.js (1)
72-103: Consider cloning the data object before mutation.

The method mutates the input data object by reassigning its properties (lines 75, 83, 89, 95). If the original data object is referenced elsewhere, this could lead to unexpected side effects.

If data immutability is a concern, apply this diff to clone the data first:
 processData(data) {
+  const clonedData = JSON.parse(JSON.stringify(data));
   // Add path prefix to all image URLs
-  if (data.referralLinks) {
-    data.referralLinks = data.referralLinks.map((link) => ({
+  if (clonedData.referralLinks) {
+    clonedData.referralLinks = clonedData.referralLinks.map((link) => ({
       ...link,
       logo: this.prefixImagePath(link.logo),
     }));
   }

-  if (data.sponsors) {
-    if (data.sponsors.gold) {
-      data.sponsors.gold = data.sponsors.gold.map((sponsor) => ({
+  if (clonedData.sponsors) {
+    if (clonedData.sponsors.gold) {
+      clonedData.sponsors.gold = clonedData.sponsors.gold.map((sponsor) => ({
         ...sponsor,
         logo: this.prefixImagePath(sponsor.logo),
       }));
     }
-    if (data.sponsors.silver) {
-      data.sponsors.silver = data.sponsors.silver.map((sponsor) => ({
+    if (clonedData.sponsors.silver) {
+      clonedData.sponsors.silver = clonedData.sponsors.silver.map((sponsor) => ({
         ...sponsor,
         logo: this.prefixImagePath(sponsor.logo),
       }));
     }
-    if (data.sponsors.bronze) {
-      data.sponsors.bronze = data.sponsors.bronze.map((sponsor) => ({
+    if (clonedData.sponsors.bronze) {
+      clonedData.sponsors.bronze = clonedData.sponsors.bronze.map((sponsor) => ({
         ...sponsor,
         logo: this.prefixImagePath(sponsor.logo),
       }));
     }
   }

-  return data;
+  return clonedData;
 }
internal/util/pathutil/pathutil_test.go (2)
58-59: Fragile state manipulation breaks encapsulation.

Directly resetting unexported package variables (pathPrefix and pathPrefixOnce) is fragile and breaks encapsulation. This pattern works only because the test is in the same package, but it makes the tests brittle and harder to maintain.

Consider exposing a ResetForTesting() function in the pathutil package (build-tagged for test files only) or restructuring to avoid global state where possible.

Example approach with a test-only reset function in pathutil.go:
//go:build test
// +build test

package pathutil

func ResetForTesting() {
	pathPrefixOnce = sync.Once{}
	pathPrefix = ""
}
Then in the test:
 		t.Run(tt.name, func(t *testing.T) {
-			originalPrefix := pathPrefix
-			pathPrefixOnce = sync.Once{}
+			defer ResetForTesting()
 			SetPathPrefix(tt.prefix)
-			defer func() {
-				pathPrefixOnce = sync.Once{}
-				pathPrefix = originalPrefix
-			}()

 			result := BuildPath(tt.path)
76-76: Apply the same encapsulation improvement here.

Similar to the previous comment on TestBuildPath, consider using a ResetForTesting() function instead of directly manipulating unexported variables.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9cafda5 and 8282d9b.

⛔ Files ignored due to path filters (3)

assets/logos/hetzner-horizontal.png is excluded by !**/*.png
assets/logos/hetzner.png is excluded by !**/*.png
internal/view/static/libs/sweetalert2/sweetalert2-11.13.1.min.js is excluded by !**/*.min.js

📒 Files selected for processing (68)

.env.example (1 hunks)
.github/workflows/docs-deploy.yaml (1 hunks)
.prettierignore (1 hunks)
README.md (5 hunks)
assets/support-project-v1.json (2 hunks)
cmd/app/main.go (3 hunks)
docs/_redirects (1 hunks)
docs/index.html (1 hunks)
internal/config/env.go (1 hunks)
internal/config/env_validate.go (1 hunks)
internal/util/pathutil/pathutil.go (1 hunks)
internal/util/pathutil/pathutil_test.go (1 hunks)
internal/validate/path_prefix.go (1 hunks)
internal/validate/path_prefix_test.go (1 hunks)
internal/view/middleware/require_auth.go (2 hunks)
internal/view/middleware/require_no_auth.go (2 hunks)
internal/view/router.go (2 hunks)
internal/view/static/css/partials/sweetalert2.css (0 hunks)
internal/view/static/css/style.css (0 hunks)
internal/view/static/js/app.js (1 hunks)
internal/view/static/js/init-dialogs.js (1 hunks)
internal/view/static/js/init-htmx.js (3 hunks)
internal/view/static/js/init-sweetalert2.js (0 hunks)
internal/view/static/static_fs.go (2 hunks)
internal/view/web/auth/create_first_user.go (5 hunks)
internal/view/web/auth/login.go (5 hunks)
internal/view/web/auth/logout.go (3 hunks)
internal/view/web/component/logotype.go (2 hunks)
internal/view/web/component/support_project.inc.js (3 hunks)
internal/view/web/dashboard/backups/create_backup.go (4 hunks)
internal/view/web/dashboard/backups/delete_backup.go (2 hunks)
internal/view/web/dashboard/backups/duplicate_backup.go (2 hunks)
internal/view/web/dashboard/backups/edit_backup.go (2 hunks)
internal/view/web/dashboard/backups/index.go (2 hunks)
internal/view/web/dashboard/backups/list_backups.go (3 hunks)
internal/view/web/dashboard/backups/manual_run.go (2 hunks)
internal/view/web/dashboard/databases/create_database.go (2 hunks)
internal/view/web/dashboard/databases/delete_database.go (2 hunks)
internal/view/web/dashboard/databases/edit_database.go (2 hunks)
internal/view/web/dashboard/databases/index.go (2 hunks)
internal/view/web/dashboard/databases/list_databases.go (3 hunks)
internal/view/web/dashboard/destinations/create_destination.go (2 hunks)
internal/view/web/dashboard/destinations/delete_destination.go (2 hunks)
internal/view/web/dashboard/destinations/edit_destination.go (2 hunks)
internal/view/web/dashboard/destinations/index.go (2 hunks)
internal/view/web/dashboard/destinations/list_destinations.go (3 hunks)
internal/view/web/dashboard/executions/index.go (2 hunks)
internal/view/web/dashboard/executions/list_executions.go (2 hunks)
internal/view/web/dashboard/executions/restore_execution.go (3 hunks)
internal/view/web/dashboard/executions/show_execution.go (2 hunks)
internal/view/web/dashboard/executions/soft_delete_execution.go (2 hunks)
internal/view/web/dashboard/profile/close_all_sessions.go (2 hunks)
internal/view/web/dashboard/profile/update_user.go (2 hunks)
internal/view/web/dashboard/restorations/index.go (2 hunks)
internal/view/web/dashboard/restorations/list_restorations.go (2 hunks)
internal/view/web/dashboard/webhooks/create_webhook.go (4 hunks)
internal/view/web/dashboard/webhooks/delete_webhook.go (2 hunks)
internal/view/web/dashboard/webhooks/duplicate_webhook.go (2 hunks)
internal/view/web/dashboard/webhooks/edit_webhook.go (3 hunks)
internal/view/web/dashboard/webhooks/index.go (2 hunks)
internal/view/web/dashboard/webhooks/list_webhooks.go (2 hunks)
internal/view/web/dashboard/webhooks/run_webhook.go (2 hunks)
internal/view/web/dashboard/webhooks/webhook_executions.go (3 hunks)
internal/view/web/layout/common.go (2 hunks)
internal/view/web/layout/dashboard_aside.go (3 hunks)
internal/view/web/layout/dashboard_header.go (2 hunks)
internal/view/web/router.go (3 hunks)
tailwind.config.ts (1 hunks)

💤 Files with no reviewable changes (3)

internal/view/static/css/partials/sweetalert2.css
internal/view/static/js/init-sweetalert2.js
internal/view/static/css/style.css

🧰 Additional context used

📓 Path-based instructions (7)

**/*.go