overleaf/services/history-v1
Jakob Ackermann 63520c7076 Merge pull request #16859 from overleaf/jpa-sharelatex-cleanup
[misc] ShareLaTeX cleanup - high impact

GitOrigin-RevId: 6dcce9b0f15e30f7afcf6d69c3df36a369f38120
2024-02-09 09:04:11 +00:00
..
api Merge pull request #15410 from overleaf/jpa-history-v1-verbose-logging 2023-10-25 08:04:54 +00:00
benchmarks Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +00:00
config Merge pull request #16859 from overleaf/jpa-sharelatex-cleanup 2024-02-09 09:04:11 +00:00
migrations Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +00:00
storage Merge pull request #15445 from overleaf/jpa-history-v1-gzip-in-place 2023-10-26 08:03:41 +00:00
test [overleaf-editor-core] Restructure TextOperation hierachy (#16582) 2024-01-24 09:04:18 +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 #15506 from overleaf/jpa-node-18-18-2 2023-11-01 09:02:48 +00:00
app.js Merge pull request #15409 from overleaf/jpa-history-v1-http-timeout 2023-10-25 08:04:50 +00:00
buildscript.txt Merge pull request #16058 from overleaf/jpa-faster-restart 2023-12-08 09:04:01 +00:00
docker-compose.ci.yml Merge pull request #16859 from overleaf/jpa-sharelatex-cleanup 2024-02-09 09:04:11 +00:00
docker-compose.yml Merge pull request #16859 from overleaf/jpa-sharelatex-cleanup 2024-02-09 09:04:11 +00:00
Dockerfile Merge pull request #15506 from overleaf/jpa-node-18-18-2 2023-11-01 09:02:48 +00:00
knexfile.js Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +00:00
Makefile Merge pull request #16845 from overleaf/csh-docker-compose 2024-02-01 09:03:43 +00:00
package.json Merge pull request #16524 from overleaf/em-fix-typescript-backend 2024-01-17 09:03:42 +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 #16385 from overleaf/em-typescript-other-services 2024-01-12 09:03:22 +00:00

Database migrations

The history service uses knex to manage PostgreSQL migrations.

To create a new migrations, run:

npx knex migrate:make migration_name

To apply migrations, run:

npx knex migrate:latest

For more information, consult the knex migrations guide.

Global blobs

Global blobs are blobs that are shared between projects. The list of global blobs is stored in the projectHistoryGlobalBlobs Mongo collection and is read when the service starts. Changing the list of global blobs needs to be done carefully.

Adding a blob to the global blobs list

If we identify a blob that appears in many projects, we might want to move that blob to the global blobs list.

  1. Add a record for the blob to the projectHistoryGlobalBlobs collection.
  2. Restart the history service.
  3. Delete any corresponding project blobs.

Removing a blob from the global blobs list

Removing a blob from the global blobs list is trickier. As soon as the global blob is made unavailable, every project that needs the blob will have to get its own copy. To avoid disruptions, follow these steps:

  1. In the projectHistoryGlobalBlobs collection, set the demoted property to false on the global blob to remove. This will make the history system write new instances of this blob to project blobs, but still read from the global blob.

  2. Restart the history service.

  3. Copy the blob to all projects that need it.

  4. Remove the blob from the projectHistoryGlobalBlobs collection.

  5. Restart the history service.