|
| 1 | +# Orchestration API PR – Pre-existing / environment notes |
| 2 | + |
| 3 | +For PR: **feat(orchestration): stable programmatic orchestration API** (Fixes #116). |
| 4 | + |
| 5 | +## Pre-existing repo issues (not introduced by this PR) |
| 6 | + |
| 7 | +These were observed during the pre-PR checklist. They affect the **whole repo**, not the orchestration changes. |
| 8 | + |
| 9 | +### Lint config |
| 10 | + |
| 11 | +- **Root `npm run lint`** fails: script references `config/.eslintrc.strict.js` but the repo has `config/.eslintrc.strict.cjs`. |
| 12 | +- **Orchestration code:** No ESLint errors reported in IDE for `agentic-flow/src/orchestration` or `agentic-flow/tests/orchestration`. |
| 13 | + |
| 14 | +### Prettier config |
| 15 | + |
| 16 | +- **Root `npm run format:check`** / **`npm run format`** fail: script references `config/.prettierrc.js` but the repo has `config/.prettierrc.cjs`. |
| 17 | +- Orchestration files follow existing style. |
| 18 | + |
| 19 | +### TypeScript / build |
| 20 | + |
| 21 | +- **`npx tsc --noEmit`** in `agentic-flow` fails in **other** modules: |
| 22 | + - `src/reasoningbank/AdvancedMemory.ts`, `HybridBackend.ts`: missing `../memory/SharedMemoryPool.js` |
| 23 | + - `src/sdk/e2b-sandbox.ts`: missing `e2b` and `@e2b/code-interpreter` |
| 24 | +- **Orchestration code** has no type errors. |
| 25 | +- **`npm run build`** in agentic-flow uses `tsc ... || true`, so it exits 0 despite these errors. |
| 26 | + |
| 27 | +### Commit-msg hook |
| 28 | + |
| 29 | +- **Husky commit-msg** calls `scripts/validate-commit-msg.js`, which is missing (MODULE_NOT_FOUND). Commits used `--no-verify` where needed so the branch could be updated. |
| 30 | + |
| 31 | +### Vitest / Rollup (darwin-arm64) |
| 32 | + |
| 33 | +- On a clean install, **Vitest** can fail with `Cannot find module @rollup/rollup-darwin-arm64` (npm optional dependency). Workaround: `npm install @rollup/rollup-darwin-arm64 --save-optional` in `agentic-flow`. Documented in `agentic-flow/tests/orchestration/README.md`. |
| 34 | + |
| 35 | +--- |
| 36 | + |
| 37 | +## PR description block (paste into PR) |
| 38 | + |
| 39 | +Copy the following into your PR description so reviewers see the pre-existing issues and what was verified: |
| 40 | + |
| 41 | +```markdown |
| 42 | +### Pre-existing repo issues (not from this PR) |
| 43 | + |
| 44 | +- **Lint:** Root `npm run lint` fails (script expects `config/.eslintrc.strict.js`, repo has `.eslintrc.strict.cjs`). No ESLint errors in orchestration code (IDE). |
| 45 | +- **Prettier:** Root `format:check`/`format` fail (script expects `config/.prettierrc.js`, repo has `.prettierrc.cjs`). |
| 46 | +- **TypeScript/build:** `tsc --noEmit` fails in other modules (SharedMemoryPool, e2b); orchestration code typechecks. Build uses `tsc ... || true` so it exits 0. |
| 47 | +- **Commit-msg hook:** `scripts/validate-commit-msg.js` missing; used `--no-verify` where needed. |
| 48 | +- **Vitest (darwin-arm64):** Clean install may need `npm install @rollup/rollup-darwin-arm64 --save-optional` in agentic-flow (see `tests/orchestration/README.md`). |
| 49 | + |
| 50 | +### Verified for this PR |
| 51 | + |
| 52 | +- `npm run test:orchestration` and `npm run test:orchestration:smoke` pass in agentic-flow. |
| 53 | +- Root `npm test` passes. CHANGELOG and docs updated. |
| 54 | +``` |
| 55 | + |
| 56 | +--- |
| 57 | + |
| 58 | +## Verification performed for this PR |
| 59 | + |
| 60 | +- **Orchestration tests:** `npm run test:orchestration` (Vitest) and `npm run test:orchestration:smoke` (tsx) pass in `agentic-flow`. |
| 61 | +- **Root tests:** `npm test` (test:retry, test:logging, benchmark suite) passes. |
| 62 | +- **CHANGELOG.md** updated; **docs** added/updated for orchestration and memory plane. |
0 commit comments