diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..96dbe0b --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,22 @@ +name: Build + +on: + pull_request: + branches: [main, feat/*] + types: [opened, ready_for_review] + push: + workflow_dispatch: + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - name: Set up Go + uses: actions/setup-go@v3 + with: + go-version: 1.17.6 + + - name: Build + run: go build -v ./... diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml new file mode 100644 index 0000000..acd35f4 --- /dev/null +++ b/.github/workflows/linter.yml @@ -0,0 +1,34 @@ +name: Go linter +on: + pull_request: + branches: [main, feat/*] + types: [opened, ready_for_review] + push: + workflow_dispatch: + +permissions: + contents: read + +jobs: + golangci: + name: golangci linter + runs-on: ubuntu-latest + steps: + - uses: actions/setup-go@v3 + with: + go-version: 1.17.6 + - uses: actions/checkout@v3 + - name: golangci-lint + uses: golangci/golangci-lint-action@v3 + with: + # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version. + version: v1.45.2 + + # Optional: working directory, useful for monorepos + # working-directory: somedir + + # Optional: golangci-lint command line arguments. + args: --timeout 10m0s --max-issues-per-linter 0 --max-same-issues 0 --print-issued-lines + + # Optional: show only new issues if it's a pull request. The default value is `false`. + only-new-issues: true diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..9f2c8ef --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,25 @@ +name: Test + +on: + pull_request: + branches: [main, feat/*] + types: [opened, ready_for_review] + push: + workflow_dispatch: + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - name: Set up Go + uses: actions/setup-go@v3 + with: + go-version: 1.17.6 + + - name: Build + run: go build -v ./... + + - name: Test + run: go test -v -race ./... diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3b735ec --- /dev/null +++ b/.gitignore @@ -0,0 +1,21 @@ +# If you prefer the allow list template instead of the deny list, see community template: +# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore +# +# Binaries for programs and plugins +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Test binary, built with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# Dependency directories (remove the comment below to include it) +# vendor/ + +# Go workspace file +go.work diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/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/README.md b/README.md new file mode 100644 index 0000000..b719294 --- /dev/null +++ b/README.md @@ -0,0 +1,143 @@ +# mx-chain-ws-connector-template-go + +## Introduction + +In today's rapidly evolving blockchain ecosystem, the demand for real-time access to exported data from blockchain nodes +has significantly increased. To meet this growing need within our expanding system, we have developed the Outport +Driver, a powerful websocket connection system specifically designed for the MultiversX blockchain. + +The Outport Driver acts as a crucial bridge between the MultiversX blockchain node and various services that rely on +receiving up-to-date data from the node. By establishing a websocket connection, the Outport Driver enables seamless +transmission of essential information, including blocks, validator details, account changes, and other processing +results. + +One of the key features of the MultiversX blockchain node is its flexible configuration file. By simply setting a flag +to "true" within this file, the node can initiate the delivery of data via a websocket connection to any connected +websocket client. This capability provides a reliable and efficient method for receiving live updates from the +MultiversX blockchain. + +To simplify the process of setting up your own data receiver from the MultiversX blockchain node, we have created this +repository as a comprehensive template. It serves as a valuable resource, guiding you through the necessary steps to +establish a successful connection with the MultiversX blockchain node and receive the exported data effortlessly. + +Whether you are building a decentralized application, monitoring the blockchain network, or conducting in-depth data +analysis, this template repository equips you with the foundation to swiftly integrate and leverage the exported data +from the MultiversX blockchain node. + +Begin your journey towards seamless data integration and take advantage of the Outport Driver's robust websocket +connector by exploring the contents of this repository. We look forward to witnessing the innovative applications and +services that will emerge as a result of this collaborative ecosystem. + +_Note: The Outport Driver is an open-source project, and we encourage active contributions and feedback from the +community to further enhance its capabilities and compatibility with different blockchain networks._ + +## How to use + +### Use cases + +The Outport Driver operates on a robust websocket connection architecture, supporting both server and client roles. The +system is designed to seamlessly export data from the MultiversX blockchain node, which adopts a sharded architecture +where each shard represents a separate running chain, interconnected by the meta chain. + +To export data from a specific shard, you need to enable an observer node within that shard to export data. One can do +that +by enabling the **[HostDriverConfig].Enabled** flag to true +[from this config file](https://github.com/MultiversX/mx-chain-go/blob/master/cmd/node/config/external.toml) + +In our case of a network consisting of three shards and a metachain, you would require four separate websocket receiver +binaries, each responsible for receiving data from its respective shard. This distributed approach ensures data +integrity and allows for shard-specific data processing. + +However, the websocket connection in the Outport Driver is highly flexible and parameterizable. By customizing the +configuration, you can configure the observer nodes to function as clients and the driver (this template binary) as a +server. This configuration reduces the number of driver receiver binaries to just one, acting as a server that receives +data from each observer, from each shard. To set your receiver as a server, you need set **mode** +from `cmd/connector/config/config.toml` to **"server"**. + +Alternatively, you have the option to set up the observer node as a server capable of handling multiple clients. This +setup proves advantageous when multiple services within your ecosystem need to receive exported data. For instance, a +single node could export data to various services, such as an elastic indexer, a monitoring tool, a notifier, or other +implementations. + +By tailoring the configuration of the observer nodes and the driver (this template binary) to suit your specific +requirements, you can effectively streamline and centralize the reception of data from the MultiversX blockchain node. +This flexibility empowers you to design a data distribution strategy that aligns with your ecosystem's needs while +ensuring efficient and reliable data transmission. + +### Illustration + +1. In this scenario, each observer node acts as a server, sending data to one or more receivers. The receivers act as a + client and receive data from each observer node and processes it accordingly. + +``` + +----------------+ +-------------------+ + | Observer 1 |-->| Receiver 1 | + | | +-------------------+ + | | + | | +-------------------+ + | |-->| Receiver 2 | + +----------------+ +-------------------+ + + +----------------+ +-------------------+ + | Observer 2 |-->| Receiver 3 | + +----------------+ +-------------------+ + + +----------------+ +-------------------+ + | Observer 3 |-->| Receiver 4 | + +----------------+ +-------------------+ +``` + +2. In this scenario, the observer nodes act as clients, while a single receiver collects data from all of them. The + receiver acts as the server, receiving data from each observer node. + +``` + +----------------+ +-------------------+ + | Observer 1 |-->| | + +----------------+ | | + | | + +----------------+ | | + | Observer 2 |-->| Receiver | + +----------------+ | | + | | + +----------------+ | | + | Observer 3 |-->| | + +----------------+ | | + | | + +----------------+ | | + | Receiver |-->| | + +----------------+ +-------------------+ +``` + +### Start building + +Once you have an observer node running and configured to export data (either server or client) you can test your +receiver. + +1. Start by navigating to the `cmd/connector` directory in your terminal or file explorer. This is where you'll find + the `main.go` file. + +2. Build the binary by running the `go build` command. This will compile the code and create the `connector` binary + executable. + +3. After building, you can start the `connector` binary by executing the generated executable file. This will launch the + websocket data receiver. + +4. In the `cmd/connector/config/config.toml` file, you can configure the settings for your receiver. Adjust the + necessary parameters such as the url, port, or any other relevant options. + +5. The provided code is a dummy implementation that logs events upon receiving data from the blockchain node. To + customize the actions taken when receiving exported data, you need to define your own logic in the `process` package. + +6. In the `process` package, there is a `logDataProcessor.go`. This processor is capable of handling data from the + websocket outport driver and logging events. + +7. One can see that `operationHandlers` defines a map of actions and their handler functions for the received payload. + All you need to do is to replace the dummy code (which only logs events) with your specific use case on how to handle + received data (`saveBlock`, `revertIndexedBlock`, etc.). Modify the logic according to your requirements, + such as saving to a database, triggering other processes, or performing any necessary data transformations. + +8. Once you have customized the code to handle the received data as desired, you can build and run the `connector` + binary again to see your changes in action. + +_If you want to test the ws receiver within a local setup testnet environment, you can use the provided demo +within `cmd/demo` directory._ \ No newline at end of file diff --git a/cmd/connector/config/config.toml b/cmd/connector/config/config.toml new file mode 100644 index 0000000..6c50162 --- /dev/null +++ b/cmd/connector/config/config.toml @@ -0,0 +1,15 @@ +[web_socket] + # IP with port used to recieve data via ws. Should be compatible with the one from node. See [HostDriverConfig].URL + # from https://github.com/multiversx/mx-chain-go/blob/master/cmd/node/config/external.toml. + url = "localhost:22111" + # Possible values: json, gogo protobuf. Should be compatible with [HostDriverConfig].MarshallerType + marshaller_type = "json" + # This flag describes the mode to start the WebSocket connector. Can be "client" or "server" + mode = "client" + # Retry duration (receive/send data/acknowledge) in seconds + retry_duration = 5 + # This flag specifies if we should send an acknowledge signal upon recieving data + with_acknowledge = true + # Signals if in case of data payload processing error, we should send the ack signal or not. If you want to block + # incoming data in case of a local error, this should be set to true. + blocking_ack_on_error = false diff --git a/cmd/connector/flags.go b/cmd/connector/flags.go new file mode 100644 index 0000000..071c804 --- /dev/null +++ b/cmd/connector/flags.go @@ -0,0 +1,25 @@ +package main + +import ( + logger "github.com/multiversx/mx-chain-logger-go" + "github.com/urfave/cli" +) + +var ( + logLevel = cli.StringFlag{ + Name: "log-level", + Usage: "This flag specifies the logger `level(s)`. It can contain multiple comma-separated value. For example" + + ", if set to *:INFO the logs for all packages will have the INFO level. However, if set to *:INFO,api:DEBUG" + + " the logs for all packages will have the INFO level, excepting the api package which will receive a DEBUG" + + " log level.", + Value: "*:" + logger.LogDebug.String(), + } + logSaveFile = cli.BoolFlag{ + Name: "log-save", + Usage: "Boolean option for enabling log saving. If set, it will automatically save all the logs into a file.", + } + disableAnsiColor = cli.BoolFlag{ + Name: "disable-ansi-color", + Usage: "Boolean option for disabling ANSI colors in the logging system.", + } +) diff --git a/cmd/connector/main.go b/cmd/connector/main.go new file mode 100644 index 0000000..6b2268b --- /dev/null +++ b/cmd/connector/main.go @@ -0,0 +1,155 @@ +package main + +import ( + "fmt" + "os" + "os/signal" + "syscall" + "time" + + "github.com/multiversx/mx-chain-core-go/core" + "github.com/multiversx/mx-chain-core-go/core/closing" + logger "github.com/multiversx/mx-chain-logger-go" + "github.com/multiversx/mx-chain-logger-go/file" + "github.com/multiversx/mx-chain-ws-connector-template-go/config" + "github.com/multiversx/mx-chain-ws-connector-template-go/factory" + "github.com/urfave/cli" +) + +var log = logger.GetOrCreate("mx-chain-ws-connector-template-go") + +const ( + configPath = "config/config.toml" + + logsPath = "logs" + logFilePrefix = "sovereign-notifier" + logLifeSpanSec = 432000 // 5 days + logLifeSpanMb = 1024 // 1 GB +) + +func main() { + app := cli.NewApp() + app.Name = "MultiversX ws connector template" + app.Usage = "This tool will communicate with an observer/light client connected to mx-chain via " + + "websocket outport driver and listen to incoming exported data." + app.Flags = []cli.Flag{ + logLevel, + logSaveFile, + disableAnsiColor, + } + app.Authors = []cli.Author{ + { + Name: "The MultiversX Team", + Email: "contact@multiversx.com", + }, + } + + app.Action = startConnector + + err := app.Run(os.Args) + if err != nil { + log.Error(err.Error()) + os.Exit(1) + } +} + +func startConnector(ctx *cli.Context) error { + cfg, err := loadConfig(configPath) + if err != nil { + return err + } + + err = initializeLogger(ctx) + if err != nil { + return err + } + + var logFile closing.Closer + withLogFile := ctx.GlobalBool(logSaveFile.Name) + if withLogFile { + logFile, err = createLogger() + if err != nil { + return err + } + } + + wsClient, err := factory.CreateWSConnector(cfg.WebSocketConfig) + if err != nil { + return fmt.Errorf("cannot create sovereign notifier, error: %w", err) + } + + interrupt := make(chan os.Signal, 1) + signal.Notify(interrupt, syscall.SIGINT, syscall.SIGTERM) + + log.Info("starting ws client...") + + <-interrupt + log.Info("closing app at user's signal") + + err = wsClient.Close() + log.LogIfError(err) + + if withLogFile { + err = logFile.Close() + log.LogIfError(err) + } + return nil +} + +func loadConfig(filepath string) (config.Config, error) { + cfg := config.Config{} + err := core.LoadTomlFile(&cfg, filepath) + + log.Info("loaded config", "path", configPath) + + return cfg, err +} + +func initializeLogger(ctx *cli.Context) error { + logLevelFlagValue := ctx.GlobalString(logLevel.Name) + err := logger.SetLogLevel(logLevelFlagValue) + if err != nil { + return err + } + + disableAnsi := ctx.GlobalBool(disableAnsiColor.Name) + return removeANSIColorsForLoggerIfNeeded(disableAnsi) +} + +func removeANSIColorsForLoggerIfNeeded(disableAnsi bool) error { + if !disableAnsi { + return nil + } + + err := logger.RemoveLogObserver(os.Stdout) + if err != nil { + return err + } + + return logger.AddLogObserver(os.Stdout, &logger.PlainFormatter{}) +} + +func createLogger() (closing.Closer, error) { + workingDir, err := os.Getwd() + if err != nil { + log.Error("error getting working directory when trying to create logger file", "error", err) + workingDir = "" + } + + argsLogger := file.ArgsFileLogging{ + WorkingDir: workingDir, + DefaultLogsPath: logsPath, + LogFilePrefix: logFilePrefix, + } + fileLogging, err := file.NewFileLogging(argsLogger) + if err != nil { + return nil, fmt.Errorf("%w creating log file", err) + } + + err = fileLogging.ChangeFileLifeSpan(time.Second*time.Duration(logLifeSpanSec), logLifeSpanMb) + if err != nil { + return nil, err + } + + return fileLogging, nil +} diff --git a/cmd/demo/README.md b/cmd/demo/README.md new file mode 100644 index 0000000..2bddeb8 --- /dev/null +++ b/cmd/demo/README.md @@ -0,0 +1,62 @@ +## About + +This folder contains system test demo for the ws connector, which is going to receive exported data from a local testnet + +### How it works + +These scripts provide a demo to help you configure and test your ws connector/driver to receive data from a local +testnet. The scripts found in this `demo` folder: + +- `local-testnet.sh` creates a local testnet with one shard (0) + metachain. Each shard has 2 nodes (1 validator + 1 + observer) +- `observer-outport.sh` creates an observer in a specified shard (shard/metachain). This node acts an outport driver for + the ws connector. When started, it will sync from genesis and export data (blocks, validators info, etc.) to your ws + driver connector. + +Inside `cmd/connector` folder, there is a `main.go` file which represents the ws connector (data receiver). + +> **TIP**: Once you have experimented with this local setup, you might want to test the driver with exported data from +> an observing squad (mainnet/devnet/testnet). [Here](https://github.com/multiversx/mx-chain-observing-squad) you can +> find how to run your own observing squad. In order to enable nodes to export data, one needs to set +> **[HostDriverConfig].Enabled = true** +> [from this config file](https://github.com/multiversx/mx-chain-go/blob/master/cmd/node/config/external.toml) + +## How to use + +1. Create and start a local testnet: + +```bash +cd cmd/demo +bash ./local-testnet.sh new +bash ./local-testnet.sh start +``` + +2. Start the exporter node in your desired shard (metachain/shard): + +```bash +bash ./observer-outport.sh shard +``` + +3. Inside `cmd/connector`, start your driver to receive exported data: + +```bash +go build +./connector +``` + +Once the setup is ready, the connected driver will start receiving data from the observer. One can see a similar log +info: + +``` +INFO [2023-05-24 13:53:49.234] received payload topic = SaveBlock hash = de0d84d2e88f83916cfa955121938c952ceab657cd49852cac51f7f5c7c0091a +INFO [2023-05-24 13:53:49.234] received payload topic = SaveRoundsInfo +INFO [2023-05-24 13:53:49.240] received payload topic = FinalizedBlock + +``` + +After you finished testing, you can close the observer node and ws connector (can use CTRL+C) as well as the local +testnet, by executing: + +```bash +bash ./local-testnet.sh stop +``` \ No newline at end of file diff --git a/cmd/demo/local-testnet.sh b/cmd/demo/local-testnet.sh new file mode 100644 index 0000000..1b724d7 --- /dev/null +++ b/cmd/demo/local-testnet.sh @@ -0,0 +1,119 @@ +CURRENT_DIR=$(pwd) +WORKING_DIR="$CURRENT_DIR" +TESTNET_DIR=$WORKING_DIR/testnet +TESTNET_OUTPUT_DIR=$TESTNET_DIR/testnet-local +SCRIPTS_DIR=mx-chain-go/scripts/testnet +VARIABLES_PATH=$SCRIPTS_DIR/variables.sh +OBSERVERS_PATH=$SCRIPTS_DIR/include/observers.sh +VALIDATORS_PATH=$SCRIPTS_DIR/include/validators.sh +ENABLE_EPOCH_DIR=$TESTNET_DIR/mx-chain-go/cmd/node/config/enableEpochs.toml +SANDBOX_NAME=sandbox + +cloneDependencies(){ + if [ -d "$TESTNET_DIR" ]; then + rm -rf $TESTNET_DIR + fi + + mkdir "$TESTNET_DIR" + + git clone https://github.com/multiversx/mx-chain-go "$TESTNET_DIR/mx-chain-go" + checkoutStableVersion mx-chain-go cc39c2460f69e9db3e7970519f8474c8abbc294f + + git clone https://github.com/multiversx/mx-chain-deploy-go "$TESTNET_DIR/mx-chain-deploy-go" + + git clone https://github.com/multiversx/mx-chain-proxy-go "$TESTNET_DIR/mx-chain-proxy-go" + checkoutStableVersion mx-chain-proxy-go rc/v1.6.0 +} + +checkoutStableVersion(){ + cd $TESTNET_DIR/$1 + git checkout $2 + cd ../.. +} + +testnetRemove(){ + rm -rf "$TESTNET_OUTPUT_DIR" +} + +testnetSetup(){ + sed -i 's/BuiltInFunctionsEnableEpoch =.*/BuiltInFunctionsEnableEpoch = 0/' "$ENABLE_EPOCH_DIR" + + mkdir "$TESTNET_OUTPUT_DIR" + cd "$TESTNET_OUTPUT_DIR" + ln -s "$TESTNET_DIR"/mx-chain-go mx-chain-go + ln -s "$TESTNET_DIR"/mx-chain-deploy-go mx-chain-deploy-go + ln -s "$TESTNET_DIR"/mx-chain-proxy-go mx-chain-proxy-go +} + +testnetPrereq(){ + cd "$TESTNET_OUTPUT_DIR" && \ + bash $SCRIPTS_DIR/prerequisites.sh && \ + echo -e "export TESTNETDIR=$TESTNET_OUTPUT_DIR/$SANDBOX_NAME" > $SCRIPTS_DIR/local.sh && \ + bash $SCRIPTS_DIR/config.sh +} + +testnetUpdateVariables(){ + sed -i 's/export SHARDCOUNT=.*/export SHARDCOUNT=1/' $VARIABLES_PATH + sed -i 's/SHARD_VALIDATORCOUNT=.*/SHARD_VALIDATORCOUNT=1/' $VARIABLES_PATH + sed -i 's/SHARD_OBSERVERCOUNT=.*/SHARD_OBSERVERCOUNT=1/' $VARIABLES_PATH + sed -i 's/SHARD_CONSENSUS_SIZE=.*/SHARD_CONSENSUS_SIZE=$SHARD_VALIDATORCOUNT/' $VARIABLES_PATH + sed -i 's/META_VALIDATORCOUNT=.*/META_VALIDATORCOUNT=1/' $VARIABLES_PATH + sed -i 's/META_OBSERVERCOUNT=.*/META_OBSERVERCOUNT=1/' $VARIABLES_PATH + sed -i 's/META_CONSENSUS_SIZE=.*/META_CONSENSUS_SIZE=$META_VALIDATORCOUNT/' $VARIABLES_PATH + sed -i 's/export NODE_DELAY=.*/export NODE_DELAY=30/' $VARIABLES_PATH + + sed -i 's/EXTRA_OBSERVERS_FLAGS.*/EXTRA_OBSERVERS_FLAGS --operation-mode db-lookup-extension"/' $OBSERVERS_PATH + sed -i 's/config_validator.toml/config_validator.toml --operation-mode db-lookup-extension/' $VALIDATORS_PATH +} + +testnetNew(){ + cloneDependencies + testnetRemove + testnetSetup + testnetUpdateVariables + testnetPrereq +} + +testnetStart(){ + cd "$TESTNET_DIR" && \ + ./mx-chain-go/scripts/testnet/start.sh +} + +testnetReset(){ + cd "$TESTNET_DIR" && \ + ./mx-chain-go/scripts/testnet/reset.sh +} + +testnetStop(){ + cd "$TESTNET_DIR" && \ + ./mx-chain-go/scripts/testnet/stop.sh +} + +echoOptions(){ + echo "ERROR!!! Please choose one of the following parameters: + - new to create a new testnet + - start to start the testnet + - reset to reset the testnet + - stop to stop the testnet" +} + +main(){ + if [ $# -eq 1 ]; then + case "$1" in + new) + testnetNew ;; + start) + testnetStart ;; + reset) + testnetReset ;; + stop) + testnetStop ;; + *) + echoOptions ;; + esac + else + echoOptions + fi +} + +main "$@" diff --git a/cmd/demo/observer-outport.sh b/cmd/demo/observer-outport.sh new file mode 100644 index 0000000..e27cb5f --- /dev/null +++ b/cmd/demo/observer-outport.sh @@ -0,0 +1,71 @@ +#!/usr/bin/env bash + +# Possible values: "server"/"client" +OBSERVER_MODE="server" + +CURRENT_DIR=$(pwd) +SANDBOX_PATH=$CURRENT_DIR/testnet/testnet-local/sandbox +KEY_GENERATOR_PATH=$CURRENT_DIR/testnet/mx-chain-go/cmd/keygenerator +EXTERNAL_CONFIG_DIR=$CURRENT_DIR/exporter/config/external.toml + +createObserverKey(){ + pushd $CURRENT_DIR + + cd testnet/mx-chain-go/cmd/keygenerator + go build + ./keygenerator + + popd +} + +resetWorkingDir(){ + rm -rf exporter + mkdir "exporter/" + cd "exporter/" + mkdir "config/" +} + +setupObserver(){ + OBSERVER_PATH=$(pwd) + cp $SANDBOX_PATH/node/node $OBSERVER_PATH + cp -R $SANDBOX_PATH/node/config $OBSERVER_PATH + mv config/config_observer.toml config/config.toml + mv $KEY_GENERATOR_PATH/validatorKey.pem config/ + + sed -i "s@DestinationShardAsObserver =.*@DestinationShardAsObserver = \"$1\"@" $OBSERVER_PATH/config/prefs.toml + sed -i '/HostDriverConfig\]/!b;n;n;c\ Enabled = true' "$EXTERNAL_CONFIG_DIR" + sed -i "s@Mode =.*@Mode = \"$OBSERVER_MODE\"@" "$EXTERNAL_CONFIG_DIR" + sed -i 's/MarshallerType =.*/MarshallerType = "json"/' "$EXTERNAL_CONFIG_DIR" + sed -i 's/BlockingAckOnError =.*/BlockingAckOnError = false/' "$EXTERNAL_CONFIG_DIR" + + ./node --log-level *:INFO --rest-api-interface :10044 +} + + +setup(){ + createObserverKey + resetWorkingDir + setupObserver $1 +} + +echoOptions(){ + echo "This script will start an observer node in the provided shard (metachain/shard). + The only acceptable parameters, for the current test configuration, are shard (will use shard 0) and metachain." +} + +main(){ + if [ $# -eq 1 ]; then + case "$1" in + metachain) + setup metachain;; + shard) + setup 0;; + *) + echoOptions;; + esac + else + echoOptions + fi +} + +main "$@" diff --git a/config/config.go b/config/config.go new file mode 100644 index 0000000..dd7ee03 --- /dev/null +++ b/config/config.go @@ -0,0 +1,16 @@ +package config + +// Config holds general configuration +type Config struct { + WebSocketConfig WebSocketConfig `toml:"web_socket"` +} + +// WebSocketConfig holds web sockets config +type WebSocketConfig struct { + Url string `toml:"url"` + MarshallerType string `toml:"marshaller_type"` + Mode string `toml:"mode"` + RetryDuration uint32 `toml:"retry_duration"` + WithAcknowledge bool `toml:"with_acknowledge"` + BlockingAckOnError bool `toml:"blocking_ack_on_error"` +} diff --git a/factory/wsConnectorFactory.go b/factory/wsConnectorFactory.go new file mode 100644 index 0000000..a00f5fe --- /dev/null +++ b/factory/wsConnectorFactory.go @@ -0,0 +1,54 @@ +package factory + +import ( + "github.com/multiversx/mx-chain-communication-go/websocket/data" + factoryHost "github.com/multiversx/mx-chain-communication-go/websocket/factory" + "github.com/multiversx/mx-chain-core-go/marshal" + "github.com/multiversx/mx-chain-core-go/marshal/factory" + logger "github.com/multiversx/mx-chain-logger-go" + "github.com/multiversx/mx-chain-ws-connector-template-go/config" + "github.com/multiversx/mx-chain-ws-connector-template-go/process" +) + +var log = logger.GetOrCreate("ws-connector") + +// CreateWSConnector will create a ws connector able to receive and process incoming data +// from a multiversx node +func CreateWSConnector(cfg config.WebSocketConfig) (process.WSConnector, error) { + marshaller, err := factory.NewMarshalizer(cfg.MarshallerType) + if err != nil { + return nil, err + } + + dataProcessor, err := process.NewLogDataProcessor(marshaller, log) + if err != nil { + return nil, err + } + + wsHost, err := createWsHost(marshaller, cfg) + if err != nil { + return nil, err + } + + err = wsHost.SetPayloadHandler(dataProcessor) + if err != nil { + return nil, err + } + + return wsHost, nil +} + +func createWsHost(wsMarshaller marshal.Marshalizer, cfg config.WebSocketConfig) (factoryHost.FullDuplexHost, error) { + return factoryHost.CreateWebSocketHost(factoryHost.ArgsWebSocketHost{ + WebSocketConfig: data.WebSocketConfig{ + URL: cfg.Url, + WithAcknowledge: cfg.WithAcknowledge, + Mode: cfg.Mode, + RetryDurationInSec: int(cfg.RetryDuration), + BlockingAckOnError: cfg.BlockingAckOnError, + DropMessagesIfNoConnection: false, + }, + Marshaller: wsMarshaller, + Log: log, + }) +} diff --git a/factory/wsConnectorFactory_test.go b/factory/wsConnectorFactory_test.go new file mode 100644 index 0000000..90e3e47 --- /dev/null +++ b/factory/wsConnectorFactory_test.go @@ -0,0 +1,55 @@ +package factory + +import ( + "testing" + + "github.com/multiversx/mx-chain-communication-go/websocket/data" + "github.com/multiversx/mx-chain-ws-connector-template-go/config" + "github.com/stretchr/testify/require" +) + +func createConfig() config.WebSocketConfig { + return config.WebSocketConfig{ + Url: "localhost", + MarshallerType: "json", + RetryDuration: 1, + WithAcknowledge: false, + BlockingAckOnError: false, + Mode: data.ModeClient, + } +} + +func TestCreateWSConnector(t *testing.T) { + t.Parallel() + + t.Run("invalid marshaller, should return error", func(t *testing.T) { + t.Parallel() + + cfg := createConfig() + cfg.MarshallerType = "invalid" + ws, err := CreateWSConnector(cfg) + require.NotNil(t, err) + require.Nil(t, ws) + }) + + t.Run("cannot create ws host, should return error", func(t *testing.T) { + t.Parallel() + + cfg := createConfig() + cfg.RetryDuration = 0 + ws, err := CreateWSConnector(cfg) + require.NotNil(t, err) + require.Nil(t, ws) + }) + + t.Run("should work", func(t *testing.T) { + t.Parallel() + + cfg := createConfig() + ws, err := CreateWSConnector(cfg) + require.Nil(t, err) + require.NotNil(t, ws) + + _ = ws.Close() + }) +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..d56f4de --- /dev/null +++ b/go.mod @@ -0,0 +1,28 @@ +module github.com/multiversx/mx-chain-ws-connector-template-go + +go 1.17 + +require ( + github.com/multiversx/mx-chain-communication-go v1.0.1 + github.com/multiversx/mx-chain-core-go v1.2.4 + github.com/multiversx/mx-chain-logger-go v1.0.11 + github.com/stretchr/testify v1.8.2 + github.com/urfave/cli v1.22.13 +) + +require ( + github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/denisbrodbeck/machineid v1.0.1 // indirect + github.com/gogo/protobuf v1.3.2 // indirect + github.com/golang/protobuf v1.5.2 // indirect + github.com/gorilla/mux v1.8.0 // indirect + github.com/gorilla/websocket v1.4.2 // indirect + github.com/mr-tron/base58 v1.2.0 // indirect + github.com/pelletier/go-toml v1.9.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/russross/blackfriday/v2 v2.1.0 // indirect + golang.org/x/sys v0.2.0 // indirect + google.golang.org/protobuf v1.26.0 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..737ec91 --- /dev/null +++ b/go.sum @@ -0,0 +1,184 @@ +github.com/BurntSushi/toml v1.2.1/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ= +github.com/aead/siphash v1.0.1/go.mod h1:Nywa3cDsYNNK3gaciGTWPwHt0wlpNV15vwmswBAUSII= +github.com/btcsuite/btcd v0.20.1-beta/go.mod h1:wVuoA8VJLEcwgqHBwHmzLRazpKxTv13Px/pDuV7OomQ= +github.com/btcsuite/btcd v0.22.0-beta.0.20220111032746-97732e52810c/go.mod h1:tjmYdS6MLJ5/s0Fj4DbLgSbDHbEqLJrtnHecBFkdz5M= +github.com/btcsuite/btcd v0.23.0/go.mod h1:0QJIIN1wwIXF/3G/m87gIwGniDMDQqjVn4SZgnFpsYY= +github.com/btcsuite/btcd/btcec/v2 v2.1.0/go.mod h1:2VzYrv4Gm4apmbVVsSq5bqf1Ec8v56E48Vt0Y/umPgA= +github.com/btcsuite/btcd/btcec/v2 v2.1.3/go.mod h1:ctjw4H1kknNJmRN4iP1R7bTQ+v3GJkZBd6mui8ZsAZE= +github.com/btcsuite/btcd/btcutil v1.0.0/go.mod h1:Uoxwv0pqYWhD//tfTiipkxNfdhG9UrLwaeswfjfdF0A= +github.com/btcsuite/btcd/btcutil v1.1.0/go.mod h1:5OapHB7A2hBBWLm48mmw4MOHNJCcUBTwmWH/0Jn8VHE= +github.com/btcsuite/btcd/btcutil v1.1.3/go.mod h1:UR7dsSJzJUfMmFiiLlIrMq1lS9jh9EdCV7FStZSnpi0= +github.com/btcsuite/btcd/chaincfg/chainhash v1.0.0/go.mod h1:7SFka0XMvUgj3hfZtydOrQY2mwhPclbT2snogU7SQQc= +github.com/btcsuite/btcd/chaincfg/chainhash v1.0.1/go.mod h1:7SFka0XMvUgj3hfZtydOrQY2mwhPclbT2snogU7SQQc= +github.com/btcsuite/btclog v0.0.0-20170628155309-84c8d2346e9f/go.mod h1:TdznJufoqS23FtqVCzL0ZqgP5MqXbb4fg/WgDys70nA= +github.com/btcsuite/btcutil v0.0.0-20190425235716-9e5f4b9a998d/go.mod h1:+5NJ2+qvTyV9exUAL/rxXi3DcLg2Ts+ymUAY5y4NvMg= +github.com/btcsuite/go-socks v0.0.0-20170105172521-4720035b7bfd/go.mod h1:HHNXQzUsZCxOoE+CPiyCTO6x34Zs86zZUiwtpXoGdtg= +github.com/btcsuite/goleveldb v0.0.0-20160330041536-7834afc9e8cd/go.mod h1:F+uVaaLLH7j4eDXPRvw78tMflu7Ie2bzYOH4Y8rRKBY= +github.com/btcsuite/goleveldb v1.0.0/go.mod h1:QiK9vBlgftBg6rWQIj6wFzbPfRjiykIEhBH4obrXJ/I= +github.com/btcsuite/snappy-go v0.0.0-20151229074030-0bdef8d06723/go.mod h1:8woku9dyThutzjeg+3xrA5iCpBRH8XEEg3lh6TiUghc= +github.com/btcsuite/snappy-go v1.0.0/go.mod h1:8woku9dyThutzjeg+3xrA5iCpBRH8XEEg3lh6TiUghc= +github.com/btcsuite/websocket v0.0.0-20150119174127-31079b680792/go.mod h1:ghJtEyQwv5/p4Mg4C0fgbePVuGr935/5ddU9Z3TmDRY= +github.com/btcsuite/winsvc v1.0.0/go.mod h1:jsenWakMcC0zFBFurPLEAyrnc/teJEM1O46fmI40EZs= +github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHHBfMQ6w= +github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= +github.com/davecgh/go-spew v0.0.0-20171005155431-ecdeabc65495/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/decred/dcrd/crypto/blake256 v1.0.0/go.mod h1:sQl2p6Y26YV+ZOcSTP6thNdn47hh8kt6rqSlvmrXFAc= +github.com/decred/dcrd/dcrec/secp256k1/v4 v4.0.1/go.mod h1:hyedUtir6IdtD/7lIxGeCxkaw7y45JueMRL4DIyJDKs= +github.com/decred/dcrd/lru v1.0.0/go.mod h1:mxKOwFd7lFjN2GZYsiz/ecgqR6kkYAl+0pz0tEMk218= +github.com/denisbrodbeck/machineid v1.0.1 h1:geKr9qtkB876mXguW2X6TU4ZynleN6ezuMSRhl4D7AQ= +github.com/denisbrodbeck/machineid v1.0.1/go.mod h1:dJUwb7PTidGDeYyUBmXZ2GphQBbjJCrnectwCyxcUSI= +github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo= +github.com/fsnotify/fsnotify v1.4.9/go.mod h1:znqG4EE+3YCdAaPaxE2ZRY/06pZUdp0tY4IgpuI1SZQ= +github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q= +github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q= +github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.4.0-rc.1/go.mod h1:ceaxUfeHdC40wWswd/P6IGgMaK3YpKi5j83Wpe3EHw8= +github.com/golang/protobuf v1.4.0-rc.1.0.20200221234624-67d41d38c208/go.mod h1:xKAWHe0F5eneWXFV3EuXVDTCmh+JuBKY0li0aMyXATA= +github.com/golang/protobuf v1.4.0-rc.2/go.mod h1:LlEzMj4AhA7rCAGe4KMBDvJI+AwstrUpVNzEA03Pprs= +github.com/golang/protobuf v1.4.0-rc.4.0.20200313231945-b860323f09d0/go.mod h1:WU3c8KckQ9AFe+yFwt9sWVRKCVIyN9cPHBJSNnbL67w= +github.com/golang/protobuf v1.4.0/go.mod h1:jodUvKwWbYaEsadDk5Fwe5c77LiNKVO9IDvqG2KuDX0= +github.com/golang/protobuf v1.4.2/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI= +github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk= +github.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw= +github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY= +github.com/golang/snappy v0.0.4/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= +github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= +github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= +github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU= +github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI= +github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So= +github.com/gorilla/websocket v1.4.2 h1:+/TMaTYc4QFitKJxsQ7Yye35DkWvkdLcvGKqM+x0Ufc= +github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= +github.com/hashicorp/golang-lru v0.5.4/go.mod h1:iADmTwqILo4mZ8BN3D2Q6+9jd8WM5uGBxy+E8yxSoD4= +github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU= +github.com/jessevdk/go-flags v0.0.0-20141203071132-1679536dcc89/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI= +github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI= +github.com/jrick/logrotate v1.0.0/go.mod h1:LNinyqDIJnpAur+b8yyulnQw/wDuN1+BYKlTRt3OuAQ= +github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI2bnpBCr8= +github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck= +github.com/kkdai/bstream v0.0.0-20161212061736-f391b8402d23/go.mod h1:J+Gs4SYgM6CZQHDETBtE9HaSEkGmuNXF86RwHhHUvq4= +github.com/mr-tron/base58 v1.2.0 h1:T/HDJBh4ZCPbU39/+c3rRvE0uKBQlU27+QI8LJ4t64o= +github.com/mr-tron/base58 v1.2.0/go.mod h1:BinMc/sQntlIE1frQmRFPUoPA1Zkr8VRgBdjWI2mNwc= +github.com/multiversx/mx-chain-communication-go v1.0.1 h1:L1be7djQCJIuWEndkPW9F1/+X9tGarpHs6mZuJ1LVdo= +github.com/multiversx/mx-chain-communication-go v1.0.1/go.mod h1:GPHOm4HSXbvC0IotMziWXQmhtsUe69ScBPYsb+mF9bk= +github.com/multiversx/mx-chain-core-go v1.1.30/go.mod h1:8gGEQv6BWuuJwhd25qqhCOZbBSv9mk+hLeKvinSaSMk= +github.com/multiversx/mx-chain-core-go v1.2.1-0.20230510143029-ab37792342df/go.mod h1:jzYFSiYBuO0dGpGFXnZWSwcwcKP7Flyn/X41y4zIQrQ= +github.com/multiversx/mx-chain-core-go v1.2.4 h1:BRXyajUevLU6zHszR8jnp2+7C2bAQBor51YTc4dp3YQ= +github.com/multiversx/mx-chain-core-go v1.2.4/go.mod h1:jzYFSiYBuO0dGpGFXnZWSwcwcKP7Flyn/X41y4zIQrQ= +github.com/multiversx/mx-chain-logger-go v1.0.11 h1:DFsHa+sc5fKwhDR50I8uBM99RTDTEW68ESyr5ALRDwE= +github.com/multiversx/mx-chain-logger-go v1.0.11/go.mod h1:1srDkP0DQucWQ+rYfaq0BX2qLnULsUdRPADpYUTM6dA= +github.com/nxadm/tail v1.4.4/go.mod h1:kenIhsEOeOJmVchQTgglprH7qJGnHDVpk1VPCcaMI8A= +github.com/onsi/ginkgo v1.6.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= +github.com/onsi/ginkgo v1.7.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= +github.com/onsi/ginkgo v1.12.1/go.mod h1:zj2OWP4+oCPe1qIXoGWkgMRwljMUYCdkwsT2108oapk= +github.com/onsi/ginkgo v1.14.0/go.mod h1:iSB4RoI2tjJc9BBv4NKIKWKya62Rps+oPG/Lv9klQyY= +github.com/onsi/gomega v1.4.1/go.mod h1:C1qb7wdrVGGVU+Z6iS04AVkA3Q65CEZX59MT0QO5uiA= +github.com/onsi/gomega v1.4.3/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1CpauHY= +github.com/onsi/gomega v1.7.1/go.mod h1:XdKZgCCFLUoM/7CFJVPcG8C1xQ1AJ0vpAezJrB7JYyY= +github.com/onsi/gomega v1.10.1/go.mod h1:iN09h71vgCQne3DLsj+A5owkum+a2tYe+TOCB1ybHNo= +github.com/pelletier/go-toml v1.9.3 h1:zeC5b1GviRUyKYd6OJPvBU/mcVDVoL1OhT17FCt5dSQ= +github.com/pelletier/go-toml v1.9.3/go.mod h1:u1nR/EPcESfeI/szUZKdtJ0xRNbUoANCkoOuaOx1Y+c= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk= +github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= +github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= +github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= +github.com/stretchr/testify v1.8.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8= +github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= +github.com/syndtr/goleveldb v1.0.1-0.20210819022825-2ae1ddf74ef7/go.mod h1:q4W45IWZaF22tdD+VEXcAWRA037jwmWEB5VWYORlTpc= +github.com/urfave/cli v1.22.13 h1:wsLILXG8qCJNse/qAgLNf23737Cx05GflHg/PJGe1Ok= +github.com/urfave/cli v1.22.13/go.mod h1:VufqObjsMTF2BBwKawpx9R8eAneNEWhoO0yx8Vd+FkE= +github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= +github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= +github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= +golang.org/x/crypto v0.0.0-20170930174604-9419663f5a44/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/crypto v0.3.0 h1:a06MkbcxBrEFc0w0QIZWXrH/9cCX6KJyWbBOIwAn+7A= +golang.org/x/crypto v0.3.0/go.mod h1:hebNnKkNXi2UzZN1eVRvBB7co0a+JxK6XbPiWVs/3J4= +golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= +golang.org/x/net v0.0.0-20180719180050-a680a1efc54d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20180906233101-161cd47e91fd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20200520004742-59133d7f0dd7/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A= +golang.org/x/net v0.0.0-20200813134508-3edf25e44fcc/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA= +golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU= +golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= +golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= +golang.org/x/net v0.2.0/go.mod h1:KqCZLdyyvdV855qA2rE3GC2aiw5xGR5TEjj8smXukLY= +golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190904154756-749cb33beabd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191005200804-aed5e4c7ecf9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191120155948-bd437916bb0e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200519105757-fe76b779f299/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200814200057-3d37ad5750ed/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.2.0 h1:ljd4t30dBnAvMZaQCevtY0xLLD0A+bRZXbgLMLU1F/A= +golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/term v0.2.0/go.mod h1:TVmDHMZPmdnySmBfhjOoOdhjzdE1h4u1VwSiw2l1Nuc= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= +golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= +golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= +golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE= +golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8= +google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0= +google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQJ+fmap5saPgwCLgHXTUD7jkjRqWcaiX5VyM= +google.golang.org/protobuf v1.20.1-0.20200309200217-e05f789c0967/go.mod h1:A+miEFZTKqfCUM6K7xSMQL9OKL/b6hQv+e19PK+JZNE= +google.golang.org/protobuf v1.21.0/go.mod h1:47Nbq4nVaFHyn7ilMalzfO3qCViNmqZ2kzikPIcrTAo= +google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU= +google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw= +google.golang.org/protobuf v1.26.0 h1:bxAC2xTBsZGibn2RTntX0oH50xLsqy1OxA9tTL3p/lk= +google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys= +gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWDmTeBkI65Dw0HsyUHuEVlX15mw= +gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/process/errors.go b/process/errors.go new file mode 100644 index 0000000..f7494b0 --- /dev/null +++ b/process/errors.go @@ -0,0 +1,11 @@ +package process + +import "errors" + +var errInvalidOperationType = errors.New("invalid/unknown operation type") + +var errNilMarshaller = errors.New("nil marshaller provided") + +var errNilLogger = errors.New("nil logger provided") + +var errNilOutportBlockData = errors.New("nil outport block data") diff --git a/process/interface.go b/process/interface.go new file mode 100644 index 0000000..a89205a --- /dev/null +++ b/process/interface.go @@ -0,0 +1,19 @@ +package process + +// WSConnector defines a ws connector that receives incoming data and can be closed +type WSConnector interface { + Close() error +} + +// DataProcessor defines a payload processor for incoming ws data +type DataProcessor interface { + ProcessPayload(payload []byte, topic string) error + Close() error + IsInterfaceNil() bool +} + +// Logger defines the behavior of a data logger component +type Logger interface { + Info(message string, args ...interface{}) + IsInterfaceNil() bool +} diff --git a/process/logDataProcessor.go b/process/logDataProcessor.go new file mode 100644 index 0000000..264eb38 --- /dev/null +++ b/process/logDataProcessor.go @@ -0,0 +1,152 @@ +package process + +import ( + "fmt" + + "github.com/multiversx/mx-chain-core-go/core/check" + "github.com/multiversx/mx-chain-core-go/data/outport" + "github.com/multiversx/mx-chain-core-go/marshal" +) + +type logDataProcessor struct { + marshaller marshal.Marshalizer + logger Logger + operationHandlers map[string]func(marshalledData []byte) error +} + +// NewLogDataProcessor creates a data processor able to receive data from a ws outport driver and log events +func NewLogDataProcessor(marshaller marshal.Marshalizer, logger Logger) (DataProcessor, error) { + if check.IfNil(marshaller) { + return nil, errNilMarshaller + } + if check.IfNil(logger) { + return nil, errNilLogger + } + + dp := &logDataProcessor{ + marshaller: marshaller, + logger: logger, + } + + dp.operationHandlers = map[string]func(marshalledData []byte) error{ + outport.TopicSaveBlock: dp.saveBlock, + outport.TopicRevertIndexedBlock: dp.revertIndexedBlock, + outport.TopicSaveRoundsInfo: dp.saveRounds, + outport.TopicSaveValidatorsRating: dp.saveValidatorsRating, + outport.TopicSaveValidatorsPubKeys: dp.saveValidatorsPubKeys, + outport.TopicSaveAccounts: dp.saveAccounts, + outport.TopicFinalizedBlock: dp.finalizedBlock, + } + + return dp, nil +} + +// ProcessPayload will process the received payload, if the topic is known. +func (dp *logDataProcessor) ProcessPayload(payload []byte, topic string) error { + operationHandler, found := dp.operationHandlers[topic] + if !found { + return fmt.Errorf("%w, operation type for topic = %s, received data = %s", + errInvalidOperationType, topic, string(payload)) + } + + return operationHandler(payload) +} + +func (dp *logDataProcessor) saveBlock(marshalledData []byte) error { + outportBlock := &outport.OutportBlock{} + err := dp.marshaller.Unmarshal(outportBlock, marshalledData) + if err != nil { + return err + } + + if outportBlock.BlockData == nil { + return errNilOutportBlockData + } + + dp.logger.Info("received payload", "topic", outport.TopicSaveBlock, "hash", outportBlock.BlockData.HeaderHash) + + return nil +} + +func (dp *logDataProcessor) revertIndexedBlock(marshalledData []byte) error { + blockData := &outport.BlockData{} + err := dp.marshaller.Unmarshal(blockData, marshalledData) + if err != nil { + return err + } + + dp.logger.Info("received payload", "topic", outport.TopicRevertIndexedBlock) + + return nil +} + +func (dp *logDataProcessor) saveRounds(marshalledData []byte) error { + roundsInfo := &outport.RoundsInfo{} + err := dp.marshaller.Unmarshal(roundsInfo, marshalledData) + if err != nil { + return err + } + + dp.logger.Info("received payload", "topic", outport.TopicSaveRoundsInfo) + + return nil +} + +func (dp *logDataProcessor) saveValidatorsRating(marshalledData []byte) error { + ratingData := &outport.ValidatorsRating{} + err := dp.marshaller.Unmarshal(ratingData, marshalledData) + if err != nil { + return err + } + + dp.logger.Info("received payload", "topic", outport.TopicSaveValidatorsRating) + + return nil +} + +func (dp *logDataProcessor) saveValidatorsPubKeys(marshalledData []byte) error { + validatorsPubKeys := &outport.ValidatorsPubKeys{} + err := dp.marshaller.Unmarshal(validatorsPubKeys, marshalledData) + if err != nil { + return err + } + + dp.logger.Info("received payload", "topic", outport.TopicSaveValidatorsPubKeys) + + return nil +} + +func (dp *logDataProcessor) saveAccounts(marshalledData []byte) error { + accounts := &outport.Accounts{} + err := dp.marshaller.Unmarshal(accounts, marshalledData) + if err != nil { + return err + } + + dp.logger.Info("received payload", "topic", outport.TopicSaveAccounts) + + return nil +} + +func (dp *logDataProcessor) finalizedBlock(marshalledData []byte) error { + finalizedBlock := &outport.FinalizedBlock{} + err := dp.marshaller.Unmarshal(finalizedBlock, marshalledData) + if err != nil { + return err + } + + dp.logger.Info("received payload", "topic", outport.TopicFinalizedBlock) + + return nil +} + +// Close will signal via a log that the data processor is closed +func (dp *logDataProcessor) Close() error { + dp.logger.Info("data processor closed") + return nil +} + +// IsInterfaceNil checks if the underlying pointer is nil +func (dp *logDataProcessor) IsInterfaceNil() bool { + return dp == nil +} diff --git a/process/logDataProcessor_test.go b/process/logDataProcessor_test.go new file mode 100644 index 0000000..63de2b2 --- /dev/null +++ b/process/logDataProcessor_test.go @@ -0,0 +1,249 @@ +package process + +import ( + "strings" + "testing" + + "github.com/multiversx/mx-chain-core-go/core/check" + "github.com/multiversx/mx-chain-core-go/data/outport" + "github.com/multiversx/mx-chain-ws-connector-template-go/testscommon" + "github.com/stretchr/testify/require" +) + +func TestNewLogDataProcessor(t *testing.T) { + t.Parallel() + + t.Run("nil marshaller, should return error", func(t *testing.T) { + dp, err := NewLogDataProcessor(nil, &testscommon.LoggerStub{}) + require.True(t, check.IfNil(dp)) + require.Equal(t, errNilMarshaller, err) + }) + + t.Run("nil logger, should return error", func(t *testing.T) { + dp, err := NewLogDataProcessor(&testscommon.MarshallerMock{}, nil) + require.True(t, check.IfNil(dp)) + require.Equal(t, errNilLogger, err) + }) + + t.Run("should work", func(t *testing.T) { + dp, err := NewLogDataProcessor(&testscommon.MarshallerMock{}, &testscommon.LoggerStub{}) + require.False(t, check.IfNil(dp)) + require.Nil(t, err) + + err = dp.Close() + require.Nil(t, err) + }) +} + +func TestLogDataProcessor_ProcessPayload(t *testing.T) { + t.Parallel() + + marshaller := &testscommon.MarshallerMock{} + + t.Run("invalid topic, should return error", func(t *testing.T) { + t.Parallel() + + dp, _ := NewLogDataProcessor(marshaller, &testscommon.LoggerStub{}) + err := dp.ProcessPayload([]byte("payload"), "invalid topic") + require.True(t, strings.Contains(err.Error(), errInvalidOperationType.Error())) + require.True(t, strings.Contains(err.Error(), "payload")) + require.True(t, strings.Contains(err.Error(), "invalid topic")) + }) + + t.Run("save block", func(t *testing.T) { + t.Parallel() + + logInfoCalledCt := 0 + logger := &testscommon.LoggerStub{ + InfoCalled: func(message string, args ...interface{}) { + require.Equal(t, "received payload", message) + require.Len(t, args, 1) + require.Equal(t, []interface{}{"topic", outport.TopicSaveBlock, "hash", []byte("hash")}, args[0]) + logInfoCalledCt++ + }, + } + dp, _ := NewLogDataProcessor(marshaller, logger) + + err := dp.ProcessPayload([]byte("payload"), outport.TopicSaveBlock) + require.NotNil(t, err) + require.Equal(t, 0, logInfoCalledCt) + + outportBlock := &outport.OutportBlock{} + outportBlockBytes, err := marshaller.Marshal(outportBlock) + require.Nil(t, err) + + err = dp.ProcessPayload(outportBlockBytes, outport.TopicSaveBlock) + require.Equal(t, errNilOutportBlockData, err) + require.Equal(t, 0, logInfoCalledCt) + + outportBlock.BlockData = &outport.BlockData{HeaderHash: []byte("hash")} + outportBlockBytes, err = marshaller.Marshal(outportBlock) + require.Nil(t, err) + + err = dp.ProcessPayload(outportBlockBytes, outport.TopicSaveBlock) + require.Nil(t, err) + require.Equal(t, 1, logInfoCalledCt) + }) + + t.Run("revert indexed block", func(t *testing.T) { + t.Parallel() + + logInfoCalledCt := 0 + logger := &testscommon.LoggerStub{ + InfoCalled: func(message string, args ...interface{}) { + require.Equal(t, "received payload", message) + require.Len(t, args, 1) + require.Equal(t, []interface{}{"topic", outport.TopicRevertIndexedBlock}, args[0]) + logInfoCalledCt++ + }, + } + dp, _ := NewLogDataProcessor(marshaller, logger) + + err := dp.ProcessPayload([]byte("payload"), outport.TopicRevertIndexedBlock) + require.NotNil(t, err) + require.Equal(t, 0, logInfoCalledCt) + + blockData := &outport.BlockData{} + blockDataBytes, err := marshaller.Marshal(blockData) + require.Nil(t, err) + + err = dp.ProcessPayload(blockDataBytes, outport.TopicRevertIndexedBlock) + require.Nil(t, err) + require.Equal(t, 1, logInfoCalledCt) + }) + + t.Run("save rounds", func(t *testing.T) { + t.Parallel() + + logInfoCalledCt := 0 + logger := &testscommon.LoggerStub{ + InfoCalled: func(message string, args ...interface{}) { + require.Equal(t, "received payload", message) + require.Len(t, args, 1) + require.Equal(t, []interface{}{"topic", outport.TopicSaveRoundsInfo}, args[0]) + logInfoCalledCt++ + }, + } + dp, _ := NewLogDataProcessor(marshaller, logger) + + err := dp.ProcessPayload([]byte("payload"), outport.TopicSaveRoundsInfo) + require.NotNil(t, err) + require.Equal(t, 0, logInfoCalledCt) + + roundsInfo := &outport.RoundsInfo{} + roundsInfoBytes, err := marshaller.Marshal(roundsInfo) + require.Nil(t, err) + + err = dp.ProcessPayload(roundsInfoBytes, outport.TopicSaveRoundsInfo) + require.Nil(t, err) + require.Equal(t, 1, logInfoCalledCt) + }) + + t.Run("save validators rating", func(t *testing.T) { + t.Parallel() + + logInfoCalledCt := 0 + logger := &testscommon.LoggerStub{ + InfoCalled: func(message string, args ...interface{}) { + require.Equal(t, "received payload", message) + require.Len(t, args, 1) + require.Equal(t, []interface{}{"topic", outport.TopicSaveValidatorsRating}, args[0]) + logInfoCalledCt++ + }, + } + dp, _ := NewLogDataProcessor(marshaller, logger) + + err := dp.ProcessPayload([]byte("payload"), outport.TopicSaveValidatorsRating) + require.NotNil(t, err) + require.Equal(t, 0, logInfoCalledCt) + + ratingData := &outport.ValidatorsRating{} + ratingDataBytes, err := marshaller.Marshal(ratingData) + require.Nil(t, err) + + err = dp.ProcessPayload(ratingDataBytes, outport.TopicSaveValidatorsRating) + require.Nil(t, err) + require.Equal(t, 1, logInfoCalledCt) + }) + + t.Run("save validators pubKeys", func(t *testing.T) { + t.Parallel() + + logInfoCalledCt := 0 + logger := &testscommon.LoggerStub{ + InfoCalled: func(message string, args ...interface{}) { + require.Equal(t, "received payload", message) + require.Len(t, args, 1) + require.Equal(t, []interface{}{"topic", outport.TopicSaveValidatorsPubKeys}, args[0]) + logInfoCalledCt++ + }, + } + dp, _ := NewLogDataProcessor(marshaller, logger) + + err := dp.ProcessPayload([]byte("payload"), outport.TopicSaveValidatorsPubKeys) + require.NotNil(t, err) + require.Equal(t, 0, logInfoCalledCt) + + validatorsPubKeys := &outport.ValidatorsPubKeys{} + validatorsPubKeysBytes, err := marshaller.Marshal(validatorsPubKeys) + require.Nil(t, err) + + err = dp.ProcessPayload(validatorsPubKeysBytes, outport.TopicSaveValidatorsPubKeys) + require.Nil(t, err) + require.Equal(t, 1, logInfoCalledCt) + }) + + t.Run("save accounts", func(t *testing.T) { + t.Parallel() + + logInfoCalledCt := 0 + logger := &testscommon.LoggerStub{ + InfoCalled: func(message string, args ...interface{}) { + require.Equal(t, "received payload", message) + require.Len(t, args, 1) + require.Equal(t, []interface{}{"topic", outport.TopicSaveAccounts}, args[0]) + logInfoCalledCt++ + }, + } + dp, _ := NewLogDataProcessor(marshaller, logger) + + err := dp.ProcessPayload([]byte("payload"), outport.TopicSaveAccounts) + require.NotNil(t, err) + require.Equal(t, 0, logInfoCalledCt) + + accounts := &outport.Accounts{} + accountsBytes, err := marshaller.Marshal(accounts) + require.Nil(t, err) + + err = dp.ProcessPayload(accountsBytes, outport.TopicSaveAccounts) + require.Nil(t, err) + require.Equal(t, 1, logInfoCalledCt) + }) + + t.Run("finalized block", func(t *testing.T) { + t.Parallel() + + logInfoCalledCt := 0 + logger := &testscommon.LoggerStub{ + InfoCalled: func(message string, args ...interface{}) { + require.Equal(t, "received payload", message) + require.Len(t, args, 1) + require.Equal(t, []interface{}{"topic", outport.TopicFinalizedBlock}, args[0]) + logInfoCalledCt++ + }, + } + dp, _ := NewLogDataProcessor(marshaller, logger) + + err := dp.ProcessPayload([]byte("payload"), outport.TopicFinalizedBlock) + require.NotNil(t, err) + require.Equal(t, 0, logInfoCalledCt) + + finalizedBlock := &outport.FinalizedBlock{} + finalizedBlockBytes, err := marshaller.Marshal(finalizedBlock) + require.Nil(t, err) + + err = dp.ProcessPayload(finalizedBlockBytes, outport.TopicFinalizedBlock) + require.Nil(t, err) + require.Equal(t, 1, logInfoCalledCt) + }) +} diff --git a/testscommon/loggerStub.go b/testscommon/loggerStub.go new file mode 100644 index 0000000..05bd0c1 --- /dev/null +++ b/testscommon/loggerStub.go @@ -0,0 +1,18 @@ +package testscommon + +// LoggerStub - +type LoggerStub struct { + InfoCalled func(message string, args ...interface{}) +} + +// Info - +func (l *LoggerStub) Info(message string, args ...interface{}) { + if l.InfoCalled != nil { + l.InfoCalled(message, args) + } +} + +// IsInterfaceNil - +func (l *LoggerStub) IsInterfaceNil() bool { + return l == nil +} diff --git a/testscommon/marshallerMock.go b/testscommon/marshallerMock.go new file mode 100644 index 0000000..b4259f2 --- /dev/null +++ b/testscommon/marshallerMock.go @@ -0,0 +1,41 @@ +package testscommon + +import ( + "encoding/json" + "errors" +) + +// MarshallerMock - +type MarshallerMock struct { +} + +// Marshal - +func (mm *MarshallerMock) Marshal(obj interface{}) ([]byte, error) { + if obj == nil { + return nil, errors.New("nil object to serialize from") + } + + return json.Marshal(obj) +} + +// Unmarshal - +func (mm *MarshallerMock) Unmarshal(obj interface{}, buff []byte) error { + if obj == nil { + return errors.New("nil object to serialize to") + } + + if buff == nil { + return errors.New("nil byte buffer to deserialize from") + } + + if len(buff) == 0 { + return errors.New("empty byte buffer to deserialize from") + } + + return json.Unmarshal(buff, obj) +} + +// IsInterfaceNil - +func (mm *MarshallerMock) IsInterfaceNil() bool { + return mm == nil +}