pgroast 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

package/README.md

@@ -1,3 +1,174 @@
-# Temporary Holding Version
+# pgroast
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+PG Roast is an adversarial reviewer for Postgres proposals. It judges the idea and the design, not the code.
+
+Given a pgsql-hackers thread or a CommitFest entry, it argues why the proposal might not be accepted, the way experienced committers do: earlier attempts that were not accepted, the strongest objections with concrete failure scenarios, and the touch points that raise the risk. A critic then tries to refute every objection, and only the survivors are reported.
+
+> Prepared by an AI harness; treat as a devil's advocate, not a verdict.
+
+Status: prototype. Output is local files only. Nothing is posted to mailing lists or to CommitFest, and there is no code that could do so.
+
+## What you get
+
+`roast.md` (the short report), `roast-full.md`, `roast.json` and `roast-summary.txt` in a local directory. The short report has the verdict, prior attempts, the listed objections, the questions and the touch points that are hit. The full report and the JSON also have:
+
+- a neutral restatement of the proposal;
+- prior attempts from the precedent index, with links, status and who objected;
+- the ranked objections that survived the critic, each with a failure scenario and what the author would need to show;
+- the 15 touch points, each marked hit or not hit;
+- up to 5 questions for the author;
+- a verdict with a confidence, and three fields kept apart from it: `committability`, `not_now` ("not now, show demand") and `priority`.
+
+Refuted objections stay in the JSON and are listed at the end of the full report with the critic's reason.
+
+All prose follows one set of writing rules, [prompts/writing.md](prompts/writing.md): the point first, hard length limits per field, plain words.
+
+### Verdict scale
+
+| Verdict | Meaning |
+|---|---|
+| `LIKELY-REJECT` | A fatal objection at the idea or design level survived the critic and cannot be overcome without making a different proposal, or the same idea was not accepted before and nothing has changed. |
+| `NEEDS-DESIGN-DISCUSSION` | The goal may be fine, but the design or the demand is in question; the list needs to agree on something before code review makes sense. "Not now, show demand" goes here. |
+| `NEEDS-COMMITTER-EYES` | No fundamental objection to the idea, but it touches things that only a committer who knows the area can sign off, or the remaining concerns are fixable design points. |
+| `NO-FUNDAMENTAL-OBJECTION` | Nothing that survived would stop it at the idea or design level. This says nothing about the code. |
+
+The verdict covers the review pyramid from the base up: 1a understandability, 1b desirability, 2 architecture and design. When a level fails, the levels above it are not argued. Implementation (levels 3 to 5) is out of scope. The rubric is in [prompts/committer-paranoia.md](prompts/committer-paranoia.md); its sources are in [docs/haas-paranoia-notes.md](docs/haas-paranoia-notes.md).
+
+### Touch points
+
+1. on-disk format / pg_upgrade
+2. WAL / replication / standby
+3. wire protocol
+4. catalog changes
+5. ABI / extension API
+6. SQL-standard conflict or non-standard syntax
+7. new GUC
+8. planner behaviour change
+9. pg_dump / restore round-trip
+10. psql UX conventions
+11. security / privileges
+12. backpatchability
+13. maintenance burden ("who maintains this in 10 years")
+14. performance on the hot path
+15. doesn't fit what Postgres is about (extension / external tool / already solved)
+
+## How it works
+
+1. **Brief**: a neutral restatement and the search queries for precedents.
+2. **Retrieval**, in code: full-text search over the precedent index, with a date cutoff. The proposal's own thread and CommitFest entry are excluded.
+3. **Enrichment**: precedent threads without a recorded reason are summarised once and cached. A relevance call decides which candidates the roasters see.
+4. **Seven roasters** in parallel, one angle each: prior attempts, standards and compatibility, replication and on-disk, security, maintenance and fit, already exists, demand.
+5. **Critic**: tries to refute every objection.
+6. **Synthesis**: applies the stop rule, picks the verdict, fills the touch points and the questions.
+7. **Checks in code**: links, precedent ids, message numbers and quotes are verified; a tone lint runs; then the files are written.
+
+The models have no tools. They never see a URL: they cite ids such as `P3`, and code fills in the links from the database. Quotes are accepted only as verbatim substrings of the author's own text. Free prose is not fact-checked by code.
+
+The precedent index holds 2,547 rows: CommitFest entries that ended Rejected, Returned with feedback or Withdrawn, revert commits from the Postgres git history, and the wiki page "Not Worth Doing". See [docs/corpus.md](docs/corpus.md).
+
+Full design: [docs/design.md](docs/design.md).
+
+## Requirements
+
+1. **An AI coding CLI, installed and signed in with your subscription.** One of:
+   - [Claude Code](https://claude.com/claude-code): install it, run `claude` once and sign in (`/login`). The account needs access to Opus, and to Mythos 5.2 or Fable 5.2.
+   - Codex CLI: install it and run `codex login`.
+
+   PG Roast starts that CLI for every model call, so the calls count toward the limits of the account the CLI is signed in to. A roast is 12 to 20 calls. No API key is needed or used: `ANTHROPIC_API_KEY`, `ANTHROPIC_AUTH_TOKEN`, `OPENAI_API_KEY` and `CODEX_API_KEY` are removed from the CLI's environment, and a call fails if the CLI reports that it is using a key.
+2. **[Bun](https://bun.sh) 1.3.5 or later.** There are no npm dependencies.
+3. **Postgres 18**, for the precedent index (database `pgroast`; `PGROAST_DSN` if it is not on the local socket). `createdb` and `psql` are used once, to load the index.
+4. A clone of the Postgres repository, only if you rebuild the index (`PGROAST_PG_REPO`).
+
+## Quick start
+
+With npm (the package starts Bun for you; `bunx pgroast` works the same way):
+
+```
+npx pgroast init-db                  # once: creates the database "pgroast" and loads the index
+npx pgroast doctor                   # checks both CLIs and their login
+npx pgroast <cf-id|thread-url>       # results go to ./pgroast-out/<name>/
+```
+
+From a clone:
+
+```
+git clone https://github.com/NikolayS/pgroast && cd pgroast
+bun run src/cli.ts init-db
+bun run src/cli.ts doctor
+bun run src/cli.ts <cf-id|thread-url>    # results go to out/<name>/
+```
+
+`doctor` makes one small call on each installed CLI and says which backends are usable. If it reports a sign-in problem, run `claude` (then `/login`) or `codex login` and try again.
+
+Claude Code keeps one login per config directory. If you start `claude` through an alias that sets `CLAUDE_CONFIG_DIR`, a plain `pgroast` run uses a different login, which may be expired even though `claude` works for you. Set the same variable for PG Roast:
+
+```
+CLAUDE_CONFIG_DIR=~/.claude npx pgroast doctor
+```
+
+Fetched pages are cached in `~/.cache/pgroast` when installed from npm and in `data/cache/` in a clone (`PGROAST_CACHE_DIR` overrides both).
+
+Models on the claude backend: roasters run on `opus` (`PGROAST_ROASTER_MODEL`), critic and synthesis on `claude-mythos-5-2` (`PGROAST_CRITIC_MODEL`). If your account does not have Mythos 5.2, use Fable 5.2, which is the same underlying model:
+
+```
+export PGROAST_CRITIC_MODEL=claude-fable-5-2
+```
+
+Only Opus, Mythos and Fable models are accepted on the claude backend. To use Codex instead, pass `--backend codex`.
+
+## Run
+
+```
+pgroast <cf-id|cf-url|message-id|thread-url> [options]
+pgroast --self --proposal FILE [--patch FILE ...]
+pgroast page <roast.json> [--out FILE] [--site DIR [--base-url URL]]
+pgroast doctor
+pgroast init-db
+```
+
+`pgroast` here is `npx pgroast`, or `bun run src/cli.ts` in a clone.
+
+| Option | Meaning |
+|---|---|
+| `--blind N` | read only the first N messages of the thread |
+| `--before YYYY-MM-DD` | read only messages before the date (UTC); also the precedent cutoff |
+| `--hint TEXT` | directed precedent lookup |
+| `--out DIR` | output directory; default `./pgroast-out/<slug>` (npm) or `out/<slug>` (clone) |
+| `--backend claude\|codex` | which installed CLI runs the model |
+| `--self` | your own proposal before you send it; with `--proposal FILE` for a draft that has no thread yet |
+| `--rounds N` | extra reflection rounds after the first pass, default 0 |
+| `--no-enrich` | skip the reading of precedent threads and the relevance pass |
+| `--dry-run` | build every prompt, call no model |
+| `--offline` | use only cached pages |
+
+A roast at `--rounds 0` makes 11 model calls, plus up to 8 for enrichment, and takes a few minutes.
+
+Fetching is polite: a generic User-Agent, at least 1 s between requests per host, read-only, no sign-in, and every page is cached under `data/cache/`.
+
+## Evaluation
+
+`eval/cases.json` holds 18 historical proposals with a known outcome (rejected, accepted, reverted). The roaster reads only the first messages of each thread, and precedents are cut off at that date. The scoring rules were fixed before any result existed: [docs/eval.md](docs/eval.md).
+
+```
+bun run src/eval/cli.ts run --run-id ID [--case a,b] [--concurrency 2]
+bun run src/eval/cli.ts score ID
+```
+
+## Limits
+
+- Models may remember how a well-known old thread ended. Blind mode cannot remove that. Only 2 of the 18 eval cases started after the models' training cutoff.
+- Only idea and design are judged. A problem that shows up in the implementation is out of reach.
+- The index does not hold list-only threads that never had a CommitFest entry, and search is keyword-based.
+- The tone lint is a word list.
+- Only the earliest thread of a multi-thread CommitFest entry is read.
+
+## Tests
+
+```
+bun test
+bunx tsc --noEmit
+```
+
+## License
+
+Apache 2.0, see [LICENSE](LICENSE).

package/bin/pgroast.mjs

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+// Launcher for `npx pgroast`. PG Roast is written for Bun (TypeScript sources, Bun.sql), so this
+// small Node script only finds `bun` and hands over to it.
+import { spawnSync } from "node:child_process";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const root = join(dirname(fileURLToPath(import.meta.url)), "..");
+const bun = process.env.PGROAST_BUN_BIN || "bun";
+const r = spawnSync(bun, ["run", join(root, "src", "cli.ts"), ...process.argv.slice(2)], { stdio: "inherit" });
+if (r.error) {
+  if (r.error.code === "ENOENT") {
+    console.error("pgroast needs Bun 1.3.5 or later (https://bun.sh), and `bun` was not found on PATH.\nInstall it, for example: curl -fsSL https://bun.sh/install | bash\nOr run it directly with: bunx pgroast ...");
+    process.exit(127);
+  }
+  console.error(`pgroast: could not start bun: ${r.error.message}`);
+  process.exit(1);
+}
+process.exit(r.status ?? 1);