diff --git a/Cargo.lock b/Cargo.lock index cf16d38f..e90cf835 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -244,9 +244,9 @@ dependencies = [ name = "binstalk" version = "0.15.0" dependencies = [ - "async-trait", "atomic-file-install", "binstalk-downloader", + "binstalk-fetchers", "binstalk-registry", "binstalk-types", "cargo-toml-workspace", @@ -258,11 +258,9 @@ dependencies = [ "itertools", "jobslot", "leon", - "leon-macros", "maybe-owned", "miette", "normalize-path", - "once_cell", "semver", "strum", "target-lexicon", @@ -309,6 +307,27 @@ dependencies = [ "zstd 0.12.4", ] +[[package]] +name = "binstalk-fetchers" +version = "0.0.0" +dependencies = [ + "async-trait", + "binstalk-downloader", + "binstalk-types", + "compact_str", + "either", + "itertools", + "leon", + "leon-macros", + "miette", + "once_cell", + "strum", + "thiserror", + "tokio", + "tracing", + "url", +] + [[package]] name = "binstalk-manifests" version = "0.8.0" diff --git a/Cargo.toml b/Cargo.toml index 39c2e512..03fee99c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,6 +3,7 @@ members = [ "crates/atomic-file-install", "crates/bin", "crates/binstalk", + "crates/binstalk-fetchers", "crates/binstalk-registry", "crates/binstalk-manifests", "crates/binstalk-types", diff --git a/crates/bin/src/logging.rs b/crates/bin/src/logging.rs index 787f07f4..2b5e4dbd 100644 --- a/crates/bin/src/logging.rs +++ b/crates/bin/src/logging.rs @@ -197,6 +197,8 @@ pub fn logging(log_level: LevelFilter, json_output: bool) { "atomic_file_install", "binstalk", "binstalk_downloader", + "binstalk_fetchers", + "binstalk_registry", "cargo_binstall", "cargo_toml_workspace", ]); diff --git a/crates/binstalk-fetchers/Cargo.toml b/crates/binstalk-fetchers/Cargo.toml new file mode 100644 index 00000000..89f26da6 --- /dev/null +++ b/crates/binstalk-fetchers/Cargo.toml @@ -0,0 +1,31 @@ +[package] +name = "binstalk-fetchers" +version = "0.0.0" +edition = "2021" + +description = "The binstall fetchers" +repository = "https://github.com/cargo-bins/cargo-binstall" +documentation = "https://docs.rs/binstalk-fetchers" +rust-version = "1.65.0" +authors = ["Jiahao XU "] +license = "GPL-3.0-only" + +[dependencies] +async-trait = "0.1.68" +binstalk-downloader = { version = "0.7.0", path = "../binstalk-downloader", default-features = false, features = ["gh-api-client"] } +binstalk-types = { version = "0.5.0", path = "../binstalk-types" } +compact_str = { version = "0.7.0" } +either = "1.8.1" +itertools = "0.11.0" +leon = { version = "2.0.1", path = "../leon", features = ["miette"] } +leon-macros = { version = "1.0.0", path = "../leon-macros" } +miette = "5.9.0" +once_cell = "1.18.0" +strum = "0.25.0" +thiserror = "1.0.40" +tokio = { version = "1.30.0", features = ["rt", "sync"], default-features = false } +tracing = "0.1.37" +url = "2.3.1" + +[dev-dependencies] +binstalk-downloader = { version = "0.7.0", path = "../binstalk-downloader" } diff --git a/crates/binstalk-fetchers/LICENSE b/crates/binstalk-fetchers/LICENSE new file mode 100644 index 00000000..f288702d --- /dev/null +++ b/crates/binstalk-fetchers/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 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 General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is 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. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + 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. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + 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 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. Use with the GNU Affero General Public License. + + 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 Affero 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 special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 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 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 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. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/crates/binstalk-fetchers/src/common.rs b/crates/binstalk-fetchers/src/common.rs new file mode 100644 index 00000000..c748b101 --- /dev/null +++ b/crates/binstalk-fetchers/src/common.rs @@ -0,0 +1,60 @@ +use std::sync::{ + atomic::{AtomicBool, Ordering::Relaxed}, + Once, +}; + +use binstalk_downloader::gh_api_client::{GhReleaseArtifact, HasReleaseArtifact}; +pub(super) use binstalk_downloader::{ + download::{Download, ExtractedFiles}, + gh_api_client::GhApiClient, + remote::{Client, Method, Url}, +}; +pub(super) use binstalk_types::cargo_toml_binstall::{PkgFmt, PkgMeta}; +pub(super) use compact_str::CompactString; +pub(super) use tokio::task::JoinHandle; +pub(super) use tracing::{debug, instrument, warn}; + +use crate::FetchError; + +/// This function returns a future where its size should be at most size of +/// 2-4 pointers. +pub(super) async fn does_url_exist( + client: Client, + gh_api_client: GhApiClient, + url: &Url, +) -> Result { + static GH_API_CLIENT_FAILED: AtomicBool = AtomicBool::new(false); + static WARN_RATE_LIMIT_ONCE: Once = Once::new(); + static WARN_UNAUTHORIZED_ONCE: Once = Once::new(); + + debug!("Checking for package at: '{url}'"); + + if !GH_API_CLIENT_FAILED.load(Relaxed) { + if let Some(artifact) = GhReleaseArtifact::try_extract_from_url(url) { + debug!("Using GitHub API to check for existence of artifact, which will also cache the API response"); + + // The future returned has the same size as a pointer + match gh_api_client.has_release_artifact(artifact).await? { + HasReleaseArtifact::Yes => return Ok(true), + HasReleaseArtifact::No | HasReleaseArtifact::NoSuchRelease => return Ok(false), + + HasReleaseArtifact::RateLimit { retry_after } => { + WARN_RATE_LIMIT_ONCE.call_once(|| { + warn!("Your GitHub API token (if any) has reached its rate limit and cannot be used again until {retry_after:?}, so we will fallback to HEAD/GET on the url."); + warn!("If you did not supply a github token, consider doing so: GitHub limits unauthorized users to 60 requests per hour per origin IP address."); + }); + } + HasReleaseArtifact::Unauthorized => { + WARN_UNAUTHORIZED_ONCE.call_once(|| { + warn!("GitHub API somehow requires a token for the API access, so we will fallback to HEAD/GET on the url."); + warn!("Please consider supplying a token to cargo-binstall to speedup resolution."); + }); + } + } + + GH_API_CLIENT_FAILED.store(true, Relaxed); + } + } + + Ok(Box::pin(client.remote_gettable(url.clone())).await?) +} diff --git a/crates/binstalk/src/helpers/futures_resolver.rs b/crates/binstalk-fetchers/src/futures_resolver.rs similarity index 100% rename from crates/binstalk/src/helpers/futures_resolver.rs rename to crates/binstalk-fetchers/src/futures_resolver.rs diff --git a/crates/binstalk/src/fetchers/gh_crate_meta.rs b/crates/binstalk-fetchers/src/gh_crate_meta.rs similarity index 84% rename from crates/binstalk/src/fetchers/gh_crate_meta.rs rename to crates/binstalk-fetchers/src/gh_crate_meta.rs index 33d732c2..9c0d949f 100644 --- a/crates/binstalk/src/fetchers/gh_crate_meta.rs +++ b/crates/binstalk-fetchers/src/gh_crate_meta.rs @@ -1,4 +1,4 @@ -use std::{borrow::Cow, iter, path::Path, sync::Arc}; +use std::{borrow::Cow, fmt, iter, marker::PhantomData, path::Path, sync::Arc}; use compact_str::{CompactString, ToCompactString}; use either::Either; @@ -9,34 +9,24 @@ use tracing::{debug, warn}; use url::Url; use crate::{ - errors::{BinstallError, InvalidPkgFmtError}, - helpers::{ - download::{Download, ExtractedFiles}, - futures_resolver::FuturesResolver, - gh_api_client::GhApiClient, - remote::{does_url_exist, Client}, - target_triple::TargetTriple, - tasks::AutoAbortJoinHandle, - }, - manifests::cargo_toml_binstall::{PkgFmt, PkgMeta}, + common::*, futures_resolver::FuturesResolver, Data, FetchError, InvalidPkgFmtError, RepoInfo, + TargetDataErased, }; -use super::{Data, RepoInfo, TargetData}; - pub(crate) mod hosting; pub struct GhCrateMeta { client: Client, gh_api_client: GhApiClient, data: Arc, - target_data: Arc, + target_data: Arc, resolution: OnceCell<(Url, PkgFmt)>, } impl GhCrateMeta { fn launch_baseline_find_tasks( &self, - futures_resolver: &FuturesResolver<(Url, PkgFmt), BinstallError>, + futures_resolver: &FuturesResolver<(Url, PkgFmt), FetchError>, pkg_fmt: PkgFmt, pkg_url: &Template<'_>, repo: Option<&str>, @@ -46,7 +36,7 @@ impl GhCrateMeta { let ctx = Context::from_data_with_repo( &self.data, &self.target_data.target, - &self.target_data.triple, + &self.target_data.target_related_info, ext, repo, subcrate, @@ -94,7 +84,7 @@ impl super::Fetcher for GhCrateMeta { client: Client, gh_api_client: GhApiClient, data: Arc, - target_data: Arc, + target_data: Arc, ) -> Arc { Arc::new(Self { client, @@ -105,8 +95,8 @@ impl super::Fetcher for GhCrateMeta { }) } - fn find(self: Arc) -> AutoAbortJoinHandle> { - AutoAbortJoinHandle::spawn(async move { + fn find(self: Arc) -> JoinHandle> { + tokio::spawn(async move { let info = self.data.get_repo_info(&self.client).await?.as_ref(); let repo = info.map(|info| &info.repo); @@ -137,9 +127,11 @@ impl super::Fetcher for GhCrateMeta { return Err(InvalidPkgFmtError { crate_name: crate_name.clone(), version: version.clone(), - target: target.clone(), - pkg_url: pkg_url.to_string(), - reason: "pkg-fmt is not specified, yet pkg-url does not contain format, archive-format or archive-suffix which is required for automatically deducing pkg-fmt", + target: target.into(), + pkg_url: pkg_url.into(), + reason: + &"pkg-fmt is not specified, yet pkg-url does not contain format, \ +archive-format or archive-suffix which is required for automatically deducing pkg-fmt", } .into()); } @@ -230,7 +222,7 @@ impl super::Fetcher for GhCrateMeta { }) } - async fn fetch_and_extract(&self, dst: &Path) -> Result { + async fn fetch_and_extract(&self, dst: &Path) -> Result { let (url, pkg_fmt) = self.resolution.get().unwrap(); // find() is called first debug!( "Downloading package from: '{url}' dst:{} fmt:{pkg_fmt:?}", @@ -278,31 +270,74 @@ impl super::Fetcher for GhCrateMeta { &self.target_data.target } - fn target_data(&self) -> &Arc { + fn target_data(&self) -> &Arc { &self.target_data } } /// Template for constructing download paths -#[derive(Clone, Debug)] +#[derive(Clone)] struct Context<'c> { - pub name: &'c str, - pub repo: Option<&'c str>, - pub target: &'c str, - pub version: &'c str, + name: &'c str, + repo: Option<&'c str>, + target: &'c str, + version: &'c str, /// Archive format e.g. tar.gz, zip - pub archive_format: Option<&'c str>, + archive_format: Option<&'c str>, - pub archive_suffix: Option<&'c str>, + archive_suffix: Option<&'c str>, /// Filename extension on the binary, i.e. .exe on Windows, nothing otherwise - pub binary_ext: &'c str, + binary_ext: &'c str, /// Workspace of the crate inside the repository. - pub subcrate: Option<&'c str>, + subcrate: Option<&'c str>, - pub triple: &'c TargetTriple, + target_related_info: &'c dyn leon::Values, +} + +impl fmt::Debug for Context<'_> { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + #[allow(dead_code)] + #[derive(Debug)] + struct Context<'c> { + name: &'c str, + repo: Option<&'c str>, + target: &'c str, + version: &'c str, + + archive_format: Option<&'c str>, + + archive_suffix: Option<&'c str>, + + binary_ext: &'c str, + + subcrate: Option<&'c str>, + + target_related_info: PhantomData<&'c dyn leon::Values>, + } + + fmt::Debug::fmt( + &Context { + name: self.name, + repo: self.repo, + target: self.target, + version: self.version, + + archive_format: self.archive_format, + + archive_suffix: self.archive_suffix, + + binary_ext: self.binary_ext, + + subcrate: self.subcrate, + + target_related_info: PhantomData, + }, + f, + ) + } } impl leon::Values for Context<'_> { @@ -324,7 +359,7 @@ impl leon::Values for Context<'_> { "subcrate" => self.subcrate.map(Cow::Borrowed), - key => self.triple.get_value(key), + key => self.target_related_info.get_value(key), } } } @@ -333,7 +368,7 @@ impl<'c> Context<'c> { fn from_data_with_repo( data: &'c Data, target: &'c str, - triple: &'c TargetTriple, + target_related_info: &'c dyn leon::Values, archive_suffix: Option<&'c str>, repo: Option<&'c str>, subcrate: Option<&'c str>, @@ -364,22 +399,19 @@ impl<'c> Context<'c> { }, subcrate, - triple, + target_related_info, } } /// * `tt` - must have added a template named "pkg_url". - pub(self) fn render_url_with_compiled_tt( - &self, - tt: &Template<'_>, - ) -> Result { + fn render_url_with_compiled_tt(&self, tt: &Template<'_>) -> Result { debug!("Render {tt:#?} using context: {self:?}"); Ok(Url::parse(&tt.render(self)?)?) } #[cfg(test)] - pub(self) fn render_url(&self, template: &str) -> Result { + fn render_url(&self, template: &str) -> Result { debug!("Render {template} using context in render_url: {self:?}"); let tt = Template::parse(template)?; @@ -389,10 +421,7 @@ impl<'c> Context<'c> { #[cfg(test)] mod test { - - use std::str::FromStr; - - use super::{super::Data, Context, TargetTriple}; + use super::{super::Data, Context}; use compact_str::ToCompactString; use url::Url; @@ -405,12 +434,14 @@ mod test { template: &str, expected_url: &str, ) { - let triple = &TargetTriple::from_str(target).unwrap(); + // The template provided doesn't need this, so just returning None + // is OK. + let target_info = leon::vals(|_| None); let ctx = Context::from_data_with_repo( data, target, - triple, + &target_info, Some(archive_format), data.repo.as_deref(), None, diff --git a/crates/binstalk/src/fetchers/gh_crate_meta/hosting.rs b/crates/binstalk-fetchers/src/gh_crate_meta/hosting.rs similarity index 100% rename from crates/binstalk/src/fetchers/gh_crate_meta/hosting.rs rename to crates/binstalk-fetchers/src/gh_crate_meta/hosting.rs diff --git a/crates/binstalk/src/fetchers.rs b/crates/binstalk-fetchers/src/lib.rs similarity index 79% rename from crates/binstalk/src/fetchers.rs rename to crates/binstalk-fetchers/src/lib.rs index aaf0e5ac..12396579 100644 --- a/crates/binstalk/src/fetchers.rs +++ b/crates/binstalk-fetchers/src/lib.rs @@ -1,26 +1,72 @@ use std::{path::Path, sync::Arc}; -use compact_str::CompactString; -pub use gh_crate_meta::*; -pub use quickinstall::*; -use tokio::sync::OnceCell; -use tracing::{debug, instrument}; -use url::Url; - -use crate::{ - errors::BinstallError, - helpers::{ - download::ExtractedFiles, gh_api_client::GhApiClient, remote::Client, - target_triple::TargetTriple, tasks::AutoAbortJoinHandle, - }, - manifests::cargo_toml_binstall::{PkgFmt, PkgMeta}, +use binstalk_downloader::{ + download::DownloadError, gh_api_client::GhApiError, remote::Error as RemoteError, }; +use thiserror::Error as ThisError; +use tokio::sync::OnceCell; +pub use url::ParseError as UrlParseError; -pub(crate) mod gh_crate_meta; -pub(crate) mod quickinstall; +mod gh_crate_meta; +pub use gh_crate_meta::*; + +mod quickinstall; +pub use quickinstall::*; + +mod common; +use common::*; + +mod futures_resolver; use gh_crate_meta::hosting::RepositoryHost; +#[derive(Debug, ThisError)] +#[error("Invalid pkg-url {pkg_url} for {crate_name}@{version} on {target}: {reason}")] +pub struct InvalidPkgFmtError { + pub crate_name: CompactString, + pub version: CompactString, + pub target: CompactString, + pub pkg_url: Box, + pub reason: &'static &'static str, +} + +#[derive(Debug, ThisError, miette::Diagnostic)] +#[non_exhaustive] +#[cfg_attr(feature = "miette", derive(miette::Diagnostic))] +pub enum FetchError { + #[error(transparent)] + Download(#[from] DownloadError), + + #[error("Failed to parse template: {0}")] + #[diagnostic(transparent)] + TemplateParse(#[from] leon::ParseError), + + #[error("Failed to render template: {0}")] + #[diagnostic(transparent)] + TemplateRender(#[from] leon::RenderError), + + #[error("Failed to render template: {0}")] + GhApi(#[from] GhApiError), + + #[error(transparent)] + InvalidPkgFmt(Box), + + #[error("Failed to parse url: {0}")] + UrlParse(#[from] UrlParseError), +} + +impl From for FetchError { + fn from(e: RemoteError) -> Self { + DownloadError::from(e).into() + } +} + +impl From for FetchError { + fn from(e: InvalidPkgFmtError) -> Self { + Self::InvalidPkgFmt(Box::new(e)) + } +} + #[async_trait::async_trait] pub trait Fetcher: Send + Sync { /// Create a new fetcher from some data @@ -29,13 +75,13 @@ pub trait Fetcher: Send + Sync { client: Client, gh_api_client: GhApiClient, data: Arc, - target_data: Arc, + target_data: Arc, ) -> Arc where Self: Sized; /// Fetch a package and extract - async fn fetch_and_extract(&self, dst: &Path) -> Result; + async fn fetch_and_extract(&self, dst: &Path) -> Result; /// Find the package, if it is available for download /// @@ -45,7 +91,7 @@ pub trait Fetcher: Send + Sync { /// /// Must return `true` if a package is available, `false` if none is, and reserve errors to /// fatal conditions only. - fn find(self: Arc) -> AutoAbortJoinHandle>; + fn find(self: Arc) -> JoinHandle>; /// Report to upstream that cargo-binstall tries to use this fetcher. /// Currently it is only overriden by [`quickinstall::QuickInstall`]. @@ -73,7 +119,7 @@ pub trait Fetcher: Send + Sync { /// Return the target for this fetcher fn target(&self) -> &str; - fn target_data(&self) -> &Arc; + fn target_data(&self) -> &Arc; } #[derive(Clone, Debug)] @@ -103,7 +149,7 @@ impl Data { } #[instrument(level = "debug")] - async fn get_repo_info(&self, client: &Client) -> Result<&Option, BinstallError> { + async fn get_repo_info(&self, client: &Client) -> Result<&Option, FetchError> { self.repo_info .get_or_try_init(move || { Box::pin(async move { @@ -194,12 +240,19 @@ impl RepoInfo { /// Target specific data required to fetch a package #[derive(Clone, Debug)] -pub struct TargetData { +pub struct TargetData { pub target: String, - pub triple: TargetTriple, pub meta: PkgMeta, + /// More target related info, it's recommend to provide the following keys: + /// - target_family, + /// - target_arch + /// - target_libc + /// - target_vendor + pub target_related_info: T, } +pub type TargetDataErased = TargetData; + #[cfg(test)] mod test { use super::*; diff --git a/crates/binstalk/src/fetchers/quickinstall.rs b/crates/binstalk-fetchers/src/quickinstall.rs similarity index 88% rename from crates/binstalk/src/fetchers/quickinstall.rs rename to crates/binstalk-fetchers/src/quickinstall.rs index 157ae679..f0ffae25 100644 --- a/crates/binstalk/src/fetchers/quickinstall.rs +++ b/crates/binstalk-fetchers/src/quickinstall.rs @@ -1,23 +1,10 @@ use std::{path::Path, sync::Arc}; -use compact_str::CompactString; +use binstalk_types::cargo_toml_binstall::{PkgFmt, PkgMeta}; use tokio::sync::OnceCell; -use tracing::{debug, warn}; use url::Url; -use crate::{ - errors::BinstallError, - helpers::{ - download::{Download, ExtractedFiles}, - gh_api_client::GhApiClient, - is_universal_macos, - remote::{does_url_exist, Client, Method}, - tasks::AutoAbortJoinHandle, - }, - manifests::cargo_toml_binstall::{PkgFmt, PkgMeta}, -}; - -use super::{Data, TargetData}; +use crate::{common::*, Data, FetchError, TargetDataErased}; const BASE_URL: &str = "https://github.com/cargo-bins/cargo-quickinstall/releases/download"; const STATS_URL: &str = "https://warehouse-clerk-tmp.vercel.app/api/crate"; @@ -25,9 +12,13 @@ const STATS_URL: &str = "https://warehouse-clerk-tmp.vercel.app/api/crate"; const QUICKINSTALL_SUPPORTED_TARGETS_URL: &str = "https://raw.githubusercontent.com/cargo-bins/cargo-quickinstall/main/supported-targets"; +fn is_universal_macos(target: &str) -> bool { + ["universal-apple-darwin", "universal2-apple-darwin"].contains(&target) +} + async fn get_quickinstall_supported_targets( client: &Client, -) -> Result<&'static [CompactString], BinstallError> { +) -> Result<&'static [CompactString], FetchError> { static SUPPORTED_TARGETS: OnceCell> = OnceCell::const_new(); SUPPORTED_TARGETS @@ -60,11 +51,11 @@ pub struct QuickInstall { package_url: Url, stats_url: Url, - target_data: Arc, + target_data: Arc, } impl QuickInstall { - async fn is_supported(&self) -> Result { + async fn is_supported(&self) -> Result { self.is_supported_v .get_or_try_init(|| async { Ok(get_quickinstall_supported_targets(&self.client) @@ -83,7 +74,7 @@ impl super::Fetcher for QuickInstall { client: Client, gh_api_client: GhApiClient, data: Arc, - target_data: Arc, + target_data: Arc, ) -> Arc { let crate_name = &data.name; let version = &data.version; @@ -108,8 +99,8 @@ impl super::Fetcher for QuickInstall { }) } - fn find(self: Arc) -> AutoAbortJoinHandle> { - AutoAbortJoinHandle::spawn(async move { + fn find(self: Arc) -> JoinHandle> { + tokio::spawn(async move { if !self.is_supported().await? { return Ok(false); } @@ -145,7 +136,7 @@ by rust officially."#, } } - async fn fetch_and_extract(&self, dst: &Path) -> Result { + async fn fetch_and_extract(&self, dst: &Path) -> Result { let url = &self.package_url; debug!("Downloading package from: '{url}'"); Ok(Download::new(self.client.clone(), url.clone()) @@ -180,13 +171,13 @@ by rust officially."#, &self.target_data.target } - fn target_data(&self) -> &Arc { + fn target_data(&self) -> &Arc { &self.target_data } } impl QuickInstall { - pub async fn report(&self) -> Result<(), BinstallError> { + pub async fn report(&self) -> Result<(), FetchError> { if !self.is_supported().await? { debug!( "Not sending quickinstall report for {} since Quickinstall does not support these targets.", diff --git a/crates/binstalk/Cargo.toml b/crates/binstalk/Cargo.toml index 2e70281e..26413227 100644 --- a/crates/binstalk/Cargo.toml +++ b/crates/binstalk/Cargo.toml @@ -10,9 +10,9 @@ edition = "2021" license = "GPL-3.0-only" [dependencies] -async-trait = "0.1.68" atomic-file-install = { version = "0.0.0", path = "../atomic-file-install" } binstalk-downloader = { version = "0.7.0", path = "../binstalk-downloader", default-features = false, features = ["gh-api-client"] } +binstalk-fetchers = { version = "0.0.0", path = "../binstalk-fetchers" } binstalk-registry = { version = "0.0.0", path = "../binstalk-registry" } binstalk-types = { version = "0.5.0", path = "../binstalk-types" } cargo-toml-workspace = { version = "0.0.0", path = "../cargo-toml-workspace" } @@ -24,11 +24,9 @@ home = "0.5.5" itertools = "0.11.0" jobslot = { version = "0.2.11", features = ["tokio"] } leon = { version = "2.0.1", path = "../leon" } -leon-macros = { version = "1.0.0", path = "../leon-macros" } maybe-owned = "0.3.4" miette = "5.9.0" normalize-path = { version = "0.2.1", path = "../normalize-path" } -once_cell = "1.18.0" semver = { version = "1.0.17", features = ["serde"] } strum = "0.25.0" target-lexicon = { version = "0.12.11", features = ["std"] } diff --git a/crates/binstalk/src/bins.rs b/crates/binstalk/src/bins.rs index 980069f2..5136552c 100644 --- a/crates/binstalk/src/bins.rs +++ b/crates/binstalk/src/bins.rs @@ -15,7 +15,7 @@ use crate::{ atomic_install, atomic_install_noclobber, atomic_symlink_file, atomic_symlink_file_noclobber, }, - helpers::{download::ExtractedFiles, target_triple::TargetTriple}, + helpers::download::ExtractedFiles, manifests::cargo_toml_binstall::{PkgFmt, PkgMeta}, }; @@ -99,7 +99,7 @@ impl BinFile { bin: base_name, binary_ext, - triple: data.triple, + target_related_info: data.target_related_info, }; let (source, archive_source_path) = if data.meta.pkg_fmt == Some(PkgFmt::Bin) { @@ -273,21 +273,26 @@ pub struct Data<'a> { pub meta: PkgMeta, pub bin_path: &'a Path, pub install_path: &'a Path, - pub triple: &'a TargetTriple, + /// More target related info, it's recommend to provide the following keys: + /// - target_family, + /// - target_arch + /// - target_libc + /// - target_vendor + pub target_related_info: &'a dyn leon::Values, } -#[derive(Clone, Debug)] +#[derive(Clone)] struct Context<'c> { - pub name: &'c str, - pub repo: Option<&'c str>, - pub target: &'c str, - pub version: &'c str, - pub bin: &'c str, + name: &'c str, + repo: Option<&'c str>, + target: &'c str, + version: &'c str, + bin: &'c str, /// Filename extension on the binary, i.e. .exe on Windows, nothing otherwise - pub binary_ext: &'c str, + binary_ext: &'c str, - pub triple: &'c TargetTriple, + target_related_info: &'c dyn leon::Values, } impl leon::Values for Context<'_> { @@ -302,7 +307,7 @@ impl leon::Values for Context<'_> { // Soft-deprecated alias for binary-ext "format" => Some(Cow::Borrowed(self.binary_ext)), - key => self.triple.get_value(key), + key => self.target_related_info.get_value(key), } } } diff --git a/crates/binstalk/src/errors.rs b/crates/binstalk/src/errors.rs index db2e19cd..750e6507 100644 --- a/crates/binstalk/src/errors.rs +++ b/crates/binstalk/src/errors.rs @@ -7,6 +7,7 @@ use std::{ use binstalk_downloader::{ download::DownloadError, gh_api_client::GhApiError, remote::Error as RemoteError, }; +use binstalk_fetchers::FetchError; use compact_str::CompactString; use miette::{Diagnostic, Report}; use target_lexicon::ParseError as TargetTripleParseError; @@ -94,6 +95,16 @@ pub enum BinstallError { leon::ParseError, ), + /// Failed to fetch pre-built binaries. + /// + /// - Code: `binstall::fetch` + /// - Exit: 68 + #[error(transparent)] + #[diagnostic(severity(error), code(binstall::fetch))] + #[source_code(transparent)] + #[label(transparent)] + FetchError(Box), + /// Failed to render template. /// /// - Code: `binstall::template` @@ -352,6 +363,7 @@ impl BinstallError { UserAbort => 32, UrlParse(_) => 65, TemplateParseError(..) => 67, + FetchError(..) => 68, TemplateRenderError(..) => 69, Download(_) => 68, SubProcess { .. } => 70, @@ -494,3 +506,9 @@ impl From for BinstallError { BinstallError::LoadManifestFromWSError(Box::new(e)) } } + +impl From for BinstallError { + fn from(e: FetchError) -> Self { + BinstallError::FetchError(Box::new(e)) + } +} diff --git a/crates/binstalk/src/helpers.rs b/crates/binstalk/src/helpers.rs index bbe9411e..019fd7a9 100644 --- a/crates/binstalk/src/helpers.rs +++ b/crates/binstalk/src/helpers.rs @@ -1,4 +1,3 @@ -pub(crate) mod futures_resolver; pub mod jobserver_client; pub mod remote; pub(crate) mod target_triple; diff --git a/crates/binstalk/src/helpers/tasks.rs b/crates/binstalk/src/helpers/tasks.rs index 47bee796..6530c444 100644 --- a/crates/binstalk/src/helpers/tasks.rs +++ b/crates/binstalk/src/helpers/tasks.rs @@ -60,8 +60,11 @@ impl Future for AutoAbortJoinHandle { } } -impl AutoAbortJoinHandle> { +impl AutoAbortJoinHandle> +where + E: Into, +{ pub async fn flattened_join(self) -> Result { - self.await? + self.await?.map_err(Into::into) } } diff --git a/crates/binstalk/src/lib.rs b/crates/binstalk/src/lib.rs index c3b467ff..295e6bfd 100644 --- a/crates/binstalk/src/lib.rs +++ b/crates/binstalk/src/lib.rs @@ -2,11 +2,11 @@ mod bins; pub mod errors; -pub mod fetchers; pub mod helpers; pub mod ops; use atomic_file_install as fs; +pub use binstalk_fetchers as fetchers; pub use binstalk_registry as registry; pub use binstalk_types as manifests; pub use detect_targets::{get_desired_targets, DesiredTargets, TARGET}; diff --git a/crates/binstalk/src/ops.rs b/crates/binstalk/src/ops.rs index d996e4d0..eb75b724 100644 --- a/crates/binstalk/src/ops.rs +++ b/crates/binstalk/src/ops.rs @@ -5,7 +5,7 @@ use std::{path::PathBuf, sync::Arc}; use semver::VersionReq; use crate::{ - fetchers::{Data, Fetcher, TargetData}, + fetchers::{Data, Fetcher, TargetDataErased}, helpers::{ self, gh_api_client::GhApiClient, jobserver_client::LazyJobserverClient, remote::Client, }, @@ -16,7 +16,7 @@ use crate::{ pub mod resolve; -pub type Resolver = fn(Client, GhApiClient, Arc, Arc) -> Arc; +pub type Resolver = fn(Client, GhApiClient, Arc, Arc) -> Arc; #[non_exhaustive] pub enum CargoTomlFetchOverride { diff --git a/crates/binstalk/src/ops/resolve.rs b/crates/binstalk/src/ops/resolve.rs index fdf3414a..d6c73149 100644 --- a/crates/binstalk/src/ops/resolve.rs +++ b/crates/binstalk/src/ops/resolve.rs @@ -23,6 +23,7 @@ use crate::{ helpers::{ self, cargo_toml::Manifest, cargo_toml_workspace::load_manifest_from_workspace, download::ExtractedFiles, remote::Client, target_triple::TargetTriple, + tasks::AutoAbortJoinHandle, }, manifests::cargo_toml_binstall::{Meta, PkgMeta, PkgOverride}, ops::{CargoTomlFetchOverride, Options}, @@ -111,8 +112,8 @@ async fn resolve_inner( Arc::new(TargetData { target: target.clone(), - triple, meta: target_meta, + target_related_info: triple, }) }) .cartesian_product(resolvers) @@ -123,7 +124,7 @@ async fn resolve_inner( data.clone(), target_data, ); - (fetcher.clone(), fetcher.find()) + (fetcher.clone(), AutoAbortJoinHandle::new(fetcher.find())) }), ); @@ -305,7 +306,7 @@ fn collect_bin_files( meta, bin_path, install_path, - triple: &fetcher.target_data().triple, + target_related_info: &fetcher.target_data().target_related_info, }; let bin_dir = bin_data