@intx/tool-packaging 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,176 @@
1
+ GNU LESSER GENERAL PUBLIC LICENSE
2
+
3
+ Version 2.1, February 1999
4
+
5
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
6
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
7
+
8
+ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
9
+
10
+ [This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.]
11
+
12
+ Preamble
13
+
14
+ The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users.
15
+
16
+ This license, the Lesser General Public License, applies to some specially designated software packages--typically libraries--of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below.
17
+
18
+ When we speak of free software, we are referring to freedom of use, 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 this service if you wish); that you receive source code or can get it if you want it; that you can change the software and use pieces of it in new free programs; and that you are informed that you can do these things.
19
+
20
+ To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it.
21
+
22
+ For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling it. And you must show them these terms so they know their rights.
23
+
24
+ We protect your rights with a two-step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library.
25
+
26
+ To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is modified by someone else and passed on, the recipients should know that what they have is not the original version, so that the original author's reputation will not be affected by problems that might be introduced by others.
27
+
28
+ Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license.
29
+
30
+ Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use this license for certain libraries in order to permit linking those libraries into non-free programs.
31
+
32
+ When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with the library.
33
+
34
+ We call this license the "Lesser" General Public License because it does Less to protect the user's freedom than the ordinary General Public License. It also provides other free software developers Less of an advantage over competing non-free programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances.
35
+
36
+ For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes a de-facto standard. To achieve this, non-free programs must be allowed to use the library. A more frequent case is that a free library does the same job as widely used non-free libraries. In this case, there is little to gain by limiting the free library to free software only, so we use the Lesser General Public License.
37
+
38
+ In other cases, permission to use a particular library in non-free programs enables a greater number of people to use a large body of free software. For example, permission to use the GNU C Library in non-free programs enables many more people to use the whole GNU operating system, as well as its variant, the GNU/Linux operating system.
39
+
40
+ Although the Lesser General Public License is Less protective of the users' freedom, it does ensure that the user of a program that is linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library.
41
+
42
+ The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, whereas the latter must be combined with the library in order to run.
43
+
44
+ GNU LESSER GENERAL PUBLIC LICENSE
45
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
46
+
47
+ 0. This License Agreement applies to any software library or other program which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Lesser General Public License (also called "this License"). Each licensee is addressed as "you".
48
+
49
+ A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables.
50
+
51
+ The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".)
52
+
53
+ "Source code" for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library.
54
+
55
+ Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does.
56
+
57
+ 1. You may copy and distribute verbatim copies of the Library's complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the Library.
58
+
59
+ You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.
60
+
61
+ 2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:
62
+
63
+ a) The modified work must itself be a software library.
64
+
65
+ b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change.
66
+
67
+ c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License.
68
+
69
+ d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, in the event an application does not supply such function or table, the facility still operates, and performs whatever part of its purpose remains meaningful.
70
+
71
+ (For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.)
72
+
73
+ These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.
74
+
75
+ Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library.
76
+
77
+ In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
78
+
79
+ 3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices.
80
+
81
+ Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy.
82
+
83
+ This option is useful when you wish to copy part of the code of the Library into a program that is not a library.
84
+
85
+ 4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange.
86
+
87
+ If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code.
88
+
89
+ 5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License.
90
+
91
+ However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. Section 6 states terms for distribution of such executables.
92
+
93
+ When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law.
94
+
95
+ If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.)
96
+
97
+ Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself.
98
+
99
+ 6. As an exception to the Sections above, you may also combine or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer's own use and reverse engineering for debugging such modifications.
100
+
101
+ You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things:
102
+
103
+ a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application to use the modified definitions.)
104
+
105
+ b) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (1) uses at run time a copy of the library already present on the user's computer system, rather than copying library functions into the executable, and (2) will operate properly with a modified version of the library, if the user installs one, as long as the modified version is interface-compatible with the version that the work was made with.
106
+
107
+ c) Accompany the work with a written offer, valid for at least three years, to give the same user the materials specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution.
108
+
109
+ d) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above specified materials from the same place.
110
+
111
+ e) Verify that the user has already received a copy of these materials or that you have already sent this user a copy.
112
+
113
+ For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the materials to be distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.
114
+
115
+ It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute.
116
+
117
+ 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things:
118
+
119
+ a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities. This must be distributed under the terms of the Sections above.
120
+
121
+ b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work.
122
+
123
+ 8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
124
+
125
+ 9. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it.
126
+
127
+ 10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties with this License.
128
+
129
+ 11. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), 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 distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library.
130
+
131
+ If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances.
132
+
133
+ It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.
134
+
135
+ This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
136
+
137
+ 12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.
138
+
139
+ 13. The Free Software Foundation may publish revised and/or new versions of the Lesser 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.
140
+
141
+ Each version is given a distinguishing version number. If the Library specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation.
142
+
143
+ 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.
144
+
145
+ NO WARRANTY
146
+
147
+ 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "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 LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
148
+
149
+ 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY 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 LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
150
+
151
+ END OF TERMS AND CONDITIONS
152
+
153
+ How to Apply These Terms to Your New Libraries
154
+
155
+ If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License).
156
+
157
+ To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.
158
+
159
+ one line to give the library's name and an idea of what it does.
160
+ Copyright (C) year name of author
161
+
162
+ This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
163
+
164
+ This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
165
+
166
+ You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail.
167
+
168
+ You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the library, if necessary. Here is a sample; alter the names:
169
+
170
+ Yoyodyne, Inc., hereby disclaims all copyright interest in
171
+ the library `Frob' (a library for tweaking knobs) written
172
+ by James Random Hacker.
173
+
174
+ signature of Ty Coon, 1 April 1990
175
+ Ty Coon, President of Vice
176
+ That's all there is to it!
package/README.md ADDED
@@ -0,0 +1,116 @@
1
+ # @intx/tool-packaging
2
+
3
+ Hub-side closure resolver and sidecar-side loader for the npm-distributed
4
+ tool-package format. The contract below describes what the layered
5
+ pipeline actually guarantees end-to-end; downstream code (the apply
6
+ protocol, the session service, the deploy-flow integration tests) leans
7
+ on it as written.
8
+
9
+ ## Loader resolution contract
10
+
11
+ A tool package's `interchange.tools` entry, and the JS body it pulls in
12
+ transitively, may `import` (or `require`) any bare specifier the
13
+ manifest's resolved closure satisfies. The loader builds a per-instance
14
+ nested `node_modules/` layout under the scratch directory so each
15
+ package's direct dependencies are reachable through Node's standard
16
+ ancestor walk; the layout composes recursively, so a transitive's own
17
+ transitives are reachable from inside it.
18
+
19
+ Concretely the loader:
20
+
21
+ 1. Walks every manifest entry and validates that each one is
22
+ registry-chain-consistent: every entry the manifest says lives at a
23
+ registry resolves end-to-end against that registry, and every entry
24
+ that lives in an asset resolves against the asset's `assetMounts`
25
+ map.
26
+ 2. Materializes every entry into the content-addressable tarball
27
+ cache: bytes pulled from the entry's source on a miss are verified
28
+ through `cache.put`, and the bytes are then unpacked once via
29
+ `cache.extractTarball`. A single sha512 produces a single
30
+ extraction shared across instances.
31
+ 3. Lays out each entry under `<scratch>/store/<name>/<version>/` by
32
+ hardlinking the file tree from the cache extraction. Each layout
33
+ directory then gets `node_modules/<dep>` symlinked into it pointing
34
+ at the sibling `store/<dep>/<depVersion>/` chosen for that
35
+ requirer. Hardlinks keep on-disk usage to one copy per integrity
36
+ per filesystem; symlinks at the `node_modules/` boundary let
37
+ Node's realpath-based resolver walk to the dep's own layout dir
38
+ (which has its own `node_modules/`).
39
+ 4. Dynamically imports each top-level entry's `interchange.tools`
40
+ module and collects the `AnnotatedToolFactory` /
41
+ `AnnotatedPluginFactory` values it exports.
42
+
43
+ Properties that fall out of this layout:
44
+
45
+ - **Closure satisfies itself.** A top-level package's body, plus every
46
+ transitive it pulls in, resolves bare-specifier imports against the
47
+ manifest closure with no help from the sidecar host's own
48
+ `node_modules`.
49
+ - **No hoisting between top-levels.** Each top-level keeps its own
50
+ nested view; two top-levels that disagree on a transitive's version
51
+ get two distinct entries in the store, both materialized.
52
+ - **Version conflicts coexist.** Diamond dependencies share a single
53
+ store entry (one symlink target per `(name, version)`); divergent
54
+ versions live as separate store entries and Node's ancestor walk
55
+ picks the right one for each requirer.
56
+ - **Runtime-agnostic tarballs.** The loader does no Bun-specific
57
+ resolution. A tool package whose `interchange.tools` entry is a
58
+ `.js` file with no workspace-only deps loads identically on Node
59
+ and Bun. The workspace's built-in tool packages bundle their entries
60
+ through `bin/build-builtins.ts` precisely so the produced tarballs
61
+ satisfy this property.
62
+
63
+ ## Optional-dependency semantics
64
+
65
+ The closure walker honors npm's "an optional subtree is best-effort"
66
+ contract: when an `optionalDependencies` edge fails to resolve — the
67
+ packument is absent, the range picks nothing, the registry rejects the
68
+ fetch — the whole subtree under that edge is dropped from the manifest
69
+ silently. A hard dep of an optional dep is part of that optional
70
+ subtree; a failure there drops the parent too, instead of leaving a
71
+ parent in the closure whose own hard requirement is missing. Failures
72
+ outside any optional subtree abort the walk and surface as a
73
+ `manifest.invalid` deploy-apply error.
74
+
75
+ ## Asset modification race
76
+
77
+ The hub-side `AssetRegistrySource` reads tarball packuments from a
78
+ `package-registry` asset at resolution time. The sidecar's
79
+ `createPack` then resolves the asset's main ref and serves the tarball
80
+ bytes the resolver pinned. A concurrent PUT or DELETE against the
81
+ asset's `tarballs/` prefix in the window between the resolver's read
82
+ and the sidecar's fetch can cause the apply to fail with
83
+ `tarball.missing` or `integrity.mismatch`.
84
+
85
+ The substrate's `writeTreePreservingPrefix` primitive makes PUTs and
86
+ DELETEs against the asset atomic with respect to one another, but it
87
+ does not couple them to the sidecar's deploy-apply read. The
88
+ intentional behavior is: the apply fails loudly as a rejected
89
+ deploy-apply. There is no silent corruption —
90
+ the integrity check on the sidecar side guarantees that mismatched
91
+ bytes are rejected — but the operator does see a failed apply if the
92
+ asset is mutated concurrently with a launch.
93
+
94
+ A follow-up that snapshots the asset's commit SHA at resolution time
95
+ and replays against it at apply time is in scope if this shows up in
96
+ operator practice; it is not implemented today.
97
+
98
+ ## Call-time imports and `import.meta.url`
99
+
100
+ Tool packages may resolve files relative to their own on-disk location
101
+ at run time — `import.meta.url`, `require.resolve()`, or an
102
+ `await import(new URL("./sibling.js", import.meta.url))` evaluated long
103
+ after the module first loaded. The loader imports each top-level
104
+ package's `interchange.tools` entry from a path under
105
+ `<instanceDir>/packages/<deploy-id>/` that is never renamed, so a
106
+ module's `import.meta.url` stays valid for the life of the deploy.
107
+
108
+ The prior deploy's directory is retained across the next apply, so a
109
+ session still draining against an older deploy keeps resolving its own
110
+ files until a further apply supersedes it. See `ASSET-LAYOUT.md` for
111
+ the on-disk layout and retention rules.
112
+
113
+ ## Follow-up reference
114
+
115
+ - **INTR-180**: drizzle mock replacement for tests that introspect
116
+ the package's resolver outputs.
@@ -0,0 +1,65 @@
1
+ import type { DeployApplyErrorCategory } from "@intx/types/sidecar";
2
+ import type { ToolPackageManifest } from "@intx/types/tool-packages";
3
+ import { type LoadedToolPackage, type ToolLoader } from "./loader.js";
4
+ export interface ApplyAtomicArgs {
5
+ readonly manifest: ToolPackageManifest;
6
+ readonly loader: ToolLoader;
7
+ readonly instanceDir: string;
8
+ readonly assetRoot: string;
9
+ /**
10
+ * Maps a `source.assetId` to a workspace-relative mount path. The
11
+ * loader uses this to resolve `kind: "asset"` manifest entries.
12
+ * Forwarded verbatim to `ToolLoader.loadManifest`.
13
+ */
14
+ readonly assetMounts: ReadonlyMap<string, string>;
15
+ readonly attemptId: string;
16
+ /**
17
+ * The deploy id the instance is currently running. Retained on disk
18
+ * through this apply (its `packages/<previousDeployId>/` tree is not
19
+ * swept) and carried back on a failure so the caller can confirm the
20
+ * prior deploy is unchanged.
21
+ */
22
+ readonly previousDeployId: string;
23
+ /** New deploy id; on the caller's commit becomes the active deploy id. */
24
+ readonly newDeployId: string;
25
+ }
26
+ export interface ApplyAtomicSuccess {
27
+ readonly status: "ok";
28
+ readonly activeDeployId: string;
29
+ /** Absolute path of the staged, never-renamed deploy directory. */
30
+ readonly deployDir: string;
31
+ readonly loaded: readonly LoadedToolPackage[];
32
+ }
33
+ export interface ApplyAtomicFailure {
34
+ readonly status: "failed";
35
+ readonly category: DeployApplyErrorCategory;
36
+ readonly message: string;
37
+ readonly package?: {
38
+ readonly name: string;
39
+ readonly version: string;
40
+ };
41
+ /**
42
+ * The deploy id the instance is still running. The apply never wrote
43
+ * `active-deploy-id`, so a failure always leaves the prior deploy
44
+ * live: this equals the input `previousDeployId`. (The caller owns
45
+ * the commit and is the only layer that can advance the active id;
46
+ * the persist-degraded case it handles there carries its own
47
+ * inverted meaning, but that case does not originate in this module.)
48
+ */
49
+ readonly previousDeployId: string;
50
+ readonly attemptId: string;
51
+ readonly occurredAt: string;
52
+ }
53
+ export type ApplyAtomicResult = ApplyAtomicSuccess | ApplyAtomicFailure;
54
+ /**
55
+ * Stage a tool-package manifest into a per-deploy-id directory under
56
+ * `instanceDir` and return the loaded packages. The orchestration is
57
+ * single-threaded per instance: the prelude sweep assumes exclusive
58
+ * write access to `<instanceDir>/packages/`. The hub-side session
59
+ * manager already serializes applies per agent (one apply per
60
+ * `agentAddress` at a time); host-side callers that bypass that
61
+ * serialization must provide their own per-`instanceDir` lock, because
62
+ * the prelude sweep deletes sibling deploy directories and a racing
63
+ * apply could delete a directory the other just committed.
64
+ */
65
+ export declare function applyAtomic(args: ApplyAtomicArgs): Promise<ApplyAtomicResult>;
@@ -0,0 +1,223 @@
1
+ // Apply protocol for a ToolPackageManifest.
2
+ //
3
+ // Each apply materializes its closure into a stable, per-deploy-id
4
+ // directory that is never moved:
5
+ //
6
+ // <instanceDir>/packages/<deploy-id>/store/<name>/<version>/...
7
+ //
8
+ // The loader dynamic-imports each pinned package's `interchange.tools`
9
+ // module from an absolute path inside that deploy-id directory. Because
10
+ // the directory is never renamed, the URL Node keys its ESM module
11
+ // cache under stays valid for the life of the deploy: a tool package
12
+ // that uses `import.meta.url`, `require.resolve()`, or a call-time
13
+ // `await import("./sibling.js")` resolves against a path that still
14
+ // exists. (The earlier protocol staged under `pending/` and renamed
15
+ // `pending/` → `active/` after import; the renamed-away URL ENOENTed
16
+ // any late path resolution. This module exists to remove that swap.)
17
+ //
18
+ // This module does NOT commit. It stages, loads, validates, and
19
+ // returns the loaded packages plus the deploy-id directory. The commit
20
+ // point lives one layer up: the caller writes the instance's
21
+ // `active-deploy-id` file to name `newDeployId`. Until that write
22
+ // lands, the instance is still running `previousDeployId`, whose
23
+ // directory is left untouched here. The "atomic swap" is therefore the
24
+ // single `active-deploy-id` file write the caller performs, not a
25
+ // directory rename.
26
+ //
27
+ // Retention. A prelude sweep removes every `packages/<id>/` except
28
+ // `{newDeployId, previousDeployId}`. The keep set is invariant across
29
+ // the caller's commit: before the commit the live deploy is
30
+ // `previousDeployId`; after it the live deploy is `newDeployId` and
31
+ // `previousDeployId` is the retained prior tree. So a single sweep at
32
+ // the start of the apply both bounds disk to ~2 closures and preserves
33
+ // exactly the prior deploy as a liveness window for any session still
34
+ // draining against it.
35
+ //
36
+ // Retention invariant: the previous deploy's directory must survive
37
+ // until the next apply, because a session built against it may still
38
+ // perform a call-time `await import()` into its tree. The next apply's
39
+ // prelude reaps it. This is safe only because per-agent applies are
40
+ // serialized (the hub runs one apply per `agentAddress` at a time) and
41
+ // each successful apply replaces the running harness, so by the time
42
+ // apply N+2 reaps deploy N, generation-N's harness teardown has
43
+ // completed and no live code references deploy N's tree.
44
+ //
45
+ // Caller responsibilities (not handled here):
46
+ //
47
+ // - Writing `active-deploy-id` to commit the staged deploy.
48
+ // - Constructing the WebSocket frame from the returned error.
49
+ // - Writing the rejected manifest + error to the sidecar's git audit
50
+ // trail under `audit/rejected-applies/<attemptId>/`.
51
+ //
52
+ // Crash safety. Boot never reads a deploy-id directory: the harness
53
+ // rebuilds by re-running the apply against the current manifest into a
54
+ // fresh deploy id. A half-written `packages/<newDeployId>/` left by a
55
+ // crash mid-build is therefore self-healing — the next boot
56
+ // re-materializes into a new id and the prelude sweep reclaims the
57
+ // orphan. Only `active-deploy-id` needs durability, and the caller owns
58
+ // that. Consequently this module fsyncs nothing.
59
+ //
60
+ // Cross-apply ESM module-identity: Node keys its ESM cache by resolved
61
+ // URL. Per-deploy-id directories already make every apply's import URL
62
+ // unique, so a reused `(name, version)` whose bytes changed across
63
+ // applies resolves to a distinct path. The loader additionally
64
+ // cache-busts each import URL with an `?integrity=<sri>` query string;
65
+ // that remains correct (and harmless) under per-deploy-id paths.
66
+ import { promises as fs } from "node:fs";
67
+ import path from "node:path";
68
+ import { getLogger } from "@intx/log";
69
+ import { ToolLoaderError, } from "./loader.js";
70
+ const logger = getLogger(["sidecar", "tool-packaging", "atomic-apply"]);
71
+ const PACKAGES_DIR = "packages";
72
+ /**
73
+ * Stage a tool-package manifest into a per-deploy-id directory under
74
+ * `instanceDir` and return the loaded packages. The orchestration is
75
+ * single-threaded per instance: the prelude sweep assumes exclusive
76
+ * write access to `<instanceDir>/packages/`. The hub-side session
77
+ * manager already serializes applies per agent (one apply per
78
+ * `agentAddress` at a time); host-side callers that bypass that
79
+ * serialization must provide their own per-`instanceDir` lock, because
80
+ * the prelude sweep deletes sibling deploy directories and a racing
81
+ * apply could delete a directory the other just committed.
82
+ */
83
+ export async function applyAtomic(args) {
84
+ const packagesDir = path.join(args.instanceDir, PACKAGES_DIR);
85
+ const deployDir = path.join(packagesDir, args.newDeployId);
86
+ // Prelude sweep. Reclaim every prior deploy directory except the one
87
+ // we are about to build (`newDeployId`) and the one still live
88
+ // (`previousDeployId`). `previousDeployId` may be the "no prior
89
+ // deploy" sentinel, which simply matches no directory. The sweep is
90
+ // best-effort per stray: an EIO/EPERM reclaiming one old deploy is a
91
+ // disk-reclamation concern, not a correctness one, and must not fail
92
+ // an otherwise-valid apply — the next apply's prelude retries the
93
+ // reclaim. The deploy directory we then build, by contrast, must be
94
+ // a clean tree, so its removal+mkdir below propagate on failure.
95
+ const keep = new Set([args.newDeployId, args.previousDeployId]);
96
+ let existing;
97
+ try {
98
+ existing = await fs.readdir(packagesDir);
99
+ }
100
+ catch (err) {
101
+ if (!isENOENT(err))
102
+ throw err;
103
+ existing = [];
104
+ }
105
+ await Promise.all(existing
106
+ .filter((id) => !keep.has(id))
107
+ .map(async (id) => {
108
+ try {
109
+ await fs.rm(path.join(packagesDir, id), {
110
+ recursive: true,
111
+ force: true,
112
+ });
113
+ }
114
+ catch (err) {
115
+ logger.warn `apply prelude sweep could not reclaim stale deploy ${id} under ${packagesDir}: ${err instanceof Error ? err.message : String(err)}; next apply will retry`;
116
+ }
117
+ }));
118
+ // A leftover directory under this exact `newDeployId` (a crash mid-
119
+ // build, or the astronomically unlikely uuid reuse) must be cleared
120
+ // before staging so the loader builds into a clean tree.
121
+ await fs.rm(deployDir, { recursive: true, force: true });
122
+ await fs.mkdir(deployDir, { recursive: true });
123
+ let loaded;
124
+ try {
125
+ loaded = await args.loader.loadManifest({
126
+ manifest: args.manifest,
127
+ instanceScratchDir: deployDir,
128
+ assetRoot: args.assetRoot,
129
+ assetMounts: args.assetMounts,
130
+ });
131
+ }
132
+ catch (err) {
133
+ await fs.rm(deployDir, { recursive: true, force: true });
134
+ if (err instanceof ToolLoaderError) {
135
+ logger.warn `apply rejected (${err.category}) for attempt ${args.attemptId}; previous deploy ${args.previousDeployId} retained`;
136
+ const out = {
137
+ status: "failed",
138
+ category: err.category,
139
+ message: err.message,
140
+ ...(err.package !== undefined ? { package: err.package } : {}),
141
+ previousDeployId: args.previousDeployId,
142
+ attemptId: args.attemptId,
143
+ occurredAt: new Date().toISOString(),
144
+ };
145
+ return out;
146
+ }
147
+ // Unknown error shape: surface as factory.construct.failed since
148
+ // that is the closest catch-all in the taxonomy.
149
+ logger.error `unexpected loader error for attempt ${args.attemptId}: ${err instanceof Error ? err.message : String(err)}`;
150
+ return {
151
+ status: "failed",
152
+ category: "factory.construct.failed",
153
+ message: err instanceof Error ? err.message : String(err),
154
+ previousDeployId: args.previousDeployId,
155
+ attemptId: args.attemptId,
156
+ occurredAt: new Date().toISOString(),
157
+ };
158
+ }
159
+ // Check for duplicate factory ids across loaded bundles. The plan's
160
+ // taxonomy distinguishes `tool.name.duplicate` from other
161
+ // categories, so this check fires after a successful load but before
162
+ // the caller commits. The loader has already prefixed each tool
163
+ // factory id with its bundle id by the time we see it here, so a
164
+ // collision in `factory.id` means two pinned packages shared a bundle
165
+ // id (the per-bundle prefix did not produce unique ids across the
166
+ // load).
167
+ //
168
+ // Plugin factories carry their own `id` (not bundle-prefixed) and
169
+ // are addressed by id at harness construction; a collision between
170
+ // two plugin ids would resolve to undefined behavior at the harness
171
+ // layer. Treat that as the same apply-time gate: tool and plugin
172
+ // id spaces are tracked separately so the operator-facing message
173
+ // points at the right surface, but neither admits a duplicate.
174
+ const toolIdsSeen = new Set();
175
+ const pluginIdsSeen = new Set();
176
+ for (const pkg of loaded) {
177
+ for (const factory of pkg.factories) {
178
+ if (toolIdsSeen.has(factory.id)) {
179
+ await fs.rm(deployDir, { recursive: true, force: true });
180
+ const out = {
181
+ status: "failed",
182
+ category: "tool.name.duplicate",
183
+ message: `tool factory id ${factory.id} appears in more than one pinned package`,
184
+ package: { name: pkg.name, version: pkg.version },
185
+ previousDeployId: args.previousDeployId,
186
+ attemptId: args.attemptId,
187
+ occurredAt: new Date().toISOString(),
188
+ };
189
+ return out;
190
+ }
191
+ toolIdsSeen.add(factory.id);
192
+ }
193
+ for (const plugin of pkg.plugins) {
194
+ if (pluginIdsSeen.has(plugin.id)) {
195
+ await fs.rm(deployDir, { recursive: true, force: true });
196
+ const out = {
197
+ status: "failed",
198
+ category: "tool.name.duplicate",
199
+ message: `plugin factory id ${plugin.id} appears in more than one pinned package`,
200
+ package: { name: pkg.name, version: pkg.version },
201
+ previousDeployId: args.previousDeployId,
202
+ attemptId: args.attemptId,
203
+ occurredAt: new Date().toISOString(),
204
+ };
205
+ return out;
206
+ }
207
+ pluginIdsSeen.add(plugin.id);
208
+ }
209
+ }
210
+ logger.info `apply staged: attempt ${args.attemptId} ready as ${args.newDeployId} (caller commits via active-deploy-id)`;
211
+ return {
212
+ status: "ok",
213
+ activeDeployId: args.newDeployId,
214
+ deployDir,
215
+ loaded,
216
+ };
217
+ }
218
+ function isENOENT(err) {
219
+ return (err !== null &&
220
+ typeof err === "object" &&
221
+ "code" in err &&
222
+ err.code === "ENOENT");
223
+ }