[PR #3550] [CLOSED] feat: run database migration on backend start up #4429

New issue

Closed

opened 2026-03-17 01:57:56 +03:00 by kerem · 0 comments

kerem commented

2026-03-17 01:57:56 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/hoppscotch/hoppscotch/pull/3550
Author: @mirarifhasan
Created: 11/14/2023
Status: ❌ Closed

Base: release/2023.12.0 ← Head: feat/migrate-on-startup

📝 Commits (1)

fe1d700 feat: script command added in package.json

📊 Changes

4 files changed (+7 additions, -4 deletions)

View changed files

📝 aio_run.mjs (+1 -1)
📝 packages/hoppscotch-backend/Dockerfile (+2 -2)
📝 packages/hoppscotch-backend/package.json (+3 -0)
📝 prod.Dockerfile (+1 -1)

📄 Description

Closes HBE-313

Description

Previously we needed to run pnpx prisma migrate dev --name something to run database migration after container starts.
The drawback is, to run the migration command, the backend container must be in running state.

This brings an issue that, if anyonModuleInit needs to read from database, and database has not migrated earlier, thenonModuleInit fails as well as backend container fails to start. Since backend container fails to start, you can not run pnpx prisma migrate .... command by docker exec ....

In this PR, we introduce a script in the backend package.json to run migration before the backend container startup.
This way, you do not need to run pnpx prisma migrate ... anymore. During the container startup, migration will be executed itself.

Checks

My pull request adheres to the code style of this project
My code requires changes to the documentation
I have updated the documentation as required
All the tests have passed

Additional Information

Nil

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/hoppscotch/hoppscotch/pull/3550 **Author:** [@mirarifhasan](https://github.com/mirarifhasan) **Created:** 11/14/2023 **Status:** ❌ Closed **Base:** `release/2023.12.0` ← **Head:** `feat/migrate-on-startup` --- ### 📝 Commits (1) - [`fe1d700`](https://github.com/hoppscotch/hoppscotch/commit/fe1d7005b54aa56cbc82a13a4d43d32f3e8cab3c) feat: script command added in package.json ### 📊 Changes **4 files changed** (+7 additions, -4 deletions) <details> <summary>View changed files</summary> 📝 `aio_run.mjs` (+1 -1) 📝 `packages/hoppscotch-backend/Dockerfile` (+2 -2) 📝 `packages/hoppscotch-backend/package.json` (+3 -0) 📝 `prod.Dockerfile` (+1 -1) </details> ### 📄 Description    Closes HBE-313 ### Description  Previously we needed to run `pnpx prisma migrate dev --name something` to run database migration after container starts. The drawback is, to run the migration command, the backend container must be in running state. This brings an issue that, if any`onModuleInit` needs to read from database, and database has not migrated earlier, then`onModuleInit` fails as well as backend container fails to start. Since backend container fails to start, you can not run `pnpx prisma migrate ....` command by `docker exec ...`. In this PR, we introduce a script in the backend `package.json` to run migration before the backend container startup. This way, you do not need to run `pnpx prisma migrate ...` anymore. During the container startup, migration will be executed itself.  ### Checks  - [x] My pull request adheres to the code style of this project - [x] My code requires changes to the documentation - [ ] I have updated the documentation as required - [x] All the tests have passed ### Additional Information  Nil --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>