fix: Change to use database environment variables in dev mode

[0417taehyun]

About the changes

Problems

• I need to change the server-dev.ts code manually when trying to disable the migration even though it could be provided by the environment variable,DATABASE_DISABLE_MIGRATION.

Development Environment

• I usually handle my environment variables like the one below with .envrc, which are the same ways that I've been using on development and production environment.

export DATABASE_USERNAME=
export DATABASE_PASSWORD=
export DATABASE_HOST=
export DATABASE_PORT=
export DATABASE_NAME=
export DATABASE_SCHEMA=
export DATABASE_APPLICATION_NAME=
export DATABASE_DISABLE_MIGRATION=

• It might be better to handle them as the seamless way on the dev mode for the development experience.

Solutions

• I change to use database environment variables such as DATABASE_HOST when running dev mode
• I change contributing backend overview document to describe how to use pre-defined database with environment variables

Discussion points

In some cases, users want to use their pre-defined database in dev mode and now they only can use DATABASE_URL. However, it is more efficient to help them use separated options such as DATABASE_HOST and DATABASE_PORT.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
unleash-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 11, 2024 0:03am
unleash-monorepo-frontend	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 11, 2024 0:03am

[vercel]

@0417taehyun is attempting to deploy a commit to the unleash-team Team on Vercel.

A member of the Team first needs to authorize it.

[0417taehyun]

It would be better to handle migration flag through environment variable in dev mode because sometimes users don't want to run migration and they have to turn it off by fixing code if they can't handle it via environment variable.

[0417taehyun]

yarn seed:serve also use start:dev and it would be better to use the same environment variables instead of using different name such as UNLEASH_DATABASE_NAME.

[melindafekete]

Thanks! Left some suggestions for the docs.

[0417taehyun]

@melindafekete

Thanks! I applied your review on 34c6998 commit.

[0417taehyun]

I don't know why the test was failed even though I didn't change anything related of that 🤔

FAIL src/lib/features/metrics/instance/metrics.test.ts (8.894 s)
  ● bulk metrics › filters out metrics for environments we do not have access for. No auth setup so we can only access default env

    expect(received).toHaveLength(expected)

    Expected length: 1
    Received length: 0
    Received array:  []

      312 |             );
      313 |         expect(developmentReport).toHaveLength(0);
    > 314 |         expect(defaultReport).toHaveLength(1);
          |                               ^
      315 |         expect(defaultReport[0].yes).toBe(1000);
      316 |     });
      317 |

      at Object.toHaveLength (src/lib/features/metrics/instance/metrics.test.ts:314:31)

[ivarconr]

Thanks @0417taehyun!

In general the changes seems fine. But could you update the description to explain which problem it is solving for you and put some words on how you run Unleash / postgres locally while developing Unleash.

[0417taehyun]

@ivarconr

Hi, I've updated my description. Thanks!

[0417taehyun]

@ivarconr

Hi, is there any progress of this?