mirror of
https://github.com/overleaf/overleaf.git
synced 2024-11-14 20:40:17 -05:00
Merge pull request #21575 from overleaf/em-big-query-add-ons
Fix RAW.REC_subscription_history table in BigQuery GitOrigin-RevId: 47507e17e819341a2663e4aadd8fea04b0e7a02d
This commit is contained in:
Eric Mc Sween
Copybot
parent
8a90ffa3fb
commit
eec87af5ff
34 changed files with 0 additions and 122313 deletions
8
services/spelling/.gitignore
vendored
8
services/spelling/.gitignore
vendored
|
|
@ -1,8 +0,0 @@
|
||||||
**.swp
|
|
||||||
**.swo
|
|
||||||
node_modules/*
|
|
||||||
cache/spell.cache
|
|
||||||
**/*.map
|
|
||||||
|
|
||||||
# managed by dev-environment$ bin/update_build_scripts
|
|
||||||
.npmrc
|
|
||||||
|
|
@ -1,3 +0,0 @@
|
||||||
{
|
|
||||||
"require": "test/setup.js"
|
|
||||||
}
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
18.20.4
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# This file was auto-generated, do not edit it directly.
|
|
||||||
# Instead run bin/update_build_scripts from
|
|
||||||
# https://github.com/overleaf/internal/
|
|
||||||
|
|
||||||
FROM node:18.20.4 AS base
|
|
||||||
|
|
||||||
WORKDIR /overleaf/services/spelling
|
|
||||||
COPY services/spelling/install_deps.sh /overleaf/services/spelling/
|
|
||||||
RUN chmod 0755 ./install_deps.sh && ./install_deps.sh
|
|
||||||
|
|
||||||
# Google Cloud Storage needs a writable $HOME/.config for resumable uploads
|
|
||||||
# (see https://googleapis.dev/nodejs/storage/latest/File.html#createWriteStream)
|
|
||||||
RUN mkdir /home/node/.config && chown node:node /home/node/.config
|
|
||||||
|
|
||||||
FROM base AS app
|
|
||||||
|
|
||||||
COPY package.json package-lock.json /overleaf/
|
|
||||||
COPY services/spelling/package.json /overleaf/services/spelling/
|
|
||||||
COPY libraries/ /overleaf/libraries/
|
|
||||||
COPY patches/ /overleaf/patches/
|
|
||||||
|
|
||||||
RUN cd /overleaf && npm ci --quiet
|
|
||||||
|
|
||||||
COPY services/spelling/ /overleaf/services/spelling/
|
|
||||||
|
|
||||||
FROM app
|
|
||||||
RUN mkdir -p cache \
|
|
||||||
&& chown node:node cache
|
|
||||||
USER node
|
|
||||||
|
|
||||||
CMD ["node", "--expose-gc", "app.js"]
|
|
||||||
|
|
@ -1,662 +0,0 @@
|
||||||
|
|
||||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
|
||||||
Version 3, 19 November 2007
|
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://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 <http://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
|
|
||||||
<http://www.gnu.org/licenses/>.
|
|
||||||
|
|
@ -1,137 +0,0 @@
|
||||||
# This file was auto-generated, do not edit it directly.
|
|
||||||
# Instead run bin/update_build_scripts from
|
|
||||||
# https://github.com/overleaf/internal/
|
|
||||||
|
|
||||||
BUILD_NUMBER ?= local
|
|
||||||
BRANCH_NAME ?= $(shell git rev-parse --abbrev-ref HEAD)
|
|
||||||
PROJECT_NAME = spelling
|
|
||||||
BUILD_DIR_NAME = $(shell pwd | xargs basename | tr -cd '[a-zA-Z0-9_.\-]')
|
|
||||||
|
|
||||||
DOCKER_COMPOSE_FLAGS ?= -f docker-compose.yml
|
|
||||||
DOCKER_COMPOSE := BUILD_NUMBER=$(BUILD_NUMBER) \
|
|
||||||
BRANCH_NAME=$(BRANCH_NAME) \
|
|
||||||
PROJECT_NAME=$(PROJECT_NAME) \
|
|
||||||
MOCHA_GREP=${MOCHA_GREP} \
|
|
||||||
docker compose ${DOCKER_COMPOSE_FLAGS}
|
|
||||||
|
|
||||||
COMPOSE_PROJECT_NAME_TEST_ACCEPTANCE ?= test_acceptance_$(BUILD_DIR_NAME)
|
|
||||||
DOCKER_COMPOSE_TEST_ACCEPTANCE = \
|
|
||||||
COMPOSE_PROJECT_NAME=$(COMPOSE_PROJECT_NAME_TEST_ACCEPTANCE) $(DOCKER_COMPOSE)
|
|
||||||
|
|
||||||
COMPOSE_PROJECT_NAME_TEST_UNIT ?= test_unit_$(BUILD_DIR_NAME)
|
|
||||||
DOCKER_COMPOSE_TEST_UNIT = \
|
|
||||||
COMPOSE_PROJECT_NAME=$(COMPOSE_PROJECT_NAME_TEST_UNIT) $(DOCKER_COMPOSE)
|
|
||||||
|
|
||||||
clean:
|
|
||||||
-docker rmi ci/$(PROJECT_NAME):$(BRANCH_NAME)-$(BUILD_NUMBER)
|
|
||||||
-docker rmi us-east1-docker.pkg.dev/overleaf-ops/ol-docker/$(PROJECT_NAME):$(BRANCH_NAME)-$(BUILD_NUMBER)
|
|
||||||
-$(DOCKER_COMPOSE_TEST_UNIT) down --rmi local
|
|
||||||
-$(DOCKER_COMPOSE_TEST_ACCEPTANCE) down --rmi local
|
|
||||||
|
|
||||||
HERE=$(shell pwd)
|
|
||||||
MONOREPO=$(shell cd ../../ && pwd)
|
|
||||||
# Run the linting commands in the scope of the monorepo.
|
|
||||||
# Eslint and prettier (plus some configs) are on the root.
|
|
||||||
RUN_LINTING = docker run --rm -v $(MONOREPO):$(MONOREPO) -w $(HERE) node:18.20.4 npm run --silent
|
|
||||||
|
|
||||||
RUN_LINTING_CI = docker run --rm --volume $(MONOREPO)/.editorconfig:/overleaf/.editorconfig --volume $(MONOREPO)/.eslintignore:/overleaf/.eslintignore --volume $(MONOREPO)/.eslintrc:/overleaf/.eslintrc --volume $(MONOREPO)/.prettierignore:/overleaf/.prettierignore --volume $(MONOREPO)/.prettierrc:/overleaf/.prettierrc --volume $(MONOREPO)/tsconfig.backend.json:/overleaf/tsconfig.backend.json ci/$(PROJECT_NAME):$(BRANCH_NAME)-$(BUILD_NUMBER) npm run --silent
|
|
||||||
|
|
||||||
# Same but from the top of the monorepo
|
|
||||||
RUN_LINTING_MONOREPO = docker run --rm -v $(MONOREPO):$(MONOREPO) -w $(MONOREPO) node:18.20.4 npm run --silent
|
|
||||||
|
|
||||||
format:
|
|
||||||
$(RUN_LINTING) format
|
|
||||||
|
|
||||||
format_ci:
|
|
||||||
$(RUN_LINTING_CI) format
|
|
||||||
|
|
||||||
format_fix:
|
|
||||||
$(RUN_LINTING) format:fix
|
|
||||||
|
|
||||||
lint:
|
|
||||||
$(RUN_LINTING) lint
|
|
||||||
|
|
||||||
lint_ci:
|
|
||||||
$(RUN_LINTING_CI) lint
|
|
||||||
|
|
||||||
lint_fix:
|
|
||||||
$(RUN_LINTING) lint:fix
|
|
||||||
|
|
||||||
typecheck:
|
|
||||||
$(RUN_LINTING) types:check
|
|
||||||
|
|
||||||
typecheck_ci:
|
|
||||||
$(RUN_LINTING_CI) types:check
|
|
||||||
|
|
||||||
test: format lint typecheck test_unit test_acceptance
|
|
||||||
|
|
||||||
test_unit:
|
|
||||||
ifneq (,$(wildcard test/unit))
|
|
||||||
$(DOCKER_COMPOSE_TEST_UNIT) run --rm test_unit
|
|
||||||
$(MAKE) test_unit_clean
|
|
||||||
endif
|
|
||||||
|
|
||||||
test_clean: test_unit_clean
|
|
||||||
test_unit_clean:
|
|
||||||
ifneq (,$(wildcard test/unit))
|
|
||||||
$(DOCKER_COMPOSE_TEST_UNIT) down -v -t 0
|
|
||||||
endif
|
|
||||||
|
|
||||||
test_acceptance: test_acceptance_clean test_acceptance_pre_run test_acceptance_run
|
|
||||||
$(MAKE) test_acceptance_clean
|
|
||||||
|
|
||||||
test_acceptance_debug: test_acceptance_clean test_acceptance_pre_run test_acceptance_run_debug
|
|
||||||
$(MAKE) test_acceptance_clean
|
|
||||||
|
|
||||||
test_acceptance_run:
|
|
||||||
ifneq (,$(wildcard test/acceptance))
|
|
||||||
$(DOCKER_COMPOSE_TEST_ACCEPTANCE) run --rm test_acceptance
|
|
||||||
endif
|
|
||||||
|
|
||||||
test_acceptance_run_debug:
|
|
||||||
ifneq (,$(wildcard test/acceptance))
|
|
||||||
$(DOCKER_COMPOSE_TEST_ACCEPTANCE) run -p 127.0.0.9:19999:19999 --rm test_acceptance npm run test:acceptance -- --inspect=0.0.0.0:19999 --inspect-brk
|
|
||||||
endif
|
|
||||||
|
|
||||||
test_clean: test_acceptance_clean
|
|
||||||
test_acceptance_clean:
|
|
||||||
$(DOCKER_COMPOSE_TEST_ACCEPTANCE) down -v -t 0
|
|
||||||
|
|
||||||
test_acceptance_pre_run:
|
|
||||||
ifneq (,$(wildcard test/acceptance/js/scripts/pre-run))
|
|
||||||
$(DOCKER_COMPOSE_TEST_ACCEPTANCE) run --rm test_acceptance test/acceptance/js/scripts/pre-run
|
|
||||||
endif
|
|
||||||
|
|
||||||
benchmarks:
|
|
||||||
$(DOCKER_COMPOSE_TEST_ACCEPTANCE) run --rm test_acceptance npm run benchmarks
|
|
||||||
|
|
||||||
build:
|
|
||||||
docker build \
|
|
||||||
--pull \
|
|
||||||
--build-arg BUILDKIT_INLINE_CACHE=1 \
|
|
||||||
--tag ci/$(PROJECT_NAME):$(BRANCH_NAME)-$(BUILD_NUMBER) \
|
|
||||||
--tag us-east1-docker.pkg.dev/overleaf-ops/ol-docker/$(PROJECT_NAME):$(BRANCH_NAME)-$(BUILD_NUMBER) \
|
|
||||||
--tag us-east1-docker.pkg.dev/overleaf-ops/ol-docker/$(PROJECT_NAME):$(BRANCH_NAME) \
|
|
||||||
--cache-from us-east1-docker.pkg.dev/overleaf-ops/ol-docker/$(PROJECT_NAME):$(BRANCH_NAME) \
|
|
||||||
--cache-from us-east1-docker.pkg.dev/overleaf-ops/ol-docker/$(PROJECT_NAME):main \
|
|
||||||
--file Dockerfile \
|
|
||||||
../..
|
|
||||||
|
|
||||||
tar:
|
|
||||||
$(DOCKER_COMPOSE) up tar
|
|
||||||
|
|
||||||
publish:
|
|
||||||
|
|
||||||
docker push $(DOCKER_REPO)/$(PROJECT_NAME):$(BRANCH_NAME)-$(BUILD_NUMBER)
|
|
||||||
|
|
||||||
|
|
||||||
.PHONY: clean \
|
|
||||||
format format_fix \
|
|
||||||
lint lint_fix \
|
|
||||||
build_types typecheck \
|
|
||||||
lint_ci format_ci typecheck_ci \
|
|
||||||
test test_clean test_unit test_unit_clean \
|
|
||||||
test_acceptance test_acceptance_debug test_acceptance_pre_run \
|
|
||||||
test_acceptance_run test_acceptance_run_debug test_acceptance_clean \
|
|
||||||
benchmarks \
|
|
||||||
build tar publish \
|
|
||||||
|
|
@ -1,11 +0,0 @@
|
||||||
overleaf/spelling
|
|
||||||
===================
|
|
||||||
|
|
||||||
The backend spellcheck API that performs spell checking for Overleaf
|
|
||||||
|
|
||||||
License
|
|
||||||
-------
|
|
||||||
|
|
||||||
The code in this repository is released under the GNU AFFERO GENERAL PUBLIC LICENSE, version 3. A copy can be found in the `LICENSE` file.
|
|
||||||
|
|
||||||
Copyright (c) Overleaf, 2014-2019.
|
|
||||||
|
|
@ -1,27 +0,0 @@
|
||||||
// Metrics must be initialized before importing anything else
|
|
||||||
import '@overleaf/metrics/initialize.js'
|
|
||||||
|
|
||||||
import Settings from '@overleaf/settings'
|
|
||||||
import logger from '@overleaf/logger'
|
|
||||||
import { app } from './app/js/server.js'
|
|
||||||
import * as ASpell from './app/js/ASpell.js'
|
|
||||||
import Metrics from '@overleaf/metrics'
|
|
||||||
|
|
||||||
const { host = '127.0.0.1', port = 3005 } = Settings.internal?.spelling ?? {}
|
|
||||||
|
|
||||||
ASpell.startCacheDump()
|
|
||||||
|
|
||||||
const server = app.listen(port, host, function (error) {
|
|
||||||
if (error) {
|
|
||||||
throw error
|
|
||||||
}
|
|
||||||
logger.info({ host, port }, 'spelling HTTP server starting up')
|
|
||||||
})
|
|
||||||
|
|
||||||
process.on('SIGTERM', () => {
|
|
||||||
ASpell.stopCacheDump()
|
|
||||||
server.close(() => {
|
|
||||||
logger.info({ host, port }, 'spelling HTTP server closed')
|
|
||||||
Metrics.close()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
@ -1,197 +0,0 @@
|
||||||
// TODO: This file was created by bulk-decaffeinate.
|
|
||||||
// Sanity-check the conversion and remove this comment.
|
|
||||||
/*
|
|
||||||
* decaffeinate suggestions:
|
|
||||||
* DS101: Remove unnecessary use of Array.from
|
|
||||||
* DS102: Remove unnecessary code created because of implicit returns
|
|
||||||
* DS207: Consider shorter variations of null checks
|
|
||||||
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
|
|
||||||
*/
|
|
||||||
import fs from 'node:fs'
|
|
||||||
import Path from 'node:path'
|
|
||||||
import { promisify } from 'node:util'
|
|
||||||
import LRU from 'lru-cache'
|
|
||||||
import logger from '@overleaf/logger'
|
|
||||||
import settings from '@overleaf/settings'
|
|
||||||
import OError from '@overleaf/o-error'
|
|
||||||
import { ASpellWorkerPool } from './ASpellWorkerPool.js'
|
|
||||||
|
|
||||||
let ASPELL_TIMEOUT = 10000
|
|
||||||
|
|
||||||
const OneMinute = 60 * 1000
|
|
||||||
const opts = { max: 10000, maxAge: OneMinute * 60 * 10 }
|
|
||||||
const cache = new LRU(opts)
|
|
||||||
|
|
||||||
const cacheFsPath = Path.resolve(settings.cacheDir, 'spell.cache')
|
|
||||||
const cacheFsPathTmp = cacheFsPath + '.tmp'
|
|
||||||
|
|
||||||
const WorkerPool = new ASpellWorkerPool()
|
|
||||||
|
|
||||||
// load any existing cache
|
|
||||||
try {
|
|
||||||
const oldCache = fs.readFileSync(cacheFsPath)
|
|
||||||
cache.load(JSON.parse(oldCache))
|
|
||||||
} catch (error) {
|
|
||||||
logger.debug(
|
|
||||||
OError.tag(error, 'could not load the cache file', { cacheFsPath })
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
let cacheDumpInterval
|
|
||||||
export function startCacheDump() {
|
|
||||||
// write the cache every 30 minutes
|
|
||||||
cacheDumpInterval = setInterval(function () {
|
|
||||||
const dump = JSON.stringify(cache.dump())
|
|
||||||
return fs.writeFile(cacheFsPathTmp, dump, function (err) {
|
|
||||||
if (err != null) {
|
|
||||||
logger.debug(OError.tag(err, 'error writing cache file'))
|
|
||||||
fs.unlink(cacheFsPathTmp, () => {})
|
|
||||||
} else {
|
|
||||||
fs.rename(cacheFsPathTmp, cacheFsPath, err => {
|
|
||||||
if (err) {
|
|
||||||
logger.error(OError.tag(err, 'error renaming cache file'))
|
|
||||||
} else {
|
|
||||||
logger.debug({ len: dump.length, cacheFsPath }, 'wrote cache file')
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}, 30 * OneMinute)
|
|
||||||
}
|
|
||||||
|
|
||||||
export function stopCacheDump() {
|
|
||||||
clearInterval(cacheDumpInterval)
|
|
||||||
}
|
|
||||||
|
|
||||||
class ASpellRunner {
|
|
||||||
checkWords(language, words, callback) {
|
|
||||||
if (callback == null) {
|
|
||||||
callback = () => {}
|
|
||||||
}
|
|
||||||
return this.runAspellOnWords(language, words, (error, output) => {
|
|
||||||
if (error != null) {
|
|
||||||
return callback(OError.tag(error))
|
|
||||||
}
|
|
||||||
// output = @removeAspellHeader(output)
|
|
||||||
const suggestions = this.getSuggestions(language, output)
|
|
||||||
const results = []
|
|
||||||
let hits = 0
|
|
||||||
const addToCache = {}
|
|
||||||
for (let i = 0; i < words.length; i++) {
|
|
||||||
const word = words[i]
|
|
||||||
const key = language + ':' + word
|
|
||||||
const cached = cache.get(key)
|
|
||||||
if (cached != null) {
|
|
||||||
hits++
|
|
||||||
if (cached === true) {
|
|
||||||
// valid word, no need to do anything
|
|
||||||
continue
|
|
||||||
} else {
|
|
||||||
results.push({ index: i, suggestions: cached })
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
if (suggestions[key] != null) {
|
|
||||||
addToCache[key] = suggestions[key]
|
|
||||||
results.push({ index: i, suggestions: suggestions[key] })
|
|
||||||
} else {
|
|
||||||
// a valid word, but uncached
|
|
||||||
addToCache[key] = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// update the cache after processing all words, to avoid cache
|
|
||||||
// changing while we use it
|
|
||||||
for (const k in addToCache) {
|
|
||||||
const v = addToCache[k]
|
|
||||||
cache.set(k, v)
|
|
||||||
}
|
|
||||||
|
|
||||||
logger.debug(
|
|
||||||
{
|
|
||||||
hits,
|
|
||||||
total: words.length,
|
|
||||||
hitrate: (hits / words.length).toFixed(2),
|
|
||||||
},
|
|
||||||
'cache hit rate'
|
|
||||||
)
|
|
||||||
return callback(null, results)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
getSuggestions(language, output) {
|
|
||||||
const lines = output.split('\n')
|
|
||||||
const suggestions = {}
|
|
||||||
for (const line of Array.from(lines)) {
|
|
||||||
let parts, word
|
|
||||||
if (line[0] === '&') {
|
|
||||||
// Suggestions found
|
|
||||||
parts = line.split(' ')
|
|
||||||
if (parts.length > 1) {
|
|
||||||
word = parts[1]
|
|
||||||
const suggestionsString = line.slice(line.indexOf(':') + 2)
|
|
||||||
suggestions[language + ':' + word] = suggestionsString.split(', ')
|
|
||||||
}
|
|
||||||
} else if (line[0] === '#') {
|
|
||||||
// No suggestions
|
|
||||||
parts = line.split(' ')
|
|
||||||
if (parts.length > 1) {
|
|
||||||
word = parts[1]
|
|
||||||
suggestions[language + ':' + word] = []
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return suggestions
|
|
||||||
}
|
|
||||||
|
|
||||||
// removeAspellHeader: (output) -> output.slice(1)
|
|
||||||
|
|
||||||
runAspellOnWords(language, words, callback) {
|
|
||||||
// send words to aspell, get back string output for those words
|
|
||||||
// find a free pipe for the language (or start one)
|
|
||||||
// send the words down the pipe
|
|
||||||
// send an END marker that will generate a "*" line in the output
|
|
||||||
// when the output pipe receives the "*" return the data sofar and reset the pipe to be available
|
|
||||||
//
|
|
||||||
// @open(language)
|
|
||||||
// @captureOutput(callback)
|
|
||||||
// @setTerseMode()
|
|
||||||
// start = new Date()
|
|
||||||
|
|
||||||
if (callback == null) {
|
|
||||||
callback = () => {}
|
|
||||||
}
|
|
||||||
const newWord = {}
|
|
||||||
for (const word of Array.from(words)) {
|
|
||||||
if (!newWord[word] && !cache.has(language + ':' + word)) {
|
|
||||||
newWord[word] = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
words = Object.keys(newWord)
|
|
||||||
|
|
||||||
if (words.length) {
|
|
||||||
return WorkerPool.check(language, words, ASPELL_TIMEOUT, callback)
|
|
||||||
} else {
|
|
||||||
return callback(null, '')
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// The description of how to call aspell from another program can be found here:
|
|
||||||
// http://aspell.net/man-html/Through-A-Pipe.html
|
|
||||||
export function checkWords(language, words, callback) {
|
|
||||||
if (callback == null) {
|
|
||||||
callback = () => {}
|
|
||||||
}
|
|
||||||
const runner = new ASpellRunner()
|
|
||||||
return runner.checkWords(language, words, callback)
|
|
||||||
}
|
|
||||||
|
|
||||||
export const promises = {
|
|
||||||
checkWords: promisify(checkWords),
|
|
||||||
}
|
|
||||||
|
|
||||||
// for tests
|
|
||||||
export function setTimeout(timeout) {
|
|
||||||
ASPELL_TIMEOUT = timeout
|
|
||||||
}
|
|
||||||
|
|
@ -1,240 +0,0 @@
|
||||||
// TODO: This file was created by bulk-decaffeinate.
|
|
||||||
// Sanity-check the conversion and remove this comment.
|
|
||||||
/*
|
|
||||||
* decaffeinate suggestions:
|
|
||||||
* DS102: Remove unnecessary code created because of implicit returns
|
|
||||||
* DS205: Consider reworking code to avoid use of IIFEs
|
|
||||||
* DS207: Consider shorter variations of null checks
|
|
||||||
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
|
|
||||||
*/
|
|
||||||
import childProcess from 'node:child_process'
|
|
||||||
import logger from '@overleaf/logger'
|
|
||||||
import metrics from '@overleaf/metrics'
|
|
||||||
import _ from 'underscore'
|
|
||||||
import OError from '@overleaf/o-error'
|
|
||||||
|
|
||||||
const BATCH_SIZE = 100
|
|
||||||
|
|
||||||
export class ASpellWorker {
|
|
||||||
constructor(language) {
|
|
||||||
this.language = language
|
|
||||||
this.count = 0
|
|
||||||
this.closeReason = ''
|
|
||||||
this.pipe = childProcess.spawn('aspell', [
|
|
||||||
'pipe',
|
|
||||||
'-t',
|
|
||||||
'--encoding=utf-8',
|
|
||||||
'-d',
|
|
||||||
language,
|
|
||||||
])
|
|
||||||
logger.debug(
|
|
||||||
{ process: this.pipe.pid, lang: this.language },
|
|
||||||
'starting new aspell worker'
|
|
||||||
)
|
|
||||||
metrics.inc('aspellWorker', 1, { status: 'start', method: this.language })
|
|
||||||
this.pipe.on('exit', () => {
|
|
||||||
this.state = 'killed'
|
|
||||||
logger.debug(
|
|
||||||
{ process: this.pipe.pid, lang: this.language },
|
|
||||||
'aspell worker has exited'
|
|
||||||
)
|
|
||||||
metrics.inc('aspellWorker', 1, {
|
|
||||||
status: 'exit',
|
|
||||||
method: this.language,
|
|
||||||
})
|
|
||||||
})
|
|
||||||
this.pipe.on('close', () => {
|
|
||||||
const previousWorkerState = this.state
|
|
||||||
if (this.state !== 'killed') {
|
|
||||||
this.state = 'closed'
|
|
||||||
}
|
|
||||||
if (this.callback != null) {
|
|
||||||
const err = new OError(
|
|
||||||
'aspell worker closed output streams with uncalled callback',
|
|
||||||
{
|
|
||||||
process: this.pipe.pid,
|
|
||||||
lang: this.language,
|
|
||||||
stdout: output.slice(-1024),
|
|
||||||
stderr: error.slice(-1024),
|
|
||||||
workerState: this.state,
|
|
||||||
previousWorkerState,
|
|
||||||
closeReason: this.closeReason,
|
|
||||||
}
|
|
||||||
)
|
|
||||||
this.callback(err, [])
|
|
||||||
this.callback = null
|
|
||||||
}
|
|
||||||
})
|
|
||||||
this.pipe.on('error', err => {
|
|
||||||
const previousWorkerState = this.state
|
|
||||||
if (this.state !== 'killed') {
|
|
||||||
this.state = 'error'
|
|
||||||
}
|
|
||||||
OError.tag(err, 'aspell worker error', {
|
|
||||||
process: this.pipe.pid,
|
|
||||||
stdout: output.slice(-1024),
|
|
||||||
stderr: error.slice(-1024),
|
|
||||||
lang: this.language,
|
|
||||||
workerState: this.state,
|
|
||||||
previousWorkerState,
|
|
||||||
closeReason: this.closeReason,
|
|
||||||
})
|
|
||||||
|
|
||||||
if (this.callback != null) {
|
|
||||||
this.callback(err, [])
|
|
||||||
this.callback = null
|
|
||||||
} else {
|
|
||||||
logger.warn(err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
this.pipe.stdin.on('error', err => {
|
|
||||||
const previousWorkerState = this.state
|
|
||||||
if (this.state !== 'killed') {
|
|
||||||
this.state = 'error'
|
|
||||||
}
|
|
||||||
|
|
||||||
OError.tag(err, 'aspell worker error on stdin', {
|
|
||||||
process: this.pipe.pid,
|
|
||||||
stdout: output.slice(-1024),
|
|
||||||
stderr: error.slice(-1024),
|
|
||||||
lang: this.language,
|
|
||||||
workerState: this.state,
|
|
||||||
previousWorkerState,
|
|
||||||
closeReason: this.closeReason,
|
|
||||||
})
|
|
||||||
|
|
||||||
if (this.callback != null) {
|
|
||||||
this.callback(err, [])
|
|
||||||
this.callback = null
|
|
||||||
} else {
|
|
||||||
logger.warn(err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
this.pipe.stdout.setEncoding('utf8') // ensure utf8 output is handled correctly
|
|
||||||
let output = ''
|
|
||||||
const endMarkerRegex = /^[a-z]{2}/gm
|
|
||||||
this.pipe.stdout.on('data', data => {
|
|
||||||
// We receive the language code from Aspell as the end of data marker in
|
|
||||||
// the data. The input is a utf8 encoded string.
|
|
||||||
const oldPos = output.length
|
|
||||||
output = output + data
|
|
||||||
// The end marker may cross the end of a chunk, so we optimise the search
|
|
||||||
// using the regex lastIndex property.
|
|
||||||
endMarkerRegex.lastIndex = oldPos > 2 ? oldPos - 2 : 0
|
|
||||||
if (endMarkerRegex.test(output)) {
|
|
||||||
if (this.callback != null) {
|
|
||||||
this.callback(null, output.slice())
|
|
||||||
this.callback = null // only allow one callback in use
|
|
||||||
} else {
|
|
||||||
logger.err(
|
|
||||||
new OError(
|
|
||||||
'end of data marker received when callback already used',
|
|
||||||
{
|
|
||||||
process: this.pipe.pid,
|
|
||||||
lang: this.language,
|
|
||||||
workerState: this.state,
|
|
||||||
}
|
|
||||||
)
|
|
||||||
)
|
|
||||||
}
|
|
||||||
this.state = 'ready'
|
|
||||||
output = ''
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
let error = ''
|
|
||||||
this.pipe.stderr.on('data', chunk => {
|
|
||||||
return (error = error + chunk)
|
|
||||||
})
|
|
||||||
|
|
||||||
this.pipe.stdout.on('end', () => {
|
|
||||||
// process has ended
|
|
||||||
return (this.state = 'end')
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
isReady() {
|
|
||||||
return this.state === 'ready'
|
|
||||||
}
|
|
||||||
|
|
||||||
check(words, callback) {
|
|
||||||
// we will now send data to aspell, and be ready again when we
|
|
||||||
// receive the end of data marker
|
|
||||||
this.state = 'busy'
|
|
||||||
if (this.callback != null) {
|
|
||||||
// only allow one callback in use
|
|
||||||
return this.callback(
|
|
||||||
new OError('Aspell callback already in use - SHOULD NOT HAPPEN', {
|
|
||||||
process: this.pipe.pid,
|
|
||||||
lang: this.language,
|
|
||||||
workerState: this.state,
|
|
||||||
})
|
|
||||||
)
|
|
||||||
}
|
|
||||||
this.callback = _.once(callback) // extra defence against double callback
|
|
||||||
this.setTerseMode()
|
|
||||||
this.write(words)
|
|
||||||
return this.flush()
|
|
||||||
}
|
|
||||||
|
|
||||||
write(words) {
|
|
||||||
let i = 0
|
|
||||||
return (() => {
|
|
||||||
const result = []
|
|
||||||
while (i < words.length) {
|
|
||||||
// batch up the words to check for efficiency
|
|
||||||
const batch = words.slice(i, i + BATCH_SIZE)
|
|
||||||
this.sendWords(batch)
|
|
||||||
result.push((i += BATCH_SIZE))
|
|
||||||
}
|
|
||||||
return result
|
|
||||||
})()
|
|
||||||
}
|
|
||||||
|
|
||||||
flush() {
|
|
||||||
// get aspell to send an end of data marker "*" when ready
|
|
||||||
// @sendCommand("%") # take the aspell pipe out of terse mode so we can look for a '*'
|
|
||||||
// @sendCommand("^ENDOFSTREAMMARKER") # send our marker which will generate a '*'
|
|
||||||
// @sendCommand("!") # go back into terse mode
|
|
||||||
return this.sendCommand('$$l')
|
|
||||||
}
|
|
||||||
|
|
||||||
shutdown(reason) {
|
|
||||||
logger.debug({ process: this.pipe.pid, reason }, 'shutting down')
|
|
||||||
this.state = 'closing'
|
|
||||||
this.closeReason = reason
|
|
||||||
return this.pipe.stdin.end()
|
|
||||||
}
|
|
||||||
|
|
||||||
kill(reason) {
|
|
||||||
logger.debug({ process: this.pipe.pid, reason }, 'killing')
|
|
||||||
this.closeReason = reason
|
|
||||||
if (this.state === 'killed') {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
return this.pipe.kill('SIGKILL')
|
|
||||||
}
|
|
||||||
|
|
||||||
setTerseMode() {
|
|
||||||
return this.sendCommand('!')
|
|
||||||
}
|
|
||||||
|
|
||||||
sendWord(word) {
|
|
||||||
return this.sendCommand(`^${word}`)
|
|
||||||
}
|
|
||||||
|
|
||||||
sendWords(words) {
|
|
||||||
// Aspell accepts multiple words to check on the same line
|
|
||||||
// ^word1 word2 word3 ...
|
|
||||||
// See aspell.info, writing programs to use Aspell Through A Pipe
|
|
||||||
this.sendCommand(`^${words.join(' ')}`)
|
|
||||||
return this.count++
|
|
||||||
}
|
|
||||||
|
|
||||||
sendCommand(command) {
|
|
||||||
// Sanitize user input. Reject line feed characters.
|
|
||||||
command = command.replace(/[\r\n]/g, '')
|
|
||||||
return this.pipe.stdin.write(command + '\n')
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,115 +0,0 @@
|
||||||
// TODO: This file was created by bulk-decaffeinate.
|
|
||||||
// Sanity-check the conversion and remove this comment.
|
|
||||||
/*
|
|
||||||
* decaffeinate suggestions:
|
|
||||||
* DS102: Remove unnecessary code created because of implicit returns
|
|
||||||
* DS206: Consider reworking classes to avoid initClass
|
|
||||||
* DS207: Consider shorter variations of null checks
|
|
||||||
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
|
|
||||||
*/
|
|
||||||
import _ from 'underscore'
|
|
||||||
import Settings from '@overleaf/settings'
|
|
||||||
import logger from '@overleaf/logger'
|
|
||||||
import metrics from '@overleaf/metrics'
|
|
||||||
import OError from '@overleaf/o-error'
|
|
||||||
import { ASpellWorker } from './ASpellWorker.js'
|
|
||||||
|
|
||||||
export class ASpellWorkerPool {
|
|
||||||
static initClass() {
|
|
||||||
this.prototype.MAX_REQUESTS = Settings.maxRequestsPerWorker
|
|
||||||
this.prototype.MAX_WORKERS = 32
|
|
||||||
this.prototype.MAX_IDLE_TIME = 1000
|
|
||||||
this.prototype.MAX_REQUEST_TIME = 60 * 1000
|
|
||||||
}
|
|
||||||
|
|
||||||
constructor(options) {
|
|
||||||
this.options = options
|
|
||||||
this.PROCESS_POOL = []
|
|
||||||
}
|
|
||||||
|
|
||||||
create(language) {
|
|
||||||
if (this.PROCESS_POOL.length >= this.MAX_WORKERS) {
|
|
||||||
logger.debug(
|
|
||||||
{ maxworkers: this.MAX_WORKERS },
|
|
||||||
'maximum number of workers already running'
|
|
||||||
)
|
|
||||||
return null
|
|
||||||
}
|
|
||||||
const worker = new ASpellWorker(language, this.options)
|
|
||||||
worker.pipe.on('exit', () => {
|
|
||||||
if (worker.killTimer != null) {
|
|
||||||
clearTimeout(worker.killTimer)
|
|
||||||
worker.killTimer = null
|
|
||||||
}
|
|
||||||
if (worker.idleTimer != null) {
|
|
||||||
clearTimeout(worker.idleTimer)
|
|
||||||
worker.idleTimer = null
|
|
||||||
}
|
|
||||||
logger.debug(
|
|
||||||
{ process: worker.pipe.pid, lang: language },
|
|
||||||
'removing aspell worker from pool'
|
|
||||||
)
|
|
||||||
return this.cleanup()
|
|
||||||
})
|
|
||||||
this.PROCESS_POOL.push(worker)
|
|
||||||
metrics.gauge('aspellWorkerPool-size', this.PROCESS_POOL.length)
|
|
||||||
return worker
|
|
||||||
}
|
|
||||||
|
|
||||||
cleanup() {
|
|
||||||
const active = this.PROCESS_POOL.filter(worker => worker.state !== 'killed')
|
|
||||||
this.PROCESS_POOL = active
|
|
||||||
return metrics.gauge('aspellWorkerPool-size', this.PROCESS_POOL.length)
|
|
||||||
}
|
|
||||||
|
|
||||||
check(language, words, timeout, callback) {
|
|
||||||
// look for an existing process in the pool
|
|
||||||
let worker
|
|
||||||
const availableWorker = _.find(
|
|
||||||
this.PROCESS_POOL,
|
|
||||||
cached => cached.language === language && cached.isReady()
|
|
||||||
)
|
|
||||||
if (availableWorker == null) {
|
|
||||||
worker = this.create(language)
|
|
||||||
} else {
|
|
||||||
worker = availableWorker
|
|
||||||
}
|
|
||||||
|
|
||||||
if (worker == null) {
|
|
||||||
// return error if too many workers
|
|
||||||
callback(new OError('no worker available'))
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if (worker.idleTimer != null) {
|
|
||||||
clearTimeout(worker.idleTimer)
|
|
||||||
worker.idleTimer = null
|
|
||||||
}
|
|
||||||
|
|
||||||
worker.killTimer = setTimeout(
|
|
||||||
() => worker.kill('spell check timed out'),
|
|
||||||
timeout || this.MAX_REQUEST_TIME
|
|
||||||
)
|
|
||||||
|
|
||||||
return worker.check(words, (err, output) => {
|
|
||||||
if (worker.killTimer != null) {
|
|
||||||
clearTimeout(worker.killTimer)
|
|
||||||
worker.killTimer = null
|
|
||||||
}
|
|
||||||
callback(err, output)
|
|
||||||
if (err != null) {
|
|
||||||
return
|
|
||||||
} // process has shut down
|
|
||||||
if (worker.count > this.MAX_REQUESTS) {
|
|
||||||
return worker.shutdown(`reached limit of ${this.MAX_REQUESTS} requests`)
|
|
||||||
} else {
|
|
||||||
// queue a shutdown if worker is idle
|
|
||||||
return (worker.idleTimer = setTimeout(function () {
|
|
||||||
worker.shutdown('idle worker')
|
|
||||||
return (worker.idleTimer = null)
|
|
||||||
}, this.MAX_IDLE_TIME))
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
ASpellWorkerPool.initClass()
|
|
||||||
|
|
@ -1,37 +0,0 @@
|
||||||
import request from 'request'
|
|
||||||
import logger from '@overleaf/logger'
|
|
||||||
import settings from '@overleaf/settings'
|
|
||||||
import OError from '@overleaf/o-error'
|
|
||||||
|
|
||||||
export function healthCheck(req, res) {
|
|
||||||
const opts = {
|
|
||||||
url: `http://127.0.0.1:3005/user/${settings.healthCheckUserId}/check`,
|
|
||||||
json: {
|
|
||||||
words: ['helllo'],
|
|
||||||
language: 'en',
|
|
||||||
},
|
|
||||||
timeout: 1000 * 20,
|
|
||||||
}
|
|
||||||
return request.post(opts, function (err, response, body) {
|
|
||||||
if (err != null) {
|
|
||||||
return res.sendStatus(500)
|
|
||||||
}
|
|
||||||
|
|
||||||
const misspellings =
|
|
||||||
body && body.misspellings ? body.misspellings[0] : undefined
|
|
||||||
const numberOfSuggestions =
|
|
||||||
misspellings && misspellings.suggestions
|
|
||||||
? misspellings.suggestions.length
|
|
||||||
: 0
|
|
||||||
|
|
||||||
if (numberOfSuggestions > 10) {
|
|
||||||
logger.debug('health check passed')
|
|
||||||
res.sendStatus(200)
|
|
||||||
} else {
|
|
||||||
logger.err(
|
|
||||||
new OError('health check failed', { body, numberOfSuggestions })
|
|
||||||
)
|
|
||||||
res.sendStatus(500)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
@ -1,28 +0,0 @@
|
||||||
import logger from '@overleaf/logger'
|
|
||||||
import metrics from '@overleaf/metrics'
|
|
||||||
import OError from '@overleaf/o-error'
|
|
||||||
import * as SpellingAPIManager from './SpellingAPIManager.js'
|
|
||||||
|
|
||||||
function extractCheckRequestData(req) {
|
|
||||||
const token = req.params?.user_id
|
|
||||||
const wordCount = req.body?.words?.length
|
|
||||||
return { token, wordCount }
|
|
||||||
}
|
|
||||||
|
|
||||||
export function check(req, res) {
|
|
||||||
metrics.inc('spelling-check', 0.1)
|
|
||||||
const { token, wordCount } = extractCheckRequestData(req)
|
|
||||||
logger.debug({ token, wordCount }, 'running check')
|
|
||||||
SpellingAPIManager.runRequest(token, req.body, (error, result) => {
|
|
||||||
if (error != null) {
|
|
||||||
logger.error(
|
|
||||||
OError.tag(error, 'error processing spelling request', {
|
|
||||||
user_id: token,
|
|
||||||
wordCount,
|
|
||||||
})
|
|
||||||
)
|
|
||||||
return res.sendStatus(500)
|
|
||||||
}
|
|
||||||
res.send(result)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
// TODO: This file was created by bulk-decaffeinate.
|
|
||||||
// Sanity-check the conversion and remove this comment.
|
|
||||||
/*
|
|
||||||
* decaffeinate suggestions:
|
|
||||||
* DS102: Remove unnecessary code created because of implicit returns
|
|
||||||
* DS207: Consider shorter variations of null checks
|
|
||||||
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
|
|
||||||
*/
|
|
||||||
import { callbackify } from 'node:util'
|
|
||||||
import OError from '@overleaf/o-error'
|
|
||||||
import * as ASpell from './ASpell.js'
|
|
||||||
|
|
||||||
// The max number of words checked in a single request
|
|
||||||
const REQUEST_LIMIT = 10000
|
|
||||||
|
|
||||||
export const promises = {}
|
|
||||||
|
|
||||||
promises.runRequest = async (token, request) => {
|
|
||||||
if (!request.words) {
|
|
||||||
throw new OError('malformed JSON')
|
|
||||||
}
|
|
||||||
const lang = request.language || 'en'
|
|
||||||
|
|
||||||
// only the first 10K words are checked
|
|
||||||
const wordSlice = request.words.slice(0, REQUEST_LIMIT)
|
|
||||||
|
|
||||||
const misspellings = await ASpell.promises.checkWords(lang, wordSlice)
|
|
||||||
return { misspellings }
|
|
||||||
}
|
|
||||||
|
|
||||||
export const runRequest = callbackify(promises.runRequest)
|
|
||||||
|
|
@ -1,27 +0,0 @@
|
||||||
import metrics from '@overleaf/metrics'
|
|
||||||
import Settings from '@overleaf/settings'
|
|
||||||
import logger from '@overleaf/logger'
|
|
||||||
import express from 'express'
|
|
||||||
import bodyParser from 'body-parser'
|
|
||||||
import * as SpellingAPIController from './SpellingAPIController.js'
|
|
||||||
import * as HealthCheckController from './HealthCheckController.js'
|
|
||||||
|
|
||||||
logger.initialize('spelling')
|
|
||||||
if (Settings.sentry?.dsn != null) {
|
|
||||||
logger.initializeErrorReporting(Settings.sentry.dsn)
|
|
||||||
}
|
|
||||||
metrics.memory.monitor(logger)
|
|
||||||
metrics.leaked_sockets.monitor(logger)
|
|
||||||
metrics.open_sockets.monitor()
|
|
||||||
|
|
||||||
export const app = express()
|
|
||||||
|
|
||||||
metrics.injectMetricsRoute(app)
|
|
||||||
|
|
||||||
app.use(bodyParser.json({ limit: '2mb' }))
|
|
||||||
app.use(metrics.http.monitor(logger))
|
|
||||||
|
|
||||||
app.post('/user/:user_id/check', SpellingAPIController.check)
|
|
||||||
app.get('/status', (req, res) => res.send({ status: 'spelling api is up' }))
|
|
||||||
|
|
||||||
app.get('/health_check', HealthCheckController.healthCheck)
|
|
||||||
|
|
@ -1,10 +0,0 @@
|
||||||
spelling
|
|
||||||
--data-dirs=cache
|
|
||||||
--dependencies=
|
|
||||||
--docker-repos=us-east1-docker.pkg.dev/overleaf-ops/ol-docker
|
|
||||||
--env-add=
|
|
||||||
--env-pass-through=
|
|
||||||
--esmock-loader=True
|
|
||||||
--node-version=18.20.4
|
|
||||||
--public-repo=False
|
|
||||||
--script-version=4.5.0
|
|
||||||
1
services/spelling/cache/.gitignore
vendored
1
services/spelling/cache/.gitignore
vendored
|
|
@ -1 +0,0 @@
|
||||||
.
|
|
||||||
|
|
@ -1,34 +0,0 @@
|
||||||
const Path = require('path')
|
|
||||||
|
|
||||||
module.exports = {
|
|
||||||
internal: {
|
|
||||||
spelling: {
|
|
||||||
port: 3005,
|
|
||||||
host: process.env.LISTEN_ADDRESS || '127.0.0.1',
|
|
||||||
},
|
|
||||||
},
|
|
||||||
|
|
||||||
maxRequestsPerWorker:
|
|
||||||
parseInt(process.env.MAX_REQUESTS_PER_WORKER, 10) || 100 * 1024,
|
|
||||||
|
|
||||||
cacheDir: Path.resolve('cache'),
|
|
||||||
|
|
||||||
healthCheckUserId: '53c64d2fd68c8d000010bb5f',
|
|
||||||
|
|
||||||
ignoredMisspellings: process.env.IGNORED_MISSPELLINGS
|
|
||||||
? process.env.IGNORED_MISSPELLINGS.split(',')
|
|
||||||
: [
|
|
||||||
'Overleaf',
|
|
||||||
'overleaf',
|
|
||||||
'ShareLaTeX',
|
|
||||||
'sharelatex',
|
|
||||||
'LaTeX',
|
|
||||||
'http',
|
|
||||||
'https',
|
|
||||||
'www',
|
|
||||||
],
|
|
||||||
|
|
||||||
sentry: {
|
|
||||||
dsn: process.env.SENTRY_DSN,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
@ -1,37 +0,0 @@
|
||||||
# This file was auto-generated, do not edit it directly.
|
|
||||||
# Instead run bin/update_build_scripts from
|
|
||||||
# https://github.com/overleaf/internal/
|
|
||||||
|
|
||||||
version: "2.3"
|
|
||||||
|
|
||||||
services:
|
|
||||||
test_unit:
|
|
||||||
image: ci/$PROJECT_NAME:$BRANCH_NAME-$BUILD_NUMBER
|
|
||||||
user: node
|
|
||||||
command: npm run test:unit:_run
|
|
||||||
environment:
|
|
||||||
NODE_ENV: test
|
|
||||||
NODE_OPTIONS: "--unhandled-rejections=strict"
|
|
||||||
|
|
||||||
|
|
||||||
test_acceptance:
|
|
||||||
build: .
|
|
||||||
image: ci/$PROJECT_NAME:$BRANCH_NAME-$BUILD_NUMBER
|
|
||||||
environment:
|
|
||||||
ELASTIC_SEARCH_DSN: es:9200
|
|
||||||
MONGO_HOST: mongo
|
|
||||||
POSTGRES_HOST: postgres
|
|
||||||
MOCHA_GREP: ${MOCHA_GREP}
|
|
||||||
NODE_ENV: test
|
|
||||||
NODE_OPTIONS: "--unhandled-rejections=strict"
|
|
||||||
user: node
|
|
||||||
command: npm run test:acceptance
|
|
||||||
|
|
||||||
|
|
||||||
tar:
|
|
||||||
build: .
|
|
||||||
image: ci/$PROJECT_NAME:$BRANCH_NAME-$BUILD_NUMBER
|
|
||||||
volumes:
|
|
||||||
- ./:/tmp/build/
|
|
||||||
command: tar -czf /tmp/build/build.tar.gz --exclude=build.tar.gz --exclude-vcs .
|
|
||||||
user: root
|
|
||||||
|
|
@ -1,45 +0,0 @@
|
||||||
# This file was auto-generated, do not edit it directly.
|
|
||||||
# Instead run bin/update_build_scripts from
|
|
||||||
# https://github.com/overleaf/internal/
|
|
||||||
|
|
||||||
version: "2.3"
|
|
||||||
|
|
||||||
services:
|
|
||||||
test_unit:
|
|
||||||
build:
|
|
||||||
context: ../..
|
|
||||||
dockerfile: services/spelling/Dockerfile
|
|
||||||
target: base
|
|
||||||
volumes:
|
|
||||||
- .:/overleaf/services/spelling
|
|
||||||
- ../../node_modules:/overleaf/node_modules
|
|
||||||
- ../../libraries:/overleaf/libraries
|
|
||||||
working_dir: /overleaf/services/spelling
|
|
||||||
environment:
|
|
||||||
MOCHA_GREP: ${MOCHA_GREP}
|
|
||||||
NODE_ENV: test
|
|
||||||
NODE_OPTIONS: "--unhandled-rejections=strict"
|
|
||||||
command: npm run --silent test:unit
|
|
||||||
user: node
|
|
||||||
|
|
||||||
test_acceptance:
|
|
||||||
build:
|
|
||||||
context: ../..
|
|
||||||
dockerfile: services/spelling/Dockerfile
|
|
||||||
target: base
|
|
||||||
volumes:
|
|
||||||
- .:/overleaf/services/spelling
|
|
||||||
- ../../node_modules:/overleaf/node_modules
|
|
||||||
- ../../libraries:/overleaf/libraries
|
|
||||||
working_dir: /overleaf/services/spelling
|
|
||||||
environment:
|
|
||||||
ELASTIC_SEARCH_DSN: es:9200
|
|
||||||
MONGO_HOST: mongo
|
|
||||||
POSTGRES_HOST: postgres
|
|
||||||
MOCHA_GREP: ${MOCHA_GREP}
|
|
||||||
LOG_LEVEL: ERROR
|
|
||||||
NODE_ENV: test
|
|
||||||
NODE_OPTIONS: "--unhandled-rejections=strict"
|
|
||||||
user: node
|
|
||||||
command: npm run --silent test:acceptance
|
|
||||||
|
|
||||||
|
|
@ -1,72 +0,0 @@
|
||||||
#!/bin/bash
|
|
||||||
|
|
||||||
set -ex
|
|
||||||
|
|
||||||
# Prefer Debian packages over Ubuntu packages
|
|
||||||
echo 'APT::Default-Release "bookworm";' >/etc/apt/apt.conf.d/default-release
|
|
||||||
|
|
||||||
# The following aspell packages exist in Ubuntu but not Debian:
|
|
||||||
# aspell-af, aspell-id, aspell-nr, aspell-ns, aspell-st, aspell-tn, aspell-ts, aspell-xh
|
|
||||||
echo "deb [arch=amd64] http://archive.ubuntu.com/ubuntu/ focal main universe" > /etc/apt/sources.list.d/focal-amd.list
|
|
||||||
echo "deb [arch=arm64] http://ports.ubuntu.com/ubuntu-ports/ focal main universe" > /etc/apt/sources.list.d/focal-ports-arm.list
|
|
||||||
apt-key adv --no-tty --keyserver keyserver.ubuntu.com --recv-keys 3B4FE6ACC0B21F32
|
|
||||||
|
|
||||||
# aspell is leaking memory in bookworm, we'll obtain it from trixie
|
|
||||||
echo "deb http://deb.debian.org/debian trixie main" > /etc/apt/sources.list.d/trixie.list
|
|
||||||
|
|
||||||
apt-get update
|
|
||||||
|
|
||||||
# aspell is leaking memory in bookworm, we'll obtain it from trixie
|
|
||||||
apt satisfy -y -t trixie 'aspell (>=0.60.8.1)'
|
|
||||||
|
|
||||||
apt-get install -y \
|
|
||||||
aspell-af \
|
|
||||||
aspell-ar \
|
|
||||||
aspell-ar-large \
|
|
||||||
aspell-bg \
|
|
||||||
aspell-br \
|
|
||||||
aspell-ca \
|
|
||||||
aspell-cs \
|
|
||||||
aspell-cy \
|
|
||||||
aspell-da \
|
|
||||||
aspell-de \
|
|
||||||
aspell-de-1901 \
|
|
||||||
aspell-el \
|
|
||||||
aspell-en \
|
|
||||||
aspell-eo \
|
|
||||||
aspell-es \
|
|
||||||
aspell-et \
|
|
||||||
aspell-eu-es \
|
|
||||||
aspell-fa \
|
|
||||||
aspell-fo \
|
|
||||||
aspell-fr \
|
|
||||||
aspell-ga \
|
|
||||||
aspell-gl-minimos \
|
|
||||||
aspell-hr \
|
|
||||||
aspell-hsb \
|
|
||||||
aspell-id \
|
|
||||||
aspell-it \
|
|
||||||
aspell-kk \
|
|
||||||
aspell-ku \
|
|
||||||
aspell-lt \
|
|
||||||
aspell-lv \
|
|
||||||
aspell-nl \
|
|
||||||
aspell-no \
|
|
||||||
aspell-nr \
|
|
||||||
aspell-ns \
|
|
||||||
aspell-pa \
|
|
||||||
aspell-pl \
|
|
||||||
aspell-pt-br \
|
|
||||||
aspell-pt-pt \
|
|
||||||
aspell-ro \
|
|
||||||
aspell-ru \
|
|
||||||
aspell-sk \
|
|
||||||
aspell-sl \
|
|
||||||
aspell-st \
|
|
||||||
aspell-sv \
|
|
||||||
aspell-tl \
|
|
||||||
aspell-tn \
|
|
||||||
aspell-ts \
|
|
||||||
aspell-xh \
|
|
||||||
|
|
||||||
rm -rf /var/lib/apt/lists/*
|
|
||||||
|
|
@ -1,47 +0,0 @@
|
||||||
{
|
|
||||||
"name": "@overleaf/spelling",
|
|
||||||
"description": "A JSON API wrapper around aspell",
|
|
||||||
"private": true,
|
|
||||||
"main": "app.js",
|
|
||||||
"type": "module",
|
|
||||||
"scripts": {
|
|
||||||
"compile:app": "([ -e app/coffee ] && coffee -m $COFFEE_OPTIONS -o app/js -c app/coffee || echo 'No CoffeeScript folder to compile') && ( [ -e app.coffee ] && coffee -m $COFFEE_OPTIONS -c app.coffee || echo 'No CoffeeScript app to compile')",
|
|
||||||
"start": "node app.js",
|
|
||||||
"test:acceptance:_run": "LOG_LEVEL=fatal mocha --loader=esmock --recursive --reporter spec --timeout 15000 --exit $@ test/acceptance/js",
|
|
||||||
"test:acceptance": "npm run test:acceptance:_run -- --grep=$MOCHA_GREP",
|
|
||||||
"test:unit:_run": "LOG_LEVEL=fatal mocha --loader=esmock --recursive --reporter spec $@ test/unit/js",
|
|
||||||
"test:unit": "npm run test:unit:_run -- --grep=$MOCHA_GREP",
|
|
||||||
"compile:unit_tests": "[ ! -e test/unit/coffee ] && echo 'No unit tests to compile' || coffee -o test/unit/js -c test/unit/coffee",
|
|
||||||
"compile:acceptance_tests": "[ ! -e test/acceptance/coffee ] && echo 'No acceptance tests to compile' || coffee -o test/acceptance/js -c test/acceptance/coffee",
|
|
||||||
"compile:all": "npm run compile:app && npm run compile:unit_tests && npm run compile:acceptance_tests && npm run compile:smoke_tests",
|
|
||||||
"nodemon": "node --watch app.js",
|
|
||||||
"compile:smoke_tests": "[ ! -e test/smoke/coffee ] && echo 'No smoke tests to compile' || coffee -o test/smoke/js -c test/smoke/coffee",
|
|
||||||
"lint": "eslint --max-warnings 0 --format unix .",
|
|
||||||
"format": "prettier --list-different $PWD/'**/*.*js'",
|
|
||||||
"format:fix": "prettier --write $PWD/'**/*.*js'",
|
|
||||||
"lint:fix": "eslint --fix .",
|
|
||||||
"types:check": "tsc --noEmit"
|
|
||||||
},
|
|
||||||
"version": "0.1.4",
|
|
||||||
"dependencies": {
|
|
||||||
"@overleaf/logger": "*",
|
|
||||||
"@overleaf/metrics": "*",
|
|
||||||
"@overleaf/o-error": "*",
|
|
||||||
"@overleaf/settings": "*",
|
|
||||||
"async": "^3.2.5",
|
|
||||||
"body-parser": "^1.20.3",
|
|
||||||
"bunyan": "^1.8.15",
|
|
||||||
"express": "^4.21.0",
|
|
||||||
"lru-cache": "^5.1.1",
|
|
||||||
"request": "^2.88.2",
|
|
||||||
"underscore": "1.13.1"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"chai": "^4.3.6",
|
|
||||||
"chai-as-promised": "^7.1.1",
|
|
||||||
"esmock": "^2.6.3",
|
|
||||||
"mocha": "^10.2.0",
|
|
||||||
"sinon": "^9.2.4",
|
|
||||||
"typescript": "^5.0.4"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,149 +0,0 @@
|
||||||
import { expect } from 'chai'
|
|
||||||
import * as request from './helpers/request.js'
|
|
||||||
|
|
||||||
const USER_ID = 101
|
|
||||||
|
|
||||||
const checkWord = (words, language) =>
|
|
||||||
request.post({
|
|
||||||
url: `/user/${USER_ID}/check`,
|
|
||||||
body: JSON.stringify({
|
|
||||||
words,
|
|
||||||
language,
|
|
||||||
}),
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('checking words', function () {
|
|
||||||
let response
|
|
||||||
|
|
||||||
describe('on successful response', function () {
|
|
||||||
beforeEach(async function () {
|
|
||||||
response = await checkWord(['anather'])
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return status 200', async function () {
|
|
||||||
expect(response.statusCode).to.equal(200)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return the list of misspellings', async function () {
|
|
||||||
const body = JSON.parse(response.body)
|
|
||||||
expect(body).to.deep.equal({
|
|
||||||
misspellings: [
|
|
||||||
{
|
|
||||||
index: 0,
|
|
||||||
suggestions: [
|
|
||||||
'anther',
|
|
||||||
'another',
|
|
||||||
'anthers',
|
|
||||||
'panther',
|
|
||||||
'anathema',
|
|
||||||
'anthem',
|
|
||||||
'nether',
|
|
||||||
"anther's",
|
|
||||||
'ante',
|
|
||||||
'neither',
|
|
||||||
'norther',
|
|
||||||
'ether',
|
|
||||||
'other',
|
|
||||||
],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('when multiple words are submitted', function () {
|
|
||||||
beforeEach(async function () {
|
|
||||||
response = await checkWord(['anather', 'anather', 'theorie'])
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return the misspellings for all the words', async function () {
|
|
||||||
const body = JSON.parse(response.body)
|
|
||||||
expect(body.misspellings.length).to.equal(3)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should have misspelling suggestions with consecutive indexes', async function () {
|
|
||||||
const body = JSON.parse(response.body)
|
|
||||||
const indexes = body.misspellings.map(mspl => mspl.index)
|
|
||||||
expect(indexes).to.deep.equal([0, 1, 2])
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return identical suggestions for the same entry', async function () {
|
|
||||||
const body = JSON.parse(response.body)
|
|
||||||
expect(body.misspellings[0].suggestions).to.deep.equal(
|
|
||||||
body.misspellings[1].suggestions
|
|
||||||
)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('when a very long list of words if submitted', function () {
|
|
||||||
beforeEach(async function () {
|
|
||||||
const words = []
|
|
||||||
for (let i = 0; i <= 20000; i++) {
|
|
||||||
words.push('anather')
|
|
||||||
}
|
|
||||||
response = await checkWord(words)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return misspellings for the first 10K results only', async function () {
|
|
||||||
const body = JSON.parse(response.body)
|
|
||||||
expect(body.misspellings.length).to.equal(10000)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should have misspelling suggestions with consecutive indexes', async function () {
|
|
||||||
const body = JSON.parse(response.body)
|
|
||||||
const indexList = body.misspellings.map(mspl => mspl.index)
|
|
||||||
expect(indexList.length).to.equal(10000) // avoid testing over an incorrect array
|
|
||||||
for (let i = 0; i < indexList.length - 1; i++) {
|
|
||||||
expect(indexList[i] + 1).to.equal(indexList[i + 1])
|
|
||||||
}
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('when a very long list of words with utf8 responses', function () {
|
|
||||||
beforeEach(async function () {
|
|
||||||
const words = []
|
|
||||||
for (let i = 0; i <= 20000; i++) {
|
|
||||||
words.push('anéther')
|
|
||||||
}
|
|
||||||
response = await checkWord(words, 'bg') // use Bulgarian to generate utf8 response
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return misspellings for the first 10K results only', async function () {
|
|
||||||
const body = JSON.parse(response.body)
|
|
||||||
expect(body.misspellings.length).to.equal(10000)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should have misspelling suggestions with consecutive indexes', async function () {
|
|
||||||
const body = JSON.parse(response.body)
|
|
||||||
const indexList = body.misspellings.map(mspl => mspl.index)
|
|
||||||
expect(indexList.length).to.equal(10000) // avoid testing over an incorrect array
|
|
||||||
for (let i = 0; i < indexList.length - 1; i++) {
|
|
||||||
expect(indexList[i] + 1).to.equal(indexList[i + 1])
|
|
||||||
}
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('when multiple words with utf8 are submitted', function () {
|
|
||||||
beforeEach(async function () {
|
|
||||||
response = await checkWord(['mneá', 'meniésn', 'meônoi', 'mneá'], 'pt_BR')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return the misspellings for all the words', async function () {
|
|
||||||
const body = JSON.parse(response.body)
|
|
||||||
expect(body.misspellings.length).to.equal(4)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should have misspelling suggestions with consecutive indexes', async function () {
|
|
||||||
const body = JSON.parse(response.body)
|
|
||||||
const indexes = body.misspellings.map(mspl => mspl.index)
|
|
||||||
expect(indexes).to.deep.equal([0, 1, 2, 3])
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return identical suggestions for the same entry', async function () {
|
|
||||||
const body = JSON.parse(response.body)
|
|
||||||
expect(body.misspellings[0].suggestions).to.deep.equal(
|
|
||||||
body.misspellings[3].suggestions
|
|
||||||
)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
@ -1,9 +0,0 @@
|
||||||
import { expect } from 'chai'
|
|
||||||
import * as request from './helpers/request.js'
|
|
||||||
|
|
||||||
describe('/health_check', function () {
|
|
||||||
it('should return 200', async function () {
|
|
||||||
const response = await request.get('/health_check')
|
|
||||||
expect(response.statusCode).to.equal(200)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
@ -1,6 +0,0 @@
|
||||||
import { app } from '../../../app/js/server.js'
|
|
||||||
import { PORT } from './helpers/request.js'
|
|
||||||
|
|
||||||
before(function (done) {
|
|
||||||
return app.listen(PORT, '127.0.0.1', done)
|
|
||||||
})
|
|
||||||
|
|
@ -1,9 +0,0 @@
|
||||||
import { expect } from 'chai'
|
|
||||||
import * as request from './helpers/request.js'
|
|
||||||
|
|
||||||
describe('/status', function () {
|
|
||||||
it('should return 200', async function () {
|
|
||||||
const response = await request.get('/health_check')
|
|
||||||
expect(response.statusCode).to.equal(200)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
@ -1,18 +0,0 @@
|
||||||
import { promisify } from 'node:util'
|
|
||||||
import Request from 'request'
|
|
||||||
|
|
||||||
export const PORT = 3005
|
|
||||||
|
|
||||||
const BASE_URL = `http://${process.env.HTTP_TEST_HOST || '127.0.0.1'}:${PORT}`
|
|
||||||
|
|
||||||
const request = Request.defaults({
|
|
||||||
baseUrl: BASE_URL,
|
|
||||||
headers: {
|
|
||||||
'Content-Type': 'application/json',
|
|
||||||
},
|
|
||||||
followRedirect: false,
|
|
||||||
})
|
|
||||||
|
|
||||||
export const get = promisify(request.get)
|
|
||||||
export const post = promisify(request.post)
|
|
||||||
export const del = promisify(request.del)
|
|
||||||
|
|
@ -1,4 +0,0 @@
|
||||||
import chai from 'chai'
|
|
||||||
|
|
||||||
// Chai configuration
|
|
||||||
chai.should()
|
|
||||||
|
|
@ -1,162 +0,0 @@
|
||||||
/* eslint-disable */
|
|
||||||
// TODO: This file was created by bulk-decaffeinate.
|
|
||||||
// Sanity-check the conversion and remove this comment.
|
|
||||||
/*
|
|
||||||
* decaffeinate suggestions:
|
|
||||||
* DS101: Remove unnecessary use of Array.from
|
|
||||||
* DS102: Remove unnecessary code created because of implicit returns
|
|
||||||
* DS104: Avoid inline assignments
|
|
||||||
* DS202: Simplify dynamic range loops
|
|
||||||
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
|
|
||||||
*/
|
|
||||||
// N requests in parallel
|
|
||||||
// send P correct words and Q incorrect words
|
|
||||||
// generate incorrect words by qq+random
|
|
||||||
|
|
||||||
import fs from 'node:fs'
|
|
||||||
import async from 'async'
|
|
||||||
import request from 'request'
|
|
||||||
|
|
||||||
// created with
|
|
||||||
// aspell -d en dump master | aspell -l en expand | shuf -n 150000 > words.txt
|
|
||||||
const WORDS = 'words.txt'
|
|
||||||
const wordlist = fs
|
|
||||||
.readFileSync(WORDS)
|
|
||||||
.toString()
|
|
||||||
.split('\n')
|
|
||||||
.filter(w => w.match(/^[a-z]+$/))
|
|
||||||
|
|
||||||
const generateCorrectWords = function (n) {
|
|
||||||
const words = []
|
|
||||||
const N = Math.random() > 0.5 ? wordlist.length : 10
|
|
||||||
for (
|
|
||||||
let i = 1, end = n, asc = 1 <= end;
|
|
||||||
asc ? i <= end : i >= end;
|
|
||||||
asc ? i++ : i--
|
|
||||||
) {
|
|
||||||
const j = Math.floor(N * Math.random())
|
|
||||||
words.push(wordlist[j])
|
|
||||||
}
|
|
||||||
return words
|
|
||||||
}
|
|
||||||
|
|
||||||
const generateIncorrectWords = function (n) {
|
|
||||||
const words = []
|
|
||||||
const N = wordlist.length
|
|
||||||
for (
|
|
||||||
let i = 1, end = n, asc = 1 <= end;
|
|
||||||
asc ? i <= end : i >= end;
|
|
||||||
asc ? i++ : i--
|
|
||||||
) {
|
|
||||||
const j = Math.floor(N * Math.random())
|
|
||||||
words.push(`qzxq${wordlist[j]}`)
|
|
||||||
}
|
|
||||||
return words
|
|
||||||
}
|
|
||||||
|
|
||||||
const makeRequest = function (correctWords, incorrectWords, callback) {
|
|
||||||
let i, j, w
|
|
||||||
let i1
|
|
||||||
let j1
|
|
||||||
const correctSet = generateCorrectWords(correctWords)
|
|
||||||
const incorrectSet = generateIncorrectWords(incorrectWords)
|
|
||||||
correctSet.push('constructor')
|
|
||||||
incorrectSet.push('qzxqfoofoofoo')
|
|
||||||
const full = correctSet.concat(incorrectSet)
|
|
||||||
const bad = []
|
|
||||||
for (j = 0, i = j; j < correctSet.length; j++, i = j) {
|
|
||||||
w = correctSet[i]
|
|
||||||
bad[i] = false
|
|
||||||
}
|
|
||||||
for (i1 = 0, i = i1; i1 < incorrectSet.length; i1++, i = i1) {
|
|
||||||
w = incorrectSet[i]
|
|
||||||
bad[i + correctSet.length] = true
|
|
||||||
}
|
|
||||||
const k = full.length
|
|
||||||
full.forEach(function (e, i) {
|
|
||||||
let ref
|
|
||||||
j = Math.floor(k * Math.random())
|
|
||||||
;[full[i], full[j]] = Array.from([full[j], full[i]])
|
|
||||||
return ([bad[i], bad[j]] = Array.from((ref = [bad[j], bad[i]]))), ref
|
|
||||||
})
|
|
||||||
const expected = []
|
|
||||||
for (j1 = 0, i = j1; j1 < bad.length; j1++, i = j1) {
|
|
||||||
const tf = bad[i]
|
|
||||||
if (tf) {
|
|
||||||
expected.push({ index: i, word: full[i] })
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return request.post(
|
|
||||||
'http://127.0.0.1:3005/user/1/check',
|
|
||||||
{ json: true, body: { words: full } },
|
|
||||||
function (err, req, body) {
|
|
||||||
let m
|
|
||||||
const { misspellings } = body
|
|
||||||
console.log(JSON.stringify({ full, misspellings }))
|
|
||||||
if (expected.length !== misspellings.length) {
|
|
||||||
let asc, end
|
|
||||||
console.log(
|
|
||||||
'ERROR: length mismatch',
|
|
||||||
expected.length,
|
|
||||||
misspellings.length
|
|
||||||
)
|
|
||||||
console.log(full, bad)
|
|
||||||
console.log('expected', expected, 'mispellings', misspellings)
|
|
||||||
for (
|
|
||||||
i = 0,
|
|
||||||
end = Math.max(expected.length, misspellings.length) - 1,
|
|
||||||
asc = 0 <= end;
|
|
||||||
asc ? i <= end : i >= end;
|
|
||||||
asc ? i++ : i--
|
|
||||||
) {
|
|
||||||
if (expected[i].index !== misspellings[i].index) {
|
|
||||||
console.log(
|
|
||||||
'ERROR',
|
|
||||||
i,
|
|
||||||
expected[i],
|
|
||||||
misspellings[i],
|
|
||||||
full[misspellings[i].index]
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
for (m of Array.from(misspellings)) {
|
|
||||||
console.log(full[m.index], '=>', m)
|
|
||||||
}
|
|
||||||
process.exit()
|
|
||||||
callback('error')
|
|
||||||
} else {
|
|
||||||
for (i = 0; i < body.misspellings.length; i++) {
|
|
||||||
m = body.misspellings[i]
|
|
||||||
if (m.index !== expected[i].index) {
|
|
||||||
console.log('ERROR AT RESULT', i, m, expected[i])
|
|
||||||
process.exit()
|
|
||||||
callback('error')
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return callback(null, full)
|
|
||||||
}
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
const q = async.queue(
|
|
||||||
(task, callback) =>
|
|
||||||
setTimeout(
|
|
||||||
() => makeRequest(task.correct, task.incorrect, callback),
|
|
||||||
Math.random() * 100
|
|
||||||
),
|
|
||||||
|
|
||||||
3
|
|
||||||
)
|
|
||||||
|
|
||||||
q.drain(() => console.log('all items have been processed'))
|
|
||||||
|
|
||||||
for (let i = 0; i <= 1000; i++) {
|
|
||||||
q.push({
|
|
||||||
correct: Math.floor(30 * Math.random()) + 1,
|
|
||||||
incorrect: Math.floor(3 * Math.random()),
|
|
||||||
})
|
|
||||||
}
|
|
||||||
// if Math.random() < 0.1
|
|
||||||
// else
|
|
||||||
// q.push({correct: Math.floor(100*Math.random()) + 1, incorrect: Math.floor(3*Math.random())})
|
|
||||||
File diff suppressed because it is too large
Load diff
|
|
@ -1,139 +0,0 @@
|
||||||
/* eslint-disable
|
|
||||||
no-undef
|
|
||||||
*/
|
|
||||||
// TODO: This file was created by bulk-decaffeinate.
|
|
||||||
// Sanity-check the conversion and remove this comment.
|
|
||||||
/*
|
|
||||||
* decaffeinate suggestions:
|
|
||||||
* DS102: Remove unnecessary code created because of implicit returns
|
|
||||||
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
|
|
||||||
*/
|
|
||||||
import { expect, assert } from 'chai'
|
|
||||||
import esmock from 'esmock'
|
|
||||||
|
|
||||||
describe('ASpell', function () {
|
|
||||||
beforeEach(async function () {
|
|
||||||
this.ASpell = await esmock('../../../app/js/ASpell', {
|
|
||||||
'@overleaf/metrics': {
|
|
||||||
gauge() {},
|
|
||||||
inc() {},
|
|
||||||
},
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('a correctly spelled word', function () {
|
|
||||||
beforeEach(function (done) {
|
|
||||||
return this.ASpell.checkWords('en', ['word'], (error, result) => {
|
|
||||||
if (error) return done(error)
|
|
||||||
this.result = result
|
|
||||||
return done()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
return it('should not correct the word', function () {
|
|
||||||
return this.result.length.should.equal(0)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('a misspelled word', function () {
|
|
||||||
beforeEach(function (done) {
|
|
||||||
return this.ASpell.checkWords('en', ['bussines'], (error, result) => {
|
|
||||||
if (error) return done(error)
|
|
||||||
this.result = result
|
|
||||||
return done()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
return it('should correct the word', function () {
|
|
||||||
this.result.length.should.equal(1)
|
|
||||||
return this.result[0].suggestions.indexOf('business').should.not.equal(-1)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('multiple words', function () {
|
|
||||||
beforeEach(function (done) {
|
|
||||||
return this.ASpell.checkWords(
|
|
||||||
'en',
|
|
||||||
['bussines', 'word', 'neccesary'],
|
|
||||||
(error, result) => {
|
|
||||||
if (error) return done(error)
|
|
||||||
this.result = result
|
|
||||||
return done()
|
|
||||||
}
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
return it('should correct the incorrect words', function () {
|
|
||||||
this.result[0].index.should.equal(0)
|
|
||||||
this.result[0].suggestions.indexOf('business').should.not.equal(-1)
|
|
||||||
this.result[1].index.should.equal(2)
|
|
||||||
return this.result[1].suggestions
|
|
||||||
.indexOf('necessary')
|
|
||||||
.should.not.equal(-1)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('without a valid language', function () {
|
|
||||||
beforeEach(function (done) {
|
|
||||||
return this.ASpell.checkWords('notALang', ['banana'], (error, result) => {
|
|
||||||
this.error = error
|
|
||||||
this.result = result
|
|
||||||
return done()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
return it('should return an error', function () {
|
|
||||||
return expect(this.error).to.exist
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('when there are no suggestions', function () {
|
|
||||||
beforeEach(function (done) {
|
|
||||||
return this.ASpell.checkWords(
|
|
||||||
'en',
|
|
||||||
['asdkfjalkdjfadhfkajsdhfashdfjhadflkjadhflajsd'],
|
|
||||||
(error, result) => {
|
|
||||||
this.error = error
|
|
||||||
this.result = result
|
|
||||||
return done()
|
|
||||||
}
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
return it('should return a blank array', function () {
|
|
||||||
this.result.length.should.equal(1)
|
|
||||||
return assert.deepEqual(this.result[0].suggestions, [])
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
return describe('when the request times out', function () {
|
|
||||||
beforeEach(function (done) {
|
|
||||||
const words = __range__(0, 1000, true).map(i => 'abcdefg' + i)
|
|
||||||
this.ASpell.setTimeout(1)
|
|
||||||
this.start = Date.now()
|
|
||||||
return this.ASpell.checkWords('en', words, (error, result) => {
|
|
||||||
expect(error).to.exist
|
|
||||||
this.result = result
|
|
||||||
return done()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
// Note that this test fails on OS X, due to differing pipe behaviour
|
|
||||||
// on killing the child process. It can be tested successfully on Travis
|
|
||||||
// or the CI server.
|
|
||||||
return it('should return in reasonable time', function () {
|
|
||||||
const delta = Date.now() - this.start
|
|
||||||
return delta.should.be.below(1000)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
function __range__(left, right, inclusive) {
|
|
||||||
const range = []
|
|
||||||
const ascending = left < right
|
|
||||||
const end = !inclusive ? right : ascending ? right + 1 : right - 1
|
|
||||||
for (let i = left; ascending ? i < end : i > end; ascending ? i++ : i--) {
|
|
||||||
range.push(i)
|
|
||||||
}
|
|
||||||
return range
|
|
||||||
}
|
|
||||||
|
|
@ -1,101 +0,0 @@
|
||||||
import sinon from 'sinon'
|
|
||||||
import { expect } from 'chai'
|
|
||||||
import esmock from 'esmock'
|
|
||||||
import EventEmitter from 'node:events'
|
|
||||||
|
|
||||||
describe('ASpellWorker', function () {
|
|
||||||
beforeEach(async function () {
|
|
||||||
this.pipe = {
|
|
||||||
stdout: new EventEmitter(),
|
|
||||||
stderr: { on: sinon.stub() },
|
|
||||||
stdin: { on: sinon.stub() },
|
|
||||||
on: sinon.stub(),
|
|
||||||
pid: 12345,
|
|
||||||
}
|
|
||||||
this.pipe.stdout.setEncoding = sinon.stub()
|
|
||||||
this.child_process = {
|
|
||||||
spawn: sinon.stub().returns(this.pipe),
|
|
||||||
}
|
|
||||||
const { ASpellWorker } = await esmock('../../../app/js/ASpellWorker', {
|
|
||||||
'@overleaf/metrics': {
|
|
||||||
gauge() {},
|
|
||||||
inc() {},
|
|
||||||
},
|
|
||||||
child_process: this.child_process,
|
|
||||||
})
|
|
||||||
this.ASpellWorker = ASpellWorker
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('creating a worker', function () {
|
|
||||||
beforeEach(function () {
|
|
||||||
this.worker = new this.ASpellWorker('en')
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('with normal aspell output', function () {
|
|
||||||
beforeEach(function () {
|
|
||||||
this.callback = this.worker.callback = sinon.stub()
|
|
||||||
this.pipe.stdout.emit('data', '& hello\n')
|
|
||||||
this.pipe.stdout.emit('data', '& world\n')
|
|
||||||
this.pipe.stdout.emit('data', 'en\n')
|
|
||||||
this.pipe.stdout.emit('data', '& goodbye')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should call the callback', function () {
|
|
||||||
expect(this.callback.called).to.equal(true)
|
|
||||||
expect(
|
|
||||||
this.callback.calledWith(null, '& hello\n& world\nen\n')
|
|
||||||
).to.equal(true)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('with the aspell end marker split across chunks', function () {
|
|
||||||
beforeEach(function () {
|
|
||||||
this.callback = this.worker.callback = sinon.stub()
|
|
||||||
this.pipe.stdout.emit('data', '& hello\n')
|
|
||||||
this.pipe.stdout.emit('data', '& world\ne')
|
|
||||||
this.pipe.stdout.emit('data', 'n\n')
|
|
||||||
this.pipe.stdout.emit('data', '& goodbye')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should call the callback', function () {
|
|
||||||
expect(this.callback.called).to.equal(true)
|
|
||||||
expect(
|
|
||||||
this.callback.calledWith(null, '& hello\n& world\nen\n')
|
|
||||||
).to.equal(true)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('with the aspell end marker newline split across chunks', function () {
|
|
||||||
beforeEach(function () {
|
|
||||||
this.callback = this.worker.callback = sinon.stub()
|
|
||||||
this.pipe.stdout.emit('data', '& hello\n')
|
|
||||||
this.pipe.stdout.emit('data', '& world\n')
|
|
||||||
this.pipe.stdout.emit('data', 'en')
|
|
||||||
this.pipe.stdout.emit('data', '\n& goodbye')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should call the callback', function () {
|
|
||||||
expect(this.callback.called).to.equal(true)
|
|
||||||
expect(this.callback.calledWith(null, '& hello\n& world\nen')).to.equal(
|
|
||||||
true
|
|
||||||
)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('with everything split across chunks', function () {
|
|
||||||
beforeEach(function () {
|
|
||||||
this.callback = this.worker.callback = sinon.stub()
|
|
||||||
'& hello\n& world\nen\n& goodbye'.split('').forEach(x => {
|
|
||||||
this.pipe.stdout.emit('data', x)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should call the callback', function () {
|
|
||||||
expect(this.callback.called).to.equal(true)
|
|
||||||
expect(this.callback.calledWith(null, '& hello\n& world\nen')).to.equal(
|
|
||||||
true
|
|
||||||
)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
@ -1,114 +0,0 @@
|
||||||
/* eslint-disable
|
|
||||||
handle-callback-err
|
|
||||||
*/
|
|
||||||
import sinon from 'sinon'
|
|
||||||
import { expect } from 'chai'
|
|
||||||
import esmock from 'esmock'
|
|
||||||
|
|
||||||
const MODULE_PATH = '../../../app/js/SpellingAPIManager'
|
|
||||||
|
|
||||||
const promiseStub = val => new Promise(resolve => resolve(val))
|
|
||||||
|
|
||||||
describe('SpellingAPIManager', function () {
|
|
||||||
beforeEach(async function () {
|
|
||||||
this.token = 'user-id-123'
|
|
||||||
this.nonLearnedWords = ['some', 'words', 'htat', 'are', 'speled', 'rong']
|
|
||||||
this.allWords = this.nonLearnedWords
|
|
||||||
this.misspellings = [
|
|
||||||
{ index: 2, suggestions: ['that'] },
|
|
||||||
{ index: 4, suggestions: ['spelled'] },
|
|
||||||
{ index: 5, suggestions: ['wrong', 'ring'] },
|
|
||||||
]
|
|
||||||
this.misspellingsWithoutLearnedWords = this.misspellings.slice(0, 3)
|
|
||||||
this.ASpell = {
|
|
||||||
checkWords: sinon.stub().yields(null, this.misspellings),
|
|
||||||
promises: {
|
|
||||||
checkWords: sinon.stub().returns(promiseStub(this.misspellings)),
|
|
||||||
},
|
|
||||||
}
|
|
||||||
this.SpellingAPIManager = await esmock(MODULE_PATH, {
|
|
||||||
'../../../app/js/ASpell.js': this.ASpell,
|
|
||||||
'@overleaf/settings': { ignoredMisspellings: ['Overleaf'] },
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('runRequest', function () {
|
|
||||||
describe('with sensible JSON', function () {
|
|
||||||
beforeEach(function (done) {
|
|
||||||
this.SpellingAPIManager.runRequest(
|
|
||||||
this.token,
|
|
||||||
{ words: this.allWords },
|
|
||||||
(error, result) => {
|
|
||||||
if (error) return done(error)
|
|
||||||
this.result = result
|
|
||||||
done()
|
|
||||||
}
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return the words that are spelled incorrectly and not learned', function () {
|
|
||||||
expect(this.result.misspellings).to.deep.equal(
|
|
||||||
this.misspellingsWithoutLearnedWords
|
|
||||||
)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('with a missing words array', function () {
|
|
||||||
beforeEach(function (done) {
|
|
||||||
this.SpellingAPIManager.runRequest(this.token, {}, (error, result) => {
|
|
||||||
this.error = error
|
|
||||||
this.result = result
|
|
||||||
done()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return an error', function () {
|
|
||||||
expect(this.error).to.exist
|
|
||||||
expect(this.error).to.be.instanceof(Error)
|
|
||||||
expect(this.error.message).to.equal('malformed JSON')
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('without a language', function () {
|
|
||||||
beforeEach(function (done) {
|
|
||||||
this.SpellingAPIManager.runRequest(
|
|
||||||
this.token,
|
|
||||||
{ words: this.allWords },
|
|
||||||
(error, result) => {
|
|
||||||
if (error) return done(error)
|
|
||||||
this.result = result
|
|
||||||
done()
|
|
||||||
}
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should use en as the default', function () {
|
|
||||||
this.ASpell.promises.checkWords.calledWith('en').should.equal(true)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('with a language', function () {
|
|
||||||
beforeEach(function (done) {
|
|
||||||
this.language = 'fr'
|
|
||||||
this.SpellingAPIManager.runRequest(
|
|
||||||
this.token,
|
|
||||||
{
|
|
||||||
words: this.allWords,
|
|
||||||
language: this.language,
|
|
||||||
},
|
|
||||||
(error, result) => {
|
|
||||||
if (error) return done(error)
|
|
||||||
this.result = result
|
|
||||||
done()
|
|
||||||
}
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should use the language', function () {
|
|
||||||
this.ASpell.promises.checkWords
|
|
||||||
.calledWith(this.language)
|
|
||||||
.should.equal(true)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
@ -1,12 +0,0 @@
|
||||||
{
|
|
||||||
"extends": "../../tsconfig.backend.json",
|
|
||||||
"include": [
|
|
||||||
"app.js",
|
|
||||||
"app/js/**/*",
|
|
||||||
"benchmarks/**/*",
|
|
||||||
"config/**/*",
|
|
||||||
"scripts/**/*",
|
|
||||||
"test/**/*",
|
|
||||||
"types"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
Loading…
Reference in a new issue