shakapacker 7.3.0.beta.1 → 8.0.0.rc.2

data/test/package/production.test.js

@@ -0,0 +1,32 @@
+const { resolve } = require("path")
+const { chdirTestApp } = require("../helpers")
+
+const rootPath = process.cwd()
+chdirTestApp()
+
+describe("Production environment", () => {
+  afterAll(() => process.chdir(rootPath))
+
+  describe("generateWebpackConfig", () => {
+    beforeEach(() => jest.resetModules())
+
+    test("should use production config and environment", () => {
+      process.env.RAILS_ENV = "production"
+      process.env.NODE_ENV = "production"
+
+      const { generateWebpackConfig } = require("../../package/index")
+
+      const webpackConfig = generateWebpackConfig()
+
+      expect(webpackConfig.output.path).toStrictEqual(
+        resolve("public", "packs")
+      )
+      expect(webpackConfig.output.publicPath).toBe("/packs/")
+
+      expect(webpackConfig).toMatchObject({
+        devtool: "source-map",
+        stats: "normal"
+      })
+    })
+  })
+})

data/test/package/rules/babel.test.js

@@ -0,0 +1,58 @@
+const {
+  pathToAppJavascript,
+  pathToNodeModules,
+  pathToNodeModulesIncluded,
+  createTestCompiler,
+  createTrackLoader
+} = require("../../helpers")
+const babelConfig = require("../../../package/rules/babel")
+
+jest.mock("../../../package/config", () => {
+  const original = jest.requireActual("../../../package/config")
+  return {
+    ...original,
+    additional_paths: [...original.additional_paths, "node_modules/included"]
+  }
+})
+
+const createWebpackConfig = (file, use) => ({
+  entry: { file },
+  module: {
+    rules: [
+      {
+        ...babelConfig,
+        use
+      }
+    ]
+  },
+  output: {
+    path: "/",
+    filename: "scripts-bundled.js"
+  }
+})
+
+describe("babel", () => {
+  test("process source path", async () => {
+    const normalPath = `${pathToAppJavascript}/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 = `${pathToNodeModules}/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 = `${pathToNodeModulesIncluded}/a.js`
+    const [tracked, loader] = createTrackLoader()
+    const compiler = createTestCompiler(createWebpackConfig(included, loader))
+    await compiler.run()
+    expect(tracked[included]).toBeTruthy()
+  })
+})

data/test/package/rules/esbuild.test.js

@@ -0,0 +1,59 @@
+const {
+  pathToAppJavascript,
+  pathToNodeModules,
+  pathToNodeModulesIncluded,
+  createTestCompiler,
+  createTrackLoader
+} = require("../../helpers")
+const esbuildConfig = require("../../../package/rules/esbuild")
+
+jest.mock("../../../package/config", () => {
+  const original = jest.requireActual("../../../package/config")
+  return {
+    ...original,
+    webpack_loader: "esbuild",
+    additional_paths: [...original.additional_paths, "node_modules/included"]
+  }
+})
+
+const createWebpackConfig = (file, use) => ({
+  entry: { file },
+  module: {
+    rules: [
+      {
+        ...esbuildConfig,
+        use
+      }
+    ]
+  },
+  output: {
+    path: "/",
+    filename: "scripts-bundled.js"
+  }
+})
+
+describe("swc", () => {
+  test("process source path", async () => {
+    const normalPath = `${pathToAppJavascript}/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 = `${pathToNodeModules}/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 = `${pathToNodeModulesIncluded}/a.js`
+    const [tracked, loader] = createTrackLoader()
+    const compiler = createTestCompiler(createWebpackConfig(included, loader))
+    await compiler.run()
+    expect(tracked[included]).toBeTruthy()
+  })
+})

data/test/package/rules/file.test.js

@@ -0,0 +1,81 @@
+const file = require("../../../package/rules/file")
+
+jest.mock("../../../package/config", () => {
+  const original = jest.requireActual("../../../package/config")
+  return {
+    ...original,
+    additional_paths: [...original.additional_paths, "app/assets"]
+  }
+})
+
+describe("file", () => {
+  test("expected file types", () => {
+    const types = [
+      ".bmp",
+      ".gif",
+      ".jpg",
+      ".jpeg",
+      ".png",
+      ".tiff",
+      ".ico",
+      ".avif",
+      ".webp",
+      ".eot",
+      ".otf",
+      ".ttf",
+      ".woff",
+      ".woff2",
+      ".svg"
+    ]
+    types.forEach((type) => expect(file.test.test(type)).toBe(true))
+  })
+
+  test("exclude expected file types", () => {
+    const types = [".js", ".mjs", ".jsx", ".ts", ".tsx"]
+    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)).toBe(
+      "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)).toBe(
+      "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)).toBe(
+      "static/images/nested/deeply/[name]-[hash][ext][query]"
+    )
+  })
+
+  test("correct generated output path is returned for additional_paths", () => {
+    const pathData = {
+      filename: "app/assets/images/image.svg"
+    }
+
+    expect(file.generator.filename(pathData)).toBe(
+      "static/images/[name]-[hash][ext][query]"
+    )
+
+    const pathData2 = {
+      filename: "app/javascript/app/assets/image.svg"
+    }
+    expect(file.generator.filename(pathData2)).toBe(
+      "static/app/assets/[name]-[hash][ext][query]"
+    )
+  })
+})

