feat: add configurable backup file prefix by Antoninj · Pull Request #356 · Portabase/portabase

Antoninj · 2026-07-05T10:05:27Z

Summary

Adds an optional dashboard environment variable, BACKUP_FILE_PREFIX, for the object-key namespace used when backup files are sent to configured storage channels.

Defaults to backups, preserving existing deployments.
Normalizes leading/trailing slashes and falls back to backups for an empty value.
Includes the normalized prefix in each storage channel sent to agents, including encrypted storage payloads.
Documents the variable in .env.example.

Coordinated changes

Agent implementation: Portabase/agent#83
Tracking issue: Portabase/portabase#394

Deploy this PR together with the agent change before setting a custom prefix.

Validation

git diff --check
Type-check not run: pnpm is unavailable in the development environment.

Summary by CodeRabbit

New Features
- Added an optional configuration for customizing the storage prefix used for backup files.
- Backup paths now use the configured prefix while preserving the default backups location.
- Storage status information now includes the active backup prefix.

coderabbitai · 2026-07-05T10:05:36Z

📝 Walkthrough

Walkthrough

Adds optional BACKUP_FILE_PREFIX configuration, documents its default, normalizes the value, and uses it for backup storage paths and database storage-channel responses.

Changes

Backup prefix configuration

Layer / File(s)	Summary
Backup prefix configuration `.env.example`, `src/env.mjs`	Documents, validates, loads, and normalizes the optional `BACKUP_FILE_PREFIX` environment variable, defaulting to `backups`.
Backup prefix propagation `src/features/storages/utils/storages.helpers.ts`, `src/features/agents/utils/status/storage-channels.helpers.ts`	Uses the normalized prefix in backup paths and includes it in returned storage-channel objects.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related issues

feat: configure backup file prefix across dashboard and agent #394 — Covers backup prefix configuration, storage paths, and agent storage-channel propagation.

Suggested reviewers: asuniia, rambokdev

Poem

A bunny tuned the backup trail,
With tidy slashes in the gale.
Channels share the prefix too,
And stored files know where to chew.
Hop, hop—defaults guide them through!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the main change: making the backup file prefix configurable.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

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.}

RambokDev · 2026-07-05T10:09:31Z

Hi @Antoninj ,

Could you describe a bit more you use case ?

Tests are in : https://github.com/Portabase/e2e-tests you can are test to it directly

This e2e tests are called in PR, like a component

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/features/channel/components/storages/s3.ts`:
- Around line 34-39: Add unit tests for buildKey to cover the centralized S3 key
normalization logic used by upload/get/delete/ping/copy. Focus on edge cases
around S3Config.prefix and path handling: empty or whitespace-only prefix,
prefix containing only slashes, path values with leading/trailing slashes, and
paths with multiple internal slashes. Use buildKey and S3Config as the main
symbols to locate the behavior and verify the returned key strings for each
case.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: fbc8effb-dc47-40c1-bf7e-80df479d9bde

📥 Commits

Reviewing files that changed from the base of the PR and between 6952ac5 and 8646ec9.

📒 Files selected for processing (3)

src/features/channel/components/storages/s3.form.tsx
src/features/channel/components/storages/s3.schema.ts
src/features/channel/components/storages/s3.ts

📜 Review details

🔇 Additional comments (3)

src/features/channel/components/storages/s3.schema.ts (1)

9-9: LGTM!

src/features/channel/components/storages/s3.form.tsx (1)

87-99: LGTM!
src/features/channel/components/storages/s3.ts (1)
34-39: 🗄️ Data Integrity & Integration

No backward-compatibility issue. prefix is opt-in; existing S3 configs keep using the raw object path, so there’s no key-namespace migration here.
			> Likely an incorrect or invalid review comment.

Antoninj · 2026-07-05T11:48:38Z

@RambokDev

-> Could you describe a bit more you use case ?

The use case is the following: I use the same S3 bucket for multiple backups (not only portabase ones). Currently, portabase hardcodes the prefix to backups but I would like to configure the name to something else

Tests are in : https://github.com/Portabase/e2e-tests you can are test to it directly
This e2e tests are called in PR, like a component

thanks I'll take a look and see if adding an E2E test makes sense for my changes. But in any case, I'd need to get those changes in first

Antoninj · 2026-07-05T12:06:36Z

Added E2E coverage in Portabase/e2e-tests#11. It fills the new S3 Prefix field for the existing S3/R2 storage channel flow and verifies the value persists when reopening the channel. I left it as a draft because it depends on this PR introducing the Prefix field.

RambokDev · 2026-07-05T16:49:38Z

Hi @Antoninj,

I now understand your use case.

This PR will not work as-is because uploads are handled partly on the dashboard side at some point, but mainly by the agent when dispatching backup files to storage after the backup is completed.

What I suggest is adding an environment variable on the dashboard side, for example BACKUP_FILE_PREFIX. If defined, it would override the currently hardcoded /backups prefix and then be passed down to the agent.

I think this would be more generic and would apply consistently across the whole ecosystem.

Could you open an issue so we can continue the discussion there?

I can work on it ASAP, but if you want, you can also start implementing the dashboard-side part, and I can finish the agent-side integration.

Regards,

Antoninj · 2026-07-06T07:05:17Z

Sounds good I'll do that thanks

RambokDev · 2026-07-07T17:20:54Z

Sounds good I'll do that thanks

Feel free to ask if you have any questions. I’d be happy to help.

Antoninj · 2026-07-07T18:09:44Z

Thanks. I won't have time to iterate on this before next week end though.

RambokDev · 2026-07-07T19:27:46Z

Thanks. I won't have time to iterate on this before next week end though.

No problem, ping me when you have time

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/features/storages/utils/storages.helpers.ts`:
- Around line 23-25: Update getBackupFilePrefix and the dashboard-to-agent
configuration flow so the same normalized BACKUP_FILE_PREFIX is propagated to
agent-managed backups. Ensure agent uploads and subsequent storage operations
use this prefix instead of defaulting to /backups, while preserving the existing
"backups" fallback when the variable is unset.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 10e8fbf6-8f74-4174-8bd3-4bf3b08c047f

