overleaf/services/history-v1
Miguel Serrano 2252bdb836 Merge pull request #13545 from overleaf/msm-fix-build-scripts
Fix build scripts and update to 4.3.0

GitOrigin-RevId: 90e57a410bc12e8cdfc7f757445c8352cd5d49eb
2023-07-17 11:08:32 +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 #13362 from overleaf/csh-issue-13004-Always-Retry-during-GCS-delete 2023-07-17 10:28:33 +00:00
migrations Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +00:00
storage Merge pull request #13256 from overleaf/csh-issue-13004-max-retries 2023-06-02 08:07:17 +00:00
test Merge pull request #11890 from overleaf/em-fix-deleted-chunks-indexes 2023-02-23 09:05:50 +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 #13545 from overleaf/msm-fix-build-scripts 2023-07-17 11:08:32 +00:00
app.js Merge pull request #13255 from overleaf/em-socket-leak-detection 2023-05-31 08:05:24 +00:00
buildscript.txt Merge pull request #13545 from overleaf/msm-fix-build-scripts 2023-07-17 11:08:32 +00:00
docker-compose.ci.yml Merge pull request #13274 from overleaf/csh-issue-13004-cleanup-custom-code 2023-06-02 08:05:10 +00:00
docker-compose.yml Merge pull request #13566 from overleaf/ae-node-docker 2023-07-17 10:45:23 +00:00
Dockerfile Merge pull request #13566 from overleaf/ae-node-docker 2023-07-17 10:45:23 +00:00
knexfile.js Avoid duplicating a math-closing dollar sign (#11227) 2023-01-16 08:41:42 +00:00
Makefile Merge pull request #13566 from overleaf/ae-node-docker 2023-07-17 10:45:23 +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.