Issue 0 file pathing and environments (#179)

rphovley · web-flow · commit b72eb60b6675 · 2024-08-21T23:56:49.000-06:00
diff --git a/bin/startup.js b/bin/startup.js
@@ -4,35 +4,23 @@ const { spawn } = require('child_process')
 // node is often not in path for the service process
 process.env.PATH = `${process.env.PATH}:${process.env.NODE_PATH}`
 
-if (process.env.DEBUG === '*') {
-  console.log('DEBUG: Starting the server')
+const isProduction = process.env.NODE_ENV === 'production'
+
+if (!isProduction) {
+  console.log('DEVELOPMENT: Starting the server')
   console.log(`process.env: ${JSON.stringify(process.env)}`)
 }
 
-const isProduction = process.env.NODE_ENV === 'production'
-
-const runScript = isProduction
+isProduction
   ? spawn('npx', ['codeclimbers', 'start', 'server'], {
       shell: true,
+      stdio: 'inherit',
     })
-  : spawn('node', [
-      `${process.env.CODE_CLIMBER_BIN_PATH}/run.js`,
-      'start',
-      'server',
-    ])
-
-runScript.stdout.on('data', (data) => {
-  process.stdout.write(data)
-})
-
-runScript.stderr.on('data', (data) => {
-  process.stderr.write(data)
-})
-
-runScript.on('close', (code) => {
-  console.log(`Child process exited with code ${code}`)
-})
-
-runScript.on('error', (error) => {
-  console.error(`Error executing the script: ${error.message}`)
-})
+  : spawn(
+      'node',
+      [`${process.env.CODE_CLIMBER_BIN_PATH}/run.js`, 'start', 'server'],
+      {
+        shell: true,
+        stdio: 'inherit',
+      },
+    )
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/server/commands/start/index.ts b/packages/server/commands/start/index.ts
@@ -6,7 +6,9 @@ import find from 'find-process'
 import pc from 'picocolors'
 
 import http from 'http'
-import { bootstrap, SERVER_CONSTANTS, StartupServiceFactory } from '../..'
+import { StartupServiceFactory } from '../../src/v1/startup/startupService.factory'
+import { bootstrap } from '../../src/main'
+import { PROCESS_NAME } from '../../utils/constants'
 
 const MAX_ATTEMPTS = 10
 const POLL_INTERVAL = 3000 // 3 seconds
@@ -78,10 +80,7 @@ export default class Start extends Command {
   }
 
   async run(): Promise<void> {
-    const [codeclimbersInstance] = await find(
-      'name',
-      SERVER_CONSTANTS.PROCESS_NAME,
-    )
+    const [codeclimbersInstance] = await find('name', PROCESS_NAME)
 
     if (codeclimbersInstance) {
       return this.error(
diff --git a/packages/server/commands/startup/disable.ts b/packages/server/commands/startup/disable.ts
@@ -1,7 +1,7 @@
 process.env.CODECLIMBERS_SERVER_APP_CONTEXT = 'cli'
 
 import { Command } from '@oclif/core'
-import { StartupServiceFactory } from '../..'
+import { StartupServiceFactory } from '../../src/v1/startup/startupService.factory'
 
 export default class Disable extends Command {
   static description = 'Disable starting codeclimbers on computer startup'
diff --git a/packages/server/commands/startup/enable.ts b/packages/server/commands/startup/enable.ts
@@ -1,7 +1,7 @@
 process.env.CODECLIMBERS_SERVER_APP_CONTEXT = 'cli'
 
 import { Command } from '@oclif/core'
-import { StartupServiceFactory } from '../..'
+import { StartupServiceFactory } from '../../src/v1/startup/startupService.factory'
 
 export default class Disable extends Command {
   static description = 'Disable starting codeclimbers on computer startup'
diff --git a/packages/server/commands/stop/index.ts b/packages/server/commands/stop/index.ts
@@ -5,7 +5,7 @@ import { exec as _exec } from 'node:child_process'
 import util from 'node:util'
 import os from 'node:os'
 import find from 'find-process'
-import { SERVER_CONSTANTS } from '../..'
+import { PROCESS_NAME } from '../../utils/constants'
 // eslint-disable-next-line import/no-unresolved
 
 const exec = util.promisify(_exec)
@@ -18,12 +18,10 @@ export default class Stop extends Command {
   static examples = [`<%= config.bin %> <%= command.id %>`]
 
   async run(): Promise<void> {
-    const [instance] = await find('name', SERVER_CONSTANTS.PROCESS_NAME)
+    const [instance] = await find('name', PROCESS_NAME)
 
     if (!instance) {
-      this.error(
-        `Could not find a running instance of ${SERVER_CONSTANTS.PROCESS_NAME}`,
-      )
+      this.error(`Could not find a running instance of ${PROCESS_NAME}`)
     }
 
     const { stdout, stderr } = await exec(
@@ -36,8 +34,6 @@ export default class Stop extends Command {
       this.error(stderr)
     }
 
-    this.log(
-      `Stopped ${SERVER_CONSTANTS.PROCESS_NAME} - ${stdout || 'Success!'}`,
-    )
+    this.log(`Stopped ${PROCESS_NAME} - ${stdout || 'Success!'}`)
   }
 }
diff --git a/packages/server/index.ts b/packages/server/index.ts
diff --git a/packages/server/src/app.module.ts b/packages/server/src/app.module.ts
@@ -6,7 +6,7 @@ import { RequestLoggerMiddleware } from './common/infrastructure/http/middleware
 import { ServeStaticModule } from '@nestjs/serve-static'
 import { DbModule } from './v1/database/knex'
 import { SentryModule } from '@sentry/nestjs/setup'
-import { APP_PATH } from '../utils/node.util'
+import { APP_DIST_PATH } from '../utils/node.util'
 
 @Module({
   imports: [
@@ -20,7 +20,7 @@ import { APP_PATH } from '../utils/node.util'
       },
     ]),
     ServeStaticModule.forRoot({
-      rootPath: APP_PATH,
+      rootPath: APP_DIST_PATH,
     }),
   ],
   providers: [
diff --git a/packages/server/src/main.ts b/packages/server/src/main.ts
@@ -4,7 +4,7 @@ import './sentry'
 import { NestFactory } from '@nestjs/core'
 import { AppModule } from './app.module'
 import { Logger, ValidationPipe } from '@nestjs/common'
-import { isCli } from '../utils/environment.util'
+import { isCli, isProd } from '../utils/environment.util'
 import { PROCESS_NAME } from '../utils/constants'
 import { updateSettings } from '../utils/wakatime.util'
 import { startMigrations } from './v1/database/migrations'
@@ -13,20 +13,18 @@ const updatedIniValues: Record<string, string> = {
   api_key: 'eacb3beb-dad8-4fa1-b6ba-f89de8bf8f4a', // placeholder value
   api_url: 'http://localhost:14400/api/v1/wakatime',
 }
-const shouldShowDebugLogs =
-  process.env.DEBUG === '*' || process.env.NODE_ENV === 'development'
 
 const traceEnvironment = () => {
-  Logger.log(`Running as: ${process.env.NODE_ENV}`, 'main.ts')
-  Logger.log(`process.env: ${JSON.stringify(process.env)}`, 'main.ts')
+  Logger.debug(`Running as: ${process.env.NODE_ENV}`, 'main.ts')
+  Logger.debug(`process.env: ${JSON.stringify(process.env)}`, 'main.ts')
 }
 
 export async function bootstrap() {
   const port = process.env.CODECLIMBERS_SERVER_PORT || 14_400
   const app = await NestFactory.create(AppModule, {
-    logger: shouldShowDebugLogs
+    logger: !isProd()
       ? ['log', 'debug', 'error', 'verbose', 'warn']
-      : ['error', 'warn'],
+      : ['log', 'error', 'warn'],
   })
   traceEnvironment()
 
diff --git a/packages/server/src/sentry.ts b/packages/server/src/sentry.ts
@@ -1,7 +1,8 @@
 import * as Sentry from '@sentry/nestjs'
 import { nodeProfilingIntegration } from '@sentry/profiling-node'
+import { isProd } from '../utils/environment.util'
 
-if (process.env.NODE_ENV === 'production') {
+if (isProd()) {
   Sentry.init({
     dsn: 'https://e885e4c5eeed09d6229c7d7bfdc8d762@o4507772937043968.ingest.us.sentry.io/4507772946022400',
     integrations: [nodeProfilingIntegration()],
diff --git a/packages/server/src/v1/startup/darwinStartup.service.ts b/packages/server/src/v1/startup/darwinStartup.service.ts
@@ -6,6 +6,7 @@ import {
   NODE_PATH,
 } from '../../../utils/node.util'
 import startupUtil from './startup.util'
+import { isDev } from '../../../utils/environment.util'
 const { Service } = startupUtil.getServiceLib()
 
 @Injectable()
@@ -29,11 +30,7 @@ export class DarwinStartupService implements CodeClimbers.StartupService {
         },
         {
           name: 'NODE_PATH',
-          value: NODE_PATH,
-        },
-        {
-          name: 'DEBUG',
-          value: process.env.DEBUG,
+          value: NODE_PATH(),
         },
       ],
       logOnAsUser: true,
@@ -43,7 +40,7 @@ export class DarwinStartupService implements CodeClimbers.StartupService {
       maxRestarts: 10,
     })
 
-    if (process.env.NODE_ENV === 'development' || process.env.DEBUG === '*') {
+    if (isDev()) {
       this.service.on('install', () => {
         console.log(`${this.service.name} installed`)
       })
diff --git a/packages/server/src/v1/startup/linuxStartup.service.ts b/packages/server/src/v1/startup/linuxStartup.service.ts
@@ -3,6 +3,7 @@ import { Injectable, Logger } from '@nestjs/common'
 import * as path from 'node:path'
 import { BIN_PATH, CODE_CLIMBER_META_DIR } from '../../../utils/node.util'
 import startupUtil from './startup.util'
+import { isDev } from '../../../utils/environment.util'
 const { Service } = startupUtil.getServiceLib()
 
 @Injectable()
@@ -18,7 +19,7 @@ export class LinuxStartupService implements CodeClimbers.StartupService {
       env: [
         {
           name: 'NODE_ENV',
-          value: 'production',
+          value: process.env.NODE_ENV || 'production',
         },
         {
           name: 'CODE_CLIMBER_BIN_PATH',
@@ -31,30 +32,31 @@ export class LinuxStartupService implements CodeClimbers.StartupService {
       grow: 0,
       maxRestarts: 10,
     })
+    if (isDev()) {
+      this.service.on('install', () => {
+        Logger.debug(`${this.service.name.get} installed`)
+      })
 
-    this.service.on('install', () => {
-      Logger.log(`${this.service.name.get} installed`)
-    })
-
-    this.service.on('alreadyinstalled', () => {
-      Logger.log(`${this.service.name} already installed`)
-    })
+      this.service.on('alreadyinstalled', () => {
+        Logger.debug(`${this.service.name} already installed`)
+      })
 
-    this.service.on('uninstall', () => {
-      Logger.log(`${this.service.name} uninstalled`)
-    })
+      this.service.on('uninstall', () => {
+        Logger.debug(`${this.service.name} uninstalled`)
+      })
 
-    this.service.on('start', () => {
-      Logger.log(`${this.service.name} started`)
-    })
+      this.service.on('start', () => {
+        Logger.debug(`${this.service.name} started`)
+      })
 
-    this.service.on('stop', () => {
-      Logger.log(`${this.service.name} stopped`)
-    })
+      this.service.on('stop', () => {
+        Logger.debug(`${this.service.name} stopped`)
+      })
 
-    this.service.on('error', (error) => {
-      Logger.error(`${this.service.name} error:`, error)
-    })
+      this.service.on('error', (error) => {
+        Logger.error(`${this.service.name} error:`, error)
+      })
+    }
   }
 
   async enableStartup(): Promise<void> {
diff --git a/packages/server/src/v1/startup/windowsStartup.service.ts b/packages/server/src/v1/startup/windowsStartup.service.ts
@@ -3,6 +3,7 @@ import { Injectable, Logger } from '@nestjs/common'
 import * as path from 'node:path'
 import { BIN_PATH, CODE_CLIMBER_META_DIR } from '../../../utils/node.util'
 import startupUtil from './startup.util'
+import { isDev } from '../../../utils/environment.util'
 const { Service } = startupUtil.getServiceLib()
 
 @Injectable()
@@ -18,7 +19,7 @@ export class WindowsStartupService implements CodeClimbers.StartupService {
       env: [
         {
           name: 'NODE_ENV',
-          value: 'production',
+          value: process.env.NODE_ENV || 'production',
         },
         {
           name: 'CODE_CLIMBER_BIN_PATH',
@@ -31,30 +32,31 @@ export class WindowsStartupService implements CodeClimbers.StartupService {
       grow: 0,
       maxRestarts: 10,
     })
+    if (isDev()) {
+      this.service.on('install', () => {
+        Logger.debug(`${this.service.name.get} installed`)
+      })
 
-    this.service.on('install', () => {
-      Logger.log(`${this.service.name.get} installed`)
-    })
-
-    this.service.on('alreadyinstalled', () => {
-      Logger.log(`${this.service.name} already installed`)
-    })
+      this.service.on('alreadyinstalled', () => {
+        Logger.debug(`${this.service.name} already installed`)
+      })
 
-    this.service.on('uninstall', () => {
-      Logger.log(`${this.service.name} uninstalled`)
-    })
+      this.service.on('uninstall', () => {
+        Logger.debug(`${this.service.name} uninstalled`)
+      })
 
-    this.service.on('start', () => {
-      Logger.log(`${this.service.name} started`)
-    })
+      this.service.on('start', () => {
+        Logger.debug(`${this.service.name} started`)
+      })
 
-    this.service.on('stop', () => {
-      Logger.log(`${this.service.name} stopped`)
-    })
+      this.service.on('stop', () => {
+        Logger.debug(`${this.service.name} stopped`)
+      })
 
-    this.service.on('error', (error) => {
-      Logger.error(`${this.service.name} error:`, error)
-    })
+      this.service.on('error', (error) => {
+        Logger.error(`${this.service.name} error:`, error)
+      })
+    }
   }
 
   async enableStartup(): Promise<void> {
diff --git a/packages/server/tsconfig.json b/packages/server/tsconfig.json
@@ -1,7 +1,6 @@
 {
   "compilerOptions": {
     "composite": true,
-    "jsx": "react-jsx",
     "module": "CommonJS",
     "declaration": true,
     "removeComments": true,
@@ -19,5 +18,5 @@
     "strictBindCallApply": false,
     "forceConsistentCasingInFileNames": false,
     "noFallthroughCasesInSwitch": false,
-  },
+  }
 }
diff --git a/packages/server/utils/environment.util.ts b/packages/server/utils/environment.util.ts
@@ -1,2 +1,4 @@
 export const isCli = () => process.env.CODECLIMBERS_SERVER_APP_CONTEXT === 'cli'
 export const isTest = () => process.env.NODE_ENV === 'test'
+export const isDev = () => process.env.NODE_ENV === 'development'
+export const isProd = () => process.env.NODE_ENV === 'production'
diff --git a/packages/server/utils/node.util.ts b/packages/server/utils/node.util.ts
diff --git a/packages/server/utils/wakatime.util.ts b/packages/server/utils/wakatime.util.ts