data/test/package/rules/index.test.js

@@ -0,0 +1,7 @@
+const rules = require("../../../package/rules/index")
+
+describe("index", () => {
+  test("rule tests are regexes", () => {
+    rules.forEach((rule) => expect(rule.test instanceof RegExp).toBe(true))
+  })
+})

data/test/package/rules/raw.test.js

@@ -0,0 +1,12 @@
+const raw = require("../../../package/rules/raw")
+
+describe("raw", () => {
+  test("expected file types", () => {
+    expect(raw.test.test(".html")).toBe(true)
+  })
+
+  test("exclude expected file types", () => {
+    const types = [".js", ".mjs", ".jsx", ".ts", ".tsx"]
+    types.forEach((type) => expect(raw.exclude.test(type)).toBe(true))
+  })
+})

data/test/package/rules/swc.test.js

@@ -0,0 +1,59 @@
+const {
+  pathToAppJavascript,
+  pathToNodeModules,
+  pathToNodeModulesIncluded,
+  createTestCompiler,
+  createTrackLoader
+} = require("../../helpers")
+const swcConfig = require("../../../package/rules/swc")
+
+jest.mock("../../../package/config", () => {
+  const original = jest.requireActual("../../../package/config")
+  return {
+    ...original,
+    webpack_loader: "swc",
+    additional_paths: [...original.additional_paths, "node_modules/included"]
+  }
+})
+
+const createWebpackConfig = (file, use) => ({
+  entry: { file },
+  module: {
+    rules: [
+      {
+        ...swcConfig,
+        use
+      }
+    ]
+  },
+  output: {
+    path: "/",
+    filename: "scripts-bundled.js"
+  }
+})
+
+describe("swc", () => {
+  test("process files in source_path", async () => {
+    const normalPath = `${pathToAppJavascript}/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 = `${pathToNodeModules}/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 = `${pathToNodeModulesIncluded}/a.js`
+    const [tracked, loader] = createTrackLoader()
+    const compiler = createTestCompiler(createWebpackConfig(included, loader))
+    await compiler.run()
+    expect(tracked[included]).toBeTruthy()
+  })
+})

data/test/package/staging.test.js

@@ -0,0 +1,31 @@
+const { resolve } = require("path")
+const { chdirTestApp } = require("../helpers")
+
+const rootPath = process.cwd()
+chdirTestApp()
+
+describe("Custom environment", () => {
+  afterAll(() => process.chdir(rootPath))
+
+  describe("generateWebpackConfig", () => {
+    beforeEach(() => jest.resetModules())
+
+    test("should use staging config and default production environment", () => {
+      process.env.RAILS_ENV = "staging"
+      delete process.env.NODE_ENV
+
+      const { generateWebpackConfig } = require("../../package/index")
+
+      const webpackConfig = generateWebpackConfig()
+
+      expect(webpackConfig.output.path).toStrictEqual(
+        resolve("public", "packs-staging")
+      )
+      expect(webpackConfig.output.publicPath).toBe("/packs-staging/")
+      expect(webpackConfig).toMatchObject({
+        devtool: "source-map",
+        stats: "normal"
+      })
+    })
+  })
+})

data/test/package/test.test.js

@@ -0,0 +1,28 @@
+const { resolve } = require("path")
+const { chdirTestApp } = require("../helpers")
+
+const rootPath = process.cwd()
+chdirTestApp()
+
+describe("Test environment", () => {
+  afterAll(() => process.chdir(rootPath))
+
+  describe("generateWebpackConfig", () => {
+    beforeEach(() => jest.resetModules())
+
+    test("should use test config and production environment", () => {
+      process.env.RAILS_ENV = "test"
+      process.env.NODE_ENV = "test"
+
+      const { generateWebpackConfig } = require("../../package/index")
+
+      const webpackConfig = generateWebpackConfig()
+
+      expect(webpackConfig.output.path).toStrictEqual(
+        resolve("public", "packs-test")
+      )
+      expect(webpackConfig.output.publicPath).toBe("/packs-test/")
+      expect(webpackConfig.devServer).toBeUndefined()
+    })
+  })
+})