mirror of
https://github.com/overleaf/overleaf.git
synced 2024-11-21 20:47:08 -05:00
merge multiple repositories into an existing monorepo
- merged using: 'monorepo_add.sh services-chat:services/chat' - see https://github.com/shopsys/monorepo-tools
This commit is contained in:
Jakob Ackermann
commit
baf613bc42
35 changed files with 9063 additions and 0 deletions
7
services/chat/.dockerignore
Normal file
7
services/chat/.dockerignore
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
node_modules/*
|
||||||
|
gitrev
|
||||||
|
.git
|
||||||
|
.gitignore
|
||||||
|
.npm
|
||||||
|
.nvmrc
|
||||||
|
nodemon.json
|
||||||
86
services/chat/.eslintrc
Normal file
86
services/chat/.eslintrc
Normal file
|
|
@ -0,0 +1,86 @@
|
||||||
|
// this file was auto-generated, do not edit it directly.
|
||||||
|
// instead run bin/update_build_scripts from
|
||||||
|
// https://github.com/sharelatex/sharelatex-dev-environment
|
||||||
|
{
|
||||||
|
"extends": [
|
||||||
|
"eslint:recommended",
|
||||||
|
"standard",
|
||||||
|
"prettier"
|
||||||
|
],
|
||||||
|
"parserOptions": {
|
||||||
|
"ecmaVersion": 2018
|
||||||
|
},
|
||||||
|
"plugins": [
|
||||||
|
"mocha",
|
||||||
|
"chai-expect",
|
||||||
|
"chai-friendly"
|
||||||
|
],
|
||||||
|
"env": {
|
||||||
|
"node": true,
|
||||||
|
"mocha": true
|
||||||
|
},
|
||||||
|
"rules": {
|
||||||
|
// TODO(das7pad): remove overrides after fixing all the violations manually (https://github.com/overleaf/issues/issues/3882#issuecomment-878999671)
|
||||||
|
// START of temporary overrides
|
||||||
|
"array-callback-return": "off",
|
||||||
|
"no-dupe-else-if": "off",
|
||||||
|
"no-var": "off",
|
||||||
|
"no-empty": "off",
|
||||||
|
"node/handle-callback-err": "off",
|
||||||
|
"no-loss-of-precision": "off",
|
||||||
|
"node/no-callback-literal": "off",
|
||||||
|
"node/no-path-concat": "off",
|
||||||
|
"prefer-regex-literals": "off",
|
||||||
|
// END of temporary overrides
|
||||||
|
|
||||||
|
// Swap the no-unused-expressions rule with a more chai-friendly one
|
||||||
|
"no-unused-expressions": 0,
|
||||||
|
"chai-friendly/no-unused-expressions": "error",
|
||||||
|
|
||||||
|
// Do not allow importing of implicit dependencies.
|
||||||
|
"import/no-extraneous-dependencies": "error"
|
||||||
|
},
|
||||||
|
"overrides": [
|
||||||
|
{
|
||||||
|
// Test specific rules
|
||||||
|
"files": ["test/**/*.js"],
|
||||||
|
"globals": {
|
||||||
|
"expect": true
|
||||||
|
},
|
||||||
|
"rules": {
|
||||||
|
// mocha-specific rules
|
||||||
|
"mocha/handle-done-callback": "error",
|
||||||
|
"mocha/no-exclusive-tests": "error",
|
||||||
|
"mocha/no-global-tests": "error",
|
||||||
|
"mocha/no-identical-title": "error",
|
||||||
|
"mocha/no-nested-tests": "error",
|
||||||
|
"mocha/no-pending-tests": "error",
|
||||||
|
"mocha/no-skipped-tests": "error",
|
||||||
|
"mocha/no-mocha-arrows": "error",
|
||||||
|
|
||||||
|
// chai-specific rules
|
||||||
|
"chai-expect/missing-assertion": "error",
|
||||||
|
"chai-expect/terminating-properties": "error",
|
||||||
|
|
||||||
|
// prefer-arrow-callback applies to all callbacks, not just ones in mocha tests.
|
||||||
|
// we don't enforce this at the top-level - just in tests to manage `this` scope
|
||||||
|
// based on mocha's context mechanism
|
||||||
|
"mocha/prefer-arrow-callback": "error"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
// Backend specific rules
|
||||||
|
"files": ["app/**/*.js", "app.js", "index.js"],
|
||||||
|
"rules": {
|
||||||
|
// don't allow console.log in backend code
|
||||||
|
"no-console": "error",
|
||||||
|
|
||||||
|
// Do not allow importing of implicit dependencies.
|
||||||
|
"import/no-extraneous-dependencies": ["error", {
|
||||||
|
// Do not allow importing of devDependencies.
|
||||||
|
"devDependencies": false
|
||||||
|
}]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
38
services/chat/.github/ISSUE_TEMPLATE.md
vendored
Normal file
38
services/chat/.github/ISSUE_TEMPLATE.md
vendored
Normal file
|
|
@ -0,0 +1,38 @@
|
||||||
|
<!-- BUG REPORT TEMPLATE -->
|
||||||
|
|
||||||
|
## Steps to Reproduce
|
||||||
|
<!-- Describe the steps leading up to when / where you found the bug. -->
|
||||||
|
<!-- Screenshots may be helpful here. -->
|
||||||
|
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
3.
|
||||||
|
|
||||||
|
## Expected Behaviour
|
||||||
|
<!-- What should have happened when you completed the steps above? -->
|
||||||
|
|
||||||
|
## Observed Behaviour
|
||||||
|
<!-- What actually happened when you completed the steps above? -->
|
||||||
|
<!-- Screenshots may be helpful here. -->
|
||||||
|
|
||||||
|
## Context
|
||||||
|
<!-- How has this issue affected you? What were you trying to accomplish? -->
|
||||||
|
|
||||||
|
## Technical Info
|
||||||
|
<!-- Provide any technical details that may be applicable (or N/A if not applicable). -->
|
||||||
|
|
||||||
|
* URL:
|
||||||
|
* Browser Name and version:
|
||||||
|
* Operating System and version (desktop or mobile):
|
||||||
|
* Signed in as:
|
||||||
|
* Project and/or file:
|
||||||
|
|
||||||
|
## Analysis
|
||||||
|
<!--- Optionally, document investigation of / suggest a fix for the bug, e.g. 'comes from this line / commit' -->
|
||||||
|
|
||||||
|
## Who Needs to Know?
|
||||||
|
<!-- If you want to bring this to the attention of particular people, @-mention them below. -->
|
||||||
|
<!-- If a user reported this bug and should be notified when it is fixed, provide the Front conversation link. -->
|
||||||
|
|
||||||
|
-
|
||||||
|
-
|
||||||
46
services/chat/.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
46
services/chat/.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
|
@ -0,0 +1,46 @@
|
||||||
|
|
||||||
|
<!-- Please review https://github.com/overleaf/developer-manual/blob/master/code/pr-guidance.md for guidance on what is expected in each section. -->
|
||||||
|
|
||||||
|
### Description
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#### Screenshots
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#### Related Issues / PRs
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Review
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#### Potential Impact
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#### Manual Testing Performed
|
||||||
|
|
||||||
|
- [ ]
|
||||||
|
- [ ]
|
||||||
|
|
||||||
|
#### Accessibility
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Deployment
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#### Deployment Checklist
|
||||||
|
|
||||||
|
- [ ] Update documentation not included in the PR (if any)
|
||||||
|
- [ ]
|
||||||
|
|
||||||
|
#### Metrics and Monitoring
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#### Who Needs to Know?
|
||||||
23
services/chat/.github/dependabot.yml
vendored
Normal file
23
services/chat/.github/dependabot.yml
vendored
Normal file
|
|
@ -0,0 +1,23 @@
|
||||||
|
version: 2
|
||||||
|
updates:
|
||||||
|
- package-ecosystem: "npm"
|
||||||
|
directory: "/"
|
||||||
|
schedule:
|
||||||
|
interval: "daily"
|
||||||
|
|
||||||
|
pull-request-branch-name:
|
||||||
|
# Separate sections of the branch name with a hyphen
|
||||||
|
# Docker images use the branch name and do not support slashes in tags
|
||||||
|
# https://github.com/overleaf/google-ops/issues/822
|
||||||
|
# https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#pull-request-branch-nameseparator
|
||||||
|
separator: "-"
|
||||||
|
|
||||||
|
# Block informal upgrades -- security upgrades use a separate queue.
|
||||||
|
# https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#open-pull-requests-limit
|
||||||
|
open-pull-requests-limit: 0
|
||||||
|
|
||||||
|
# currently assign team-magma to all dependabot PRs - this may change in
|
||||||
|
# future if we reorganise teams
|
||||||
|
labels:
|
||||||
|
- "dependencies"
|
||||||
|
- "type:maintenance"
|
||||||
12
services/chat/.gitignore
vendored
Normal file
12
services/chat/.gitignore
vendored
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
**.swp
|
||||||
|
|
||||||
|
public/build/
|
||||||
|
|
||||||
|
node_modules/
|
||||||
|
|
||||||
|
plato/
|
||||||
|
|
||||||
|
**/*.map
|
||||||
|
|
||||||
|
# managed by dev-environment$ bin/update_build_scripts
|
||||||
|
.npmrc
|
||||||
1
services/chat/.nvmrc
Normal file
1
services/chat/.nvmrc
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
12.22.3
|
||||||
11
services/chat/.prettierrc
Normal file
11
services/chat/.prettierrc
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
# This file was auto-generated, do not edit it directly.
|
||||||
|
# Instead run bin/update_build_scripts from
|
||||||
|
# https://github.com/sharelatex/sharelatex-dev-environment
|
||||||
|
{
|
||||||
|
"arrowParens": "avoid",
|
||||||
|
"semi": false,
|
||||||
|
"singleQuote": true,
|
||||||
|
"trailingComma": "es5",
|
||||||
|
"tabWidth": 2,
|
||||||
|
"useTabs": false
|
||||||
|
}
|
||||||
23
services/chat/Dockerfile
Normal file
23
services/chat/Dockerfile
Normal file
|
|
@ -0,0 +1,23 @@
|
||||||
|
# This file was auto-generated, do not edit it directly.
|
||||||
|
# Instead run bin/update_build_scripts from
|
||||||
|
# https://github.com/sharelatex/sharelatex-dev-environment
|
||||||
|
|
||||||
|
FROM node:12.22.3 as base
|
||||||
|
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
FROM base as app
|
||||||
|
|
||||||
|
#wildcard as some files may not be in all repos
|
||||||
|
COPY package*.json npm-shrink*.json /app/
|
||||||
|
|
||||||
|
RUN npm ci --quiet
|
||||||
|
|
||||||
|
COPY . /app
|
||||||
|
|
||||||
|
FROM base
|
||||||
|
|
||||||
|
COPY --from=app /app /app
|
||||||
|
USER node
|
||||||
|
|
||||||
|
CMD ["node", "--expose-gc", "app.js"]
|
||||||
662
services/chat/LICENSE
Normal file
662
services/chat/LICENSE
Normal file
|
|
@ -0,0 +1,662 @@
|
||||||
|
|
||||||
|
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/>.
|
||||||
90
services/chat/Makefile
Normal file
90
services/chat/Makefile
Normal file
|
|
@ -0,0 +1,90 @@
|
||||||
|
# This file was auto-generated, do not edit it directly.
|
||||||
|
# Instead run bin/update_build_scripts from
|
||||||
|
# https://github.com/sharelatex/sharelatex-dev-environment
|
||||||
|
|
||||||
|
BUILD_NUMBER ?= local
|
||||||
|
BRANCH_NAME ?= $(shell git rev-parse --abbrev-ref HEAD)
|
||||||
|
PROJECT_NAME = chat
|
||||||
|
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}
|
||||||
|
|
||||||
|
DOCKER_COMPOSE_TEST_ACCEPTANCE = \
|
||||||
|
COMPOSE_PROJECT_NAME=test_acceptance_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE)
|
||||||
|
|
||||||
|
DOCKER_COMPOSE_TEST_UNIT = \
|
||||||
|
COMPOSE_PROJECT_NAME=test_unit_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE)
|
||||||
|
|
||||||
|
clean:
|
||||||
|
-docker rmi ci/$(PROJECT_NAME):$(BRANCH_NAME)-$(BUILD_NUMBER)
|
||||||
|
-docker rmi gcr.io/overleaf-ops/$(PROJECT_NAME):$(BRANCH_NAME)-$(BUILD_NUMBER)
|
||||||
|
-$(DOCKER_COMPOSE_TEST_UNIT) down --rmi local
|
||||||
|
-$(DOCKER_COMPOSE_TEST_ACCEPTANCE) down --rmi local
|
||||||
|
|
||||||
|
format:
|
||||||
|
$(DOCKER_COMPOSE) run --rm test_unit npm run --silent format
|
||||||
|
|
||||||
|
format_fix:
|
||||||
|
$(DOCKER_COMPOSE) run --rm test_unit npm run --silent format:fix
|
||||||
|
|
||||||
|
lint:
|
||||||
|
$(DOCKER_COMPOSE) run --rm test_unit npm run --silent lint
|
||||||
|
|
||||||
|
test: format lint 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
|
||||||
|
|
||||||
|
build:
|
||||||
|
docker build --pull --tag ci/$(PROJECT_NAME):$(BRANCH_NAME)-$(BUILD_NUMBER) \
|
||||||
|
--tag gcr.io/overleaf-ops/$(PROJECT_NAME):$(BRANCH_NAME)-$(BUILD_NUMBER) \
|
||||||
|
.
|
||||||
|
|
||||||
|
tar:
|
||||||
|
$(DOCKER_COMPOSE) up tar
|
||||||
|
|
||||||
|
publish:
|
||||||
|
|
||||||
|
docker push $(DOCKER_REPO)/$(PROJECT_NAME):$(BRANCH_NAME)-$(BUILD_NUMBER)
|
||||||
|
|
||||||
|
|
||||||
|
.PHONY: clean test test_unit test_acceptance test_clean build publish
|
||||||
11
services/chat/README.md
Normal file
11
services/chat/README.md
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
overleaf/chat
|
||||||
|
===============
|
||||||
|
|
||||||
|
The backend API that powers the chat service in ShareLaTeX
|
||||||
|
|
||||||
|
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.
|
||||||
49
services/chat/app.js
Normal file
49
services/chat/app.js
Normal file
|
|
@ -0,0 +1,49 @@
|
||||||
|
/*
|
||||||
|
* decaffeinate suggestions:
|
||||||
|
* DS102: Remove unnecessary code created because of implicit returns
|
||||||
|
* DS103: Rewrite code to no longer use __guard__
|
||||||
|
* DS207: Consider shorter variations of null checks
|
||||||
|
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
|
||||||
|
*/
|
||||||
|
const logger = require('logger-sharelatex')
|
||||||
|
const settings = require('@overleaf/settings')
|
||||||
|
|
||||||
|
const mongodb = require('./app/js/mongodb')
|
||||||
|
const Server = require('./app/js/server')
|
||||||
|
|
||||||
|
if (!module.parent) {
|
||||||
|
// Called directly
|
||||||
|
const port =
|
||||||
|
__guard__(
|
||||||
|
settings.internal != null ? settings.internal.chat : undefined,
|
||||||
|
x => x.port
|
||||||
|
) || 3010
|
||||||
|
const host =
|
||||||
|
__guard__(
|
||||||
|
settings.internal != null ? settings.internal.chat : undefined,
|
||||||
|
x1 => x1.host
|
||||||
|
) || 'localhost'
|
||||||
|
mongodb
|
||||||
|
.waitForDb()
|
||||||
|
.then(() => {
|
||||||
|
Server.server.listen(port, host, function (err) {
|
||||||
|
if (err) {
|
||||||
|
logger.fatal({ err }, `Cannot bind to ${host}:${port}. Exiting.`)
|
||||||
|
process.exit(1)
|
||||||
|
}
|
||||||
|
return logger.info(`Chat starting up, listening on ${host}:${port}`)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
.catch(err => {
|
||||||
|
logger.fatal({ err }, 'Cannot connect to mongo. Exiting.')
|
||||||
|
process.exit(1)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = Server.server
|
||||||
|
|
||||||
|
function __guard__(value, transform) {
|
||||||
|
return typeof value !== 'undefined' && value !== null
|
||||||
|
? transform(value)
|
||||||
|
: undefined
|
||||||
|
}
|
||||||
80
services/chat/app/js/Features/Messages/MessageFormatter.js
Normal file
80
services/chat/app/js/Features/Messages/MessageFormatter.js
Normal file
|
|
@ -0,0 +1,80 @@
|
||||||
|
/* eslint-disable
|
||||||
|
camelcase,
|
||||||
|
max-len,
|
||||||
|
*/
|
||||||
|
// TODO: This file was created by bulk-decaffeinate.
|
||||||
|
// Fix any style issues and re-enable lint.
|
||||||
|
/*
|
||||||
|
* 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
|
||||||
|
*/
|
||||||
|
let MessageFormatter
|
||||||
|
module.exports = MessageFormatter = {
|
||||||
|
formatMessageForClientSide(message) {
|
||||||
|
if (message._id != null) {
|
||||||
|
message.id = message._id.toString()
|
||||||
|
delete message._id
|
||||||
|
}
|
||||||
|
const formattedMessage = {
|
||||||
|
id: message.id,
|
||||||
|
content: message.content,
|
||||||
|
timestamp: message.timestamp,
|
||||||
|
user_id: message.user_id,
|
||||||
|
}
|
||||||
|
if (message.edited_at != null) {
|
||||||
|
formattedMessage.edited_at = message.edited_at
|
||||||
|
}
|
||||||
|
return formattedMessage
|
||||||
|
},
|
||||||
|
|
||||||
|
formatMessagesForClientSide(messages) {
|
||||||
|
return Array.from(messages).map(message =>
|
||||||
|
this.formatMessageForClientSide(message)
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
groupMessagesByThreads(rooms, messages) {
|
||||||
|
let room, thread
|
||||||
|
const rooms_by_id = {}
|
||||||
|
for (room of Array.from(rooms)) {
|
||||||
|
rooms_by_id[room._id.toString()] = room
|
||||||
|
}
|
||||||
|
|
||||||
|
const threads = {}
|
||||||
|
const getThread = function (room) {
|
||||||
|
const thread_id = room.thread_id.toString()
|
||||||
|
if (threads[thread_id] != null) {
|
||||||
|
return threads[thread_id]
|
||||||
|
} else {
|
||||||
|
const thread = { messages: [] }
|
||||||
|
if (room.resolved != null) {
|
||||||
|
thread.resolved = true
|
||||||
|
thread.resolved_at = room.resolved.ts
|
||||||
|
thread.resolved_by_user_id = room.resolved.user_id
|
||||||
|
}
|
||||||
|
threads[thread_id] = thread
|
||||||
|
return thread
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const message of Array.from(messages)) {
|
||||||
|
room = rooms_by_id[message.room_id.toString()]
|
||||||
|
if (room != null) {
|
||||||
|
thread = getThread(room)
|
||||||
|
thread.messages.push(
|
||||||
|
MessageFormatter.formatMessageForClientSide(message)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const thread_id in threads) {
|
||||||
|
thread = threads[thread_id]
|
||||||
|
thread.messages.sort((a, b) => a.timestamp - b.timestamp)
|
||||||
|
}
|
||||||
|
|
||||||
|
return threads
|
||||||
|
},
|
||||||
|
}
|
||||||
273
services/chat/app/js/Features/Messages/MessageHttpController.js
Normal file
273
services/chat/app/js/Features/Messages/MessageHttpController.js
Normal file
|
|
@ -0,0 +1,273 @@
|
||||||
|
/* eslint-disable
|
||||||
|
camelcase,
|
||||||
|
max-len,
|
||||||
|
no-unused-vars,
|
||||||
|
*/
|
||||||
|
// TODO: This file was created by bulk-decaffeinate.
|
||||||
|
// Fix any style issues and re-enable lint.
|
||||||
|
/*
|
||||||
|
* 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
|
||||||
|
*/
|
||||||
|
let MessageHttpController
|
||||||
|
const logger = require('logger-sharelatex')
|
||||||
|
const metrics = require('@overleaf/metrics')
|
||||||
|
const MessageManager = require('./MessageManager')
|
||||||
|
const MessageFormatter = require('./MessageFormatter')
|
||||||
|
const ThreadManager = require('../Threads/ThreadManager')
|
||||||
|
const { ObjectId } = require('../../mongodb')
|
||||||
|
|
||||||
|
module.exports = MessageHttpController = {
|
||||||
|
DEFAULT_MESSAGE_LIMIT: 50,
|
||||||
|
MAX_MESSAGE_LENGTH: 10 * 1024, // 10kb, about 1,500 words
|
||||||
|
|
||||||
|
getGlobalMessages(req, res, next) {
|
||||||
|
return MessageHttpController._getMessages(
|
||||||
|
ThreadManager.GLOBAL_THREAD,
|
||||||
|
req,
|
||||||
|
res,
|
||||||
|
next
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
sendGlobalMessage(req, res, next) {
|
||||||
|
return MessageHttpController._sendMessage(
|
||||||
|
ThreadManager.GLOBAL_THREAD,
|
||||||
|
req,
|
||||||
|
res,
|
||||||
|
next
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
sendThreadMessage(req, res, next) {
|
||||||
|
return MessageHttpController._sendMessage(
|
||||||
|
req.params.thread_id,
|
||||||
|
req,
|
||||||
|
res,
|
||||||
|
next
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
getAllThreads(req, res, next) {
|
||||||
|
const { project_id } = req.params
|
||||||
|
logger.log({ project_id }, 'getting all threads')
|
||||||
|
return ThreadManager.findAllThreadRooms(
|
||||||
|
project_id,
|
||||||
|
function (error, rooms) {
|
||||||
|
if (error != null) {
|
||||||
|
return next(error)
|
||||||
|
}
|
||||||
|
const room_ids = rooms.map(r => r._id)
|
||||||
|
return MessageManager.findAllMessagesInRooms(
|
||||||
|
room_ids,
|
||||||
|
function (error, messages) {
|
||||||
|
if (error != null) {
|
||||||
|
return next(error)
|
||||||
|
}
|
||||||
|
const threads = MessageFormatter.groupMessagesByThreads(
|
||||||
|
rooms,
|
||||||
|
messages
|
||||||
|
)
|
||||||
|
return res.json(threads)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
resolveThread(req, res, next) {
|
||||||
|
const { project_id, thread_id } = req.params
|
||||||
|
const { user_id } = req.body
|
||||||
|
logger.log({ user_id, project_id, thread_id }, 'marking thread as resolved')
|
||||||
|
return ThreadManager.resolveThread(
|
||||||
|
project_id,
|
||||||
|
thread_id,
|
||||||
|
user_id,
|
||||||
|
function (error) {
|
||||||
|
if (error != null) {
|
||||||
|
return next(error)
|
||||||
|
}
|
||||||
|
return res.sendStatus(204)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}, // No content
|
||||||
|
|
||||||
|
reopenThread(req, res, next) {
|
||||||
|
const { project_id, thread_id } = req.params
|
||||||
|
logger.log({ project_id, thread_id }, 'reopening thread')
|
||||||
|
return ThreadManager.reopenThread(project_id, thread_id, function (error) {
|
||||||
|
if (error != null) {
|
||||||
|
return next(error)
|
||||||
|
}
|
||||||
|
return res.sendStatus(204)
|
||||||
|
})
|
||||||
|
}, // No content
|
||||||
|
|
||||||
|
deleteThread(req, res, next) {
|
||||||
|
const { project_id, thread_id } = req.params
|
||||||
|
logger.log({ project_id, thread_id }, 'deleting thread')
|
||||||
|
return ThreadManager.deleteThread(
|
||||||
|
project_id,
|
||||||
|
thread_id,
|
||||||
|
function (error, room_id) {
|
||||||
|
if (error != null) {
|
||||||
|
return next(error)
|
||||||
|
}
|
||||||
|
return MessageManager.deleteAllMessagesInRoom(
|
||||||
|
room_id,
|
||||||
|
function (error) {
|
||||||
|
if (error != null) {
|
||||||
|
return next(error)
|
||||||
|
}
|
||||||
|
return res.sendStatus(204)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}, // No content
|
||||||
|
|
||||||
|
editMessage(req, res, next) {
|
||||||
|
const { content } = req != null ? req.body : undefined
|
||||||
|
const { project_id, thread_id, message_id } = req.params
|
||||||
|
logger.log(
|
||||||
|
{ project_id, thread_id, message_id, content },
|
||||||
|
'editing message'
|
||||||
|
)
|
||||||
|
return ThreadManager.findOrCreateThread(
|
||||||
|
project_id,
|
||||||
|
thread_id,
|
||||||
|
function (error, room) {
|
||||||
|
if (error != null) {
|
||||||
|
return next(error)
|
||||||
|
}
|
||||||
|
return MessageManager.updateMessage(
|
||||||
|
room._id,
|
||||||
|
message_id,
|
||||||
|
content,
|
||||||
|
Date.now(),
|
||||||
|
function (error) {
|
||||||
|
if (error != null) {
|
||||||
|
return next(error)
|
||||||
|
}
|
||||||
|
return res.sendStatus(204)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
deleteMessage(req, res, next) {
|
||||||
|
const { project_id, thread_id, message_id } = req.params
|
||||||
|
logger.log({ project_id, thread_id, message_id }, 'deleting message')
|
||||||
|
return ThreadManager.findOrCreateThread(
|
||||||
|
project_id,
|
||||||
|
thread_id,
|
||||||
|
function (error, room) {
|
||||||
|
if (error != null) {
|
||||||
|
return next(error)
|
||||||
|
}
|
||||||
|
return MessageManager.deleteMessage(
|
||||||
|
room._id,
|
||||||
|
message_id,
|
||||||
|
function (error, message) {
|
||||||
|
if (error != null) {
|
||||||
|
return next(error)
|
||||||
|
}
|
||||||
|
return res.sendStatus(204)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
_sendMessage(client_thread_id, req, res, next) {
|
||||||
|
const { user_id, content } = req != null ? req.body : undefined
|
||||||
|
const { project_id } = req.params
|
||||||
|
if (!ObjectId.isValid(user_id)) {
|
||||||
|
return res.status(400).send('Invalid user_id')
|
||||||
|
}
|
||||||
|
if (content == null) {
|
||||||
|
return res.status(400).send('No content provided')
|
||||||
|
}
|
||||||
|
if (content.length > this.MAX_MESSAGE_LENGTH) {
|
||||||
|
return res
|
||||||
|
.status(400)
|
||||||
|
.send(`Content too long (> ${this.MAX_MESSAGE_LENGTH} bytes)`)
|
||||||
|
}
|
||||||
|
logger.log(
|
||||||
|
{ client_thread_id, project_id, user_id, content },
|
||||||
|
'new message received'
|
||||||
|
)
|
||||||
|
return ThreadManager.findOrCreateThread(
|
||||||
|
project_id,
|
||||||
|
client_thread_id,
|
||||||
|
function (error, thread) {
|
||||||
|
if (error != null) {
|
||||||
|
return next(error)
|
||||||
|
}
|
||||||
|
return MessageManager.createMessage(
|
||||||
|
thread._id,
|
||||||
|
user_id,
|
||||||
|
content,
|
||||||
|
Date.now(),
|
||||||
|
function (error, message) {
|
||||||
|
if (error != null) {
|
||||||
|
return next(error)
|
||||||
|
}
|
||||||
|
message = MessageFormatter.formatMessageForClientSide(message)
|
||||||
|
message.room_id = project_id
|
||||||
|
return res.status(201).send(message)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
_getMessages(client_thread_id, req, res, next) {
|
||||||
|
let before, limit
|
||||||
|
const { project_id } = req.params
|
||||||
|
if ((req.query != null ? req.query.before : undefined) != null) {
|
||||||
|
before = parseInt(req.query.before, 10)
|
||||||
|
} else {
|
||||||
|
before = null
|
||||||
|
}
|
||||||
|
if ((req.query != null ? req.query.limit : undefined) != null) {
|
||||||
|
limit = parseInt(req.query.limit, 10)
|
||||||
|
} else {
|
||||||
|
limit = MessageHttpController.DEFAULT_MESSAGE_LIMIT
|
||||||
|
}
|
||||||
|
logger.log(
|
||||||
|
{ limit, before, project_id, client_thread_id },
|
||||||
|
'get message request received'
|
||||||
|
)
|
||||||
|
return ThreadManager.findOrCreateThread(
|
||||||
|
project_id,
|
||||||
|
client_thread_id,
|
||||||
|
function (error, thread) {
|
||||||
|
if (error != null) {
|
||||||
|
return next(error)
|
||||||
|
}
|
||||||
|
const thread_object_id = thread._id
|
||||||
|
logger.log(
|
||||||
|
{ limit, before, project_id, client_thread_id, thread_object_id },
|
||||||
|
'found or created thread'
|
||||||
|
)
|
||||||
|
return MessageManager.getMessages(
|
||||||
|
thread_object_id,
|
||||||
|
limit,
|
||||||
|
before,
|
||||||
|
function (error, messages) {
|
||||||
|
if (error != null) {
|
||||||
|
return next(error)
|
||||||
|
}
|
||||||
|
messages = MessageFormatter.formatMessagesForClientSide(messages)
|
||||||
|
logger.log({ project_id, messages }, 'got messages')
|
||||||
|
return res.status(200).send(messages)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
},
|
||||||
|
}
|
||||||
137
services/chat/app/js/Features/Messages/MessageManager.js
Normal file
137
services/chat/app/js/Features/Messages/MessageManager.js
Normal file
|
|
@ -0,0 +1,137 @@
|
||||||
|
/* eslint-disable
|
||||||
|
camelcase,
|
||||||
|
handle-callback-err,
|
||||||
|
max-len,
|
||||||
|
no-unused-vars,
|
||||||
|
*/
|
||||||
|
// TODO: This file was created by bulk-decaffeinate.
|
||||||
|
// Fix any style issues and re-enable lint.
|
||||||
|
/*
|
||||||
|
* 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
|
||||||
|
*/
|
||||||
|
let MessageManager
|
||||||
|
const { db, ObjectId } = require('../../mongodb')
|
||||||
|
const metrics = require('@overleaf/metrics')
|
||||||
|
const logger = require('logger-sharelatex')
|
||||||
|
|
||||||
|
module.exports = MessageManager = {
|
||||||
|
createMessage(room_id, user_id, content, timestamp, callback) {
|
||||||
|
if (callback == null) {
|
||||||
|
callback = function (error, message) {}
|
||||||
|
}
|
||||||
|
let newMessageOpts = {
|
||||||
|
content,
|
||||||
|
room_id,
|
||||||
|
user_id,
|
||||||
|
timestamp,
|
||||||
|
}
|
||||||
|
newMessageOpts = this._ensureIdsAreObjectIds(newMessageOpts)
|
||||||
|
db.messages.insertOne(newMessageOpts, function (error, confirmation) {
|
||||||
|
if (error) {
|
||||||
|
return callback(error)
|
||||||
|
}
|
||||||
|
newMessageOpts._id = confirmation.insertedId
|
||||||
|
callback(null, newMessageOpts)
|
||||||
|
})
|
||||||
|
},
|
||||||
|
|
||||||
|
getMessages(room_id, limit, before, callback) {
|
||||||
|
if (callback == null) {
|
||||||
|
callback = function (error, messages) {}
|
||||||
|
}
|
||||||
|
let query = { room_id }
|
||||||
|
if (before != null) {
|
||||||
|
query.timestamp = { $lt: before }
|
||||||
|
}
|
||||||
|
query = this._ensureIdsAreObjectIds(query)
|
||||||
|
db.messages
|
||||||
|
.find(query)
|
||||||
|
.sort({ timestamp: -1 })
|
||||||
|
.limit(limit)
|
||||||
|
.toArray(callback)
|
||||||
|
},
|
||||||
|
|
||||||
|
findAllMessagesInRooms(room_ids, callback) {
|
||||||
|
if (callback == null) {
|
||||||
|
callback = function (error, messages) {}
|
||||||
|
}
|
||||||
|
db.messages
|
||||||
|
.find({
|
||||||
|
room_id: { $in: room_ids },
|
||||||
|
})
|
||||||
|
.toArray(callback)
|
||||||
|
},
|
||||||
|
|
||||||
|
deleteAllMessagesInRoom(room_id, callback) {
|
||||||
|
if (callback == null) {
|
||||||
|
callback = function (error) {}
|
||||||
|
}
|
||||||
|
db.messages.deleteMany(
|
||||||
|
{
|
||||||
|
room_id,
|
||||||
|
},
|
||||||
|
callback
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
updateMessage(room_id, message_id, content, timestamp, callback) {
|
||||||
|
if (callback == null) {
|
||||||
|
callback = function (error, message) {}
|
||||||
|
}
|
||||||
|
const query = this._ensureIdsAreObjectIds({
|
||||||
|
_id: message_id,
|
||||||
|
room_id,
|
||||||
|
})
|
||||||
|
db.messages.updateOne(
|
||||||
|
query,
|
||||||
|
{
|
||||||
|
$set: {
|
||||||
|
content,
|
||||||
|
edited_at: timestamp,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
callback
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
deleteMessage(room_id, message_id, callback) {
|
||||||
|
if (callback == null) {
|
||||||
|
callback = function (error) {}
|
||||||
|
}
|
||||||
|
const query = this._ensureIdsAreObjectIds({
|
||||||
|
_id: message_id,
|
||||||
|
room_id,
|
||||||
|
})
|
||||||
|
db.messages.deleteOne(query, callback)
|
||||||
|
},
|
||||||
|
|
||||||
|
_ensureIdsAreObjectIds(query) {
|
||||||
|
if (query.user_id != null && !(query.user_id instanceof ObjectId)) {
|
||||||
|
query.user_id = ObjectId(query.user_id)
|
||||||
|
}
|
||||||
|
if (query.room_id != null && !(query.room_id instanceof ObjectId)) {
|
||||||
|
query.room_id = ObjectId(query.room_id)
|
||||||
|
}
|
||||||
|
if (query._id != null && !(query._id instanceof ObjectId)) {
|
||||||
|
query._id = ObjectId(query._id)
|
||||||
|
}
|
||||||
|
return query
|
||||||
|
},
|
||||||
|
}
|
||||||
|
;[
|
||||||
|
'createMessage',
|
||||||
|
'getMessages',
|
||||||
|
'findAllMessagesInRooms',
|
||||||
|
'updateMessage',
|
||||||
|
'deleteMessage',
|
||||||
|
].map(method =>
|
||||||
|
metrics.timeAsyncMethod(
|
||||||
|
MessageManager,
|
||||||
|
method,
|
||||||
|
'mongo.MessageManager',
|
||||||
|
logger
|
||||||
|
)
|
||||||
|
)
|
||||||
155
services/chat/app/js/Features/Threads/ThreadManager.js
Normal file
155
services/chat/app/js/Features/Threads/ThreadManager.js
Normal file
|
|
@ -0,0 +1,155 @@
|
||||||
|
/* eslint-disable
|
||||||
|
camelcase,
|
||||||
|
handle-callback-err,
|
||||||
|
max-len,
|
||||||
|
*/
|
||||||
|
// TODO: This file was created by bulk-decaffeinate.
|
||||||
|
// Fix any style issues and re-enable lint.
|
||||||
|
/*
|
||||||
|
* 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
|
||||||
|
*/
|
||||||
|
let ThreadManager
|
||||||
|
const { db, ObjectId } = require('../../mongodb')
|
||||||
|
const logger = require('logger-sharelatex')
|
||||||
|
const metrics = require('@overleaf/metrics')
|
||||||
|
|
||||||
|
module.exports = ThreadManager = {
|
||||||
|
GLOBAL_THREAD: 'GLOBAL',
|
||||||
|
|
||||||
|
findOrCreateThread(project_id, thread_id, callback) {
|
||||||
|
let query, update
|
||||||
|
if (callback == null) {
|
||||||
|
callback = function (error, thread) {}
|
||||||
|
}
|
||||||
|
project_id = ObjectId(project_id.toString())
|
||||||
|
if (thread_id !== ThreadManager.GLOBAL_THREAD) {
|
||||||
|
thread_id = ObjectId(thread_id.toString())
|
||||||
|
}
|
||||||
|
|
||||||
|
if (thread_id === ThreadManager.GLOBAL_THREAD) {
|
||||||
|
query = {
|
||||||
|
project_id,
|
||||||
|
thread_id: { $exists: false },
|
||||||
|
}
|
||||||
|
update = {
|
||||||
|
project_id,
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
query = {
|
||||||
|
project_id,
|
||||||
|
thread_id,
|
||||||
|
}
|
||||||
|
update = {
|
||||||
|
project_id,
|
||||||
|
thread_id,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
db.rooms.updateOne(
|
||||||
|
query,
|
||||||
|
{ $set: update },
|
||||||
|
{ upsert: true },
|
||||||
|
function (error) {
|
||||||
|
if (error != null) {
|
||||||
|
return callback(error)
|
||||||
|
}
|
||||||
|
db.rooms.findOne(query, callback)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
findAllThreadRooms(project_id, callback) {
|
||||||
|
if (callback == null) {
|
||||||
|
callback = function (error, rooms) {}
|
||||||
|
}
|
||||||
|
db.rooms
|
||||||
|
.find(
|
||||||
|
{
|
||||||
|
project_id: ObjectId(project_id.toString()),
|
||||||
|
thread_id: { $exists: true },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
thread_id: 1,
|
||||||
|
resolved: 1,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
.toArray(callback)
|
||||||
|
},
|
||||||
|
|
||||||
|
resolveThread(project_id, thread_id, user_id, callback) {
|
||||||
|
if (callback == null) {
|
||||||
|
callback = function (error) {}
|
||||||
|
}
|
||||||
|
db.rooms.updateOne(
|
||||||
|
{
|
||||||
|
project_id: ObjectId(project_id.toString()),
|
||||||
|
thread_id: ObjectId(thread_id.toString()),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
$set: {
|
||||||
|
resolved: {
|
||||||
|
user_id,
|
||||||
|
ts: new Date(),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
callback
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
reopenThread(project_id, thread_id, callback) {
|
||||||
|
if (callback == null) {
|
||||||
|
callback = function (error) {}
|
||||||
|
}
|
||||||
|
db.rooms.updateOne(
|
||||||
|
{
|
||||||
|
project_id: ObjectId(project_id.toString()),
|
||||||
|
thread_id: ObjectId(thread_id.toString()),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
$unset: {
|
||||||
|
resolved: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
callback
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
deleteThread(project_id, thread_id, callback) {
|
||||||
|
if (callback == null) {
|
||||||
|
callback = function (error, room_id) {}
|
||||||
|
}
|
||||||
|
return this.findOrCreateThread(
|
||||||
|
project_id,
|
||||||
|
thread_id,
|
||||||
|
function (error, room) {
|
||||||
|
if (error != null) {
|
||||||
|
return callback(error)
|
||||||
|
}
|
||||||
|
db.rooms.deleteOne(
|
||||||
|
{
|
||||||
|
_id: room._id,
|
||||||
|
},
|
||||||
|
function (error) {
|
||||||
|
if (error != null) {
|
||||||
|
return callback(error)
|
||||||
|
}
|
||||||
|
return callback(null, room._id)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
;[
|
||||||
|
'findOrCreateThread',
|
||||||
|
'findAllThreadRooms',
|
||||||
|
'resolveThread',
|
||||||
|
'reopenThread',
|
||||||
|
'deleteThread',
|
||||||
|
].map(method =>
|
||||||
|
metrics.timeAsyncMethod(ThreadManager, method, 'mongo.ThreadManager', logger)
|
||||||
|
)
|
||||||
29
services/chat/app/js/mongodb.js
Normal file
29
services/chat/app/js/mongodb.js
Normal file
|
|
@ -0,0 +1,29 @@
|
||||||
|
const Settings = require('@overleaf/settings')
|
||||||
|
const { MongoClient, ObjectId } = require('mongodb')
|
||||||
|
|
||||||
|
const clientPromise = MongoClient.connect(
|
||||||
|
Settings.mongo.url,
|
||||||
|
Settings.mongo.options
|
||||||
|
)
|
||||||
|
|
||||||
|
let setupDbPromise
|
||||||
|
async function waitForDb() {
|
||||||
|
if (!setupDbPromise) {
|
||||||
|
setupDbPromise = setupDb()
|
||||||
|
}
|
||||||
|
await setupDbPromise
|
||||||
|
}
|
||||||
|
|
||||||
|
const db = {}
|
||||||
|
async function setupDb() {
|
||||||
|
const internalDb = (await clientPromise).db()
|
||||||
|
|
||||||
|
db.messages = internalDb.collection('messages')
|
||||||
|
db.rooms = internalDb.collection('rooms')
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
db,
|
||||||
|
ObjectId,
|
||||||
|
waitForDb,
|
||||||
|
}
|
||||||
84
services/chat/app/js/router.js
Normal file
84
services/chat/app/js/router.js
Normal file
|
|
@ -0,0 +1,84 @@
|
||||||
|
/* eslint-disable
|
||||||
|
camelcase,
|
||||||
|
max-len,
|
||||||
|
no-unused-vars,
|
||||||
|
*/
|
||||||
|
// TODO: This file was created by bulk-decaffeinate.
|
||||||
|
// Fix any style issues and re-enable lint.
|
||||||
|
/*
|
||||||
|
* decaffeinate suggestions:
|
||||||
|
* DS102: Remove unnecessary code created because of implicit returns
|
||||||
|
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
|
||||||
|
*/
|
||||||
|
let Router
|
||||||
|
const MessageHttpController = require('./Features/Messages/MessageHttpController')
|
||||||
|
const { ObjectId } = require('./mongodb')
|
||||||
|
|
||||||
|
module.exports = Router = {
|
||||||
|
route(app) {
|
||||||
|
app.param('project_id', function (req, res, next, project_id) {
|
||||||
|
if (ObjectId.isValid(project_id)) {
|
||||||
|
return next()
|
||||||
|
} else {
|
||||||
|
return res.status(400).send('Invalid project_id')
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
app.param('thread_id', function (req, res, next, thread_id) {
|
||||||
|
if (ObjectId.isValid(thread_id)) {
|
||||||
|
return next()
|
||||||
|
} else {
|
||||||
|
return res.status(400).send('Invalid thread_id')
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
// These are for backwards compatibility
|
||||||
|
app.get(
|
||||||
|
'/room/:project_id/messages',
|
||||||
|
MessageHttpController.getGlobalMessages
|
||||||
|
)
|
||||||
|
app.post(
|
||||||
|
'/room/:project_id/messages',
|
||||||
|
MessageHttpController.sendGlobalMessage
|
||||||
|
)
|
||||||
|
|
||||||
|
app.get(
|
||||||
|
'/project/:project_id/messages',
|
||||||
|
MessageHttpController.getGlobalMessages
|
||||||
|
)
|
||||||
|
app.post(
|
||||||
|
'/project/:project_id/messages',
|
||||||
|
MessageHttpController.sendGlobalMessage
|
||||||
|
)
|
||||||
|
|
||||||
|
app.post(
|
||||||
|
'/project/:project_id/thread/:thread_id/messages',
|
||||||
|
MessageHttpController.sendThreadMessage
|
||||||
|
)
|
||||||
|
app.get('/project/:project_id/threads', MessageHttpController.getAllThreads)
|
||||||
|
|
||||||
|
app.post(
|
||||||
|
'/project/:project_id/thread/:thread_id/messages/:message_id/edit',
|
||||||
|
MessageHttpController.editMessage
|
||||||
|
)
|
||||||
|
app.delete(
|
||||||
|
'/project/:project_id/thread/:thread_id/messages/:message_id',
|
||||||
|
MessageHttpController.deleteMessage
|
||||||
|
)
|
||||||
|
|
||||||
|
app.post(
|
||||||
|
'/project/:project_id/thread/:thread_id/resolve',
|
||||||
|
MessageHttpController.resolveThread
|
||||||
|
)
|
||||||
|
app.post(
|
||||||
|
'/project/:project_id/thread/:thread_id/reopen',
|
||||||
|
MessageHttpController.reopenThread
|
||||||
|
)
|
||||||
|
app.delete(
|
||||||
|
'/project/:project_id/thread/:thread_id',
|
||||||
|
MessageHttpController.deleteThread
|
||||||
|
)
|
||||||
|
|
||||||
|
return app.get('/status', (req, res, next) => res.send('chat is alive'))
|
||||||
|
},
|
||||||
|
}
|
||||||
41
services/chat/app/js/server.js
Normal file
41
services/chat/app/js/server.js
Normal file
|
|
@ -0,0 +1,41 @@
|
||||||
|
/* eslint-disable
|
||||||
|
no-unused-vars,
|
||||||
|
*/
|
||||||
|
// TODO: This file was created by bulk-decaffeinate.
|
||||||
|
// Fix any style issues and re-enable lint.
|
||||||
|
/*
|
||||||
|
* decaffeinate suggestions:
|
||||||
|
* DS102: Remove unnecessary code created because of implicit returns
|
||||||
|
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
|
||||||
|
*/
|
||||||
|
const metrics = require('@overleaf/metrics')
|
||||||
|
metrics.initialize('chat')
|
||||||
|
const logger = require('logger-sharelatex')
|
||||||
|
logger.initialize('chat')
|
||||||
|
const Path = require('path')
|
||||||
|
const express = require('express')
|
||||||
|
const bodyParser = require('body-parser')
|
||||||
|
const errorHandler = require('errorhandler')
|
||||||
|
const app = express()
|
||||||
|
const server = require('http').createServer(app)
|
||||||
|
const Router = require('./router')
|
||||||
|
|
||||||
|
app.use(bodyParser.json())
|
||||||
|
app.use(bodyParser.urlencoded({ extended: true }))
|
||||||
|
app.use(metrics.http.monitor(logger))
|
||||||
|
metrics.injectMetricsRoute(app)
|
||||||
|
|
||||||
|
if (app.get('env') === 'development') {
|
||||||
|
app.use(errorHandler({ dumpExceptions: true, showStack: true }))
|
||||||
|
}
|
||||||
|
|
||||||
|
if (app.get('env') === 'production') {
|
||||||
|
app.use(errorHandler())
|
||||||
|
}
|
||||||
|
|
||||||
|
Router.route(app)
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
server,
|
||||||
|
app,
|
||||||
|
}
|
||||||
8
services/chat/buildscript.txt
Normal file
8
services/chat/buildscript.txt
Normal file
|
|
@ -0,0 +1,8 @@
|
||||||
|
chat
|
||||||
|
--dependencies=mongo
|
||||||
|
--docker-repos=gcr.io/overleaf-ops
|
||||||
|
--env-add=
|
||||||
|
--env-pass-through=
|
||||||
|
--node-version=12.22.3
|
||||||
|
--public-repo=False
|
||||||
|
--script-version=3.11.0
|
||||||
28
services/chat/config/settings.defaults.js
Normal file
28
services/chat/config/settings.defaults.js
Normal file
|
|
@ -0,0 +1,28 @@
|
||||||
|
module.exports = {
|
||||||
|
internal: {
|
||||||
|
chat: {
|
||||||
|
host: process.env.LISTEN_ADDRESS || 'localhost',
|
||||||
|
port: 3010,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
|
||||||
|
apis: {
|
||||||
|
web: {
|
||||||
|
url: `http://${process.env.WEB_HOST || 'localhost'}:${
|
||||||
|
process.env.WEB_PORT || 3000
|
||||||
|
}`,
|
||||||
|
user: process.env.WEB_API_USER || 'sharelatex',
|
||||||
|
pass: process.env.WEB_API_PASSWORD || 'password',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
|
||||||
|
mongo: {
|
||||||
|
options: {
|
||||||
|
useUnifiedTopology:
|
||||||
|
(process.env.MONGO_USE_UNIFIED_TOPOLOGY || 'true') === 'true',
|
||||||
|
},
|
||||||
|
url:
|
||||||
|
process.env.MONGO_CONNECTION_STRING ||
|
||||||
|
`mongodb://${process.env.MONGO_HOST || 'localhost'}/sharelatex`,
|
||||||
|
},
|
||||||
|
}
|
||||||
48
services/chat/docker-compose.ci.yml
Normal file
48
services/chat/docker-compose.ci.yml
Normal file
|
|
@ -0,0 +1,48 @@
|
||||||
|
# This file was auto-generated, do not edit it directly.
|
||||||
|
# Instead run bin/update_build_scripts from
|
||||||
|
# https://github.com/sharelatex/sharelatex-dev-environment
|
||||||
|
|
||||||
|
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
|
||||||
|
REDIS_HOST: redis
|
||||||
|
QUEUES_REDIS_HOST: redis
|
||||||
|
MONGO_HOST: mongo
|
||||||
|
POSTGRES_HOST: postgres
|
||||||
|
MOCHA_GREP: ${MOCHA_GREP}
|
||||||
|
NODE_ENV: test
|
||||||
|
NODE_OPTIONS: "--unhandled-rejections=strict"
|
||||||
|
depends_on:
|
||||||
|
mongo:
|
||||||
|
condition: service_healthy
|
||||||
|
user: node
|
||||||
|
command: npm run test:acceptance:_run
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
mongo:
|
||||||
|
image: mongo:4.0
|
||||||
|
healthcheck:
|
||||||
|
test: "mongo --quiet localhost/test --eval 'quit(db.runCommand({ ping: 1 }).ok ? 0 : 1)'"
|
||||||
|
interval: 1s
|
||||||
|
retries: 20
|
||||||
47
services/chat/docker-compose.yml
Normal file
47
services/chat/docker-compose.yml
Normal file
|
|
@ -0,0 +1,47 @@
|
||||||
|
# This file was auto-generated, do not edit it directly.
|
||||||
|
# Instead run bin/update_build_scripts from
|
||||||
|
# https://github.com/sharelatex/sharelatex-dev-environment
|
||||||
|
|
||||||
|
version: "2.3"
|
||||||
|
|
||||||
|
services:
|
||||||
|
test_unit:
|
||||||
|
image: node:12.22.3
|
||||||
|
volumes:
|
||||||
|
- .:/app
|
||||||
|
working_dir: /app
|
||||||
|
environment:
|
||||||
|
MOCHA_GREP: ${MOCHA_GREP}
|
||||||
|
NODE_ENV: test
|
||||||
|
NODE_OPTIONS: "--unhandled-rejections=strict"
|
||||||
|
command: npm run --silent test:unit
|
||||||
|
user: node
|
||||||
|
|
||||||
|
test_acceptance:
|
||||||
|
image: node:12.22.3
|
||||||
|
volumes:
|
||||||
|
- .:/app
|
||||||
|
working_dir: /app
|
||||||
|
environment:
|
||||||
|
ELASTIC_SEARCH_DSN: es:9200
|
||||||
|
REDIS_HOST: redis
|
||||||
|
QUEUES_REDIS_HOST: redis
|
||||||
|
MONGO_HOST: mongo
|
||||||
|
POSTGRES_HOST: postgres
|
||||||
|
MOCHA_GREP: ${MOCHA_GREP}
|
||||||
|
LOG_LEVEL: ERROR
|
||||||
|
NODE_ENV: test
|
||||||
|
NODE_OPTIONS: "--unhandled-rejections=strict"
|
||||||
|
user: node
|
||||||
|
depends_on:
|
||||||
|
mongo:
|
||||||
|
condition: service_healthy
|
||||||
|
command: npm run --silent test:acceptance
|
||||||
|
|
||||||
|
mongo:
|
||||||
|
image: mongo:4.0
|
||||||
|
healthcheck:
|
||||||
|
test: "mongo --quiet localhost/test --eval 'quit(db.runCommand({ ping: 1 }).ok ? 0 : 1)'"
|
||||||
|
interval: 1s
|
||||||
|
retries: 20
|
||||||
|
|
||||||
17
services/chat/nodemon.json
Normal file
17
services/chat/nodemon.json
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
{
|
||||||
|
"ignore": [
|
||||||
|
".git",
|
||||||
|
"node_modules/"
|
||||||
|
],
|
||||||
|
"verbose": true,
|
||||||
|
"legacyWatch": true,
|
||||||
|
"execMap": {
|
||||||
|
"js": "npm run start"
|
||||||
|
},
|
||||||
|
"watch": [
|
||||||
|
"app/js/",
|
||||||
|
"app.js",
|
||||||
|
"config/"
|
||||||
|
],
|
||||||
|
"ext": "js"
|
||||||
|
}
|
||||||
6151
services/chat/package-lock.json
generated
Normal file
6151
services/chat/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load diff
55
services/chat/package.json
Normal file
55
services/chat/package.json
Normal file
|
|
@ -0,0 +1,55 @@
|
||||||
|
{
|
||||||
|
"name": "chat-sharelatex",
|
||||||
|
"version": "0.1.4",
|
||||||
|
"description": "The backend API that powers ShareLaTeX chat",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "https://github.com/sharelatex/chat-sharelatex.git"
|
||||||
|
},
|
||||||
|
"scripts": {
|
||||||
|
"start": "node $NODE_APP_OPTIONS app.js",
|
||||||
|
"test:acceptance": "npm run test:acceptance:_run -- --grep=$MOCHA_GREP",
|
||||||
|
"test:unit": "npm run test:unit:_run -- --grep=$MOCHA_GREP",
|
||||||
|
"nodemon": "nodemon --config nodemon.json",
|
||||||
|
"test:acceptance:_run": "mocha --recursive --reporter spec --timeout 15000 --exit $@ test/acceptance/js",
|
||||||
|
"test:unit:_run": "mocha --recursive --reporter spec $@ test/unit/js",
|
||||||
|
"lint": "eslint --max-warnings 0 --format unix .",
|
||||||
|
"format": "prettier --list-different $PWD/'**/*.js'",
|
||||||
|
"format:fix": "prettier --write $PWD/'**/*.js'",
|
||||||
|
"lint:fix": "eslint --fix ."
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"@overleaf/metrics": "^3.5.1",
|
||||||
|
"@overleaf/settings": "^2.1.1",
|
||||||
|
"async": "3.2.0",
|
||||||
|
"body-parser": "^1.19.0",
|
||||||
|
"bunyan": "^1.8.15",
|
||||||
|
"errorhandler": "^1.5.1",
|
||||||
|
"express": "4.17.1",
|
||||||
|
"logger-sharelatex": "^2.2.0",
|
||||||
|
"mongodb": "^3.6.0",
|
||||||
|
"request": "^2.88.2"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"acorn": "^7.1.1",
|
||||||
|
"ajv": "^6.12.0",
|
||||||
|
"chai": "^4.2.0",
|
||||||
|
"chai-as-promised": "^7.1.1",
|
||||||
|
"eslint": "^7.21.0",
|
||||||
|
"eslint-config-prettier": "^8.1.0",
|
||||||
|
"eslint-config-standard": "^16.0.2",
|
||||||
|
"eslint-plugin-chai-expect": "^2.2.0",
|
||||||
|
"eslint-plugin-chai-friendly": "^0.6.0",
|
||||||
|
"eslint-plugin-import": "^2.22.1",
|
||||||
|
"eslint-plugin-mocha": "^8.0.0",
|
||||||
|
"eslint-plugin-node": "^11.1.0",
|
||||||
|
"eslint-plugin-prettier": "^3.1.2",
|
||||||
|
"eslint-plugin-promise": "^4.2.1",
|
||||||
|
"mocha": "^8.3.2",
|
||||||
|
"nodemon": "^2.0.2",
|
||||||
|
"prettier": "^2.2.1",
|
||||||
|
"sandboxed-module": "^2.0.3",
|
||||||
|
"sinon": "^9.0.0",
|
||||||
|
"timekeeper": "^2.2.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
73
services/chat/test/acceptance/js/DeletingAMessageTests.js
Normal file
73
services/chat/test/acceptance/js/DeletingAMessageTests.js
Normal file
|
|
@ -0,0 +1,73 @@
|
||||||
|
/* eslint-disable
|
||||||
|
max-len,
|
||||||
|
*/
|
||||||
|
// TODO: This file was created by bulk-decaffeinate.
|
||||||
|
// Fix any style issues and re-enable lint.
|
||||||
|
/*
|
||||||
|
* decaffeinate suggestions:
|
||||||
|
* DS102: Remove unnecessary code created because of implicit returns
|
||||||
|
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
|
||||||
|
*/
|
||||||
|
const { ObjectId } = require('../../../app/js/mongodb')
|
||||||
|
const { expect } = require('chai')
|
||||||
|
|
||||||
|
const ChatClient = require('./helpers/ChatClient')
|
||||||
|
const ChatApp = require('./helpers/ChatApp')
|
||||||
|
|
||||||
|
describe('Deleting a message', function () {
|
||||||
|
before(function (done) {
|
||||||
|
this.project_id = ObjectId().toString()
|
||||||
|
this.user_id = ObjectId().toString()
|
||||||
|
this.thread_id = ObjectId().toString()
|
||||||
|
return ChatApp.ensureRunning(done)
|
||||||
|
})
|
||||||
|
|
||||||
|
return describe('in a thread', function () {
|
||||||
|
before(function (done) {
|
||||||
|
return ChatClient.sendMessage(
|
||||||
|
this.project_id,
|
||||||
|
this.thread_id,
|
||||||
|
this.user_id,
|
||||||
|
'first message',
|
||||||
|
(error, response, message) => {
|
||||||
|
this.message = message
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(201)
|
||||||
|
return ChatClient.sendMessage(
|
||||||
|
this.project_id,
|
||||||
|
this.thread_id,
|
||||||
|
this.user_id,
|
||||||
|
'deleted message',
|
||||||
|
(error, response, message1) => {
|
||||||
|
this.message = message1
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(201)
|
||||||
|
return ChatClient.deleteMessage(
|
||||||
|
this.project_id,
|
||||||
|
this.thread_id,
|
||||||
|
this.message.id,
|
||||||
|
(error, response, body) => {
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(204)
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
return it('should then remove the message from the threads', function (done) {
|
||||||
|
return ChatClient.getThreads(
|
||||||
|
this.project_id,
|
||||||
|
(error, response, threads) => {
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(200)
|
||||||
|
expect(threads[this.thread_id].messages.length).to.equal(1)
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
63
services/chat/test/acceptance/js/DeletingAThreadTests.js
Normal file
63
services/chat/test/acceptance/js/DeletingAThreadTests.js
Normal file
|
|
@ -0,0 +1,63 @@
|
||||||
|
/* eslint-disable
|
||||||
|
max-len,
|
||||||
|
no-unused-vars,
|
||||||
|
*/
|
||||||
|
// TODO: This file was created by bulk-decaffeinate.
|
||||||
|
// Fix any style issues and re-enable lint.
|
||||||
|
/*
|
||||||
|
* decaffeinate suggestions:
|
||||||
|
* DS102: Remove unnecessary code created because of implicit returns
|
||||||
|
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
|
||||||
|
*/
|
||||||
|
const { ObjectId } = require('../../../app/js/mongodb')
|
||||||
|
const { expect } = require('chai')
|
||||||
|
const crypto = require('crypto')
|
||||||
|
|
||||||
|
const ChatClient = require('./helpers/ChatClient')
|
||||||
|
const ChatApp = require('./helpers/ChatApp')
|
||||||
|
|
||||||
|
describe('Deleting a thread', function () {
|
||||||
|
before(function (done) {
|
||||||
|
this.project_id = ObjectId().toString()
|
||||||
|
this.user_id = ObjectId().toString()
|
||||||
|
return ChatApp.ensureRunning(done)
|
||||||
|
})
|
||||||
|
|
||||||
|
return describe('with a thread that is deleted', function () {
|
||||||
|
before(function (done) {
|
||||||
|
this.thread_id = ObjectId().toString()
|
||||||
|
this.content = 'deleted thread message'
|
||||||
|
return ChatClient.sendMessage(
|
||||||
|
this.project_id,
|
||||||
|
this.thread_id,
|
||||||
|
this.user_id,
|
||||||
|
this.content,
|
||||||
|
(error, response, body) => {
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(201)
|
||||||
|
return ChatClient.deleteThread(
|
||||||
|
this.project_id,
|
||||||
|
this.thread_id,
|
||||||
|
(error, response, body) => {
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(204)
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
return it('should then not list the thread for the project', function (done) {
|
||||||
|
return ChatClient.getThreads(
|
||||||
|
this.project_id,
|
||||||
|
(error, response, threads) => {
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(200)
|
||||||
|
expect(Object.keys(threads).length).to.equal(0)
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
72
services/chat/test/acceptance/js/EditingAMessageTests.js
Normal file
72
services/chat/test/acceptance/js/EditingAMessageTests.js
Normal file
|
|
@ -0,0 +1,72 @@
|
||||||
|
/* eslint-disable
|
||||||
|
camelcase,
|
||||||
|
max-len,
|
||||||
|
*/
|
||||||
|
// TODO: This file was created by bulk-decaffeinate.
|
||||||
|
// Fix any style issues and re-enable lint.
|
||||||
|
/*
|
||||||
|
* decaffeinate suggestions:
|
||||||
|
* DS102: Remove unnecessary code created because of implicit returns
|
||||||
|
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
|
||||||
|
*/
|
||||||
|
const { ObjectId } = require('../../../app/js/mongodb')
|
||||||
|
const { expect } = require('chai')
|
||||||
|
|
||||||
|
const ChatClient = require('./helpers/ChatClient')
|
||||||
|
const ChatApp = require('./helpers/ChatApp')
|
||||||
|
|
||||||
|
describe('Editing a message', function () {
|
||||||
|
before(function (done) {
|
||||||
|
this.project_id = ObjectId().toString()
|
||||||
|
this.user_id = ObjectId().toString()
|
||||||
|
this.thread_id = ObjectId().toString()
|
||||||
|
return ChatApp.ensureRunning(done)
|
||||||
|
})
|
||||||
|
|
||||||
|
return describe('in a thread', function () {
|
||||||
|
before(function (done) {
|
||||||
|
this.content = 'thread message'
|
||||||
|
this.new_content = 'updated thread message'
|
||||||
|
return ChatClient.sendMessage(
|
||||||
|
this.project_id,
|
||||||
|
this.thread_id,
|
||||||
|
this.user_id,
|
||||||
|
this.content,
|
||||||
|
(error, response, message) => {
|
||||||
|
this.message = message
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(201)
|
||||||
|
expect(this.message.id).to.exist
|
||||||
|
expect(this.message.content).to.equal(this.content)
|
||||||
|
return ChatClient.editMessage(
|
||||||
|
this.project_id,
|
||||||
|
this.thread_id,
|
||||||
|
this.message.id,
|
||||||
|
this.new_content,
|
||||||
|
(error, response, new_message) => {
|
||||||
|
this.new_message = new_message
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(204)
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
return it('should then list the updated message in the threads', function (done) {
|
||||||
|
return ChatClient.getThreads(
|
||||||
|
this.project_id,
|
||||||
|
(error, response, threads) => {
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(200)
|
||||||
|
expect(threads[this.thread_id].messages.length).to.equal(1)
|
||||||
|
expect(threads[this.thread_id].messages[0].content).to.equal(
|
||||||
|
this.new_content
|
||||||
|
)
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
138
services/chat/test/acceptance/js/GettingMessagesTests.js
Normal file
138
services/chat/test/acceptance/js/GettingMessagesTests.js
Normal file
|
|
@ -0,0 +1,138 @@
|
||||||
|
/* eslint-disable
|
||||||
|
handle-callback-err,
|
||||||
|
max-len,
|
||||||
|
no-unused-vars,
|
||||||
|
*/
|
||||||
|
// TODO: This file was created by bulk-decaffeinate.
|
||||||
|
// Fix any style issues and re-enable lint.
|
||||||
|
/*
|
||||||
|
* decaffeinate suggestions:
|
||||||
|
* DS102: Remove unnecessary code created because of implicit returns
|
||||||
|
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
|
||||||
|
*/
|
||||||
|
const { ObjectId } = require('../../../app/js/mongodb')
|
||||||
|
const { expect } = require('chai')
|
||||||
|
const async = require('async')
|
||||||
|
const crypto = require('crypto')
|
||||||
|
|
||||||
|
const ChatClient = require('./helpers/ChatClient')
|
||||||
|
const ChatApp = require('./helpers/ChatApp')
|
||||||
|
|
||||||
|
describe('Getting messages', function () {
|
||||||
|
before(function (done) {
|
||||||
|
this.user_id1 = ObjectId().toString()
|
||||||
|
this.user_id2 = ObjectId().toString()
|
||||||
|
this.content1 = 'foo bar'
|
||||||
|
this.content2 = 'hello world'
|
||||||
|
return ChatApp.ensureRunning(done)
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('globally', function () {
|
||||||
|
before(function (done) {
|
||||||
|
this.project_id = ObjectId().toString()
|
||||||
|
return async.series(
|
||||||
|
[
|
||||||
|
cb =>
|
||||||
|
ChatClient.sendGlobalMessage(
|
||||||
|
this.project_id,
|
||||||
|
this.user_id1,
|
||||||
|
this.content1,
|
||||||
|
cb
|
||||||
|
),
|
||||||
|
cb =>
|
||||||
|
ChatClient.sendGlobalMessage(
|
||||||
|
this.project_id,
|
||||||
|
this.user_id2,
|
||||||
|
this.content2,
|
||||||
|
cb
|
||||||
|
),
|
||||||
|
],
|
||||||
|
done
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
return it('should contain the messages and populated users when getting the messages', function (done) {
|
||||||
|
return ChatClient.getGlobalMessages(
|
||||||
|
this.project_id,
|
||||||
|
(error, response, messages) => {
|
||||||
|
expect(messages.length).to.equal(2)
|
||||||
|
messages.reverse()
|
||||||
|
expect(messages[0].content).to.equal(this.content1)
|
||||||
|
expect(messages[0].user_id).to.equal(this.user_id1)
|
||||||
|
expect(messages[1].content).to.equal(this.content2)
|
||||||
|
expect(messages[1].user_id).to.equal(this.user_id2)
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
return describe('from all the threads', function () {
|
||||||
|
before(function (done) {
|
||||||
|
this.project_id = ObjectId().toString()
|
||||||
|
this.thread_id1 = ObjectId().toString()
|
||||||
|
this.thread_id2 = ObjectId().toString()
|
||||||
|
return async.series(
|
||||||
|
[
|
||||||
|
cb =>
|
||||||
|
ChatClient.sendMessage(
|
||||||
|
this.project_id,
|
||||||
|
this.thread_id1,
|
||||||
|
this.user_id1,
|
||||||
|
'one',
|
||||||
|
cb
|
||||||
|
),
|
||||||
|
cb =>
|
||||||
|
ChatClient.sendMessage(
|
||||||
|
this.project_id,
|
||||||
|
this.thread_id2,
|
||||||
|
this.user_id2,
|
||||||
|
'two',
|
||||||
|
cb
|
||||||
|
),
|
||||||
|
cb =>
|
||||||
|
ChatClient.sendMessage(
|
||||||
|
this.project_id,
|
||||||
|
this.thread_id1,
|
||||||
|
this.user_id1,
|
||||||
|
'three',
|
||||||
|
cb
|
||||||
|
),
|
||||||
|
cb =>
|
||||||
|
ChatClient.sendMessage(
|
||||||
|
this.project_id,
|
||||||
|
this.thread_id2,
|
||||||
|
this.user_id2,
|
||||||
|
'four',
|
||||||
|
cb
|
||||||
|
),
|
||||||
|
],
|
||||||
|
done
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
return it('should contain a dictionary of threads with messages with populated users', function (done) {
|
||||||
|
return ChatClient.getThreads(
|
||||||
|
this.project_id,
|
||||||
|
(error, response, threads) => {
|
||||||
|
expect(Object.keys(threads).length).to.equal(2)
|
||||||
|
const thread1 = threads[this.thread_id1]
|
||||||
|
expect(thread1.messages.length).to.equal(2)
|
||||||
|
const thread2 = threads[this.thread_id2]
|
||||||
|
expect(thread2.messages.length).to.equal(2)
|
||||||
|
|
||||||
|
expect(thread1.messages[0].content).to.equal('one')
|
||||||
|
expect(thread1.messages[0].user_id).to.equal(this.user_id1)
|
||||||
|
expect(thread1.messages[1].content).to.equal('three')
|
||||||
|
expect(thread1.messages[1].user_id).to.equal(this.user_id1)
|
||||||
|
|
||||||
|
expect(thread2.messages[0].content).to.equal('two')
|
||||||
|
expect(thread2.messages[0].user_id).to.equal(this.user_id2)
|
||||||
|
expect(thread2.messages[1].content).to.equal('four')
|
||||||
|
expect(thread2.messages[1].user_id).to.equal(this.user_id2)
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
147
services/chat/test/acceptance/js/ResolvingAThreadTests.js
Normal file
147
services/chat/test/acceptance/js/ResolvingAThreadTests.js
Normal file
|
|
@ -0,0 +1,147 @@
|
||||||
|
/* eslint-disable
|
||||||
|
camelcase,
|
||||||
|
max-len,
|
||||||
|
no-unused-vars,
|
||||||
|
*/
|
||||||
|
// TODO: This file was created by bulk-decaffeinate.
|
||||||
|
// Fix any style issues and re-enable lint.
|
||||||
|
/*
|
||||||
|
* decaffeinate suggestions:
|
||||||
|
* DS102: Remove unnecessary code created because of implicit returns
|
||||||
|
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
|
||||||
|
*/
|
||||||
|
const { ObjectId } = require('../../../app/js/mongodb')
|
||||||
|
const { expect } = require('chai')
|
||||||
|
const crypto = require('crypto')
|
||||||
|
|
||||||
|
const ChatClient = require('./helpers/ChatClient')
|
||||||
|
const ChatApp = require('./helpers/ChatApp')
|
||||||
|
|
||||||
|
describe('Resolving a thread', function () {
|
||||||
|
before(function (done) {
|
||||||
|
this.project_id = ObjectId().toString()
|
||||||
|
this.user_id = ObjectId().toString()
|
||||||
|
return ChatApp.ensureRunning(done)
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('with a resolved thread', function () {
|
||||||
|
before(function (done) {
|
||||||
|
this.thread_id = ObjectId().toString()
|
||||||
|
this.content = 'resolved message'
|
||||||
|
return ChatClient.sendMessage(
|
||||||
|
this.project_id,
|
||||||
|
this.thread_id,
|
||||||
|
this.user_id,
|
||||||
|
this.content,
|
||||||
|
(error, response, body) => {
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(201)
|
||||||
|
return ChatClient.resolveThread(
|
||||||
|
this.project_id,
|
||||||
|
this.thread_id,
|
||||||
|
this.user_id,
|
||||||
|
(error, response, body) => {
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(204)
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
return it('should then list the thread as resolved', function (done) {
|
||||||
|
return ChatClient.getThreads(
|
||||||
|
this.project_id,
|
||||||
|
(error, response, threads) => {
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(200)
|
||||||
|
expect(threads[this.thread_id].resolved).to.equal(true)
|
||||||
|
expect(threads[this.thread_id].resolved_by_user_id).to.equal(
|
||||||
|
this.user_id
|
||||||
|
)
|
||||||
|
const resolved_at = new Date(threads[this.thread_id].resolved_at)
|
||||||
|
expect(new Date() - resolved_at).to.be.below(1000)
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('when a thread is not resolved', function () {
|
||||||
|
before(function (done) {
|
||||||
|
this.thread_id = ObjectId().toString()
|
||||||
|
this.content = 'open message'
|
||||||
|
return ChatClient.sendMessage(
|
||||||
|
this.project_id,
|
||||||
|
this.thread_id,
|
||||||
|
this.user_id,
|
||||||
|
this.content,
|
||||||
|
(error, response, body) => {
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(201)
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
return it('should not list the thread as resolved', function (done) {
|
||||||
|
return ChatClient.getThreads(
|
||||||
|
this.project_id,
|
||||||
|
(error, response, threads) => {
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(200)
|
||||||
|
expect(threads[this.thread_id].resolved).to.be.undefined
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
return describe('when a thread is resolved then reopened', function () {
|
||||||
|
before(function (done) {
|
||||||
|
this.thread_id = ObjectId().toString()
|
||||||
|
this.content = 'resolved message'
|
||||||
|
return ChatClient.sendMessage(
|
||||||
|
this.project_id,
|
||||||
|
this.thread_id,
|
||||||
|
this.user_id,
|
||||||
|
this.content,
|
||||||
|
(error, response, body) => {
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(201)
|
||||||
|
return ChatClient.resolveThread(
|
||||||
|
this.project_id,
|
||||||
|
this.thread_id,
|
||||||
|
this.user_id,
|
||||||
|
(error, response, body) => {
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(204)
|
||||||
|
return ChatClient.reopenThread(
|
||||||
|
this.project_id,
|
||||||
|
this.thread_id,
|
||||||
|
(error, response, body) => {
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(204)
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
return it('should not list the thread as resolved', function (done) {
|
||||||
|
return ChatClient.getThreads(
|
||||||
|
this.project_id,
|
||||||
|
(error, response, threads) => {
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(200)
|
||||||
|
expect(threads[this.thread_id].resolved).to.be.undefined
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
197
services/chat/test/acceptance/js/SendingAMessageTests.js
Normal file
197
services/chat/test/acceptance/js/SendingAMessageTests.js
Normal file
|
|
@ -0,0 +1,197 @@
|
||||||
|
/* eslint-disable
|
||||||
|
handle-callback-err,
|
||||||
|
max-len,
|
||||||
|
no-return-assign,
|
||||||
|
node/no-deprecated-api,
|
||||||
|
*/
|
||||||
|
// TODO: This file was created by bulk-decaffeinate.
|
||||||
|
// Fix any style issues and re-enable lint.
|
||||||
|
/*
|
||||||
|
* decaffeinate suggestions:
|
||||||
|
* DS102: Remove unnecessary code created because of implicit returns
|
||||||
|
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
|
||||||
|
*/
|
||||||
|
const { ObjectId } = require('../../../app/js/mongodb')
|
||||||
|
const { expect } = require('chai')
|
||||||
|
|
||||||
|
const ChatClient = require('./helpers/ChatClient')
|
||||||
|
const ChatApp = require('./helpers/ChatApp')
|
||||||
|
|
||||||
|
describe('Sending a message', function () {
|
||||||
|
before(function (done) {
|
||||||
|
return ChatApp.ensureRunning(done)
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('globally', function () {
|
||||||
|
before(function (done) {
|
||||||
|
this.project_id = ObjectId().toString()
|
||||||
|
this.user_id = ObjectId().toString()
|
||||||
|
this.content = 'global message'
|
||||||
|
return ChatClient.sendGlobalMessage(
|
||||||
|
this.project_id,
|
||||||
|
this.user_id,
|
||||||
|
this.content,
|
||||||
|
(error, response, body) => {
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(201)
|
||||||
|
expect(body.content).to.equal(this.content)
|
||||||
|
expect(body.user_id).to.equal(this.user_id)
|
||||||
|
expect(body.room_id).to.equal(this.project_id)
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
return it('should then list the message in the project messages', function (done) {
|
||||||
|
return ChatClient.getGlobalMessages(
|
||||||
|
this.project_id,
|
||||||
|
(error, response, messages) => {
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(200)
|
||||||
|
expect(messages.length).to.equal(1)
|
||||||
|
expect(messages[0].content).to.equal(this.content)
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('to a thread', function () {
|
||||||
|
before(function (done) {
|
||||||
|
this.project_id = ObjectId().toString()
|
||||||
|
this.user_id = ObjectId().toString()
|
||||||
|
this.thread_id = ObjectId().toString()
|
||||||
|
this.content = 'thread message'
|
||||||
|
return ChatClient.sendMessage(
|
||||||
|
this.project_id,
|
||||||
|
this.thread_id,
|
||||||
|
this.user_id,
|
||||||
|
this.content,
|
||||||
|
(error, response, body) => {
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(201)
|
||||||
|
expect(body.content).to.equal(this.content)
|
||||||
|
expect(body.user_id).to.equal(this.user_id)
|
||||||
|
expect(body.room_id).to.equal(this.project_id)
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should then list the message in the threads', function (done) {
|
||||||
|
return ChatClient.getThreads(
|
||||||
|
this.project_id,
|
||||||
|
(error, response, threads) => {
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(200)
|
||||||
|
expect(threads[this.thread_id].messages.length).to.equal(1)
|
||||||
|
expect(threads[this.thread_id].messages[0].content).to.equal(
|
||||||
|
this.content
|
||||||
|
)
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
return it('should not appear in the global messages', function (done) {
|
||||||
|
return ChatClient.getGlobalMessages(
|
||||||
|
this.project_id,
|
||||||
|
(error, response, messages) => {
|
||||||
|
expect(error).to.be.null
|
||||||
|
expect(response.statusCode).to.equal(200)
|
||||||
|
expect(messages.length).to.equal(0)
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
return describe('failure cases', function () {
|
||||||
|
before(function () {
|
||||||
|
this.project_id = ObjectId().toString()
|
||||||
|
this.user_id = ObjectId().toString()
|
||||||
|
return (this.thread_id = ObjectId().toString())
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('with a malformed user_id', function () {
|
||||||
|
return it('should return a graceful error', function (done) {
|
||||||
|
return ChatClient.sendMessage(
|
||||||
|
this.project_id,
|
||||||
|
this.thread_id,
|
||||||
|
'malformed-user',
|
||||||
|
'content',
|
||||||
|
(error, response, body) => {
|
||||||
|
expect(response.statusCode).to.equal(400)
|
||||||
|
expect(body).to.equal('Invalid user_id')
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('with a malformed project_id', function () {
|
||||||
|
return it('should return a graceful error', function (done) {
|
||||||
|
return ChatClient.sendMessage(
|
||||||
|
'malformed-project',
|
||||||
|
this.thread_id,
|
||||||
|
this.user_id,
|
||||||
|
'content',
|
||||||
|
(error, response, body) => {
|
||||||
|
expect(response.statusCode).to.equal(400)
|
||||||
|
expect(body).to.equal('Invalid project_id')
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('with a malformed thread_id', function () {
|
||||||
|
return it('should return a graceful error', function (done) {
|
||||||
|
return ChatClient.sendMessage(
|
||||||
|
this.project_id,
|
||||||
|
'malformed-thread-id',
|
||||||
|
this.user_id,
|
||||||
|
'content',
|
||||||
|
(error, response, body) => {
|
||||||
|
expect(response.statusCode).to.equal(400)
|
||||||
|
expect(body).to.equal('Invalid thread_id')
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('with no content', function () {
|
||||||
|
return it('should return a graceful error', function (done) {
|
||||||
|
return ChatClient.sendMessage(
|
||||||
|
this.project_id,
|
||||||
|
this.thread_id,
|
||||||
|
this.user_id,
|
||||||
|
null,
|
||||||
|
(error, response, body) => {
|
||||||
|
expect(response.statusCode).to.equal(400)
|
||||||
|
expect(body).to.equal('No content provided')
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
return describe('with very long content', function () {
|
||||||
|
return it('should return a graceful error', function (done) {
|
||||||
|
const content = '-'.repeat(10 * 1024 + 1)
|
||||||
|
return ChatClient.sendMessage(
|
||||||
|
this.project_id,
|
||||||
|
this.thread_id,
|
||||||
|
this.user_id,
|
||||||
|
content,
|
||||||
|
(error, response, body) => {
|
||||||
|
expect(response.statusCode).to.equal(400)
|
||||||
|
expect(body).to.equal('Content too long (> 10240 bytes)')
|
||||||
|
return done()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
48
services/chat/test/acceptance/js/helpers/ChatApp.js
Normal file
48
services/chat/test/acceptance/js/helpers/ChatApp.js
Normal file
|
|
@ -0,0 +1,48 @@
|
||||||
|
/* eslint-disable
|
||||||
|
handle-callback-err,
|
||||||
|
*/
|
||||||
|
// TODO: This file was created by bulk-decaffeinate.
|
||||||
|
// Fix any style issues and re-enable lint.
|
||||||
|
/*
|
||||||
|
* decaffeinate suggestions:
|
||||||
|
* DS101: Remove unnecessary use of Array.from
|
||||||
|
* 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
|
||||||
|
*/
|
||||||
|
const { waitForDb } = require('../../../../app/js/mongodb')
|
||||||
|
const app = require('../../../../app')
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
running: false,
|
||||||
|
initing: false,
|
||||||
|
callbacks: [],
|
||||||
|
ensureRunning(callback) {
|
||||||
|
if (callback == null) {
|
||||||
|
callback = function (error) {}
|
||||||
|
}
|
||||||
|
if (this.running) {
|
||||||
|
return callback()
|
||||||
|
} else if (this.initing) {
|
||||||
|
return this.callbacks.push(callback)
|
||||||
|
}
|
||||||
|
this.initing = true
|
||||||
|
this.callbacks.push(callback)
|
||||||
|
waitForDb().then(() => {
|
||||||
|
return app.listen(3010, 'localhost', error => {
|
||||||
|
if (error != null) {
|
||||||
|
throw error
|
||||||
|
}
|
||||||
|
this.running = true
|
||||||
|
return (() => {
|
||||||
|
const result = []
|
||||||
|
for (callback of Array.from(this.callbacks)) {
|
||||||
|
result.push(callback())
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
})()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
},
|
||||||
|
}
|
||||||
113
services/chat/test/acceptance/js/helpers/ChatClient.js
Normal file
113
services/chat/test/acceptance/js/helpers/ChatClient.js
Normal file
|
|
@ -0,0 +1,113 @@
|
||||||
|
/* eslint-disable
|
||||||
|
camelcase,
|
||||||
|
max-len,
|
||||||
|
*/
|
||||||
|
// TODO: This file was created by bulk-decaffeinate.
|
||||||
|
// Fix any style issues and re-enable lint.
|
||||||
|
/*
|
||||||
|
* decaffeinate suggestions:
|
||||||
|
* DS102: Remove unnecessary code created because of implicit returns
|
||||||
|
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
|
||||||
|
*/
|
||||||
|
const request = require('request').defaults({
|
||||||
|
baseUrl: 'http://localhost:3010',
|
||||||
|
})
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
sendGlobalMessage(project_id, user_id, content, callback) {
|
||||||
|
return request.post(
|
||||||
|
{
|
||||||
|
url: `/project/${project_id}/messages`,
|
||||||
|
json: {
|
||||||
|
user_id,
|
||||||
|
content,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
callback
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
getGlobalMessages(project_id, callback) {
|
||||||
|
return request.get(
|
||||||
|
{
|
||||||
|
url: `/project/${project_id}/messages`,
|
||||||
|
json: true,
|
||||||
|
},
|
||||||
|
callback
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
sendMessage(project_id, thread_id, user_id, content, callback) {
|
||||||
|
return request.post(
|
||||||
|
{
|
||||||
|
url: `/project/${project_id}/thread/${thread_id}/messages`,
|
||||||
|
json: {
|
||||||
|
user_id,
|
||||||
|
content,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
callback
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
getThreads(project_id, callback) {
|
||||||
|
return request.get(
|
||||||
|
{
|
||||||
|
url: `/project/${project_id}/threads`,
|
||||||
|
json: true,
|
||||||
|
},
|
||||||
|
callback
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
resolveThread(project_id, thread_id, user_id, callback) {
|
||||||
|
return request.post(
|
||||||
|
{
|
||||||
|
url: `/project/${project_id}/thread/${thread_id}/resolve`,
|
||||||
|
json: {
|
||||||
|
user_id,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
callback
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
reopenThread(project_id, thread_id, callback) {
|
||||||
|
return request.post(
|
||||||
|
{
|
||||||
|
url: `/project/${project_id}/thread/${thread_id}/reopen`,
|
||||||
|
},
|
||||||
|
callback
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
deleteThread(project_id, thread_id, callback) {
|
||||||
|
return request.del(
|
||||||
|
{
|
||||||
|
url: `/project/${project_id}/thread/${thread_id}`,
|
||||||
|
},
|
||||||
|
callback
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
editMessage(project_id, thread_id, message_id, content, callback) {
|
||||||
|
return request.post(
|
||||||
|
{
|
||||||
|
url: `/project/${project_id}/thread/${thread_id}/messages/${message_id}/edit`,
|
||||||
|
json: {
|
||||||
|
content,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
callback
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
deleteMessage(project_id, thread_id, message_id, callback) {
|
||||||
|
return request.del(
|
||||||
|
{
|
||||||
|
url: `/project/${project_id}/thread/${thread_id}/messages/${message_id}`,
|
||||||
|
},
|
||||||
|
callback
|
||||||
|
)
|
||||||
|
},
|
||||||
|
}
|
||||||
Loading…
Reference in a new issue