fix(serve): move install-app-deps to postinstall

nklayman · nklayman · commit a726ec99904f · 2018-08-23T11:01:40.000-07:00
diff --git a/__tests__/commands.spec.js b/__tests__/commands.spec.js
@@ -7,7 +7,7 @@ const fs = require('fs-extra')
 const execa = require('execa')
 const portfinder = require('portfinder')
 const Application = require('spectron').Application
-const { chainWebpack, getExternals } = require('../lib/webpackConfig')
+const { chainWebpack } = require('../lib/webpackConfig')
 // #endregion
 
 // #region Mocks
@@ -419,29 +419,6 @@ describe('serve:electron', () => {
     // Electron was re-launched
     expect(execa).toHaveBeenCalledTimes(3)
   })
-
-  test('Native deps are installed if detected', async () => {
-    getExternals.mockReturnValueOnce({
-      someDep: {
-        commonjs: 'someDep',
-        commonjs2: 'someDep'
-      }
-    })
-    await runCommand('serve:electron')
-
-    // electron-builder's install-app-deps function was called
-    expect(mockInstallAppDeps.mock.calls[0][0]).toEqual({
-      platform: process.platform
-    })
-  })
-
-  test('Native deps are not installed if there are none detected', async () => {
-    getExternals.mockReturnValueOnce({})
-    await runCommand('serve:electron')
-
-    // electron-builder's install-app-deps function was not called
-    expect(mockInstallAppDeps).not.toBeCalled()
-  })
 })
 
 describe('Custom webpack chain', () => {
diff --git a/__tests__/generator.spec.js b/__tests__/generator.spec.js
@@ -3,13 +3,16 @@ const fs = require('fs')
 jest.mock('fs')
 
 // Mock the generator api
+let pkg = {}
 let completionCb
 const mockApi = {
   render: jest.fn(),
   onCreateComplete: jest.fn(cb => {
     completionCb = cb
   }),
-  extendPackage: jest.fn(),
+  extendPackage: jest.fn(newPkg => {
+    pkg = newPkg
+  }),
   // Make sure api.resolve(path) is used
   resolve: jest.fn(path => 'apiResolve_' + path),
   hasPlugin: jest.fn()
@@ -23,6 +26,9 @@ test('extends gitignore if it exists', () => {
   fs.readFileSync.mockImplementation((path, encoding) => {
     // Check that utf8 encoding is set
     expect(encoding).toBe('utf8')
+    if (path === 'apiResolve_./package.json') {
+      return JSON.stringify({ scripts: {} })
+    }
     // return mock content
     return 'existing_content'
   })
@@ -51,7 +57,34 @@ test("doesn't modify .gitignore if it doesn't exist", () => {
     'existing_content\n#Electron-builder output\n/dist_electron'
   )
   expect(fs.readFileSync).not.toBeCalledWith('apiResolve_./.gitignore', 'utf8')
-  // Only index should have been read/written
+  // Only index should have been written
   expect(fs.writeFileSync).toHaveBeenCalledTimes(1)
-  expect(fs.readFileSync).toHaveBeenCalledTimes(1)
+})
+
+test('Adds electron-builder install-app-deps to postInstall', () => {
+  generator(mockApi)
+  completionCb()
+  expect(pkg.scripts.postinstall).toBe('electron-builder install-app-deps')
+})
+
+test('Adds on to existing postinstall script instead of replacing', () => {
+  fs.readFileSync.mockImplementation((path, encoding) => {
+    // Check that utf8 encoding is set
+    expect(encoding).toBe('utf8')
+    // Mock existing postinstall script in app's package.json
+    if (path === 'apiResolve_./package.json') {
+      return JSON.stringify({
+        scripts: { postinstall: 'existingTask' }
+      })
+    }
+    // return mock content
+    return 'existing_content'
+  })
+
+  generator(mockApi)
+  completionCb()
+
+  expect(pkg.scripts.postinstall).toBe(
+    'existingTask && electron-builder install-app-deps'
+  )
 })
diff --git a/generator/index.js b/generator/index.js
@@ -9,17 +9,19 @@ module.exports = api => {
     index = index.replace(
       /^\s*?<head.*?>\s*?$/m,
       `<head>\n    <% if (BASE_URL === './') { %><base href="app://./" /><% } %>
-      <% if (VUE_APP_NODE_MODULES_PATH !== "false") { %><script>require('module').globalPaths.push('<%= VUE_APP_NODE_MODULES_PATH %>')</script><% } %>`
+    <% if (VUE_APP_NODE_MODULES_PATH !== "false") { %><script>require('module').globalPaths.push('<%= VUE_APP_NODE_MODULES_PATH %>')</script><% } %>`
     )
     //   Write updated index.html
     fs.writeFileSync(api.resolve('./public/index.html'), index)
+
     // Update .gitignore if it exists
     if (fs.existsSync(api.resolve('./.gitignore'))) {
       let gitignore = fs.readFileSync(api.resolve('./.gitignore'), 'utf8')
       //   Add /dist_electron to gitignore
       gitignore = gitignore + '\n#Electron-builder output\n/dist_electron'
       fs.writeFileSync(api.resolve('./.gitignore'), gitignore)
     }
+
     if (api.hasPlugin('typescript')) {
       let background
       if (fs.existsSync(api.resolve('./src/background.js'))) {
@@ -36,10 +38,26 @@ module.exports = api => {
       fs.writeFileSync(api.resolve('./src/background.ts'), background)
     }
   })
+
+  // Add electron-builder install-app-deps to postinstall
+  let postinstallScript
+  let pkg = fs.readFileSync(api.resolve('./package.json'), 'utf8')
+  pkg = JSON.parse(pkg)
+  if (pkg.scripts && pkg.scripts.postinstall) {
+    // Add on to existing script if it exists
+    postinstallScript = `${
+      // Existing script
+      pkg.scripts.postinstall
+    } && electron-builder install-app-deps`
+  } else {
+    // Create new postinstall script
+    postinstallScript = 'electron-builder install-app-deps'
+  }
   api.extendPackage({
     scripts: {
       'build:electron': 'vue-cli-service build:electron',
-      'serve:electron': 'vue-cli-service serve:electron'
+      'serve:electron': 'vue-cli-service serve:electron',
+      postinstall: postinstallScript
     },
     devDependencies: {
       electron: '^2.0.2'
diff --git a/index.js b/index.js
@@ -221,6 +221,8 @@ module.exports = (api, options) => {
         .plugin('env')
         .use(webpack.EnvironmentPlugin, [{ NODE_ENV: 'development' }])
       mainConfig.entry('background').add(api.resolve(mainProcessFile))
+      // Set external (native) deps
+      mainConfig.externals(getExternals(api, pluginOptions))
       if (usesTypescript) {
         mainConfig.resolve.extensions.merge(['.js', '.ts'])
         mainConfig.module
@@ -231,17 +233,6 @@ module.exports = (api, options) => {
           .options({ transpileOnly: !mainProcessTypeChecking })
       }
 
-      // Build native deps if needed
-      const externals = getExternals(api, pluginOptions)
-      if (externals && Object.keys(externals).length > 0) {
-        // Set externals in main process webpack config
-        mainConfig.externals(externals)
-        console.log('Installing native deps with electron-builder:')
-        await require('electron-builder/out/cli/install-app-deps.js').installAppDeps(
-          { platform: process.platform }
-        )
-      }
-
       console.log('\nStarting development server:\n')
       // Run the serve command
       const server = await api.service.run('serve', {
