overleaf/services/project-history
Brian Gough acfeafd276 Merge pull request #12965 from overleaf/bg-improve-timeout-error
improve lock timeout error in project history

GitOrigin-RevId: fdcdacd4526e008f13c46c396fb13d07ae1b8c0f
2023-05-10 08:06:07 +00:00
..
.github Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +00:00
app/js Merge pull request #12965 from overleaf/bg-improve-timeout-error 2023-05-10 08:06:07 +00:00
config Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +00:00
scripts Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +00:00
test Merge pull request #12831 from overleaf/jpa-project-history-pipe 2023-05-09 08:04:14 +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 #12706 from overleaf/bg-rollback-broken-node-18-services 2023-04-20 08:03:54 +00:00
app.js Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +00:00
buildscript.txt Merge pull request #12706 from overleaf/bg-rollback-broken-node-18-services 2023-04-20 08:03:54 +00:00
docker-compose.ci.yml Merge pull request #12575 from overleaf/em-fix-chunk-replace-transaction 2023-04-19 08:03:10 +00:00
docker-compose.yml Merge pull request #12706 from overleaf/bg-rollback-broken-node-18-services 2023-04-20 08:03:54 +00:00
Dockerfile Merge pull request #12935 from overleaf/jpa-include-patches 2023-05-05 08:04:13 +00:00
Makefile Merge pull request #12575 from overleaf/em-fix-chunk-replace-transaction 2023-04-19 08:03:10 +00:00
nodemon.json Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +00:00
package.json Merge pull request #12831 from overleaf/jpa-project-history-pipe 2023-05-09 08:04:14 +00:00
README.md Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +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.