"Mark as Not Found" should remove the log entry created by "Mark as Found"

Aperta
  • Qualcosa non va?
#768 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
52/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Tranquilla
Stack tecnologico
python
Ambito
database, desktop

Direzione di ricerca

Start in cache_table.py at the found/not-found handler and at the session.add(Log(...)) call in the Mark as Found path, which leaves log_id unset. Check importer/__init__.py and gsak_importer.py to confirm imported logs always carry a log_id. Done when Mark as Not Found deletes only logs matching the current finder, a type in FOUND_LOG_TYPES, and log_id is None, and decrements found_log_count.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

area: cache-details improvement
Current State

"Mark as Found" creates a Log row (type "Found it"/"Attended", finder = the
configured username) when a cache is manually marked found. "Mark as Not
Found" currently clears cache.found/cache.found_date but deliberately
leaves that Log row in place — see the comment in
cache_table.py's found/not-found handler:

It deliberately does NOT touch existing Log rows though: deleting/
rewriting log history risks destroying real, imported found logs (e.g. a
genuine earlier find from before this cache was re-marked), and there's
no reliable way to tell "the log this feature created" apart from "a real
imported log" well enough to safely delete just the former.

That caution turned out to matter beyond just the UI: #766 (found status not
surviving GPX round-trips) had to add an explicit guard so a stale log left
behind by an unmark doesn't get misread as "found" again on re-export/
re-import. The guard fixes the symptom, but the stale log itself is still
sitting in the database, which is confusing (a cache correctly showing "not
found" that still has a "Found it" log entry if you open its Logs tab) and
still slightly fragile (e.g. it would appear in the log list / log count
displayed elsewhere in the UI).

Proposed Improvement

The "no reliable way to tell them apart" concern turns out to be solvable
without a schema change: Log.log_id is only ever None for logs created
by this feature. Every import path — GPX (importer/__init__.py) and
GSAK database (gsak_importer.py) — always sets a real log_id (the GC.com
log GUID, or f"{gc_code}_{lLogId}" for GSAK-DB imports). "Mark as Found"
is the only code path that creates a Log row with log_id left unset
(see cache_table.py, the session.add(Log(...)) call — no log_id is
passed).

So "Mark as Not Found" can safely delete the found-type log it's clearing,
as long as it also checks log_id is None — i.e. only delete a log that:

  1. matches the current user (finder_id/finder against
    gc_finder_id/gc_username, same matching already used elsewhere), AND
  2. has log_type in FOUND_LOG_TYPES, AND
  3. has log_id is None (proof it was created by this feature, not imported).

Any real imported found log — which always has a log_id — is left
untouched, even if it happens to belong to the current user. This should
fully resolve the original concern without needing to guess.

Notes

  • found_log_count should be decremented (not just left stale) when the
    log is removed, mirroring the increment that happens on creation.
  • Once this ships, the #766 sym is None-only fallback guard technically
    becomes less likely to ever see a stale log in practice for OpenSAK's own
    exports — but it should stay in place regardless, since third-party GPX
    sources (GSAK, etc.) can still legitimately omit <sym> and it's cheap
    insurance either way.
Expected Benefits

No response

Lingua principale
Python
Stelle
37
Fork
17
Merge medio
16h 7m
PR unite (30g)
128

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di OpenSAK-Org/OpenSAK

Tutte le issue di OpenSAK-Org/OpenSAK

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.