overleaf/services/history-v1
Antoine Clausse 6c2cf20125 Merge pull request #20552 from overleaf/ac-update-node-fetch-2
Reapply "Upgrade node-fetch to 2.7.0", Fix fetch-utils tests

GitOrigin-RevId: b42a2d2c50ce73f474e39755845e4df065f30b48
2024-10-01 08:05:18 +00:00
..
api Merge pull request #20592 from overleaf/em-mj-load-history-version 2024-09-25 08:06:24 +00:00
benchmarks
config
migrations
storage Merge pull request #20695 from overleaf/bg-issue15972 2024-10-01 08:04:52 +00:00
test Merge pull request #17362 from overleaf/bg-chai-object-id-tests 2024-07-16 08:04:46 +00:00
.gitignore
.mocharc.json
.nvmrc
app.js
buildscript.txt Merge pull request #20332 from overleaf/jpa-small-runner 2024-09-26 08:04:38 +00:00
docker-compose.ci.yml
docker-compose.yml
Dockerfile Fix Dockerfile FromAsCasing warnings (#20388) 2024-09-23 08:04:52 +00:00
knexfile.js
Makefile Merge pull request #20332 from overleaf/jpa-small-runner 2024-09-26 08:04:38 +00:00
package.json Merge pull request #20552 from overleaf/ac-update-node-fetch-2 2024-10-01 08:05:18 +00:00
README.md
tsconfig.json Merge pull request #20331 from overleaf/jpa-build-scripts-sync 2024-09-10 08:05:01 +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.