Halaman utama Jelajahi Bantuan
Daftar Masuk
creylopez
/
overleaf
1
0
Fork 0
Berkas Masalah 0 Permintaan Tarik 0 Wiki
Pohon: 1b553c0455
Ranting Tag
overleaf
/
services
/
project-history
Jakob Ackermann 1b553c0455 [migrations] only apply non-blocking migrations in CI (#34665) 1 bulan lalu
..
app cb9e834a1f [project-history] return status "423 Locked" when redis lock is taken (#34429) 1 bulan lalu
config 6f516b25af [project-history] add metrics for compression of updates (#26307) 1 tahun lalu
scripts f8c7e092fa upgrade to eslint v10 (#34054) 2 bulan lalu
test 1b553c0455 [migrations] only apply non-blocking migrations in CI (#34665) 1 bulan lalu
.mocharc.cjs 44dee7592a use require.resolve for mocha reporter paths (#34235) 2 bulan lalu
.nvmrc 1a7de4ddd8 Upgrades Node.js from 24.13.0 → 24.14.1 (#32498) 4 bulan lalu
Dockerfile 7035a2e025 Revert "Acf pnp migration master" (#34709) 1 bulan lalu
Makefile 9fd0d644cf [agents] refine guidance for running tests (#34977) 1 bulan lalu
README.md 0d64a88a46 Yarn 4 Migration (#32253) 3 bulan lalu
app.js 81aab1e159 [misc] fix logger.error(err) and logger.warn(err) calls (#23369) 1 tahun lalu
buildscript.txt 6b084424b5 [monorepo] fix running make lint from root (#33559) 1 bulan lalu
docker-compose.ci.yml 9fd0d644cf [agents] refine guidance for running tests (#34977) 1 bulan lalu
docker-compose.yml 7035a2e025 Revert "Acf pnp migration master" (#34709) 1 bulan lalu
package.json 7035a2e025 Revert "Acf pnp migration master" (#34709) 1 bulan lalu
tsconfig.json 7aa66b260c Merge pull request #28541 from overleaf/td-notifications-app-ts 10 bulan lalu

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 yarn and Node on the local system:

yarn install
yarn 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 yarn 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 yarn 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 yarn 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 yarn scripts inside the appropriate docker containers, using the docker-compose files in the project.

Copyright (c) Overleaf, 2017-2021.