overleaf/services/project-history
Domagoj Kriskovic 8bde496da4 Send operations to project-history when resolving/unresolving comments (#17540)
* Send operations to project-history when resolving/unresolving comments

* small fixes

* added doc_id in web unit test

* Revert "added doc_id in web unit test"

This reverts commit f0b8251abfce17965d5e1b0e45d8784fcf1d9eed.

* fix mocked dependency in test

* wip: web unit tests

* document updater, reopen test

* document-updater tests

* format fix

* fix typo

* fix callsArgWith

* fix reopenThread calls in doc updater tests

* fix typos

* log error if chat api resolve failes

* log error when reopening thread

* sendStatus calls done() in tests

* using OError instead of logging

* removed timers

* preserve legacy endpoints

* update after merge

* Remove timer check in HttpControllerTest

* prettier

* added "legacy" in log

* remove metrics.timer

* fix promisify issues

* remove unused cb

GitOrigin-RevId: 849538c86996973a065c727835e93028e5429344
2024-04-10 08:04:08 +00:00
..
app/js Send operations to project-history when resolving/unresolving comments (#17540) 2024-04-10 08:04:08 +00:00
config Merge pull request #16873 from overleaf/dp-mongo-command-monitoring 2024-02-23 09:02:55 +00:00
scripts Merge pull request #17525 from overleaf/ae-upgrade-prettier 2024-03-26 09:04:05 +00:00
test [project-history] fix convertToDiffUpdates when track delete is moved by previous op (#17681) 2024-04-10 08:04:03 +00:00
.eslintignore Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +00:00
.gitignore Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +00:00
.mocharc.json Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +00:00
.nvmrc Merge pull request #17748 from overleaf/bg-node-security-upgrade-2024-04-05 2024-04-08 08:04:41 +00:00
app.js Merge pull request #15241 from overleaf/em-gcp-opentelemetry 2023-10-19 08:02:52 +00:00
buildscript.txt Merge pull request #17748 from overleaf/bg-node-security-upgrade-2024-04-05 2024-04-08 08:04:41 +00:00
docker-compose.ci.yml Merge pull request #16849 from overleaf/hb-issue-16799-mongdodb-v5-to-v6 2024-02-14 09:04:38 +00:00
docker-compose.yml Merge pull request #17748 from overleaf/bg-node-security-upgrade-2024-04-05 2024-04-08 08:04:41 +00:00
Dockerfile Merge pull request #17748 from overleaf/bg-node-security-upgrade-2024-04-05 2024-04-08 08:04:41 +00:00
Makefile Merge pull request #17748 from overleaf/bg-node-security-upgrade-2024-04-05 2024-04-08 08:04:41 +00:00
package.json Merge pull request #17285 from overleaf/ae-nock 2024-02-29 09:03:58 +00:00
README.md Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +00:00
tsconfig.json Merge pull request #16385 from overleaf/em-typescript-other-services 2024-01-12 09:03:22 +00:00

@overleaf/project-history

An API for converting raw editor updates into a compressed and browseable history.

Running project-history

The app runs natively using npm and Node on the local system:

npm install
npm run start

Unit Tests

The test suites run in Docker.

Unit tests can be run in the test_unit container defined in docker-compose.tests.yml.

The makefile contains a short cut to run these:

make install # Only needs running once, or when npm packages are updated
make test_unit

During development it is often useful to only run a subset of tests, which can be configured with arguments to the mocha CLI:

make test_unit MOCHA_ARGS='--grep=AuthorizationManager'

Acceptance Tests

Acceptance tests are run against a live service, which runs in the acceptance_test container defined in docker-compose.tests.yml.

To run the tests out-of-the-box, the makefile defines:

make install # Only needs running once, or when npm packages are updated
make test_acceptance

However, during development it is often useful to leave the service running for rapid iteration on the acceptance tests. This can be done with:

make test_acceptance_start_service
make test_acceptance_run # Run as many times as needed during development
make test_acceptance_stop_service

make test_acceptance just runs these three commands in sequence.

During development it is often useful to only run a subset of tests, which can be configured with arguments to the mocha CLI:

make test_acceptance_run MOCHA_ARGS='--grep=AuthorizationManager'

Makefile and npm scripts

The commands used to compile the app and tests, to run the mocha tests, and to run the app are all in package.json. These commands call out to coffee, mocha, etc which are available to npm in the local node_modules/.bin directory, using the local versions. Normally, these commands should not be run directly, but instead run in docker via make.

The makefile contains a collection of shortcuts for running the npm scripts inside the appropriate docker containers, using the docker-compose files in the project.

Copyright (c) Overleaf, 2017-2021.