Prefer builtin NODE_ENV over custom Playwright environment variable (#7723)

Remove explicit Playwright environment variable

Author: jacebrowning

e2e/playwright/fixtures/fixtureSetup.ts

@@ -134,7 +134,7 @@ export class ElectronZoo {
       args: ['.', '--no-sandbox'],
       env: {
         ...process.env,
-        IS_PLAYWRIGHT: 'true',
+        NODE_ENV: 'test',
       },
       ...(process.env.ELECTRON_OVERRIDE_DIST_PATH
         ? {

interface.d.ts

@@ -72,7 +72,6 @@ export interface IElectronAPI {
   }
   process: {
     env: {
-      IS_PLAYWRIGHT: string
       VITE_KITTYCAD_API_BASE_URL: string
       VITE_KITTYCAD_API_WEBSOCKET_URL: string
       VITE_KITTYCAD_API_TOKEN: string

src/components/CommandBar/CommandBarPathInput.tsx

@@ -74,7 +74,7 @@ function CommandBarPathInput({
 
   // Fire on component mount, if outside of e2e test context
   useEffect(() => {
-    window.electron.process.env.IS_PLAYWRIGHT !== 'true' &&
+    window.electron.process.env.NODE_ENV !== 'test' &&
       toSync(pickFileThroughNativeDialog, reportRejection)()
   }, [])
 

src/lib/desktop.ts

@@ -477,7 +477,7 @@ const getAppFolderName = () => {
 }
 
 export const getAppSettingsFilePath = async () => {
-  const isTestEnv = window.electron.process.env.IS_PLAYWRIGHT === 'true'
+  const isTestEnv = window.electron.process.env.NODE_ENV === 'test'
   const testSettingsPath = await window.electron.getAppTestProperty(
     'TEST_SETTINGS_FILE_KEY'
   )
@@ -499,7 +499,7 @@ export const getAppSettingsFilePath = async () => {
   return window.electron.path.join(fullPath, SETTINGS_FILE_NAME)
 }
 const getTokenFilePath = async () => {
-  const isTestEnv = window.electron.process.env.IS_PLAYWRIGHT === 'true'
+  const isTestEnv = window.electron.process.env.NODE_ENV === 'test'
   const testSettingsPath = await window.electron.getAppTestProperty(
     'TEST_SETTINGS_FILE_KEY'
   )
@@ -520,7 +520,7 @@ const getTokenFilePath = async () => {
 }
 
 const getTelemetryFilePath = async () => {
-  const isTestEnv = window.electron.process.env.IS_PLAYWRIGHT === 'true'
+  const isTestEnv = window.electron.process.env.NODE_ENV === 'test'
   const testSettingsPath = await window.electron.getAppTestProperty(
     'TEST_SETTINGS_FILE_KEY'
   )
@@ -541,7 +541,7 @@ const getTelemetryFilePath = async () => {
 }
 
 const getRawTelemetryFilePath = async () => {
-  const isTestEnv = window.electron.process.env.IS_PLAYWRIGHT === 'true'
+  const isTestEnv = window.electron.process.env.NODE_ENV === 'test'
   const testSettingsPath = await window.electron.getAppTestProperty(
     'TEST_SETTINGS_FILE_KEY'
   )
@@ -573,7 +573,7 @@ const getProjectSettingsFilePath = async (projectPath: string) => {
 }
 
 export const getInitialDefaultDir = async () => {
-  const isTestEnv = window.electron.process.env.IS_PLAYWRIGHT === 'true'
+  const isTestEnv = window.electron.process.env.NODE_ENV === 'test'
   const testSettingsPath = await window.electron.getAppTestProperty(
     'TEST_SETTINGS_FILE_KEY'
   )

src/lib/exportSave.ts

@@ -15,7 +15,7 @@ const save_ = async (file: ModelingAppFile, toastId: string) => {
         extensions.push(extension)
       }
 
-      if (window.electron.process.env.IS_PLAYWRIGHT) {
+      if (window.electron.process.env.NODE_ENV === 'test') {
         // Skip file picker, save to the test dir downloads directory
         const testSettingsPath = await window.electron.getAppTestProperty(
           'TEST_SETTINGS_FILE_KEY'

src/lib/isPlaywright.ts

@@ -3,7 +3,7 @@ import { IS_PLAYWRIGHT_KEY } from '@src/lib/constants'
 export function isPlaywright(): boolean {
   // ? checks for browser
   const electronRunTimePlaywright =
-    window?.electron?.process?.env.IS_PLAYWRIGHT == 'true'
+    window?.electron?.process?.env.NODE_ENV === 'test'
   const browserRuntimePlaywright =
     localStorage.getItem(IS_PLAYWRIGHT_KEY) === 'true'
   return electronRunTimePlaywright || browserRuntimePlaywright

src/lib/routeLoaders.ts

@@ -94,7 +94,7 @@ export const fileLoader: LoaderFunction = async (
 
       // If persistCode in localStorage is present, it'll persist that code
       // through *anything*. INTENDED FOR TESTS.
-      if (window.electron.process.env.IS_PLAYWRIGHT) {
+      if (window.electron.process.env.NODE_ENV === 'test') {
         code = codeManager.localStoragePersistCode() || code
       }
 

src/main.ts

@@ -63,7 +63,6 @@ const args = parseCLIArgs(process.argv)
 // @ts-ignore: TS1343
 const viteEnv = import.meta.env
 const NODE_ENV = process.env.NODE_ENV || viteEnv.MODE
-const IS_PLAYWRIGHT = process.env.IS_PLAYWRIGHT
 
 // dotenv override when present
 dotenv.config({ path: [`.env.${NODE_ENV}.local`, `.env.${NODE_ENV}`] })
@@ -96,7 +95,7 @@ if (process.defaultApp) {
 // Must be done before ready event.
 // Checking against this lock is needed for Windows and Linux, see
 // https://www.electronjs.org/docs/latest/tutorial/launch-app-from-url-in-another-app#windows-and-linux-code
-if (!singleInstanceLock && !IS_PLAYWRIGHT) {
+if (!singleInstanceLock && process.env.NODE_ENV !== 'test') {
   app.quit()
 } else {
   registerStartupListeners()
@@ -592,7 +591,7 @@ const getProjectPathAtStartup = async (
   // startup.
   // Since the args passed are always '.'
   // aka Forge for npm run tron:start live dev or playwright tests, but not dev packaged apps
-  if (MAIN_WINDOW_VITE_DEV_SERVER_URL || IS_PLAYWRIGHT) {
+  if (MAIN_WINDOW_VITE_DEV_SERVER_URL || process.env.NODE_ENV === 'test') {
     return null
   }
 

src/preload.ts

@@ -293,7 +293,6 @@ contextBridge.exposeInMainWorld('electron', {
         'VITE_KITTYCAD_API_TOKEN',
         'VITE_KITTYCAD_SITE_BASE_URL',
         'VITE_KITTYCAD_SITE_APP_URL',
-        'IS_PLAYWRIGHT',
         'TEST',
       ])
     ),