/* * Copyright 2017 balena.io * * Licensed under the Apache License, Version 2.0 (the "License") * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import * as CopyPlugin from 'copy-webpack-plugin'; import { readdirSync } from 'fs'; import * as _ from 'lodash'; import * as os from 'os'; import outdent from 'outdent'; import * as path from 'path'; import { env } from 'process'; import * as SimpleProgressWebpackPlugin from 'simple-progress-webpack-plugin'; import * as TerserPlugin from 'terser-webpack-plugin'; import { BannerPlugin, NormalModuleReplacementPlugin } from 'webpack'; import * as PnpWebpackPlugin from 'pnp-webpack-plugin'; import * as tsconfigRaw from './tsconfig.webpack.json'; /** * Don't webpack package.json as mixpanel & sentry tokens * will be inserted in it after webpacking */ function externalPackageJson(packageJsonPath: string) { return ( { request }: { context: string; request: string }, callback: (error?: Error | null, result?: string) => void, ) => { if (_.endsWith(request, 'package.json')) { return callback(null, `commonjs ${packageJsonPath}`); } return callback(); }; } function platformSpecificModule( platform: string, module: string, replacement = '{}', ) { // Resolves module on platform, otherwise resolves the replacement return ( { request }: { context: string; request: string }, callback: (error?: Error, result?: string, type?: string) => void, ) => { if (request === module && os.platform() !== platform) { callback(undefined, replacement); return; } callback(); }; } function renameNodeModules(resourcePath: string) { // electron-builder excludes the node_modules folder even if you specifically include it // Work around by renaming it to "modules" // See https://github.com/electron-userland/electron-builder/issues/4545 return ( path .relative(__dirname, resourcePath) .replace('node_modules', 'modules') // use the same name on all architectures so electron-builder can build a universal dmg on mac .replace(LZMA_BINDINGS_FOLDER, LZMA_BINDINGS_FOLDER_RENAMED) // file-loader expects posix paths, even on Windows .replace(/\\/g, '/') ); } function findLzmaNativeBindingsFolder(): string { const files = readdirSync(path.join('node_modules', 'lzma-native')); const bindingsFolder = files.find( (f) => f.startsWith('binding-') && f.endsWith(env.npm_config_target_arch || os.arch()), ); if (bindingsFolder === undefined) { throw new Error('Could not find lzma_native binding'); } return bindingsFolder; } const LZMA_BINDINGS_FOLDER = findLzmaNativeBindingsFolder(); const LZMA_BINDINGS_FOLDER_RENAMED = 'binding'; interface ReplacementRule { search: string; replace: string | (() => string); } function slashOrAntislash(pattern: RegExp): RegExp { return new RegExp(pattern.source.replace(/\\\//g, '(\\/|\\\\)')); } function replace(test: RegExp, ...replacements: ReplacementRule[]) { return { loader: 'string-replace-loader', // Handle windows path separators test: slashOrAntislash(test), options: { multiple: replacements.map((r) => ({ ...r, strict: true })) }, }; } function fetchWasm(...where: string[]) { const whereStr = where.map((x) => `'${x}'`).join(', '); return outdent` const Path = require('path'); let electron; try { // This doesn't exist in the child-writer electron = require('electron'); } catch { } function appPath() { return Path.isAbsolute(__dirname) ? __dirname : Path.join( // With macOS universal builds, getAppPath() returns the path to an app.asar file containing an index.js file which will // include the app-x64 or app-arm64 folder depending on the arch. // We don't care about the app.asar file, we want the actual folder. electron.remote.app.getAppPath().replace(/\\.asar$/, () => process.platform === 'darwin' ? '-' + process.arch : ''), 'generated' ); } scriptDirectory = Path.join(appPath(), 'modules', ${whereStr}, '/'); `; } const commonConfig = { mode: 'production', optimization: { moduleIds: 'natural', minimize: true, minimizer: [ new TerserPlugin({ parallel: true, terserOptions: { compress: false, mangle: false, format: { comments: false, ecma: 2020, }, }, extractComments: false, }), ], }, module: { rules: [ { test: /\.css$/, use: ['style-loader', 'css-loader'], }, { test: /\.(woff|woff2|eot|ttf|otf)$/, loader: 'file-loader', options: { name: renameNodeModules }, }, { test: /\.svg$/, use: '@svgr/webpack', }, { test: /\.tsx?$/, use: [ { loader: 'esbuild-loader', options: { loader: 'tsx', target: 'es2021', tsconfigRaw, }, }, ], }, // don't import WeakMap polyfill in deep-map-keys (required in corvus) replace(/node_modules\/deep-map-keys\/lib\/deep-map-keys\.js$/, { search: "var WeakMap = require('es6-weak-map');", replace: '', }), // force axios to use http backend (not xhr) to support streams replace(/node_modules\/axios\/lib\/defaults\.js$/, { search: './adapters/xhr', replace: './adapters/http', }), // remove bindings magic from drivelist replace( /node_modules\/drivelist\/js\/index\.js$/, { search: 'require("bindings");', replace: "require('../build/Release/drivelist.node')", }, { search: "bindings('drivelist')", replace: 'bindings', }, ), replace( /node_modules\/lzma-native\/index\.js$/, // remove node-pre-gyp magic from lzma-native { search: 'require(binding_path)', replace: `require('./${LZMA_BINDINGS_FOLDER}/lzma_native.node')`, }, // use regular stream module instead of readable-stream { search: "var stream = require('readable-stream');", replace: "var stream = require('stream');", }, ), // remove node-pre-gyp magic from usb replace(/node_modules\/@balena.io\/usb\/usb\.js$/, { search: 'require(binding_path)', replace: "require('./build/Release/usb_bindings.node')", }), // remove bindings magic from mountutils replace(/node_modules\/mountutils\/index\.js$/, { search: outdent` require('bindings')({ bindings: 'MountUtils', /* eslint-disable camelcase */ module_root: __dirname /* eslint-enable camelcase */ }) `, replace: "require('./build/Release/MountUtils.node')", }), // remove bindings magic from winusb-driver-generator replace(/node_modules\/winusb-driver-generator\/index\.js$/, { search: outdent` require('bindings')({ bindings: 'Generator', /* eslint-disable camelcase */ module_root: __dirname /* eslint-enable camelcase */ }); `, replace: "require('./build/Release/Generator.node')", }), // Use the copy of blobs in the generated folder and rename node_modules -> modules // See the renameNodeModules function above replace(/node_modules\/node-raspberrypi-usbboot\/build\/index\.js$/, { search: "return await readFile(Path.join(__dirname, '..', 'blobs', filename));", replace: outdent` const { app, remote } = require('electron'); return await readFile( Path.join( // With macOS universal builds, getAppPath() returns the path to an app.asar file containing an index.js file which will // include the app-x64 or app-arm64 folder depending on the arch. // We don't care about the app.asar file, we want the actual folder. (app || remote.app).getAppPath().replace(/\\.asar$/, () => process.platform === 'darwin' ? '-' + process.arch : ''), 'generated', __dirname.replace('node_modules', 'modules'), '..', 'blobs', filename ) ); `, }), // Use the libext2fs.wasm file in the generated folder // The way to find the app directory depends on whether we run in the renderer or in the child-writer // We use __dirname in the child-writer and electron.remote.app.getAppPath() in the renderer replace(/node_modules\/ext2fs\/lib\/libext2fs\.js$/, { search: 'scriptDirectory=__dirname+"/"', replace: fetchWasm('ext2fs', 'lib'), }), // Same for node-crc-utils replace(/node_modules\/@balena\/node-crc-utils\/crc32\.js$/, { search: 'scriptDirectory=__dirname+"/"', replace: fetchWasm('@balena', 'node-crc-utils'), }), // Copy native modules to generated folder { test: /\.node$/, use: [ { loader: 'native-addon-loader', options: { name: renameNodeModules }, }, ], }, ], }, resolve: { extensions: ['.node', '.js', '.json', '.ts', '.tsx'], }, plugins: [ PnpWebpackPlugin, new SimpleProgressWebpackPlugin({ format: process.env.WEBPACK_PROGRESS || 'verbose', }), // Force axios to use http.js, not xhr.js as we need stream support // (its package.json file replaces http with xhr for browser targets). new NormalModuleReplacementPlugin( slashOrAntislash(/node_modules\/axios\/lib\/adapters\/xhr\.js/), './http.js', ), ], resolveLoader: { plugins: [PnpWebpackPlugin.moduleLoader(module)], }, output: { path: path.join(__dirname, 'generated'), filename: '[name].js', }, externals: [ // '../package.json' because we are in 'generated' externalPackageJson('../package.json'), // Only exists on windows platformSpecificModule('win32', 'winusb-driver-generator'), // Not needed but required by resin-corvus > os-locale > execa > cross-spawn platformSpecificModule('none', 'spawn-sync'), // Not needed as we replace all requires for it platformSpecificModule('none', 'node-pre-gyp', '{ find: () => {} }'), // Not needed as we replace all requires for it platformSpecificModule('none', 'bindings'), ], }; const guiConfigCopyPatterns = [ { from: 'node_modules/node-raspberrypi-usbboot/blobs', to: 'modules/node-raspberrypi-usbboot/blobs', }, { from: 'node_modules/ext2fs/lib/libext2fs.wasm', to: 'modules/ext2fs/lib/libext2fs.wasm', }, { from: 'node_modules/@balena/node-crc-utils/crc32.wasm', to: 'modules/@balena/node-crc-utils/crc32.wasm', }, ]; if (os.platform() === 'win32') { // liblzma.dll is required on Windows for lzma-native guiConfigCopyPatterns.push({ from: `node_modules/lzma-native/${LZMA_BINDINGS_FOLDER}/liblzma.dll`, to: `modules/lzma-native/${LZMA_BINDINGS_FOLDER_RENAMED}/liblzma.dll`, }); } const guiConfig = { ...commonConfig, target: 'electron-renderer', node: { __dirname: true, __filename: true, }, entry: { gui: path.join(__dirname, 'lib', 'gui', 'app', 'renderer.ts'), }, // entry: path.join(__dirname, 'lib', 'gui', 'app', 'renderer.ts'), plugins: [ ...commonConfig.plugins, new CopyPlugin({ patterns: [ { from: 'lib/gui/app/index.html', to: 'index.html' }, // electron-builder doesn't bundle folders named "assets" // See https://github.com/electron-userland/electron-builder/issues/4545 { from: 'assets/icon.png', to: 'media/icon.png' }, ], }), // Remove "Download the React DevTools for a better development experience" message new BannerPlugin({ banner: '__REACT_DEVTOOLS_GLOBAL_HOOK__ = { isDisabled: true };', raw: true, }), new CopyPlugin({ patterns: guiConfigCopyPatterns }), ], }; const mainConfig = { ...commonConfig, target: 'electron-main', node: { __dirname: false, __filename: true, }, }; const etcherConfig = { ...mainConfig, entry: { etcher: path.join(__dirname, 'lib', 'gui', 'etcher.ts'), }, }; const childWriterConfig = { ...mainConfig, entry: { 'child-writer': path.join( __dirname, 'lib', 'gui', 'modules', 'child-writer.ts', ), }, }; export default [guiConfig, etcherConfig, childWriterConfig];