refactor: import process explicit (#1418)

dherault · May 16, 2022 · 8893c67 · 8893c67
1 parent 90d5169
commit 8893c67
Show file tree

Hide file tree

Showing 55 changed files with 159 additions and 109 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -36,6 +36,10 @@ module.exports = {
         name: 'Buffer',
         message: "Import 'Buffer' from 'buffer' module instead",
       },
+      {
+        name: 'process',
+        message: "Import 'process' from 'process' module instead",
+      },
     ],
     // we use underscores to indicate private fields in classes
     'no-underscore-dangle': 'off',

diff --git a/examples/events/http/handler.js b/examples/events/http/handler.js
@@ -1,10 +1,12 @@
 'use strict'
 
+const { env } = require('process')
+
 const { stringify } = JSON
 
 exports.hello = async function hello() {
   return {
-    body: stringify({ foo: 'bar', IS_OFFLINE: process.env.IS_OFFLINE }),
+    body: stringify({ foo: 'bar', IS_OFFLINE: env.IS_OFFLINE }),
     statusCode: 200,
   }
 }
diff --git a/jest.config.js b/jest.config.js
@@ -1,15 +1,15 @@
 'use strict'
 
-const { AWS_ENDPOINT } = process.env
+const { env } = require('process')
 
 module.exports = {
   bail: true,
   globals: {
-    RUN_TEST_AGAINST_AWS: AWS_ENDPOINT != null,
-    TEST_BASE_URL: AWS_ENDPOINT || 'http://localhost:3000',
+    RUN_TEST_AGAINST_AWS: env.AWS_ENDPOINT != null,
+    TEST_BASE_URL: env.AWS_ENDPOINT || 'http://localhost:3000',
   },
   modulePathIgnorePatterns: ['src/lambda/__tests__/fixtures/'],
-  ...(!process.env.SKIP_SETUP && {
+  ...(!env.SKIP_SETUP && {
     globalSetup: './tests/_setupTeardown/npmInstall.js',
   }),
 }
diff --git a/src/ServerlessOffline.js b/src/ServerlessOffline.js
@@ -1,3 +1,4 @@
+import process, { env, exit } from 'process'
 import updateNotifier from 'update-notifier'
 import chalk from 'chalk'
 import { parse as semverParse } from 'semver'
@@ -65,7 +66,7 @@ export default class ServerlessOffline {
   }
 
   _printBlankLine() {
-    if (process.env.NODE_ENV !== 'test') {
+    if (env.NODE_ENV !== 'test') {
       if (this.log) {
         this.log.notice()
       } else {
@@ -77,7 +78,7 @@ export default class ServerlessOffline {
   // Entry point for the plugin (sls offline) when running 'sls offline start'
   async start() {
     // Put here so available everywhere, not just in handlers
-    process.env.IS_OFFLINE = true
+    env.IS_OFFLINE = true
 
     // check if update is available
     updateNotifier({ pkg }).notify()
@@ -111,14 +112,14 @@ export default class ServerlessOffline {
   }
 
   async ready() {
-    if (process.env.NODE_ENV !== 'test') {
+    if (env.NODE_ENV !== 'test') {
       await this._listenForTermination()
     }
   }
 
   async end(skipExit) {
     // TEMP FIXME
-    if (process.env.NODE_ENV === 'test' && skipExit === undefined) {
+    if (env.NODE_ENV === 'test' && skipExit === undefined) {
       return
     }
 
@@ -150,7 +151,7 @@ export default class ServerlessOffline {
     await Promise.all(eventModules)
 
     if (!skipExit) {
-      process.exit(0)
+      exit(0)
     }
   }
 

diff --git a/src/debugLog.js b/src/debugLog.js
@@ -1,3 +1,5 @@
-export default typeof process.env.SLS_DEBUG !== 'undefined'
+import { env } from 'process'
+
+export default typeof env.SLS_DEBUG !== 'undefined'
   ? console.log.bind(null, '[offline]')
   : () => null
diff --git a/src/events/http/HttpServer.js b/src/events/http/HttpServer.js
@@ -1,6 +1,7 @@
 import { Buffer } from 'buffer'
 import { readFileSync } from 'fs'
 import { join, resolve } from 'path'
+import process, { env, exit } from 'process'
 import h2o2 from '@hapi/h2o2'
 import { Server } from '@hapi/hapi'
 import { createRequire } from 'module'
@@ -200,7 +201,7 @@ export default class HttpServer {
           err,
         )
       }
-      process.exit(1)
+      exit(1)
     }
 
     // TODO move the following block
@@ -220,7 +221,7 @@ export default class HttpServer {
       serverlessLog('Enter "rp" to replay the last request')
     }
 
-    if (process.env.NODE_ENV !== 'test') {
+    if (env.NODE_ENV !== 'test') {
       process.openStdin().addListener('data', (data) => {
         // note: data is an object, and when converted to a string it will
         // end with a linefeed.  so we (rather crudely) account for that
@@ -257,7 +258,7 @@ export default class HttpServer {
   // }
 
   _printBlankLine() {
-    if (process.env.NODE_ENV !== 'test') {
+    if (env.NODE_ENV !== 'test') {
       if (this.log) {
         this.log.notice()
       } else {

diff --git a/src/events/http/lambda-events/LambdaIntegrationEvent.js b/src/events/http/lambda-events/LambdaIntegrationEvent.js
@@ -1,3 +1,4 @@
+import { env } from 'process'
 import renderVelocityTemplateObject from './renderVelocityTemplateObject.js'
 import VelocityContext from './VelocityContext.js'
 
@@ -18,9 +19,9 @@ export default class LambdaIntegrationEvent {
   }
 
   create() {
-    if (process.env.AUTHORIZER) {
+    if (env.AUTHORIZER) {
       try {
-        const authorizerContext = parse(process.env.AUTHORIZER)
+        const authorizerContext = parse(env.AUTHORIZER)
         if (authorizerContext) {
           this.#request.auth = {
             ...this.#request.auth,

diff --git a/src/events/http/lambda-events/LambdaProxyIntegrationEvent.js b/src/events/http/lambda-events/LambdaProxyIntegrationEvent.js
@@ -1,4 +1,5 @@
 import { Buffer } from 'buffer'
+import { env } from 'process'
 import { decode } from 'jsonwebtoken'
 import {
   createUniqueId,
@@ -62,17 +63,17 @@ export default class LambdaProxyIntegrationEvent {
 
     let authAuthorizer
 
-    if (process.env.AUTHORIZER) {
+    if (env.AUTHORIZER) {
       try {
-        authAuthorizer = parse(process.env.AUTHORIZER)
+        authAuthorizer = parse(env.AUTHORIZER)
       } catch (error) {
         if (this.log) {
           this.log.error(
-            'Could not parse process.env.AUTHORIZER, make sure it is correct JSON',
+            'Could not parse env.AUTHORIZER, make sure it is correct JSON',
           )
         } else {
           console.error(
-            'Serverless-offline: Could not parse process.env.AUTHORIZER, make sure it is correct JSON.',
+            'Serverless-offline: Could not parse env.AUTHORIZER, make sure it is correct JSON.',
           )
         }
       }
@@ -195,7 +196,7 @@ export default class LambdaProxyIntegrationEvent {
             // 'principalId' should have higher priority
             principalId:
               authPrincipalId ||
-              process.env.PRINCIPAL_ID ||
+              env.PRINCIPAL_ID ||
               'offlineContext_authorizer_principalId', // See #24
           }),
         domainName: 'offlineContext_domainName',
@@ -204,23 +205,23 @@ export default class LambdaProxyIntegrationEvent {
         httpMethod,
         identity: {
           accessKey: null,
-          accountId: process.env.SLS_ACCOUNT_ID || 'offlineContext_accountId',
-          apiKey: process.env.SLS_API_KEY || 'offlineContext_apiKey',
-          apiKeyId: process.env.SLS_API_KEY_ID || 'offlineContext_apiKeyId',
-          caller: process.env.SLS_CALLER || 'offlineContext_caller',
+          accountId: env.SLS_ACCOUNT_ID || 'offlineContext_accountId',
+          apiKey: env.SLS_API_KEY || 'offlineContext_apiKey',
+          apiKeyId: env.SLS_API_KEY_ID || 'offlineContext_apiKeyId',
+          caller: env.SLS_CALLER || 'offlineContext_caller',
           cognitoAuthenticationProvider:
             _headers['cognito-authentication-provider'] ||
-            process.env.SLS_COGNITO_AUTHENTICATION_PROVIDER ||
+            env.SLS_COGNITO_AUTHENTICATION_PROVIDER ||
             'offlineContext_cognitoAuthenticationProvider',
           cognitoAuthenticationType:
-            process.env.SLS_COGNITO_AUTHENTICATION_TYPE ||
+            env.SLS_COGNITO_AUTHENTICATION_TYPE ||
             'offlineContext_cognitoAuthenticationType',
           cognitoIdentityId:
             _headers['cognito-identity-id'] ||
-            process.env.SLS_COGNITO_IDENTITY_ID ||
+            env.SLS_COGNITO_IDENTITY_ID ||
             'offlineContext_cognitoIdentityId',
           cognitoIdentityPoolId:
-            process.env.SLS_COGNITO_IDENTITY_POOL_ID ||
+            env.SLS_COGNITO_IDENTITY_POOL_ID ||
             'offlineContext_cognitoIdentityPoolId',
           principalOrgId: null,
           sourceIp: remoteAddress,

diff --git a/src/events/http/lambda-events/LambdaProxyIntegrationEventV2.js b/src/events/http/lambda-events/LambdaProxyIntegrationEventV2.js
@@ -1,4 +1,5 @@
 import { Buffer } from 'buffer'
+import { env } from 'process'
 import { decode } from 'jsonwebtoken'
 import {
   formatToClfTime,
@@ -49,9 +50,9 @@ export default class LambdaProxyIntegrationEventV2 {
 
     let authAuthorizer
 
-    if (process.env.AUTHORIZER) {
+    if (env.AUTHORIZER) {
       try {
-        authAuthorizer = parse(process.env.AUTHORIZER)
+        authAuthorizer = parse(env.AUTHORIZER)
       } catch (error) {
         if (this.log) {
           this.log.error(

diff --git a/src/events/http/lambda-events/VelocityContext.js b/src/events/http/lambda-events/VelocityContext.js
@@ -1,4 +1,5 @@
 import { Buffer } from 'buffer'
+import { env } from 'process'
 import jsEscapeString from 'js-string-escape'
 import { decode } from 'jsonwebtoken'
 import {
@@ -74,7 +75,7 @@ export default class VelocityContext {
 
     authorizer.principalId =
       authPrincipalId ||
-      process.env.PRINCIPAL_ID ||
+      env.PRINCIPAL_ID ||
       'offlineContext_authorizer_principalId' // See #24
 
     if (token) {

diff --git a/src/events/websocket/HttpServer.js b/src/events/websocket/HttpServer.js
@@ -1,3 +1,4 @@
+import { exit } from 'process'
 import { Server } from '@hapi/hapi'
 import { catchAllRoute, connectionsRoutes } from './http-routes/index.js'
 import serverlessLog from '../../serverlessLog.js'
@@ -57,7 +58,7 @@ export default class HttpServer {
           err,
         )
       }
-      process.exit(1)
+      exit(1)
     }
 
     if (this.log) {

diff --git a/src/lambda/HttpServer.js b/src/lambda/HttpServer.js
@@ -1,4 +1,5 @@
 import { Server } from '@hapi/hapi'
+import { exit } from 'process'
 import { invocationsRoute, invokeAsyncRoute } from './routes/index.js'
 import serverlessLog from '../serverlessLog.js'
 import debugLog from '../debugLog.js'
@@ -56,7 +57,7 @@ export default class HttpServer {
           err,
         )
       }
-      process.exit(1)
+      exit(1)
     }
 
     if (this.log) {

diff --git a/src/lambda/handler-runner/child-process-runner/childProcessHelper.js b/src/lambda/handler-runner/child-process-runner/childProcessHelper.js
@@ -1,3 +1,4 @@
+import process, { argv } from 'process'
 import InProcessRunner from '../in-process-runner/index.js'
 
 // TODO handle this:
@@ -20,7 +21,7 @@ process.on('uncaughtException', (err) => {
   })
 })
 
-const [, , functionKey, handlerName, handlerPath] = process.argv
+const [, , functionKey, handlerName, handlerPath] = argv
 
 process.on('message', async (messageData) => {
   const { context, event, allowCache, timeout } = messageData

diff --git a/src/lambda/handler-runner/go-runner/GoRunner.js b/src/lambda/handler-runner/go-runner/GoRunner.js
@@ -1,11 +1,11 @@
-import { EOL } from 'os'
 import { promises as fsPromises } from 'fs'
+import { EOL } from 'os'
 import { sep, resolve, parse as pathParse } from 'path'
+import process, { chdir, cwd } from 'process'
 import execa, { sync } from 'execa'
 
 const { writeFile, readFile, mkdir, rmdir } = fsPromises
 const { parse, stringify } = JSON
-const { cwd, chdir } = process
 
 const PAYLOAD_IDENTIFIER = 'offline_payload'
 

diff --git a/src/lambda/handler-runner/in-process-runner/InProcessRunner.js b/src/lambda/handler-runner/in-process-runner/InProcessRunner.js
@@ -1,6 +1,7 @@
-import { performance } from 'perf_hooks'
 import { readdirSync } from 'fs'
 import { dirname, resolve } from 'path'
+import { performance } from 'perf_hooks'
+import process from 'process'
 
 const { assign, keys } = Object
 

diff --git a/src/lambda/handler-runner/java-runner/JavaRunner.js b/src/lambda/handler-runner/java-runner/JavaRunner.js
@@ -1,4 +1,5 @@
 import { EOL } from 'os'
+import process from 'process'
 import fetch from 'node-fetch'
 import { invokeJavaLocal } from 'java-invoke-local'
 

diff --git a/src/lambda/handler-runner/python-runner/PythonRunner.js b/src/lambda/handler-runner/python-runner/PythonRunner.js
@@ -1,10 +1,10 @@
+import { spawn } from 'child_process'
 import { EOL, platform } from 'os'
 import { delimiter, join, relative, resolve } from 'path'
-import { spawn } from 'child_process'
+import process, { cwd } from 'process'
 import readline from 'readline'
 
 const { parse, stringify } = JSON
-const { cwd } = process
 const { assign } = Object
 const { has } = Reflect
 

diff --git a/src/lambda/handler-runner/ruby-runner/RubyRunner.js b/src/lambda/handler-runner/ruby-runner/RubyRunner.js
@@ -1,9 +1,9 @@
 import { EOL, platform } from 'os'
 import { relative, resolve } from 'path'
+import { cwd } from 'process'
 import execa from 'execa'
 
 const { parse, stringify } = JSON
-const { cwd } = process
 const { has } = Reflect
 
 export default class RubyRunner {

diff --git a/src/lambda/handler-runner/worker-thread-runner/workerThreadHelper.js b/src/lambda/handler-runner/worker-thread-runner/workerThreadHelper.js
@@ -1,3 +1,4 @@
+import { env } from 'process'
 import { parentPort, workerData } from 'worker_threads' // eslint-disable-line import/no-unresolved
 import InProcessRunner from '../in-process-runner/index.js'
 
@@ -13,7 +14,7 @@ parentPort.on('message', async (messageData) => {
     handlerPath,
     handlerName,
     handlerModuleNesting,
-    process.env,
+    env,
     timeout,
     allowCache,
   )