shakapacker 6.5.4 → 7.0.2

data/package/rules/__tests__/esbuild.js

@@ -0,0 +1,64 @@
+const path = require("path");
+const {
+  app_javascript,
+  node_modules,
+  node_modules_included,
+  createTestCompiler,
+  createTrackLoader,
+} = require("./__utils__/webpack");
+const esbuildConfig = require("../esbuild");
+
+jest.mock("../../config", () => {
+  const original = jest.requireActual("../../config");
+  return {
+    ...original,
+    webpack_loader: "esbuild",
+    additional_paths: [...original.additional_paths, "node_modules/included"],
+  };
+});
+
+const createWebpackConfig = (file, use) => {
+  return {
+    entry: { file },
+    module: {
+      rules: [
+        {
+          ...esbuildConfig,
+          use,
+        },
+      ],
+    },
+    output: {
+      path: "/",
+      filename: "scripts-bundled.js",
+    },
+  };
+};
+
+describe("swc", () => {
+  test("process source path", async () => {
+    const normalPath = `${app_javascript}/a.js`;
+    const [tracked, loader] = createTrackLoader();
+    const compiler = createTestCompiler(
+      createWebpackConfig(normalPath, loader)
+    );
+    await compiler.run();
+    expect(tracked[normalPath]).toBeTruthy();
+  });
+
+  test("exclude node_modules", async () => {
+    const ignored = `${node_modules}/a.js`;
+    const [tracked, loader] = createTrackLoader();
+    const compiler = createTestCompiler(createWebpackConfig(ignored, loader));
+    await compiler.run();
+    expect(tracked[ignored]).toBeUndefined();
+  });
+
+  test("explicitly included node_modules should be transpiled", async () => {
+    const included = `${node_modules_included}/a.js`;
+    const [tracked, loader] = createTrackLoader();
+    const compiler = createTestCompiler(createWebpackConfig(included, loader));
+    await compiler.run();
+    expect(tracked[included]).toBeTruthy();
+  });
+});

data/package/rules/__tests__/file.js

@@ -32,4 +32,31 @@ describe('file', () => {
     ]
     types.forEach(type => expect(file.exclude.test(type)).toBe(true))
   })
+
+  test('correct generated output path is returned for top level files', () => {
+    const pathData = {
+      filename: 'app/javascript/image.svg',
+    };
+    expect(file.generator.filename(pathData)).toEqual(
+      'static/[name]-[hash][ext][query]'
+    );
+  });
+
+  test('correct generated output path is returned for nested files', () => {
+    const pathData = {
+      filename: 'app/javascript/images/image.svg',
+    };
+    expect(file.generator.filename(pathData)).toEqual(
+      'static/images/[name]-[hash][ext][query]'
+    );
+  })
+
+  test('correct generated output path is returned for deeply nested files', () => {
+    const pathData = {
+      filename: 'app/javascript/images/nested/deeply/image.svg',
+    };
+    expect(file.generator.filename(pathData)).toEqual(
+      'static/images/nested/deeply/[name]-[hash][ext][query]'
+    );
+  });
 })

data/package/rules/__tests__/index.js

@@ -4,8 +4,4 @@ describe('index', () => {
   test('rule tests are regexes', () => {
     rules.forEach(rule => expect(rule.test instanceof RegExp).toBe(true))
   })
-
-  test('rule excludes are regexes', () => {
-    rules.forEach(rule => expect(rule.exclude instanceof RegExp).toBe(true))
-  })
 })

data/package/rules/__tests__/swc.js

