Compare commits
32 Commits
18f2ffaaa9
...
master
Author | SHA1 | Date | |
---|---|---|---|
6b2826c79f | |||
cd6857b8dd | |||
4a8add1d3d | |||
e40a8515cf | |||
4c72331a76 | |||
a94d9ed720 | |||
a1f09bafcc | |||
dec695f0e2 | |||
cc89f755cf | |||
6b52aae8f1 | |||
ad5c02bd80 | |||
576d5f8548 | |||
1c740f8399 | |||
fe90d81b5d | |||
9343970672 | |||
b73723b5f5 | |||
985ce3eba3 | |||
f48503f2b6 | |||
5d53e32316 | |||
76dea96a46 | |||
636b2dbf8f | |||
42aba649c8 | |||
67e87adf89 | |||
60d9fde890 | |||
bc82c8b59c | |||
682d70ed30 | |||
fa49bcf0c7 | |||
e4293b7b8b | |||
7a88321a69 | |||
35bd6d65bb | |||
4d82e29793 | |||
b2a83e3022 |
4
.gitignore
vendored
4
.gitignore
vendored
@ -1 +1,3 @@
|
||||
/coverage
|
||||
/coverage
|
||||
/bin
|
||||
/.vscode
|
661
LICENCE
Normal file
661
LICENCE
Normal file
@ -0,0 +1,661 @@
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero General Public License from time to time. Such new versions
|
||||
will be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU Affero General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU Affero General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU Affero General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
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.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
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 AGPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
5
Makefile
5
Makefile
@ -1,6 +1,9 @@
|
||||
test:
|
||||
go clean -testcache
|
||||
go test -v ./...
|
||||
go test -v -race ./...
|
||||
|
||||
watch:
|
||||
modd
|
||||
|
||||
deps:
|
||||
go get -u golang.org/x/tools/cmd/godoc
|
||||
|
18
api/api.go
18
api/api.go
@ -8,39 +8,41 @@ import (
|
||||
|
||||
// Response is a JSON encoded HTTP response body
|
||||
type Response struct {
|
||||
Error *Error `json:",omitempty"`
|
||||
Data interface{} `json:",omitempty"`
|
||||
Error *Error `json:"error,omitempty"`
|
||||
Data interface{} `json:"data,omitempty"`
|
||||
}
|
||||
|
||||
type ErrorCode string
|
||||
|
||||
// Error is a JSON encoded error
|
||||
type Error struct {
|
||||
Code ErrorCode
|
||||
Data interface{} `json:",omitempty"`
|
||||
Code ErrorCode `json:"code"`
|
||||
Data interface{} `json:"data,omitempty"`
|
||||
}
|
||||
|
||||
func (e *Error) Error() string {
|
||||
return fmt.Sprintf("%s: %v", e.Code, e.Data)
|
||||
return fmt.Sprintf("api-error: %s", e.Code)
|
||||
}
|
||||
|
||||
func DataResponse(w http.ResponseWriter, status int, data interface{}) {
|
||||
response(w, status, &Response{
|
||||
Data: data,
|
||||
})
|
||||
}, false)
|
||||
}
|
||||
|
||||
func ErrorResponse(w http.ResponseWriter, status int, code ErrorCode, data interface{}) {
|
||||
response(w, status, &Response{
|
||||
Error: &Error{code, data},
|
||||
})
|
||||
}, false)
|
||||
}
|
||||
|
||||
func response(w http.ResponseWriter, status int, res *Response) {
|
||||
func response(w http.ResponseWriter, status int, res *Response, conventional bool) {
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
w.WriteHeader(status)
|
||||
|
||||
encoder := json.NewEncoder(w)
|
||||
encoder.SetIndent("", " ")
|
||||
|
||||
if err := encoder.Encode(res); err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
@ -4,6 +4,8 @@ import (
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
|
||||
"github.com/pkg/errors"
|
||||
"gitlab.com/wpetit/goweb/logger"
|
||||
validator "gopkg.in/go-playground/validator.v9"
|
||||
)
|
||||
|
||||
@ -11,6 +13,10 @@ const (
|
||||
ErrCodeMalformedRequest ErrorCode = "malformed-request"
|
||||
ErrCodeInvalidRequest ErrorCode = "invalid-request"
|
||||
ErrCodeInvalidFieldValue ErrorCode = "invalid-field-value"
|
||||
ErrCodeNotFound ErrorCode = "not-found"
|
||||
ErrCodeUnknownError ErrorCode = "unknown-error"
|
||||
ErrCodeUnauthorized ErrorCode = "unauthorized"
|
||||
ErrCodeForbidden ErrorCode = "forbidden"
|
||||
)
|
||||
|
||||
// Bind parses and bind the request body to the given target
|
||||
@ -21,6 +27,7 @@ const (
|
||||
// validation.
|
||||
func Bind(w http.ResponseWriter, r *http.Request, target interface{}) (ok bool) {
|
||||
if err := parseBody(r, target); err != nil {
|
||||
logger.Error(r.Context(), "malformed request", logger.E(errors.WithStack(err)))
|
||||
ErrorResponse(
|
||||
w, http.StatusBadRequest,
|
||||
ErrCodeMalformedRequest,
|
||||
|
38
cli/format/json/writer.go
Normal file
38
cli/format/json/writer.go
Normal file
@ -0,0 +1,38 @@
|
||||
package json
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"io"
|
||||
|
||||
"github.com/pkg/errors"
|
||||
"gitlab.com/wpetit/goweb/cli/format"
|
||||
)
|
||||
|
||||
const Format format.Format = "json"
|
||||
|
||||
func init() {
|
||||
format.Register(Format, NewWriter())
|
||||
}
|
||||
|
||||
type Writer struct{}
|
||||
|
||||
// Format implements format.Writer.
|
||||
func (*Writer) Write(writer io.Writer, hints format.Hints, data ...any) error {
|
||||
encoder := json.NewEncoder(writer)
|
||||
|
||||
if hints.OutputMode == format.OutputModeWide {
|
||||
encoder.SetIndent("", " ")
|
||||
}
|
||||
|
||||
if err := encoder.Encode(data); err != nil {
|
||||
return errors.WithStack(err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func NewWriter() *Writer {
|
||||
return &Writer{}
|
||||
}
|
||||
|
||||
var _ format.Writer = &Writer{}
|
49
cli/format/prop.go
Normal file
49
cli/format/prop.go
Normal file
@ -0,0 +1,49 @@
|
||||
package format
|
||||
|
||||
type PropHintName string
|
||||
|
||||
type PropHintFunc func() (PropHintName, any)
|
||||
|
||||
type Prop struct {
|
||||
name string
|
||||
label string
|
||||
hints map[PropHintName]any
|
||||
}
|
||||
|
||||
func (p *Prop) Name() string {
|
||||
return p.name
|
||||
}
|
||||
|
||||
func (p *Prop) Label() string {
|
||||
return p.label
|
||||
}
|
||||
|
||||
func NewProp(name, label string, funcs ...PropHintFunc) Prop {
|
||||
hints := make(map[PropHintName]any)
|
||||
for _, fn := range funcs {
|
||||
name, value := fn()
|
||||
hints[name] = value
|
||||
}
|
||||
|
||||
return Prop{name, label, hints}
|
||||
}
|
||||
|
||||
func WithPropHint(name PropHintName, value any) PropHintFunc {
|
||||
return func() (PropHintName, any) {
|
||||
return name, value
|
||||
}
|
||||
}
|
||||
|
||||
func PropHint[T any](p Prop, name PropHintName, defaultValue T) T {
|
||||
rawValue, exists := p.hints[name]
|
||||
if !exists {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
value, ok := rawValue.(T)
|
||||
if !ok {
|
||||
return defaultValue
|
||||
}
|
||||
|
||||
return value
|
||||
}
|
46
cli/format/registry.go
Normal file
46
cli/format/registry.go
Normal file
@ -0,0 +1,46 @@
|
||||
package format
|
||||
|
||||
import (
|
||||
"io"
|
||||
|
||||
"github.com/pkg/errors"
|
||||
)
|
||||
|
||||
type Format string
|
||||
|
||||
type Registry map[Format]Writer
|
||||
|
||||
var defaultRegistry = Registry{}
|
||||
|
||||
var ErrUnknownFormat = errors.New("unknown format")
|
||||
|
||||
func Write(format Format, writer io.Writer, hints Hints, data ...any) error {
|
||||
formatWriter, exists := defaultRegistry[format]
|
||||
if !exists {
|
||||
return errors.WithStack(ErrUnknownFormat)
|
||||
}
|
||||
|
||||
if hints.OutputMode == "" {
|
||||
hints.OutputMode = OutputModeCompact
|
||||
}
|
||||
|
||||
if err := formatWriter.Write(writer, hints, data...); err != nil {
|
||||
return errors.WithStack(err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func Available() []Format {
|
||||
formats := make([]Format, 0, len(defaultRegistry))
|
||||
|
||||
for f := range defaultRegistry {
|
||||
formats = append(formats, f)
|
||||
}
|
||||
|
||||
return formats
|
||||
}
|
||||
|
||||
func Register(format Format, writer Writer) {
|
||||
defaultRegistry[format] = writer
|
||||
}
|
65
cli/format/table/prop.go
Normal file
65
cli/format/table/prop.go
Normal file
@ -0,0 +1,65 @@
|
||||
package table
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"reflect"
|
||||
|
||||
"github.com/pkg/errors"
|
||||
"gitlab.com/wpetit/goweb/cli/format"
|
||||
)
|
||||
|
||||
const (
|
||||
hintCompactModeMaxColumnWidth format.PropHintName = "compactModeMaxColumnWidth"
|
||||
)
|
||||
|
||||
func WithCompactModeMaxColumnWidth(max int) format.PropHintFunc {
|
||||
return format.WithPropHint(hintCompactModeMaxColumnWidth, max)
|
||||
}
|
||||
|
||||
func getProps(d any) []format.Prop {
|
||||
props := make([]format.Prop, 0)
|
||||
|
||||
v := reflect.Indirect(reflect.ValueOf(d))
|
||||
typeOf := v.Type()
|
||||
|
||||
for i := 0; i < v.NumField(); i++ {
|
||||
name := typeOf.Field(i).Name
|
||||
props = append(props, format.NewProp(name, name))
|
||||
}
|
||||
|
||||
return props
|
||||
}
|
||||
|
||||
func getFieldValue(obj any, name string) string {
|
||||
v := reflect.Indirect(reflect.ValueOf(obj))
|
||||
|
||||
fieldValue := v.FieldByName(name)
|
||||
|
||||
if !fieldValue.IsValid() {
|
||||
return ""
|
||||
}
|
||||
|
||||
if fieldValue.Kind() == reflect.Pointer && !fieldValue.IsNil() {
|
||||
fieldValue = fieldValue.Elem()
|
||||
}
|
||||
|
||||
switch fieldValue.Kind() {
|
||||
case reflect.Map:
|
||||
fallthrough
|
||||
case reflect.Struct:
|
||||
fallthrough
|
||||
case reflect.Slice:
|
||||
fallthrough
|
||||
case reflect.Interface:
|
||||
json, err := json.Marshal(fieldValue.Interface())
|
||||
if err != nil {
|
||||
panic(errors.WithStack(err))
|
||||
}
|
||||
|
||||
return string(json)
|
||||
|
||||
default:
|
||||
return fmt.Sprintf("%v", fieldValue)
|
||||
}
|
||||
}
|
80
cli/format/table/writer.go
Normal file
80
cli/format/table/writer.go
Normal file
@ -0,0 +1,80 @@
|
||||
package table
|
||||
|
||||
import (
|
||||
"io"
|
||||
|
||||
"github.com/jedib0t/go-pretty/v6/table"
|
||||
"gitlab.com/wpetit/goweb/cli/format"
|
||||
)
|
||||
|
||||
const Format format.Format = "table"
|
||||
|
||||
const DefaultCompactModeMaxColumnWidth = 30
|
||||
|
||||
func init() {
|
||||
format.Register(Format, NewWriter(DefaultCompactModeMaxColumnWidth))
|
||||
}
|
||||
|
||||
type Writer struct {
|
||||
compactModeMaxColumnWidth int
|
||||
}
|
||||
|
||||
// Write implements format.Writer.
|
||||
func (w *Writer) Write(writer io.Writer, hints format.Hints, data ...any) error {
|
||||
t := table.NewWriter()
|
||||
|
||||
t.SetOutputMirror(writer)
|
||||
|
||||
var props []format.Prop
|
||||
|
||||
if hints.Props != nil {
|
||||
props = hints.Props
|
||||
} else {
|
||||
if len(data) > 0 {
|
||||
props = getProps(data[0])
|
||||
} else {
|
||||
props = make([]format.Prop, 0)
|
||||
}
|
||||
}
|
||||
|
||||
labels := table.Row{}
|
||||
|
||||
for _, p := range props {
|
||||
labels = append(labels, p.Label())
|
||||
}
|
||||
|
||||
t.AppendHeader(labels)
|
||||
|
||||
isCompactMode := hints.OutputMode == format.OutputModeCompact
|
||||
|
||||
for _, d := range data {
|
||||
row := table.Row{}
|
||||
|
||||
for _, p := range props {
|
||||
value := getFieldValue(d, p.Name())
|
||||
|
||||
compactModeMaxColumnWidth := format.PropHint(p,
|
||||
hintCompactModeMaxColumnWidth,
|
||||
w.compactModeMaxColumnWidth,
|
||||
)
|
||||
|
||||
if isCompactMode && len(value) > compactModeMaxColumnWidth {
|
||||
value = value[:compactModeMaxColumnWidth] + "..."
|
||||
}
|
||||
|
||||
row = append(row, value)
|
||||
}
|
||||
|
||||
t.AppendRow(row)
|
||||
}
|
||||
|
||||
t.Render()
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func NewWriter(compactModeMaxColumnWidth int) *Writer {
|
||||
return &Writer{compactModeMaxColumnWidth}
|
||||
}
|
||||
|
||||
var _ format.Writer = &Writer{}
|
101
cli/format/table/writer_test.go
Normal file
101
cli/format/table/writer_test.go
Normal file
@ -0,0 +1,101 @@
|
||||
package table
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/pkg/errors"
|
||||
"gitlab.com/wpetit/goweb/cli/format"
|
||||
)
|
||||
|
||||
type dummyItem struct {
|
||||
MyString string
|
||||
MyInt int
|
||||
MySub subItem
|
||||
MySubPtr *subItem
|
||||
MyPointStr *string
|
||||
}
|
||||
|
||||
func (d *dummyItem) MyMethod() string {
|
||||
return fmt.Sprintf("myMethod: %s | %d", d.MyString, d.MyInt)
|
||||
}
|
||||
|
||||
type subItem struct {
|
||||
MyBool bool
|
||||
}
|
||||
|
||||
var dummyItems = []any{
|
||||
dummyItem{
|
||||
MyString: "Foo",
|
||||
MyInt: 1,
|
||||
MySub: subItem{
|
||||
MyBool: false,
|
||||
},
|
||||
},
|
||||
dummyItem{
|
||||
MyString: "Bar",
|
||||
MyInt: 0,
|
||||
MySub: subItem{
|
||||
MyBool: true,
|
||||
},
|
||||
MySubPtr: &subItem{
|
||||
MyBool: false,
|
||||
},
|
||||
MyPointStr: strPtr("Test"),
|
||||
},
|
||||
}
|
||||
|
||||
func TestWriterNoHints(t *testing.T) {
|
||||
var buf bytes.Buffer
|
||||
|
||||
writer := NewWriter(DefaultCompactModeMaxColumnWidth)
|
||||
|
||||
if err := writer.Write(&buf, format.Hints{}, dummyItems...); err != nil {
|
||||
t.Fatalf("%+v", errors.WithStack(err))
|
||||
}
|
||||
|
||||
expected := `+----------+-------+------------------+------------------+------------+
|
||||
| MYSTRING | MYINT | MYSUB | MYSUBPTR | MYPOINTSTR |
|
||||
+----------+-------+------------------+------------------+------------+
|
||||
| Foo | 1 | {"MyBool":false} | <nil> | <nil> |
|
||||
| Bar | 0 | {"MyBool":true} | {"MyBool":false} | Test |
|
||||
+----------+-------+------------------+------------------+------------+`
|
||||
|
||||
if e, g := strings.TrimSpace(expected), strings.TrimSpace(buf.String()); e != g {
|
||||
t.Errorf("buf.String(): expected \n%v\ngot\n%v", e, g)
|
||||
}
|
||||
}
|
||||
|
||||
func TestWriterWithPropHints(t *testing.T) {
|
||||
var buf bytes.Buffer
|
||||
|
||||
writer := NewWriter(DefaultCompactModeMaxColumnWidth)
|
||||
|
||||
hints := format.Hints{
|
||||
Props: []format.Prop{
|
||||
format.NewProp("MyString", "MyString"),
|
||||
format.NewProp("MyInt", "MyInt"),
|
||||
},
|
||||
}
|
||||
|
||||
if err := writer.Write(&buf, hints, dummyItems...); err != nil {
|
||||
t.Fatalf("%+v", errors.WithStack(err))
|
||||
}
|
||||
|
||||
expected := `+----------+-------+
|
||||
| MYSTRING | MYINT |
|
||||
+----------+-------+
|
||||
| Foo | 1 |
|
||||
| Bar | 0 |
|
||||
+----------+-------+`
|
||||
|
||||
if e, g := strings.TrimSpace(expected), strings.TrimSpace(buf.String()); e != g {
|
||||
t.Errorf("buf.String(): expected \n%v\ngot\n%v", e, g)
|
||||
}
|
||||
}
|
||||
|
||||
func strPtr(str string) *string {
|
||||
return &str
|
||||
}
|
19
cli/format/writer.go
Normal file
19
cli/format/writer.go
Normal file
@ -0,0 +1,19 @@
|
||||
package format
|
||||
|
||||
import "io"
|
||||
|
||||
type OutputMode string
|
||||
|
||||
const (
|
||||
OutputModeWide OutputMode = "wide"
|
||||
OutputModeCompact OutputMode = "compact"
|
||||
)
|
||||
|
||||
type Hints struct {
|
||||
Props []Prop
|
||||
OutputMode OutputMode
|
||||
}
|
||||
|
||||
type Writer interface {
|
||||
Write(writer io.Writer, hints Hints, data ...any) error
|
||||
}
|
52
cqrs/bus_test.go
Normal file
52
cqrs/bus_test.go
Normal file
@ -0,0 +1,52 @@
|
||||
package cqrs
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
)
|
||||
|
||||
type testCommandRequest struct {
|
||||
Foo string
|
||||
}
|
||||
|
||||
func TestSimpleCommandExec(t *testing.T) {
|
||||
dispatcher := NewDispatcher()
|
||||
|
||||
handlerCalled := false
|
||||
|
||||
handleTestCommand := func(ctx context.Context, cmd Command) error {
|
||||
handlerCalled = true
|
||||
return nil
|
||||
}
|
||||
|
||||
dispatcher.RegisterCommand(
|
||||
MatchCommandRequest(&testCommandRequest{}),
|
||||
CommandHandlerFunc(handleTestCommand),
|
||||
)
|
||||
|
||||
cmd := &testCommandRequest{
|
||||
Foo: "bar",
|
||||
}
|
||||
ctx := context.Background()
|
||||
|
||||
result, err := dispatcher.Exec(ctx, cmd)
|
||||
if err != nil {
|
||||
t.Error(err)
|
||||
}
|
||||
|
||||
if result == nil {
|
||||
t.Error("result should not be nil")
|
||||
}
|
||||
|
||||
if result.Command() == nil {
|
||||
t.Error("result.Command() should not be nil")
|
||||
}
|
||||
|
||||
if e, g := result.Command().Request(), cmd; e != g {
|
||||
t.Errorf("result.Command().Request(): expected '%v', got '%v'", e, g)
|
||||
}
|
||||
|
||||
if e, g := handlerCalled, true; e != g {
|
||||
t.Errorf("handlerCalled: expected '%v', got '%v'", e, g)
|
||||
}
|
||||
}
|
61
cqrs/command.go
Normal file
61
cqrs/command.go
Normal file
@ -0,0 +1,61 @@
|
||||
package cqrs
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"github.com/google/uuid"
|
||||
)
|
||||
|
||||
type CommandID string
|
||||
|
||||
type CommandRequest interface {
|
||||
}
|
||||
|
||||
type Command interface {
|
||||
ID() CommandID
|
||||
Request() CommandRequest
|
||||
}
|
||||
|
||||
type BaseCommand struct {
|
||||
id CommandID
|
||||
req CommandRequest
|
||||
}
|
||||
|
||||
func (c *BaseCommand) ID() CommandID {
|
||||
return c.id
|
||||
}
|
||||
|
||||
func (c *BaseCommand) Request() CommandRequest {
|
||||
return c.req
|
||||
}
|
||||
|
||||
func NewBaseCommand(req CommandRequest) *BaseCommand {
|
||||
id := CommandID(uuid.New().String())
|
||||
return &BaseCommand{id, req}
|
||||
}
|
||||
|
||||
type CommandResult interface {
|
||||
Command() Command
|
||||
}
|
||||
|
||||
type BaseCommandResult struct {
|
||||
cmd Command
|
||||
}
|
||||
|
||||
func (r *BaseCommandResult) Command() Command {
|
||||
return r.cmd
|
||||
}
|
||||
|
||||
func NewBaseCommandResult(cmd Command) *BaseCommandResult {
|
||||
return &BaseCommandResult{cmd}
|
||||
}
|
||||
|
||||
type CommandHandlerFunc func(context.Context, Command) error
|
||||
|
||||
func (h CommandHandlerFunc) Handle(ctx context.Context, cmd Command) error {
|
||||
return h(ctx, cmd)
|
||||
}
|
||||
|
||||
type CommandHandler interface {
|
||||
Handle(context.Context, Command) error
|
||||
}
|
92
cqrs/dispatcher.go
Normal file
92
cqrs/dispatcher.go
Normal file
@ -0,0 +1,92 @@
|
||||
package cqrs
|
||||
|
||||
import (
|
||||
"context"
|
||||
)
|
||||
|
||||
type Dispatcher struct {
|
||||
reg *Registry
|
||||
cmdFactory CommandFactory
|
||||
cmdResultFactory CommandResultFactory
|
||||
qryFactory QueryFactory
|
||||
qryResultFactory QueryResultFactory
|
||||
}
|
||||
|
||||
func (d *Dispatcher) Exec(ctx context.Context, req CommandRequest) (CommandResult, error) {
|
||||
cmd, err := d.cmdFactory(req)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
hdlr, mdlwrs, err := d.reg.MatchCommand(cmd)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if len(mdlwrs) > 0 {
|
||||
for i := len(mdlwrs) - 1; i >= 0; i-- {
|
||||
hdlr = mdlwrs[i](hdlr)
|
||||
}
|
||||
}
|
||||
|
||||
if err := hdlr.Handle(ctx, cmd); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
result, err := d.cmdResultFactory(cmd)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return result, nil
|
||||
}
|
||||
|
||||
func (d *Dispatcher) Query(ctx context.Context, req QueryRequest) (QueryResult, error) {
|
||||
qry, err := d.qryFactory(req)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
hdlr, mdlwrs, err := d.reg.MatchQuery(qry)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if len(mdlwrs) > 0 {
|
||||
for i := len(mdlwrs) - 1; i >= 0; i-- {
|
||||
hdlr = mdlwrs[i](hdlr)
|
||||
}
|
||||
}
|
||||
|
||||
data, err := hdlr.Handle(ctx, qry)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
result, err := d.qryResultFactory(qry, data)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return result, nil
|
||||
}
|
||||
|
||||
func (d *Dispatcher) RegisterCommand(match MatchFunc, hdlr CommandHandler, mdlwrs ...CommandMiddleware) {
|
||||
d.reg.RegisterCommand(match, hdlr, mdlwrs...)
|
||||
}
|
||||
|
||||
func (d *Dispatcher) RegisterQuery(match MatchFunc, hdlr QueryHandler, mdlwrs ...QueryMiddleware) {
|
||||
d.reg.RegisterQuery(match, hdlr, mdlwrs...)
|
||||
}
|
||||
|
||||
func NewDispatcher(funcs ...OptionFunc) *Dispatcher {
|
||||
opt := CreateOption(funcs...)
|
||||
|
||||
return &Dispatcher{
|
||||
reg: NewRegistry(),
|
||||
cmdFactory: opt.CommandFactory,
|
||||
cmdResultFactory: opt.CommandResultFactory,
|
||||
qryFactory: opt.QueryFactory,
|
||||
qryResultFactory: opt.QueryResultFactory,
|
||||
}
|
||||
}
|
9
cqrs/error.go
Normal file
9
cqrs/error.go
Normal file
@ -0,0 +1,9 @@
|
||||
package cqrs
|
||||
|
||||
import "errors"
|
||||
|
||||
var (
|
||||
ErrHandlerNotFound = errors.New("handler not found")
|
||||
ErrUnexpectedRequest = errors.New("unexpected request")
|
||||
ErrUnexpectedData = errors.New("unexpected data")
|
||||
)
|
33
cqrs/match.go
Normal file
33
cqrs/match.go
Normal file
@ -0,0 +1,33 @@
|
||||
package cqrs
|
||||
|
||||
import (
|
||||
"reflect"
|
||||
)
|
||||
|
||||
type MatchFunc func(interface{}) (bool, error)
|
||||
|
||||
func MatchCommandRequest(req interface{}) MatchFunc {
|
||||
reqType := reflect.TypeOf(req)
|
||||
|
||||
return func(raw interface{}) (bool, error) {
|
||||
cmd, ok := raw.(Command)
|
||||
if !ok {
|
||||
return false, ErrUnexpectedRequest
|
||||
}
|
||||
|
||||
return reflect.TypeOf(cmd.Request()) == reqType, nil
|
||||
}
|
||||
}
|
||||
|
||||
func MatchQueryRequest(req interface{}) MatchFunc {
|
||||
reqType := reflect.TypeOf(req)
|
||||
|
||||
return func(raw interface{}) (bool, error) {
|
||||
cmd, ok := raw.(Query)
|
||||
if !ok {
|
||||
return false, ErrUnexpectedRequest
|
||||
}
|
||||
|
||||
return reflect.TypeOf(cmd.Request()) == reqType, nil
|
||||
}
|
||||
}
|
42
cqrs/match_test.go
Normal file
42
cqrs/match_test.go
Normal file
@ -0,0 +1,42 @@
|
||||
package cqrs
|
||||
|
||||
import "testing"
|
||||
|
||||
type testType struct{}
|
||||
|
||||
func TestMatchCommandRequestType(t *testing.T) {
|
||||
match := MatchCommandRequest(&testType{})
|
||||
|
||||
cmd := NewBaseCommand(&testType{})
|
||||
|
||||
matches, err := match(cmd)
|
||||
if err != nil {
|
||||
t.Error(err)
|
||||
}
|
||||
|
||||
if e, g := true, matches; e != g {
|
||||
t.Errorf("match(&testType{}): expected '%v', got '%v'", e, g)
|
||||
}
|
||||
|
||||
cmd = NewBaseCommand(nil)
|
||||
|
||||
matches, err = match(cmd)
|
||||
if err != nil {
|
||||
t.Error(err)
|
||||
}
|
||||
|
||||
if e, g := false, matches; e != g {
|
||||
t.Errorf("match(nil): expected '%v', got '%v'", e, g)
|
||||
}
|
||||
|
||||
cmd = NewBaseCommand("test")
|
||||
|
||||
matches, err = match(cmd)
|
||||
if err != nil {
|
||||
t.Error(err)
|
||||
}
|
||||
|
||||
if e, g := false, matches; e != g {
|
||||
t.Errorf("match(\"test\"): expected '%v', got '%v'", e, g)
|
||||
}
|
||||
}
|
64
cqrs/middleware_test.go
Normal file
64
cqrs/middleware_test.go
Normal file
@ -0,0 +1,64 @@
|
||||
package cqrs
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestBasicCommandMiddleware(t *testing.T) {
|
||||
dispatcher := NewDispatcher()
|
||||
|
||||
handlerCalled := false
|
||||
|
||||
handleTestCommand := func(ctx context.Context, cmd Command) error {
|
||||
handlerCalled = true
|
||||
return nil
|
||||
}
|
||||
|
||||
middlewareCalled := false
|
||||
|
||||
commandMiddleware := func(next CommandHandler) CommandHandler {
|
||||
fn := func(ctx context.Context, cmd Command) error {
|
||||
middlewareCalled = true
|
||||
return next.Handle(ctx, cmd)
|
||||
}
|
||||
|
||||
return CommandHandlerFunc(fn)
|
||||
}
|
||||
|
||||
dispatcher.RegisterCommand(
|
||||
MatchCommandRequest(&testCommandRequest{}),
|
||||
CommandHandlerFunc(handleTestCommand),
|
||||
commandMiddleware,
|
||||
)
|
||||
|
||||
cmd := &testCommandRequest{
|
||||
Foo: "bar",
|
||||
}
|
||||
ctx := context.Background()
|
||||
|
||||
result, err := dispatcher.Exec(ctx, cmd)
|
||||
if err != nil {
|
||||
t.Error(err)
|
||||
}
|
||||
|
||||
if result == nil {
|
||||
t.Error("result should not be nil")
|
||||
}
|
||||
|
||||
if result.Command() == nil {
|
||||
t.Error("result.Command() should not be nil")
|
||||
}
|
||||
|
||||
if e, g := result.Command().Request(), cmd; e != g {
|
||||
t.Errorf("result.Command().Request(): expected '%v', got '%v'", e, g)
|
||||
}
|
||||
|
||||
if e, g := middlewareCalled, true; e != g {
|
||||
t.Errorf("middlewareCalled: expected '%v', got '%v'", e, g)
|
||||
}
|
||||
|
||||
if e, g := handlerCalled, true; e != g {
|
||||
t.Errorf("handlerCalled: expected '%v', got '%v'", e, g)
|
||||
}
|
||||
}
|
86
cqrs/option.go
Normal file
86
cqrs/option.go
Normal file
@ -0,0 +1,86 @@
|
||||
package cqrs
|
||||
|
||||
type Option struct {
|
||||
CommandFactory CommandFactory
|
||||
QueryFactory QueryFactory
|
||||
CommandResultFactory CommandResultFactory
|
||||
QueryResultFactory QueryResultFactory
|
||||
}
|
||||
|
||||
type CommandFactory func(CommandRequest) (Command, error)
|
||||
type QueryFactory func(QueryRequest) (Query, error)
|
||||
type CommandResultFactory func(Command) (CommandResult, error)
|
||||
type QueryResultFactory func(Query, interface{}) (QueryResult, error)
|
||||
|
||||
type OptionFunc func(*Option)
|
||||
|
||||
func DefaultOption() *Option {
|
||||
funcs := []OptionFunc{
|
||||
WithBaseQueryFactory(),
|
||||
WithBaseCommandFactory(),
|
||||
WithBaseQueryResultFactory(),
|
||||
WithBaseCommandResultFactory(),
|
||||
}
|
||||
|
||||
opt := &Option{}
|
||||
|
||||
for _, fn := range funcs {
|
||||
fn(opt)
|
||||
}
|
||||
|
||||
return opt
|
||||
}
|
||||
|
||||
func CreateOption(funcs ...OptionFunc) *Option {
|
||||
opt := DefaultOption()
|
||||
|
||||
for _, fn := range funcs {
|
||||
fn(opt)
|
||||
}
|
||||
|
||||
return opt
|
||||
}
|
||||
|
||||
func WithCommandFactory(factory CommandFactory) OptionFunc {
|
||||
return func(opt *Option) {
|
||||
opt.CommandFactory = factory
|
||||
}
|
||||
}
|
||||
|
||||
func WithQueryFactory(factory QueryFactory) OptionFunc {
|
||||
return func(opt *Option) {
|
||||
opt.QueryFactory = factory
|
||||
}
|
||||
}
|
||||
|
||||
func WithBaseQueryFactory() OptionFunc {
|
||||
return func(opt *Option) {
|
||||
opt.QueryFactory = func(req QueryRequest) (Query, error) {
|
||||
return NewBaseQuery(req), nil
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func WithBaseCommandFactory() OptionFunc {
|
||||
return func(opt *Option) {
|
||||
opt.CommandFactory = func(req CommandRequest) (Command, error) {
|
||||
return NewBaseCommand(req), nil
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func WithBaseQueryResultFactory() OptionFunc {
|
||||
return func(opt *Option) {
|
||||
opt.QueryResultFactory = func(qry Query, data interface{}) (QueryResult, error) {
|
||||
return NewBaseQueryResult(qry, data), nil
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func WithBaseCommandResultFactory() OptionFunc {
|
||||
return func(opt *Option) {
|
||||
opt.CommandResultFactory = func(cmd Command) (CommandResult, error) {
|
||||
return NewBaseCommandResult(cmd), nil
|
||||
}
|
||||
}
|
||||
}
|
13
cqrs/provider.go
Normal file
13
cqrs/provider.go
Normal file
@ -0,0 +1,13 @@
|
||||
package cqrs
|
||||
|
||||
import "gitlab.com/wpetit/goweb/service"
|
||||
|
||||
// ServiceProvider returns a service.Provider for the
|
||||
// the cqrs service
|
||||
func ServiceProvider() service.Provider {
|
||||
dispatcher := NewDispatcher()
|
||||
|
||||
return func(container *service.Container) (interface{}, error) {
|
||||
return dispatcher, nil
|
||||
}
|
||||
}
|
66
cqrs/query.go
Normal file
66
cqrs/query.go
Normal file
@ -0,0 +1,66 @@
|
||||
package cqrs
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"github.com/google/uuid"
|
||||
)
|
||||
|
||||
type QueryID string
|
||||
|
||||
type QueryRequest interface{}
|
||||
|
||||
type Query interface {
|
||||
ID() QueryID
|
||||
Request() QueryRequest
|
||||
}
|
||||
|
||||
type BaseQuery struct {
|
||||
id QueryID
|
||||
req QueryRequest
|
||||
}
|
||||
|
||||
func (q *BaseQuery) ID() QueryID {
|
||||
return q.id
|
||||
}
|
||||
|
||||
func (q *BaseQuery) Request() QueryRequest {
|
||||
return q.req
|
||||
}
|
||||
|
||||
func NewBaseQuery(req QueryRequest) *BaseQuery {
|
||||
id := QueryID(uuid.New().String())
|
||||
return &BaseQuery{id, req}
|
||||
}
|
||||
|
||||
type QueryResult interface {
|
||||
Query() Query
|
||||
Data() interface{}
|
||||
}
|
||||
|
||||
type BaseQueryResult struct {
|
||||
qry Query
|
||||
data interface{}
|
||||
}
|
||||
|
||||
func (r *BaseQueryResult) Query() Query {
|
||||
return r.qry
|
||||
}
|
||||
|
||||
func (r *BaseQueryResult) Data() interface{} {
|
||||
return r.data
|
||||
}
|
||||
|
||||
func NewBaseQueryResult(qry Query, data interface{}) *BaseQueryResult {
|
||||
return &BaseQueryResult{qry, data}
|
||||
}
|
||||
|
||||
type QueryHandlerFunc func(context.Context, Query) (interface{}, error)
|
||||
|
||||
func (h QueryHandlerFunc) Handle(ctx context.Context, qry Query) (interface{}, error) {
|
||||
return h(ctx, qry)
|
||||
}
|
||||
|
||||
type QueryHandler interface {
|
||||
Handle(context.Context, Query) (interface{}, error)
|
||||
}
|
68
cqrs/registry.go
Normal file
68
cqrs/registry.go
Normal file
@ -0,0 +1,68 @@
|
||||
package cqrs
|
||||
|
||||
type CommandMiddleware func(next CommandHandler) CommandHandler
|
||||
type QueryMiddleware func(next QueryHandler) QueryHandler
|
||||
|
||||
type Registry struct {
|
||||
commands []*commandHandler
|
||||
queries []*queryHandler
|
||||
}
|
||||
|
||||
type commandHandler struct {
|
||||
Match MatchFunc
|
||||
Handler CommandHandler
|
||||
Middlewares []CommandMiddleware
|
||||
}
|
||||
|
||||
type queryHandler struct {
|
||||
Match MatchFunc
|
||||
Handler QueryHandler
|
||||
Middlewares []QueryMiddleware
|
||||
}
|
||||
|
||||
func (r *Registry) MatchCommand(cmd Command) (CommandHandler, []CommandMiddleware, error) {
|
||||
// TODO cache matching to avoid unnecessary ops
|
||||
for _, reg := range r.commands {
|
||||
matches, err := reg.Match(cmd)
|
||||
if err != nil {
|
||||
return nil, nil, err
|
||||
}
|
||||
|
||||
if matches {
|
||||
return reg.Handler, reg.Middlewares, nil
|
||||
}
|
||||
}
|
||||
|
||||
return nil, nil, ErrHandlerNotFound
|
||||
}
|
||||
|
||||
func (r *Registry) MatchQuery(qry Query) (QueryHandler, []QueryMiddleware, error) {
|
||||
// TODO cache matching to avoid unnecessary ops
|
||||
for _, reg := range r.queries {
|
||||
matches, err := reg.Match(qry)
|
||||
if err != nil {
|
||||
return nil, nil, err
|
||||
}
|
||||
|
||||
if matches {
|
||||
return reg.Handler, reg.Middlewares, nil
|
||||
}
|
||||
}
|
||||
|
||||
return nil, nil, ErrHandlerNotFound
|
||||
}
|
||||
|
||||
func (r *Registry) RegisterCommand(match MatchFunc, hdlr CommandHandler, mdlwrs ...CommandMiddleware) {
|
||||
r.commands = append(r.commands, &commandHandler{match, hdlr, mdlwrs})
|
||||
}
|
||||
|
||||
func (r *Registry) RegisterQuery(match MatchFunc, hdlr QueryHandler, mdlwrs ...QueryMiddleware) {
|
||||
r.queries = append(r.queries, &queryHandler{match, hdlr, mdlwrs})
|
||||
}
|
||||
|
||||
func NewRegistry() *Registry {
|
||||
return &Registry{
|
||||
commands: make([]*commandHandler, 0),
|
||||
queries: make([]*queryHandler, 0),
|
||||
}
|
||||
}
|
34
cqrs/service.go
Normal file
34
cqrs/service.go
Normal file
@ -0,0 +1,34 @@
|
||||
package cqrs
|
||||
|
||||
import (
|
||||
"github.com/pkg/errors"
|
||||
"gitlab.com/wpetit/goweb/service"
|
||||
)
|
||||
|
||||
// ServiceName defines the cqrs service name
|
||||
const ServiceName service.Name = "cqrs"
|
||||
|
||||
// From retrieves the cqrs service in the given container
|
||||
func From(container *service.Container) (*Dispatcher, error) {
|
||||
raw, err := container.Service(ServiceName)
|
||||
if err != nil {
|
||||
return nil, errors.Wrapf(err, "error while retrieving '%s' service", ServiceName)
|
||||
}
|
||||
|
||||
srv, ok := raw.(*Dispatcher)
|
||||
if !ok {
|
||||
return nil, errors.Errorf("retrieved service is not a valid '%s' service", ServiceName)
|
||||
}
|
||||
|
||||
return srv, nil
|
||||
}
|
||||
|
||||
// Must retrieves the cqrs service in the given container or panic otherwise
|
||||
func Must(container *service.Container) *Dispatcher {
|
||||
service, err := From(container)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
return service
|
||||
}
|
1
example/pluggable/.gitignore
vendored
Normal file
1
example/pluggable/.gitignore
vendored
Normal file
@ -0,0 +1 @@
|
||||
/bin
|
11
example/pluggable/Makefile
Normal file
11
example/pluggable/Makefile
Normal file
@ -0,0 +1,11 @@
|
||||
build: extension
|
||||
go build -o ./bin/app ./
|
||||
|
||||
extension:
|
||||
go build -o ./bin/myplugin.so -buildmode=plugin ./myplugin
|
||||
|
||||
watch:
|
||||
modd
|
||||
|
||||
run:
|
||||
./bin/app
|
5
example/pluggable/hook/initializable.go
Normal file
5
example/pluggable/hook/initializable.go
Normal file
@ -0,0 +1,5 @@
|
||||
package hook
|
||||
|
||||
type Initializable interface {
|
||||
HookInit() error
|
||||
}
|
44
example/pluggable/main.go
Normal file
44
example/pluggable/main.go
Normal file
@ -0,0 +1,44 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"log"
|
||||
|
||||
"github.com/pkg/errors"
|
||||
"gitlab.com/wpetit/goweb/example/pluggable/hook"
|
||||
"gitlab.com/wpetit/goweb/plugin"
|
||||
)
|
||||
|
||||
func main() {
|
||||
reg := plugin.NewRegistry()
|
||||
ctx := context.Background()
|
||||
|
||||
_, err := reg.LoadAll(ctx, "./bin/*.so")
|
||||
if err != nil {
|
||||
log.Fatal(errors.WithStack(err))
|
||||
}
|
||||
|
||||
for _, ext := range reg.Plugins() {
|
||||
log.Printf("Loaded plugin '%s', version '%s'", ext.PluginName(), ext.PluginVersion())
|
||||
}
|
||||
|
||||
// Iterate over plugins
|
||||
err = reg.Each(func(p plugin.Plugin) error {
|
||||
h, ok := p.(hook.Initializable)
|
||||
if !ok {
|
||||
// Skip non initializable plugins
|
||||
return nil
|
||||
}
|
||||
|
||||
// Initialize plugin
|
||||
if err := h.HookInit(); err != nil {
|
||||
return errors.WithStack(err)
|
||||
}
|
||||
|
||||
return nil
|
||||
})
|
||||
|
||||
if err != nil {
|
||||
log.Fatal(errors.WithStack(err))
|
||||
}
|
||||
}
|
6
example/pluggable/modd.conf
Normal file
6
example/pluggable/modd.conf
Normal file
@ -0,0 +1,6 @@
|
||||
**/*.go
|
||||
modd.conf
|
||||
Makefile {
|
||||
prep: make build
|
||||
prep: make run
|
||||
}
|
11
example/pluggable/myplugin/main.go
Normal file
11
example/pluggable/myplugin/main.go
Normal file
@ -0,0 +1,11 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"gitlab.com/wpetit/goweb/plugin"
|
||||
)
|
||||
|
||||
func RegisterPlugin(ctx context.Context) (plugin.Plugin, error) {
|
||||
return &MyPlugin{}, nil
|
||||
}
|
19
example/pluggable/myplugin/plugin.go
Normal file
19
example/pluggable/myplugin/plugin.go
Normal file
@ -0,0 +1,19 @@
|
||||
package main
|
||||
|
||||
import "log"
|
||||
|
||||
type MyPlugin struct{}
|
||||
|
||||
func (e *MyPlugin) PluginName() string {
|
||||
return "my.plugin"
|
||||
}
|
||||
|
||||
func (e *MyPlugin) PluginVersion() string {
|
||||
return "0.0.0"
|
||||
}
|
||||
|
||||
func (e *MyPlugin) HookInit() error {
|
||||
log.Println("MyPlugin initialized !")
|
||||
|
||||
return nil
|
||||
}
|
37
go.mod
37
go.mod
@ -1,18 +1,39 @@
|
||||
module gitlab.com/wpetit/goweb
|
||||
|
||||
go 1.12
|
||||
go 1.21
|
||||
|
||||
toolchain go1.21.4
|
||||
|
||||
require (
|
||||
github.com/davecgh/go-spew v1.1.0
|
||||
cdr.dev/slog v1.6.1
|
||||
github.com/go-chi/chi v4.0.2+incompatible
|
||||
github.com/go-playground/locales v0.12.1 // indirect
|
||||
github.com/go-playground/universal-translator v0.16.0 // indirect
|
||||
github.com/go-chi/chi/v5 v5.0.10
|
||||
github.com/google/uuid v1.3.0
|
||||
github.com/gorilla/securecookie v1.1.1
|
||||
github.com/gorilla/sessions v1.2.0
|
||||
github.com/leodido/go-urn v1.1.0 // indirect
|
||||
github.com/oxtoacart/bpool v0.0.0-20190530202638-03653db5a59c
|
||||
github.com/pkg/errors v0.8.1
|
||||
golang.org/x/net v0.0.0-20190724013045-ca1201d0de80 // indirect
|
||||
gopkg.in/go-playground/assert.v1 v1.2.1 // indirect
|
||||
github.com/pkg/errors v0.9.1
|
||||
gopkg.in/go-playground/validator.v9 v9.29.1
|
||||
)
|
||||
|
||||
require (
|
||||
github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
|
||||
github.com/charmbracelet/lipgloss v0.7.1 // indirect
|
||||
github.com/go-playground/locales v0.14.0 // indirect
|
||||
github.com/go-playground/universal-translator v0.18.0 // indirect
|
||||
github.com/jedib0t/go-pretty/v6 v6.4.9
|
||||
github.com/leodido/go-urn v1.2.1 // indirect
|
||||
github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
|
||||
github.com/mattn/go-isatty v0.0.19 // indirect
|
||||
github.com/mattn/go-runewidth v0.0.15 // indirect
|
||||
github.com/muesli/reflow v0.3.0 // indirect
|
||||
github.com/muesli/termenv v0.15.2 // indirect
|
||||
github.com/rivo/uniseg v0.4.4 // indirect
|
||||
go.opentelemetry.io/otel v1.21.0 // indirect
|
||||
go.opentelemetry.io/otel/trace v1.21.0 // indirect
|
||||
golang.org/x/crypto v0.11.0 // indirect
|
||||
golang.org/x/sys v0.10.0 // indirect
|
||||
golang.org/x/term v0.10.0 // indirect
|
||||
golang.org/x/xerrors v0.0.0-20231012003039-104605ab7028 // indirect
|
||||
gopkg.in/go-playground/assert.v1 v1.2.1 // indirect
|
||||
)
|
||||
|
115
go.sum
115
go.sum
@ -1,33 +1,116 @@
|
||||
github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
|
||||
cdr.dev/slog v1.6.1 h1:IQjWZD0x6//sfv5n+qEhbu3wBkmtBQY5DILXNvMaIv4=
|
||||
cdr.dev/slog v1.6.1/go.mod h1:eHEYQLaZvxnIAXC+XdTSNLb/kgA/X2RVSF72v5wsxEI=
|
||||
cloud.google.com/go/compute v1.23.0 h1:tP41Zoavr8ptEqaW6j+LQOnyBBhO7OkOMAGrgLopTwY=
|
||||
cloud.google.com/go/compute v1.23.0/go.mod h1:4tCnrn48xsqlwSAiLf1HXMQk8CONslYbdiEZc9FEIbM=
|
||||
cloud.google.com/go/compute/metadata v0.2.3 h1:mg4jlk7mCAj6xXp9UJ4fjI9VUI5rubuGBW5aJ7UnBMY=
|
||||
cloud.google.com/go/compute/metadata v0.2.3/go.mod h1:VAV5nSsACxMJvgaAuX6Pk2AawlZn8kiOGuCv6gTkwuA=
|
||||
cloud.google.com/go/logging v1.7.0 h1:CJYxlNNNNAMkHp9em/YEXcfJg+rPDg7YfwoRpMU+t5I=
|
||||
cloud.google.com/go/logging v1.7.0/go.mod h1:3xjP2CjkM3ZkO73aj4ASA5wRPGGCRrPIAeNqVNkzY8M=
|
||||
cloud.google.com/go/longrunning v0.5.1 h1:Fr7TXftcqTudoyRJa113hyaqlGdiBQkp0Gq7tErFDWI=
|
||||
cloud.google.com/go/longrunning v0.5.1/go.mod h1:spvimkwdz6SPWKEt/XBij79E9fiTkHSQl/fRUUQJYJc=
|
||||
github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k=
|
||||
github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8=
|
||||
github.com/charmbracelet/lipgloss v0.7.1 h1:17WMwi7N1b1rVWOjMT+rCh7sQkvDU75B2hbZpc5Kc1E=
|
||||
github.com/charmbracelet/lipgloss v0.7.1/go.mod h1:yG0k3giv8Qj8edTCbbg6AlQ5e8KNWpFujkNawKNhE2c=
|
||||
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/go-chi/chi v4.0.2+incompatible h1:maB6vn6FqCxrpz4FqWdh4+lwpyZIQS7YEAUcHlgXVRs=
|
||||
github.com/go-chi/chi v4.0.2+incompatible/go.mod h1:eB3wogJHnLi3x/kFX2A+IbTBlXxmMeXJVKy9tTv1XzQ=
|
||||
github.com/go-playground/locales v0.12.1 h1:2FITxuFt/xuCNP1Acdhv62OzaCiviiE4kotfhkmOqEc=
|
||||
github.com/go-playground/locales v0.12.1/go.mod h1:IUMDtCfWo/w/mtMfIE/IG2K+Ey3ygWanZIBtBW0W2TM=
|
||||
github.com/go-playground/universal-translator v0.16.0 h1:X++omBR/4cE2MNg91AoC3rmGrCjJ8eAeUP/K/EKx4DM=
|
||||
github.com/go-playground/universal-translator v0.16.0/go.mod h1:1AnU7NaIRDWWzGEKwgtJRd2xk99HeFyHw3yid4rvQIY=
|
||||
github.com/go-chi/chi/v5 v5.0.10 h1:rLz5avzKpjqxrYwXNfmjkrYYXOyLJd37pz53UFHC6vk=
|
||||
github.com/go-chi/chi/v5 v5.0.10/go.mod h1:DslCQbL2OYiznFReuXYUmQ2hGd1aDpCnlMNITLSKoi8=
|
||||
github.com/go-logr/logr v1.3.0 h1:2y3SDp0ZXuc6/cjLSZ+Q3ir+QB9T/iG5yYRXqsagWSY=
|
||||
github.com/go-logr/logr v1.3.0/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
|
||||
github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
|
||||
github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
|
||||
github.com/go-playground/locales v0.14.0 h1:u50s323jtVGugKlcYeyzC0etD1HifMjqmJqb8WugfUU=
|
||||
github.com/go-playground/locales v0.14.0/go.mod h1:sawfccIbzZTqEDETgFXqTho0QybSa7l++s0DH+LDiLs=
|
||||
github.com/go-playground/universal-translator v0.18.0 h1:82dyy6p4OuJq4/CByFNOn/jYrnRPArHwAcmLoJZxyho=
|
||||
github.com/go-playground/universal-translator v0.18.0/go.mod h1:UvRDBj+xPUEGrFYl+lu/H90nyDXpg0fqeB/AQUGNTVA=
|
||||
github.com/golang/protobuf v1.5.3 h1:KhyjKVUg7Usr/dYsdSqoFveMYd5ko72D+zANwlG1mmg=
|
||||
github.com/golang/protobuf v1.5.3/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=
|
||||
github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
|
||||
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
|
||||
github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
|
||||
github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
|
||||
github.com/gorilla/securecookie v1.1.1 h1:miw7JPhV+b/lAHSXz4qd/nN9jRiAFV5FwjeKyCS8BvQ=
|
||||
github.com/gorilla/securecookie v1.1.1/go.mod h1:ra0sb63/xPlUeL+yeDciTfxMRAA+MP+HVt/4epWDjd4=
|
||||
github.com/gorilla/sessions v1.2.0 h1:S7P+1Hm5V/AT9cjEcUD5uDaQSX0OE577aCXgoaKpYbQ=
|
||||
github.com/gorilla/sessions v1.2.0/go.mod h1:dk2InVEVJ0sfLlnXv9EAgkf6ecYs/i80K/zI+bUmuGM=
|
||||
github.com/leodido/go-urn v1.1.0 h1:Sm1gr51B1kKyfD2BlRcLSiEkffoG96g6TPv6eRoEiB8=
|
||||
github.com/leodido/go-urn v1.1.0/go.mod h1:+cyI34gQWZcE1eQU7NVgKkkzdXDQHr1dBMtdAPozLkw=
|
||||
github.com/jedib0t/go-pretty/v6 v6.4.9 h1:vZ6bjGg2eBSrJn365qlxGcaWu09Id+LHtrfDWlB2Usc=
|
||||
github.com/jedib0t/go-pretty/v6 v6.4.9/go.mod h1:Ndk3ase2CkQbXLLNf5QDHoYb6J9WtVfmHZu9n8rk2xs=
|
||||
github.com/leodido/go-urn v1.2.1 h1:BqpAaACuzVSgi/VLzGZIobT2z4v53pjosyNd9Yv6n/w=
|
||||
github.com/leodido/go-urn v1.2.1/go.mod h1:zt4jvISO2HfUBqxjfIshjdMTYS56ZS/qv49ictyFfxY=
|
||||
github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=
|
||||
github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
|
||||
github.com/mattn/go-isatty v0.0.19 h1:JITubQf0MOLdlGRuRq+jtsDlekdYPia9ZFsB8h/APPA=
|
||||
github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
|
||||
github.com/mattn/go-runewidth v0.0.12/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk=
|
||||
github.com/mattn/go-runewidth v0.0.13/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
|
||||
github.com/mattn/go-runewidth v0.0.15 h1:UNAjwbU9l54TA3KzvqLGxwWjHmMgBUVhBiTjelZgg3U=
|
||||
github.com/mattn/go-runewidth v0.0.15/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
|
||||
github.com/muesli/reflow v0.3.0 h1:IFsN6K9NfGtjeggFP+68I4chLZV2yIKsXJFNZ+eWh6s=
|
||||
github.com/muesli/reflow v0.3.0/go.mod h1:pbwTDkVPibjO2kyvBQRBxTWEEGDGq0FlB1BIKtnHY/8=
|
||||
github.com/muesli/termenv v0.15.2 h1:GohcuySI0QmI3wN8Ok9PtKGkgkFIk7y6Vpb5PvrY+Wo=
|
||||
github.com/muesli/termenv v0.15.2/go.mod h1:Epx+iuz8sNs7mNKhxzH4fWXGNpZwUaJKRS1noLXviQ8=
|
||||
github.com/oxtoacart/bpool v0.0.0-20190530202638-03653db5a59c h1:rp5dCmg/yLR3mgFuSOe4oEnDDmGLROTvMragMUXpTQw=
|
||||
github.com/oxtoacart/bpool v0.0.0-20190530202638-03653db5a59c/go.mod h1:X07ZCGwUbLaax7L0S3Tw4hpejzu63ZrrQiUe6W0hcy0=
|
||||
github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
|
||||
github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
|
||||
github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
|
||||
github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
|
||||
github.com/pkg/profile v1.6.0/go.mod h1:qBsxPvzyUincmltOk6iyRVxHYg4adc0OFOv72ZdLa18=
|
||||
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/rivo/uniseg v0.1.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
|
||||
github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
|
||||
github.com/rivo/uniseg v0.4.4 h1:8TfxU8dW6PdqD27gjM8MVNuicgxIjxpm4K7x4jp8sis=
|
||||
github.com/rivo/uniseg v0.4.4/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
|
||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||
github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
|
||||
github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
|
||||
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
|
||||
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
|
||||
golang.org/x/net v0.0.0-20190724013045-ca1201d0de80 h1:Ao/3l156eZf2AW5wK8a7/smtodRU+gha3+BeqJ69lRk=
|
||||
golang.org/x/net v0.0.0-20190724013045-ca1201d0de80/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
||||
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
|
||||
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
||||
github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||
github.com/stretchr/testify v1.7.4/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
|
||||
github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
|
||||
github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
|
||||
go.opentelemetry.io/otel v1.21.0 h1:hzLeKBZEL7Okw2mGzZ0cc4k/A7Fta0uoPgaJCr8fsFc=
|
||||
go.opentelemetry.io/otel v1.21.0/go.mod h1:QZzNPQPm1zLX4gZK4cMi+71eaorMSGT3A4znnUvNNEo=
|
||||
go.opentelemetry.io/otel/metric v1.21.0 h1:tlYWfeo+Bocx5kLEloTjbcDwBuELRrIFxwdQ36PlJu4=
|
||||
go.opentelemetry.io/otel/metric v1.21.0/go.mod h1:o1p3CA8nNHW8j5yuQLdc1eeqEaPfzug24uvsyIEJRWM=
|
||||
go.opentelemetry.io/otel/sdk v1.16.0 h1:Z1Ok1YsijYL0CSJpHt4cS3wDDh7p572grzNrBMiMWgE=
|
||||
go.opentelemetry.io/otel/sdk v1.16.0/go.mod h1:tMsIuKXuuIWPBAOrH+eHtvhTL+SntFtXF9QD68aP6p4=
|
||||
go.opentelemetry.io/otel/trace v1.21.0 h1:WD9i5gzvoUPuXIXH24ZNBudiarZDKuekPqi/E8fpfLc=
|
||||
go.opentelemetry.io/otel/trace v1.21.0/go.mod h1:LGbsEB0f9LGjN+OZaQQ26sohbOmiMR+BaslueVtS/qQ=
|
||||
golang.org/x/crypto v0.11.0 h1:6Ewdq3tDic1mg5xRO4milcWCfMVQhI4NkqWWvqejpuA=
|
||||
golang.org/x/crypto v0.11.0/go.mod h1:xgJhtzW8F9jGdVFWZESrid1U1bjeNy4zgy5cRr/CIio=
|
||||
golang.org/x/net v0.12.0 h1:cfawfvKITfUsFCeJIHJrbSxpeu/E81khclypR0GVT50=
|
||||
golang.org/x/net v0.12.0/go.mod h1:zEVYFnQC7m/vmpQFELhcD1EWkZlX69l4oqgmer6hfKA=
|
||||
golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.10.0 h1:SqMFp9UcQJZa+pmYuAKjd9xq1f0j5rLcDIk0mj4qAsA=
|
||||
golang.org/x/sys v0.10.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/term v0.10.0 h1:3R7pNqamzBraeqj/Tj8qt1aQ2HpmlC+Cx/qL/7hn4/c=
|
||||
golang.org/x/term v0.10.0/go.mod h1:lpqdcUyK/oCiQxvxVrppt5ggO2KCZ5QblwqPnfZ6d5o=
|
||||
golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
||||
golang.org/x/text v0.11.0 h1:LAntKIrcmeSKERyiOh0XMV39LXS8IE9UL2yP7+f5ij4=
|
||||
golang.org/x/text v0.11.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
|
||||
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
|
||||
golang.org/x/xerrors v0.0.0-20231012003039-104605ab7028 h1:+cNy6SZtPcJQH3LJVLOSmiC7MMxXNOb3PU/VUEz+EhU=
|
||||
golang.org/x/xerrors v0.0.0-20231012003039-104605ab7028/go.mod h1:NDW/Ps6MPRej6fsCIbMTohpP40sJ/P/vI1MoTEGwX90=
|
||||
google.golang.org/genproto v0.0.0-20230726155614-23370e0ffb3e h1:xIXmWJ303kJCuogpj0bHq+dcjcZHU+XFyc1I0Yl9cRg=
|
||||
google.golang.org/genproto v0.0.0-20230726155614-23370e0ffb3e/go.mod h1:0ggbjUrZYpy1q+ANUS30SEoGZ53cdfwtbuG7Ptgy108=
|
||||
google.golang.org/genproto/googleapis/api v0.0.0-20230706204954-ccb25ca9f130 h1:XVeBY8d/FaK4848myy41HBqnDwvxeV3zMZhwN1TvAMU=
|
||||
google.golang.org/genproto/googleapis/api v0.0.0-20230706204954-ccb25ca9f130/go.mod h1:mPBs5jNgx2GuQGvFwUvVKqtn6HsUw9nP64BedgvqEsQ=
|
||||
google.golang.org/genproto/googleapis/rpc v0.0.0-20230706204954-ccb25ca9f130 h1:2FZP5XuJY9zQyGM5N0rtovnoXjiMUEIUMvw0m9wlpLc=
|
||||
google.golang.org/genproto/googleapis/rpc v0.0.0-20230706204954-ccb25ca9f130/go.mod h1:8mL13HKkDa+IuJ8yruA3ci0q+0vsUz4m//+ottjwS5o=
|
||||
google.golang.org/grpc v1.57.0 h1:kfzNeI/klCGD2YPMUlaGNT3pxvYfga7smW3Vth8Zsiw=
|
||||
google.golang.org/grpc v1.57.0/go.mod h1:Sd+9RMTACXwmub0zcNY2c4arhtrbBYD1AUHI/dt16Mo=
|
||||
google.golang.org/protobuf v1.31.0 h1:g0LDEJHgrBl9N9r17Ru3sqWhkIx2NB67okBHPwC7hs8=
|
||||
google.golang.org/protobuf v1.31.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/go-playground/assert.v1 v1.2.1 h1:xoYuJVE7KT85PYWrN730RguIQO0ePzVRfFMXadIrXTM=
|
||||
gopkg.in/go-playground/assert.v1 v1.2.1/go.mod h1:9RXL0bg/zibRAgZUYszZSwO/z8Y/a8bDuhia5mkpMnE=
|
||||
gopkg.in/go-playground/validator.v9 v9.29.1 h1:SvGtYmN60a5CVKTOzMSyfzWDeZRxRuGvRQyEAKbw1xc=
|
||||
gopkg.in/go-playground/validator.v9 v9.29.1/go.mod h1:+c9/zcJMFNgbLvly1L1V+PpxWdVbfP1avr/N00E2vyQ=
|
||||
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=
|
||||
|
@ -20,7 +20,9 @@ func Example_usage() {
|
||||
|
||||
// On expose le service "template" avec l'implémentation
|
||||
// basée sur le moteur de rendu HTML de la librairie standard
|
||||
container.Provide(template.ServiceName, html.ServiceProvider("./templates"))
|
||||
container.Provide(template.ServiceName, html.ServiceProvider(
|
||||
html.NewDirectoryLoader("./templates"),
|
||||
))
|
||||
|
||||
router := chi.NewRouter()
|
||||
|
||||
|
122
logger/logger.go
Normal file
122
logger/logger.go
Normal file
@ -0,0 +1,122 @@
|
||||
package logger
|
||||
|
||||
import (
|
||||
"context"
|
||||
"io"
|
||||
"os"
|
||||
|
||||
"github.com/pkg/errors"
|
||||
|
||||
"cdr.dev/slog/sloggers/slogjson"
|
||||
|
||||
"cdr.dev/slog/sloggers/sloghuman"
|
||||
|
||||
"cdr.dev/slog"
|
||||
)
|
||||
|
||||
type Format string
|
||||
|
||||
const (
|
||||
FormatHuman Format = "human"
|
||||
FormatJSON Format = "json"
|
||||
)
|
||||
|
||||
var captureFunc CaptureFunc = func(err error) {}
|
||||
|
||||
var defaultLogger slog.Logger // nolint: gochecknoglobals
|
||||
|
||||
type Field = slog.Field
|
||||
type Map = slog.Map
|
||||
type Level = slog.Level
|
||||
|
||||
const (
|
||||
LevelCritical Level = slog.LevelCritical
|
||||
LevelError Level = slog.LevelError
|
||||
LevelWarn Level = slog.LevelWarn
|
||||
LevelInfo Level = slog.LevelInfo
|
||||
LevelDebug Level = slog.LevelDebug
|
||||
)
|
||||
|
||||
func init() { // nolint: gochecknoinits
|
||||
defaultLogger = Make(FormatHuman, os.Stdout)
|
||||
}
|
||||
|
||||
func Make(f Format, w io.Writer) slog.Logger {
|
||||
var sink slog.Sink
|
||||
|
||||
switch f {
|
||||
case FormatHuman:
|
||||
sink = sloghuman.Sink(w)
|
||||
case FormatJSON:
|
||||
sink = slogjson.Sink(w)
|
||||
default:
|
||||
panic(errors.Errorf("unknown logger format '%s'", f))
|
||||
}
|
||||
|
||||
return slog.Make(sink)
|
||||
}
|
||||
|
||||
func Debug(ctx context.Context, msg string, fields ...any) {
|
||||
slog.Helper()
|
||||
defaultLogger.Debug(ctx, msg, fields...)
|
||||
}
|
||||
|
||||
func Info(ctx context.Context, msg string, fields ...any) {
|
||||
slog.Helper()
|
||||
defaultLogger.Info(ctx, msg, fields...)
|
||||
}
|
||||
|
||||
func Warn(ctx context.Context, msg string, fields ...any) {
|
||||
slog.Helper()
|
||||
defaultLogger.Warn(ctx, msg, fields...)
|
||||
}
|
||||
|
||||
func Error(ctx context.Context, msg string, fields ...any) {
|
||||
slog.Helper()
|
||||
defaultLogger.Error(ctx, msg, fields...)
|
||||
}
|
||||
|
||||
func Critical(ctx context.Context, msg string, fields ...any) {
|
||||
slog.Helper()
|
||||
defaultLogger.Critical(ctx, msg, fields...)
|
||||
}
|
||||
|
||||
func Fatal(ctx context.Context, msg string, fields ...any) {
|
||||
slog.Helper()
|
||||
defaultLogger.Fatal(ctx, msg, fields...)
|
||||
}
|
||||
|
||||
func F(name string, value interface{}) Field {
|
||||
return slog.F(name, value)
|
||||
}
|
||||
|
||||
func M(fields ...Field) Map {
|
||||
return slog.M(fields...)
|
||||
}
|
||||
|
||||
func E(err error) Field {
|
||||
return slog.Error(err)
|
||||
}
|
||||
|
||||
func CapturedE(err error) Field {
|
||||
captureFunc(err)
|
||||
return slog.Error(err)
|
||||
}
|
||||
|
||||
func SetLevel(level Level) {
|
||||
defaultLogger = defaultLogger.Leveled(level)
|
||||
}
|
||||
|
||||
func SetFormat(format Format) {
|
||||
defaultLogger = Make(format, os.Stdout)
|
||||
}
|
||||
|
||||
func With(ctx context.Context, fields ...Field) context.Context {
|
||||
return slog.With(ctx, fields...)
|
||||
}
|
||||
|
||||
type CaptureFunc func(err error)
|
||||
|
||||
func SetCaptureFunc(fn CaptureFunc) {
|
||||
captureFunc = fn
|
||||
}
|
13
logger/logger_test.go
Normal file
13
logger/logger_test.go
Normal file
@ -0,0 +1,13 @@
|
||||
package logger
|
||||
|
||||
import (
|
||||
"context"
|
||||
"os"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestLogger(t *testing.T) {
|
||||
log := Make(FormatHuman, os.Stdout)
|
||||
|
||||
log.Info(context.Background(), "test")
|
||||
}
|
@ -4,7 +4,7 @@ import (
|
||||
"context"
|
||||
"errors"
|
||||
|
||||
"github.com/go-chi/chi/middleware"
|
||||
"github.com/go-chi/chi/v5/middleware"
|
||||
goweb "gitlab.com/wpetit/goweb/middleware"
|
||||
"gitlab.com/wpetit/goweb/service"
|
||||
)
|
||||
@ -41,3 +41,9 @@ func Must(ctx context.Context) *service.Container {
|
||||
func ServiceContainer(container *service.Container) goweb.Middleware {
|
||||
return middleware.WithValue(KeyServiceContainer, container)
|
||||
}
|
||||
|
||||
// WithContainer returns a new context.Context with the given *service.Container
|
||||
// attached.
|
||||
func WithContainer(ctx context.Context, container *service.Container) context.Context {
|
||||
return context.WithValue(ctx, KeyServiceContainer, container)
|
||||
}
|
||||
|
@ -4,7 +4,7 @@ import (
|
||||
"context"
|
||||
"errors"
|
||||
|
||||
"github.com/go-chi/chi/middleware"
|
||||
"github.com/go-chi/chi/v5/middleware"
|
||||
goweb "gitlab.com/wpetit/goweb/middleware"
|
||||
)
|
||||
|
||||
|
16
plugin/error.go
Normal file
16
plugin/error.go
Normal file
@ -0,0 +1,16 @@
|
||||
package plugin
|
||||
|
||||
import "errors"
|
||||
|
||||
var (
|
||||
// ErrInvalidRegisterFunc is returned when the plugin package
|
||||
// could not find the expected RegisterPlugin func in the loaded
|
||||
// plugin.
|
||||
ErrInvalidRegisterFunc = errors.New("invalid register func")
|
||||
// ErrInvalidPlugin is returned when a loaded plugin does
|
||||
// not match the expected interface.
|
||||
ErrInvalidPlugin = errors.New("invalid plugin")
|
||||
// ErrPluginNotFound is returned when the given plugin could
|
||||
// not be found in the registry.
|
||||
ErrPluginNotFound = errors.New("plugin not found")
|
||||
)
|
6
plugin/plugin.go
Normal file
6
plugin/plugin.go
Normal file
@ -0,0 +1,6 @@
|
||||
package plugin
|
||||
|
||||
type Plugin interface {
|
||||
PluginName() string
|
||||
PluginVersion() string
|
||||
}
|
117
plugin/registry.go
Normal file
117
plugin/registry.go
Normal file
@ -0,0 +1,117 @@
|
||||
package plugin
|
||||
|
||||
import (
|
||||
"context"
|
||||
"path/filepath"
|
||||
"plugin"
|
||||
"sync"
|
||||
|
||||
"github.com/pkg/errors"
|
||||
)
|
||||
|
||||
type Registry struct {
|
||||
plugins map[string]Plugin
|
||||
mutex sync.RWMutex
|
||||
}
|
||||
|
||||
func (r *Registry) Add(plg Plugin) {
|
||||
r.mutex.Lock()
|
||||
defer r.mutex.Unlock()
|
||||
|
||||
r.plugins[plg.PluginName()] = plg
|
||||
}
|
||||
|
||||
func (r *Registry) Get(name string) (Plugin, error) {
|
||||
r.mutex.RLock()
|
||||
defer r.mutex.RUnlock()
|
||||
|
||||
plg, exists := r.plugins[name]
|
||||
if !exists {
|
||||
return nil, errors.WithStack(ErrPluginNotFound)
|
||||
}
|
||||
|
||||
return plg, nil
|
||||
}
|
||||
|
||||
func (r *Registry) Load(ctx context.Context, path string) (Plugin, error) {
|
||||
p, err := plugin.Open(path)
|
||||
if err != nil {
|
||||
return nil, errors.WithStack(err)
|
||||
}
|
||||
|
||||
registerFuncSymbol, err := p.Lookup("RegisterPlugin")
|
||||
if err != nil {
|
||||
return nil, errors.WithStack(err)
|
||||
}
|
||||
|
||||
register, ok := registerFuncSymbol.(func(context.Context) (Plugin, error))
|
||||
if !ok {
|
||||
return nil, errors.WithStack(ErrInvalidRegisterFunc)
|
||||
}
|
||||
|
||||
plg, err := register(ctx)
|
||||
if err != nil {
|
||||
return nil, errors.WithStack(err)
|
||||
}
|
||||
|
||||
if plg == nil {
|
||||
return nil, errors.WithStack(ErrInvalidPlugin)
|
||||
}
|
||||
|
||||
r.Add(plg)
|
||||
|
||||
return plg, nil
|
||||
}
|
||||
|
||||
func (r *Registry) LoadAll(ctx context.Context, pattern string) ([]Plugin, error) {
|
||||
extensions := make([]Plugin, 0)
|
||||
|
||||
matches, err := filepath.Glob(pattern)
|
||||
if err != nil {
|
||||
return nil, errors.WithStack(err)
|
||||
}
|
||||
|
||||
for _, m := range matches {
|
||||
ext, err := r.Load(ctx, m)
|
||||
if err != nil {
|
||||
return nil, errors.WithStack(err)
|
||||
}
|
||||
|
||||
extensions = append(extensions, ext)
|
||||
}
|
||||
|
||||
return extensions, nil
|
||||
}
|
||||
|
||||
func (r *Registry) Plugins() []Plugin {
|
||||
r.mutex.RLock()
|
||||
defer r.mutex.RUnlock()
|
||||
|
||||
plugins := make([]Plugin, 0, len(r.plugins))
|
||||
for _, p := range r.plugins {
|
||||
plugins = append(plugins, p)
|
||||
}
|
||||
|
||||
return plugins
|
||||
}
|
||||
|
||||
type IteratorFunc func(plg Plugin) error
|
||||
|
||||
func (r *Registry) Each(iterator IteratorFunc) error {
|
||||
r.mutex.RLock()
|
||||
defer r.mutex.RUnlock()
|
||||
|
||||
for _, p := range r.plugins {
|
||||
if err := iterator(p); err != nil {
|
||||
return errors.WithStack(err)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func NewRegistry() *Registry {
|
||||
return &Registry{
|
||||
plugins: make(map[string]Plugin),
|
||||
}
|
||||
}
|
94
plugin/registry_test.go
Normal file
94
plugin/registry_test.go
Normal file
@ -0,0 +1,94 @@
|
||||
package plugin_test
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/pkg/errors"
|
||||
"gitlab.com/wpetit/goweb/plugin"
|
||||
)
|
||||
|
||||
type testPlugin struct {
|
||||
name string
|
||||
version string
|
||||
}
|
||||
|
||||
func (p *testPlugin) PluginName() string {
|
||||
return p.name
|
||||
}
|
||||
|
||||
func (p *testPlugin) PluginVersion() string {
|
||||
return p.version
|
||||
}
|
||||
|
||||
func (p *testPlugin) Foo() string {
|
||||
return "bar"
|
||||
}
|
||||
|
||||
func TestRegistryEach(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
reg := plugin.NewRegistry()
|
||||
|
||||
plugins := []*testPlugin{
|
||||
{"plugin.a", "0.0.0"},
|
||||
{"plugin.b", "0.0.1"},
|
||||
}
|
||||
|
||||
for _, p := range plugins {
|
||||
reg.Add(p)
|
||||
}
|
||||
|
||||
total := 0
|
||||
|
||||
err := reg.Each(func(p plugin.Plugin) error {
|
||||
total++
|
||||
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
t.Error(errors.WithStack(err))
|
||||
}
|
||||
|
||||
if e, g := len(plugins), total; e != g {
|
||||
t.Errorf("total: expected '%v', got '%v'", e, g)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRegistryGet(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
reg := plugin.NewRegistry()
|
||||
|
||||
plugins := []*testPlugin{
|
||||
{"plugin.a", "0.0.0"},
|
||||
{"plugin.b", "0.0.1"},
|
||||
}
|
||||
|
||||
for _, p := range plugins {
|
||||
reg.Add(p)
|
||||
}
|
||||
|
||||
for _, p := range plugins {
|
||||
plugin, err := reg.Get(p.name)
|
||||
if err != nil {
|
||||
t.Error(errors.WithStack(err))
|
||||
}
|
||||
|
||||
if e, g := p.name, plugin.PluginName(); e != g {
|
||||
t.Errorf("plugin.PluginName(): expected '%v', got '%v'", e, g)
|
||||
}
|
||||
|
||||
if e, g := p.version, plugin.PluginVersion(); e != g {
|
||||
t.Errorf("plugin.PluginVersion(): expected '%v', got '%v'", e, g)
|
||||
}
|
||||
}
|
||||
|
||||
p, err := reg.Get("plugin.c")
|
||||
if !errors.Is(err, plugin.ErrPluginNotFound) {
|
||||
t.Errorf("err: expected '%v', got '%v'", plugin.ErrPluginNotFound, err)
|
||||
}
|
||||
|
||||
if p != nil {
|
||||
t.Errorf("reg.Get(\"plugin.c\"): expected '%v', got '%v'", nil, p)
|
||||
}
|
||||
}
|
7
service/build/info.go
Normal file
7
service/build/info.go
Normal file
@ -0,0 +1,7 @@
|
||||
package build
|
||||
|
||||
type Info struct {
|
||||
ProjectVersion string
|
||||
GitRef string
|
||||
BuildDate string
|
||||
}
|
43
service/build/service.go
Normal file
43
service/build/service.go
Normal file
@ -0,0 +1,43 @@
|
||||
package build
|
||||
|
||||
import (
|
||||
"github.com/pkg/errors"
|
||||
"gitlab.com/wpetit/goweb/service"
|
||||
)
|
||||
|
||||
const (
|
||||
ServiceName service.Name = "build"
|
||||
)
|
||||
|
||||
func ServiceProvider(projectVersion, gitRef, buildDate string) service.Provider {
|
||||
info := &Info{projectVersion, gitRef, buildDate}
|
||||
|
||||
return func(ctn *service.Container) (interface{}, error) {
|
||||
return info, nil
|
||||
}
|
||||
}
|
||||
|
||||
// From retrieves the build informations in the given service container
|
||||
func From(container *service.Container) (*Info, error) {
|
||||
service, err := container.Service(ServiceName)
|
||||
if err != nil {
|
||||
return nil, errors.Wrapf(err, "error while retrieving '%s' service", ServiceName)
|
||||
}
|
||||
|
||||
srv, ok := service.(*Info)
|
||||
if !ok {
|
||||
return nil, errors.Errorf("retrieved service is not a valid '%s' service", ServiceName)
|
||||
}
|
||||
|
||||
return srv, nil
|
||||
}
|
||||
|
||||
// Must retrieves the user repository in the given service container or panic otherwise
|
||||
func Must(container *service.Container) *Info {
|
||||
srv, err := From(container)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
return srv
|
||||
}
|
@ -1,5 +1,12 @@
|
||||
package template
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
|
||||
"gitlab.com/wpetit/goweb/service"
|
||||
"gitlab.com/wpetit/goweb/service/build"
|
||||
)
|
||||
|
||||
// Data is some data to inject into the template
|
||||
type Data map[string]interface{}
|
||||
|
||||
@ -17,3 +24,14 @@ func Extend(data Data, extensions ...DataExtFunc) (Data, error) {
|
||||
}
|
||||
return data, nil
|
||||
}
|
||||
|
||||
func WithBuildInfo(w http.ResponseWriter, r *http.Request, ctn *service.Container) DataExtFunc {
|
||||
return func(data Data) (Data, error) {
|
||||
info, err := build.From(ctn)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
data["BuildInfo"] = info
|
||||
return data, nil
|
||||
}
|
||||
}
|
||||
|
@ -1,6 +1,7 @@
|
||||
package template
|
||||
|
||||
import (
|
||||
"io"
|
||||
"net/http"
|
||||
|
||||
"github.com/pkg/errors"
|
||||
@ -13,6 +14,7 @@ const ServiceName service.Name = "template"
|
||||
// Service is a templating service
|
||||
type Service interface {
|
||||
RenderPage(w http.ResponseWriter, templateName string, data interface{}) error
|
||||
Render(w io.Writer, templateName string, data interface{}) error
|
||||
}
|
||||
|
||||
// From retrieves the template service in the given container
|
||||
|
@ -10,20 +10,23 @@ import (
|
||||
// CreateCookieSessionStore creates and returns a new cookie session store
|
||||
// with random authentication and encryption keys
|
||||
func CreateCookieSessionStore(authKeySize, encryptKeySize int, defaultOptions *sessions.Options) (sessions.Store, error) {
|
||||
authenticationKey, err := generateRandomBytes(authKeySize)
|
||||
authenticationKey, err := GenerateRandomBytes(authKeySize)
|
||||
if err != nil {
|
||||
return nil, errors.Wrap(err, "error while generating cookie authentication key")
|
||||
}
|
||||
encryptionKey, err := generateRandomBytes(encryptKeySize)
|
||||
|
||||
encryptionKey, err := GenerateRandomBytes(encryptKeySize)
|
||||
if err != nil {
|
||||
return nil, errors.Wrap(err, "error while generating cookie encryption key")
|
||||
}
|
||||
|
||||
store := sessions.NewCookieStore(authenticationKey, encryptionKey)
|
||||
store.Options = defaultOptions
|
||||
|
||||
return store, nil
|
||||
}
|
||||
|
||||
func generateRandomBytes(n int) ([]byte, error) {
|
||||
func GenerateRandomBytes(n int) ([]byte, error) {
|
||||
b := make([]byte, n)
|
||||
_, err := rand.Read(b)
|
||||
if err != nil {
|
||||
|
56
template/html/loader.go
Normal file
56
template/html/loader.go
Normal file
@ -0,0 +1,56 @@
|
||||
package html
|
||||
|
||||
import (
|
||||
"io/ioutil"
|
||||
"path/filepath"
|
||||
)
|
||||
|
||||
type Loader interface {
|
||||
Load(*TemplateService) error
|
||||
}
|
||||
|
||||
type DirectoryLoader struct {
|
||||
rootDir string
|
||||
}
|
||||
|
||||
func (l *DirectoryLoader) Load(srv *TemplateService) error {
|
||||
blockFiles, err := filepath.Glob(filepath.Join(l.rootDir, "blocks", "*.tmpl"))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
for _, f := range blockFiles {
|
||||
blockContent, err := ioutil.ReadFile(f)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
blockName := filepath.Base(f)
|
||||
srv.AddBlock(blockName, string(blockContent))
|
||||
}
|
||||
|
||||
layoutFiles, err := filepath.Glob(filepath.Join(l.rootDir, "layouts", "*.tmpl"))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Generate our templates map from our layouts/ and blocks/ directories
|
||||
for _, f := range layoutFiles {
|
||||
templateData, err := ioutil.ReadFile(f)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
templateName := filepath.Base(f)
|
||||
|
||||
if err := srv.LoadLayout(templateName, string(templateData)); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func NewDirectoryLoader(rootDir string) *DirectoryLoader {
|
||||
return &DirectoryLoader{rootDir}
|
||||
}
|
@ -6,6 +6,7 @@ import "html/template"
|
||||
type Options struct {
|
||||
Helpers template.FuncMap
|
||||
PoolSize int
|
||||
DevMode bool
|
||||
}
|
||||
|
||||
// OptionFunc configures options for the template service
|
||||
@ -48,6 +49,14 @@ func WithPoolSize(size int) OptionFunc {
|
||||
}
|
||||
}
|
||||
|
||||
// WithDevMode configures the template service
|
||||
// to use the development mode (auto reload of templates).
|
||||
func WithDevMode(enabled bool) OptionFunc {
|
||||
return func(opts *Options) {
|
||||
opts.DevMode = enabled
|
||||
}
|
||||
}
|
||||
|
||||
func defaultOptions() *Options {
|
||||
options := &Options{}
|
||||
funcs := []OptionFunc{
|
||||
|
@ -4,9 +4,9 @@ import "gitlab.com/wpetit/goweb/service"
|
||||
|
||||
// ServiceProvider returns a service.Provider for the
|
||||
// the HTML template service implementation
|
||||
func ServiceProvider(templateDir string, funcs ...OptionFunc) service.Provider {
|
||||
templateService := NewTemplateService(funcs...)
|
||||
err := templateService.LoadTemplatesDir(templateDir)
|
||||
func ServiceProvider(loader Loader, funcs ...OptionFunc) service.Provider {
|
||||
templateService := NewTemplateService(loader, funcs...)
|
||||
err := templateService.Load()
|
||||
return func(container *service.Container) (interface{}, error) {
|
||||
if err != nil {
|
||||
return nil, err
|
||||
|
@ -1,91 +1,79 @@
|
||||
package html
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"errors"
|
||||
"html/template"
|
||||
"io/ioutil"
|
||||
"io"
|
||||
"net/http"
|
||||
"path/filepath"
|
||||
"sync"
|
||||
|
||||
"github.com/oxtoacart/bpool"
|
||||
)
|
||||
|
||||
var (
|
||||
ErrLayoutNotFound = errors.New("layout not found")
|
||||
)
|
||||
|
||||
// TemplateService is a template/html based templating service
|
||||
type TemplateService struct {
|
||||
templates map[string]*template.Template
|
||||
pool *bpool.BufferPool
|
||||
helpers template.FuncMap
|
||||
mutex sync.RWMutex
|
||||
blocks map[string]string
|
||||
layouts map[string]*template.Template
|
||||
loader Loader
|
||||
pool *bpool.BufferPool
|
||||
helpers template.FuncMap
|
||||
devMode bool
|
||||
}
|
||||
|
||||
func (t *TemplateService) LoadLayout(name string, layout string, blocks []string) error {
|
||||
func (t *TemplateService) AddBlock(name string, blockContent string) {
|
||||
t.mutex.Lock()
|
||||
defer t.mutex.Unlock()
|
||||
|
||||
t.blocks[name] = blockContent
|
||||
}
|
||||
|
||||
func (t *TemplateService) LoadLayout(name string, layoutContent string) error {
|
||||
tmpl := template.New(name)
|
||||
tmpl.Funcs(t.helpers)
|
||||
|
||||
for _, b := range blocks {
|
||||
t.mutex.RLock()
|
||||
for _, b := range t.blocks {
|
||||
if _, err := tmpl.Parse(b); err != nil {
|
||||
t.mutex.RUnlock()
|
||||
return err
|
||||
}
|
||||
}
|
||||
t.mutex.RUnlock()
|
||||
|
||||
tmpl, err := tmpl.Parse(layout)
|
||||
tmpl, err := tmpl.Parse(layoutContent)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
t.templates[name] = tmpl
|
||||
t.mutex.Lock()
|
||||
t.layouts[name] = tmpl
|
||||
t.mutex.Unlock()
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// LoadTemplatesDir loads the templates used by the service
|
||||
func (t *TemplateService) LoadTemplatesDir(templatesDir string) error {
|
||||
|
||||
layoutFiles, err := filepath.Glob(filepath.Join(templatesDir, "layouts", "*.tmpl"))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
blockFiles, err := filepath.Glob(filepath.Join(templatesDir, "blocks", "*.tmpl"))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
blockTemplates := make([]string, 0, len(blockFiles))
|
||||
|
||||
for _, f := range blockFiles {
|
||||
templateData, err := ioutil.ReadFile(f)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
blockTemplates = append(blockTemplates, string(templateData))
|
||||
}
|
||||
|
||||
// Generate our templates map from our layouts/ and blocks/ directories
|
||||
for _, f := range layoutFiles {
|
||||
templateData, err := ioutil.ReadFile(f)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
templateName := filepath.Base(f)
|
||||
|
||||
if err := t.LoadLayout(templateName, string(templateData), blockTemplates); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
|
||||
// Load parses templates via the configured template loader.
|
||||
func (t *TemplateService) Load() error {
|
||||
return t.loader.Load(t)
|
||||
}
|
||||
|
||||
// RenderPage renders a template to the given http.ResponseWriter
|
||||
func (t *TemplateService) RenderPage(w http.ResponseWriter, templateName string, data interface{}) error {
|
||||
if t.devMode {
|
||||
if err := t.loader.Load(t); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
// Ensure the template exists in the map.
|
||||
tmpl, ok := t.templates[templateName]
|
||||
tmpl, ok := t.layouts[templateName]
|
||||
if !ok {
|
||||
return fmt.Errorf("the template '%s' does not exist", templateName)
|
||||
return ErrLayoutNotFound
|
||||
}
|
||||
|
||||
// Create a buffer to temporarily write to and check if any errors were encountered.
|
||||
@ -103,15 +91,45 @@ func (t *TemplateService) RenderPage(w http.ResponseWriter, templateName string,
|
||||
|
||||
}
|
||||
|
||||
// Render renders a layout to the given io.Writer.
|
||||
func (t *TemplateService) Render(w io.Writer, layoutName string, data interface{}) error {
|
||||
if t.devMode {
|
||||
if err := t.loader.Load(t); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
// Ensure the template exists in the map.
|
||||
tmpl, ok := t.layouts[layoutName]
|
||||
if !ok {
|
||||
return ErrLayoutNotFound
|
||||
}
|
||||
|
||||
// Create a buffer to temporarily write to and check if any errors were encountered.
|
||||
buf := t.pool.Get()
|
||||
defer t.pool.Put(buf)
|
||||
|
||||
if err := tmpl.ExecuteTemplate(buf, layoutName, data); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
_, err := buf.WriteTo(w)
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
// NewTemplateService returns a new Service
|
||||
func NewTemplateService(funcs ...OptionFunc) *TemplateService {
|
||||
func NewTemplateService(loader Loader, funcs ...OptionFunc) *TemplateService {
|
||||
options := defaultOptions()
|
||||
for _, f := range funcs {
|
||||
f(options)
|
||||
}
|
||||
return &TemplateService{
|
||||
templates: make(map[string]*template.Template),
|
||||
pool: bpool.NewBufferPool(options.PoolSize),
|
||||
helpers: options.Helpers,
|
||||
blocks: make(map[string]string),
|
||||
layouts: make(map[string]*template.Template),
|
||||
pool: bpool.NewBufferPool(options.PoolSize),
|
||||
helpers: options.Helpers,
|
||||
loader: loader,
|
||||
devMode: options.DevMode,
|
||||
}
|
||||
}
|
||||
|
Reference in New Issue
Block a user