diff --git a/.changeset/seven-poems-punch.md b/.changeset/seven-poems-punch.md new file mode 100644 index 00000000000..a19d6a75a10 --- /dev/null +++ b/.changeset/seven-poems-punch.md @@ -0,0 +1,5 @@ +--- +"@hashintel/petrinaut": patch +--- + +Add an interactive-tool extension point to the AI assistant panel: hosts can register app-level tools whose calls render as interactive widgets in the conversation, including tools that suspend the turn until the user responds. diff --git a/.github/actions/prune-repository/prune.py b/.github/actions/prune-repository/prune.py index e1eca864964..400859f7b6b 100644 --- a/.github/actions/prune-repository/prune.py +++ b/.github/actions/prune-repository/prune.py @@ -6,6 +6,7 @@ import argparse import json +import shutil import subprocess from collections.abc import Iterable from glob import glob @@ -18,7 +19,8 @@ # --------------------------------------------------------------------------- # If any of these packages appear in the dependency closure, add the -# corresponding extra packages to the scope. +# corresponding extra packages to the scope. Triggers use prefix matching +# so a family root can pull its children (e.g. darwin-kperf). EXTRA_DEPENDENCIES: dict[str, list[str]] = { # Cyclic: hashql crates need compiletest "@rust/hashql-ast": ["@rust/hashql-compiletest"], @@ -38,6 +40,27 @@ "@rust/hash-graph-types": ["@rust/hash-graph-test-data"], } +# Extras that must not fire on a transitive or prefix match. Brunch core's +# architecture tests need the app and context root, but a job whose requested +# scope is only a sibling or a consumer of core must not pull that fixture. +REQUESTED_DEPENDENCIES: dict[str, list[str]] = { + "@hashintel/brunch-agent": ["@apps/brunch-agent"], +} + +# Non-workspace paths required by packages in the *requested* scope. +# `turbo prune` copies workspace directories and root manifests only. +REQUESTED_PATHS: dict[str, list[str]] = { + # The Brunch context root is deliberately not a workspace, but the + # architecture tests in packages/core read its docs, scripts, and agent + # contract files + "@hashintel/brunch-agent": [ + "libs/@hashintel/brunch-agent/AGENTS.md", + "libs/@hashintel/brunch-agent/CONTEXT.md", + "libs/@hashintel/brunch-agent/docs", + "libs/@hashintel/brunch-agent/scripts", + ], +} + TURBO_QUERY = """ query { packages { @@ -73,6 +96,31 @@ def turbo_dependency_map() -> dict[str, frozenset[str]]: return dep_map +def extras_for_requested(requested: Iterable[str]) -> frozenset[str]: + """Return extras implied by the job's requested scopes only. + + Exact identity: a name that is a prefix of its siblings must not match them. + """ + + names = set(requested) + extras: set[str] = set() + for trigger, additions in REQUESTED_DEPENDENCIES.items(): + if trigger in names: + extras.update(additions) + return frozenset(extras) + + +def extra_paths_for_requested(requested: Iterable[str]) -> list[str]: + """Return non-workspace paths implied by the job's requested scopes only.""" + + names = set(requested) + paths: list[str] = [] + for trigger, trigger_paths in REQUESTED_PATHS.items(): + if trigger in names: + paths.extend(trigger_paths) + return paths + + def expand_scopes(dependencies: Iterable[str]) -> frozenset[str]: """Return extra scopes implied by the dependency names. @@ -121,6 +169,29 @@ def turbo_prune(scopes: Iterable[str], *, dry_run: bool = False) -> None: subprocess.run(args, check=True) +def copy_extra_paths(scopes: Iterable[str], *, dry_run: bool = False) -> None: + """Copy non-workspace paths that `turbo prune` cannot include.""" + + for path in extra_paths_for_requested(scopes): + source = Path(path) + if not source.exists(): + msg = f"REQUESTED_PATHS names {source}, which does not exist" + raise FileNotFoundError(msg) + + destination = Path("out") / source + + if dry_run: + print(f"[dry-run] Would copy: {source} -> {destination}") + continue + + print(f"Copying extra path: {source} -> {destination}") + if source.is_dir(): + shutil.copytree(source, destination, dirs_exist_ok=True) + else: + destination.parent.mkdir(parents=True, exist_ok=True) + shutil.copy2(source, destination) + + def resolve_workspace_members() -> list[Path]: """Read workspace members from Cargo.toml and resolve globs to Cargo.toml paths.""" @@ -192,8 +263,9 @@ def main(argv: list[str] | None = None) -> None: } dependencies = turbo_dependency_map() - scopes = fixpoint_expand(initial, dependencies) + scopes = fixpoint_expand(initial | extras_for_requested(initial), dependencies) turbo_prune(scopes, dry_run=args.dry_run) + copy_extra_paths(initial, dry_run=args.dry_run) stub_missing_members(dry_run=args.dry_run) diff --git a/.github/actions/prune-repository/prune_test.py b/.github/actions/prune-repository/prune_test.py new file mode 100644 index 00000000000..8e2722cb52a --- /dev/null +++ b/.github/actions/prune-repository/prune_test.py @@ -0,0 +1,66 @@ +#!/usr/bin/env python3 +"""Hermetic oracles for prune extra-scope rules. Does not run turbo prune.""" + +from __future__ import annotations + +import unittest + +from prune import ( + expand_scopes, + extra_paths_for_requested, + extras_for_requested, + fixpoint_expand, +) + +CORE = "@hashintel/brunch-agent" +TRANSPORT = "@hashintel/brunch-agent-transport-aisdk" +APP = "@apps/brunch-agent" +WEBSITE = "@apps/petrinaut-website" + + +class BrunchRequestedExtras(unittest.TestCase): + def test_core_job_adds_the_app_and_context_paths(self) -> None: + self.assertEqual(extras_for_requested({CORE}), frozenset({APP})) + self.assertIn( + APP, + fixpoint_expand( + {CORE} | extras_for_requested({CORE}), + {CORE: frozenset(), APP: frozenset({CORE})}, + ), + ) + self.assertEqual( + extra_paths_for_requested({CORE}), + [ + "libs/@hashintel/brunch-agent/AGENTS.md", + "libs/@hashintel/brunch-agent/CONTEXT.md", + "libs/@hashintel/brunch-agent/docs", + "libs/@hashintel/brunch-agent/scripts", + ], + ) + + def test_sibling_or_website_job_does_not_add_brunch_extras(self) -> None: + self.assertEqual(extras_for_requested({TRANSPORT}), frozenset()) + self.assertEqual(extras_for_requested({WEBSITE}), frozenset()) + self.assertEqual(extra_paths_for_requested({TRANSPORT}), []) + self.assertEqual(extra_paths_for_requested({WEBSITE}), []) + + def test_transitive_core_in_the_closure_does_not_add_the_app(self) -> None: + dependencies = { + WEBSITE: frozenset({TRANSPORT}), + TRANSPORT: frozenset({CORE}), + CORE: frozenset(), + } + expanded = fixpoint_expand({WEBSITE}, dependencies) + self.assertNotIn(APP, expanded) + self.assertEqual(extras_for_requested({WEBSITE}), frozenset()) + + +class DarwinPrefix(unittest.TestCase): + def test_child_crate_still_triggers_the_prefix_family(self) -> None: + extras = expand_scopes({"@rust/darwin-kperf-sys"}) + self.assertIn("@rust/darwin-kperf-sys", extras) + self.assertIn("@rust/darwin-kperf-events", extras) + + +if __name__ == "__main__": + unittest.main() diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc index 908fbb21ec6..2d47e9c6681 100644 --- a/.markdownlint-cli2.jsonc +++ b/.markdownlint-cli2.jsonc @@ -35,6 +35,7 @@ "**/_ai/**", "**/.cursor/plans/**", "libs/@hashintel/ds-components/**", - "libs/@hashintel/ds-helpers/**" + "libs/@hashintel/ds-helpers/**", + "libs/@hashintel/brunch-agent/docs/**" ] } diff --git a/apps/brunch-agent/.gitignore b/apps/brunch-agent/.gitignore new file mode 100644 index 00000000000..e941ebb524d --- /dev/null +++ b/apps/brunch-agent/.gitignore @@ -0,0 +1,2 @@ +.data-wipe-me/ +.flue/ diff --git a/apps/brunch-agent/AGENTS.md b/apps/brunch-agent/AGENTS.md new file mode 100644 index 00000000000..90c05dde6d5 --- /dev/null +++ b/apps/brunch-agent/AGENTS.md @@ -0,0 +1,9 @@ +# Brunch agent application + +This application belongs to the Brunch context rooted at +`../../libs/@hashintel/brunch-agent/`. Read that context's `AGENTS.md`, `CONTEXT.md`, and relevant +ADRs before changing this application. HASH root guidance takes precedence. + +The application composes the Brunch packages, Flue runtime, HTTP routes, and local diagnostics. It +must remain independent of Petrinaut implementation packages; `apps/petrinaut-website` meets it +through the AI SDK/HTTP transport. diff --git a/apps/brunch-agent/CLAUDE.md b/apps/brunch-agent/CLAUDE.md new file mode 120000 index 00000000000..47dc3e3d863 --- /dev/null +++ b/apps/brunch-agent/CLAUDE.md @@ -0,0 +1 @@ +AGENTS.md \ No newline at end of file diff --git a/apps/brunch-agent/LICENSE.md b/apps/brunch-agent/LICENSE.md new file mode 100644 index 00000000000..c7d627721e2 --- /dev/null +++ b/apps/brunch-agent/LICENSE.md @@ -0,0 +1,607 @@ +GNU Affero General Public License +================================= + +_Version 3, 19 November 2007_ +_Copyright © 2007 Free Software Foundation, Inc. <>_ + +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. + +## Preamble + +The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +Developers that use our General Public Licenses protect your rights +with two steps: **(1)** assert copyright on the software, and **(2)** offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + +A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + +The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + +An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + +The precise terms and conditions for copying, distribution and +modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions + +“This License” refers to version 3 of the GNU Affero General Public License. + +“Copyright” also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + +“The Program” refers to any copyrightable work licensed under this +License. Each licensee is addressed as “you”. “Licensees” and +“recipients” may be individuals or organizations. + +To “modify” a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a “modified version” of the +earlier work or a work “based on” the earlier work. + +A “covered work” means either the unmodified Program or a work based +on the Program. + +To “propagate” a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To “convey” a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + +An interactive user interface displays “Appropriate Legal Notices” +to the extent that it includes a convenient and prominently visible +feature that **(1)** displays an appropriate copyright notice, and **(2)** +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code + +The “source code” for a work means the preferred form of the work +for making modifications to it. “Object code” means any non-source +form of a work. + +A “Standard Interface” means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The “System Libraries” of an executable work include anything, other +than the work as a whole, that **(a)** is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and **(b)** serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +“Major Component”, in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The “Corresponding Source” for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + +The Corresponding Source for a work in source code form is that +same work. + +### 2. Basic Permissions + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + +### 4. Conveying Verbatim Copies + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + +* **a)** The work must carry prominent notices stating that you modified +it, and giving a relevant date. +* **b)** The work must carry prominent notices stating that it is +released under this License and any conditions added under section 7. +This requirement modifies the requirement in section 4 to +“keep intact all notices”. +* **c)** You must license the entire work, as a whole, under this +License to anyone who comes into possession of a copy. This +License will therefore apply, along with any applicable section 7 +additional terms, to the whole of the work, and all its parts, +regardless of how they are packaged. This License gives no +permission to license the work in any other way, but it does not +invalidate such permission if you have separately received it. +* **d)** If the work has interactive user interfaces, each must display +Appropriate Legal Notices; however, if the Program has interactive +interfaces that do not display Appropriate Legal Notices, your +work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +“aggregate” if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +### 6. Conveying Non-Source Forms + +You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + +* **a)** Convey the object code in, or embodied in, a physical product +(including a physical distribution medium), accompanied by the +Corresponding Source fixed on a durable physical medium +customarily used for software interchange. +* **b)** Convey the object code in, or embodied in, a physical product +(including a physical distribution medium), accompanied by a +written offer, valid for at least three years and valid for as +long as you offer spare parts or customer support for that product +model, to give anyone who possesses the object code either **(1)** a +copy of the Corresponding Source for all the software in the +product that is covered by this License, on a durable physical +medium customarily used for software interchange, for a price no +more than your reasonable cost of physically performing this +conveying of source, or **(2)** access to copy the +Corresponding Source from a network server at no charge. +* **c)** Convey individual copies of the object code with a copy of the +written offer to provide the Corresponding Source. This +alternative is allowed only occasionally and noncommercially, and +only if you received the object code with such an offer, in accord +with subsection 6b. +* **d)** Convey the object code by offering access from a designated +place (gratis or for a charge), and offer equivalent access to the +Corresponding Source in the same way through the same place at no +further charge. You need not require recipients to copy the +Corresponding Source along with the object code. If the place to +copy the object code is a network server, the Corresponding Source +may be on a different server (operated by you or a third party) +that supports equivalent copying facilities, provided you maintain +clear directions next to the object code saying where to find the +Corresponding Source. Regardless of what server hosts the +Corresponding Source, you remain obligated to ensure that it is +available for as long as needed to satisfy these requirements. +* **e)** Convey the object code using peer-to-peer transmission, provided +you inform other peers where the object code and Corresponding +Source of the work are being offered to the general public at no +charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A “User Product” is either **(1)** a “consumer product”, which means any +tangible personal property which is normally used for personal, family, +or household purposes, or **(2)** anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, “normally used” refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + +“Installation Information” for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +### 7. Additional Terms + +“Additional permissions” are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + +* **a)** Disclaiming warranty or limiting liability differently from the +terms of sections 15 and 16 of this License; or +* **b)** Requiring preservation of specified reasonable legal notices or +author attributions in that material or in the Appropriate Legal +Notices displayed by works containing it; or +* **c)** Prohibiting misrepresentation of the origin of that material, or +requiring that modified versions of such material be marked in +reasonable ways as different from the original version; or +* **d)** Limiting the use for publicity purposes of names of licensors or +authors of the material; or +* **e)** Declining to grant rights under trademark law for use of some +trade names, trademarks, or service marks; or +* **f)** Requiring indemnification of licensors and authors of that +material by anyone who conveys the material (or modified versions of +it) with contractual assumptions of liability to the recipient, for +any liability that these contractual assumptions directly impose on +those licensors and authors. + +All other non-permissive additional terms are considered “further +restrictions” within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + +### 8. Termination + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated **(a)** +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and **(b)** permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +### 9. Acceptance Not Required for Having Copies + +You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An “entity transaction” is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +### 11. Patents + +A “contributor” is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's “contributor version”. + +A contributor's “essential patent claims” are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, “control” includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a “patent license” is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To “grant” such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either **(1)** cause the Corresponding Source to be so +available, or **(2)** arrange to deprive yourself of the benefit of the +patent license for this particular work, or **(3)** arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. “Knowingly relying” means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is “discriminatory” if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license **(a)** in connection with copies of the covered work +conveyed by you (or copies made from those copies), or **(b)** primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +### 12. No Surrender of Others' Freedom + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + +### 13. Remote Network Interaction; Use with the GNU General Public License + +Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + +### 14. Revised Versions of this License + +The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License “or any later version” applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +### 15. Disclaimer of Warranty + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +### 16. Limitation of Liability + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16 + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. diff --git a/apps/brunch-agent/flue.config.ts b/apps/brunch-agent/flue.config.ts new file mode 100644 index 00000000000..829f8e06779 --- /dev/null +++ b/apps/brunch-agent/flue.config.ts @@ -0,0 +1,8 @@ +import { defineConfig } from "@flue/runtime/config"; + +export default defineConfig({ + target: "node", + // Exhaustive, so a typo'd provider fails at resolution instead of reaching + // the network (Flue patterns audit, 2026-08-17). + providers: ["anthropic"], +}); diff --git a/apps/brunch-agent/index.html b/apps/brunch-agent/index.html new file mode 100644 index 00000000000..0b84eae229a --- /dev/null +++ b/apps/brunch-agent/index.html @@ -0,0 +1,12 @@ + + + + + + Elicitation harness — dev app + + +
+ + + diff --git a/apps/brunch-agent/package.json b/apps/brunch-agent/package.json new file mode 100644 index 00000000000..fc199cec26f --- /dev/null +++ b/apps/brunch-agent/package.json @@ -0,0 +1,42 @@ +{ + "name": "@apps/brunch-agent", + "version": "0.0.0-private", + "private": true, + "description": "Remote Brunch server, local development loop, target gallery, and diagnostic probe surface.", + "license": "AGPL-3.0", + "type": "module", + "scripts": { + "build": "vite build && vite build --config vite.client.config.ts", + "dev": "vite dev", + "fix:eslint": "oxlint --fix --type-aware --report-unused-disable-directives-severity=error .", + "lint:eslint": "oxlint --type-aware --report-unused-disable-directives-severity=error .", + "lint:tsc": "tsgo --noEmit", + "petrinaut:dev": "vite dev --config petrinaut-local.vite.config.ts", + "test:unit": "vitest run --config vitest.config.ts" + }, + "dependencies": { + "@flue/react": "2.0.3", + "@flue/runtime": "2.0.3", + "@flue/sdk": "2.0.3", + "@hashintel/brunch-agent": "workspace:*", + "@hashintel/brunch-agent-binding-flue": "workspace:*", + "@hashintel/brunch-agent-plugin-gherkin": "workspace:*", + "@hashintel/brunch-agent-transport-aisdk": "workspace:*", + "hono": "4.13.2", + "react": "19.2.6", + "react-dom": "19.2.6", + "valibot": "1.4.2" + }, + "devDependencies": { + "@earendil-works/pi-ai": "0.83.0", + "@flue/vite": "2.0.3", + "@types/node": "22.18.13", + "@types/react": "19.2.14", + "@types/react-dom": "19.2.3", + "@typescript/native-preview": "7.0.0-dev.20260511.1", + "oxlint": "1.63.0", + "oxlint-tsgolint": "0.22.1", + "vite": "8.1.0", + "vitest": "4.1.10" + } +} diff --git a/apps/brunch-agent/petrinaut-local.vite.config.ts b/apps/brunch-agent/petrinaut-local.vite.config.ts new file mode 100644 index 00000000000..249686c8498 --- /dev/null +++ b/apps/brunch-agent/petrinaut-local.vite.config.ts @@ -0,0 +1,72 @@ +/** + * Local FE-1436 panel launcher. + * + * Loads the real hash Petrinaut website config, removes only its incumbent + * `/api/chat` dev handler, and sends that same-origin route to brunch's + * committed application server. The real panel, wrappers, and editor stay untouched; + * hash's tracked checkout stays clean. + */ + +import { join, resolve } from "node:path"; + +import { + defineConfig, + loadConfigFromFile, + mergeConfig, + type PluginOption, +} from "vite"; + +import { + defaultChatOrigin, + petrinautLocalServer, +} from "./src/local-dev-origins.ts"; + +const withoutIncumbentChatHandler = ( + plugins: readonly PluginOption[], +): PluginOption[] => + plugins.filter((plugin) => { + if ( + plugin === false || + plugin === null || + plugin === undefined || + Array.isArray(plugin) || + typeof plugin !== "object" || + !("name" in plugin) + ) { + return true; + } + return plugin.name !== "petrinaut-api-dev"; + }); + +export default defineConfig(async (environment) => { + const websiteRoot = process.env.PETRINAUT_WEBSITE_ROOT; + if (!websiteRoot) { + throw new Error( + "PETRINAUT_WEBSITE_ROOT must point at hash/apps/petrinaut-website for the real-panel run.", + ); + } + const root = resolve(websiteRoot); + // Babel resolves the React compiler plugin from the launched project's cwd, + // not from the imported config file. Match a native hash launch before the + // plugin begins transforming the real panel source. + process.chdir(root); + const loaded = await loadConfigFromFile( + environment, + join(root, "vite.config.ts"), + root, + ); + if (!loaded) + throw new Error(`Could not load Petrinaut's Vite config from ${root}.`); + + const chatOrigin = process.env.BRUNCH_CHAT_ORIGIN ?? defaultChatOrigin; + return mergeConfig( + { + ...loaded.config, + plugins: withoutIncumbentChatHandler(loaded.config.plugins ?? []), + }, + { + root, + server: petrinautLocalServer(chatOrigin), + }, + ); +}); diff --git a/apps/brunch-agent/src/agents/gherkin-elicitor.ts b/apps/brunch-agent/src/agents/gherkin-elicitor.ts new file mode 100644 index 00000000000..a6bbc6d387d --- /dev/null +++ b/apps/brunch-agent/src/agents/gherkin-elicitor.ts @@ -0,0 +1,73 @@ +"use agent"; +/** + * The gherkin elicitor (spec §12.5: one agent per target). + * + * Named as a noun — the thing, not the act — and read target-first, so the + * family sorts together as targets multiply: `gherkin-elicitor`, + * `assurance-elicitor`. + * + * The product is the harness library in a thin host-authored agent — Flue's + * build-time scan makes the alternative structurally unavailable, since a + * library cannot ship a pre-registered agent (spec §12.1). So this module is + * deliberately thin: it mounts harness capability and holds no elicitation + * semantics of its own. + * + * Three recorded Flue constraints are honoured here by construction (spec §10): + * the `'use agent'` directive is the file's first statement; `agentName` is a + * pinned string literal, because conversation storage keys on it; and the tool + * set is static, because prompt-cache economics forbid per-question tool + * swapping. + */ + +import { useInitialData, useModel, type AgentProps } from "@flue/runtime"; +import * as v from "valibot"; + +import { useElicitation } from "@hashintel/brunch-agent-binding-flue"; +import { gherkin } from "@hashintel/brunch-agent-plugin-gherkin"; + +import { createGherkinElicitationSession } from "../elicitation-session.ts"; + +/** + * One definition for the agent and the faux provider alike: the two must name + * the same model id, and drift fails at resolution only if both sides resolve + * the same string (Flue patterns audit, 2026-08-17). + */ +export const GHERKIN_MODEL_ID = "claude-haiku-4-5"; + +export function GherkinElicitor(props: AgentProps) { + useModel(`anthropic/${GHERKIN_MODEL_ID}`); + const initialData = useInitialData<{ targetDocumentId: string }>(); + return useElicitation( + gherkin, + createGherkinElicitationSession(props.id, initialData.targetDocumentId), + ); +} + +/** + * Pinned, and never to be edited: conversation storage keys on this literal, + * so changing it orphans every existing conversation. Flue requires a string + * literal here because build targets derive durable identifiers from it before + * any user code runs. + * + * Product-prefixed on purpose, and this is the one place the prefix is not + * cosmetic. Agent identities are global per application, and the September + * demo shell is chartered to mount this library alongside the Petrinaut + * libraries — a bare `gherkin-elicitor` could collide with another library's + * agent, and the collision would land on durable conversation storage. + * + * The exported symbol stays the shorter `GherkinElicitor` because it reads + * better at the mount site; `agentName` exists precisely to let durable + * identity and source-level name differ. + */ +GherkinElicitor.agentName = "brunch-gherkin-elicitor"; + +/** + * Session→document binding (spec §9.1, adjudication L4): a new session's + * `initialData` carries the target-document id, validated once at creation and + * immutable thereafter — Flue's own lane for a target descriptor. Dispatching + * to an existing conversation id resumes that session against the current state + * of its target-document. + */ +GherkinElicitor.initialData = v.object({ + targetDocumentId: v.pipe(v.string(), v.nonEmpty()), +}); diff --git a/apps/brunch-agent/src/app.ts b/apps/brunch-agent/src/app.ts new file mode 100644 index 00000000000..6ce50876433 --- /dev/null +++ b/apps/brunch-agent/src/app.ts @@ -0,0 +1,57 @@ +/** + * The dev app's route map — the "mount" half of the thin host (spec §12.1). + * + * The dev app is chartered with three roles, none of them "the product" + * (spec §12.5): the local dev loop against every plugin, the colleague-facing + * target-gallery demo, and the diagnostic probe surface. Milestone one keeps + * affordance renderers here rather than in a ui package. + */ + +import { readFile } from "node:fs/promises"; + +import { createAgentRouter } from "@flue/runtime/routing"; +import { Hono } from "hono"; + +import { GherkinElicitor } from "./agents/gherkin-elicitor.ts"; +import { assetHandler } from "./assets.ts"; +import { petrinautChatHandler } from "./petrinaut-chat.ts"; +import { GHERKIN_AGENT_ROUTE, PETRINAUT_CHAT_ROUTE } from "./routes.ts"; + +const app = new Hono(); + +// One route per target agent. The gallery grows an entry per plugin; gherkin +// is the tracer that wires end-to-end first (spec §13). The browser and mount +// share the route constant; Flue still keys storage on the agent's independent, +// pinned identity. +app.route(`/agents/${GHERKIN_AGENT_ROUTE}`, createAgentRouter(GherkinElicitor)); + +// The application owns the HTTP mount; transport-aisdk owns only request validation +// and AI SDK stream encoding. No parallel conversation renderer is introduced. +app.on(["POST", "OPTIONS"], PETRINAUT_CHAT_ROUTE, (c) => + petrinautChatHandler(c.req.raw), +); + +// The flue dev controller owns the whole request space — no fall-through to +// vite's html serving — so the ui is app-served, in dev and in production +// alike (spec §10, recorded facts). +// +// Two different files, because two different builds produce them: in dev, the +// source `index.html` whose script tag vite resolves live; in production, the +// client build's emitted `index.html`, whose script tag points at a real +// bundled asset. `@flue/vite` emits the server environment only, so that +// client build is a second, plain vite build — without it the ui tree would +// have no build coverage at all. +const uiRoot = new URL( + import.meta.env?.DEV === false ? "./client/" : "../", + import.meta.url, +); + +app.get("/", async (c) => + c.html(await readFile(new URL("index.html", uiRoot), "utf8")), +); + +// Production only: in dev, vite serves the module graph under /src. A +// wildcard, not `:file` — bundlers may emit nested asset paths. +app.get("/assets/*", assetHandler(uiRoot)); + +export default app; diff --git a/apps/brunch-agent/src/assets.ts b/apps/brunch-agent/src/assets.ts new file mode 100644 index 00000000000..044eb140c32 --- /dev/null +++ b/apps/brunch-agent/src/assets.ts @@ -0,0 +1,106 @@ +/** + * Production asset serving — everything the client build emits, not an + * extension allowlist and not a filename grammar. + * + * The FE-1361 review verified the failure the old inline route carried: it + * allowlisted `js|css|map` and read hits as UTF-8, so the first font or image + * the client build emitted would 404 in production while vite dev served it + * fine — and widening the allowlist without dropping the UTF-8 read would + * have corrupted binary bytes instead. So: any safe file name serves, read as + * bytes; the content-type comes from hono's own MIME table and fails open to + * `application/octet-stream` rather than failing the asset. + * + * What counts as safe is a property of the path, not a pattern the emitted + * names are assumed to follow. `[name]` in a bundler's `assetFileNames` is the + * source basename, so spaces, parentheses, accents, `+`, `,`, `'`, `#` and `?` + * are all legal output, and a grammar narrower than the producer's is a + * production-only 404 waiting for the first asset that uses one. + * + * Mounted as a wildcard (`/assets/*`) rather than `:file`, because a `:file` + * param cannot match the nested paths bundlers emit (`assets/fonts/x.woff2`). + */ + +import { readFile } from "node:fs/promises"; + +import { getMimeType } from "hono/utils/mime"; + +import type { Context } from "hono"; + +/** + * Read failures that mean "no file at this path, and none can be": absent, + * reached through a file, a directory rather than a file, or too long to name + * one. Every other failure — a permission problem, a symlink cycle, an I/O + * error — is a fault to surface, because a 404 would report a broken build tree + * as an asset that was simply never emitted. + */ +const ABSENT_PATH_CODES = new Set([ + "ENOENT", + "ENOTDIR", + "EISDIR", + "ENAMETOOLONG", +]); + +const isAbsentPath = (error: unknown): boolean => + error instanceof Error && + "code" in error && + ABSENT_PATH_CODES.has((error as NodeJS.ErrnoException).code ?? ""); + +/** + * Whether a decoded path is safe to look up under the asset root: at least one + * segment, none empty, none dot-led — which is what keeps `..` traversal and + * hidden files out — no nul byte, which `readFile` rejects with a `TypeError` + * rather than an errno, and an extension on the last segment. + */ +const isSafeAssetPath = (file: string): boolean => { + if (file.includes("\0")) return false; + const segments = file.split("/"); + return ( + segments.every( + (segment) => segment.length > 0 && !segment.startsWith("."), + ) && /\.[^./]+$/.test(segments.at(-1) ?? "") + ); +}; + +/** Serve `assets/*` from the client build rooted at `uiRoot`. */ +export function assetHandler(uiRoot: URL): (c: Context) => Promise { + return async (c) => { + // The raw wildcard remainder, decoded here because hono decodes params + // but not the path — an undecodable escape is a 404, not a crash. + let file: string; + try { + file = decodeURIComponent(c.req.path.replace(/^\/assets\//, "")); + } catch (error) { + if (error instanceof URIError) return c.notFound(); + throw error; + } + if (!isSafeAssetPath(file)) return c.notFound(); + // Re-encoded segment by segment on the way into the URL: to the URL parser + // `#` opens a fragment and `?` a query, and under the file: scheme a + // backslash is a path separator, so a name carrying any of them addresses + // some other file — `..\` addresses one outside the asset root entirely. + const path = new URL( + `assets/${file + .split("/") + .map((segment) => encodeURIComponent(segment)) + .join("/")}`, + uiRoot, + ); + // Served as read, with no intermediate copy. The cast is a type gap, not a + // conversion: `readFile` is typed to admit a SharedArrayBuffer-backed view, + // which hono's body type excludes, while the value it returns always owns + // its own ArrayBuffer. + let bytes: Uint8Array; + try { + bytes = (await readFile(path)) as Uint8Array; + } catch (error) { + if (isAbsentPath(error)) return c.notFound(); + throw error; + } + // Fail open on the content-type, never on the bytes: an extension the + // table does not know degrades to a pickier content-type, not to a + // production-only 404. + return c.body(bytes, 200, { + "content-type": getMimeType(file) ?? "application/octet-stream", + }); + }; +} diff --git a/apps/brunch-agent/src/db-path.ts b/apps/brunch-agent/src/db-path.ts new file mode 100644 index 00000000000..faaec3fcec7 --- /dev/null +++ b/apps/brunch-agent/src/db-path.ts @@ -0,0 +1,27 @@ +/** + * Where the conversation store lives, resolved before the adapter opens it. + * + * Anchored to this module's location — the way `app.ts` anchors `uiRoot` — + * never to the launch directory: a cwd-relative default silently creates a + * fresh empty database when the app is launched from anywhere else, which is + * the exact restart-durability failure `db.ts` exists to prevent. From `src/` + * and from the emitted `dist/` bundle alike, `../.data-wipe-me/` resolves to + * the package directory. + * + * Kept apart from `db.ts` so path policy stays importable without loading the + * Flue Node runtime and SQLite adapter. + */ + +import { fileURLToPath } from "node:url"; + +export function conversationDbPath(): string { + // Truthiness, not nullish, on purpose: a set-but-empty override would pass + // '' through to sqlite(), which opens an anonymous temporary database + // deleted on close — silently non-durable again. + const override = process.env.BRUNCH_DEV_DB_PATH; + return override + ? override + : fileURLToPath( + new URL("../.data-wipe-me/conversations.db", import.meta.url), + ); +} diff --git a/apps/brunch-agent/src/db.ts b/apps/brunch-agent/src/db.ts new file mode 100644 index 00000000000..a63b9680437 --- /dev/null +++ b/apps/brunch-agent/src/db.ts @@ -0,0 +1,19 @@ +/** + * The substrate's conversation storage — host-authored because Flue requires + * it of the consuming app (spec §9.6, adjudication C1). + * + * Not to be confused with the capture store: that is the harness's storage + * port, harness-defined and implemented in `@hashintel/brunch-agent-binding-flue`, and plugins are + * blind to both. This file holds only the live transport copy of conversations. + * The provenance record is the target-document's own session-log archive. + * + * Without this file conversations are process-memory and a restart loses them + * (recorded Flue fact, spec §10). Restart durability of the full stack is an + * open verification item (spec §14.5) that this file exists to make testable. + */ + +import { sqlite } from "@flue/runtime/node"; + +import { conversationDbPath } from "./db-path.ts"; + +export default sqlite(conversationDbPath()); diff --git a/apps/brunch-agent/src/elicitation-session.ts b/apps/brunch-agent/src/elicitation-session.ts new file mode 100644 index 00000000000..ae7a9753668 --- /dev/null +++ b/apps/brunch-agent/src/elicitation-session.ts @@ -0,0 +1,34 @@ +/** Host-owned wiring for the local Flue binding's history transport and store. */ + +import { + createFlueHistoryReader, + createLocalCaptureStore, + type ElicitationSession, +} from "@hashintel/brunch-agent-binding-flue"; + +import { GHERKIN_AGENT_ROUTE } from "./routes.ts"; +import { targetDocumentPath } from "./target-document-path.ts"; + +const appTransport = (async (input: RequestInfo | URL, init?: RequestInit) => { + const { default: app } = await import("./app.ts"); + return app.fetch(input instanceof Request ? input : new Request(input, init)); +}) as typeof fetch; + +export const createGherkinElicitationSession = ( + sessionId: string, + targetDocumentId: string, +): ElicitationSession => { + const captureStore = createLocalCaptureStore( + targetDocumentPath(targetDocumentId), + ); + return { + sessionId, + captureStore, + historyReader: createFlueHistoryReader({ + resolveConversationUrl: (id) => + `http://brunch.local/agents/${GHERKIN_AGENT_ROUTE}/${id}`, + transport: appTransport, + archive: captureStore, + }), + }; +}; diff --git a/apps/brunch-agent/src/local-dev-origins.ts b/apps/brunch-agent/src/local-dev-origins.ts new file mode 100644 index 00000000000..797fc52b346 --- /dev/null +++ b/apps/brunch-agent/src/local-dev-origins.ts @@ -0,0 +1,30 @@ +/** Listen addresses the local Brunch↔Petrinaut pair must emit and assume. */ + +export const localChatListen = { + host: "127.0.0.1", + port: 4321, + strictPort: true, +} as const; + +export const localPanelListen = { + host: "127.0.0.1", + port: 4915, + strictPort: true, +} as const; + +export const defaultChatOrigin = `http://${localChatListen.host}:${localChatListen.port}`; + +export const defaultPanelOrigins = [ + `http://${localPanelListen.host}:${localPanelListen.port}`, + `http://localhost:${localPanelListen.port}`, +] as const; + +export const petrinautLocalServer = (chatOrigin: string) => ({ + ...localPanelListen, + proxy: { + "/api/chat": { + target: chatOrigin, + changeOrigin: true, + }, + }, +}); diff --git a/apps/brunch-agent/src/petrinaut-chat.ts b/apps/brunch-agent/src/petrinaut-chat.ts new file mode 100644 index 00000000000..9480653f56d --- /dev/null +++ b/apps/brunch-agent/src/petrinaut-chat.ts @@ -0,0 +1,94 @@ +/** Application composition for Petrinaut's stock AI SDK chat transport. */ + +import { init } from "@flue/runtime"; + +import { + decideAskReplyAdmission, + pendingAskAffordanceId, +} from "@hashintel/brunch-agent"; +import { + createFlueReplyProjector, + projectFlueHistoryForSweep, +} from "@hashintel/brunch-agent-binding-flue"; +import { + createAiSdkChatHandler, + type HarnessReplyEvent, + type TransportInspectionEvent, +} from "@hashintel/brunch-agent-transport-aisdk"; + +import { GherkinElicitor } from "./agents/gherkin-elicitor.ts"; +import { createGherkinElicitationSession } from "./elicitation-session.ts"; +import { defaultPanelOrigins } from "./local-dev-origins.ts"; + +const inspect = + process.env.BRUNCH_TRANSPORT_AISDK_INSPECT === "1" + ? (event: TransportInspectionEvent): void => { + // This is an opt-in shell diagnostic stream. It is never dispatched + // into Flue and therefore cannot become elicitation evidence. + console.log(`TRANSPORT_AISDK ${JSON.stringify(event)}`); + } + : undefined; + +// FE-1439 replaces this local one-conversation/one-document identity +// with principal-owned private session lookup. Keep it opaque here. +const targetDocumentIdFor = (conversationId: string): string => + `petrinaut-local:${conversationId}`; + +const streamElicitorTurn = async ( + conversationId: string, + dispatch: { readonly message: string; readonly idempotencyKey: string }, + emit: (event: HarnessReplyEvent) => void, +): Promise => { + const agent = init(GherkinElicitor, { id: conversationId }); + const receipt = await agent.dispatch({ + ...dispatch, + initialData: { targetDocumentId: targetDocumentIdFor(conversationId) }, + }); + const projector = createFlueReplyProjector({ + submissionId: receipt.submissionId, + emit, + }); + await agent.read(receipt, { onEvent: (chunk) => projector.accept(chunk) }); +}; + +export const petrinautChatHandler = createAiSdkChatHandler({ + allowedOrigins: ( + process.env.BRUNCH_PETRINAUT_ORIGINS ?? defaultPanelOrigins.join(",") + ) + .split(",") + .map((origin) => origin.trim()) + .filter((origin) => origin.length > 0), + inspect, + runTurn: (input, emit) => + streamElicitorTurn( + input.conversationId, + { message: input.userMessage.text, idempotencyKey: input.idempotencyKey }, + emit, + ), + askReply: { + // Admission consults durable Flue history, not request-shaped claims: the + // submission resumes the conversation only when its tool-call id + // correlates with the one ask still awaiting a reply. + async admit(input) { + const session = createGherkinElicitationSession( + input.conversationId, + targetDocumentIdFor(input.conversationId), + ); + const entries = projectFlueHistoryForSweep( + await session.historyReader.peek(input.conversationId), + ); + return decideAskReplyAdmission( + pendingAskAffordanceId(entries), + input.ask.toolCallId, + ); + }, + // The admitted answer is a fresh user dispatch (spec §7.4); the binding + // binds it to the pending affordance, making it the user-affordance reply. + run: (input, emit) => + streamElicitorTurn( + input.conversationId, + { message: input.ask.answer, idempotencyKey: input.idempotencyKey }, + emit, + ), + }, +}); diff --git a/apps/brunch-agent/src/routes.ts b/apps/brunch-agent/src/routes.ts new file mode 100644 index 00000000000..739c6323023 --- /dev/null +++ b/apps/brunch-agent/src/routes.ts @@ -0,0 +1,5 @@ +/** Browser-facing route segment; conversation identity remains the agent's pinned `agentName`. */ +export const GHERKIN_AGENT_ROUTE = "gherkin"; + +/** Stock `DefaultChatTransport` endpoint used by Petrinaut's local panel. */ +export const PETRINAUT_CHAT_ROUTE = "/api/chat"; diff --git a/apps/brunch-agent/src/target-document-path.ts b/apps/brunch-agent/src/target-document-path.ts new file mode 100644 index 00000000000..a2939f7ee7b --- /dev/null +++ b/apps/brunch-agent/src/target-document-path.ts @@ -0,0 +1,17 @@ +/** Resolve one target-document's local binding store without trusting its id as a path. */ + +import { createHash } from "node:crypto"; +import { join } from "node:path"; +import { fileURLToPath } from "node:url"; + +const defaultDirectory = (): string => + fileURLToPath(new URL("../.data-wipe-me/target-documents/", import.meta.url)); + +export function targetDocumentPath(targetDocumentId: string): string { + if (targetDocumentId.length === 0) + throw new TypeError("A target-document id cannot be empty."); + const directory = + process.env.BRUNCH_DEV_TARGET_DOCUMENT_DIR || defaultDirectory(); + const identity = createHash("sha256").update(targetDocumentId).digest("hex"); + return join(directory, `${identity}.json`); +} diff --git a/apps/brunch-agent/src/ui/chat.tsx b/apps/brunch-agent/src/ui/chat.tsx new file mode 100644 index 00000000000..ea9d6dd2f59 --- /dev/null +++ b/apps/brunch-agent/src/ui/chat.tsx @@ -0,0 +1,143 @@ +import { useFlueAgent } from "@flue/react"; +import { createFlueClient, type FlueConversationMessage } from "@flue/sdk"; +import { useEffect, useMemo, useRef, useState, type FormEvent } from "react"; +import * as v from "valibot"; + +import { FreeTextAffordance } from "@hashintel/brunch-agent"; + +import { GHERKIN_AGENT_ROUTE } from "../routes.ts"; + +const conversationId = crypto.randomUUID(); + +function VisibleMessage({ message }: { message: FlueConversationMessage }) { + if ( + message.display !== "visible" || + (message.purpose !== "user" && message.purpose !== "assistant") + ) { + return null; + } + + return ( +
+

+ {message.role === "user" ? "You" : "Interviewer"} +

+ {message.parts.map((part, index) => { + if (part.type === "text") { + return ( +

+ {part.text} +

+ ); + } + if (part.type === "data-affordance") { + const affordance = v.safeParse(FreeTextAffordance, part.data); + if (!affordance.success) return null; + return ( +
+ Question +

{affordance.output.markdown}

+ + Reply in your own words below. + +
+ ); + } + return null; + })} +
+ ); +} + +export function Chat() { + const [input, setInput] = useState(""); + const [bootstrapping, setBootstrapping] = useState(true); + const [startupError, setStartupError] = useState(); + const started = useRef(false); + const client = useMemo( + () => + createFlueClient({ + url: `/agents/${GHERKIN_AGENT_ROUTE}/${conversationId}`, + }), + [], + ); + const agent = useFlueAgent({ client }); + + useEffect(() => { + if (!agent.historyReady || agent.messages.length > 0 || started.current) + return; + started.current = true; + + void (async () => { + try { + const admission = await client.send({ + message: { kind: "user", body: "Begin the interview." }, + initialData: { targetDocumentId: `dev-${conversationId}` }, + }); + await client.wait(admission); + agent.refresh(); + } catch (error: unknown) { + setStartupError( + error instanceof Error + ? error.message + : "The interview could not start.", + ); + } finally { + setBootstrapping(false); + } + })(); + }, [agent, client]); + + const busy = + bootstrapping || + agent.status === "connecting" || + agent.status === "submitted" || + agent.status === "streaming"; + + function submit(event: FormEvent): void { + event.preventDefault(); + const reply = input.trim(); + if (!reply || busy) return; + setInput(""); + void agent.sendMessage(reply); + } + + return ( +
+
+
+

Brunch / elicitation field notes

+

Tell me how it should behave.

+
+ {agent.status} +
+ +
+ {agent.messages.map((message) => ( + + ))} + {agent.messages.length === 0 && !startupError ? ( +

Opening a fresh interview…

+ ) : null} + {startupError ?

{startupError}

: null} + {agent.error ?

{agent.error.message}

: null} +
+ +
+ +
+