Repository navigation
docs(settings): say where an executable unpacks its assets - #32
Conversation
There was a problem hiding this comment.
REVIEWED ON 2026-11-04 13:40 UTC
Reviewed the two added paragraphs in docs/installation.md and docs/settings.md, plus the cross-links and anchors they use (/settings/#sasjs_root resolves - settings.md carries ### SASJS_ROOT and the other links in installation.md use the same form).
- docs/settings.md: the
pkg-cache-<pid>folder name, its removal on start, andPKG_NATIVE_CACHE_PATHare behaviours of the executable's packaging runtime, not of anything this repo pins. Nothing here can catch them going stale when the pkg version changes, so name the source of the claim (the module or pkg release the behaviour comes from) or keep the wording to the contract that matters - the directory used and that it is cleaned up - rather than the folder name and the env var override.
1 note above; no blocking issues.
d477f61 to
9f8b06d
Compare
|
Both rounds actioned, current head Round 1 - contract, not implementation. Round 2 - how the sweep decides. It is age, not a pid probe: a running instance refreshes its folder's timestamp hourly, and a start removes a
|
There was a problem hiding this comment.
REVIEWED ON 2026-11-04 14:03 UTC
Reviewed the current diff - two documentation paragraphs, no code, CI still pending on this head.
The SASJS_ROOT addition to docs/settings.md says a start removes leftover tmp folders "belonging to processes that are no longer running", while docs/installation.md only promises removal on exit. If the startup sweep is real, saying how it decides a process is gone (pid file, marker file) would save a reader from assuming the sweep covers a crash - and if it does not exist, the settings.md sentence overstates the behaviour.
Reviewed the diff - no blocking issues found.
sasjs/server#523 moved pkg's extracted-asset cache from `~/.cache/pkg` into `<SASJS_ROOT>/tmp/pkg-cache-<pid>`, removed when the process exits. The `SASJS_ROOT` entry and the standalone-executable section are the two places an operator would look for it.
9f8b06d to
57df2a5
Compare
Follows sasjs/server#536 (issue #523).
A standalone executable used to leave the assets it unpacks in
~/.cache/pkg/tmp-XXXXXX, in the service account's home, on every start that refreshed the drive. That cache now lives in atmpsubfolder ofSASJS_ROOT, is removed when the process exits, and a start clears out folders from earlier runs once they are a day old.Two docs surfaces, because an operator looking for it could arrive at either:
docs/settings.md- theSASJS_ROOTentry now says what thetmpsubfolder is for.docs/installation.md- the standalone-executable section says the same in the place someone reads while installing.Both state the contract only - the folder under
SASJS_ROOT, the cleanup, and the age - rather than the folder's own naming or pkg'sPKG_NATIVE_CACHE_PATH, which belong to the packaging runtime and would go stale with it. No version numbers are named either, so nothing here goes stale with the next release.