adds tests for custom build directory

Author: jzxhuang

README.md

@@ -20,7 +20,12 @@ Config values are written to `package.json` under the key `nextBundleAnalysis`,
 
 There is one config value, `showDetails`, that is set to "true" by default. This option renders a collapsed "details" section under each section of the bundle analysis comment explaining some of the finer details of the numbers provided. If you feel like this is not necessary and you and/or those working on your project understand the details, you can set this option to `false` and that section will not render.
 
-If your application builds to a directory other than `.next`, you can specify this with the key `buildOutputDirectory`.
+If your application [builds to a custom directory](https://nextjs.org/docs/api-reference/next.config.js/setting-a-custom-build-directory), you can specify this with the key `buildOutputDirectory`. You will also need to replace all instances of `.next` in `next_bundle_analysis.yml` with your custom output directory.
+
+For example, if you build to `dist`, you should:
+
+- Set `package.json.nextBundleAnalysis.buildOutputDirectory` to `"dist"`.
+- In `nextjs_bundle_analysis`, replace all instances of `.next` with `dist`.
 
 ### Caveats
 

__tests__/__fixtures__/package-lock.json renamed to __tests__/__fixtures__/basic/package-lock.json

@@ -0,0 +1,3 @@
+module.exports = {
+  distDir: 'dist',
+}

__tests__/__fixtures__/package.json renamed to __tests__/__fixtures__/basic/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "bundle-analysis-test-fixture",
+  "version": "1.0.0",
+  "description": "its a test",
+  "main": "index.js",
+  "author": "",
+  "license": "GPL-2.0",
+  "dependencies": {
+    "next": "^11.0.1",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2"
+  },
+  "scripts": {
+    "build": "next build"
+  },
+  "nextBundleAnalysis": {
+    "budget": 358400,
+    "budgetPercentIncreaseRed": 20,
+    "buildOutputDirectory": "dist"
+  }
+}

__tests__/__fixtures__/pages/index.jsx renamed to __tests__/__fixtures__/basic/pages/index.jsx

@@ -0,0 +1,3 @@
+export default function IndexPage() {
+  return <p>hello world</p>
+}

__tests__/__fixtures__/custom-output-directory/next.config.js

@@ -2,46 +2,74 @@ const path = require('path')
 const fs = require('fs')
 const { execSync } = require('child_process')
 const rimraf = require('rimraf')
-const { afterAll, beforeAll, expect } = require('@jest/globals')
+const { afterEach, beforeEach, expect } = require('@jest/globals')
 const mkdirp = require('mkdirp')
+const { getBuildOutputDirectory, getOptions } = require('../utils')
 
 const fixturesPath = path.join(__dirname, '__fixtures__')
 
-beforeAll(() => {
-  process.chdir(fixturesPath)
-  execSync('npm install')
-  execSync('npm run build')
-})
+// Get all test suites (fixtures)
+const fixtures = fs
+  .readdirSync(fixturesPath, { withFileTypes: true })
+  .filter((dirent) => dirent.isDirectory())
+  .map((dirent) => dirent.name)
 
-afterAll(() => {
-  rimraf.sync(path.join(fixturesPath, '.next'))
-})
+describe('sort of integration', () => {
+  fixtures.forEach((dirName) => {
+    describe(`fixture ${dirName}`, () => {
+      const cwd = path.join(fixturesPath, dirName)
+      const options = getOptions(cwd)
+      const buildOutputDirectory = getBuildOutputDirectory(options)
+
+      beforeEach(() => {
+        process.chdir(cwd)
+        execSync('npm install')
+        execSync('npm run build')
+      })
+
+      afterEach(() => {
+        rimraf.sync(path.join(cwd, buildOutputDirectory))
+      })
+
+      test(`bundle analysis action generates report and compares artifacts correctly ${dirName}`, () => {
+        // make sure the 'report' command works
+        execSync('node ../../../report.js')
+        const bundleAnalysis = fs.readFileSync(
+          path.join(
+            process.cwd(),
+            buildOutputDirectory,
+            'analyze/__bundle_analysis.json'
+          ),
+          'utf8'
+        )
+        expect(bundleAnalysis.length).toBeGreaterThan(1)
+
+        // create a fake artifact download - in the real world this would pull from
+        // github as part of the action flow
+        mkdirp.sync(
+          path.join(process.cwd(), buildOutputDirectory, 'analyze/base/bundle')
+        )
+        fs.writeFileSync(
+          path.join(
+            process.cwd(),
+            buildOutputDirectory,
+            'analyze/base/bundle/__bundle_analysis.json'
+          ),
+          bundleAnalysis
+        )
 
-test('sort of integration', () => {
-  // make sure the 'report' command works
-  execSync('node ../../report.js')
-  const bundleAnalysis = fs.readFileSync(
-    path.join(process.cwd(), '.next/analyze/__bundle_analysis.json'),
-    'utf8'
-  )
-  expect(bundleAnalysis.length).toBeGreaterThan(1)
-
-  // create a fake artifact download - in the real world this would pull from
-  // github as part of the action flow
-  mkdirp.sync(path.join(process.cwd(), '.next/analyze/base/bundle'))
-  fs.writeFileSync(
-    path.join(
-      process.cwd(),
-      '.next/analyze/base/bundle/__bundle_analysis.json'
-    ),
-    bundleAnalysis
-  )
-
-  // make sure the 'compare' command works
-  execSync('node ../../compare.js')
-  const comment = fs.readFileSync(
-    path.join(process.cwd(), '.next/analyze/__bundle_analysis_comment.txt'),
-    'utf8'
-  )
-  expect(comment).toMatch(/no changes to the javascript bundle/)
+        // make sure the 'compare' command works
+        execSync('node ../../../compare.js')
+        const comment = fs.readFileSync(
+          path.join(
+            process.cwd(),
+            buildOutputDirectory,
+            'analyze/__bundle_analysis_comment.txt'
+          ),
+          'utf8'
+        )
+        expect(comment).toMatch(/no changes to the javascript bundle/)
+      })
+    })
+  })
 })

__tests__/__fixtures__/custom-output-directory/package-lock.json

@@ -1,4 +1,4 @@
-name: "Next.js Bundle Analysis"
+name: 'Next.js Bundle Analysis'
 
 on:
   pull_request:
@@ -21,7 +21,7 @@ jobs:
       - name: Set up node
         uses: actions/setup-node@v1
         with:
-          node-version: "14.x"
+          node-version: '14.x'
 
       - name: Install dependencies
         uses: bahmutov/npm-install@v1
@@ -32,6 +32,8 @@ jobs:
         env:
           cache-name: cache-next-build
         with:
+          # if you use a custom build directory, replace all instances of `.next` in this file with your build directory
+          # ex: if your app builds to `dist`, replace `.next` with `dist`
           path: .next/cache
           # change this if you prefer a more strict cache
           key: ${{ runner.os }}-build-${{ env.cache-name }}
@@ -92,7 +94,7 @@ jobs:
         id: fc
         with:
           issue-number: ${{ github.event.number }}
-          body-includes: "<!-- __NEXTJS_BUNDLE -->"
+          body-includes: '<!-- __NEXTJS_BUNDLE -->'
 
       - name: Create Comment
         uses: peter-evans/[email protected]
@@ -108,4 +110,4 @@ jobs:
           issue-number: ${{ github.event.number }}
           body: ${{ steps.get-comment-body.outputs.body }}
           comment-id: ${{ steps.fc.outputs.comment-id }}
-          edit-mode: replace
+          edit-mode: replace