Dedupe daemon by unpetrifiedstone2005 · Pull Request #40 · Rakshat28/bdstorage

unpetrifiedstone2005 · 2026-04-04T10:21:34Z

feat: add daemon mode for deduplication with configurable interval

Introduced a new Daemon command to periodically run deduplication on a specified path.
Refactored Dedupe command to use a dedicated DedupeOptions struct for better organization.
Added ctrlc support for graceful shutdown of the daemon.
Updated Cargo.toml to include the ctrlc dependency.

- Introduced a new `Daemon` command to periodically run deduplication on a specified path. - Refactored `Dedupe` command to use a dedicated `DedupeOptions` struct for better organization. - Added `ctrlc` support for graceful shutdown of the daemon. - Updated `Cargo.toml` to include the `ctrlc` dependency.

Copilot

Pull request overview

Adds a periodic “dedupe daemon” mode to the bdstorage CLI and introduces example systemd units/docs (both WSL user units and bare-metal system units) to run scheduled or continuously-looping dedupe runs.

Changes:

Refactors dedupe CLI args into a reusable DedupeOptions and adds a new daemon subcommand that repeatedly spawns bdstorage dedupe until interrupted.
Adds ctrlc dependency to support clean interruption of the daemon loop.
Adds contrib/wsl/* and contrib/systemd/* docs, unit files, and an install helper script.

Reviewed changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 13 comments.

Show a summary per file

File	Description
`src/main.rs`	Adds `DedupeOptions`, `daemon` subcommand, and `run_daemon` loop with ctrl-c handling.
`Cargo.toml`	Adds `ctrlc` dependency needed by the daemon command.
`contrib/wsl/README.md`	Documents WSL2 + systemd setup and how to run user units/timers.
`contrib/wsl/wsl.conf.example`	Example snippet to enable systemd in WSL.
`contrib/wsl/install-wsl-user-units.sh`	Installs user unit files and creates an env file for WSL usage.
`contrib/wsl/env.example`	Example env file for user units.
`contrib/wsl/bdstorage-dedupe.service`	User service to run `bdstorage daemon …` under `systemctl --user`.
`contrib/wsl/bdstorage-dedupe-once.service`	User oneshot unit to run one `bdstorage dedupe …`.
`contrib/wsl/bdstorage-dedupe.timer`	User timer to trigger the oneshot daily.
`contrib/systemd/README.md`	Bare-metal systemd deployment instructions.
`contrib/systemd/bdstorage.env.example`	Example `/etc/bdstorage.env` for the system units.
`contrib/systemd/bdstorage-dedupe.service`	System service to run `bdstorage daemon …` as user `bdstorage`.
`contrib/systemd/bdstorage-dedupe-once.service`	System oneshot unit to run one `bdstorage dedupe …`.
`contrib/systemd/bdstorage-dedupe.timer`	System timer to trigger the oneshot daily.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-04T11:33:32Z

+        for _ in 0..interval_secs {
+            if !running.load(Ordering::SeqCst) {
+                break;
+            }
+            thread::sleep(Duration::from_secs(1));
+        }


interval_secs can be set to 0, which makes the daemon immediately start the next dedupe run with no delay (tight loop after the child exits). Consider validating interval_secs >= 1 (or enforcing a minimum via clap) to avoid accidental high-CPU / high-IO behavior.

Copilot · 2026-04-04T11:33:32Z

+
+[Unit]
+Description=bdstorage deduplication daemon (WSL user)
+After=default.target


After=default.target combined with WantedBy=default.target creates an ordering cycle (the target pulls the service in, but the service is ordered after the target). Dropping After=default.target (or ordering after a more specific target) avoids systemd cycle warnings and ensures reliable startup ordering.

Suggested change

After=default.target

Copilot · 2026-04-04T11:33:33Z

+
+[Service]
+Type=simple
+EnvironmentFile=-%h/.config/bdstorage/env


EnvironmentFile is marked optional (-...), but ExecStart depends on variables from that file. If the env file is missing, the unit will fail in a more confusing way (empty command/path/args). Consider removing the leading - so systemd reports a missing environment file explicitly, or provide safe defaults in the unit.

Suggested change

EnvironmentFile=-%h/.config/bdstorage/env

EnvironmentFile=%h/.config/bdstorage/env

Copilot · 2026-04-04T11:33:33Z

+Type=simple
+User=bdstorage
+Group=bdstorage
+EnvironmentFile=-/etc/bdstorage.env


EnvironmentFile is marked optional (-...), but ExecStart depends on variables from that file. If the env file is missing, the unit will fail in a more confusing way (missing target/interval). Consider removing the leading - so systemd reports the missing env file explicitly, or provide defaults.

Suggested change

EnvironmentFile=-/etc/bdstorage.env

EnvironmentFile=/etc/bdstorage.env

Copilot · 2026-04-04T11:33:33Z

+Type=oneshot
+User=bdstorage
+Group=bdstorage
+EnvironmentFile=-/etc/bdstorage.env


EnvironmentFile is marked optional (-...), but ExecStart relies on $BDSTORAGE_TARGET. If the env file is missing (or the var is unset), the oneshot will fail with a clap usage error rather than a clear systemd env-file error. Consider making the env file required or hardcoding the target in the unit.

Suggested change

EnvironmentFile=-/etc/bdstorage.env

EnvironmentFile=/etc/bdstorage.env

Copilot · 2026-04-04T11:33:34Z

+User=bdstorage
+Group=bdstorage
+EnvironmentFile=-/etc/bdstorage.env
+ExecStart=/usr/local/bin/bdstorage daemon $BDSTORAGE_TARGET --interval-secs $BDSTORAGE_INTERVAL_SECS


ExecStart uses $BDSTORAGE_TARGET unquoted; if the target path contains spaces, systemd will split it into multiple arguments and the dedupe invocation will fail. Consider quoting $BDSTORAGE_TARGET in ExecStart= (systemd supports quoting) to keep it a single argument.

Suggested change

ExecStart=/usr/local/bin/bdstorage daemon $BDSTORAGE_TARGET --interval-secs $BDSTORAGE_INTERVAL_SECS

ExecStart=/usr/local/bin/bdstorage daemon "$BDSTORAGE_TARGET" --interval-secs $BDSTORAGE_INTERVAL_SECS

Copilot · 2026-04-04T11:33:34Z

+User=bdstorage
+Group=bdstorage
+EnvironmentFile=-/etc/bdstorage.env
+ExecStart=/usr/local/bin/bdstorage dedupe $BDSTORAGE_TARGET


ExecStart uses $BDSTORAGE_TARGET unquoted; if the target path contains spaces, systemd will split it into multiple arguments and the oneshot will fail. Consider quoting $BDSTORAGE_TARGET in ExecStart= to keep it a single argument.

Suggested change

ExecStart=/usr/local/bin/bdstorage dedupe $BDSTORAGE_TARGET

ExecStart=/usr/local/bin/bdstorage dedupe "$BDSTORAGE_TARGET"

Copilot · 2026-04-04T11:33:34Z

+[Service]
+Type=oneshot
+EnvironmentFile=-%h/.config/bdstorage/env
+ExecStart=$BDSTORAGE_BIN dedupe $BDSTORAGE_TARGET


ExecStart uses $BDSTORAGE_TARGET unquoted; if the target path contains spaces, systemd will split it into multiple arguments and the oneshot will fail. Consider quoting $BDSTORAGE_TARGET in ExecStart=.

Suggested change

ExecStart=$BDSTORAGE_BIN dedupe $BDSTORAGE_TARGET

ExecStart=$BDSTORAGE_BIN dedupe "$BDSTORAGE_TARGET"

Copilot · 2026-04-04T11:33:35Z

+  umask 077
+  cat >"$ENV_FILE" <<EOF
+HOME=${HOME}
+BDSTORAGE_BIN=${BIN}
+BDSTORAGE_TARGET=${TARGET}
+BDSTORAGE_INTERVAL_SECS=${INTERVAL}
+EOF


The script sets umask 077 when creating the env file but does not restore the previous umask afterward. This can unintentionally affect permissions of files created later in the script (including installed unit files). Consider saving/restoring the prior umask (or doing env-file creation in a subshell).

Suggested change

umask 077

cat >"$ENV_FILE" <<EOF

HOME=${HOME}

BDSTORAGE_BIN=${BIN}

BDSTORAGE_TARGET=${TARGET}

BDSTORAGE_INTERVAL_SECS=${INTERVAL}

EOF

(

umask 077

cat >"$ENV_FILE" <<EOF

HOME=${HOME}

BDSTORAGE_BIN=${BIN}

BDSTORAGE_TARGET=${TARGET}

BDSTORAGE_INTERVAL_SECS=${INTERVAL}

EOF

)

Copilot · 2026-04-04T11:33:35Z

+        Commands::Daemon {
+            dedupe,
+            interval_secs,
+        } => {
+            run_daemon(dedupe, interval_secs)?;
+        }


New daemon subcommand / run_daemon behavior isn’t covered by the existing integration tests (which already exercise dedupe/restore). Adding an integration test that starts bdstorage daemon <tmpdir> --interval-secs 1 and then terminates it (after verifying at least one dedupe run occurred) would help prevent regressions in CLI parsing and daemon loop behavior.

Rakshat28 · 2026-04-04T14:11:36Z

background daemon for native systemd execution (Closes #38 )

Replaced process spawning with native Rust loops and crossbeam.
Added self-generating daemon install subcommand.
Fixed root split-brain bug by detecting SUDO_USER.
Propagated dedupe flags (like --allow-unsafe-hardlinks).
Removed outdated contrib/ folder bloat.
Added full daemon documentation to README.

unpetrifiedstone2005 added 2 commits April 4, 2026 15:47

daemon added

5df732b

Rakshat28 requested a review from Copilot April 4, 2026 11:27

Copilot started reviewing on behalf of Rakshat28 April 4, 2026 11:28 View session

Copilot AI reviewed Apr 4, 2026

View reviewed changes

unpetrifiedstone2005 and others added 3 commits April 4, 2026 17:11

readme updated: usage directions added

7c4a3d2

feat(daemon): implement native rust daemon with safe systemd integration

fbd7645

fmt check

50d938e

Rakshat28 merged commit fc05d86 into main Apr 4, 2026
2 checks passed

Rakshat28 deleted the dedupe-daemon branch May 15, 2026 11:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dedupe daemon#40

Dedupe daemon#40
Rakshat28 merged 5 commits into
mainfrom
dedupe-daemon

unpetrifiedstone2005 commented Apr 4, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 4, 2026

Uh oh!

Copilot AI Apr 4, 2026

Uh oh!

Copilot AI Apr 4, 2026

Uh oh!

Copilot AI Apr 4, 2026

Uh oh!

Copilot AI Apr 4, 2026

Uh oh!

Copilot AI Apr 4, 2026

Uh oh!

Copilot AI Apr 4, 2026

Uh oh!

Copilot AI Apr 4, 2026

Uh oh!

Copilot AI Apr 4, 2026

Uh oh!

Copilot AI Apr 4, 2026

Uh oh!

Rakshat28 commented Apr 4, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	EnvironmentFile=-%h/.config/bdstorage/env
	EnvironmentFile=%h/.config/bdstorage/env

	EnvironmentFile=-/etc/bdstorage.env
	EnvironmentFile=/etc/bdstorage.env

	ExecStart=/usr/local/bin/bdstorage daemon $BDSTORAGE_TARGET --interval-secs $BDSTORAGE_INTERVAL_SECS
	ExecStart=/usr/local/bin/bdstorage daemon "$BDSTORAGE_TARGET" --interval-secs $BDSTORAGE_INTERVAL_SECS

	ExecStart=/usr/local/bin/bdstorage dedupe $BDSTORAGE_TARGET
	ExecStart=/usr/local/bin/bdstorage dedupe "$BDSTORAGE_TARGET"

	ExecStart=$BDSTORAGE_BIN dedupe $BDSTORAGE_TARGET
	ExecStart=$BDSTORAGE_BIN dedupe "$BDSTORAGE_TARGET"

Conversation

unpetrifiedstone2005 commented Apr 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

Rakshat28 commented Apr 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

unpetrifiedstone2005 commented Apr 4, 2026 •

edited

Loading

Rakshat28 commented Apr 4, 2026 •

edited

Loading