shakapacker 6.5.5 → 6.5.6

data/package/rules/__tests__/swc.js

@@ -0,0 +1,64 @@
+const path = require("path");
+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 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,24 +1,13 @@
-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/,
+    ...jscommon,
     use: [
       {
         loader: require.resolve('babel-loader'),
@@ -29,4 +18,4 @@ module.exports = loaderMatches(webpackLoader, 'babel', () => ({
         }
       }
     ]
-  }))
+}))

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/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/helpers.js

@@ -2,7 +2,7 @@ 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/test_app')
   } catch (e) {
     return null
   }

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shakapacker",
-  "version": "6.5.5",
+  "version": "6.5.6",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "main": "package/index.js",
   "files": [
@@ -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/spec/command_spec.rb

@@ -0,0 +1,114 @@
+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

data/spec/compiler_spec.rb

@@ -0,0 +1,57 @@
+describe "Webpacker::Compiler" do
+  it "accepts custom environment variables" do
+    expect(Webpacker.compiler.send(:webpack_env)["FOO"]).to be nil
+
+    Webpacker.compiler.env["FOO"] = "BAR"
+    expect(Webpacker.compiler.send(:webpack_env)["FOO"]).to eq "BAR"
+  ensure
+    Webpacker.compiler.env = {}
+  end
+
+  it "returns true when fresh" do
+    mocked_strategy = double("Strategy")
+    expect(mocked_strategy).to receive(:stale?).and_return(false)
+
+    expect(Webpacker.compiler).to receive(:strategy).and_return(mocked_strategy)
+
+    expect(Webpacker.compiler.compile).to be true
+  end
+
+  it "returns true and calls after_compile_hook on successful compile" do
+    mocked_strategy = spy("Strategy")
+    expect(mocked_strategy).to receive(:stale?).and_return(true)
+
+    allow(Webpacker.compiler).to receive(:strategy).and_return(mocked_strategy)
+
+    status = OpenStruct.new(success?: true)
+    allow(Open3).to receive(:capture3).and_return([:sterr, :stdout, status])
+
+    expect(Webpacker.compiler.compile).to be true
+    expect(mocked_strategy).to have_received(:after_compile_hook)
+  end
+
+  it "returns false and calls after_compile_hook on failed compile" do
+    mocked_strategy = spy("Strategy")
+    allow(mocked_strategy).to receive(:stale?).and_return(true)
+    allow(mocked_strategy).to receive(:after_compile_hook)
+
+    allow(Webpacker.compiler).to receive(:strategy).and_return(mocked_strategy)
+
+    status = OpenStruct.new(success?: false)
+    allow(Open3).to receive(:capture3).and_return([:sterr, :stdout, status])
+
+    expect(Webpacker.compiler.compile).to be false
+    expect(mocked_strategy).to have_received(:after_compile_hook)
+  end
+
+  it "accepts external env variables" do
+    expect(Webpacker.compiler.send(:webpack_env)["WEBPACKER_ASSET_HOST"]).to be nil
+    expect(Webpacker.compiler.send(:webpack_env)["WEBPACKER_RELATIVE_URL_ROOT"]).to be nil
+
+    ENV["WEBPACKER_ASSET_HOST"] = "foo.bar"
+    ENV["WEBPACKER_RELATIVE_URL_ROOT"] = "/baz"
+
+    expect(Webpacker.compiler.send(:webpack_env)["WEBPACKER_ASSET_HOST"]).to eq "foo.bar"
+    expect(Webpacker.compiler.send(:webpack_env)["WEBPACKER_RELATIVE_URL_ROOT"]).to eq "/baz"
+  end
+end

data/spec/compiler_strategy_spec.rb

@@ -0,0 +1,20 @@
+describe "Webpacker::CompilerStrategy" do
+  describe "#from_config" do
+    it "returns and instance of MtimeStrategy when compiler_strategy is set to mtime" do
+      allow(Webpacker.config).to receive(:compiler_strategy).and_return("mtime")
+      expect(Webpacker::CompilerStrategy.from_config).to be_an_instance_of(Webpacker::MtimeStrategy)
+    end
+
+    it "returns and instance of DigestStrategy when compiler_strategy is set to digest" do
+      allow(Webpacker.config).to receive(:compiler_strategy).and_return("digest")
+      expect(Webpacker::CompilerStrategy.from_config).to be_an_instance_of(Webpacker::DigestStrategy)
+    end
+
+    it "raise exception for unknown compiler_strategy in the config file" do
+      expected_error_message = "Unknown strategy 'other'. Available options are 'mtime' and 'digest'."
+      allow(Webpacker.config).to receive(:compiler_strategy).and_return("other")
+
+      expect { Webpacker::CompilerStrategy.from_config }.to raise_error(expected_error_message)
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,281 @@
+describe "Webpacker::Configuration" do
+  ROOT_PATH = Pathname.new(File.expand_path("test_app", __dir__))
+
+  context "with standard webpacker.yml" do
+    let(:config) do
+      Webpacker::Configuration.new(
+        root_path: ROOT_PATH,
+        config_path: Pathname.new(File.expand_path("./test_app/config/webpacker.yml", __dir__)),
+        env: "production"
+      )
+    end
+
+    it "#source_path returns correct path" do
+      source_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/app/packs").to_s
+      expect(config.source_path.to_s).to eq source_path
+    end
+
+    it "#source_entry_path returns correct path" do
+      source_entry_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/app/packs", "entrypoints").to_s
+      expect(config.source_entry_path.to_s).to eq source_entry_path
+    end
+
+    it "#public_root_path returns correct path" do
+      public_root_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/public").to_s
+      expect(config.public_path.to_s).to eq public_root_path
+    end
+
+    it "#public_output_path returns correct path" do
+      public_output_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/public/packs").to_s
+      expect(config.public_output_path.to_s).to eq public_output_path
+    end
+
+    it "#public_manifest_path returns correct path" do
+      public_manifest_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/public/packs", "manifest.json").to_s
+      expect(config.public_manifest_path.to_s).to eq public_manifest_path
+    end
+
+    it "#manifest_path returns correct path" do
+      manifest_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/public/packs", "manifest.json").to_s
+      expect(config.manifest_path.to_s).to eq manifest_path
+    end
+
+    it "#cache_path returns correct path" do
+      cache_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/tmp/webpacker").to_s
+      expect(config.cache_path.to_s).to eq cache_path
+    end
+
+    it "#additional_paths returns correct path" do
+      expect(config.additional_paths).to eq ["app/assets", "/etc/yarn", "some.config.js", "app/elm"]
+    end
+
+    describe "#cache_manifest?" do
+      it "returns true in production environment" do
+        expect(config.cache_manifest?).to be true
+      end
+
+      it "returns false in developemnt environemnt" do
+        with_rails_env("development") do
+          expect(Webpacker.config.cache_manifest?).to be false
+        end
+      end
+
+      it "returns false in test environment" do
+        with_rails_env("test") do
+          expect(Webpacker.config.cache_manifest?).to be false
+        end
+      end
+    end
+
+    describe "#compile?" do
+      it "returns false in production environment" do
+        expect(config.compile?).to be false
+      end
+
+      it "returns true in developemnt environemnt" do
+        with_rails_env("development") do
+          expect(Webpacker.config.compile?).to be true
+        end
+      end
+
+      it "returns true in test environemnt" do
+        with_rails_env("test") do
+          expect(Webpacker.config.compile?).to be true
+        end
+      end
+    end
+
+    describe "#nested_entries?" do
+      it "returns false in production environment" do
+        expect(config.nested_entries?).to be false
+      end
+
+      it "returns false in development environment" do
+        with_rails_env("development") do
+          expect(Webpacker.config.nested_entries?).to be false
+        end
+      end
+
+      it "returns false in test environment" do
+        with_rails_env("test") do
+          expect(Webpacker.config.nested_entries?).to be false
+        end
+      end
+    end
+
+    describe "#ensure_consistent_versioning?" do
+      it "returns false in production environment" do
+        expect(config.ensure_consistent_versioning?).to be false
+      end
+
+      it "returns true in development environment" do
+        with_rails_env("development") do
+          expect(Webpacker.config.ensure_consistent_versioning?).to be true
+        end
+      end
+
+      it "returns false in test environment" do
+        with_rails_env("test") do
+          expect(Webpacker.config.ensure_consistent_versioning?).to be false
+        end
+      end
+    end
+
+    describe "#webpacker_precompile?" do
+      before :each do
+        ENV["WEBPACKER_PRECOMPILE"] = nil
+      end
+
+      subject { config.webpacker_precompile? }
+
+      it "returns true when WEBPACKER_PRECOMPILE is unset" do
+        is_expected.to be true
+      end
+
+      it "returns false when WEBPACKER_PRECOMPILE sets to no" do
+        ENV["WEBPACKER_PRECOMPILE"] = "no"
+        is_expected.to be false
+      end
+
+      it "returns true when WEBPACKER_PRECOMPILE sets to yes" do
+        ENV["WEBPACKER_PRECOMPILE"] = "yes"
+        is_expected.to be true
+      end
+
+      it "returns false when WEBPACKER_PRECOMPILE sets to false" do
+        ENV["WEBPACKER_PRECOMPILE"] = "false"
+        is_expected.to be false
+      end
+
+      it "returns true when WEBPACKER_PRECOMPILE sets to true" do
+        ENV["WEBPACKER_PRECOMPILE"] = "true"
+        is_expected.to be true
+      end
+
+      it "returns false when WEBPACKER_PRECOMPILE sets to n" do
+        ENV["WEBPACKER_PRECOMPILE"] = "n"
+        is_expected.to be false
+      end
+
+      it "returns true when WEBPACKER_PRECOMPILE sets to y" do
+        ENV["WEBPACKER_PRECOMPILE"] = "y"
+        is_expected.to be true
+      end
+
+      it "returns false when WEBPACKER_PRECOMPILE sets to f" do
+        ENV["WEBPACKER_PRECOMPILE"] = "f"
+        is_expected.to be false
+      end
+
+      it "returns true when WEBPACKER_PRECOMPILE sets to t" do
+        ENV["WEBPACKER_PRECOMPILE"] = "t"
+        is_expected.to be true
+      end
+    end
+  end
+
+  context "with webpacker config file containing public_output_path entry" do
+    config = Webpacker::Configuration.new(
+      root_path: ROOT_PATH,
+      config_path: Pathname.new(File.expand_path("./test_app/config/webpacker_public_root.yml", __dir__)),
+      env: "production"
+    )
+
+    it "#public_output_path returns correct path" do
+      expected_public_output_path = File.expand_path File.join(File.dirname(__FILE__), "public/packs").to_s
+      expect(config.public_output_path.to_s).to eq expected_public_output_path
+    end
+  end
+
+  context "with webpacker config file containing manifext_path entry" do
+    config = Webpacker::Configuration.new(
+      root_path: ROOT_PATH,
+      config_path: Pathname.new(File.expand_path("./test_app/config/webpacker_manifest_path.yml", __dir__)),
+      env: "production"
+    )
+
+    it "#manifest_path returns correct expected value" do
+      expected_manifest_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/app/packs", "manifest.json").to_s
+      expect(config.manifest_path.to_s).to eq expected_manifest_path
+    end
+  end
+
+  context "with webpacker_precompile entry set to false" do
+    describe "#webpacker_precompile?" do
+      before :each do
+        ENV["WEBPACKER_PRECOMPILE"] = nil
+      end
+
+      let(:config) {
+        Webpacker::Configuration.new(
+          root_path: ROOT_PATH,
+          config_path: Pathname.new(File.expand_path("./test_app/config/webpacker_no_precompile.yml", __dir__)),
+          env: "production"
+        )
+      }
+
+      subject { config.webpacker_precompile? }
+
+      it "returns false with unset WEBPACKER_PRECOMPILE" do
+        expect(subject).to be false
+      end
+
+      it "returns true with WEBPACKER_PRECOMPILE set to true" do
+        ENV["WEBPACKER_PRECOMPILE"] = "true"
+        expect(subject).to be true
+      end
+
+      it "returns false with WEBPACKER_PRECOMPILE set to nil" do
+        ENV["WEBPACKER_PRECOMPILE"] = nil
+        expect(subject).to be false
+      end
+    end
+  end
+
+  context "with webpacker config file containing invalid path" do
+    config = Webpacker::Configuration.new(
+      root_path: ROOT_PATH,
+      config_path: Pathname.new(File.expand_path("./test_app/config/invalid_path.yml", __dir__)),
+      env: "default"
+    )
+
+    it "#webpacker_precompile? returns false" do
+      expect(config.webpacker_precompile?).to be false
+    end
+  end
+
+  context "with webpacker config file with defaults fallback" do
+    let(:config) do
+      Webpacker::Configuration.new(
+        root_path: ROOT_PATH,
+        config_path: Pathname.new(File.expand_path("./test_app/config/webpacker_defaults_fallback.yml", __dir__)),
+        env: "default"
+      )
+    end
+
+    it "#cache_manifest? falls back to 'default' config from bundled file" do
+      expect(config.cache_manifest?).to be false
+    end
+
+    it "#webpacker_precompile? uses 'default' config from custom file" do
+      expect(config.webpacker_precompile?).to be false
+    end
+  end
+
+  context "falls back to bundled production config for custom environments" do
+    let(:config) do
+      Webpacker::Configuration.new(
+        root_path: ROOT_PATH,
+        config_path: Pathname.new(File.expand_path("./test_app/config/webpacker_defaults_fallback.yml", __dir__)),
+        env: "staging"
+      )
+    end
+
+    it "#cache_manifest? fall back to 'production' config from bundled file" do
+      expect(config.cache_manifest?).to be true
+    end
+    it "#webpacker_precompile? use 'staging' config from custom file" do
+      expect(config.webpacker_precompile?).to be false
+    end
+  end
+end