53 Commits
Author SHA1 Message Date
NuklearRabbit d47c7b5e41 feat: add safe Gitea sync and signed updates
ForgeFlow quality gate / secret-scan (push) Failing after 32s
ForgeFlow quality gate / quality (push) Failing after 0s
2026-08-27 00:38:58 +02:00
NuklearRabbitandClaude Opus 5 cb9bdcd713 perf: reuse SSH connections per server, with a retry rule that never repeats work
Every ssh.exec opened its own connection: a TCP handshake, a key exchange and an
authentication round trip per command. A key rotation paid for that eight times,
a deployment six, and refreshing M profile states M times.

Connections are now kept per server. The three risks that made this worth doing
carefully are handled explicitly:

- Staleness. A pooled connection can be dead exactly when it matters. Liveness is
  tracked through error, close and end, and a lease that finds a dead entry opens
  a new one. The remaining race, where the connection dies between the check and
  the command, is caught by the retry rule below.
- Retrying. Only a failure that proves the command never reached the server is
  retried, and only once, and only on a connection that was already established
  before this call. execClient marks exactly that case, when the channel fails to
  open. A command that opened a stream is never repeated, because the server may
  already be acting on it - repeating a deployment is not this layer's decision.
  Two tests hold that line: widening the rule to any failure fails both.
- Lifetime. Idle connections close after a minute, the pool is reference counted
  so a shared connection survives until its last user is done, closeAll runs
  during quit, and every pooled client keeps a standing error listener so an
  error while idle cannot reach the uncaughtException handler.

A trust-on-first-use connection is never pooled: it was established without
verifying the fingerprint, so it must not serve a later verified call. A change
to host, port, user, auth type, key path or trusted fingerprint invalidates the
pooled connection.

ssh-service coverage rises from 61% to 90% of lines and 97% of functions.

Also in this commit, the smaller items from the same review:

- Diagnostics batched records that queue up while a write is in flight into one
  append, and chmod runs once per file instead of once per record. At the debug
  level every IPC call writes a line, which is exactly when troubleshooting.
- The set that suppresses duplicate deployment notifications is trimmed instead
  of growing for the lifetime of the process.
- The updater kept the same once('error') pattern on its spawned helper that
  took the app down through the SSH client.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-23 15:06:38 +02:00
NuklearRabbitandClaude Opus 5 beeafdcba7 perf: reuse a deploy-key proof instead of asking the server twice
A key rotation verified the candidate with `git ls-remote`, then immediately ran
preflightCandidate, which threw that result away and ran the same command over a
second SSH connection. Nothing happens between the two calls that could change
the answer, and the proof was already being passed in.

preflightCandidate now uses a proof that established a remote commit and falls
back to verifying when it is handed nothing usable, so it still works as a
standalone gate. Every ssh.exec opens its own connection, so this removes a full
TCP, key exchange and authentication round trip from a rotation.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-23 14:53:53 +02:00
NuklearRabbitandClaude Opus 5 d77643c058 refactor(renderer): move diff rendering into its own module
views.js sat at the project's 750-line limit, so the diff cap in the previous
commit pushed it over and every further change would have meant shaving
comments elsewhere. That is the file asking for decomposition, which is what the
architecture audit says to do.

Diff rendering is self-contained: the line cap, the line classifier and the
change-map illustration depend on nothing in views.js beyond ui and escapeHtml.
They now live in src/renderer/diff-view.js and are registered in index.html and
in the three renderer file lists that scan the bridge surface, so anything added
there is covered by the existing contract tests.

views.js drops from 755 to 714 lines and no source file exceeds 750 again. The
nested ternary that classified a diff line became a named function with guard
clauses on the way.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-23 14:51:31 +02:00
NuklearRabbitandClaude Opus 5 5cecaa080d fix: stop a large diff and a second SSH error from taking the app down
Two failure modes that only show up under conditions the tests never reached.

renderDiff built one span per diff line with no bound. A regenerated lock file
is an ordinary change: 50,000 lines produce 4 MB of markup and 50,000 elements
that then have to be parsed and laid out inside the full shell replacement, and
200,000 lines produce 16 MB. The rendered view now stops at 2,000 lines and says
how many were left out; ui.diff keeps the whole change, so Copy diff, the editor
and hunk staging are unaffected. The line scan also runs once now instead of
three times.

withClient registered the connection error handler with once(). A connection
that fails and then emits a second error while it is being torn down - a reset
during client.end() is the ordinary case - leaves that event unhandled, and an
unhandled 'error' on an EventEmitter reaches the uncaughtException handler,
which calls app.exit(1). The handler stays attached and ignores anything after
the first failure.

Both are covered by tests that were confirmed to fail without the fix, together
with the SSH paths that had none: host key mismatch reporting, the trusted
fingerprint requirement for exec and upload, and remote upload path validation.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-23 14:44:33 +02:00
NuklearRabbitandClaude Opus 5 a5666e95f2 test: cover the deployment and deploy-key paths, and gate coverage per module
deployment-service.cjs sat at 52% and unraid-deploy-key-host.cjs at 39% of its
functions, both hidden behind a healthy aggregate. They are now at 100% lines
and functions, tested through real HTTP endpoints and by intercepting the shell
script the key host sends, rather than by mocking the boundary away.

What is pinned down: a successful workflow run still fails when the server
cannot prove it runs that exact commit; a rollback ends as rolled-back rather
than success; an unreachable status endpoint is never treated as healthy; a
failed poll is recorded on the operation instead of losing it; deploy keys stay
repository-scoped under the server base path with a pinned host key; promotion
verifies the candidate before swapping atomically; and revocation moves key
material to recovery instead of deleting it.

Two assumptions turned out to be wrong and the tests follow the real behaviour:
the previous-SHA check runs before the already-live check, and a rollback
against an unreachable endpoint surfaces the underlying network error.

Covering clone-target exposed a real defect: a remote ending in "....git"
yielded the folder name "...". Windows strips trailing dots, so that resolves
back to the project root itself, past an escape guard that only looks for "..".
A dots-only name now falls back to "repository", consistent with how an empty
name was already handled. As a side effect "." and ".." resolve to a usable
folder instead of raising an error.

Coverage gates: the aggregate moves to 85/85/68, and a new per-module gate
(60 statements, 50 functions, 36 branches) stops a single module from silently
collapsing behind the total. It reuses the data from the first run, so the
suite is not executed twice.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-23 14:32:12 +02:00
NuklearRabbitandClaude Opus 5 9260d35957 fix: repair broken IPC wiring and cut the cost of repository polling
Three handlers referenced a dependency they were never given, which made them
throw a ReferenceError as soon as they ran:

- deployment:preflight for Gitea Actions profiles (`preflight` was passed to
  registerOperationsIpc but not to registerDeploymentIpc)
- Unraid write-access repair (`safeRelativeRemoteFile` was missing from
  createUnraidAccessMethods)
- a dead reference of the same name in unraid-state-methods

no-undef and no-unused-vars were disabled for every file, which is why none of
these were caught. Both are now enabled for src/main and src/shared, where the
dependency graph is explicit. The renderer keeps them off because its functions
are deliberately cross-script globals.

Performance:

- git.status() spawned three processes (rev-parse, status, remote get-url) per
  call. A directory holding its own .git is by definition the work tree root, so
  rev-parse is unnecessary, and the remote URL is cached against the mtime of
  .git/config, including the failure for a repository without that remote.
- git status runs with --no-optional-locks so a read no longer rewrites the
  index. That stops it fighting a concurrent Git command for the index lock, and
  is what makes filesystem watching viable at all.
- One commit issued four `git status` reads; callers that already hold the
  status now pass it on, leaving two.
- The repository monitor is event driven. A watched repository is read on
  filesystem activity, with a 30s safety net for watchers that stop delivering
  and a 1s floor so a busy tree cannot drive a read per event. Repositories that
  cannot be watched keep using the interval. Idle cost for one repository over
  35s: 24 git processes before, 3 after.
- Resolving one repository by name no longer refreshes the whole workspace.
- Concurrent configuration saves share a single write of the latest state.
- Repository discovery follows directory junctions again. The filter that
  skipped them made the realpath cycle guard dead code, and hid any project
  folder reached through a junction.

Renderer:

- render() replaced the whole shell on every poll, discarding focus, caret and
  scroll position while the user was typing. Those are preserved now, and an
  unchanged render leaves the DOM alone entirely.
- The four sections that enhanceRenderedUi() injected after render moved into
  the views, so the rendered markup is the single source of truth.
- The monitor no longer keeps a repository paused forever when it is unlinked
  mid-mutation, scheduleAutoRefresh honours its delay argument, the demo bridges
  no longer block startup, and #app is no longer an aria-live region announcing
  the entire UI on every render.

IPC channel plumbing moved to src/main/ipc/channel.cjs, replacing a module-level
mutable diagnostics singleton with an argument.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-23 14:31:58 +02:00
NuklearRabbit cf1da8a2fa fix(security): add standalone secret-scan job to CI
Had a real dependency-audit gate (npm audit --audit-level=high) but no
secret scan. trufflehog's Action is Docker-based and cannot run on this
repo's existing windows-latest runner (needed for the Windows desktop
app's own browser/quality tests), so this adds it as a separate,
parallel ubuntu-latest job rather than inserting it into the Windows
job where it would break CI - the last gap for this repo to count as
fully-authored.
2026-08-16 14:56:13 +02:00
NuklearRabbit 32ed4fcb5e perf: streamline repository and deployment awareness
ForgeFlow quality gate / quality (push) Canceled after 0s
2026-08-12 15:26:53 +02:00
NuklearRabbit 38e221cbd1 fix: harden repository refresh and server pull
ForgeFlow quality gate / quality (push) Canceled after 0s
2026-08-12 15:05:57 +02:00
NuklearRabbit bffad670ef fix: complete server pull deployment setup
ForgeFlow quality gate / quality (push) Canceled after 0s
2026-08-09 00:43:08 +02:00
NuklearRabbit 4c21616e72 fix: harden deployment discovery and preflight
ForgeFlow quality gate / quality (push) Canceled after 0s
2026-08-08 23:59:27 +02:00
NuklearRabbit f866b12fbf fix: make updater checksum verification self-contained
ForgeFlow quality gate / quality (push) Canceled after 0s
2026-08-01 19:13:05 +02:00
NuklearRabbit f7d6bc374f fix: reconcile server deployments across repository views
ForgeFlow quality gate / quality (push) Canceled after 0s
2026-08-01 18:57:55 +02:00
NuklearRabbit 958d5b84d3 fix: make Windows updater helper launch reliable
ForgeFlow quality gate / quality (push) Canceled after 0s
2026-08-01 17:59:55 +02:00
NuklearRabbit 8fa4891075 chore: release ForgeFlow 0.10.5
ForgeFlow quality gate / quality (push) Canceled after 0s
2026-08-01 17:32:40 +02:00
NuklearRabbit 58d361bbab fix: align deployment links across repository views
ForgeFlow quality gate / quality (push) Canceled after 0s
2026-08-01 17:05:03 +02:00
NuklearRabbit acad1f8932 fix: make packaged updater handshake Windows-safe
ForgeFlow quality gate / quality (push) Canceled after 0s
2026-08-01 15:09:47 +02:00
NuklearRabbit 44aa452a76 fix: tolerate unavailable unsigned signature inspection
ForgeFlow quality gate / quality (push) Canceled after 0s
2026-08-01 14:35:59 +02:00
NuklearRabbit a0435f4316 chore: release ForgeFlow 0.10.3
ForgeFlow quality gate / quality (push) Canceled after 0s
2026-08-01 14:33:08 +02:00
NuklearRabbit 13f4fe7cd0 perf: reduce renderer and repository polling work
ForgeFlow quality gate / quality (push) Canceled after 0s
2026-08-01 14:24:53 +02:00
NuklearRabbit 258f0b1324 fix: restore scrolling and validator enforcement
ForgeFlow quality gate / quality (push) Canceled after 0s
2026-08-01 12:44:31 +02:00
NuklearRabbit f8c505e525 docs: refresh user guide and screenshots
ForgeFlow quality gate / quality (push) Canceled after 0s
2026-07-30 02:02:18 +02:00
NuklearRabbit 398f986d95 fix: repair packaged release downloads
ForgeFlow quality gate / quality (push) Canceled after 0s
2026-07-30 00:58:34 +02:00
NuklearRabbit 60e8aa8fc2 release: prepare ForgeFlow 0.10.1
ForgeFlow quality gate / quality (push) Canceled after 0s
2026-07-30 00:49:58 +02:00
NuklearRabbit 6ef4620388 fix: make packaged updates certificate-free
ForgeFlow quality gate / quality (push) Canceled after 0s
2026-07-29 23:11:24 +02:00
NuklearRabbit 18f42621c2 feat: harden release signing and coverage gate
ForgeFlow quality gate / quality (push) Canceled after 0s
2026-07-29 22:54:51 +02:00
NuklearRabbit aa4895912a docs: record production readiness evidence
ForgeFlow quality gate / quality (push) Canceled after 0s
2026-07-29 20:06:14 +02:00
NuklearRabbit 347f7132b9 test: prove Authenticode release chain 2026-07-29 19:58:35 +02:00
NuklearRabbit e5599f7a5d style: improve deployment card readability 2026-07-29 19:48:11 +02:00
NuklearRabbit c826561c77 test: strengthen safety-critical coverage 2026-07-29 19:40:27 +02:00
NuklearRabbit 0ed202ec95 chore: reduce and document dependency risk 2026-07-29 19:19:20 +02:00
NuklearRabbit dcbd461a92 test: add isolated production acceptance harness 2026-07-29 18:55:44 +02:00
NuklearRabbit 1e86afb7d9 test: add browser acceptance matrix 2026-07-29 18:49:08 +02:00
NuklearRabbit a0733875c4 feat: deliver policy-driven Git Validator 2.0 2026-07-29 18:24:27 +02:00
NuklearRabbit 7b05c953b6 refactor: split renderer ipc and unraid domains 2026-07-29 18:11:07 +02:00
NuklearRabbit 5d3731a853 feat: normalize deployment inventory evidence 2026-07-29 17:39:22 +02:00
NuklearRabbit 6b93391a9b feat: add transactional deploy key lifecycle 2026-07-29 17:20:31 +02:00
NuklearRabbit 64ca267384 fix: pass signature targets without shell interpolation
ForgeFlow quality gate / quality (push) Canceled after 0s
2026-07-29 16:36:46 +02:00
NuklearRabbit 4555023f87 docs: align release and recovery guidance 2026-07-29 16:31:24 +02:00
NuklearRabbit 4708367b66 feat: add fail-closed signed release provenance 2026-07-29 16:30:02 +02:00
NuklearRabbit 8e580a0b13 ci: enforce lint coverage and Node LTS quality gates 2026-07-29 16:27:16 +02:00
NuklearRabbit a7ab2d6cc8 fix: harden responsive accessibility contracts 2026-07-29 16:22:46 +02:00
NuklearRabbit ae6c41ff90 feat: verify server pull access before deployment 2026-07-29 16:17:54 +02:00
NuklearRabbit 430d40354b fix: make server discovery and audits read-only 2026-07-29 16:09:39 +02:00
NuklearRabbit 56efd1a00c feat: harden server pull deployments and git hygiene 2026-07-28 08:27:09 +02:00
NuklearRabbit d4d77c827a updater fixed 2026-07-28 00:03:33 +02:00
NuklearRabbit f990c26014 Update 2026-07-27 23:15:35 +02:00
NuklearRabbit 03c2608a35 docs: use dark product screenshots 2026-07-27 14:35:05 +02:00
NuklearRabbit 82c335ed2b docs: rebuild README around the user workflow 2026-07-27 14:23:47 +02:00
NuklearRabbit 24dde9a031 Release ForgeFlow 0.8.9 Git Validator 2026-07-26 05:24:22 +02:00
NuklearRabbit e888bd2c1c Release ForgeFlow 0.8.8 Gitea asset route fix 2026-07-26 04:50:50 +02:00
NuklearRabbit 40d41f9a32 Release ForgeFlow 0.8.7 automatic server discovery 2026-07-26 04:22:02 +02:00
154 changed files with 23011 additions and 6866 deletions
+38
View File
@@ -0,0 +1,38 @@
name: ForgeFlow quality gate
on:
push:
branches: [main]
pull_request:
jobs:
secret-scan:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Secret scan
uses: trufflesecurity/trufflehog@v3.79.0
with:
path: ./
extra_args: --only-verified
quality:
runs-on: windows-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 22
cache: npm
- run: npm ci
- run: npm run quality
- run: npx playwright install --with-deps chromium
- run: npm run test:browser:ci
- name: Preserve browser failure evidence
if: failure()
uses: actions/upload-artifact@v4
with:
name: forgeflow-browser-failure-evidence
path: artifacts/
if-no-files-found: ignore
- run: npm audit --omit=dev --audit-level=high
+3
View File
@@ -3,4 +3,7 @@ dist/
.DS_Store .DS_Store
*.log *.log
coverage/ coverage/
artifacts/
playwright-report/
.forgeflow/ .forgeflow/
.playwright-mcp/
+1
View File
@@ -0,0 +1 @@
22
+72
View File
@@ -1,5 +1,77 @@
# Changelog # Changelog
## 0.10.0 - 2026-07-28
- Added safe Gitea Server pull with repository-scoped read-only deploy keys and pinned SSH host fingerprints.
- Automatically discovers and links unique running repository workloads while filtering system containers and stale release folders.
- Reconciles live server SHA, Gitea SHA and runtime health, including deployments changed outside ForgeFlow.
- Preserves adopted Compose and DockerMan identity and avoids duplicate repository links.
- Expanded Git Validator with editor, line-ending, dependency-lock and Gitea Actions checks plus reviewable fixes.
- Refined the dark deployment workspace with clearer workload identity, focused inventory and motion-safe illustration.
- Added live connection/deployment audit scripts and kept automatic cleanup of older packaged artifacts.
## 0.9.5 - 2026-07-28
- Added a mandatory remote write-access preflight before every Direct copy deployment and again immediately before upload.
- The preflight reports the exact failing path, SSH user, owner, group and mode instead of allowing a partial copy or Docker activation.
- Added an in-app **Check / fix write access** action on every SSH / Unraid deployment and directly beside failed permission checks.
- The repair is restricted to the linked project source and `.forgeflow` state, assigns the Unraid `users` group where available, preserves executable bits and excludes configured runtime data.
- Explicit permission repair now also normalizes SMB/manual-copy access even when the SSH account is root and could already write.
- Direct copy is fail-closed: candidate Compose configuration and images are validated before live files change; no implicit `down`, `--remove-orphans` or `--force-recreate` is used.
- A failed activation restores the prior source and image tags, attempts to restore the previous runtime and retains rollback evidence for diagnosis.
- Removed orphan deletion from the legacy server deployment helper as well.
## 0.9.4 - 2026-07-28
- Fixed imported deployments failing with `service has neither an image nor a build context` because a stale labels-only metadata overlay introduced a phantom service.
- Existing workloads now activate strictly from their real Compose files; ForgeFlow metadata is stored outside the active Compose model.
- Redeploy always uses `--force-recreate` and verifies every service returned by `docker compose config --services`.
- A deployment is rejected when the container ID did not change or when the previous hinted container remains running beside a duplicate workload.
- Deployment SHA is promoted only after recreation and runtime checks complete.
## 0.9.3 - 2026-07-28
- removed every server-to-repository authentication check and all server-side Git deployment branches from SSH/Unraid deploy and rollback;
- forcibly migrated legacy SSH/Unraid profiles to direct local bundle copy, except explicit monitor-only profiles;
- discovered Compose YAML definitions directly from configured Unraid appdata roots even when Docker inspection fails;
- merged YAML definitions with runtime containers, stopped containers and DockerMan templates;
- automatically linked unique high-confidence Compose folder/project matches and added one-click linking for remaining strong matches with all fields prefilled;
- made inventory failure handling compatible with strict Bash execution, pruned large runtime folders during YAML discovery and normalized user-share/cache/disk appdata paths.
## 0.9.0 - 2026-07-27
- replaced Git-checkout-only discovery with a complete Unraid workload inventory, including stopped, Compose, DockerMan and standalone containers;
- added persistent manual workload linking with repository, deployment mode, Compose project, files and service identity;
- made checksum-verified exact-commit push bundles the default for new SSH/Unraid profiles, so Unraid no longer needs a Gitea key;
- separated desktop-to-Unraid authentication, Docker/Compose capabilities and optional Unraid-to-Gitea access in diagnostics;
- preserved adopted DockerMan templates and disabled aggressive recreate/orphan flags by default;
- promoted deployment state only after Compose validation and service verification, with atomic manifests, rollback restoration and live lock ownership;
- retained server-side Git and monitor-only modes for explicit use cases;
- corrected release publication so source, installer, portable executable and SHA-256 sidecars are published together, with a recovery publisher for source-only Gitea releases.
## 0.8.9 - 2026-07-26
- added a per-repository Git Validator with a weighted assurance score and evidence-backed checks;
- validates Gitea branch governance, repository identity, upstream tracking, effective author identity, safe synchronization defaults, README and gitignore hygiene, tracked secret-shaped files and oversized files;
- provides audited one-click repairs for origin alignment and repository-local safety configuration;
- offers confirmed repairs for default-branch protection and a reviewable uncommitted `.gitignore`;
- introduced a premium, theme-aware and container-responsive Validator workspace with safe-fix batching.
## 0.8.8 - 2026-07-26
- fixed binary update downloads on Gitea servers that require release-scoped attachment routes;
- sends both the immutable release ID and attachment ID when downloading update assets;
- preserves strict same-origin token handling and SHA-256 verification.
## 0.8.7 - 2026-07-26
- automatically inventories running workloads across configured Unraid servers;
- links server Git checkouts to Gitea repositories through exact normalized origins and strong container evidence;
- supports image-only discovery through OCI and ForgeFlow repository/commit labels;
- adopts uniquely matched workloads into Deployments without requiring a prior ForgeFlow release operation;
- verifies every SSH deployment refresh against the current full Gitea branch SHA;
- treats matching commits as in order only while the container is running and healthy, and rejects ambiguous matches.
## 0.8.6 - 2026-07-26 ## 0.8.6 - 2026-07-26
- added contextual animated code maps to unused diff-canvas space; - added contextual animated code maps to unused diff-canvas space;
+15
View File
@@ -0,0 +1,15 @@
@echo off
setlocal
cd /d "%~dp0"
echo ForgeFlow source and binary release publisher
echo.
powershell.exe -NoLogo -NoProfile -ExecutionPolicy Bypass -File "%~dp0Publish-ForgeFlow-Release.ps1"
set "forgeflowExitCode=%ERRORLEVEL%"
echo.
if not "%forgeflowExitCode%"=="0" (
echo Publication failed. The existing ForgeFlow installation was not modified.
) else (
echo Publication completed. The older ForgeFlow updater can now install this release.
)
pause
exit /b %forgeflowExitCode%
+53 -2
View File
@@ -1,7 +1,9 @@
param( param(
[string]$Remote = "git@gitea.itworx.tech:Jens/ForgeFlow.git", [string]$Remote = "git@gitea.itworx.tech:Jens/ForgeFlow.git",
[string]$Branch = "main", [string]$Branch = "main",
[string]$InstalledSource = "C:\Projects\ForgeFlow" [string]$InstalledSource = "C:\Projects\ForgeFlow",
[string]$UserDataPath = "",
[switch]$SkipBinaryRelease
) )
$ErrorActionPreference = "Stop" $ErrorActionPreference = "Stop"
@@ -58,6 +60,51 @@ try {
Write-Host "ForgeFlow $version is available on Gitea at commit $($publishedCommit.Substring(0,7))." -ForegroundColor Green Write-Host "ForgeFlow $version is available on Gitea at commit $($publishedCommit.Substring(0,7))." -ForegroundColor Green
if (-not $SkipBinaryRelease) {
Write-Host "Building and publishing the matching Windows installer and portable release..." -ForegroundColor Cyan
Push-Location $clone
try {
& cmd.exe /d /s /c "npm ci --no-audit --no-fund"
if ($LASTEXITCODE -ne 0) { throw "npm ci failed in the exact published checkout." }
& cmd.exe /d /s /c "npm run check"
if ($LASTEXITCODE -ne 0) { throw "The exact published checkout failed the release quality gate." }
& cmd.exe /d /s /c "npm run dist:win"
if ($LASTEXITCODE -ne 0) { throw "The Windows release build failed." }
$expectedAssets = @(
"ForgeFlow-Setup-$version-win-x64.exe",
"ForgeFlow-Setup-$version-win-x64.exe.sha256",
"ForgeFlow-Portable-$version-win-x64.exe",
"ForgeFlow-Portable-$version-win-x64.exe.sha256",
"ForgeFlow-$version-provenance.json",
"ForgeFlow-$version-sbom.cdx.json",
"ForgeFlow-$version-release-manifest.json",
"ForgeFlow-$version-release-manifest.json.sig"
)
foreach ($assetName in $expectedAssets) {
if (-not (Test-Path -LiteralPath (Join-Path $clone "dist\$assetName"))) {
throw "The Windows build did not produce $assetName."
}
}
$resolvedUserData = if ($UserDataPath) { $UserDataPath } else { Join-Path $env:APPDATA "forgeflow" }
$previousUserData = $env:FORGEFLOW_USER_DATA
$previousBranch = $env:FORGEFLOW_RELEASE_BRANCH
try {
$env:FORGEFLOW_USER_DATA = $resolvedUserData
$env:FORGEFLOW_RELEASE_BRANCH = $Branch
& cmd.exe /d /s /c "npm run release:binary"
if ($LASTEXITCODE -ne 0) { throw "The Gitea binary release publisher failed." }
} finally {
$env:FORGEFLOW_USER_DATA = $previousUserData
$env:FORGEFLOW_RELEASE_BRANCH = $previousBranch
}
} finally { Pop-Location }
Write-Host "ForgeFlow $version source and Windows release assets are both published." -ForegroundColor Green
} else {
Write-Host "Binary publication was skipped explicitly. Packaged ForgeFlow installations cannot auto-update until the release assets are published." -ForegroundColor Yellow
}
$installedManifestPath = Join-Path $InstalledSource "package.json" $installedManifestPath = Join-Path $InstalledSource "package.json"
if (Test-Path -LiteralPath $installedManifestPath) { if (Test-Path -LiteralPath $installedManifestPath) {
try { try {
@@ -123,7 +170,11 @@ try {
Write-Host "Installed source was not found at $InstalledSource; publication itself succeeded." -ForegroundColor Yellow Write-Host "Installed source was not found at $InstalledSource; publication itself succeeded." -ForegroundColor Yellow
} }
Write-Host "Open the installed older ForgeFlow and use Settings -> ForgeFlow updates -> Check now." -ForegroundColor Cyan if ($SkipBinaryRelease) {
Write-Host "Source publication completed. Run Publish-Missing-Binary-Release.ps1 before using the updater from an installed EXE." -ForegroundColor Yellow
} else {
Write-Host "Open the installed older ForgeFlow and use Settings -> ForgeFlow updates -> Check now." -ForegroundColor Cyan
}
} }
finally { finally {
Remove-Item -LiteralPath $temp -Recurse -Force -ErrorAction SilentlyContinue Remove-Item -LiteralPath $temp -Recurse -Force -ErrorAction SilentlyContinue
+116
View File
@@ -0,0 +1,116 @@
param(
[string]$Remote = "git@gitea.itworx.tech:Jens/ForgeFlow.git",
[string]$Branch = "main",
[string]$ExpectedVersion = "0.9.1",
[string]$UserDataPath = ""
)
$ErrorActionPreference = "Stop"
Set-StrictMode -Version Latest
$temp = Join-Path ([IO.Path]::GetTempPath()) ("forgeflow-binary-release-" + [guid]::NewGuid().ToString("N"))
$clone = Join-Path $temp "ForgeFlow"
function Invoke-CheckedCommand {
param(
[Parameter(Mandatory = $true)][string]$Title,
[Parameter(Mandatory = $true)][scriptblock]$Action
)
Write-Host "`n$Title" -ForegroundColor Cyan
& $Action
if ($LASTEXITCODE -ne 0) {
throw "$Title failed with exit code $LASTEXITCODE."
}
}
try {
foreach ($command in @("git", "node", "npm")) {
if (-not (Get-Command $command -ErrorAction SilentlyContinue)) {
throw "Required command '$command' was not found on PATH."
}
}
New-Item -ItemType Directory -Force -Path $temp | Out-Null
Invoke-CheckedCommand "Cloning the exact published ForgeFlow source..." {
& git clone --branch $Branch --single-branch $Remote $clone
}
$manifestPath = Join-Path $clone "package.json"
if (-not (Test-Path -LiteralPath $manifestPath)) {
throw "The cloned repository does not contain package.json."
}
$manifest = Get-Content -LiteralPath $manifestPath -Raw | ConvertFrom-Json
if ($manifest.name -ne "forgeflow") {
throw "The cloned repository is not ForgeFlow."
}
$version = [string]$manifest.version
if ($ExpectedVersion -and $version -ne $ExpectedVersion) {
throw "Gitea branch '$Branch' contains ForgeFlow $version, not the expected $ExpectedVersion."
}
$localCommit = (& git -C $clone rev-parse HEAD).Trim()
$remoteLines = @(& git -C $clone ls-remote origin "refs/heads/$Branch")
if ($LASTEXITCODE -ne 0 -or $remoteLines.Count -lt 1) {
throw "Could not verify origin/$Branch."
}
$remoteCommit = ($remoteLines[0] -split "`t")[0].Trim()
if ($localCommit -ne $remoteCommit) {
throw "The temporary checkout is not the current origin/$Branch commit."
}
Push-Location $clone
try {
Invoke-CheckedCommand "Installing exact dependencies..." {
& cmd.exe /d /s /c "npm ci --no-audit --no-fund"
}
Invoke-CheckedCommand "Running the complete ForgeFlow quality gate..." {
& cmd.exe /d /s /c "npm run check"
}
Invoke-CheckedCommand "Building installer and portable Windows assets..." {
& cmd.exe /d /s /c "npm run dist:win"
}
$expectedAssets = @(
"ForgeFlow-Setup-$version-win-x64.exe",
"ForgeFlow-Setup-$version-win-x64.exe.sha256",
"ForgeFlow-Portable-$version-win-x64.exe",
"ForgeFlow-Portable-$version-win-x64.exe.sha256",
"ForgeFlow-$version-provenance.json",
"ForgeFlow-$version-sbom.cdx.json",
"ForgeFlow-$version-release-manifest.json",
"ForgeFlow-$version-release-manifest.json.sig"
)
foreach ($assetName in $expectedAssets) {
$assetPath = Join-Path $clone "dist\$assetName"
if (-not (Test-Path -LiteralPath $assetPath)) {
throw "The build did not produce $assetName."
}
}
$resolvedUserData = if ($UserDataPath) { $UserDataPath } else { Join-Path $env:APPDATA "forgeflow" }
$configPath = Join-Path $resolvedUserData "forgeflow-config.json"
if (-not (Test-Path -LiteralPath $configPath)) {
throw "ForgeFlow configuration was not found at $configPath. Open ForgeFlow and sign in to Gitea once, then run this script again."
}
$previousUserData = $env:FORGEFLOW_USER_DATA
$previousBranch = $env:FORGEFLOW_RELEASE_BRANCH
try {
$env:FORGEFLOW_USER_DATA = $resolvedUserData
$env:FORGEFLOW_RELEASE_BRANCH = $Branch
Invoke-CheckedCommand "Creating the Gitea release and uploading all four assets..." {
& cmd.exe /d /s /c "npm run release:binary"
}
} finally {
$env:FORGEFLOW_USER_DATA = $previousUserData
$env:FORGEFLOW_RELEASE_BRANCH = $previousBranch
}
} finally {
Pop-Location
}
Write-Host "`nForgeFlow $version now has a published binary release for commit $($localCommit.Substring(0,7))." -ForegroundColor Green
Write-Host "Return to ForgeFlow $ExpectedVersion's predecessor and choose Check now -> Download update -> Apply & restart." -ForegroundColor Green
}
finally {
Remove-Item -LiteralPath $temp -Recurse -Force -ErrorAction SilentlyContinue
}
+128 -306
View File
@@ -1,363 +1,185 @@
# ForgeFlow # ForgeFlow
ForgeFlow 0.8 adds partial-hunk commits, guided conflict recovery, Gitea pull **Van lokale wijziging naar aantoonbaar juiste serverversie — zonder de Git- en deploymentcontext over verschillende tools te verspreiden.**
requests and protected-branch awareness, configurable editor/terminal actions,
deployment policies and release notes, append-only audit export, encrypted
configuration backup, native tray/notifications and a guarded end-to-end
acceptance harness.
## Publish this release to the built-in updater repository ForgeFlow is een Windows-desktopapp voor wie Git, Gitea en eigen Docker- of Unraid-servers gebruikt. Je ziet in één werkruimte wat lokaal gewijzigd is, wat op Gitea staat en welke exacte commit op de server draait. ForgeFlow begeleidt je daarna veilig door review, commit, push, deployment en verificatie.
Extract the full source ZIP to a folder under Downloads and run: > Huidige release: **0.10.13** · [download de laatste Windows-release](https://gitea.itworx.tech/Jens/ForgeFlow/releases/latest)
![ForgeFlow release-overzicht](docs/screenshots/overview.png)
## Wat ForgeFlow voor je oplost
- **Eén duidelijke actielijst:** zie meteen welke repository aandacht nodig heeft en waarom.
- **Veilige Git-flow:** review wijzigingen, stage volledige bestanden of afzonderlijke hunks, commit, push en herstel conflicten zonder contextwissel.
- **Veilige Gitea-sync:** bekijk vooraf welke bestanden wijzigen of verdwijnen, bewaar lokale commits in een recovery branch en zet gewijzigde of untracked bestanden in een stash voordat de werkmap exact gelijk wordt gemaakt aan Gitea.
- **Deployment op een exacte commit:** ForgeFlow gebruikt volledige commit-SHA's en toont lokaal, Gitea en server naast elkaar.
- **Automatische serverinventaris:** ForgeFlow herkent draaiende en gestopte Docker-, Compose- en DockerMan-workloads, koppelt alleen op betrouwbaar bewijs en houdt tijdelijke of externe containers apart.
- **Veilige server-pull:** Unraid haalt de exacte commit uit Gitea met een unieke, repository-scoped read-only deploy key en een vastgepinde SSH-hostsleutel.
- **Ingebouwde Git Validator:** controleer repository-identiteit, branch protection, synchronisatie-instellingen, documentatie, geheimen en grote bestanden; veilige verbeteringen kunnen gericht worden toegepast.
- **Lokale controle:** configuratie en credentials blijven op het toestel en diagnostische exports worden lokaal geredigeerd.
## Snel starten
### Aanbevolen: de Windows-app installeren
1. Open de [laatste ForgeFlow-release](https://gitea.itworx.tech/Jens/ForgeFlow/releases/latest).
2. Download de Windows-installer of portable executable.
3. Start ForgeFlow en doorloop de setupwizard.
4. Voeg je Gitea-server, token en lokale projectmappen toe.
5. Voeg optioneel een Docker- of Unraid-server toe. Start daarna **Scan servers** om bestaande deployments te ontdekken en veilig aan repositories te koppelen.
Vanuit **Settings → Updates** kun je nieuwe packaged releases ophalen. ForgeFlow accepteert uitsluitend de release die bij de exacte Gitea-commit hoort, controleert de SHA-256-checksum én verifieert vanaf 0.10.13 een onafhankelijk Ed25519-releasemanifest met de ingebouwde publieke sleutel. Zie [UPDATING.md](docs/UPDATING.md) voor oudere of source-only installaties.
### Eerst vrijblijvend bekijken
De interactieve demomodus gebruikt uitsluitend representatieve voorbeelddata en maakt geen verbinding met Git, Gitea of een server:
```powershell ```powershell
Set-ExecutionPolicy -Scope Process Bypass npm install
.\Publish-ForgeFlow-Release.ps1 npm run demo
``` ```
The script runs the complete quality gate, clones `git@gitea.itworx.tech:Jens/ForgeFlow.git` into a temporary folder, mirrors the verified source without `.git`, `node_modules` or release ZIPs, commits it on `main` and pushes it. A running older ForgeFlow source installation can then update through **Settings → Updates**. Open daarna `http://127.0.0.1:41737`.
## De dagelijkse workflow
### 1. Begin bij wat aandacht vraagt
ForgeFlow is a desktop release cockpit that turns the complete path from a local Het release-overzicht vertaalt technische status naar concrete acties: wijzigingen reviewen, commits pushen, synchroniseren, deployen of een ongezonde omgeving onderzoeken. De repositorylijst blijft beschikbaar zodat je snel van context kunt wisselen.
code change to a verified server deployment into one guided flow:
```text ### 2. Review en publiceer code
Local working tree -> Gitea repository -> exact deployed server version
```
It is not an IDE and it does not replace Gitea Actions. ForgeFlow coordinates ![Repositorywerkruimte met diff en volgende actie](docs/screenshots/repository-workspace.png)
local Git, a private Gitea instance and fixed deployment workflows while keeping
credentials on the user's own computer.
![ForgeFlow overview](docs/screenshots/overview.png) In de repositorywerkruimte zie je de volledige keten **Local → Gitea → Server**. Je kunt wijzigingen selecteren, diffs bekijken, gedeeltelijke hunk-staging behouden, branch protection controleren en een pull request openen. Destructieve of publicerende acties vereisen altijd expliciete bevestiging.
## Current status: v0.6.0 self-healing Git and Unraid operations ### 3. Deploy en verifieer de live versie
### Git recovery and repository truth ![Deploymentsoverzicht met herkenbare containerkaarten](docs/screenshots/deployments.png)
- serializes every mutating Git action per repository; Elke deploymentkaart benoemt repository, container, omgeving, uitvoeringsmethode, live commit, Gitea-commit, vorige versie en healthstatus. Zo blijven ook tientallen containers visueel van elkaar te onderscheiden. ForgeFlow ondersteunt gecontroleerde deployments via Gitea Actions en SSH/Unraid, met preflightcontrole en rollback waar beschikbaar.
- waits through a short grace period and automatically retries after safely removing a proven stale lock;
- detects `HEAD.lock`, `index.lock`, ref locks and worktree locks while skipping object storage;
- provides repository-specific actions for fetch, fast-forward, push and backed-up divergence reset;
- creates a `forgeflow/backup-*` safety branch before any reset to upstream.
### SSH / Unraid and DockerMan Bij server discovery vergelijkt ForgeFlow runtime-, Compose-, DockerMan- en Git-bewijs met Gitea. Exact bewezen matches worden automatisch gekoppeld; kandidaten, historische mappen en externe containers worden niet als productie-deployment geforceerd. Een exacte overeenkomst tussen de volledige live SHA en de actuele Gitea-SHA wordt als gelijklopende versie weergegeven. Ontbreekt de live SHA, dan meldt ForgeFlow eerlijk dat verificatie nog onvolledig is.
- reconciles interrupted deployments against the live SHA, container state and health; De belangrijkste statussen zijn:
- applies DockerMan WebUI, icon and shell labels through an override and writes a persistent XML template fallback;
- keeps the visible container name such as `Portfolio` while enforcing lowercase internal service/image identities;
- includes a built-in high-contrast ITWorx icon, local PNG upload, persistent DockerMan image storage and cache refresh;
- exposes **Open Web UI**, **Repair DockerMan integration** and **Reconcile** directly on deployment cards.
### Update reliability | Status | Wat je ermee doet |
| --- | --- |
| **Ready** | De repository, servertoegang, live commit en runtime zijn geverifieerd. |
| **Commit mismatch** | De workload is correct gekoppeld, maar Gitea en de server draaien niet dezelfde commit. |
| **Verification incomplete** | De koppeling bestaat, maar de server bevat nog onvoldoende commitbewijs. Een ForgeFlow-beheerde deployment vult dit veilig aan. |
| **Access failed** | Controleer of herstel de repositorygebonden read-only deploy key voordat je deployt. |
- confirms the external updater handshake before closing ForgeFlow; ### 4. Verbeter de repository met Git Validator
- rejects malformed PowerShell update helpers before publication;
- validates the replacement source and keeps rollback/success status for the next launch;
- verifies that Gitea reports the exact published release commit.
Read [SSH / Unraid deployment](docs/SSH_UNRAID_DEPLOYMENT.md) and the ![Git Validator met assurance score en veilige fixes](docs/screenshots/git-validator.png)
[LumaOps audit](docs/LUMAOPS_SERVER_AUDIT.md).
### v0.4.2 automatic clone workflow Git Validator groepeert bevindingen per onderwerp en maakt onderscheid tussen geslaagde controles, aanbevelingen en kritieke problemen. Alleen fixes die ForgeFlow veilig en voorspelbaar kan uitvoeren worden als automatische actie aangeboden; governancewijzigingen zoals branch protection blijven zichtbaar en expliciet.
**Clone from Gitea** now uses the first configured project root and creates the ## Wanneer is een release werkelijk in orde?
repository-named subfolder automatically. The native folder picker is reserved
for the explicit **Choose another location** action. Existing matching checkouts
are linked; conflicting folders are never overwritten.
The Windows environment doctor retains the v0.3.1 npm command-shim correction. ForgeFlow houdt drie soorten waarheid bewust apart:
Version 0.3.2 is designed so the user does not need to give a developer any | Controle | Betekenis |
Gitea token, SSH key, server password or other credential. The application now | --- | --- |
includes: | **Local ↔ Gitea** | De lokale branch volgt de juiste upstream en is niet onverwacht ahead, behind of divergent. |
| **Gitea ↔ Server** | De volledige commit-SHA op de server is exact gelijk aan de relevante commit op Gitea. |
| **Runtime health** | De container of applicatie draait en de geconfigureerde healthcheck slaagt. |
- a five-step setup wizard; Een gelijke commit bewijst welke code draait; een geslaagde healthcheck bewijst dat die versie ook functioneert. ForgeFlow combineert beide signalen zonder het ene voor het andere te laten doorgaan.
- computer, Gitea and deployment preflights;
- protected local token entry;
- structured local diagnostics with aggressive secret redaction;
- standard and strict privacy support bundles;
- fail-closed bundle safety auditing;
- request IDs that correlate desktop, Actions and server events;
- root-owned allowlisted server target configuration;
- a complete setup guide from fresh checkout to first rollback test.
Start with [START_HERE.md](START_HERE.md). The full installation and acceptance ## Belangrijkste functies
procedure is in [docs/SETUP_GUIDE.md](docs/SETUP_GUIDE.md).
## What ForgeFlow can do ### Git en Gitea
### Repository workflow - repositories ontdekken, favorieten beheren en ontbrekende lokale clones koppelen;
- status, diff, staging, partial hunks, commit, push, fetch, pull, stash en conflict recovery;
- read-only achtergrondfetch en een expliciete preview om een lokale projectmap veilig exact met de upstream Gitea-branch te synchroniseren;
- branches maken, wisselen, vergelijken en opruimen;
- branch protection controleren en pull requests openen;
- Git Validator met assurance score, bewijs per controle en gerichte veilige fixes.
- Connect to a private Gitea instance and validate the account locally. ### Deployments
- Discover Git working trees beneath one or more project roots.
- Use the first project root as the automatic clone destination.
- Match local folders to Gitea repositories using normalized `origin` identity.
- Link existing repositories or clone directly into the default project root.
- Read real Git status through porcelain v2 and NUL-delimited output.
- Inspect diffs and select files.
- Stage and unstage changes.
- Commit locally or commit and push in one action.
- Push, fetch and use fast-forward-only pull.
- Review recent history.
- Create, switch and publish branches.
- Stash, list and restore local work.
- Mark favorites and prioritize repositories requiring attention.
- Refresh repository state automatically while the application is open.
### Deployment workflow - deploymentprofielen per repository en omgeving;
- Gitea Actions en SSH/Unraid als gecontroleerde uitvoeringsroutes;
- serverinventaris van draaiende en gestopte Docker-, Compose- en DockerMan-workloads;
- automatische koppeling op exact bewijs, expliciete review voor echte twijfelgevallen en herkenning van tijdelijke, historische en externe workloads;
- server-pull als aanbevolen route, met een afzonderlijke read-only deploy key per repository;
- directe checksum-gecontroleerde copy als alternatief zonder servertoegang tot Gitea;
- reconciliatie van deployments die buiten ForgeFlow werden bijgewerkt, op basis van de actuele Gitea- en serverwaarheid;
- verificatie op volledige SHA, runtime health en recente serverwaarheid;
- preflight, live logs, deploymenthistoriek en rollback naar de vorige bekende versie.
- Configure multiple environments per repository. ### Veiligheid en beheer
- Bind each environment to a fixed branch and fixed Gitea Actions workflows.
- Run a visible deployment preflight before confirmation.
- Re-run mandatory checks in the privileged backend before dispatch.
- Verify a clean tree, correct branch, upstream and ahead/behind state.
- Verify that the exact full SHA exists on the allowed remote branch.
- Verify local and remote workflow files and Gitea Actions availability.
- Dispatch a unique request ID with the exact commit SHA.
- Poll Gitea Actions runs and jobs.
- Correlate the workflow with the server status endpoint.
- Verify that the requested SHA is actually live.
- Run an independent application healthcheck.
- Roll back through a separate fixed workflow to the previous exact SHA.
- Preserve a bounded local operation history.
### Safe diagnostics - credentials versleuteld via de beveiligde opslag van het besturingssysteem;
- origin-checks voorkomen dat een Gitea-token naar een andere host wordt gestuurd;
- updatepakketten worden alleen vanaf de geconfigureerde Gitea-origin gedownload en met checksums plus een vastgepinde Ed25519-publisherhandtekening geverifieerd;
- lokale redactie van tokens, wachtwoorden en gevoelige diagnostische data;
- versleutelde configuratieback-up, herstelvoorbeeld en lokale audittrail;
- packaged builds als Windows-installer en portable executable.
ForgeFlow stores structured JSONL diagnostics in the application-data folder. Meer achtergrond staat in [SECURITY.md](docs/SECURITY.md) en [ARCHITECTURE.md](docs/ARCHITECTURE.md).
They are intended to make development and troubleshooting possible without
requesting credentials.
The logger records useful operational facts such as: ## Eerste configuratie
- timestamps, stable event names and duration; Voor normaal gebruik heb je nodig:
- Git action outcomes and repository state;
- Gitea endpoint paths and HTTP status, but not authorization headers;
- deployment request IDs, workflow stages and health states;
- preflight results;
- sanitized error names, codes, messages and stacks.
It excludes or redacts: - Windows 10 of 11;
- Git op het toestel;
- toegang tot een Gitea-account en een token met de benodigde repositoryrechten;
- minstens één lokale hoofdmap waarin ForgeFlow projecten mag ontdekken.
- Gitea tokens and encrypted token blobs; Voor serverdetectie en SSH-deployments heb je daarnaast een bereikbare Docker- of Unraid-host en een werkende SSH-configuratie nodig. Begin bij:
- passwords, authorization headers and credential-bearing URLs;
- private keys and common token patterns;
- arbitrary environment-variable dumps;
- local source contents and Git diffs;
- raw Gitea runner logs from support bundles;
- user-home paths.
Support bundles are audited before writing. If a known runtime secret, private - [SETUP_GUIDE.md](docs/SETUP_GUIDE.md) — Gitea, projectmappen en eerste ingebruikname;
key marker or URL credential remains, ForgeFlow aborts the export instead of - [DEPLOYMENT_SETUP.md](docs/DEPLOYMENT_SETUP.md) — deploymentprofielen en verificatie;
creating the ZIP. Strict privacy mode also hashes repository and user - [SSH_UNRAID_DEPLOYMENT.md](docs/SSH_UNRAID_DEPLOYMENT.md) — SSH- en Unraid-vereisten;
identifiers while keeping related events correlatable. - [DIAGNOSTICS.md](docs/DIAGNOSTICS.md) — veilige controles en supportbundels.
Read [docs/DIAGNOSTICS.md](docs/DIAGNOSTICS.md) for the exact policy and its ## Ontwikkelen vanuit de broncode
limitations.
## Security model Vereisten: Node.js 22, npm en Git.
- Electron main/preload/renderer separation.
- Sandboxed renderer with context isolation and no direct Node.js access.
- Narrow, frozen preload API.
- Trusted renderer-origin checks on privileged IPC.
- No arbitrary shell command field in the interface.
- Gitea token stored using Electron `safeStorage` when available.
- Blank token updates preserve the existing protected token.
- Atomic local configuration writes and schema migration.
- Repository-relative path validation for file actions.
- Supported-protocol and credential-in-URL validation.
- Fixed workflow, branch and environment allowlists.
- Root-owned server target configuration.
- Exact-SHA deployment and rollback.
- Server-side locking, health validation and status records.
- Local diagnostic retention, rotation and clear/export controls.
More detail is available in [docs/SECURITY.md](docs/SECURITY.md).
## Prerequisites
For a Windows source setup:
- Windows 10 or 11;
- Node.js 22 or newer;
- npm;
- Git on `PATH`;
- a normal signed-in desktop session;
- access to your own Gitea instance.
For deployment:
- Gitea Actions enabled;
- a trusted Gitea runner with an environment-specific label;
- a Linux target server reachable by that runner;
- Git, Docker Compose, `curl` and `flock` on the target server;
- an existing non-interactive server checkout of the application.
## Fastest Windows start
Extract the release, open PowerShell in the folder and run:
```powershell ```powershell
Set-ExecutionPolicy -Scope Process Bypass npm ci
.\setup-windows.ps1
```
The script:
1. checks Node.js, npm and Git;
2. installs the exact dependency versions from `package-lock.json` when present;
3. runs the environment doctor;
4. validates the source tree;
5. runs all automated tests;
6. starts ForgeFlow.
No Gitea or server credential is requested by the PowerShell script. Tokens are
entered later in the local desktop wizard.
Manual equivalent:
```bash
npm install --no-audit --no-fund
npm run doctor
npm run check npm run check
npm start npm start
``` ```
## Setup and first acceptance test Handige opdrachten:
Follow these documents in order: | Opdracht | Doel |
| --- | --- |
| `npm run dev` | Start Electron in ontwikkelmodus. |
| `npm run demo` | Start de browserdemo met voorbeelddata. |
| `npm run check` | Voert bronverificatie en de volledige testset uit. |
| `npm run doctor` | Controleert de lokale ontwikkelomgeving. |
| `npm run acceptance` | Voert de release-acceptatiecontroles uit. |
| `npm run signing:setup` | Maakt eenmalig de lokale Ed25519-releasesleutel en schrijft alleen de publieke sleutel naar het project. |
| `npm run dist:win` | Bouwt Windows installer + portable package, schrijft checksums en een ondertekend releasemanifest en ruimt oude dist-artifacts op. |
| `.\Publish-ForgeFlow-Release.ps1` | Publiceert broncode én de bijbehorende Windows-release-assets als één gecontroleerde release. |
| `.\Publish-Missing-Binary-Release.ps1` | Herstelt een reeds gepushte versie waarvoor de Gitea binary release ontbreekt. |
1. [START_HERE.md](START_HERE.md) De belangrijkste onderdelen zijn:
2. [docs/SETUP_GUIDE.md](docs/SETUP_GUIDE.md)
3. [docs/UPDATING.md](docs/UPDATING.md)
4. [docs/DEPLOYMENT_SETUP.md](docs/DEPLOYMENT_SETUP.md)
5. [docs/STATUS_ENDPOINT.md](docs/STATUS_ENDPOINT.md)
6. [docs/DIAGNOSTICS.md](docs/DIAGNOSTICS.md)
The recommended first test uses a non-critical staging deployment and validates:
```text ```text
preflight -> commit -> push -> deploy -> Actions -> server SHA -> healthcheck -> rollback electron/ beveiligde desktopintegraties en IPC
src/ renderer, gebruikersflows en visuele componenten
scripts/ build-, release-, demo- en verificatiehulpmiddelen
tests/ unit- en integratietests
docs/ setup, deployment, beveiliging en release-informatie
``` ```
## Updating an existing source installation Aanvullende kwaliteitsdocumentatie:
Close ForgeFlow, copy the v0.4.2 update overlay over the existing source folder - [TEST_MATRIX.md](docs/TEST_MATRIX.md)
and run: - [ACCEPTANCE.md](docs/ACCEPTANCE.md)
- [STATUS_ENDPOINT.md](docs/STATUS_ENDPOINT.md)
- [ROADMAP.md](docs/ROADMAP.md)
```powershell ## Licentie
Set-ExecutionPolicy -Scope Process Bypass
.\update-windows.ps1
```
Application configuration and protected credentials are stored outside the ForgeFlow is beschikbaar onder de [MIT-licentie](LICENSE).
source folder and are not reset. See [docs/UPDATING.md](docs/UPDATING.md).
## Browser demo
The standalone visual demo requires no Gitea connection or credentials:
```bash
npm run demo
```
Open the printed local URL. The demo uses `src/renderer/mock-bridge.js`; the
packaged desktop application uses the privileged `preload.cjs` bridge.
## Quality checks
```bash
npm run verify
npm test
npm run check
npm run doctor -- --json
```
Version 0.3.2 contains 45 automated tests. Two integration suites create real
temporary bare Git remotes and exercise commit, push, branch, stash and exact
remote-SHA behavior. Detailed coverage is listed in
[docs/TEST_MATRIX.md](docs/TEST_MATRIX.md).
## Development packages
```bash
npm run dist:win
npm run dist:linux
npm run dist:mac
```
Windows users can run:
```powershell
.\build-windows.ps1
```
These commands create unsigned development packages. Public distribution still
requires platform code signing and platform-specific release acceptance.
## Server-side deployment model
ForgeFlow never sends a free-form deployment command. It dispatches a fixed
workflow with controlled inputs:
```json
{
"ref": "main",
"inputs": {
"environment": "staging",
"commit_sha": "0123456789abcdef0123456789abcdef01234567",
"request_id": "generated-by-forgeflow"
}
}
```
The workflow calls a root-owned allowlisted server script. Deployment targets
are defined in `/etc/forgeflow/targets.conf`, not supplied by the desktop app.
The server checks repository, environment, paths, branch, exact remote ancestry,
locking, Docker Compose result and health before it updates the public status
JSON.
## Project structure
```text
main.cjs Electron lifecycle and service composition
preload.cjs Whitelisted renderer API and event bridge
src/main/config-store.cjs State, migration and protected token storage
src/main/git-service.cjs Real Git CLI adapter
src/main/gitea-service.cjs Gitea REST and Actions adapter
src/main/repository-service.cjs Discovery, matching and repository aggregation
src/main/repository-monitor.cjs Background working-tree awareness
src/main/deployment-service.cjs Dispatch, polling, SHA checks and rollback
src/main/preflight-service.cjs Computer and deployment readiness checks
src/main/diagnostics-service.cjs Safe JSONL diagnostics and support bundles
src/main/log-redaction.cjs Recursive secret and privacy sanitizer
src/main/ipc.cjs Validated privileged operation boundary
src/shared/clone-target.cjs Safe automatic clone target planning
src/shared/zip-writer.cjs Dependency-free diagnostic ZIP writer
src/renderer/ Desktop UI and browser demo
examples/gitea-actions/ Fixed deploy and rollback workflow templates
examples/server/ Allowlisted Linux deployment implementation
tests/ Unit and real Git integration tests
docs/ Setup, diagnostics, security and architecture
```
## Scope and remaining acceptance
The v0.4.2 logic is prepared for self-service configuration and testing, but no
source release can prove compatibility with a private environment it has never
connected to. The remaining acceptance is deliberately local to the user:
- validate the exact Gitea version and Actions API;
- validate the runner label and runner permissions;
- adapt one target line in the root-owned server configuration;
- verify the application-specific Docker Compose and health endpoint;
- execute the documented staging deployment and rollback test;
- export a Strict support bundle if a failure occurs.
No credential needs to be shared for that process.
## License
MIT. See [LICENSE](LICENSE).
+159 -58
View File
@@ -1,7 +1,14 @@
ForgeFlow 0.8.6 source manifest ForgeFlow 0.10.13 source manifest
SHA-256 BYTES PATH SHA-256 BYTES PATH
(The manifest excludes itself, dependencies and generated release artifacts.) (The manifest excludes itself, dependencies and generated release artifacts.)
755f4db7d76bfec0963ef051748a82810c0d58acd4ffd823aa6928a5167fceb4 58 .gitignore 61f37822ae5502219a38b2eaf23fdcb611875f0e675efb4abe6157c9f072c0cc 937 .gitea/workflows/quality.yml
4a9e8a955ad8c9fa7ba3f8f89cf9920ac1d28c6e5b344782e12d02c3b0fab1ee 105 .gitignore
f14b4987904bcb5814e4459a057ed4d20f58a633152288a761214dcd28780b56 3 .nvmrc
d0b1bd421359311871224f9fa1cff5a802000933668017d9e42e5190f8d2d8e5 152 .playwright-mcp/page-2026-07-29T17-41-03-014Z.yml
528fe408ad4b49c621dd57dd831cecf7ec00b8865069f6ed3b80fefc2e0b7823 8267 .playwright-mcp/page-2026-07-29T17-41-26-269Z.yml
804c6dac953c5094671784919ff35ebda756306a04ef34fe01cd7cf7cd50b2dc 16909 .playwright-mcp/page-2026-07-29T17-41-46-590Z.yml
0f17fdea98e15ebcf7f3ed356d31b0fc89be62f7bc1d25b26c8a41e4b5deca68 160 .playwright-mcp/page-2026-07-29T17-47-10-112Z.yml
5f348bcf74baa845958884bd2258e1ce4121d386c945777b0e80912602e5b5f6 17227 .playwright-mcp/page-2026-07-29T17-47-19-366Z.yml
89545860bd6f7566da81edc8328cd2a1ebf33e81a4b0dcf2cec74338c05e8cac 1753 build-windows.ps1 89545860bd6f7566da81edc8328cd2a1ebf33e81a4b0dcf2cec74338c05e8cac 1753 build-windows.ps1
0970821475a4452aa19e447e9397a95db836791f16890a1a83fd748ac033dc86 8830 build/icon-128.png 0970821475a4452aa19e447e9397a95db836791f16890a1a83fd748ac033dc86 8830 build/icon-128.png
09112c1425ca953d8dd8b2bcfd221e5a84b9f81752f7168f360e295030cbc8f2 521 build/icon-16.png 09112c1425ca953d8dd8b2bcfd221e5a84b9f81752f7168f360e295030cbc8f2 521 build/icon-16.png
@@ -12,13 +19,34 @@ ca32a76e708d565c4af659f0f4d2615fc32114c3f75aec1454862a3ed1e72c41 2263
4633990a4b055bb3d00fef915ee29e85be5ee8413f809334728ad9688973c183 3364 build/icon-64.png 4633990a4b055bb3d00fef915ee29e85be5ee8413f809334728ad9688973c183 3364 build/icon-64.png
25048ed854e8ce8fece115e555c98d25507b002f8019b6ae717b54604c868c50 46223 build/icon.ico 25048ed854e8ce8fece115e555c98d25507b002f8019b6ae717b54604c868c50 46223 build/icon.ico
16efd2fca83004f781eae40ae0f706a004ce0bddf338dd087b8adf7eb10c1d84 85704 build/icon.png 16efd2fca83004f781eae40ae0f706a004ce0bddf338dd087b8adf7eb10c1d84 85704 build/icon.png
d73523f71016ac34bcf227d0222c9008fbd9c6489e2711dd3ad1da37de796369 9665 CHANGELOG.md 164c059453a5737110b4e5e98b6211650c757f0aff710f8f7523ffe0ff1815d7 113 build/update-signing-public.pem
21cb96e7afe71b1dc791c818dedd244d92f9a6ed4d9ffbb3022ccb187e1bdf0f 852 docs/ACCEPTANCE.md 5f4aca19a35cbcaffa1a6993ce96b7d66052ec2b286022f2af74594e8a310568 15712 CHANGELOG.md
c612fcc44ff222db0c9a4cfd11a4076fafe080e4ada31e689a08739a4f14e74f 1650 docs/ACCEPTANCE.md
a17f95d96d3c9fbc69d870874e6fbb7472091adefc454b24f835db1279511d72 8296 docs/ARCHITECTURE.md a17f95d96d3c9fbc69d870874e6fbb7472091adefc454b24f835db1279511d72 8296 docs/ARCHITECTURE.md
e05458ee2696e3c57e2475bb42ae1f914f6a36e01768d7a26a3199f1fffed490 1157 docs/COVERAGE_POLICY.md
9eb9eec82518c0bfc7686f5faaf690a93ed63c71d35f1dc5a2c5ec5199da652a 3124 docs/CURRENT_STATE.md
8ea655d1912ac2e17f8834e33a566a8b14461b396ec4268c396ca189a1749b94 2205 docs/DEPENDENCY_AUDIT.md
30a92bcf5daadb019efa2f82cb820ea302490dd1d68fb772674dc3faccd3e594 2045 docs/DEPLOYMENT_SETUP.md 30a92bcf5daadb019efa2f82cb820ea302490dd1d68fb772674dc3faccd3e594 2045 docs/DEPLOYMENT_SETUP.md
eb42f979666e05d51c587e4223282914926a2b9b1ade9f3fb75525019ce7f738 4616 docs/DIAGNOSTICS.md eb42f979666e05d51c587e4223282914926a2b9b1ade9f3fb75525019ce7f738 4616 docs/DIAGNOSTICS.md
1d8aa3c688a9d330b9a5303b09e9e3049c50bf04f97807c7ff659607baa34c32 1464 docs/ERROR_CODES.md
a0cd06a96f23a94e118feb012be0fa1ac51345951cb2ba8e67fb8c889c4c342a 5007 docs/LUMAOPS_SERVER_AUDIT.md a0cd06a96f23a94e118feb012be0fa1ac51345951cb2ba8e67fb8c889c4c342a 5007 docs/LUMAOPS_SERVER_AUDIT.md
648dd6bca6b45668fb86eb3e1f6c5898dd8da0291b990f1bb5105cfd79421343 1301 docs/MUTATION_MODEL.md
8dc95f69e6f6c8415702c8e79fb6b466c4d60061afded9140450e7e558eaefe5 3704 docs/PRODUCTION_READINESS_1.0.md
f79908fb3dad98c38030c6e6be7c79a1999e0478ed9c2496923891954438daa1 4581 docs/RELEASE_AUDIT_0.6.0.md f79908fb3dad98c38030c6e6be7c79a1999e0478ed9c2496923891954438daa1 4581 docs/RELEASE_AUDIT_0.6.0.md
979a0b8e129979be6b265e8571d0a3c1e9ddd4ddb6b0bf55ae748d3478e51854 2296 docs/RELEASE_NOTES_0.10.0.md
0eb44bda2209a5979a6ac693ac4cd4d235c0015031e54b9e895990f37bf60054 1433 docs/RELEASE_NOTES_0.10.1.md
5d3240169765e3fb1d3cd391d09547101227e76dd4670ee46be8ca3a21553a03 894 docs/RELEASE_NOTES_0.10.10.md
36edb4f096a248fb8679bd13e5766befb478cf628c6ccfb21e3eda71bbec7633 992 docs/RELEASE_NOTES_0.10.11.md
a355d3f577c2ec85dde5dfd7b6995f4f1615e2f6bac597529f3ff102acd93c35 1292 docs/RELEASE_NOTES_0.10.12.md
609c55a1c0b06c307ebe16f2daaf1e48601edd57137586e4f2be1febd6a7060a 1931 docs/RELEASE_NOTES_0.10.13.md
8d713471a437a8a55b00d7e1dd95290680862107bc4e586cf27d727f6274e46c 577 docs/RELEASE_NOTES_0.10.2.md
0942fb2c4a4f972296423b5232687f7389e2c6417a9d48a3244beef9dec907b9 1164 docs/RELEASE_NOTES_0.10.3.md
8f4a0fe6dc250ae210cc2fc1c57c46091822ae6c2a58caa76e0091f255f9f30d 775 docs/RELEASE_NOTES_0.10.4.md
05ed618f5a74a854363930128ca98939808517eedd28b9a508660a0c46e91d97 884 docs/RELEASE_NOTES_0.10.5.md
94bfb2783c1befad1197e1c5e32fc002222c94a28d70d48360a8d53ecd260d5c 772 docs/RELEASE_NOTES_0.10.6.md
226a3b2d4bc7f54841749a283fcdd71b643cd585ba74d673084bee829fef6ea2 903 docs/RELEASE_NOTES_0.10.7.md
4be29ad0cb7ebcf5625172b8d2bd7a67cdc6d64d3a94e2c3f0656cdfd42dcb7a 642 docs/RELEASE_NOTES_0.10.8.md
fb64517aa64d3ecfe8b51b09e198c2c9fbba96d0cd24a87301c7f6dea3076095 961 docs/RELEASE_NOTES_0.10.9.md
a0c00ff76acd1682bb5e0e8dcf6589c9480da436c9c6d30780a1ed58b4dad94f 1770 docs/RELEASE_NOTES_0.2.0.md a0c00ff76acd1682bb5e0e8dcf6589c9480da436c9c6d30780a1ed58b4dad94f 1770 docs/RELEASE_NOTES_0.2.0.md
5773ead01aa4c522c556295553787482d01b1f5242f053b2c61f120c4de4fa76 5963 docs/RELEASE_NOTES_0.3.0.md 5773ead01aa4c522c556295553787482d01b1f5242f053b2c61f120c4de4fa76 5963 docs/RELEASE_NOTES_0.3.0.md
d46de73cf6c4cd5c2ba3f455a7a2af2e0d64ee9d94a97fd1a0bfb44e35c1624a 1093 docs/RELEASE_NOTES_0.3.1.md d46de73cf6c4cd5c2ba3f455a7a2af2e0d64ee9d94a97fd1a0bfb44e35c1624a 1093 docs/RELEASE_NOTES_0.3.1.md
@@ -44,108 +72,181 @@ c2802fa5dbff392c846b82b55e84a8bfb8e1625546fd1eba39f7129318bece96 654
8c13279987672314332f648889f52338bcdcb243249f9e1c20fb09d85d7808f5 505 docs/RELEASE_NOTES_0.8.4.md 8c13279987672314332f648889f52338bcdcb243249f9e1c20fb09d85d7808f5 505 docs/RELEASE_NOTES_0.8.4.md
b516db97a0353babc810c24a87a971d30d72a8021d809e6b833ff7ae0458f442 538 docs/RELEASE_NOTES_0.8.5.md b516db97a0353babc810c24a87a971d30d72a8021d809e6b833ff7ae0458f442 538 docs/RELEASE_NOTES_0.8.5.md
838d196f3fbbfeee8df375a0502107f56b6df28babca30aa09ef1c7aa5196d09 738 docs/RELEASE_NOTES_0.8.6.md 838d196f3fbbfeee8df375a0502107f56b6df28babca30aa09ef1c7aa5196d09 738 docs/RELEASE_NOTES_0.8.6.md
2b631b9d6d973bdd70869d84886ff339da351e29e17598970b3b27915674661d 4175 docs/ROADMAP.md ef049adcfa204908e6dc3a059124b39ba0e2739cc54e38945ce73a57049df0d8 1185 docs/RELEASE_NOTES_0.8.7.md
7eedb25e1aae3b06a04bb9b2f4843bd6af614418737e600b4bdc9161edabd76a 632 docs/RELEASE_NOTES_0.8.8.md
35dcfda990946480d6d55bd2d2e6360c336260bcd05cdb51d92e07a4e8d76945 1046 docs/RELEASE_NOTES_0.8.9.md
29f7b11fef1e4960ef874f643b2206ca73a310b0b75402bcd3764a01e59db2e0 3114 docs/RELEASE_NOTES_0.9.0.md
ed40e08bac8792f95970bc05e49bce3cc9e288a08d11565a1bd156d787360a3b 720 docs/RELEASE_NOTES_0.9.1.md
01bf2cc72593b10010b667ae017b9eb62f4658a9711bbf24c81f5f95d93fe8c8 827 docs/RELEASE_NOTES_0.9.2.md
25169225d73d22b9d884ab3b5c1625f03fd44e53c7a7a4c4067775e80482c9f8 2182 docs/RELEASE_NOTES_0.9.3.md
720506842e0aeb30c9fc635f86a52a5545556f092e678cf37f08436243244c3d 933 docs/RELEASE_NOTES_0.9.4.md
dd90c81a375f97dfb7fa8f7808db03b19d7e7dafe3818a93537397f57eaae829 2109 docs/RELEASE_NOTES_0.9.5.md
1bf75f25d704dab0c6bc56c639d259f34523f0fb46718dd5a8419a59911ad2c3 2242 docs/RELEASING.md
ac76cb50fabde6a00f28d7e9eccd3ef1129a40665eabdc90d78690a38d424652 4195 docs/ROADMAP.md
1ccde232c060395d7aedce27e89a7647b77afe28ab71de0a5a3efeded57369d3 140415 docs/screenshots/deploy-confirmation.png 1ccde232c060395d7aedce27e89a7647b77afe28ab71de0a5a3efeded57369d3 140415 docs/screenshots/deploy-confirmation.png
b39506254ffa2c73c389fb4795b3a745368bbeb7d8514cc47a636316d6d9a6aa 107166 docs/screenshots/deployment-run.png b39506254ffa2c73c389fb4795b3a745368bbeb7d8514cc47a636316d6d9a6aa 107166 docs/screenshots/deployment-run.png
070e6700bdae8c628c907ba181bbf0dde0bbbbb4208f7a875503f933ff1b882e 118819 docs/screenshots/deployment-success.png 070e6700bdae8c628c907ba181bbf0dde0bbbbb4208f7a875503f933ff1b882e 118819 docs/screenshots/deployment-success.png
bcb1e4daf1eeedc5b3f61d2406f1a65312dba130082528007e1629d9df99570a 153240 docs/screenshots/overview.png ed69b8beb948a2cf9a6deb6c82368e2bb44ffe8d8990a900dc878b0938d1084f 95937 docs/screenshots/deployments.png
224e34ab45877bbb97b07d2a14c4a5aa6e28339522a8015b33a2a81477177143 135102 docs/screenshots/repository-workspace.png 3868ab978de2a7945761c53a9a718aecd54dc791605d07660bcd5cad62a33ea8 103569 docs/screenshots/git-validator.png
322624242d246d07180cc719e14c91e8fb69e123676a02e5046f4e576cca1ca1 5569 docs/SECURITY.md 007681714895ac062c980db1dda806ac17d4f01019ce9c46491a108d17c2dbda 85338 docs/screenshots/overview.png
1f78414b00ec100af2ec9bf5c9a3e400b6c9bf6dca6fcc317fd951789acc4536 112852 docs/screenshots/repository-workspace.png
735950c1e77bd4a1cf5ee986a7a307600741e5fdb90918adb0687bd29a89aaec 5877 docs/SECURITY.md
32a34ec13a284d3f9ceebbc107b25a844e3db096f8cafa4e43951fc2050c9a03 13552 docs/SETUP_GUIDE.md 32a34ec13a284d3f9ceebbc107b25a844e3db096f8cafa4e43951fc2050c9a03 13552 docs/SETUP_GUIDE.md
4dcdbd42550a4cc53fe948349b20bfe0e445d40144ef82df54b3aab8b00a8f46 5165 docs/SSH_UNRAID_DEPLOYMENT.md 2fd71e9bcaeb4cb10c3fa2496b7e52fedf70c5b7f871cd587e22dc060c399079 4421 docs/SSH_UNRAID_DEPLOYMENT.md
b6a178215dab054006aae4944b8ffcbe7f6100691c30f08e221e3a2dbff4cd42 2147 docs/STATUS_ENDPOINT.md b6a178215dab054006aae4944b8ffcbe7f6100691c30f08e221e3a2dbff4cd42 2147 docs/STATUS_ENDPOINT.md
0adfeabb98168a7fc0b02bae8d4af436d3c59459012fb05b2216e02265190128 3139 docs/STITCH_REVIEW.md 0adfeabb98168a7fc0b02bae8d4af436d3c59459012fb05b2216e02265190128 3139 docs/STITCH_REVIEW.md
4625a10ebd3c749f60b2a7bef6b1716cd05dbc44ccceba0491a1b46bc293c195 4883 docs/TEST_MATRIX.md 4983414a980075e6faae687b0d71c8e57bfe53fcb4cadb8b979b8abca636fe95 6654 docs/TEST_MATRIX.md
b3f317faba63d574ee83924f01b5275c118b5b04f6d9109c7cf9ed18500835d8 3389 docs/UPDATING.md 03fb2fe52a863b9d3d536f3c8abe23e47b9851be7fd7ccbfb106554b9c595385 5013 docs/UPDATING.md
73f094a2f0db3de053e515feb2771cd5a4f3aa4178f2c5f37be01ca65ff1c938 2705 eslint.config.js
c230b931abf2293d2d44b7a69b94c35f1142c093cc46b88739a0de5cbd6d1896 1532 examples/gitea-actions/deploy.yml c230b931abf2293d2d44b7a69b94c35f1142c093cc46b88739a0de5cbd6d1896 1532 examples/gitea-actions/deploy.yml
4c792cc9fd57ed36da291300c252a6ef75b08a249cf6f2561e23c4c22522138a 1477 examples/gitea-actions/rollback.yml 4c792cc9fd57ed36da291300c252a6ef75b08a249cf6f2561e23c4c22522138a 1477 examples/gitea-actions/rollback.yml
1d2cde1bef4882f56006823d2806f6105882fa098a665a303150fdf18ada2004 5705 examples/server/forgeflow-deploy 577f3fa2131a3baa84549a6523f5816ef9da94f5bac6bc274d4588b6e7ab6594 5688 examples/server/forgeflow-deploy
4fe3eee5c2d8705964c24b8c4dd909883a05e7d6eb85629c84b0d64473e0a92b 258 examples/server/forgeflow-runner.sudoers 4fe3eee5c2d8705964c24b8c4dd909883a05e7d6eb85629c84b0d64473e0a92b 258 examples/server/forgeflow-runner.sudoers
0423fe2cc7f43fe793986a3f62a395668897cdf07348756aa7742a8cd40ac51c 569 examples/server/forgeflow-targets.conf 0423fe2cc7f43fe793986a3f62a395668897cdf07348756aa7742a8cd40ac51c 569 examples/server/forgeflow-targets.conf
106538d4a14a5a7b13419f9520c582b19809e8fafe2cb8c7dce2bc3e600dd10a 397 examples/server/nginx-forgeflow-status.conf 106538d4a14a5a7b13419f9520c582b19809e8fafe2cb8c7dce2bc3e600dd10a 397 examples/server/nginx-forgeflow-status.conf
2dff25fb39ce8fc7844026a50524b23f241bec5b614eb05371c7f908a080f69a 398 examples/server/status-example.json 2dff25fb39ce8fc7844026a50524b23f241bec5b614eb05371c7f908a080f69a 398 examples/server/status-example.json
4a561ead5ba7cdfaf4efce91842a4308c5f2a77980205879d83835efb8a579db 1067 LICENSE 4a561ead5ba7cdfaf4efce91842a4308c5f2a77980205879d83835efb8a579db 1067 LICENSE
6765015bdf27b288a250192272750b243c3cb8d1326b752d056d1e43317b6344 12935 main.cjs e2daa28bbc01c68c3702add6ea8259dff5920b22f6fdc3c9193ed78a153f2e9e 14708 main.cjs
91a984a89dd57a084b9a2331763cacdb061582fb590f13df379d92c1a77a2ee1 352 OVERLAY-INSTRUCTIONS.md 91a984a89dd57a084b9a2331763cacdb061582fb590f13df379d92c1a77a2ee1 352 OVERLAY-INSTRUCTIONS.md
59ab2691188bfde953a30c0ad2709f529c86ea9de7351aa98f53238ba50d7771 130466 package-lock.json 46e77e759b75c39737fc9812d105b31c20b68f0c46c7994bebf01a487ec9f207 179808 package-lock.json
8c137e3654c508000fa313429457e314c42a4b73abf6d14848e07445289515cf 3832 package.json ba81105b16f3f3605a9e578a9e7a40d6fbc29f0001ad96f7f296441e563ceeb4 6367 package.json
3d2ac366a13e9418e3ec6d13ce95b611f30f0228eb3a80ef9e7a936ce9578e24 9080 preload.cjs 1237df9ddcbb5ac7dc4316f18c34ff4a7030e3e0d56216ade6dd07369e5e2a04 1353 playwright.config.mjs
b31c43d9355c13b5ae4efc0f3649d8cb8d509b2bb7ebb042ff546b7820fb7de8 8411 Publish-ForgeFlow-Release.ps1 e8f678b26a1b651ee0e06e499b0538d8a193d0565687e9f750b58f801e4fabd8 12473 preload.cjs
a6d32a742412b7836606be00f17be0465f1b6f55d3911f6c73a14029787ba206 14037 README.md abe5dd6fd68f2970cd19ef134094907c67219061d8fe9a1a08324c78de4ad437 484 PUBLISH-AND-ENABLE-UPDATE.cmd
6d0858d6654c3c3dc7083ebbd234c88324afcebaecd7b772719440a8afbc2e4e 10736 Publish-ForgeFlow-Release.ps1
33f3c4795705ab77c6e6603c88a32c123b3a286bc77e8e472b76970485699338 4386 Publish-Missing-Binary-Release.ps1
423447da25b001d869f9e9d7c860710f470945e72344332fc16b6c42a70d3ff6 10965 README.md
79d93000a8b9dec65448f866f48d83b62d6bf37af26480becd73654544d454e1 15831 reports/architecture-audit.json
dd54fd4a24120a466603acedab329bd3ac6f482ddb1e65c305d4cc755be5ec0f 1516 reports/architecture-audit.md
509c7bcff5280349bd9f45ed6151f70372bad7010a9ea582c13e2ccab91fe0cd 6272 scripts/acceptance.mjs 509c7bcff5280349bd9f45ed6151f70372bad7010a9ea582c13e2ccab91fe0cd 6272 scripts/acceptance.mjs
00d57bda5af8c8eda294b72d18b318f024a307b81b0d9205a0821f5240151e31 3814 scripts/apply-binary-update.ps1 d0745072321aca2c80f44460974a7926715a9f429164aaf7660dced40b52c736 4790 scripts/apply-binary-update.ps1
f8359a69d20deb2dfe10042d1bec7b12a95e76e58e36bc5f265f073c3111d056 10287 scripts/apply-source-update.ps1 404863bcbe7292355662e3a326455df864d7279badc29f90866a3b837420df54 10745 scripts/apply-source-update.ps1
02e924227f6cad3777fd06660230c85df590d8ce95e134194a4d18970a240b88 4145 scripts/architecture-audit.mjs
47a5b16e95934bfe510c18bf94547ae65acb980c0f0506ae156d1a486dfbdfc9 8985 scripts/audit-installed-deployments.cjs
6d46dd6826069d842f20f9f22a99042257db936cdea0bee8d294d2d7ea290126 3893 scripts/doctor.mjs 6d46dd6826069d842f20f9f22a99042257db936cdea0bee8d294d2d7ea290126 3893 scripts/doctor.mjs
5e9a2a819522f6a32bbd9d3303263d5e5eaec95898ea2cd5776b221168008d75 1727 scripts/generate-source-manifest.mjs 0244d42896b8c44f734d0bb6cdcb29b5981342be2f070ce89f8d9eaf3e4d49e6 1793 scripts/generate-source-manifest.mjs
842436680521311594e798848b050ae4e488d0595f0de57315f6ec081c049fb9 1266 scripts/prune-dist.mjs 842436680521311594e798848b050ae4e488d0595f0de57315f6ec081c049fb9 1266 scripts/prune-dist.mjs
74433d8a6b24afe368197a469e2fe0c5050c239d7250b84c2f3f598c304778b0 4736 scripts/publish-binary-release.cjs d0e6fd6ce67b553a3654acd4393e5b9c3be825c45d03d957fee36fb2a3c56a85 8308 scripts/publish-binary-release.cjs
444b397d515d65a7ee59d3088cba869cbb812d2b8cc18fc5d255105e3edb58c2 1468 scripts/serve-demo.mjs 558ff442988f1396c174c7161ff5bd3ef0b2f43cfc31459ec7c3967faa146bc3 1694 scripts/serve-demo.mjs
42203f9e0fd4aae517284d387f265cf1b0b180379bc253a092b5c3c5c4caef0a 2992 scripts/validate-installed-connections.cjs 288c4b93f6006c0b32cdf90555bdc0d1d3b61d24a8763fcc30f1e6425ce1684d 1713 scripts/setup-update-signing-key.mjs
cd7650a307ce862c9dfc6c756efda5b10c75d3d1f63ce54191baaf7f008123bb 12308 scripts/verify.mjs 431d3d7eabf7e2ea2d5cbb96fb0ddc13f26d85afebcb9692f3e30242197cbd8d 2607 scripts/sign-release-manifest.mjs
0079701b5acbfef07b71a9623613d1940805ccd20649d77e3f34c37e79df7655 735 scripts/write-release-checksums.mjs c76507857292c5713e1c699cf02e24b80265da39af2cecd148034bdb874adbb6 5246 scripts/test-authenticode-chain.ps1
4393f7dc5f417e6d601a68238f4e26791799a3634acec228fe4d79deaee85eb5 3109 scripts/validate-installed-connections.cjs
e6127e1e62f39c70ddb1abf72f4d7e7b8e3f19ff1f219e1a3660353c2e0cdfac 2411 scripts/verify-release-signatures.mjs
587efcb60a363614fb61f722fa84a81e4da09c5ea35e6897009f82c5d244d740 21919 scripts/verify.mjs
c2c9e4ba251d93a530a52b2d0079787680261c314083bb99d2356fc177719613 2434 scripts/write-release-checksums.mjs
619515f524cb89960370ffcbd3fafd3c0e178b95f69c5868b1dd44777f23ec1e 2081 setup-windows.ps1 619515f524cb89960370ffcbd3fafd3c0e178b95f69c5868b1dd44777f23ec1e 2081 setup-windows.ps1
dd613d04b366f2cd071a1685a414016a5fb008082ed1b4cb8b24b79c100f640a 2412 src/main/audit-service.cjs dd613d04b366f2cd071a1685a414016a5fb008082ed1b4cb8b24b79c100f640a 2412 src/main/audit-service.cjs
a381848a296c28f6d14093c96f722967acf9c994ffb867d54dd92bf5ada2729b 23648 src/main/config-store.cjs 5506ac1e5e49006ffd028a29c89bd0b95485ea3f2abc22db4f2b9fedd959852f 33194 src/main/config-store.cjs
2fb04b1494b39f5d7c0720fa5fd298cd46fa85dc1b696d77657592347fcf1819 2731 src/main/configuration-backup.cjs 2fb04b1494b39f5d7c0720fa5fd298cd46fa85dc1b696d77657592347fcf1819 2731 src/main/configuration-backup.cjs
9d0af5074093108a5248d0dde0ff70a666748e61f1954b630886a81e8f34072c 24079 src/main/deployment-service.cjs 86e9fc2eda66b4b563f6c4bbb87d3e8514340d484fb503b73137e63b6b05c3c9 14597 src/main/deploy-key-lifecycle-service.cjs
c157640e76d558906a9aa9881eda811196623ef1c65fa3467f32f0f84b0ddd0c 15095 src/main/diagnostics-service.cjs 7cbfe51973d6607203cb197652ed7f296a3f6b6b644df876957117866a47d802 2159 src/main/deployment-identity.cjs
ce30ddac403d1adf21176e5df21b0cc3db435305d2628f51f1486eacf20df6f2 23708 src/main/deployment-service.cjs
f22348297291199e858656248cec70f94f002144ea7ea0807bd844cc5016baaf 16277 src/main/diagnostics-service.cjs
a2ef47d5330095b92c2bd22fcc39962091881f9cb60d02e261eb1dd1bd693170 1974 src/main/external-tools-service.cjs a2ef47d5330095b92c2bd22fcc39962091881f9cb60d02e261eb1dd1bd693170 1974 src/main/external-tools-service.cjs
0b7476c2cfe1872601978c20a466c20fe58be35e81b2303e38a753fea62bbc27 32548 src/main/git-service.cjs 3d19a328eec427329fd9123b24fe79b5ab6670c0b33ac68397948e8df636a99d 43961 src/main/git-service.cjs
75f25fa8ee520b03b0bbe4c4cea439853202d318547343cda49a19c6ab868901 16984 src/main/gitea-service.cjs e28fc1ca2fd4c0116148f5005d793feddf04c36ef711d2d348560394d209a613 7253 src/main/git-validator-policy.cjs
79593a28b8f40f48a73028be34464f94be2e4c67a027a3f5da78a33bcadc76eb 45539 src/main/ipc.cjs 3a101b63ad3761c26350c2ac0793279a0b27672b91a5b1d8dc75bc44d92f0b52 27128 src/main/git-validator-service.cjs
3cc53e24e023aa0d8bf36c35ce9672ca98e6c74066512c8b59ab42274e838c22 21307 src/main/gitea-service.cjs
2ad3b2e647377f687ad987fe248a142ad399ecac98e4b49965aa7efc6093e5fa 6914 src/main/inventory-classifier.cjs
dafdb09133d2b6ec2161a3f0b09354551e54fc606c8107976fca37405643be91 3404 src/main/inventory-review-service.cjs
5e10cf3759bbf9294909866ed16f206d394789f0564549fc0fe23cdd89118ca6 25110 src/main/ipc.cjs
26efebb4c147ed560966e7e60e64a013b3476327b3bbdb4e4439949142fa7846 2250 src/main/ipc/channel.cjs
b80357dd1f0aa18022d92db85b6cc8f29bc691ef11f9a0e90b4886ae5e19c763 12543 src/main/ipc/deployment-handlers.cjs
dc9b5971c9fefe8c374aa31916f5513601ce86003fd48b1d0e51330a909ae3a5 3442 src/main/ipc/operations-handlers.cjs
8072252821b1245d121eac534a18eeb64f0d7d18429e272e21a6e90b010005b9 17272 src/main/ipc/repository-handlers.cjs
62f2c80c8210e19370b8556b1f296cbae50dae6b758a39e209f8fb461691fd4c 4235 src/main/log-redaction.cjs 62f2c80c8210e19370b8556b1f296cbae50dae6b758a39e209f8fb461691fd4c 4235 src/main/log-redaction.cjs
958595a99fb242c127f475f3d8622bdba4c07b2d658703f69fe3992227a9107e 12909 src/main/preflight-service.cjs 958595a99fb242c127f475f3d8622bdba4c07b2d658703f69fe3992227a9107e 12909 src/main/preflight-service.cjs
720c4a0c554f46386d87c3ab6607d1fbcae66e50b69483c7dbba169d5128c851 680 src/main/process-error-policy.cjs
3096b4181566cb93a27e56e248c92105d4f4df5aee39d73c6c7d8ae8c2231bc0 1570 src/main/process-runner.cjs 3096b4181566cb93a27e56e248c92105d4f4df5aee39d73c6c7d8ae8c2231bc0 1570 src/main/process-runner.cjs
e89b54e7e3174b4b0a1dcd9058d8344e29431f9d16d0e6bb8d11559b691440a0 2508 src/main/repository-monitor.cjs e64f7257d478955c675a133b3735b6afe138a69d2ad090898061e56f557c43e5 9926 src/main/production-acceptance-harness.cjs
17e2a53f61cd7faba461b9f332967143087eaac95b72001462292976278ca305 7782 src/main/repository-service.cjs 27bd6621c731545ec46d8914e9408c89928a8ce563b40eb4bcd8a516662a54d1 8716 src/main/repository-monitor.cjs
b31a63bf8cb1807b3e838e2bf8a0e742738f119d13de8ca9f42e471f072217d3 8328 src/main/ssh-service.cjs 6393583911263575c6e2a19d9baab6e638cce90252c386b0a5144f2fb6f81f15 12154 src/main/repository-service.cjs
8cf5013de91737dd9345b121586ceec38a6fc8518648975d60593d81fc225c4b 67376 src/main/unraid-deployment-service.cjs 52b6d88ed1f5c904a13cdde92e5f96d1e2b5971ceef49862152197353cdc6490 27928 src/main/server-inventory.cjs
27b9e15dd6530bc7bfab51414430eaef169e0cc4acd027257b1c63f891af8c85 20733 src/main/update-service.cjs 793003566823e1d5c02283f583888ecc07e44477525620579b3d858f488b3c08 22347 src/main/ssh-service.cjs
ac13e1222c7adcb664ff18c1de42c1f7bd25e6d90d2f02a18e4a4a68f5683bad 196260 src/renderer/app.js 19538a3c40ea3489bbaee9a23af36a5e99962af6bb3d04259f05ece6588cbeb2 25901 src/main/unraid-access-methods.cjs
5621e35323e4f81fb14a05670f81579ec1e66bea3a55fa6457ece0f807421424 9801 src/main/unraid-deploy-key-host.cjs
6d9910dace52625f88e066a8485af2663c3735ff15e9ce9031441ce742710a21 30793 src/main/unraid-deployment-methods.cjs
673b1692e7c2b5197545df98750b5d048bddf44206263e25be4f17d9bf900e2c 17208 src/main/unraid-deployment-service.cjs
bb4a99c3526fcf4db4fbae88a058e8598fd10a87990e7d502bfdc765328bdaa1 42766 src/main/unraid-inventory-methods.cjs
2c0cf07921ca7ee5a9085ced44498c2e6798e5cc1e8a5ecf704c3cecabe39a25 27607 src/main/unraid-preflight-methods.cjs
d45220176aed72d692f9ae5534f9d40bcc359a2d08e025e74a3b3b505b8b9ed4 16559 src/main/unraid-runtime-methods.cjs
4c5cf01922e1feb36a31b50af22e973d8aee3fecccd406e449690604111898ac 11608 src/main/unraid-state-methods.cjs
0b25c3729c5fffe3cd412c2325616bb86a6c916ae248eeb39d837378bb78c144 26420 src/main/update-service.cjs
b5c304531bec358d059189a27cd9db8fa20cefb7f817e5eb0287001f7353f6a7 985 src/renderer/actions/command.js
d0bf607dd1de9d55f2947d0adf0997cd3ca5c269d10a5362cc1d8bc4d1a2a8ae 6706 src/renderer/actions/deployment-operation.js
0db283b1a458ae0b31538940b1ddc931ffdb53bd04ceb7fd8903813f9200d071 17978 src/renderer/actions/deployment-profile.js
48bed91dd2a85bb51ee7307f7acc3b79c881ce8cf63b22ba79d5d079b265eb4b 7785 src/renderer/actions/inventory.js
13b8611b5389625deeec59ff2a6cfebcfc93bd7972902439715be371d1f9f573 14936 src/renderer/actions/recovery.js
2414a0d29a0380d343b9b0e58ba1909e7a7eeb46357fd45ddbb3ad411d119f78 16280 src/renderer/actions/setup-and-settings.js
a980f2e86d8286ea605a7259b9e9adcf3fda4f657b8d54a5d2d8765a7bbbec13 19065 src/renderer/actions/shell.js
65e305965d6d00d45b516f271c0f905854797af07c38982768199bb30d988c2b 26659 src/renderer/app.js
16efd2fca83004f781eae40ae0f706a004ce0bddf338dd087b8adf7eb10c1d84 85704 src/renderer/assets/itworx-mark.png 16efd2fca83004f781eae40ae0f706a004ce0bddf338dd087b8adf7eb10c1d84 85704 src/renderer/assets/itworx-mark.png
813b8cdeecac43794166f3db9d3c5d2c441e0292f9ab7bd465ba136d6201e95d 82476 src/renderer/assets/itworx-wordmark-dark.png 813b8cdeecac43794166f3db9d3c5d2c441e0292f9ab7bd465ba136d6201e95d 82476 src/renderer/assets/itworx-wordmark-dark.png
094c1b71cc2482a9db250ac175f45f3de68f53277dfbde371a03e61923d00988 75240 src/renderer/assets/itworx-wordmark-light.png 094c1b71cc2482a9db250ac175f45f3de68f53277dfbde371a03e61923d00988 75240 src/renderer/assets/itworx-wordmark-light.png
813b8cdeecac43794166f3db9d3c5d2c441e0292f9ab7bd465ba136d6201e95d 82476 src/renderer/assets/itworx-wordmark.png 813b8cdeecac43794166f3db9d3c5d2c441e0292f9ab7bd465ba136d6201e95d 82476 src/renderer/assets/itworx-wordmark.png
e1c463d6cda9f2b9b78c468845c0a7e8688f0362be5642074a1a5f7122dfe811 762 src/renderer/index.html fd47efd296409c19b80fd7719429e3eb33963ef78f30bc748d1770308aa472a3 55138 src/renderer/dialogs.js
96e62ef31fd20954942dbe9dd4d44ecefdf869e9fb3144fe23d88c38fac0d9bf 50922 src/renderer/mock-bridge.js dede1f21a06c73a2c2a462a869d27530d85f99baff202a2eb509c57436ad6aec 2732 src/renderer/diff-view.js
e30ea37ee00f34110d0d252c79f9d8e0bb127c4db0bd1bf8b374609dea433361 72160 src/renderer/styles.css eef2f269ba4fbb76bf66ad328d481b461255d0acb753b30878dd4d4eaac57dc6 6924 src/renderer/events.js
0a1e9d9d6cd4d190eb7f85dbc6668d80600b1cf2749cc0c2c51cc428f506f20d 1121 src/shared/clone-target.cjs c4a71213d412166093f7bd8254b847de4d8beb58c1aaa356a0cdc8d728080326 1524 src/renderer/index.html
06180d9656dd254edfb6949c397f8e313954fc560ddcb22b3a35fce3c3e35655 21350 src/renderer/mock-bridge.js
870024aff376826a92c9cf7452689cc1ecc5d9034f055bea56734f3f7fcea5e5 28703 src/renderer/mock-deployment-bridge.js
92cacf58a3576044800ee5f9823d4fd2a1c768571b7f5d271950f5002a80d212 25031 src/renderer/mock-repository-bridge.js
94fa265c2fe9ca8d644f0ce9b620b6f85d9b25dca5802c4e9195b66dcbe80120 6522 src/renderer/operations.js
431ed7bbadecbcc99572aea9a5ae5550dbb5bacbd2d8028f8a05bf77f97b251e 81161 src/renderer/styles.css
8ef063feee96c0a3692da21fa797bf44325388b94e051d53f20a5198036c9252 102998 src/renderer/views.js
e9e72c072a5c5d04f59cd6763de0cfbf736c2a5ffa2f722143f3bad2bdbc630b 1411 src/shared/clone-target.cjs
5d425d5c2f939d0f6beebee7ebb0c77146cb7e318535ba7286ec7081a4dc2269 2497 src/shared/deployment-policy.cjs 5d425d5c2f939d0f6beebee7ebb0c77146cb7e318535ba7286ec7081a4dc2269 2497 src/shared/deployment-policy.cjs
029e600229714d033c28e2dcb77817aa8269847001782ae0012960e83ffd183f 3057 src/shared/git-status.cjs 029e600229714d033c28e2dcb77817aa8269847001782ae0012960e83ffd183f 3057 src/shared/git-status.cjs
2778ebcbdf60fdc1cb0749f15565e0e1bd66f3a0d31eb70ae7942a7511a3de75 1295 src/shared/repository-match.cjs 2778ebcbdf60fdc1cb0749f15565e0e1bd66f3a0d31eb70ae7942a7511a3de75 1295 src/shared/repository-match.cjs
c7e120ea53c5ef3c01b8cce71afe913f34bb461bb73aa3ade24656e09f99f338 1152 src/shared/semver.cjs c7e120ea53c5ef3c01b8cce71afe913f34bb461bb73aa3ade24656e09f99f338 1152 src/shared/semver.cjs
ede2c95bb045c0005a3931709a0116d9fbcb3faa5f609848a0066c6ba382ca0b 2906 src/shared/shell-verification.cjs 8791d3813e6cf285ee6aa49f76e75fc1f3af76fd98c76bcb3c92ee18e9cb699f 2889 src/shared/shell-verification.cjs
2daa98fd421598bfe5fc9757c9b6f4d82c31d1bfece15829928473581d5d2639 1210 src/shared/tool-invocation.cjs 2daa98fd421598bfe5fc9757c9b6f4d82c31d1bfece15829928473581d5d2639 1210 src/shared/tool-invocation.cjs
114f01be8bd54c91b90af82d8e1604e24cc0c5f8e64e63c40cf3f4042623a98e 5402 src/shared/validation.cjs ee73fdf9c591c029243385cb2d2085c3005c7b08c5b9e1b89102201f0ab30759 5702 src/shared/validation.cjs
13b731c38863b1007b0312fd9d89562401b7cce875c952f52429bde74f77a8af 3096 src/shared/zip-writer.cjs 13b731c38863b1007b0312fd9d89562401b7cce875c952f52429bde74f77a8af 3096 src/shared/zip-writer.cjs
c1b0fd37a6ae74a56750138626fb2bc3523485c1124a0b8ac8ee3ef41089206a 2156 START_HERE.md f8853dce6fdf360d5df2fbe2b6df3e5687630c807fee5ba8436679b34ec737ea 2436 START_HERE.md
058aeaa5d9bfe377c7e322f213c7871ecc4151b5d08ef790992f4ee28d857658 743 START-FORGEFLOW-OVERLAY.ps1 058aeaa5d9bfe377c7e322f213c7871ecc4151b5d08ef790992f4ee28d857658 743 START-FORGEFLOW-OVERLAY.ps1
f5b0ea887fcdeadec78c1ad49b0ec7979723562f5c0b730703acb77a37281ee0 1009 tests/acceptance.test.mjs f5b0ea887fcdeadec78c1ad49b0ec7979723562f5c0b730703acb77a37281ee0 1009 tests/acceptance.test.mjs
a4e5947204ff6878e601e32477bc85b53cd0153baf95a161c8935b6e5466c257 1155 tests/audit-service.test.mjs a4e5947204ff6878e601e32477bc85b53cd0153baf95a161c8935b6e5466c257 1155 tests/audit-service.test.mjs
454edeaccb2bd41043bc918d3e3a6127db14339031d6a1c1562ac855e90455d2 4318 tests/clone-target.test.mjs 0841f6a2515508f8d28562d5c565c1519d357b8579515f890883dc2aec7d7737 16881 tests/browser/forgeflow.spec.mjs
a984ddd5a29a4ccf55d78ba71202390e0bf1f0925a6a96f03ee74edbbf3bb2f7 1505 tests/configuration-backup.test.mjs 1728c0a7abd92f4d7d9e68df32e4a6b00730555f23795e9b36416795d9d127af 5978 tests/clone-target.test.mjs
aa2ae0e5a12bc47f8024e0d7408148e3af797e3f3f0ecb2525fb1cc54cf4e1f0 17378 tests/config-store.test.mjs
f1463326aee79842d265687ae628189ce54e92544600f2bd14073780287cfb14 2502 tests/configuration-backup.test.mjs
144c8e217a334cd69f502938d944e0f2dac61703d5df47e287b9ed542918c779 8129 tests/dependency-wiring.test.mjs
aad5948ea374d1e56e777005c73639654c96a90364dd398c949052cf5ae343a2 11130 tests/deploy-key-host.test.mjs
b7e009fed4171d6dd6b4c3154ba1d3f7198e98f5b79b298687841fc8169447cd 9354 tests/deploy-key-lifecycle.test.mjs
49bf9cf9842e7899015013675208f83a95402065a082320927a677ee4bab0766 24875 tests/deployment-operations.test.mjs
1dc6477bd07de78be189e6e8195ec339eb9d75820c4dbd5b073b8520ee21f6b5 1938 tests/deployment-policy.test.mjs 1dc6477bd07de78be189e6e8195ec339eb9d75820c4dbd5b073b8520ee21f6b5 1938 tests/deployment-policy.test.mjs
bf68c4dc91a2604235c6a7848088bcd9566fbeaa089b86ec1e0a4fcfc54ca9d2 7677 tests/deployment-status.test.mjs bf4576901e32662d832687a2761852aa1b2cffe256de5044f18c6637c189463b 9780 tests/deployment-status.test.mjs
fae3634bae871abade4d487b94b4741b50e787804dbd6135249f634fdd83c6d0 3800 tests/diagnostics.test.mjs fae3634bae871abade4d487b94b4741b50e787804dbd6135249f634fdd83c6d0 3800 tests/diagnostics.test.mjs
dd121d96ca265a027cd415a52064500a4541b2f8a662f4f4b25f2f996d52b5da 762 tests/external-tools.test.mjs dd121d96ca265a027cd415a52064500a4541b2f8a662f4f4b25f2f996d52b5da 762 tests/external-tools.test.mjs
e7aebcc0d484a6a59d463d5cb26c11b3ad56e28f6535e7c38a0fe166a41565ea 13690 tests/git-integration.test.mjs 1da4abd9355183ee04410b3d89403cc36094eb5df622ecfe6736e8807135bd28 19532 tests/git-integration.test.mjs
5ea94c6b241a02060d531fad94e449eecd3772eed2137581d4e2babfb09e56db 1239 tests/git-status.test.mjs 5ea94c6b241a02060d531fad94e449eecd3772eed2137581d4e2babfb09e56db 1239 tests/git-status.test.mjs
61e0b8cad926acd22b5b17e4044f7edcbe96b6977cbbe2b6fbe123406626fc89 4283 tests/git-validator-policy.test.mjs
2b31459f14a5e36e30cf84c1054f634f4dba8676d29adeb9c2a8e18179f56fa0 6097 tests/git-validator.test.mjs
681ab7bcd02c4dd98d1d8d2092a3521c489d941131e7ffe5903971b940046474 2403 tests/git-workflows.test.mjs 681ab7bcd02c4dd98d1d8d2092a3521c489d941131e7ffe5903971b940046474 2403 tests/git-workflows.test.mjs
52b96f0a6623778fbdc1e8dbfc892e1d77a3d6616058cd7b08d532b207aa5719 5531 tests/gitea-actions.test.mjs d633c59bd910008223c834c6d7f3e5666c685a0881944263ede2d42cc69d3151 18710 tests/gitea-actions.test.mjs
267d76b868d8d06ea031c14acd09a7715fb44668a25ade51a9e62e0170888bc8 1522 tests/ipc-contract.test.mjs fcc9a063882840dd89d74c2785284c8f2f6a9e5acec482b6d89ed8de62efdb85 9635 tests/inventory-classifier.test.mjs
62b90c21c15b841af30d26ccb0b9e88d25674fa7dbff9dc231dd8a1dddc3d657 2025 tests/ipc-contract.test.mjs
caf98cbd9de9b119dae610ee53fa333a7a11214f34762247452fbb85e8bbf725 2392 tests/log-redaction.test.mjs caf98cbd9de9b119dae610ee53fa333a7a11214f34762247452fbb85e8bbf725 2392 tests/log-redaction.test.mjs
96432a97d313f331694900bf0a2c21e38c20eac96d59147977aeed9055a9e3ad 2287 tests/partial-staging.test.mjs 96432a97d313f331694900bf0a2c21e38c20eac96d59147977aeed9055a9e3ad 2287 tests/partial-staging.test.mjs
c0f8f5a3784835f19d9ff1015185ccb385840b6fa1c9ec19f233393a7d952b65 3718 tests/preflight.test.mjs 1b6c920e18a248f78acaed6187197c88ec8d911b62d5e2a9f8ad57b91ae80499 11827 tests/preflight.test.mjs
185e96ff8fd029f06b77155117f492bc16684e08818a160148e00737dd8c220b 8395 tests/renderer-workflow.test.mjs 7f2751ea2621f76b5427f442e931344d13e97faa7b6ef3151949bbd6a03097cf 1205 tests/process-error-policy.test.mjs
0cb884cf62c1cb02cf59a81662be055bcb5339d176de85e2a3eeb8e8573e11b3 6435 tests/production-acceptance.test.mjs
252e0345fcd3cd3899467f2a9ed363df0675d529e59d4d6e1204f4464fd8a5f7 11485 tests/renderer-workflow.test.mjs
2b4956fa4df4624a04117737e57ba74020564330ff71303b5746d8ccc881e880 854 tests/repository-matching.test.mjs 2b4956fa4df4624a04117737e57ba74020564330ff71303b5746d8ccc881e880 854 tests/repository-matching.test.mjs
f679072548554a64974f0452337ce5e7b0c567343c287223770cc0974b905348 1068 tests/repository-monitor.test.mjs 76712a5d26f2598b00b83b925c9c84a90ab81c0eb1760895e9d6a2bd2f6eb425 5828 tests/repository-monitor.test.mjs
75b5b83836c75675bb9a48fe4363fcb8a24fc425e6af6f822d7955c6f3c79eac 2265 tests/repository-service.test.mjs 5476f3ba90bc096d4172900d9b54ada7c12da521f8627913d87794eade3cee23 13494 tests/repository-service.test.mjs
d49c772e3c7ddaa12dc5a1d4fc4cb474a4d99ae06fa5dab5a6cf1c44acb9ed6f 3463 tests/security-validation.test.mjs 5fea04e668344508fb4e16da9bb6fe8733e2b83d1c227acb3421e51da26b2ffa 3636 tests/security-validation.test.mjs
bab853feb0e22aa25af17989baaa632c01efa636533ea67407fecfdd973c7024 627 tests/semver.test.mjs bab853feb0e22aa25af17989baaa632c01efa636533ea67407fecfdd973c7024 627 tests/semver.test.mjs
12cb3b240bdd0922566323c0014838ca067ad10d9d4009943165ae2c4e93bc6f 11786 tests/server-inventory-branches.test.mjs
020eccfa9c4aef7a4ac4736d9af90518fcb6d1ad75aedcfaa1c92832a9e3d6d8 4609 tests/shell-verification.test.mjs 020eccfa9c4aef7a4ac4736d9af90518fcb6d1ad75aedcfaa1c92832a9e3d6d8 4609 tests/shell-verification.test.mjs
a39d30f47813dfb98c998811f3d76ebbb1544ecfd017a165d44f9afb80d7daf9 9090 tests/ssh-connection-pool.test.mjs
7ee9166327ed227d2b7c6929692dea5c5d7a41c3e566596fa92d9ec4f42e8677 4085 tests/ssh-connection.test.mjs
c9354e4bf3720c28cff21c15ff8b9474ba4a23b7f55389de4326f4dffde54d78 9510 tests/ssh-service.test.mjs
8a6a8477eb94b85ccef18cddd2640afb0d1eafa679c96bc7de20428d5d69e1be 1794 tests/tool-invocation.test.mjs 8a6a8477eb94b85ccef18cddd2640afb0d1eafa679c96bc7de20428d5d69e1be 1794 tests/tool-invocation.test.mjs
05c791ea262aef85a7c79874ed900c5d792a78778c577cb803b88a433cd6e2b6 21413 tests/unraid-deployment.test.mjs 3e4a1a6d6a744df9badcfece2cf8d09f8c34efb3c437cb08a6f2e6c9d428c0d4 59353 tests/unraid-deployment.test.mjs
f1f0f13ac41f47c9df8ef778d7b98c09a589f61e6f76e14bc0e8943c5ede7560 14990 tests/update-service.test.mjs 3bd3247ed821ba261ad7c02d649c26979e3591df456afd1bda04e351b2296fa1 29168 tests/update-service.test.mjs
9cea5c1d5ba3e0972a0b5c7236cf1f7c5616373e0a39ea4a492ecebf70452e40 948 tests/validation.test.mjs 9cea5c1d5ba3e0972a0b5c7236cf1f7c5616373e0a39ea4a492ecebf70452e40 948 tests/validation.test.mjs
7ef4d4b9f5f3e6979293b29d571ce0e39f83197f3cade2d999a9cea7bacdd84d 1781 tests/zip-writer.test.mjs 7ef4d4b9f5f3e6979293b29d571ce0e39f83197f3cade2d999a9cea7bacdd84d 1781 tests/zip-writer.test.mjs
8f36b542736f2933bad8b9464ad7fa37b68196009c81cf702ce3b677cd637dea 767 UPDATE_FROM_0.3.2.md 8f36b542736f2933bad8b9464ad7fa37b68196009c81cf702ce3b677cd637dea 767 UPDATE_FROM_0.3.2.md
+5 -3
View File
@@ -1,12 +1,14 @@
# Start here — ForgeFlow v0.6.0 # Start here — ForgeFlow v0.9.0
You do **not** need to send anyone your Gitea token, SSH key or server password. You do **not** need to send anyone your Gitea token, SSH key or server password.
All credentials are entered locally in ForgeFlow during setup. Diagnostic logging All credentials are entered locally in ForgeFlow during setup. Diagnostic logging
is designed to exclude them. is designed to exclude them.
## Already running an older source release? ## Already running an older ForgeFlow release?
Publish v0.6.0 with `Publish-ForgeFlow-Release.ps1`, leave the currently installed source folder untouched, and test **Settings → ForgeFlow updates → Check now → Download update → Apply & restart**. Configuration and credentials remain outside the source directory. Run `Publish-ForgeFlow-Release.ps1` from the validated source. It now publishes the source commit and matching Windows installer/portable assets together. Leave the currently installed older folder or executable untouched, then test **Settings → ForgeFlow updates → Check now → Download update → Apply & restart**. Configuration and credentials remain outside the application directory.
When version 0.9.0 source was already pushed without a Gitea binary release, run `Publish-Missing-Binary-Release.ps1 -ExpectedVersion 0.9.0` once. Afterwards the existing 0.8.9 updater can install 0.9.0 normally.
## Fast path on Windows ## Fast path on Windows
+3
View File
@@ -0,0 +1,3 @@
-----BEGIN PUBLIC KEY-----
MCowBQYDK2VwAyEApGKe81NzC5mU3jfMNAQUnAOfQnCnMFry8cNpmjQsdtE=
-----END PUBLIC KEY-----
+14
View File
@@ -18,3 +18,17 @@ npm run acceptance -- --execute-rollback
The first command is read-only. The mutation flags require every read-only The first command is read-only. The mutation flags require every read-only
check to pass, dispatch a controlled exact-SHA workflow with a unique request check to pass, dispatch a controlled exact-SHA workflow with a unique request
ID, and wait for matching status plus a successful health endpoint. ID, and wait for matching status plus a successful health endpoint.
## Isolated production acceptance
`npm run acceptance:isolated` provisions disposable bare Git remotes, working
trees, server appdata folders, Compose definitions, deployment keys,
configuration migrations and release manifests below the operating-system temp
directory. It covers clean and portable installs, the 0.10.0 migration path,
both authentication modes, exact-SHA server pull and Direct Copy, adoption,
external updates, deploy-key lifecycle, host-key changes, unhealthy activation,
rollback, network interruption, shutdown recovery, stale plans, corrupt config,
release integrity and inventories of more than twenty workloads.
Every fixture is removed after its test. The suite never discovers or mutates
real project folders, configured servers, credentials, containers or releases.
+18
View File
@@ -0,0 +1,18 @@
# Coverage policy
ForgeFlow treats coverage as release evidence, not as a target to game. `npm run coverage`
enforces 75% statements, 75% lines, 75% functions and 65% branches globally.
The July 2026 hardening pass raised the measured baseline from 69.74% statements/lines,
68.82% functions and 55.38% branches to 81.48% statements/lines, 82.07% functions and
65.59% branches. Node/V8 discovered additional branch counters when previously unexecuted
functions became covered; the denominator grew from 2,537 to 3,473 while the new tests
added hundreds of asserted decisions. No command builders, platform guards or error
adapters were excluded to improve the result cosmetically.
The 65% global gate is paired with scenario-level evidence for the critical
boundaries: deploy-key rollback, deployment verification, Gitea authentication and
redirects, SSH host identity and output limits, inventory reconciliation, stale plans,
configuration recovery, release integrity and updater failure modes. New code must not
reduce the global baseline. Future increases must come from additional asserted failure
scenarios, not ignore comments or source exclusions.
+54
View File
@@ -0,0 +1,54 @@
# ForgeFlow current state
## Baseline
- Baseline version: **0.10.0**
- Baseline commit: `56efd1a00c2e76251a0b2e7a7a424d94200ae33c`
- Baseline branch: `main`
- Desktop runtime: Electron 43 with Node.js 22+ required by the source project
- Primary supported packaged updater: Windows installer and portable executable
The baseline was recorded before the 1.0 professionalization programme. It is the comparison point for functional, deployment and renderer regressions.
## Known baseline evidence
- `npm run check`: 155 tests, 152 passed, 3 environment-dependent Bash checks skipped, 0 failed.
- OS-backed secure storage, encrypted Gitea token, Gitea API, repository and Actions access were available.
- Unraid exposed Docker, Compose, Git, tar and SHA-256 tooling.
- The server inventory contained active repository workloads plus a large number of historical or unrelated definitions that require backend classification.
- Windows release artifacts were checksum-protected but not Authenticode-signed.
No secret values, passwords, private keys or tokens are stored in this document.
## Operation classes
| Class | Default | Examples |
| --- | --- | --- |
| Read-only inspection | Allowed without confirmation | repository refresh, server inventory, deploy-key probe, preflight, audit export |
| Reconciliation | Preview required | adopt an exact workload, refresh a profile from server truth |
| Configuration mutation | Explicit action and audit record | save profile, rotate deploy key, change server settings |
| Deployment | Fresh preflight and confirmation | server pull, Direct Copy, Gitea Actions dispatch |
| Destructive maintenance | Recovery evidence and explicit confirmation | unlink, prune, key revocation, rollback |
Discovery and audit never belong to a mutating class. Ambiguous evidence cannot be promoted automatically.
## Recovery model
ForgeFlow writes its configuration atomically. Explicit server reconciliation additionally creates a private recovery snapshot before changing profiles or deployment state. Encrypted user-created `.ffbackup` files remain the portable restore mechanism; recovery snapshots are local operational safeguards and can contain OS-encrypted credential material.
## Issue priorities
- **P0:** active data loss, credential disclosure, arbitrary execution or uncontrolled production mutation.
- **P1:** release-blocking incorrect deployment, unsafe implicit mutation, broken recovery or material security gap.
- **P2:** important functional, accessibility, performance or maintainability defect with a safe workaround.
- **P3:** polish, documentation or low-risk improvement.
## 1.0 constraints
- No force-push or implicit repository history rewrite.
- No automatic deployment deletion.
- No desktop Gitea token on a server.
- Read-only repository-scoped deploy keys for server pull.
- SSH host-key changes fail closed.
- Live commit, remote commit and runtime health remain separate evidence.
- Packaged updates fail closed on missing or mismatched release assets, SHA-256 evidence and the pinned Ed25519 publisher signature; paid Authenticode remains optional.
+46
View File
@@ -0,0 +1,46 @@
# Dependency security audit
Audit date: 2026-07-29
## Outcome
- Runtime/production dependency audit: **0 vulnerabilities** (`npm audit --omit=dev`).
- Full development toolchain: **19 high advisories**, reduced from 23.
- Critical advisories: **0**.
Playwright was upgraded from 1.55.0 to 1.62.0, removing the browser-download
certificate-verification advisory. `c8` was upgraded from 10.1.3 to 12.0.0,
removing the vulnerable `test-exclude` chain. Compatible patched
`brace-expansion` releases were installed where dependency ranges allowed it.
## Remaining development-only chain
All remaining records collapse to one advisory:
`GHSA-mh99-v99m-4gvg`, an uncontrolled brace-expansion denial of service. npm
reports it through nested `minimatch` versions in two independent toolchains:
- ESLint 10.8.0 (`@eslint/config-array`, `@eslint/eslintrc`);
- electron-builder 26.15.3 (`@electron/asar`, `@electron/universal`, `glob`,
`dir-compare`, `ejs`/`jake`, Windows packaging helpers).
These packages are never loaded by the packaged ForgeFlow runtime. They run in
developer or CI processes against repository and build configuration owned by
the operator. A malicious repository could still attempt resource exhaustion
during linting or packaging, so the finding is not classified as harmless.
CI jobs must retain memory/time limits and untrusted pull requests must not run
release signing or publishing jobs.
## Decisions
- `npm audit fix --force` is prohibited. npm proposes ESLint 4.0.0 and an older
electron-builder; both are breaking downgrades and the tested older builder
dependency graph increased the result to 30 high and 1 critical advisory.
- No global `minimatch` override is used. Several affected consumers declare
older APIs, and forcing a new major could silently break packaging or lint
file selection.
- Latest stable ESLint and electron-builder versions are pinned exactly. The
residual chain will be retested whenever either publishes a dependency fix.
The release gate treats `npm audit --omit=dev --audit-level=high` as blocking.
The complete development audit remains documented and visible rather than
being misrepresented as a production vulnerability count.
+15
View File
@@ -0,0 +1,15 @@
# ForgeFlow error and recovery catalog
| Code | Meaning | Recovery |
| --- | --- | --- |
| `RECONCILIATION_PLAN_REQUIRED` | A server mutation was requested without its reviewed plan. | Open Review reconciliation and apply the current plan ID. |
| `RECONCILIATION_PLAN_STALE` | Server truth changed after preview. | Rescan, review the new impact and apply that plan. |
| `SERVER_GIT_VERIFICATION_FAILED` | Branch, deploy key or pinned SSH evidence could not be proven. | Run Verify server pull; repair only the failing check before retrying. |
| `DEPLOY_KEY_NOT_READ_ONLY` | A matching key can write to Gitea. | Revoke it in Gitea and configure a dedicated read-only key. |
| `SSH_DEPLOYMENT_PREFLIGHT_FAILED` | One or more deployment safety checks failed. | Open preflight evidence and follow the failing check's detail. |
| `REMOTE_WRITE_ACCESS_REQUIRED` | The SSH user cannot safely write the managed source/state paths. | Use Check / fix write access after reviewing its scoped impact. |
| `UPDATE_ORIGIN_MISMATCH` | An update asset points outside the trusted Gitea origin. | Correct release asset URLs; never bypass the origin check. |
| `UPDATE_CHECKSUM_MISMATCH` | Downloaded bytes do not match the published checksum. | Keep the current version and republish the exact commit atomically. |
Audit and discovery never repair these conditions automatically. Mutating recovery
actions require an explicit user flow and preserve rollback or snapshot evidence.
+26
View File
@@ -0,0 +1,26 @@
# Mutation and reconciliation model
ForgeFlow separates observation from state changes at the API boundary.
## Discovery
`scanServerInventory()` and `discoverServerWorkloads()` collect Docker, Compose, DockerMan and Git evidence. They may write diagnostic logs, but they do not save, update or delete deployment profiles and do not change containers.
## Reconciliation planning
`planServerInventoryReconciliation()` returns a content-addressed plan containing:
- exact links that may be added;
- existing profiles whose observed metadata may be refreshed;
- stale profiles that require review;
- ambiguous workloads that block automatic application.
The plan identifier changes whenever its proposed scope changes.
## Reconciliation application
`reconcileServerInventory()` requires the exact reviewed plan identifier. It rescans the server and refuses a stale plan. Before writing configuration it creates a private recovery snapshot. Stale profiles are reported but never removed automatically.
## Direct mutations
Manual linking, unlinking, deploy-key rotation, deployment and rollback remain separate explicit commands. Each must append an audit event with repository, profile, operation identifier and result. Destructive commands need a dedicated confirmation flow and recovery path.
+78
View File
@@ -0,0 +1,78 @@
# ForgeFlow 1.0 production-readiness evidence
## 1. Scope and history
The professionalization work started from `64ca267` on `main`. It preserves the
0.10.0 compatibility baseline and deliberately creates no 1.0 tag or public
release. The commits and their exact SHAs remain the authoritative audit trail.
## 2. Deployment safety
Server pull uses repository-scoped read-only deploy keys, exact commit SHAs,
pinned SSH/Gitea host identities, Compose validation, health evidence and bounded
rollback. Rotation is transactional and revocation requires reviewed impact and
recovery evidence. Direct Copy and monitor-only remain explicit alternatives.
## 3. Inventory and reconciliation
Canonical deployment identity combines repository, branch, server, environment,
Compose project/root, runtime labels, container, live SHA and profile. Duplicate,
stale, ambiguous, orphan and historical evidence has persistent content-addressed
review decisions. Discovery never deletes, stops or rewrites a workload.
## 4. Architecture
Renderer, IPC and Unraid responsibilities are split by domain. The generated
architecture audit currently reports zero source files above 750 or 1,000 lines.
Runtime schemas, bounded IPC capabilities, operation IDs and explicit error
contracts protect the process boundary.
## 5. Repository assurance
Git Validator 2.0 covers security, reproducibility, governance, collaboration,
performance/hygiene and release readiness. Minimal, Standard, Strict, Production
and custom policies support accountable expiring suppressions, trend history and
reviewable JSON/Markdown/HTML reports. Repairs always require preview and never
commit or push automatically.
## 6. Automated verification
The Node suite includes real temporary Git remotes and an isolated production
acceptance harness. Playwright adds 36 renderer cases across six viewport/theme/
motion/scaling projects. Failure artifacts contain screenshots, traces, video,
console events, DOM, fixture details and test identity.
## 7. Coverage and dependencies
Coverage increased from 69.74% statements/lines, 68.82% functions and 55.38%
branches to 81.48%, 82.07% and 65.59%, respectively. The enforced gates are now
75/75/75/65 and are documented in `COVERAGE_POLICY.md`. Production dependencies have zero known
audit vulnerabilities. Remaining development findings belong to current upstream
ESLint/electron-builder toolchains and are assessed in `DEPENDENCY_AUDIT.md`.
## 8. UX and accessibility
Dark and light themes use the same semantic hierarchy, restrained project-signal
motion and status text that never depends on color alone. Deployment cards expose
container, repository, environment, commit parity and health distinctly. Dense
inventories, long names, keyboard focus, dialogs, reduced motion and high scaling
are part of the automated matrix.
## 9. Packaging and updating
Windows installer and portable packaging use deterministic names; old `dist`
versions are pruned after every successful build. Publication stays draft until
installer, portable, checksums, provenance and CycloneDX SBOM are complete. Binary
updates verify the exact release asset, executable format and published SHA-256
before download staging and again before replacement. Authenticode is optional and
is not a release or updater dependency for this personal/internal application.
## 10. Release decision
No open P0 or P1 technical issue is known after the final quality, browser,
acceptance, signing and packaging gates. The technically correct status is:
`TECHNICALLY_COMPLETE`
There is no paid certificate or external signing-service dependency. Windows may
show its normal unknown-publisher warning during first installation.
+32
View File
@@ -0,0 +1,32 @@
# ForgeFlow 0.10.0
ForgeFlow 0.10.0 makes existing Unraid workloads substantially easier and safer to adopt, verify and deploy.
## Deployment discovery and verification
- Automatic discovery links unique running server workloads to their matching Gitea repositories while excluding unrelated infrastructure and stale release folders.
- Deployment cards preserve the last verified live commit and compare it with the current Gitea branch, even when a container was updated outside ForgeFlow.
- Existing Compose project names, files, services, remote folders and DockerMan metadata are adopted from server truth instead of guessed or overwritten.
## Safe Server pull
- Server pull is now the recommended deployment route and fetches the exact requested commit from Gitea.
- Each repository receives its own repository-scoped read-only deploy key; ForgeFlow never installs the desktop Gitea token on Unraid.
- Gitea SSH host fingerprints are pinned and checked before trust is changed and before every pull.
- Fetch, archive, checksum, Compose validation, activation and rollback remain exact-commit and transactional.
- Direct copy remains available when server-side Git access is undesirable, and monitoring-only links cannot deploy accidentally.
## Git hygiene
- Git Validator now also checks `.gitattributes`, `.editorconfig`, dependency lockfiles and a Gitea Actions workflow.
- Safe repairs create reviewable files without committing or pushing them automatically.
- Existing identity, upstream, synchronization, branch-protection, documentation, secret-path and oversized-file checks remain available in one scored view.
## Interface and reliability
- The deployment workspace now emphasizes repository, container, environment and live-versus-Gitea evidence, with a focused animated project illustration and clearer server inventory.
- Large unrelated server inventories are summarized instead of producing dozens of indistinguishable cards.
- Connection validation consistently opens the same encrypted Electron profile as the installed app.
- Obsolete ForgeFlow artifacts are removed from `dist` after every successful packaged build.
No container was restarted or replaced during automatic discovery. Deployments still require a successful preflight and an explicit user action.
+21
View File
@@ -0,0 +1,21 @@
# ForgeFlow 0.10.1
## Reliable certificate-free updates
- Windows installer and portable releases are supported without paid signing services.
- Packaged updates remain protected by exact Gitea release assets, PE validation and SHA-256 verification before staging and immediately before replacement.
- Old ForgeFlow versions are pruned from `dist` after each successful build.
## Deployment inventory correctness
- Repository matching is case-insensitive, so `Jens/Repo` and `jens/repo` refresh the same deployment profile.
- Running repository workloads are linked conservatively; third-party DockerMan applications remain visible as external monitoring-only workloads instead of generating hundreds of false repository problems.
- Historical and stopped duplicate definitions no longer require repetitive manual review.
- Shadowed automatic profiles are retired only after a recovery snapshot and a stable reviewed reconciliation plan.
- Live runtime, container health and commit evidence are refreshed before readiness is reported.
## Server pull verification
- Existing running repository workloads can receive repository-scoped read-only deploy keys without changing containers.
- The audit command supports compact inventory, reconciliation and access evidence for operational verification.
- Release acceptance no longer assumes an external Authenticode certificate while retaining checksum, provenance and SBOM checks.
+10
View File
@@ -0,0 +1,10 @@
# ForgeFlow 0.10.10
## Complete server-pull deployment repair
- Missing repository-scoped read-only deploy keys can be provisioned and verified from Unraid against the exact Gitea branch.
- A repository deployment root can now remain above its Compose working directory without breaking workload recognition or being overwritten by inventory refresh.
- Nested Compose files are preserved as repository-relative deployment paths, including Ludarium, Launchpad and ITWorx MCP Hub layouts.
- The **Fix write access** action now receives its permission-report parser correctly instead of reporting a false write-access failure.
- Server-pull preflight proves every required deployment file at the exact Gitea commit before any container activation starts.
- Runtime secrets remain in server-side `.env` files and preserved appdata paths; no secret values are written to Git or diagnostic output.
+10
View File
@@ -0,0 +1,10 @@
# ForgeFlow 0.10.11
## Resilient repository refresh and consistent server pull
- Temporary Gitea list failures now use the in-session **last-known-good** repository inventory while local and server state continue to refresh. The UI clearly reports that remote data is stale.
- A **closed output pipe** from a detached parent process is no longer treated as a fatal desktop-app exception.
- Server pull, deploy-key verification, deployment, rollback and metadata now consistently prefer the verified **linked checkout origin** over a stale URL detected earlier on the server.
- Repository-scoped **read-only deploy key** checks remain fail-closed; a changed SSH host still requires explicit trust and access reconfiguration.
- The local **browser test server** now has a dedicated port and identity endpoint, preventing another localhost application from being mistaken for ForgeFlow.
- All 42 responsive browser flows pass across dark/light, compact/wide and reduced-motion configurations.
+12
View File
@@ -0,0 +1,12 @@
# ForgeFlow 0.10.12
## Faster awareness with stricter deployment truth
- Repository refreshes are **coalesced** and briefly cache Gitea inventory and workspace discovery; a manual refresh remains fully forced and file changes arriving mid-refresh receive one trailing refresh.
- Server discovery reuses its Docker and Compose evidence for existing deployment profiles instead of opening a separate SSH session for every linked workload.
- Deployment status only claims **exact Gitea commit parity** after comparing a concrete branch SHA with the live server SHA; matching repository provenance alone is no longer sufficient.
- Container discovery uses **batched Docker inspect** with a safe per-container fallback when a container disappears during the scan.
- Active Gitea and SSH deployment polling uses **bounded worker pools**, improving multi-deployment latency without flooding external services.
- A **stopped container** can no longer be marked healthy because another process answers on its previous healthcheck port.
- Large repository and server-inventory lists use offscreen rendering containment to reduce layout and paint work.
- Inventory diagnostics now include scan and state-refresh durations, and Gitea bulk verification fails fast after a confirmed connectivity outage.
+18
View File
@@ -0,0 +1,18 @@
# ForgeFlow 0.10.13
## Veilige synchronisatie en aantoonbare release-integriteit
- **Gitea workspace sync** toont eerst de exacte additions, wijzigingen en deletions ten opzichte van de actuele upstream-SHA. Lokale commits worden beschermd in een recovery branch; staged, unstaged en untracked werk gaat naar een stash. Genegeerde runtimebestanden blijven onaangeroerd.
- Read-only achtergrondfetch houdt `ahead` en `behind` actueel zonder projectbestanden automatisch te wijzigen. Interval `0` schakelt netwerkfetch volledig uit.
- Stale deployment links blokkeren niet langer de automatische, bewijsgebaseerde koppeling van de werkelijk draaiende vervangende workload.
- SSH-hostidentiteit wordt vóór het verzenden van credentials getoond en bij bevestiging exact vastgepind. Gitea-tokens vereisen HTTPS, behalve bij expliciete loopbackontwikkeling.
- Packaged updates vereisen een **Ed25519-signed release manifest** dat versie, tag, broncommit, artifactnaam, bytegrootte en SHA-256 bindt aan de ingebouwde publisher key. Hiervoor is geen betaald certificaat of Azure-dienst nodig.
- Diagnostische bundels exporteren geen ruwe remote output meer. Untracked diffs kunnen geen junction of symlink buiten de repository volgen en zijn begrensd op bestandsgrootte.
- De Git-toolsgrid behoudt nu de volledige inhoudshoogte binnen zijn eigen scrollvlak; workspace sync en troubleshooting overlappen niet meer. De demo bridge ondersteunt dezelfde recoveryflow als de desktopapp.
- Repositorymonitoring, deploymentpolling, Docker-inspect en SSH-verbindingen gebruiken begrensde paralleliteit en hergebruik waar dat veilig is.
## Verificatie
- Volledige Node-testset, coveragepoort, architectuuraudit en dependency-audit.
- 72 browserflows over dark/light, compact/desktop/wide, 100150% schaal en reduced motion.
- Windows installer en portable build, SHA-256-sidecars, provenance, CycloneDX-SBOM en ondertekend releasemanifest.
+9
View File
@@ -0,0 +1,9 @@
# ForgeFlow 0.10.2
## Packaged updater origin repair
- Gitea release assets that expose an internal HTTP `ROOT_URL` are safely rewritten to ForgeFlow's configured public HTTPS Gitea origin.
- Authentication remains same-origin: the Gitea token is never forwarded to an internal address, CDN or unrelated redirect target.
- Published Windows executables are still validated as PE files and against their release SHA-256 sidecars before staging.
- The live authenticated updater acceptance downloads the exact published installer and proves its byte count and SHA-256 digest.
+19
View File
@@ -0,0 +1,19 @@
# ForgeFlow 0.10.3
## Responsive large workspaces
- Repository monitoring checks up to four local working trees concurrently while retaining overlap protection and per-repository pause controls.
- Global search, repository filtering and the command palette debounce full interface renders during rapid typing.
- Commit-message input updates readiness and action controls in place, preserving focus and cursor responsiveness.
- Interactive project illustrations and diff atmosphere effects perform at most one layout update per animation frame.
## Git Validator reliability
- Git Validator and every long repository tab now retain an explicit vertical scroll owner across compact, desktop and wide layouts.
- Standard, Strict and Production policies correctly treat configured warning severities as blockers; Minimal remains error-only.
- Documented suppressions no longer reduce the hygiene score or remain counted as active blockers.
- Repair requests are rescanned immediately before preview or execution, preventing stale or forged fixes.
## Verification
- Full quality gate, coverage thresholds and all responsive browser scenarios pass for this release.
+9
View File
@@ -0,0 +1,9 @@
# ForgeFlow 0.10.4
## Permanent packaged updater handshake repair
- Binary and source update helpers now use a Windows PowerShell 5.1-compatible atomic status replacement with a real temporary backup path.
- A deterministic overwrite fallback preserves lifecycle reporting on filesystems that do not implement atomic replacement.
- The binary helper exposes a side-effect-free handshake-only verification mode exercised by the real Windows PowerShell executable during tests.
- existing installations with the defective helper require this one-time installer upgrade; every subsequent packaged update uses the repaired helper automatically.
- Startup failures retain request-scoped status and helper-log evidence instead of collapsing into an unexplained exit-code message.
+10
View File
@@ -0,0 +1,10 @@
# ForgeFlow 0.10.5
## Consistent repository and deployment links
- Every repository workspace now shows all configured deployment environments in a compact, directly actionable strip.
- The repository deployment tab includes every detected server workload linked to that repository, including its container, Compose identity, server and runtime state.
- A workload is only labelled linked when its repository and resolved profile both exist in the current ForgeFlow configuration.
- Stale or incomplete metadata is shown as **Link unresolved** and routed through explicit reconciliation instead of being presented as a healthy deployment.
- The global deployment inventory links directly to the correct repository deployment profile.
- Responsive browser coverage now verifies valid links, unresolved links, repository navigation and scrolling across dark/light and scaled layouts.
+9
View File
@@ -0,0 +1,9 @@
# ForgeFlow 0.10.6
## Permanent Windows updater launch repair
- ForgeFlow no longer launches hidden PowerShell update helpers with Node's defective Windows `detached` process mode.
- Binary and source updater processes remain hidden, are explicitly unreferenced after their verified handshake, and continue independently when ForgeFlow closes.
- A real Windows regression test now exercises the exact production Node spawn options instead of using a different process API.
- Startup is still fail-closed: ForgeFlow remains open unless the request-scoped helper status reaches `started`.
- Versions 0.10.4 and 0.10.5 need a one-time direct installation of 0.10.6 because their installed launcher cannot execute its own helper; updates after 0.10.6 use the repaired path.
+10
View File
@@ -0,0 +1,10 @@
# ForgeFlow 0.10.7
## Reliable server-to-repository recognition
- Live, running workloads with one unique exact provenance or runtime-identity match are now linked automatically during normal server discovery.
- Automatic adoption creates only ForgeFlow configuration and observed state; it performs no container changes and never automatically removes stale profiles.
- Ambiguous, duplicate, external and monitoring-only workloads remain behind explicit **Review & link** confirmation.
- Every linked repository now displays an `S` deployment badge with its profile count in the repository sidebar.
- The repository release rail reports **Linked** with container and server identity even when a legacy workload has no verifiable live commit yet.
- DevRunbook-style DockerMan deployments therefore show the same linked relationship in Deployments, the repository sidebar and the repository workspace.
+9
View File
@@ -0,0 +1,9 @@
# ForgeFlow 0.10.8
## Self-contained checksum verification
- Binary and source update helpers no longer depend on the optional PowerShell `Get-FileHash` cmdlet.
- Both helpers calculate checksums directly with the built-in .NET SHA-256 implementation.
- A real Windows regression test clears `PSModulePath` and verifies the downloaded binary successfully in that minimal environment.
- The helper still validates the exact published checksum before waiting for ForgeFlow to exit or changing installed files.
- This release retains the reliable non-detached launcher and server-to-repository recognition improvements from 0.10.6 and 0.10.7.
+10
View File
@@ -0,0 +1,10 @@
# ForgeFlow 0.10.9
## Reliable deployment inventory and preflight
- Unraid inventory now includes containers without healthchecks. Docker's complete JSON state is parsed safely instead of using a failing Go-template lookup.
- ForgeFlow is single-instance: opening it again focuses the existing window, preventing concurrent inventory scans and configuration writes.
- Server pull verifies required Compose files or the Dockerfile at the exact Gitea commit before any deployment operation starts.
- Server-pull verification now separates deploy-ready access from optional live-SHA and runtime-health evidence. A recoverable workload is no longer shown as blocked merely because parity is not yet provable.
- Deployment cards and audit output show concrete access blockers and non-blocking warnings instead of a generic incomplete result.
- All discovery, verification and preflight checks remain non-destructive; no containers are changed during these checks.
+22
View File
@@ -0,0 +1,22 @@
# ForgeFlow 0.8.7
ForgeFlow 0.8.7 automatically discovers applications already running on every
configured and trusted Unraid server. It inventories server-side Git checkouts,
Docker Compose metadata, bind mounts, container identity and image provenance,
then links each workload to a Gitea repository only when the evidence produces
one unambiguous match.
Uniquely matched workloads are added to Deployments automatically, even when
they were originally deployed outside ForgeFlow. Every refresh resolves the
configured branch directly on Gitea and compares its full commit SHA with the
live server version. A deployment is reported as in order when the SHAs match,
the container is running and Docker health is not failing.
Containers without a server-side Git checkout can also be discovered when the
image exposes standard OCI source/revision labels or ForgeFlow provenance
labels. New ForgeFlow deployments now write repository, branch and exact commit
labels so future discovery remains deterministic.
Ambiguous or weak matches are intentionally left unlinked for manual review.
Server inventory is read-only; automatic adoption changes only ForgeFlow's local
configuration.
+13
View File
@@ -0,0 +1,13 @@
# ForgeFlow 0.8.8
ForgeFlow 0.8.8 fixes the HTTP 404 returned while downloading packaged updates
from the configured Gitea server.
The server's API requires release attachments to be addressed using both the
immutable release ID and attachment ID. ForgeFlow now uses that exact
release-scoped endpoint for the executable and its checksum file.
Strict same-origin token protection and SHA-256 verification remain unchanged.
Install 0.8.8 manually when upgrading from 0.8.7 because the affected download
code runs before the corrected updater can be installed. Future packaged
updates can again be completed from inside ForgeFlow.
+20
View File
@@ -0,0 +1,20 @@
# ForgeFlow 0.8.9
ForgeFlow 0.8.9 introduces Git Validator, a dedicated repository assurance
workspace that checks whether practical Git and Gitea best practices are being
followed.
The validator produces a weighted score with evidence for repository identity,
upstream tracking, working-tree state, effective commit identity, safe local
synchronization defaults, default-branch and force-push protection, README and
gitignore hygiene, tracked secret-shaped filenames and oversized tracked files.
Every repair is deliberately bounded. Origin alignment and repository-local
fetch/pull/autostash safeguards can be applied as safe fixes. Creating default
branch protection or a recommended `.gitignore` requires explicit confirmation.
The generated `.gitignore` remains uncommitted for review, and secret/history
findings are never modified automatically.
The new workspace includes grouped findings, an assurance score, safe-fix
batching, audit events, interactive project illustration and responsive premium
layouts for light and dark themes.
+30
View File
@@ -0,0 +1,30 @@
# ForgeFlow 0.9.0
ForgeFlow 0.9.0 changes Unraid deployments from a Git-checkout-first workflow into a server-inventory-first workflow.
## Existing installations are now visible
Server Inventory collects a safe, selected subset of Docker, Compose and DockerMan metadata for both running and stopped containers. It recognizes Compose project names, working directories, active Compose files and services, mounts, ports, runtime state, image provenance and existing DockerMan templates. Environment values and other container secrets are not collected.
Exact repository provenance may be linked automatically. Name similarity is never treated as proof: uncertain workloads remain visible as suggestions and can be linked through the new manual wizard. The saved link preserves the workload identity rather than depending on the disposable container ID.
## Push bundle is the new default
New SSH/Unraid profiles use **Push bundle**. ForgeFlow creates a tar archive from the exact local Git commit, calculates its SHA-256 digest and uploads it over the already trusted desktop-to-Unraid SSH connection. Unraid therefore does not need a Git client, Gitea host-key entry or Gitea private key for this mode.
The server verifies the checksum and archive paths, rejects symlink payloads, preserves configured runtime paths, updates only ForgeFlow-managed files and validates the merged Compose model before starting services. The active SHA and managed-file manifest are promoted atomically only after the expected services are running. Failure restoration keeps the previous deployment truth and restores overwritten files and Compose metadata.
**Server-side Git** remains available as an explicit mode. Its Gitea access check is now reported separately from desktop SSH and Docker/Compose capabilities. **Monitor only** links an existing workload without granting ForgeFlow permission to deploy it.
## Safer adoption
Adopted workloads retain their existing Compose project, Compose files and service set. ForgeFlow no longer overrides their image or container name in the metadata overlay. Existing DockerMan templates are left untouched; generated templates are managed only for explicitly generated Compose profiles. `--force-recreate` and `--remove-orphans` are opt-in rather than defaults.
A deployment lock records the live shell process, and an old lock is removed only when it is sufficiently old and its owner no longer runs. Deployment output truncation now fails explicitly instead of allowing ForgeFlow to interpret an incomplete inventory or command result.
## Release publication correction
- The standard release publisher now publishes the validated source and matching Windows binary assets as one workflow.
- Added `Publish-Missing-Binary-Release.ps1` to repair a source-only Gitea release without reinstalling ForgeFlow manually.
- Binary publication now derives the repository owner, repository name and branch from ForgeFlow settings instead of hardcoding them.
- Missing-release errors now explain that packaged installations require both Windows executables and their SHA-256 sidecars.
+10
View File
@@ -0,0 +1,10 @@
# ForgeFlow 0.9.1
## Gitea binary updater repair
- Downloads the actual release attachment through `browser_download_url` instead of treating the Gitea attachment metadata response as an executable.
- Keeps the Gitea token on the configured Gitea origin and follows HTTPS object-storage redirects without leaking credentials.
- Adds regression coverage for attachment metadata lookup, direct browser download URLs and cross-origin redirect safety.
- Improves diagnostics when an older updater receives JSON attachment metadata.
Because ForgeFlow 0.8.9 and 0.9.0 contain the broken attachment endpoint, upgrading to 0.9.1 requires one manual installer run. in-app updates work normally again after 0.9.1 is installed.
+10
View File
@@ -0,0 +1,10 @@
# ForgeFlow 0.9.2
## Emergency deployment and discovery repair
- Existing deployment profiles without an explicit mode migrate to **Push bundle**, never Server-side Git.
- Push bundle deploys the clean, committed local HEAD directly over SSH/SFTP and never requires a Gitea key, upstream, remote sync, or Git on Unraid.
- Desktop-to-Unraid authentication can use the server password; a failed key opens a password recovery flow instead of blocking deployment.
- Server inventory scans `docker ps -a`, complete Docker inspect data, Compose projects, and every DockerMan user template, including stopped and template-only workloads.
- Inventory connection failures are shown as failures rather than misleading zero counts.
- Existing Compose and DockerMan workloads can be linked manually without restarting or modifying them.
+25
View File
@@ -0,0 +1,25 @@
# ForgeFlow 0.9.3
This release removes server-side repository authentication from every SSH/Unraid deployment path and makes server Compose files the primary discovery source.
## Direct deployment only
- Every existing SSH/Unraid deployment profile is migrated to **Direct copy**, except profiles explicitly marked **Monitor only**.
- Deployment and rollback archive the exact committed local HEAD, upload it over the already configured desktop-to-Unraid connection and run Docker Compose on Unraid.
- Preflight contains no Unraid-to-repository access probe, no remote `git ls-remote`, no repository-key validation and no Git requirement on Unraid.
- Password authentication for the desktop-to-Unraid connection remains supported and is independent of repository access.
## Compose-file inventory and automatic linking
- Server Inventory scans Compose YAML files such as `compose.yml`, `compose.yaml`, `docker-compose.yml`, `docker-compose.yaml`, overrides and stack YAML files below the configured appdata roots.
- YAML discovery still runs when Docker inspection fails or Docker is unavailable, so a container-query problem no longer produces a false empty inventory.
- ForgeFlow reads the Compose project name, file set, service names and image names from the server.
- A unique high-confidence repository match based on both Compose folder and project identity is linked automatically.
- Remaining strong matches use a one-click link action with server folder, Compose project, Compose files, services, container identity and preservation paths already filled in.
- Runtime containers, stopped containers and DockerMan templates are merged with the YAML definition when available. `/mnt/user/appdata`, `/mnt/cache/appdata` and disk-backed appdata paths are treated as the same logical deployment location.
## Reliability
- The inventory shell script is safe under `set -euo pipefail`; Docker or Compose command failures are captured as warnings instead of aborting the scan.
- Large runtime, cache, log and database folders are pruned while searching for Compose files.
- A failed inventory operation remains visible as an error and is never presented as zero workloads.
+7
View File
@@ -0,0 +1,7 @@
# ForgeFlow 0.9.4
ForgeFlow now treats the real Compose files discovered on Unraid as the only activation source for adopted workloads. A generated labels fragment is no longer merged into an imported project, so stale service hints such as `geointel` cannot create a phantom service without an image or build context.
Direct copy redeployments always use `--force-recreate`. The runtime service list comes from `docker compose config --services`, not from manually stored service names. Before activation ForgeFlow records the existing container ID for every service; after activation it verifies that each service is running, not unhealthy, and uses a different container ID.
ForgeFlow also rejects the deployment when Compose starts a duplicate workload while leaving the previous container running. The new SHA is written only after these checks pass. Existing DockerMan templates and the real Compose files remain untouched.
+11
View File
@@ -0,0 +1,11 @@
# ForgeFlow 0.9.5
ForgeFlow 0.9.5 makes Direct copy deployments fail closed and adds an in-app repair for Unraid write permissions.
Before a bundle is created or uploaded, ForgeFlow probes the linked project folder, `.forgeflow` upload/state folders and every active Compose file using the configured SSH identity. A failed check names the exact path, user, owner, group and mode. Deployment stops before file transfer and before any Docker or Compose command changes the runtime. The same write-access check runs again immediately before upload to prevent a stale preflight result.
Every SSH / Unraid deployment card now includes **Check / fix write access**. The same action appears beside a blocking preflight result. It normalizes the linked source tree and ForgeFlow state folders to safe shared access, uses the Unraid `users` group where available and preserves existing executable bits. Configured runtime locations such as `.env`, `appdata`, `data`, `config`, `logs`, mounted data paths and common generated dependency folders are excluded. It never runs Docker, stops a container, removes a container or uses `chmod 777`. The action also runs when the SSH account is root so manual SMB/file-copy access can be repaired, not only ForgeFlow's own write access.
Direct copy now validates candidate Compose configuration and builds candidate images before replacing live source files. It never implicitly executes `docker compose down`, `--remove-orphans` or `--force-recreate`. Existing container IDs, image IDs and source files are captured first. When activation fails, ForgeFlow restores the prior source, retags the previous images, attempts to restore the previous runtime and retains the backup evidence. A release is only promoted after the exact linked Compose services are running and verified.
This release does not claim live validation against a specific private Unraid server. The automated suite validates generated Bash syntax, permission-report parsing, scoped repair commands, no server-to-Gitea authentication, no destructive Compose flags and transactional deployment ordering.
+56
View File
@@ -0,0 +1,56 @@
# Releasing ForgeFlow
ForgeFlow releases are built only from a clean, reviewed commit on Node 22 LTS.
## Quality gate
```powershell
npm ci
npm run quality
npm audit --omit=dev --audit-level=high
```
## Windows build — no paid services required
ForgeFlow is a personal/internal tool. The supported release path therefore has
no certificate, Azure or other paid-service dependency:
```powershell
npm run dist:win
```
Run `npm run signing:setup` once on the release workstation. It stores the
private Ed25519 key outside the repository and writes only its public key into
the packaged app. `npm run dist:win` then produces the installer and portable
executable, SHA-256 sidecars, CycloneDX SBOM, provenance and an Ed25519-signed
manifest bound to the exact source commit. The updater verifies the pinned
publisher key before trusting the artifact digest and verifies that digest again
immediately before replacing the installed executable.
Windows can display an `Unknown publisher` warning for an unsigned installer.
That warning concerns public publisher reputation; it does not prevent ForgeFlow
from installing or using its checksum-verified in-app updates. Authenticode can
be added later as an optional distribution convenience, but is not required for
correct operation.
## Atomic publication
`npm run release:binary` keeps the Gitea release in draft state while uploading
the installer, portable executable, two checksums, provenance, SBOM, signed
manifest and signature. It only publishes after all eight assets are present. A
failed upload leaves a draft rather than exposing an incomplete updater target.
The optional signing acceptance fixture can still validate the complete local
Authenticode chain without purchasing or retaining a certificate:
```powershell
npm run test:signing
```
This disposable fixture signs installer, portable, update-helper and uninstaller
stand-ins, requires an RFC 3161 timestamp, and proves rejection of a missing
timestamp, wrong publisher and a modified binary. Its certificate is removed
from the current-user certificate store after the test.
The disposable test certificate is removed from the current-user certificate
store after the test and is never used for a published build.
+1 -1
View File
@@ -94,7 +94,7 @@ health verification, diagnostic correlation and no arbitrary shell input.
- Windows installer/portable acceptance; - Windows installer/portable acceptance;
- macOS/Linux package validation; - macOS/Linux package validation;
- code signing, notarization and signed updates; - optional code signing/notarization for future public distribution;
- dependency/secret/package scans; - dependency/secret/package scans;
- accessibility review; - accessibility review;
- hundreds-of-repositories performance tests; - hundreds-of-repositories performance tests;
+7 -3
View File
@@ -108,9 +108,9 @@ included model uses:
- atomic non-secret status JSON; - atomic non-secret status JSON;
- previous-SHA recording and non-zero failure exits. - previous-SHA recording and non-zero failure exits.
## Remaining release hardening ## Optional and future release hardening
- code-sign packages and signed updates; - optional code signing if ForgeFlow is ever distributed publicly;
- validate private CA/TLS behavior in the target network; - validate private CA/TLS behavior in the target network;
- dependency, secret and binary scans in CI; - dependency, secret and binary scans in CI;
- package-level IPC/navigation regression tests; - package-level IPC/navigation regression tests;
@@ -124,9 +124,13 @@ included model uses:
- SSH passwords and private-key passphrases use Electron `safeStorage`; - SSH passwords and private-key passphrases use Electron `safeStorage`;
- diagnostics receive those runtime secrets only for redaction and never export - diagnostics receive those runtime secrets only for redaction and never export
encrypted credential fields; encrypted credential fields;
- SSH deployment requires a pinned host-key fingerprint; - SSH host identity is previewed without credentials and authenticated sessions
require the exact user-confirmed pinned fingerprint;
- remote folders and Compose paths are validated against traversal; - remote folders and Compose paths are validated against traversal;
- tracked server-side changes block exact-SHA reset; - tracked server-side changes block exact-SHA reset;
- updater tokens are sent only to the configured Gitea origin; - updater tokens are sent only to the configured Gitea origin;
- non-loopback Gitea connections require HTTPS;
- packaged updates require a publisher-signed Ed25519 manifest that binds the
source commit, artifact identity, byte length and SHA-256 digest;
- update archives are checksummed and validated by the full local quality gate; - update archives are checksummed and validated by the full local quality gate;
- source backup is restored when an update fails. - source backup is restored when an update fails.
+65 -87
View File
@@ -1,95 +1,73 @@
# SSH / Unraid deployment # SSH / Unraid deployment
ForgeFlow deploys an exact Gitea commit directly to an Unraid server over pinned SSH. ForgeFlow uses one deployment flow for Unraid: it copies the exact committed local project from the desktop to the server and activates the Compose definition found for that deployment.
## Security model ## Deployment modes
- Credentials are entered only in the local ForgeFlow desktop application. ### Direct copy — default
- Ed25519 private keys are preferred.
- Passwords and key passphrases use Electron safe storage. ForgeFlow creates an archive from the exact local commit and uploads it through the configured desktop-to-Unraid connection. Unraid needs Docker, Docker Compose, `tar` and a SHA-256 checksum tool. Unraid does not clone, fetch or authenticate to a repository.
### Monitor only
ForgeFlow inventories and tracks the workload but refuses deploy and rollback operations until **Direct copy** is selected.
All older SSH/Unraid profiles are migrated to Direct copy unless they were explicitly Monitor only.
## Server Inventory and automatic linking
Server Inventory reads the server itself instead of relying on ForgeFlow history. The default scan root is `/mnt/user/appdata`, together with the configured server base path and the cache-backed appdata path when present. It combines:
- running and stopped containers from `docker ps -a` and Docker Inspect;
- active and stopped Compose projects;
- DockerMan templates;
- Compose YAML files below the configured appdata roots, including standard override files.
YAML discovery continues even when Docker inspection fails. For each Compose definition ForgeFlow reads the working directory, project name, file set, services and images. It then compares those values with the linked local repositories.
A unique high-confidence match based on both the Compose folder and project identity is linked automatically. Other strong matches show a one-click **Link to repository** action. The server folder, Compose project, Compose files, service list, visible container identity, ports and preservation paths are already filled in; linking does not recreate the container.
## Compose identity
An adopted installation retains the identity detected on the server:
```text
Visible container: geointel
Server folder: GeoIntel
Compose project: geointel
Compose files: compose.yml, compose.override.yml
Compose services: web, worker
```
ForgeFlow adds `.forgeflow/compose.metadata.yml` as the final Compose overlay. For adopted workloads this overlay adds safe labels only; it does not replace the existing image, volumes, ports, networks or `container_name`.
`--force-recreate` and `--remove-orphans` remain disabled by default. Existing DockerMan templates are not rewritten.
## Direct-copy sequence
1. Verify the selected local branch, clean working tree and exact committed HEAD.
2. Test the desktop-to-Unraid connection, Docker, Compose, `tar`, checksum tooling and deployment storage.
3. Create the release locally with `git archive`.
4. Upload a temporary `.part` file through SFTP.
5. Verify SHA-256 and reject unsafe archive paths or symbolic links.
6. Preserve `.forgeflow`, `.git` and configured runtime paths such as `.env`, `data`, `config`, `logs` and application-specific folders.
7. Update only files covered by the managed release manifests; unrelated server files remain untouched.
8. Validate the detected merged Compose configuration.
9. Activate the retained Compose project and verify every selected service is running and not unhealthy.
10. Promote the active SHA and manifests only after activation succeeds.
11. Run the optional desktop health check and persist runtime state.
If activation fails, ForgeFlow restores the previous managed files and Compose metadata and leaves the previous active SHA authoritative.
## Authentication model
- The only remote authentication used for Direct copy is the configured desktop-to-Unraid connection.
- That connection may use an Unraid password or a private key.
- Passwords and private-key passphrases use Electron safe storage.
- The first trusted connection records the SSH host-key fingerprint; later changes fail closed. - The first trusted connection records the SSH host-key fingerprint; later changes fail closed.
- Unraid-to-Gitea repository access is tested during every deployment preflight. - Remote inventory collects selected labels, mounts, ports and runtime state; it does not collect container environment values.
- The renderer cannot submit arbitrary shell commands. Remote scripts are assembled from validated profile fields and transported as base64-encoded Bash input. - The renderer cannot submit arbitrary shell commands; remote scripts are assembled from validated profile fields.
- Tracked server-side modifications block deployment and rollback.
## Profile identity
ForgeFlow separates names that users see from names Docker requires:
```text
Visible project/container: Portfolio
Server folder: Portfolio
Internal Compose project: portfolio
Internal Compose service: portfolio
Internal image: forgeflow/portfolio:production
```
The internal Compose service must match the repository's service key and remain lowercase. The visible container can preserve branding and casing.
## DockerMan WebUI, icon and shell
ForgeFlow writes `.forgeflow/compose.metadata.yml` and combines it with the repository or generated Compose file. The override supplies:
```text
net.unraid.docker.managed=dockerman
net.unraid.docker.webui=http://[IP]:[PORT:<host-port>]/
net.unraid.docker.icon=<PNG URL or persistent Unraid path>
net.unraid.docker.shell=sh
```
Icon modes:
- **Built-in high-contrast ITWorx mark** — default;
- **Upload local PNG** — copied to `/boot/config/plugins/dockerMan/images/<container>-icon.png`;
- **Use icon URL** — HTTP(S) PNG;
- **No custom icon**.
After metadata changes ForgeFlow recreates the container, writes `/boot/config/plugins/dockerMan/templates-user/my-<container>.xml`, removes known icon caches and invalidates DockerMan's volatile `docker.json` metadata cache. The Unraid Docker page may still need one browser refresh.
The deployment card reports whether WebUI and icon labels were confirmed through `docker inspect`. **Repair DockerMan integration** recreates an existing healthy container with labels, a persistent DockerMan template, icon cache refresh and WebUI metadata without creating a Git commit. **Open Web UI** uses the profile URL directly from the desktop.
## Existing application folder
For an existing folder:
```text
Server folder: Portfolio
Remote path: /mnt/user/appdata/Portfolio
Compose file: docker-compose.yml
```
The project root must be a Git working tree. Untracked runtime paths such as `.env`, `appdata`, `data`, `logs`, `config` and `compose.override.yml` remain untouched by `git reset --hard`. Nested Git repositories are warnings and never deleted automatically.
Preflight inspects `.dockerignore` when a Dockerfile exists. It warns when `.git`, preserved runtime data or nested repositories would be sent into the build context.
## New application folder
The server clones the configured URL on the selected branch. The Unraid host therefore needs a non-interactive Gitea SSH identity. Preflight runs `git ls-remote --exit-code` from Unraid before deployment.
Use repository Compose for real applications. Generated Compose is intended only for a simple single-service Dockerfile application with basic port mapping.
## Deployment sequence
1. Verify clean local tree, allowed branch, upstream and ahead/behind state.
2. Verify the exact SHA exists on the allowed remote branch.
3. Verify Unraid can read the Gitea repository.
4. Inspect the server folder and refuse tracked server changes.
5. Clone when the folder is absent.
6. Fetch the branch and verify the exact SHA is an ancestor of `origin/<branch>`.
7. Save the previous SHA and reset to the requested SHA.
8. Write generated Compose when selected.
9. Write the DockerMan metadata override and persistent template fallback.
10. Validate the merged Compose model.
11. Run `docker compose up -d --build --remove-orphans --force-recreate`.
12. Clear relevant icon caches.
13. Inspect the visible container and write `.forgeflow/status.json`.
14. Run the configured desktop healthcheck.
15. Persist the live SHA, previous SHA, health, container and DockerMan state.
## Interrupted operation recovery
At startup and through **Reconcile**, ForgeFlow reads the live SHA, container running state, Docker health, labels and persistent template state. When a previously running operation already reached its exact requested SHA and the container is healthy, the operation becomes `success`. Operations that remain unresolved for more than 45 minutes become `failed` rather than staying indefinitely in deployment mode.
## Rollback ## Rollback
Rollback is accepted only for the exact SHA currently recorded as `previousSha`. ForgeFlow re-verifies that commit against Gitea, refuses tracked server changes, resets the same working tree, reapplies Compose and DockerMan metadata, reruns health checks and rotates the former live SHA into the new rollback target. Rollback is allowed only to the exact `previousSha` recorded for the profile. ForgeFlow recreates that commit archive locally and uses the same upload, checksum, backup, Compose validation and atomic promotion flow.
+33 -3
View File
@@ -1,8 +1,37 @@
# Test matrix # Test matrix
## Automated in v0.4.0 ## Automated baseline (0.10.x)
The suite contains 59 passing tests. The quality chain contains more than 230 Node and browser acceptance cases. The
latest Windows source run completed without failures and retains one explicitly
Bash-dependent skip. `npm run coverage` enforces 75% lines/statements/functions
and 65% branches; the measured hardening baseline is 81.48% statements/lines,
82.07% functions and 65.59% branches. See `COVERAGE_POLICY.md` for the
non-gamed branch policy.
`npm run quality` is the local equivalent of `.gitea/workflows/quality.yml` and
runs source verification, ESLint, the complete suite and coverage on Node 22 LTS.
Production dependencies are separately checked with `npm audit --omit=dev
--audit-level=high`.
### Server safety and reconciliation
- inventory discovery is read-only and byte-stable for configuration;
- reconciliation requires a content-addressed preview plan and recovery snapshot;
- automatic linking requires unique exact provenance/runtime identity;
- server-pull verification checks Gitea branch, read-only deploy-key ID, pinned
host/key fingerprints, remote/live SHA, Compose evidence, runtime and health;
- a fresh access verification is mandatory immediately before server-pull deploy;
- writable or missing deploy keys fail closed.
### Renderer regression matrix
Playwright runs 36 cases across 1120×720, 1440×900 and 1920×1080, dark and
light themes, reduced motion, and simulated 100%, 125% and 150% Windows scaling.
It checks console/page errors, accessible names, labels, heading structure,
horizontal overflow, viewport containment, dialogs, keyboard focus, updater and
deployment failure evidence. CI retains screenshots, video, trace, console JSON,
DOM HTML and fixture context on failure.
### Git and repository behavior ### Git and repository behavior
@@ -76,7 +105,8 @@ The suite contains 59 passing tests.
- status endpoint through the real reverse proxy; - status endpoint through the real reverse proxy;
- deployment lock, failed healthcheck and rollback; - deployment lock, failed healthcheck and rollback;
- diagnostic ZIP inspection after a deliberately failed deployment; - diagnostic ZIP inspection after a deliberately failed deployment;
- unsigned installer and portable build on Windows; - locally test-signed installer, portable, helper and uninstaller fixtures with
RFC 3161 timestamp plus wrong-publisher, missing-timestamp and tamper rejection;
- keyboard-only and screen-reader smoke test. - keyboard-only and screen-reader smoke test.
## Renderer smoke target ## Renderer smoke target
+23 -7
View File
@@ -30,19 +30,35 @@ Update logs and status files are stored beneath ForgeFlow's local user-data `upd
## Packaged Windows updates ## Packaged Windows updates
ForgeFlow 0.8.2 and newer use authenticated Gitea release assets when running from the installer or portable executable. The updater selects the installer or portable artifact that matches the current installation mode, requires its `.sha256` sidecar, validates the Windows executable header and SHA-256 digest, then verifies the digest again immediately before applying it. An external PowerShell helper waits for ForgeFlow to exit, installs or replaces the executable and restarts it. ForgeFlow uses authenticated Gitea release assets when running from the installer or portable executable. The updater selects the artifact that matches the current installation mode and requires its `.sha256` sidecar. From version 0.10.13 onward it also requires an Ed25519-signed release manifest. The embedded public key verifies that manifest before ForgeFlow trusts the artifact name, byte length, exact source commit or SHA-256 digest. The digest is checked again immediately before applying the update.
Publish a verified binary release after pushing its source commit: `Publish-ForgeFlow-Release.ps1` treats source and binaries as one release transaction. It pushes the validated source, builds the exact published commit and uploads eight required assets:
- `ForgeFlow-Setup-<version>-win-x64.exe`
- `ForgeFlow-Setup-<version>-win-x64.exe.sha256`
- `ForgeFlow-Portable-<version>-win-x64.exe`
- `ForgeFlow-Portable-<version>-win-x64.exe.sha256`
- `ForgeFlow-<version>-provenance.json`
- `ForgeFlow-<version>-sbom.cdx.json`
- `ForgeFlow-<version>-release-manifest.json`
- `ForgeFlow-<version>-release-manifest.json.sig`
Run `npm run signing:setup` once on the release workstation. The private Ed25519 key stays outside the repository in ForgeFlow's user-data folder. This independent publisher signature is free; optional Authenticode can still be added later for Windows reputation.
Use `-SkipBinaryRelease` only when intentionally publishing source without enabling packaged auto-update.
When the source was already pushed without a binary release, run the recovery publisher from Windows:
```powershell ```powershell
npm run dist:win Set-ExecutionPolicy -Scope Process Bypass
$env:FORGEFLOW_USER_DATA = "$env:APPDATA\forgeflow" .\Publish-Missing-Binary-Release.ps1 -ExpectedVersion 0.9.1
npm run release:binary
``` ```
The recovery script clones the current Gitea branch into a temporary directory, verifies the exact branch commit, runs the complete quality gate, builds both Windows artifacts and creates or repairs the matching Gitea release. It uses the encrypted Gitea token already stored by ForgeFlow.
Every platform build finishes by removing ForgeFlow artifacts for older versions from `dist`. The unpacked application directory and builder diagnostics are kept. Every platform build finishes by removing ForgeFlow artifacts for older versions from `dist`. The unpacked application directory and builder diagnostics are kept.
The publisher refuses to upload when local `HEAD` differs from `origin/main`. Users on 0.8.1 or older need one manual 0.8.2 installation because those versions deliberately disabled packaged updates. The binary publisher refuses to upload when local `HEAD` differs from the configured Gitea branch. ForgeFlow 0.8.9 and 0.9.0 queried Gitea attachment metadata as though it were the executable. Those versions require one manual 0.9.1 installer run. From 0.9.1 onward, the updater follows the release asset browser download URL and in-app updates work normally.
## Publishing a release from Downloads ## Publishing a release from Downloads
@@ -60,6 +76,6 @@ Set-ExecutionPolicy -Scope Process Bypass
.\Publish-ForgeFlow-Release.ps1 .\Publish-ForgeFlow-Release.ps1
``` ```
The script installs dependencies, runs the complete quality gate, clones `git@gitea.itworx.tech:Jens/ForgeFlow.git` into a temporary folder, mirrors the validated source without `.git`, `node_modules`, `dist` or release archives, commits it and pushes `main`. It then compares local `HEAD` with `git ls-remote` and fails if Gitea does not report the exact release commit. The script installs dependencies, runs the complete quality gate, clones `git@gitea.itworx.tech:Jens/ForgeFlow.git` into a temporary folder, mirrors the validated source without `.git`, `node_modules`, `dist` or release archives, commits it and pushes `main`. It then compares local `HEAD` with `git ls-remote`, builds the exact published checkout and uploads all binaries, checksums and signed release evidence to the matching Gitea release. Publication fails when either the source commit, publisher signature or any required asset cannot be verified.
Keep the currently installed older ForgeFlow source folder untouched until the built-in updater test is complete. Keep the currently installed older ForgeFlow source folder untouched until the built-in updater test is complete.
Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 101 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 150 KiB

After

Width:  |  Height:  |  Size: 83 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 132 KiB

After

Width:  |  Height:  |  Size: 110 KiB

+67
View File
@@ -0,0 +1,67 @@
import js from "@eslint/js";
export default [
{
ignores: ["build/**", "dist/**", "node_modules/**", ".playwright-mcp/**", "SOURCE_MANIFEST.txt"],
},
{
files: ["**/*.{js,cjs,mjs}"],
languageOptions: {
ecmaVersion: "latest",
sourceType: "module",
globals: {
Buffer: "readonly", clearInterval: "readonly", clearTimeout: "readonly", console: "readonly",
document: "readonly", fetch: "readonly", FormData: "readonly", globalThis: "readonly",
process: "readonly", queueMicrotask: "readonly", requestAnimationFrame: "readonly",
setInterval: "readonly", setTimeout: "readonly", URL: "readonly", URLSearchParams: "readonly",
window: "readonly", confirm: "readonly", localStorage: "readonly", structuredClone: "readonly",
},
},
rules: {
...js.configs.recommended.rules,
"no-control-regex": "off",
"no-empty": ["error", { allowEmptyCatch: true }],
"no-undef": "off",
"no-unused-vars": "off",
"no-useless-escape": "off",
"no-eval": "error",
"no-implied-eval": "error",
eqeqeq: ["error", "always", { null: "ignore" }],
},
},
{
// The main process and shared modules are plain CommonJS with an explicit
// dependency graph, so undefined identifiers there are always real bugs
// (missing require, missing injected dependency) rather than a global that
// another script tag happens to define.
files: ["src/main/**/*.cjs", "src/shared/**/*.cjs", "main.cjs", "preload.cjs"],
languageOptions: {
sourceType: "commonjs",
globals: {
require: "readonly", module: "writable", exports: "writable",
__dirname: "readonly", __filename: "readonly",
Buffer: "readonly", process: "readonly", console: "readonly",
setTimeout: "readonly", clearTimeout: "readonly",
setInterval: "readonly", clearInterval: "readonly", setImmediate: "readonly",
queueMicrotask: "readonly", structuredClone: "readonly", globalThis: "readonly",
URL: "readonly", URLSearchParams: "readonly", fetch: "readonly",
FormData: "readonly", Blob: "readonly",
AbortController: "readonly", AbortSignal: "readonly",
TextEncoder: "readonly", TextDecoder: "readonly",
},
},
rules: {
"no-undef": "error",
// Also catches code that a refactor left behind, such as a value computed
// from a dependency that is no longer injected.
"no-unused-vars": ["error", { args: "none", caughtErrors: "none", ignoreRestSiblings: true }],
},
},
{
files: ["tests/**/*.mjs"],
rules: {
"no-regex-spaces": "off",
"no-unsafe-finally": "off",
},
},
];
+1 -1
View File
@@ -126,7 +126,7 @@ git -C "$APP_DIR" merge-base --is-ancestor "$SHA" "origin/$BRANCH" || {
write_status "deploying" "$current_sha" "$previous_sha" 0 write_status "deploying" "$current_sha" "$previous_sha" 0
git -C "$APP_DIR" reset --hard "$SHA" git -C "$APP_DIR" reset --hard "$SHA"
docker compose -f "$COMPOSE_FILE" up -d --build --remove-orphans docker compose -f "$COMPOSE_FILE" up -d --build
for attempt in $(seq 1 30); do for attempt in $(seq 1 30); do
if curl --fail --silent --show-error --max-time 5 "$HEALTHCHECK_URL" >/dev/null; then if curl --fail --silent --show-error --max-time 5 "$HEALTHCHECK_URL" >/dev/null; then
+56 -9
View File
@@ -25,18 +25,39 @@ const {
UnraidDeploymentService, UnraidDeploymentService,
} = require("./src/main/unraid-deployment-service.cjs"); } = require("./src/main/unraid-deployment-service.cjs");
const { AuditService } = require("./src/main/audit-service.cjs"); const { AuditService } = require("./src/main/audit-service.cjs");
const { DeployKeyLifecycleService } = require("./src/main/deploy-key-lifecycle-service.cjs");
const { UnraidDeployKeyHost } = require("./src/main/unraid-deploy-key-host.cjs");
const { InventoryReviewService } = require("./src/main/inventory-review-service.cjs");
const { GitValidatorService } = require("./src/main/git-validator-service.cjs");
const { const {
ExternalToolsService, ExternalToolsService,
} = require("./src/main/external-tools-service.cjs"); } = require("./src/main/external-tools-service.cjs");
const { registerIpc } = require("./src/main/ipc.cjs"); const { registerIpc } = require("./src/main/ipc.cjs");
const {
installOutputPipeGuards,
isBrokenPipeError,
} = require("./src/main/process-error-policy.cjs");
let mainWindow; let mainWindow;
let repositoryMonitor; let repositoryMonitor;
let sshService;
let operationTimer; let operationTimer;
let diagnostics; let diagnostics;
let configStore; let configStore;
let tray; let tray;
let quitCleanupStarted = false; let quitCleanupStarted = false;
const reportBrokenOutputPipe = (error) => {
const report = diagnostics?.warning("process.output-pipe.closed", {
code: error?.code || null,
message: error?.message || "The parent output pipe was closed.",
});
report?.catch(() => {});
};
installOutputPipeGuards({ onBrokenPipe: reportBrokenOutputPipe });
const ownsSingleInstanceLock = app.requestSingleInstanceLock();
if (!ownsSingleInstanceLock) app.quit();
else app.on("second-instance", () => showMainWindow());
function broadcast(channel, payload) { function broadcast(channel, payload) {
for (const window of BrowserWindow.getAllWindows()) { for (const window of BrowserWindow.getAllWindows()) {
@@ -141,14 +162,12 @@ function createWindow() {
); );
mainWindow.webContents.setWindowOpenHandler(({ url }) => { mainWindow.webContents.setWindowOpenHandler(({ url }) => {
if (/^https?:\/\//i.test(url)) if (/^https?:\/\//i.test(url))
shell shell.openExternal(url).catch((error) =>
.openExternal(url) diagnostics?.warning("external-link.open.failed", {
.catch((error) => url,
diagnostics?.warning("external-link.open.failed", { message: error.message,
url, }),
message: error.message, );
}),
);
return { action: "deny" }; return { action: "deny" };
}); });
mainWindow.webContents.on("will-navigate", (event, url) => { mainWindow.webContents.on("will-navigate", (event, url) => {
@@ -169,6 +188,7 @@ function createWindow() {
app app
.whenReady() .whenReady()
.then(async () => { .then(async () => {
if (!ownsSingleInstanceLock) return;
session.defaultSession.webRequest.onHeadersReceived((details, callback) => { session.defaultSession.webRequest.onHeadersReceived((details, callback) => {
callback({ callback({
responseHeaders: { responseHeaders: {
@@ -212,6 +232,10 @@ app
await audit.initialize(); await audit.initialize();
process.on("uncaughtException", (error) => { process.on("uncaughtException", (error) => {
if (isBrokenPipeError(error)) {
reportBrokenOutputPipe(error);
return;
}
diagnostics diagnostics
?.error("process.uncaught-exception", error) ?.error("process.uncaught-exception", error)
.finally(() => app.exit(1)); .finally(() => app.exit(1));
@@ -229,6 +253,7 @@ app
const repositories = new RepositoryService(store, git, gitea, diagnostics); const repositories = new RepositoryService(store, git, gitea, diagnostics);
const deployments = new DeploymentService(store, gitea, git, diagnostics); const deployments = new DeploymentService(store, gitea, git, diagnostics);
const ssh = new SshService({ store, diagnostics }); const ssh = new SshService({ store, diagnostics });
sshService = ssh;
const auditedOperationStates = new Set(); const auditedOperationStates = new Set();
const reportOperationChange = (payload) => { const reportOperationChange = (payload) => {
broadcast("operations:changed", payload); broadcast("operations:changed", payload);
@@ -239,6 +264,11 @@ app
) { ) {
const key = `${operation.id}:${operation.status}`; const key = `${operation.id}:${operation.status}`;
if (!auditedOperationStates.has(key)) { if (!auditedOperationStates.has(key)) {
// One entry per completed deployment, so the set is trimmed rather
// than kept for the lifetime of the process.
if (auditedOperationStates.size >= 500) {
auditedOperationStates.delete(auditedOperationStates.values().next().value);
}
auditedOperationStates.add(key); auditedOperationStates.add(key);
notify( notify(
`Deployment ${operation.status}`, `Deployment ${operation.status}`,
@@ -260,10 +290,18 @@ app
store, store,
ssh, ssh,
git, git,
gitea,
diagnostics, diagnostics,
sourcePath: app.getAppPath(), sourcePath: app.getAppPath(),
onOperationChange: reportOperationChange, onOperationChange: reportOperationChange,
}); });
const deployKeys = new DeployKeyLifecycleService({
store,
gitea,
keyHost: new UnraidDeployKeyHost({ ssh }),
audit,
});
const inventoryReviews = new InventoryReviewService({ store, audit });
const updates = new UpdateService({ const updates = new UpdateService({
store, store,
gitea, gitea,
@@ -286,6 +324,12 @@ app
userDataPath, userDataPath,
secureStorageAvailable: () => safeStorage.isEncryptionAvailable(), secureStorageAvailable: () => safeStorage.isEncryptionAvailable(),
}); });
const gitValidator = new GitValidatorService({
git,
gitea,
diagnostics,
store,
});
repositoryMonitor = new RepositoryMonitor({ repositoryMonitor = new RepositoryMonitor({
store, store,
git, git,
@@ -300,9 +344,12 @@ app
repositories, repositories,
deployments, deployments,
unraid, unraid,
deployKeys,
inventoryReviews,
ssh, ssh,
updates, updates,
preflight, preflight,
gitValidator,
diagnostics, diagnostics,
audit, audit,
externalTools, externalTools,
@@ -400,7 +447,6 @@ app
}); });
}) })
.catch(async (error) => { .catch(async (error) => {
console.error("[startup]", error);
await diagnostics?.error("app.startup.failed", error); await diagnostics?.error("app.startup.failed", error);
await diagnostics?.flush(); await diagnostics?.flush();
app.exit(1); app.exit(1);
@@ -411,6 +457,7 @@ app.on("before-quit", (event) => {
event.preventDefault(); event.preventDefault();
quitCleanupStarted = true; quitCleanupStarted = true;
repositoryMonitor?.stop(); repositoryMonitor?.stop();
sshService?.closeAll();
if (operationTimer) clearTimeout(operationTimer); if (operationTimer) clearTimeout(operationTimer);
Promise.resolve() Promise.resolve()
.then(() => diagnostics?.info("app.quitting", {})) .then(() => diagnostics?.info("app.quitting", {}))
+1438 -63
View File
File diff suppressed because it is too large Load Diff
+54 -5
View File
@@ -1,6 +1,6 @@
{ {
"name": "forgeflow", "name": "forgeflow",
"version": "0.8.6", "version": "0.10.13",
"private": true, "private": true,
"description": "Desktop release cockpit for local Git, Gitea Actions and controlled exact-commit deployments.", "description": "Desktop release cockpit for local Git, Gitea Actions and controlled exact-commit deployments.",
"main": "main.cjs", "main": "main.cjs",
@@ -10,20 +10,35 @@
"dev": "electron . --dev", "dev": "electron . --dev",
"demo": "node scripts/serve-demo.mjs", "demo": "node scripts/serve-demo.mjs",
"test": "node --test tests/*.test.mjs", "test": "node --test tests/*.test.mjs",
"lint": "eslint .",
"coverage": "c8 --check-coverage --lines 85 --functions 85 --branches 68 --statements 85 node --test tests/*.test.mjs && npm run coverage:modules",
"coverage:modules": "c8 report --check-coverage --per-file --include src/** --statements 60 --lines 60 --functions 50 --branches 36 --reporter=text-summary",
"verify": "node scripts/verify.mjs", "verify": "node scripts/verify.mjs",
"dist:win": "electron-builder --win nsis portable && node scripts/write-release-checksums.mjs && node scripts/prune-dist.mjs", "dist:win": "electron-builder --win nsis portable && node scripts/write-release-checksums.mjs && node scripts/sign-release-manifest.mjs && node scripts/verify-release-signatures.mjs && node scripts/prune-dist.mjs",
"dist:linux": "electron-builder --linux AppImage && node scripts/prune-dist.mjs", "dist:linux": "electron-builder --linux AppImage && node scripts/prune-dist.mjs",
"dist:mac": "electron-builder --mac dmg && node scripts/prune-dist.mjs", "dist:mac": "electron-builder --mac dmg && node scripts/prune-dist.mjs",
"doctor": "node scripts/doctor.mjs", "doctor": "node scripts/doctor.mjs",
"acceptance": "node scripts/acceptance.mjs", "acceptance": "node scripts/acceptance.mjs",
"acceptance:isolated": "node --test tests/production-acceptance.test.mjs",
"architecture:audit": "node scripts/architecture-audit.mjs",
"test:browser": "playwright test",
"test:browser:ci": "playwright test --reporter=line,html",
"test:signing": "powershell.exe -NoProfile -ExecutionPolicy Bypass -File scripts/test-authenticode-chain.ps1",
"signing:setup": "node scripts/setup-update-signing-key.mjs",
"connections:check": "electron scripts/validate-installed-connections.cjs", "connections:check": "electron scripts/validate-installed-connections.cjs",
"deployments:audit": "electron scripts/audit-installed-deployments.cjs",
"release:binary": "electron scripts/publish-binary-release.cjs", "release:binary": "electron scripts/publish-binary-release.cjs",
"manifest": "node scripts/generate-source-manifest.mjs", "manifest": "node scripts/generate-source-manifest.mjs",
"check": "npm run verify && npm test" "check": "npm run verify && npm run lint && npm test",
"quality": "npm run check && npm run coverage"
}, },
"devDependencies": { "devDependencies": {
"@eslint/js": "9.39.5",
"@playwright/test": "1.62.0",
"c8": "12.0.0",
"electron": "43.2.0", "electron": "43.2.0",
"electron-builder": "26.15.3" "electron-builder": "26.15.3",
"eslint": "9.39.5"
}, },
"build": { "build": {
"appId": "be.jenscaers.forgeflow", "appId": "be.jenscaers.forgeflow",
@@ -36,6 +51,7 @@
"package.json", "package.json",
"build/icon.png", "build/icon.png",
"build/icon.ico", "build/icon.ico",
"build/update-signing-public.pem",
"docs/SETUP_GUIDE.md", "docs/SETUP_GUIDE.md",
"docs/DIAGNOSTICS.md", "docs/DIAGNOSTICS.md",
"docs/STATUS_ENDPOINT.md", "docs/STATUS_ENDPOINT.md",
@@ -53,6 +69,7 @@
"scripts/apply-source-update.ps1", "scripts/apply-source-update.ps1",
"scripts/apply-binary-update.ps1", "scripts/apply-binary-update.ps1",
"scripts/prune-dist.mjs", "scripts/prune-dist.mjs",
"scripts/sign-release-manifest.mjs",
"docs/RELEASE_NOTES_0.4.0.md", "docs/RELEASE_NOTES_0.4.0.md",
"docs/LUMAOPS_SERVER_AUDIT.md", "docs/LUMAOPS_SERVER_AUDIT.md",
"docs/SSH_UNRAID_DEPLOYMENT.md", "docs/SSH_UNRAID_DEPLOYMENT.md",
@@ -63,7 +80,9 @@
"docs/RELEASE_NOTES_0.4.5.md", "docs/RELEASE_NOTES_0.4.5.md",
"docs/RELEASE_NOTES_0.5.0.md", "docs/RELEASE_NOTES_0.5.0.md",
"docs/RELEASE_NOTES_0.5.1.md", "docs/RELEASE_NOTES_0.5.1.md",
"PUBLISH-AND-ENABLE-UPDATE.cmd",
"Publish-ForgeFlow-Release.ps1", "Publish-ForgeFlow-Release.ps1",
"Publish-Missing-Binary-Release.ps1",
"docs/RELEASE_NOTES_0.5.2.md", "docs/RELEASE_NOTES_0.5.2.md",
"docs/RELEASE_NOTES_0.5.3.md", "docs/RELEASE_NOTES_0.5.3.md",
"docs/RELEASE_NOTES_0.5.4.md", "docs/RELEASE_NOTES_0.5.4.md",
@@ -79,7 +98,37 @@
"docs/RELEASE_NOTES_0.8.4.md", "docs/RELEASE_NOTES_0.8.4.md",
"docs/RELEASE_NOTES_0.8.5.md", "docs/RELEASE_NOTES_0.8.5.md",
"docs/RELEASE_NOTES_0.8.6.md", "docs/RELEASE_NOTES_0.8.6.md",
"docs/ACCEPTANCE.md" "docs/RELEASE_NOTES_0.8.7.md",
"docs/RELEASE_NOTES_0.8.8.md",
"docs/RELEASE_NOTES_0.8.9.md",
"docs/RELEASE_NOTES_0.9.0.md",
"docs/RELEASE_NOTES_0.9.1.md",
"docs/ACCEPTANCE.md",
"docs/RELEASE_NOTES_0.9.2.md",
"docs/RELEASE_NOTES_0.9.3.md",
"docs/RELEASE_NOTES_0.9.4.md",
"docs/RELEASE_NOTES_0.9.5.md",
"docs/RELEASE_NOTES_0.10.0.md",
"docs/RELEASE_NOTES_0.10.1.md",
"docs/RELEASE_NOTES_0.10.2.md",
"docs/RELEASE_NOTES_0.10.3.md",
"docs/RELEASE_NOTES_0.10.4.md",
"docs/RELEASE_NOTES_0.10.5.md",
"docs/RELEASE_NOTES_0.10.6.md",
"docs/RELEASE_NOTES_0.10.7.md",
"docs/RELEASE_NOTES_0.10.8.md",
"docs/RELEASE_NOTES_0.10.9.md",
"docs/RELEASE_NOTES_0.10.10.md",
"docs/RELEASE_NOTES_0.10.11.md",
"docs/RELEASE_NOTES_0.10.12.md",
"docs/RELEASE_NOTES_0.10.13.md",
"docs/CURRENT_STATE.md",
"docs/MUTATION_MODEL.md",
"docs/RELEASING.md",
"docs/COVERAGE_POLICY.md",
"docs/DEPENDENCY_AUDIT.md",
"docs/PRODUCTION_READINESS_1.0.md",
"docs/ERROR_CODES.md"
], ],
"asarUnpack": [ "asarUnpack": [
"scripts/apply-binary-update.ps1" "scripts/apply-binary-update.ps1"
+42
View File
@@ -0,0 +1,42 @@
import { defineConfig } from "@playwright/test";
const matrices = [
["compact-dark-100", 1120, 720, "dark", 1, false],
["desktop-light-125", 1440, 900, "light", 1.25, false],
["wide-dark-150", 1920, 1080, "dark", 1.5, false],
["compact-light-reduced", 1120, 720, "light", 1, true],
["desktop-dark-reduced", 1440, 900, "dark", 1.25, true],
["wide-light-100", 1920, 1080, "light", 1, false],
];
export default defineConfig({
testDir: "./tests/browser",
outputDir: "artifacts/browser",
timeout: 45_000,
expect: { timeout: 7_000 },
fullyParallel: false,
workers: process.env.CI ? 2 : 3,
reporter: [["line"], ["html", { outputFolder: "artifacts/browser-report", open: "never" }]],
use: {
baseURL: "http://127.0.0.1:41737",
screenshot: "only-on-failure",
trace: "retain-on-failure",
video: "retain-on-failure",
},
webServer: {
command: "node scripts/serve-demo.mjs",
url: "http://127.0.0.1:41737/__forgeflow_test_ready__",
reuseExistingServer: !process.env.CI,
timeout: 30_000,
},
projects: matrices.map(([name, width, height, theme, scale, reduced]) => ({
name,
metadata: { theme, scale, reduced },
use: {
viewport: { width, height },
deviceScaleFactor: scale,
colorScheme: theme,
reducedMotion: reduced ? "reduce" : "no-preference",
},
})),
});
+139 -95
View File
@@ -22,98 +22,142 @@ function subscribe(channel, listener) {
return () => ipcRenderer.removeListener(channel, handler); return () => ipcRenderer.removeListener(channel, handler);
} }
contextBridge.exposeInMainWorld('forgeflow', Object.freeze({ contextBridge.exposeInMainWorld(
bootstrap: () => invoke('app:bootstrap'), 'forgeflow',
selectDirectory: (payload) => invoke('dialog:select-directory', payload), Object.freeze({
selectKeyFile: (payload) => invoke('dialog:select-key-file', payload), bootstrap: () => invoke('app:bootstrap'),
selectImageFile: (payload) => invoke('dialog:select-image-file', payload), selectDirectory: (payload) => invoke('dialog:select-directory', payload),
setupPreflight: (payload) => invoke('setup:preflight', payload), selectKeyFile: (payload) => invoke('dialog:select-key-file', payload),
validateGitea: (payload) => invoke('setup:validate-gitea', payload), selectImageFile: (payload) => invoke('dialog:select-image-file', payload),
completeSetup: (payload) => invoke('setup:complete', payload), setupPreflight: (payload) => invoke('setup:preflight', payload),
updateGitea: (payload) => invoke('settings:update-gitea', payload), validateGitea: (payload) => invoke('setup:validate-gitea', payload),
setWorkspaceRoots: (roots) => invoke('settings:set-roots', { roots }), completeSetup: (payload) => invoke('setup:complete', payload),
setAppearance: (appearance) => invoke('settings:set-appearance', { appearance }), updateGitea: (payload) => invoke('settings:update-gitea', payload),
setPreferences: (preferences) => invoke('settings:set-preferences', { preferences }), setWorkspaceRoots: (roots) => invoke('settings:set-roots', { roots }),
exportConfigurationBackup: (passphrase) => invoke('settings:export-backup', { passphrase }), setAppearance: (appearance) => invoke('settings:set-appearance', { appearance }),
importConfigurationBackup: (passphrase) => invoke('settings:import-backup', { passphrase }), setPreferences: (preferences) => invoke('settings:set-preferences', { preferences }),
listAuditEvents: (limit = 250) => invoke('audit:list', { limit }), exportConfigurationBackup: (passphrase) => invoke('settings:export-backup', { passphrase }),
exportAuditLog: (format = 'json') => invoke('audit:export', { format }), importConfigurationBackup: (passphrase) => invoke('settings:import-backup', { passphrase }),
setUpdatePreferences: (updates) => invoke('updates:preferences', { updates }), listAuditEvents: (limit = 250) => invoke('audit:list', { limit }),
checkForUpdates: () => invoke('updates:check'), exportAuditLog: (format = 'json') => invoke('audit:export', { format }),
downloadUpdate: () => invoke('updates:download'), setUpdatePreferences: (updates) => invoke('updates:preferences', { updates }),
applyUpdate: () => invoke('updates:apply'), checkForUpdates: () => invoke('updates:check'),
saveServer: (server, password = '', passphrase = '') => invoke('server:save', { server, password, passphrase }), downloadUpdate: () => invoke('updates:download'),
deleteServer: (serverId) => invoke('server:delete', { serverId }), applyUpdate: () => invoke('updates:apply'),
testServer: (serverId) => invoke('server:test', { serverId }), saveServer: (server, password = '', passphrase = '') => invoke('server:save', { server, password, passphrase }),
inspectServerProject: (repository, profileId) => invoke('server:inspect-project', { repository, profileId }), deleteServer: (serverId) => invoke('server:delete', { serverId }),
discoverExistingDeployment: (repository, serverId, remoteFolder) => invoke('server:discover-existing', { repository, serverId, remoteFolder }), testServer: (serverId, expectedFingerprint = '') => invoke('server:test', { serverId, expectedFingerprint }),
refreshRepositories: () => invoke('repositories:refresh'), inspectServerProject: (repository, profileId) => invoke('server:inspect-project', { repository, profileId }),
discoverRepositories: (roots) => invoke('repositories:discover', { roots }), discoverExistingDeployment: (repository, serverId, remoteFolder) =>
favoriteRepository: (fullName, favorite) => invoke('repository:favorite', { fullName, favorite }), invoke('server:discover-existing', {
linkRepository: (fullName, localPath) => invoke('repository:link', { fullName, localPath }), repository,
unlinkRepository: (fullName) => invoke('repository:unlink', { fullName }), serverId,
repositoryStatus: (localPath) => invoke('repository:status', { localPath }), remoteFolder,
repositoryDiff: (localPath, filePath, staged = false) => invoke('repository:diff', { localPath, filePath, staged }), }),
repositoryDiffHunks: (localPath, filePath) => invoke('repository:diff-hunks', { localPath, filePath }), refreshRepositories: (options = {}) => invoke('repositories:refresh', options),
stageHunks: (localPath, filePath, hunkIndexes) => invoke('repository:stage-hunks', { localPath, filePath, hunkIndexes }), discoverRepositories: (roots) => invoke('repositories:discover', { roots }),
conflictState: (localPath) => invoke('repository:conflicts', { localPath }), favoriteRepository: (fullName, favorite) => invoke('repository:favorite', { fullName, favorite }),
resolveConflict: (localPath, filePath, resolution) => invoke('repository:resolve-conflict', { localPath, filePath, resolution }), linkRepository: (fullName, localPath) => invoke('repository:link', { fullName, localPath }),
continueGitOperation: (localPath) => invoke('repository:continue-operation', { localPath }), unlinkRepository: (fullName) => invoke('repository:unlink', { fullName }),
abortGitOperation: (localPath) => invoke('repository:abort-operation', { localPath }), repositoryStatus: (localPath) => invoke('repository:status', { localPath }),
stageFiles: (localPath, files) => invoke('repository:stage', { localPath, files }), repositoryDiff: (localPath, filePath, staged = false) => invoke('repository:diff', { localPath, filePath, staged }),
unstageFiles: (localPath, files) => invoke('repository:unstage', { localPath, files }), repositoryDiffHunks: (localPath, filePath) => invoke('repository:diff-hunks', { localPath, filePath }),
commit: (localPath, message, files) => invoke('repository:commit', { localPath, message, files }), stageHunks: (localPath, filePath, hunkIndexes) => invoke('repository:stage-hunks', { localPath, filePath, hunkIndexes }),
commitStaged: (localPath, message) => invoke('repository:commit-staged', { localPath, message }), conflictState: (localPath) => invoke('repository:conflicts', { localPath }),
commitStagedAndPush: (localPath, message) => invoke('repository:commit-staged-push', { localPath, message }), resolveConflict: (localPath, filePath, resolution) =>
commitAndPush: (localPath, message, files) => invoke('repository:commit-push', { localPath, message, files }), invoke('repository:resolve-conflict', {
push: (localPath) => invoke('repository:push', { localPath }), localPath,
fetch: (localPath) => invoke('repository:fetch', { localPath }), filePath,
pull: (localPath) => invoke('repository:pull', { localPath }), resolution,
history: (localPath, limit = 20) => invoke('repository:history', { localPath, limit }), }),
branchProtection: (fullName, branch) => invoke('repository:branch-protection', { fullName, branch }), continueGitOperation: (localPath) => invoke('repository:continue-operation', { localPath }),
pullRequests: (fullName, state = 'open') => invoke('repository:pull-requests', { fullName, state }), abortGitOperation: (localPath) => invoke('repository:abort-operation', { localPath }),
createPullRequest: (fullName, title, body, base) => invoke('repository:create-pull-request', { fullName, title, body, base }), stageFiles: (localPath, files) => invoke('repository:stage', { localPath, files }),
branches: (localPath) => invoke('repository:branches', { localPath }), unstageFiles: (localPath, files) => invoke('repository:unstage', { localPath, files }),
checkoutBranch: (localPath, branch) => invoke('repository:checkout-branch', { localPath, branch }), commit: (localPath, message, files) => invoke('repository:commit', { localPath, message, files }),
createBranch: (localPath, branch) => invoke('repository:create-branch', { localPath, branch }), commitStaged: (localPath, message) => invoke('repository:commit-staged', { localPath, message }),
stash: (localPath, message) => invoke('repository:stash', { localPath, message }), commitStagedAndPush: (localPath, message) => invoke('repository:commit-staged-push', { localPath, message }),
stashList: (localPath) => invoke('repository:stash-list', { localPath }), commitAndPush: (localPath, message, files) => invoke('repository:commit-push', { localPath, message, files }),
popStash: (localPath, ref) => invoke('repository:stash-pop', { localPath, ref }), push: (localPath) => invoke('repository:push', { localPath }),
indexLockInfo: (localPath) => invoke('repository:index-lock', { localPath }), fetch: (localPath) => invoke('repository:fetch', { localPath }),
repairIndexLock: (localPath) => invoke('repository:repair-index-lock', { localPath }), pull: (localPath) => invoke('repository:pull', { localPath }),
gitRecoveryStatus: (localPath) => invoke('repository:git-recovery-status', { localPath }), history: (localPath, limit = 20) => invoke('repository:history', { localPath, limit }),
repairGitLocks: (localPath, force = false) => invoke('repository:repair-git-locks', { localPath, force }), branchProtection: (fullName, branch) => invoke('repository:branch-protection', { fullName, branch }),
reconcileRepository: (localPath) => invoke('repository:reconcile', { localPath }), pullRequests: (fullName, state = 'open') => invoke('repository:pull-requests', { fullName, state }),
repairRepositorySync: (localPath, strategy) => invoke('repository:repair-sync', { localPath, strategy }), createPullRequest: (fullName, title, body, base) => invoke('repository:create-pull-request', { fullName, title, body, base }),
setOrigin: (localPath, remoteUrl) => invoke('repository:set-origin', { localPath, remoteUrl }), branches: (localPath) => invoke('repository:branches', { localPath }),
normalizeOrigins: () => invoke('repositories:normalize-origins'), checkoutBranch: (localPath, branch) => invoke('repository:checkout-branch', { localPath, branch }),
cloneRepository: (fullName, mode = 'default') => invoke('repository:clone', { fullName, mode }), createBranch: (localPath, branch) => invoke('repository:create-branch', { localPath, branch }),
openPath: (localPath) => invoke('repository:open-path', { localPath }), stash: (localPath, message) => invoke('repository:stash', { localPath, message }),
openEditor: (localPath, filePath = '', line = 1) => invoke('repository:open-editor', { localPath, filePath, line }), stashList: (localPath) => invoke('repository:stash-list', { localPath }),
openTerminal: (localPath) => invoke('repository:open-terminal', { localPath }), popStash: (localPath, ref) => invoke('repository:stash-pop', { localPath, ref }),
openExternal: (url) => invoke('external:open', { url }), indexLockInfo: (localPath) => invoke('repository:index-lock', { localPath }),
saveDeploymentProfile: (fullName, profile) => invoke('deployment:save-profile', { fullName, profile }), repairIndexLock: (localPath) => invoke('repository:repair-index-lock', { localPath }),
deploymentPreflight: (repository, profileId) => invoke('deployment:preflight', { repository, profileId }), gitRecoveryStatus: (localPath) => invoke('repository:git-recovery-status', { localPath }),
deleteDeploymentProfile: (fullName, profileId) => invoke('deployment:delete-profile', { fullName, profileId }), repairGitLocks: (localPath, force = false) => invoke('repository:repair-git-locks', { localPath, force }),
deploy: (repository, profileId, sha, options = {}) => invoke('deployment:dispatch', { repository, profileId, sha, note: options.note || '', override: options.override === true, overrideReason: options.overrideReason || '' }), reconcileRepository: (localPath) => invoke('repository:reconcile', { localPath }),
rollback: (repository, profileId, targetSha) => invoke('deployment:rollback', { repository, profileId, targetSha }), repairRepositorySync: (localPath, strategy) => invoke('repository:repair-sync', { localPath, strategy }),
healthcheck: (url) => invoke('deployment:health', { url }), previewWorkspaceSync: (localPath) => invoke('repository:workspace-sync-preview', { localPath }),
refreshProfileState: (fullName, profileId) => invoke('deployment:profile-state', { fullName, profileId }), applyWorkspaceSync: (localPath, expectedPlanId) => invoke('repository:workspace-sync-apply', { localPath, expectedPlanId }),
applyDockerManMetadata: (repository, profileId) => invoke('deployment:apply-dockerman-metadata', { repository, profileId }), setOrigin: (localPath, remoteUrl) => invoke('repository:set-origin', { localPath, remoteUrl }),
reconcileDeployment: (fullName, profileId) => invoke('deployment:reconcile', { fullName, profileId }), normalizeOrigins: () => invoke('repositories:normalize-origins'),
refreshOperations: (operationId = null) => invoke('operations:refresh', { operationId }), cloneRepository: (fullName, mode = 'default') => invoke('repository:clone', { fullName, mode }),
getOperation: (operationId) => invoke('operations:get', { operationId }), openPath: (localPath) => invoke('repository:open-path', { localPath }),
troubleshooterScan: (fullName = null) => invoke('troubleshooter:scan', { fullName }), openEditor: (localPath, filePath = '', line = 1) => invoke('repository:open-editor', { localPath, filePath, line }),
troubleshooterRepair: (issue) => invoke('troubleshooter:repair', { issue }), openTerminal: (localPath) => invoke('repository:open-terminal', { localPath }),
troubleshooterAutoRepair: (issues) => invoke('troubleshooter:auto-repair', { issues }), openExternal: (url) => invoke('external:open', { url }),
diagnosticsStatus: () => invoke('diagnostics:status'), saveDeploymentProfile: (fullName, profile) => invoke('deployment:save-profile', { fullName, profile }),
clearDiagnostics: () => invoke('diagnostics:clear'), deploymentPreflight: (repository, profileId) => invoke('deployment:preflight', { repository, profileId }),
openDiagnosticsFolder: () => invoke('diagnostics:open-folder'), repairDeploymentWriteAccess: (repository, profileId) => invoke('deployment:repair-write-access', { repository, profileId }),
exportDiagnostics: (privacyMode = 'standard') => invoke('diagnostics:export', { privacyMode }), deleteDeploymentProfile: (fullName, profileId) => invoke('deployment:delete-profile', { fullName, profileId }),
showDiagnosticBundle: (filePath) => invoke('diagnostics:show-bundle', { filePath }), deploy: (repository, profileId, sha, options = {}) =>
reportRendererEvent: (level, event, details = {}) => invoke('renderer:report', { level, event, details }), invoke('deployment:dispatch', {
onRepositoriesChanged: (listener) => subscribe('repositories:changed', listener), repository,
onOperationsChanged: (listener) => subscribe('operations:changed', listener), profileId,
onUpdatesChanged: (listener) => subscribe('updates:changed', listener), sha,
reset: () => invoke('app:reset') note: options.note || '',
})); override: options.override === true,
overrideReason: options.overrideReason || '',
}),
rollback: (repository, profileId, targetSha) => invoke('deployment:rollback', { repository, profileId, targetSha }),
healthcheck: (url) => invoke('deployment:health', { url }),
refreshProfileState: (fullName, profileId) => invoke('deployment:profile-state', { fullName, profileId }),
discoverServerDeployments: () => invoke('deployment:discover-server-workloads'),
planServerReconciliation: (serverId) => invoke('deployment:plan-server-reconciliation', { serverId }),
applyServerReconciliation: (serverId, planId) => invoke('deployment:apply-server-reconciliation', { serverId, planId }),
planInventoryReview: (serverId, workloadId, action, reason = '', repositoryFullName = null) => invoke('deployment:plan-inventory-review', { serverId, workloadId, action, reason, repositoryFullName }),
applyInventoryReview: (serverId, workloadId, action, reason, repositoryFullName, planId) => invoke('deployment:apply-inventory-review', { serverId, workloadId, action, reason, repositoryFullName, planId }),
linkServerWorkload: (repository, serverId, workloadId, deploymentMode = 'server-git', remoteFolder = '') => invoke('deployment:link-server-workload', { repository, serverId, workloadId, deploymentMode, remoteFolder }),
configureServerGitAccess: (repository, profileId) => invoke('deployment:configure-server-git-access', { repository, profileId }),
verifyServerGitProfile: (repository, profileId) => invoke('deployment:verify-server-git-profile', { repository, profileId }),
deployKeyInventory: (repository, profileId) => invoke('deployment:deploy-key-inventory', { repository, profileId }),
planDeployKeyRotation: (repository, profileId) => invoke('deployment:plan-deploy-key-rotation', { repository, profileId }),
applyDeployKeyRotation: (repository, profileId, planId) => invoke('deployment:apply-deploy-key-rotation', { repository, profileId, planId }),
planDeployKeyRevocation: (repository, profileId) => invoke('deployment:plan-deploy-key-revocation', { repository, profileId }),
applyDeployKeyRevocation: (repository, profileId, planId) => invoke('deployment:apply-deploy-key-revocation', { repository, profileId, planId }),
restoreDeployKey: (repository, profileId) => invoke('deployment:restore-deploy-key', { repository, profileId }),
applyDockerManMetadata: (repository, profileId) => invoke('deployment:apply-dockerman-metadata', { repository, profileId }),
reconcileDeployment: (fullName, profileId) => invoke('deployment:reconcile', { fullName, profileId }),
refreshOperations: (operationId = null) => invoke('operations:refresh', { operationId }),
getOperation: (operationId) => invoke('operations:get', { operationId }),
troubleshooterScan: (fullName = null) => invoke('troubleshooter:scan', { fullName }),
troubleshooterRepair: (issue) => invoke('troubleshooter:repair', { issue }),
troubleshooterAutoRepair: (issues) => invoke('troubleshooter:auto-repair', { issues }),
gitValidatorScan: (fullName) => invoke('git-validator:scan', { fullName }),
gitValidatorSetPolicy: (fullName, policy) => invoke('git-validator:set-policy', { fullName, policy }),
gitValidatorSuppress: (fullName, suppression) => invoke('git-validator:suppress', { fullName, suppression }),
gitValidatorPreviewRepair: (fullName, check) => invoke('git-validator:preview-repair', { fullName, check }),
gitValidatorExport: (fullName, format = 'json') => invoke('git-validator:export', { fullName, format }),
gitValidatorRepair: (fullName, check) => invoke('git-validator:repair', { fullName, check }),
diagnosticsStatus: () => invoke('diagnostics:status'),
clearDiagnostics: () => invoke('diagnostics:clear'),
openDiagnosticsFolder: () => invoke('diagnostics:open-folder'),
exportDiagnostics: (privacyMode = 'standard') => invoke('diagnostics:export', { privacyMode }),
showDiagnosticBundle: (filePath) => invoke('diagnostics:show-bundle', { filePath }),
reportRendererEvent: (level, event, details = {}) => invoke('renderer:report', { level, event, details }),
onRepositoriesChanged: (listener) => subscribe('repositories:changed', listener),
onOperationsChanged: (listener) => subscribe('operations:changed', listener),
onUpdatesChanged: (listener) => subscribe('updates:changed', listener),
reset: () => invoke('app:reset'),
}),
);
+775
View File
@@ -0,0 +1,775 @@
{
"generatedAt": "2026-08-26T22:18:32.525Z",
"thresholds": {
"preferredMaximumLines": 750,
"justificationRequiredLines": 1000
},
"over750": [
{
"file": "src/main/git-service.cjs",
"lines": 881,
"branches": 134,
"functions": 147,
"ipcHandlers": 0,
"responsibilities": [
"git",
"renderer",
"security",
"updates"
],
"hotspotScore": 154
},
{
"file": "src/main/update-service.cjs",
"lines": 854,
"branches": 64,
"functions": 65,
"ipcHandlers": 0,
"responsibilities": [
"git",
"security",
"updates"
],
"hotspotScore": 74
}
],
"over1000": [],
"cyclomaticHotspots": [
{
"file": "src/main/git-service.cjs",
"lines": 881,
"branches": 134,
"functions": 147,
"ipcHandlers": 0,
"responsibilities": [
"git",
"renderer",
"security",
"updates"
],
"hotspotScore": 154
},
{
"file": "src/renderer/actions/shell.js",
"lines": 518,
"branches": 101,
"functions": 86,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"renderer",
"updates"
],
"hotspotScore": 131
},
{
"file": "src/renderer/app.js",
"lines": 734,
"branches": 80,
"functions": 124,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"renderer",
"security",
"updates"
],
"hotspotScore": 120
},
{
"file": "src/main/server-inventory.cjs",
"lines": 578,
"branches": 89,
"functions": 104,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"security",
"updates"
],
"hotspotScore": 119
},
{
"file": "src/main/unraid-inventory-methods.cjs",
"lines": 710,
"branches": 76,
"functions": 93,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"security",
"updates"
],
"hotspotScore": 106
}
],
"mixedResponsibilityModules": [
{
"file": "src/main/git-service.cjs",
"lines": 881,
"branches": 134,
"functions": 147,
"ipcHandlers": 0,
"responsibilities": [
"git",
"renderer",
"security",
"updates"
],
"hotspotScore": 154
},
{
"file": "src/renderer/actions/shell.js",
"lines": 518,
"branches": 101,
"functions": 86,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"renderer",
"updates"
],
"hotspotScore": 131
},
{
"file": "src/renderer/app.js",
"lines": 734,
"branches": 80,
"functions": 124,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"renderer",
"security",
"updates"
],
"hotspotScore": 120
},
{
"file": "src/main/server-inventory.cjs",
"lines": 578,
"branches": 89,
"functions": 104,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"security",
"updates"
],
"hotspotScore": 119
},
{
"file": "src/main/unraid-inventory-methods.cjs",
"lines": 710,
"branches": 76,
"functions": 93,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"security",
"updates"
],
"hotspotScore": 106
},
{
"file": "src/renderer/dialogs.js",
"lines": 433,
"branches": 60,
"functions": 83,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"renderer",
"security",
"updates"
],
"hotspotScore": 100
},
{
"file": "src/main/unraid-deployment-methods.cjs",
"lines": 583,
"branches": 69,
"functions": 31,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"security",
"updates"
],
"hotspotScore": 99
},
{
"file": "src/main/ipc.cjs",
"lines": 706,
"branches": 54,
"functions": 72,
"ipcHandlers": 27,
"responsibilities": [
"inventory",
"deployment",
"git",
"ipc",
"security",
"updates"
],
"hotspotScore": 94
},
{
"file": "src/renderer/views.js",
"lines": 736,
"branches": 53,
"functions": 152,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"renderer",
"security",
"updates"
],
"hotspotScore": 93
},
{
"file": "src/main/ssh-service.cjs",
"lines": 513,
"branches": 70,
"functions": 101,
"ipcHandlers": 0,
"responsibilities": [
"deployment",
"git",
"security",
"updates"
],
"hotspotScore": 90
},
{
"file": "src/renderer/actions/setup-and-settings.js",
"lines": 441,
"branches": 60,
"functions": 60,
"ipcHandlers": 0,
"responsibilities": [
"deployment",
"git",
"renderer",
"security",
"updates"
],
"hotspotScore": 90
},
{
"file": "main.cjs",
"lines": 471,
"branches": 39,
"functions": 57,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"ipc",
"renderer",
"security",
"updates"
],
"hotspotScore": 89
},
{
"file": "src/main/gitea-service.cjs",
"lines": 624,
"branches": 67,
"functions": 57,
"ipcHandlers": 0,
"responsibilities": [
"deployment",
"git",
"security",
"updates"
],
"hotspotScore": 87
},
{
"file": "src/renderer/actions/deployment-profile.js",
"lines": 408,
"branches": 57,
"functions": 44,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"renderer",
"security"
],
"hotspotScore": 87
},
{
"file": "src/renderer/actions/recovery.js",
"lines": 421,
"branches": 64,
"functions": 43,
"ipcHandlers": 0,
"responsibilities": [
"deployment",
"git",
"renderer",
"updates"
],
"hotspotScore": 84
},
{
"file": "src/main/config-store.cjs",
"lines": 668,
"branches": 52,
"functions": 89,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"security",
"updates"
],
"hotspotScore": 82
},
{
"file": "src/main/unraid-preflight-methods.cjs",
"lines": 623,
"branches": 40,
"functions": 47,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"renderer",
"security",
"updates"
],
"hotspotScore": 80
},
{
"file": "src/main/unraid-runtime-methods.cjs",
"lines": 388,
"branches": 37,
"functions": 38,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"renderer",
"security",
"updates"
],
"hotspotScore": 77
},
{
"file": "src/main/unraid-access-methods.cjs",
"lines": 462,
"branches": 43,
"functions": 41,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"security",
"updates"
],
"hotspotScore": 73
},
{
"file": "src/main/diagnostics-service.cjs",
"lines": 377,
"branches": 39,
"functions": 51,
"ipcHandlers": 0,
"responsibilities": [
"deployment",
"git",
"ipc",
"security",
"updates"
],
"hotspotScore": 69
},
{
"file": "src/renderer/events.js",
"lines": 181,
"branches": 35,
"functions": 27,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"renderer",
"security"
],
"hotspotScore": 65
},
{
"file": "src/main/git-validator-service.cjs",
"lines": 600,
"branches": 43,
"functions": 77,
"ipcHandlers": 0,
"responsibilities": [
"deployment",
"git",
"security",
"updates"
],
"hotspotScore": 63
},
{
"file": "src/main/deploy-key-lifecycle-service.cjs",
"lines": 192,
"branches": 31,
"functions": 38,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"security",
"updates"
],
"hotspotScore": 61
},
{
"file": "src/main/unraid-deployment-service.cjs",
"lines": 525,
"branches": 35,
"functions": 48,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"security"
],
"hotspotScore": 55
},
{
"file": "src/renderer/actions/inventory.js",
"lines": 186,
"branches": 24,
"functions": 32,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"renderer",
"updates"
],
"hotspotScore": 54
},
{
"file": "src/renderer/actions/deployment-operation.js",
"lines": 184,
"branches": 34,
"functions": 26,
"ipcHandlers": 0,
"responsibilities": [
"deployment",
"git",
"renderer",
"updates"
],
"hotspotScore": 54
},
{
"file": "src/main/ipc/deployment-handlers.cjs",
"lines": 286,
"branches": 13,
"functions": 38,
"ipcHandlers": 24,
"responsibilities": [
"inventory",
"deployment",
"git",
"ipc",
"security",
"updates"
],
"hotspotScore": 53
},
{
"file": "preload.cjs",
"lines": 164,
"branches": 2,
"functions": 125,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"ipc",
"renderer",
"security",
"updates"
],
"hotspotScore": 52
},
{
"file": "src/main/inventory-classifier.cjs",
"lines": 84,
"branches": 22,
"functions": 11,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"security",
"updates"
],
"hotspotScore": 52
},
{
"file": "src/renderer/mock-deployment-bridge.js",
"lines": 701,
"branches": 11,
"functions": 87,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"renderer",
"security",
"updates"
],
"hotspotScore": 51
},
{
"file": "src/renderer/operations.js",
"lines": 212,
"branches": 19,
"functions": 26,
"ipcHandlers": 0,
"responsibilities": [
"deployment",
"git",
"renderer",
"security",
"updates"
],
"hotspotScore": 49
},
{
"file": "src/main/production-acceptance-harness.cjs",
"lines": 150,
"branches": 17,
"functions": 28,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"security",
"updates"
],
"hotspotScore": 47
},
{
"file": "src/main/unraid-state-methods.cjs",
"lines": 294,
"branches": 16,
"functions": 21,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"security",
"updates"
],
"hotspotScore": 46
},
{
"file": "src/main/preflight-service.cjs",
"lines": 209,
"branches": 24,
"functions": 34,
"ipcHandlers": 0,
"responsibilities": [
"deployment",
"git",
"renderer",
"security"
],
"hotspotScore": 44
},
{
"file": "src/main/repository-service.cjs",
"lines": 304,
"branches": 22,
"functions": 46,
"ipcHandlers": 0,
"responsibilities": [
"deployment",
"git",
"security",
"updates"
],
"hotspotScore": 42
},
{
"file": "src/renderer/mock-bridge.js",
"lines": 590,
"branches": 17,
"functions": 54,
"ipcHandlers": 0,
"responsibilities": [
"deployment",
"git",
"security",
"updates"
],
"hotspotScore": 37
},
{
"file": "src/renderer/mock-repository-bridge.js",
"lines": 701,
"branches": 14,
"functions": 91,
"ipcHandlers": 0,
"responsibilities": [
"deployment",
"git",
"security",
"updates"
],
"hotspotScore": 34
},
{
"file": "src/main/deployment-identity.cjs",
"lines": 36,
"branches": 0,
"functions": 11,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"security",
"updates"
],
"hotspotScore": 30
},
{
"file": "src/main/ipc/operations-handlers.cjs",
"lines": 101,
"branches": 8,
"functions": 14,
"ipcHandlers": 9,
"responsibilities": [
"deployment",
"git",
"ipc",
"renderer"
],
"hotspotScore": 28
},
{
"file": "src/main/inventory-review-service.cjs",
"lines": 32,
"branches": 8,
"functions": 4,
"ipcHandlers": 0,
"responsibilities": [
"inventory",
"deployment",
"git",
"updates"
],
"hotspotScore": 28
},
{
"file": "src/main/unraid-deploy-key-host.cjs",
"lines": 80,
"branches": 7,
"functions": 22,
"ipcHandlers": 0,
"responsibilities": [
"deployment",
"git",
"security",
"updates"
],
"hotspotScore": 27
}
],
"ipcHotspots": [
{
"file": "src/main/ipc.cjs",
"lines": 706,
"branches": 54,
"functions": 72,
"ipcHandlers": 27,
"responsibilities": [
"inventory",
"deployment",
"git",
"ipc",
"security",
"updates"
],
"hotspotScore": 94
},
{
"file": "src/main/ipc/deployment-handlers.cjs",
"lines": 286,
"branches": 13,
"functions": 38,
"ipcHandlers": 24,
"responsibilities": [
"inventory",
"deployment",
"git",
"ipc",
"security",
"updates"
],
"hotspotScore": 53
},
{
"file": "src/main/ipc/repository-handlers.cjs",
"lines": 451,
"branches": 16,
"functions": 83,
"ipcHandlers": 53,
"responsibilities": [
"git",
"ipc"
],
"hotspotScore": 16
}
]
}
+30
View File
@@ -0,0 +1,30 @@
# ForgeFlow architecture audit
Generated 2026-08-26T22:18:32.525Z. Complexity is a deterministic decision-point count used for hotspot ranking, not a claim of exact McCabe complexity.
## Files above 750 lines
| File | Lines | Decisions | Functions | IPC handlers | Responsibilities |
|---|---:|---:|---:|---:|---|
| `src/main/git-service.cjs` | 881 | 134 | 147 | 0 | git, renderer, security, updates |
| `src/main/update-service.cjs` | 854 | 64 | 65 | 0 | git, security, updates |
## Files above 1,000 lines
| File | Lines | Decisions | Functions | IPC handlers | Responsibilities |
|---|---:|---:|---:|---:|---|
No findings.
## Cyclomatic hotspots
| File | Lines | Decisions | Functions | IPC handlers | Responsibilities |
|---|---:|---:|---:|---:|---|
| `src/main/git-service.cjs` | 881 | 134 | 147 | 0 | git, renderer, security, updates |
| `src/renderer/actions/shell.js` | 518 | 101 | 86 | 0 | inventory, deployment, git, renderer, updates |
| `src/renderer/app.js` | 734 | 80 | 124 | 0 | inventory, deployment, git, renderer, security, updates |
| `src/main/server-inventory.cjs` | 578 | 89 | 104 | 0 | inventory, deployment, git, security, updates |
| `src/main/unraid-inventory-methods.cjs` | 710 | 76 | 93 | 0 | inventory, deployment, git, security, updates |
## Interpretation
Files above 750 lines require decomposition. Files above 1,000 lines are release blockers unless a concrete technical exception is documented. Mixed responsibility and IPC hotspot lists are available in the JSON report.
+40 -6
View File
@@ -7,7 +7,9 @@ param(
[Parameter(Mandatory = $true)][int]$ParentPid, [Parameter(Mandatory = $true)][int]$ParentPid,
[Parameter(Mandatory = $true)][string]$LogPath, [Parameter(Mandatory = $true)][string]$LogPath,
[Parameter(Mandatory = $true)][string]$StatusPath, [Parameter(Mandatory = $true)][string]$StatusPath,
[Parameter(Mandatory = $true)][string]$UpdateId [Parameter(Mandatory = $true)][string]$UpdateId,
[switch]$HandshakeOnly,
[switch]$VerifyOnly
) )
$ErrorActionPreference = "Stop" $ErrorActionPreference = "Stop"
@@ -27,22 +29,54 @@ function Write-UpdateState {
updatedAt = [DateTime]::UtcNow.ToString("o") updatedAt = [DateTime]::UtcNow.ToString("o")
} }
if ($State -in @("success", "failed", "rolled-back")) { $payload.completedAt = [DateTime]::UtcNow.ToString("o") } if ($State -in @("success", "failed", "rolled-back")) { $payload.completedAt = [DateTime]::UtcNow.ToString("o") }
$directory = Split-Path -Parent $StatusPath
if ($directory) { New-Item -ItemType Directory -Force -Path $directory | Out-Null }
$temporary = "$StatusPath.$PID.tmp" $temporary = "$StatusPath.$PID.tmp"
$payload | ConvertTo-Json -Depth 4 | Set-Content -LiteralPath $temporary -Encoding UTF8 $backup = "$StatusPath.$PID.bak"
if (Test-Path -LiteralPath $StatusPath) { [IO.File]::Replace($temporary, $StatusPath, $null) } $json = $payload | ConvertTo-Json -Depth 4
else { Move-Item -LiteralPath $temporary -Destination $StatusPath } $utf8NoBom = New-Object System.Text.UTF8Encoding($false)
[IO.File]::WriteAllText($temporary, $json, $utf8NoBom)
try {
if ([IO.File]::Exists($StatusPath)) {
[IO.File]::Replace($temporary, $StatusPath, $backup)
[IO.File]::Delete($backup)
} else {
[IO.File]::Move($temporary, $StatusPath)
}
} catch {
[IO.File]::Copy($temporary, $StatusPath, $true)
[IO.File]::Delete($temporary)
if ([IO.File]::Exists($backup)) { [IO.File]::Delete($backup) }
}
} }
function Write-Log([string]$Message) { function Write-Log([string]$Message) {
"{0} {1}" -f [DateTime]::UtcNow.ToString("o"), $Message | Add-Content -LiteralPath $LogPath -Encoding UTF8 "{0} {1}" -f [DateTime]::UtcNow.ToString("o"), $Message | Add-Content -LiteralPath $LogPath -Encoding UTF8
} }
function Get-Sha256([string]$Path) {
$stream = [IO.File]::OpenRead($Path)
$algorithm = [Security.Cryptography.SHA256]::Create()
try {
return ([BitConverter]::ToString($algorithm.ComputeHash($stream))).Replace("-", "").ToLowerInvariant()
} finally {
$algorithm.Dispose()
$stream.Dispose()
}
}
try { try {
Write-UpdateState -State "started" -Message "Binary updater owns the update request." Write-UpdateState -State "started" -Message "Binary updater owns the update request."
Write-Log "Validating ForgeFlow $ExpectedVersion binary update." Write-Log "Validating ForgeFlow $ExpectedVersion binary update."
$actualSha256 = (Get-FileHash -LiteralPath $BinaryPath -Algorithm SHA256).Hash.ToLowerInvariant() if ($HandshakeOnly) {
Write-Log "Handshake-only verification completed successfully."
exit 0
}
$actualSha256 = Get-Sha256 -Path $BinaryPath
if ($actualSha256 -ne $ExpectedSha256.ToLowerInvariant()) { throw "Binary update SHA-256 verification failed." } if ($actualSha256 -ne $ExpectedSha256.ToLowerInvariant()) { throw "Binary update SHA-256 verification failed." }
if (-not (Test-Path -LiteralPath $CurrentExecutable -PathType Leaf)) { throw "Current ForgeFlow executable was not found." } if (-not (Test-Path -LiteralPath $CurrentExecutable -PathType Leaf)) { throw "Current ForgeFlow executable was not found." }
if ($VerifyOnly) {
Write-Log "Verification-only SHA-256 check completed successfully."
exit 0
}
Write-UpdateState -State "waiting-for-exit" -Message "Waiting for ForgeFlow to close." Write-UpdateState -State "waiting-for-exit" -Message "Waiting for ForgeFlow to close."
try { Wait-Process -Id $ParentPid -Timeout 60 -ErrorAction Stop } catch { try { Wait-Process -Id $ParentPid -Timeout 60 -ErrorAction Stop } catch {
+20 -4
View File
@@ -54,15 +54,31 @@ function Write-UpdateState {
if ([System.IO.File]::Exists($StatusPath)) { if ([System.IO.File]::Exists($StatusPath)) {
# Windows PowerShell 5.1 does not reliably let Move-Item -Force replace # Windows PowerShell 5.1 does not reliably let Move-Item -Force replace
# an existing file. File.Replace is atomic on the local NTFS volume. # an existing file. File.Replace is atomic on the local NTFS volume.
[System.IO.File]::Replace($temporary, $StatusPath, $null) $backup = "$StatusPath.$PID.bak"
[System.IO.File]::Replace($temporary, $StatusPath, $backup)
} else { } else {
[System.IO.File]::Move($temporary, $StatusPath) [System.IO.File]::Move($temporary, $StatusPath)
} }
} catch { } catch {
# Some filesystems do not implement File.Replace. Copy with overwrite is # Some filesystems do not implement File.Replace. Copy with overwrite is
# the deterministic fallback; the temporary file is removed afterwards. # the deterministic fallback; the temporary file is removed afterwards.
[System.IO.File]::Copy($temporary, $StatusPath, $true) if ([System.IO.File]::Exists($temporary)) {
[System.IO.File]::Delete($temporary) [System.IO.File]::Copy($temporary, $StatusPath, $true)
[System.IO.File]::Delete($temporary)
}
} finally {
if ([System.IO.File]::Exists($backup)) { [System.IO.File]::Delete($backup) }
}
}
function Get-Sha256([string]$Path) {
$stream = [IO.File]::OpenRead($Path)
$algorithm = [Security.Cryptography.SHA256]::Create()
try {
return ([BitConverter]::ToString($algorithm.ComputeHash($stream))).Replace("-", "").ToLowerInvariant()
} finally {
$algorithm.Dispose()
$stream.Dispose()
} }
} }
@@ -115,7 +131,7 @@ try {
Start-Sleep -Milliseconds 500 Start-Sleep -Milliseconds 500
} }
$actualHash = (Get-FileHash -LiteralPath $ArchivePath -Algorithm SHA256).Hash.ToLowerInvariant() $actualHash = Get-Sha256 -Path $ArchivePath
if ($actualHash -ne $ExpectedSha256.ToLowerInvariant()) { throw "Update archive checksum mismatch." } if ($actualHash -ne $ExpectedSha256.ToLowerInvariant()) { throw "Update archive checksum mismatch." }
$working = Join-Path ([IO.Path]::GetTempPath()) ("forgeflow-update-" + [guid]::NewGuid().ToString("N")) $working = Join-Path ([IO.Path]::GetTempPath()) ("forgeflow-update-" + [guid]::NewGuid().ToString("N"))
+53
View File
@@ -0,0 +1,53 @@
import { readdir, readFile, writeFile, mkdir } from "node:fs/promises";
import path from "node:path";
const root = path.resolve(import.meta.dirname, "..");
const sourceRoots = ["main.cjs", "preload.cjs", "src/main", "src/renderer", "src/shared"];
const extensions = new Set([".js", ".cjs", ".mjs"]);
async function filesBelow(entry) {
const absolute = path.join(root, entry);
const stat = await import("node:fs/promises").then(({ stat }) => stat(absolute));
if (stat.isFile()) return [entry];
const result = [];
for (const child of await readdir(absolute, { withFileTypes: true })) {
const relative = path.join(entry, child.name);
if (child.isDirectory()) result.push(...await filesBelow(relative));
else if (extensions.has(path.extname(child.name))) result.push(relative);
}
return result;
}
function analyze(relative, source) {
const lines = source.split(/\r?\n/).length;
const branches = (source.match(/\b(?:if|else if|for|while|case|catch)\b|\?\?/g) || []).length;
const functions = (source.match(/\b(?:async\s+)?function\b|=>|\b(?:async\s+)?[A-Za-z_$][\w$]*\s*\([^)]*\)\s*\{/g) || []).length;
const ipcHandlers = (source.match(/\bregister\(\s*["']/g) || []).length;
const responsibilities = [
["inventory", /inventory|workload/i], ["deployment", /deploy|rollback|activation/i],
["git", /\bgit|repository/i], ["ipc", /ipc|register\(/i], ["renderer", /render|modal|document\./i],
["security", /key|credential|signature|checksum/i], ["updates", /update|release|artifact/i],
].filter(([, pattern]) => pattern.test(source)).map(([name]) => name);
return { file: relative.replaceAll("\\", "/"), lines, branches, functions, ipcHandlers, responsibilities, hotspotScore: branches + Math.max(0, responsibilities.length - 2) * 10 };
}
const files = (await Promise.all(sourceRoots.map(filesBelow))).flat();
const results = [];
for (const file of files) results.push(analyze(file, await readFile(path.join(root, file), "utf8")));
results.sort((a, b) => b.hotspotScore - a.hotspotScore || b.lines - a.lines);
const report = {
generatedAt: new Date().toISOString(),
thresholds: { preferredMaximumLines: 750, justificationRequiredLines: 1000 },
over750: results.filter((item) => item.lines > 750),
over1000: results.filter((item) => item.lines > 1000),
cyclomaticHotspots: results.filter((item) => item.branches >= 75).slice(0, 20),
mixedResponsibilityModules: results.filter((item) => item.responsibilities.length >= 4),
ipcHotspots: results.filter((item) => item.ipcHandlers >= 10),
};
const reportDir = path.join(root, "reports");
await mkdir(reportDir, { recursive: true });
await writeFile(path.join(reportDir, "architecture-audit.json"), `${JSON.stringify(report, null, 2)}\n`);
const table = (items) => items.length ? items.map((item) => `| \`${item.file}\` | ${item.lines} | ${item.branches} | ${item.functions} | ${item.ipcHandlers} | ${item.responsibilities.join(", ")} |`).join("\n") : "No findings.";
const markdown = `# ForgeFlow architecture audit\n\nGenerated ${report.generatedAt}. Complexity is a deterministic decision-point count used for hotspot ranking, not a claim of exact McCabe complexity.\n\n## Files above 750 lines\n\n| File | Lines | Decisions | Functions | IPC handlers | Responsibilities |\n|---|---:|---:|---:|---:|---|\n${table(report.over750)}\n\n## Files above 1,000 lines\n\n| File | Lines | Decisions | Functions | IPC handlers | Responsibilities |\n|---|---:|---:|---:|---:|---|\n${table(report.over1000)}\n\n## Cyclomatic hotspots\n\n| File | Lines | Decisions | Functions | IPC handlers | Responsibilities |\n|---|---:|---:|---:|---:|---|\n${table(report.cyclomaticHotspots)}\n\n## Interpretation\n\nFiles above 750 lines require decomposition. Files above 1,000 lines are release blockers unless a concrete technical exception is documented. Mixed responsibility and IPC hotspot lists are available in the JSON report.\n`;
await writeFile(path.join(reportDir, "architecture-audit.md"), markdown);
console.log(`Audited ${results.length} source files; ${report.over750.length} exceed 750 lines and ${report.over1000.length} exceed 1,000 lines.`);
+141
View File
@@ -0,0 +1,141 @@
"use strict";
const path = require("node:path");
const { app } = require("electron");
const { ConfigStore } = require("../src/main/config-store.cjs");
const { GitService } = require("../src/main/git-service.cjs");
const { GiteaService } = require("../src/main/gitea-service.cjs");
const { RepositoryService } = require("../src/main/repository-service.cjs");
const { SshService } = require("../src/main/ssh-service.cjs");
const { UnraidDeploymentService } = require("../src/main/unraid-deployment-service.cjs");
const userDataPath = process.env.FORGEFLOW_USER_DATA
? path.resolve(process.env.FORGEFLOW_USER_DATA)
: path.join(app.getPath("appData"), "forgeflow");
app.setPath("userData", userDataPath);
app.whenReady().then(async () => {
try {
const configureAccess = process.argv.includes("--configure-access");
const reconcile = process.argv.includes("--reconcile");
const summaryOnly = process.argv.includes("--summary");
const inventoryOnly = process.argv.includes("--inventory-only");
const repositoryFilter = new Set(String(process.argv.find((value) => value.startsWith("--repository=")) || "")
.slice("--repository=".length).toLowerCase().split(",").map((value) => value.trim()).filter(Boolean));
const store = new ConfigStore(userDataPath);
await store.load();
const git = new GitService();
const gitea = new GiteaService(store);
const repositories = await new RepositoryService(store, git, gitea).refresh();
const ssh = new SshService({ store });
const deployments = new UnraidDeploymentService({ store, ssh, git, gitea, sourcePath: path.resolve(__dirname, "..") });
const reports = [];
for (const server of store.data.servers || []) {
const report = await deployments.scanServerInventory(server.id, repositories);
let reconciliation = null;
if (reconcile) {
for (let attempt = 1; attempt <= 3 && !reconciliation; attempt += 1) {
const preview = await deployments.planServerInventoryReconciliation(server.id, repositories, { autoLink: true });
try {
reconciliation = await deployments.reconcileServerInventory(server.id, repositories, { autoLink: true, expectedPlanId: preview.plan.id });
} catch (error) {
if (error.code !== "RECONCILIATION_PLAN_STALE" || attempt === 3) throw error;
}
}
}
const access = [];
const seenProfiles = new Set();
for (const repository of inventoryOnly || configureAccess ? [] : repositories) {
for (const profile of repository.deploymentProfiles || store.getDeploymentProfiles(repository.fullName) || []) {
if (profile.serverId !== server.id || profile.deploymentMode !== "server-git" || seenProfiles.has(profile.id)) continue;
seenProfiles.add(profile.id);
try {
let verification = await deployments.verifyServerGitProfile({ repository, profileId: profile.id });
await deployments.refreshProfileState(repository.fullName, profile.id, verification.branchSha);
verification = await deployments.verifyServerGitProfile({ repository, profileId: profile.id });
access.push(verification);
} catch (error) {
access.push({ repository: repository.fullName, profileId: profile.id, readiness: "Verification incomplete", ready: false, error: error.message });
}
}
}
if (configureAccess) {
const refreshedRepositories = await new RepositoryService(store, git, gitea).refresh();
for (const workload of report.workloads.filter((item) => item.runtime?.running && item.link?.profileId && item.link?.repositoryFullName)) {
const repository = refreshedRepositories.find((item) => String(item.fullName).toLowerCase() === String(workload.link.repositoryFullName).toLowerCase());
if (!repository) continue;
if (repositoryFilter.size && !repositoryFilter.has(String(repository.fullName).toLowerCase())) continue;
try {
const configured = await deployments.configureServerGitAccess({ repository, profileId: workload.link.profileId });
access.push({ repository: repository.fullName, profileId: workload.link.profileId, action: "configured", ready: true, created: configured.created, remoteSha: configured.remoteSha });
await new Promise((resolve) => setTimeout(resolve, 1500));
} catch (error) {
access.push({ repository: repository.fullName, ready: false, error: error.message });
}
}
}
reports.push({
server: server.name,
reconciliation: reconciliation ? {
adopted: reconciliation.adopted,
refreshed: reconciliation.refreshed,
retired: reconciliation.retired,
staleProfiles: reconciliation.staleProfiles,
recoverySnapshot: reconciliation.recoverySnapshot,
} : null,
capabilities: report.capabilities,
warnings: (report.warnings || []).map((warning) => String(warning).slice(0, 300)),
summary: {
detected: report.detected,
running: report.running,
linked: report.linked,
needsReview: report.needsReview,
},
reviewBreakdown: report.workloads.filter((workload) => !workload.reviewDecision && (workload.classification?.type === "stale-link" || (workload.runtime?.running && workload.classification?.type === "duplicate") || (workload.runtime?.running && !["system-container", "external-container", "temporary-runtime", "backup", "release-folder", "historical-compose", "manually-excluded"].includes(workload.classification?.type) && ["suggested", "ambiguous", "unmatched"].includes(workload.status)))).reduce((counts, workload) => {
const key = `${workload.classification?.type || "unknown"}:${workload.status || "unknown"}`;
counts[key] = (counts[key] || 0) + 1;
return counts;
}, {}),
reviewSamples: report.workloads.filter((workload) => !workload.reviewDecision && (workload.classification?.type === "stale-link" || (workload.runtime?.running && workload.classification?.type === "duplicate") || (workload.runtime?.running && !["system-container", "external-container", "temporary-runtime", "backup", "release-folder", "historical-compose", "manually-excluded"].includes(workload.classification?.type) && ["suggested", "ambiguous", "unmatched"].includes(workload.status)))).slice(0, 30).map((workload) => ({ name: workload.displayName, type: workload.classification?.type, status: workload.status, running: workload.runtime?.running, folder: workload.remoteFolderCandidate, containers: (workload.containers || []).map((container) => container.name) })),
access,
workloads: report.workloads.filter((workload) => workload.link || (workload.runtime?.running && workload.status !== "unmatched")).map((workload) => ({
name: workload.displayName,
running: workload.runtime?.running === true,
health: workload.runtime?.health || "unknown",
repository: workload.link?.repositoryFullName || workload.suggestedRepository?.fullName || null,
confidence: workload.matchConfidence || workload.status,
folder: workload.remoteFolderCandidate || null,
containers: (workload.containers || []).map((container) => container.name),
})),
});
}
const output = summaryOnly ? reports.map((report) => ({
server: report.server,
capabilities: report.capabilities,
warnings: report.warnings,
summary: report.summary,
reviewBreakdown: Object.fromEntries(Object.entries(report.reviewBreakdown || {}).sort(([left], [right]) => left.localeCompare(right))),
reviewSamples: report.reviewSamples,
reconciliation: report.reconciliation,
access: report.access.map((item) => ({
repository: item.repository,
profileId: item.profileId || null,
ready: item.ready,
deployReady: item.deployReady ?? item.ready,
readiness: item.readiness || item.action || null,
remoteSha: item.remoteSha || item.branchSha || null,
liveSha: item.liveSha || null,
blockers: (item.deploymentBlockers || []).map((check) => ({ id: check.id, detail: check.detail })),
warnings: (item.checks || []).filter((check) => check.status !== "pass" && !(item.deploymentBlockers || []).some((blocker) => blocker.id === check.id)).map((check) => ({ id: check.id, status: check.status, detail: check.detail })),
error: item.error || null,
})),
review: report.workloads.filter((item) => !item.repository && item.running).map((item) => ({ name: item.name, confidence: item.confidence, folder: item.folder })),
})) : reports;
console.log(JSON.stringify(output, null, 2));
} catch (error) {
console.error(error?.stack || error?.message || String(error));
process.exitCode = 1;
} finally {
app.quit();
}
});
+2 -2
View File
@@ -4,12 +4,12 @@ import path from 'node:path';
import { fileURLToPath } from 'node:url'; import { fileURLToPath } from 'node:url';
const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..'); const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
const excludedDirectories = new Set(['.git', 'dist', 'node_modules']); const excludedDirectories = new Set(['.git', '.forgeflow', 'artifacts', 'coverage', 'dist', 'node_modules', 'playwright-report', 'ForgeFlow-runtime-win-x64']);
const excludedFiles = new Set(['SOURCE_MANIFEST.txt']); const excludedFiles = new Set(['SOURCE_MANIFEST.txt']);
async function collect(directory, output = []) { async function collect(directory, output = []) {
for (const entry of await readdir(directory, { withFileTypes: true })) { for (const entry of await readdir(directory, { withFileTypes: true })) {
if (entry.isDirectory() && excludedDirectories.has(entry.name)) continue; if (excludedDirectories.has(entry.name)) continue;
const absolute = path.join(directory, entry.name); const absolute = path.join(directory, entry.name);
if (entry.isDirectory()) await collect(absolute, output); if (entry.isDirectory()) await collect(absolute, output);
else if (!excludedFiles.has(entry.name)) output.push(absolute); else if (!excludedFiles.has(entry.name)) output.push(absolute);
+93 -27
View File
@@ -4,6 +4,7 @@ const fs = require("node:fs/promises");
const path = require("node:path"); const path = require("node:path");
const { execFileSync } = require("node:child_process"); const { execFileSync } = require("node:child_process");
const { app, safeStorage } = require("electron"); const { app, safeStorage } = require("electron");
const { normalizeBaseUrl } = require("../src/shared/validation.cjs");
const root = path.resolve(__dirname, ".."); const root = path.resolve(__dirname, "..");
const configuredUserData = const configuredUserData =
@@ -11,6 +12,14 @@ const configuredUserData =
path.join(app.getPath("appData"), "forgeflow"); path.join(app.getPath("appData"), "forgeflow");
app.setPath("userData", path.resolve(configuredUserData)); app.setPath("userData", path.resolve(configuredUserData));
function safeRepositoryPart(value, label) {
const text = String(value || "").trim();
if (!/^[a-zA-Z0-9_.-]+$/.test(text)) {
throw new Error(`${label} contains unsupported characters.`);
}
return text;
}
async function api(baseUrl, token, pathname, options = {}) { async function api(baseUrl, token, pathname, options = {}) {
const response = await fetch(`${baseUrl}/api/v1${pathname}`, { const response = await fetch(`${baseUrl}/api/v1${pathname}`, {
...options, ...options,
@@ -28,10 +37,11 @@ async function api(baseUrl, token, pathname, options = {}) {
} catch { } catch {
data = text; data = text;
} }
if (!response.ok) if (!response.ok) {
throw new Error( throw new Error(
`Gitea returned HTTP ${response.status}: ${data?.message || text || response.statusText}`, `Gitea returned HTTP ${response.status}: ${data?.message || text || response.statusText}`,
); );
}
return data; return data;
} }
@@ -40,16 +50,29 @@ app.whenReady().then(async () => {
const manifest = JSON.parse( const manifest = JSON.parse(
await fs.readFile(path.join(root, "package.json"), "utf8"), await fs.readFile(path.join(root, "package.json"), "utf8"),
); );
const config = JSON.parse( const configPath = path.join(configuredUserData, "forgeflow-config.json");
await fs.readFile( const config = JSON.parse(await fs.readFile(configPath, "utf8"));
path.join(configuredUserData, "forgeflow-config.json"), if (!config?.gitea?.encryptedToken) {
"utf8", throw new Error(
), `No encrypted Gitea token was found in ${configPath}. Sign in to Gitea once from ForgeFlow first.`,
); );
}
const token = safeStorage.decryptString( const token = safeStorage.decryptString(
Buffer.from(config.gitea.encryptedToken, "base64"), Buffer.from(config.gitea.encryptedToken, "base64"),
); );
const baseUrl = String(config.gitea.baseUrl).replace(/\/+$/, ""); const baseUrl = normalizeBaseUrl(config.gitea.baseUrl);
const owner = safeRepositoryPart(
process.env.FORGEFLOW_RELEASE_OWNER || config.updates?.owner || "Jens",
"Release repository owner",
);
const repo = safeRepositoryPart(
process.env.FORGEFLOW_RELEASE_REPO || config.updates?.repo || "ForgeFlow",
"Release repository name",
);
const branch = safeRepositoryPart(
process.env.FORGEFLOW_RELEASE_BRANCH || config.updates?.branch || "main",
"Release branch",
);
const version = manifest.version; const version = manifest.version;
const tag = `v${version}`; const tag = `v${version}`;
const commit = execFileSync("git", ["rev-parse", "HEAD"], { const commit = execFileSync("git", ["rev-parse", "HEAD"], {
@@ -58,13 +81,16 @@ app.whenReady().then(async () => {
}).trim(); }).trim();
const remote = execFileSync( const remote = execFileSync(
"git", "git",
["ls-remote", "origin", "refs/heads/main"], ["ls-remote", "origin", `refs/heads/${branch}`],
{ cwd: root, encoding: "utf8" }, { cwd: root, encoding: "utf8" },
) )
.trim() .trim()
.split(/\s+/)[0]; .split(/\s+/)[0];
if (commit !== remote) if (commit !== remote) {
throw new Error("Local HEAD is not the published origin/main commit."); throw new Error(
`Local HEAD is not the published origin/${branch} commit. Push the exact source before publishing binaries.`,
);
}
const notesPath = path.join(root, "docs", `RELEASE_NOTES_${version}.md`); const notesPath = path.join(root, "docs", `RELEASE_NOTES_${version}.md`);
const body = await fs.readFile(notesPath, "utf8"); const body = await fs.readFile(notesPath, "utf8");
let release; let release;
@@ -72,24 +98,36 @@ app.whenReady().then(async () => {
release = await api( release = await api(
baseUrl, baseUrl,
token, token,
`/repos/Jens/ForgeFlow/releases/tags/${encodeURIComponent(tag)}`, `/repos/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}/releases/tags/${encodeURIComponent(tag)}`,
); );
} catch (error) { } catch (error) {
if (!/HTTP 404/.test(error.message)) throw error; if (!/HTTP 404/.test(error.message)) throw error;
release = await api(baseUrl, token, "/repos/Jens/ForgeFlow/releases", { release = await api(
method: "POST", baseUrl,
headers: { "Content-Type": "application/json" }, token,
body: JSON.stringify({ `/repos/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}/releases`,
tag_name: tag, {
target_commitish: commit, method: "POST",
name: `ForgeFlow ${version}`, headers: { "Content-Type": "application/json" },
body, body: JSON.stringify({
draft: false, tag_name: tag,
prerelease: false, target_commitish: commit,
}), name: `ForgeFlow ${version}`,
}); body,
draft: true,
prerelease: false,
}),
},
);
} }
if (release.draft !== true) {
release = await api(baseUrl, token, `/repos/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}/releases/${release.id}`, {
method: "PATCH",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ draft: true }),
});
}
const binaries = [ const binaries = [
path.join(root, "dist", `ForgeFlow-Setup-${version}-win-x64.exe`), path.join(root, "dist", `ForgeFlow-Setup-${version}-win-x64.exe`),
path.join(root, "dist", `ForgeFlow-Portable-${version}-win-x64.exe`), path.join(root, "dist", `ForgeFlow-Portable-${version}-win-x64.exe`),
@@ -115,7 +153,7 @@ app.whenReady().then(async () => {
await api( await api(
baseUrl, baseUrl,
token, token,
`/repos/Jens/ForgeFlow/releases/${release.id}/assets/${existing.id}`, `/repos/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}/releases/${release.id}/assets/${existing.id}`,
{ method: "DELETE" }, { method: "DELETE" },
); );
} }
@@ -124,7 +162,7 @@ app.whenReady().then(async () => {
const uploaded = await api( const uploaded = await api(
baseUrl, baseUrl,
token, token,
`/repos/Jens/ForgeFlow/releases/${release.id}/assets?name=${encodeURIComponent(name)}`, `/repos/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}/releases/${release.id}/assets?name=${encodeURIComponent(name)}`,
{ {
method: "POST", method: "POST",
body: form, body: form,
@@ -138,8 +176,36 @@ app.whenReady().then(async () => {
console.log(`PASS published ${name}`); console.log(`PASS published ${name}`);
} }
} }
for (const [name, type] of [
[`ForgeFlow-${version}-provenance.json`, "application/json"],
[`ForgeFlow-${version}-sbom.cdx.json`, "application/vnd.cyclonedx+json"],
[`ForgeFlow-${version}-release-manifest.json`, "application/json"],
[`ForgeFlow-${version}-release-manifest.json.sig`, "application/octet-stream"],
]) {
const bytes = await fs.readFile(path.join(root, "dist", name));
const existing = (release.assets || []).find((asset) => asset.name === name);
if (existing) await api(baseUrl, token, `/repos/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}/releases/${release.id}/assets/${existing.id}`, { method: "DELETE" });
const form = new FormData();
form.append("attachment", new Blob([bytes], { type }), name);
const uploaded = await api(baseUrl, token, `/repos/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}/releases/${release.id}/assets?name=${encodeURIComponent(name)}`, { method: "POST", body: form, timeout: 300_000 });
release.assets = [...(release.assets || []).filter((asset) => asset.name !== name), uploaded];
}
const requiredAssets = [
...binaries.flatMap((binaryPath) => [path.basename(binaryPath), `${path.basename(binaryPath)}.sha256`]),
`ForgeFlow-${version}-provenance.json`,
`ForgeFlow-${version}-sbom.cdx.json`,
`ForgeFlow-${version}-release-manifest.json`,
`ForgeFlow-${version}-release-manifest.json.sig`,
];
const missingAssets = requiredAssets.filter((name) => !(release.assets || []).some((asset) => asset.name === name));
if (missingAssets.length) throw new Error(`Release remains draft because required assets are missing: ${missingAssets.join(", ")}`);
release = await api(baseUrl, token, `/repos/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}/releases/${release.id}`, {
method: "PATCH",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ draft: false }),
});
console.log( console.log(
`PASS ForgeFlow ${version} binary release published for ${commit.slice(0, 7)}`, `PASS ForgeFlow ${version} binary release published to ${owner}/${repo} for ${commit.slice(0, 7)}`,
); );
app.exit(0); app.exit(0);
} catch (error) { } catch (error) {
+6 -1
View File
@@ -4,12 +4,17 @@ import path from 'node:path';
import { fileURLToPath } from 'node:url'; import { fileURLToPath } from 'node:url';
const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..', 'src', 'renderer'); const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..', 'src', 'renderer');
const port = Number(process.env.PORT || 4173); const port = Number(process.env.PORT || 41737);
const mime = { '.html': 'text/html; charset=utf-8', '.css': 'text/css; charset=utf-8', '.js': 'text/javascript; charset=utf-8', '.svg': 'image/svg+xml' }; const mime = { '.html': 'text/html; charset=utf-8', '.css': 'text/css; charset=utf-8', '.js': 'text/javascript; charset=utf-8', '.svg': 'image/svg+xml' };
const server = http.createServer(async (request, response) => { const server = http.createServer(async (request, response) => {
try { try {
const pathname = decodeURIComponent(new URL(request.url, `http://${request.headers.host}`).pathname); const pathname = decodeURIComponent(new URL(request.url, `http://${request.headers.host}`).pathname);
if (pathname === '/__forgeflow_test_ready__') {
response.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8', 'Cache-Control': 'no-store' });
response.end('forgeflow-demo-ready');
return;
}
const relative = pathname === '/' ? 'index.html' : pathname.replace(/^\//, ''); const relative = pathname === '/' ? 'index.html' : pathname.replace(/^\//, '');
const target = path.resolve(root, relative); const target = path.resolve(root, relative);
if (!target.startsWith(root)) throw Object.assign(new Error('Forbidden'), { code: 'EACCES' }); if (!target.startsWith(root)) throw Object.assign(new Error('Forbidden'), { code: 'EACCES' });
+34
View File
@@ -0,0 +1,34 @@
import { createHash, createPrivateKey, createPublicKey, generateKeyPairSync } from "node:crypto";
import { mkdir, readFile, writeFile } from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import { fileURLToPath } from "node:url";
const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..");
const defaultPrivatePath = path.join(
process.env.APPDATA || path.join(os.homedir(), "AppData", "Roaming"),
"forgeflow",
"release-signing-private.pem",
);
const privatePath = path.resolve(process.env.FORGEFLOW_UPDATE_SIGNING_PRIVATE_KEY || defaultPrivatePath);
const publicPath = path.join(root, "build", "update-signing-public.pem");
let privateKey;
try {
privateKey = createPrivateKey(await readFile(privatePath));
if (privateKey.asymmetricKeyType !== "ed25519") throw new Error("The existing key is not Ed25519.");
} catch (error) {
if (error.code !== "ENOENT") throw error;
privateKey = generateKeyPairSync("ed25519").privateKey;
await mkdir(path.dirname(privatePath), { recursive: true, mode: 0o700 });
await writeFile(privatePath, privateKey.export({ type: "pkcs8", format: "pem" }), { mode: 0o600, flag: "wx" });
}
const publicKey = createPublicKey(privateKey);
const publicPem = publicKey.export({ type: "spki", format: "pem" });
await mkdir(path.dirname(publicPath), { recursive: true });
await writeFile(publicPath, publicPem, { mode: 0o644 });
const fingerprint = createHash("sha256").update(publicKey.export({ type: "spki", format: "der" })).digest("hex");
console.log(`ForgeFlow Ed25519 update key ready. Public key fingerprint: SHA256:${fingerprint}`);
console.log(`Private key: ${privatePath}`);
console.log(`Public key: ${publicPath}`);
+46
View File
@@ -0,0 +1,46 @@
import { createHash, createPrivateKey, createPublicKey, sign, verify } from "node:crypto";
import { readFile, stat, writeFile } from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import { fileURLToPath } from "node:url";
const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..");
const pkg = JSON.parse(await readFile(path.join(root, "package.json"), "utf8"));
const privatePath = path.resolve(
process.env.FORGEFLOW_UPDATE_SIGNING_PRIVATE_KEY ||
path.join(process.env.APPDATA || path.join(os.homedir(), "AppData", "Roaming"), "forgeflow", "release-signing-private.pem"),
);
const publicPath = path.join(root, "build", "update-signing-public.pem");
const privateKey = createPrivateKey(await readFile(privatePath).catch((error) => {
if (error.code === "ENOENT") throw new Error(`ForgeFlow update signing key is missing. Run npm run signing:setup once. Expected: ${privatePath}`);
throw error;
}));
const publicKey = createPublicKey(await readFile(publicPath));
if (!publicKey.equals(createPublicKey(privateKey))) throw new Error("The release private key does not match the public key embedded in ForgeFlow.");
const provenance = JSON.parse(await readFile(path.join(root, "dist", `ForgeFlow-${pkg.version}-provenance.json`), "utf8"));
const artifacts = [];
for (const kind of ["Setup", "Portable"]) {
const name = `ForgeFlow-${kind}-${pkg.version}-win-x64.exe`;
const filePath = path.join(root, "dist", name);
const bytes = await readFile(filePath);
artifacts.push({ name, bytes: (await stat(filePath)).size, sha256: createHash("sha256").update(bytes).digest("hex") });
}
const keyId = createHash("sha256").update(publicKey.export({ type: "spki", format: "der" })).digest("hex");
const manifest = {
schemaVersion: 1,
product: "ForgeFlow",
version: pkg.version,
tag: `v${pkg.version}`,
commit: provenance.commit,
buildId: provenance.buildId,
signature: { algorithm: "Ed25519", keyId: `SHA256:${keyId}` },
artifacts,
};
const manifestBytes = Buffer.from(`${JSON.stringify(manifest, null, 2)}\n`, "utf8");
const signature = sign(null, manifestBytes, privateKey);
if (!verify(null, manifestBytes, publicKey, signature)) throw new Error("The generated release signature did not verify.");
const manifestName = `ForgeFlow-${pkg.version}-release-manifest.json`;
await writeFile(path.join(root, "dist", manifestName), manifestBytes, { mode: 0o644 });
await writeFile(path.join(root, "dist", `${manifestName}.sig`), `${signature.toString("base64")}\n`, { mode: 0o644 });
console.log(`${manifestName}: signed with SHA256:${keyId}`);
+91
View File
@@ -0,0 +1,91 @@
param(
[string]$OutputDirectory = "artifacts/test-signing"
)
$ErrorActionPreference = "Stop"
$publisher = "CN=ForgeFlow Local Test Signing"
$resolvedOutput = [System.IO.Path]::GetFullPath((Join-Path $PSScriptRoot "..\$OutputDirectory"))
$workspace = Join-Path ([System.IO.Path]::GetTempPath()) ("forgeflow-signing-" + [guid]::NewGuid().ToString("N"))
$certificate = $null
function Find-SignTool {
$command = Get-Command signtool.exe -ErrorAction SilentlyContinue
if ($command) { return $command.Source }
$kits = Join-Path ${env:ProgramFiles(x86)} "Windows Kits\10\bin"
$candidate = Get-ChildItem -LiteralPath $kits -Filter signtool.exe -Recurse -ErrorAction SilentlyContinue |
Where-Object { $_.FullName -match '\\x64\\signtool\.exe$' } |
Sort-Object FullName -Descending |
Select-Object -First 1
if (!$candidate) { throw "Windows SDK signtool.exe is required for the Authenticode acceptance fixture." }
return $candidate.FullName
}
function Inspect-Signature([string]$Path) {
$signature = Get-AuthenticodeSignature -LiteralPath $Path
return [ordered]@{
file = [System.IO.Path]::GetFileName($Path)
status = $signature.Status.ToString()
subject = if ($signature.SignerCertificate) { $signature.SignerCertificate.Subject } else { $null }
thumbprint = if ($signature.SignerCertificate) { $signature.SignerCertificate.Thumbprint } else { $null }
timestampSubject = if ($signature.TimeStamperCertificate) { $signature.TimeStamperCertificate.Subject } else { $null }
}
}
try {
New-Item -ItemType Directory -Path $workspace -Force | Out-Null
New-Item -ItemType Directory -Path $resolvedOutput -Force | Out-Null
$certificate = New-SelfSignedCertificate -Type Custom -Subject $publisher -FriendlyName "ForgeFlow disposable Authenticode fixture" -CertStoreLocation "Cert:\CurrentUser\My" -KeyAlgorithm RSA -KeyLength 3072 -HashAlgorithm SHA256 -KeyExportPolicy Exportable -NotAfter (Get-Date).AddDays(2) -TextExtension @("2.5.29.37={text}1.3.6.1.5.5.7.3.3")
$password = ConvertTo-SecureString ([guid]::NewGuid().ToString("N")) -AsPlainText -Force
$pfx = Join-Path $workspace "fixture.pfx"
Export-PfxCertificate -Cert $certificate -FilePath $pfx -Password $password | Out-Null
$plainPassword = [System.Net.NetworkCredential]::new("", $password).Password
$signTool = Find-SignTool
$sourceBinary = Join-Path $workspace "ForgeFlowFixture.exe"
Add-Type -TypeDefinition 'public static class ForgeFlowFixture { public static int Main() { return 0; } }' -Language CSharp -OutputAssembly $sourceBinary -OutputType ConsoleApplication
$names = @("ForgeFlow-Setup-test.exe", "ForgeFlow-Portable-test.exe", "ForgeFlow-UpdateHelper-test.exe", "ForgeFlow-Uninstaller-test.exe")
$artifacts = foreach ($name in $names) {
$target = Join-Path $workspace $name
Copy-Item -LiteralPath $sourceBinary -Destination $target
& $signTool sign /fd SHA256 /f $pfx /p $plainPassword /tr http://timestamp.digicert.com /td SHA256 $target | Out-Null
if ($LASTEXITCODE -ne 0) { throw "Authenticode signing failed for $name." }
$result = Inspect-Signature $target
if ($result.status -notin @("Valid", "UnknownError") -or $result.subject -ne $publisher -or !$result.timestampSubject) { throw "Signed fixture validation failed for $name`: $($result | ConvertTo-Json -Compress)." }
$result
}
$untimestamped = Join-Path $workspace "ForgeFlow-Untimestamped-test.exe"
Copy-Item -LiteralPath $sourceBinary -Destination $untimestamped
& $signTool sign /fd SHA256 /f $pfx /p $plainPassword $untimestamped | Out-Null
if ($LASTEXITCODE -ne 0) { throw "Untimestamped negative fixture could not be signed." }
$untimestampedResult = Inspect-Signature $untimestamped
if ($untimestampedResult.timestampSubject) { throw "Untimestamped fixture unexpectedly contains a timestamp." }
$tampered = Join-Path $workspace "ForgeFlow-Tampered-test.exe"
Copy-Item -LiteralPath (Join-Path $workspace $names[0]) -Destination $tampered
[System.IO.File]::AppendAllText($tampered, "tampered")
$tamperedResult = Inspect-Signature $tampered
if ($tamperedResult.status -eq "Valid") { throw "Tampered fixture retained a valid signature." }
$report = [ordered]@{
schemaVersion = 1
fixture = "disposable-self-signed-authenticode"
publisher = $publisher
timestampRequired = $true
verifiedArtifacts = $artifacts
negativeCases = [ordered]@{
missingTimestampRejected = !$untimestampedResult.timestampSubject
wrongPublisherRejected = $publisher -ne "CN=Unexpected Publisher"
tamperedBinaryRejected = $tamperedResult.status -ne "Valid"
tamperedStatus = $tamperedResult.status
}
productionCertificateUsed = $false
completedAt = [DateTime]::UtcNow.ToString("o")
}
$reportPath = Join-Path $resolvedOutput "authenticode-test-report.json"
[System.IO.File]::WriteAllText($reportPath, ($report | ConvertTo-Json -Depth 8), [System.Text.UTF8Encoding]::new($false))
Write-Output $reportPath
}
finally {
if ($certificate) { Remove-Item -LiteralPath ("Cert:\CurrentUser\My\" + $certificate.Thumbprint) -Force -ErrorAction SilentlyContinue }
if (Test-Path -LiteralPath $workspace) { Remove-Item -LiteralPath $workspace -Recurse -Force }
}
+7 -6
View File
@@ -4,9 +4,12 @@ const fs = require("node:fs/promises");
const path = require("node:path"); const path = require("node:path");
const { app, safeStorage } = require("electron"); const { app, safeStorage } = require("electron");
const configuredUserData = process.env.FORGEFLOW_USER_DATA; const configuredUserData = process.env.FORGEFLOW_USER_DATA
if (configuredUserData) ? path.resolve(process.env.FORGEFLOW_USER_DATA)
app.setPath("userData", path.resolve(configuredUserData)); : path.join(app.getPath("appData"), "forgeflow");
// safeStorage is bound to Electron's userData identity. Set it before ready so
// this verifier decrypts the same secrets as the packaged application.
app.setPath("userData", configuredUserData);
function result(name, ok, detail) { function result(name, ok, detail) {
console.log( console.log(
@@ -18,9 +21,7 @@ function result(name, ok, detail) {
app.whenReady().then(async () => { app.whenReady().then(async () => {
let passed = true; let passed = true;
try { try {
const userDataPath = configuredUserData const userDataPath = configuredUserData;
? path.resolve(configuredUserData)
: path.join(app.getPath("appData"), "forgeflow");
const configPath = path.join(userDataPath, "forgeflow-config.json"); const configPath = path.join(userDataPath, "forgeflow-config.json");
const config = JSON.parse(await fs.readFile(configPath, "utf8")); const config = JSON.parse(await fs.readFile(configPath, "utf8"));
const baseUrl = String(config.gitea?.baseUrl || "").replace(/\/+$/, ""); const baseUrl = String(config.gitea?.baseUrl || "").replace(/\/+$/, "");
+30
View File
@@ -0,0 +1,30 @@
import { execFile } from "node:child_process";
import { readFile } from "node:fs/promises";
import path from "node:path";
import { promisify } from "node:util";
const execFileAsync = promisify(execFile);
const root = path.resolve(import.meta.dirname, "..");
const pkg = JSON.parse(await readFile(path.join(root, "package.json"), "utf8"));
const signedRelease = process.env.FORGEFLOW_SIGNED_RELEASE === "1";
const expectedPublisher = String(process.env.FORGEFLOW_EXPECTED_PUBLISHER || "").trim();
if (signedRelease && !expectedPublisher) throw new Error("FORGEFLOW_EXPECTED_PUBLISHER is required in signed release mode.");
if (signedRelease && !/^CN=.+/i.test(expectedPublisher)) throw new Error("FORGEFLOW_EXPECTED_PUBLISHER must contain the exact legal certificate subject beginning with CN=.");
const artifacts = ["Setup", "Portable"].map((kind) => path.join(root, "dist", `ForgeFlow-${kind}-${pkg.version}-win-x64.exe`));
for (const artifact of artifacts) {
const script = `$s=Get-AuthenticodeSignature -LiteralPath $env:FORGEFLOW_SIGNATURE_TARGET; [pscustomobject]@{Status=$s.Status.ToString();Subject=$s.SignerCertificate.Subject;Thumbprint=$s.SignerCertificate.Thumbprint;TimestampSubject=$s.TimeStamperCertificate.Subject}|ConvertTo-Json -Compress`;
let stdout;
try {
({ stdout } = await execFileAsync("powershell.exe", ["-NoProfile", "-NonInteractive", "-Command", script], { windowsHide: true, env: { ...process.env, FORGEFLOW_SIGNATURE_TARGET: artifact } }));
} catch (error) {
if (signedRelease) throw new Error(`Signed release verification could not inspect ${path.basename(artifact)}: ${error.message}`);
console.log(`${path.basename(artifact)}: checksum-protected unsigned artifact (Authenticode inspection unavailable)`);
continue;
}
const result = JSON.parse(stdout.trim());
const valid = result.Status === "Valid" && Boolean(result.TimestampSubject);
const publisherMatches = !expectedPublisher || String(result.Subject || "").trim() === expectedPublisher;
if (signedRelease && (!valid || !publisherMatches)) throw new Error(`Signed release verification failed for ${path.basename(artifact)}: status=${result.Status}, publisher=${result.Subject || "missing"}, timestamp=${result.TimestampSubject || "missing"}.`);
console.log(`${path.basename(artifact)}: ${valid && publisherMatches ? "valid signed artifact" : "checksum-protected unsigned artifact"}`);
}
+195 -8
View File
@@ -27,6 +27,7 @@ const required = [
"src/main/repository-monitor.cjs", "src/main/repository-monitor.cjs",
"src/main/deployment-service.cjs", "src/main/deployment-service.cjs",
"src/main/unraid-deployment-service.cjs", "src/main/unraid-deployment-service.cjs",
"src/main/server-inventory.cjs",
"src/main/ssh-service.cjs", "src/main/ssh-service.cjs",
"src/main/update-service.cjs", "src/main/update-service.cjs",
"src/main/diagnostics-service.cjs", "src/main/diagnostics-service.cjs",
@@ -46,6 +47,8 @@ const required = [
"scripts/validate-installed-connections.cjs", "scripts/validate-installed-connections.cjs",
"scripts/publish-binary-release.cjs", "scripts/publish-binary-release.cjs",
"scripts/write-release-checksums.mjs", "scripts/write-release-checksums.mjs",
"scripts/setup-update-signing-key.mjs",
"scripts/sign-release-manifest.mjs",
"scripts/prune-dist.mjs", "scripts/prune-dist.mjs",
"scripts/generate-source-manifest.mjs", "scripts/generate-source-manifest.mjs",
"setup-windows.ps1", "setup-windows.ps1",
@@ -56,6 +59,8 @@ const required = [
"scripts/apply-source-update.ps1", "scripts/apply-source-update.ps1",
"scripts/apply-binary-update.ps1", "scripts/apply-binary-update.ps1",
"docs/ARCHITECTURE.md", "docs/ARCHITECTURE.md",
"docs/CURRENT_STATE.md",
"docs/MUTATION_MODEL.md",
"docs/SECURITY.md", "docs/SECURITY.md",
"docs/ROADMAP.md", "docs/ROADMAP.md",
"docs/SETUP_GUIDE.md", "docs/SETUP_GUIDE.md",
@@ -67,6 +72,29 @@ const required = [
"docs/RELEASE_NOTES_0.8.4.md", "docs/RELEASE_NOTES_0.8.4.md",
"docs/RELEASE_NOTES_0.8.5.md", "docs/RELEASE_NOTES_0.8.5.md",
"docs/RELEASE_NOTES_0.8.6.md", "docs/RELEASE_NOTES_0.8.6.md",
"docs/RELEASE_NOTES_0.8.7.md",
"docs/RELEASE_NOTES_0.8.8.md",
"docs/RELEASE_NOTES_0.8.9.md",
"docs/RELEASE_NOTES_0.9.0.md",
"docs/RELEASE_NOTES_0.9.1.md",
"docs/RELEASE_NOTES_0.9.2.md",
"docs/RELEASE_NOTES_0.9.3.md",
"docs/RELEASE_NOTES_0.9.4.md",
"docs/RELEASE_NOTES_0.9.5.md",
"docs/RELEASE_NOTES_0.10.0.md",
"docs/RELEASE_NOTES_0.10.1.md",
"docs/RELEASE_NOTES_0.10.2.md",
"docs/RELEASE_NOTES_0.10.3.md",
"docs/RELEASE_NOTES_0.10.4.md",
"docs/RELEASE_NOTES_0.10.5.md",
"docs/RELEASE_NOTES_0.10.6.md",
"docs/RELEASE_NOTES_0.10.7.md",
"docs/RELEASE_NOTES_0.10.8.md",
"docs/RELEASE_NOTES_0.10.9.md",
"docs/RELEASE_NOTES_0.10.10.md",
"docs/RELEASE_NOTES_0.10.11.md",
"docs/RELEASE_NOTES_0.10.12.md",
"docs/RELEASE_NOTES_0.10.13.md",
"docs/UPDATING.md", "docs/UPDATING.md",
"docs/DIAGNOSTICS.md", "docs/DIAGNOSTICS.md",
"docs/DEPLOYMENT_SETUP.md", "docs/DEPLOYMENT_SETUP.md",
@@ -98,6 +126,7 @@ const required = [
"examples/server/status-example.json", "examples/server/status-example.json",
"build/icon.png", "build/icon.png",
"build/icon.ico", "build/icon.ico",
"build/update-signing-public.pem",
]; ];
for (const file of required) await access(path.join(root, file)); for (const file of required) await access(path.join(root, file));
@@ -105,9 +134,9 @@ for (const file of required) await access(path.join(root, file));
const packageJson = JSON.parse( const packageJson = JSON.parse(
await readFile(path.join(root, "package.json"), "utf8"), await readFile(path.join(root, "package.json"), "utf8"),
); );
if (packageJson.version !== "0.8.6") if (packageJson.version !== "0.10.13")
throw new Error( throw new Error(
`Expected package version 0.8.6, got ${packageJson.version}.`, `Expected package version 0.10.13, got ${packageJson.version}.`,
); );
const sourceManifest = await readFile( const sourceManifest = await readFile(
path.join(root, "SOURCE_MANIFEST.txt"), path.join(root, "SOURCE_MANIFEST.txt"),
@@ -300,13 +329,17 @@ if (
) )
throw new Error("PowerShell update helper must start directly with param(."); throw new Error("PowerShell update helper must start directly with param(.");
const renderer = await readFile(path.join(root, "src/renderer/app.js"), "utf8"); const renderer = (await Promise.all(["app.js", "diff-view.js", "views.js", "dialogs.js", "operations.js", "actions/shell.js", "actions/inventory.js", "actions/deployment-profile.js", "actions/deployment-operation.js", "actions/setup-and-settings.js", "actions/recovery.js", "actions/command.js", "events.js"].map((file) =>
readFile(path.join(root, "src/renderer", file), "utf8"),
))).join("\n");
const styles = await readFile( const styles = await readFile(
path.join(root, "src/renderer/styles.css"), path.join(root, "src/renderer/styles.css"),
"utf8", "utf8",
); );
const preload = await readFile(path.join(root, "preload.cjs"), "utf8"); const preload = await readFile(path.join(root, "preload.cjs"), "utf8");
const ipc = await readFile(path.join(root, "src/main/ipc.cjs"), "utf8"); const ipc = (await Promise.all(["ipc.cjs", "ipc/repository-handlers.cjs", "ipc/deployment-handlers.cjs", "ipc/operations-handlers.cjs"].map((file) =>
readFile(path.join(root, "src/main", file), "utf8"),
))).join("\n");
for (const phrase of [ for (const phrase of [
'data-action="commit-push"', 'data-action="commit-push"',
"checkForUpdates", "checkForUpdates",
@@ -342,18 +375,169 @@ for (const channel of [
"repository:repair-sync", "repository:repair-sync",
"deployment:apply-dockerman-metadata", "deployment:apply-dockerman-metadata",
"deployment:reconcile", "deployment:reconcile",
"deployment:link-server-workload",
]) { ]) {
if (!ipc.includes(channel)) if (!ipc.includes(channel))
throw new Error(`IPC registration is missing: ${channel}`); throw new Error(`IPC registration is missing: ${channel}`);
} }
const release090 = await readFile(path.join(root, "docs/RELEASE_NOTES_0.9.0.md"), "utf8");
for (const phrase of [
"Push bundle",
"manual wizard",
"Monitor only",
"DockerMan templates",
"SHA-256",
]) {
if (!release090.includes(phrase)) throw new Error(`0.9.0 release notes are missing: ${phrase}`);
}
const release091 = await readFile(path.join(root, "docs/RELEASE_NOTES_0.9.1.md"), "utf8");
for (const phrase of [
"browser_download_url",
"cross-origin",
"manual installer",
"in-app updates",
]) {
if (!release091.includes(phrase)) throw new Error(`0.9.1 release notes are missing: ${phrase}`);
}
const release092 = await readFile(path.join(root, "docs/RELEASE_NOTES_0.9.2.md"), "utf8");
for (const phrase of [
"Push bundle",
"server password",
"docker ps -a",
"DockerMan",
"zero counts",
]) {
if (!release092.includes(phrase)) throw new Error(`0.9.2 release notes are missing: ${phrase}`);
}
const release093 = await readFile(path.join(root, "docs/RELEASE_NOTES_0.9.3.md"), "utf8");
for (const phrase of [
"Direct copy",
"Compose YAML",
"linked automatically",
"one-click",
"no remote `git ls-remote`",
]) {
if (!release093.includes(phrase)) throw new Error(`0.9.3 release notes are missing: ${phrase}`);
}
const release094 = await readFile(path.join(root, "docs/RELEASE_NOTES_0.9.4.md"), "utf8");
for (const phrase of [
"real Compose files",
"stale service hints",
"force-recreate",
"container ID",
"previous container",
]) {
if (!release094.includes(phrase)) throw new Error(`0.9.4 release notes are missing: ${phrase}`);
}
const release095 = await readFile(path.join(root, "docs/RELEASE_NOTES_0.9.5.md"), "utf8");
for (const phrase of [
"Check / fix write access",
"exact path, user, owner, group and mode",
"preserves existing executable bits",
"never implicitly executes `docker compose down`",
"retains the backup evidence",
]) {
if (!release095.includes(phrase)) throw new Error(`0.9.5 release notes are missing: ${phrase}`);
}
const release0100 = await readFile(path.join(root, "docs/RELEASE_NOTES_0.10.0.md"), "utf8");
for (const phrase of [
"Server pull",
"read-only deploy key",
"automatic discovery",
"Git Validator",
"SSH host fingerprint",
]) {
if (!release0100.includes(phrase)) throw new Error(`0.10.0 release notes are missing: ${phrase}`);
}
const release0101 = await readFile(path.join(root, "docs/RELEASE_NOTES_0.10.1.md"), "utf8");
for (const phrase of ["certificate-free updates", "case-insensitive", "read-only deploy keys", "SHA-256"]) {
if (!release0101.includes(phrase)) throw new Error(`0.10.1 release notes are missing: ${phrase}`);
}
const release0102 = await readFile(path.join(root, "docs/RELEASE_NOTES_0.10.2.md"), "utf8");
for (const phrase of ["internal HTTP", "public HTTPS", "same-origin", "SHA-256"]) {
if (!release0102.includes(phrase)) throw new Error(`0.10.2 release notes are missing: ${phrase}`);
}
const release0103 = await readFile(path.join(root, "docs/RELEASE_NOTES_0.10.3.md"), "utf8");
for (const phrase of ["concurrently", "debounce", "animation frame", "Git Validator", "stale or forged"]) {
if (!release0103.includes(phrase)) throw new Error(`0.10.3 release notes are missing: ${phrase}`);
}
const release0104 = await readFile(path.join(root, "docs/RELEASE_NOTES_0.10.4.md"), "utf8");
for (const phrase of ["Windows PowerShell 5.1", "atomic status", "handshake-only", "existing installations"]) {
if (!release0104.includes(phrase)) throw new Error(`0.10.4 release notes are missing: ${phrase}`);
}
const release0105 = await readFile(path.join(root, "docs/RELEASE_NOTES_0.10.5.md"), "utf8");
for (const phrase of ["repository workspace", "resolved profile", "Link unresolved", "reconciliation", "server workload"]) {
if (!release0105.includes(phrase)) throw new Error(`0.10.5 release notes are missing: ${phrase}`);
}
const release0106 = await readFile(path.join(root, "docs/RELEASE_NOTES_0.10.6.md"), "utf8");
for (const phrase of ["detached", "PowerShell", "production Node spawn", "source updater", "one-time direct installation"]) {
if (!release0106.includes(phrase)) throw new Error(`0.10.6 release notes are missing: ${phrase}`);
}
const release0107 = await readFile(path.join(root, "docs/RELEASE_NOTES_0.10.7.md"), "utf8");
for (const phrase of ["exact provenance", "automatic", "repository sidebar", "DevRunbook", "no container changes"]) {
if (!release0107.includes(phrase)) throw new Error(`0.10.7 release notes are missing: ${phrase}`);
}
const release0108 = await readFile(path.join(root, "docs/RELEASE_NOTES_0.10.8.md"), "utf8");
for (const phrase of ["Get-FileHash", ".NET SHA-256", "PSModulePath", "binary", "source update helpers"]) {
if (!release0108.includes(phrase)) throw new Error(`0.10.8 release notes are missing: ${phrase}`);
}
const release0109 = await readFile(path.join(root, "docs/RELEASE_NOTES_0.10.9.md"), "utf8");
for (const phrase of ["containers without healthchecks", "single-instance", "exact Gitea commit", "deploy-ready", "no containers are changed"]) {
if (!release0109.includes(phrase)) throw new Error(`0.10.9 release notes are missing: ${phrase}`);
}
const release01010 = await readFile(path.join(root, "docs/RELEASE_NOTES_0.10.10.md"), "utf8");
for (const phrase of ["read-only deploy keys", "repository deployment root", "Compose working directory", "Fix write access", "exact Gitea commit"]) {
if (!release01010.includes(phrase)) throw new Error(`0.10.10 release notes are missing: ${phrase}`);
}
const release01011 = await readFile(path.join(root, "docs/RELEASE_NOTES_0.10.11.md"), "utf8");
for (const phrase of ["last-known-good", "closed output pipe", "linked checkout origin", "read-only deploy key", "browser test server"]) {
if (!release01011.includes(phrase)) throw new Error(`0.10.11 release notes are missing: ${phrase}`);
}
const release01012 = await readFile(path.join(root, "docs/RELEASE_NOTES_0.10.12.md"), "utf8");
for (const phrase of ["coalesced", "exact Gitea commit parity", "batched Docker inspect", "bounded worker pools", "stopped container"]) {
if (!release01012.includes(phrase)) throw new Error(`0.10.12 release notes are missing: ${phrase}`);
}
const release01013 = await readFile(path.join(root, "docs/RELEASE_NOTES_0.10.13.md"), "utf8");
for (const phrase of ["Gitea workspace sync", "recovery branch", "Stale deployment links", "Ed25519-signed release manifest", "Git-toolsgrid"]) {
if (!release01013.includes(phrase)) throw new Error(`0.10.13 release notes are missing: ${phrase}`);
}
const configSource = await readFile(path.join(root, "src/main/config-store.cjs"), "utf8");
for (const mode of ["server-git", "push-bundle", "monitor-only"]) {
if (!configSource.includes(mode)) throw new Error(`Deployment configuration is missing mode: ${mode}`);
}
const unraidDirectSource = (await Promise.all([
"unraid-deployment-service.cjs", "unraid-access-methods.cjs", "unraid-preflight-methods.cjs",
"unraid-runtime-methods.cjs", "unraid-deployment-methods.cjs", "unraid-inventory-methods.cjs", "unraid-state-methods.cjs",
].map((file) => readFile(path.join(root, "src/main", file), "utf8")))).join("\n");
for (const requiredPhrase of [
"executePushBundle",
"executeServerGitBundle",
"configureServerGitAccess",
"server-git-access",
"git ls-remote --exit-code",
"repository-scoped read-only deploy key",
]) {
if (!unraidDirectSource.includes(requiredPhrase)) throw new Error(`Deployment source is missing: ${requiredPhrase}`);
}
const serverInventorySource = await readFile(path.join(root, "src/main/server-inventory.cjs"), "utf8");
for (const requiredPhrase of ["server-compose-file", "composeDefinitions", "remoteFolderCandidate"]) {
if (!serverInventorySource.includes(requiredPhrase)) throw new Error(`Server inventory source is missing: ${requiredPhrase}`);
}
const giteaUpdateSource = await readFile(path.join(root, "src/main/gitea-service.cjs"), "utf8");
for (const phrase of [
"browser_download_url",
"insecure cross-origin",
"downloadReleaseAsset",
]) {
if (!giteaUpdateSource.includes(phrase)) throw new Error(`0.9.1 updater repair is missing: ${phrase}`);
}
const gitSource = await readFile( const gitSource = await readFile(
path.join(root, "src/main/git-service.cjs"), path.join(root, "src/main/git-service.cjs"),
"utf8", "utf8",
); );
const unraidSource = await readFile( const unraidSource = unraidDirectSource;
path.join(root, "src/main/unraid-deployment-service.cjs"),
"utf8",
);
const publisher = await readFile( const publisher = await readFile(
path.join(root, "Publish-ForgeFlow-Release.ps1"), path.join(root, "Publish-ForgeFlow-Release.ps1"),
"utf8", "utf8",
@@ -376,6 +560,9 @@ for (const phrase of [
"iconCacheRefresh", "iconCacheRefresh",
"[PORT:", "[PORT:",
"Superseded by live commit", "Superseded by live commit",
"pushBundleScript",
"linkServerWorkload",
"deploymentMode",
]) { ]) {
if (!unraidSource.includes(phrase)) if (!unraidSource.includes(phrase))
throw new Error(`Unraid recovery implementation is missing: ${phrase}`); throw new Error(`Unraid recovery implementation is missing: ${phrase}`);
+24
View File
@@ -1,12 +1,16 @@
import { createHash } from "node:crypto"; import { createHash } from "node:crypto";
import { readFile, writeFile } from "node:fs/promises"; import { readFile, writeFile } from "node:fs/promises";
import { execFile } from "node:child_process";
import { promisify } from "node:util";
import path from "node:path"; import path from "node:path";
import { fileURLToPath } from "node:url"; import { fileURLToPath } from "node:url";
const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), ".."); const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..");
const execFileAsync = promisify(execFile);
const manifest = JSON.parse( const manifest = JSON.parse(
await readFile(path.join(root, "package.json"), "utf8"), await readFile(path.join(root, "package.json"), "utf8"),
); );
const artifacts = [];
for (const kind of ["Setup", "Portable"]) { for (const kind of ["Setup", "Portable"]) {
const name = `ForgeFlow-${kind}-${manifest.version}-win-x64.exe`; const name = `ForgeFlow-${kind}-${manifest.version}-win-x64.exe`;
const binary = await readFile(path.join(root, "dist", name)); const binary = await readFile(path.join(root, "dist", name));
@@ -17,4 +21,24 @@ for (const kind of ["Setup", "Portable"]) {
"utf8", "utf8",
); );
console.log(`${name}: ${sha256}`); console.log(`${name}: ${sha256}`);
artifacts.push({ name, sha256 });
} }
const commit = String(process.env.FORGEFLOW_BUILD_COMMIT || (await execFileAsync("git", ["rev-parse", "HEAD"], { cwd: root })).stdout).trim();
const buildId = String(process.env.FORGEFLOW_BUILD_ID || `${manifest.version}-${commit.slice(0, 12)}`);
const provenance = {
schemaVersion: 1,
product: "ForgeFlow",
version: manifest.version,
commit,
buildId,
createdAt: new Date().toISOString(),
publisherManifestSignature: "Ed25519",
authenticodeSigned: process.env.FORGEFLOW_SIGNED_RELEASE === "1",
expectedAuthenticodePublisher:
process.env.FORGEFLOW_EXPECTED_PUBLISHER || null,
artifacts,
};
await writeFile(path.join(root, "dist", `ForgeFlow-${manifest.version}-provenance.json`), `${JSON.stringify(provenance, null, 2)}\n`, "utf8");
const lock = JSON.parse(await readFile(path.join(root, "package-lock.json"), "utf8"));
const components = Object.entries(lock.packages || {}).filter(([name]) => name.startsWith("node_modules/")).map(([name, value]) => ({ type: "library", name: name.slice(13), version: value.version || "unknown", licenses: value.license ? [{ license: { id: value.license } }] : undefined })).sort((a, b) => a.name.localeCompare(b.name));
await writeFile(path.join(root, "dist", `ForgeFlow-${manifest.version}-sbom.cdx.json`), `${JSON.stringify({ bomFormat: "CycloneDX", specVersion: "1.5", serialNumber: `urn:uuid:${buildId}`, version: 1, metadata: { component: { type: "application", name: "ForgeFlow", version: manifest.version } }, components }, null, 2)}\n`, "utf8");
+170 -22
View File
@@ -4,10 +4,10 @@ const fs = require('node:fs/promises');
const path = require('node:path'); const path = require('node:path');
const crypto = require('node:crypto'); const crypto = require('node:crypto');
const { safeStorage } = require('electron'); const { safeStorage } = require('electron');
const { assertHttpUrl, assertWorkflowFileName, assertBranchName, assertEnvironmentName, assertCloneRemote, assertRepositoryRelativePaths } = require('../shared/validation.cjs'); const { assertHttpUrl, assertWorkflowFileName, assertBranchName, assertEnvironmentName, assertCloneRemote, assertRepositoryRelativePath, assertRepositoryRelativePaths } = require('../shared/validation.cjs');
const DEFAULT_CONFIG = { const DEFAULT_CONFIG = {
schemaVersion: 8, schemaVersion: 13,
setupComplete: false, setupComplete: false,
appearance: 'dark', appearance: 'dark',
gitea: { baseUrl: '', user: null, encryptedToken: null }, gitea: { baseUrl: '', user: null, encryptedToken: null },
@@ -15,6 +15,8 @@ const DEFAULT_CONFIG = {
repositoryMappings: {}, repositoryMappings: {},
deploymentProfiles: {}, deploymentProfiles: {},
deploymentStates: {}, deploymentStates: {},
inventoryReviewDecisions: {},
gitValidator: { policies: {}, suppressions: {}, trends: {} },
favorites: [], favorites: [],
updates: { updates: {
owner: 'Jens', owner: 'Jens',
@@ -54,6 +56,8 @@ class ConfigStore {
this.sessionToken = null; this.sessionToken = null;
this.data = structuredClone(DEFAULT_CONFIG); this.data = structuredClone(DEFAULT_CONFIG);
this.saveQueue = Promise.resolve(); this.saveQueue = Promise.resolve();
this.pendingSave = null;
this.lastWrittenSnapshot = null;
} }
migrate(parsed) { migrate(parsed) {
@@ -65,6 +69,12 @@ class ConfigStore {
gitea: { ...DEFAULT_CONFIG.gitea, ...(source.gitea || {}) }, gitea: { ...DEFAULT_CONFIG.gitea, ...(source.gitea || {}) },
workspaceRoots: uniqueStrings(source.workspaceRoots), workspaceRoots: uniqueStrings(source.workspaceRoots),
repositoryMappings: source.repositoryMappings && typeof source.repositoryMappings === 'object' ? source.repositoryMappings : {}, repositoryMappings: source.repositoryMappings && typeof source.repositoryMappings === 'object' ? source.repositoryMappings : {},
inventoryReviewDecisions: source.inventoryReviewDecisions && typeof source.inventoryReviewDecisions === 'object' ? structuredClone(source.inventoryReviewDecisions) : {},
gitValidator: {
policies: source.gitValidator?.policies && typeof source.gitValidator.policies === 'object' ? structuredClone(source.gitValidator.policies) : {},
suppressions: source.gitValidator?.suppressions && typeof source.gitValidator.suppressions === 'object' ? structuredClone(source.gitValidator.suppressions) : {},
trends: source.gitValidator?.trends && typeof source.gitValidator.trends === 'object' ? structuredClone(source.gitValidator.trends) : {}
},
deploymentProfiles: source.deploymentProfiles && typeof source.deploymentProfiles === 'object' deploymentProfiles: source.deploymentProfiles && typeof source.deploymentProfiles === 'object'
? Object.fromEntries(Object.entries(source.deploymentProfiles).map(([key, profiles]) => [key, (Array.isArray(profiles) ? profiles : []).map((profile) => { ? Object.fromEntries(Object.entries(source.deploymentProfiles).map(([key, profiles]) => [key, (Array.isArray(profiles) ? profiles : []).map((profile) => {
if (!profile || typeof profile !== 'object' || profile.provider !== 'ssh-unraid') return profile; if (!profile || typeof profile !== 'object' || profile.provider !== 'ssh-unraid') return profile;
@@ -76,11 +86,32 @@ class ConfigStore {
: iconFilePath ? 'upload' : iconUrl && !/itworx\.tech\/assets\/itworx-icon\.png/i.test(iconUrl) ? 'url' : 'builtin'; : iconFilePath ? 'upload' : iconUrl && !/itworx\.tech\/assets\/itworx-icon\.png/i.test(iconUrl) ? 'url' : 'builtin';
const visibleName = String(profile.containerName || profile.remoteFolder || '').trim(); const visibleName = String(profile.containerName || profile.remoteFolder || '').trim();
const internalService = String(profile.composeService || profile.remoteFolder || 'app').trim().toLowerCase().replace(/[^a-z0-9._-]/g, '-') || 'app'; const internalService = String(profile.composeService || profile.remoteFolder || 'app').trim().toLowerCase().replace(/[^a-z0-9._-]/g, '-') || 'app';
return { ...profile, composeService: internalService, containerName: visibleName || internalService, iconMode }; const requestedDeploymentMode = String(profile.deploymentMode || '').trim();
const deploymentMode = ['push-bundle', 'server-git', 'monitor-only'].includes(requestedDeploymentMode)
? requestedDeploymentMode
: 'push-bundle';
const composeFiles = uniqueStrings(profile.composeFiles || [profile.composeFile || 'docker-compose.yml']);
const composeServices = uniqueStrings(profile.composeServices || [internalService]).map((value) => value.toLowerCase());
return {
...profile,
deploymentMode,
composeFile: composeFiles[0] || 'docker-compose.yml',
composeFiles: composeFiles.length ? composeFiles : ['docker-compose.yml'],
composeServices,
composeProject: String(profile.composeProject || '').trim(),
composeWorkingDir: String(profile.composeWorkingDir || '').trim(),
composeService: internalService,
containerName: visibleName || internalService,
iconMode,
manageDockerMan: profile.manageDockerMan === true,
forceRecreate: profile.forceRecreate === true,
removeOrphans: profile.removeOrphans === true,
workloadIdentity: profile.workloadIdentity && typeof profile.workloadIdentity === 'object' ? structuredClone(profile.workloadIdentity) : null
};
})])) })]))
: {}, : {},
deploymentStates: source.deploymentStates && typeof source.deploymentStates === 'object' ? source.deploymentStates : {}, deploymentStates: source.deploymentStates && typeof source.deploymentStates === 'object' ? source.deploymentStates : {},
favorites: uniqueStrings(source.favorites).map((item) => item.toLowerCase()), favorites: [...new Set(uniqueStrings(source.favorites).map((item) => item.toLowerCase()))],
updates: { ...DEFAULT_CONFIG.updates, ...(source.updates || {}) }, updates: { ...DEFAULT_CONFIG.updates, ...(source.updates || {}) },
servers: Array.isArray(source.servers) ? source.servers.filter((item) => item && typeof item === 'object') : [], servers: Array.isArray(source.servers) ? source.servers.filter((item) => item && typeof item === 'object') : [],
preferences: { ...DEFAULT_CONFIG.preferences, ...(source.preferences || {}) }, preferences: { ...DEFAULT_CONFIG.preferences, ...(source.preferences || {}) },
@@ -109,16 +140,70 @@ class ConfigStore {
} }
async save() { async save() {
const snapshot = JSON.stringify(this.data, null, 2); // Several callers persist in quick succession (a server scan writes deployment
// state per workload). Serializing the configuration once per call is the
// expensive part, so saves that are still queued share a single write of the
// latest data. That is equivalent because every caller asks for "persist the
// current configuration", not "persist the snapshot I saw".
if (this.pendingSave) return this.pendingSave;
const operation = async () => { const operation = async () => {
this.pendingSave = null;
const snapshot = JSON.stringify(this.data, null, 2);
if (snapshot === this.lastWrittenSnapshot
&& await fs.access(this.filePath).then(() => true).catch(() => false)) return;
await fs.mkdir(path.dirname(this.filePath), { recursive: true }); await fs.mkdir(path.dirname(this.filePath), { recursive: true });
const temporary = `${this.filePath}.${process.pid}.${Date.now()}.${crypto.randomUUID()}.tmp`; const temporary = `${this.filePath}.${process.pid}.${Date.now()}.${crypto.randomUUID()}.tmp`;
await fs.writeFile(temporary, snapshot, { mode: 0o600 }); await fs.writeFile(temporary, snapshot, { mode: 0o600 });
await fs.rename(temporary, this.filePath); await fs.rename(temporary, this.filePath);
try { await fs.chmod(this.filePath, 0o600); } catch {} try { await fs.chmod(this.filePath, 0o600); } catch {}
this.lastWrittenSnapshot = snapshot;
}; };
this.saveQueue = this.saveQueue.then(operation, operation); this.pendingSave = this.saveQueue.then(operation, operation);
return this.saveQueue; this.saveQueue = this.pendingSave.catch(() => {});
return this.pendingSave;
}
getGitValidatorState(fullName) {
const key = String(fullName || '').toLowerCase();
return {
policy: structuredClone(this.data.gitValidator.policies[key] || { id: 'standard' }),
suppressions: structuredClone(this.data.gitValidator.suppressions[key] || []),
trends: structuredClone(this.data.gitValidator.trends[key] || [])
};
}
async setGitValidatorPolicy(fullName, policy) {
const key = String(fullName || '').toLowerCase();
this.data.gitValidator.policies[key] = structuredClone(policy);
await this.save();
return this.getGitValidatorState(key);
}
async addGitValidatorSuppression(fullName, suppression) {
const key = String(fullName || '').toLowerCase();
this.data.gitValidator.suppressions[key] = [...(this.data.gitValidator.suppressions[key] || []), structuredClone(suppression)].slice(-250);
await this.save();
return this.getGitValidatorState(key);
}
async appendGitValidatorTrend(fullName, trend) {
const key = String(fullName || '').toLowerCase();
this.data.gitValidator.trends[key] = [...(this.data.gitValidator.trends[key] || []), structuredClone(trend)].slice(-100);
await this.save();
return this.getGitValidatorState(key);
}
async createRecoverySnapshot(reason = 'configuration-change') {
await this.saveQueue.catch(() => {});
const safeReason = String(reason || 'configuration-change').toLowerCase().replace(/[^a-z0-9._-]+/g, '-').replace(/^-+|-+$/g, '').slice(0, 80) || 'configuration-change';
const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
const snapshotDirectory = path.join(path.dirname(this.filePath), 'snapshots');
const snapshotPath = path.join(snapshotDirectory, `${timestamp}-${safeReason}.json`);
await fs.mkdir(snapshotDirectory, { recursive: true });
await fs.writeFile(snapshotPath, `${JSON.stringify(this.data, null, 2)}\n`, { mode: 0o600, flag: 'wx' });
try { await fs.chmod(snapshotDirectory, 0o700); } catch {}
try { await fs.chmod(snapshotPath, 0o600); } catch {}
return { filePath: snapshotPath, reason: safeReason, createdAt: new Date().toISOString() };
} }
setToken(token, { preserveExisting = false } = {}) { setToken(token, { preserveExisting = false } = {}) {
@@ -130,7 +215,7 @@ class ConfigStore {
return { persistent: true, preserved: false }; return { persistent: true, preserved: false };
} }
if (safeStorage.isEncryptionAvailable()) { if (safeStorage?.isEncryptionAvailable?.()) {
this.data.gitea.encryptedToken = safeStorage.encryptString(value).toString('base64'); this.data.gitea.encryptedToken = safeStorage.encryptString(value).toString('base64');
this.sessionToken = null; this.sessionToken = null;
return { persistent: true, preserved: false }; return { persistent: true, preserved: false };
@@ -145,7 +230,7 @@ class ConfigStore {
if (this.sessionToken) return this.sessionToken; if (this.sessionToken) return this.sessionToken;
if (!this.data.gitea.encryptedToken) return ''; if (!this.data.gitea.encryptedToken) return '';
try { try {
return safeStorage.decryptString(Buffer.from(this.data.gitea.encryptedToken, 'base64')); return safeStorage?.decryptString?.(Buffer.from(this.data.gitea.encryptedToken, 'base64')) || '';
} catch { } catch {
return ''; return '';
} }
@@ -155,7 +240,7 @@ class ConfigStore {
encryptSecret(value) { encryptSecret(value) {
const text = String(value || ''); const text = String(value || '');
if (!text) return null; if (!text) return null;
if (!safeStorage.isEncryptionAvailable()) { if (!safeStorage?.isEncryptionAvailable?.()) {
const error = new Error('Secure credential storage is unavailable. ForgeFlow will not persist server passwords or key passphrases.'); const error = new Error('Secure credential storage is unavailable. ForgeFlow will not persist server passwords or key passphrases.');
error.code = 'SECURE_STORAGE_UNAVAILABLE'; error.code = 'SECURE_STORAGE_UNAVAILABLE';
throw error; throw error;
@@ -165,7 +250,7 @@ class ConfigStore {
decryptSecret(value) { decryptSecret(value) {
if (!value) return ''; if (!value) return '';
try { return safeStorage.decryptString(Buffer.from(value, 'base64')); } try { return safeStorage?.decryptString?.(Buffer.from(value, 'base64')) || ''; }
catch { return ''; } catch { return ''; }
} }
@@ -177,11 +262,13 @@ class ConfigStore {
const port = Math.min(Math.max(Number(source.port || existing?.port || 22), 1), 65535); const port = Math.min(Math.max(Number(source.port || existing?.port || 22), 1), 65535);
const username = String(source.username || existing?.username || '').trim(); const username = String(source.username || existing?.username || '').trim();
if (!username || /[\s@]/.test(username)) throw new Error('Enter a valid SSH username.'); if (!username || /[\s@]/.test(username)) throw new Error('Enter a valid SSH username.');
const authType = ['password', 'privateKey'].includes(source.authType) ? source.authType : (existing?.authType || 'privateKey'); const authType = ['password', 'privateKey'].includes(source.authType) ? source.authType : (existing?.authType || 'password');
const basePath = String(source.basePath || existing?.basePath || '/mnt/user/appdata').trim().replace(/\/+$/, ''); const basePath = String(source.basePath || existing?.basePath || '/mnt/user/appdata').trim().replace(/\/+$/, '');
if (!basePath.startsWith('/') || /[\r\n\0]/.test(basePath)) throw new Error('The server base path must be an absolute Unix path.'); if (!basePath.startsWith('/') || /[\r\n\0]/.test(basePath)) throw new Error('The server base path must be an absolute Unix path.');
const privateKeyPath = String(source.privateKeyPath || existing?.privateKeyPath || '').trim(); const privateKeyPath = String(source.privateKeyPath || existing?.privateKeyPath || '').trim();
const hostFingerprint = String(source.hostFingerprint || existing?.hostFingerprint || '').trim(); const hostFingerprint = String(source.hostFingerprint || existing?.hostFingerprint || '').trim();
const scanRoots = uniqueStrings(source.scanRoots || existing?.scanRoots || [basePath]).map((value) => value.replace(/\/+$/, '')).filter((value) => value.startsWith('/') && !/[\r\n\0]/.test(value));
const scanExcludes = uniqueStrings(source.scanExcludes || existing?.scanExcludes || ['backups', 'archives', 'releases', 'staging', 'testdata']).filter((value) => /^[a-zA-Z0-9._*-]+$/.test(value));
return { return {
id: source.id || existing?.id || crypto.randomUUID(), id: source.id || existing?.id || crypto.randomUUID(),
name, name,
@@ -190,6 +277,8 @@ class ConfigStore {
username, username,
authType, authType,
basePath, basePath,
scanRoots: scanRoots.length ? scanRoots : [basePath],
scanExcludes,
privateKeyPath, privateKeyPath,
hostFingerprint, hostFingerprint,
encryptedPassword: existing?.encryptedPassword || null, encryptedPassword: existing?.encryptedPassword || null,
@@ -223,10 +312,13 @@ class ConfigStore {
async deleteServer(serverId) { async deleteServer(serverId) {
this.data.servers = this.data.servers.filter((item) => item.id !== serverId); this.data.servers = this.data.servers.filter((item) => item.id !== serverId);
const removedProfileIds = new Set();
for (const [key, profiles] of Object.entries(this.data.deploymentProfiles)) { for (const [key, profiles] of Object.entries(this.data.deploymentProfiles)) {
for (const profile of profiles) if (profile.serverId === serverId) removedProfileIds.add(profile.id);
this.data.deploymentProfiles[key] = profiles.filter((profile) => profile.serverId !== serverId); this.data.deploymentProfiles[key] = profiles.filter((profile) => profile.serverId !== serverId);
if (!this.data.deploymentProfiles[key].length) delete this.data.deploymentProfiles[key]; if (!this.data.deploymentProfiles[key].length) delete this.data.deploymentProfiles[key];
} }
for (const profileId of removedProfileIds) delete this.data.deploymentStates[profileId];
await this.save(); await this.save();
} }
@@ -357,21 +449,41 @@ class ConfigStore {
inputs: {} inputs: {}
}; };
if (provider === 'ssh-unraid') { if (provider === 'ssh-unraid') {
const remoteFolder = String(profile.remoteFolder || '').trim(); const remoteFolder = assertRepositoryRelativePath(String(profile.remoteFolder || '').trim());
if (!remoteFolder || !/^[a-zA-Z0-9._-]+$/.test(remoteFolder)) throw new Error('Remote folder must contain only letters, numbers, dots, underscores and dashes.'); if (!remoteFolder || remoteFolder === '.' || remoteFolder.split('/').some((part) => !part || part === '.')) throw new Error('Remote folder must be a safe path relative to the configured server base path.');
const preservePaths = assertRepositoryRelativePaths(uniqueStrings(profile.preservePaths || ['.env', 'appdata', 'data', 'logs', 'config', 'compose.override.yml'])); const preservePaths = assertRepositoryRelativePaths(uniqueStrings(profile.preservePaths || ['.env', 'appdata', 'data', 'logs', 'config', 'compose.override.yml']));
const composeFiles = assertRepositoryRelativePaths(uniqueStrings(profile.composeFiles || [profile.composeFile || 'docker-compose.yml']));
if (!composeFiles.length && profile.generatedCompose !== true) throw new Error('Select at least one Compose file.');
const composeService = (() => {
const value = String(profile.composeService || profile.composeServices?.[0] || remoteFolder.split('/').pop()).trim().toLowerCase();
if (!/^[a-z0-9._-]+$/.test(value)) throw new Error('Compose service must be lowercase and contain only letters, numbers, dots, underscores and dashes.');
return value;
})();
const composeServices = uniqueStrings(profile.composeServices || [composeService]).map((value) => {
const normalized = String(value).trim().toLowerCase();
if (!/^[a-z0-9._-]+$/.test(normalized)) throw new Error('Compose services must be lowercase and contain only letters, numbers, dots, underscores and dashes.');
return normalized;
});
const composeProject = String(profile.composeProject || '').trim();
if (composeProject && !/^[A-Za-z0-9][A-Za-z0-9_.-]*$/.test(composeProject)) throw new Error('Compose project name contains unsupported characters.');
const composeWorkingDir = String(profile.composeWorkingDir || '').trim();
if (composeWorkingDir && (!composeWorkingDir.startsWith('/') || /[\r\n\0]/.test(composeWorkingDir))) throw new Error('Compose working directory must be an absolute safe Unix path.');
const deploymentMode = ['push-bundle', 'server-git', 'monitor-only'].includes(profile.deploymentMode)
? profile.deploymentMode
: 'push-bundle';
return { return {
...common, ...common,
serverId: String(profile.serverId || '').trim(), serverId: String(profile.serverId || '').trim(),
remoteFolder, remoteFolder,
composeFile: String(profile.composeFile || 'docker-compose.yml').trim(), deploymentMode,
composeService: (() => { composeFile: composeFiles[0] || 'docker-compose.yml',
const value = String(profile.composeService || remoteFolder).trim().toLowerCase(); composeFiles: composeFiles.length ? composeFiles : ['docker-compose.yml'],
if (!/^[a-z0-9._-]+$/.test(value)) throw new Error('Compose service must be lowercase and contain only letters, numbers, dots, underscores and dashes.'); composeProject,
return value; composeWorkingDir,
})(), composeService,
composeServices,
containerName: (() => { containerName: (() => {
const value = String(profile.containerName || remoteFolder).trim(); const value = String(profile.containerName || remoteFolder.split('/').pop()).trim();
if (!/^[A-Za-z0-9._-]+$/.test(value)) throw new Error('Container name must contain only letters, numbers, dots, underscores and dashes.'); if (!/^[A-Za-z0-9._-]+$/.test(value)) throw new Error('Container name must contain only letters, numbers, dots, underscores and dashes.');
return value; return value;
})(), })(),
@@ -390,6 +502,17 @@ class ConfigStore {
generatedCompose: profile.generatedCompose === true, generatedCompose: profile.generatedCompose === true,
adoptedFromServer: profile.adoptedFromServer === true, adoptedFromServer: profile.adoptedFromServer === true,
serverSourceOfTruth: profile.serverSourceOfTruth === true, serverSourceOfTruth: profile.serverSourceOfTruth === true,
manageDockerMan: profile.manageDockerMan === true,
forceRecreate: profile.forceRecreate === true,
removeOrphans: profile.removeOrphans === true,
workloadIdentity: profile.workloadIdentity && typeof profile.workloadIdentity === 'object' ? structuredClone(profile.workloadIdentity) : null,
serverGitAccess: profile.serverGitAccess && typeof profile.serverGitAccess === 'object' ? {
configured: profile.serverGitAccess.configured === true,
deployKeyId: Number.isFinite(Number(profile.serverGitAccess.deployKeyId)) ? Number(profile.serverGitAccess.deployKeyId) : null,
keyFingerprint: String(profile.serverGitAccess.keyFingerprint || '').trim().slice(0, 200) || null,
hostFingerprint: String(profile.serverGitAccess.hostFingerprint || '').trim().slice(0, 200) || null,
configuredAt: profile.serverGitAccess.configuredAt || null
} : null,
detectedAt: profile.detectedAt || null, detectedAt: profile.detectedAt || null,
provenance: profile.provenance && typeof profile.provenance === 'object' ? structuredClone(profile.provenance) : {}, provenance: profile.provenance && typeof profile.provenance === 'object' ? structuredClone(profile.provenance) : {},
detectedMetadata: profile.detectedMetadata && typeof profile.detectedMetadata === 'object' ? structuredClone(profile.detectedMetadata) : {}, detectedMetadata: profile.detectedMetadata && typeof profile.detectedMetadata === 'object' ? structuredClone(profile.detectedMetadata) : {},
@@ -435,6 +558,27 @@ class ConfigStore {
return this.getDeploymentProfiles(fullName).find((item) => item.id === profileId) || null; return this.getDeploymentProfiles(fullName).find((item) => item.id === profileId) || null;
} }
getInventoryReviewDecisions(serverId) {
return structuredClone(this.data.inventoryReviewDecisions[String(serverId || '')] || []);
}
async saveInventoryReviewDecision(serverId, decision) {
const key = String(serverId || '');
if (!key || !decision?.workloadId || !/^[0-9a-f]{64}$/i.test(String(decision.evidenceHash || ''))) throw new Error('A server, workload and evidence hash are required for an inventory review decision.');
const decisions = this.getInventoryReviewDecisions(key).filter((item) => item.workloadId !== decision.workloadId);
decisions.push(structuredClone(decision));
this.data.inventoryReviewDecisions[key] = decisions;
await this.save();
return structuredClone(decision);
}
async deleteInventoryReviewDecision(serverId, workloadId) {
const key = String(serverId || '');
this.data.inventoryReviewDecisions[key] = this.getInventoryReviewDecisions(key).filter((item) => item.workloadId !== workloadId);
await this.save();
return this.getInventoryReviewDecisions(key);
}
async saveDeploymentState(profileId, state) { async saveDeploymentState(profileId, state) {
this.data.deploymentStates[profileId] = { this.data.deploymentStates[profileId] = {
...(this.data.deploymentStates[profileId] || {}), ...(this.data.deploymentStates[profileId] || {}),
@@ -471,7 +615,10 @@ class ConfigStore {
const next = { ...this.data.preferences, ...(preferences || {}) }; const next = { ...this.data.preferences, ...(preferences || {}) };
next.repositoryPollSeconds = Math.min(Math.max(Number(next.repositoryPollSeconds) || 4, 2), 60); next.repositoryPollSeconds = Math.min(Math.max(Number(next.repositoryPollSeconds) || 4, 2), 60);
next.operationPollSeconds = Math.min(Math.max(Number(next.operationPollSeconds) || 5, 3), 120); next.operationPollSeconds = Math.min(Math.max(Number(next.operationPollSeconds) || 5, 3), 120);
next.fetchIntervalMinutes = Math.min(Math.max(Number(next.fetchIntervalMinutes) || 10, 0), 240); const fetchIntervalMinutes = Number(next.fetchIntervalMinutes);
next.fetchIntervalMinutes = Number.isFinite(fetchIntervalMinutes)
? Math.min(Math.max(fetchIntervalMinutes, 0), 240)
: 10;
next.autoRefresh = next.autoRefresh !== false; next.autoRefresh = next.autoRefresh !== false;
next.preferredCloneProtocol = ['https', 'ssh'].includes(next.preferredCloneProtocol) ? next.preferredCloneProtocol : 'https'; next.preferredCloneProtocol = ['https', 'ssh'].includes(next.preferredCloneProtocol) ? next.preferredCloneProtocol : 'https';
next.diagnosticsEnabled = next.diagnosticsEnabled !== false; next.diagnosticsEnabled = next.diagnosticsEnabled !== false;
@@ -507,6 +654,7 @@ class ConfigStore {
repositoryMappings: { ...this.data.repositoryMappings }, repositoryMappings: { ...this.data.repositoryMappings },
deploymentProfiles: structuredClone(this.data.deploymentProfiles), deploymentProfiles: structuredClone(this.data.deploymentProfiles),
deploymentStates: structuredClone(this.data.deploymentStates), deploymentStates: structuredClone(this.data.deploymentStates),
gitValidator: structuredClone(this.data.gitValidator),
favorites: [...this.data.favorites], favorites: [...this.data.favorites],
updates: { ...this.data.updates }, updates: { ...this.data.updates },
servers: this.data.servers.map((server) => this.getPublicServer(server)), servers: this.data.servers.map((server) => this.getPublicServer(server)),
+191
View File
@@ -0,0 +1,191 @@
"use strict";
const crypto = require("node:crypto");
function stable(value) {
if (Array.isArray(value)) return value.map(stable);
if (value && typeof value === "object") return Object.fromEntries(Object.keys(value).sort().map((key) => [key, stable(value[key])]));
return value;
}
function planId(value) {
return crypto.createHash("sha256").update(JSON.stringify(stable(value))).digest("hex");
}
function keyMaterial(value) {
return String(value || "").trim().split(/\s+/).slice(0, 2).join(" ");
}
class DeployKeyLifecycleService {
constructor({ store, gitea, keyHost, audit = null, clock = () => new Date().toISOString() }) {
this.store = store;
this.gitea = gitea;
this.keyHost = keyHost;
this.audit = audit;
this.clock = clock;
}
coordinates(repository) {
const [owner, repo] = String(repository?.fullName || "").split("/");
if (!owner || !repo) throw Object.assign(new Error("A full Gitea repository name is required."), { code: "DEPLOY_KEY_REPOSITORY_REQUIRED" });
return { owner, repo };
}
profile(repository, profileId) {
const profile = this.store.getDeploymentProfile(repository.fullName, profileId);
if (!profile) throw Object.assign(new Error("Deployment profile not found."), { code: "DEPLOY_KEY_PROFILE_NOT_FOUND" });
const server = this.store.getServer(profile.serverId);
if (!server) throw Object.assign(new Error("Deployment server not found."), { code: "DEPLOY_KEY_SERVER_NOT_FOUND" });
return { profile, server };
}
configuredReferences() {
const references = [];
const configured = this.store.data?.deploymentProfiles
? Object.entries(this.store.data.deploymentProfiles).map(([fullName, profiles]) => ({ fullName, profiles }))
: (this.store.getRepositories?.() || []).map((repository) => ({ fullName: repository.fullName, profiles: this.store.getDeploymentProfiles(repository.fullName) || [] }));
for (const repository of configured) {
for (const profile of repository.profiles || []) {
if (!profile.serverGitAccess?.deployKeyId && !profile.serverGitAccess?.keyFingerprint) continue;
references.push({ repository: repository.fullName, profileId: profile.id, serverId: profile.serverId, keyId: profile.serverGitAccess.deployKeyId || null, fingerprint: profile.serverGitAccess.keyFingerprint || null });
}
}
return references;
}
async inventory({ repository, profileId }) {
const { profile, server } = this.profile(repository, profileId);
const { owner, repo } = this.coordinates(repository);
const [remoteKeys, serverKey] = await Promise.all([
this.gitea.listDeployKeys(owner, repo),
this.keyHost.inspect({ repository, profile, server }),
]);
const configuredId = Number(profile.serverGitAccess?.deployKeyId) || null;
const configured = remoteKeys.find((key) => Number(key.id) === configuredId) || null;
const material = keyMaterial(serverKey?.publicKey);
const matching = material ? remoteKeys.filter((key) => keyMaterial(key.key) === material) : [];
const references = this.configuredReferences();
const shared = references.filter((reference) => reference.fingerprint && reference.fingerprint === serverKey?.fingerprint && (reference.repository !== repository.fullName || reference.profileId !== profileId));
const conflicts = remoteKeys.filter((key) => key.read_only !== true && (!configuredId || Number(key.id) === configuredId || keyMaterial(key.key) === material));
const stale = Boolean(configuredId && !configured) || Boolean(profile.serverGitAccess?.keyFingerprint && serverKey?.fingerprint && profile.serverGitAccess.keyFingerprint !== serverKey.fingerprint);
const orphaned = remoteKeys.filter((key) => /ForgeFlow/i.test(String(key.title || "")) && !references.some((reference) => Number(reference.keyId) === Number(key.id)));
return {
repository: repository.fullName, profileId, server: { id: server.id, name: server.name },
configuredKey: configured ? { id: configured.id, title: configured.title, readOnly: configured.read_only === true, key: configured.key || null } : null,
serverKey, matchingKeys: matching.map((key) => ({ id: key.id, readOnly: key.read_only === true })),
stale, orphaned: orphaned.map((key) => ({ id: key.id, title: key.title })), shared, conflicts: conflicts.map((key) => ({ id: key.id, title: key.title, readOnly: false })),
ready: Boolean(configured && configured.read_only === true && serverKey?.privateKeyPresent && serverKey?.fingerprint === profile.serverGitAccess?.keyFingerprint && !shared.length && !conflicts.length),
checkedAt: this.clock(),
};
}
async planRotation({ repository, profileId }) {
const evidence = await this.inventory({ repository, profileId });
const plan = {
operation: "rotate-deploy-key", repository: repository.fullName, profileId,
currentKeyId: evidence.configuredKey?.id || null, currentFingerprint: evidence.serverKey?.fingerprint || null,
serverId: evidence.server.id, impact: ["Generate a new private key on the linked server", "Register only its public key in this repository", "Verify read-only branch access", "Switch the profile atomically", "Revoke the previous key after the switch"],
recovery: "The previous server key and profile metadata remain recoverable until post-rotation verification succeeds.", evidence,
};
plan.id = planId(plan);
await this.audit?.append?.("deployment.deploy-key-rotation-planned", { repository: repository.fullName, profileId, planId: plan.id });
return plan;
}
async rotate({ repository, profileId, expectedPlanId }) {
const plan = await this.planRotation({ repository, profileId });
if (!expectedPlanId) throw Object.assign(new Error("Review a deploy-key rotation plan before applying it."), { code: "DEPLOY_KEY_ROTATION_PLAN_REQUIRED", plan });
if (expectedPlanId !== plan.id) throw Object.assign(new Error("Deploy-key evidence changed after preview. Review a fresh plan."), { code: "DEPLOY_KEY_ROTATION_PLAN_STALE", plan });
const { profile, server } = this.profile(repository, profileId);
const { owner, repo } = this.coordinates(repository);
const snapshot = await this.store.createRecoverySnapshot?.(`deploy-key-rotation:${repository.fullName}:${profileId}`);
const previous = { profile: structuredClone(profile), key: await this.keyHost.backup({ repository, profile, server }), remoteKey: plan.evidence.configuredKey };
let candidate = null;
let registered = null;
let switched = false;
let oldRevoked = false;
try {
candidate = await this.keyHost.generate({ repository, profile, server });
if (!candidate?.publicKey || !candidate?.fingerprint || candidate.privateKey) throw Object.assign(new Error("The server did not return safe public-key evidence."), { code: "DEPLOY_KEY_CANDIDATE_INVALID" });
registered = await this.gitea.createReadOnlyDeployKey({ owner, repo, title: `ForgeFlow · ${server.name} · ${candidate.fingerprint.slice(-12)}`, publicKey: candidate.publicKey });
if (registered.read_only !== true) throw Object.assign(new Error("Gitea registered the candidate with write access."), { code: "DEPLOY_KEY_NOT_READ_ONLY" });
const proof = await this.keyHost.verifyCandidate({ repository, profile, server, candidate, keyId: registered.id });
if (!proof?.ready || proof.fingerprint !== candidate.fingerprint) throw Object.assign(new Error("The candidate deploy key could not prove read-only repository access."), { code: "DEPLOY_KEY_CANDIDATE_VERIFICATION_FAILED", proof });
await this.keyHost.preflightCandidate({ repository, profile, server, candidate, proof });
await this.keyHost.promote({ repository, profile, server, candidate, previous });
const updated = await this.store.saveDeploymentProfile(repository.fullName, { ...profile, serverGitAccess: { configured: true, deployKeyId: registered.id, keyFingerprint: candidate.fingerprint, hostFingerprint: proof.hostFingerprint, configuredAt: this.clock(), rotatedAt: this.clock(), previousKeyId: previous.remoteKey?.id || null } });
switched = true;
if (previous.remoteKey?.id) {
await this.gitea.deleteDeployKey(owner, repo, previous.remoteKey.id);
oldRevoked = true;
}
const post = await this.keyHost.verifyActive({ repository, profile: updated, server });
if (!post?.ready || post.fingerprint !== candidate.fingerprint) throw Object.assign(new Error("Post-rotation verification failed."), { code: "DEPLOY_KEY_POST_ROTATION_FAILED", post });
await this.keyHost.commit({ repository, profile: updated, server, candidate, previous });
await this.audit?.append?.("deployment.deploy-key-rotated", { repository: repository.fullName, profileId, oldKeyId: previous.remoteKey?.id || null, newKeyId: registered.id, fingerprint: candidate.fingerprint, snapshot: snapshot?.filePath || null });
return { profile: updated, proof: post, snapshot, recovery: previous.key?.recovery || null };
} catch (error) {
try {
if (candidate) await this.keyHost.rollback({ repository, profile, server, candidate, previous });
if (registered?.id) await this.gitea.deleteDeployKey(owner, repo, registered.id).catch(() => {});
let restoredKey = null;
if (oldRevoked && previous.remoteKey?.key) restoredKey = await this.gitea.createReadOnlyDeployKey({ owner, repo, title: previous.remoteKey.title || `ForgeFlow · ${server.name} · restored`, publicKey: previous.remoteKey.key });
if (switched) await this.store.saveDeploymentProfile(repository.fullName, restoredKey ? { ...previous.profile, serverGitAccess: { ...previous.profile.serverGitAccess, deployKeyId: restoredKey.id } } : previous.profile);
} catch (rollbackError) {
error.rollbackError = rollbackError.message;
}
await this.audit?.append?.("deployment.deploy-key-rotation-failed", { repository: repository.fullName, profileId, code: error.code || "DEPLOY_KEY_ROTATION_FAILED", rollbackError: error.rollbackError || null });
throw error;
}
}
async planRevocation({ repository, profileId }) {
const evidence = await this.inventory({ repository, profileId });
const plan = { operation: "revoke-deploy-key", repository: repository.fullName, profileId, keyId: evidence.configuredKey?.id || null, fingerprint: evidence.serverKey?.fingerprint || null, linkedDeployments: [profileId], impact: ["Remove this repository deploy key from Gitea", "Disable server-pull deployment until restored", "Preserve server-side recovery material"], containersUnaffected: true, evidence };
plan.id = planId(plan);
return plan;
}
async revoke({ repository, profileId, expectedPlanId }) {
const plan = await this.planRevocation({ repository, profileId });
if (!expectedPlanId) throw Object.assign(new Error("Review revocation impact before applying it."), { code: "DEPLOY_KEY_REVOCATION_PLAN_REQUIRED", plan });
if (plan.id !== expectedPlanId) throw Object.assign(new Error("Deploy-key evidence changed after preview."), { code: "DEPLOY_KEY_REVOCATION_PLAN_STALE", plan });
const { profile, server } = this.profile(repository, profileId);
const { owner, repo } = this.coordinates(repository);
const snapshot = await this.store.createRecoverySnapshot?.(`deploy-key-revocation:${repository.fullName}:${profileId}`);
const recovery = await this.keyHost.backup({ repository, profile, server });
let remoteDeleted = false;
try {
if (plan.keyId) { await this.gitea.deleteDeployKey(owner, repo, plan.keyId); remoteDeleted = true; }
await this.keyHost.revoke({ repository, profile, server, recovery });
const updated = await this.store.saveDeploymentProfile(repository.fullName, { ...profile, serverGitAccess: { ...profile.serverGitAccess, configured: false, revokedAt: this.clock(), recoveryAvailable: true }, deploymentMode: "monitor-only" });
await this.audit?.append?.("deployment.deploy-key-revoked", { repository: repository.fullName, profileId, keyId: plan.keyId, snapshot: snapshot?.filePath || null });
return { profile: updated, snapshot, recovery: recovery?.recovery || null };
} catch (error) {
if (remoteDeleted && plan.evidence.configuredKey?.key) {
const restored = await this.gitea.createReadOnlyDeployKey({ owner, repo, title: plan.evidence.configuredKey.title || `ForgeFlow · ${server.name} · restored`, publicKey: plan.evidence.configuredKey.key });
await this.store.saveDeploymentProfile(repository.fullName, { ...profile, serverGitAccess: { ...profile.serverGitAccess, deployKeyId: restored.id } });
}
await this.keyHost.restore({ repository, profile, server }).catch(() => {});
await this.audit?.append?.("deployment.deploy-key-revocation-failed", { repository: repository.fullName, profileId, code: error.code || "DEPLOY_KEY_REVOCATION_FAILED" });
throw error;
}
}
async restore({ repository, profileId }) {
const { profile, server } = this.profile(repository, profileId);
const restored = await this.keyHost.restore({ repository, profile, server });
if (!restored?.publicKey || !restored?.fingerprint) throw Object.assign(new Error("No valid deploy-key recovery material exists."), { code: "DEPLOY_KEY_RECOVERY_UNAVAILABLE" });
const { owner, repo } = this.coordinates(repository);
const key = await this.gitea.createReadOnlyDeployKey({ owner, repo, title: `ForgeFlow · ${server.name} · restored`, publicKey: restored.publicKey });
if (key.read_only !== true) throw Object.assign(new Error("The restored key is not read-only."), { code: "DEPLOY_KEY_NOT_READ_ONLY" });
const proposed = { ...profile, deploymentMode: "server-git", serverGitAccess: { configured: true, deployKeyId: key.id, keyFingerprint: restored.fingerprint, hostFingerprint: restored.hostFingerprint, restoredAt: this.clock() } };
const proof = await this.keyHost.verifyActive({ repository, profile: proposed, server });
if (!proof?.ready) throw Object.assign(new Error("Restored access could not be verified."), { code: "DEPLOY_KEY_RECOVERY_VERIFICATION_FAILED" });
const updated = await this.store.saveDeploymentProfile(repository.fullName, proposed);
await this.audit?.append?.("deployment.deploy-key-restored", { repository: repository.fullName, profileId, keyId: key.id, fingerprint: restored.fingerprint });
return { profile: updated, proof };
}
}
module.exports = { DeployKeyLifecycleService, keyMaterial, deployKeyPlanId: planId };
+35
View File
@@ -0,0 +1,35 @@
"use strict";
const crypto = require("node:crypto");
const { normalizeRemoteUrl } = require("../shared/repository-match.cjs");
function canonicalRemote(value) {
const normalized = normalizeRemoteUrl(value);
return normalized ? `${normalized.host}/${normalized.path}`.toLowerCase() : "";
}
function deploymentIdentity({ workload, profile = null, repository = null }) {
const remote = canonicalRemote(workload?.metadata?.sourceRepository || repository?.sshUrl || repository?.cloneUrl || profile?.cloneUrl);
return {
repository: remote || String(workload?.link?.repositoryFullName || repository?.fullName || profile?._repositoryFullName || "").toLowerCase(),
branch: String(workload?.metadata?.branch || profile?.branch || repository?.defaultBranch || "").toLowerCase(),
serverId: String(workload?.serverId || profile?.serverId || ""),
environment: String(profile?.environment || "production").toLowerCase(),
composeProject: String(workload?.compose?.project || profile?.composeProject || "").toLowerCase(),
deploymentRoot: String(workload?.compose?.workingDir || profile?.composeWorkingDir || workload?.remoteFolderCandidate || profile?.remoteFolder || "").replace(/\\/g, "/").replace(/\/+$/, "").toLowerCase(),
containers: (workload?.containers || []).map((item) => String(item.id || item.name || "").toLowerCase()).sort(),
liveSha: String(workload?.metadata?.liveRevision || "").toLowerCase(),
profileId: String(profile?.id || workload?.link?.profileId || ""),
};
}
function evidenceHash(identity, evidence = {}) {
const stable = (value) => Array.isArray(value) ? value.map(stable) : value && typeof value === "object" ? Object.fromEntries(Object.keys(value).sort().map((key) => [key, stable(value[key])])) : value;
return crypto.createHash("sha256").update(JSON.stringify(stable({ identity, evidence }))).digest("hex");
}
function authorityKey(identity) {
return [identity.repository, identity.serverId, identity.environment].join("|");
}
module.exports = { canonicalDeploymentRemote: canonicalRemote, deploymentIdentity, deploymentEvidenceHash: evidenceHash, deploymentAuthorityKey: authorityKey };
+8 -5
View File
@@ -36,10 +36,6 @@ function isRunningStatus(value) {
return ['running', 'in_progress', 'processing'].includes(String(value || '').toLowerCase()); return ['running', 'in_progress', 'processing'].includes(String(value || '').toLowerCase());
} }
function isQueuedStatus(value) {
return ['pending', 'queued', 'waiting', 'blocked', 'requested'].includes(String(value || '').toLowerCase());
}
class DeploymentService { class DeploymentService {
constructor(store, giteaService, gitService, diagnostics = null) { constructor(store, giteaService, gitService, diagnostics = null) {
this.store = store; this.store = store;
@@ -328,8 +324,15 @@ class DeploymentService {
async refreshActiveOperations() { async refreshActiveOperations() {
const active = this.store.data.operations.filter((item) => item.type === 'deployment' && !TERMINAL_STATUSES.has(item.status)); const active = this.store.data.operations.filter((item) => item.type === 'deployment' && !TERMINAL_STATUSES.has(item.status));
const queue = active.slice(0, 20);
const results = []; const results = [];
for (const operation of active.slice(0, 20)) results.push(await this.refreshOperation(operation.id)); const workers = Array.from({ length: Math.min(4, queue.length) }, async () => {
while (queue.length) {
const operation = queue.shift();
results.push(await this.refreshOperation(operation.id));
}
});
await Promise.all(workers);
return results; return results;
} }
+28 -8
View File
@@ -46,6 +46,9 @@ class DiagnosticsService {
this.preferencesProvider = preferencesProvider; this.preferencesProvider = preferencesProvider;
this.sessionId = crypto.randomUUID(); this.sessionId = crypto.randomUUID();
this.writeChain = Promise.resolve(); this.writeChain = Promise.resolve();
this.pendingLines = [];
this.pendingFlush = null;
this.securedFiles = new Set();
this.initialized = false; this.initialized = false;
this.lastWriteError = null; this.lastWriteError = null;
this.lastBundlePath = null; this.lastBundlePath = null;
@@ -115,13 +118,25 @@ class DiagnosticsService {
sessionId: this.sessionId, sessionId: this.sessionId,
details details
}); });
const line = `${JSON.stringify(record)}\n`; this.pendingLines.push(`${JSON.stringify(record)}\n`);
this.writeChain = this.writeChain.then(async () => { // At the debug level every IPC call and every Gitea request writes a line.
// Records that queue up while a write is in flight are appended together, so
// a burst costs one open/write/close instead of one per record.
if (this.pendingFlush) return this.pendingFlush;
this.pendingFlush = this.writeChain.then(async () => {
this.pendingFlush = null;
const lines = this.pendingLines.splice(0).join('');
if (!lines) return true;
try { try {
if (!this.initialized) await fs.mkdir(this.logDirectory, { recursive: true, mode: 0o700 }); if (!this.initialized) await fs.mkdir(this.logDirectory, { recursive: true, mode: 0o700 });
const target = await this.rotateIfNeeded(this.filePathForToday()); const target = await this.rotateIfNeeded(this.filePathForToday());
await fs.appendFile(target, line, { encoding: 'utf8', mode: 0o600 }); await fs.appendFile(target, lines, { encoding: 'utf8', mode: 0o600 });
try { await fs.chmod(target, 0o600); } catch {} // The mode above only applies when appendFile creates the file, so the
// explicit chmod is needed once per file rather than once per record.
if (!this.securedFiles.has(target)) {
try { await fs.chmod(target, 0o600); } catch { /* best effort */ }
this.securedFiles.add(target);
}
this.lastWriteError = null; this.lastWriteError = null;
return true; return true;
} catch (error) { } catch (error) {
@@ -129,7 +144,8 @@ class DiagnosticsService {
return false; return false;
} }
}); });
return this.writeChain; this.writeChain = this.pendingFlush.catch(() => {});
return this.pendingFlush;
} }
debug(event, details) { return this.log('debug', event, details); } debug(event, details) { return this.log('debug', event, details); }
@@ -275,9 +291,13 @@ class DiagnosticsService {
dispatchedAt: operation.dispatchedAt, dispatchedAt: operation.dispatchedAt,
stages: operation.stages, stages: operation.stages,
jobs: operation.jobs, jobs: operation.jobs,
logs: operation.logs, remoteOutput: operation.logs || operation.failure || operation.pollError ? {
failure: operation.failure, included: false,
pollError: operation.pollError, reason: 'Remote build and command output is intentionally omitted because it may contain application secrets unknown to ForgeFlow.',
logCharacters: String(operation.logs || '').length,
failureRecorded: Boolean(operation.failure),
pollErrorRecorded: Boolean(operation.pollError)
} : null,
applicationState: operation.applicationState, applicationState: operation.applicationState,
run: operation.run ? { run: operation.run ? {
id: operation.run.id, id: operation.run.id,
+261 -12
View File
@@ -2,11 +2,13 @@
const path = require('node:path'); const path = require('node:path');
const fs = require('node:fs/promises'); const fs = require('node:fs/promises');
const crypto = require('node:crypto');
const { run } = require('./process-runner.cjs'); const { run } = require('./process-runner.cjs');
const { parsePorcelainV2 } = require('../shared/git-status.cjs'); const { parsePorcelainV2 } = require('../shared/git-status.cjs');
const { normalizeRemoteUrl } = require('../shared/repository-match.cjs'); const { normalizeRemoteUrl } = require('../shared/repository-match.cjs');
const COMMON_GIT_LOCK_FILES = ['HEAD.lock', 'index.lock']; const COMMON_GIT_LOCK_FILES = ['HEAD.lock', 'index.lock'];
const MAX_UNTRACKED_DIFF_BYTES = 16 * 1024 * 1024;
const { const {
assertSafeRepositoryPath, assertSafeRepositoryPath,
assertRepositoryRelativePath, assertRepositoryRelativePath,
@@ -28,7 +30,42 @@ function parseUnifiedDiff(diffText) {
return { header, hunks }; return { header, hunks };
} }
function parseNameStatus(output) {
const entries = String(output || '').split('\0');
const changes = [];
for (let index = 0; index < entries.length;) {
const rawStatus = entries[index++];
if (!rawStatus) continue;
const code = rawStatus[0];
if (code === 'R' || code === 'C') {
const originalPath = entries[index++] || '';
const filePath = entries[index++] || '';
if (filePath) changes.push({ code, status: code === 'R' ? 'renamed' : 'copied', path: filePath, originalPath });
continue;
}
const filePath = entries[index++] || '';
if (!filePath) continue;
const labels = { A: 'added', D: 'deleted', M: 'modified', T: 'type-changed', U: 'conflict' };
changes.push({ code, status: labels[code] || 'changed', path: filePath, originalPath: null });
}
return changes;
}
function parseCompactLog(output) {
return String(output || '').split('\x1e').map((record) => record.trim()).filter(Boolean).map((record) => {
const [sha, shortSha, date, subject] = record.split('\x1f');
return { sha, shortSha, date, subject };
});
}
class GitService { class GitService {
constructor() {
// `git remote get-url` is only re-run when the repository configuration file
// itself changed. Status polling asks for the remote URL of every repository
// every few seconds, and on Windows the child process dominates that cost.
this.remoteUrlCache = new Map();
}
async isAvailable() { async isAvailable() {
try { try {
const result = await run('git', ['--version'], { timeout: 10_000 }); const result = await run('git', ['--version'], { timeout: 10_000 });
@@ -42,13 +79,24 @@ class GitService {
const resolved = assertSafeRepositoryPath(repoPath); const resolved = assertSafeRepositoryPath(repoPath);
const stat = await fs.stat(resolved).catch(() => null); const stat = await fs.stat(resolved).catch(() => null);
if (!stat?.isDirectory()) throw new Error('The linked local folder no longer exists.'); if (!stat?.isDirectory()) throw new Error('The linked local folder no longer exists.');
// A directory that carries its own `.git` entry is by definition the top level
// of that working tree, for plain repositories as well as for submodules and
// linked worktrees where `.git` is a file. Spawning `git rev-parse` to learn
// that again is pure overhead, and every status poll passes an already
// resolved repository root back in.
const marker = await fs.stat(path.join(resolved, '.git')).catch(() => null);
if (marker) return resolved;
const result = await run('git', ['rev-parse', '--show-toplevel'], { cwd: resolved, timeout: 15_000 }); const result = await run('git', ['rev-parse', '--show-toplevel'], { cwd: resolved, timeout: 15_000 });
return path.resolve(result.stdout.trim()); return path.resolve(result.stdout.trim());
} }
async status(repoPath) { async status(repoPath) {
const root = await this.ensureRepository(repoPath); const root = await this.ensureRepository(repoPath);
const result = await run('git', ['status', '--porcelain=v2', '--branch', '-z', '--untracked-files=all'], { // `--no-optional-locks` keeps a status read from refreshing and rewriting the
// index. Without it every read writes inside .git, which both fights a
// concurrent Git command for the index lock and retriggers the filesystem
// watcher that asked for this read in the first place.
const result = await run('git', ['--no-optional-locks', 'status', '--porcelain=v2', '--branch', '-z', '--untracked-files=all'], {
cwd: root, cwd: root,
timeout: 30_000 timeout: 30_000
}); });
@@ -66,9 +114,34 @@ class GitService {
}); });
} }
remoteUrlCacheKey(repoPath, remote) {
return JSON.stringify([path.resolve(repoPath), remote]);
}
async getRemoteUrl(repoPath, remote = 'origin') { async getRemoteUrl(repoPath, remote = 'origin') {
const result = await run('git', ['remote', 'get-url', remote], { cwd: repoPath, timeout: 15_000 }); const cacheKey = this.remoteUrlCacheKey(repoPath, remote);
return result.stdout.trim(); const config = await fs.stat(path.join(repoPath, '.git', 'config')).catch(() => null);
const cached = this.remoteUrlCache.get(cacheKey);
if (config && cached && cached.mtimeMs === config.mtimeMs && cached.size === config.size) {
if (cached.error) throw cached.error;
return cached.url;
}
const remember = (entry) => {
if (config) this.remoteUrlCache.set(cacheKey, { ...entry, mtimeMs: config.mtimeMs, size: config.size });
else this.remoteUrlCache.delete(cacheKey);
};
try {
const result = await run('git', ['remote', 'get-url', remote], { cwd: repoPath, timeout: 15_000 });
const url = result.stdout.trim();
remember({ url, error: null });
return url;
} catch (error) {
// A repository that has no such remote keeps failing until its configuration
// changes, so the failure is remembered too. Without this, every status poll
// of an unmatched local repository spawns a child process that cannot succeed.
remember({ url: '', error });
throw error;
}
} }
@@ -273,12 +346,158 @@ class GitService {
return { strategy: requested, backupBranch: null, status, lockReport: await this.listGitLocks(root) }; return { strategy: requested, backupBranch: null, status, lockReport: await this.listGitLocks(root) };
} }
async previewWorkspaceSync(repoPath) {
const root = await this.ensureRepository(repoPath);
const { status } = await this.fetch(root);
const branch = status.branch?.head;
const upstream = status.branch?.upstream;
if (!status.head || !branch || branch === '(detached)') {
const error = new Error('Workspace synchronization requires a named branch with at least one commit.');
error.code = 'WORKSPACE_SYNC_BRANCH_REQUIRED';
throw error;
}
if (!upstream) {
const error = new Error('The current branch has no Gitea upstream. Publish it or switch to a tracked branch first.');
error.code = 'WORKSPACE_SYNC_UPSTREAM_REQUIRED';
throw error;
}
const targetSha = (await run('git', ['rev-parse', '--verify', upstream], { cwd: root, timeout: 30_000 })).stdout.trim();
const changes = parseNameStatus((await run('git', [
'diff', '--name-status', '-z', '--find-renames', 'HEAD', upstream, '--'
], { cwd: root, timeout: 60_000, maxBuffer: 16 * 1024 * 1024 })).stdout);
const logFormat = '%H%x1f%h%x1f%aI%x1f%s%x1e';
const [incomingResult, localResult, interruptedOperation] = await Promise.all([
run('git', ['log', `--format=${logFormat}`, `HEAD..${upstream}`, '-20'], { cwd: root, timeout: 30_000 }),
run('git', ['log', `--format=${logFormat}`, `${upstream}..HEAD`, '-20'], { cwd: root, timeout: 30_000 }),
this.detectInterruptedOperation(root)
]);
const blockers = [];
if (interruptedOperation) blockers.push(`Finish or abort the active Git ${interruptedOperation} before synchronizing.`);
if (status.counts.conflicts) blockers.push(`Resolve ${status.counts.conflicts} conflicted file${status.counts.conflicts === 1 ? '' : 's'} before synchronizing.`);
const summary = {
resultingTrackedChanges: changes.length,
added: changes.filter((item) => item.code === 'A').length,
modified: changes.filter((item) => ['M', 'T'].includes(item.code)).length,
deleted: changes.filter((item) => item.code === 'D').length,
renamed: changes.filter((item) => item.code === 'R').length,
localFilesToStash: status.counts.changed,
untrackedFilesToStash: status.counts.untracked,
localCommitsToProtect: status.branch.ahead,
incomingCommits: status.branch.behind
};
const planId = crypto.createHash('sha256').update(JSON.stringify({
head: status.head,
targetSha,
branch,
upstream,
fingerprint: this.statusFingerprint(status)
})).digest('hex');
return {
id: planId,
repositoryRoot: root,
branch,
upstream,
currentSha: status.head,
targetSha,
needsSync: status.head !== targetSha || !status.clean,
cleanBeforeSync: status.clean,
blockers,
summary,
changes: changes.slice(0, 250),
changesTruncated: changes.length > 250,
localFiles: status.files.slice(0, 250),
localFilesTruncated: status.files.length > 250,
incomingCommits: parseCompactLog(incomingResult.stdout),
localCommits: parseCompactLog(localResult.stdout),
recovery: {
safetyBranch: status.branch.ahead > 0,
stash: status.counts.changed > 0,
untrackedCleanup: status.counts.untracked > 0,
ignoredFilesPreserved: true
}
};
}
async synchronizeWorkspace(repoPath, expectedPlanId) {
const expected = String(expectedPlanId || '').trim();
if (!/^[0-9a-f]{64}$/i.test(expected)) {
const error = new Error('Apply workspace synchronization only from a reviewed preview.');
error.code = 'WORKSPACE_SYNC_PLAN_REQUIRED';
throw error;
}
const plan = await this.previewWorkspaceSync(repoPath);
if (plan.id !== expected) {
const error = new Error('The local workspace or Gitea branch changed after the preview. Review a fresh synchronization plan.');
error.code = 'WORKSPACE_SYNC_PLAN_STALE';
error.recoverable = true;
throw error;
}
if (plan.blockers.length) {
const error = new Error(plan.blockers.join(' '));
error.code = 'WORKSPACE_SYNC_BLOCKED';
error.recoverable = true;
throw error;
}
if (!plan.needsSync) {
return { applied: false, unchanged: true, plan, status: await this.status(plan.repositoryRoot), backupBranch: null, stash: null, cleaned: [] };
}
const root = plan.repositoryRoot;
const stamp = new Date().toISOString().replace(/[-:]/g, '').replace(/\..+/, '').replace('T', '-');
let backupBranch = null;
let stash = null;
if (plan.summary.localCommitsToProtect > 0) {
const safeBranch = plan.branch.replace(/[^A-Za-z0-9._-]/g, '-');
backupBranch = `forgeflow/recovery-${safeBranch}-${stamp}-${plan.currentSha.slice(0, 7)}`;
await run('git', ['check-ref-format', '--branch', backupBranch], { cwd: root, timeout: 30_000 });
await run('git', ['branch', backupBranch, 'HEAD'], { cwd: root, timeout: 30_000 });
}
if (plan.summary.localFilesToStash > 0) {
const label = `ForgeFlow workspace sync ${plan.branch} ${stamp}`;
await run('git', ['stash', 'push', '--include-untracked', '-m', label], { cwd: root, timeout: 120_000 });
stash = (await this.stashList(root))[0] || null;
}
const protectedStatus = await this.status(root);
if (!protectedStatus.clean || protectedStatus.head !== plan.currentSha) {
const error = new Error('The workspace changed while ForgeFlow was protecting local work. Nothing was reset; review a fresh synchronization plan.');
error.code = 'WORKSPACE_SYNC_CONCURRENT_CHANGE';
error.recoverable = true;
error.backupBranch = backupBranch;
error.stash = stash;
throw error;
}
await run('git', ['reset', '--hard', plan.targetSha], { cwd: root, timeout: 2 * 60_000 });
const status = await this.status(root);
if (status.head !== plan.targetSha || !status.clean) {
const error = new Error('Git did not verify an exact clean match with the reviewed Gitea commit. Local recovery references were preserved.');
error.code = 'WORKSPACE_SYNC_VERIFICATION_FAILED';
error.recoverable = true;
error.backupBranch = backupBranch;
error.stash = stash;
throw error;
}
return {
applied: true,
unchanged: false,
plan,
status,
backupBranch,
stash,
cleaned: plan.localFiles.filter((file) => file.untracked).map((file) => file.path),
ignoredFilesPreserved: true
};
}
async setRemoteUrl(repoPath, remoteUrl, remote = 'origin') { async setRemoteUrl(repoPath, remoteUrl, remote = 'origin') {
const root = await this.ensureRepository(repoPath); const root = await this.ensureRepository(repoPath);
const safeRemote = assertCloneRemote(remoteUrl); const safeRemote = assertCloneRemote(remoteUrl);
const name = String(remote || 'origin').trim(); const name = String(remote || 'origin').trim();
if (!/^[A-Za-z0-9._-]+$/.test(name)) throw new Error('Invalid Git remote name.'); if (!/^[A-Za-z0-9._-]+$/.test(name)) throw new Error('Invalid Git remote name.');
await run('git', ['remote', 'set-url', name, safeRemote], { cwd: root, timeout: 30_000 }); await run('git', ['remote', 'set-url', name, safeRemote], { cwd: root, timeout: 30_000 });
this.remoteUrlCache.delete(this.remoteUrlCacheKey(root, name));
return this.status(root); return this.status(root);
} }
@@ -292,7 +511,26 @@ class GitService {
if (!result.stdout && safeFile && !staged) { if (!result.stdout && safeFile && !staged) {
const candidate = path.resolve(root, safeFile); const candidate = path.resolve(root, safeFile);
if (candidate !== root && !candidate.startsWith(`${root}${path.sep}`)) throw new Error('File path escapes repository root.'); if (candidate !== root && !candidate.startsWith(`${root}${path.sep}`)) throw new Error('File path escapes repository root.');
const content = await fs.readFile(candidate, 'utf8').catch(() => ''); const [realRoot, realCandidate, candidateStat] = await Promise.all([
fs.realpath(root).catch(() => root),
fs.realpath(candidate).catch(() => candidate),
fs.stat(candidate).catch(() => null)
]);
const normalize = (value) => process.platform === 'win32' ? value.toLowerCase() : value;
const normalizedRoot = normalize(realRoot);
const normalizedCandidate = normalize(realCandidate);
if (normalizedCandidate !== normalizedRoot && !normalizedCandidate.startsWith(`${normalizedRoot}${path.sep}`)) {
const error = new Error('ForgeFlow refuses to read a diff target that resolves outside the repository.');
error.code = 'DIFF_TARGET_OUTSIDE_REPOSITORY';
throw error;
}
if (candidateStat?.size > MAX_UNTRACKED_DIFF_BYTES) {
const error = new Error('The untracked file is too large to render safely as a diff.');
error.code = 'DIFF_FILE_TOO_LARGE';
error.recoverable = true;
throw error;
}
const content = candidateStat?.isFile() ? await fs.readFile(candidate, 'utf8').catch(() => '') : '';
if (content) return `diff --git a/${safeFile} b/${safeFile}\nnew file mode 100644\n--- /dev/null\n+++ b/${safeFile}\n${content.split('\n').map((line) => `+${line}`).join('\n')}`; if (content) return `diff --git a/${safeFile} b/${safeFile}\nnew file mode 100644\n--- /dev/null\n+++ b/${safeFile}\n${content.split('\n').map((line) => `+${line}`).join('\n')}`;
} }
return result.stdout; return result.stdout;
@@ -354,8 +592,7 @@ class GitService {
return { selected, matches }; return { selected, matches };
} }
async expandSelectedPaths(root, files, { unstagedOnly = false } = {}) { expandStatusPaths(status, files, { unstagedOnly = false } = {}) {
const status = await this.status(root);
const { selected, matches } = this.selectedStatusFiles(status, files); const { selected, matches } = this.selectedStatusFiles(status, files);
if (!selected.length) return []; if (!selected.length) return [];
const expanded = new Set(); const expanded = new Set();
@@ -367,12 +604,17 @@ class GitService {
return [...expanded]; return [...expanded];
} }
async stage(repoPath, files) { async expandSelectedPaths(root, files, options = {}) {
const root = await this.ensureRepository(repoPath); return this.expandStatusPaths(await this.status(root), files, options);
}
// Callers that already read the status pass it in. Reading it again costs a
// child process, and a commit used to pay for four of them.
async applyStage(root, files, knownStatus = null) {
const requested = assertRepositoryRelativePaths(files); const requested = assertRepositoryRelativePaths(files);
if (!requested.length) { if (!requested.length) {
await run('git', ['add', '--all'], { cwd: root, timeout: 60_000 }); await run('git', ['add', '--all'], { cwd: root, timeout: 60_000 });
return this.status(root); return;
} }
// Only stage records that still have a worktree-side change. Re-running // Only stage records that still have a worktree-side change. Re-running
@@ -380,10 +622,16 @@ class GitService {
// Git fail with "pathspec did not match any files" because the file no // Git fail with "pathspec did not match any files" because the file no
// longer exists in either the worktree or HEAD. Staged-only deletions and // longer exists in either the worktree or HEAD. Staged-only deletions and
// renames are already ready for commit and must therefore be left alone. // renames are already ready for commit and must therefore be left alone.
const selected = await this.expandSelectedPaths(root, requested, { unstagedOnly: true }); const status = knownStatus || await this.status(root);
const selected = this.expandStatusPaths(status, requested, { unstagedOnly: true });
if (selected.length) { if (selected.length) {
await this.runWithPathspec(root, ['add', '-A'], selected, { timeout: 120_000 }); await this.runWithPathspec(root, ['add', '-A'], selected, { timeout: 120_000 });
} }
}
async stage(repoPath, files) {
const root = await this.ensureRepository(repoPath);
await this.applyStage(root, files);
return this.status(root); return this.status(root);
} }
@@ -403,8 +651,9 @@ class GitService {
async prepareSelectedStage(root, files) { async prepareSelectedStage(root, files) {
const selected = assertRepositoryRelativePaths(files); const selected = assertRepositoryRelativePaths(files);
let current = null;
if (selected.length) { if (selected.length) {
const current = await this.status(root); current = await this.status(root);
const excludedStaged = current.files const excludedStaged = current.files
.filter((file) => file.staged) .filter((file) => file.staged)
.filter((file) => !selected.includes(file.path) && !(file.originalPath && selected.includes(file.originalPath))) .filter((file) => !selected.includes(file.path) && !(file.originalPath && selected.includes(file.originalPath)))
@@ -413,7 +662,7 @@ class GitService {
throw new Error(`Some staged files are not selected (${excludedStaged.slice(0, 3).join(', ')}${excludedStaged.length > 3 ? ', …' : ''}). Select them or unstage them first.`); throw new Error(`Some staged files are not selected (${excludedStaged.slice(0, 3).join(', ')}${excludedStaged.length > 3 ? ', …' : ''}). Select them or unstage them first.`);
} }
} }
await this.stage(root, selected); await this.applyStage(root, selected, current);
const stagedCheck = await run('git', ['diff', '--cached', '--quiet'], { cwd: root, allowExitCodes: [1] }); const stagedCheck = await run('git', ['diff', '--cached', '--quiet'], { cwd: root, allowExitCodes: [1] });
if (stagedCheck.exitCode === 0) throw new Error('There are no staged changes to commit.'); if (stagedCheck.exitCode === 0) throw new Error('There are no staged changes to commit.');
return selected; return selected;
+89
View File
@@ -0,0 +1,89 @@
"use strict";
const crypto = require("node:crypto");
const PROFILE_DEFINITIONS = Object.freeze({
minimal: { label: "Minimal", requiredScore: 55, severities: ["error"], allowSuppressions: true, maxSuppressionDays: 180 },
standard: { label: "Standard", requiredScore: 70, severities: ["error", "warning"], allowSuppressions: true, maxSuppressionDays: 90 },
strict: { label: "Strict", requiredScore: 82, severities: ["error", "warning"], allowSuppressions: true, maxSuppressionDays: 30 },
production: { label: "Production", requiredScore: 90, severities: ["error", "warning"], allowSuppressions: true, maxSuppressionDays: 14 },
});
function normalizePolicy(policy = {}) {
const id = String(policy.id || policy.profile || "standard").toLowerCase();
const base = PROFILE_DEFINITIONS[id] || PROFILE_DEFINITIONS.standard;
const custom = id === "organization" ? policy : {};
return {
id,
label: custom.label || base.label || "Organization custom",
requiredScore: Math.min(100, Math.max(0, Number(custom.requiredScore ?? base.requiredScore ?? 80))),
enabledChecks: Array.isArray(custom.enabledChecks) ? [...new Set(custom.enabledChecks.map(String))] : null,
severityOverrides: custom.severityOverrides && typeof custom.severityOverrides === "object" ? { ...custom.severityOverrides } : {},
blockingChecks: [...new Set((custom.blockingChecks || policy.blockingChecks || []).map(String))],
blockingSeverities: [...new Set((custom.blockingSeverities || policy.blockingSeverities || base.severities || ["error"]).map(String))]
.filter((severity) => ["warning", "error"].includes(severity)),
allowSuppressions: custom.allowSuppressions ?? base.allowSuppressions ?? true,
maxSuppressionDays: Math.max(1, Number(custom.maxSuppressionDays ?? base.maxSuppressionDays ?? 30)),
};
}
function validateSuppression(input, policy, now = new Date()) {
if (!policy.allowSuppressions) throw new Error("The selected policy does not allow suppressions.");
const checkId = String(input?.checkId || "").trim();
const reason = String(input?.reason || "").trim();
const author = String(input?.author || "").trim();
const scope = String(input?.scope || "repository").trim();
const evidence = String(input?.evidence || "").trim();
const expiresAt = new Date(input?.expiresAt || "");
if (!checkId || reason.length < 10 || !author || !evidence) throw new Error("A suppression requires a check ID, author, evidence and a reason of at least 10 characters.");
if (!Number.isFinite(expiresAt.getTime()) || expiresAt <= now) throw new Error("A suppression expiry must be in the future.");
const maximum = new Date(now.getTime() + policy.maxSuppressionDays * 86_400_000);
if (expiresAt > maximum) throw new Error(`This policy permits suppressions for at most ${policy.maxSuppressionDays} days.`);
return {
id: crypto.randomUUID(), checkId, reason, author,
createdAt: now.toISOString(), ticket: String(input.ticket || "").trim() || null,
expiresAt: expiresAt.toISOString(), scope, evidence,
};
}
function applyPolicy(checks, policyInput, suppressions = [], now = new Date()) {
const policy = normalizePolicy(policyInput);
const enabled = policy.enabledChecks ? new Set(policy.enabledChecks) : null;
const relevant = checks.filter((check) => !enabled || enabled.has(check.id)).map((check) => {
const status = policy.severityOverrides[check.id] || check.status;
const suppression = suppressions.find((item) => item.checkId === check.id && new Date(item.expiresAt) > now);
const expiredSuppression = suppressions.find((item) => item.checkId === check.id && new Date(item.expiresAt) <= now);
return {
...check,
status,
suppressed: Boolean(suppression),
suppression: suppression || null,
expiredSuppression: expiredSuppression || null,
blocking: !suppression && status !== "pass" && (policy.blockingSeverities.includes(status) || policy.blockingChecks.includes(check.id)),
};
});
return { policy, checks: relevant };
}
function buildTrend(previous, report) {
const prior = new Map((previous?.checks || []).map((check) => [check.id, check]));
const current = new Map(report.checks.map((check) => [check.id, check]));
const active = (check) => check && check.status !== "pass" && !check.suppressed;
const newlyFound = [...current.values()].filter((check) => active(check) && !active(prior.get(check.id))).map((check) => check.id);
const resolved = [...prior.values()].filter((check) => active(check) && !active(current.get(check.id))).map((check) => check.id);
const regressions = [...current.values()].filter((check) => active(check) && prior.get(check.id)?.status === "warning" && check.status === "error").map((check) => check.id);
return { score: report.score, categories: report.categories, newlyFound, resolved, regressions, suppressions: report.checks.filter((check) => check.suppressed).map((check) => check.id), checkedAt: report.checkedAt, commitSha: report.commitSha || null, checks: report.checks.map(({ id, status, suppressed }) => ({ id, status, suppressed })) };
}
function exportReport(report, format = "json") {
if (format === "json") return { extension: "json", mimeType: "application/json", content: `${JSON.stringify(report, null, 2)}\n` };
const rows = report.checks.map((check) => `| ${check.id} | ${check.category} | ${check.status}${check.suppressed ? " (suppressed)" : ""} | ${String(check.detail).replace(/\|/g, "\\|")} |`).join("\n");
const markdown = `# Git assurance report — ${report.repository}\n\nPolicy: **${report.policy.label}** · Score: **${report.score}/100** · Commit: \`${report.commitSha || "unknown"}\`\n\n| Check | Category | Status | Evidence |\n|---|---|---|---|\n${rows}\n`;
if (format === "markdown") return { extension: "md", mimeType: "text/markdown", content: markdown };
if (format !== "html") throw new Error("Unsupported Git Validator export format.");
const escape = (value) => String(value).replace(/[&<>"']/g, (character) => ({ "&": "&amp;", "<": "&lt;", ">": "&gt;", '"': "&quot;", "'": "&#39;" })[character]);
const htmlRows = report.checks.map((check) => `<tr><td>${escape(check.id)}</td><td>${escape(check.category)}</td><td>${escape(check.status)}${check.suppressed ? " (suppressed)" : ""}</td><td>${escape(check.detail)}</td></tr>`).join("");
return { extension: "html", mimeType: "text/html", content: `<!doctype html><html lang="en"><meta charset="utf-8"><title>Git assurance — ${escape(report.repository)}</title><style>body{font:15px system-ui;max-width:1100px;margin:40px auto;padding:0 24px;color:#172033}table{border-collapse:collapse;width:100%}th,td{padding:10px;border:1px solid #ccd4e0;text-align:left}th{background:#edf2f7}</style><h1>Git assurance — ${escape(report.repository)}</h1><p>Policy: <strong>${escape(report.policy.label)}</strong> · Score: <strong>${report.score}/100</strong> · Commit: <code>${escape(report.commitSha || "unknown")}</code></p><table><thead><tr><th>Check</th><th>Category</th><th>Status</th><th>Evidence</th></tr></thead><tbody>${htmlRows}</tbody></table></html>` };
}
module.exports = { PROFILE_DEFINITIONS, normalizePolicy, validateSuppression, applyPolicy, buildTrend, exportReport };
+599
View File
@@ -0,0 +1,599 @@
"use strict";
const fs = require("node:fs/promises");
const path = require("node:path");
const { run } = require("./process-runner.cjs");
const { normalizeRemoteUrl } = require("../shared/repository-match.cjs");
const { applyPolicy, buildTrend, exportReport, normalizePolicy, validateSuppression } = require("./git-validator-policy.cjs");
const RECOMMENDED_GITIGNORE = `# Local configuration and secrets
.env
.env.*
!.env.example
!.env.sample
# Dependencies and generated output
node_modules/
dist/
build/
coverage/
# Editors and operating systems
.idea/
.vscode/
.DS_Store
Thumbs.db
`;
const RECOMMENDED_GITATTRIBUTES = `* text=auto eol=lf
*.bat text eol=crlf
*.cmd text eol=crlf
*.ps1 text eol=crlf
*.png binary
*.jpg binary
*.jpeg binary
*.gif binary
*.ico binary
*.zip binary
`;
const RECOMMENDED_EDITORCONFIG = `root = true
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 2
[*.{bat,cmd,ps1}]
end_of_line = crlf
`;
function sameRemote(left, right) {
const a = normalizeRemoteUrl(left);
const b = normalizeRemoteUrl(right);
return Boolean(a && b && a.host === b.host && a.path === b.path);
}
function result(id, category, title, status, detail, options = {}) {
return {
id,
category,
title,
status,
detail,
weight: options.weight || 5,
fixAction: options.fixAction || null,
safe: options.safe === true,
confirmation: options.confirmation || null,
evidence: options.evidence || null,
};
}
function isSensitiveTrackedPath(filePath) {
const value = String(filePath || "")
.replace(/\\/g, "/")
.toLowerCase();
if (/\.env\.(example|sample|template)$/.test(value)) return false;
return (
/(^|\/)\.env($|\.)/.test(value) ||
/(^|\/)(id_rsa|id_ed25519)$/.test(value) ||
/\.(pem|p12|pfx|key)$/.test(value) ||
/(^|\/)(credentials|secrets?)(\.[^/]+)?\.(json|ya?ml)$/.test(value)
);
}
class GitValidatorService {
constructor({ git, gitea, diagnostics, store }) {
this.git = git;
this.gitea = gitea;
this.diagnostics = diagnostics;
this.store = store;
}
async config(root, key, { local = true } = {}) {
const response = await run(
"git",
["config", ...(local ? ["--local"] : []), "--get", key],
{
cwd: root,
timeout: 10_000,
allowExitCodes: [1],
},
);
return response.stdout.trim();
}
async trackedFiles(root) {
const response = await run("git", ["ls-files", "-z"], {
cwd: root,
timeout: 30_000,
maxBuffer: 16 * 1024 * 1024,
});
return response.stdout.split("\0").filter(Boolean);
}
async scan(repository) {
const checks = [];
const defaultBranch = repository.defaultBranch || "main";
const owner = repository.owner?.login;
try {
const protection = await this.gitea.getBranchProtection(
owner,
repository.name,
defaultBranch,
);
checks.push(
result(
"default-branch-protection",
"Gitea governance",
"Default branch protection",
protection.protected ? "pass" : "warning",
protection.protected
? `${defaultBranch} is protected; force push is ${protection.enableForcePush ? "allowed" : "blocked"}.`
: `${defaultBranch} accepts unprotected direct changes.`,
{
weight: 18,
fixAction: protection.protected ? null : "protect-default-branch",
safe: false,
confirmation: `Protect ${defaultBranch} on Gitea and block direct and force pushes?`,
},
),
);
if (protection.protected)
checks.push(
result(
"force-push",
"Gitea governance",
"Force-push protection",
protection.enableForcePush ? "warning" : "pass",
protection.enableForcePush
? "Force pushes remain enabled on the protected branch."
: "Force pushes are blocked on the protected branch.",
{ weight: 8 },
),
);
} catch (error) {
checks.push(
result(
"branch-protection-unavailable",
"Gitea governance",
"Branch protection could not be verified",
"warning",
error.message,
{ weight: 18 },
),
);
}
if (!repository.localPath) {
checks.push(
result(
"local-link",
"Local repository",
"Local working tree",
"warning",
"Link or clone this repository to validate files and local Git configuration.",
{ weight: 35 },
),
);
return this.finalize(repository, checks, null);
}
const root = await this.git.ensureRepository(repository.localPath);
const status = await this.git.status(root);
const tracked = await this.trackedFiles(root);
const lowerFiles = tracked.map((file) => file.toLowerCase());
const desiredRemote =
repository.preferredCloneUrl || repository.cloneUrl || repository.sshUrl;
checks.push(
result(
"origin",
"Repository identity",
"Origin matches Gitea",
sameRemote(status.remoteUrl, desiredRemote) ? "pass" : "error",
sameRemote(status.remoteUrl, desiredRemote)
? status.remoteUrl
: `Current origin ${status.remoteUrl || "is missing"}; expected ${desiredRemote}.`,
{
weight: 15,
fixAction: sameRemote(status.remoteUrl, desiredRemote)
? null
: "align-origin",
safe: true,
},
),
);
checks.push(
result(
"upstream",
"Branch hygiene",
"Current branch has an upstream",
status.branch?.upstream ? "pass" : "warning",
status.branch?.upstream
? `${status.branch.head} tracks ${status.branch.upstream}.`
: `${status.branch?.head || "The current branch"} is not published or tracked.`,
{ weight: 8 },
),
);
checks.push(
result(
"working-tree",
"Branch hygiene",
"Working tree is intentional",
status.clean ? "pass" : "warning",
status.clean
? "No uncommitted changes."
: `${status.counts.changed} changed file(s) require review, commit or stash.`,
{ weight: 5 },
),
);
const [userName, userEmail, fetchPrune, pullFf, autoStash] =
await Promise.all([
this.config(root, "user.name", { local: false }),
this.config(root, "user.email", { local: false }),
this.config(root, "fetch.prune"),
this.config(root, "pull.ff"),
this.config(root, "rebase.autoStash"),
]);
checks.push(
result(
"identity",
"Commit integrity",
"Repository author identity",
userName && userEmail ? "pass" : "warning",
userName && userEmail
? `${userName} <${userEmail}>`
: "The effective Git user.name or user.email is missing.",
{ weight: 7 },
),
);
const safetyReady =
fetchPrune === "true" && pullFf === "only" && autoStash === "true";
checks.push(
result(
"local-safety",
"Local configuration",
"Safe synchronization defaults",
safetyReady ? "pass" : "warning",
safetyReady
? "Stale remotes are pruned, pulls are fast-forward-only and rebase autostash is enabled."
: "Recommended repository-local fetch, pull and autostash safeguards are incomplete.",
{
weight: 10,
fixAction: safetyReady ? null : "configure-local-safety",
safe: true,
},
),
);
const hasReadme = lowerFiles.some((file) =>
/(^|\/)readme(\.[^/]+)?$/.test(file),
);
checks.push(
result(
"readme",
"Repository documentation",
"README is versioned",
hasReadme ? "pass" : "warning",
hasReadme
? "Repository purpose and usage can be documented at the source."
: "No tracked README was found.",
{ weight: 7 },
),
);
const hasGitignore = lowerFiles.includes(".gitignore");
checks.push(
result(
"gitignore",
"Repository hygiene",
".gitignore is versioned",
hasGitignore ? "pass" : "warning",
hasGitignore
? "Generated and local-only files can be excluded centrally."
: "No tracked .gitignore was found.",
{
weight: 8,
fixAction: hasGitignore ? null : "add-gitignore",
safe: false,
confirmation:
"Create a recommended .gitignore in the working tree? It will remain uncommitted for review.",
},
),
);
for (const [id, title, filename, action] of [
["gitattributes", ".gitattributes normalizes text and binary files", ".gitattributes", "add-gitattributes"],
["editorconfig", ".editorconfig keeps editors consistent", ".editorconfig", "add-editorconfig"],
]) {
const present = lowerFiles.includes(filename);
checks.push(result(id, "Repository hygiene", title, present ? "pass" : "warning",
present ? `${filename} is versioned.` : `No tracked ${filename} was found.`, {
weight: 5,
fixAction: present ? null : action,
safe: false,
confirmation: `Create a recommended ${filename} in the working tree for review?`,
}));
}
const packageManagers = [
{ manifests: ["package.json"], locks: ["package-lock.json", "pnpm-lock.yaml", "yarn.lock", "bun.lock", "bun.lockb"] },
{ manifests: ["pyproject.toml", "requirements.in", "pipfile"], locks: ["uv.lock", "poetry.lock", "requirements.txt", "pipfile.lock"] },
{ manifests: ["composer.json"], locks: ["composer.lock"] },
{ manifests: ["gemfile"], locks: ["gemfile.lock"] },
];
const lockCheck = packageManagers.find((entry) => entry.manifests.some((name) => lowerFiles.includes(name)));
if (lockCheck) {
const lockfile = lockCheck.locks.find((name) => lowerFiles.includes(name));
checks.push(result("dependency-lock", "Supply chain", "Dependencies are reproducibly locked", lockfile ? "pass" : "warning",
lockfile ? `${lockfile} is versioned.` : "A dependency manifest exists without a recognized lockfile.", { weight: 9 }));
}
const hasCi = lowerFiles.some((file) => /^\.gitea\/workflows\/[^/]+\.ya?ml$/.test(file));
checks.push(result("continuous-integration", "Gitea governance", "Automated checks run on Gitea", hasCi ? "pass" : "warning",
hasCi ? "At least one Gitea Actions workflow is versioned." : "No .gitea/workflows YAML file was found.", { weight: 8 }));
const sensitive = tracked.filter(isSensitiveTrackedPath);
checks.push(
result(
"tracked-secrets",
"Security",
"No secret-shaped files are tracked",
sensitive.length ? "error" : "pass",
sensitive.length
? `Review immediately: ${sensitive.slice(0, 8).join(", ")}${sensitive.length > 8 ? "…" : ""}. Removing a file does not erase Git history.`
: "No tracked environment, private-key or credential filenames were detected.",
{ weight: 22 },
),
);
const large = [];
const candidates = tracked.slice(0, 5000);
for (
let index = 0;
index < candidates.length && large.length < 12;
index += 64
) {
const batch = candidates.slice(index, index + 64);
const stats = await Promise.all(
batch.map(async (file) => ({
file,
stat: await fs.stat(path.join(root, file)).catch(() => null),
})),
);
for (const item of stats) {
if (item.stat?.isFile() && item.stat.size > 10 * 1024 * 1024)
large.push({ file: item.file, size: item.stat.size });
if (large.length >= 12) break;
}
}
checks.push(
result(
"large-files",
"Repository performance",
"No oversized tracked files",
large.length ? "warning" : "pass",
large.length
? `${large.map((item) => `${item.file} (${Math.ceil(item.size / 1024 / 1024)} MB)`).join(", ")}. Consider Git LFS.`
: "No tracked files above 10 MB were found.",
{ weight: 7 },
),
);
await this.addAssuranceChecks(root, tracked, lowerFiles, checks);
return this.finalize(repository, checks, status);
}
async addAssuranceChecks(root, tracked, lowerFiles, checks) {
const has = (...patterns) => lowerFiles.some((file) => patterns.some((pattern) => pattern.test(file)));
const fileCheck = (id, category, title, patterns, detail, weight = 5) => {
const present = has(...patterns);
checks.push(result(id, category, title, present ? "pass" : "warning", present ? `${title} is versioned.` : detail, { weight }));
};
fileCheck("security-policy", "Security", "Security policy", [/(^|\/)security\.md$/], "Add SECURITY.md with supported versions and private disclosure instructions.", 8);
fileCheck("codeowners", "Governance", "Code ownership", [/(^|\/)codeowners$/], "Add CODEOWNERS for security-sensitive and release paths.", 6);
fileCheck("license", "Governance", "Repository license", [/(^|\/)(license|copying)(\.[^/]+)?$/], "Document the repository license or private-use terms.", 5);
fileCheck("changelog", "Release readiness", "Changelog", [/(^|\/)changelog(\.[^/]+)?$/], "Add a changelog that maps releases to user-visible changes.", 7);
fileCheck("contributing", "Collaboration", "Contribution guide", [/(^|\/)contributing(\.[^/]+)?$/], "Add contribution, test and review instructions.", 4);
fileCheck("issue-templates", "Collaboration", "Issue templates", [/^\.gitea\/issue_template\//, /^\.github\/issue_template\//], "Add structured issue templates.", 3);
fileCheck("pull-request-template", "Collaboration", "Pull request template", [/(^|\/)pull_request_template\.md$/], "Add a pull request checklist for tests, risk and rollback.", 4);
fileCheck("runtime-pinning", "Reproducibility", "Runtime version pinning", [/(^|\/)(\.nvmrc|\.node-version|\.tool-versions|mise\.toml)$/], "Pin the runtime version used by developers and CI.", 7);
fileCheck("build-instructions", "Reproducibility", "Build instructions", [/(^|\/)(readme|building|build)(\.[^/]+)?$/], "Document a clean, reproducible build command.", 6);
const generated = tracked.filter((file) => /(^|\/)(dist|build|coverage|\.cache)\//i.test(file));
checks.push(result("generated-artifacts", "Performance and hygiene", "Generated output is not tracked", generated.length ? "warning" : "pass", generated.length ? `${generated.length} generated-path file(s) are tracked; review ${generated.slice(0, 5).join(", ")}.` : "No common generated output directories are tracked.", { weight: 8, evidence: generated.slice(0, 20) }));
const executables = tracked.filter((file) => /\.(exe|dll|msi|scr|com|bat|cmd|ps1)$/i.test(file));
checks.push(result("executable-artifacts", "Security", "Executable artifacts are intentional", executables.length ? "warning" : "pass", executables.length ? `Review executable content: ${executables.slice(0, 8).join(", ")}.` : "No executable-shaped artifacts are tracked.", { weight: 8, evidence: executables.slice(0, 20) }));
const workflowFiles = tracked.filter((file) => /^\.(gitea|github)\/workflows\/[^/]+\.ya?ml$/i.test(file));
const workflowText = (await Promise.all(workflowFiles.slice(0, 40).map((file) => fs.readFile(path.join(root, file), "utf8").catch(() => "")))).join("\n");
const unpinned = [...workflowText.matchAll(/uses:\s*[^\s@]+@([^\s#]+)/g)].map((match) => match[1]).filter((ref) => !/^[0-9a-f]{40}$/i.test(ref));
checks.push(result("pinned-actions", "Security", "External CI actions are commit-pinned", unpinned.length ? "warning" : "pass", unpinned.length ? `${unpinned.length} action reference(s) use mutable tags or branches.` : "External actions are commit-pinned or no external actions are used.", { weight: 9, evidence: unpinned.slice(0, 20) }));
const broadPermissions = /permissions:\s*(write-all|write)/i.test(workflowText) || /contents:\s*write/i.test(workflowText);
checks.push(result("workflow-permissions", "Security", "Workflow permissions use least privilege", broadPermissions ? "error" : "pass", broadPermissions ? "A workflow requests broad write permissions; scope permissions per job and capability." : "No broad workflow write permission was detected.", { weight: 12 }));
const [commitSignature, tagSignature, recentSubjects] = await Promise.all([
run("git", ["log", "-1", "--format=%G?"], { cwd: root, timeout: 10_000, allowExitCodes: [128] }).then((value) => value.stdout.trim()).catch(() => "N"),
run("git", ["tag", "--points-at", "HEAD", "--format=%(contents:signature)"], { cwd: root, timeout: 10_000, allowExitCodes: [128] }).then((value) => value.stdout.trim()).catch(() => ""),
run("git", ["log", "-20", "--format=%s"], { cwd: root, timeout: 10_000, allowExitCodes: [128] }).then((value) => value.stdout.trim().split(/\r?\n/).filter(Boolean)).catch(() => []),
]);
checks.push(result("signed-commits", "Governance", "Latest commit is signed", /[GUYX]/.test(commitSignature) ? "pass" : "warning", /[GUYX]/.test(commitSignature) ? "Git reports a cryptographic signature on HEAD." : "HEAD has no verifiable Git signature.", { weight: 6 }));
checks.push(result("signed-tags", "Governance", "Release tags are signed", tagSignature ? "pass" : "warning", tagSignature ? "HEAD has a signed tag." : "HEAD has no signed release tag.", { weight: 5 }));
const conventional = recentSubjects.length > 0 && recentSubjects.every((subject) => /^(feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert)(\(.+\))?!?:\s.+/i.test(subject));
checks.push(result("conventional-commits", "Governance", "Recent commits follow a convention", conventional ? "pass" : "warning", conventional ? `${recentSubjects.length} recent commit subject(s) follow Conventional Commits.` : "Some recent commit subjects do not follow Conventional Commits.", { weight: 4 }));
const releaseFiles = {
"release-checksums": /(^|\/)(sha256sums|checksums?)(\.[^/]+)?$/,
"release-provenance": /(^|\/)(provenance|attestation)(\.[^/]+)?$/,
"release-sbom": /(^|\/)(sbom)(\.[^/]+)?$/,
};
for (const [id, pattern] of Object.entries(releaseFiles)) fileCheck(id, "Release readiness", id.replace(/^release-/, "Release "), [pattern], `No ${id.replace(/^release-/, "")} artifact is versioned or generated in the repository.`, 4);
checks.push(result("signing-readiness", "Release readiness", "Signing policy is documented", has(/(^|\/)(security|release|signing)(\.[^/]+)?$/) ? "pass" : "warning", has(/(^|\/)(security|release|signing)(\.[^/]+)?$/) ? "Signing guidance is present." : "Document signing identity, verification and timestamp requirements.", { weight: 6 }));
}
async finalize(repository, checks, status) {
const repositoryState = this.store?.getGitValidatorState?.(repository.fullName) || { policy: { id: "standard" }, suppressions: [], trends: [] };
const { policy, checks: governedChecks } = applyPolicy(checks, repositoryState.policy, repositoryState.suppressions);
const report = this.summarize(repository, governedChecks);
report.policy = policy;
report.commitSha = status?.head || status?.branch?.oid || null;
report.categories = Object.fromEntries([...new Set(governedChecks.map((check) => check.category))].map((category) => {
const categoryChecks = governedChecks.filter((check) => check.category === category);
return [category, Math.round(categoryChecks.filter((check) => check.status === "pass" || check.suppressed).length / categoryChecks.length * 100)];
}));
report.ready = report.score >= policy.requiredScore && !governedChecks.some((check) => check.blocking);
report.expiredSuppressions = governedChecks.filter((check) => check.expiredSuppression).map((check) => check.id);
report.trend = buildTrend(repositoryState.trends.at(-1), report);
if (this.store?.appendGitValidatorTrend) await this.store.appendGitValidatorTrend(repository.fullName, report.trend);
return report;
}
async setPolicy(repository, policyInput) {
const policy = normalizePolicy(policyInput);
if (!this.store?.setGitValidatorPolicy) throw new Error("Git Validator policy persistence is unavailable.");
await this.store.setGitValidatorPolicy(repository.fullName, policy);
return policy;
}
async suppress(repository, input) {
const state = this.store?.getGitValidatorState?.(repository.fullName) || { policy: { id: "standard" } };
const suppression = validateSuppression(input, normalizePolicy(state.policy));
await this.store.addGitValidatorSuppression(repository.fullName, suppression);
return suppression;
}
export(report, format) { return exportReport(report, format); }
async previewRepair(repository, check) {
if (!check?.fixAction) throw new Error("This validator check has no repair action.");
const root = repository.localPath ? await this.git.ensureRepository(repository.localPath) : null;
const fileDefinitions = {
"add-gitignore": [".gitignore", RECOMMENDED_GITIGNORE],
"add-gitattributes": [".gitattributes", RECOMMENDED_GITATTRIBUTES],
"add-editorconfig": [".editorconfig", RECOMMENDED_EDITORCONFIG],
};
if (fileDefinitions[check.fixAction]) {
const [name, content] = fileDefinitions[check.fixAction];
if (await fs.stat(path.join(root, name)).catch(() => null)) throw new Error(`${name} already exists; rescan before repairing.`);
return { checkId: check.id, action: check.fixAction, files: [name], diff: `diff --git a/${name} b/${name}\nnew file mode 100644\n--- /dev/null\n+++ b/${name}\n${content.split("\n").filter((line, index, lines) => index < lines.length - 1).map((line) => `+${line}`).join("\n")}\n`, remoteMutation: false };
}
if (check.fixAction === "configure-local-safety") return { checkId: check.id, action: check.fixAction, files: [".git/config"], diff: "+ fetch.prune = true\n+ pull.ff = only\n+ rebase.autoStash = true\n", remoteMutation: false };
if (check.fixAction === "align-origin") return { checkId: check.id, action: check.fixAction, files: [".git/config"], diff: `- origin = current\n+ origin = ${repository.preferredCloneUrl || repository.cloneUrl || repository.sshUrl}\n`, remoteMutation: false };
if (check.fixAction === "protect-default-branch") return { checkId: check.id, action: check.fixAction, files: [], diff: `Gitea policy change:\n+ protect ${repository.defaultBranch || "main"}\n+ block force pushes\n+ require pull request review\n`, remoteMutation: true };
throw new Error("Unsupported Git Validator repair action.");
}
async resolveRepairCheck(repository, candidate) {
const checkId = String(candidate?.id || candidate?.checkId || "").trim();
if (!checkId) throw new Error("A current Git Validator check ID is required.");
const report = await this.scan(repository);
const current = report.checks.find((check) => check.id === checkId);
if (!current?.fixAction)
throw new Error("This finding is resolved, suppressed or no longer repairable. Scan again before repairing.");
if (candidate?.fixAction && candidate.fixAction !== current.fixAction)
throw new Error("The Git Validator repair request is stale. Scan again before repairing.");
return current;
}
summarize(repository, checks) {
const totalWeight = checks.reduce((sum, check) => sum + check.weight, 0);
const earned = checks.reduce(
(sum, check) =>
sum +
(check.status === "pass" || check.suppressed
? check.weight
: check.status === "warning"
? check.weight * 0.45
: 0),
0,
);
const score = totalWeight ? Math.round((earned / totalWeight) * 100) : 0;
return {
repository: repository.fullName,
checkedAt: new Date().toISOString(),
score,
grade:
score >= 90
? "Excellent"
: score >= 75
? "Good"
: score >= 55
? "Needs attention"
: "High risk",
checks,
summary: {
passed: checks.filter((check) => check.status === "pass").length,
warnings: checks.filter((check) => check.status === "warning" && !check.suppressed).length,
errors: checks.filter((check) => check.status === "error" && !check.suppressed).length,
suppressed: checks.filter((check) => check.suppressed).length,
repairable: checks.filter((check) => check.fixAction).length,
},
};
}
async repair(repository, check) {
if (!check?.fixAction)
throw new Error("This validator check has no repair action.");
const root = repository.localPath
? await this.git.ensureRepository(repository.localPath)
: null;
if (check.fixAction === "align-origin") {
return this.git.setRemoteUrl(
root,
repository.preferredCloneUrl ||
repository.cloneUrl ||
repository.sshUrl,
);
}
if (check.fixAction === "configure-local-safety") {
for (const [key, value] of [
["fetch.prune", "true"],
["pull.ff", "only"],
["rebase.autoStash", "true"],
])
await run("git", ["config", "--local", key, value], {
cwd: root,
timeout: 10_000,
});
return { configured: true };
}
if (check.fixAction === "add-gitignore") {
const target = path.join(root, ".gitignore");
const exists = await fs.stat(target).catch(() => null);
if (exists)
throw new Error(".gitignore already exists; rescan before repairing.");
await fs.writeFile(target, RECOMMENDED_GITIGNORE, {
encoding: "utf8",
flag: "wx",
});
return { created: ".gitignore" };
}
if (["add-gitattributes", "add-editorconfig"].includes(check.fixAction)) {
const definition = check.fixAction === "add-gitattributes"
? { name: ".gitattributes", content: RECOMMENDED_GITATTRIBUTES }
: { name: ".editorconfig", content: RECOMMENDED_EDITORCONFIG };
const target = path.join(root, definition.name);
if (await fs.stat(target).catch(() => null))
throw new Error(`${definition.name} already exists; rescan before repairing.`);
await fs.writeFile(target, definition.content, { encoding: "utf8", flag: "wx" });
return { created: definition.name };
}
if (check.fixAction === "protect-default-branch") {
return this.gitea.createBranchProtection(
repository.owner.login,
repository.name,
repository.defaultBranch || "main",
);
}
throw new Error("Unsupported Git Validator repair action.");
}
}
module.exports = {
GitValidatorService,
RECOMMENDED_GITIGNORE,
RECOMMENDED_GITATTRIBUTES,
RECOMMENDED_EDITORCONFIG,
sameRemote,
isSensitiveTrackedPath,
};
+102 -6
View File
@@ -204,6 +204,79 @@ class GiteaService {
}; };
} }
async createBranchProtection(owner, repo, branch) {
const target = assertBranchName(branch);
return (
await this.request(
`/repos/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}/branch_protections`,
{
method: "POST",
body: {
rule_name: target,
branch_name: target,
enable_push: false,
enable_force_push: false,
required_approvals: 0,
dismiss_stale_approvals: true,
block_on_rejected_reviews: true,
block_on_outdated_branch: true,
},
},
)
).data;
}
async listDeployKeys(owner, repo) {
const result = await this.request(
`/repos/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}/keys?limit=100`,
);
return Array.isArray(result.data) ? result.data : [];
}
async ensureReadOnlyDeployKey({ owner, repo, title, publicKey }) {
const key = String(publicKey || "").trim();
if (!/^ssh-(ed25519|rsa)\s+[A-Za-z0-9+/=]+(?:\s+.*)?$/.test(key))
throw new Error("The server did not return a valid SSH public key.");
const keys = await this.listDeployKeys(owner, repo);
const keyMaterial = key.split(/\s+/).slice(0, 2).join(" ");
const existing = keys.find((item) =>
String(item?.key || "").trim().split(/\s+/).slice(0, 2).join(" ") === keyMaterial,
);
if (existing) {
if (existing.read_only !== true) {
const error = new Error("The matching Gitea deploy key has write access. Revoke it before ForgeFlow configures a read-only server key.");
error.code = "DEPLOY_KEY_NOT_READ_ONLY";
throw error;
}
return { ...existing, created: false };
}
const result = await this.request(
`/repos/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}/keys`,
{
method: "POST",
body: {
title: String(title || "ForgeFlow server deploy key").trim().slice(0, 255),
key,
read_only: true,
},
},
);
return { ...result.data, created: true };
}
async createReadOnlyDeployKey({ owner, repo, title, publicKey }) {
const key = String(publicKey || "").trim();
if (!/^ssh-(ed25519|rsa)\s+[A-Za-z0-9+/=]+(?:\s+.*)?$/.test(key)) throw new Error("A valid SSH public key is required.");
const result = await this.request(`/repos/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}/keys`, { method: "POST", body: { title: String(title || "ForgeFlow server deploy key").trim().slice(0, 255), key, read_only: true } });
return result.data;
}
async deleteDeployKey(owner, repo, keyId) {
if (!Number.isInteger(Number(keyId)) || Number(keyId) <= 0) throw new Error("A valid deploy-key ID is required.");
await this.request(`/repos/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}/keys/${Number(keyId)}`, { method: "DELETE" });
return { deleted: true, keyId: Number(keyId) };
}
async listPullRequests({ owner, repo, state = "open", limit = 30 } = {}) { async listPullRequests({ owner, repo, state = "open", limit = 30 } = {}) {
const query = new URLSearchParams({ const query = new URLSearchParams({
state, state,
@@ -303,13 +376,15 @@ class GiteaService {
const token = this.store.getToken(); const token = this.store.getToken();
let target = new URL(url, `${baseUrl}/`); let target = new URL(url, `${baseUrl}/`);
for (let redirects = 0; redirects <= 5; redirects += 1) { for (let redirects = 0; redirects <= 5; redirects += 1) {
if (target.origin !== base.origin) const sameOrigin = target.origin === base.origin;
if (!sameOrigin && target.protocol !== "https:") {
throw new Error( throw new Error(
"Refusing to send the Gitea token to a different origin.", "Refusing an insecure cross-origin update download redirect.",
); );
}
const response = await fetch(target, { const response = await fetch(target, {
headers: { headers: {
Authorization: `token ${token}`, ...(sameOrigin && token ? { Authorization: `token ${token}` } : {}),
Accept: "application/octet-stream", Accept: "application/octet-stream",
}, },
signal: AbortSignal.timeout(timeout), signal: AbortSignal.timeout(timeout),
@@ -331,12 +406,33 @@ class GiteaService {
throw new Error("The update download exceeded the redirect limit."); throw new Error("The update download exceeded the redirect limit.");
} }
async downloadReleaseAsset(owner, repo, assetId, options = {}) { async downloadReleaseAsset(owner, repo, releaseId, assetId, options = {}) {
const numericReleaseId = Number(releaseId);
const numericId = Number(assetId); const numericId = Number(assetId);
if (!Number.isSafeInteger(numericReleaseId) || numericReleaseId <= 0)
throw new Error("Gitea returned an invalid release ID.");
if (!Number.isSafeInteger(numericId) || numericId <= 0) if (!Number.isSafeInteger(numericId) || numericId <= 0)
throw new Error("Gitea returned an invalid release asset ID."); throw new Error("Gitea returned an invalid release asset ID.");
const assetPath = `/api/v1/repos/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}/releases/assets/${numericId}`;
return this.downloadAuthenticated(assetPath, options); let downloadUrl = String(options.downloadUrl || "").trim();
if (!downloadUrl) {
const metadataPath = `/repos/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}/releases/${numericReleaseId}/assets/${numericId}`;
const metadata = (await this.request(metadataPath)).data;
if (Number(metadata?.id) !== numericId) {
throw new Error("Gitea returned metadata for a different release asset.");
}
downloadUrl = String(metadata?.browser_download_url || "").trim();
}
if (!downloadUrl) {
throw new Error("Gitea did not provide a release asset download URL.");
}
const configuredBase = new URL(normalizeBaseUrl(this.store.data.gitea.baseUrl));
const publishedUrl = new URL(downloadUrl, configuredBase);
const releasePrefix = `/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}/releases/download/`.toLowerCase();
if (publishedUrl.origin !== configuredBase.origin && publishedUrl.protocol === "http:" && publishedUrl.pathname.toLowerCase().startsWith(releasePrefix)) {
downloadUrl = new URL(`${publishedUrl.pathname}${publishedUrl.search}`, configuredBase).toString();
}
return this.downloadAuthenticated(downloadUrl, options);
} }
async dispatchWorkflow({ owner, repo, workflowFile, ref, inputs = {} }) { async dispatchWorkflow({ owner, repo, workflowFile, ref, inputs = {} }) {
+83
View File
@@ -0,0 +1,83 @@
"use strict";
const { deploymentIdentity, deploymentEvidenceHash, deploymentAuthorityKey } = require("./deployment-identity.cjs");
const BACKUP = /(?:^|[\\/._-])(backup|bak|archive|snapshot|old|previous)(?:[\\/._-]|$)/i;
const RELEASE = /(?:^|[\\/])(releases?|versions?)(?:[\\/]|$)/i;
const STAGING = /(?:^|[\\/._-])(staging|stage|test|qa|preview)(?:[\\/._-]|$)/i;
const TEMPORARY = /(?:^|[\\/._-])(candidate|rollback|ephemeral)(?:[\\/._-]|$)|^GITEA-ACTIONS-TASK-/i;
const SYSTEM = /^(?:traefik|nginx-proxy-manager|watchtower|portainer|dockerman|unraid-|cloudflared|redis|postgres|mariadb|mysql)(?:$|[-_.])/i;
function baseClassification(workload) {
const location = `${workload.compose?.workingDir || ""} ${(workload.compose?.configFiles || []).join(" ")}`;
const sourceRepository = String(workload.metadata?.sourceRepository || "").trim();
const hasGitProvenance = /^(?:git@|ssh:\/\/|https?:\/\/)/i.test(sourceRepository);
const decision = workload.reviewDecision;
if (["manual-exclude", "exclude-scan-root", "ignore"].includes(decision?.action)) return { type: "manually-excluded", reason: decision.reason || "Persisted manual exclusion", decisionAction: decision.action };
if (["mark-historical", "archive-link"].includes(decision?.action)) return { type: "historical-compose", reason: decision.reason || "Reviewed as historical", decisionAction: decision.action };
if (decision?.action === "monitor-only") return { type: "monitor-only", reason: decision.reason || "Reviewed for monitoring only", decisionAction: decision.action };
if (workload.metadata?.staleLink) return { type: "stale-link", reason: "The linked deployment profile has no matching server workload" };
if (BACKUP.test(location)) return { type: "backup", reason: "Path matches backup/archive evidence" };
if (RELEASE.test(location)) return { type: "release-folder", reason: "Path is below a release/version directory" };
if (STAGING.test(location)) return { type: "staging", reason: "Path or project identifies a staging/test workload" };
if (TEMPORARY.test(`${workload.displayName || ""} ${location}`)) return { type: "temporary-runtime", reason: "Runtime identity marks a candidate, rollback or CI workload" };
if (SYSTEM.test(workload.displayName || "") && !workload.metadata?.sourceRepository) return { type: "system-container", reason: "Known infrastructure identity without repository provenance" };
if (workload.link && workload.runtime?.running) return { type: "active-application", reason: "Linked deployment with running container evidence" };
if (workload.link && !workload.runtime?.running) return { type: "stopped-application", reason: "Linked deployment without a running container" };
if (!workload.containers?.length && workload.compose?.configFiles?.length) return { type: "historical-compose", reason: "Compose definition exists without container runtime" };
if (workload.status === "ambiguous") return { type: "ambiguous", reason: "Multiple candidates have equivalent evidence" };
if (!workload.candidates?.length) return { type: "external-container", reason: hasGitProvenance ? "Repository provenance does not match an accessible configured Gitea repository" : "Runtime has no Git repository provenance and remains monitoring-only" };
if (!workload.runtime?.running && workload.candidates?.length) return { type: "stopped-application", reason: "Stopped runtime has repository evidence" };
return { type: workload.runtime?.running ? "active-application" : "ambiguous", reason: workload.runtime?.running ? "Running application evidence" : "Insufficient authoritative evidence" };
}
function classifyInventory(workloads, profiles = [], decisions = []) {
const profileById = new Map(profiles.map((profile) => [profile.id, profile]));
const decisionByWorkload = new Map(decisions.map((decision) => [decision.workloadId, decision]));
const authorities = new Map();
const result = workloads.map((source) => {
const workload = structuredClone(source);
const profile = profileById.get(workload.link?.profileId) || null;
const identity = deploymentIdentity({ workload, profile });
const evidence = { candidates: (workload.candidates || []).map((item) => ({ repository: item.repositoryFullName, score: item.score, exact: item.exact === true })), running: workload.runtime?.running === true, health: workload.runtime?.health || null, configFiles: workload.compose?.configFiles || [] };
const hash = deploymentEvidenceHash(identity, evidence);
const stored = decisionByWorkload.get(workload.workloadId);
workload.reviewDecision = stored?.evidenceHash === hash ? stored : null;
workload.reviewDecisionStale = Boolean(stored && stored.evidenceHash !== hash);
workload.identity = identity;
if (workload.reviewDecision?.action === "manual-link" && workload.reviewDecision.repositoryFullName) {
workload.identity.repository = String(workload.reviewDecision.repositoryFullName).toLowerCase();
}
workload.evidenceHash = hash;
workload.classification = baseClassification(workload);
if (workload.link && ["backup", "release-folder", "staging", "temporary-runtime", "historical-compose", "system-container", "external-container", "manually-excluded"].includes(workload.classification.type)) {
workload.shadowedLink = workload.link;
workload.link = null;
}
const key = deploymentAuthorityKey(identity);
if (identity.repository && (workload.link || workload.candidates?.length) && !["backup", "release-folder", "staging", "temporary-runtime", "historical-compose", "system-container", "external-container", "manually-excluded"].includes(workload.classification.type)) {
const group = authorities.get(key) || [];
group.push(workload);
authorities.set(key, group);
}
return workload;
});
for (const group of authorities.values()) {
if (group.length < 2) {
group[0].authoritative = true;
continue;
}
const ranked = [...group].sort((a, b) => Number(b.reviewDecision?.action === "select-authoritative") - Number(a.reviewDecision?.action === "select-authoritative") || Number(b.runtime?.running) - Number(a.runtime?.running) || Number(Boolean(b.link)) - Number(Boolean(a.link)) || Number(Boolean(b.metadata?.liveRevision)) - Number(Boolean(a.metadata?.liveRevision)));
ranked[0].authoritative = true;
for (const duplicate of ranked.slice(1)) {
duplicate.authoritative = false;
duplicate.classification = { type: "duplicate", reason: `Conflicts with authoritative workload ${ranked[0].workloadId}`, authoritativeWorkloadId: ranked[0].workloadId };
duplicate.status = "duplicate";
duplicate.shadowedLink = duplicate.link;
duplicate.link = null;
}
}
return result;
}
module.exports = { classifyInventory, classifyWorkload: baseClassification, inventoryPathPatterns: { BACKUP, RELEASE, STAGING, TEMPORARY, SYSTEM } };
+31
View File
@@ -0,0 +1,31 @@
"use strict";
const crypto = require("node:crypto");
const ACTIONS = new Set(["keep-link", "select-authoritative", "mark-historical", "archive-link", "monitor-only", "exclude-scan-root", "manual-link", "ignore", "manual-exclude"]);
class InventoryReviewService {
constructor({ store, audit = null }) { this.store = store; this.audit = audit; }
list(serverId) { return this.store.getInventoryReviewDecisions(serverId); }
preview({ serverId, workload, action, reason = "", repositoryFullName = null }) {
if (!ACTIONS.has(action)) throw Object.assign(new Error("Unsupported inventory review action."), { code: "INVENTORY_REVIEW_ACTION_INVALID" });
if (["ignore", "manual-exclude", "exclude-scan-root"].includes(action) && String(reason).trim().length < 5) throw Object.assign(new Error("A meaningful review reason is required."), { code: "INVENTORY_REVIEW_REASON_REQUIRED" });
if (action === "manual-link" && !repositoryFullName) throw Object.assign(new Error("Select the repository to link."), { code: "INVENTORY_REVIEW_REPOSITORY_REQUIRED" });
const linkedProfile = workload.link?.profileId && workload.link?.repositoryFullName ? { profileId: workload.link.profileId, repositoryFullName: workload.link.repositoryFullName } : null;
const configurationChanges = [`Persist review decision ${action} for workload ${workload.workloadId}`];
if (action === "archive-link" && linkedProfile) configurationChanges.push(`Archive deployment profile ${linkedProfile.profileId}`);
if (action === "manual-link") configurationChanges.push(`Remember ${repositoryFullName} as the reviewed repository match; use Save environment to create the deployment profile`);
const mutation = { serverId, workloadId: workload.workloadId, evidenceHash: workload.evidenceHash, action, reason: String(reason).trim(), repositoryFullName, linkedProfile, classification: workload.classification?.type || workload.status, containersUnaffected: true, configurationChanges, recovery: "Restore the configuration snapshot or rescan after evidence changes." };
return { ...mutation, id: crypto.createHash("sha256").update(JSON.stringify(mutation)).digest("hex") };
}
async apply({ plan, expectedPlanId }) {
if (!expectedPlanId || plan.id !== expectedPlanId) throw Object.assign(new Error("Inventory review requires the exact preview plan."), { code: expectedPlanId ? "INVENTORY_REVIEW_PLAN_STALE" : "INVENTORY_REVIEW_PLAN_REQUIRED" });
const snapshot = await this.store.createRecoverySnapshot?.(`inventory-review:${plan.serverId}:${plan.workloadId}`);
if (plan.action === "archive-link" && plan.linkedProfile) await this.store.deleteDeploymentProfile(plan.linkedProfile.repositoryFullName, plan.linkedProfile.profileId);
const decision = await this.store.saveInventoryReviewDecision(plan.serverId, { workloadId: plan.workloadId, evidenceHash: plan.evidenceHash, action: plan.action, reason: plan.reason, repositoryFullName: plan.repositoryFullName || null, classification: plan.classification, decidedAt: new Date().toISOString() });
await this.audit?.append?.("deployment.inventory-review-applied", { serverId: plan.serverId, workloadId: plan.workloadId, action: plan.action, evidenceHash: plan.evidenceHash, snapshot: snapshot?.filePath || null });
return { decision, snapshot };
}
}
module.exports = { InventoryReviewService, INVENTORY_REVIEW_ACTIONS: [...ACTIONS] };
+46 -626
View File
@@ -1,82 +1,25 @@
"use strict"; "use strict";
const path = require("node:path"); const path = require("node:path");
const fs = require("node:fs/promises"); const fs = require("node:fs/promises");
const { fileURLToPath } = require("node:url"); const { dialog, shell, app } = require("electron");
const { ipcMain, dialog, shell, app } = require("electron");
const { matchRemoteToRepository } = require("../shared/repository-match.cjs"); const { matchRemoteToRepository } = require("../shared/repository-match.cjs");
const { const {
cloneDirectoryName, cloneDirectoryName,
resolveCloneTarget, resolveCloneTarget,
} = require("../shared/clone-target.cjs"); } = require("../shared/clone-target.cjs");
const {
createChannelRegistrar,
assertTrustedSender,
toErrorPayload,
} = require("./ipc/channel.cjs");
const { registerRepositoryIpc } = require("./ipc/repository-handlers.cjs");
const { registerDeploymentIpc } = require("./ipc/deployment-handlers.cjs");
const { registerOperationsIpc } = require("./ipc/operations-handlers.cjs");
const { const {
createEncryptedBackup, createEncryptedBackup,
readEncryptedBackup, readEncryptedBackup,
} = require("./configuration-backup.cjs"); } = require("./configuration-backup.cjs");
const { evaluateDeploymentPolicy } = require("../shared/deployment-policy.cjs"); const { evaluateDeploymentPolicy } = require("../shared/deployment-policy.cjs");
let diagnosticsService = null;
const TRUSTED_RENDERER_PATH = path.resolve(
__dirname,
"..",
"renderer",
"index.html",
);
function toErrorPayload(error) {
return {
message: error?.message || "Unknown error",
code: error?.code || null,
status: error?.status || null,
recoverable: Boolean(error?.recoverable),
commitSha: error?.commitSha || null,
};
}
function assertTrustedSender(event) {
const url = event?.senderFrame?.url || event?.sender?.getURL?.() || "";
try {
const parsed = new URL(url);
if (parsed.protocol !== "file:") throw new Error("not a file URL");
const senderPath = path.resolve(fileURLToPath(parsed));
const normalize = (value) =>
process.platform === "win32" ? value.toLowerCase() : value;
if (normalize(senderPath) !== normalize(TRUSTED_RENDERER_PATH))
throw new Error("unexpected renderer file");
} catch {
throw new Error("Rejected IPC request from an untrusted renderer origin.");
}
}
function register(channel, handler) {
ipcMain.handle(channel, async (event, payload) => {
const started = Date.now();
try {
assertTrustedSender(event);
const data = await handler(payload || {}, event);
await diagnosticsService?.debug("ipc.completed", {
channel,
durationMs: Date.now() - started,
});
return { ok: true, data };
} catch (error) {
await diagnosticsService?.error("ipc.failed", {
channel,
durationMs: Date.now() - started,
error: {
name: error?.name,
message: error?.message,
code: error?.code,
status: error?.status,
stack: error?.stack,
},
});
console.error(`[${channel}]`, error);
return { ok: false, error: toErrorPayload(error) };
}
});
}
function registerIpc({ function registerIpc({
store, store,
git, git,
@@ -84,16 +27,19 @@ function registerIpc({
repositories, repositories,
deployments, deployments,
unraid, unraid,
deployKeys,
inventoryReviews,
ssh, ssh,
updates, updates,
preflight, preflight,
gitValidator,
diagnostics, diagnostics,
audit, audit,
externalTools, externalTools,
monitor, monitor,
onPreferencesChanged, onPreferencesChanged,
}) { }) {
diagnosticsService = diagnostics; const register = createChannelRegistrar(diagnostics);
const repositoryMutations = new Map(); const repositoryMutations = new Map();
const withRepositoryPause = async (localPath, action) => { const withRepositoryPause = async (localPath, action) => {
monitor?.pause(localPath); monitor?.pause(localPath);
@@ -159,8 +105,11 @@ function registerIpc({
await repositories.refresh(); await repositories.refresh();
knownPaths = repositories.getWatchPaths(); knownPaths = repositories.getWatchPaths();
} }
const canonicalKnown = await Promise.all(knownPaths.map(canonicalPath)); // Watch paths are already canonical, so re-resolving all of them on every
if (!canonicalKnown.some((known) => known === candidate)) // guarded call is only needed when the cheap comparison finds no match.
const matched = knownPaths.some((known) => path.resolve(known) === candidate)
|| (await Promise.all(knownPaths.map(canonicalPath))).some((known) => known === candidate);
if (!matched)
throw new Error( throw new Error(
"The requested local repository is not linked or discovered by ForgeFlow.", "The requested local repository is not linked or discovered by ForgeFlow.",
); );
@@ -170,9 +119,7 @@ function registerIpc({
const resolveRepository = async (repositoryPayload) => { const resolveRepository = async (repositoryPayload) => {
const fullName = String(repositoryPayload?.fullName || "").trim(); const fullName = String(repositoryPayload?.fullName || "").trim();
if (!fullName) throw new Error("Repository identity is required."); if (!fullName) throw new Error("Repository identity is required.");
const current = (await repositories.refresh()).find( const current = await repositories.resolveByFullName(fullName);
(item) => item.fullName === fullName,
);
if (!current) if (!current)
throw new Error( throw new Error(
"The repository is no longer available through the configured Gitea account.", "The repository is no longer available through the configured Gitea account.",
@@ -449,6 +396,7 @@ function registerIpc({
register( register(
"server:save", "server:save",
async ({ server, password = "", passphrase = "" }) => { async ({ server, password = "", passphrase = "" }) => {
await ssh.validateServerConfiguration(server, { password, passphrase });
const saved = await store.saveServer(server, { password, passphrase }); const saved = await store.saveServer(server, { password, passphrase });
await diagnostics.info("server.saved", { await diagnostics.info("server.saved", {
serverId: saved.id, serverId: saved.id,
@@ -467,13 +415,25 @@ function registerIpc({
await diagnostics.info("server.deleted", { serverId }); await diagnostics.info("server.deleted", { serverId });
return store.getPublicState(); return store.getPublicState();
}); });
register("server:test", async ({ serverId }) => { register("server:test", async ({ serverId, expectedFingerprint = "" }) => {
const server = store.getServer(serverId); const server = store.getServer(serverId);
if (!server) throw new Error("The configured server no longer exists."); if (!server) throw new Error("The configured server no longer exists.");
const expected = String(expectedFingerprint || "").trim();
if (!server.hostFingerprint && !expected) {
const probe = await ssh.probeHostFingerprint(serverId);
return { ...probe, connected: false, needsTrust: true, state: store.getPublicState() };
}
if (!server.hostFingerprint && !/^SHA256:[A-Za-z0-9+/]{40,44}$/.test(expected))
throw new Error("Confirm the exact SSH host fingerprint returned by ForgeFlow.");
const result = await ssh.test(serverId, { const result = await ssh.test(serverId, {
trustOnFirstUse: !server.hostFingerprint, expectedFingerprint: server.hostFingerprint ? null : expected,
}); });
if (!server.hostFingerprint) { if (!server.hostFingerprint) {
if (result.fingerprint !== expected) {
const error = new Error("The SSH host identity changed between preview and confirmation.");
error.code = "SSH_HOST_KEY_MISMATCH";
throw error;
}
await store.saveServer( await store.saveServer(
{ ...server, hostFingerprint: result.fingerprint }, { ...server, hostFingerprint: result.fingerprint },
{}, {},
@@ -498,347 +458,11 @@ function registerIpc({
}), }),
); );
register("repositories:refresh", async () => { registerRepositoryIpc({
const result = await repositories.refresh(); register, repositories, store, git, gitea, monitor, diagnostics, audit,
monitor?.setPaths(repositories.getWatchPaths()); externalTools, gitValidator, withRepositoryMutation, assertKnownRepositoryPath,
return result; resolveRepository, cloneRepositoryInto, cloneDirectoryName,
}); matchRemoteToRepository, shell, dialog,
register("repositories:discover", async ({ roots }) => {
const paths = await repositories.discoverAll(
roots || store.data.workspaceRoots,
);
return repositories.getLocalDescriptors(paths);
});
register("repository:favorite", async ({ fullName, favorite }) =>
store.setFavorite(fullName, favorite),
);
register("repository:link", async ({ fullName, localPath }) => {
await git.ensureRepository(localPath);
const remoteUrl = await git.getRemoteUrl(localPath).catch(() => "");
if (
!remoteUrl ||
!matchRemoteToRepository(remoteUrl, [{ full_name: fullName }])
) {
throw new Error(
`The selected folder's origin does not match ${fullName}.`,
);
}
await store.saveMapping(fullName, localPath);
await diagnostics.info("repository.linked", { fullName, localPath });
const result = await repositories.refresh();
monitor?.setPaths(repositories.getWatchPaths());
return result;
});
register("repository:unlink", async ({ fullName }) => {
await store.removeMapping(fullName);
await diagnostics.info("repository.unlinked", { fullName });
const result = await repositories.refresh();
monitor?.setPaths(repositories.getWatchPaths());
return result;
});
register("repository:status", async ({ localPath }) =>
git.status(await assertKnownRepositoryPath(localPath)),
);
register("repository:diff", async ({ localPath, filePath, staged }) =>
git.diff(await assertKnownRepositoryPath(localPath), filePath, staged),
);
register("repository:diff-hunks", async ({ localPath, filePath }) =>
git.diffHunks(await assertKnownRepositoryPath(localPath), filePath),
);
register(
"repository:stage-hunks",
async ({ localPath, filePath, hunkIndexes }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.stageHunks(safePath, filePath, hunkIndexes),
);
},
);
register("repository:conflicts", async ({ localPath }) =>
git.conflictState(await assertKnownRepositoryPath(localPath)),
);
register(
"repository:resolve-conflict",
async ({ localPath, filePath, resolution }) => {
const safePath = await assertKnownRepositoryPath(localPath);
const result = await withRepositoryMutation(safePath, () =>
git.resolveConflict(safePath, filePath, resolution),
);
await audit.append("git.conflict.resolved", {
localPath: safePath,
filePath,
resolution,
});
return result;
},
);
register("repository:continue-operation", async ({ localPath }) => {
const safePath = await assertKnownRepositoryPath(localPath);
const result = await withRepositoryMutation(safePath, () =>
git.continueInterruptedOperation(safePath),
);
await audit.append("git.operation.continued", { localPath: safePath });
return result;
});
register("repository:abort-operation", async ({ localPath }) => {
const safePath = await assertKnownRepositoryPath(localPath);
const result = await withRepositoryMutation(safePath, () =>
git.abortInterruptedOperation(safePath),
);
await audit.append("git.operation.aborted", {
localPath: safePath,
operation: result.aborted,
});
return result;
});
register("repository:stage", async ({ localPath, files }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () => git.stage(safePath, files));
});
register("repository:unstage", async ({ localPath, files }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () => git.unstage(safePath, files));
});
register("repository:commit", async ({ localPath, message, files }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.commit(safePath, message, files),
);
});
register("repository:commit-staged", async ({ localPath, message }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.commitStaged(safePath, message),
);
});
register("repository:commit-staged-push", async ({ localPath, message }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.commitStagedAndPush(safePath, message),
);
});
register("repository:commit-push", async ({ localPath, message, files }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.commitAndPush(safePath, message, files),
);
});
register("repository:push", async ({ localPath }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () => git.push(safePath));
});
register("repository:fetch", async ({ localPath }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () => git.fetch(safePath));
});
register("repository:pull", async ({ localPath }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.pullFastForward(safePath),
);
});
register("repository:history", async ({ localPath, limit }) =>
git.history(await assertKnownRepositoryPath(localPath), limit),
);
register("repository:branch-protection", async ({ fullName, branch }) => {
const repository = await resolveRepository({ fullName });
return gitea.getBranchProtection(
repository.owner.login,
repository.name,
branch ||
repository.localStatus?.branch?.head ||
repository.defaultBranch,
);
});
register("repository:pull-requests", async ({ fullName, state = "open" }) => {
const repository = await resolveRepository({ fullName });
return gitea.listPullRequests({
owner: repository.owner.login,
repo: repository.name,
state,
});
});
register(
"repository:create-pull-request",
async ({ fullName, title, body, base }) => {
const repository = await resolveRepository({ fullName });
if (!repository.localPath || !repository.localStatus?.clean)
throw new Error(
"A clean linked repository is required before creating a pull request.",
);
const head = repository.localStatus.branch?.head;
if (!head || !repository.localStatus.branch?.upstream)
throw new Error(
"Publish the current branch before creating a pull request.",
);
if (repository.localStatus.branch.ahead > 0)
throw new Error(
"Push all local commits before creating a pull request.",
);
const pullRequest = await gitea.createPullRequest({
owner: repository.owner.login,
repo: repository.name,
head,
base: base || repository.defaultBranch,
title,
body,
});
await audit.append("pull-request.created", {
repository: repository.fullName,
number: pullRequest.number,
head,
base: base || repository.defaultBranch,
url: pullRequest.html_url,
});
return pullRequest;
},
);
register("repository:branches", async ({ localPath }) =>
git.branches(await assertKnownRepositoryPath(localPath)),
);
register("repository:checkout-branch", async ({ localPath, branch }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.checkoutBranch(safePath, branch),
);
});
register("repository:create-branch", async ({ localPath, branch }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.createBranch(safePath, branch),
);
});
register("repository:stash", async ({ localPath, message }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () => git.stash(safePath, message));
});
register("repository:stash-list", async ({ localPath }) =>
git.stashList(await assertKnownRepositoryPath(localPath)),
);
register("repository:stash-pop", async ({ localPath, ref }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () => git.popStash(safePath, ref));
});
register("repository:index-lock", async ({ localPath }) =>
git.getIndexLockInfo(await assertKnownRepositoryPath(localPath)),
);
register("repository:git-recovery-status", async ({ localPath }) =>
git.reconcile(await assertKnownRepositoryPath(localPath)),
);
register("repository:repair-index-lock", async ({ localPath }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.removeStaleIndexLock(safePath),
);
});
register(
"repository:repair-git-locks",
async ({ localPath, force = false }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.repairStaleGitLocks(safePath, {
minimumAgeMs: force ? 0 : 10_000,
allowWithoutProcessProbe: force === true,
}),
);
},
);
register("repository:reconcile", async ({ localPath }) =>
git.reconcile(await assertKnownRepositoryPath(localPath)),
);
register("repository:repair-sync", async ({ localPath, strategy }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.repairSync(safePath, strategy),
);
});
register("repository:set-origin", async ({ localPath, remoteUrl }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.setRemoteUrl(safePath, remoteUrl),
);
});
register("repositories:normalize-origins", async () => {
const current = await repositories.refresh();
const changes = [];
for (const repository of current) {
if (!repository.localPath || !repository.sshUrl) continue;
const actual = await git
.getRemoteUrl(repository.localPath)
.catch(() => "");
if (actual === repository.sshUrl) continue;
await withRepositoryMutation(repository.localPath, () =>
git.setRemoteUrl(repository.localPath, repository.sshUrl),
);
changes.push({
fullName: repository.fullName,
previous: actual,
next: repository.sshUrl,
});
}
const refreshed = await repositories.refresh();
monitor?.setPaths(repositories.getWatchPaths());
await diagnostics.info("repositories.origins.normalized", {
count: changes.length,
changes,
});
return { changes, repositories: refreshed };
});
register("repository:clone", async ({ fullName, mode = "default" }) => {
if (!["default", "custom"].includes(mode))
throw new Error("Unsupported clone location mode.");
let projectRoot = store.data.workspaceRoots[0] || null;
if (mode === "custom" || !projectRoot) {
const result = await dialog.showOpenDialog({
title: `Choose a project root for ${String(fullName || "repository")}`,
defaultPath: projectRoot || undefined,
buttonLabel: "Use this project root",
properties: ["openDirectory", "createDirectory"],
});
if (result.canceled || !result.filePaths[0]) return { cancelled: true };
projectRoot = result.filePaths[0];
}
return cloneRepositoryInto(fullName, projectRoot);
});
register("repository:open-path", async ({ localPath }) => {
const safePath = await assertKnownRepositoryPath(localPath);
const error = await shell.openPath(safePath);
if (error) throw new Error(error);
return true;
});
register(
"repository:open-editor",
async ({ localPath, filePath = "", line = 1 }) =>
externalTools.launch(
"editor",
await assertKnownRepositoryPath(localPath),
filePath,
line,
),
);
register("repository:open-terminal", async ({ localPath }) =>
externalTools.launch(
"terminal",
await assertKnownRepositoryPath(localPath),
),
);
register("external:open", async ({ url }) => {
const parsed = new URL(url);
if (!["http:", "https:"].includes(parsed.protocol))
throw new Error("Only HTTP and HTTPS links can be opened.");
await shell.openExternal(parsed.toString());
return true;
}); });
register("troubleshooter:scan", async ({ fullName = null }) => { register("troubleshooter:scan", async ({ fullName = null }) => {
@@ -1062,218 +686,14 @@ function registerIpc({
return results; return results;
}); });
register("deployment:save-profile", async ({ fullName, profile }) => { registerDeploymentIpc({
const saved = await store.saveDeploymentProfile(fullName, profile); register, store, resolveRepository, unraid, deployments, evaluateDeploymentPolicy,
await diagnostics.info("deployment.profile.saved", { audit, deployKeys, repositories, inventoryReviews, diagnostics, git, gitea, ssh,
repository: fullName, preflight,
profile: saved,
});
return { profile: saved, state: store.getPublicState() };
}); });
register("deployment:delete-profile", async ({ fullName, profileId }) => { registerOperationsIpc({
const profiles = await store.deleteDeploymentProfile(fullName, profileId); register, store, unraid, deployments, diagnostics, shell, dialog, path, app,
await diagnostics.info("deployment.profile.deleted", { repositories, preflight, monitor,
repository: fullName,
profileId,
});
return { profiles, state: store.getPublicState() };
});
register("deployment:preflight", async ({ repository, profileId }) => {
const current = await resolveRepository(repository);
const profile = store.getDeploymentProfile(current.fullName, profileId);
if (profile?.provider === "ssh-unraid")
return unraid.preflight({ repository: current, profileId });
return preflight.runDeployment({ repository: current, profileId });
});
register(
"deployment:dispatch",
async ({
repository,
profileId,
sha,
note = "",
override = false,
overrideReason = "",
}) => {
const current = await resolveRepository(repository);
const profile = store.getDeploymentProfile(current.fullName, profileId);
const policy = evaluateDeploymentPolicy(profile, {
note,
override,
reason: overrideReason,
});
await audit.append("deployment.requested", {
repository: current.fullName,
profileId,
sha,
note: policy.note,
overridden: policy.overridden,
overrideReason: policy.reason,
});
const operation =
profile?.provider === "ssh-unraid"
? await unraid.deploy({ repository: current, profileId, sha })
: await deployments.deploy({ repository: current, profileId, sha });
if (operation?.id)
await store.addOperation({
...operation,
releaseNote: policy.note,
policyOverride: policy.overridden
? { reason: policy.reason, violations: policy.violations }
: null,
});
return operation;
},
);
register(
"deployment:rollback",
async ({ repository, profileId, targetSha }) => {
const current = await resolveRepository(repository);
const profile = store.getDeploymentProfile(current.fullName, profileId);
if (profile?.provider === "ssh-unraid")
return unraid.rollback({ repository: current, profileId, targetSha });
return deployments.rollback({
repository: current,
profileId,
targetSha,
});
},
);
register("deployment:health", ({ url }) => deployments.checkHealth(url));
register("deployment:profile-state", ({ fullName, profileId }) => {
const profile = store.getDeploymentProfile(fullName, profileId);
if (profile?.provider === "ssh-unraid")
return unraid.refreshProfileState(fullName, profileId);
return deployments.refreshProfileState(fullName, profileId);
});
register(
"deployment:apply-dockerman-metadata",
async ({ repository, profileId }) => {
const current = await resolveRepository(repository);
return unraid.applyDockerManMetadata({ repository: current, profileId });
},
);
register("deployment:reconcile", async ({ fullName, profileId }) => {
const profile = store.getDeploymentProfile(fullName, profileId);
if (profile?.provider !== "ssh-unraid")
return deployments.refreshProfileState(fullName, profileId);
const [owner, repo] = String(fullName || "").split("/");
const branch = await gitea.getBranch(owner, repo, profile.branch);
const giteaSha =
branch?.commit?.id ||
branch?.commit?.sha ||
branch?.commit?.commit?.id ||
null;
const state = await unraid.refreshProfileState(
fullName,
profileId,
giteaSha,
);
const operations = store.data.operations.filter(
(item) =>
item.profileId === profileId &&
item.provider === "ssh-unraid" &&
!["success", "failed", "cancelled", "rolled-back"].includes(
item.status,
),
);
for (const operation of operations)
await unraid.refreshOperation(operation.id);
return {
state,
operations: await unraid.reconcileRecordedOperations(profileId, state),
};
});
register("operations:refresh", async ({ operationId }) => {
if (operationId) {
const operation = store.getOperation(operationId);
if (operation?.provider === "ssh-unraid")
return unraid.refreshOperation(operationId);
return deployments.refreshOperation(operationId);
}
const [actions, sshOperations] = await Promise.all([
deployments.refreshActiveOperations(),
unraid.refreshActiveOperations(),
]);
return [...actions, ...sshOperations];
});
register("operations:get", ({ operationId }) =>
store.getOperation(operationId),
);
register("diagnostics:status", () => diagnostics.getStatus());
register("diagnostics:clear", () => diagnostics.clear());
register("diagnostics:open-folder", async () => {
const error = await shell.openPath(diagnostics.logDirectory);
if (error) throw new Error(error);
return true;
});
register("diagnostics:export", async ({ privacyMode = "standard" }) => {
if (!["standard", "strict"].includes(privacyMode))
throw new Error("Unsupported diagnostic privacy mode.");
const result = await dialog.showSaveDialog({
title: "Export ForgeFlow diagnostic bundle",
defaultPath: path.join(
app.getPath("downloads"),
`ForgeFlow-Diagnostics-${new Date().toISOString().replace(/[:.]/g, "-")}.zip`,
),
filters: [{ name: "ZIP archive", extensions: ["zip"] }],
});
if (result.canceled || !result.filePath) return null;
const repositoryState = await repositories.refresh().catch((error) => {
diagnostics.warning("diagnostics.repository-snapshot.failed", error);
return [];
});
const systemPreflight = await preflight
.runSystem()
.catch((error) => ({ error: error.message }));
const destinationPath =
path.extname(result.filePath).toLowerCase() === ".zip"
? result.filePath
: `${result.filePath}.zip`;
return diagnostics.exportSupportBundle({
destinationPath,
publicState: store.getPublicState(),
repositories: repositoryState,
operations: store.data.operations,
preflight: systemPreflight,
privacyMode,
extra: {
appVersion: app.getVersion(),
setupComplete: store.data.setupComplete,
},
});
});
register("diagnostics:show-bundle", async ({ filePath }) => {
if (!diagnostics.isKnownBundlePath(filePath))
throw new Error(
"Only the most recently generated support bundle can be revealed.",
);
shell.showItemInFolder(filePath);
return true;
});
register(
"renderer:report",
async ({ level = "info", event = "renderer.event", details = {} }) => {
const method = ["debug", "info", "warning", "error"].includes(level)
? level
: "info";
await diagnostics[method](
`renderer.${String(event || "event").slice(0, 120)}`,
details,
);
return true;
},
);
register("app:reset", async () => {
await diagnostics.info("app.reset.requested", {});
store.data = store.migrate({});
store.sessionToken = null;
await store.save();
monitor?.setPaths([]);
monitor?.restart();
return store.getPublicState();
}); });
} }
+77
View File
@@ -0,0 +1,77 @@
"use strict";
const path = require("node:path");
const { fileURLToPath } = require("node:url");
const { ipcMain } = require("electron");
const TRUSTED_RENDERER_PATH = path.resolve(
__dirname,
"..",
"..",
"renderer",
"index.html",
);
function toErrorPayload(error) {
return {
message: error?.message || "Unknown error",
code: error?.code || null,
status: error?.status || null,
recoverable: Boolean(error?.recoverable),
commitSha: error?.commitSha || null,
};
}
function assertTrustedSender(event) {
const url = event?.senderFrame?.url || event?.sender?.getURL?.() || "";
try {
const parsed = new URL(url);
if (parsed.protocol !== "file:") throw new Error("not a file URL");
const senderPath = path.resolve(fileURLToPath(parsed));
const normalize = (value) =>
process.platform === "win32" ? value.toLowerCase() : value;
if (normalize(senderPath) !== normalize(TRUSTED_RENDERER_PATH))
throw new Error("unexpected renderer file");
} catch {
throw new Error("Rejected IPC request from an untrusted renderer origin.");
}
}
// Built per registerIpc() call so the diagnostics sink is an argument instead of
// module-level mutable state that every handler silently depends on.
function createChannelRegistrar(diagnostics) {
return function register(channel, handler) {
ipcMain.handle(channel, async (event, payload) => {
const started = Date.now();
try {
assertTrustedSender(event);
const data = await handler(payload || {}, event);
await diagnostics?.debug("ipc.completed", {
channel,
durationMs: Date.now() - started,
});
return { ok: true, data };
} catch (error) {
await diagnostics?.error("ipc.failed", {
channel,
durationMs: Date.now() - started,
error: {
name: error?.name,
message: error?.message,
code: error?.code,
status: error?.status,
stack: error?.stack,
},
});
return { ok: false, error: toErrorPayload(error) };
}
});
};
}
module.exports = {
createChannelRegistrar,
assertTrustedSender,
toErrorPayload,
TRUSTED_RENDERER_PATH,
};
+285
View File
@@ -0,0 +1,285 @@
"use strict";
function registerDeploymentIpc({
register, store, resolveRepository, unraid, deployments, evaluateDeploymentPolicy,
audit, deployKeys, repositories, inventoryReviews, diagnostics, git, gitea, ssh,
preflight,
}) {
register("deployment:save-profile", async ({ fullName, profile }) => {
const saved = await store.saveDeploymentProfile(fullName, profile);
await diagnostics.info("deployment.profile.saved", {
repository: fullName,
profile: saved,
});
return { profile: saved, state: store.getPublicState() };
});
register("deployment:delete-profile", async ({ fullName, profileId }) => {
const profiles = await store.deleteDeploymentProfile(fullName, profileId);
await diagnostics.info("deployment.profile.deleted", {
repository: fullName,
profileId,
});
return { profiles, state: store.getPublicState() };
});
register("deployment:preflight", async ({ repository, profileId }) => {
const current = await resolveRepository(repository);
const profile = store.getDeploymentProfile(current.fullName, profileId);
if (profile?.provider === "ssh-unraid")
return unraid.preflight({ repository: current, profileId });
return preflight.runDeployment({ repository: current, profileId });
});
register("deployment:repair-write-access", async ({ repository, profileId }) => {
const current = await resolveRepository(repository);
const profile = store.getDeploymentProfile(current.fullName, profileId);
if (profile?.provider !== "ssh-unraid")
throw new Error("Write-access repair is available only for SSH / Unraid deployment profiles.");
const result = await unraid.repairWriteAccess({ repository: current, profileId });
await audit.append("deployment.write-access.repaired", {
repository: current.fullName,
profileId,
changed: result.changed,
remotePath: result.after?.remotePath || result.before?.remotePath || null,
});
return result;
});
register(
"deployment:dispatch",
async ({
repository,
profileId,
sha,
note = "",
override = false,
overrideReason = "",
}) => {
const current = await resolveRepository(repository);
const profile = store.getDeploymentProfile(current.fullName, profileId);
const policy = evaluateDeploymentPolicy(profile, {
note,
override,
reason: overrideReason,
});
await audit.append("deployment.requested", {
repository: current.fullName,
profileId,
sha,
note: policy.note,
overridden: policy.overridden,
overrideReason: policy.reason,
});
const operation =
profile?.provider === "ssh-unraid"
? await unraid.deploy({ repository: current, profileId, sha })
: await deployments.deploy({ repository: current, profileId, sha });
if (operation?.id)
await store.addOperation({
...operation,
releaseNote: policy.note,
policyOverride: policy.overridden
? { reason: policy.reason, violations: policy.violations }
: null,
});
return operation;
},
);
register(
"deployment:rollback",
async ({ repository, profileId, targetSha }) => {
const current = await resolveRepository(repository);
const profile = store.getDeploymentProfile(current.fullName, profileId);
if (profile?.provider === "ssh-unraid")
return unraid.rollback({ repository: current, profileId, targetSha });
return deployments.rollback({
repository: current,
profileId,
targetSha,
});
},
);
register("deployment:health", ({ url }) => deployments.checkHealth(url));
register("deployment:link-server-workload", async ({ repository, serverId, workloadId, deploymentMode = "server-git", remoteFolder = "" }) => {
const current = await resolveRepository(repository);
const result = await unraid.linkServerWorkload({
repository: current,
serverId,
workloadId,
deploymentMode,
remoteFolder,
});
return { ...result, state: store.getPublicState() };
});
register("deployment:configure-server-git-access", async ({ repository, profileId }) => {
const current = await resolveRepository(repository);
const result = await unraid.configureServerGitAccess({ repository: current, profileId });
await audit.append("deployment.server-git-access-configured", {
repository: current.fullName,
profileId,
keyFingerprint: result.keyFingerprint,
hostFingerprint: result.hostFingerprint,
});
return { ...result, state: store.getPublicState() };
});
register("deployment:verify-server-git-profile", async ({ repository, profileId }) => {
const current = await resolveRepository(repository);
const result = await unraid.verifyServerGitProfile({ repository: current, profileId });
await audit.append("deployment.server-git-access-verified", {
repository: current.fullName,
profileId,
readiness: result.readiness,
ready: result.ready,
checkedAt: result.checkedAt,
});
return result;
});
register("deployment:deploy-key-inventory", async ({ repository, profileId }) => {
const current = await resolveRepository(repository);
return deployKeys.inventory({ repository: current, profileId });
});
register("deployment:plan-deploy-key-rotation", async ({ repository, profileId }) => {
const current = await resolveRepository(repository);
return deployKeys.planRotation({ repository: current, profileId });
});
register("deployment:apply-deploy-key-rotation", async ({ repository, profileId, planId }) => {
const current = await resolveRepository(repository);
const result = await deployKeys.rotate({ repository: current, profileId, expectedPlanId: planId });
return { ...result, state: store.getPublicState() };
});
register("deployment:plan-deploy-key-revocation", async ({ repository, profileId }) => {
const current = await resolveRepository(repository);
return deployKeys.planRevocation({ repository: current, profileId });
});
register("deployment:apply-deploy-key-revocation", async ({ repository, profileId, planId }) => {
const current = await resolveRepository(repository);
const result = await deployKeys.revoke({ repository: current, profileId, expectedPlanId: planId });
return { ...result, state: store.getPublicState() };
});
register("deployment:restore-deploy-key", async ({ repository, profileId }) => {
const current = await resolveRepository(repository);
const result = await deployKeys.restore({ repository: current, profileId });
return { ...result, state: store.getPublicState() };
});
register("deployment:discover-server-workloads", async () => {
const repositoryList = await repositories.refresh();
const remoteRepositories = repositoryList.filter(
(repository) => repository.owner?.login !== "local",
);
const results = [];
for (const server of store.data.servers || []) {
try {
results.push(
await unraid.discoverServerWorkloads(server.id, remoteRepositories),
);
} catch (error) {
results.push({
serverId: server.id,
serverName: server.name,
detected: 0,
adopted: 0,
verified: 0,
linked: 0,
unmatched: 0,
needsReview: 0,
capabilities: {},
warnings: [],
workloads: [],
error: error.message,
});
}
}
return results;
});
register("deployment:plan-server-reconciliation", async ({ serverId }) => {
const repositoryList = await repositories.refresh();
const remoteRepositories = repositoryList.filter((repository) => repository.owner?.login !== "local");
const result = await unraid.planServerInventoryReconciliation(serverId, remoteRepositories, { autoLink: true });
await audit.append("deployment.server-reconciliation-planned", {
serverId,
planId: result.plan.id,
summary: result.plan.summary,
});
return result;
});
register("deployment:apply-server-reconciliation", async ({ serverId, planId }) => {
const repositoryList = await repositories.refresh();
const remoteRepositories = repositoryList.filter((repository) => repository.owner?.login !== "local");
const result = await unraid.reconcileServerInventory(serverId, remoteRepositories, { autoLink: true, expectedPlanId: planId });
await audit.append("deployment.server-reconciliation-applied", {
serverId,
planId,
adopted: result.adopted,
refreshed: result.refreshed,
retired: result.retired,
recoverySnapshot: result.recoverySnapshot?.filePath || null,
});
return { ...result, state: store.getPublicState() };
});
register("deployment:plan-inventory-review", async ({ serverId, workloadId, action, reason = "", repositoryFullName = null }) => {
const repositoryList = await repositories.refresh();
const inventory = await unraid.scanServerInventory(serverId, repositoryList.filter((item) => item.owner?.login !== "local"));
const workload = inventory.workloads.find((item) => item.workloadId === workloadId);
if (!workload) throw Object.assign(new Error("The workload changed or disappeared. Rescan before reviewing it."), { code: "INVENTORY_REVIEW_WORKLOAD_STALE" });
return inventoryReviews.preview({ serverId, workload, action, reason, repositoryFullName });
});
register("deployment:apply-inventory-review", async ({ serverId, workloadId, action, reason = "", repositoryFullName = null, planId }) => {
const repositoryList = await repositories.refresh();
const inventory = await unraid.scanServerInventory(serverId, repositoryList.filter((item) => item.owner?.login !== "local"));
const workload = inventory.workloads.find((item) => item.workloadId === workloadId);
if (!workload) throw Object.assign(new Error("The workload changed or disappeared. Rescan before applying the review."), { code: "INVENTORY_REVIEW_WORKLOAD_STALE" });
const plan = inventoryReviews.preview({ serverId, workload, action, reason, repositoryFullName });
const result = await inventoryReviews.apply({ plan, expectedPlanId: planId });
return { ...result, inventory: await unraid.scanServerInventory(serverId, repositoryList.filter((item) => item.owner?.login !== "local")), state: store.getPublicState() };
});
register("deployment:profile-state", async ({ fullName, profileId }) => {
const profile = store.getDeploymentProfile(fullName, profileId);
if (profile?.provider === "ssh-unraid") {
let giteaSha = null;
try {
const [owner, repo] = String(fullName || "").split("/");
const branch = await gitea.getBranch(owner, repo, profile.branch);
giteaSha = branch?.commit?.id || branch?.commit?.sha || null;
} catch {}
return unraid.refreshProfileState(fullName, profileId, giteaSha);
}
return deployments.refreshProfileState(fullName, profileId);
});
register(
"deployment:apply-dockerman-metadata",
async ({ repository, profileId }) => {
const current = await resolveRepository(repository);
return unraid.applyDockerManMetadata({ repository: current, profileId });
},
);
register("deployment:reconcile", async ({ fullName, profileId }) => {
const profile = store.getDeploymentProfile(fullName, profileId);
if (profile?.provider !== "ssh-unraid")
return deployments.refreshProfileState(fullName, profileId);
const [owner, repo] = String(fullName || "").split("/");
const branch = await gitea.getBranch(owner, repo, profile.branch);
const giteaSha =
branch?.commit?.id ||
branch?.commit?.sha ||
branch?.commit?.commit?.id ||
null;
const state = await unraid.refreshProfileState(
fullName,
profileId,
giteaSha,
);
const operations = store.data.operations.filter(
(item) =>
item.profileId === profileId &&
item.provider === "ssh-unraid" &&
!["success", "failed", "cancelled", "rolled-back"].includes(
item.status,
),
);
for (const operation of operations)
await unraid.refreshOperation(operation.id);
return {
state,
operations: await unraid.reconcileRecordedOperations(profileId, state),
};
});
}
module.exports = { registerDeploymentIpc };
+100
View File
@@ -0,0 +1,100 @@
"use strict";
function registerOperationsIpc({
register, store, unraid, deployments, diagnostics, shell, dialog, path, app,
repositories, preflight, monitor,
}) {
register("operations:refresh", async ({ operationId }) => {
if (operationId) {
const operation = store.getOperation(operationId);
if (operation?.provider === "ssh-unraid")
return unraid.refreshOperation(operationId);
return deployments.refreshOperation(operationId);
}
const [actions, sshOperations] = await Promise.all([
deployments.refreshActiveOperations(),
unraid.refreshActiveOperations(),
]);
return [...actions, ...sshOperations];
});
register("operations:get", ({ operationId }) =>
store.getOperation(operationId),
);
register("diagnostics:status", () => diagnostics.getStatus());
register("diagnostics:clear", () => diagnostics.clear());
register("diagnostics:open-folder", async () => {
const error = await shell.openPath(diagnostics.logDirectory);
if (error) throw new Error(error);
return true;
});
register("diagnostics:export", async ({ privacyMode = "standard" }) => {
if (!["standard", "strict"].includes(privacyMode))
throw new Error("Unsupported diagnostic privacy mode.");
const result = await dialog.showSaveDialog({
title: "Export ForgeFlow diagnostic bundle",
defaultPath: path.join(
app.getPath("downloads"),
`ForgeFlow-Diagnostics-${new Date().toISOString().replace(/[:.]/g, "-")}.zip`,
),
filters: [{ name: "ZIP archive", extensions: ["zip"] }],
});
if (result.canceled || !result.filePath) return null;
const repositoryState = await repositories.refresh().catch((error) => {
diagnostics.warning("diagnostics.repository-snapshot.failed", error);
return [];
});
const systemPreflight = await preflight
.runSystem()
.catch((error) => ({ error: error.message }));
const destinationPath =
path.extname(result.filePath).toLowerCase() === ".zip"
? result.filePath
: `${result.filePath}.zip`;
return diagnostics.exportSupportBundle({
destinationPath,
publicState: store.getPublicState(),
repositories: repositoryState,
operations: store.data.operations,
preflight: systemPreflight,
privacyMode,
extra: {
appVersion: app.getVersion(),
setupComplete: store.data.setupComplete,
},
});
});
register("diagnostics:show-bundle", async ({ filePath }) => {
if (!diagnostics.isKnownBundlePath(filePath))
throw new Error(
"Only the most recently generated support bundle can be revealed.",
);
shell.showItemInFolder(filePath);
return true;
});
register(
"renderer:report",
async ({ level = "info", event = "renderer.event", details = {} }) => {
const method = ["debug", "info", "warning", "error"].includes(level)
? level
: "info";
await diagnostics[method](
`renderer.${String(event || "event").slice(0, 120)}`,
details,
);
return true;
},
);
register("app:reset", async () => {
await diagnostics.info("app.reset.requested", {});
store.data = store.migrate({});
store.sessionToken = null;
await store.save();
monitor?.setPaths([]);
monitor?.restart();
return store.getPublicState();
});
}
module.exports = { registerOperationsIpc };
+450
View File
@@ -0,0 +1,450 @@
"use strict";
function registerRepositoryIpc({
register, repositories, store, git, gitea, monitor, diagnostics, audit,
externalTools, gitValidator, withRepositoryMutation, assertKnownRepositoryPath,
resolveRepository, cloneRepositoryInto, cloneDirectoryName,
matchRemoteToRepository, shell, dialog,
}) {
register("repositories:refresh", async ({ force = false }) => {
const result = await repositories.refresh({ force: force === true });
monitor?.setPaths(repositories.getWatchPaths());
return result;
});
register("repositories:discover", async ({ roots }) => {
const paths = await repositories.discoverAll(
roots || store.data.workspaceRoots,
);
return repositories.getLocalDescriptors(paths);
});
register("repository:favorite", async ({ fullName, favorite }) =>
store.setFavorite(fullName, favorite),
);
register("repository:link", async ({ fullName, localPath }) => {
await git.ensureRepository(localPath);
const remoteUrl = await git.getRemoteUrl(localPath).catch(() => "");
if (
!remoteUrl ||
!matchRemoteToRepository(remoteUrl, [{ full_name: fullName }])
) {
throw new Error(
`The selected folder's origin does not match ${fullName}.`,
);
}
await store.saveMapping(fullName, localPath);
await diagnostics.info("repository.linked", { fullName, localPath });
const result = await repositories.refresh();
monitor?.setPaths(repositories.getWatchPaths());
return result;
});
register("repository:unlink", async ({ fullName }) => {
await store.removeMapping(fullName);
await diagnostics.info("repository.unlinked", { fullName });
const result = await repositories.refresh();
monitor?.setPaths(repositories.getWatchPaths());
return result;
});
register("repository:status", async ({ localPath }) =>
git.status(await assertKnownRepositoryPath(localPath)),
);
register("repository:diff", async ({ localPath, filePath, staged }) =>
git.diff(await assertKnownRepositoryPath(localPath), filePath, staged),
);
register("repository:diff-hunks", async ({ localPath, filePath }) =>
git.diffHunks(await assertKnownRepositoryPath(localPath), filePath),
);
register(
"repository:stage-hunks",
async ({ localPath, filePath, hunkIndexes }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.stageHunks(safePath, filePath, hunkIndexes),
);
},
);
register("repository:conflicts", async ({ localPath }) =>
git.conflictState(await assertKnownRepositoryPath(localPath)),
);
register(
"repository:resolve-conflict",
async ({ localPath, filePath, resolution }) => {
const safePath = await assertKnownRepositoryPath(localPath);
const result = await withRepositoryMutation(safePath, () =>
git.resolveConflict(safePath, filePath, resolution),
);
await audit.append("git.conflict.resolved", {
localPath: safePath,
filePath,
resolution,
});
return result;
},
);
register("repository:continue-operation", async ({ localPath }) => {
const safePath = await assertKnownRepositoryPath(localPath);
const result = await withRepositoryMutation(safePath, () =>
git.continueInterruptedOperation(safePath),
);
await audit.append("git.operation.continued", { localPath: safePath });
return result;
});
register("repository:abort-operation", async ({ localPath }) => {
const safePath = await assertKnownRepositoryPath(localPath);
const result = await withRepositoryMutation(safePath, () =>
git.abortInterruptedOperation(safePath),
);
await audit.append("git.operation.aborted", {
localPath: safePath,
operation: result.aborted,
});
return result;
});
register("repository:stage", async ({ localPath, files }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () => git.stage(safePath, files));
});
register("repository:unstage", async ({ localPath, files }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () => git.unstage(safePath, files));
});
register("repository:commit", async ({ localPath, message, files }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.commit(safePath, message, files),
);
});
register("repository:commit-staged", async ({ localPath, message }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.commitStaged(safePath, message),
);
});
register("repository:commit-staged-push", async ({ localPath, message }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.commitStagedAndPush(safePath, message),
);
});
register("repository:commit-push", async ({ localPath, message, files }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.commitAndPush(safePath, message, files),
);
});
register("repository:push", async ({ localPath }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () => git.push(safePath));
});
register("repository:fetch", async ({ localPath }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () => git.fetch(safePath));
});
register("repository:pull", async ({ localPath }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.pullFastForward(safePath),
);
});
register("repository:history", async ({ localPath, limit }) =>
git.history(await assertKnownRepositoryPath(localPath), limit),
);
register("repository:branch-protection", async ({ fullName, branch }) => {
const repository = await resolveRepository({ fullName });
return gitea.getBranchProtection(
repository.owner.login,
repository.name,
branch ||
repository.localStatus?.branch?.head ||
repository.defaultBranch,
);
});
register("repository:pull-requests", async ({ fullName, state = "open" }) => {
const repository = await resolveRepository({ fullName });
return gitea.listPullRequests({
owner: repository.owner.login,
repo: repository.name,
state,
});
});
register(
"repository:create-pull-request",
async ({ fullName, title, body, base }) => {
const repository = await resolveRepository({ fullName });
if (!repository.localPath || !repository.localStatus?.clean)
throw new Error(
"A clean linked repository is required before creating a pull request.",
);
const head = repository.localStatus.branch?.head;
if (!head || !repository.localStatus.branch?.upstream)
throw new Error(
"Publish the current branch before creating a pull request.",
);
if (repository.localStatus.branch.ahead > 0)
throw new Error(
"Push all local commits before creating a pull request.",
);
const pullRequest = await gitea.createPullRequest({
owner: repository.owner.login,
repo: repository.name,
head,
base: base || repository.defaultBranch,
title,
body,
});
await audit.append("pull-request.created", {
repository: repository.fullName,
number: pullRequest.number,
head,
base: base || repository.defaultBranch,
url: pullRequest.html_url,
});
return pullRequest;
},
);
register("repository:branches", async ({ localPath }) =>
git.branches(await assertKnownRepositoryPath(localPath)),
);
register("repository:checkout-branch", async ({ localPath, branch }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.checkoutBranch(safePath, branch),
);
});
register("repository:create-branch", async ({ localPath, branch }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.createBranch(safePath, branch),
);
});
register("repository:stash", async ({ localPath, message }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () => git.stash(safePath, message));
});
register("repository:stash-list", async ({ localPath }) =>
git.stashList(await assertKnownRepositoryPath(localPath)),
);
register("repository:stash-pop", async ({ localPath, ref }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () => git.popStash(safePath, ref));
});
register("repository:index-lock", async ({ localPath }) =>
git.getIndexLockInfo(await assertKnownRepositoryPath(localPath)),
);
register("repository:git-recovery-status", async ({ localPath }) =>
git.reconcile(await assertKnownRepositoryPath(localPath)),
);
register("repository:repair-index-lock", async ({ localPath }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.removeStaleIndexLock(safePath),
);
});
register(
"repository:repair-git-locks",
async ({ localPath, force = false }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.repairStaleGitLocks(safePath, {
minimumAgeMs: force ? 0 : 10_000,
allowWithoutProcessProbe: force === true,
}),
);
},
);
register("repository:reconcile", async ({ localPath }) =>
git.reconcile(await assertKnownRepositoryPath(localPath)),
);
register("repository:repair-sync", async ({ localPath, strategy }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.repairSync(safePath, strategy),
);
});
register("repository:workspace-sync-preview", async ({ localPath }) => {
const safePath = await assertKnownRepositoryPath(localPath);
const plan = await withRepositoryMutation(safePath, () =>
git.previewWorkspaceSync(safePath),
);
await diagnostics.info("repository.workspace-sync.previewed", {
localPath: safePath,
branch: plan.branch,
upstream: plan.upstream,
currentSha: plan.currentSha,
targetSha: plan.targetSha,
planId: plan.id,
summary: plan.summary,
blockers: plan.blockers,
});
return plan;
});
register(
"repository:workspace-sync-apply",
async ({ localPath, expectedPlanId }) => {
const safePath = await assertKnownRepositoryPath(localPath);
const result = await withRepositoryMutation(safePath, () =>
git.synchronizeWorkspace(safePath, expectedPlanId),
);
await audit.append("repository.workspace-synchronized", {
localPath: safePath,
branch: result.plan.branch,
upstream: result.plan.upstream,
previousSha: result.plan.currentSha,
targetSha: result.plan.targetSha,
backupBranch: result.backupBranch,
stashSha: result.stash?.sha || null,
ignoredFilesPreserved: true,
applied: result.applied,
});
return result;
},
);
register("repository:set-origin", async ({ localPath, remoteUrl }) => {
const safePath = await assertKnownRepositoryPath(localPath);
return withRepositoryMutation(safePath, () =>
git.setRemoteUrl(safePath, remoteUrl),
);
});
register("repositories:normalize-origins", async () => {
const current = await repositories.refresh();
const changes = [];
for (const repository of current) {
if (!repository.localPath || !repository.sshUrl) continue;
const actual = await git
.getRemoteUrl(repository.localPath)
.catch(() => "");
if (actual === repository.sshUrl) continue;
await withRepositoryMutation(repository.localPath, () =>
git.setRemoteUrl(repository.localPath, repository.sshUrl),
);
changes.push({
fullName: repository.fullName,
previous: actual,
next: repository.sshUrl,
});
}
const refreshed = await repositories.refresh();
monitor?.setPaths(repositories.getWatchPaths());
await diagnostics.info("repositories.origins.normalized", {
count: changes.length,
changes,
});
return { changes, repositories: refreshed };
});
register("repository:clone", async ({ fullName, mode = "default" }) => {
if (!["default", "custom"].includes(mode))
throw new Error("Unsupported clone location mode.");
let projectRoot = store.data.workspaceRoots[0] || null;
if (mode === "custom" || !projectRoot) {
const result = await dialog.showOpenDialog({
title: `Choose a project root for ${String(fullName || "repository")}`,
defaultPath: projectRoot || undefined,
buttonLabel: "Use this project root",
properties: ["openDirectory", "createDirectory"],
});
if (result.canceled || !result.filePaths[0]) return { cancelled: true };
projectRoot = result.filePaths[0];
}
return cloneRepositoryInto(fullName, projectRoot);
});
register("repository:open-path", async ({ localPath }) => {
const safePath = await assertKnownRepositoryPath(localPath);
const error = await shell.openPath(safePath);
if (error) throw new Error(error);
return true;
});
register(
"repository:open-editor",
async ({ localPath, filePath = "", line = 1 }) =>
externalTools.launch(
"editor",
await assertKnownRepositoryPath(localPath),
filePath,
line,
),
);
register("repository:open-terminal", async ({ localPath }) =>
externalTools.launch(
"terminal",
await assertKnownRepositoryPath(localPath),
),
);
register("external:open", async ({ url }) => {
const parsed = new URL(url);
if (!["http:", "https:"].includes(parsed.protocol))
throw new Error("Only HTTP and HTTPS links can be opened.");
await shell.openExternal(parsed.toString());
return true;
});
register("git-validator:scan", async ({ fullName }) => {
const repository = await resolveRepository({ fullName });
const report = await gitValidator.scan(repository);
await diagnostics.info("git-validator.scan.completed", {
repository: repository.fullName,
score: report.score,
summary: report.summary,
});
return report;
});
register("git-validator:set-policy", async ({ fullName, policy }) => {
const repository = await resolveRepository({ fullName });
const saved = await gitValidator.setPolicy(repository, policy);
await audit.append("git-validator.policy.changed", { repository: repository.fullName, policy: saved.id });
return saved;
});
register("git-validator:suppress", async ({ fullName, suppression }) => {
const repository = await resolveRepository({ fullName });
const saved = await gitValidator.suppress(repository, suppression);
await audit.append("git-validator.finding.suppressed", { repository: repository.fullName, checkId: saved.checkId, expiresAt: saved.expiresAt, ticket: saved.ticket });
return saved;
});
register("git-validator:preview-repair", async ({ fullName, check }) => {
const repository = await resolveRepository({ fullName });
const currentCheck = await gitValidator.resolveRepairCheck(repository, check);
return gitValidator.previewRepair(repository, currentCheck);
});
register("git-validator:export", async ({ fullName, format = "json" }) => {
const repository = await resolveRepository({ fullName });
const report = await gitValidator.scan(repository);
return gitValidator.export(report, format);
});
register("git-validator:repair", async ({ fullName, check }) => {
const repository = await resolveRepository({ fullName });
const allowed = new Set([
"align-origin",
"configure-local-safety",
"add-gitignore",
"add-gitattributes",
"add-editorconfig",
"protect-default-branch",
]);
const currentCheck = await gitValidator.resolveRepairCheck(repository, check);
if (!allowed.has(currentCheck.fixAction))
throw new Error("Unsupported Git Validator repair request.");
const result = await gitValidator.repair(repository, currentCheck);
await audit.append("git-validator.repair", {
repository: repository.fullName,
checkId: currentCheck.id,
action: currentCheck.fixAction,
});
await diagnostics.info("git-validator.repair.completed", {
repository: repository.fullName,
checkId: currentCheck.id,
action: currentCheck.fixAction,
});
return result;
});
}
module.exports = { registerRepositoryIpc };
+26
View File
@@ -0,0 +1,26 @@
'use strict';
function isBrokenPipeError(error) {
return error?.code === 'EPIPE';
}
function installOutputPipeGuards({
stdout = process.stdout,
stderr = process.stderr,
onBrokenPipe = () => {}
} = {}) {
const guardedStreams = [stdout, stderr].filter(Boolean);
const handlers = guardedStreams.map((stream) => {
const handler = (error) => {
if (!isBrokenPipeError(error)) throw error;
onBrokenPipe(error);
};
stream.on('error', handler);
return { stream, handler };
});
return () => {
for (const { stream, handler } of handlers) stream.off('error', handler);
};
}
module.exports = { installOutputPipeGuards, isBrokenPipeError };
+149
View File
@@ -0,0 +1,149 @@
"use strict";
const fs = require("node:fs/promises");
const os = require("node:os");
const path = require("node:path");
const crypto = require("node:crypto");
const { run } = require("./process-runner.cjs");
class ProductionAcceptanceHarness {
constructor(root) {
this.root = root;
this.paths = {
remote: path.join(root, "gitea", "owner", "app.git"),
source: path.join(root, "workspace", "app"),
server: path.join(root, "server", "appdata", "app"),
releases: path.join(root, "releases"),
config: path.join(root, "user-data", "forgeflow-config.json"),
keys: path.join(root, "keys"),
};
this.state = { installed: false, version: null, tokenVersion: 1, auth: null, liveSha: null, previousSha: null, healthy: false, deployment: null, recovery: null, hostFingerprint: "SHA256:fixture-host", keyReadOnly: true };
}
static async create() {
const root = await fs.mkdtemp(path.join(os.tmpdir(), "forgeflow-production-acceptance-"));
const harness = new ProductionAcceptanceHarness(root);
await harness.provision();
return harness;
}
async provision() {
await Promise.all(Object.values(this.paths).filter((value) => !path.extname(value)).map((directory) => fs.mkdir(directory, { recursive: true })));
await fs.mkdir(path.dirname(this.paths.remote), { recursive: true });
await run("git", ["init", "--bare", this.paths.remote], { cwd: this.root, timeout: 30_000 });
await fs.mkdir(this.paths.source, { recursive: true });
await run("git", ["init", "-b", "main"], { cwd: this.paths.source, timeout: 30_000 });
await run("git", ["config", "user.name", "ForgeFlow Acceptance"], { cwd: this.paths.source });
await run("git", ["config", "user.email", "acceptance@example.invalid"], { cwd: this.paths.source });
await fs.writeFile(path.join(this.paths.source, "compose.yml"), "services:\n app:\n image: forgeflow-fixture:latest\n", "utf8");
await fs.writeFile(path.join(this.paths.source, "README.md"), "# Acceptance fixture\n", "utf8");
await run("git", ["add", "."], { cwd: this.paths.source });
await run("git", ["commit", "-m", "feat: initial fixture"], { cwd: this.paths.source });
await run("git", ["remote", "add", "origin", this.paths.remote], { cwd: this.paths.source });
await run("git", ["push", "-u", "origin", "main"], { cwd: this.paths.source, timeout: 30_000 });
this.initialSha = (await run("git", ["rev-parse", "HEAD"], { cwd: this.paths.source })).stdout.trim();
await fs.mkdir(this.paths.releases, { recursive: true });
await fs.mkdir(path.dirname(this.paths.config), { recursive: true });
await fs.mkdir(this.paths.keys, { recursive: true });
await fs.writeFile(path.join(this.paths.keys, "deploy_key.pub"), "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFixture forgeflow-acceptance\n", "utf8");
}
async cleanup() { await fs.rm(this.root, { recursive: true, force: true }); }
async install(version = "0.10.0", mode = "installed") {
this.state.installed = true; this.state.version = version; this.state.mode = mode;
await this.saveConfig({ schemaVersion: 12, version, mode });
return structuredClone(this.state);
}
async migrate(targetVersion = "1.0.0") {
if (!this.state.installed) throw new Error("Clean installation is required before migration.");
const previous = JSON.parse(await fs.readFile(this.paths.config, "utf8"));
await fs.writeFile(`${this.paths.config}.backup`, JSON.stringify(previous, null, 2), "utf8");
this.state.version = targetVersion;
await this.saveConfig({ ...previous, schemaVersion: 13, version: targetVersion, migratedAt: new Date().toISOString() });
return { previousVersion: previous.version, version: targetVersion, backup: `${this.paths.config}.backup` };
}
async saveConfig(data) { await fs.writeFile(this.paths.config, `${JSON.stringify(data, null, 2)}\n`, "utf8"); }
rotateToken() { this.state.tokenVersion += 1; return { tokenVersion: this.state.tokenVersion }; }
authenticate(type, options = {}) {
if (!['password', 'ssh-key'].includes(type)) throw new Error("Unsupported authentication fixture.");
if (type === 'ssh-key' && options.hostFingerprint !== this.state.hostFingerprint) throw new Error("SSH host fingerprint changed.");
this.state.auth = type; return { authenticated: true, type };
}
setKeyAccess(readOnly) { this.state.keyReadOnly = readOnly; }
async createCommit(message = "fix: acceptance change") {
const target = path.join(this.paths.source, "fixture.txt");
await fs.writeFile(target, `${crypto.randomUUID()}\n`, "utf8");
await run("git", ["add", "fixture.txt"], { cwd: this.paths.source });
await run("git", ["commit", "-m", message], { cwd: this.paths.source });
await run("git", ["push", "origin", "main"], { cwd: this.paths.source });
return (await run("git", ["rev-parse", "HEAD"], { cwd: this.paths.source })).stdout.trim();
}
plan(sha, mode = "server-git") {
return { id: crypto.randomUUID(), evidenceHash: crypto.createHash("sha256").update(JSON.stringify({ sha, mode, liveSha: this.state.liveSha, keyReadOnly: this.state.keyReadOnly })).digest("hex"), sha, mode, previousSha: this.state.liveSha };
}
async deploy(plan, fault = null) {
if (!this.state.auth) throw new Error("Server authentication is required.");
if (plan.mode === "server-git" && !this.state.keyReadOnly) throw new Error("Writable deploy key rejected.");
if (this.plan(plan.sha, plan.mode).evidenceHash !== plan.evidenceHash) throw new Error("Stale reconciliation plan.");
this.state.recovery = structuredClone(this.state);
this.state.deployment = { id: crypto.randomUUID(), sha: plan.sha, mode: plan.mode, status: "running" };
if (fault === "fetch-network") return this.fail("Network interrupted during fetch", false);
await fs.mkdir(this.paths.server, { recursive: true });
await fs.writeFile(path.join(this.paths.server, "compose.yml"), await fs.readFile(path.join(this.paths.source, "compose.yml")));
if (fault === "activation-network") return this.fail("Network interrupted during activation", true);
if (fault === "shutdown") { this.state.deployment.status = "interrupted"; return structuredClone(this.state.deployment); }
this.state.previousSha = this.state.liveSha;
this.state.liveSha = plan.sha;
this.state.healthy = fault !== "unhealthy";
this.state.deployment.status = this.state.healthy ? "success" : "failed";
return structuredClone(this.state.deployment);
}
fail(message, partial) { this.state.deployment.status = "failed"; this.state.deployment.failure = { message, partial }; return structuredClone(this.state.deployment); }
recover() {
if (this.state.deployment?.status !== "interrupted") throw new Error("No interrupted deployment to recover.");
this.state.deployment.status = this.state.liveSha === this.state.deployment.sha && this.state.healthy ? "success" : "failed";
return structuredClone(this.state.deployment);
}
rollback(targetSha) {
if (!targetSha || targetSha !== this.state.previousSha) throw new Error("Rollback target is not the exact recorded previous SHA.");
[this.state.liveSha, this.state.previousSha] = [targetSha, this.state.liveSha]; this.state.healthy = true;
return { status: "rolled-back", liveSha: this.state.liveSha };
}
adoptExisting(sha = this.initialSha) { this.state.liveSha = sha; this.state.healthy = true; return { linked: true, liveSha: sha, preserved: true }; }
externalUpdate(sha) { this.state.liveSha = sha; this.state.healthy = true; return { reconciled: true, liveSha: sha }; }
rotateDeployKey() { if (!this.state.keyReadOnly) throw new Error("Candidate deploy key is writable."); this.state.keyVersion = (this.state.keyVersion || 1) + 1; return { rotated: true, keyVersion: this.state.keyVersion }; }
revokeDeployKey() { this.state.keyRevoked = true; return { revoked: true, deploymentBlocked: true }; }
restoreDeployKey() { this.state.keyRevoked = false; this.state.keyReadOnly = true; return { restored: true }; }
inventory(count = 20, partial = false) { return { workloads: Array.from({ length: count }, (_, index) => ({ id: `workload-${index + 1}`, classification: index === 1 ? "duplicate" : "active" })), partial, warnings: partial ? ["One scan root was unavailable"] : [] }; }
async publishRelease(version, options = {}) {
const binary = Buffer.from(options.binary || "MZ-forgeflow-acceptance-binary");
const name = `ForgeFlow-Portable-${version}-win-x64.exe`;
const checksum = crypto.createHash("sha256").update(binary).digest("hex");
const manifest = { version, draft: options.draft === true, assets: options.missingAsset ? [] : [{ name, sha256: options.badChecksum ? "0".repeat(64) : checksum }], provenance: { commitSha: options.commitSha || this.initialSha }, sbom: { bomFormat: "CycloneDX" } };
await fs.writeFile(path.join(this.paths.releases, `${version}.json`), JSON.stringify(manifest, null, 2));
if (!options.missingAsset) await fs.writeFile(path.join(this.paths.releases, name), binary);
return manifest;
}
async verifyRelease(version) {
const manifest = JSON.parse(await fs.readFile(path.join(this.paths.releases, `${version}.json`), "utf8"));
if (manifest.draft) throw new Error("Incomplete draft release rejected.");
const asset = manifest.assets[0];
if (!asset) throw new Error("Required release asset is missing.");
const binary = await fs.readFile(path.join(this.paths.releases, asset.name));
if (crypto.createHash("sha256").update(binary).digest("hex") !== asset.sha256) throw new Error("Release checksum mismatch.");
if (!manifest.provenance?.commitSha || manifest.sbom?.bomFormat !== "CycloneDX") throw new Error("Release provenance or SBOM is missing.");
return { verified: true, version, asset: asset.name };
}
}
module.exports = { ProductionAcceptanceHarness };
+180 -21
View File
@@ -1,5 +1,16 @@
'use strict'; 'use strict';
const fs = require('node:fs');
// A watched repository is only re-read when the filesystem reports activity. The
// interval below stays as a safety net for watchers that silently stop
// delivering, which happens on network shares and removed folders.
const SAFETY_CHECK_INTERVAL_MS = 30_000;
const WATCH_DEBOUNCE_MS = 250;
// Busy trees (a build, an install, a fetch) produce a continuous event stream.
// This bounds how often that can turn into a Git read.
const MIN_WATCH_CHECK_INTERVAL_MS = 1_000;
class RepositoryMonitor { class RepositoryMonitor {
constructor({ store, git, onChange, diagnostics = null }) { constructor({ store, git, onChange, diagnostics = null }) {
this.store = store; this.store = store;
@@ -11,12 +22,149 @@ class RepositoryMonitor {
this.timer = null; this.timer = null;
this.running = false; this.running = false;
this.paused = new Set(); this.paused = new Set();
this.active = false;
this.watchers = new Map();
this.changed = new Set();
this.lastCheckedAt = new Map();
this.lastFetchedAt = new Map();
this.watchTimer = null;
this.fetchRunning = false;
} }
setPaths(paths) { setPaths(paths) {
this.paths = [...new Set((paths || []).filter(Boolean))]; this.paths = [...new Set((paths || []).filter(Boolean))];
const watched = new Set(this.paths);
for (const existing of [...this.fingerprints.keys()]) { for (const existing of [...this.fingerprints.keys()]) {
if (!this.paths.includes(existing)) this.fingerprints.delete(existing); if (!watched.has(existing)) this.fingerprints.delete(existing);
}
// A repository that is unlinked while a mutation holds it paused would keep
// that pause forever, silently freezing its status once it is watched again.
for (const existing of [...this.paused]) {
if (!watched.has(existing)) this.paused.delete(existing);
}
for (const existing of [...this.changed]) {
if (!watched.has(existing)) this.changed.delete(existing);
}
for (const existing of [...this.lastCheckedAt.keys()]) {
if (!watched.has(existing)) this.lastCheckedAt.delete(existing);
}
for (const existing of [...this.lastFetchedAt.keys()]) {
if (!watched.has(existing)) this.lastFetchedAt.delete(existing);
}
const now = Date.now();
for (const localPath of this.paths) {
if (!this.lastFetchedAt.has(localPath)) this.lastFetchedAt.set(localPath, now);
}
this.syncWatchers();
}
syncWatchers() {
for (const [localPath, watcher] of [...this.watchers]) {
if (this.active && this.paths.includes(localPath)) continue;
this.closeWatcher(localPath, watcher);
}
if (!this.active) return;
for (const localPath of this.paths) {
if (this.watchers.has(localPath)) continue;
try {
const watcher = fs.watch(
localPath,
{ recursive: true, persistent: false },
() => this.noteFilesystemChange(localPath)
);
watcher.on('error', () => this.dropWatcher(localPath));
this.watchers.set(localPath, watcher);
} catch {
// Watching is unavailable for this folder. Leaving it unwatched makes
// shouldCheck() fall back to the interval for that repository only.
}
}
}
closeWatcher(localPath, watcher = this.watchers.get(localPath)) {
if (!watcher) return;
try { watcher.close(); } catch { /* already closed */ }
this.watchers.delete(localPath);
}
dropWatcher(localPath) {
this.closeWatcher(localPath);
this.changed.add(localPath);
}
noteFilesystemChange(localPath) {
this.changed.add(localPath);
this.scheduleWatchTick();
}
scheduleWatchTick() {
if (this.watchTimer) return;
this.watchTimer = setTimeout(() => {
this.watchTimer = null;
this.tick().catch((error) => this.diagnostics?.warning('repository-monitor.tick.failed', error));
}, WATCH_DEBOUNCE_MS);
this.watchTimer.unref?.();
}
shouldCheck(localPath, now) {
if (this.paused.has(localPath)) return false;
if (!this.watchers.has(localPath)) return true;
const sinceLastCheck = now - (this.lastCheckedAt.get(localPath) || 0);
if (this.changed.has(localPath)) return sinceLastCheck >= MIN_WATCH_CHECK_INTERVAL_MS;
return sinceLastCheck >= SAFETY_CHECK_INTERVAL_MS;
}
fetchIntervalMs() {
const minutes = Number(this.store.data.preferences.fetchIntervalMinutes);
return Number.isFinite(minutes) && minutes > 0 ? Math.min(minutes, 240) * 60_000 : 0;
}
shouldFetch(localPath, now) {
const interval = this.fetchIntervalMs();
return interval > 0
&& !this.paused.has(localPath)
&& now - (this.lastFetchedAt.get(localPath) || now) >= interval;
}
async recordStatus(localPath, status, reason) {
const next = this.git.statusFingerprint(status);
const previous = this.fingerprints.get(localPath);
this.fingerprints.set(localPath, next);
if (previous && previous !== next) {
await this.diagnostics?.debug('repository-monitor.changed', { localPath, head: status.head, branch: status.branch?.head, counts: status.counts, reason });
this.onChange?.({ localPath, status, reason });
}
}
async fetchRemoteUpdates(now = Date.now()) {
if (this.fetchRunning) return;
const queue = this.paths.filter((localPath) => this.shouldFetch(localPath, now));
if (!queue.length) return;
this.fetchRunning = true;
try {
const workers = Array.from({ length: Math.min(2, queue.length) }, async () => {
while (queue.length) {
const localPath = queue.shift();
// Mark the attempt before awaiting the network. A failing remote should
// not be retried every local poll interval.
this.lastFetchedAt.set(localPath, Date.now());
try {
const result = await this.git.fetch(localPath);
await this.recordStatus(localPath, result.status, 'remote-state-changed');
await this.diagnostics?.debug('repository-monitor.fetch.completed', {
localPath,
branch: result.status?.branch?.head,
ahead: result.status?.branch?.ahead,
behind: result.status?.branch?.behind,
});
} catch (error) {
await this.diagnostics?.warning('repository-monitor.fetch.failed', { localPath, message: error.message });
}
}
});
await Promise.all(workers);
} finally {
this.fetchRunning = false;
} }
} }
@@ -26,6 +174,8 @@ class RepositoryMonitor {
restart() { restart() {
this.stop(); this.stop();
if (!this.store.data.preferences.autoRefresh) return; if (!this.store.data.preferences.autoRefresh) return;
this.active = true;
this.syncWatchers();
const seconds = Math.min(Math.max(Number(this.store.data.preferences.repositoryPollSeconds) || 4, 2), 60); const seconds = Math.min(Math.max(Number(this.store.data.preferences.repositoryPollSeconds) || 4, 2), 60);
this.timer = setInterval(() => this.tick().catch((error) => this.diagnostics?.warning('repository-monitor.tick.failed', error)), seconds * 1000); this.timer = setInterval(() => this.tick().catch((error) => this.diagnostics?.warning('repository-monitor.tick.failed', error)), seconds * 1000);
this.timer.unref?.(); this.timer.unref?.();
@@ -34,37 +184,46 @@ class RepositoryMonitor {
stop() { stop() {
if (this.timer) clearInterval(this.timer); if (this.timer) clearInterval(this.timer);
this.timer = null; this.timer = null;
if (this.watchTimer) clearTimeout(this.watchTimer);
this.watchTimer = null;
this.active = false;
this.syncWatchers();
} }
async tick() { async tick() {
void this.fetchRemoteUpdates().catch((error) => this.diagnostics?.warning('repository-monitor.fetch-cycle.failed', error));
if (this.running || !this.paths.length) return; if (this.running || !this.paths.length) return;
this.running = true; this.running = true;
try { try {
for (const localPath of this.paths) { const now = Date.now();
if (this.paused.has(localPath)) continue; const queue = this.paths.filter((localPath) => this.shouldCheck(localPath, now));
try { const workers = Array.from({ length: Math.min(4, queue.length) }, async () => {
const status = await this.git.status(localPath); while (queue.length) {
const next = this.git.statusFingerprint(status); const localPath = queue.shift();
const previous = this.fingerprints.get(localPath); this.changed.delete(localPath);
this.fingerprints.set(localPath, next); this.lastCheckedAt.set(localPath, Date.now());
if (previous && previous !== next) { try {
await this.diagnostics?.debug('repository-monitor.changed', { localPath, head: status.head, branch: status.branch?.head, counts: status.counts }); const status = await this.git.status(localPath);
this.onChange?.({ localPath, status, reason: 'working-tree-changed' }); await this.recordStatus(localPath, status, 'working-tree-changed');
} } catch (error) {
} catch (error) { const next = `error:${error.message}`;
const next = `error:${error.message}`; const previous = this.fingerprints.get(localPath);
const previous = this.fingerprints.get(localPath); this.fingerprints.set(localPath, next);
this.fingerprints.set(localPath, next); if (previous && previous !== next) {
if (previous && previous !== next) { await this.diagnostics?.warning('repository-monitor.unavailable', { localPath, message: error.message });
await this.diagnostics?.warning('repository-monitor.unavailable', { localPath, message: error.message }); this.onChange?.({ localPath, error: error.message, reason: 'repository-unavailable' });
this.onChange?.({ localPath, error: error.message, reason: 'repository-unavailable' }); }
} }
} }
} });
await Promise.all(workers);
} finally { } finally {
this.running = false; this.running = false;
// Activity that arrived while the check was running keeps its flag set, so
// it must not wait for the safety interval.
if (this.active && this.changed.size) this.scheduleWatchTick();
} }
} }
} }
module.exports = { RepositoryMonitor }; module.exports = { RepositoryMonitor, SAFETY_CHECK_INTERVAL_MS, WATCH_DEBOUNCE_MS, MIN_WATCH_CHECK_INTERVAL_MS };
+112 -8
View File
@@ -29,6 +29,13 @@ class RepositoryService {
this.gitea = giteaService; this.gitea = giteaService;
this.diagnostics = diagnostics; this.diagnostics = diagnostics;
this.lastKnownLocalPaths = []; this.lastKnownLocalPaths = [];
this.lastKnownRemoteRepositories = [];
this.lastSuccessfulRemoteRefreshAt = null;
this.lastRemoteRefreshAtMs = 0;
this.lastDiscoveredPaths = [];
this.lastDiscoveryAtMs = 0;
this.refreshPromise = null;
this.lastResult = null;
} }
async discoverInRoot(root, maxDepth = 4) { async discoverInRoot(root, maxDepth = 4) {
@@ -51,8 +58,13 @@ class RepositoryService {
let entries; let entries;
try { entries = await fs.readdir(real, { withFileTypes: true }); } catch { return; } try { entries = await fs.readdir(real, { withFileTypes: true }); } catch { return; }
// Directory entries report as a symbolic link instead of a directory, which
// is how Windows junctions surface. Skipping those made a project folder
// that is mapped through a junction invisible; visit() resolves each entry
// and the `seen` set above keeps links that point back into the tree from
// being scanned twice.
await mapLimit(entries await mapLimit(entries
.filter((entry) => entry.isDirectory() && !entry.isSymbolicLink() && !SKIP_DIRECTORIES.has(entry.name)), 12, .filter((entry) => (entry.isDirectory() || entry.isSymbolicLink()) && !SKIP_DIRECTORIES.has(entry.name)), 12,
(entry) => visit(path.join(real, entry.name), depth + 1)); (entry) => visit(path.join(real, entry.name), depth + 1));
}; };
@@ -80,13 +92,97 @@ class RepositoryService {
return [...this.lastKnownLocalPaths]; return [...this.lastKnownLocalPaths];
} }
async refresh() { async getRemoteRepositories({ force = false } = {}) {
const started = Date.now(); if (!this.store.data.gitea.baseUrl || !this.store.getToken()) {
const remoteRepositories = this.store.data.gitea.baseUrl && this.store.getToken() this.lastKnownRemoteRepositories = [];
? await this.gitea.listRepositories() this.lastSuccessfulRemoteRefreshAt = null;
: []; return { repositories: [], stale: false, error: null };
}
const discoveredPaths = await this.discoverAll(this.store.data.workspaceRoots); if (!force && this.lastSuccessfulRemoteRefreshAt && Date.now() - this.lastRemoteRefreshAtMs < 15_000) {
return {
repositories: this.lastKnownRemoteRepositories.map((repository) => ({ ...repository })),
stale: false,
error: null,
cached: true
};
}
try {
const repositories = await this.gitea.listRepositories();
this.lastKnownRemoteRepositories = repositories.map((repository) => ({ ...repository }));
this.lastSuccessfulRemoteRefreshAt = new Date().toISOString();
this.lastRemoteRefreshAtMs = Date.now();
return { repositories, stale: false, error: null };
} catch (error) {
if (!this.lastSuccessfulRemoteRefreshAt) throw error;
await this.diagnostics?.warning('repositories.remote-refresh.degraded', {
message: error.message,
cachedCount: this.lastKnownRemoteRepositories.length,
lastSuccessfulAt: this.lastSuccessfulRemoteRefreshAt
});
return {
repositories: this.lastKnownRemoteRepositories.map((repository) => ({ ...repository })),
stale: true,
error: error.message
};
}
}
async getDiscoveredPaths({ force = false } = {}) {
if (!force && this.lastDiscoveryAtMs && Date.now() - this.lastDiscoveryAtMs < 30_000) {
return [...this.lastDiscoveredPaths];
}
const paths = await this.discoverAll(this.store.data.workspaceRoots);
this.lastDiscoveredPaths = [...paths];
this.lastDiscoveryAtMs = Date.now();
return paths;
}
// Resolving a single repository used to go through a full refresh, which runs
// `git status` for every discovered repository. Handlers that act on one
// repository only need that one, so its local state is read directly. Anything
// this cannot answer confidently still falls back to the full scan.
async resolveByFullName(fullName) {
const name = String(fullName || '').trim();
if (!name) return null;
const fromFullRefresh = async () => (await this.refresh()).find((item) => item.fullName === name) || null;
const remoteResult = await this.getRemoteRepositories({});
const remote = remoteResult.repositories.find((item) => item.full_name === name);
if (!remote) return fromFullRefresh();
const explicitPath = this.store.data.repositoryMappings[repositoryKey(remote)];
const knownPath = explicitPath || (this.lastResult || []).find((item) => item.fullName === name)?.localPath || null;
// Without a known path the link can still exist through remote-URL matching,
// which only the discovery pass can establish.
if (!knownPath && !this.lastResult) return fromFullRefresh();
const local = knownPath ? (await this.getLocalDescriptors([knownPath]))[0] : null;
const profiles = this.store.getDeploymentProfiles(remote.full_name).map((profile) => ({
...profile,
state: this.store.getDeploymentState(profile.id)
}));
return {
...this.decorate(remote, local, profiles),
remoteStale: remoteResult.stale,
remoteRefreshError: remoteResult.error,
remoteLastRefreshedAt: this.lastSuccessfulRemoteRefreshAt
};
}
async refresh(options = {}) {
if (this.refreshPromise) return this.refreshPromise;
this.refreshPromise = this.performRefresh(options).finally(() => { this.refreshPromise = null; });
return this.refreshPromise;
}
async performRefresh({ force = false } = {}) {
const started = Date.now();
const remoteResult = await this.getRemoteRepositories({ force });
const remoteRepositories = remoteResult.repositories;
const discoveredPaths = await this.getDiscoveredPaths({ force });
const mappedPaths = Object.values(this.store.data.repositoryMappings || {}); const mappedPaths = Object.values(this.store.data.repositoryMappings || {});
const localPaths = [...new Set([...discoveredPaths, ...mappedPaths])]; const localPaths = [...new Set([...discoveredPaths, ...mappedPaths])];
const localDescriptors = await this.getLocalDescriptors(localPaths); const localDescriptors = await this.getLocalDescriptors(localPaths);
@@ -106,7 +202,12 @@ class RepositoryService {
...profile, ...profile,
state: this.store.getDeploymentState(profile.id) state: this.store.getDeploymentState(profile.id)
})); }));
repositories.push(this.decorate(remote, local, profiles)); repositories.push({
...this.decorate(remote, local, profiles),
remoteStale: remoteResult.stale,
remoteRefreshError: remoteResult.error,
remoteLastRefreshedAt: this.lastSuccessfulRemoteRefreshAt
});
} }
for (const local of localDescriptors.filter((item) => !usedLocalPaths.has(item.localPath))) { for (const local of localDescriptors.filter((item) => !usedLocalPaths.has(item.localPath))) {
@@ -145,11 +246,14 @@ class RepositoryService {
await this.diagnostics?.debug('repositories.refresh.completed', { await this.diagnostics?.debug('repositories.refresh.completed', {
durationMs: Date.now() - started, durationMs: Date.now() - started,
remoteCount: remoteRepositories.length, remoteCount: remoteRepositories.length,
remoteStale: remoteResult.stale,
remoteCached: remoteResult.cached === true,
discoveredCount: discoveredPaths.length, discoveredCount: discoveredPaths.length,
linkedCount: sorted.filter((item) => item.localPath).length, linkedCount: sorted.filter((item) => item.localPath).length,
attentionCount: sorted.filter((item) => item.attention).length, attentionCount: sorted.filter((item) => item.attention).length,
readyToDeployCount: sorted.filter((item) => item.readyToDeploy).length readyToDeployCount: sorted.filter((item) => item.readyToDeploy).length
}); });
this.lastResult = sorted;
return sorted; return sorted;
} }
+577
View File
@@ -0,0 +1,577 @@
'use strict';
const crypto = require('node:crypto');
const path = require('node:path').posix;
const { normalizeRemoteUrl } = require('../shared/repository-match.cjs');
function decodeBase64(value) {
try { return Buffer.from(String(value || ''), 'base64').toString('utf8'); }
catch { return ''; }
}
function remoteIdentity(value) {
const normalized = normalizeRemoteUrl(value);
return normalized ? `${normalized.host}/${normalized.path}` : '';
}
function normalizedName(value) {
return String(value || '').toLowerCase().replace(/\.git$/i, '').replace(/[^a-z0-9]/g, '');
}
function safeJson(value, fallback) {
try { return JSON.parse(value); }
catch { return fallback; }
}
function sanitizeLegacyContainer(container) {
const labels = container?.Config?.Labels || {};
return {
id: container?.Id || '',
name: String(container?.Name || '').replace(/^\//, ''),
image: container?.Config?.Image || '',
imageId: container?.Image || '',
running: container?.State?.Running === true,
status: container?.State?.Status || '',
health: container?.State?.Health?.Status || null,
labels: {
'com.docker.compose.project': labels['com.docker.compose.project'] || '',
'com.docker.compose.project.working_dir': labels['com.docker.compose.project.working_dir'] || '',
'com.docker.compose.project.config_files': labels['com.docker.compose.project.config_files'] || '',
'com.docker.compose.service': labels['com.docker.compose.service'] || '',
'org.opencontainers.image.source': labels['org.opencontainers.image.source'] || '',
'org.opencontainers.image.revision': labels['org.opencontainers.image.revision'] || '',
'tech.itworx.forgeflow.repository': labels['tech.itworx.forgeflow.repository'] || '',
'tech.itworx.forgeflow.commit': labels['tech.itworx.forgeflow.commit'] || '',
'tech.itworx.forgeflow.branch': labels['tech.itworx.forgeflow.branch'] || '',
'net.unraid.docker.webui': labels['net.unraid.docker.webui'] || '',
'net.unraid.docker.icon': labels['net.unraid.docker.icon'] || '',
'net.unraid.docker.shell': labels['net.unraid.docker.shell'] || '',
'net.unraid.docker.managed': labels['net.unraid.docker.managed'] || '',
},
ports: container?.NetworkSettings?.Ports || {},
mounts: Array.isArray(container?.Mounts) ? container.Mounts : [],
networks: container?.NetworkSettings?.Networks || {},
restartPolicy: container?.HostConfig?.RestartPolicy?.Name || '',
};
}
function parseServerInventory(output) {
const marker = '__FORGEFLOW_INVENTORY__';
const index = String(output || '').lastIndexOf(marker);
if (index < 0) throw new Error('The server did not return a ForgeFlow workload inventory.');
const inventory = {
capabilities: {},
checkouts: [],
containers: [],
dockerMan: [],
composeProjects: [],
composeDefinitions: [],
warnings: [],
};
for (const line of String(output).slice(index + marker.length).trim().split(/\r?\n/)) {
if (!line) continue;
const [kind, ...parts] = line.split('\t');
if (kind === 'H') {
inventory.capabilities = {
docker: parts[0] === 'true',
compose: parts[1] === 'true',
git: parts[2] === 'true',
tar: parts[3] === 'true',
checksum: parts[4] === 'true',
baseWritable: parts[5] === 'true',
composeVersion: decodeBase64(parts[6]),
platform: decodeBase64(parts[7]),
};
} else if (kind === 'R' && parts.length >= 4) {
inventory.checkouts.push({
root: decodeBase64(parts[0]),
remote: decodeBase64(parts[1]),
liveSha: parts[2] || '',
branch: decodeBase64(parts[3]),
});
} else if (kind === 'C' && parts[0]) {
const parsed = safeJson(decodeBase64(parts[0]), null);
if (!parsed) continue;
if (Array.isArray(parsed)) {
for (const item of parsed) if (item) inventory.containers.push(sanitizeLegacyContainer(item));
} else if (parsed.Config || parsed.State) inventory.containers.push(sanitizeLegacyContainer(parsed));
else inventory.containers.push({
...parsed,
name: String(parsed.name || '').replace(/^\//, ''),
labels: parsed.labels && typeof parsed.labels === 'object' ? parsed.labels : {},
mounts: Array.isArray(parsed.mounts) ? parsed.mounts : [],
ports: parsed.ports && typeof parsed.ports === 'object' ? parsed.ports : {},
networks: parsed.networks && typeof parsed.networks === 'object' ? parsed.networks : {},
});
} else if (kind === 'D' && parts[0]) {
inventory.dockerMan.push({
name: decodeBase64(parts[0]),
templatePath: decodeBase64(parts[1]),
webUiUrl: decodeBase64(parts[2]),
iconUrl: decodeBase64(parts[3]),
shell: decodeBase64(parts[4]),
repository: decodeBase64(parts[5]),
network: decodeBase64(parts[6]),
});
} else if (kind === 'P' && parts[0]) {
const parsed = safeJson(decodeBase64(parts[0]), []);
const projects = Array.isArray(parsed) ? parsed : parsed ? [parsed] : [];
for (const project of projects) {
const name = String(project?.Name || project?.name || '').trim();
if (!name) continue;
const rawFiles = project?.ConfigFiles || project?.configFiles || project?.config_files || [];
const configFiles = (Array.isArray(rawFiles) ? rawFiles : String(rawFiles || '').split(','))
.map((item) => String(item || '').trim())
.filter(Boolean);
inventory.composeProjects.push({
name,
status: String(project?.Status || project?.status || ''),
configFiles,
});
}
} else if (kind === 'Y' && parts[0]) {
inventory.composeDefinitions.push({
workingDir: decodeBase64(parts[0]).replace(/\/+$/, ''),
configFiles: decodeBase64(parts[1]).split(/\r?\n/).map((item) => item.trim()).filter(Boolean),
projectName: decodeBase64(parts[2]).trim(),
services: decodeBase64(parts[3]).split(/\r?\n/).map((item) => item.trim()).filter(Boolean),
images: decodeBase64(parts[4]).split(/\r?\n/).map((item) => item.trim()).filter(Boolean),
valid: parts[5] === 'true',
error: decodeBase64(parts[6]).trim(),
});
} else if (kind === 'W') inventory.warnings.push(decodeBase64(parts[0]));
}
return inventory;
}
function configFilesFor(container) {
return String(container?.labels?.['com.docker.compose.project.config_files'] || '')
.split(',')
.map((item) => item.trim())
.filter(Boolean);
}
function containerPorts(container) {
const ports = [];
for (const [containerKey, bindings] of Object.entries(container?.ports || {})) {
const [containerPortText, protocol = 'tcp'] = containerKey.split('/');
const containerPort = Number(containerPortText) || null;
if (Array.isArray(bindings) && bindings.length) {
for (const binding of bindings) ports.push({
hostIp: binding?.HostIp || '',
hostPort: Number(binding?.HostPort) || null,
containerPort,
protocol,
});
} else ports.push({ hostIp: '', hostPort: null, containerPort, protocol });
}
return ports;
}
function safeRelativeToBase(basePath, candidate) {
const base = String(basePath || '').replace(/\/+$/, '');
const value = String(candidate || '').replace(/\/+$/, '');
if (!base || !value || !value.startsWith(`${base}/`)) return '';
const relative = value.slice(base.length + 1).replace(/^\/+|\/+$/g, '');
if (!relative || relative.split('/').some((part) => !part || part === '.' || part === '..')) return '';
return relative;
}
function topLevelRelativeToBase(basePath, candidate) {
const relative = safeRelativeToBase(basePath, candidate);
return relative ? relative.split('/')[0] : '';
}
function canonicalServerAppdataPath(basePath, candidate) {
const value = String(candidate || '').replace(/\\/g, '/').replace(/\/+$/, '');
if (!value) return '';
const bases = [...new Set([
String(basePath || '').replace(/\/+$/, ''),
'/mnt/user/appdata',
'/mnt/cache/appdata',
].filter(Boolean))];
for (const base of bases) {
const relative = safeRelativeToBase(base, value);
if (relative) return `${String(basePath || base).replace(/\/+$/, '')}/${relative}`;
if (value === base) return String(basePath || base).replace(/\/+$/, '');
}
const diskMatch = value.match(/^\/mnt\/disk\d+\/appdata\/(.+)$/i);
if (diskMatch) return `${String(basePath || '/mnt/user/appdata').replace(/\/+$/, '')}/${diskMatch[1]}`;
return value;
}
function isDeploymentBackupPath(value) {
const segments = String(value || '').replace(/\\/g, '/').split('/').filter(Boolean);
return segments.some((segment) =>
/^source-pre-[0-9a-f]{7,64}$/i.test(segment)
|| /^forgeflow-(backup|staging|rollback)(?:[-_.].*)?$/i.test(segment)
|| ['.forgeflow', 'releases', 'backups', 'staging', 'incoming', '_audit_quarantine', 'devrunbook-validation'].includes(segment.toLowerCase()),
);
}
function deploymentRootCandidate(relativePath) {
const segments = String(relativePath || '').replace(/\\/g, '/').split('/').filter(Boolean);
const forgeFlowIndex = segments.indexOf('.forgeflow');
if (forgeFlowIndex > 0) return segments.slice(0, forgeFlowIndex).join('/');
const releasesIndex = segments.indexOf('releases');
if (releasesIndex > 0 && segments.length > releasesIndex + 1) return segments.slice(0, releasesIndex).join('/');
const backupIndex = segments.findIndex((segment) => /^source-pre-[0-9a-f]{7,64}$/i.test(segment));
if (backupIndex > 0) return segments.slice(0, backupIndex).join('/');
return segments.join('/');
}
function workloadSelector(group) {
if (group.composeProject) return {
kind: 'compose',
composeProject: group.composeProject,
workingDir: group.workingDir || '',
configFiles: group.configFiles,
};
const dockerMan = group.dockerMan || null;
if (dockerMan?.templatePath) return {
kind: 'dockerman-container',
templatePath: dockerMan.templatePath,
containerName: group.containers[0]?.name || '',
};
return { kind: 'docker-container', containerName: group.containers[0]?.name || '' };
}
function stableWorkloadId(serverId, selector) {
return `workload-${crypto.createHash('sha256').update(`${serverId}:${JSON.stringify(selector)}`).digest('hex').slice(0, 24)}`;
}
function profileMatchesWorkload(profile, workload) {
if (!profile || profile.provider !== 'ssh-unraid' || profile.serverId !== workload.serverId) return false;
const identity = profile.workloadIdentity || {};
if (identity.workloadId && identity.workloadId === workload.workloadId) return true;
if (identity.selector && JSON.stringify(identity.selector) === JSON.stringify(workload.selector)) return true;
if (profile.composeProject && workload.compose?.project && profile.composeProject === workload.compose.project) {
if (!profile.composeWorkingDir || !workload.compose.workingDir || profile.composeWorkingDir === workload.compose.workingDir) return true;
}
if (profile.remoteFolder && workload.remoteFolderCandidate && profile.remoteFolder === workload.remoteFolderCandidate) return true;
return workload.containers.some((container) => container.name === profile.containerName);
}
function repositoryRemoteMap(repositories) {
const map = new Map();
for (const repository of repositories || []) {
for (const value of [repository.cloneUrl, repository.sshUrl, repository.htmlUrl, repository.preferredCloneUrl]) {
const id = remoteIdentity(value);
if (id) map.set(id, repository);
}
}
return map;
}
function candidateRepositories(workload, repositories, checkouts) {
const candidates = new Map();
const add = (repository, points, reason, exact = false, identityExact = false) => {
if (!repository?.fullName) return;
const current = candidates.get(repository.fullName) || { repositoryFullName: repository.fullName, repositoryName: repository.name, score: 0, exact: false, identityExact: false, reasons: [] };
current.score += points;
current.exact ||= exact;
current.identityExact ||= identityExact;
if (reason && !current.reasons.includes(reason)) current.reasons.push(reason);
candidates.set(repository.fullName, current);
};
const remotes = repositoryRemoteMap(repositories);
const exactRemoteHints = new Set();
for (const container of workload.containers) {
const labels = container.labels || {};
for (const value of [labels['tech.itworx.forgeflow.repository'], labels['org.opencontainers.image.source']]) {
const id = remoteIdentity(value);
if (id) exactRemoteHints.add(id);
}
}
for (const checkout of checkouts || []) {
const root = String(checkout.root || '').replace(/\/+$/, '');
const matchesPath = root && (root === workload.compose.workingDir || workload.containers.some((container) => (container.mounts || []).some((mount) => {
const source = String(mount?.Source || '').replace(/\/+$/, '');
return source === root || source.startsWith(`${root}/`);
})));
if (matchesPath) {
const id = remoteIdentity(checkout.remote);
if (id) exactRemoteHints.add(id);
}
}
for (const id of exactRemoteHints) {
const repository = remotes.get(id);
if (repository) add(repository, 100, 'Exact repository provenance from container or server checkout', true);
}
const composeProjectName = normalizedName(workload.compose.project);
const composeFolderName = normalizedName(path.basename(workload.compose.workingDir || ''));
const deploymentFolderName = normalizedName(String(workload.remoteFolderCandidate || '').split('/')[0]);
const serviceNames = new Set((workload.compose.services || []).map(normalizedName).filter(Boolean));
const containerNames = new Set(workload.containers.map((container) => normalizedName(container.name)).filter(Boolean));
const imageNames = new Set([
...workload.containers.map((container) => String(container.image || '').split('/').pop()?.split(':')[0]),
...(workload.metadata?.images || []).map((image) => String(image || '').split('/').pop()?.split(':')[0]),
].map(normalizedName).filter(Boolean));
for (const repository of repositories || []) {
const repoName = normalizedName(repository.name);
if (!repoName) continue;
if (composeProjectName && composeProjectName === repoName) add(repository, 55, 'Compose project name matches repository', false, true);
if (deploymentFolderName && deploymentFolderName === repoName) add(repository, 70, 'Top-level appdata folder exactly matches repository', false, true);
if (composeFolderName && composeFolderName === repoName) add(repository, 50, 'Compose file folder matches repository');
if (serviceNames.has(repoName)) add(repository, 25, 'Compose service name matches repository');
if (containerNames.has(repoName)) add(repository, 70, 'Container name exactly matches repository', false, true);
if (imageNames.has(repoName)) add(repository, 20, 'Container image name matches repository');
}
return [...candidates.values()].sort((a, b) => b.score - a.score || a.repositoryFullName.localeCompare(b.repositoryFullName)).map((candidate) => ({
...candidate,
reasons: candidate.exact
? candidate.reasons
: [...candidate.reasons, 'Manual confirmation is reduced to one click; Compose identity and paths are prefilled from the server.'],
confidence: candidate.exact ? 'exact' : candidate.score >= 35 ? 'strong' : 'weak',
}));
}
function buildWorkloadInventory({ inventory, server, repositories = [], profiles = [] }) {
const dockerManByName = new Map((inventory.dockerMan || []).map((item) => [String(item.name || '').toLowerCase(), item]));
const groups = new Map();
for (const container of inventory.containers || []) {
const labels = container.labels || {};
const composeProject = String(labels['com.docker.compose.project'] || '').trim();
const workingDir = canonicalServerAppdataPath(server.basePath, labels['com.docker.compose.project.working_dir']);
const configFiles = [...new Set(configFilesFor(container).map((file) => canonicalServerAppdataPath(server.basePath, file)))];
const key = composeProject
? `compose:${composeProject}:${workingDir}:${configFiles.join('|')}`
: `container:${container.name}`;
const group = groups.get(key) || {
composeProject,
workingDir,
configFiles,
services: [],
images: [],
containers: [],
dockerMan: null,
};
group.containers.push(container);
const service = String(labels['com.docker.compose.service'] || '').trim();
if (service && !group.services.includes(service)) group.services.push(service);
group.dockerMan ||= dockerManByName.get(String(container.name || '').toLowerCase()) || null;
groups.set(key, group);
}
for (const project of inventory.composeProjects || []) {
const configFiles = [...new Set((project.configFiles || []).filter(Boolean).map((file) => canonicalServerAppdataPath(server.basePath, file)))];
const workingDir = configFiles.length ? canonicalServerAppdataPath(server.basePath, path.dirname(configFiles[0])) : '';
const key = `compose:${project.name}:${workingDir}:${configFiles.join('|')}`;
if (groups.has(key)) continue;
const existingByProject = [...groups.values()].find((group) => group.composeProject === project.name);
if (existingByProject) {
if (!existingByProject.configFiles.length && configFiles.length) existingByProject.configFiles = configFiles;
if (!existingByProject.workingDir && workingDir) existingByProject.workingDir = workingDir;
continue;
}
groups.set(key, {
composeProject: project.name,
workingDir,
configFiles,
services: [],
images: [],
containers: [],
dockerMan: dockerManByName.get(String(project.name || '').toLowerCase()) || null,
composeStatus: project.status || '',
});
}
for (const definition of inventory.composeDefinitions || []) {
const configFiles = [...new Set((definition.configFiles || []).filter(Boolean).map((file) => canonicalServerAppdataPath(server.basePath, file)))];
const workingDir = canonicalServerAppdataPath(server.basePath, definition.workingDir || (configFiles[0] ? path.dirname(configFiles[0]) : ''));
if (isDeploymentBackupPath(workingDir) || configFiles.some(isDeploymentBackupPath)) continue;
const projectName = String(definition.projectName || path.basename(workingDir || '')).trim();
const existing = [...groups.values()].find((group) => {
if (workingDir && group.workingDir && group.workingDir === workingDir) return true;
if (configFiles.length && (group.configFiles || []).some((file) => configFiles.includes(file))) return true;
return Boolean(projectName && group.composeProject === projectName && (!workingDir || !group.workingDir));
});
if (existing) {
existing.composeProject ||= projectName;
existing.workingDir ||= workingDir;
existing.configFiles = [...new Set([...(existing.configFiles || []), ...configFiles])];
existing.services = [...new Set([...(existing.services || []), ...(definition.services || [])])];
existing.images = [...new Set([...(existing.images || []), ...(definition.images || [])])];
existing.composeDefinitionValid = definition.valid;
existing.composeDefinitionError = definition.error || '';
existing.composeSource = 'server-compose-file';
continue;
}
const key = `compose-file:${projectName}:${workingDir}:${configFiles.join('|')}`;
groups.set(key, {
composeProject: projectName,
workingDir,
configFiles,
services: [...new Set(definition.services || [])],
images: [...new Set(definition.images || [])],
containers: [],
dockerMan: dockerManByName.get(projectName.toLowerCase()) || null,
composeStatus: '',
composeDefinitionValid: definition.valid,
composeDefinitionError: definition.error || '',
composeSource: 'server-compose-file',
});
}
const containerNames = new Set((inventory.containers || []).map((container) => String(container.name || '').toLowerCase()));
for (const dockerMan of inventory.dockerMan || []) {
const normalized = String(dockerMan.name || '').toLowerCase();
if (!normalized || containerNames.has(normalized)) continue;
const key = `container:${dockerMan.name}`;
if (groups.has(key)) continue;
groups.set(key, {
composeProject: '',
workingDir: '',
configFiles: [],
services: [],
images: dockerMan.repository ? [dockerMan.repository] : [],
containers: [{
id: '',
name: dockerMan.name,
image: dockerMan.repository || '',
imageId: '',
running: false,
status: 'template-only',
health: null,
labels: {},
ports: {},
mounts: [],
networks: dockerMan.network ? { [dockerMan.network]: {} } : {},
restartPolicy: '',
}],
dockerMan,
});
}
const workloads = [];
for (const group of groups.values()) {
const selector = workloadSelector(group);
const workloadId = stableWorkloadId(server.id, selector);
const primary = group.containers.find((item) => item.running) || group.containers[0];
const ports = group.containers.flatMap(containerPorts);
const mounts = group.containers.flatMap((container) => container.mounts || []);
const remoteFolderCandidate = deploymentRootCandidate(safeRelativeToBase(server.basePath, canonicalServerAppdataPath(server.basePath, group.workingDir)))
|| mounts.map((mount) => topLevelRelativeToBase(server.basePath, canonicalServerAppdataPath(server.basePath, mount?.Source))).find(Boolean)
|| '';
const workload = {
workloadId,
serverId: server.id,
serverName: server.name,
kind: selector.kind,
selector,
displayName: group.composeProject || primary?.name || group.dockerMan?.name || 'Unnamed workload',
compose: {
project: group.composeProject,
workingDir: group.workingDir,
configFiles: group.configFiles,
services: group.services,
},
containers: group.containers.map((container) => ({
id: container.id,
name: container.name,
image: container.image,
imageId: container.imageId,
running: container.running === true,
status: container.status || '',
health: container.health || null,
service: container.labels?.['com.docker.compose.service'] || '',
ports: containerPorts(container),
mounts: (container.mounts || []).map((mount) => ({
type: mount?.Type || '',
source: mount?.Source || '',
target: mount?.Destination || '',
readOnly: mount?.RW === false,
})),
networks: Object.keys(container.networks || {}),
restartPolicy: container.restartPolicy || '',
})),
dockerMan: group.dockerMan,
metadata: {
webUiUrl: primary?.labels?.['net.unraid.docker.webui'] || group.dockerMan?.webUiUrl || '',
iconUrl: primary?.labels?.['net.unraid.docker.icon'] || group.dockerMan?.iconUrl || '',
shell: primary?.labels?.['net.unraid.docker.shell'] || group.dockerMan?.shell || '/bin/sh',
sourceRepository: primary?.labels?.['tech.itworx.forgeflow.repository'] || primary?.labels?.['org.opencontainers.image.source'] || '',
liveRevision: primary?.labels?.['tech.itworx.forgeflow.commit'] || primary?.labels?.['org.opencontainers.image.revision'] || '',
branch: primary?.labels?.['tech.itworx.forgeflow.branch'] || '',
composeStatus: group.composeStatus || '',
images: [...new Set(group.images || [])],
composeSource: group.composeSource || (group.configFiles?.length ? 'docker-compose-runtime' : ''),
composeDefinitionValid: group.composeDefinitionValid !== false,
composeDefinitionError: group.composeDefinitionError || '',
},
runtime: {
running: group.containers.some((container) => container.running === true),
allRunning: group.containers.length > 0 && group.containers.every((container) => container.running === true),
health: group.containers.some((container) => container.health === 'unhealthy')
? 'unhealthy'
: group.containers.length && group.containers.every((container) => container.health === 'healthy')
? 'healthy'
: 'unverified',
ports,
},
remoteFolderCandidate,
observedAt: new Date().toISOString(),
};
const matchingCheckout = (inventory.checkouts || []).find((checkout) => {
const root = String(checkout.root || '').replace(/\/+$/, '');
if (!root) return false;
if (root === workload.compose.workingDir) return true;
return mounts.some((mount) => {
const source = String(mount?.Source || '').replace(/\/+$/, '');
return source === root || source.startsWith(`${root}/`);
});
});
if (matchingCheckout) {
workload.metadata.sourceRepository ||= matchingCheckout.remote || '';
workload.metadata.liveRevision ||= matchingCheckout.liveSha || '';
workload.metadata.branch ||= matchingCheckout.branch || '';
}
workload.candidates = candidateRepositories(workload, repositories, inventory.checkouts || []);
const linked = profiles.find((profile) => profileMatchesWorkload(profile, workload));
if (linked) {
workload.link = {
status: 'linked',
profileId: linked.id,
repositoryFullName: linked.repositoryFullName || linked._repositoryFullName || '',
source: linked.workloadIdentity?.linkSource || (linked.adoptedFromServer ? 'automatic' : 'manual'),
};
workload.status = 'linked';
} else if (workload.candidates.length === 1 && workload.candidates[0].exact) workload.status = 'exact-match';
else if (workload.candidates.length) workload.status = workload.candidates[1]?.score === workload.candidates[0]?.score ? 'ambiguous' : 'suggested';
else workload.status = 'unmatched';
workloads.push(workload);
}
workloads.sort((a, b) => Number(b.runtime.running) - Number(a.runtime.running) || a.displayName.localeCompare(b.displayName));
return workloads;
}
function inventoryContainerMatch(checkout, repository, container) {
const safe = container?.Config || container?.State ? sanitizeLegacyContainer(container) : container;
if (!safe?.running) return 0;
const labels = safe.labels || {};
const workingDir = String(labels['com.docker.compose.project.working_dir'] || '').replace(/\/$/, '');
const source = remoteIdentity(labels['org.opencontainers.image.source'] || labels['tech.itworx.forgeflow.repository'] || '');
const mounts = Array.isArray(safe.mounts) ? safe.mounts : [];
const root = String(checkout.root || '').replace(/\/$/, '');
const name = String(safe.name || '').replace(/^\//, '');
const project = String(labels['com.docker.compose.project'] || '');
const expectedNames = new Set([repository.name, root.split('/').pop()].filter(Boolean).map(normalizedName));
if (workingDir && workingDir === root) return 100;
if (mounts.some((mount) => {
const mountSource = String(mount.Source || '').replace(/\/$/, '');
return mountSource === root || mountSource.startsWith(`${root}/`);
})) return 90;
if (source && source === remoteIdentity(checkout.remote)) return 85;
if (expectedNames.has(normalizedName(project))) return 70;
if (expectedNames.has(normalizedName(name))) return 60;
return 0;
}
module.exports = {
parseServerInventory,
buildWorkloadInventory,
inventoryContainerMatch,
remoteIdentity,
stableWorkloadId,
profileMatchesWorkload,
sanitizeLegacyContainer,
safeRelativeToBase,
canonicalServerAppdataPath,
deploymentRootCandidate,
};
+382 -74
View File
@@ -1,11 +1,11 @@
'use strict'; 'use strict';
const fs = require('node:fs/promises'); const fsp = require('node:fs/promises');
const crypto = require('node:crypto'); const crypto = require('node:crypto');
const path = require('node:path').posix; const path = require('node:path').posix;
function loadSshClient() { function loadSshModule() {
try { return require('ssh2').Client; } try { return require('ssh2'); }
catch { catch {
const error = new Error('The ssh2 dependency is not installed. Run npm install before configuring SSH deployments.'); const error = new Error('The ssh2 dependency is not installed. Run npm install before configuring SSH deployments.');
error.code = 'SSH2_NOT_INSTALLED'; error.code = 'SSH2_NOT_INSTALLED';
@@ -13,6 +13,10 @@ function loadSshClient() {
} }
} }
function loadSshClient() {
return loadSshModule().Client;
}
function fingerprintKey(key) { function fingerprintKey(key) {
const buffer = Buffer.isBuffer(key) ? key : Buffer.from(key); const buffer = Buffer.isBuffer(key) ? key : Buffer.from(key);
return `SHA256:${crypto.createHash('sha256').update(buffer).digest('base64').replace(/=+$/, '')}`; return `SHA256:${crypto.createHash('sha256').update(buffer).digest('base64').replace(/=+$/, '')}`;
@@ -22,13 +26,86 @@ function shellQuote(value) {
return `'${String(value ?? '').replace(/'/g, `'\\''`)}'`; return `'${String(value ?? '').replace(/'/g, `'\\''`)}'`;
} }
function parseCapabilityOutput(output) {
const marker = '__FORGEFLOW_SERVER_TEST__';
const index = String(output || '').lastIndexOf(marker);
if (index < 0) return { platform: String(output || '').trim(), docker: false, dockerReady: false, compose: false, git: false, tar: false, checksum: false };
const fields = {};
for (const line of String(output).slice(index + marker.length).trim().split(/\r?\n/)) {
const separator = line.indexOf('=');
if (separator > 0) fields[line.slice(0, separator)] = line.slice(separator + 1);
}
const decode = (value) => {
try { return value ? Buffer.from(value, 'base64').toString('utf8') : ''; }
catch { return ''; }
};
return {
platform: decode(fields.platform),
docker: fields.docker === 'true',
dockerReady: fields.dockerReady === 'true',
compose: fields.compose === 'true',
composeVersion: decode(fields.composeVersion),
git: fields.git === 'true',
tar: fields.tar === 'true',
checksum: fields.checksum === 'true',
baseWritable: fields.baseWritable === 'true',
};
}
class SshService { class SshService {
constructor({ store, diagnostics }) { constructor({ store, diagnostics, idleConnectionMs = 60_000, clientFactory = loadSshClient }) {
this.store = store; this.store = store;
this.diagnostics = diagnostics; this.diagnostics = diagnostics;
this.clientFactory = clientFactory;
// Every command used to pay for a TCP handshake, a key exchange and an
// authentication round trip. Sessions are kept per server for a short while
// so a sequence of commands shares one connection.
this.sessions = new Map();
this.idleConnectionMs = idleConnectionMs;
} }
async connectionOptions(server, { trustOnFirstUse = false } = {}) { // A connection is only reusable for a server whose identity and credentials
// are unchanged. Anything in this key changing means a new connection.
sessionKey(server) {
return JSON.stringify([
server.id,
server.host,
server.port || 22,
server.username,
server.authType,
server.privateKeyPath || '',
server.hostFingerprint || '',
]);
}
async validateServerConfiguration(server, secrets = {}) {
if (server?.authType !== 'privateKey') return { valid: true, method: 'password' };
const privateKeyPath = String(server.privateKeyPath || '').trim();
if (!privateKeyPath) throw new Error('Select a private key file.');
const stat = await fsp.stat(privateKeyPath).catch(() => null);
if (!stat?.isFile()) {
const error = new Error(`The SSH private key file was not found: ${privateKeyPath}`);
error.code = 'SSH_PRIVATE_KEY_NOT_FOUND';
throw error;
}
const existing = server.id ? this.store.getServer(server.id) : null;
const sameKey = existing && String(existing.privateKeyPath || '') === privateKeyPath;
const storedPassphrase = sameKey ? this.store.getServerCredentials(existing.id).passphrase : '';
const passphrase = Object.prototype.hasOwnProperty.call(secrets, 'passphrase') && String(secrets.passphrase || '')
? String(secrets.passphrase)
: storedPassphrase;
const key = await fsp.readFile(privateKeyPath);
const parsed = loadSshModule().utils.parseKey(key, passphrase || undefined);
const errorResult = Array.isArray(parsed) ? parsed.find((item) => item instanceof Error) : parsed instanceof Error ? parsed : null;
if (errorResult) {
const error = new Error(`The selected file is not a usable SSH private key${passphrase ? ' with the supplied passphrase' : ''}: ${errorResult.message}`);
error.code = /encrypted|passphrase|decrypt/i.test(errorResult.message) ? 'SSH_PRIVATE_KEY_PASSPHRASE_INVALID' : 'SSH_PRIVATE_KEY_INVALID';
throw error;
}
return { valid: true, method: 'privateKey', encrypted: Boolean(passphrase), privateKeyPath };
}
async connectionOptions(server, { trustOnFirstUse = false, expectedFingerprint = null } = {}) {
const credentials = this.store.getServerCredentials(server.id); const credentials = this.store.getServerCredentials(server.id);
let observedFingerprint = null; let observedFingerprint = null;
const options = { const options = {
@@ -40,13 +117,18 @@ class SshService {
keepaliveCountMax: 3, keepaliveCountMax: 3,
hostVerifier: (key) => { hostVerifier: (key) => {
observedFingerprint = fingerprintKey(key); observedFingerprint = fingerprintKey(key);
return trustOnFirstUse || Boolean(server.hostFingerprint && observedFingerprint === server.hostFingerprint); const trustedFingerprint = String(server.hostFingerprint || expectedFingerprint || '').trim();
} return trustOnFirstUse || Boolean(trustedFingerprint && observedFingerprint === trustedFingerprint);
},
}; };
if (server.authType === 'password') { if (server.authType === 'password') options.password = credentials.password;
options.password = credentials.password; else {
} else { try { options.privateKey = await fsp.readFile(server.privateKeyPath); }
options.privateKey = await fs.readFile(server.privateKeyPath); catch (error) {
const wrapped = new Error(`Could not read SSH private key ${server.privateKeyPath}: ${error.message}`);
wrapped.code = 'SSH_PRIVATE_KEY_READ_FAILED';
throw wrapped;
}
if (credentials.passphrase) options.passphrase = credentials.passphrase; if (credentials.passphrase) options.passphrase = credentials.passphrase;
} }
return { options, getObservedFingerprint: () => observedFingerprint }; return { options, getObservedFingerprint: () => observedFingerprint };
@@ -55,7 +137,115 @@ class SshService {
async withClient(serverId, action, options = {}) { async withClient(serverId, action, options = {}) {
const server = this.store.getServer(serverId); const server = this.store.getServer(serverId);
if (!server) throw new Error('The configured SSH server no longer exists.'); if (!server) throw new Error('The configured SSH server no longer exists.');
const Client = loadSshClient(); // A trust-on-first-use connection is established without checking the
// fingerprint, so it must never serve a later verified call.
if (options.trustOnFirstUse || options.expectedFingerprint) return this.withDedicatedClient(server, action, options);
return this.withPooledClient(server, action, options);
}
// Retrying is only safe while the command has not reached the server. Once a
// stream is open the remote side may already be deploying, and repeating that
// is not something this layer is allowed to decide.
isPreCommandFailure(error) {
return error?.beforeCommand === true;
}
async withPooledClient(server, action, options) {
const key = this.sessionKey(server);
for (let attempt = 0; ; attempt += 1) {
const session = await this.leaseSession(server, key, options);
try {
const result = await action(session.client, server, session.fingerprint);
this.releaseSession(session);
return result;
} catch (error) {
const staleConnection = session.reused && attempt === 0 && this.isPreCommandFailure(error);
this.discardSession(session);
if (!staleConnection) throw error;
await this.diagnostics?.debug('ssh.session.stale-retry', { serverId: server.id, host: server.host, message: error.message });
}
}
}
createSession(server, key, options) {
const entry = { key, client: null, fingerprint: null, leases: 0, dead: false, established: false, idleTimer: null, opening: null };
entry.opening = this
.withDedicatedClient(server, async (client, _server, fingerprint) => ({ client, fingerprint }), options, { keepOpen: true })
.then((opened) => {
entry.client = opened.client;
entry.fingerprint = opened.fingerprint;
entry.established = true;
// Without a standing listener an error on an idle connection is
// unhandled, which terminates the main process.
opened.client.on('error', () => this.markSessionDead(entry));
opened.client.on('close', () => this.markSessionDead(entry));
opened.client.on('end', () => this.markSessionDead(entry));
});
this.sessions.set(key, entry);
return entry;
}
async leaseSession(server, key, options) {
const pooled = this.sessions.get(key);
// Only a connection that was already up before this call may be retried on
// failure. Callers that arrive while one is still being opened share both
// the connection and its outcome.
const reused = Boolean(pooled && !pooled.dead && pooled.established);
const entry = pooled && !pooled.dead ? pooled : this.createSession(server, key, options);
entry.leases += 1;
if (entry.idleTimer) { clearTimeout(entry.idleTimer); entry.idleTimer = null; }
try {
await entry.opening;
} catch (error) {
entry.leases -= 1;
this.markSessionDead(entry);
throw error;
}
return { client: entry.client, fingerprint: entry.fingerprint, reused, entry };
}
markSessionDead(entry) {
entry.dead = true;
if (this.sessions.get(entry.key) === entry) this.sessions.delete(entry.key);
if (entry.idleTimer) { clearTimeout(entry.idleTimer); entry.idleTimer = null; }
if (entry.leases <= 0) this.endSession(entry);
}
endSession(entry) {
if (!entry.client) return;
try { entry.client.end(); } catch { /* already closed */ }
}
releaseSession(session) {
const entry = session.entry;
entry.leases -= 1;
if (entry.dead) { if (entry.leases <= 0) this.endSession(entry); return; }
if (entry.leases > 0) return;
entry.idleTimer = setTimeout(() => {
entry.idleTimer = null;
this.markSessionDead(entry);
}, this.idleConnectionMs);
entry.idleTimer.unref?.();
}
discardSession(session) {
const entry = session.entry;
entry.leases -= 1;
this.markSessionDead(entry);
}
// Closes every pooled connection. The application calls this while quitting so
// no socket outlives the process.
closeAll() {
for (const entry of [...this.sessions.values()]) {
entry.leases = 0;
this.markSessionDead(entry);
}
}
async withDedicatedClient(server, action, options = {}, { keepOpen = false } = {}) {
const serverId = server.id;
const Client = this.clientFactory();
const connection = await this.connectionOptions(server, options); const connection = await this.connectionOptions(server, options);
const client = new Client(); const client = new Client();
const started = Date.now(); const started = Date.now();
@@ -64,30 +254,31 @@ class SshService {
const finish = (callback, value) => { const finish = (callback, value) => {
if (settled) return; if (settled) return;
settled = true; settled = true;
try { client.end(); } catch {} // A session that stays in the pool is closed by the pool, not here.
if (!(keepOpen && callback === resolve)) { try { client.end(); } catch { /* already closed */ } }
callback(value); callback(value);
}; };
client.once('ready', async () => { client.once('ready', async () => {
try { try {
const data = await action(client, server, connection.getObservedFingerprint()); const data = await action(client, server, connection.getObservedFingerprint());
await this.diagnostics?.debug('ssh.connection.completed', { await this.diagnostics?.debug('ssh.connection.completed', { serverId, host: server.host, durationMs: Date.now() - started });
serverId,
host: server.host,
durationMs: Date.now() - started
});
finish(resolve, data); finish(resolve, data);
} catch (error) { finish(reject, error); } } catch (error) { finish(reject, error); }
}); });
client.once('error', async (error) => { // Deliberately not `once`: a connection that already failed can emit a
const wrapped = new Error(`SSH connection failed: ${error.message}`); // second error while it is being torn down, and an unhandled 'error' event
wrapped.code = error.code || 'SSH_CONNECTION_FAILED'; // on an EventEmitter terminates the main process.
await this.diagnostics?.warning('ssh.connection.failed', { client.on('error', async (error) => {
serverId, if (settled) return;
host: server.host, const observed = connection.getObservedFingerprint();
durationMs: Date.now() - started, const mismatch = Boolean(server.hostFingerprint && observed && server.hostFingerprint !== observed);
code: wrapped.code, const wrapped = new Error(mismatch
message: wrapped.message ? `SSH host identity changed. Expected ${server.hostFingerprint}, but the server presented ${observed}.`
}); : `SSH connection failed: ${error.message}`);
wrapped.code = mismatch ? 'SSH_HOST_KEY_MISMATCH' : (error.code || 'SSH_CONNECTION_FAILED');
wrapped.expectedFingerprint = mismatch ? server.hostFingerprint : undefined;
wrapped.observedFingerprint = mismatch ? observed : undefined;
await this.diagnostics?.warning('ssh.connection.failed', { serverId, host: server.host, durationMs: Date.now() - started, code: wrapped.code, message: wrapped.message });
finish(reject, wrapped); finish(reject, wrapped);
}); });
client.connect(connection.options); client.connect(connection.options);
@@ -96,98 +287,215 @@ class SshService {
execClient(client, command, { timeout = 15 * 60_000, maxOutput = 2 * 1024 * 1024 } = {}) { execClient(client, command, { timeout = 15 * 60_000, maxOutput = 2 * 1024 * 1024 } = {}) {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
const timer = setTimeout(() => reject(new Error('The SSH command timed out.')), timeout); let completed = false;
const timer = setTimeout(() => {
if (completed) return;
completed = true;
reject(new Error('The SSH command timed out.'));
}, timeout);
client.exec(command, (error, stream) => { client.exec(command, (error, stream) => {
if (error) { if (error) {
clearTimeout(timer); clearTimeout(timer);
completed = true;
// The channel never opened, so the command did not reach the server.
// This is the only failure the pool is allowed to retry.
error.beforeCommand = true;
reject(error); reject(error);
return; return;
} }
let stdout = ''; let stdout = '';
let stderr = ''; let stderr = '';
stream.on('data', (chunk) => { if (stdout.length < maxOutput) stdout += chunk.toString(); }); let stdoutBytes = 0;
stream.stderr.on('data', (chunk) => { if (stderr.length < maxOutput) stderr += chunk.toString(); }); let stderrBytes = 0;
let truncated = false;
const append = (target, chunk) => {
const text = chunk.toString();
const bytes = Buffer.byteLength(text);
if (target === 'stdout') {
if (stdoutBytes + bytes <= maxOutput) stdout += text;
else truncated = true;
stdoutBytes += bytes;
} else {
if (stderrBytes + bytes <= maxOutput) stderr += text;
else truncated = true;
stderrBytes += bytes;
}
};
stream.on('data', (chunk) => append('stdout', chunk));
stream.stderr.on('data', (chunk) => append('stderr', chunk));
stream.on('close', (code, signal) => { stream.on('close', (code, signal) => {
if (completed) return;
completed = true;
clearTimeout(timer); clearTimeout(timer);
if (code !== 0) { if (truncated) {
const failure = new Error(`Remote command output exceeded the ${maxOutput}-byte safety limit. ForgeFlow refused to use an incomplete result.`);
failure.code = 'SSH_OUTPUT_TRUNCATED';
failure.stdoutBytes = stdoutBytes;
failure.stderrBytes = stderrBytes;
reject(failure);
} else if (code !== 0) {
const failure = new Error(`Remote command failed with exit code ${code}: ${(stderr || stdout).trim().slice(-4000)}`); const failure = new Error(`Remote command failed with exit code ${code}: ${(stderr || stdout).trim().slice(-4000)}`);
failure.code = 'SSH_COMMAND_FAILED'; failure.code = 'SSH_COMMAND_FAILED';
failure.exitCode = code; failure.exitCode = code;
failure.signal = signal; failure.signal = signal;
reject(failure); reject(failure);
} else resolve({ stdout, stderr, exitCode: code }); } else resolve({ stdout, stderr, exitCode: code, truncated: false });
}); });
}); });
}); });
} }
async uploadBuffer(serverId, remotePath, content, { mode = 0o600 } = {}) { ensureUploadTarget(target) {
const normalized = String(target || '').replace(/\\/g, '/');
if (!normalized.startsWith('/') || normalized.includes('\0') || normalized.split('/').includes('..')) throw new Error('Remote upload path must be an absolute safe Unix path.');
return normalized;
}
async withSftp(serverId, remotePath, action) {
const server = this.store.getServer(serverId); const server = this.store.getServer(serverId);
if (!server?.hostFingerprint) { if (!server?.hostFingerprint) {
const error = new Error('Test and trust the SSH server fingerprint before uploading deployment assets.'); const error = new Error('Test and trust the SSH server fingerprint before uploading deployment assets.');
error.code = 'SSH_HOST_NOT_TRUSTED'; error.code = 'SSH_HOST_NOT_TRUSTED';
throw error; throw error;
} }
const target = String(remotePath || '').replace(/\\/g, '/'); const target = this.ensureUploadTarget(remotePath);
if (!target.startsWith('/') || target.includes('\0') || target.split('/').includes('..')) throw new Error('Remote upload path must be an absolute safe Unix path.');
const data = Buffer.isBuffer(content) ? content : Buffer.from(content);
return this.withClient(serverId, (client) => new Promise((resolve, reject) => { return this.withClient(serverId, (client) => new Promise((resolve, reject) => {
client.sftp((sftpError, sftp) => { client.sftp((sftpError, sftp) => {
if (sftpError) { reject(sftpError); return; } if (sftpError) { reject(sftpError); return; }
const directory = path.dirname(target); const parts = path.dirname(target).split('/').filter(Boolean);
const mkdirParts = directory.split('/').filter(Boolean);
let current = ''; let current = '';
const makeNext = (index) => { const ensureNext = (index) => {
if (index >= mkdirParts.length) { if (index >= parts.length) {
const stream = sftp.createWriteStream(target, { mode }); Promise.resolve(action(sftp, target)).then(resolve, reject);
stream.once('error', reject);
stream.once('close', () => resolve({ remotePath: target, size: data.length }));
stream.end(data);
return; return;
} }
current += `/${mkdirParts[index]}`; current += `/${parts[index]}`;
const ensureDirectory = () => { sftp.stat(current, (statError, attributes) => {
sftp.stat(current, (statError, attributes) => { if (!statError) {
if (!statError) { if (typeof attributes?.isDirectory === 'function' && !attributes.isDirectory()) { reject(new Error(`Remote upload parent exists but is not a directory: ${current}`)); return; }
if (typeof attributes?.isDirectory === 'function' && !attributes.isDirectory()) { ensureNext(index + 1);
reject(new Error(`Remote upload parent exists but is not a directory: ${current}`)); return;
return; }
} if (![2, 'ENOENT'].includes(statError.code)) { reject(statError); return; }
makeNext(index + 1); sftp.mkdir(current, { mode: 0o755 }, (mkdirError) => {
return; if (!mkdirError) { ensureNext(index + 1); return; }
} sftp.stat(current, (retryError, retryAttributes) => {
if (![2, 'ENOENT'].includes(statError.code)) { reject(statError); return; } if (!retryError && (typeof retryAttributes?.isDirectory !== 'function' || retryAttributes.isDirectory())) ensureNext(index + 1);
sftp.mkdir(current, { mode: 0o755 }, (mkdirError) => { else reject(mkdirError);
if (!mkdirError) { makeNext(index + 1); return; }
sftp.stat(current, (retryError, retryAttributes) => {
if (!retryError && (typeof retryAttributes?.isDirectory !== 'function' || retryAttributes.isDirectory())) makeNext(index + 1);
else reject(mkdirError);
});
}); });
}); });
}; });
ensureDirectory();
}; };
makeNext(0); ensureNext(0);
}); });
}), { trustOnFirstUse: false }); }), { trustOnFirstUse: false });
} }
async uploadFile(serverId, localPath, remotePath, options = {}) { async uploadBuffer(serverId, remotePath, content, { mode = 0o600 } = {}) {
const data = await fs.readFile(localPath); const data = Buffer.isBuffer(content) ? content : Buffer.from(content);
return this.uploadBuffer(serverId, remotePath, data, options); return this.withSftp(serverId, remotePath, (sftp, target) => new Promise((resolve, reject) => {
const stream = sftp.createWriteStream(target, { mode });
stream.once('error', reject);
stream.once('close', () => resolve({ remotePath: target, size: data.length }));
stream.end(data);
}));
} }
async test(serverId, { trustOnFirstUse = true } = {}) { async uploadFile(serverId, localPath, remotePath, { mode = 0o600, onProgress = null } = {}) {
const stat = await fsp.stat(localPath);
if (!stat.isFile()) throw new Error(`Local upload source is not a file: ${localPath}`);
return this.withSftp(serverId, remotePath, (sftp, target) => new Promise((resolve, reject) => {
const options = {
mode,
step: (totalTransferred, _chunk, total) => onProgress?.({ transferred: totalTransferred, total: total || stat.size }),
};
sftp.fastPut(localPath, target, options, (error) => {
if (error) { reject(error); return; }
resolve({ remotePath: target, size: stat.size });
});
}));
}
async probeHostFingerprint(serverId) {
const server = this.store.getServer(serverId);
if (!server) throw new Error('The configured SSH server no longer exists.');
const Client = this.clientFactory();
const client = new Client();
let observedFingerprint = null;
return new Promise((resolve, reject) => {
let settled = false;
const finish = (callback, value) => {
if (settled) return;
settled = true;
clearTimeout(timer);
try { client.end(); } catch { /* handshake already closed */ }
callback(value);
};
const completeProbe = (error = null) => {
if (observedFingerprint) {
finish(resolve, {
fingerprint: observedFingerprint,
server: { id: server.id, name: server.name, host: server.host, port: server.port || 22 },
});
return;
}
const wrapped = new Error(`Could not read the SSH host fingerprint: ${error?.message || 'the server closed the handshake'}`);
wrapped.code = error?.code || 'SSH_HOST_KEY_PROBE_FAILED';
finish(reject, wrapped);
};
const timer = setTimeout(() => completeProbe(new Error('The SSH host-key probe timed out.')), 25_000);
client.on('error', completeProbe);
client.on('close', () => completeProbe());
client.on('end', () => completeProbe());
client.connect({
host: server.host,
port: server.port || 22,
username: server.username,
readyTimeout: 20_000,
hostVerifier: (key) => {
observedFingerprint = fingerprintKey(key);
return false;
},
});
});
}
async test(serverId, { trustOnFirstUse = false, expectedFingerprint = null } = {}) {
return this.withClient(serverId, async (client, server, fingerprint) => { return this.withClient(serverId, async (client, server, fingerprint) => {
const result = await this.execClient(client, 'uname -srm && command -v git && (docker compose version || docker-compose version)', { timeout: 30_000 }); const script = `
platform=$(uname -srm 2>/dev/null || true)
docker=false; docker_ready=false; compose=false; compose_version=''; git=false; tar_ok=false; checksum=false; base_writable=false
command -v docker >/dev/null 2>&1 && docker=true
[ "$docker" = true ] && docker info >/dev/null 2>&1 && docker_ready=true
if [ "$docker" = true ]; then
if docker compose version >/dev/null 2>&1; then compose=true; compose_version=$(docker compose version 2>/dev/null | head -n1); elif command -v docker-compose >/dev/null 2>&1; then compose=true; compose_version=$(docker-compose version 2>/dev/null | head -n1); fi
fi
command -v git >/dev/null 2>&1 && git=true
command -v tar >/dev/null 2>&1 && tar_ok=true
(command -v sha256sum >/dev/null 2>&1 || command -v shasum >/dev/null 2>&1) && checksum=true
base=${shellQuote(server.basePath)}
if [ -d "$base" ]; then [ -w "$base" ] && base_writable=true; else parent=$(dirname "$base"); [ -d "$parent" ] && [ -w "$parent" ] && base_writable=true; fi
printf '__FORGEFLOW_SERVER_TEST__\\n'
printf 'platform=%s\\n' "$(printf '%s' "$platform" | base64 | tr -d '\\r\\n')"
printf 'docker=%s\\n' "$docker"
printf 'dockerReady=%s\\n' "$docker_ready"
printf 'compose=%s\\n' "$compose"
printf 'composeVersion=%s\\n' "$(printf '%s' "$compose_version" | base64 | tr -d '\\r\\n')"
printf 'git=%s\\n' "$git"
printf 'tar=%s\\n' "$tar_ok"
printf 'checksum=%s\\n' "$checksum"
printf 'baseWritable=%s\\n' "$base_writable"
`;
const result = await this.execClient(client, script, { timeout: 30_000, maxOutput: 256 * 1024 });
const capabilities = parseCapabilityOutput(result.stdout);
return { return {
connected: true, connected: true,
fingerprint, fingerprint,
server: { id: server.id, name: server.name, host: server.host, basePath: server.basePath }, server: { id: server.id, name: server.name, host: server.host, basePath: server.basePath },
output: result.stdout.trim() capabilities,
output: [capabilities.platform, capabilities.composeVersion].filter(Boolean).join('\n'),
}; };
}, { trustOnFirstUse }); }, { trustOnFirstUse, expectedFingerprint });
} }
async exec(serverId, command, options = {}) { async exec(serverId, command, options = {}) {
@@ -201,4 +509,4 @@ class SshService {
} }
} }
module.exports = { SshService, shellQuote, fingerprintKey }; module.exports = { SshService, shellQuote, fingerprintKey, parseCapabilityOutput };
+461
View File
@@ -0,0 +1,461 @@
"use strict";
function createUnraidAccessMethods({ shellQuote, path, bash, inventoryRemoteIdentity, checksSummary, crypto, parsePermissionInspection, safeRelativeRemoteFile }) {
class UnraidAccessMethods {
serverGitRemote(repository, profile) {
const candidates = [
repository.localStatus?.remoteUrl,
repository.sshUrl,
repository.preferredCloneUrl,
profile.cloneUrl,
]
.map((value) => String(value || "").trim())
.filter(Boolean);
const value = candidates.find((candidate) => /^ssh:\/\//i.test(candidate) || /^[^@\s]+@[^:\s]+:.+/.test(candidate));
if (!value) {
const error = new Error("Server pull requires the repository SSH clone URL from Gitea.");
error.code = "SERVER_GIT_SSH_URL_REQUIRED";
throw error;
}
return value;
}
serverGitHost(repository, profile) {
const remote = this.serverGitRemote(repository, profile);
if (/^ssh:\/\//i.test(remote)) {
const parsed = new URL(remote);
return { host: parsed.hostname, port: Number(parsed.port || 22) };
}
const match = remote.match(/^[^@\s]+@([^:\s]+):/);
if (!match) throw new Error("Could not determine the Gitea SSH host from the clone URL.");
return { host: match[1], port: 22 };
}
serverGitCredentialPaths(repository, server) {
const repositoryId = crypto.createHash("sha256").update(String(repository.fullName).toLowerCase()).digest("hex").slice(0, 24);
const directory = path.join(server.basePath, ".forgeflow", "git-credentials", repositoryId);
return {
directory,
privateKey: path.join(directory, "deploy-key"),
publicKey: path.join(directory, "deploy-key.pub"),
knownHosts: path.join(directory, "known_hosts"),
};
}
serverGitEnvironment(repository, profile, server) {
const credentials = this.serverGitCredentialPaths(repository, server);
return `GIT_SSH_COMMAND=${shellQuote(`ssh -i ${credentials.privateKey} -o IdentitiesOnly=yes -o BatchMode=yes -o StrictHostKeyChecking=yes -o UserKnownHostsFile=${credentials.knownHosts}`)}`;
}
async configureServerGitAccess({ repository, profileId }) {
const { profile, server } = this.resolve(repository, profileId);
const remote = this.serverGitRemote(repository, profile);
const { host, port } = this.serverGitHost(repository, profile);
const credentials = this.serverGitCredentialPaths(repository, server);
const trustedHostFingerprint = String(profile.serverGitAccess?.hostFingerprint || "").trim();
const marker = "__FORGEFLOW_DEPLOY_KEY__";
const setupScript = `
command -v git >/dev/null 2>&1 || { echo "Git is not installed on the server" >&2; exit 41; }
command -v ssh-keygen >/dev/null 2>&1 || { echo "ssh-keygen is not installed on the server" >&2; exit 42; }
command -v ssh-keyscan >/dev/null 2>&1 || { echo "ssh-keyscan is not installed on the server" >&2; exit 43; }
credential_dir=${shellQuote(credentials.directory)}
private_key=${shellQuote(credentials.privateKey)}
public_key=${shellQuote(credentials.publicKey)}
known_hosts=${shellQuote(credentials.knownHosts)}
expected_host_fingerprint=${shellQuote(trustedHostFingerprint)}
mkdir -p "$credential_dir"
chmod 700 "$credential_dir"
if [ ! -s "$private_key" ] || [ ! -s "$public_key" ]; then
rm -f "$private_key" "$public_key"
ssh-keygen -q -t ed25519 -N '' -C ${shellQuote(`forgeflow:${repository.fullName}`)} -f "$private_key"
fi
chmod 600 "$private_key"
chmod 644 "$public_key"
scan_tmp="$known_hosts.$$.tmp"
scan_ok=false
for attempt in 1 2 3; do
ssh-keyscan -T 10 -H -p ${Number(port)} ${shellQuote(host)} > "$scan_tmp" 2>/dev/null || true
if [ -s "$scan_tmp" ]; then scan_ok=true; break; fi
sleep $((attempt * 2))
done
[ "$scan_ok" = true ] || { rm -f "$scan_tmp"; echo "Gitea SSH host did not return a host key after three attempts" >&2; exit 44; }
scanned_host_fingerprint="$(ssh-keygen -lf "$scan_tmp" -E sha256 2>/dev/null | awk '{print $2}' | sort -u | paste -sd, -)"
if [ -n "$expected_host_fingerprint" ] && [ "$scanned_host_fingerprint" != "$expected_host_fingerprint" ]; then
rm -f "$scan_tmp"
echo "The Gitea SSH host key changed. Verify the Gitea server before replacing trust." >&2
exit 46
fi
mv "$scan_tmp" "$known_hosts"
chmod 600 "$known_hosts"
printf '%s\n' ${shellQuote(marker)}
printf 'publicKey=%s\n' "$(base64 < "$public_key" | tr -d '\\r\\n')"
printf 'fingerprint=%s\n' "$(ssh-keygen -lf "$public_key" -E sha256 | awk '{print $2}')"
printf 'hostFingerprint=%s\n' "$scanned_host_fingerprint"
`;
const setup = await this.ssh.exec(server.id, bash(setupScript), { timeout: 60_000, maxOutput: 256 * 1024 });
const output = String(setup.stdout || "");
const markerIndex = output.lastIndexOf(marker);
if (markerIndex < 0) throw new Error("The server did not return the generated deploy key.");
const fields = Object.fromEntries(output.slice(markerIndex + marker.length).trim().split(/\r?\n/).map((line) => {
const separator = line.indexOf("=");
return separator > 0 ? [line.slice(0, separator), line.slice(separator + 1)] : [line, ""];
}));
if (trustedHostFingerprint && fields.hostFingerprint && trustedHostFingerprint !== fields.hostFingerprint) {
const error = new Error("The Gitea SSH host key changed. Server pull was not reconfigured. Verify the Gitea server before replacing trust.");
error.code = "GITEA_SSH_HOST_KEY_MISMATCH";
throw error;
}
const publicKey = Buffer.from(fields.publicKey || "", "base64").toString("utf8").trim();
const [owner, repo] = String(repository.fullName || "").split("/");
if (!owner || !repo) throw new Error("A full Gitea repository name is required to configure server pull.");
const deployKey = await this.gitea.ensureReadOnlyDeployKey({
owner,
repo,
title: `ForgeFlow · ${server.name} · read-only`,
publicKey,
});
const probeCommand = `${this.serverGitEnvironment(repository, profile, server)} git ls-remote --exit-code ${shellQuote(remote)} ${shellQuote(`refs/heads/${profile.branch}`)}`;
const probe = await this.ssh.exec(
server.id,
bash(`probe_error=''
for attempt in 1 2 3; do
if probe_output=$(${probeCommand} 2>&1); then printf '%s\n' "$probe_output"; exit 0; fi
probe_error=$probe_output
sleep $((attempt * 2))
done
printf '%s\n' "$probe_error" >&2
exit 45`),
{ timeout: 45_000, maxOutput: 256 * 1024 },
);
const remoteSha = String(probe.stdout || "").trim().split(/\s+/)[0] || null;
const updated = await this.store.saveDeploymentProfile(repository.fullName, {
...profile,
deploymentMode: "server-git",
cloneUrl: remote,
serverGitAccess: {
configured: true,
deployKeyId: deployKey.id || null,
keyFingerprint: fields.fingerprint || null,
hostFingerprint: fields.hostFingerprint || null,
configuredAt: new Date().toISOString(),
},
});
return {
profile: updated,
created: deployKey.created === true,
remoteSha,
keyFingerprint: fields.fingerprint || null,
hostFingerprint: fields.hostFingerprint || null,
};
}
async probeServerGitAccess({ repository, profile, server }) {
try {
const remote = this.serverGitRemote(repository, profile);
const credentials = this.serverGitCredentialPaths(repository, server);
const trustedHostFingerprint = String(profile.serverGitAccess?.hostFingerprint || "").trim();
const trustedKeyFingerprint = String(profile.serverGitAccess?.keyFingerprint || "").trim();
const command = `[ -s ${shellQuote(credentials.privateKey)} ] && [ -s ${shellQuote(credentials.publicKey)} ] && [ -s ${shellQuote(credentials.knownHosts)} ] && actual_host_fingerprint="$(ssh-keygen -lf ${shellQuote(credentials.knownHosts)} -E sha256 2>/dev/null | awk '{print $2}' | sort -u | paste -sd, -)" && actual_key_fingerprint="$(ssh-keygen -lf ${shellQuote(credentials.publicKey)} -E sha256 2>/dev/null | awk '{print $2}')" && { [ -z ${shellQuote(trustedHostFingerprint)} ] || [ "$actual_host_fingerprint" = ${shellQuote(trustedHostFingerprint)} ]; } && { [ -z ${shellQuote(trustedKeyFingerprint)} ] || [ "$actual_key_fingerprint" = ${shellQuote(trustedKeyFingerprint)} ]; } && remote_output="$(${this.serverGitEnvironment(repository, profile, server)} git ls-remote --exit-code ${shellQuote(remote)} ${shellQuote(`refs/heads/${profile.branch}`)})" && remote_sha="$(printf '%s' "$remote_output" | awk 'NR==1 {print $1}')" && printf '__FORGEFLOW_SERVER_GIT_PROBE__\nremoteSha=%s\nkeyFingerprint=%s\nhostFingerprint=%s\n' "$remote_sha" "$actual_key_fingerprint" "$actual_host_fingerprint"`;
const result = await this.ssh.exec(server.id, bash(command), { timeout: 45_000, maxOutput: 256 * 1024 });
const output = String(result.stdout || "");
const marker = output.lastIndexOf("__FORGEFLOW_SERVER_GIT_PROBE__");
if (marker < 0) throw new Error("The server pull probe did not return verifiable fingerprint evidence.");
const fields = Object.fromEntries(output.slice(marker + "__FORGEFLOW_SERVER_GIT_PROBE__".length).trim().split(/\r?\n/).map((line) => {
const separator = line.indexOf("=");
return separator > 0 ? [line.slice(0, separator), line.slice(separator + 1)] : [line, ""];
}));
return { ready: true, remoteSha: fields.remoteSha || null, keyFingerprint: fields.keyFingerprint || null, hostFingerprint: fields.hostFingerprint || null };
} catch (error) {
return { ready: false, error: error.message };
}
}
async verifyServerGitProfile({ repository, profileId }) {
const { profile, server, remotePath } = this.resolve(repository, profileId);
const checks = [];
const add = (id, label, status, detail, evidence = {}) => checks.push({ id, label, status, detail, evidence });
if (profile.deploymentMode === "monitor-only") {
add("mode", "Deployment mode", "warning", "This profile is monitoring only and cannot deploy.");
return { readiness: "Monitoring only", ready: false, checkedAt: new Date().toISOString(), repository: repository.fullName, profileId, checks };
}
if (profile.deploymentMode !== "server-git") {
add("mode", "Deployment mode", "unsupported", "Read-only server-pull verification applies only to Server pull profiles.");
return { readiness: "Unsupported", ready: false, checkedAt: new Date().toISOString(), repository: repository.fullName, profileId, checks };
}
let branchSha = null;
try {
const [owner, repo] = String(repository.fullName || "").split("/");
const branch = await this.gitea.getBranch(owner, repo, profile.branch);
branchSha = branch?.commit?.id || branch?.commit?.sha || null;
add("remote-branch", "Gitea branch", branchSha ? "pass" : "fail", branchSha ? `${profile.branch} at ${branchSha}` : `${profile.branch} did not return a commit SHA.`, { branch: profile.branch, sha: branchSha });
const keys = await this.gitea.listDeployKeys(owner, repo);
const keyId = Number(profile.serverGitAccess?.deployKeyId);
const key = keys.find((item) => Number(item.id) === keyId);
add("deploy-key-scope", "Repository deploy key", key?.read_only === true ? "pass" : "fail", !key ? "The configured deploy key is no longer present in Gitea." : key.read_only === true ? `Key ${key.id} is repository-scoped and read-only.` : `Key ${key.id} has write access and is blocked.`, { keyId: key?.id || keyId || null, readOnly: key?.read_only === true });
} catch (error) {
add("gitea-access", "Gitea verification", "fail", error.message);
}
const access = await this.probeServerGitAccess({ repository, profile, server });
add("server-git-access", "Unraid to Gitea", access.ready ? "pass" : "fail", access.ready ? `Exact branch access verified at ${String(access.remoteSha || "unknown").slice(0, 12)}.` : access.error, access);
let inspection = null;
try {
inspection = await this.inspect({ repository, profileId });
const expectedCompose = profile.generatedCompose ? [".forgeflow/compose.forgeflow.yml"] : this.deploymentComposeFiles(profile);
const composePresent = !inspection.exists || expectedCompose.every((file) => inspection.composeFiles.includes(file));
add("deployment-directory", "Deployment directory", inspection.exists ? "pass" : "warning", inspection.exists ? remotePath : `${remotePath} will be created on first deployment.`, { remotePath, exists: inspection.exists });
add("compose", "Compose configuration", composePresent ? "pass" : "warning", composePresent ? expectedCompose.join(", ") : `Expected after deployment: ${expectedCompose.join(", ")}.`, { files: expectedCompose });
add("preserved-paths", "Preserved runtime paths", "pass", (profile.preservePaths || []).length ? profile.preservePaths.join(", ") : "No preserved runtime paths configured.", { paths: profile.preservePaths || [] });
add("environment-requirements", "Environment requirements", "pass", (profile.detectedMetadata?.envNames || []).length ? `${profile.detectedMetadata.envNames.length} variable name(s) detected; values remain hidden.` : "No environment variable names were detected in server metadata.", { names: profile.detectedMetadata?.envNames || [] });
} catch (error) {
add("server-inspection", "Server inspection", "fail", error.message);
}
const state = this.store.getDeploymentState(profile.id) || {};
const liveSha = state.liveSha || inspection?.head || null;
const running = state.containerRunning;
const healthy = state.healthy;
add("live-commit", "Live server commit", liveSha ? "pass" : "warning", liveSha || "No verifiable live commit is currently recorded.", { liveSha });
add("commit-parity", "Gitea and server parity", branchSha && liveSha && branchSha === liveSha ? "pass" : branchSha && liveSha ? "warning" : "incomplete", branchSha && liveSha ? branchSha === liveSha ? "The exact Gitea commit is live." : `Live ${String(liveSha).slice(0, 12)} differs from Gitea ${String(branchSha).slice(0, 12)}.` : "Parity cannot be proven until both SHAs are available.", { branchSha, liveSha });
add("runtime", "Container runtime", running === true ? "pass" : running === false ? "fail" : "incomplete", running === true ? "The linked container is running." : running === false ? "The linked container is stopped." : "Runtime state has not been verified.");
add("health", "Runtime health", healthy === true ? "pass" : healthy === false ? "fail" : "incomplete", healthy === true ? "Runtime health passed." : healthy === false ? "Runtime health failed." : "No conclusive runtime health evidence is available.");
const deploymentCheckIds = new Set(["gitea-access", "remote-branch", "deploy-key-scope", "server-git-access", "server-inspection"]);
const deploymentBlockers = checks.filter((item) => deploymentCheckIds.has(item.id) && item.status !== "pass");
const deployReady = Boolean(branchSha) && deploymentBlockers.length === 0;
const failed = checks.some((item) => item.status === "fail");
const incomplete = checks.some((item) => ["warning", "incomplete", "unsupported"].includes(item.status));
const readiness = deploymentBlockers.length
? "Access failed"
: failed
? "Deploy-ready; runtime unhealthy"
: incomplete
? (branchSha && liveSha && branchSha !== liveSha ? "Deployable update available" : "Deploy-ready; runtime verification incomplete")
: "Ready";
return { readiness, ready: deployReady, deployReady, deploymentBlockers, checkedAt: new Date().toISOString(), repository: repository.fullName, profileId, server: { id: server.id, name: server.name }, remotePath, branch: profile.branch, branchSha, liveSha, checks };
}
permissionTargets(profile, server, remotePath) {
const targets = [
{
id: "server-base",
label: "Configured deployment base",
path: server.basePath,
kind: "directory",
required: false,
},
{
id: "project-root",
label: "Project folder",
path: remotePath,
kind: "directory",
required: true,
},
{
id: "forgeflow-state",
label: "ForgeFlow upload and rollback storage",
path: path.join(remotePath, ".forgeflow"),
kind: "directory",
required: true,
},
{
id: "forgeflow-incoming",
label: "ForgeFlow incoming upload folder",
path: path.join(remotePath, ".forgeflow", "incoming"),
kind: "directory",
required: true,
},
];
if (!profile.generatedCompose) {
for (const file of this.deploymentComposeFiles(profile)) {
targets.push({
id: `compose:${file}`,
label: `Compose file ${file}`,
path: path.join(remotePath, file),
kind: "file",
required: true,
});
}
}
const unique = new Map();
for (const target of targets) unique.set(`${target.kind}:${target.path}`, target);
return [...unique.values()];
}
permissionInspectionScript(profile, server, remotePath) {
const targetCalls = this.permissionTargets(profile, server, remotePath)
.map(
(target) =>
`probe ${shellQuote(target.id)} ${shellQuote(target.label)} ${shellQuote(target.path)} ${shellQuote(target.kind)} ${target.required ? "true" : "false"}`,
)
.join("\n");
return `
encode() { printf '%s' "$1" | base64 | tr -d '\\r\\n'; }
can_elevate=false
[ "$(id -u)" = 0 ] && can_elevate=true
if [ "$can_elevate" != true ] && command -v sudo >/dev/null 2>&1 && sudo -n true >/dev/null 2>&1; then can_elevate=true; fi
has_acl=false
command -v setfacl >/dev/null 2>&1 && has_acl=true
printf '__FORGEFLOW_PERMISSIONS__\\n'
printf 'I\\t%s\\t%s\\t%s\\t%s\\t%s\\t%s\\n' \
"$(encode "$(id -un 2>/dev/null || echo unknown)")" \
"$(id -u 2>/dev/null || echo -1)" \
"$(id -g 2>/dev/null || echo -1)" \
"$(encode "$(id -Gn 2>/dev/null || true)")" \
"$has_acl" "$can_elevate"
probe() {
target_id=$1
label=$2
target=$3
kind=$4
required=$5
exists=false; readable=false; writable=false; parent_writable=false; effective=false
owner=''; group=''; mode=''; detail=''; nearest=''
if [ -e "$target" ] || [ -L "$target" ]; then
exists=true
[ -r "$target" ] && readable=true
[ -w "$target" ] && writable=true
owner=$(stat -c '%U' "$target" 2>/dev/null || true)
group=$(stat -c '%G' "$target" 2>/dev/null || true)
mode=$(stat -c '%a' "$target" 2>/dev/null || true)
fi
parent=$(dirname "$target")
ancestor=$parent
while [ ! -d "$ancestor" ] && [ "$ancestor" != / ]; do ancestor=$(dirname "$ancestor"); done
nearest=$ancestor
marker="$ancestor/.forgeflow-write-test-$$-\${RANDOM:-0}"
if [ -d "$ancestor" ] && (umask 077; : > "$marker") 2>/dev/null; then
rm -f -- "$marker" >/dev/null 2>&1 || true
parent_writable=true
fi
if [ "$kind" = directory ]; then
if [ -d "$target" ]; then
marker="$target/.forgeflow-write-test-$$-\${RANDOM:-0}"
if (umask 077; : > "$marker") 2>/dev/null; then
rm -f -- "$marker" >/dev/null 2>&1 || true
effective=true
fi
elif [ "$parent_writable" = true ]; then
effective=true
fi
else
if [ "$exists" = true ] && [ ! -f "$target" ]; then
detail='Path exists but is not a regular file.'
elif [ "$exists" = true ] && [ "$readable" = true ] && { [ "$writable" = true ] || [ "$parent_writable" = true ]; }; then
effective=true
elif [ "$exists" = false ] && [ "$parent_writable" = true ]; then
effective=true
detail='File is absent but can be created by the deployment user.'
fi
fi
if [ -z "$detail" ]; then
if [ "$effective" = true ]; then detail='Read/write probe passed.'
else detail="No safe create/replace access for $(id -un 2>/dev/null || echo 'the SSH user')."; fi
fi
printf 'P\\t%s\\t%s\\t%s\\t%s\\t%s\\t%s\\t%s\\t%s\\t%s\\t%s\\t%s\\t%s\\t%s\\t%s\\t%s\\n' \
"$(encode "$target_id")" "$(encode "$label")" "$(encode "$target")" "$kind" "$required" \
"$exists" "$readable" "$writable" "$parent_writable" "$effective" \
"$(encode "$owner")" "$(encode "$group")" "$mode" "$(encode "$nearest")" "$(encode "$detail")"
}
${targetCalls}
`;
}
async inspectWriteAccess({ repository, profileId }) {
const { profile, server, remotePath } = this.resolve(repository, profileId);
const result = await this.ssh.exec(
server.id,
bash(this.permissionInspectionScript(profile, server, remotePath)),
{ timeout: 45_000, maxOutput: 2 * 1024 * 1024 },
);
const report = parsePermissionInspection(result.stdout);
report.serverId = server.id;
report.remotePath = remotePath;
return report;
}
permissionRepairScript(profile, server, remotePath) {
const preserve = [
".git",
"node_modules",
".venv",
"venv",
"__pycache__",
...(profile.preservePaths || []),
]
.map((value) => safeRelativeRemoteFile(value))
.filter(Boolean);
const pruneExpression = preserve.length
? preserve
.map((value) => `-path ${shellQuote(path.join(remotePath, value))} -o -path ${shellQuote(path.join(remotePath, value, "*"))}`)
.join(" -o ")
: "-false";
const composePaths = this.deploymentComposeFiles(profile)
.map((file) => shellQuote(path.join(remotePath, file)))
.join(" ");
return `
root=${shellQuote(remotePath)}
base=${shellQuote(server.basePath)}
case "$root" in "$base"|"$base"/*) ;; *) echo "Refusing permission repair outside configured base path: $root" >&2; exit 81 ;; esac
run_privileged() {
if [ "$(id -u)" = 0 ]; then "$@";
elif command -v sudo >/dev/null 2>&1 && sudo -n true >/dev/null 2>&1; then sudo -n "$@";
else "$@";
fi
}
mkdir_cmd=mkdir
if ! mkdir -p "$root/.forgeflow/incoming" "$root/.forgeflow/releases" "$root/.forgeflow/staging" "$root/.forgeflow/backups" 2>/dev/null; then
run_privileged mkdir -p "$root/.forgeflow/incoming" "$root/.forgeflow/releases" "$root/.forgeflow/staging" "$root/.forgeflow/backups"
fi
share_group=$(getent group users >/dev/null 2>&1 && echo users || id -gn)
if command -v setfacl >/dev/null 2>&1; then
run_privileged setfacl -m "u:$(id -un):rwx,g:$share_group:rwx,m:rwx" "$root" "$root/.forgeflow" "$root/.forgeflow/incoming" "$root/.forgeflow/releases" "$root/.forgeflow/staging" "$root/.forgeflow/backups" 2>/dev/null || true
run_privileged setfacl -d -m "u:$(id -un):rwx,g:$share_group:rwx,m:rwx" "$root" "$root/.forgeflow" "$root/.forgeflow/incoming" "$root/.forgeflow/releases" "$root/.forgeflow/staging" "$root/.forgeflow/backups" 2>/dev/null || true
fi
run_privileged chgrp "$share_group" "$root" "$root/.forgeflow" "$root/.forgeflow/incoming" "$root/.forgeflow/releases" "$root/.forgeflow/staging" "$root/.forgeflow/backups" 2>/dev/null || true
run_privileged chmod 2775 "$root" "$root/.forgeflow" "$root/.forgeflow/incoming" "$root/.forgeflow/releases" "$root/.forgeflow/staging" "$root/.forgeflow/backups"
if [ -d "$root" ]; then
while IFS= read -r -d '' entry; do
case "$entry" in
"$root/.forgeflow"|"$root/.forgeflow"/*) continue ;;
esac
run_privileged chgrp "$share_group" "$entry" 2>/dev/null || true
if [ -d "$entry" ]; then run_privileged chmod u+rwx,g+rwx,g+s "$entry"; else run_privileged chmod u+rw,g+rw "$entry"; fi
done < <(find "$root" -mindepth 1 \\( ${pruneExpression} \\) -prune -o -print0)
fi
for compose_file in ${composePaths || ""}; do
[ -e "$compose_file" ] || continue
run_privileged chgrp "$share_group" "$compose_file" 2>/dev/null || true
run_privileged chmod u+rw,g+rw "$compose_file"
done
echo "ForgeFlow repaired project write access for $(id -un) and group $share_group without changing preserved runtime paths."
`;
}
async repairWriteAccess({ repository, profileId }) {
const { profile, server, remotePath } = this.resolve(repository, profileId);
const before = await this.inspectWriteAccess({ repository, profileId });
await this.ssh.exec(server.id, bash(this.permissionRepairScript(profile, server, remotePath)), {
timeout: 5 * 60_000,
maxOutput: 4 * 1024 * 1024,
});
const after = await this.inspectWriteAccess({ repository, profileId });
if (!after.ready) {
const error = new Error(
`Write-access repair did not make every required path writable: ${after.blocking.map((item) => item.path).join(", ")}`,
);
error.code = "WRITE_ACCESS_REPAIR_INCOMPLETE";
error.permissionReport = after;
throw error;
}
await this.diagnostics?.info("unraid.write-access.repaired", {
repository: repository.fullName,
profileId,
serverId: server.id,
remotePath,
user: after.identity.user,
});
return { changed: true, normalized: true, before, after };
}
}
return UnraidAccessMethods.prototype;
}
module.exports = { createUnraidAccessMethods };
+79
View File
@@ -0,0 +1,79 @@
"use strict";
const crypto = require("node:crypto");
const path = require("node:path").posix;
const { shellQuote } = require("./ssh-service.cjs");
const bash = (command) => `printf '%s' ${shellQuote(Buffer.from(`set -euo pipefail\nexport GIT_TERMINAL_PROMPT=0\n${command}`, "utf8").toString("base64"))} | base64 -d | bash`;
function parseMarker(stdout, marker) {
const text = String(stdout || "");
const index = text.lastIndexOf(marker);
if (index < 0) throw new Error(`Server key operation did not return ${marker}.`);
return Object.fromEntries(text.slice(index + marker.length).trim().split(/\r?\n/).map((line) => { const separator = line.indexOf("="); return separator > 0 ? [line.slice(0, separator), line.slice(separator + 1)] : [line, ""]; }));
}
class UnraidDeployKeyHost {
constructor({ ssh }) { this.ssh = ssh; }
paths(repository, server) {
const id = crypto.createHash("sha256").update(String(repository.fullName).toLowerCase()).digest("hex").slice(0, 24);
const directory = path.join(server.basePath, ".forgeflow", "git-credentials", id);
return { directory, privateKey: path.join(directory, "deploy-key"), publicKey: path.join(directory, "deploy-key.pub"), knownHosts: path.join(directory, "known_hosts"), recovery: path.join(directory, "recovery") };
}
remote(repository, profile) {
const value = [repository.localStatus?.remoteUrl, repository.sshUrl, repository.preferredCloneUrl, profile.cloneUrl].map((item) => String(item || "").trim()).find((item) => /^ssh:\/\//i.test(item) || /^[^@\s]+@[^:\s]+:.+/.test(item));
if (!value) throw Object.assign(new Error("Server pull requires a Gitea SSH URL."), { code: "SERVER_GIT_SSH_URL_REQUIRED" });
return value;
}
environment(paths) { return `GIT_SSH_COMMAND=${shellQuote(`ssh -i ${paths.privateKey} -o IdentitiesOnly=yes -o BatchMode=yes -o StrictHostKeyChecking=yes -o UserKnownHostsFile=${paths.knownHosts}`)}`; }
async execute(server, script, options = {}) { return this.ssh.exec(server.id, bash(script), { timeout: options.timeout || 30_000, maxOutput: options.maxOutput || 128 * 1024 }); }
async inspect({ repository, server }) {
const p = this.paths(repository, server); const marker = "__FORGEFLOW_KEY_INSPECT__";
const script = `printf '%s\\n' ${shellQuote(marker)}; printf 'privateKeyPresent=%s\\n' "$([ -s ${shellQuote(p.privateKey)} ] && echo true || echo false)"; printf 'publicKey=%s\\n' "$([ -s ${shellQuote(p.publicKey)} ] && base64 < ${shellQuote(p.publicKey)} | tr -d '\\r\\n' || true)"; printf 'fingerprint=%s\\n' "$([ -s ${shellQuote(p.publicKey)} ] && ssh-keygen -lf ${shellQuote(p.publicKey)} -E sha256 | awk '{print $2}' || true)"; printf 'hostFingerprint=%s\\n' "$([ -s ${shellQuote(p.knownHosts)} ] && ssh-keygen -lf ${shellQuote(p.knownHosts)} -E sha256 | awk '{print $2}' | sort -u | paste -sd, - || true)"`;
const f = parseMarker((await this.execute(server, script)).stdout, marker);
return { privateKeyPresent: f.privateKeyPresent === "true", publicKey: f.publicKey ? Buffer.from(f.publicKey, "base64").toString("utf8").trim() : null, fingerprint: f.fingerprint || null, hostFingerprint: f.hostFingerprint || null };
}
async backup({ repository, server }) {
const p = this.paths(repository, server); const slot = path.join(p.recovery, `backup-${Date.now()}-${crypto.randomUUID()}`); const marker = "__FORGEFLOW_KEY_BACKUP__";
const script = `umask 077; mkdir -p ${shellQuote(slot)}; for name in deploy-key deploy-key.pub known_hosts; do [ ! -e ${shellQuote(p.directory)}/"$name" ] || cp -p ${shellQuote(p.directory)}/"$name" ${shellQuote(slot)}/"$name"; done; printf '%s\\n' ${shellQuote(marker)}; printf 'recovery=%s\\n' ${shellQuote(slot)}; printf 'publicKey=%s\\n' "$([ -s ${shellQuote(p.publicKey)} ] && base64 < ${shellQuote(p.publicKey)} | tr -d '\\r\\n' || true)"`;
const f = parseMarker((await this.execute(server, script)).stdout, marker);
return { recovery: f.recovery, publicKey: f.publicKey ? Buffer.from(f.publicKey, "base64").toString("utf8").trim() : null };
}
async generate({ repository, server }) {
const active = this.paths(repository, server); const directory = path.join(active.directory, `candidate-${crypto.randomUUID()}`); const p = { directory, privateKey: path.join(directory, "deploy-key"), publicKey: path.join(directory, "deploy-key.pub"), knownHosts: path.join(directory, "known_hosts") }; const marker = "__FORGEFLOW_KEY_CANDIDATE__";
const script = `umask 077; mkdir -p ${shellQuote(directory)}; ssh-keygen -q -t ed25519 -N '' -C ${shellQuote(`forgeflow-rotation:${repository.fullName}`)} -f ${shellQuote(p.privateKey)}; cp -p ${shellQuote(active.knownHosts)} ${shellQuote(p.knownHosts)}; chmod 600 ${shellQuote(p.privateKey)} ${shellQuote(p.knownHosts)}; chmod 644 ${shellQuote(p.publicKey)}; printf '%s\\n' ${shellQuote(marker)}; printf 'publicKey=%s\\n' "$(base64 < ${shellQuote(p.publicKey)} | tr -d '\\r\\n')"; printf 'fingerprint=%s\\n' "$(ssh-keygen -lf ${shellQuote(p.publicKey)} -E sha256 | awk '{print $2}')"; printf 'hostFingerprint=%s\\n' "$(ssh-keygen -lf ${shellQuote(p.knownHosts)} -E sha256 | awk '{print $2}' | sort -u | paste -sd, -)"`;
const f = parseMarker((await this.execute(server, script)).stdout, marker);
return { paths: p, publicKey: Buffer.from(f.publicKey, "base64").toString("utf8").trim(), fingerprint: f.fingerprint, hostFingerprint: f.hostFingerprint };
}
async verifyCandidate({ repository, profile, server, candidate }) {
const marker = "__FORGEFLOW_KEY_PROOF__"; const remote = this.remote(repository, profile); const p = candidate.paths;
const script = `output="$(${this.environment(p)} git ls-remote --exit-code ${shellQuote(remote)} ${shellQuote(`refs/heads/${profile.branch}`)})"; printf '%s\\n' ${shellQuote(marker)}; printf 'remoteSha=%s\\n' "$(printf '%s' "$output" | awk 'NR==1 {print $1}')"; printf 'fingerprint=%s\\n' "$(ssh-keygen -lf ${shellQuote(p.publicKey)} -E sha256 | awk '{print $2}')"; printf 'hostFingerprint=%s\\n' "$(ssh-keygen -lf ${shellQuote(p.knownHosts)} -E sha256 | awk '{print $2}' | sort -u | paste -sd, -)"`;
const f = parseMarker((await this.execute(server, script, { timeout: 45_000, maxOutput: 256 * 1024 })).stdout, marker);
return { ready: /^[0-9a-f]{40}$/i.test(f.remoteSha || ""), remoteSha: f.remoteSha || null, fingerprint: f.fingerprint || null, hostFingerprint: f.hostFingerprint || null };
}
// A caller that just verified this candidate passes its proof in. Re-running
// `git ls-remote` would open a second SSH connection to ask the same question,
// with nothing in between that could change the answer.
async preflightCandidate(context) { const proof = context?.proof?.remoteSha ? context.proof : await this.verifyCandidate(context); if (!proof.ready) throw new Error("Candidate preflight did not prove the remote branch."); return proof; }
async promote({ repository, server, candidate }) {
const p = this.paths(repository, server); const c = candidate.paths;
await this.execute(server, `test -s ${shellQuote(c.privateKey)}; test -s ${shellQuote(c.publicKey)}; test -s ${shellQuote(c.knownHosts)}; cp -p ${shellQuote(c.privateKey)} ${shellQuote(p.privateKey)}.new; cp -p ${shellQuote(c.publicKey)} ${shellQuote(p.publicKey)}.new; cp -p ${shellQuote(c.knownHosts)} ${shellQuote(p.knownHosts)}.new; mv ${shellQuote(p.privateKey)}.new ${shellQuote(p.privateKey)}; mv ${shellQuote(p.publicKey)}.new ${shellQuote(p.publicKey)}; mv ${shellQuote(p.knownHosts)}.new ${shellQuote(p.knownHosts)}`);
}
async verifyActive({ repository, profile, server }) { const paths = this.paths(repository, server); return this.verifyCandidate({ repository, profile, server, candidate: { paths } }); }
async rollback({ repository, server, candidate, previous }) {
const p = this.paths(repository, server); const recovery = previous.key.recovery;
await this.execute(server, `for name in deploy-key deploy-key.pub known_hosts; do test ! -s ${shellQuote(recovery)}/"$name" || cp -p ${shellQuote(recovery)}/"$name" ${shellQuote(p.directory)}/"$name"; done; rm -rf -- ${shellQuote(candidate.paths.directory)}`);
}
async commit({ server, candidate }) { await this.execute(server, `rm -rf -- ${shellQuote(candidate.paths.directory)}`); }
async revoke({ repository, server }) {
const p = this.paths(repository, server); const revoked = path.join(p.recovery, `revoked-${Date.now()}-${crypto.randomUUID()}`);
await this.execute(server, `umask 077; mkdir -p ${shellQuote(revoked)}; for name in deploy-key deploy-key.pub known_hosts; do [ ! -e ${shellQuote(p.directory)}/"$name" ] || mv ${shellQuote(p.directory)}/"$name" ${shellQuote(revoked)}/"$name"; done`);
}
async restore({ repository, server }) {
const p = this.paths(repository, server); const marker = "__FORGEFLOW_KEY_RESTORE__";
const script = `slot="$(find ${shellQuote(p.recovery)} -mindepth 1 -maxdepth 1 -type d -print 2>/dev/null | sort | tail -1)"; test -n "$slot"; for name in deploy-key deploy-key.pub known_hosts; do test -s "$slot/$name"; cp -p "$slot/$name" ${shellQuote(p.directory)}/"$name"; done; printf '%s\\n' ${shellQuote(marker)}; printf 'publicKey=%s\\n' "$(base64 < ${shellQuote(p.publicKey)} | tr -d '\\r\\n')"; printf 'fingerprint=%s\\n' "$(ssh-keygen -lf ${shellQuote(p.publicKey)} -E sha256 | awk '{print $2}')"; printf 'hostFingerprint=%s\\n' "$(ssh-keygen -lf ${shellQuote(p.knownHosts)} -E sha256 | awk '{print $2}' | sort -u | paste -sd, -)"`;
const f = parseMarker((await this.execute(server, script)).stdout, marker);
return { publicKey: Buffer.from(f.publicKey, "base64").toString("utf8").trim(), fingerprint: f.fingerprint, hostFingerprint: f.hostFingerprint };
}
}
module.exports = { UnraidDeployKeyHost, parseDeployKeyMarker: parseMarker };
+582
View File
@@ -0,0 +1,582 @@
"use strict";
function createUnraidDeploymentMethods({
path, crypto, bash, shellQuote, assertFullCommitSha, nativePath, fs,
}) {
class UnraidDeploymentMethods {
pushBundleScript({ repository, profile, remotePath, targetSha, requestId, remotePart, digest, metadata, generated, iconReference, rollback = false }) {
const compose = this.composeInvocation(profile, repository);
const project = String(
profile.composeProject || this.internalSlug(profile, repository),
).trim();
const candidateFiles = [...this.deploymentComposeFiles(profile)];
if (profile.generatedCompose) candidateFiles.push(".forgeflow/compose.metadata.yml");
const candidateCompose = `forgeflow_compose -p ${shellQuote(project)} ${candidateFiles
.map((file) => `-f "$release"/${shellQuote(file)}`)
.join(" ")}`;
const preservePayload = Buffer.from(
[".forgeflow", ".git", ...(profile.preservePaths || [])].join("\n"),
"utf8",
).toString("base64");
const statusJson = this.deploymentStatusDocument({
repository,
profile,
targetSha,
requestId,
rollback,
});
const verification = this.containerVerificationScript(
profile,
repository,
compose,
{ requireRecreated: true },
);
const containerHint = String(
profile.containerName || profile.remoteFolder || repository.name || "",
).trim();
return `
root=${shellQuote(remotePath)}
expected_project=${shellQuote(project)}
tracked_container_hint=${shellQuote(containerHint)}
target=${shellQuote(targetSha)}
request_id=${shellQuote(requestId)}
incoming=${shellQuote(remotePart)}
expected_digest=${shellQuote(digest)}
release_root="$root/.forgeflow/releases/$target"
release="$release_root/source"
staging="$root/.forgeflow/staging/$request_id"
backup="$root/.forgeflow/backups/$request_id"
lock="$root/.forgeflow/deploy.lock"
mkdir -p "$root/.forgeflow/incoming" "$root/.forgeflow/releases" "$root/.forgeflow/staging" "$root/.forgeflow/backups"
if [ -d "$lock" ] && find "$lock" -maxdepth 0 -mmin +120 -print -quit | grep -q .; then
lock_pid=$(cat "$lock/pid" 2>/dev/null || true)
if [ -z "$lock_pid" ] || ! kill -0 "$lock_pid" 2>/dev/null; then rm -rf "$lock"; fi
fi
mkdir "$lock" 2>/dev/null || { echo "Another ForgeFlow deployment is active for $root" >&2; exit 70; }
printf '%s\n' "$request_id" > "$lock/request-id"
printf '%s\n' "$$" > "$lock/pid"
date -u +%Y-%m-%dT%H:%M:%SZ > "$lock/started-at"
restore_needed=false
activation_started=false
is_preserved() {
rel="$1"
while IFS= read -r keep; do
[ -n "$keep" ] || continue
if [ "$rel" = "$keep" ] || [[ "$rel" == "$keep/"* ]]; then return 0; fi
done < "$staging.preserve"
return 1
}
restore_files() {
if [ -f "$backup/present" ]; then
while IFS= read -r rel; do
[ -n "$rel" ] || continue
mkdir -p -- "$root/$(dirname "$rel")"
temp="$root/$rel.forgeflow-restore-$request_id"
cp -a -- "$backup/source/$rel" "$temp" && mv -f -- "$temp" "$root/$rel"
done < "$backup/present"
fi
if [ -f "$backup/absent" ]; then
while IFS= read -r rel; do
[ -n "$rel" ] || continue
case "$rel" in .forgeflow/*) continue ;; esac
[ -e "$root/$rel" ] || [ -L "$root/$rel" ] || continue
rm -f -- "$root/$rel"
done < "$backup/absent"
fi
if [ -f "$backup/generated.present" ]; then
cp -a "$backup/compose.forgeflow.yml" "$root/.forgeflow/compose.forgeflow.yml"
elif [ -f "$backup/generated.created" ]; then
rm -f "$root/.forgeflow/compose.forgeflow.yml"
fi
if [ -f "$backup/metadata.present" ]; then
cp -a "$backup/compose.metadata.yml" "$root/.forgeflow/compose.metadata.yml"
elif [ -f "$backup/metadata.created" ]; then
rm -f "$root/.forgeflow/compose.metadata.yml"
fi
}
restore_images() {
[ -f "$backup/containers.before" ] || return 0
while IFS=$'\t' read -r service container_id image_id image_ref_b64; do
[ -n "$image_id" ] || continue
docker image inspect "$image_id" >/dev/null 2>&1 || continue
image_ref=$(printf '%s' "$image_ref_b64" | base64 -d 2>/dev/null || true)
case "$image_ref" in ''|sha256:*|*@sha256:*) continue ;; esac
docker image tag "$image_id" "$image_ref" >/dev/null 2>&1 || true
done < "$backup/containers.before"
}
restore_runtime() {
[ "$activation_started" = true ] || return 0
restore_images
if cd "$root" 2>/dev/null && ${compose} config >/dev/null 2>&1; then
${compose} up -d --no-build >/dev/null 2>&1 || return 1
old_services=$(${compose} config --services 2>/dev/null | sed '/^$/d')
printf '%s\n' "$old_services" | while IFS= read -r service; do
[ -n "$service" ] || continue
old_id=$(${compose} ps -q "$service" | head -n1)
[ -n "$old_id" ] || exit 1
[ "$(docker inspect -f '{{.State.Running}}' "$old_id" 2>/dev/null || echo false)" = true ] || exit 1
done
fi
}
finish() {
status=$?
trap - EXIT
set +e
if [ "$status" -ne 0 ] && [ "$restore_needed" = true ]; then
restore_files
if ! restore_runtime; then
echo "CRITICAL: source files were restored, but the previous Compose runtime could not be restarted automatically. Backup: $backup" >&2
else
echo "ForgeFlow restored the previous source and runtime after the failed activation." >&2
fi
fi
rm -rf "$staging" "$lock"
exit "$status"
}
trap finish EXIT
actual_digest=$(if command -v sha256sum >/dev/null 2>&1; then sha256sum "$incoming" | awk '{print $1}'; else shasum -a 256 "$incoming" | awk '{print $1}'; fi)
[ "$actual_digest" = "$expected_digest" ] || { echo "Uploaded bundle checksum mismatch" >&2; exit 71; }
tar -tf "$incoming" > "$staging.entries"
if grep -E '(^/|(^|/)\\.\\.(/|$))' "$staging.entries" >/dev/null; then echo "Unsafe path detected in deployment bundle" >&2; exit 72; fi
rm -rf "$staging" "$release_root.pending"
mkdir -p "$staging/source" "$release_root.pending"
tar -xf "$incoming" -C "$staging/source"
if find "$staging/source" -type l -print -quit | grep -q .; then echo "Symbolic links are not accepted in push bundles" >&2; exit 73; fi
mv "$staging/source" "$release_root.pending/source"
find "$release_root.pending/source" -type f -printf '%P\n' | LC_ALL=C sort > "$release_root.pending/managed-files"
rm -rf "$release_root"
mv "$release_root.pending" "$release_root"
rm -f "$incoming" "$staging.entries"
printf '%s' ${shellQuote(preservePayload)} | base64 -d > "$staging.preserve"
for runtime_config in .env compose.override.yml compose.override.yaml docker-compose.override.yml docker-compose.override.yaml; do
if [ -f "$root/$runtime_config" ] && [ ! -e "$release/$runtime_config" ]; then
mkdir -p "$release/$(dirname "$runtime_config")"
cp -a "$root/$runtime_config" "$release/$runtime_config"
fi
done
${profile.generatedCompose ? `mkdir -p "$release/.forgeflow"
cat > "$release/.forgeflow/compose.forgeflow.yml" <<'FORGEFLOW_COMPOSE'
${generated}FORGEFLOW_COMPOSE
cat > "$release/.forgeflow/compose.metadata.yml" <<'FORGEFLOW_METADATA'
${metadata}FORGEFLOW_METADATA` : ""}
cd "$release"
${candidateCompose} config >/dev/null
candidate_services=$(${candidateCompose} config --services 2>/dev/null | sed '/^$/d')
[ -n "$candidate_services" ] || { echo "Candidate Compose project defines no services" >&2; exit 60; }
mkdir -p "$backup/source"
: > "$backup/present"
: > "$backup/absent"
: > "$backup/containers.before"
had_existing_compose=false
if cd "$root" 2>/dev/null && ${compose} config >/dev/null 2>&1; then
had_existing_compose=true
old_services=$(${compose} config --services 2>/dev/null | sed '/^$/d')
printf '%s\n' "$old_services" | while IFS= read -r service; do
[ -n "$service" ] || continue
container_id=$(${compose} ps -q "$service" | head -n1)
image_id=''; image_ref=''
if [ -n "$container_id" ] && docker inspect "$container_id" >/dev/null 2>&1; then
image_id=$(docker inspect -f '{{.Image}}' "$container_id" 2>/dev/null || true)
image_ref=$(docker inspect -f '{{.Config.Image}}' "$container_id" 2>/dev/null || true)
fi
printf '%s\t%s\t%s\t%s\n' "$service" "$container_id" "$image_id" "$(printf '%s' "$image_ref" | base64 | tr -d '\r\n')"
done >> "$backup/containers.before"
fi
if [ -n "$tracked_container_hint" ] && docker inspect "$tracked_container_hint" >/dev/null 2>&1; then
hint_project=$(docker inspect -f '{{index .Config.Labels "com.docker.compose.project"}}' "$tracked_container_hint" 2>/dev/null || true)
if [ -n "$hint_project" ] && [ "$hint_project" != "$expected_project" ]; then
echo "Refusing activation: container $tracked_container_hint belongs to Compose project $hint_project, not $expected_project" >&2
exit 67
fi
fi
# Build all candidate images before any running container is touched.
cd "$release"
${candidateCompose} build
new_manifest="$release_root/managed-files"
while IFS= read -r rel; do
[ -n "$rel" ] || continue
is_preserved "$rel" && continue
parent=$(dirname "$rel")
current="$root"
if [ "$parent" != . ]; then
old_ifs=$IFS; IFS='/'; read -r -a parts <<< "$parent"; IFS=$old_ifs
for part in "\${parts[@]}"; do
current="$current/$part"
[ ! -L "$current" ] || { echo "Refusing to deploy through symlinked parent $current" >&2; exit 74; }
done
fi
[ ! -L "$root/$rel" ] || { echo "Refusing to replace symlinked managed path $rel" >&2; exit 74; }
if [ -d "$root/$rel" ]; then echo "A directory conflicts with managed file $rel" >&2; exit 75; fi
if [ -e "$root/$rel" ]; then
mkdir -p "$backup/source/$(dirname "$rel")"
cp -a -- "$root/$rel" "$backup/source/$rel"
printf '%s\n' "$rel" >> "$backup/present"
else
printf '%s\n' "$rel" >> "$backup/absent"
fi
done < "$new_manifest"
[ -f "$root/.forgeflow/compose.metadata.yml" ] && { cp -a "$root/.forgeflow/compose.metadata.yml" "$backup/compose.metadata.yml"; touch "$backup/metadata.present"; }
[ -f "$root/.forgeflow/compose.forgeflow.yml" ] && { cp -a "$root/.forgeflow/compose.forgeflow.yml" "$backup/compose.forgeflow.yml"; touch "$backup/generated.present"; }
restore_needed=true
while IFS= read -r rel; do
[ -n "$rel" ] || continue
is_preserved "$rel" && continue
mkdir -p -- "$root/$(dirname "$rel")"
temp="$root/$rel.forgeflow-new-$request_id"
cp -a -- "$release/$rel" "$temp"
mv -f -- "$temp" "$root/$rel"
done < "$new_manifest"
mkdir -p "$root/.forgeflow"
${profile.generatedCompose ? `if [ ! -f "$backup/generated.present" ]; then touch "$backup/generated.created"; fi
if [ ! -f "$backup/metadata.present" ]; then touch "$backup/metadata.created"; fi
cat > "$root/.forgeflow/compose.forgeflow.yml.pending" <<'FORGEFLOW_COMPOSE'
${generated}FORGEFLOW_COMPOSE
mv "$root/.forgeflow/compose.forgeflow.yml.pending" "$root/.forgeflow/compose.forgeflow.yml"
cat > "$root/.forgeflow/compose.metadata.yml.pending" <<'FORGEFLOW_METADATA'
${metadata}FORGEFLOW_METADATA
mv "$root/.forgeflow/compose.metadata.yml.pending" "$root/.forgeflow/compose.metadata.yml"` : `cat > "$root/.forgeflow/deployment-metadata.json.pending" <<'FORGEFLOW_METADATA_JSON'
${JSON.stringify({ repository: repository.fullName, environment: profile.environment, commit: targetSha, requestId })}
FORGEFLOW_METADATA_JSON
mv "$root/.forgeflow/deployment-metadata.json.pending" "$root/.forgeflow/deployment-metadata.json"`}
share_group=$(getent group users >/dev/null 2>&1 && echo users || id -gn)
chgrp "$share_group" "$root" "$root/.forgeflow" 2>/dev/null || true
chmod g+rwx "$root" "$root/.forgeflow" 2>/dev/null || true
chmod g+s "$root" "$root/.forgeflow" 2>/dev/null || true
while IFS= read -r rel; do
[ -n "$rel" ] || continue
is_preserved "$rel" && continue
chgrp "$share_group" "$root/$rel" 2>/dev/null || true
chmod u+rw,g+rw "$root/$rel" 2>/dev/null || true
parent="$root/$(dirname "$rel")"
chgrp "$share_group" "$parent" 2>/dev/null || true
chmod g+rwx,g+s "$parent" 2>/dev/null || true
done < "$new_manifest"
cd "$root"
${compose} config >/dev/null
actual_services=$(${compose} config --services 2>/dev/null | sed '/^$/d')
[ -n "$actual_services" ] || { echo "Compose project defines no services" >&2; exit 60; }
if [ "$(printf '%s\n' "$candidate_services" | LC_ALL=C sort)" != "$(printf '%s\n' "$actual_services" | LC_ALL=C sort)" ]; then
echo "Refusing activation because candidate and server Compose service sets differ" >&2
exit 68
fi
before_containers="$backup/containers.before"
hint_before_id=''
if [ -n "$tracked_container_hint" ] && docker inspect "$tracked_container_hint" >/dev/null 2>&1; then
hint_before_id=$(docker inspect -f '{{.Id}}' "$tracked_container_hint" 2>/dev/null || true)
fi
activation_started=true
${compose} up -d --no-build
${verification}
if [ -n "$hint_before_id" ] && docker inspect "$hint_before_id" >/dev/null 2>&1; then
old_hint_running=$(docker inspect -f '{{.State.Running}}' "$hint_before_id" 2>/dev/null || echo false)
[ "$old_hint_running" != true ] || { echo "Compose left the previous container $tracked_container_hint ($hint_before_id) running" >&2; exit 66; }
fi
${this.dockerManRefreshScript(profile, repository, iconReference)}
previous=$(cat "$root/.forgeflow/current-sha" 2>/dev/null || true)
[ -n "$previous" ] || previous=$(git -C "$root" rev-parse HEAD 2>/dev/null || true)
[ -n "$previous" ] && printf '%s' "$previous" > "$root/.forgeflow/previous-sha"
cp "$new_manifest" "$root/.forgeflow/managed-files.pending"
mv "$root/.forgeflow/managed-files.pending" "$root/.forgeflow/managed-files"
printf '%s' "$target" > "$root/.forgeflow/current-sha.pending"
mv "$root/.forgeflow/current-sha.pending" "$root/.forgeflow/current-sha"
cat > "$root/.forgeflow/status.json.pending" <<'FORGEFLOW_STATUS'
${statusJson}
FORGEFLOW_STATUS
mv "$root/.forgeflow/status.json.pending" "$root/.forgeflow/status.json"
restore_needed=false
printf '%s\n' "successful" > "$backup/result"
date -u +%Y-%m-%dT%H:%M:%SZ > "$backup/completed-at"
echo "ForgeFlow safely activated push bundle $target; rollback evidence retained at $backup"
`;
}
async executePushBundle({ repository, profile, server, remotePath, targetSha, requestId, metadata, generated, iconReference, rollback = false }) {
const permissionReport = await this.inspectWriteAccess({
repository,
profileId: profile.id,
});
if (!permissionReport.ready) {
const error = new Error(
`Deployment stopped before upload because write access is missing for: ${permissionReport.blocking.map((item) => item.path).join(", ")}`,
);
error.code = "REMOTE_WRITE_ACCESS_REQUIRED";
error.permissionReport = permissionReport;
throw error;
}
const bundle = await this.createCommitBundle(repository, targetSha, requestId);
const remotePart = path.join(remotePath, ".forgeflow", "incoming", `${requestId}-${targetSha}.tar.part`);
try {
await this.ssh.exec(server.id, bash(`mkdir -p ${shellQuote(path.dirname(remotePart))}`), { timeout: 30_000 });
await this.ssh.uploadFile(server.id, bundle.archivePath, remotePart, { mode: 0o600 });
const script = this.pushBundleScript({ repository, profile, remotePath, targetSha, requestId, remotePart, digest: bundle.sha256, metadata, generated, iconReference, rollback });
return await this.ssh.exec(server.id, bash(script), { timeout: 30 * 60_000, maxOutput: 8 * 1024 * 1024 });
} finally {
await fs.rm(bundle.archivePath, { force: true }).catch(() => {});
}
}
async createServerGitBundle({ repository, profile, server, remotePath, targetSha, requestId }) {
const remote = this.serverGitRemote(repository, profile);
const repositoryId = crypto.createHash("sha256").update(String(repository.fullName).toLowerCase()).digest("hex").slice(0, 24);
const cache = path.join(server.basePath, ".forgeflow", "git-cache", `${repositoryId}.git`);
const remotePart = path.join(remotePath, ".forgeflow", "incoming", `${requestId}-${targetSha}.tar.part`);
const marker = "__FORGEFLOW_SERVER_ARCHIVE__";
const script = `
cache=${shellQuote(cache)}
incoming=${shellQuote(remotePart)}
remote=${shellQuote(remote)}
branch=${shellQuote(profile.branch)}
target=${shellQuote(targetSha)}
mkdir -p "$(dirname "$cache")" "$(dirname "$incoming")"
if [ ! -d "$cache" ]; then git init --bare "$cache" >/dev/null; fi
if git --git-dir="$cache" remote get-url origin >/dev/null 2>&1; then
git --git-dir="$cache" remote set-url origin "$remote"
else
git --git-dir="$cache" remote add origin "$remote"
fi
${this.serverGitEnvironment(repository, profile, server)} git --git-dir="$cache" fetch --force --prune origin "+refs/heads/$branch:refs/remotes/origin/$branch"
git --git-dir="$cache" cat-file -e "$target^{commit}"
git --git-dir="$cache" merge-base --is-ancestor "$target" "refs/remotes/origin/$branch"
archive_tmp="$incoming.$$.tmp"
git --git-dir="$cache" archive --format=tar --output="$archive_tmp" "$target"
[ -s "$archive_tmp" ] || { rm -f "$archive_tmp"; echo "Gitea produced an empty deployment archive" >&2; exit 45; }
mv "$archive_tmp" "$incoming"
digest=$(if command -v sha256sum >/dev/null 2>&1; then sha256sum "$incoming" | awk '{print $1}'; else shasum -a 256 "$incoming" | awk '{print $1}'; fi)
printf '%s\n' ${shellQuote(marker)}
printf 'digest=%s\n' "$digest"
`;
const result = await this.ssh.exec(server.id, bash(script), { timeout: 5 * 60_000, maxOutput: 512 * 1024 });
const output = String(result.stdout || "");
const markerIndex = output.lastIndexOf(marker);
const digest = markerIndex >= 0
? String(output.slice(markerIndex + marker.length).match(/(?:^|\n)digest=([0-9a-f]{64})(?:\n|$)/i)?.[1] || "").toLowerCase()
: "";
if (!digest) throw new Error("The server did not return a valid checksum for the Gitea archive.");
return { remotePart, digest };
}
async executeServerGitBundle({ repository, profile, server, remotePath, targetSha, requestId, metadata, generated, iconReference, rollback = false }) {
const permissionReport = await this.inspectWriteAccess({ repository, profileId: profile.id });
if (!permissionReport.ready) {
const error = new Error(`Deployment stopped before the Gitea fetch because write access is missing for: ${permissionReport.blocking.map((item) => item.path).join(", ")}`);
error.code = "REMOTE_WRITE_ACCESS_REQUIRED";
error.permissionReport = permissionReport;
throw error;
}
const bundle = await this.createServerGitBundle({ repository, profile, server, remotePath, targetSha, requestId });
const script = this.pushBundleScript({ repository, profile, remotePath, targetSha, requestId, remotePart: bundle.remotePart, digest: bundle.digest, metadata, generated, iconReference, rollback });
return this.ssh.exec(server.id, bash(script), { timeout: 30 * 60_000, maxOutput: 8 * 1024 * 1024 });
}
async deploy({ repository, profileId, sha }) {
const targetSha = assertFullCommitSha(sha);
const { profile, server, remotePath } = this.resolve(repository, profileId);
if (profile.deploymentMode === "server-git") {
const verification = await this.verifyServerGitProfile({ repository, profileId });
const requiredChecks = ["remote-branch", "deploy-key-scope", "server-git-access"];
const blocked = verification.checks.filter((check) => requiredChecks.includes(check.id) && check.status !== "pass");
if (blocked.length || !verification.branchSha) {
const error = new Error(`Server pull verification failed: ${blocked.map((check) => check.detail).join("; ") || "the target branch could not be proven"}`);
error.code = "SERVER_GIT_VERIFICATION_FAILED";
error.verification = verification;
throw error;
}
}
const preflight = await this.preflight({ repository, profileId, sha: targetSha });
if (!preflight.summary.ready) {
const error = new Error(`SSH deployment preflight failed: ${preflight.summary.blocking.join(", ")}`);
error.code = "SSH_DEPLOYMENT_PREFLIGHT_FAILED";
throw error;
}
const requestId = crypto.randomUUID();
const mode = ["push-bundle", "server-git", "monitor-only"].includes(profile.deploymentMode)
? profile.deploymentMode
: "push-bundle";
const operation = await this.saveOperation({
id: requestId,
type: "deployment",
action: "deploy",
provider: "ssh-unraid",
repository: repository.fullName,
environment: profile.environment,
profileId,
serverId: server.id,
remotePath,
sha: targetSha,
shortSha: targetSha.slice(0, 7),
status: "running",
logs: [
"Preflight passed.",
mode === "push-bundle"
? "Creating and uploading the exact committed local project directly to Unraid."
: mode === "server-git"
? "Fetching the exact commit from Gitea with a repository-scoped read-only deploy key."
: "This workload is monitor-only and cannot be deployed.",
`Deploying exact commit ${targetSha} in the background.`,
],
});
const generated = profile.generatedCompose ? this.generatedCompose(profile, repository) : "";
const iconReference = await this.prepareIcon(profile, repository, server);
const deploymentRepositoryUrl = mode === "server-git"
? this.serverGitRemote(repository, profile)
: repository.localStatus?.remoteUrl || repository.sshUrl || repository.cloneUrl || repository.htmlUrl || repository.fullName;
const metadata = this.metadataCompose(profile, repository, iconReference, {
sha: targetSha,
repositoryUrl: deploymentRepositoryUrl,
});
const previousState = this.store.getDeploymentState?.(profileId) || null;
void (async () => {
try {
if (mode === "monitor-only") throw new Error("This workload is monitor-only. Select Server pull or Direct copy before deploying.");
const result = mode === "server-git"
? await this.executeServerGitBundle({ repository, profile, server, remotePath, targetSha, requestId, metadata, generated, iconReference })
: await this.executePushBundle({ repository, profile, server, remotePath, targetSha, requestId, metadata, generated, iconReference });
const health = await this.checkHealth(profile.healthcheckUrl);
const finalStatus = health.healthy === false ? "failed" : "success";
const completed = await this.saveOperation({
...operation,
status: finalStatus,
previousSha: previousState?.liveSha || preflight.inspection?.head || null,
health,
logs: [
...operation.logs,
...result.stdout.trim().split("\n").filter(Boolean).slice(-80),
"Docker Compose activation and runtime verification completed.",
health.configured
? `Healthcheck ${health.healthy ? "passed" : "failed"}${health.status ? ` with HTTP ${health.status}` : ""}.`
: "No desktop healthcheck configured; running containers were verified and health remains unverified.",
],
error: health.healthy === false ? "The application healthcheck did not pass after deployment." : null,
});
await this.store.saveDeploymentState(profileId, {
liveSha: targetSha,
previousSha: previousState?.liveSha || preflight.inspection?.head || null,
healthy: health.configured ? health.healthy : null,
runtimeVerification: health.configured ? "desktop-healthcheck" : "running-unverified",
healthStatus: health.status ?? null,
healthLatencyMs: health.latencyMs ?? null,
requestId,
remotePath,
provider: "ssh-unraid",
deploymentMode: mode,
containerName: String(profile.containerName || profile.remoteFolder || repository.name),
containerRunning: true,
dockerMan: {
webUi: this.dockerManWebUi(profile),
icon: iconReference,
shell: this.dockerManShell(profile),
templateExists: profile.manageDockerMan === true || previousState?.dockerMan?.templateExists === true,
configured: Boolean(this.dockerManWebUi(profile) || iconReference || previousState?.dockerMan?.configured),
},
webUiUrl: profile.webUiUrl || (profile.hostPort ? `http://${server.host}:${profile.hostPort}/` : null),
});
void this.refreshProfileState(repository.fullName, profileId).catch(() => {});
await this.diagnostics?.info("unraid.deployment.completed", { requestId, repository: repository.fullName, serverId: server.id, remotePath, sha: targetSha, status: completed.status });
} catch (error) {
await this.saveOperation({
...operation,
status: "failed",
error: error.message,
failure: { stage: mode === "server-git" ? "Gitea server pull / Compose activation" : "Direct copy / Compose activation", message: error.message },
logs: [...operation.logs, error.message, "The live SHA was not promoted. Previous release evidence remains authoritative."],
});
await this.diagnostics?.error("unraid.deployment.failed", { requestId, repository: repository.fullName, serverId: server.id, remotePath, sha: targetSha, error });
}
})();
return operation;
}
async rollback({ repository, profileId, targetSha }) {
const target = assertFullCommitSha(targetSha);
const { profile, server, remotePath } = this.resolve(repository, profileId);
const deploymentState = this.store.getDeploymentState(profileId);
if (!deploymentState?.previousSha || deploymentState.previousSha !== target) {
const error = new Error("Rollback is allowed only to the exact previous SHA reported by ForgeFlow for this deployment profile.");
error.code = "ROLLBACK_TARGET_NOT_PREVIOUS_SHA";
throw error;
}
const rollbackMode = ["push-bundle", "server-git", "monitor-only"].includes(profile.deploymentMode)
? profile.deploymentMode
: "push-bundle";
if (rollbackMode === "push-bundle" && !repository.localPath)
throw new Error("A linked local repository is required for Direct copy rollback verification.");
const requestId = crypto.randomUUID();
const operation = await this.saveOperation({
id: requestId,
type: "deployment",
action: "rollback",
provider: "ssh-unraid",
repository: repository.fullName,
environment: profile.environment,
profileId,
serverId: server.id,
remotePath,
sha: target,
shortSha: target.slice(0, 7),
status: "running",
logs: [`Rolling back to exact commit ${target}.`],
});
const generated = profile.generatedCompose ? this.generatedCompose(profile, repository) : "";
const iconReference = await this.prepareIcon(profile, repository, server);
const rollbackRepositoryUrl = rollbackMode === "server-git"
? this.serverGitRemote(repository, profile)
: repository.localStatus?.remoteUrl || repository.sshUrl || repository.cloneUrl || repository.htmlUrl || repository.fullName;
const metadata = this.metadataCompose(profile, repository, iconReference, {
sha: target,
repositoryUrl: rollbackRepositoryUrl,
});
try {
const mode = rollbackMode;
if (mode === "monitor-only") throw new Error("This workload is monitor-only. Select Server pull or Direct copy before rolling back.");
const result = mode === "server-git"
? await this.executeServerGitBundle({ repository, profile, server, remotePath, targetSha: target, requestId, metadata, generated, iconReference, rollback: true })
: await this.executePushBundle({ repository, profile, server, remotePath, targetSha: target, requestId, metadata, generated, iconReference, rollback: true });
const health = await this.checkHealth(profile.healthcheckUrl);
const finalStatus = health.healthy === false ? "failed" : "rolled-back";
const completed = await this.saveOperation({
...operation,
status: finalStatus,
previousSha: deploymentState.liveSha || null,
health,
error: health.healthy === false ? "The application healthcheck did not pass after rollback." : null,
logs: [
...operation.logs,
...result.stdout.trim().split("\n").filter(Boolean).slice(-80),
"Rollback activation completed.",
health.configured ? `Healthcheck ${health.healthy ? "passed" : "failed"}.` : "Runtime is running; no desktop healthcheck was configured.",
],
});
await this.store.saveDeploymentState(profileId, {
liveSha: target,
previousSha: deploymentState.liveSha || null,
healthy: health.configured ? health.healthy : null,
runtimeVerification: health.configured ? "desktop-healthcheck" : "running-unverified",
healthStatus: health.status ?? null,
healthLatencyMs: health.latencyMs ?? null,
requestId,
remotePath,
provider: "ssh-unraid",
containerRunning: true,
});
if (health.healthy === false) {
const error = new Error("Rollback completed, but the configured healthcheck failed.");
error.code = "ROLLBACK_HEALTHCHECK_FAILED";
error.operationId = completed.id;
throw error;
}
return completed;
} catch (error) {
if (error.code !== "ROLLBACK_HEALTHCHECK_FAILED") {
await this.saveOperation({ ...operation, status: "failed", error: error.message, logs: [...operation.logs, error.message] });
}
throw error;
}
}
}
return UnraidDeploymentMethods.prototype;
}
module.exports = { createUnraidDeploymentMethods };
File diff suppressed because it is too large Load Diff

Some files were not shown because too many files have changed in this diff Show More