Including DD_TRACE_ESM_IMPORT & DD_TRACE_PACKAGE causes an unsuccessful prisma migrate command in CI

[AnishSDET1]

Issue

Including the following in GHA

NODE_OPTIONS: -r ${{ env.DD_TRACE_PACKAGE }} --import ${{ env.DD_TRACE_ESM_IMPORT }} causes the following command

**pnpm prisma migrate dev --schema libs/data/src/schema.prisma**

to be unsuccessful with no output and therefore unable to run our unit tests with vitest & DataDog Trace.

NOTE without NODE_OPTIONS: -r ${{ env.DD_TRACE_PACKAGE }} --import ${{ env.DD_TRACE_ESM_IMPORT }} this command works perfectly fine and starts logging the migration without any issues such as

Prisma schema loaded from libs/data/src/schema.prisma
Datasource "db": MySQL database "test_app" at "127.0.0.1:3306"
MySQL database test_app created at 127.0.0.1:3306
Applying migration `20210203112813_init`
Applying migration `20210222120942_remove`
......

So there is some kind of issue when including DD_TRACE_PACKAGE or DD_TRACE_ESM_IMPORT or both which causes prisma commands execution issues i.e. not able to execute these prisma commands.

Environment

GHA running on ubuntu

GHA File

name: Test
on:

env:
  DD_API_KEY: ${{ secrets.DD_API_KEY }}
jobs:
  tests:
    name: Run tests
    runs-on: ubuntu-latest
    timeout-minutes: 15
    strategy:
      fail-fast: false
      matrix:
        app: [test_app]
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
      - name: Install dependencies
        run: pnpm install

      - name: Configure Datadog Test Optimization
        uses: datadog/test-visibility-github-action@v2
        with:
          api_key: ${{ env.DD_API_KEY }}
          languages: js
          service: ${{ matrix.app }}
          site: datadoghq.eu

      - name: Run prisma migrate
        run: pnpm prisma migrate dev --schema libs/data/src/schema.prisma
        env:
          NODE_OPTIONS: -r ${{ env.DD_TRACE_PACKAGE }} --import ${{ env.DD_TRACE_ESM_IMPORT }}

[AnishSDET1]

Is there any updates on this ?

[anmarchenko]

Hi @AnishSDET1! Thank you for contacting us and sorry for the troubles. Our JS library engineer is out of office and will take a look at this issue next week

[Mariovido]

Hi @AnishSDET1, this should not be happening. Could you please share the logs of the action (removing sensitive information)? This will help me understand where it is failing. In the meantime, another thing that we can try is running your vitests directly without datadog/test-visibility-github-action (see instructions), and see if that solves the issue.

[AnishSDET1]

Thank you for your reply.

For now, it is not an issue with vitests but the command pnpm prisma migrate dev --schema libs/data/src/schema.prisma needs to succeed in order to run vitests which is not the case when including -r ${{ env.DD_TRACE_PACKAGE }} --import ${{ env.DD_TRACE_ESM_IMPORT }}

There are no logs, as GHA just choses to ignore prisma command when including -r ${{ env.DD_TRACE_PACKAGE }} --import ${{ env.DD_TRACE_ESM_IMPORT }} and does not even attempt to execute the command. And the same behaviour when without datadog/test-visibility-github-action.

Very simply, which I have narrowed down, see the 2 cases

WITHOUT NODE_OPTIONS: '--import dd-trace/register.js -r dd-trace/ci/init'

name: Test
on:
   push:

jobs:
  tests:
    name: Run tests
    runs-on: ubuntu-latest
    timeout-minutes: 15

    steps:
      - name: Checkout 
        uses: actions/checkout@v4
      - name: Setup Node
        uses: actions/setup-node@v4
        with:
          node-version: '20'
      - name: Install dependencies
        run: pnpm install

      - name: Run prisma migrate dev command
        run: pnpm prisma migrate dev --schema libs/data/src/schema.prisma

