Using Sentry Electron with Sentry React will cause the environment tag to be missing

[Claudia-teng]

Is there an existing issue for this?

• I have checked for existing issues https://github.com/getsentry/sentry-javascript/issues
• I have reviewed the documentation https://docs.sentry.io/
• I am using the latest SDK release https://github.com/getsentry/sentry-javascript/releases

How do you use Sentry?

Self-hosted/on-premise

Electron SDK Version

5.7.0

Electron Version

28.3.3

What platform are you using?

MacOS

Link to Sentry event

No response

Steps to Reproduce

1. Add sentry electron & sentry react to renderer process as the document recommended
   https://docs.sentry.io/platforms/javascript/guides/electron/#framework-specific-sdks

import * as Sentry from '@sentry/electron/renderer'
import { init as ReactInit } from '@sentry/react'

Sentry.init(
  {
    dsn: import.meta.env.VITE_SENTRY_DSN,
    environment: process.env.NODE_ENV
  },
  ReactInit
)

2. Throw an error in the renderer process function

3. Build the electron app

4. Occur the function that makes error

5. Check Sentry error with json format, and there's no environment attribute under "tags".

"tags": [
    [
      "browser.name",
      "Chrome"
    ],
    [
      "chrome",
      "Chrome 120.0.6099.291"
    ],
    [
      "chrome.name",
      "Chrome"
    ],
    [
      "device.family",
      "Desktop"
    ],
    [
      "event.environment",
      "javascript"
    ],
    [
      "event.origin",
      "electron"
    ],
    [
      "event.process",
      "renderer"
    ],
    [
      "handled",
      "yes"
    ],
    [
      "level",
      "error"
    ],
    [
      "mechanism",
      "generic"
    ],
    [
      "node",
      "Node 18.18.2"
    ],
    [
      "node.name",
      "Node"
    ],
    [
      "os",
      "macOS 13.3.1"
    ],
    [
      "os.name",
      "macOS"
    ],
    [
      "runtime",
      "Electron 28.3.3"
    ],
    [
      "runtime.name",
      "Electron"
    ],
    [
      "release",
      "xxx"
    ],
    [
      "user",
      "xxx"
    ],
    [
      "url",
      "xxx"
    ]
  ],

This will make environment field to be "--" on Sentry ui.

This only happens in production mode. In development mode, there is an "environment" tag,

 "tags": [
    [
      "browser.name",
      "Chrome"
    ],
    [
      "chrome",
      "Chrome 120.0.6099.291"
    ],
    [
      "chrome.name",
      "Chrome"
    ],
    [
      "device.family",
      "Desktop"
    ],
    [
      "environment",
      "development"
    ],
    [
      "event.environment",
      "javascript"
    ],
    [
      "event.origin",
      "electron"
    ],
    [
      "event.process",
      "renderer"
    ],
    [
      "handled",
      "yes"
    ],
    [
      "level",
      "error"
    ],
    [
      "mechanism",
      "generic"
    ],
    [
      "node",
      "Node 18.18.2"
    ],
    [
      "node.name",
      "Node"
    ],
    [
      "os",
      "macOS 13.3.1"
    ],
    [
      "os.name",
      "macOS"
    ],
    [
      "runtime",
      "Electron 28.3.3"
    ],
    [
      "runtime.name",
      "Electron"
    ],
    [
      "release",
      "xxx"
    ],
    [
      "user",
      "xxx"
    ],
    [
      "url",
      "xxx"
    ]
  ],

Expected Result

Can see which environment the error occurs

Actual Result

Missing the environment field

--

But If I only import sentry react, the environment tag appears.
It seems that using only sentry react works for catching correct errors and environment.

import * as Sentry from '@sentry/react'

Sentry.init({
  dsn: import.meta.env.VITE_SENTRY_DSN,
  environment: process.env.NODE_ENV
})

error json

"tags": [
    [
      "browser",
      "Electron 28.3.3"
    ],
    [
      "browser.name",
      "Electron"
    ],
    [
      "device",
      "Mac"
    ],
    [
      "device.family",
      "Mac"
    ],
    [
      "environment",
      "production"
    ],
    [
      "handled",
      "yes"
    ],
    [
      "level",
      "error"
    ],
    [
      "mechanism",
      "generic"
    ],
    [
      "os",
      "Mac OS X \u003E=10.15.7"
    ],
    [
      "os.name",
      "Mac OS X"
    ],
    [
      "release",
      "xxx"
    ],
    [
      "user",
      "xxx"
    ],
    [
      "url",
      "xxx"
    ]
  ],

The fields received are different.

Please advise, thanks!

[timfish]

Thanks for reporting this. It's on my list of things to take a look at!

[timfish]

With the Electron SDK, all events from renderers are sent through the Electron main process so that all events include the full app and machine context. The environment in the main process therefore takes precedence so you should set your desired environment there.

Maybe we should add some warnings if an environment is passed in the renderer so this is more obvious 🤔