overleaf/services/history-v1
Jakob Ackermann 4f25b0de91 Merge pull request #22028 from overleaf/jpa-logging
[misc] logging tweaks

GitOrigin-RevId: 7757b81b6c684955374038376035dc2bd272c4e8
2024-11-21 09:05:41 +00:00
..
api
benchmarks
config
migrations
storage Merge pull request #22028 from overleaf/jpa-logging 2024-11-21 09:05:41 +00:00
test Merge pull request #22028 from overleaf/jpa-logging 2024-11-21 09:05:41 +00:00
.gitignore
.mocharc.json
.nvmrc
app.js Add prefer-node-protocol ESLint rule (#21532) 2024-11-11 09:04:51 +00:00
backup-deletion-app.mjs
buildscript.txt
docker-compose.ci.yml Merge pull request #21681 from overleaf/jpa-back-fill-file-hash 2024-11-18 09:05:39 +00:00
docker-compose.yml Merge pull request #21681 from overleaf/jpa-back-fill-file-hash 2024-11-18 09:05:39 +00:00
Dockerfile Merge pull request #21627 from overleaf/ar-node-20 2024-11-15 09:04:32 +00:00
knexfile.js Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +00:00
Makefile
package.json Merge pull request #21996 from overleaf/jpa-stream-pg-result 2024-11-21 09:04:38 +00:00
README.md
tsconfig.json

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.