Nuxt/packages/builder/test/builder.build.test.js

import path from 'path'
import consola from 'consola'
import fsExtra from 'fs-extra'
import semver from 'semver'
import { r, waitFor } from '@nuxt/utils'

import Builder from '../src/builder'
import { createNuxt } from './__utils__'

jest.mock('fs-extra')
jest.mock('semver')
jest.mock('hash-sum', () => src => `hash(${src})`)
jest.mock('@nuxt/utils')
jest.mock('../src/ignore')

describe('builder: builder build', () => {
  beforeAll(() => {
    jest.spyOn(path, 'join').mockImplementation((...args) => `join(${args.join(', ')})`)
  })

  afterAll(() => {
    path.join.mockRestore()
  })

  beforeEach(() => {
    jest.clearAllMocks()
  })

  test('should build all resources', async () => {
    const nuxt = createNuxt()
    nuxt.options.srcDir = '/var/nuxt/src'
    nuxt.options.buildDir = '/var/nuxt/build'
    nuxt.options.dir = { pages: '/var/nuxt/src/pages' }
    nuxt.options.build.createRoutes = jest.fn()

    const bundleBuilder = { build: jest.fn() }
    const builder = new Builder(nuxt, bundleBuilder)
    builder.validatePages = jest.fn()
    builder.validateTemplate = jest.fn()
    builder.generateRoutesAndFiles = jest.fn()
    builder.resolvePlugins = jest.fn()

    r.mockImplementation((dir, src) => `r(${dir})`)

    const buildReturn = await builder.build()

    expect(consola.info).toBeCalledTimes(1)
    expect(consola.info).toBeCalledWith('Production build')
    expect(nuxt.ready).toBeCalledTimes(1)
    expect(nuxt.callHook).toBeCalledTimes(2)
    expect(nuxt.callHook).nthCalledWith(1, 'build:before', builder, nuxt.options.build)
    expect(builder.validatePages).toBeCalledTimes(1)
    expect(builder.validateTemplate).toBeCalledTimes(1)
    expect(consola.success).toBeCalledTimes(1)
    expect(consola.success).toBeCalledWith('Builder initialized')
    expect(consola.debug).toBeCalledTimes(1)
    expect(consola.debug).toBeCalledWith('App root: /var/nuxt/src')
    expect(fsExtra.remove).toBeCalledTimes(1)
    expect(fsExtra.remove).toBeCalledWith('r(/var/nuxt/build)')
    expect(fsExtra.mkdirp).toBeCalledTimes(3)
    expect(fsExtra.mkdirp).nthCalledWith(1, 'r(/var/nuxt/build)')
    expect(fsExtra.mkdirp).nthCalledWith(2, 'r(/var/nuxt/build)')
    expect(fsExtra.mkdirp).nthCalledWith(3, 'r(/var/nuxt/build)')
    expect(r).toBeCalledTimes(4)
    expect(r).nthCalledWith(1, '/var/nuxt/build')
    expect(r).nthCalledWith(2, '/var/nuxt/build', 'components')
    expect(r).nthCalledWith(3, '/var/nuxt/build', 'dist', 'client')
    expect(r).nthCalledWith(4, '/var/nuxt/build', 'dist', 'server')
    expect(builder.generateRoutesAndFiles).toBeCalledTimes(1)
    expect(builder.resolvePlugins).toBeCalledTimes(1)
    expect(bundleBuilder.build).toBeCalledTimes(1)
    expect(builder._buildStatus).toEqual(2)
    expect(nuxt.callHook).nthCalledWith(2, 'build:done', builder)
    expect(buildReturn).toBe(builder)
  })

  test('should prevent duplicate build in dev mode', async () => {
    const nuxt = createNuxt()
    nuxt.options.dev = true
    const builder = new Builder(nuxt, {})
    builder._buildStatus = 3

    waitFor.mockImplementationOnce(() => {
      builder.build = jest.fn(() => 'calling build')
    })

    const buildReturn = await builder.build()

    expect(nuxt.ready).not.toBeCalled()
    expect(waitFor).toBeCalledTimes(1)
    expect(waitFor).toBeCalledWith(1000)
    expect(builder.build).toBeCalledTimes(1)
    expect(buildReturn).toBe('calling build')
  })

  test('should wait 1000ms and retry if building is in progress', async () => {
    const nuxt = createNuxt()
    nuxt.options.dev = true
    const builder = new Builder(nuxt, {})
    builder._buildStatus = 2

    const buildReturn = await builder.build()

    expect(nuxt.ready).not.toBeCalled()
    expect(buildReturn).toBe(builder)
  })

  test('should build in dev mode and print dev mode building messages', async () => {
    const nuxt = createNuxt()
    nuxt.options.dev = true
    nuxt.options.srcDir = '/var/nuxt/src'
    nuxt.options.buildDir = '/var/nuxt/build'
    nuxt.options.dir = { pages: '/var/nuxt/src/pages' }
    nuxt.options.build.createRoutes = jest.fn()

    const bundleBuilder = { build: jest.fn() }
    const builder = new Builder(nuxt, bundleBuilder)
    builder.validatePages = jest.fn()
    builder.validateTemplate = jest.fn()
    builder.generateRoutesAndFiles = jest.fn()
    builder.resolvePlugins = jest.fn()

    await builder.build()

    expect(consola.info).toBeCalledTimes(2)
    expect(consola.info).nthCalledWith(1, 'Preparing project for development')
    expect(consola.info).nthCalledWith(2, 'Initial build may take a while')
    expect(fsExtra.mkdirp).toBeCalledTimes(1)
    expect(fsExtra.mkdirp).toBeCalledWith('r(/var/nuxt/build)')
    expect(r).toBeCalledTimes(2)
    expect(r).nthCalledWith(1, '/var/nuxt/build')
    expect(r).nthCalledWith(2, '/var/nuxt/build', 'components')
  })

  test('should throw error when validateTemplate failed', async () => {
    const nuxt = createNuxt()
    const builder = new Builder(nuxt, {})
    builder.validatePages = jest.fn()
    builder.validateTemplate = jest.fn(() => {
      throw new Error('validate failed')
    })
    consola.success.mockImplementationOnce(() => {
      throw new Error('exit')
    })

    await expect(builder.build()).rejects.toThrow('exit')

    expect(builder._buildStatus).toEqual(3)
    expect(consola.fatal).toBeCalledTimes(1)
    expect(consola.fatal).toBeCalledWith(new Error('validate failed'))
  })

  test('should warn built-in page will be used if no pages dir found', async () => {
    const nuxt = createNuxt()
    nuxt.options.srcDir = '/var/nuxt/src'
    nuxt.options.dir = { pages: '/var/nuxt/src/pages' }
    const builder = new Builder(nuxt, {})
    fsExtra.exists.mockReturnValue(false)

    await builder.validatePages()

    expect(builder._nuxtPages).toEqual(true)
    expect(path.join).toBeCalledTimes(2)
    expect(path.join).nthCalledWith(1, '/var/nuxt/src', '/var/nuxt/src/pages')
    expect(path.join).nthCalledWith(2, '/var/nuxt/src', '..', '/var/nuxt/src/pages')
    expect(fsExtra.exists).toBeCalledTimes(2)
    expect(fsExtra.exists).nthCalledWith(1, 'join(/var/nuxt/src, /var/nuxt/src/pages)')
    expect(fsExtra.exists).nthCalledWith(2, 'join(/var/nuxt/src, .., /var/nuxt/src/pages)')
    expect(builder._defaultPage).toEqual(true)
    expect(consola.warn).toBeCalledTimes(1)
    expect(consola.warn).toBeCalledWith('No `/var/nuxt/src/pages` directory found in /var/nuxt/src. Using the default built-in page.')
  })

  test('should throw error if pages is found in parent dir', async () => {
    const nuxt = createNuxt()
    nuxt.options.srcDir = '/var/nuxt/src'
    nuxt.options.dir = { pages: '/var/nuxt/src/pages' }
    const builder = new Builder(nuxt, {})
    fsExtra.exists
      .mockReturnValueOnce(false)
      .mockReturnValueOnce(true)

    await expect(builder.validatePages()).rejects.toThrow(
      'No `/var/nuxt/src/pages` directory found in /var/nuxt/src. Did you mean to run `nuxt` in the parent (`../`) directory?'
    )

    expect(builder._nuxtPages).toEqual(true)
    expect(path.join).toBeCalledTimes(2)
    expect(path.join).nthCalledWith(1, '/var/nuxt/src', '/var/nuxt/src/pages')
    expect(path.join).nthCalledWith(2, '/var/nuxt/src', '..', '/var/nuxt/src/pages')
    expect(fsExtra.exists).toBeCalledTimes(2)
    expect(fsExtra.exists).nthCalledWith(1, 'join(/var/nuxt/src, /var/nuxt/src/pages)')
    expect(fsExtra.exists).nthCalledWith(2, 'join(/var/nuxt/src, .., /var/nuxt/src/pages)')
    expect(builder._defaultPage).toBeUndefined()
  })

  test('should pass validation if createRoutes is function', async () => {
    const nuxt = createNuxt()
    nuxt.options.build.createRoutes = jest.fn()
    const builder = new Builder(nuxt, {})

    await builder.validatePages()

    expect(builder._nuxtPages).toEqual(false)
    expect(fsExtra.exists).not.toBeCalled()
  })

  test('should pass validation if pages exists', async () => {
    const nuxt = createNuxt()
    nuxt.options.srcDir = '/var/nuxt/src'
    nuxt.options.dir = { pages: '/var/nuxt/src/pages' }
    const builder = new Builder(nuxt, {})
    fsExtra.exists.mockReturnValueOnce(true)

    await builder.validatePages()

    expect(builder._nuxtPages).toEqual(true)
    expect(path.join).toBeCalledTimes(1)
    expect(path.join).toBeCalledWith('/var/nuxt/src', '/var/nuxt/src/pages')
    expect(fsExtra.exists).toBeCalledTimes(1)
    expect(fsExtra.exists).toBeCalledWith('join(/var/nuxt/src, /var/nuxt/src/pages)')
    expect(builder._defaultPage).toBeUndefined()
  })

  test('should validate dependencies in template', () => {
    const nuxt = createNuxt()
    nuxt.options.build.template = {
      dependencies: {
        vue: 'latest',
        nuxt: 'edge'
      }
    }
    const builder = new Builder(nuxt, {})
    semver.satisfies
      .mockReturnValueOnce(true)
      .mockReturnValueOnce(true)
    nuxt.resolver.requireModule
      .mockReturnValueOnce({ version: 'alpha' })
      .mockReturnValueOnce({ version: 'beta' })

    builder.validateTemplate()

    expect(nuxt.resolver.requireModule).toBeCalledTimes(2)
    expect(nuxt.resolver.requireModule).nthCalledWith(1, 'join(vue, package.json)')
    expect(nuxt.resolver.requireModule).nthCalledWith(2, 'join(nuxt, package.json)')
    expect(semver.satisfies).toBeCalledTimes(2)
    expect(semver.satisfies).nthCalledWith(1, 'alpha', 'latest')
    expect(semver.satisfies).nthCalledWith(2, 'beta', 'edge')
  })

  test('should warn and throw error if dependencies is not installed', () => {
    const nuxt = createNuxt()
    nuxt.options.build.template = {
      dependencies: {
        vue: 'latest',
        nuxt: 'edge'
      }
    }
    const builder = new Builder(nuxt, {})
    semver.satisfies
      .mockReturnValueOnce(false)
    nuxt.resolver.requireModule
      .mockReturnValueOnce({ version: 'alpha' })
      .mockReturnValueOnce(undefined)

    expect(() => builder.validateTemplate()).toThrow('Missing Template Dependencies')

    expect(nuxt.resolver.requireModule).toBeCalledTimes(2)
    expect(nuxt.resolver.requireModule).nthCalledWith(1, 'join(vue, package.json)')
    expect(nuxt.resolver.requireModule).nthCalledWith(2, 'join(nuxt, package.json)')
    expect(consola.warn).toBeCalledTimes(2)
    expect(consola.warn).nthCalledWith(1, 'vue@latest is required but vue@alpha is installed!')
    expect(consola.warn).nthCalledWith(2, 'nuxt@edge is required but not installed!')
    expect(consola.error).toBeCalledTimes(1)
    expect(consola.error).toBeCalledWith(
      'Please install missing dependencies:\n',
      '\n',
      'Using yarn:\n',
      'yarn add vue@latest nuxt@edge\n',
      '\n',
      'Using npm:\n',
      'npm i vue@latest nuxt@edge\n'
    )
    expect(semver.satisfies).toBeCalledTimes(1)
    expect(semver.satisfies).nthCalledWith(1, 'alpha', 'latest')
  })
})