overleaf/services/project-history
Alf Eaton 2976fd0b44 Fix Dockerfile FromAsCasing warnings (#20388)
GitOrigin-RevId: 6d6be3ba17eec695907dde25da2dbe98818fae10
2024-09-23 08:04:52 +00:00
..
app/js Merge pull request #20520 from overleaf/em-ts-import 2024-09-23 08:04:47 +00:00
config Merge pull request #19847 from overleaf/jpa-rename-history-v1 2024-08-09 08:04:29 +00:00
scripts Merge pull request #17960 from overleaf/em-force-resync-hard 2024-04-22 08:04:15 +00:00
test Merge pull request #20520 from overleaf/em-ts-import 2024-09-23 08:04:47 +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 #17870 from overleaf/bg-node-upgrade-18-20-2 2024-04-24 08:05:16 +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 #17870 from overleaf/bg-node-upgrade-18-20-2 2024-04-24 08:05:16 +00:00
docker-compose.ci.yml Merge pull request #19282 from overleaf/jpa-filestore-sharding 2024-07-15 09:05:11 +00:00
docker-compose.yml Merge pull request #17870 from overleaf/bg-node-upgrade-18-20-2 2024-04-24 08:05:16 +00:00
Dockerfile Fix Dockerfile FromAsCasing warnings (#20388) 2024-09-23 08:04:52 +00:00
Makefile Merge pull request #19282 from overleaf/jpa-filestore-sharding 2024-07-15 09:05:11 +00:00
package.json Merge pull request #19951 from overleaf/bg-remove-unused-redis-from-project-history 2024-08-16 08:04:40 +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 #20331 from overleaf/jpa-build-scripts-sync 2024-09-10 08:05:01 +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.