Detangle NODE_ENV and RAILS_ENV (#1359)

lib/install/bin/webpack

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 ENV["RAILS_ENV"] ||= ENV["RACK_ENV"] || "development"
-ENV["NODE_ENV"] ||= ENV["RAILS_ENV"]
+ENV["NODE_ENV"]  ||= ENV["NODE_ENV"] || "development"
 
 require "pathname"
 ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",

lib/install/bin/webpack-dev-server

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 ENV["RAILS_ENV"] ||= ENV["RACK_ENV"] || "development"
-ENV["NODE_ENV"] ||= ENV["RAILS_ENV"]
+ENV["NODE_ENV"]  ||= ENV["NODE_ENV"] || "development"
 
 require "pathname"
 ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",

lib/install/config/webpack/development.js

@@ -1,3 +1,5 @@
+process.env.NODE_ENV = process.env.NODE_ENV || 'development'
+
 const environment = require('./environment')
 
 module.exports = environment.toWebpackConfig()

lib/install/config/webpack/production.js

@@ -1,3 +1,5 @@
+process.env.NODE_ENV = process.env.NODE_ENV || 'production'
+
 const environment = require('./environment')
 
 module.exports = environment.toWebpackConfig()

lib/install/config/webpack/test.js

@@ -1,3 +1,5 @@
+process.env.NODE_ENV = process.env.NODE_ENV || 'development'
+
 const environment = require('./environment')
 
 module.exports = environment.toWebpackConfig()

lib/tasks/webpacker/compile.rake

@@ -1,3 +1,5 @@
+ENV["NODE_ENV"] ||= "production"
+
 $stdout.sync = true
 
 def ensure_log_goes_to_stdout

lib/webpacker/compiler.rb

@@ -78,8 +78,7 @@ def compilation_digest_path
     end
 
     def webpack_env
-      env.merge("NODE_ENV"                    => @webpacker.env,
-                "WEBPACKER_ASSET_HOST"        => ActionController::Base.helpers.compute_asset_host,
+      env.merge("WEBPACKER_ASSET_HOST"        => ActionController::Base.helpers.compute_asset_host,
                 "WEBPACKER_RELATIVE_URL_ROOT" => ActionController::Base.relative_url_root)
     end
 end

lib/webpacker/dev_server_runner.rb

@@ -14,14 +14,14 @@ def run
     private
       def load_config
         @config_file = File.join(@app_path, "config/webpacker.yml")
-        dev_server = YAML.load_file(@config_file)[ENV["NODE_ENV"]]["dev_server"]
+        dev_server = YAML.load_file(@config_file)[ENV["RAILS_ENV"]]["dev_server"]
 
         @hostname          = dev_server["host"]
         @port              = dev_server["port"]
         @pretty            = dev_server.fetch("pretty", true)
 
       rescue Errno::ENOENT, NoMethodError
-        $stdout.puts "webpack dev_server configuration not found in #{@config_file}."
+        $stdout.puts "webpack dev_server configuration not found in #{@config_file}[#{ENV["RAILS_ENV"]}]."
         $stdout.puts "Please run bundle exec rails webpacker:install to install Webpacker"
         exit!
       end

lib/webpacker/env.rb

@@ -18,11 +18,11 @@ def inquire
 
   private
     def current
-      (ENV["NODE_ENV"] || Rails.env).presence_in(available_environments)
+      Rails.env.presence_in(available_environments)
     end
 
     def fallback_env_warning
-      logger.info "NODE_ENV=#{ENV["NODE_ENV"]} and RAILS_ENV=#{Rails.env} environment is not defined in config/webpacker.yml, falling back to #{DEFAULT} environment"
+      logger.info "RAILS_ENV=#{Rails.env} environment is not defined in config/webpacker.yml, falling back to #{DEFAULT} environment"
     end
 
     def available_environments

package/__tests__/dev_server.js

@@ -8,8 +8,9 @@ describe('DevServer', () => {
   beforeEach(() => jest.resetModules())
   afterAll(chdirCwd)
 
-  test('with NODE_ENV set to development', () => {
+  test('with NODE_ENV and RAILS_ENV set to development', () => {
     process.env.NODE_ENV = 'development'
+    process.env.RAILS_ENV = 'development'
     process.env.WEBPACKER_DEV_SERVER_HOST = '0.0.0.0'
     process.env.WEBPACKER_DEV_SERVER_PORT = 5000
 
@@ -19,7 +20,8 @@ describe('DevServer', () => {
     expect(devServer.port).toEqual('5000')
   })
 
-  test('with NODE_ENV set to production', () => {
+  test('with NODE_ENV and RAILS_ENV set to production', () => {
+    process.env.RAILS_ENV = 'production'
     process.env.NODE_ENV = 'production'
     expect(require('../dev_server')).toEqual({})
   })

package/__tests__/development.js

@@ -0,0 +1,30 @@
+/* test expect, describe, afterAll, beforeEach */
+
+const { resolve } = require('path')
+const { chdirTestApp, chdirCwd } = require('../utils/helpers')
+
+chdirTestApp()
+
+describe('Development environment', () => {
+  afterAll(chdirCwd)
+
+  describe('toWebpackConfig', () => {
+    beforeEach(() => jest.resetModules())
+
+    test('should use development config and environment', () => {
+      process.env.RAILS_ENV = 'development'
+      process.env.NODE_ENV = 'development'
+      const { environment } = require('../index')
+
+      const config = environment.toWebpackConfig()
+      expect(config.output.path).toEqual(resolve('public', 'packs'))
+      expect(config.output.publicPath).toEqual('/packs/')
+      expect(config).toMatchObject({
+        devServer: {
+          host: 'localhost',
+          port: 3035
+        }
+      })
+    })
+  })
+})

package/__tests__/env.js

@@ -8,21 +8,39 @@ describe('Env', () => {
   beforeEach(() => jest.resetModules())
   afterAll(chdirCwd)
 
-  test('with NODE_ENV set to development', () => {
+  test('with NODE_ENV and RAILS_ENV set to development', () => {
+    process.env.RAILS_ENV = 'development'
     process.env.NODE_ENV = 'development'
-    expect(require('../env')).toEqual('development')
+    expect(require('../env')).toEqual({
+      railsEnv: 'development',
+      nodeEnv: 'development'
+    })
   })
 
   test('with undefined NODE_ENV and RAILS_ENV set to development', () => {
-    delete process.env.NODE_ENV
     process.env.RAILS_ENV = 'development'
-    expect(require('../env')).toEqual('development')
+    delete process.env.NODE_ENV
+    expect(require('../env')).toEqual({
+      railsEnv: 'development',
+      nodeEnv: 'production'
+    })
   })
 
-  test('with a non-standard environment', () => {
-    process.env.NODE_ENV = 'foo'
-    process.env.RAILS_ENV = 'foo'
-    expect(require('../env')).toEqual('production')
+  test('with undefined NODE_ENV and RAILS_ENV', () => {
+    delete process.env.NODE_ENV
     delete process.env.RAILS_ENV
+    expect(require('../env')).toEqual({
+      railsEnv: 'production',
+      nodeEnv: 'production'
+    })
+  })
+
+  test('with a non-standard environment', () => {
+    process.env.RAILS_ENV = 'staging'
+    process.env.NODE_ENV = 'staging'
+    expect(require('../env')).toEqual({
+      railsEnv: 'staging',
+      nodeEnv: 'production'
+    })
   })
 })

package/__tests__/production.js

@@ -0,0 +1,27 @@
+/* test expect, describe, afterAll, beforeEach */
+
+const { resolve } = require('path')
+const { chdirTestApp, chdirCwd } = require('../utils/helpers')
+
+chdirTestApp()
+
+describe('Production environment', () => {
+  afterAll(chdirCwd)
+
+  describe('toWebpackConfig', () => {
+    beforeEach(() => jest.resetModules())
+
+    test('should use production config and environment', () => {
+      process.env.RAILS_ENV = 'production'
+      const { environment } = require('../index')
+
+      const config = environment.toWebpackConfig()
+      expect(config.output.path).toEqual(resolve('public', 'packs'))
+      expect(config.output.publicPath).toEqual('/packs/')
+      expect(config).toMatchObject({
+        devtool: 'nosources-source-map',
+        stats: 'normal'
+      })
+    })
+  })
+})

package/__tests__/staging.js

@@ -0,0 +1,27 @@
+/* test expect, describe, afterAll, beforeEach */
+
+const { resolve } = require('path')
+const { chdirTestApp, chdirCwd } = require('../utils/helpers')
+
+chdirTestApp()
+
+describe('Custom environment', () => {
+  afterAll(chdirCwd)
+
+  describe('toWebpackConfig', () => {
+    beforeEach(() => jest.resetModules())
+
+    test('should use staging config and production environment', () => {
+      process.env.RAILS_ENV = 'staging'
+      const { environment } = require('../index')
+
+      const config = environment.toWebpackConfig()
+      expect(config.output.path).toEqual(resolve('public', 'packs-staging'))
+      expect(config.output.publicPath).toEqual('/packs-staging/')
+      expect(config).toMatchObject({
+        devtool: 'nosources-source-map',
+        stats: 'normal'
+      })
+    })
+  })
+})

package/__tests__/test.js

@@ -0,0 +1,23 @@
+/* test expect, describe, afterAll, beforeEach */
+
+const { resolve } = require('path')
+const { chdirTestApp, chdirCwd } = require('../utils/helpers')
+
+chdirTestApp()
+
+describe('Test environment', () => {
+  afterAll(chdirCwd)
+
+  describe('toWebpackConfig', () => {
+    beforeEach(() => jest.resetModules())
+
+    test('should use test config and production environment', () => {
+      process.env.RAILS_ENV = 'test'
+      const { environment } = require('../index')
+
+      const config = environment.toWebpackConfig()
+      expect(config.output.path).toEqual(resolve('public', 'packs-test'))
+      expect(config.output.publicPath).toEqual('/packs-test/')
+    })
+  })
+})

package/config.js

@@ -3,25 +3,23 @@ const { safeLoad } = require('js-yaml')
 const { readFileSync } = require('fs')
 const deepMerge = require('./utils/deep_merge')
 const { isArray } = require('./utils/helpers')
-const env = require('./env')
+const { railsEnv } = require('./env')
 
 const defaultConfigPath = require.resolve('../lib/install/config/webpacker.yml')
 const configPath = resolve('config', 'webpacker.yml')
 
-const getConfig = () => {
-  const defaults = safeLoad(readFileSync(defaultConfigPath), 'utf8')[env]
-  const app = safeLoad(readFileSync(configPath), 'utf8')[env]
-
-  if (isArray(app.extensions) && app.extensions.length) {
-    delete defaults.extensions
-  }
+const getDefaultConfig = () => {
+  const defaultConfig = safeLoad(readFileSync(defaultConfigPath), 'utf8')
+  return defaultConfig[railsEnv] || defaultConfig.production
+}
 
-  const config = deepMerge(defaults, app)
+const defaults = getDefaultConfig()
+const app = safeLoad(readFileSync(configPath), 'utf8')[railsEnv]
 
-  config.outputPath = resolve('public', config.public_output_path)
-  config.publicPath = `/${config.public_output_path}/`.replace(/([^:]\/)\/+/g, '$1')
+if (isArray(app.extensions) && app.extensions.length) delete defaults.extensions
 
-  return config
-}
+const config = deepMerge(defaults, app)
+config.outputPath = resolve('public', config.public_output_path)
+config.publicPath = `/${config.public_output_path}/`.replace(/([^:]\/)\/+/g, '$1')
 
-module.exports = getConfig()
+module.exports = config

package/dev_server.js

@@ -1,23 +1,18 @@
-const { isBoolean, isEmpty } = require('./utils/helpers')
+const { isBoolean } = require('./utils/helpers')
 const config = require('./config')
 
 const fetch = (key) => {
   const value = process.env[key]
   return isBoolean(value) ? JSON.parse(value) : value
 }
 
-const devServer = () => {
-  const devServerConfig = config.dev_server
+const devServerConfig = config.dev_server
 
-  if (devServerConfig) {
-    Object.keys(devServerConfig).forEach((key) => {
-      const envValue = fetch(`WEBPACKER_DEV_SERVER_${key.toUpperCase().replace(/_/g, '')}`)
-      if (isEmpty(envValue)) return devServerConfig[key]
-      devServerConfig[key] = envValue
-    })
-  }
-
-  return devServerConfig || {}
+if (devServerConfig) {
+  Object.keys(devServerConfig).forEach((key) => {
+    const envValue = fetch(`WEBPACKER_DEV_SERVER_${key.toUpperCase().replace(/_/g, '')}`)
+    if (envValue) devServerConfig[key] = envValue
+  })
 }
 
-module.exports = devServer()
+module.exports = devServerConfig || {}

package/env.js

@@ -2,22 +2,18 @@ const { resolve } = require('path')
 const { safeLoad } = require('js-yaml')
 const { readFileSync } = require('fs')
 
+const NODE_ENVIRONMENTS = ['development', 'production']
+const DEFAULT = 'production'
 const configPath = resolve('config', 'webpacker.yml')
-const DEFAULT_ENV = 'production'
 
-const env = () => {
-  const nodeEnv = process.env.NODE_ENV
-  const railsEnv = process.env.RAILS_ENV
-  const config = safeLoad(readFileSync(configPath), 'utf8')
-  const availableEnvironments = Object.keys(config).join('|')
-  const regex = new RegExp(availableEnvironments, 'g')
+const railsEnv = process.env.RAILS_ENV
+const nodeEnv = process.env.NODE_ENV
 
-  if (nodeEnv && nodeEnv.match(regex)) return nodeEnv
-  if (railsEnv && railsEnv.match(regex)) return railsEnv
+const config = safeLoad(readFileSync(configPath), 'utf8')
+const availableEnvironments = Object.keys(config).join('|')
+const regex = new RegExp(availableEnvironments, 'g')
 
-  /* eslint no-console: 0 */
-  console.warn(`NODE_ENV=${nodeEnv} and RAILS_ENV=${railsEnv} environment is not defined in config/webpacker.yml, falling back to ${DEFAULT_ENV}`)
-  return DEFAULT_ENV
+module.exports = {
+  railsEnv: railsEnv && railsEnv.match(regex) ? railsEnv : DEFAULT,
+  nodeEnv: nodeEnv && NODE_ENVIRONMENTS.includes(nodeEnv) ? nodeEnv : DEFAULT
 }
-
-module.exports = env()