@@ -0,0 +1,63 @@
+const {
+  app_javascript,
+  node_modules,
+  node_modules_included,
+  createTestCompiler,
+  createTrackLoader,
+} = require("./__utils__/webpack");
+const swcConfig = require("../swc");
+
+jest.mock("../../config", () => {
+  const original = jest.requireActual("../../config");
+  return {
+    ...original,
+    webpack_loader: "swc",
+    additional_paths: [...original.additional_paths, "node_modules/included"],
+  };
+});
+
+const createWebpackConfig = (file, use) => {
+  return {
+    entry: { file },
+    module: {
+      rules: [
+        {
+          ...swcConfig,
+          use,
+        },
+      ],
+    },
+    output: {
+      path: "/",
+      filename: "scripts-bundled.js",
+    },
+  };
+};
+
+describe("swc", () => {
+  test("process files in source_path", async () => {
+    const normalPath = `${app_javascript}/a.js`;
+    const [tracked, loader] = createTrackLoader();
+    const compiler = createTestCompiler(
+      createWebpackConfig(normalPath, loader)
+    );
+    await compiler.run();
+    expect(tracked[normalPath]).toBeTruthy();
+  });
+
+  test("exclude node_modules", async () => {
+    const ignored = `${node_modules}/a.js`;
+    const [tracked, loader] = createTrackLoader();
+    const compiler = createTestCompiler(createWebpackConfig(ignored, loader));
+    await compiler.run();
+    expect(tracked[ignored]).toBeUndefined();
+  });
+
+  test("explicitly included node_modules should be transpiled", async () => {
+    const included = `${node_modules_included}/a.js`;
+    const [tracked, loader] = createTrackLoader();
+    const compiler = createTestCompiler(createWebpackConfig(included, loader));
+    await compiler.run();
+    expect(tracked[included]).toBeTruthy();
+  });
+});

data/package/rules/babel.js

@@ -1,32 +1,21 @@
-const { resolve } = require('path')
-const { realpathSync } = require('fs')
 const { loaderMatches } = require('../utils/helpers')
-
 const {
-  source_path: sourcePath,
-  additional_paths: additionalPaths,
   webpack_loader: webpackLoader
 } = require('../config')
 const { isProduction } = require('../env')
+const jscommon = require('./jscommon')
 
 module.exports = loaderMatches(webpackLoader, 'babel', () => ({
-    test: /\.(js|jsx|mjs|ts|tsx|coffee)?(\.erb)?$/,
-    include: [sourcePath, ...additionalPaths].map((p) => {
-      try {
-        return realpathSync(p)
-      } catch (e) {
-        return resolve(p)
-      }
-    }),
-    exclude: /node_modules/,
-    use: [
-      {
-        loader: require.resolve('babel-loader'),
-        options: {
-          cacheDirectory: true,
-          cacheCompression: isProduction,
-          compact: isProduction
-        }
+  test: /\.(js|jsx|mjs|ts|tsx|coffee)?(\.erb)?$/,
+  ...jscommon,
+  use: [
+    {
+      loader: require.resolve('babel-loader'),
+      options: {
+        cacheDirectory: true,
+        cacheCompression: isProduction,
+        compact: isProduction
       }
-    ]
-  }))
+    }
+  ]
+}))

data/package/rules/esbuild.js

@@ -1,23 +1,12 @@
-const { resolve } = require('path')
-const { realpathSync } = require('fs')
 const { loaderMatches } = require('../utils/helpers')
 const { getEsbuildLoaderConfig } = require('../esbuild')
-
 const {
-  source_path: sourcePath,
-  additional_paths: additionalPaths,
   webpack_loader: webpackLoader
 } = require('../config')
+const jscommon = require('./jscommon')
 
 module.exports = loaderMatches(webpackLoader, 'esbuild', () => ({
   test: /\.(ts|tsx|js|jsx|mjs|coffee)?(\.erb)?$/,
-  include: [sourcePath, ...additionalPaths].map((p) => {
-    try {
-      return realpathSync(p)
-    } catch (e) {
-      return resolve(p)
-    }
-  }),
-  exclude: /node_modules/,
+  ...jscommon,
   use: ({ resource }) => getEsbuildLoaderConfig(resource)
 }))

data/package/rules/file.js