The following is reported Provided --schema at libs/data/src/schema.prisma does not exist - NOTE: I have deliberately deleted file schema.prisma as to keep it simple.`. So here, we have some kind of output.

WITH NODE_OPTIONS: '--import dd-trace/register.js -r dd-trace/ci/init'

name: Test
on:
   push:

jobs:
  tests:
    name: Run tests
    runs-on: ubuntu-latest
    timeout-minutes: 15

    steps:
      - name: Checkout 
        uses: actions/checkout@v4
      - name: Setup Node
        uses: actions/setup-node@v4
        with:
          node-version: '20'
      - name: Install dependencies
        run: pnpm install

      - name: Run tests
        run: pnpm prisma migrate dev --schema libs/data/src/schema.prisma
        env:
          NODE_OPTIONS: '--import dd-trace/register.js -r dd-trace/ci/init'

NO OUTPUT what so ever, so the pnpm prisma command is completely ignored when including NODE_OPTIONS: '--import dd-trace/register.js -r dd-trace/ci/init'

NOTE: I have also tried executing this command from JS script which GHA would call and the same behaviour, where its completely ignored when including these node options.

pnpm prisma commands REJECTS node options --import dd-trace/register.js OR -r dd-trace/ci/init for some reason OR both

NOTE: To reproduce this, a simple JS Node project can be created with node v20, pnpm (>=9.0.0), @prisma/client(4.16.12), prisma (4.16.2), dd-trace 5.49.0 dependencies and that GHA file, and then to execute the GHA file.

Please advice.

[AnishSDET1]

I have created a very small repro so it can be easily reproduced that shows the 2 cases

• WITHOUT NODE_OPTIONS: '--import dd-trace/register.js -r dd-trace/ci/init' - error reported schema does not exist.

• WITH NODE_OPTIONS: '--import dd-trace/register.js -r dd-trace/ci/init' NO OUTPUT what so ever, so prisma command is completely ignored when including NODE_OPTIONS: '--import dd-trace/register.js -r dd-trace/ci/init' - This needs debugging or fixing in dd-trace such that the command is executed and shows the same error as case 1

Shall I attach the small repro zip file ?

[Mariovido]

Hi @AnishSDET1 if you can attach the small repro (In a public repository), I would appreciate, as will make our investigating much faster.

[AnishSDET1]

Hi there, I will attach the zip file here as its a very small zip file, run the GHA file with & without node options and see the differences as stated above.

repro-datadog-main.zip

[Mariovido]

@AnishSDET1, could you create a public repo with the information of that zip? We are not allowed to work with this type of files.

[AnishSDET1]

@Mariovido The public repro is at https://github.com/rbs-path/repro-datadog

Thanks

[Mariovido]

Hi @AnishSDET1,
Sorry but I am bit confused. Does the pnpm prisma migrate dev --schema libs/data/src/schema.prisma command run any test? The NODE_OPTIONS should be put in the tests not in the prisma command. The workflow should be something like this:

...
      - name: Run migrations
        run: pnpm prisma migrate dev --schema libs/data/src/schema.prisma
      - name: Run tests
        shell: bash
        run: pnpm test:vitest
        env:
          NODE_OPTIONS: -r ${{ env.DD_TRACE_PACKAGE }} --import ${{ env.DD_TRACE_ESM_IMPORT }}
...

[AnishSDET1]

Yes I know, the NODE_OPTIONS are not needed when executing the prisma command.

Our setup of the prisma command and execution of the vitest is done in the same process. So something like

     - name: Run tests
        shell: bash
        run: pnpm test:vitest
        env:
          NODE_OPTIONS: -r ${{ env.DD_TRACE_PACKAGE }} --import ${{ env.DD_TRACE_ESM_IMPORT }}

which first sets up prima then runs the unit tests. And this is where the prisma call is not executed due to the DataDog Trace environment variables.

I did think of refactoring our setup, so the prisma is done in a different step followed by vitest step. But this is going to be a huge effort and not practical.

The underlying issue of including DD_TRACE causes prisma commands to be ignored which needs to be looked at.

[AnishSDET1]

Can this issue please be looked ? Or at least investigated please ?

The repro was only to show the issue very simply.

[Mariovido]

@AnishSDET1. This issue is not related with test-visibility-github-action. As you mentioned the prisma command is not executed due to the use of NODE_OPTIONS in the step. The action is working as expected.

In your specific case, you're setting NODE_OPTIONS for two command the prisma and the tests ones. The prisma command is not working as probably is crashing due to this setting.

To avoid this I would recommend to follow this guide to setup (Other Cloud CI Providers), and setup the tests in a more manual way. Following this steps you'll be able to setup only NODE_OPTIONS for the test command:

"test": "NODE_OPTIONS=\"--import dd-trace/register.js -r dd-trace/ci/init\" vitest run"
"test:ci": "prisma migrate dev --schema libs/data/src/schema.prisma && yarn test"

Hope this helps, but if you find any issue let me know

[AnishSDET1]

I have looked at the guide.

Yes, including DD_TRACE causes prisma command to crash. So something in dd-trace/register.js and dd-trace/ci/init causes the prisma to crash. I feel this is a dd-trace issue.

Even if I contact prisma, to say its an issue on their side, they would say its a DD_TRACE issue.

I am aware of the manual setup and workaround, which I had in mind when first creating this issue and I will have no other choice other than to use this, if the bug is not fixed.