Acasă Explorează Ajutor
Înregistrare Autentificare
creylopez
/
Overleaf
1
0
Bifurcare 0
Fisiere Probleme 0 Trageți solicitările 0 Wiki
Arbore: be33d0dd67
Ramuri Etichete
Overleaf
/
services
/
project-history
Jakob Ackermann 0a7b2004d2 [misc] silence logger when running tests (#22243) 1 an în urmă
..
app 064baf31ad Merge pull request #23478 from overleaf/em-doc-hash-diff 1 an în urmă
config 762266cd87 [project-history] block filestore reads from old queue entries (#23096) 1 an în urmă
scripts f727389b2b [project-history] make logging of latency in resync script optional (#23325) 1 an în urmă
test 0a7b2004d2 [misc] silence logger when running tests (#22243) 1 an în urmă
.eslintignore ee85d948e2 Avoid duplicating a math-closing dollar sign (#11227) 3 ani în urmă
.gitignore ee85d948e2 Avoid duplicating a math-closing dollar sign (#11227) 3 ani în urmă
.mocharc.json ee85d948e2 Avoid duplicating a math-closing dollar sign (#11227) 3 ani în urmă
.nvmrc 272108a213 Run `bin/update_node 20.18.0 20.18.2` (#23074) 1 an în urmă
Dockerfile 272108a213 Run `bin/update_node 20.18.0 20.18.2` (#23074) 1 an în urmă
Makefile 5404dcb93d [misc] update build scripts (#23316) 1 an în urmă
README.md ee85d948e2 Avoid duplicating a math-closing dollar sign (#11227) 3 ani în urmă
app.js 81aab1e159 [misc] fix logger.error(err) and logger.warn(err) calls (#23369) 1 an în urmă
buildscript.txt 272108a213 Run `bin/update_node 20.18.0 20.18.2` (#23074) 1 an în urmă
docker-compose.ci.yml cbe7a2f5a9 Merge pull request #19282 from overleaf/jpa-filestore-sharding 2 ani în urmă
docker-compose.yml 0a7b2004d2 [misc] silence logger when running tests (#22243) 1 an în urmă
package.json c6c623da78 [project-history] script for fixing-up files/metadata with bulk resync (#23184) 1 an în urmă
tsconfig.json 84be385550 Merge pull request #20331 from overleaf/jpa-build-scripts-sync 2 ani în urmă

README.md

@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.