overleaf/services/history-v1
Jakob Ackermann a2cf7b459c Merge pull request #14902 from overleaf/jpa-node-18-18-0
[misc] upgrade Node.js to latest LTS 18.18.0

GitOrigin-RevId: 96c7171065ceb8797c28efa4ab331d86a84868d2
2023-09-25 08:04:25 +00:00
..
api Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +00:00
benchmarks Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +00:00
config Merge pull request #14075 from overleaf/jpa-trim-space 2023-08-03 08:03:45 +00:00
migrations Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +00:00
storage Merge pull request #14544 from overleaf/jlm-add-history-restore-script 2023-08-31 08:04:31 +00:00
test Merge pull request #14419 from overleaf/em-history-lib-async-await 2023-08-23 08:05:38 +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 #14902 from overleaf/jpa-node-18-18-0 2023-09-25 08:04:25 +00:00
app.js Merge pull request #14138 from overleaf/bg-em-jpa-mj-node-18 2023-08-03 08:03:56 +00:00
buildscript.txt Merge pull request #14902 from overleaf/jpa-node-18-18-0 2023-09-25 08:04:25 +00:00
docker-compose.ci.yml Merge pull request #13060 from overleaf/bg-upgrade-fake-gcs-server 2023-07-24 08:03:58 +00:00
docker-compose.yml Merge pull request #14902 from overleaf/jpa-node-18-18-0 2023-09-25 08:04:25 +00:00
Dockerfile Merge pull request #14902 from overleaf/jpa-node-18-18-0 2023-09-25 08:04:25 +00:00
knexfile.js Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +00:00
Makefile Merge pull request #14902 from overleaf/jpa-node-18-18-0 2023-09-25 08:04:25 +00:00
nodemon.json Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +00:00
package.json Merge pull request #12916 from overleaf/bg-move-stream-buffer-code-to-library 2023-06-02 08:05:57 +00:00
README.md Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +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.