mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-06 10:48:12 +02:00
fix(workspaces): prepare checkouts without a local seed config (#14810)
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Task preparation can create an isolated Git worktree and run its setup script. > - The Paperclip repository setup script also prepares a seeded development instance. > - A server configured through environment variables can have no local seed config. > - This stops ordinary task preparation before the agent starts. > - This pull request prepares checkout dependencies when no seed source exists, while preserving errors for invalid sources and existing development instances. > - Tasks can start without creating or claiming a seeded development runtime. ## Linked Issues or Issue Description **What happened?** A task with the Paperclip repository fails during setup when the host has no repository-local or default instance config. The automatic worktree provisioner requires a seed source even when the task only needs the checkout. **Expected behavior** A plain checkout should prepare its dependencies without a local development database. A missing custom source, invalid source path, or existing development instance with a missing source should still fail. Starting a seeded runtime must still require a valid source. **Steps to reproduce** 1. Run an environment-configured Paperclip server without a local instance config. 2. Add the Paperclip repository to a project. 3. Start a task that uses an isolated Git worktree without a custom provision command. 4. Observe the setup error before agent execution. **Paperclip version or commit** Reproduced against `0d3e7bf6ac` with a real script subprocess and workspace realization regression. **Deployment mode** Environment-configured server with external PostgreSQL. **Additional context** Searched open and closed GitHub PRs and issues. Related work: Refs #14795 (seed-source diagnostics) and Refs #11733 (source validation). This change keeps source validation and seed-readiness checks in place. ## What Changed - Permit dependency setup when the default seed config is absent (including the Docker image config path) and the worktree has no development-instance state. - Keep missing custom configs, invalid paths, and lost sources for existing instances as errors. - Create no config, environment file, or seed manifest for a plain checkout. - Keep dependency install failures visible and allow normal instance setup once a source becomes available. - Cover the setup script, seed-runtime refusal, and automatic server worktree realization. - Document the difference between checkout preparation and seeded-runtime readiness. ## Verification - Regression tests failed before the fix for absent-source checkout preparation and dependency setup. - `bash -n scripts/provision-worktree.sh` - `node --test scripts/__tests__/provision-worktree-self-heal.test.mjs` — 34 passed; 1 existing flock-dependent test skipped on macOS. - Server regression — 2 passed, covering an unset config and the Docker image default path. - `pnpm build` — passed. - `pnpm -r typecheck` — passed. - All CI checks passed, including the full test shards, build, typecheck, browser tests, and canary dry run. - The first local `pnpm test:run` encountered two chat-test failures because skill discovery selected an unrelated parent directory. Both tests pass at the PR commit in a clean temporary checkout. The full local run was not completed; the redundant clean run was stopped after the complete CI suite passed. - `git diff --check` and added-line secrets/PII scan passed. - Greptile: 5/5, no comments. The branch has no merge conflicts. - No live tenant deployment or task retry was performed. ## Risks - A new checkout with no implicit seed config now completes dependency setup. It has no seeded development instance. A runtime request still fails until a valid source exists. - Existing instances and custom source paths retain their failure behavior. The script does not synthesize a source from environment credentials or copy a live database. - No schema, API, or task-setting changes. Revert the commit to restore the previous setup behavior. ## Model Used OpenAI Codex (GPT-6), with tool-assisted analysis, code edits, and local tests. The runtime did not expose a verified model variant or context-window size. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge Co-authored-by: Paperclip <noreply@paperclip.ing>
This commit is contained in:
Devin FoleyandPaperclip authored and GitHub committed
1 parent
6d654f63d1
commit
6f2ce27ca7
4 files changed
+228
-59
No files matched your search
@@ -5,6 +5,7 @@ base_cwd="${PAPERCLIP_WORKSPACE_BASE_CWD:?PAPERCLIP_WORKSPACE_BASE_CWD is requir
|
||||
worktree_cwd="${PAPERCLIP_WORKSPACE_CWD:?PAPERCLIP_WORKSPACE_CWD is required}"
|
||||
paperclip_home="${PAPERCLIP_HOME:-$HOME/.paperclip}"
|
||||
paperclip_instance_id="${PAPERCLIP_INSTANCE_ID:-default}"
|
||||
default_source_config_path="$paperclip_home/instances/$paperclip_instance_id/config.json"
|
||||
paperclip_dir="$worktree_cwd/.paperclip"
|
||||
worktree_config_path="$paperclip_dir/config.json"
|
||||
worktree_env_path="$paperclip_dir/.env"
|
||||
@@ -53,26 +54,52 @@ if [[ ! -e "$source_config_path" && ! -L "$source_config_path" ]]; then
|
||||
# A base workspace that is a plain checkout carries no instance config of its own.
|
||||
# Fall back to the control plane's own registered instance config, which is process
|
||||
# state this workspace cannot rewrite.
|
||||
source_config_path="${PAPERCLIP_CONFIG:-$paperclip_home/instances/$paperclip_instance_id/config.json}"
|
||||
source_config_path="${PAPERCLIP_CONFIG:-$default_source_config_path}"
|
||||
source_config_origin="control-plane instance"
|
||||
fi
|
||||
if [[ ! -f "$source_config_path" || -L "$source_config_path" ]]; then
|
||||
if [[ ! -e "$source_config_path" && ! -L "$source_config_path" ]]; then
|
||||
echo "Registered Paperclip seed source config is unavailable ($source_config_origin): $source_config_path" >&2
|
||||
echo "For a seeded development instance, configure a canonical config for that registered source before retrying." >&2
|
||||
echo 'Only for a checkout-only worktree, explicitly set workspaceStrategy.provisionCommand to "true". This skips setup; it does not prepare a development runtime.' >&2
|
||||
else
|
||||
echo "Registered Paperclip seed source config is not a canonical file ($source_config_origin): $source_config_path" >&2
|
||||
echo "Repair the registered source path; symlinks and non-regular files are not accepted." >&2
|
||||
# Environment-configured servers need no local instance config. A new plain
|
||||
# checkout can still prepare dependencies without inventing a seed source.
|
||||
# The Docker image sets PAPERCLIP_CONFIG to this default even without a file.
|
||||
# Custom sources and existing development instances must still fail closed.
|
||||
if [[ "$source_config_path" == "$default_source_config_path" && ! -e "$source_config_path" && ! -L "$source_config_path" ]]; then
|
||||
source_required=0
|
||||
for target_state in "$worktree_config_path" "$worktree_env_path" "$seed_manifest_path" "$seed_pending_marker_path" "$seed_complete_marker_path"; do
|
||||
if [[ -e "$target_state" || -L "$target_state" ]]; then
|
||||
source_required=1
|
||||
fi
|
||||
done
|
||||
if [[ "$source_required" -eq 0 ]]; then
|
||||
# Do not mistake a broken or aliased parent path for an absent instance.
|
||||
source_parent="$(dirname "$source_config_path")"
|
||||
while [[ ! -e "$source_parent" && ! -L "$source_parent" ]]; do
|
||||
source_parent="$(dirname "$source_parent")"
|
||||
done
|
||||
if [[ ! -d "$source_parent" || -L "$source_parent" || "$(cd "$source_parent" && pwd -P)" != "$source_parent" ]]; then
|
||||
echo "Registered Paperclip seed source config has a non-canonical parent: $source_config_path" >&2
|
||||
exit 1
|
||||
fi
|
||||
echo "No local Paperclip seed source config; preparing checkout dependencies without a seeded development instance." >&2
|
||||
source_config_path=""
|
||||
fi
|
||||
fi
|
||||
exit 1
|
||||
fi
|
||||
canonical_source_dir="$(cd "$(dirname "$source_config_path")" && pwd -P)"
|
||||
if [[ "$canonical_source_dir/config.json" != "$source_config_path" ]]; then
|
||||
echo "Registered Paperclip seed source config uses a symlink alias: $source_config_path" >&2
|
||||
exit 1
|
||||
if [[ -n "$source_config_path" ]]; then
|
||||
if [[ ! -f "$source_config_path" || -L "$source_config_path" ]]; then
|
||||
if [[ ! -e "$source_config_path" && ! -L "$source_config_path" ]]; then
|
||||
echo "Registered Paperclip seed source config is unavailable ($source_config_origin): $source_config_path" >&2
|
||||
echo "For a seeded development instance, configure a canonical config for that registered source before retrying." >&2
|
||||
else
|
||||
echo "Registered Paperclip seed source config is not a canonical file ($source_config_origin): $source_config_path" >&2
|
||||
echo "Repair the registered source path; symlinks and non-regular files are not accepted." >&2
|
||||
fi
|
||||
exit 1
|
||||
fi
|
||||
canonical_source_dir="$(cd "$(dirname "$source_config_path")" && pwd -P)"
|
||||
if [[ "$canonical_source_dir/config.json" != "$source_config_path" ]]; then
|
||||
echo "Registered Paperclip seed source config uses a symlink alias: $source_config_path" >&2
|
||||
exit 1
|
||||
fi
|
||||
source_env_path="$(dirname "$source_config_path")/.env"
|
||||
fi
|
||||
source_env_path="$(dirname "$source_config_path")/.env"
|
||||
|
||||
mkdir -p "$paperclip_dir"
|
||||
|
||||
@@ -619,44 +646,46 @@ main().catch((error) => {
|
||||
EOF
|
||||
}
|
||||
|
||||
if [[ -e "$worktree_config_path" && -e "$worktree_env_path" ]] && existing_worktree_config_is_usable; then
|
||||
echo "Reusing existing isolated Paperclip worktree config at $worktree_config_path" >&2
|
||||
else
|
||||
if [[ -e "$worktree_config_path" || -e "$worktree_env_path" ]]; then
|
||||
echo "Existing isolated Paperclip worktree config is stale for this host; regenerating." >&2
|
||||
fi
|
||||
if paperclipai_command_available; then
|
||||
if run_isolated_worktree_init; then
|
||||
:
|
||||
else
|
||||
init_exit_code=$?
|
||||
if [[ "$init_exit_code" -eq 127 ]]; then
|
||||
# Every CLI candidate was unusable (e.g. an unhealthy base install that
|
||||
# the repair could not fix); degrade instead of stranding the run.
|
||||
echo "No usable paperclipai CLI found; writing isolated fallback config without DB seeding." >&2
|
||||
write_fallback_worktree_config
|
||||
else
|
||||
# A CLI that ran and failed signals a real problem; do not paper over
|
||||
# it with an unseeded fallback config.
|
||||
echo "paperclipai worktree init failed (exit $init_exit_code); failing provisioning instead of writing an unseeded fallback config." >&2
|
||||
exit "$init_exit_code"
|
||||
fi
|
||||
fi
|
||||
if [[ -n "$source_config_path" ]]; then
|
||||
if [[ -e "$worktree_config_path" && -e "$worktree_env_path" ]] && existing_worktree_config_is_usable; then
|
||||
echo "Reusing existing isolated Paperclip worktree config at $worktree_config_path" >&2
|
||||
else
|
||||
echo "paperclipai worktree init unavailable; writing isolated fallback config without DB seeding." >&2
|
||||
write_fallback_worktree_config
|
||||
if [[ -e "$worktree_config_path" || -e "$worktree_env_path" ]]; then
|
||||
echo "Existing isolated Paperclip worktree config is stale for this host; regenerating." >&2
|
||||
fi
|
||||
if paperclipai_command_available; then
|
||||
if run_isolated_worktree_init; then
|
||||
:
|
||||
else
|
||||
init_exit_code=$?
|
||||
if [[ "$init_exit_code" -eq 127 ]]; then
|
||||
# Every CLI candidate was unusable (e.g. an unhealthy base install that
|
||||
# the repair could not fix); degrade instead of stranding the run.
|
||||
echo "No usable paperclipai CLI found; writing isolated fallback config without DB seeding." >&2
|
||||
write_fallback_worktree_config
|
||||
else
|
||||
# A CLI that ran and failed signals a real problem; do not paper over
|
||||
# it with an unseeded fallback config.
|
||||
echo "paperclipai worktree init failed (exit $init_exit_code); failing provisioning instead of writing an unseeded fallback config." >&2
|
||||
exit "$init_exit_code"
|
||||
fi
|
||||
fi
|
||||
else
|
||||
echo "paperclipai worktree init unavailable; writing isolated fallback config without DB seeding." >&2
|
||||
write_fallback_worktree_config
|
||||
fi
|
||||
created_worktree_config=1
|
||||
fi
|
||||
created_worktree_config=1
|
||||
fi
|
||||
|
||||
# The target config can predate a deployment-mode change on the registered
|
||||
# source, and older/fallback CLI writers may default this field independently.
|
||||
# Reconcile it after either create or reuse so the final guest config always
|
||||
# carries the source's deployment/auth contract without replacing its database.
|
||||
reconcile_worktree_deployment_mode
|
||||
# The target config can predate a deployment-mode change on the registered
|
||||
# source, and older/fallback CLI writers may default this field independently.
|
||||
# Reconcile it after either create or reuse so the final guest config always
|
||||
# carries the source's deployment/auth contract without replacing its database.
|
||||
reconcile_worktree_deployment_mode
|
||||
|
||||
if [[ "$created_worktree_config" -eq 1 && ! -e "$seed_manifest_path" && ! -e "$seed_pending_marker_path" && ! -e "$seed_complete_marker_path" ]]; then
|
||||
write_seed_pending_manifest
|
||||
if [[ "$created_worktree_config" -eq 1 && ! -e "$seed_manifest_path" && ! -e "$seed_pending_marker_path" && ! -e "$seed_complete_marker_path" ]]; then
|
||||
write_seed_pending_manifest
|
||||
fi
|
||||
fi
|
||||
|
||||
list_base_node_modules_paths() {
|
||||
|
||||
Reference in new issue
Block a user