Startseite Erkunden Hilfe
Registrieren Anmelden
creylopez
/
overleaf
1
0
Fork 0
Dateien Issues 0 Pull-Requests 0 Wiki
Struktur: 8a67258461
Branches Tags
overleaf
/
services
/
project-history
Jakob Ackermann 8a67258461 [project-history] remove unused DocumentUpdaterManager (#32537) vor 4 Monaten
..
app 8a67258461 [project-history] remove unused DocumentUpdaterManager (#32537) vor 4 Monaten
config 6f516b25af [project-history] add metrics for compression of updates (#26307) vor 1 Jahr
scripts 7e9a33841d [project-history] migrate retry_failures script to ESM (#26444) vor 1 Jahr
test 8a67258461 [project-history] remove unused DocumentUpdaterManager (#32537) vor 4 Monaten
.eslintignore ee85d948e2 Avoid duplicating a math-closing dollar sign (#11227) vor 3 Jahren
.mocharc.cjs fd0d21fbbd [monorepo] migrate build scripts to Jenkins (#29019) vor 10 Monaten
.nvmrc e80ce42896 Upgrade Node.js from 22.18 to 24.13 (#30509) vor 6 Monaten
Dockerfile da9da896c2 Revert "Revert "[project-history] migrate from joi to zod (#30187)" (#30681)" vor 6 Monaten
Makefile dbf6401f22 [monorepo] move retries from the outside to the per-test level (#31528) vor 5 Monaten
README.md a648015db8 Centralize prettier configuration to root level (#30501) vor 6 Monaten
app.js 81aab1e159 [misc] fix logger.error(err) and logger.warn(err) calls (#23369) vor 1 Jahr
buildscript.txt bf1f34bca6 Merge pull request #32197 from overleaf/lg-project-number-buildscripts vor 4 Monaten
docker-compose.ci.yml dbf6401f22 [monorepo] move retries from the outside to the per-test level (#31528) vor 5 Monaten
docker-compose.yml dbf6401f22 [monorepo] move retries from the outside to the per-test level (#31528) vor 5 Monaten
package.json dbf6401f22 [monorepo] move retries from the outside to the per-test level (#31528) vor 5 Monaten
tsconfig.json 7aa66b260c Merge pull request #28541 from overleaf/td-notifications-app-ts vor 10 Monaten

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.