@@ -8,9 +8,9 @@ module.exports = {
   generator: {
     filename: (pathData) => {
       const folders = dirname(pathData.filename)
-        .replace(`${sourcePath}/`, '')
+        .replace(`${sourcePath}`, '')
         .split('/')
-        .slice(1)
+        .filter(Boolean)
 
       const foldersWithStatic = ['static', ...folders].join('/')
       return `${foldersWithStatic}/[name]-[hash][ext][query]`

data/package/rules/jscommon.js

@@ -0,0 +1,26 @@
+const { resolve } = require('path')
+const { realpathSync } = require('fs')
+const {
+  source_path: sourcePath,
+  additional_paths: additionalPaths
+} = require('../config')
+
+const inclusions = [sourcePath, ...additionalPaths].map(p => {
+  try {
+    return realpathSync(p)
+  } catch (e) {
+    return resolve(p)
+  }
+})
+
+module.exports = {
+  include: inclusions,
+  exclude: [
+    {
+      // exclude all node_modules from running through babel-loader
+      and: [resolve('node_modules')],
+      // Do not exclude inclusions, as otherwise these won't be transpiled
+      not: [...inclusions]
+    }
+  ]
+}

data/package/rules/swc.js

@@ -1,23 +1,12 @@
-const { resolve } = require('path')
-const { realpathSync } = require('fs')
 const { loaderMatches } = require('../utils/helpers')
 const { getSwcLoaderConfig } = require('../swc')
-
 const {
-  source_path: sourcePath,
-  additional_paths: additionalPaths,
   webpack_loader: webpackLoader
 } = require('../config')
+const jscommon = require('./jscommon')
 
 module.exports = loaderMatches(webpackLoader, 'swc', () => ({
   test: /\.(ts|tsx|js|jsx|mjs|coffee)?(\.erb)?$/,
-  include: [sourcePath, ...additionalPaths].map((p) => {
-    try {
-      return realpathSync(p)
-    } catch (e) {
-      return resolve(p)
-    }
-  }),
-  exclude: /node_modules/,
+  ...jscommon,
   use: ({ resource }) => getSwcLoaderConfig(resource)
 }))

data/package/utils/configPath.js

@@ -0,0 +1,19 @@
+const fs = require('fs')
+const { resolve } = require('path')
+const { setShakapackerEnvVariablesForBackwardCompatibility } = require('./helpers')
+
+setShakapackerEnvVariablesForBackwardCompatibility()
+
+// For backward compatibility
+const resolveToPhysicalFilePath = () => {
+  const shakapackerConfigPath = resolve('config', 'shakapacker.yml')
+  const webpackerConfigPath = resolve('config', 'webpacker.yml')
+
+  if (fs.existsSync(shakapackerConfigPath)) return shakapackerConfigPath
+  if (fs.existsSync(webpackerConfigPath)) return webpackerConfigPath
+
+  // If neither of files exist, try to resolve to shakapacker.yml to get more relevant error
+  return shakapackerConfigPath
+}
+
+module.exports = process.env.SHAKAPACKER_CONFIG || resolveToPhysicalFilePath()

data/package/utils/defaultConfigPath.js

@@ -0,0 +1,2 @@
+const path = require.resolve('../../lib/install/config/shakapacker.yml')
+module.exports = path

data/package/utils/get_style_rule.js

@@ -1,6 +1,6 @@
 /* eslint global-require: 0 */
 const { canProcess, moduleExists } = require('./helpers')
-const inliningCss = require('../inliningCss')
+const inliningCss = require('./inliningCss')
 
 const getStyleRule = (test, preprocessors = []) => {
   if (moduleExists('css-loader')) {
@@ -18,7 +18,10 @@ const getStyleRule = (test, preprocessors = []) => {
         loader: require.resolve('css-loader'),
         options: {
           sourceMap: true,
-          importLoaders: 2
+          importLoaders: 2,
+          modules: {
+            auto: true
+          }
         }
       },
       tryPostcss(),

data/package/utils/helpers.js

@@ -2,7 +2,16 @@ const isArray = (value) => Array.isArray(value)
 const isBoolean = (str) => /^true/.test(str) || /^false/.test(str)
 const chdirTestApp = () => {
   try {
-    return process.chdir('test/test_app')
+    return process.chdir('spec/shakapacker/test_app')
+  } catch (e) {
+    return null
+  }
+}
+
+// For backward compatibility
+const chdirWebpackerTestApp = () => {
+  try {
+    return process.chdir('spec/backward_compatibility_specs/webpacker_test_app')
   } catch (e) {
     return null
   }
@@ -48,15 +57,29 @@ const loaderMatches = (configLoader, loaderToCheck, fn) => {
 
   if (!moduleExists(loaderName)) {
     throw new Error(
-      `Your webpacker config specified using ${configLoader}, but ${loaderName} package is not installed. Please install ${loaderName} first.`
+      `Your Shakapacker config specified using ${configLoader}, but ${loaderName} package is not installed. Please install ${loaderName} first.`
     )
   }
 
   return fn()
 }
 
+// For backward compatibility
+// Set SHAKAPACKER_XYZ only if SHAKAPACKER_XYZ is not defined but WEBPACKER_XYZ is.
+const setShakapackerEnvVariablesForBackwardCompatibility = () => {
+  const webpackerEnvVariables = Object.entries(process.env).filter((key) => /^WEBPACKER_/.test(key))
+  webpackerEnvVariables.forEach(([webpackerEnvKey, webpackerEnvValue]) => {
+    const shakapackerKey = webpackerEnvKey.replace(/^WEBPACKER/, 'SHAKAPACKER')
+    if (!process.env[shakapackerKey]) {
+      process.env[shakapackerKey] = webpackerEnvValue
+    }
+  })
+}
+
 module.exports = {
   chdirTestApp,
+  chdirWebpackerTestApp,
+  setShakapackerEnvVariablesForBackwardCompatibility,
   chdirCwd,
   isArray,
   isBoolean,

data/package/utils/inliningCss.js

@@ -0,0 +1,7 @@
+const { runningWebpackDevServer } = require('../env')
+const devServer = require('../dev_server')
+
+// This logic is tied to lib/shakapacker/instance.rb
+const inliningCss = runningWebpackDevServer && devServer.hmr && devServer.inline_css !== false
+
+module.exports = inliningCss

data/package/utils/snakeToCamelCase

@@ -0,0 +1,7 @@
+function snakeToCamelCase(s) {
+  return s.replace(/(_\w)/g, function (match) {
+    return match[1].toUpperCase()
+  })
+}
+
+module.exports = snakeToCamelCase

data/package/webpackDevServerConfig.js

@@ -0,0 +1,68 @@
+const shakapackerDevServerYamlConfig = require('./dev_server')
+const snakeToCamelCase = require('./utils/snakeToCamelCase')
+const { outputPath: contentBase, publicPath } = require('./config')
+
+const webpackDevServerMappedKeys = new Set([
+  // client, server, liveReload, devMiddleware are handled separately
+  'allowedHosts',
+  'bonjour',
+  'compress',
+  'headers',
+  'historyApiFallback',
+  'host',
+  'hot',
+  'http2',
+  'https',
+  'ipc',
+  'magicHtml',
+  'onAfterSetupMiddleware',
+  'onBeforeSetupMiddleware',
+  'open',
+  'port',
+  'proxy',
+  'server',
+  'setupExitSignals',
+  'setupMiddlewares',
+  'watchFiles',
+  'webSocketServer'
+])
+
+function createDevServerConfig() {
+  const devServerYamlConfig = { ...shakapackerDevServerYamlConfig }
+  const liveReload = devServerYamlConfig.live_reload !== undefined ? devServerYamlConfig.live_reload : !devServerYamlConfig.hmr
+  delete devServerYamlConfig.live_reload
+
+  const config = {
+    devMiddleware: {
+      publicPath
+    },
+    liveReload,
+    historyApiFallback: {
+      disableDotRule: true
+    },
+    static: {
+      publicPath: contentBase
+    }
+  }
+
+  if (devServerYamlConfig.static) {
+    config.static = { ...config.static, ...devServerYamlConfig.static }
+    delete devServerYamlConfig.static
+  }
+
+  if (devServerYamlConfig.client) {
+    config.client = devServerYamlConfig.client
+    delete devServerYamlConfig.client
+  }
+
+  Object.keys(devServerYamlConfig).forEach((yamlKey) => {
+    const camelYamlKey = snakeToCamelCase(yamlKey)
+    if (webpackDevServerMappedKeys.has(camelYamlKey)) {
+      config[camelYamlKey] = devServerYamlConfig[yamlKey]
+    }
+  })
+
+  return config
+}
+
+module.exports = createDevServerConfig

data/package.json

@@ -1,11 +1,11 @@
 {
   "name": "shakapacker",
-  "version": "6.5.4",
+  "version": "7.0.2",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "main": "package/index.js",
   "files": [
     "package",
-    "lib/install/config/webpacker.yml"
+    "lib/install/config/shakapacker.yml"
   ],
   "engines": {
     "node": "^12.13.0 || ^14 || >=16",
@@ -16,12 +16,12 @@
     "@babel/plugin-transform-runtime": "^7.17.0",
     "@babel/preset-env": "^7.16.11",
     "@babel/runtime": "^7.17.9",
-    "babel-loader": "^8.2.4",
+    "babel-loader": "^8.2.4 || ^9.0.0",
     "compression-webpack-plugin": "^9.0.0 || ^10.0.0",
     "terser-webpack-plugin": "^5.3.1",
     "webpack": "^5.72.0",
     "webpack-assets-manifest": "^5.0.6",
-    "webpack-cli": "^4.9.2",
+    "webpack-cli": "^4.9.2 || ^5.0.0",
     "webpack-dev-server": "^4.9.0",
     "webpack-merge": "^5.8.0"
   },
@@ -40,14 +40,20 @@
     "eslint-plugin-import": "^2.24.2",
     "eslint-plugin-jsx-a11y": "^6.4.1",
     "eslint-plugin-react": "^7.26.0",
-    "jest": "^27.2.1",
+    "jest": "^28.1.3",
+    "memory-fs": "^0.5.0",
     "swc-loader": "^0.1.15",
+    "thenify": "^3.3.1",
     "webpack": "^5.72.0",
     "webpack-assets-manifest": "^5.0.6",
     "webpack-merge": "^5.8.0"
   },
   "jest": {
     "testRegex": "(/__tests__/.*|(\\.|/))\\.jsx?$",
+    "testPathIgnorePatterns": [
+      "/__fixtures__/",
+      "/__utils__/"
+    ],
     "roots": [
       "<rootDir>/package"
     ]

data/{webpacker.gemspec → shakapacker.gemspec}

@@ -1,16 +1,16 @@
 $:.push File.expand_path("../lib", __FILE__)
-require "webpacker/version"
+require "shakapacker/version"
 
 Gem::Specification.new do |s|
   s.name     = "shakapacker"
-  s.version  = Webpacker::VERSION
+  s.version  = Shakapacker::VERSION
   s.authors  = [ "David Heinemeier Hansson", "Gaurav Tiwari", "Justin Gordon" ]
   s.email    = [ "david@basecamp.com", "gaurav@gauravtiwari.co.uk", "justin@shakacode.com" ]
   s.summary  = "Use webpack to manage app-like JavaScript modules in Rails"
   s.homepage = "https://github.com/shakacode/shakapacker"
   s.license  = "MIT"
 
-  npm_version = Webpacker::VERSION.gsub(".rc", "-rc")
+  npm_version = Shakapacker::VERSION.gsub(".rc", "-rc")
   s.metadata = {
     "source_code_uri" => "https://github.com/shakacode/shakapacker/tree/v#{npm_version}",
   }

data/spec/backward_compatibility_specs/command_spec.rb

@@ -0,0 +1,116 @@
+require_relative "spec_helper_initializer"
+
+describe "Command" do
+  before do
+    allow(Webpacker.logger).to receive(:info)
+  end
+
+  describe "#compile" do
+    it "returns success status when stale" do
+      expect(Webpacker.compiler).to receive(:stale?).and_return(true)
+      expect(Webpacker.compiler).to receive(:run_webpack).and_return(true)
+
+      expect(Webpacker.commands.compile).to be true
+    end
+
+    it "returns success status when fresh" do
+      expect(Webpacker.compiler).to receive(:stale?).and_return(false)
+
+      expect(Webpacker.commands.compile).to be true
+    end
+
+    it "returns failure status when stale" do
+      expect(Webpacker.compiler).to receive(:stale?).and_return(true)
+      expect(Webpacker.compiler).to receive(:run_webpack).and_return(false)
+
+      expect(Webpacker.commands.compile).to be false
+    end
+  end
+
+  describe "#clean" do
+    let(:now) { Time.parse("2021-01-01 12:34:56 UTC") }
+    let(:prev_files) do
+      # Test assets to be kept and deleted, path and mtime
+      {
+        # recent versions to be kept with Webpacker.commands.clean(count = 2)
+        "js/application-deadbeef.js" => now - 4000,
+        "js/common-deadbeee.js" => now - 4002,
+        "css/common-deadbeed.css" => now - 4004,
+        "media/images/logo-deadbeeb.css" => now - 4006,
+        "js/application-1eadbeef.js" => now - 8000,
+        "js/common-1eadbeee.js" => now - 8002,
+        "css/common-1eadbeed.css" => now - 8004,
+        "media/images/logo-1eadbeeb.css" => now - 8006,
+        # new files to be kept with Webpacker.commands.clean(age = 3600)
+        "js/brandnew-0001.js" => now,
+        "js/brandnew-0002.js" => now - 10,
+        "js/brandnew-0003.js" => now - 20,
+        "js/brandnew-0004.js" => now - 40,
+      }.transform_keys { |path| "#{Webpacker.config.public_output_path}/#{path}" }
+    end
+
+    let(:expired_files) do
+      {
+        # old files that are outside count = 2 or age = 3600 and to be deleted
+        "js/application-0eadbeef.js" => now - 9000,
+        "js/common-0eadbeee.js" => now - 9002,
+        "css/common-0eadbeed.css" => now - 9004,
+        "js/brandnew-0005.js" => now - 3640,
+      }.transform_keys { |path| "#{Webpacker.config.public_output_path}/#{path}" }
+    end
+
+    let(:all_files) { prev_files.merge(expired_files) }
+
+    let(:file_delete_mock) { double("File Delete") }
+    let(:file_mtime_stub) { Proc.new { |longpath| all_files[longpath] } }
+    let(:file_delete_stub) { Proc.new { |longpath| file_delete_mock.delete(longpath) } }
+
+    before :context do
+      @dir_glob_stub = Proc.new { |arg|
+        case arg
+        when "#{Webpacker.config.public_output_path}/**/*"
+          all_files.keys
+        else
+          []
+        end
+      }
+    end
+
+    it "works with nested hashes and without any compiled files" do
+      allow(File).to receive(:delete).and_return(true)
+      expect(Webpacker.commands.clean).to be true
+    end
+
+    it "deletes only and only expired versioned files if no parameter passed" do
+      all_files.keys.each do |longpath|
+        allow(file_delete_mock).to receive(:delete).with(longpath)
+      end
+
+      with_time_dir_and_files_stub do
+        expect(Webpacker.commands.clean).to be true
+
+        # Verify that only and only expired files are deleted
+        all_files.keys.each do |longpath|
+          if expired_files.has_key? longpath
+            expect(file_delete_mock).to have_received(:delete).with(longpath)
+          else
+            expect(file_delete_mock).to_not have_received(:delete).with(longpath)
+          end
+        end
+      end
+    end
+
+    private
+
+      def with_time_dir_and_files_stub(&proc)
+        allow(Time).to receive(:now).and_return(now)
+        allow(Dir).to receive(:glob) { |arg| @dir_glob_stub.call(arg) }
+        allow(File).to receive(:directory?).and_return(false)
+        allow(File).to receive(:file?).and_return(true)
+        allow(File).to receive(:mtime) { |arg| file_mtime_stub.call(arg) }
+        allow(File).to receive(:delete) { |arg| file_delete_stub.call(arg) }
+
+        yield proc
+      end
+  end
+end