📥 Commits

Reviewing files that changed from the base of the PR and between 8646ec9 and 4a77932.

📒 Files selected for processing (3)

.env.example
src/env.mjs
src/features/storages/utils/storages.helpers.ts

📜 Review details

🔇 Additional comments (2)

.env.example (1)

76-79: LGTM!

src/env.mjs (1)

69-70: LGTM!

Also applies to: 128-131, 159-159, 215-215

coderabbitai · 2026-07-18T11:11:23Z

+function getBackupFilePrefix(): string {
+    return env.BACKUP_FILE_PREFIX?.trim().replace(/^\/+|\/+$/g, "") || "backups";
+}


🗄️ Data Integrity & Integration | 🟠 Major | 🏗️ Heavy lift

Propagate the prefix to agent-managed backups.

This helper only changes paths created by the dashboard. Agent uploads will continue using their existing /backups prefix unless BACKUP_FILE_PREFIX is included in the dashboard-to-agent configuration contract. That leaves backup sets split across prefixes and can make subsequent storage operations target inconsistent keys. Pass the normalized prefix to the agent, or centralize path construction before applying this dashboard-only change.

Also applies to: 63-63

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/features/storages/utils/storages.helpers.ts` around lines 23 - 25, Update getBackupFilePrefix and the dashboard-to-agent configuration flow so the same normalized BACKUP_FILE_PREFIX is propagated to agent-managed backups. Ensure agent uploads and subsequent storage operations use this prefix instead of defaulting to /backups, while preserving the existing "backups" fallback when the variable is unset.

Antoninj · 2026-07-18T11:11:40Z

Thanks. I won't have time to iterate on this before next week end though.

No problem, ping me when you have time

I updated the implementation based on your recommendations and linked the PR to an issue in the repo.

Antoninj marked this pull request as ready for review July 5, 2026 10:06

Antoninj changed the title ~~[codex] Add configurable S3 storage prefix~~ enhancement: add configurable S3 storage prefix Jul 5, 2026

coderabbitai Bot requested changes Jul 5, 2026

View reviewed changes

Comment thread src/features/channel/components/storages/s3.ts Outdated

coderabbitai Bot approved these changes Jul 5, 2026

View reviewed changes

Antoninj mentioned this pull request Jul 5, 2026

Cover S3 prefix configuration Portabase/e2e-tests#11

Closed

Antoninj mentioned this pull request Jul 18, 2026

feat: configure backup file prefix across dashboard and agent #394

Closed

Antoninj added 2 commits July 18, 2026 13:07

Add configurable S3 storage prefix

0781116

feat: configure backup file prefix

4a77932

Antoninj force-pushed the codex/configurable-s3-prefix branch from 8646ec9 to 4a77932 Compare July 18, 2026 11:07

Antoninj changed the title ~~enhancement: add configurable S3 storage prefix~~ feat: add configurable backup file prefix Jul 18, 2026

coderabbitai Bot requested changes Jul 18, 2026

View reviewed changes

Antoninj mentioned this pull request Jul 18, 2026

fix: support configurable backup file prefix Portabase/agent#83

Merged

feat: pass backup prefix to agents

5f4293a

RambokDev changed the base branch from main to dev July 21, 2026 18:14

RambokDev merged commit 7c896d5 into Portabase:dev Jul 21, 2026
1 check passed

coderabbitai Bot mentioned this pull request Jul 21, 2026

dev #406

Merged

Uh oh!

Uh oh!

Conversation

Antoninj commented Jul 5, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Coordinated changes

Validation

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jul 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

RambokDev commented Jul 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Antoninj commented Jul 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Antoninj commented Jul 5, 2026

Uh oh!

RambokDev commented Jul 5, 2026

Uh oh!

Antoninj commented Jul 6, 2026

Uh oh!

RambokDev commented Jul 7, 2026

Uh oh!

Antoninj commented Jul 7, 2026

Uh oh!

RambokDev commented Jul 7, 2026

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Jul 18, 2026

Choose a reason for hiding this comment

Uh oh!

Antoninj commented Jul 18, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Antoninj commented Jul 5, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jul 5, 2026 •

edited

Loading

RambokDev commented Jul 5, 2026 •

edited

Loading

Antoninj commented Jul 5, 2026 •

edited

Loading