mirror of
https://github.com/Matysh/houseplan-card
synced 2026-07-31 08:28:31 +00:00
v1.46.4: detached plans were being collected as garbage — data loss
Deployed v1.46.3 to my own instance, restarted, and the startup sweep deleted
both floor plans: config/houseplan/plans/ went from f1.svg + f2.png to empty.
The backup is a SecureTar, so they are gone.
The rule was wrong, not the code. v1.46.0 introduced collection that treats
'nothing references this right now' as abandoned and gives it an hour. But
detaching a plan — switching a space to 'draw' — is a normal, reversible action,
and the editor's own comment says the file stays on disk. Those two plans had
been detached for weeks; every pass since v1.46.0 was entitled to remove them,
and the one that finally ran did.
New rule, one for every path:
* superseded by a commit (was in the old revision, is not in the new) — goes
immediately; that is the one thing a commit knows for certain;
* belongs to a space or marker that still exists — never collected, at any
age, because unreferenced is not abandoned;
* a per-dialog staging folder (up_*) — one hour, unchanged: by construction it
only ever holds an upload from a dialog that was never saved;
* anything else — thirty days.
The flag I added an hour ago is gone with it: two rules for the same
question is how this happened. Tests updated to the new grace, plus two that pin
the distinction directly.
I am sorry about the files.
This commit is contained in:
@@ -860,9 +860,9 @@ async def _seed_aged(hass, names) -> None:
|
||||
import os
|
||||
import time
|
||||
|
||||
from custom_components.houseplan.const import PLAN_ORPHAN_TTL_S
|
||||
from custom_components.houseplan.const import SCHEDULED_GRACE_S
|
||||
|
||||
old = time.time() - PLAN_ORPHAN_TTL_S - 60
|
||||
old = time.time() - SCHEDULED_GRACE_S - 60
|
||||
|
||||
def _do() -> None:
|
||||
for path in names:
|
||||
@@ -885,7 +885,7 @@ def _paths(hass):
|
||||
"kept_file": os.path.join(files, "m5", "kept.pdf"),
|
||||
"kept_plan": os.path.join(plans, "s5.tok.png"),
|
||||
"orphan_file": os.path.join(files, "up_cancelled", "manual.pdf"),
|
||||
"orphan_plan": os.path.join(plans, "s5.orphan.png"),
|
||||
"orphan_plan": os.path.join(plans, "deleted_space.orphan.png"),
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -266,11 +266,11 @@ def test_collect_plans_keeps_a_fresh_unreferenced_upload(tmp_path):
|
||||
|
||||
|
||||
def test_collect_plans_takes_an_aged_orphan(tmp_path):
|
||||
PLAN_ORPHAN_TTL_S = const.PLAN_ORPHAN_TTL_S
|
||||
collect_plans = plans.collect_plans
|
||||
|
||||
d = _plans(tmp_path, ["f1.keep.png"])
|
||||
_plans(tmp_path, ["f1.abandoned.png"], age=PLAN_ORPHAN_TTL_S + 60)
|
||||
# past the long grace, and belonging to no space in the config
|
||||
_plans(tmp_path, ["f1.abandoned.png"], age=const.SCHEDULED_GRACE_S + 60)
|
||||
removed = collect_plans(d, _cfg("/p/f1.keep.png"), _cfg("/p/f1.keep.png"))
|
||||
assert removed == 1
|
||||
assert (d / "f1.keep.png").is_file() and not (d / "f1.abandoned.png").exists()
|
||||
@@ -495,7 +495,7 @@ def test_collect_attachments_supersedes_and_ages(tmp_path):
|
||||
assert (files / "m1" / "new.pdf").is_file()
|
||||
assert (files / "m1" / "cancelled.pdf").is_file()
|
||||
|
||||
old = time.time() - const.PLAN_ORPHAN_TTL_S - 60
|
||||
old = time.time() - const.SCHEDULED_GRACE_S - 60
|
||||
os.utime(files / "m1" / "cancelled.pdf", (old, old))
|
||||
assert collect_attachments(files, _acfg("m1/new.pdf"), _acfg("m1/new.pdf")) == 1
|
||||
assert not (files / "m1" / "cancelled.pdf").exists()
|
||||
@@ -552,3 +552,63 @@ def test_legacy_segments_are_dropped_by_the_server():
|
||||
"segments": [[1, 2, 3, 4]] * 100000,
|
||||
})
|
||||
assert "segments" not in out
|
||||
|
||||
|
||||
def test_scheduled_collection_never_takes_a_detached_plan(tmp_path):
|
||||
"""2026-07-28, on the author's own instance: two plans were deleted.
|
||||
|
||||
Detaching a plan (switching a space to "draw") is reversible and the editor
|
||||
says the file stays on disk. The timer only knows "nothing points at it",
|
||||
applied the one-hour orphan rule, and removed images that had been detached
|
||||
weeks earlier. A commit may still collect what it superseded — it knows it
|
||||
replaced something. The timer may not.
|
||||
"""
|
||||
import os
|
||||
import time
|
||||
|
||||
d = tmp_path / "plans"
|
||||
d.mkdir()
|
||||
for n in ("f1.svg", "f2.tok.png", "gone.old.png"):
|
||||
(d / n).write_bytes(b"x")
|
||||
t = time.time() - const.SCHEDULED_GRACE_S - 60
|
||||
os.utime(d / n, (t, t))
|
||||
|
||||
cfg = {"spaces": [{"id": "f1", "plan_url": None}, # detached, space alive
|
||||
{"id": "f2", "plan_url": None}]} # same
|
||||
assert plans.collect_plans(d, cfg, cfg) == 1
|
||||
assert (d / "f1.svg").is_file(), "a detached plan of a live space is kept"
|
||||
assert (d / "f2.tok.png").is_file()
|
||||
assert not (d / "gone.old.png").exists(), "a plan of a space that no longer exists ages out"
|
||||
|
||||
# a commit still removes what it SUPERSEDED — that it knows for certain
|
||||
old = {"spaces": [{"id": "f1", "plan_url": "/p/f1.svg"}, {"id": "f2", "plan_url": None}]}
|
||||
new = {"spaces": [{"id": "f1", "plan_url": "/p/f1.new.png"}, {"id": "f2", "plan_url": None}]}
|
||||
(d / "f1.new.png").write_bytes(b"x")
|
||||
assert plans.collect_plans(d, old, new) == 1
|
||||
assert not (d / "f1.svg").exists()
|
||||
assert (d / "f2.tok.png").is_file(), "and still touches nothing else of a live space"
|
||||
|
||||
|
||||
def test_scheduled_collection_keeps_a_live_marker_s_files(tmp_path):
|
||||
import os
|
||||
import time
|
||||
|
||||
files = tmp_path / "files"
|
||||
(files / "m1").mkdir(parents=True)
|
||||
(files / "up_abandoned").mkdir(parents=True)
|
||||
(files / "dead").mkdir(parents=True)
|
||||
old = time.time() - const.SCHEDULED_GRACE_S - 60
|
||||
for p in ((files / "m1" / "unlinked.pdf"), (files / "dead" / "x.pdf")):
|
||||
p.write_bytes(b"x")
|
||||
os.utime(p, (old, old))
|
||||
staging = files / "up_abandoned" / "manual.pdf"
|
||||
staging.write_bytes(b"x")
|
||||
hour_ago = time.time() - const.PLAN_ORPHAN_TTL_S - 60
|
||||
os.utime(staging, (hour_ago, hour_ago))
|
||||
|
||||
cfg = {"markers": [{"id": "m1", "pdfs": []}]}
|
||||
removed = plans.collect_attachments(files, cfg, cfg)
|
||||
assert (files / "m1" / "unlinked.pdf").is_file(), "the marker exists; leave its files alone"
|
||||
assert not staging.exists(), "a cancelled dialog is still collected after an hour"
|
||||
assert not (files / "dead" / "x.pdf").exists(), "a marker that is gone ages out"
|
||||
assert removed == 2
|
||||
|
||||
Reference in New Issue
Block a user