v2.1.0

Add informational notice about how to disable analytics collection

.eslintrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  extends: ["./node_modules/@balena/lint/config/.eslintrc.js"],
+  root: true,
+  ignorePatterns: ["node_modules/"],
+  rules: {
+    "@typescript-eslint/no-floating-promises": "off",
+    "@typescript-eslint/no-var-requires": "off",
+    "@typescript-eslint/ban-ts-comment": "off",
+  },
+};

.eslintrc.yml

@@ -1,454 +0,0 @@
-env:
-  browser: true
-  commonjs: true
-  es6: true
-  node: true
-  mocha: true
-plugins:
-  - lodash
-  - jsdoc
-  - node
-  - react
-extends: 'standard'
-parserOptions:
-  sourceType: 'script'
-  ecmaFeatures:
-    jsx: true
-settings:
-  jsdoc:
-    additionalTagNames:
-      customTags:
-        - fulfil
-rules:
-
-  # Possible Errors
-
-  no-console:
-    - off
-  no-empty:
-    - error
-  no-extra-semi:
-    - error
-  no-negated-in-lhs:
-    - error
-  no-prototype-builtins:
-    - error
-  valid-jsdoc:
-    - error
-    - requireReturn: false
-      requireReturnDescription: false
-      requireReturnType: true
-      requireParamDescription: true
-      preferType:
-        boolean: "Boolean"
-        number: "Number"
-        object: "Object"
-        string: "String"
-        array: "Array"
-      prefer:
-        arg: "param"
-        return: "returns"
-
-  # Best Practices
-
-  array-callback-return:
-    - error
-  block-scoped-var:
-    - error
-  class-methods-use-this:
-    - error
-  complexity:
-    - off
-  consistent-return:
-    - error
-  curly:
-    - error
-  default-case:
-    - error
-  dot-notation:
-    - error
-  guard-for-in:
-    - error
-  no-alert:
-    - error
-  no-case-declarations:
-    - error
-  no-div-regex:
-    - error
-  no-else-return:
-    - error
-  no-empty-function:
-    - error
-  no-eq-null:
-    - error
-  no-extra-label:
-    - error
-  no-implicit-coercion:
-    - error
-  no-implicit-globals:
-    - error
-  no-loop-func:
-    - error
-  no-magic-numbers:
-    - error
-  no-native-reassign:
-    - error
-  no-param-reassign:
-    - error
-  no-restricted-properties:
-    - error
-    - property: __proto__
-  no-return-await:
-    - error
-  no-script-url:
-    - error
-  no-unused-expressions:
-    - error
-  no-unused-labels:
-    - error
-  no-useless-concat:
-    - error
-  no-void:
-    - error
-  no-warning-comments:
-    - off
-  radix:
-    - error
-  vars-on-top:
-    - off
-
-  # Strict mode
-
-  strict:
-    - error
-    - global
-
-  # Variables
-
-  init-declarations:
-    - error
-    - always
-  no-catch-shadow:
-    - error
-  no-restricted-globals:
-    - error
-    - event
-  no-shadow:
-    - error
-  no-undefined:
-    - error
-  no-unused-vars:
-    - error
-  no-use-before-define:
-    - error
-
-  # NodeJS and CommonJS
-
-  callback-return:
-    - error
-  global-require:
-    - off
-  no-mixed-requires:
-    - error
-  no-process-env:
-    - off
-  no-process-exit:
-    - off
-  no-sync:
-    - off
-
-  # Stylistic Issues
-
-  array-bracket-spacing:
-    - error
-    - always
-  capitalized-comments:
-    - error
-    - always
-    - ignoreConsecutiveComments: true
-  comma-spacing:
-    - error
-    - before: false
-      after: true
-  computed-property-spacing:
-    - error
-    - never
-  consistent-this:
-    - error
-    - self
-  func-name-matching:
-    - error
-    - always
-  func-names:
-    - error
-    - never
-  func-style:
-    - error
-    - expression
-  id-blacklist:
-    - error
-  id-length:
-    - error
-    - min: 2
-      exceptions:
-        - "_"
-  id-match:
-    - error
-    - "^[_0-9A-Za-z\\$]+$"
-  line-comment-position:
-    - error
-    - position: above
-  linebreak-style:
-    - error
-    - unix
-  lines-around-comment:
-    - error
-    - beforeBlockComment: true
-      afterBlockComment: false
-      beforeLineComment: true
-      afterLineComment: false
-      allowBlockStart: true
-      allowBlockEnd: false
-      allowObjectStart: true
-      allowObjectEnd: false
-      allowArrayStart: true
-      allowArrayEnd: false
-  lines-around-directive:
-    - error
-    - always
-  max-len:
-    - error
-    - code: 130
-      comments: 150
-      ignoreComments: false
-      ignoreTrailingComments: false
-      ignoreUrls: true
-  max-params:
-    - off
-  max-statements-per-line:
-    - error
-    - max: 1
-  multiline-ternary:
-    - off
-  newline-per-chained-call:
-    - off
-  no-bitwise:
-    - error
-  no-continue:
-    - error
-  no-inline-comments:
-    - error
-  no-lonely-if:
-    - error
-  no-mixed-operators:
-    - error
-  no-multi-assign:
-    - error
-  no-negated-condition:
-    - error
-  no-nested-ternary:
-    - error
-  no-plusplus:
-    - error
-  no-restricted-syntax:
-    - error
-    - WithStatement
-    - ForInStatement
-  no-spaced-func:
-    - error
-  no-underscore-dangle:
-    - error
-    - allowAfterThis: false
-  object-curly-newline:
-    - error
-    - minProperties: 3
-      consistent: true
-  object-curly-spacing:
-    - error
-    - always
-  one-var-declaration-per-line:
-    - error
-    - always
-  operator-assignment:
-    - error
-    - always
-  quotes:
-    - error
-    - single
-  quote-props:
-    - error
-    - as-needed
-  require-jsdoc:
-    - error
-    - require:
-        FunctionDeclaration: true
-        ClassDeclaration: true
-        MethodDefinition: true
-        ArrowFunctionExpression: true
-  space-before-function-paren:
-    - error
-    - anonymous: always
-      named: always
-      asyncArrow: always
-  template-tag-spacing:
-    - error
-    - always
-  unicode-bom:
-    - error
-
-  # ECMAScript 6
-
-  arrow-parens:
-    - error
-    - always
-  arrow-spacing:
-    - error
-    - before: true
-      after: true
-  generator-star-spacing:
-    - error
-    - before: true
-      after: false
-  no-confusing-arrow:
-    - error
-  no-var:
-    - error
-  object-shorthand:
-    - error
-    - always
-  prefer-const:
-    - error
-  prefer-spread:
-    - error
-  prefer-numeric-literals:
-    - error
-  prefer-rest-params:
-    - error
-  prefer-template:
-    - error
-  prefer-arrow-callback:
-    - error
-    - allowNamedFunctions: false
-  require-yield:
-    - error
-  symbol-description:
-    - error
-
-  # Lodash
-
-  lodash/chain-style:
-    - error
-    - explicit
-  lodash/identity-shorthand:
-    - error
-    - always
-  lodash/import-scope:
-    - error
-    - full
-  lodash/matches-prop-shorthand:
-    - error
-    - always
-  lodash/matches-shorthand:
-    - error
-    - always
-  lodash/no-commit:
-    - error
-  lodash/path-style:
-    - error
-    - array
-  lodash/prefer-compact:
-    - error
-  lodash/prefer-filter:
-    - error
-    - 5
-  lodash/prefer-flat-map:
-    - error
-  lodash/prefer-invoke-map:
-    - error
-  lodash/prefer-map:
-    - error
-  lodash/prefer-reject:
-    - error
-  lodash/prefer-thru:
-    - error
-  lodash/prefer-wrapper-method:
-    - error
-  lodash/prop-shorthand:
-    - error
-    - always
-  lodash/prefer-constant:
-    - error
-    - true
-    - true
-  lodash/prefer-get:
-    - error
-    - 2
-  lodash/prefer-includes:
-    - error
-    - includeNative: true
-  lodash/prefer-is-nil:
-    - error
-  lodash/prefer-lodash-chain:
-    - error
-  lodash/prefer-lodash-method:
-    - error
-  lodash/prefer-lodash-typecheck:
-    - error
-  lodash/prefer-matches:
-    - error
-    - 3
-  lodash/prefer-noop:
-    - error
-  lodash/prefer-over-quantifier:
-    - error
-  lodash/prefer-startswith:
-    - error
-  lodash/prefer-times:
-    - error
-
-  # JSDoc
-
-  jsdoc/check-param-names:
-    - error
-  jsdoc/check-tag-names:
-    - error
-  jsdoc/newline-after-description:
-    - error
-  jsdoc/require-example:
-    - error
-  jsdoc/require-hyphen-before-param-description:
-    - error
-  jsdoc/require-param:
-    - error
-  jsdoc/require-param-description:
-    - error
-  jsdoc/require-param-type:
-    - error
-  jsdoc/require-returns-type:
-    - error
-
-  # Node
-
-  node/no-deprecated-api:
-    - error
-  node/no-missing-import:
-    - error
-  node/no-missing-require:
-    - error
-  node/process-exit-as-throw:
-    - error
-  node/no-extraneous-require:
-    - error
-  node/no-extraneous-import:
-    - error
-
-  # React
-
-  react/jsx-uses-vars:
-    - error
-
-overrides:
-  files: ['*.jsx']
-  rules:
-    require-jsdoc:
-    - off

.github/actions/publish/action.yml

@@ -10,12 +10,12 @@ inputs:
     required: true
 
   # --- custom environment
-  XCODE_APP_LOADER_EMAIL:
-    type: string
-    default: "accounts+apple@balena.io"
   NODE_VERSION:
     type: string
-    default: "16.x"
+    # Beware that native modules will be built for this version,
+    # which might not be compatible with the one used by pkg (see forge.sidecar.ts)
+    # https://github.com/vercel/pkg-fetch/releases
+    default: "20.x"
   VERBOSE:
     type: string
     default: "true"
@@ -25,14 +25,14 @@ runs:
   using: "composite"
   steps:
     - name: Download custom source artifact
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
-        name: custom-${{ github.event.pull_request.head.sha || github.event.head_commit.id }}-${{ runner.os }}
+        name: custom-${{ github.event.pull_request.head.sha || github.event.head_commit.id }}-${{ runner.os }}-${{ runner.arch }}
         path: ${{ runner.temp }}
 
     - name: Extract custom source artifact
       if: runner.os != 'Windows'
-      shell: pwsh
+      shell: bash
       working-directory: .
       run: tar -xf ${{ runner.temp }}/custom.tgz
 
@@ -48,122 +48,158 @@ runs:
         node-version: ${{ inputs.NODE_VERSION }}
         cache: npm
 
-    - name: Install yq
-      shell: bash --noprofile --norc -eo pipefail -x {0}
-      run: choco install yq
-      if: runner.os == 'Windows'
+    - name: Install host dependencies
+      if: runner.os == 'Linux'
+      shell: bash
+      run: sudo apt-get install -y --no-install-recommends fakeroot dpkg rpm
+
+    # rpmbuild will strip binaries by default, which breaks the sidecar.
+    # Use a macro to override the "strip" to bypass stripping.
+    - name: Configure rpmbuild to not strip executables
+      if: runner.os == 'Linux'
+      shell: bash
+      run: echo '%__strip  /usr/bin/true' > ~/.rpmmacros
+
+    - name: Install host dependencies
+      if: runner.os == 'macOS'
+      # FIXME: Python 3.12 dropped distutils that node-gyp depends upon.
+      # This is a temporary workaround to make the job use Python 3.11 until
+      # we update to npm 10+.
+      uses: actions/setup-python@d27e3f3d7c64b4bbf8e4abfb9b63b83e846e0435 # v4
+      with:
+        python-version: '3.11'
 
     # https://www.electron.build/code-signing.html
-    # https://github.com/Apple-Actions/import-codesign-certs
+    # https://dev.to/rwwagner90/signing-electron-apps-with-github-actions-4cof
     - name: Import Apple code signing certificate
       if: runner.os == 'macOS'
-      uses: apple-actions/import-codesign-certs@v1
-      with:
-        p12-file-base64: ${{ fromJSON(inputs.secrets).APPLE_SIGNING }}
-        p12-password: ${{ fromJSON(inputs.secrets).APPLE_SIGNING_PASSWORD }}
+      shell: bash
+      run: |
+        KEY_CHAIN=build.keychain
+        CERTIFICATE_P12=certificate.p12
+
+        # Recreate the certificate from the secure environment variable
+        echo $CERTIFICATE_P12_B64 | base64 --decode > $CERTIFICATE_P12
+
+        # Create a keychain
+        security create-keychain -p actions $KEY_CHAIN
+
+        # Make the keychain the default so identities are found
+        security default-keychain -s $KEY_CHAIN
+
+        # Unlock the keychain
+        security unlock-keychain -p actions $KEY_CHAIN
+
+        security import $CERTIFICATE_P12 -k $KEY_CHAIN -P $CERTIFICATE_PASSWORD -T /usr/bin/codesign
+
+        security set-key-partition-list -S apple-tool:,apple: -s -k actions $KEY_CHAIN
+
+        # remove certs
+        rm -fr *.p12
+      env:
+        CERTIFICATE_P12_B64: ${{ fromJSON(inputs.secrets).APPLE_SIGNING }}
+        CERTIFICATE_PASSWORD: ${{ fromJSON(inputs.secrets).APPLE_SIGNING_PASSWORD }}
 
     - name: Import Windows code signing certificate
       if: runner.os == 'Windows'
+      id: import_win_signing_cert
       shell: powershell
       run: |
-        Set-Content -Path ${{ runner.temp }}/certificate.base64 -Value $env:WINDOWS_CERTIFICATE
-        certutil -decode ${{ runner.temp }}/certificate.base64 ${{ runner.temp }}/certificate.pfx
+        Set-Content -Path ${{ runner.temp }}/certificate.base64 -Value $env:SM_CLIENT_CERT_FILE_B64
+        certutil -decode ${{ runner.temp }}/certificate.base64 ${{ runner.temp }}/Certificate_pkcs12.p12
         Remove-Item -path ${{ runner.temp }} -include certificate.base64
 
-        Import-PfxCertificate `
-          -FilePath ${{ runner.temp }}/certificate.pfx `
-          -CertStoreLocation Cert:\CurrentUser\My `
-          -Password (ConvertTo-SecureString -String $env:WINDOWS_CERTIFICATE_PASSWORD -Force -AsPlainText)
-
-        Remove-Item -path ${{ runner.temp }} -include certificate.pfx
+        echo "certFilePath=${{ runner.temp }}/Certificate_pkcs12.p12" >> $GITHUB_OUTPUT
 
       env:
-        WINDOWS_CERTIFICATE: ${{ fromJSON(inputs.secrets).WINDOWS_SIGNING }}
-        WINDOWS_CERTIFICATE_PASSWORD: ${{ fromJSON(inputs.secrets).WINDOWS_SIGNING_PASSWORD }}
+        SM_CLIENT_CERT_FILE_B64: ${{ fromJSON(inputs.secrets).SM_CLIENT_CERT_FILE_B64 }}
 
-    # ... or refactor (e.g.) https://github.com/samuelmeuli/action-electron-builder
-    # https://github.com/product-os/scripts/tree/master/electron
-    # https://github.com/product-os/scripts/tree/master/shared
-    # https://github.com/product-os/balena-concourse/blob/master/pipelines/github-events/template.yml
     - name: Package release
-      id: package_release
-      shell: bash --noprofile --norc -eo pipefail -x {0}
+      shell: bash
+      # IMPORTANT: before making changes to this step please consult @engineering in balena's chat.
       run: |
-        set -ea
+        ## FIXME: causes issues with `xxhash` which tries to load a debug build which doens't exist and cannot be compiled
+        # if [[ '${{ inputs.VERBOSE }}' =~ on|On|Yes|yes|true|True ]]; then
+        #  export DEBUG='electron-forge:*,sidecar'
+        # fi
 
-        [[ '${{ inputs.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
-
-        runner_os="$(echo "${RUNNER_OS}" | tr '[:upper:]' '[:lower:]')"
-        runner_arch="$(echo "${RUNNER_ARCH}" | tr '[:upper:]' '[:lower:]')"
-
-        ELECTRON_BUILDER_ARCHITECTURE="${runner_arch}"
         APPLICATION_VERSION="$(jq -r '.version' package.json)"
-        ARCHITECTURE_FLAGS="--${ELECTRON_BUILDER_ARCHITECTURE}"
+        HOST_ARCH="$(echo "${RUNNER_ARCH}" | tr '[:upper:]' '[:lower:]')"
 
-        if [[ $runner_os =~ linux ]]; then
-            ELECTRON_BUILDER_OS='--linux'
-            TARGETS="$(yq e .linux.target[] electron-builder.yml)"
+        if [[ "${RUNNER_OS}" == Linux ]]; then
+          PLATFORM=Linux
+          SHA256SUM_BIN=sha256sum
 
-        elif [[ $runner_os =~ darwin|macos|osx ]]; then
-            CSC_KEY_PASSWORD=${{ fromJSON(inputs.secrets).APPLE_SIGNING_PASSWORD }}
-            CSC_KEYCHAIN=signing_temp
-            CSC_LINK=${{ fromJSON(inputs.secrets).APPLE_SIGNING }}
-            ELECTRON_BUILDER_OS='--mac'
-            TARGETS="$(yq e .mac.target[] electron-builder.yml)"
+        elif [[ "${RUNNER_OS}" == macOS ]]; then
+          PLATFORM=Darwin
+          SHA256SUM_BIN='shasum -a 256'
 
-        elif [[ $runner_os =~ windows|win ]]; then
-            ARCHITECTURE_FLAGS="--ia32 ${ARCHITECTURE_FLAGS}"
-            CSC_KEY_PASSWORD=${{ fromJSON(inputs.secrets).WINDOWS_SIGNING_PASSWORD }}
-            CSC_LINK=${{ fromJSON(inputs.secrets).WINDOWS_SIGNING }}
-            ELECTRON_BUILDER_OS='--win'
-            TARGETS="$(yq e .win.target[] electron-builder.yml)"
+        elif [[ "${RUNNER_OS}" == Windows ]]; then
+          PLATFORM=Windows
+          SHA256SUM_BIN=sha256sum
+
+          # Install DigiCert Signing Manager Tools
+          curl --silent --retry 3 --fail https://one.digicert.com/signingmanager/api-ui/v1/releases/smtools-windows-x64.msi/download \
+            -H "x-api-key:$SM_API_KEY" \
+            -o smtools-windows-x64.msi
+          msiexec -i smtools-windows-x64.msi -qn
+          PATH="/c/Program Files/DigiCert/DigiCert One Signing Manager Tools:${PATH}"
+          smksp_registrar.exe list
+          smctl.exe keypair ls
+          /c/Windows/System32/certutil.exe -csp "DigiCert Signing Manager KSP" -key -user
+          smksp_cert_sync.exe
+
+          # (signtool.exe) https://github.com/actions/runner-images/blob/main/images/win/Windows2019-Readme.md#installed-windows-sdks
+          PATH="/c/Program Files (x86)/Windows Kits/10/bin/${runner_arch}:${PATH}"
 
         else
-            exit 1
+          echo "ERROR: unexpected runner OS: ${RUNNER_OS}"
+          exit 1
         fi
 
-        npm link electron-builder
-
-        for target in ${TARGETS}; do
-            electron-builder ${ELECTRON_BUILDER_OS} ${target} ${ARCHITECTURE_FLAGS} \
-              --c.extraMetadata.analytics.sentry.token='https://739bbcfc0ba4481481138d3fc831136d@o95242.ingest.sentry.io/4504451487301632' \
-              --c.extraMetadata.analytics.amplitude.token='balena-etcher' \
-              --c.extraMetadata.packageType="${target}"
-
-            find dist -type f -maxdepth 1
-        done
+        # Currently, we can only build for the host architecture.
+        npx electron-forge make
 
         echo "version=${APPLICATION_VERSION}" >> $GITHUB_OUTPUT
 
+        # collect all artifacts from subdirectories under a common top-level directory
+        mkdir -p dist
+        find ./out/make -type f \( \
+          -iname "*.zip" -o        \
+          -iname "*.dmg" -o        \
+          -iname "*.rpm" -o        \
+          -iname "*.deb" -o        \
+          -iname "*.AppImage" -o   \
+          -iname "*Setup.exe"      \
+        \) -ls -exec cp '{}' dist/ \;
+
+        if [[ -n "${SHA256SUM_BIN}" ]]; then
+          # Compute and save digests.
+          cd dist/
+          ${SHA256SUM_BIN} *.* >"SHA256SUMS.${PLATFORM}.${HOST_ARCH}.txt"
+        fi
       env:
-        # Apple notarization (afterSignHook.js)
-        XCODE_APP_LOADER_EMAIL: ${{ inputs.XCODE_APP_LOADER_EMAIL }}
+        # ensure we sign the artifacts
+        NODE_ENV: production
+        # analytics tokens
+        SENTRY_TOKEN: https://739bbcfc0ba4481481138d3fc831136d@o95242.ingest.sentry.io/4504451487301632
+        AMPLITUDE_TOKEN: 'balena-etcher'
+        # Apple notarization
+        XCODE_APP_LOADER_EMAIL: ${{ fromJSON(inputs.secrets).XCODE_APP_LOADER_EMAIL }}
         XCODE_APP_LOADER_PASSWORD: ${{ fromJSON(inputs.secrets).XCODE_APP_LOADER_PASSWORD }}
-        # https://github.blog/2020-08-03-github-actions-improvements-for-fork-and-pull-request-workflows/#improvements-for-public-repository-forks
-        # https://docs.github.com/en/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks#about-workflow-runs-from-public-forks
-        CSC_FOR_PULL_REQUEST: true
-
-    # https://www.electron.build/auto-update.html#staged-rollouts
-    - name: Configure staged rollout(s)
-      shell: bash --noprofile --norc -eo pipefail -x {0}
-      run: |
-        set -ea
-
-        [[ '${{ inputs.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
-
-        percentage="$(cat < repo.yml | yq e .triggerNotification.stagingPercentage)"
-
-        find dist -type f -maxdepth 1 \
-          -name "latest*.yml" \
-          -exec yq -i e .version=\"${{ steps.package_release.outputs.version }}\" {} \;
-
-        find dist -type f -maxdepth 1 \
-          -name "latest*.yml" \
-          -exec yq -i e .stagingPercentage=\"$percentage\" {} \;
+        XCODE_APP_LOADER_TEAM_ID: ${{ fromJSON(inputs.secrets).XCODE_APP_LOADER_TEAM_ID }}
+        # Windows signing
+        SM_CLIENT_CERT_PASSWORD: ${{ fromJSON(inputs.secrets).SM_CLIENT_CERT_PASSWORD }}
+        SM_CLIENT_CERT_FILE: '${{ runner.temp }}\Certificate_pkcs12.p12'
+        SM_HOST: ${{ fromJSON(inputs.secrets).SM_HOST }}
+        SM_API_KEY: ${{ fromJSON(inputs.secrets).SM_API_KEY }}
+        SM_CODE_SIGNING_CERT_SHA1_HASH: ${{ fromJSON(inputs.secrets).SM_CODE_SIGNING_CERT_SHA1_HASH }}
+        TIMESTAMP_SERVER: http://timestamp.digicert.com
 
     - name: Upload artifacts
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
-        name: gh-release-${{ github.event.pull_request.head.sha || github.event.head_commit.id }}
+        name: gh-release-${{ github.event.pull_request.head.sha || github.event.head_commit.id }}-${{ runner.os }}-${{ runner.arch }}
         path: dist
         retention-days: 1
+        if-no-files-found: error

.github/actions/test/action.yml

@@ -3,23 +3,23 @@ name: test release
 # https://github.com/product-os/flowzone/tree/master/.github/actions
 inputs:
   json:
-    description: "JSON stringified object containing all the inputs from the calling workflow"
+    description: 'JSON stringified object containing all the inputs from the calling workflow'
     required: true
   secrets:
-    description: "JSON stringified object containing all the secrets from the calling workflow"
+    description: 'JSON stringified object containing all the secrets from the calling workflow'
     required: true
 
   # --- custom environment
   NODE_VERSION:
     type: string
-    default: "16.x"
+    default: '20.10'
   VERBOSE:
     type: string
-    default: "true"
+    default: 'true'
 
 runs:
   # https://docs.github.com/en/actions/creating-actions/creating-a-composite-action
-  using: "composite"
+  using: 'composite'
   steps:
     # https://github.com/actions/setup-node#caching-global-packages-data
     - name: Setup Node.js
@@ -28,27 +28,50 @@ runs:
         node-version: ${{ inputs.NODE_VERSION }}
         cache: npm
 
-    - name: Test release
-      shell: bash --noprofile --norc -eo pipefail -x {0}
+    - name: Install host dependencies
+      if: runner.os == 'Linux'
+      shell: bash
       run: |
-        set -ea
+        sudo apt-get update && sudo apt-get install -y --no-install-recommends xvfb libudev-dev
+        cat < package.json | jq -r '.hostDependencies[][]' - | \
+          xargs -L1 echo | sed 's/|//g' | xargs -L1 \
+          sudo apt-get --ignore-missing install || true
 
-        [[ '${{ inputs.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
+    - name: Install host dependencies
+      if: runner.os == 'macOS'
+      # FIXME: Python 3.12 dropped distutils that node-gyp depends upon.
+      # This is a temporary workaround to make the job use Python 3.11 until
+      # we update to npm 10+.
+      uses: actions/setup-python@d27e3f3d7c64b4bbf8e4abfb9b63b83e846e0435 # v4
+      with:
+        python-version: '3.11'
 
-        runner_os="$(echo "${RUNNER_OS}" | tr '[:upper:]' '[:lower:]')"
+    - name: Test release
+      shell: bash
+      run: |
+        ## FIXME: causes issues with `xxhash` which tries to load a debug build which doens't exist and cannot be compiled
+        # if [[ '${{ inputs.VERBOSE }}' =~ on|On|Yes|yes|true|True ]]; then
+        #   export DEBUG='electron-forge:*,sidecar'
+        # fi
 
-        npm run flowzone-preinstall-${runner_os}
         npm ci
-        npm run build
-        npm run test-${runner_os}
+
+        # as the shrinkwrap might have been done on mac/linux, this is ensure the package is there for windows
+        if [[ "$RUNNER_OS" == "Windows" ]]; then
+          npm i -D winusb-driver-generator
+        fi
+
+        npm run lint
+        npm run package
+        npm run wdio # test stage, note that it requires the package to be done first
 
       env:
         # https://www.electronjs.org/docs/latest/api/environment-variables
-        ELECTRON_NO_ATTACH_CONSOLE: true
+        ELECTRON_NO_ATTACH_CONSOLE: 'true'
 
     - name: Compress custom source
       if: runner.os != 'Windows'
-      shell: pwsh
+      shell: bash
       run: tar -acf ${{ runner.temp }}/custom.tgz .
 
     - name: Compress custom source
@@ -57,8 +80,8 @@ runs:
       run: C:\"Program Files"\Git\usr\bin\tar.exe --force-local -acf ${{ runner.temp }}\custom.tgz .
 
     - name: Upload custom artifact
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
-        name: custom-${{ github.event.pull_request.head.sha || github.event.head_commit.id }}-${{ runner.os }}
+        name: custom-${{ github.event.pull_request.head.sha || github.event.head_commit.id }}-${{ runner.os }}-${{ runner.arch }}
         path: ${{ runner.temp }}/custom.tgz
         retention-days: 1

.github/workflows/flowzone.yml

@@ -1,5 +1,4 @@
 name: Flowzone
-
 on:
   pull_request:
     types: [opened, synchronize, closed]
@@ -8,7 +7,6 @@ on:
   pull_request_target:
     types: [opened, synchronize, closed]
     branches: [main, master]
-
 jobs:
   flowzone:
     name: Flowzone
@@ -20,11 +18,24 @@ jobs:
       (github.event.pull_request.head.repo.full_name != github.repository && github.event_name == 'pull_request_target')
     secrets: inherit
     with:
-      tests_run_on: '["ubuntu-20.04","macos-latest","windows-2019"]'
+      custom_test_matrix: >
+        {
+          "os": [
+            ["ubuntu-22.04"],
+            ["windows-2019"],
+            ["macos-13"],
+            ["macos-latest-xlarge"]
+          ]
+        }
+      custom_publish_matrix: >
+        {
+          "os": [
+            ["ubuntu-22.04"],
+            ["windows-2019"],
+            ["macos-13"],
+            ["macos-latest-xlarge"]
+          ]
+        }
       restrict_custom_actions: false
       github_prerelease: true
-      repo_config: true
-      repo_description: "Flash OS images to SD cards & USB drives, safely and easily."
-      repo_homepage: https://etcher.io/
-      repo_enable_wiki: true
       cloudflare_website: "etcher"

.github/workflows/winget.yml

@@ -6,8 +6,9 @@ jobs:
   publish:
     runs-on: windows-latest # action can only be run on windows
     steps:
-      - uses: vedantmgoyal2009/winget-releaser@v1
+      - uses: vedantmgoyal2009/winget-releaser@v2
         with:
           identifier: Balena.Etcher
-          installers-regex: 'balenaEtcher-Setup.*.exe$'
+          # matches something like "balenaEtcher-1.19.0.Setup.exe"
+          installers-regex: 'balenaEtcher-[\d.-]+\.Setup.exe$'
           token: ${{ secrets.WINGET_PAT }}

.gitignore

@@ -1,40 +1,103 @@
+
+# -- ADD NEW ENTRIES AT THE END OF THE FILE ---
+
 # Logs
-/logs
+logs
 *.log
 npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 
 # Runtime data
 pids
 *.pid
 *.seed
+*.pid.lock
+.DS_Store
 
 # Directory for instrumented libs generated by jscoverage/JSCover
-/lib-cov
-
-# Image stream output directory
-/tests/image-stream/output
+lib-cov
 
 # Coverage directory used by tools like istanbul
-/coverage
+coverage
+*.lcov
 
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
+# nyc test coverage
+.nyc_output
 
 # node-waf configuration
 .lock-wscript
 
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-/build
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
 
-# Generated files
-/generated
+# Dependency directories
+node_modules/
+jspm_packages/
 
-# Dependency directory
-# https://docs.npmjs.com/misc/faq#should-i-check-my-node-modules-folder-into-git
-node_modules
+# TypeScript v1 declaration files
+typings/
 
-# Compiled Etcher releases
-/dist
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# Webpack
+.webpack/
+
+# Vite
+.vite/
+
+# Electron-Forge
+out/
+
+# ---- Do not modify entries above this line ----
+
+# Build artifacts
+dist/
 
 # Certificates
 *.spc
@@ -44,16 +107,17 @@ node_modules
 *.crt
 *.pem
 
-# OSX files
-
-.DS_Store
-
-# VSCode files
-
-.vscode
+# Secrets
 .gitsecret/keys/random_seed
 !*.secret
 secrets/APPLE_SIGNING_PASSWORD.txt
 secrets/WINDOWS_SIGNING_PASSWORD.txt
 secrets/XCODE_APP_LOADER_PASSWORD.txt
 secrets/WINDOWS_SIGNING.pfx
+
+# Image stream output directory
+/tests/image-stream/output
+
+#local development
+.yalc
+yalc.lock

.gitmodules

@@ -1,4 +0,0 @@
-[submodule "scripts/resin"]
-	path = scripts/resin
-	url = https://github.com/balena-io/scripts.git
-	branch = master

.nvmrc

@@ -1 +1 @@
-16
+18

.prettierrc.js

@@ -0,0 +1,6 @@
+const fs = require("fs");
+const path = require("path");
+
+module.exports = JSON.parse(
+  fs.readFileSync(path.join(__dirname, "node_modules", "@balena", "lint", "config", ".prettierrc"), "utf8"),
+);

.versionbot/CHANGELOG.yml

@@ -1,3 +1,566 @@
+- commits:
+    - subject: Add informational notice about how to disable analytics collection
+      hash: aac092fd4df8750024c082b25dcbd0ae6ee618fd
+      body: ""
+      footer:
+        Change-type: minor
+        change-type: minor
+      author: myarmolinsky
+      nested: []
+  version: 2.1.0
+  title: ""
+  date: 2025-02-27T16:16:57.036Z
+- commits:
+    - subject: "major: build on ubuntu 22 and macos 13"
+      hash: 039a022353d1980ef9ddd19166515c531e48aba4
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+  version: 2.0.0
+  title: ""
+  date: 2025-02-20T14:27:01.338Z
+- commits:
+    - subject: "patch: bump etcher-sdk to 9.1.2"
+      hash: c726b51dca3383c76f4bf824fd5d594ac3069180
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+  version: 1.19.25
+  title: ""
+  date: 2024-10-10T10:03:29.519Z
+- commits:
+    - subject: "patch: etcher-util is corrupted in RPM package"
+      hash: e43ee788ec5ec49e105ff804206919bb10a59ea7
+      body: |
+        rpmbuild strips executables by default when generating an rpm packge.
+        This was causing the JavaScript code bundled in the etcher-util file
+        to be removed, causing "Pkg: Error reading from file." whenever
+        etcher-util was called.
+
+        This in turn caused balena-etcher to generate the error message
+        `Error: (0, h.requestMetadata) is not a function` when attempting
+        to write an SD card.
+
+        This fixes the issue for RPM builds by replacing the `strip` command
+        with `true` so that rpmbuild no longer strips the executables and
+        the embeded code stays intact.
+
+        See: https://github.com/balena-io/etcher/issues/4150
+      footer:
+        Signed-off-by: Richard Glidden <richard@glidden.org>
+        signed-off-by: Richard Glidden <richard@glidden.org>
+      author: Richard Glidden
+      nested: []
+  version: 1.19.24
+  title: ""
+  date: 2024-10-09T14:22:56.623Z
+- commits:
+    - subject: "patch: remove gconf2 libgconf-2-4 deps"
+      hash: 2ed779ef371db367e4e413c9d0d08fcd738edb5b
+      body: "Closes #4096"
+      footer: {}
+      author: Marc-Aurèle Brothier
+      nested: []
+  version: 1.19.23
+  title: ""
+  date: 2024-10-09T13:52:54.936Z
+- commits:
+    - subject: Replace deprecated Flowzone inputs
+      hash: 52d396aa7ea9ae1ef6d68151f582f04f57191b14
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Kyle Harding
+      nested: []
+  version: 1.19.22
+  title: ""
+  date: 2024-07-18T18:12:56.368Z
+- commits:
+    - subject: "patch: fix missing windows dependency"
+      hash: 8dad81ae34b8d71f3d4f7151ee60717e6207ccd8
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+    - subject: "patch: fix missing windows dependency"
+      hash: d28719daf249f2994acdf94b4bb7ea937ffcab9b
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+    - subject: "patch: fix missing windows dependency"
+      hash: 98db4df0dc147e5fec9180c50f4e21acf1fd0a58
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+  version: 1.19.21
+  title: ""
+  date: 2024-05-30T15:00:35.706Z
+- commits:
+    - subject: "patch: fix missing windows dependency"
+      hash: c4d3f8db8769418925a9909ac700edc5f425a068
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+  version: 1.19.20
+  title: ""
+  date: 2024-05-30T10:17:29.075Z
+- commits:
+    - subject: "patch: add sentry debug flag"
+      hash: 8223130e8dfce180481550d77f022064255601e4
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+  version: 1.19.19
+  title: ""
+  date: 2024-05-28T12:09:51.167Z
+- commits:
+    - subject: "patch: fix Sentry DSN for main process"
+      hash: 4ffda6e208a6e2f109f652d39e1248bec23a2ddf
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+  version: 1.19.18
+  title: ""
+  date: 2024-05-22T13:28:03.659Z
+- commits:
+    - subject: "patch: fix injection of analytics key at build time"
+      hash: e94767aca7b07e674bd60176ef77c11440131ace
+      body: ""
+      footer: {}
+      author: JOASSART Edwin
+      nested: []
+  version: 1.19.17
+  title: ""
+  date: 2024-05-09T06:33:45.091Z
+- commits:
+    - subject: "patch: hold request for metadata while waiting for flasher"
+      hash: 2dfa795129e287f887b9ea02f2eca717575d27ac
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+  version: 1.19.16
+  title: ""
+  date: 2024-04-26T14:33:19.111Z
+- commits:
+    - subject: "patch: bump etcher-sdk to 9.0.11 to fix url loading using http/2"
+      hash: cb03fb83754f38d647fc951b94470725b46b2b31
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+  version: 1.19.15
+  title: ""
+  date: 2024-04-26T13:26:57.047Z
+- commits:
+    - subject: "patch: pretty-bytes to 6.1.1"
+      hash: fa642270f7153f14e45ee03a73bad1f0797cbd51
+      body: ""
+      footer: {}
+      author: JOASSART Edwin
+      nested: []
+  version: 1.19.14
+  title: ""
+  date: 2024-04-25T21:11:35.350Z
+- commits:
+    - subject: "patch: use etcher icon as loading for windows installer"
+      hash: bc3340960a765e99f2f02bc21adace91d228d26f
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+    - subject: "patch: fix windows squirrel install"
+      hash: d498248a0f1416045b836646b72c7b4c588119d3
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+  version: 1.19.13
+  title: ""
+  date: 2024-04-25T19:02:23.576Z
+- commits:
+    - subject: "patch: bump minors & patch"
+      hash: afd659f9e586e012be7e3b02490d14a8ac64bb35
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+    - subject: "patch: bump @electron-forge/* to 7.4.0"
+      hash: ffdeccf7efd1412a2e2838fd07df5b21f1233efe
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+    - subject: "patch: bump electron to 30.0.1 & @electron/remote to 2.1.2"
+      hash: 37ac323e10c07db35a7e47b576d07e1d4d41a470
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+    - subject: "patch: npm upgrade"
+      hash: 7c8f3c35d3d159e7be73442ab215019dc2388f54
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+    - subject: "patch: bump @balena/lint to 8.0.2 and fix formating"
+      hash: 4aa4140d65189920938c42c41a6a781c97148c8a
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+    - subject: "patch: fix pretty-bytes imports"
+      hash: 064261107954dd64d03f94d6aeffd95cd2211df0
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+    - subject: "patch: bump etcher-sdk to 9.0.9"
+      hash: 2f4a12a48facf0634ed457fe6ed7c50e21b419ee
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+  version: 1.19.12
+  title: ""
+  date: 2024-04-25T16:47:43.024Z
+- commits:
+    - subject: "patch: setup wdio and port (most) tests"
+      hash: a661d102bc94bf2707f01958d1e9d260efc06c14
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+  version: 1.19.11
+  title: ""
+  date: 2024-04-25T13:00:13.805Z
+- commits:
+    - subject: "patch: remove node-ipc and tests"
+      hash: ccc31bb9aaba8df88b2af612824d9106051e2804
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+    - subject: "patch: switch api; use ws; integrate sudo-prompt - switch api roles
+        flow - use websocket instead of node-ipc - integrate; modernize;
+        simplify and deprecate sudo-prompt"
+      hash: b3e33824ed1f70719b04f18dcb7f7dd76451b7f6
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+    - subject: "patch: refactor api to use a single topic"
+      hash: 6582260355fcc5280932bee771602fbfb5190619
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+    - subject: "patch: set require node engine to 20"
+      hash: b1d2bdaa06bfb35f4a66d92275ca21c731d1cf8e
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+  version: 1.19.10
+  title: ""
+  date: 2024-04-23T10:28:00.127Z
+- commits:
+    - subject: "patch: prevent rebuild of native deps by @electron/rebuild"
+      hash: 003abfb88f2c7bff0ee291828f3815c738340afa
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+  version: 1.19.9
+  title: ""
+  date: 2024-04-22T10:20:10.534Z
+- commits:
+    - subject: "patch: replace deprecated pkg with yao-pkg and bump etcher-util node v
+        to 20.10"
+      hash: c696c389c9988c75ad9ccc472bdac7edefe762ed
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+  version: 1.19.8
+  title: ""
+  date: 2024-04-22T09:37:37.561Z
+- commits:
+    - subject: "patch: fix formating"
+      hash: 1a9a3d2cdc5642a754b73628f4ae2636e3ffd8eb
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+    - subject: "patch: configure prettier in the project to use balena-lint
+        configuration"
+      hash: faeaa58ec548e47abaf30b2498ab145e7c0c6f76
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+  version: 1.19.7
+  title: ""
+  date: 2024-04-22T06:52:18.878Z
+- commits:
+    - subject: "patch: fix win signature process"
+      hash: f629e6d53b5329cd7e8105050df042f3873a35ee
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+  version: 1.19.6
+  title: ""
+  date: 2024-04-19T15:59:28.200Z
+- commits:
+    - subject: Replace deprecated flowzone input tests_run_on
+      hash: bec0e50741bfeda63ca9785217576613f74ca043
+      body: |
+        The `custom_runs_on` array supports multiple runner labels
+        in nested arrays.
+      footer:
+        Change-type: patch
+        change-type: patch
+        Signed-off-by: Kyle Harding <kyle@balena.io>
+        signed-off-by: Kyle Harding <kyle@balena.io>
+      author: Kyle Harding
+      nested: []
+  version: 1.19.5
+  title: ""
+  date: 2024-02-14T19:51:16.321Z
+- commits:
+    - subject: "patch: remove screensaver error when not on etcher-pro"
+      hash: 196fd8ae24de2a23ebaeae736c6ca41007162fa1
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+    - subject: "patch: fix typo in IPC server id"
+      hash: 5d436992423961258ad861c01e3b9b30f3317aab
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+  version: 1.19.4
+  title: ""
+  date: 2024-01-26T17:29:27.301Z
+- commits:
+    - subject: Update dependencies
+      hash: 0f2b4dbc106c55fe104f0b10e62c35c16bcfe9b3
+      body: >
+        - upgrade pretty_bytes to 6.1.1
+
+        - upgrade electron-remote to 2.1.0
+
+        - upgrade semver to 7.5.4 + @types/semver to 7.5.6
+
+        - upgrade chai to 4.3.11 + @types/chai to 4.3.10
+
+        - upgrade mocha to 10.2.0 + @types/mocha to 10.0.6
+
+        - upgrade sinon to 17.0.1 + @types/sinon to 17.0.2
+
+        - remove useless @types
+
+        - upgrade @svgr/webpack to 8.1.0
+
+        - upgrade @sentry/electron to 4.15.1
+
+        - upgrade tslib to 2.6.2
+
+        - upgrade immutable to 4.3.4
+
+        - upgrade redux to 4.2.1
+
+        - upgrade ts-node to 10.9.2 & ts-loader to 9.5.1
+
+        - remove mini-css-extract-plugin
+
+        - upgrade husky to 8.0.3
+
+        - upgrade uuid to 9.0.1
+
+        - upgrade lint-staged to 15.2.1
+
+        - upgrade @types/node to 18.11.9
+
+        - upgrade @fortawesome/fontawesome-free to 6.5.1
+
+        - upgrade i18next to 23.7.8 & react-i18next to 11.18.6
+
+        - bump react, react-dom + related @types to 17.0.2 and rendition to
+        35.1.0
+
+        - fix getuid for ts
+
+        - fix @types/react being in wrong deps
+
+        - upgrade @types/tmp to 0.2.6
+
+        - upgrade typescript to 5.3.3
+
+        - upgrade @types/mime-types to 2.1.4
+
+        - remove d3 from deps
+
+        - upgrade electron-updater to 6.1.7
+
+        - upgrade rendition to 35.1.2
+
+        - upgrade node-ipc to 9.2.3
+
+        - upgrade @types/node-ipc to 9.2.3
+
+        - upgrade electron to 27.1.3
+
+        - upgrade @electron-forge/* to 7.2.0
+
+        - upgrade @reforged/marker-appimage to 3.3.2
+
+        - upgrade style-loader to 3.3.3
+
+        - upgrade balena-lint to 7.2.4
+
+        - run CI with node 18.19
+
+        - add xxhash-addon to sidecar assets
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Edwin Joassart
+      nested: []
+  version: 1.19.3
+  title: ""
+  date: 2023-12-22T16:13:00.924Z
+- commits:
+    - subject: "fix: typos"
+      hash: aaac1336702b7ac4a07992f41db4f0bcdb931c70
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Rotzbua
+      nested: []
+  version: 1.19.2
+  title: ""
+  date: 2023-12-22T12:57:35.441Z
+- commits:
+    - subject: "patch: update winget-releaser v2"
+      hash: ea184eb6352b7988c6ab1f439d30c297610cd84e
+      body: ""
+      footer: {}
+      author: Vedant
+      nested: []
+  version: 1.19.1
+  title: ""
+  date: 2023-12-22T08:12:34.451Z
+- commits:
+    - subject: Use native ARM runner for Apple Silicon builds
+      hash: 01a96bb6de1ff00d20f7784469dd05286069e014
+      body: ""
+      footer:
+        Change-type: minor
+        change-type: minor
+      author: Akis Kesoglou
+      nested: []
+    - subject: Calculate and upload build artifact sha256 checksums
+      hash: 2e3a75e685258961bc8efdb95dde12727b93a04a
+      body: ""
+      footer:
+        Change-type: minor
+        change-type: minor
+      author: Akis Kesoglou
+      nested: []
+    - subject: Migrate build pipeline to Electron Forge
+      hash: bd33c5b092cb5224c8dfc4d5a2caf4684cee161d
+      body: ""
+      footer:
+        Change-type: minor
+        change-type: minor
+      author: Akis Kesoglou
+      nested: []
+  version: 1.19.0
+  title: ""
+  date: 2023-12-21T16:41:57.426Z
+- commits:
+    - subject: Remove repo config from flowzone.yml
+      hash: ecb24dad251fbb9b3f92e5b404b66aedd155a584
+      body: |
+        This functionality is being deprecated in Flowzone.
+
+        See: https://github.com/product-os/flowzone/pull/833
+      footer:
+        Change-type: patch
+        change-type: patch
+        Signed-off-by: Kyle Harding <kyle@balena.io>
+        signed-off-by: Kyle Harding <kyle@balena.io>
+      author: Kyle Harding
+      nested: []
+    - subject: Update actions/upload-artifact to v4
+      hash: a970f55b555f69c5fcb40374eb50ad7b98cc8f96
+      body: |
+        Also ensure we are generating unique artifact names on upload.
+      footer:
+        Change-type: patch
+        change-type: patch
+        Signed-off-by: Kyle Harding <kyle@balena.io>
+        signed-off-by: Kyle Harding <kyle@balena.io>
+        See: https://github.com/product-os/flowzone/pull/827
+        see: https://github.com/product-os/flowzone/pull/827
+      author: Kyle Harding
+      nested: []
+  version: 1.18.14
+  title: ""
+  date: 2023-12-20T16:23:00.875Z
+- commits:
+    - subject: "patch: upgrade to electron 25"
+      hash: f38bca290fe26121bed58d1131265e1aa350ddb5
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+    - subject: "patch: refactor scanner, loader and flasher out of gui + upgrade to
+        electron 25"
+      hash: fb8ed5b529e22bc9e766bfe99c2b6955ed695b58
+      body: ""
+      footer: {}
+      author: Edwin Joassart
+      nested: []
+  version: 1.18.13
+  title: ""
+  date: 2023-10-16T13:32:26.738Z
+- commits:
+    - subject: Update instructions for installing deb file
+      hash: acab03ad77a1c1901d0c8a65999e93c1d27169a0
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Jorge Capona
+      nested: []
+  version: 1.18.12
+  title: ""
+  date: 2023-07-19T10:24:22.407Z
+- commits:
+    - subject: "fix: prevent stealing window focus from auth dialog"
+      hash: f716c74ef7cb164b4d825828e4e46033484ad9af
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: leadpogrommer
+      nested: []
+  version: 1.18.11
+  title: ""
+  date: 2023-07-13T14:31:40.021Z
 - commits:
     - subject: "spelling: validates"
       hash: 06d246e3fd1c573b9e04d23ab3bc3c4036fb9859
@@ -323,20 +886,33 @@
         step forward to upgrading to a newer Electron and Node version.
 
 
-        Updates etcher-sdk and switches the redundant aws4-axios dependency to just axios.
+        Updates etcher-sdk and switches the redundant aws4-axios dependency to
+        just axios.
 
 
-        Also changed bundler to stop trying to bundle wasm files — they must be included inline with JS code as data — and removed some now redundant code.
+        Also changed bundler to stop trying to bundle wasm files — they must be
+        included inline with JS code as data — and removed some now redundant
+        code.
 
 
         The crucial changes that enable support are:
 
 
-        1. The update to etcher-sdk@8 where some dependency fixes and updates took place
+        1. The update to etcher-sdk@8 where some dependency fixes and updates
+        took place
 
-        2. The downgrade and pinning of "electron-rebuild" to v3.2.3 until we’re able to update to Electron >= 14.2. The patch we need to avoid is https://github.com/electron/rebuild/pull/907. Also see: https://github.com/nodejs/node-gyp/issues/2673 and https://github.com/electron/rebuild/issues/913
+        2. The downgrade and pinning of "electron-rebuild" to v3.2.3 until we’re
+        able to update to Electron >= 14.2. The patch we need to avoid is
+        https://github.com/electron/rebuild/pull/907. Also see:
+        https://github.com/nodejs/node-gyp/issues/2673 and
+        https://github.com/electron/rebuild/issues/913
 
-        3. A rule in webpack.config to ignore `aws-crt` which is a dependency of (ultimately) `aws4-axios` which is used by etcher-sdk and does a runtime check to its availability. We’re not currently using the “assume role” functionality (AFAIU) of aws4-axios and we don’t care that it’s not found, so force webpack to ignore the import. See https://github.com/aws/aws-sdk-js-v3/issues/3025
+        3. A rule in webpack.config to ignore `aws-crt` which is a dependency of
+        (ultimately) `aws4-axios` which is used by etcher-sdk and does a runtime
+        check to its availability. We’re not currently using the “assume role”
+        functionality (AFAIU) of aws4-axios and we don’t care that it’s not
+        found, so force webpack to ignore the import. See
+        https://github.com/aws/aws-sdk-js-v3/issues/3025
       footer:
         Change-type: minor
         change-type: minor
@@ -616,7 +1192,8 @@
       body: >
         Optimized several translations.
 
-        This commit itself is only a patch, but as a pull request must have at least one commit with a change-type.
+        This commit itself is only a patch, but as a pull request must have at
+        least one commit with a change-type.
       footer:
         Change-Type: minor
         change-type: minor
@@ -699,10 +1276,8 @@
       nested: []
     - subject: "Patch: run linux build on ubuntu-20.04"
       hash: adcd8e0325bc891460b3e51aa5403f8675189f13
-      body: >-
-        as [`18.04` has been
-        removed](https://github.blog/changelog/2022-08-09-github-actions-the-ubuntu-18-04-actions-runner-image-is-being-deprecated-and-will-be-removed-by-12-1-22/)
-
+      body: |-
+        as [`18.04` has been removed](https://github.blog/changelog/2022-08-09-github-actions-the-ubuntu-18-04-actions-runner-image-is-being-deprecated-and-will-be-removed-by-12-1-22/)
 
         We cannot use `latest` as the glibc version will cause issue with older ubuntu version.
       footer: {}
@@ -2235,7 +2810,8 @@
         reloads without reloading the whole electron app.
 
 
-        This patch also runs the development environment in development mode, which is much, much faster on builds and rebuilds.
+        This patch also runs the development environment in development mode,
+        which is much, much faster on builds and rebuilds.
       footer: {}
       author: Zane Hitchcox
       nested: []
@@ -2640,9 +3216,11 @@
                         exception
                           aborting program, because WCharToUtf8() returned NULL
                           in some cases, and NULL was being fed to string constructor.
-                        - Fixes memory leak because memory allocated with calloc()
+                        - Fixes memory leak because memory allocated with
+                        calloc()
                           in WCharToUtf8() was not being freed anywhere
-                        - Fixes undefined behavior because GetEnumeratorName() returns
+                        - Fixes undefined behavior because GetEnumeratorName()
+                        returns
                           pointer to stack memory, that goes outside of scope while
                           pointer still is being used.
 
@@ -4564,7 +5142,8 @@
 
         Although it's possible to use a PC keyboard on a Mac, it's unusual.
 
-        In any case, all of the macOS (not "Mac OS" for some years now) documentation refers to the "Opt" key.
+        In any case, all of the macOS (not "Mac OS" for some years now)
+        documentation refers to the "Opt" key.
     - hash: ea11f179542794294f773f503d83dad3a10cda56
       author: Tom
       footers:
@@ -4728,7 +5307,8 @@
         Changes the documentation to update the disktutil command which didn't
         fix my case, cause the boot partition was broken.
 
-        This way it rewrites the drive into a FAT32 partition editable in Unix/Windows.
+        This way it rewrites the drive into a FAT32 partition editable in
+        Unix/Windows.
     - hash: b3f25c176b1bdb487d1a7bf111d7f170fe008842
       author: Lorenzo Alberto Maria Ambrosi
       footers:
@@ -7428,7 +8008,8 @@
 
         performance improvement
 
-        - Make Breadcrumbs and Icon pure components to stop frequent re-rendering
+        - Make Breadcrumbs and Icon pure components to stop frequent
+        re-rendering
 
         - Initial support for array constraints
 
@@ -7559,9 +8140,11 @@
 
         the `ETCHER_EXPERIMENTAL_FILE_PICKER` environment variable. Further
 
-        customisation can be done with the `ETCHER_FILE_BROWSER_CONSTRAIN_FOLDER`
+        customisation can be done with the
+        `ETCHER_FILE_BROWSER_CONSTRAIN_FOLDER`
 
-        variable that takes a path and allows one to constrain the file-picker to
+        variable that takes a path and allows one to constrain the file-picker
+        to
 
         a folder.
     - hash: 687e0b563b0dc3619ece4ce49d353d5838a21ff6
@@ -7660,11 +8243,13 @@
 
         either in the user's home directory, or the current working directory.
 
-        In the case of the home directory, the config file is `$HOME/.config/etcher/config.json`,
+        In the case of the home directory, the config file is
+        `$HOME/.config/etcher/config.json`,
 
         while on Windows `$HOME/.etcher.json` is used.
 
-        The defined settings are merged with localStorage settings, and preceding
+        The defined settings are merged with localStorage settings, and
+        preceding
 
         configuration files.
 
@@ -7954,7 +8539,8 @@
         `_.isError()` returns `true` for anything that has a `name` and
         `message`
 
-        property, causing the check here to always keep the plain object as error.
+        property, causing the check here to always keep the plain object as
+        error.
     - hash: 355373f24df6be0989fad9429c2230166b33a3bf
       author: Jonas Hermsmeier
       footers:
@@ -7971,7 +8557,8 @@
         This fixes a ReferenceError that could occur when the DeviceNode was
         null,
 
-        as well as devices being null when run after the system recovers from sleep / standby.
+        as well as devices being null when run after the system recovers from
+        sleep / standby.
     - hash: 6e7484d3dabc2aeaa7cd471822d7019860cc4a5c
       author: Benedict Aas
       subject: "feat(GUI): display succeeded and failed devices on finish screen"
@@ -8132,7 +8719,8 @@
       body: >-
         This replaces shelling out to `diskpart` on Windows to clear
 
-        the partition table with `win-drive-clean`, which does so via DeviceIoControl.
+        the partition table with `win-drive-clean`, which does so via
+        DeviceIoControl.
     - hash: abf2dc3efcf214a68c0b0e329d57a3f66bb5d342
       author: Benedict Aas
       footers:
@@ -8239,15 +8827,18 @@
         This updates the instructions to open the Developer Tools in the issue
         template,
 
-        as the keyboard shortcuts have changed to their defaults on Linux & Windows
+        as the keyboard shortcuts have changed to their defaults on Linux &
+        Windows
 
         from [Ctrl]+[Alt]+[I] to [Ctrl]+[Shift]+[I].
 
-        Further, the editor config is updated to allow trailing spaces in Markdown
+        Further, the editor config is updated to allow trailing spaces in
+        Markdown
 
         files to add trailing spaces to the list items in the issue template, in
 
-        order to avoid people not putting whitespace in between, causing the formatting
+        order to avoid people not putting whitespace in between, causing the
+        formatting
 
         to not be parsed properly.
     - hash: 3dd646485fa34437ac3adb3caa5a594d439f1f68
@@ -8331,7 +8922,8 @@
         This replaces use of `electron.app.getName()` with the package.json's
         `.displayName`
 
-        property to ensure the correct application name is displayed when packaged.
+        property to ensure the correct application name is displayed when
+        packaged.
     - hash: cf340f48c3582f3e96f7b2dc16c11f44b7661363
       author: Jonas Hermsmeier
       footers:
@@ -8507,7 +9099,8 @@
       body: >-
         This updates `resin-cli-visuals` in order to fix drive selection in
 
-        the CLI, which was caused by incompatibility of two different `drivelist` versions
+        the CLI, which was caused by incompatibility of two different
+        `drivelist` versions
     - hash: bde1e32e29ae75ccecf7fc3bc1b03efd6e4f67b8
       author: Jonas Hermsmeier
       footers:
@@ -8808,7 +9401,8 @@
         We remove a piece of code checking whether `_.keys` returns any
         non-string
 
-        values in its array, but per the Lodash documentation `_.keys` always returns an
+        values in its array, but per the Lodash documentation `_.keys` always
+        returns an
 
         array of strings.
     - hash: 83528df18be32bfe62d3e9e4578101077769a7cf
@@ -9064,7 +9658,8 @@
       body: >-
         Due to some Windows systems missing certain C runtime libraries
 
-        (Visual C/C++ 2012 / 2015 Redistributables), we ignore errors when loading
+        (Visual C/C++ 2012 / 2015 Redistributables), we ignore errors when
+        loading
 
         this module until we can ensure distribution of those along with it.
     - hash: 21e595466d5d950d7c38b2411791f756ec6ebdca
@@ -9149,7 +9744,8 @@
       body: >-
         This updates the `postshrinkwrap` script to traverse the dependency tree
 
-        and remove all `from` fields to avoid inconsistent diffs across platforms,
+        and remove all `from` fields to avoid inconsistent diffs across
+        platforms,
 
         environments and installs when shrinkwrapping anew.
     - hash: 619051a4b0cd8995e31838f221386b9b44e6ffc8
@@ -9561,7 +10157,8 @@
         This works around the "Cannot fetch index base URL
         http://pypi.python.org/simple/"
 
-        error by installing pip==9.0.1 directly from the pypi.python.org/packages/
+        error by installing pip==9.0.1 directly from the
+        pypi.python.org/packages/
     - hash: c8b2b652354029cedceda2637bed13fee65f8587
       author: Juan Cruz Viotti
       footers:
@@ -9613,9 +10210,11 @@
 
         WARNING: Binary file: lib/blobs/usbboot/raspberrypi/bootcode.bin
 
-        WARNING: Binary file: tests/image-stream/data/unrecognized/xz-without-extension
+        WARNING: Binary file:
+        tests/image-stream/data/unrecognized/xz-without-extension
 
-        WARNING: Binary file: tests/image-stream/data/unrecognized/xz-with-invalid-extension.foo
+        WARNING: Binary file:
+        tests/image-stream/data/unrecognized/xz-with-invalid-extension.foo
 
         ```
     - hash: f4e0121639d8f2cbcc15b6577ec15d7ecbab7e71
@@ -11348,7 +11947,8 @@
 
         https://developer.apple.com/library/mac/technotes/tn2206/_index.html
 
-        > Code signing uses extended attributes to store signatures in non-Mach-O
+        > Code signing uses extended attributes to store signatures in
+        non-Mach-O
 
         > executables such as script files. If the extended attributes are lost
 
@@ -11360,7 +11960,8 @@
 
         > One way to guarantee preservation of extended attributes is by packing
 
-        > up your signed code in a read-write disk image (DMG) file before signing
+        > up your signed code in a read-write disk image (DMG) file before
+        signing
 
         > and then, after signing, converting to read-only. You probably don't
 
@@ -11423,31 +12024,19 @@
         changelog-entry: Don't include user paths in Mixpanel usage reports
         link: https://github.com/resin-io-modules/etcher-image-stream/blob/master/CHANGELOG.md
       subject: Fix uncaught exception if no file was selected from a dialog
-      body: >-
+      body: |-
         The following error is thrown if the open file dialog is cancelled
-
         without any selection:
-
         Unhandled rejection TypeError: Cannot read property '0' of undefined
-
         at Number.indexedGetter (/home/parallels/Projects/etcher/node_modules/bluebird/js/release/call_get.js:106:15)
-
         at Number.tryCatcher (/home/parallels/Projects/etcher/node_modules/bluebird/js/release/util.js:16:23)
-
         at Promise._settlePromiseFromHandler (/home/parallels/Projects/etcher/node_modules/bluebird/js/release/promise.js:503:31)
-
         at Promise._settlePromise (/home/parallels/Projects/etcher/node_modules/bluebird/js/release/promise.js:560:18)
-
         at Promise._settlePromise0 (/home/parallels/Projects/etcher/node_modules/bluebird/js/release/promise.js:605:10)
-
         at Promise._settlePromises (/home/parallels/Projects/etcher/node_modules/bluebird/js/release/promise.js:684:18)
-
         at Async._drainQueue (/home/parallels/Projects/etcher/node_modules/bluebird/js/release/async.js:126:16)
-
         at Async._drainQueues (/home/parallels/Projects/etcher/node_modules/bluebird/js/release/async.js:136:10)
-
         at Immediate.Async.drainQueues [as _onImmediate] (/home/parallels/Projects/etcher/node_modules/bluebird/js/release/async.js:16:14)
-
         at processImmediate [as _immediateCallback] (timers.js:383:17)
     - hash: 6bd086f1c5c6654a47125cf2d46788655cae2553
       author: Juan Cruz Viotti
@@ -11462,7 +12051,8 @@
       body: >-
         From the documentation:
 
-        > `useContentSize` Boolean - The `width` and `height` would be used as web
+        > `useContentSize` Boolean - The `width` and `height` would be used as
+        web
 
         > page’s size, which means the actual window’s size will include window
 
@@ -12043,21 +12633,14 @@
         changelog-entry: Use info icon instead of "SHOW FULL FILE NAME" in first step.
         fixes: https://github.com/resin-io/etcher/issues/458
       subject: Make use of AppImage desktop integration script
-      body: >-
+      body: |-
         This is useful to prompt the user to install the `.desktop` file.
-
         The `Description` key in `Etcher.desktop` was changed to `Comment` since
-
         `desktop-file-validate` complained with:
-
         Etcher.desktop: error: file contains key "Description" in group "Desktop
-
         Entry", but keys extending the format should start with "X-"
-
         After checking the desktop file format specification, the correct key
-
         should be "Comment"
-
         (https://specifications.freedesktop.org/desktop-entry-spec/latest/ar01s05.html).
     - hash: c3e360e61933ef0044c005b5e92c879ff9a47c49
       author: Juan Cruz Viotti
@@ -12270,15 +12853,11 @@
         changelog-entry: Fix flashing never starting after elevation in GNU/Linux.
         fixes: https://github.com/resin-io/etcher/issues/665
       subject: Make all angular modules export the name of the module
-      body: >-
+      body: |-
         This makes them very nicely require-able, for example:
-
         angular.module('MyModule', [
-
         require('my-dependency');
-
         ]);
-
         From https://medium.com/@kentcdodds/how-to-distribute-your-angularjs-module-e04d4dd58ddc#.yqg2zo8im
     - hash: b8f63af3f81bca3abd055303bc91ab35eb126655
       author: Juan Cruz Viotti
@@ -12531,7 +13110,8 @@
       body: >-
         Electron no longer supports 10.8.
 
-        See http://electron.atom.io/docs/v0.37.5/tutorial/supported-platforms/#os-x
+        See
+        http://electron.atom.io/docs/v0.37.5/tutorial/supported-platforms/#os-x
     - hash: 097c9a4aa37029154c3efe8564edbeef048926ad
       author: Juan Cruz Viotti
       subject: Add subtle hover styling to footer links

CHANGELOG.md

@@ -3,6 +3,184 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+# v2.1.0
+## (2025-02-27)
+
+* Add informational notice about how to disable analytics collection [myarmolinsky]
+
+# v2.0.0
+## (2025-02-20)
+
+* major: build on ubuntu 22 and macos 13 [Edwin Joassart]
+
+# v1.19.25
+## (2024-10-10)
+
+* patch: bump etcher-sdk to 9.1.2 [Edwin Joassart]
+
+# v1.19.24
+## (2024-10-09)
+
+* patch: etcher-util is corrupted in RPM package [Richard Glidden]
+
+# v1.19.23
+## (2024-10-09)
+
+* patch: remove gconf2 libgconf-2-4 deps [Marc-Aurèle Brothier]
+
+# v1.19.22
+## (2024-07-18)
+
+* Replace deprecated Flowzone inputs [Kyle Harding]
+
+# v1.19.21
+## (2024-05-30)
+
+* patch: fix missing windows dependency [Edwin Joassart]
+* patch: fix missing windows dependency [Edwin Joassart]
+* patch: fix missing windows dependency [Edwin Joassart]
+
+# v1.19.20
+## (2024-05-30)
+
+* patch: fix missing windows dependency [Edwin Joassart]
+
+# v1.19.19
+## (2024-05-28)
+
+* patch: add sentry debug flag [Edwin Joassart]
+
+# v1.19.18
+## (2024-05-22)
+
+* patch: fix Sentry DSN for main process [Edwin Joassart]
+
+# v1.19.17
+## (2024-05-09)
+
+* patch: fix injection of analytics key at build time [JOASSART Edwin]
+
+# v1.19.16
+## (2024-04-26)
+
+* patch: hold request for metadata while waiting for flasher [Edwin Joassart]
+
+# v1.19.15
+## (2024-04-26)
+
+* patch: bump etcher-sdk to 9.0.11 to fix url loading using http/2 [Edwin Joassart]
+
+# v1.19.14
+## (2024-04-25)
+
+* patch: pretty-bytes to 6.1.1 [JOASSART Edwin]
+
+# v1.19.13
+## (2024-04-25)
+
+* patch: use etcher icon as loading for windows installer [Edwin Joassart]
+* patch: fix windows squirrel install [Edwin Joassart]
+
+# v1.19.12
+## (2024-04-25)
+
+* patch: bump minors & patch [Edwin Joassart]
+* patch: bump @electron-forge/* to 7.4.0 [Edwin Joassart]
+* patch: bump electron to 30.0.1 & @electron/remote to 2.1.2 [Edwin Joassart]
+* patch: npm upgrade [Edwin Joassart]
+* patch: bump @balena/lint to 8.0.2 and fix formating [Edwin Joassart]
+* patch: fix pretty-bytes imports [Edwin Joassart]
+* patch: bump etcher-sdk to 9.0.9 [Edwin Joassart]
+
+# v1.19.11
+## (2024-04-25)
+
+* patch: setup wdio and port (most) tests [Edwin Joassart]
+
+# v1.19.10
+## (2024-04-23)
+
+* patch: remove node-ipc and tests [Edwin Joassart]
+* patch: switch api; use ws; integrate sudo-prompt - switch api roles flow - use websocket instead of node-ipc - integrate; modernize; simplify and deprecate sudo-prompt [Edwin Joassart]
+* patch: refactor api to use a single topic [Edwin Joassart]
+* patch: set require node engine to 20 [Edwin Joassart]
+
+# v1.19.9
+## (2024-04-22)
+
+* patch: prevent rebuild of native deps by @electron/rebuild [Edwin Joassart]
+
+# v1.19.8
+## (2024-04-22)
+
+* patch: replace deprecated pkg with yao-pkg and bump etcher-util node v to 20.10 [Edwin Joassart]
+
+# v1.19.7
+## (2024-04-22)
+
+* patch: fix formating [Edwin Joassart]
+* patch: configure prettier in the project to use balena-lint configuration [Edwin Joassart]
+
+# v1.19.6
+## (2024-04-19)
+
+* patch: fix win signature process [Edwin Joassart]
+
+# v1.19.5
+## (2024-02-14)
+
+* Replace deprecated flowzone input tests_run_on [Kyle Harding]
+
+# v1.19.4
+## (2024-01-26)
+
+* patch: remove screensaver error when not on etcher-pro [Edwin Joassart]
+* patch: fix typo in IPC server id [Edwin Joassart]
+
+# v1.19.3
+## (2023-12-22)
+
+* Update dependencies [Edwin Joassart]
+
+# v1.19.2
+## (2023-12-22)
+
+* fix: typos [Rotzbua]
+
+# v1.19.1
+## (2023-12-22)
+
+* patch: update winget-releaser v2 [Vedant]
+
+# v1.19.0
+## (2023-12-21)
+
+* Use native ARM runner for Apple Silicon builds [Akis Kesoglou]
+* Calculate and upload build artifact sha256 checksums [Akis Kesoglou]
+* Migrate build pipeline to Electron Forge [Akis Kesoglou]
+
+# v1.18.14
+## (2023-12-20)
+
+* Remove repo config from flowzone.yml [Kyle Harding]
+* Update actions/upload-artifact to v4 [Kyle Harding]
+
+# v1.18.13
+## (2023-10-16)
+
+* patch: upgrade to electron 25 [Edwin Joassart]
+* patch: refactor scanner, loader and flasher out of gui + upgrade to electron 25 [Edwin Joassart]
+
+# v1.18.12
+## (2023-07-19)
+
+* Update instructions for installing deb file [Jorge Capona]
+
+# v1.18.11
+## (2023-07-13)
+
+* fix: prevent stealing window focus from auth dialog [leadpogrommer]
+
 # v1.18.10
 ## (2023-07-12)
 

Makefile

@@ -1,152 +0,0 @@
-# ---------------------------------------------------------------------
-# Build configuration
-# ---------------------------------------------------------------------
-
-RESIN_SCRIPTS ?= ./scripts/resin
-export NPM_VERSION ?= 6.14.8
-S3_BUCKET = artifacts.ci.balena-cloud.com
-
-# This directory will be completely deleted by the `clean` rule
-BUILD_DIRECTORY ?= dist
-
-BUILD_TEMPORARY_DIRECTORY = $(BUILD_DIRECTORY)/.tmp
-
-$(BUILD_DIRECTORY):
-	mkdir $@
-
-$(BUILD_TEMPORARY_DIRECTORY): | $(BUILD_DIRECTORY)
-	mkdir $@
-
-SHELL := /bin/bash
-
-# ---------------------------------------------------------------------
-# Operating system and architecture detection
-# ---------------------------------------------------------------------
-
-# http://stackoverflow.com/a/12099167
-ifeq ($(OS),Windows_NT)
-	PLATFORM = win32
-
-	ifeq ($(PROCESSOR_ARCHITEW6432),AMD64)
-		HOST_ARCH = x64
-	else
-		ifeq ($(PROCESSOR_ARCHITECTURE),AMD64)
-			HOST_ARCH = x64
-		endif
-		ifeq ($(PROCESSOR_ARCHITECTURE),x86)
-			HOST_ARCH = x86
-		endif
-	endif
-else
-	ifeq ($(shell uname -s),Linux)
-		PLATFORM = linux
-
-		ifeq ($(shell uname -m),x86_64)
-			HOST_ARCH = x64
-		endif
-		ifneq ($(filter %86,$(shell uname -m)),)
-			HOST_ARCH = x86
-		endif
-		ifeq ($(shell uname -m),armv7l)
-			HOST_ARCH = armv7hf
-		endif
-		ifeq ($(shell uname -m),aarch64)
-			HOST_ARCH = aarch64
-		endif
-		ifeq ($(shell uname -m),armv8)
-			HOST_ARCH = aarch64
-		endif
-		ifeq ($(shell uname -m),arm64)
-			HOST_ARCH = aarch64
-		endif
-	endif
-	ifeq ($(shell uname -s),Darwin)
-		PLATFORM = darwin
-
-		ifeq ($(shell uname -m),x86_64)
-			HOST_ARCH = x64
-		endif
-		ifeq ($(shell uname -m),arm64)
-			HOST_ARCH = aarch64
-		endif
-	endif
-endif
-
-ifndef PLATFORM
-$(error We could not detect your host platform)
-endif
-ifndef HOST_ARCH
-$(error We could not detect your host architecture)
-endif
-
-# Default to host architecture. You can override by doing:
-#
-#   make <target> TARGET_ARCH=<arch>
-#
-TARGET_ARCH ?= $(HOST_ARCH)
-
-# ---------------------------------------------------------------------
-# Electron
-# ---------------------------------------------------------------------
-electron-develop:
-	git submodule update --init && \
-	npm ci && \
-	npm run webpack
-
-electron-test:
-	$(RESIN_SCRIPTS)/electron/test.sh \
-		-b $(shell pwd) \
-		-s $(PLATFORM)
-
-assets/dmg/background.tiff: assets/dmg/background.png assets/dmg/background@2x.png
-	tiffutil -cathidpicheck $^ -out $@
-
-electron-build: assets/dmg/background.tiff | $(BUILD_TEMPORARY_DIRECTORY)
-	$(RESIN_SCRIPTS)/electron/build.sh \
-		-b $(shell pwd) \
-		-r $(TARGET_ARCH) \
-		-s $(PLATFORM) \
-		-v production \
-		-n $(BUILD_TEMPORARY_DIRECTORY)/npm
-
-# ---------------------------------------------------------------------
-# Phony targets
-# ---------------------------------------------------------------------
-
-TARGETS = \
-	help \
-	info \
-	lint \
-	test \
-	clean \
-	distclean \
-	electron-develop \
-	electron-test \
-	electron-build
-
-.PHONY: $(TARGETS)
-
-lint:
-	npm run lint
-
-test:
-	npm run test
-
-help:
-	@echo "Available targets: $(TARGETS)"
-
-info:
-	@echo "Platform            : $(PLATFORM)"
-	@echo "Host arch           : $(HOST_ARCH)"
-	@echo "Target arch         : $(TARGET_ARCH)"
-
-clean:
-	rm -rf $(BUILD_DIRECTORY)
-
-distclean: clean
-	rm -rf node_modules
-	rm -rf dist
-	rm -rf generated
-	rm -rf $(BUILD_TEMPORARY_DIRECTORY)
-
-.DEFAULT_GOAL = help

README.md

@@ -17,13 +17,9 @@ was written correctly, and much more. It can also directly flash Raspberry Pi de
 
 ## Supported Operating Systems
 
-- Linux (most distros)
-- macOS 10.10 (Yosemite) and later
-- Microsoft Windows 7 and later
-
-**Note**: Etcher will run on any platform officially supported by
-[Electron][electron]. Read more in their
-[documentation][electron-supported-platforms].
+- Linux; most distros; Intel 64-bit.
+- Windows 10 and later; Intel 64-bit.
+- macOS 10.13 (High Sierra) and later; both Intel and Apple Silicon.
 
 ## Installers
 
@@ -36,26 +32,17 @@ installers for all supported operating systems.
 
 Package for Debian and Ubuntu can be downloaded from the [Github release page](https://github.com/balena-io/etcher/releases/)
 
-1. Install using dpkg
+##### Install .deb file using apt
 
    ```sh
-      sudo dpkg -i balena-etcher_******_amd64.deb
-   ```
-
-   If you're missing dependencies you can fix them with:
-
-   ```sh
-      sudo apt update && apt --fix-broken install #to add potential missing dependencies
+      sudo apt install ./balena-etcher_******_amd64.deb
    ```
 
 ##### Uninstall
 
-```sh
-sudo apt-get remove balena-etcher
-apt clean
-rm -rf /var/lib/apt/lists/*
-apt update
-```
+   ```sh
+      sudo apt remove balena-etcher
+   ```
 
 #### Redhat (RHEL) and Fedora-based Package Repository (GNU/Linux x86/x64)
 

afterPack.js

@@ -1,31 +0,0 @@
-'use strict'
-
-const cp = require('child_process')
-const fs = require('fs')
-const outdent = require('outdent')
-const path = require('path')
-
-exports.default = function(context) {
-  if (context.packager.platform.name !== 'linux') {
-    return
-  }
-  const scriptPath = path.join(context.appOutDir, context.packager.executableName)
-  const binPath = scriptPath + '.bin'
-  cp.execFileSync('mv', [scriptPath, binPath])
-  fs.writeFileSync(
-    scriptPath,
-    outdent({trimTrailingNewline: false})`
-      #!/bin/bash
-
-      # Resolve symlinks. Warning, readlink -f doesn't work on MacOS/BSD
-      script_dir="$(dirname "$(readlink -f "\${BASH_SOURCE[0]}")")"
-
-      if [[ $EUID -ne 0 ]] || [[ $ELECTRON_RUN_AS_NODE ]]; then
-        "\${script_dir}"/${context.packager.executableName}.bin "$@"
-      else
-        "\${script_dir}"/${context.packager.executableName}.bin "$@" --no-sandbox
-      fi
-    `
-  )
-  cp.execFileSync('chmod', ['+x', scriptPath])
-}

afterSignHook.js

@@ -1,25 +0,0 @@
-'use strict'
-
-const { notarize } = require('electron-notarize')
-const { ELECTRON_SKIP_NOTARIZATION } = process.env
-
-async function main(context) {
-  const { electronPlatformName, appOutDir } = context
-  if (electronPlatformName !== 'darwin' || ELECTRON_SKIP_NOTARIZATION === 'true') {
-    return
-  }
-
-  const appName = context.packager.appInfo.productFilename
-  const appleId = process.env.XCODE_APP_LOADER_EMAIL || 'accounts+apple@balena.io'
-  const appleIdPassword = process.env.XCODE_APP_LOADER_PASSWORD
-
-  // https://github.com/electron/notarize/blob/main/README.md
-  await notarize({
-    appBundleId: 'io.balena.etcher',
-    appPath: `${appOutDir}/${appName}.app`,
-    appleId,
-    appleIdPassword
-  })
-}
-
-exports.default = main

dev-app-update.yml

@@ -1,4 +0,0 @@
-owner: balena-io
-repo: etcher
-provider: github
-updaterCacheDirName: balena-etcher-updater

dictionary.txt

@@ -1,9 +0,0 @@
-boolen->boolean
-aknowledge->acknowledge
-seleted->selected
-reming->remind
-locl->local
-subsribe->subscribe
-unsubsribe->unsubscribe
-calcluate->calculate
-dictionaty->dictionary

docs/CONTRIBUTING.md

@@ -75,9 +75,7 @@ cd etcher
 #### GUI
 
 ```sh
-# Build the GUI
-npm run webpack #or npm run build
-# Start Electron
+# Build and start application
 npm start
 ```
 
@@ -104,7 +102,6 @@ systems as they can before sending a pull request.
 *The test suite is run automatically by CI servers when you send a pull
 request.*
 
-
 We make use of [EditorConfig] to communicate indentation, line endings and
 other text editing default. We encourage you to install the relevant plugin in
 your text editor of choice to avoid having to fix any issues during the review
@@ -113,7 +110,8 @@ process.
 Updating a dependency
 ---------------------
 
-- Commit *both* `package.json` and `package-lock.json`.
+- Install new version of dependency using npm
+- Commit *both* `package.json` and `npm-shrinkwrap.json`.
 
 Diffing Binaries
 ----------------

docs/MAINTAINERS.md

@@ -58,30 +58,23 @@ export ANALYTICS_AMPLITUDE_TOKEN="xxxxxx"
 
 ##### Clean dist folder
 
-**NOTE:** Make sure to adjust the path as necessary (here the Etcher repository has been cloned to `/home/$USER/code/etcher`)
+Delete `.webpack` and `out/`.
 
 ##### Generating artifacts
 
 The artifacts are generated by the CI and published as draft-release or pre-release.
-`electron-builder` is used to create the packaged application. 
+Etcher is built with electron-forge. Run:
 
-#### Mac OS
+```
+npm run make
+```
 
-**ATTENTION:** For production releases you'll need the code-signing key,
-and set `CSC_NAME` to generate signed binaries on Mac OS.
-
-#### Windows
-
-**ATTENTION:** For production releases you'll need the code-signing key,
-and set `CSC_LINK`, and `CSC_KEY_PASSWORD` to generate signed binaries on Windows.
-
-**NOTE:**
-- Keep in mind to also generate artifacts for x86, with `TARGET_ARCH=x86`.
+Our CI will appropriately sign artifacts for macOS and some Windows targets.
 
 
 ### Uploading packages to Cloudfront
 
-Log in to cloudfront and upload the `rpm` and `deb` files. 
+Log in to cloudfront and upload the `rpm` and `deb` files.
 
 ### Dealing with a Problematic Release
 

docs/PUBLISHING.md

@@ -36,14 +36,17 @@ employee by asking for it from the relevant people.
 Packaging
 ---------
 
-The resulting installers will be saved to `dist/out`.
-
-Run the following commands on all platforms with the right arguments:
+Run the following command on each platform:
 
 ```sh
-./node_modules/electron-builder build <...>
+npm run make
 ```
 
+This will produce all targets (eg. zip, dmg) specified in forge.config.ts for the
+host platform and architecture.
+
+The resulting artifacts can be found in `out/make`.
+
 
 Publishing to Cloudfront
 ---------------------

docs/USER-DOCUMENTATION.md

@@ -122,7 +122,6 @@ run Etcher on a GNU/Linux system.
 - xrender
 - xtst
 - xscrnsaver
-- gconf-2.0
 - gmodule-2.0
 - nss
 

electron-builder.yml

@@ -1,110 +0,0 @@
-# https://www.electron.build/configuration/configuration
-appId: io.balena.etcher
-copyright: Copyright 2016-2023 Balena Ltd
-productName: balenaEtcher
-afterPack: ./afterPack.js
-afterSign: ./afterSignHook.js
-asar: false
-files:
-  - generated
-  - lib/shared/catalina-sudo/sudo-askpass.osascript-zh.js
-  - lib/shared/catalina-sudo/sudo-askpass.osascript-en.js
-mac:
-  icon: assets/icon.icns
-  category: public.app-category.developer-tools
-  hardenedRuntime: true
-  entitlements: "entitlements.mac.plist"
-  entitlementsInherit: "entitlements.mac.plist"
-  artifactName: "${productName}-${version}.${ext}"
-  target:
-    - dmg
-dmg:
-  background: assets/dmg/background.tiff
-  icon: assets/icon.icns
-  iconSize: 110
-  contents:
-    - x: 140
-      y: 225
-    - x: 415
-      y: 225
-      type: link
-      path: /Applications
-  window:
-    width: 540
-    height: 405
-win:
-  icon: assets/icon.ico
-  target:
-    - zip
-    - nsis
-    - portable
-nsis:
-  oneClick: true
-  runAfterFinish: true
-  installerIcon: assets/icon.ico
-  uninstallerIcon: assets/icon.ico
-  deleteAppDataOnUninstall: true
-  license: LICENSE
-  artifactName: "${productName}-Setup-${version}.${ext}"
-portable:
-  artifactName: "${productName}-Portable-${version}.${ext}"
-  requestExecutionLevel: user
-linux:
-  icon: assets/iconset
-  target:
-    - AppImage
-    - rpm
-    - deb
-  category: Utility
-  packageCategory: utils
-  executableName: balena-etcher
-  synopsis: balenaEtcher is a powerful OS image flasher built with web technologies to ensure flashing an SDCard or USB drive is a pleasant and safe experience. It protects you from accidentally writing to your hard-drives, ensures every byte of data was written correctly and much more.
-appImage:
-  artifactName: ${productName}-${version}-${env.ELECTRON_BUILDER_ARCHITECTURE}.${ext}
-deb:
-  priority: optional
-  compression: bzip2
-  depends:
-    - gconf-service
-    - gconf2
-    - libasound2
-    - libatk1.0-0
-    - libc6
-    - libcairo2
-    - libcups2
-    - libdbus-1-3
-    - libexpat1
-    - libfontconfig1
-    - libfreetype6
-    - libgbm1
-    - libgcc1
-    - libgconf-2-4
-    - libgdk-pixbuf2.0-0
-    - libglib2.0-0
-    - libgtk-3-0
-    - liblzma5
-    - libnotify4
-    - libnspr4
-    - libnss3
-    - libpango1.0-0 | libpango-1.0-0
-    - libstdc++6
-    - libx11-6
-    - libxcomposite1
-    - libxcursor1
-    - libxdamage1
-    - libxext6
-    - libxfixes3
-    - libxi6
-    - libxrandr2
-    - libxrender1
-    - libxss1
-    - libxtst6
-    - polkit-1-auth-agent | policykit-1-gnome | polkit-kde-1
-  afterInstall: "./after-install.tpl"
-rpm:
-  depends:
-    - util-linux
-protocols:
-  name: etcher
-  schemes:
-    - etcher

entitlements.mac.plist

@@ -14,5 +14,11 @@
     <true/>
     <key>com.apple.security.network.client</key>
     <true/>
+    <key>com.apple.security.cs.disable-library-validation</key>
+    <true/>
+    <key>com.apple.security.get-task-allow</key>
+    <true/>
+    <key>com.apple.security.cs.disable-executable-page-protection</key>
+    <true/>
   </dict>
 </plist>

forge.config.ts

@@ -0,0 +1,159 @@
+import type { ForgeConfig } from '@electron-forge/shared-types';
+import { MakerSquirrel } from '@electron-forge/maker-squirrel';
+import { MakerZIP } from '@electron-forge/maker-zip';
+import { MakerDeb } from '@electron-forge/maker-deb';
+import { MakerRpm } from '@electron-forge/maker-rpm';
+import { MakerDMG } from '@electron-forge/maker-dmg';
+import { MakerAppImage } from '@reforged/maker-appimage';
+import { AutoUnpackNativesPlugin } from '@electron-forge/plugin-auto-unpack-natives';
+import { WebpackPlugin } from '@electron-forge/plugin-webpack';
+import { exec } from 'child_process';
+
+import { mainConfig, rendererConfig } from './webpack.config';
+import * as sidecar from './forge.sidecar';
+
+import { hostDependencies, productDescription } from './package.json';
+
+const osxSigningConfig: any = {};
+let winSigningConfig: any = {};
+
+if (process.env.NODE_ENV === 'production') {
+	osxSigningConfig.osxNotarize = {
+		tool: 'notarytool',
+		appleId: process.env.XCODE_APP_LOADER_EMAIL,
+		appleIdPassword: process.env.XCODE_APP_LOADER_PASSWORD,
+		teamId: process.env.XCODE_APP_LOADER_TEAM_ID,
+	};
+
+	winSigningConfig = {
+		signWithParams: `-sha1 ${process.env.SM_CODE_SIGNING_CERT_SHA1_HASH} -tr ${process.env.TIMESTAMP_SERVER} -td sha256 -fd sha256 -d balena-etcher`,
+	};
+}
+
+const config: ForgeConfig = {
+	packagerConfig: {
+		asar: true,
+		icon: './assets/icon',
+		executableName:
+			process.platform === 'linux' ? 'balena-etcher' : 'balenaEtcher',
+		appBundleId: 'io.balena.etcher',
+		appCategoryType: 'public.app-category.developer-tools',
+		appCopyright: 'Copyright 2016-2023 Balena Ltd',
+		darwinDarkModeSupport: true,
+		protocols: [{ name: 'etcher', schemes: ['etcher'] }],
+		extraResource: [
+			'lib/shared/sudo/sudo-askpass.osascript-zh.js',
+			'lib/shared/sudo/sudo-askpass.osascript-en.js',
+		],
+		osxSign: {
+			optionsForFile: () => ({
+				entitlements: './entitlements.mac.plist',
+				hardenedRuntime: true,
+			}),
+		},
+		...osxSigningConfig,
+	},
+	rebuildConfig: {
+		onlyModules: [], // prevent rebuilding *any* native modules as they won't be used by electron but by the sidecar
+	},
+	makers: [
+		new MakerZIP(),
+		new MakerSquirrel({
+			setupIcon: 'assets/icon.ico',
+			loadingGif: 'assets/icon.png',
+			...winSigningConfig,
+		}),
+		new MakerDMG({
+			background: './assets/dmg/background.tiff',
+			icon: './assets/icon.icns',
+			iconSize: 110,
+			contents: ((opts: { appPath: string }) => {
+				return [
+					{ x: 140, y: 250, type: 'file', path: opts.appPath },
+					{ x: 415, y: 250, type: 'link', path: '/Applications' },
+				];
+			}) as any, // type of MakerDMGConfig omits `appPath`
+			additionalDMGOptions: {
+				window: {
+					size: {
+						width: 540,
+						height: 425,
+					},
+					position: {
+						x: 400,
+						y: 500,
+					},
+				},
+			},
+		}),
+		new MakerAppImage({
+			options: {
+				icon: './assets/icon.png',
+				categories: ['Utility'],
+			},
+		}),
+		new MakerRpm({
+			options: {
+				icon: './assets/icon.png',
+				categories: ['Utility'],
+				productDescription,
+				requires: ['util-linux'],
+			},
+		}),
+		new MakerDeb({
+			options: {
+				icon: './assets/icon.png',
+				categories: ['Utility'],
+				section: 'utils',
+				priority: 'optional',
+				productDescription,
+				scripts: {
+					postinst: './after-install.tpl',
+				},
+				depends: hostDependencies['debian'],
+			},
+		}),
+	],
+	plugins: [
+		new AutoUnpackNativesPlugin({}),
+		new WebpackPlugin({
+			mainConfig,
+			renderer: {
+				config: rendererConfig,
+				nodeIntegration: true,
+				entryPoints: [
+					{
+						html: './lib/gui/app/index.html',
+						js: './lib/gui/app/renderer.ts',
+						name: 'main_window',
+						preload: {
+							js: './lib/gui/app/preload.ts',
+						},
+					},
+				],
+			},
+		}),
+		new sidecar.SidecarPlugin(),
+	],
+	hooks: {
+		postPackage: async (_forgeConfig, options) => {
+			if (options.platform === 'linux') {
+				// symlink the etcher binary from balena-etcher to balenaEtcher to ensure compatibility with the wdio suite and the old name
+				await new Promise<void>((resolve, reject) => {
+					exec(
+						`ln -s "${options.outputPaths}/balena-etcher" "${options.outputPaths}/balenaEtcher"`,
+						(err) => {
+							if (err) {
+								reject(err);
+							} else {
+								resolve();
+							}
+						},
+					);
+				});
+			}
+		},
+	},
+};
+
+export default config;

forge.sidecar.ts

@@ -0,0 +1,168 @@
+import { PluginBase } from '@electron-forge/plugin-base';
+import type {
+	ForgeHookMap,
+	ResolvedForgeConfig,
+} from '@electron-forge/shared-types';
+import { WebpackPlugin } from '@electron-forge/plugin-webpack';
+import { DefinePlugin } from 'webpack';
+
+import { execFileSync } from 'child_process';
+import * as fs from 'fs';
+import * as path from 'path';
+
+import * as d from 'debug';
+
+const debug = d('sidecar');
+
+function isStartScrpt(): boolean {
+	return process.env.npm_lifecycle_event === 'start';
+}
+
+function addWebpackDefine(
+	config: ResolvedForgeConfig,
+	defineName: string,
+	binDir: string,
+	binName: string,
+): ResolvedForgeConfig {
+	config.plugins.forEach((plugin) => {
+		if (plugin.name !== 'webpack' || !(plugin instanceof WebpackPlugin)) {
+			return;
+		}
+
+		const { mainConfig } = plugin.config as any;
+		if (mainConfig.plugins == null) {
+			mainConfig.plugins = [];
+		}
+
+		const value = isStartScrpt()
+			? // on `npm start`, point directly to the binary
+				path.resolve(binDir, binName)
+			: // otherwise point relative to the resources folder of the bundled app
+				binName;
+
+		debug(`define '${defineName}'='${value}'`);
+
+		mainConfig.plugins.push(
+			new DefinePlugin({
+				// expose path to helper via this webpack define
+				[defineName]: JSON.stringify(value),
+			}),
+		);
+	});
+
+	return config;
+}
+
+function build(
+	sourcesDir: string,
+	buildForArchs: string,
+	binDir: string,
+	binName: string,
+) {
+	const commands: Array<[string, string[], object?]> = [
+		['tsc', ['--project', 'tsconfig.sidecar.json', '--outDir', sourcesDir]],
+	];
+
+	buildForArchs.split(',').forEach((arch) => {
+		const binPath = isStartScrpt()
+			? // on `npm start`, we don't know the arch we're building for at the time we're
+				// adding the webpack define, so we just build under binDir
+				path.resolve(binDir, binName)
+			: // otherwise build in arch-specific directory within binDir
+				path.resolve(binDir, arch, binName);
+
+		// FIXME: rebuilding mountutils shouldn't be necessary, but it is.
+		// It's coming from etcher-sdk, a fix has been upstreamed but to use
+		// the latest etcher-sdk we need to upgrade axios at the same time.
+		commands.push(['npm', ['rebuild', 'mountutils', `--arch=${arch}`]]);
+
+		commands.push([
+			'pkg',
+			[
+				path.join(sourcesDir, 'util', 'api.js'),
+				'-c',
+				'pkg-sidecar.json',
+				// `--no-bytecode` so that we can cross-compile for arm64 on x64
+				'--no-bytecode',
+				'--public',
+				'--public-packages',
+				'"*"',
+				// always build for host platform and node version
+				// https://github.com/vercel/pkg-fetch/releases
+				'--target',
+				`node20-${arch}`,
+				'--output',
+				binPath,
+			],
+		]);
+	});
+
+	commands.forEach(([cmd, args, opt]) => {
+		debug('running command:', cmd, args.join(' '));
+		execFileSync(cmd, args, { shell: true, stdio: 'inherit', ...opt });
+	});
+}
+
+function copyArtifact(
+	buildPath: string,
+	arch: string,
+	binDir: string,
+	binName: string,
+) {
+	const binPath = isStartScrpt()
+		? // on `npm start`, we don't know the arch we're building for at the time we're
+			// adding the webpack define, so look for the binary directly under binDir
+			path.resolve(binDir, binName)
+		: // otherwise look into arch-specific directory within binDir
+			path.resolve(binDir, arch, binName);
+
+	// buildPath points to appPath, which is inside resources dir which is the one we actually want
+	const resourcesPath = path.dirname(buildPath);
+	const dest = path.resolve(resourcesPath, path.basename(binPath));
+	debug(`copying '${binPath}' to '${dest}'`);
+	fs.copyFileSync(binPath, dest);
+}
+
+export class SidecarPlugin extends PluginBase<void> {
+	name = 'sidecar';
+
+	constructor() {
+		super();
+		this.getHooks = this.getHooks.bind(this);
+		debug('isStartScript:', isStartScrpt());
+	}
+
+	getHooks(): ForgeHookMap {
+		const DEFINE_NAME = 'ETCHER_UTIL_BIN_PATH';
+		const BASE_DIR = path.join('out', 'sidecar');
+		const SRC_DIR = path.join(BASE_DIR, 'src');
+		const BIN_DIR = path.join(BASE_DIR, 'bin');
+		const BIN_NAME = `etcher-util${process.platform === 'win32' ? '.exe' : ''}`;
+
+		return {
+			resolveForgeConfig: async (currentConfig) => {
+				debug('resolveForgeConfig');
+				return addWebpackDefine(currentConfig, DEFINE_NAME, BIN_DIR, BIN_NAME);
+			},
+			generateAssets: async (_config, platform, arch) => {
+				debug('generateAssets', { platform, arch });
+				build(SRC_DIR, arch, BIN_DIR, BIN_NAME);
+			},
+			packageAfterCopy: async (
+				_config,
+				buildPath,
+				electronVersion,
+				platform,
+				arch,
+			) => {
+				debug('packageAfterCopy', {
+					buildPath,
+					electronVersion,
+					platform,
+					arch,
+				});
+				copyArtifact(buildPath, arch, BIN_DIR, BIN_NAME);
+			},
+		};
+	}
+}

lib/gui/app/app.ts

@@ -16,30 +16,30 @@
 
 import * as electron from 'electron';
 import * as remote from '@electron/remote';
-import * as sdk from 'etcher-sdk';
-import * as _ from 'lodash';
+import type { Dictionary } from 'lodash';
+import { debounce, capitalize, values } from 'lodash';
 import outdent from 'outdent';
 import * as React from 'react';
 import * as ReactDOM from 'react-dom';
 import { v4 as uuidV4 } from 'uuid';
 
 import * as packageJSON from '../../../package.json';
-import { DrivelistDrive, isSourceDrive } from '../../shared/drive-constraints';
+import type { DrivelistDrive } from '../../shared/drive-constraints';
 import * as EXIT_CODES from '../../shared/exit-codes';
 import * as messages from '../../shared/messages';
 import * as availableDrives from './models/available-drives';
 import * as flashState from './models/flash-state';
-import { deselectImage, getImage } from './models/selection-state';
 import * as settings from './models/settings';
 import { Actions, observe, store } from './models/store';
 import * as analytics from './modules/analytics';
-import { scanner as driveScanner } from './modules/drive-scanner';
+import { spawnChildAndConnect } from './modules/api';
 import * as exceptionReporter from './modules/exception-reporter';
 import * as osDialog from './os/dialog';
 import * as windowProgress from './os/window-progress';
 import MainPage from './pages/main/MainPage';
 import './css/main.css';
 import * as i18next from 'i18next';
+import type { SourceMetadata } from '../../shared/typings/source-selector';
 
 window.addEventListener(
 	'unhandledrejection',
@@ -89,7 +89,7 @@ analytics.logEvent('Application start', {
 	version: currentVersion,
 });
 
-const debouncedLog = _.debounce(console.log, 1000, { maxWait: 1000 });
+const debouncedLog = debounce(console.log, 1000, { maxWait: 1000 });
 
 function pluralize(word: string, quantity: number) {
 	return `${quantity} ${word}${quantity === 1 ? '' : 's'}`;
@@ -115,7 +115,7 @@ observe(() => {
 	// might cause some non-sense flashing state logs including
 	// `undefined` values.
 	debouncedLog(outdent({ newline: ' ' })`
-		${_.capitalize(currentFlashState.type)}
+		${capitalize(currentFlashState.type)}
 		${active},
 		${currentFlashState.percentage}%
 		at
@@ -128,172 +128,43 @@ observe(() => {
 	`);
 });
 
-/**
- * @summary The radix used by USB ID numbers
- */
-const USB_ID_RADIX = 16;
-
-/**
- * @summary The expected length of a USB ID number
- */
-const USB_ID_LENGTH = 4;
-
-/**
- * @summary Convert a USB id (e.g. product/vendor) to a string
- *
- * @example
- * console.log(usbIdToString(2652))
- * > '0x0a5c'
- */
-function usbIdToString(id: number): string {
-	return `0x${_.padStart(id.toString(USB_ID_RADIX), USB_ID_LENGTH, '0')}`;
+function setDrives(drives: Dictionary<DrivelistDrive>) {
+	// prevent setting drives while flashing otherwise we might lose some while we unmount them
+	if (!flashState.isFlashing()) {
+		availableDrives.setDrives(values(drives));
+	}
 }
 
-/**
- * @summary Product ID of BCM2708
- */
-const USB_PRODUCT_ID_BCM2708_BOOT = 0x2763;
+// Spawning the child process without privileges to get the drives list
+// TODO: clean up this mess of exports
+export let requestMetadata: any;
 
-/**
- * @summary Product ID of BCM2710
- */
-const USB_PRODUCT_ID_BCM2710_BOOT = 0x2764;
+// start the api and spawn the child process
+spawnChildAndConnect({
+	withPrivileges: false,
+})
+	.then(({ emit, registerHandler }) => {
+		// start scanning
+		emit('scan', {});
 
-/**
- * @summary Compute module descriptions
- */
-const COMPUTE_MODULE_DESCRIPTIONS: _.Dictionary<string> = {
-	[USB_PRODUCT_ID_BCM2708_BOOT]: 'Compute Module 1',
-	[USB_PRODUCT_ID_BCM2710_BOOT]: 'Compute Module 3',
-};
+		// make the sourceMetada awaitable to be used on source selection
+		requestMetadata = async (params: any): Promise<SourceMetadata> => {
+			emit('sourceMetadata', JSON.stringify(params));
 
-async function driveIsAllowed(drive: {
-	devicePath: string;
-	device: string;
-	raw: string;
-}) {
-	const driveBlacklist = (await settings.get('driveBlacklist')) || [];
-	return !(
-		driveBlacklist.includes(drive.devicePath) ||
-		driveBlacklist.includes(drive.device) ||
-		driveBlacklist.includes(drive.raw)
-	);
-}
-
-type Drive =
-	| sdk.sourceDestination.BlockDevice
-	| sdk.sourceDestination.UsbbootDrive
-	| sdk.sourceDestination.DriverlessDevice;
-
-function prepareDrive(drive: Drive) {
-	if (drive instanceof sdk.sourceDestination.BlockDevice) {
-		// @ts-ignore (BlockDevice.drive is private)
-		return drive.drive;
-	} else if (drive instanceof sdk.sourceDestination.UsbbootDrive) {
-		// This is a workaround etcher expecting a device string and a size
-		// @ts-ignore
-		drive.device = drive.usbDevice.portId;
-		drive.size = null;
-		// @ts-ignore
-		drive.progress = 0;
-		drive.disabled = true;
-		drive.on('progress', (progress) => {
-			updateDriveProgress(drive, progress);
-		});
-		return drive;
-	} else if (drive instanceof sdk.sourceDestination.DriverlessDevice) {
-		const description =
-			COMPUTE_MODULE_DESCRIPTIONS[
-				drive.deviceDescriptor.idProduct.toString()
-			] || 'Compute Module';
-		return {
-			device: `${usbIdToString(
-				drive.deviceDescriptor.idVendor,
-			)}:${usbIdToString(drive.deviceDescriptor.idProduct)}`,
-			displayName: 'Missing drivers',
-			description,
-			mountpoints: [],
-			isReadOnly: false,
-			isSystem: false,
-			disabled: true,
-			icon: 'warning',
-			size: null,
-			link: 'https://www.raspberrypi.com/documentation/computers/compute-module.html#flashing-the-compute-module-emmc',
-			linkCTA: 'Install',
-			linkTitle: 'Install missing drivers',
-			linkMessage: outdent`
-				Would you like to download the necessary drivers from the Raspberry Pi Foundation?
-				This will open your browser.
-
-
-				Once opened, download and run the installer from the "Windows Installer" section to install the drivers
-			`,
+			return new Promise((resolve) =>
+				registerHandler('sourceMetadata', (data: any) => {
+					resolve(JSON.parse(data));
+				}),
+			);
 		};
-	}
-}
 
-function setDrives(drives: _.Dictionary<DrivelistDrive>) {
-	availableDrives.setDrives(_.values(drives));
-}
-
-function getDrives() {
-	return _.keyBy(availableDrives.getDrives(), 'device');
-}
-
-async function addDrive(drive: Drive) {
-	const preparedDrive = prepareDrive(drive);
-	if (!(await driveIsAllowed(preparedDrive))) {
-		return;
-	}
-	const drives = getDrives();
-	drives[preparedDrive.device] = preparedDrive;
-	setDrives(drives);
-}
-
-function removeDrive(drive: Drive) {
-	if (
-		drive instanceof sdk.sourceDestination.BlockDevice &&
-		// @ts-ignore BlockDevice.drive is private
-		isSourceDrive(drive.drive, getImage())
-	) {
-		// Deselect the image if it was on the drive that was removed.
-		// This will also deselect the image if the drive mountpoints change.
-		deselectImage();
-	}
-	const preparedDrive = prepareDrive(drive);
-	const drives = getDrives();
-	delete drives[preparedDrive.device];
-	setDrives(drives);
-}
-
-function updateDriveProgress(
-	drive: sdk.sourceDestination.UsbbootDrive,
-	progress: number,
-) {
-	const drives = getDrives();
-	// @ts-ignore
-	const driveInMap = drives[drive.device];
-	if (driveInMap) {
-		// @ts-ignore
-		drives[drive.device] = { ...driveInMap, progress };
-		setDrives(drives);
-	}
-}
-
-driveScanner.on('attach', addDrive);
-driveScanner.on('detach', removeDrive);
-
-driveScanner.on('error', (error) => {
-	// Stop the drive scanning loop in case of errors,
-	// otherwise we risk presenting the same error over
-	// and over again to the user, while also heavily
-	// spamming our error reporting service.
-	driveScanner.stop();
-
-	return exceptionReporter.report(error);
-});
-
-driveScanner.start();
+		registerHandler('drives', (data: any) => {
+			setDrives(JSON.parse(data));
+		});
+	})
+	.catch((error: any) => {
+		throw new Error(`Failed to start the flasher process. error: ${error}`);
+	});
 
 let popupExists = false;
 

lib/gui/app/components/drive-selector/drive-selector.tsx

@@ -14,35 +14,34 @@
  * limitations under the License.
  */
 
-import ExclamationTriangleSvg from '@fortawesome/fontawesome-free/svgs/solid/exclamation-triangle.svg';
+import ExclamationTriangleSvg from '@fortawesome/fontawesome-free/svgs/solid/triangle-exclamation.svg';
 import ChevronDownSvg from '@fortawesome/fontawesome-free/svgs/solid/chevron-down.svg';
-import * as sourceDestination from 'etcher-sdk/build/source-destination/';
+import type * as sourceDestination from 'etcher-sdk/build/source-destination/';
 import * as React from 'react';
-import { Flex, ModalProps, Txt, Badge, Link, TableColumn } from 'rendition';
+import type { ModalProps, TableColumn } from 'rendition';
+import { Flex, Txt, Badge, Link } from 'rendition';
 import styled from 'styled-components';
 
+import type {
+	DriveStatus,
+	DrivelistDrive,
+} from '../../../../shared/drive-constraints';
 import {
 	getDriveImageCompatibilityStatuses,
 	isDriveValid,
-	DriveStatus,
-	DrivelistDrive,
 	isDriveSizeLarge,
 } from '../../../../shared/drive-constraints';
 import { compatibility, warning } from '../../../../shared/messages';
-import * as prettyBytes from 'pretty-bytes';
+import prettyBytes from 'pretty-bytes';
 import { getDrives, hasAvailableDrives } from '../../models/available-drives';
 import { getImage, isDriveSelected } from '../../models/selection-state';
 import { store } from '../../models/store';
 import { logEvent, logException } from '../../modules/analytics';
 import { open as openExternal } from '../../os/open-external/services/open-external';
-import {
-	Alert,
-	GenericTableProps,
-	Modal,
-	Table,
-} from '../../styled-components';
+import type { GenericTableProps } from '../../styled-components';
+import { Alert, Modal, Table } from '../../styled-components';
 
-import { SourceMetadata } from '../source-selector/source-selector';
+import type { SourceMetadata } from '../../../../shared/typings/source-selector';
 import { middleEllipsis } from '../../utils/middle-ellipsis';
 import * as i18next from 'i18next';
 
@@ -310,9 +309,17 @@ export class DriveSelector extends React.Component<
 			case compatibility.system():
 				return warning.systemDrive();
 			case compatibility.tooSmall():
-				const size =
-					this.state.image?.recommendedDriveSize || this.state.image?.size || 0;
-				return warning.tooSmall({ size }, drive);
+				return warning.tooSmall(
+					{
+						size:
+							this.state.image?.recommendedDriveSize ||
+							this.state.image?.size ||
+							0,
+					},
+					drive,
+				);
+			default:
+				return '';
 		}
 	}
 
@@ -428,11 +435,10 @@ export class DriveSelector extends React.Component<
 				) : (
 					<>
 						<DrivesTable
-							refFn={(t) => {
-								if (t !== null) {
-									t.setRowSelection(selectedList);
-								}
+							refFn={() => {
+								// noop
 							}}
+							checkedItems={selectedList}
 							checkedRowsNumber={selectedList.length}
 							multipleSelection={this.props.multipleSelection}
 							columns={this.tableColumns}
@@ -442,7 +448,10 @@ export class DriveSelector extends React.Component<
 								isDrivelistDrive(row) && row.isSystem ? ['system'] : []
 							}
 							rowKey="displayName"
-							onCheck={(rows: Drive[]) => {
+							onCheck={(rows) => {
+								if (rows == null) {
+									rows = [];
+								}
 								let newSelection = rows.filter(isDrivelistDrive);
 								if (this.props.multipleSelection) {
 									if (rows.length === 0) {

lib/gui/app/components/drive-status-warning-modal/drive-status-warning-modal.tsx

@@ -1,12 +1,12 @@
-import ExclamationTriangleSvg from '@fortawesome/fontawesome-free/svgs/solid/exclamation-triangle.svg';
-import * as _ from 'lodash';
+import ExclamationTriangleSvg from '@fortawesome/fontawesome-free/svgs/solid/triangle-exclamation.svg';
 import * as React from 'react';
-import { Badge, Flex, Txt, ModalProps } from 'rendition';
+import type { ModalProps } from 'rendition';
+import { Badge, Flex, Txt } from 'rendition';
 import { Modal, ScrollableFlex } from '../../styled-components';
 import { middleEllipsis } from '../../utils/middle-ellipsis';
 
-import * as prettyBytes from 'pretty-bytes';
-import { DriveWithWarnings } from '../../pages/main/Flash';
+import prettyBytes from 'pretty-bytes';
+import type { DriveWithWarnings } from '../../pages/main/Flash';
 import * as i18next from 'i18next';
 
 const DriveStatusWarningModal = ({

lib/gui/app/components/finish/finish.tsx

@@ -24,7 +24,8 @@ import * as settings from '../../models/settings';
 import { Actions, store } from '../../models/store';
 import * as analytics from '../../modules/analytics';
 import { FlashAnother } from '../flash-another/flash-another';
-import { FlashResults, FlashError } from '../flash-results/flash-results';
+import type { FlashError } from '../flash-results/flash-results';
+import { FlashResults } from '../flash-results/flash-results';
 import { SafeWebview } from '../safe-webview/safe-webview';
 
 function restart(goToMain: () => void) {

lib/gui/app/components/flash-results/flash-results.tsx

@@ -15,11 +15,11 @@
  */
 
 import CircleSvg from '@fortawesome/fontawesome-free/svgs/solid/circle.svg';
-import CheckCircleSvg from '@fortawesome/fontawesome-free/svgs/solid/check-circle.svg';
-import TimesCircleSvg from '@fortawesome/fontawesome-free/svgs/solid/times-circle.svg';
-import outdent from 'outdent';
+import CheckCircleSvg from '@fortawesome/fontawesome-free/svgs/solid/circle-check.svg';
+import TimesCircleSvg from '@fortawesome/fontawesome-free/svgs/solid/circle-xmark.svg';
 import * as React from 'react';
-import { Flex, FlexProps, Link, TableColumn, Txt } from 'rendition';
+import type { FlexProps, TableColumn } from 'rendition';
+import { Flex, Link, Txt } from 'rendition';
 import styled from 'styled-components';
 
 import { progress } from '../../../../shared/messages';
@@ -139,8 +139,9 @@ export function FlashResults({
 	};
 } & FlexProps) {
 	const [showErrorsInfo, setShowErrorsInfo] = React.useState(false);
-	const allFailed = !skip && results.devices.successful === 0;
-	const someFailed = results.devices.failed !== 0 || errors.length !== 0;
+
+	const allFailed = !skip && results?.devices?.successful === 0;
+	const someFailed = results?.devices?.failed !== 0 || errors?.length !== 0;
 	const effectiveSpeed = bytesToMegabytes(getEffectiveSpeed(results)).toFixed(
 		1,
 	);

lib/gui/app/components/settings/settings.tsx

@@ -17,7 +17,7 @@
 import GithubSvg from '@fortawesome/fontawesome-free/svgs/brands/github.svg';
 import * as _ from 'lodash';
 import * as React from 'react';
-import { Box, Checkbox, Flex, TextWithCopy, Txt } from 'rendition';
+import { Box, Checkbox, Flex, Txt } from 'rendition';
 
 import { version, packageType } from '../../../../../package.json';
 import * as settings from '../../models/settings';
@@ -61,7 +61,9 @@ const EPInfo = etcherProInfo();
 const InfoBox = (props: any) => (
 	<Box fontSize={14}>
 		<Txt>{props.label}</Txt>
-		<TextWithCopy code text={props.value} copy={props.value} />
+		<Txt code copy={props.value}>
+			{props.value}{' '}
+		</Txt>
 	</Box>
 );
 

lib/gui/app/components/source-selector/source-selector.tsx

@@ -17,19 +17,20 @@
 import CopySvg from '@fortawesome/fontawesome-free/svgs/solid/copy.svg';
 import FileSvg from '@fortawesome/fontawesome-free/svgs/solid/file.svg';
 import LinkSvg from '@fortawesome/fontawesome-free/svgs/solid/link.svg';
-import ExclamationTriangleSvg from '@fortawesome/fontawesome-free/svgs/solid/exclamation-triangle.svg';
+import ExclamationTriangleSvg from '@fortawesome/fontawesome-free/svgs/solid/triangle-exclamation.svg';
 import ChevronDownSvg from '@fortawesome/fontawesome-free/svgs/solid/chevron-down.svg';
 import ChevronRightSvg from '@fortawesome/fontawesome-free/svgs/solid/chevron-right.svg';
-import { sourceDestination } from 'etcher-sdk';
-import { ipcRenderer, IpcRendererEvent } from 'electron';
-import * as _ from 'lodash';
-import { GPTPartition, MBRPartition } from 'partitioninfo';
+import type { IpcRendererEvent } from 'electron';
+import { ipcRenderer } from 'electron';
+import { uniqBy, isNil } from 'lodash';
 import * as path from 'path';
-import * as prettyBytes from 'pretty-bytes';
+import prettyBytes from 'pretty-bytes';
 import * as React from 'react';
+import { requestMetadata } from '../../app';
+
+import type { ButtonProps } from 'rendition';
 import {
 	Flex,
-	ButtonProps,
 	Modal as SmallModal,
 	Txt,
 	Card as BaseCard,
@@ -47,7 +48,7 @@ import { observe } from '../../models/store';
 import * as analytics from '../../modules/analytics';
 import * as exceptionReporter from '../../modules/exception-reporter';
 import * as osDialog from '../../os/dialog';
-import { replaceWindowsNetworkDriveLetter } from '../../os/windows-network-drives';
+
 import {
 	ChangeButton,
 	DetailsText,
@@ -63,9 +64,13 @@ import { SVGIcon } from '../svg-icon/svg-icon';
 import ImageSvg from '../../../assets/image.svg';
 import SrcSvg from '../../../assets/src.svg';
 import { DriveSelector } from '../drive-selector/drive-selector';
-import { DrivelistDrive } from '../../../../shared/drive-constraints';
-import axios, { AxiosRequestConfig } from 'axios';
+import type { DrivelistDrive } from '../../../../shared/drive-constraints';
 import { isJson } from '../../../../shared/utils';
+import type {
+	SourceMetadata,
+	Authentication,
+	Source,
+} from '../../../../shared/typings/source-selector';
 import * as i18next from 'i18next';
 
 const recentUrlImagesKey = 'recentUrlImages';
@@ -83,7 +88,7 @@ function normalizeRecentUrlImages(urls: any[]): URL[] {
 			}
 		})
 		.filter((url) => url !== undefined);
-	urls = _.uniqBy(urls, (url) => url.href);
+	urls = uniqBy(urls, (url) => url.href);
 	return urls.slice(urls.length - 5);
 }
 
@@ -301,26 +306,9 @@ const FlowSelector = styled(
 	}
 `;
 
-export type Source =
-	| typeof sourceDestination.File
-	| typeof sourceDestination.BlockDevice
-	| typeof sourceDestination.Http;
-
-export interface SourceMetadata extends sourceDestination.Metadata {
-	hasMBR?: boolean;
-	partitions?: MBRPartition[] | GPTPartition[];
-	path: string;
-	displayName: string;
-	description: string;
-	SourceType: Source;
-	drive?: DrivelistDrive;
-	extension?: string;
-	archiveExtension?: string;
-	auth?: Authentication;
-}
-
 interface SourceSelectorProps {
 	flashing: boolean;
+	hideAnalyticsAlert: () => void;
 }
 
 interface SourceSelectorState {
@@ -336,11 +324,6 @@ interface SourceSelectorState {
 	imageLoading: boolean;
 }
 
-interface Authentication {
-	username: string;
-	password: string;
-}
-
 export class SourceSelector extends React.Component<
 	SourceSelectorProps,
 	SourceSelectorState
@@ -377,47 +360,29 @@ export class SourceSelector extends React.Component<
 		ipcRenderer.removeListener('select-image', this.onSelectImage);
 	}
 
+	public componentDidUpdate(
+		_prevProps: Readonly<SourceSelectorProps>,
+		prevState: Readonly<SourceSelectorState>,
+	) {
+		if (
+			(!prevState.showDriveSelector && this.state.showDriveSelector) ||
+			(!prevState.showURLSelector && this.state.showURLSelector) ||
+			(!prevState.showImageDetails && this.state.showImageDetails) ||
+			(!prevState.imageSelectorOpen && this.state.imageSelectorOpen)
+		) {
+			this.props.hideAnalyticsAlert();
+		}
+	}
+
 	private async onSelectImage(_event: IpcRendererEvent, imagePath: string) {
 		this.setState({ imageLoading: true });
 		await this.selectSource(
 			imagePath,
-			isURL(this.normalizeImagePath(imagePath))
-				? sourceDestination.Http
-				: sourceDestination.File,
+			isURL(this.normalizeImagePath(imagePath)) ? 'Http' : 'File',
 		).promise;
 		this.setState({ imageLoading: false });
 	}
 
-	private async createSource(
-		selected: string,
-		SourceType: Source,
-		auth?: Authentication,
-	) {
-		try {
-			selected = await replaceWindowsNetworkDriveLetter(selected);
-		} catch (error: any) {
-			analytics.logException(error);
-		}
-
-		if (isJson(decodeURIComponent(selected))) {
-			const config: AxiosRequestConfig = JSON.parse(
-				decodeURIComponent(selected),
-			);
-			return new sourceDestination.Http({
-				url: config.url!,
-				axiosInstance: axios.create(_.omit(config, ['url'])),
-			});
-		}
-
-		if (SourceType === sourceDestination.File) {
-			return new sourceDestination.File({
-				path: selected,
-			});
-		}
-
-		return new sourceDestination.Http({ url: selected, auth });
-	}
-
 	public normalizeImagePath(imgPath: string) {
 		const decodedPath = decodeURIComponent(imgPath);
 		if (isJson(decodedPath)) {
@@ -432,6 +397,7 @@ export class SourceSelector extends React.Component<
 		});
 
 		selectionState.deselectImage();
+		this.props.hideAnalyticsAlert();
 	}
 
 	private selectSource(
@@ -439,18 +405,16 @@ export class SourceSelector extends React.Component<
 		SourceType: Source,
 		auth?: Authentication,
 	): { promise: Promise<void>; cancel: () => void } {
-		let cancelled = false;
 		return {
 			cancel: () => {
-				cancelled = true;
+				// noop
 			},
 			promise: (async () => {
 				const sourcePath = isString(selected) ? selected : selected.device;
-				let source;
 				let metadata: SourceMetadata | undefined;
 				if (isString(selected)) {
 					if (
-						SourceType === sourceDestination.Http &&
+						SourceType === 'Http' &&
 						!isURL(this.normalizeImagePath(selected))
 					) {
 						this.handleError(
@@ -470,24 +434,22 @@ export class SourceSelector extends React.Component<
 							},
 						});
 					}
-					source = await this.createSource(selected, SourceType, auth);
-
-					if (cancelled) {
-						return;
-					}
 
 					try {
-						const innerSource = await source.getInnerSource();
-						if (cancelled) {
-							return;
-						}
-						metadata = await this.getMetadata(innerSource, selected);
-						if (cancelled) {
-							return;
-						}
-						metadata.SourceType = SourceType;
+						// this will send an event down the ipcMain asking for metadata
+						// we'll get the response through an event
 
-						if (!metadata.hasMBR && this.state.warning === null) {
+						// FIXME: This is a poor man wait while loading to prevent a potential race condition without completely blocking the interface
+						// This should be addressed when refactoring the GUI
+						let retriesLeft = 10;
+						while (requestMetadata === undefined && retriesLeft > 0) {
+							await new Promise((resolve) => setTimeout(resolve, 1050)); // api is trying to connect every 1000, this is offset to make sure we fall between retries
+							retriesLeft--;
+						}
+
+						metadata = await requestMetadata({ selected, SourceType, auth });
+
+						if (!metadata?.hasMBR && this.state.warning === null) {
 							analytics.logEvent('Missing partition table', { metadata });
 							this.setState({
 								warning: {
@@ -503,12 +465,6 @@ export class SourceSelector extends React.Component<
 							messages.error.openSource(sourcePath, error.message),
 							error,
 						);
-					} finally {
-						try {
-							await source.close();
-						} catch (error: any) {
-							// Noop
-						}
 					}
 				} else {
 					if (selected.partitionTableType === null) {
@@ -525,13 +481,14 @@ export class SourceSelector extends React.Component<
 						displayName: selected.displayName,
 						description: selected.displayName,
 						size: selected.size as SourceMetadata['size'],
-						SourceType: sourceDestination.BlockDevice,
+						SourceType: 'BlockDevice',
 						drive: selected,
 					};
 				}
 
 				if (metadata !== undefined) {
 					metadata.auth = auth;
+					metadata.SourceType = SourceType;
 					selectionState.selectSource(metadata);
 					analytics.logEvent('Select image', {
 						// An easy way so we can quickly identify if we're making use of
@@ -565,25 +522,6 @@ export class SourceSelector extends React.Component<
 		analytics.logEvent(title, { path: sourcePath });
 	}
 
-	private async getMetadata(
-		source: sourceDestination.SourceDestination,
-		selected: string | DrivelistDrive,
-	) {
-		const metadata = (await source.getMetadata()) as SourceMetadata;
-		const partitionTable = await source.getPartitionTable();
-		if (partitionTable) {
-			metadata.hasMBR = true;
-			metadata.partitions = partitionTable.partitions;
-		} else {
-			metadata.hasMBR = false;
-		}
-		if (isString(selected)) {
-			metadata.extension = path.extname(selected).slice(1);
-			metadata.path = selected;
-		}
-		return metadata;
-	}
-
 	private async openImageSelector() {
 		analytics.logEvent('Open image selector');
 		this.setState({ imageSelectorOpen: true });
@@ -596,7 +534,7 @@ export class SourceSelector extends React.Component<
 				analytics.logEvent('Image selector closed');
 				return;
 			}
-			await this.selectSource(imagePath, sourceDestination.File).promise;
+			await this.selectSource(imagePath, 'File').promise;
 		} catch (error: any) {
 			exceptionReporter.report(error);
 		} finally {
@@ -605,9 +543,9 @@ export class SourceSelector extends React.Component<
 	}
 
 	private async onDrop(event: React.DragEvent<HTMLDivElement>) {
-		const [file] = event.dataTransfer.files;
-		if (file) {
-			await this.selectSource(file.path, sourceDestination.File).promise;
+		const file = event.dataTransfer.files.item(0);
+		if (file != null) {
+			await this.selectSource(file.path, 'File').promise;
 		}
 	}
 
@@ -667,7 +605,7 @@ export class SourceSelector extends React.Component<
 			imageLoading,
 		} = this.state;
 		const selectionImage = selectionState.getImage();
-		let image: SourceMetadata | DrivelistDrive =
+		let image =
 			selectionImage !== undefined ? selectionImage : ({} as SourceMetadata);
 
 		image = image.drive ?? image;
@@ -723,7 +661,7 @@ export class SourceSelector extends React.Component<
 									{i18next.t('cancel')}
 								</ChangeButton>
 							)}
-							{!_.isNil(imageSize) && !imageLoading && (
+							{!isNil(imageSize) && !imageLoading && (
 								<DetailsText>{prettyBytes(imageSize)}</DetailsText>
 							)}
 						</>
@@ -770,7 +708,7 @@ export class SourceSelector extends React.Component<
 						style={{
 							boxShadow: '0 3px 7px rgba(0, 0, 0, 0.3)',
 						}}
-						titleElement={
+						title={
 							<span>
 								<ExclamationTriangleSvg fill="#fca321" height="1em" />{' '}
 								<span>{this.state.warning.title}</span>
@@ -827,7 +765,7 @@ export class SourceSelector extends React.Component<
 								let promise;
 								({ promise, cancel: cancelURLSelection } = this.selectSource(
 									imageURL,
-									sourceDestination.Http,
+									'Http',
 									auth,
 								));
 								await promise;
@@ -850,10 +788,7 @@ export class SourceSelector extends React.Component<
 							if (originalList.length) {
 								const originalSource = originalList[0];
 								if (selectionImage?.drive?.device !== originalSource.device) {
-									this.selectSource(
-										originalSource,
-										sourceDestination.BlockDevice,
-									);
+									this.selectSource(originalSource, 'BlockDevice');
 								}
 							} else {
 								selectionState.deselectImage();
@@ -868,7 +803,7 @@ export class SourceSelector extends React.Component<
 								) {
 									return selectionState.deselectImage();
 								}
-								this.selectSource(drive, sourceDestination.BlockDevice);
+								this.selectSource(drive, 'BlockDevice');
 							}
 						}}
 					/>

lib/gui/app/components/target-selector/target-selector-button.tsx

@@ -14,16 +14,15 @@
  * limitations under the License.
  */
 
-import ExclamationTriangleSvg from '@fortawesome/fontawesome-free/svgs/solid/exclamation-triangle.svg';
+import ExclamationTriangleSvg from '@fortawesome/fontawesome-free/svgs/solid/triangle-exclamation.svg';
 import * as React from 'react';
-import { Flex, FlexProps, Txt } from 'rendition';
+import type { FlexProps } from 'rendition';
+import { Flex, Txt } from 'rendition';
 
-import {
-	getDriveImageCompatibilityStatuses,
-	DriveStatus,
-} from '../../../../shared/drive-constraints';
+import type { DriveStatus } from '../../../../shared/drive-constraints';
+import { getDriveImageCompatibilityStatuses } from '../../../../shared/drive-constraints';
 import { compatibility, warning } from '../../../../shared/messages';
-import * as prettyBytes from 'pretty-bytes';
+import prettyBytes from 'pretty-bytes';
 import { getImage, getSelectedDrives } from '../../models/selection-state';
 import {
 	ChangeButton,

lib/gui/app/components/target-selector/target-selector.tsx

@@ -17,10 +17,8 @@
 import * as React from 'react';
 import { Flex, Txt } from 'rendition';
 
-import {
-	DriveSelector,
-	DriveSelectorProps,
-} from '../drive-selector/drive-selector';
+import type { DriveSelectorProps } from '../drive-selector/drive-selector';
+import { DriveSelector } from '../drive-selector/drive-selector';
 import {
 	isDriveSelected,
 	getImage,
@@ -36,7 +34,7 @@ import { TargetSelectorButton } from './target-selector-button';
 import TgtSvg from '../../../assets/tgt.svg';
 import DriveSvg from '../../../assets/drive.svg';
 import { warning } from '../../../../shared/messages';
-import { DrivelistDrive } from '../../../../shared/drive-constraints';
+import type { DrivelistDrive } from '../../../../shared/drive-constraints';
 import * as i18next from 'i18next';
 
 export const getDriveListLabel = () => {
@@ -102,12 +100,14 @@ interface TargetSelectorProps {
 	disabled: boolean;
 	hasDrive: boolean;
 	flashing: boolean;
+	hideAnalyticsAlert: () => void;
 }
 
 export const TargetSelector = ({
 	disabled,
 	hasDrive,
 	flashing,
+	hideAnalyticsAlert,
 }: TargetSelectorProps) => {
 	// TODO: inject these from redux-connector
 	const [{ driveListLabel, targets }, setStateSlice] = React.useState(
@@ -139,6 +139,7 @@ export const TargetSelector = ({
 				tooltip={driveListLabel}
 				openDriveSelector={() => {
 					setShowTargetSelectorModal(true);
+					hideAnalyticsAlert();
 				}}
 				reselectDrive={() => {
 					analytics.logEvent('Reselect drive');

lib/gui/app/css/main.css

@@ -15,36 +15,36 @@
  */
 
 @font-face {
-  font-family: "SourceSansPro";
-  src: url("./fonts/SourceSansPro-Regular.ttf") format("truetype");
-  font-weight: 500;
-  font-style: normal;
+	font-family: 'SourceSansPro';
+	src: url('./fonts/SourceSansPro-Regular.ttf') format('truetype');
+	font-weight: 500;
+	font-style: normal;
 }
 
 @font-face {
-  font-family: "SourceSansPro";
-  src: url("./fonts/SourceSansPro-SemiBold.ttf") format("truetype");
-  font-weight: 600;
-  font-style: normal;
+	font-family: 'SourceSansPro';
+	src: url('./fonts/SourceSansPro-SemiBold.ttf') format('truetype');
+	font-weight: 600;
+	font-style: normal;
 }
 
 html,
 body {
-  margin: 0;
-  overflow: hidden;
+	margin: 0;
+	overflow: hidden;
 
-  /* Prevent white flash when running application */
-  background-color: #4d5057;
+	/* Prevent white flash when running application */
+	background-color: #4d5057;
 
-  /* Prevent WebView bounce effect in OS X */
-  height: 100%;
-  width: 100%;
+	/* Prevent WebView bounce effect in OS X */
+	height: 100%;
+	width: 100%;
 }
 
 /* Prevent text selection */
 body {
-  -webkit-user-select: none;
-  -webkit-overflow-scrolling: touch;
+	-webkit-user-select: none;
+	-webkit-overflow-scrolling: touch;
 }
 
 /* Prevent blue outline */
@@ -52,15 +52,15 @@ a:focus,
 input:focus,
 button:focus,
 [tabindex]:focus,
-input[type="checkbox"] + div {
-  outline: none !important;
-  box-shadow: none !important;
+input[type='checkbox'] + div {
+	outline: none !important;
+	box-shadow: none !important;
 }
 
 .disabled {
-  opacity: 0.4;
+	opacity: 0.4;
 }
 
 #rendition-tooltip-root > div {
-  font-family: "SourceSansPro", sans-serif;
+	font-family: 'SourceSansPro', sans-serif;
 }

lib/gui/app/index.dev.html

@@ -1,12 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="UTF-8">
-    <title>balenaEtcher</title>
-    <link rel="stylesheet" type="text/css" href="index.css">
-  </head>
-  <body>
-    <main id="main"></main>
-    <script src="http://localhost:3030/gui.js"></script>
-  </body>
-</html>

lib/gui/app/index.html

@@ -3,10 +3,8 @@
   <head>
     <meta charset="UTF-8">
     <title>balenaEtcher</title>
-    <link rel="stylesheet" type="text/css" href="index.css">
   </head>
   <body>
     <main id="main"></main>
-    <script src="gui.js"></script>
   </body>
 </html>

lib/gui/app/models/available-drives.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { DrivelistDrive } from '../../../shared/drive-constraints';
+import type { DrivelistDrive } from '../../../shared/drive-constraints';
 import { Actions, store } from './store';
 
 export function hasAvailableDrives() {

lib/gui/app/models/flash-state.ts

@@ -15,9 +15,9 @@
  */
 
 import * as electron from 'electron';
-import * as sdk from 'etcher-sdk';
+import type * as sdk from 'etcher-sdk';
 import * as _ from 'lodash';
-import { DrivelistDrive } from '../../../shared/drive-constraints';
+import type { DrivelistDrive } from '../../../shared/drive-constraints';
 import { bytesToMegabytes } from '../../../shared/units';
 import { Actions, store } from './store';
 
@@ -47,13 +47,7 @@ export function isFlashing(): boolean {
  */
 export function setFlashingFlag() {
 	// see https://github.com/balenablocks/balena-electron-env/blob/4fce9c461f294d4a768db8f247eea6f75d7b08b0/README.md#remote-methods
-	try {
-		electron.ipcRenderer.invoke('disable-screensaver');
-	} catch (error) {
-		console.log(
-			"Can't disable-screensaver, we're probably not running on a balena-electron env",
-		);
-	}
+	electron.ipcRenderer.send('disable-screensaver');
 	store.dispatch({
 		type: Actions.SET_FLASHING_FLAG,
 		data: {},
@@ -76,7 +70,8 @@ export function unsetFlashingFlag(results: {
 		data: results,
 	});
 	// see https://github.com/balenablocks/balena-electron-env/blob/4fce9c461f294d4a768db8f247eea6f75d7b08b0/README.md#remote-methods
-	electron.ipcRenderer.invoke('enable-screensaver');
+
+	electron.ipcRenderer.send('enable-screensaver');
 }
 
 export function setDevicePaths(devicePaths: string[]) {

lib/gui/app/models/leds.ts

@@ -15,12 +15,11 @@
  */
 
 import * as _ from 'lodash';
-import { Animator, AnimationFunction, Color, RGBLed } from 'sys-class-rgb-led';
+import type { AnimationFunction, Color } from 'sys-class-rgb-led';
+import { Animator, RGBLed } from 'sys-class-rgb-led';
 
-import {
-	DrivelistDrive,
-	isSourceDrive,
-} from '../../../shared/drive-constraints';
+import type { DrivelistDrive } from '../../../shared/drive-constraints';
+import { isSourceDrive } from '../../../shared/drive-constraints';
 import { getDrives } from './available-drives';
 import { getSelectedDrives } from './selection-state';
 import * as settings from './settings';
@@ -43,7 +42,7 @@ function blink(t: number) {
 	return Math.floor(t) % 2;
 }
 
-function one(_t: number) {
+function one() {
 	return 1;
 }
 

lib/gui/app/models/selection-state.ts

@@ -1,4 +1,4 @@
-import { DrivelistDrive } from '../../../shared/drive-constraints';
+import type { DrivelistDrive } from '../../../shared/drive-constraints';
 /*
  * Copyright 2016 balena.io
  *
@@ -15,7 +15,7 @@ import { DrivelistDrive } from '../../../shared/drive-constraints';
  * limitations under the License.
  */
 
-import { SourceMetadata } from '../components/source-selector/source-selector';
+import type { SourceMetadata } from '../../../shared/typings/source-selector';
 
 import * as availableDrives from './available-drives';
 import { Actions, store } from './store';

lib/gui/app/modules/analytics.ts

@@ -14,12 +14,13 @@
  * limitations under the License.
  */
 
-import * as _ from 'lodash';
-import { Client, createClient, createNoopClient } from 'analytics-client';
+import { findLastIndex, once } from 'lodash';
+import type { Client } from 'analytics-client';
+import { createClient, createNoopClient } from 'analytics-client';
 import * as SentryRenderer from '@sentry/electron/renderer';
 import * as settings from '../models/settings';
 import { store } from '../models/store';
-import * as packageJSON from '../../../../package.json';
+import { version } from '../../../../package.json';
 
 type AnalyticsPayload = _.Dictionary<any>;
 
@@ -52,7 +53,7 @@ export const anonymizeSentryData = (
 	return event;
 };
 
-const extractPathRegex = /(.*)(^|\s)(file\:\/\/)?(\w\:)?([\\\/].+)/;
+const extractPathRegex = /(.*)(^|\s)(file:\/\/)?(\w:)?([\\/].+)/;
 const etcherSegmentMarkers = ['app.asar', 'Resources'];
 
 export const anonymizePath = (input: string) => {
@@ -72,7 +73,7 @@ export const anonymizePath = (input: string) => {
 	const segments = mainPart.split(sep);
 
 	// Moving from the end, find the first marker and cut the path from there.
-	const startCutIndex = _.findLastIndex(segments, (segment) =>
+	const startCutIndex = findLastIndex(segments, (segment) =>
 		etcherSegmentMarkers.includes(segment),
 	);
 	return (
@@ -118,21 +119,23 @@ let analyticsClient: Client;
 /**
  * @summary Init analytics configurations
  */
-export const initAnalytics = _.once(() => {
+export const initAnalytics = once(() => {
 	const dsn =
-		settings.getSync('analyticsSentryToken') ||
-		_.get(packageJSON, ['analytics', 'sentry', 'token']);
-	SentryRenderer.init({ dsn, beforeSend: anonymizeSentryData });
+		settings.getSync('analyticsSentryToken') || process.env.SENTRY_TOKEN;
+	SentryRenderer.init({
+		dsn,
+		beforeSend: anonymizeSentryData,
+		debug: process.env.ETCHER_SENTRY_DEBUG === 'true',
+	});
 
 	const projectName =
-		settings.getSync('analyticsAmplitudeToken') ||
-		_.get(packageJSON, ['analytics', 'amplitude', 'token']);
+		settings.getSync('analyticsAmplitudeToken') || process.env.AMPLITUDE_TOKEN;
 
 	const clientConfig = {
 		projectName,
 		endpoint: 'data.balena-cloud.com',
 		componentName: 'etcher',
-		componentVersion: packageJSON.version,
+		componentVersion: version,
 	};
 	analyticsClient = projectName
 		? createClient(clientConfig)
@@ -141,7 +144,7 @@ export const initAnalytics = _.once(() => {
 
 const getCircularReplacer = () => {
 	const seen = new WeakSet();
-	return (key: any, value: any) => {
+	return (_key: any, value: any) => {
 		if (typeof value === 'object' && value !== null) {
 			if (seen.has(value)) {
 				return;
@@ -156,7 +159,7 @@ function flattenObject(obj: any) {
 	const toReturn: AnalyticsPayload = {};
 
 	for (const i in obj) {
-		if (!obj.hasOwnProperty(i)) {
+		if (!Object.prototype.hasOwnProperty.call(obj, i)) {
 			continue;
 		}
 
@@ -168,7 +171,7 @@ function flattenObject(obj: any) {
 		if (typeof obj[i] === 'object' && obj[i] !== null) {
 			const flatObject = flattenObject(obj[i]);
 			for (const x in flatObject) {
-				if (!flatObject.hasOwnProperty(x)) {
+				if (!Object.prototype.hasOwnProperty.call(flatObject, x)) {
 					continue;
 				}
 

lib/gui/app/modules/api.ts

@@ -0,0 +1,251 @@
+/** This function will :
+ * 	- start the ipc server (api)
+ *  - spawn the child process (privileged or not)
+ *  - wait for the child process to connect to the api
+ *  - return a promise that will resolve with the emit function for the api
+ *
+ * //TODO:
+ *  - this should be refactored to reverse the control flow:
+ *    - the child process should be the server
+ *    - this should be the client
+ *  - replace the current node-ipc api with a websocket api
+ *  - centralise the api for both the writer and the scanner instead of having two instances running
+ */
+
+import WebSocket from 'ws'; // (no types for wrapper, this is expected)
+import { spawn, exec } from 'child_process';
+import * as os from 'os';
+import * as packageJSON from '../../../../package.json';
+import * as permissions from '../../../shared/permissions';
+import * as errors from '../../../shared/errors';
+
+const THREADS_PER_CPU = 16;
+const connectionRetryDelay = 1000;
+const connectionRetryAttempts = 10;
+
+async function writerArgv(): Promise<string[]> {
+	let entryPoint = await window.etcher.getEtcherUtilPath();
+	// AppImages run over FUSE, so the files inside the mount point
+	// can only be accessed by the user that mounted the AppImage.
+	// This means we can't re-spawn Etcher as root from the same
+	// mount-point, and as a workaround, we re-mount the original
+	// AppImage as root.
+	if (os.platform() === 'linux' && process.env.APPIMAGE && process.env.APPDIR) {
+		entryPoint = entryPoint.replace(process.env.APPDIR, '');
+		return [
+			process.env.APPIMAGE,
+			'-e',
+			`require(\`\${process.env.APPDIR}${entryPoint}\`)`,
+		];
+	} else {
+		return [entryPoint];
+	}
+}
+
+async function spawnChild(
+	withPrivileges: boolean,
+	etcherServerId: string,
+	etcherServerAddress: string,
+	etcherServerPort: string,
+) {
+	const argv = await writerArgv();
+	const env: any = {
+		ETCHER_SERVER_ADDRESS: etcherServerAddress,
+		ETCHER_SERVER_ID: etcherServerId,
+		ETCHER_SERVER_PORT: etcherServerPort,
+		UV_THREADPOOL_SIZE: (os.cpus().length * THREADS_PER_CPU).toString(),
+		// This environment variable prevents the AppImages
+		// desktop integration script from presenting the
+		// "installation" dialog
+		SKIP: '1',
+		...(process.platform === 'win32' ? {} : process.env),
+	};
+
+	if (withPrivileges) {
+		console.log('... with privileges ...');
+		return permissions.elevateCommand(argv, {
+			applicationName: packageJSON.displayName,
+			env,
+		});
+	} else {
+		if (process.platform === 'win32') {
+			// we need to ensure we reset the env as a previous elevation process might have kept them in a wrong state
+			const envCommand = [];
+			for (const key in env) {
+				if (Object.prototype.hasOwnProperty.call(env, key)) {
+					envCommand.push(`set ${key}=${env[key]}`);
+				}
+			}
+			await exec(envCommand.join(' && '));
+		}
+		const spawned = await spawn(argv[0], argv.slice(1), {
+			env,
+		});
+		return { cancelled: false, spawned };
+	}
+}
+
+type ChildApi = {
+	emit: (type: string, payload: any) => void;
+	registerHandler: (event: string, handler: any) => void;
+	failed: boolean;
+};
+
+async function connectToChildProcess(
+	etcherServerAddress: string,
+	etcherServerPort: string,
+	etcherServerId: string,
+): Promise<ChildApi | { failed: boolean }> {
+	return new Promise((resolve, reject) => {
+		// TODO: default to IPC connections https://github.com/websockets/ws/blob/master/doc/ws.md#ipc-connections
+		// TOOD: use the path as cheap authentication
+		console.log(etcherServerId);
+
+		const url = `ws://${etcherServerAddress}:${etcherServerPort}`;
+
+		const ws = new WebSocket(url);
+
+		let heartbeat: any;
+
+		const startHeartbeat = (emit: any) => {
+			console.log('start heartbeat');
+			heartbeat = setInterval(() => {
+				emit('heartbeat', {});
+			}, 1000);
+		};
+
+		const stopHeartbeat = () => {
+			console.log('stop heartbeat');
+			clearInterval(heartbeat);
+		};
+
+		ws.on('error', (error: any) => {
+			if (error.code === 'ECONNREFUSED') {
+				resolve({
+					failed: true,
+				});
+			} else {
+				stopHeartbeat();
+				reject({
+					failed: true,
+				});
+			}
+		});
+
+		ws.on('open', () => {
+			const emit = (type: string, payload: any) => {
+				ws.send(JSON.stringify({ type, payload }));
+			};
+
+			emit('ready', {});
+
+			// parse and route messages
+			const messagesHandler: any = {
+				log: (message: any) => {
+					console.log(`CHILD LOG: ${message}`);
+				},
+
+				error: (error: any) => {
+					const errorObject = errors.fromJSON(error);
+					console.error('CHILD ERROR', errorObject);
+					stopHeartbeat();
+				},
+
+				// once api is ready (means child process is connected) we pass the emit function to the caller
+				ready: () => {
+					console.log('CHILD READY');
+
+					startHeartbeat(emit);
+
+					resolve({
+						failed: false,
+						emit,
+						registerHandler,
+					});
+				},
+			};
+
+			ws.on('message', (jsonData: any) => {
+				const data = JSON.parse(jsonData);
+				const message = messagesHandler[data.type];
+				if (message) {
+					message(data.payload);
+				} else {
+					throw new Error(`Unknown message type: ${data.type}`);
+				}
+			});
+
+			// api to register more handlers with callbacks
+			const registerHandler = (event: string, handler: any) => {
+				messagesHandler[event] = handler;
+			};
+		});
+	});
+}
+
+async function spawnChildAndConnect({
+	withPrivileges,
+}: {
+	withPrivileges: boolean;
+}): Promise<ChildApi> {
+	const etcherServerAddress = process.env.ETCHER_SERVER_ADDRESS ?? '127.0.0.1'; // localhost
+	const etcherServerPort =
+		process.env.ETCHER_SERVER_PORT ?? withPrivileges ? '3435' : '3434';
+	const etcherServerId =
+		process.env.ETCHER_SERVER_ID ??
+		`etcher-${Math.random().toString(36).substring(7)}`;
+
+	console.log(
+		`Spawning ${
+			withPrivileges ? 'priviledged' : 'unpriviledged'
+		} sidecar on port ${etcherServerPort}`,
+	);
+
+	// spawn the child process, which will act as the ws server
+	// ETCHER_NO_SPAWN_UTIL can be set to launch a GUI only version of etcher, in that case you'll probably want to set other ENV to match your setup
+	if (!process.env.ETCHER_NO_SPAWN_UTIL) {
+		try {
+			const result = await spawnChild(
+				withPrivileges,
+				etcherServerId,
+				etcherServerAddress,
+				etcherServerPort,
+			);
+			if (result.cancelled) {
+				throw new Error('Spwaning the child process was cancelled');
+			}
+		} catch (error) {
+			console.error('Error spawning child process', error);
+			throw new Error('Error spawning the child process');
+		}
+	}
+
+	// try to connect to the ws server, retrying if necessary, until the connection is established
+	try {
+		let retry = 0;
+		while (retry < connectionRetryAttempts) {
+			const { emit, registerHandler, failed } = await connectToChildProcess(
+				etcherServerAddress,
+				etcherServerPort,
+				etcherServerId,
+			);
+			if (failed) {
+				retry++;
+				console.log(
+					`Retrying to connect to child process in ${connectionRetryDelay}... ${retry} / ${connectionRetryAttempts}`,
+				);
+				await new Promise((resolve) =>
+					setTimeout(resolve, connectionRetryDelay),
+				);
+				continue;
+			}
+			return { failed, emit, registerHandler };
+		}
+		throw new Error('Connection to etcher-util timed out');
+	} catch (error) {
+		console.error('Error connecting to child process', error);
+		throw new Error('Connection to etcher-util failed');
+	}
+}
+
+export { spawnChildAndConnect };

lib/gui/app/modules/image-writer.ts

@@ -14,41 +14,17 @@
  * limitations under the License.
  */
 
-import { Drive as DrivelistDrive } from 'drivelist';
-import * as sdk from 'etcher-sdk';
-import { Dictionary } from 'lodash';
-import * as ipc from 'node-ipc';
-import * as os from 'os';
-import * as path from 'path';
-
-import * as packageJSON from '../../../../package.json';
+import type { Drive as DrivelistDrive } from 'drivelist';
+import type * as sdk from 'etcher-sdk';
+import type { Dictionary } from 'lodash';
 import * as errors from '../../../shared/errors';
-import * as permissions from '../../../shared/permissions';
-import { getAppPath } from '../../../shared/utils';
-import { SourceMetadata } from '../components/source-selector/source-selector';
+import type { SourceMetadata } from '../../../shared/typings/source-selector';
 import * as flashState from '../models/flash-state';
 import * as selectionState from '../models/selection-state';
 import * as settings from '../models/settings';
 import * as analytics from '../modules/analytics';
 import * as windowProgress from '../os/window-progress';
-
-const THREADS_PER_CPU = 16;
-
-// There might be multiple Etcher instances running at
-// the same time, therefore we must ensure each IPC
-// server/client has a different name.
-const IPC_SERVER_ID = `etcher-server-${process.pid}`;
-const IPC_CLIENT_ID = `etcher-client-${process.pid}`;
-
-ipc.config.id = IPC_SERVER_ID;
-ipc.config.socketRoot = path.join(
-	process.env.XDG_RUNTIME_DIR || os.tmpdir(),
-	path.sep,
-);
-
-// NOTE: Ensure this isn't disabled, as it will cause
-// the stdout maxBuffer size to be exceeded when flashing
-ipc.config.silent = true;
+import { spawnChildAndConnect } from './api';
 
 /**
  * @summary Handle a flash error and log it to analytics
@@ -80,51 +56,7 @@ function handleErrorLogging(
 	}
 }
 
-function terminateServer() {
-	// Turns out we need to destroy all sockets for
-	// the server to actually close. Otherwise, it
-	// just stops receiving any further connections,
-	// but remains open if there are active ones.
-	// @ts-ignore (no Server.sockets in @types/node-ipc)
-	for (const socket of ipc.server.sockets) {
-		socket.destroy();
-	}
-	ipc.server.stop();
-}
-
-function writerArgv(): string[] {
-	let entryPoint = path.join(getAppPath(), 'generated', 'child-writer.js');
-	// AppImages run over FUSE, so the files inside the mount point
-	// can only be accessed by the user that mounted the AppImage.
-	// This means we can't re-spawn Etcher as root from the same
-	// mount-point, and as a workaround, we re-mount the original
-	// AppImage as root.
-	if (os.platform() === 'linux' && process.env.APPIMAGE && process.env.APPDIR) {
-		entryPoint = entryPoint.replace(process.env.APPDIR, '');
-		return [
-			process.env.APPIMAGE,
-			'-e',
-			`require(\`\${process.env.APPDIR}${entryPoint}\`)`,
-		];
-	} else {
-		return [process.argv[0], entryPoint];
-	}
-}
-
-function writerEnv() {
-	return {
-		IPC_SERVER_ID,
-		IPC_CLIENT_ID,
-		IPC_SOCKET_ROOT: ipc.config.socketRoot,
-		ELECTRON_RUN_AS_NODE: '1',
-		UV_THREADPOOL_SIZE: (os.cpus().length * THREADS_PER_CPU).toString(),
-		// This environment variable prevents the AppImages
-		// desktop integration script from presenting the
-		// "installation" dialog
-		SKIP: '1',
-		...(process.platform === 'win32' ? {} : process.env),
-	};
-}
+let cancelEmitter: (type: string) => void | undefined;
 
 interface FlashResults {
 	skip?: boolean;
@@ -144,22 +76,18 @@ async function performWrite(
 	drives: DrivelistDrive[],
 	onProgress: sdk.multiWrite.OnProgressFunction,
 ): Promise<{ cancelled?: boolean }> {
-	let cancelled = false;
-	let skip = false;
-	ipc.serve();
 	const { autoBlockmapping, decompressFirst } = await settings.getAll();
-	return await new Promise((resolve, reject) => {
-		ipc.server.on('error', (error) => {
-			terminateServer();
-			const errorObject = errors.fromJSON(error);
-			reject(errorObject);
-		});
 
-		ipc.server.on('log', (message) => {
-			console.log(message);
-		});
+	// Spawn the child process with privileges and wait for the connection to be made
+	const { emit, registerHandler } = await spawnChildAndConnect({
+		withPrivileges: true,
+	});
+
+	return await new Promise((resolve, reject) => {
+		// if the connection failed, reject the promise
 
 		const flashResults: FlashResults = {};
+
 		const analyticsData = {
 			image,
 			drives,
@@ -168,75 +96,51 @@ async function performWrite(
 			flashInstanceUuid: flashState.getFlashUuid(),
 		};
 
-		ipc.server.on('fail', ({ device, error }) => {
+		const onFail = ({ device, error }: { device: any; error: any }) => {
+			console.log('fail event');
+			console.log(device);
+			console.log(error);
 			if (device.devicePath) {
 				flashState.addFailedDeviceError({ device, error });
 			}
 			handleErrorLogging(error, analyticsData);
-		});
+			finish();
+		};
 
-		ipc.server.on('done', (event) => {
-			event.results.errors = event.results.errors.map(
+		const onDone = (payload: any) => {
+			console.log('CHILD: flash done', payload);
+			payload.results.errors = payload.results.errors.map(
 				(data: Dictionary<any> & { message: string }) => {
 					return errors.fromJSON(data);
 				},
 			);
-			flashResults.results = event.results;
-		});
+			flashResults.results = payload.results;
+			finish();
+		};
 
-		ipc.server.on('abort', () => {
-			terminateServer();
-			cancelled = true;
-		});
+		const onAbort = () => {
+			console.log('CHILD: flash aborted');
+			flashResults.cancelled = true;
+			finish();
+		};
 
-		ipc.server.on('skip', () => {
-			terminateServer();
-			skip = true;
-		});
+		const onSkip = () => {
+			console.log('CHILD: validation skipped');
+			flashResults.skip = true;
+			finish();
+		};
 
-		ipc.server.on('state', onProgress);
-
-		ipc.server.on('ready', (_data, socket) => {
-			ipc.server.emit(socket, 'write', {
-				image,
-				destinations: drives,
-				SourceType: image.SourceType.name,
-				autoBlockmapping,
-				decompressFirst,
-			});
-		});
-
-		const argv = writerArgv();
-
-		ipc.server.on('start', async () => {
-			console.log(`Elevating command: ${argv.join(' ')}`);
-			const env = writerEnv();
-			try {
-				const results = await permissions.elevateCommand(argv, {
-					applicationName: packageJSON.displayName,
-					environment: env,
-				});
-				flashResults.cancelled = cancelled || results.cancelled;
-				flashResults.skip = skip;
-			} catch (error: any) {
-				// This happens when the child is killed using SIGKILL
-				const SIGKILL_EXIT_CODE = 137;
-				if (error.code === SIGKILL_EXIT_CODE) {
-					error.code = 'ECHILDDIED';
-				}
-				reject(error);
-			} finally {
-				console.log('Terminating IPC server');
-				terminateServer();
-			}
+		const finish = () => {
 			console.log('Flash results', flashResults);
 
 			// The flash wasn't cancelled and we didn't get a 'done' event
+			// Catch unexpected situation
 			if (
 				!flashResults.cancelled &&
 				!flashResults.skip &&
 				flashResults.results === undefined
 			) {
+				console.log(flashResults);
 				reject(
 					errors.createUserError({
 						title: 'The writer process ended unexpectedly',
@@ -244,15 +148,32 @@ async function performWrite(
 							'Please try again, and contact the Etcher team if the problem persists',
 					}),
 				);
-				return;
 			}
-			resolve(flashResults);
-		});
 
-		// Clear the update lock timer to prevent longer
-		// flashing timing it out, and releasing the lock
-		ipc.server.start();
+			resolve(flashResults);
+		};
+
+		registerHandler('state', onProgress);
+		registerHandler('fail', onFail);
+		registerHandler('done', onDone);
+		registerHandler('abort', onAbort);
+		registerHandler('skip', onSkip);
+
+		cancelEmitter = (cancelStatus: string) => emit('cancel', cancelStatus);
+
+		// Now that we know we're connected we can instruct the child process to start the write
+		const parameters = {
+			image,
+			destinations: drives,
+			SourceType: image.SourceType,
+			autoBlockmapping,
+			decompressFirst,
+		};
+		console.log('params', parameters);
+		emit('write', parameters);
 	});
+
+	// The process continue in the event handler
 }
 
 /**
@@ -269,6 +190,7 @@ export async function flash(
 	}
 
 	await flashState.setFlashingFlag();
+
 	flashState.setDevicePaths(
 		drives.map((d) => d.devicePath).filter((p) => p != null) as string[],
 	);
@@ -284,16 +206,22 @@ export async function flash(
 
 	analytics.logEvent('Flash', analyticsData);
 
+	// start api and call the flasher
 	try {
 		const result = await write(image, drives, flashState.setProgressState);
+		console.log('got results', result);
 		await flashState.unsetFlashingFlag(result);
+		console.log('removed flashing flag');
 	} catch (error: any) {
 		await flashState.unsetFlashingFlag({
 			cancelled: false,
 			errorCode: error.code,
 		});
+
 		windowProgress.clear();
+
 		const { results = {} } = flashState.getFlashResults();
+
 		const eventData = {
 			...analyticsData,
 			errors: results.errors,
@@ -304,7 +232,9 @@ export async function flash(
 		analytics.logEvent('Write failed', eventData);
 		throw error;
 	}
+
 	windowProgress.clear();
+
 	if (flashState.wasLastFlashCancelled()) {
 		const eventData = {
 			...analyticsData,
@@ -327,6 +257,7 @@ export async function flash(
 
 /**
  * @summary Cancel write operation
+ * //TODO: find a better solution to handle cancellation
  */
 export async function cancel(type: string) {
 	const status = type.toLowerCase();
@@ -341,15 +272,7 @@ export async function cancel(type: string) {
 	};
 	analytics.logEvent('Cancel', analyticsData);
 
-	// Re-enable lock release on inactivity
-
-	try {
-		// @ts-ignore (no Server.sockets in @types/node-ipc)
-		const [socket] = ipc.server.sockets;
-		if (socket !== undefined) {
-			ipc.server.emit(socket, status);
-		}
-	} catch (error: any) {
-		analytics.logException(error);
+	if (cancelEmitter) {
+		cancelEmitter(status);
 	}
 }

lib/gui/app/modules/progress-status.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import * as prettyBytes from 'pretty-bytes';
+import prettyBytes from 'pretty-bytes';
 import * as i18next from 'i18next';
 
 export interface FlashState {
@@ -34,6 +34,8 @@ export function fromFlashState({
 	status: string;
 	position?: string;
 } {
+	console.log(i18next.t('progress.starting'));
+
 	if (type === undefined) {
 		return { status: i18next.t('progress.starting') };
 	} else if (type === 'decompressing') {

lib/gui/app/os/window-progress.ts

@@ -17,7 +17,8 @@
 import * as remote from '@electron/remote';
 
 import { percentageToFloat } from '../../../shared/utils';
-import { FlashState, titleFromFlashState } from '../modules/progress-status';
+import type { FlashState } from '../modules/progress-status';
+import { titleFromFlashState } from '../modules/progress-status';
 
 /**
  * @summary The title of the main window upon program launch

lib/gui/app/pages/main/Flash.tsx

@@ -27,7 +27,6 @@ import * as availableDrives from '../../models/available-drives';
 import * as flashState from '../../models/flash-state';
 import * as selection from '../../models/selection-state';
 import * as analytics from '../../modules/analytics';
-import { scanner as driveScanner } from '../../modules/drive-scanner';
 import * as imageWriter from '../../modules/image-writer';
 import * as notification from '../../os/notification';
 import {
@@ -95,10 +94,6 @@ async function flashImageToDrive(
 		return '';
 	}
 
-	// Stop scanning drives when flashing
-	// otherwise Windows throws EPERM
-	driveScanner.stop();
-
 	const iconPath = path.join('media', 'icon.png');
 	const basename = path.basename(image.path);
 	try {
@@ -110,7 +105,7 @@ async function flashImageToDrive(
 				cancelled,
 			} = flashState.getFlashResults();
 			if (!skip && !cancelled) {
-				if (results.devices.successful > 0) {
+				if (results?.devices?.successful > 0) {
 					notifySuccess(iconPath, basename, drives, results.devices);
 				} else {
 					notifyFailure(iconPath, basename, drives);
@@ -129,7 +124,6 @@ async function flashImageToDrive(
 		return errorMessage;
 	} finally {
 		availableDrives.setDrives([]);
-		driveScanner.start();
 	}
 
 	return '';

lib/gui/app/pages/main/MainPage.tsx

@@ -14,22 +14,21 @@
  * limitations under the License.
  */
 
-import CogSvg from '@fortawesome/fontawesome-free/svgs/solid/cog.svg';
-import QuestionCircleSvg from '@fortawesome/fontawesome-free/svgs/solid/question-circle.svg';
+import CogSvg from '@fortawesome/fontawesome-free/svgs/solid/gear.svg';
+import CloseSvg from '@fortawesome/fontawesome-free/svgs/solid/x.svg';
+import QuestionCircleSvg from '@fortawesome/fontawesome-free/svgs/solid/circle-question.svg';
 
 import * as path from 'path';
-import * as prettyBytes from 'pretty-bytes';
+import prettyBytes from 'pretty-bytes';
 import * as React from 'react';
-import { Flex } from 'rendition';
+import { Alert, Flex, Link } from 'rendition';
 import styled from 'styled-components';
 
 import FinishPage from '../../components/finish/finish';
 import { ReducedFlashingInfos } from '../../components/reduced-flashing-infos/reduced-flashing-infos';
 import { SettingsModal } from '../../components/settings/settings';
-import {
-	SourceMetadata,
-	SourceSelector,
-} from '../../components/source-selector/source-selector';
+import { SourceSelector } from '../../components/source-selector/source-selector';
+import type { SourceMetadata } from '../../../../shared/typings/source-selector';
 import * as flashState from '../../models/flash-state';
 import * as selectionState from '../../models/selection-state';
 import * as settings from '../../models/settings';
@@ -37,6 +36,7 @@ import { observe } from '../../models/store';
 import { open as openExternal } from '../../os/open-external/services/open-external';
 import {
 	IconButton as BaseIcon,
+	IconButton,
 	ThemedProvider,
 } from '../../styled-components';
 
@@ -48,6 +48,7 @@ import { FlashStep } from './Flash';
 
 import EtcherSvg from '../../../assets/etcher.svg';
 import { SafeWebview } from '../../components/safe-webview/safe-webview';
+import { theme } from '../../theme';
 
 const Icon = styled(BaseIcon)`
 	margin-right: 20px;
@@ -99,6 +100,8 @@ const StepBorder = styled.div<{
 	margin-left: ${(props) => (props.right ? '-120px' : undefined)};
 `;
 
+const ANALYTICS_ALERT_VISIBILITY_KEY = 'analytics_alert_visible';
+
 interface MainPageStateFromStore {
 	isFlashing: boolean;
 	hasImage: boolean;
@@ -115,18 +118,21 @@ interface MainPageState {
 	isWebviewShowing: boolean;
 	hideSettings: boolean;
 	featuredProjectURL?: string;
+	analyticsAlertIsVisible: boolean;
 }
 
 export class MainPage extends React.Component<
-	{},
+	object,
 	MainPageState & MainPageStateFromStore
 > {
-	constructor(props: {}) {
+	constructor(props: object) {
 		super(props);
 		this.state = {
 			current: 'main',
 			isWebviewShowing: false,
 			hideSettings: true,
+			analyticsAlertIsVisible:
+				localStorage.getItem(ANALYTICS_ALERT_VISIBILITY_KEY) !== 'false',
 			...this.stateHelper(),
 		};
 	}
@@ -155,6 +161,13 @@ export class MainPage extends React.Component<
 		return url.toString();
 	}
 
+	private hideAnalyticsAlert = () => {
+		if (this.state.analyticsAlertIsVisible) {
+			localStorage.setItem(ANALYTICS_ALERT_VISIBILITY_KEY, 'false');
+			this.setState({ analyticsAlertIsVisible: false });
+		}
+	};
+
 	public async componentDidMount() {
 		observe(() => {
 			this.setState(this.stateHelper());
@@ -162,6 +175,17 @@ export class MainPage extends React.Component<
 		this.setState({ featuredProjectURL: await this.getFeaturedProjectURL() });
 	}
 
+	public componentDidUpdate(
+		_prevProps: object,
+		prevState: Readonly<MainPageState & MainPageStateFromStore>,
+	) {
+		if (this.state.analyticsAlertIsVisible) {
+			if (prevState.hideSettings !== this.state.hideSettings) {
+				this.setState({ analyticsAlertIsVisible: false });
+			}
+		}
+	}
+
 	private renderMain() {
 		const state = flashState.getFlashState();
 		const shouldDriveStepBeDisabled = !this.state.hasImage;
@@ -171,86 +195,127 @@ export class MainPage extends React.Component<
 			!this.state.isFlashing || !this.state.isWebviewShowing;
 		return (
 			<Flex
-				m={`110px ${this.state.isWebviewShowing ? 35 : 55}px`}
-				justifyContent="space-between"
+				m={`110px ${this.state.isWebviewShowing ? 35 : 55}px 18px ${this.state.isWebviewShowing ? 35 : 55}px`}
+				flexDirection="column"
 			>
-				{notFlashingOrSplitView && (
-					<>
-						<SourceSelector flashing={this.state.isFlashing} />
-						<Flex>
-							<StepBorder disabled={shouldDriveStepBeDisabled} left />
-						</Flex>
-						<TargetSelector
-							disabled={shouldDriveStepBeDisabled}
-							hasDrive={this.state.hasDrive}
-							flashing={this.state.isFlashing}
-						/>
-						<Flex>
-							<StepBorder disabled={shouldFlashStepBeDisabled} right />
-						</Flex>
-					</>
-				)}
+				<Flex
+					justifyContent="space-between"
+					mb={this.state.analyticsAlertIsVisible ? '0px' : '92px'}
+				>
+					{notFlashingOrSplitView && (
+						<>
+							<SourceSelector
+								flashing={this.state.isFlashing}
+								hideAnalyticsAlert={this.hideAnalyticsAlert}
+							/>
+							<Flex>
+								<StepBorder disabled={shouldDriveStepBeDisabled} left />
+							</Flex>
+							<TargetSelector
+								disabled={shouldDriveStepBeDisabled}
+								hasDrive={this.state.hasDrive}
+								flashing={this.state.isFlashing}
+								hideAnalyticsAlert={this.hideAnalyticsAlert}
+							/>
+							<Flex>
+								<StepBorder disabled={shouldFlashStepBeDisabled} right />
+							</Flex>
+						</>
+					)}
 
-				{this.state.isFlashing && this.state.isWebviewShowing && (
-					<Flex
-						style={{
-							position: 'absolute',
-							top: 0,
-							left: 0,
-							width: '36.2vw',
-							height: '100vh',
-							zIndex: 1,
-							boxShadow: '0 2px 15px 0 rgba(0, 0, 0, 0.2)',
-						}}
-					>
-						<ReducedFlashingInfos
-							imageLogo={this.state.imageLogo}
-							imageName={this.state.imageName}
-							imageSize={
-								typeof this.state.imageSize === 'number'
-									? prettyBytes(this.state.imageSize)
-									: ''
-							}
-							driveTitle={this.state.driveTitle}
-							driveLabel={this.state.driveLabel}
+					{this.state.isFlashing && this.state.isWebviewShowing && (
+						<Flex
 							style={{
 								position: 'absolute',
-								color: '#fff',
-								left: 35,
-								top: 72,
+								top: 0,
+								left: 0,
+								width: '36.2vw',
+								height: '100vh',
+								zIndex: 1,
+								boxShadow: '0 2px 15px 0 rgba(0, 0, 0, 0.2)',
+							}}
+						>
+							<ReducedFlashingInfos
+								imageLogo={this.state.imageLogo}
+								imageName={this.state.imageName}
+								imageSize={
+									typeof this.state.imageSize === 'number'
+										? prettyBytes(this.state.imageSize)
+										: ''
+								}
+								driveTitle={this.state.driveTitle}
+								driveLabel={this.state.driveLabel}
+								style={{
+									position: 'absolute',
+									color: '#fff',
+									left: 35,
+									top: 72,
+								}}
+							/>
+						</Flex>
+					)}
+					{this.state.isFlashing && this.state.featuredProjectURL && (
+						<SafeWebview
+							src={this.state.featuredProjectURL}
+							onWebviewShow={(isWebviewShowing: boolean) => {
+								this.setState({ isWebviewShowing });
+							}}
+							style={{
+								position: 'absolute',
+								right: 0,
+								bottom: 0,
+								width: '63.8vw',
+								height: '100vh',
 							}}
 						/>
-					</Flex>
-				)}
-				{this.state.isFlashing && this.state.featuredProjectURL && (
-					<SafeWebview
-						src={this.state.featuredProjectURL}
-						onWebviewShow={(isWebviewShowing: boolean) => {
-							this.setState({ isWebviewShowing });
-						}}
-						style={{
-							position: 'absolute',
-							right: 0,
-							bottom: 0,
-							width: '63.8vw',
-							height: '100vh',
-						}}
-					/>
-				)}
+					)}
 
-				<FlashStep
-					width={this.state.isWebviewShowing ? '220px' : '200px'}
-					goToSuccess={() => this.setState({ current: 'success' })}
-					shouldFlashStepBeDisabled={shouldFlashStepBeDisabled}
-					isFlashing={this.state.isFlashing}
-					step={state.type}
-					percentage={state.percentage}
-					position={state.position}
-					failed={state.failed}
-					speed={state.speed}
-					eta={state.eta}
-					style={{ zIndex: 1 }}
-				/>
+					<FlashStep
+						width={this.state.isWebviewShowing ? '220px' : '200px'}
+						goToSuccess={() => this.setState({ current: 'success' })}
+						shouldFlashStepBeDisabled={shouldFlashStepBeDisabled}
+						isFlashing={this.state.isFlashing}
+						step={state.type}
+						percentage={state.percentage}
+						position={state.position}
+						failed={state.failed}
+						speed={state.speed}
+						eta={state.eta}
+						style={{ zIndex: 1 }}
+					/>
+				</Flex>
+				{this.state.analyticsAlertIsVisible && (
+					<Alert mt="18px" style={{ boxShadow: 'none', fontSize: '12px' }}>
+						<Flex alignItems="center" justifyContent="space-between">
+							<Flex flexDirection="column">
+								<div>
+									Etcher collects a limited amount of anonymous data to help us
+									improve user experience. You can opt out in the{' '}
+									<Link onClick={() => this.setState({ hideSettings: false })}>
+										settings
+									</Link>
+									.
+								</div>
+								<div>
+									For more information about how we use this data, see our{' '}
+									<Link
+										onClick={(e) => {
+											e.stopPropagation();
+											openExternal('https://www.balena.io/privacy-policy');
+										}}
+									>
+										privacy policy
+									</Link>
+									.
+								</div>
+							</Flex>
+							{/* TODO: can we use onDismiss instead? */}
+							<IconButton onClick={this.hideAnalyticsAlert}>
+								<CloseSvg height="0.75rem" fill={theme.colors.text.main} />
+							</IconButton>
+						</Flex>
+					</Alert>
+				)}
 			</Flex>
 		);
 	}

lib/gui/app/preload.ts

@@ -0,0 +1,12 @@
+// See the Electron documentation for details on how to use preload scripts:
+// https://www.electronjs.org/docs/latest/tutorial/process-model#preload-scripts
+
+import * as webapi from '../webapi';
+
+declare global {
+	interface Window {
+		etcher: typeof webapi;
+	}
+}
+
+window['etcher'] = webapi;

lib/gui/app/renderer.ts

@@ -6,10 +6,4 @@ import { ipcRenderer } from 'electron';
 
 ipcRenderer.send('change-lng', langParser());
 
-if (module.hot) {
-	module.hot.accept('./app', () => {
-		main();
-	});
-}
-
 main();

lib/gui/app/styled-components.tsx

@@ -14,18 +14,19 @@
  * limitations under the License.
  */
 
-import * as _ from 'lodash';
 import * as React from 'react';
+import type {
+	FlexProps,
+	ButtonProps,
+	TableProps as BaseTableProps,
+} from 'rendition';
 import {
 	Alert as AlertBase,
 	Flex,
-	FlexProps,
 	Button,
-	ButtonProps,
 	Modal as ModalBase,
 	Provider,
 	Table as BaseTable,
-	TableProps as BaseTableProps,
 	Txt,
 } from 'rendition';
 import styled, { css } from 'styled-components';
@@ -113,14 +114,25 @@ export const DetailsText = (props: FlexProps) => (
 
 const modalFooterShadowCss = css`
 	overflow: auto;
-	background: 0, linear-gradient(rgba(255, 255, 255, 0), white 70%) 0 100%, 0,
+	background:
+		0,
+		linear-gradient(rgba(255, 255, 255, 0), white 70%) 0 100%,
+		0,
 		linear-gradient(rgba(255, 255, 255, 0), rgba(221, 225, 240, 0.5) 70%) 0 100%;
 	background-repeat: no-repeat;
-	background-size: 100% 40px, 100% 40px, 100% 8px, 100% 8px;
+	background-size:
+		100% 40px,
+		100% 40px,
+		100% 8px,
+		100% 8px;
 
 	background-repeat: no-repeat;
 	background-color: white;
-	background-size: 100% 40px, 100% 40px, 100% 8px, 100% 8px;
+	background-size:
+		100% 40px,
+		100% 40px,
+		100% 8px,
+		100% 8px;
 	background-attachment: local, local, scroll, scroll;
 `;
 
@@ -236,16 +248,15 @@ export interface GenericTableProps<T> extends BaseTableProps<T> {
 	showWarnings?: boolean;
 }
 
-const GenericTable: <T>(
+function GenericTable<T>(
 	props: GenericTableProps<T>,
-) => React.ReactElement<GenericTableProps<T>> = <T extends {}>({
-	refFn,
-	...props
-}: GenericTableProps<T>) => (
-	<div>
-		<BaseTable<T> ref={refFn} {...props} />
-	</div>
-);
+): React.ReactElement<GenericTableProps<T>> {
+	return (
+		<div>
+			<BaseTable<T> ref={props.refFn} {...props} />
+		</div>
+	);
+}
 
 function StyledTable<T>() {
 	return styled((props: GenericTableProps<T>) => (
@@ -284,7 +295,6 @@ function StyledTable<T>() {
 		[data-display='table-body'] > [data-display='table-row'] {
 			> [data-display='table-cell']:first-child {
 				padding-left: 15px;
-				width: 6%;
 			}
 
 			> [data-display='table-cell']:last-child {
@@ -319,7 +329,7 @@ function StyledTable<T>() {
 	`;
 }
 
-export const Table = <T extends {}>(props: GenericTableProps<T>) => {
+export const Table = <T extends object>(props: GenericTableProps<T>) => {
 	const TypedStyledFunctional = StyledTable<T>();
 	return <TypedStyledFunctional {...props} />;
 };

lib/gui/app/utils/etcher-pro-specific.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { Dictionary } from 'lodash';
+import type { Dictionary } from 'lodash';
 
 type BalenaTag = {
 	id: number;

lib/gui/etcher.ts

@@ -14,6 +14,12 @@
  * limitations under the License.
  */
 
+// This allows TypeScript to pick up the magic constants that's auto-generated by Forge's Webpack
+// plugin that tells the Electron app where to look for the Webpack-bundled app code (depending on
+// whether you're running in development or production).
+declare const MAIN_WINDOW_WEBPACK_ENTRY: string;
+declare const MAIN_WINDOW_PRELOAD_WEBPACK_ENTRY: string;
+
 import * as electron from 'electron';
 import * as remoteMain from '@electron/remote/main';
 import { autoUpdater } from 'electron-updater';
@@ -21,7 +27,7 @@ import { promises as fs } from 'fs';
 import { platform } from 'os';
 import * as path from 'path';
 import * as semver from 'semver';
-import * as lodash from 'lodash';
+import { once } from 'lodash';
 
 import './app/i18n';
 
@@ -31,9 +37,10 @@ import * as settings from './app/models/settings';
 import { buildWindowMenu } from './menu';
 import * as i18n from 'i18next';
 import * as SentryMain from '@sentry/electron/main';
-import * as packageJSON from '../../package.json';
 import { anonymizeSentryData } from './app/modules/analytics';
 
+import { delay } from '../shared/utils';
+
 const customProtocol = 'etcher';
 const scheme = `${customProtocol}://`;
 const updatablePackageTypes = ['appimage', 'nsis', 'dmg'];
@@ -107,12 +114,16 @@ async function getCommandLineURL(argv: string[]): Promise<string | undefined> {
 	}
 }
 
-const initSentryMain = lodash.once(() => {
+const initSentryMain = once(() => {
 	const dsn =
-		settings.getSync('analyticsSentryToken') ||
-		lodash.get(packageJSON, ['analytics', 'sentry', 'token']);
+		settings.getSync('analyticsSentryToken') || process.env.SENTRY_TOKEN;
 
-	SentryMain.init({ dsn, beforeSend: anonymizeSentryData });
+	SentryMain.init({
+		dsn,
+		beforeSend: anonymizeSentryData,
+		debug: process.env.ETCHER_SENTRY_DEBUG === 'true',
+	});
+	console.log(SentryMain.getCurrentScope());
 });
 
 const sourceSelectorReady = new Promise((resolve) => {
@@ -138,14 +149,6 @@ electron.app.on('open-url', async (event, data) => {
 	await selectImageURL(data);
 });
 
-interface AutoUpdaterConfig {
-	autoDownload?: boolean;
-	autoInstallOnAppQuit?: boolean;
-	allowPrerelease?: boolean;
-	fullChangelog?: boolean;
-	allowDowngrade?: boolean;
-}
-
 async function createMainWindow() {
 	const fullscreen = Boolean(await settings.get('fullscreen'));
 	const defaultWidth = settings.DEFAULT_WIDTH;
@@ -176,15 +179,16 @@ async function createMainWindow() {
 			contextIsolation: false,
 			webviewTag: true,
 			zoomFactor: width / defaultWidth,
+			preload: MAIN_WINDOW_PRELOAD_WEBPACK_ENTRY,
 		},
 	});
 
 	electron.app.setAsDefaultProtocolClient(customProtocol);
 
-	mainWindow.setFullScreen(true);
+	// mainWindow.setFullScreen(true);
 
 	// Prevent flash of white when starting the application
-	mainWindow.on('ready-to-show', () => {
+	mainWindow.once('ready-to-show', () => {
 		console.timeEnd('ready-to-show');
 		// Electron sometimes caches the zoomFactor
 		// making it obnoxious to switch back-and-forth
@@ -195,17 +199,11 @@ async function createMainWindow() {
 	// Prevent external resources from being loaded (like images)
 	// when dropping them on the WebView.
 	// See https://github.com/electron/electron/issues/5919
-	mainWindow.webContents.on('will-navigate', (event) => {
+	mainWindow.webContents.on('will-navigate', (event: any) => {
 		event.preventDefault();
 	});
 
-	mainWindow.loadURL(
-		`file://${path.join(
-			'/',
-			...__dirname.split(path.sep).map(encodeURIComponent),
-			'index.html',
-		)}`,
-	);
+	mainWindow.loadURL(MAIN_WINDOW_WEBPACK_ENTRY);
 
 	const page = mainWindow.webContents;
 	remoteMain.enable(page);
@@ -241,6 +239,20 @@ electron.app.on('before-quit', () => {
 	process.exit(EXIT_CODES.SUCCESS);
 });
 
+// this is replaced at build-time with the path to helper binary,
+// relative to the app resources directory.
+declare const ETCHER_UTIL_BIN_PATH: string;
+
+electron.ipcMain.handle('get-util-path', () => {
+	if (process.env.NODE_ENV === 'development') {
+		// In development there is no "app bundle" and we're working directly with
+		// artifacts from the "out" directory, where this value point to.
+		return ETCHER_UTIL_BIN_PATH;
+	}
+	// In any other case, resolve the helper relative to resources path.
+	return path.resolve(process.resourcesPath, ETCHER_UTIL_BIN_PATH);
+});
+
 async function main(): Promise<void> {
 	if (!electron.app.requestSingleInstanceLock()) {
 		electron.app.quit();
@@ -272,7 +284,7 @@ async function main(): Promise<void> {
 			const webview = electron.webContents.fromId(id);
 
 			// Open link in browser if it's opened as a 'foreground-tab'
-			webview.setWindowOpenHandler((event) => {
+			webview!.setWindowOpenHandler((event) => {
 				const url = new URL(event.url);
 				if (
 					(url.protocol === 'http:' || url.protocol === 'https:') &&
@@ -287,6 +299,13 @@ async function main(): Promise<void> {
 		});
 	}
 }
+
+// Handle creating/removing shortcuts on Windows when installing/uninstalling.
+// tslint:disable-next-line:no-var-requires
+if (require('electron-squirrel-startup')) {
+	electron.app.quit();
+}
+
 main();
 
 console.time('ready-to-show');

lib/gui/modules/child-writer.ts

@@ -1,333 +0,0 @@
-/*
- * 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 { Drive as DrivelistDrive } from 'drivelist';
-import {
-	BlockDevice,
-	File,
-	Http,
-	Metadata,
-	SourceDestination,
-} from 'etcher-sdk/build/source-destination';
-import {
-	MultiDestinationProgress,
-	OnProgressFunction,
-	OnFailFunction,
-	decompressThenFlash,
-	DECOMPRESSED_IMAGE_PREFIX,
-} from 'etcher-sdk/build/multi-write';
-import { cleanupTmpFiles } from 'etcher-sdk/build/tmp';
-import * as ipc from 'node-ipc';
-import { totalmem } from 'os';
-
-import { toJSON } from '../../shared/errors';
-import { GENERAL_ERROR, SUCCESS } from '../../shared/exit-codes';
-import { delay, isJson } from '../../shared/utils';
-import { SourceMetadata } from '../app/components/source-selector/source-selector';
-import axios from 'axios';
-import * as _ from 'lodash';
-
-ipc.config.id = process.env.IPC_CLIENT_ID as string;
-ipc.config.socketRoot = process.env.IPC_SOCKET_ROOT as string;
-
-// NOTE: Ensure this isn't disabled, as it will cause
-// the stdout maxBuffer size to be exceeded when flashing
-ipc.config.silent = true;
-
-// > If set to 0, the client will NOT try to reconnect.
-// See https://github.com/RIAEvangelist/node-ipc/
-//
-// The purpose behind this change is for this process
-// to emit a "disconnect" event as soon as the GUI
-// process is closed, so we can kill this process as well.
-// @ts-ignore (0 is a valid value for stopRetrying and is not the same as false)
-ipc.config.stopRetrying = 0;
-
-const DISCONNECT_DELAY = 100;
-const IPC_SERVER_ID = process.env.IPC_SERVER_ID as string;
-
-/**
- * @summary Send a log debug message to the IPC server
- */
-function log(message: string) {
-	ipc.of[IPC_SERVER_ID].emit('log', message);
-}
-
-/**
- * @summary Terminate the child writer process
- */
-async function terminate(exitCode: number) {
-	ipc.disconnect(IPC_SERVER_ID);
-	await cleanupTmpFiles(Date.now(), DECOMPRESSED_IMAGE_PREFIX);
-	process.nextTick(() => {
-		process.exit(exitCode || SUCCESS);
-	});
-}
-
-/**
- * @summary Handle a child writer error
- */
-async function handleError(error: Error) {
-	ipc.of[IPC_SERVER_ID].emit('error', toJSON(error));
-	await delay(DISCONNECT_DELAY);
-	await terminate(GENERAL_ERROR);
-}
-
-export interface FlashError extends Error {
-	description: string;
-	device: string;
-	code: string;
-}
-
-export interface WriteResult {
-	bytesWritten?: number;
-	devices?: {
-		failed: number;
-		successful: number;
-	};
-	errors: FlashError[];
-	sourceMetadata?: Metadata;
-}
-
-export interface FlashResults extends WriteResult {
-	skip?: boolean;
-	cancelled?: boolean;
-}
-
-/**
- * @summary writes the source to the destinations and validates the writes
- * @param {SourceDestination} source - source
- * @param {SourceDestination[]} destinations - destinations
- * @param {Boolean} verify - whether to validate the writes or not
- * @param {Boolean} autoBlockmapping - whether to trim ext partitions before writing
- * @param {Function} onProgress - function to call on progress
- * @param {Function} onFail - function to call on fail
- * @returns {Promise<{ bytesWritten, devices, errors} >}
- */
-async function writeAndValidate({
-	source,
-	destinations,
-	verify,
-	autoBlockmapping,
-	decompressFirst,
-	onProgress,
-	onFail,
-}: {
-	source: SourceDestination;
-	destinations: BlockDevice[];
-	verify: boolean;
-	autoBlockmapping: boolean;
-	decompressFirst: boolean;
-	onProgress: OnProgressFunction;
-	onFail: OnFailFunction;
-}): Promise<WriteResult> {
-	const { sourceMetadata, failures, bytesWritten } = await decompressThenFlash({
-		source,
-		destinations,
-		onFail,
-		onProgress,
-		verify,
-		trim: autoBlockmapping,
-		numBuffers: Math.min(
-			2 + (destinations.length - 1) * 32,
-			256,
-			Math.floor(totalmem() / 1024 ** 2 / 8),
-		),
-		decompressFirst,
-	});
-	const result: WriteResult = {
-		bytesWritten,
-		devices: {
-			failed: failures.size,
-			successful: destinations.length - failures.size,
-		},
-		errors: [],
-		sourceMetadata,
-	};
-	for (const [destination, error] of failures) {
-		const err = error as FlashError;
-		const drive = destination as BlockDevice;
-		err.device = drive.device;
-		err.description = drive.description;
-		result.errors.push(err);
-	}
-	return result;
-}
-
-interface WriteOptions {
-	image: SourceMetadata;
-	destinations: DrivelistDrive[];
-	autoBlockmapping: boolean;
-	decompressFirst: boolean;
-	SourceType: string;
-	httpRequest?: any;
-}
-
-ipc.connectTo(IPC_SERVER_ID, () => {
-	// Remove leftover tmp files older than 1 hour
-	cleanupTmpFiles(Date.now() - 60 * 60 * 1000);
-	process.once('uncaughtException', handleError);
-
-	// Gracefully exit on the following cases. If the parent
-	// process detects that child exit successfully but
-	// no flashing information is available, then it will
-	// assume that the child died halfway through.
-
-	process.once('SIGINT', async () => {
-		await terminate(SUCCESS);
-	});
-
-	process.once('SIGTERM', async () => {
-		await terminate(SUCCESS);
-	});
-
-	// The IPC server failed. Abort.
-	ipc.of[IPC_SERVER_ID].on('error', async () => {
-		await terminate(SUCCESS);
-	});
-
-	// The IPC server was disconnected. Abort.
-	ipc.of[IPC_SERVER_ID].on('disconnect', async () => {
-		await terminate(SUCCESS);
-	});
-
-	ipc.of[IPC_SERVER_ID].on('write', async (options: WriteOptions) => {
-		/**
-		 * @summary Progress handler
-		 * @param {Object} state - progress state
-		 * @example
-		 * writer.on('progress', onProgress)
-		 */
-		const onProgress = (state: MultiDestinationProgress) => {
-			ipc.of[IPC_SERVER_ID].emit('state', state);
-		};
-
-		let exitCode = SUCCESS;
-
-		/**
-		 * @summary Abort handler
-		 * @example
-		 * writer.on('abort', onAbort)
-		 */
-		const onAbort = async () => {
-			log('Abort');
-			ipc.of[IPC_SERVER_ID].emit('abort');
-			await delay(DISCONNECT_DELAY);
-			await terminate(exitCode);
-		};
-
-		const onSkip = async () => {
-			log('Skip validation');
-			ipc.of[IPC_SERVER_ID].emit('skip');
-			await delay(DISCONNECT_DELAY);
-			await terminate(exitCode);
-		};
-
-		ipc.of[IPC_SERVER_ID].on('cancel', onAbort);
-
-		ipc.of[IPC_SERVER_ID].on('skip', onSkip);
-
-		/**
-		 * @summary Failure handler (non-fatal errors)
-		 * @param {SourceDestination} destination - destination
-		 * @param {Error} error - error
-		 * @example
-		 * writer.on('fail', onFail)
-		 */
-		const onFail = (destination: SourceDestination, error: Error) => {
-			ipc.of[IPC_SERVER_ID].emit('fail', {
-				// TODO: device should be destination
-				// @ts-ignore (destination.drive is private)
-				device: destination.drive,
-				error: toJSON(error),
-			});
-		};
-
-		const destinations = options.destinations.map((d) => d.device);
-		const imagePath = options.image.path;
-		log(`Image: ${imagePath}`);
-		log(`Devices: ${destinations.join(', ')}`);
-		log(`Auto blockmapping: ${options.autoBlockmapping}`);
-		log(`Decompress first: ${options.decompressFirst}`);
-		const dests = options.destinations.map((destination) => {
-			return new BlockDevice({
-				drive: destination,
-				unmountOnSuccess: true,
-				write: true,
-				direct: true,
-			});
-		});
-		const { SourceType } = options;
-		try {
-			let source;
-			if (options.image.drive) {
-				source = new BlockDevice({
-					drive: options.image.drive,
-					direct: !options.autoBlockmapping,
-				});
-			} else {
-				if (SourceType === File.name) {
-					source = new File({
-						path: imagePath,
-					});
-				} else {
-					const decodedImagePath = decodeURIComponent(imagePath);
-					if (isJson(decodedImagePath)) {
-						const imagePathObject = JSON.parse(decodedImagePath);
-						source = new Http({
-							url: imagePathObject.url,
-							avoidRandomAccess: true,
-							axiosInstance: axios.create(_.omit(imagePathObject, ['url'])),
-							auth: options.image.auth,
-						});
-					} else {
-						source = new Http({
-							url: imagePath,
-							avoidRandomAccess: true,
-							auth: options.image.auth,
-						});
-					}
-				}
-			}
-			const results = await writeAndValidate({
-				source,
-				destinations: dests,
-				verify: true,
-				autoBlockmapping: options.autoBlockmapping,
-				decompressFirst: options.decompressFirst,
-				onProgress,
-				onFail,
-			});
-			log(`Finish: ${results.bytesWritten}`);
-			results.errors = results.errors.map((error) => {
-				return toJSON(error);
-			});
-			ipc.of[IPC_SERVER_ID].emit('done', { results });
-			await delay(DISCONNECT_DELAY);
-			await terminate(exitCode);
-		} catch (error: any) {
-			exitCode = GENERAL_ERROR;
-			ipc.of[IPC_SERVER_ID].emit('error', toJSON(error));
-		}
-	});
-
-	ipc.of[IPC_SERVER_ID].on('connect', () => {
-		log(
-			`Successfully connected to IPC server: ${IPC_SERVER_ID}, socket root ${ipc.config.socketRoot}`,
-		);
-		ipc.of[IPC_SERVER_ID].emit('ready', {});
-	});
-});

lib/gui/webapi.ts

@@ -0,0 +1,15 @@
+//
+// Anything exported from this module will become available to the
+// renderer process via preload. They're accessible as `window.etcher.foo()`.
+//
+
+import { ipcRenderer } from 'electron';
+
+// FIXME: this is a workaround for the renderer to be able to find the etcher-util
+// binary. We should instead export a function that asks the main process to launch
+// the binary itself.
+export async function getEtcherUtilPath(): Promise<string> {
+	const utilPath = await ipcRenderer.invoke('get-util-path');
+	console.log(utilPath);
+	return utilPath;
+}

lib/shared/catalina-sudo/sudo.ts

@@ -1,72 +0,0 @@
-/*
- * Copyright 2019 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 { execFile } from 'child_process';
-import { join } from 'path';
-import { env } from 'process';
-import { promisify } from 'util';
-
-import { getAppPath } from '../utils';
-import { supportedLocales } from '../../gui/app/i18n';
-
-const execFileAsync = promisify(execFile);
-
-const SUCCESSFUL_AUTH_MARKER = 'AUTHENTICATION SUCCEEDED';
-const EXPECTED_SUCCESSFUL_AUTH_MARKER = `${SUCCESSFUL_AUTH_MARKER}\n`;
-
-export async function sudo(
-	command: string,
-): Promise<{ cancelled: boolean; stdout?: string; stderr?: string }> {
-	try {
-		let lang = Intl.DateTimeFormat().resolvedOptions().locale;
-		lang = lang.substr(0, 2);
-		if (supportedLocales.indexOf(lang) > -1) {
-			// language should be present
-		} else {
-			// fallback to eng
-			lang = 'en';
-		}
-
-		const { stdout, stderr } = await execFileAsync(
-			'sudo',
-			['--askpass', 'sh', '-c', `echo ${SUCCESSFUL_AUTH_MARKER} && ${command}`],
-			{
-				encoding: 'utf8',
-				env: {
-					PATH: env.PATH,
-					SUDO_ASKPASS: join(
-						getAppPath(),
-						__dirname,
-						`sudo-askpass.osascript-${lang}.js`,
-					),
-				},
-			},
-		);
-		return {
-			cancelled: false,
-			stdout: stdout.slice(EXPECTED_SUCCESSFUL_AUTH_MARKER.length),
-			stderr,
-		};
-	} catch (error: any) {
-		if (error.code === 1) {
-			if (!error.stdout.startsWith(EXPECTED_SUCCESSFUL_AUTH_MARKER)) {
-				return { cancelled: true };
-			}
-			error.stdout = error.stdout.slice(EXPECTED_SUCCESSFUL_AUTH_MARKER.length);
-		}
-		throw error;
-	}
-}

lib/shared/drive-constraints.ts

@@ -14,12 +14,12 @@
  * limitations under the License.
  */
 
-import { Drive } from 'drivelist';
-import * as _ from 'lodash';
+import type { Drive } from 'drivelist';
+import { isNil } from 'lodash';
 import * as pathIsInside from 'path-is-inside';
 
 import * as messages from './messages';
-import { SourceMetadata } from '../gui/app/components/source-selector/source-selector';
+import type { SourceMetadata } from './typings/source-selector';
 
 /**
  * @summary The default unknown size for things such as images and drives
@@ -210,8 +210,8 @@ export function getDriveImageCompatibilityStatuses(
 		});
 	}
 	if (
-		!_.isNil(drive) &&
-		!_.isNil(drive.size) &&
+		!isNil(drive) &&
+		!isNil(drive.size) &&
 		!isDriveLargeEnough(drive, image)
 	) {
 		statusList.push(statuses.small);
@@ -229,7 +229,7 @@ export function getDriveImageCompatibilityStatuses(
 
 		if (
 			image !== undefined &&
-			!_.isNil(drive) &&
+			!isNil(drive) &&
 			!isDriveSizeRecommended(drive, image)
 		) {
 			statusList.push(statuses.sizeNotRecommended);

lib/shared/messages.ts

@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import { Dictionary } from 'lodash';
+import type { Dictionary } from 'lodash';
 import { outdent } from 'outdent';
-import * as prettyBytes from 'pretty-bytes';
+import prettyBytes from 'pretty-bytes';
 import '../gui/app/i18n';
 import * as i18next from 'i18next';
 
@@ -164,11 +164,11 @@ export const error = {
 				? i18next.t('message.toDrive', {
 						description: drives[0].description,
 						name: drives[0].displayName,
-				  })
+					})
 				: i18next.t('message.toTarget', {
 						count: drives.length,
 						num: drives.length,
-				  });
+					});
 		return i18next.t('message.flashError', {
 			image: imageBasename,
 			targets: target,

lib/shared/permissions.ts

@@ -14,41 +14,27 @@
  * limitations under the License.
  */
 
-import * as childProcess from 'child_process';
+/**
+ * TODO:
+ * This is convoluted and needlessly complex. It should be simplified and modernized.
+ * The environment variable setting and escaping should be greatly simplified by letting {linux|catalina}-sudo handle that.
+ * We shouldn't need to write a script to a file and then execute it. We should be able to forwatd the command to the sudo code directly.
+ */
+
+import { spawn, exec } from 'child_process';
 import { withTmpFile } from 'etcher-sdk/build/tmp';
 import { promises as fs } from 'fs';
+import { promisify } from 'util';
 import * as _ from 'lodash';
 import * as os from 'os';
 import * as semver from 'semver';
-import * as sudoPrompt from '@balena/sudo-prompt';
-import { promisify } from 'util';
 
-import { sudo as catalinaSudo } from './catalina-sudo/sudo';
+import { sudo as darwinSudo } from './sudo/darwin';
+import { sudo as linuxSudo } from './sudo/linux';
+import { sudo as winSudo } from './sudo/windows';
 import * as errors from './errors';
 
-const execAsync = promisify(childProcess.exec);
-const execFileAsync = promisify(childProcess.execFile);
-
-type Std = string | Buffer | undefined;
-
-function sudoExecAsync(
-	cmd: string,
-	options: { name: string },
-): Promise<{ stdout: Std; stderr: Std }> {
-	return new Promise((resolve, reject) => {
-		sudoPrompt.exec(
-			cmd,
-			options,
-			(error: Error | undefined, stdout: Std, stderr: Std) => {
-				if (error) {
-					reject(error);
-				} else {
-					resolve({ stdout, stderr });
-				}
-			},
-		);
-	});
-}
+const execAsync = promisify(exec);
 
 /**
  * @summary The user id of the UNIX "superuser"
@@ -70,14 +56,14 @@ export async function isElevated(): Promise<boolean> {
 		}
 		return true;
 	}
-	return process.geteuid() === UNIX_SUPERUSER_USER_ID;
+	return process.geteuid!() === UNIX_SUPERUSER_USER_ID;
 }
 
 /**
  * @summary Check if the current process is running with elevated permissions
  */
 export function isElevatedUnixSync(): boolean {
-	return process.geteuid() === UNIX_SUPERUSER_USER_ID;
+	return process.geteuid!() === UNIX_SUPERUSER_USER_ID;
 }
 
 function escapeSh(value: any): string {
@@ -125,10 +111,11 @@ export function createLaunchScript(
 async function elevateScriptWindows(
 	path: string,
 	name: string,
+	env: any,
 ): Promise<{ cancelled: false }> {
 	// '&' needs to be escaped here (but not when written to a .cmd file)
 	const cmd = ['cmd', '/c', escapeParamCmd(path).replace(/&/g, '^&')].join(' ');
-	await sudoExecAsync(cmd, { name });
+	await winSudo(cmd, name, env);
 	return { cancelled: false };
 }
 
@@ -137,7 +124,7 @@ async function elevateScriptUnix(
 	name: string,
 ): Promise<{ cancelled: boolean }> {
 	const cmd = ['bash', escapeSh(path)].join(' ');
-	await sudoExecAsync(cmd, { name });
+	await linuxSudo(cmd, { name });
 	return { cancelled: false };
 }
 
@@ -146,7 +133,7 @@ async function elevateScriptCatalina(
 ): Promise<{ cancelled: boolean }> {
 	const cmd = ['bash', escapeSh(path)].join(' ');
 	try {
-		const { cancelled } = await catalinaSudo(cmd);
+		const { cancelled } = await darwinSudo(cmd);
 		return { cancelled };
 	} catch (error: any) {
 		throw errors.createError({ title: error.stderr });
@@ -156,13 +143,13 @@ async function elevateScriptCatalina(
 export async function elevateCommand(
 	command: string[],
 	options: {
-		environment: _.Dictionary<string | undefined>;
+		env: _.Dictionary<string | undefined>;
 		applicationName: string;
 	},
 ): Promise<{ cancelled: boolean }> {
 	if (await isElevated()) {
-		await execFileAsync(command[0], command.slice(1), {
-			env: options.environment,
+		spawn(command[0], command.slice(1), {
+			env: options.env,
 		});
 		return { cancelled: false };
 	}
@@ -170,7 +157,7 @@ export async function elevateCommand(
 	const launchScript = createLaunchScript(
 		command[0],
 		command.slice(1),
-		options.environment,
+		options.env,
 	);
 	return await withTmpFile(
 		{
@@ -181,7 +168,7 @@ export async function elevateCommand(
 		async ({ path }) => {
 			await fs.writeFile(path, launchScript);
 			if (isWindows) {
-				return elevateScriptWindows(path, options.applicationName);
+				return elevateScriptWindows(path, options.applicationName, options.env);
 			}
 			if (
 				os.platform() === 'darwin' &&
@@ -191,7 +178,7 @@ export async function elevateCommand(
 				return elevateScriptCatalina(path);
 			}
 			try {
-				return await elevateScriptUnix(path, options.applicationName);
+				return elevateScriptUnix(path, options.applicationName);
 			} catch (error: any) {
 				// We're hardcoding internal error messages declared by `sudo-prompt`.
 				// There doesn't seem to be a better way to handle these errors, so

lib/shared/sudo/darwin.ts

@@ -0,0 +1,102 @@
+/*
+ * Copyright 2019 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 { spawn } from 'child_process';
+import { join } from 'path';
+import { env } from 'process';
+// import { promisify } from "util";
+
+import { supportedLocales } from '../../gui/app/i18n';
+
+// const execFileAsync = promisify(execFile);
+
+const SUCCESSFUL_AUTH_MARKER = 'AUTHENTICATION SUCCEEDED';
+const EXPECTED_SUCCESSFUL_AUTH_MARKER = `${SUCCESSFUL_AUTH_MARKER}\n`;
+
+function getAskPassScriptPath(lang: string): string {
+	if (process.env.NODE_ENV === 'development') {
+		// Force webpack's hand to bundle the script.
+		return require.resolve(`./sudo-askpass.osascript-${lang}.js`);
+	}
+	// Otherwise resolve the script relative to resources path.
+	return join(process.resourcesPath, `sudo-askpass.osascript-${lang}.js`);
+}
+
+export async function sudo(
+	command: string,
+): Promise<{ cancelled: boolean; stdout?: string; stderr?: string }> {
+	try {
+		let lang = Intl.DateTimeFormat().resolvedOptions().locale;
+		lang = lang.substr(0, 2);
+		if (supportedLocales.indexOf(lang) > -1) {
+			// language should be present
+		} else {
+			// fallback to eng
+			lang = 'en';
+		}
+
+		const elevateProcess = spawn(
+			'sudo',
+			['--askpass', 'sh', '-c', `echo ${SUCCESSFUL_AUTH_MARKER} && ${command}`],
+			{
+				// encoding: "utf8",
+				env: {
+					PATH: env.PATH,
+					SUDO_ASKPASS: getAskPassScriptPath(lang),
+				},
+			},
+		);
+
+		let elevated = 'pending';
+
+		elevateProcess.stdout.on('data', (data) => {
+			if (data.toString().includes(SUCCESSFUL_AUTH_MARKER)) {
+				// if the first data comming out of the sudo command is the expected marker we resolve the promise
+				elevated = 'granted';
+			} else {
+				// if the first data comming out of the sudo command is not the expected marker we reject the promise
+				elevated = 'rejected';
+			}
+		});
+
+		// we don't spawn or read stdout in the promise otherwise resolving stop the process
+		return new Promise((resolve, reject) => {
+			const checkElevation = setInterval(() => {
+				if (elevated === 'granted') {
+					clearInterval(checkElevation);
+					resolve({ cancelled: false });
+				} else if (elevated === 'rejected') {
+					clearInterval(checkElevation);
+					resolve({ cancelled: true });
+				}
+			}, 300);
+
+			// if the elevation didn't occured in 30 seconds we reject the promise
+			setTimeout(() => {
+				clearInterval(checkElevation);
+				reject(new Error('Elevation timeout'));
+			}, 30000);
+		});
+	} catch (error: any) {
+		if (error.code === 1) {
+			if (!error.stdout.startsWith(EXPECTED_SUCCESSFUL_AUTH_MARKER)) {
+				return { cancelled: true };
+			}
+			error.stdout = error.stdout.slice(EXPECTED_SUCCESSFUL_AUTH_MARKER.length);
+		}
+		throw error;
+	}
+}

lib/shared/sudo/linux.ts

@@ -0,0 +1,142 @@
+/* 
+ * This is heavily inspired (read: a ripof) https://github.com/balena-io-modules/sudo-prompt
+ * Which was a fork of https://github.com/jorangreef/sudo-prompt
+ * 
+ * This and the original code was released under The MIT License (MIT)
+ * 
+ * Copyright (c) 2015 Joran Dirk Greef
+ * Copyright (c) 2024 Balena
+ * 
+    The MIT License (MIT)
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE.
+ */
+
+import { spawn } from 'child_process';
+import { access, constants } from 'fs/promises';
+import { env } from 'process';
+
+// const execFileAsync = promisify(execFile);
+
+const SUCCESSFUL_AUTH_MARKER = 'AUTHENTICATION SUCCEEDED';
+
+/** Check for kdesudo or pkexec */
+function checkLinuxBinary() {
+	// eslint-disable-next-line no-async-promise-executor
+	return new Promise(async (resolve, reject) => {
+		// We used to prefer gksudo over pkexec since it enabled a better prompt.
+		// However, gksudo cannot run multiple commands concurrently.
+
+		const paths = ['/usr/bin/kdesudo', '/usr/bin/pkexec'];
+		for (const path of paths) {
+			try {
+				// check if the file exist and is executable
+				await access(path, constants.X_OK);
+				resolve(path);
+			} catch (error: any) {
+				continue;
+			}
+		}
+		reject('Unable to find pkexec or kdesudo.');
+	});
+}
+
+function escapeDoubleQuotes(escapeString: string) {
+	return escapeString.replace(/"/g, '\\"');
+}
+
+export async function sudo(
+	command: string,
+	{ name }: { name: string },
+): Promise<{ cancelled: boolean; stdout?: string; stderr?: string }> {
+	const linuxBinary: string = (await checkLinuxBinary()) as string;
+	if (!linuxBinary) {
+		throw new Error('Unable to find pkexec or kdesudo.');
+	}
+
+	const parameters = [];
+
+	if (/kdesudo/i.test(linuxBinary)) {
+		parameters.push(
+			'--comment',
+			`"${name} wants to make changes.
+			Enter your password to allow this."`,
+		);
+		parameters.push('-d'); // Do not show the command to be run in the dialog.
+		parameters.push('--');
+	} else if (/pkexec/i.test(linuxBinary)) {
+		parameters.push('--disable-internal-agent');
+	}
+
+	parameters.push('/bin/bash');
+	parameters.push('-c');
+	parameters.push(
+		`echo ${SUCCESSFUL_AUTH_MARKER} && ${escapeDoubleQuotes(command)}`,
+	);
+
+	const elevateProcess = spawn(linuxBinary, parameters, {
+		// encoding: "utf8",
+		env: {
+			PATH: env.PATH,
+		},
+	});
+
+	let elevated = '';
+
+	elevateProcess.stdout.on('data', (data) => {
+		// console.log(`stdout: ${data.toString()}`);
+		if (data.toString().includes(SUCCESSFUL_AUTH_MARKER)) {
+			// if the first data comming out of the sudo command is the expected marker we resolve the promise
+			elevated = 'granted';
+		} else {
+			// if the first data comming out of the sudo command is not the expected marker we reject the promise
+			elevated = 'refused';
+		}
+	});
+
+	// elevateProcess.stderr.on('data', (data) => {
+	// 	// console.log(`stderr: ${data.toString()}`);
+	// 	// if (data.toString().includes(SUCCESSFUL_AUTH_MARKER)) {
+	// 	// 	// if the first data comming out of the sudo command is the expected marker we resolve the promise
+	// 	// 	elevated = 'granted';
+	// 	// } else {
+	// 	// 	// if the first data comming out of the sudo command is not the expected marker we reject the promise
+	// 	// 	elevated = 'refused';
+	// 	// }
+	// });
+
+	// we don't spawn or read stdout in the promise otherwise resolving stop the process
+	return new Promise((resolve, reject) => {
+		const checkElevation = setInterval(() => {
+			if (elevated === 'granted') {
+				clearInterval(checkElevation);
+				resolve({ cancelled: false });
+			} else if (elevated === 'refused') {
+				clearInterval(checkElevation);
+				resolve({ cancelled: true });
+			}
+		}, 300);
+
+		// if the elevation didn't occured in 30 seconds we reject the promise
+		setTimeout(() => {
+			clearInterval(checkElevation);
+			reject(new Error('Elevation timeout'));
+		}, 30000);
+	});
+}

lib/shared/sudo/windows.ts

@@ -0,0 +1,218 @@
+/* 
+ * This is heavily inspired (read: a ripof) https://github.com/balena-io-modules/sudo-prompt
+ * Which was a fork of https://github.com/jorangreef/sudo-prompt
+ * 
+ * This and the original code was released under The MIT License (MIT)
+ * 
+ * Copyright (c) 2015 Joran Dirk Greef
+ * Copyright (c) 2024 Balena
+ * 
+    The MIT License (MIT)
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE.
+ */
+
+import { spawn } from 'child_process';
+// import { env } from 'process';
+import { tmpdir } from 'os';
+import { v4 as uuidv4 } from 'uuid';
+import { join, sep } from 'path';
+import { mkdir, writeFile, copyFile, readFile } from 'fs/promises';
+
+/**
+ * TODO:
+ * Migrate, modernize and clenup the windows elevation code from the old @balena/sudo-prompt package in a similar way to linux-sudo.ts and catalina-sudo files.
+ */
+
+export async function sudo(
+	command: string,
+	_name: string,
+	env: any,
+): Promise<{ cancelled: boolean; stdout?: string; stderr?: string }> {
+	const uuid = uuidv4();
+
+	const temp = tmpdir();
+	if (!temp) {
+		throw new Error('os.tmpdir() not defined.');
+	}
+
+	const tmpFolder = join(temp, uuid);
+
+	if (/"/.test(tmpFolder)) {
+		// We expect double quotes to be reserved on Windows.
+		// Even so, we test for this and abort if they are present.
+		throw new Error('instance.path cannot contain double-quotes.');
+	}
+
+	const executeScriptPath = join(tmpFolder, 'execute.bat');
+	const commandScriptPath = join(tmpFolder, 'command.bat');
+	const stdoutPath = join(tmpFolder, 'stdout');
+	const stderrPath = join(tmpFolder, 'stderr');
+	const statusPath = join(tmpFolder, 'status');
+
+	const SUCCESSFUL_AUTH_MARKER = 'AUTHENTICATION SUCCEEDED';
+
+	try {
+		await mkdir(tmpFolder);
+
+		// WindowsWriteExecuteScript(instance, end)
+		const executeScript = `
+      @echo off\r\n
+      call "${commandScriptPath}" > "${stdoutPath}" 2> "${stderrPath}"\r\n
+      (echo %ERRORLEVEL%) > "${statusPath}"
+    `;
+
+		await writeFile(executeScriptPath, executeScript, 'utf-8');
+
+		// WindowsWriteCommandScript(instance, end)
+		const cwd = process.cwd();
+		if (/"/.test(cwd)) {
+			// We expect double quotes to be reserved on Windows.
+			// Even so, we test for this and abort if they are present.
+			throw new Error('process.cwd() cannot contain double-quotes.');
+		}
+
+		const commandScriptArray = [];
+		commandScriptArray.push('@echo off');
+		// Set code page to UTF-8:
+		commandScriptArray.push('chcp 65001>nul');
+		// Preserve current working directory:
+		// We pass /d as an option in case the cwd is on another drive (issue 70).
+		commandScriptArray.push(`cd /d "${cwd}"`);
+		// Export environment variables:
+		for (const key in env) {
+			// "The characters <, >, |, &, ^ are special command shell characters, and
+			// they must be preceded by the escape character (^) or enclosed in
+			// quotation marks. If you use quotation marks to enclose a string that
+			// contains one of the special characters, the quotation marks are set as
+			// part of the environment variable value."
+			// In other words, Windows assigns everything that follows the equals sign
+			// to the value of the variable, whereas Unix systems ignore double quotes.
+			if (Object.prototype.hasOwnProperty.call(env, key)) {
+				const value = env[key];
+				commandScriptArray.push(
+					`set ${key}=${value!.replace(/([<>\\|&^])/g, '^$1')}`,
+				);
+			}
+		}
+		commandScriptArray.push(`echo ${SUCCESSFUL_AUTH_MARKER}`);
+		commandScriptArray.push(command);
+		await writeFile(
+			commandScriptPath,
+			commandScriptArray.join('\r\n'),
+			'utf-8',
+		);
+
+		// WindowsCopyCmd(instance, end)
+		if (windowsNeedsCopyCmd(tmpFolder)) {
+			// Work around https://github.com/jorangreef/sudo-prompt/issues/97
+			// Powershell can't properly escape amperstands in paths.
+			// We work around this by copying cmd.exe in our temporary folder and running
+			// it from here (see WindowsElevate below).
+			// That way, we don't have to pass the path containing the amperstand at all.
+			// A symlink would probably work too but you have to be an administrator in
+			// order to create symlinks on Windows.
+			await copyFile(
+				join(process.env.SystemRoot!, 'System32', 'cmd.exe'),
+				join(tmpFolder, 'cmd.exe'),
+			);
+		}
+
+		// WindowsElevate(instance, end)
+		// We used to use this for executing elevate.vbs:
+		// var command = 'cscript.exe //NoLogo "' + instance.pathElevate + '"';
+		const spawnCommand = [];
+		// spawnCommand.push("powershell.exe") // as we use spawn this one is out of the array
+		spawnCommand.push('Start-Process');
+		spawnCommand.push('-FilePath');
+		const options: any = { encoding: 'utf8' };
+		if (windowsNeedsCopyCmd(tmpFolder)) {
+			// Node.path.join('.', 'cmd.exe') would return 'cmd.exe'
+			spawnCommand.push(['.', 'cmd.exe'].join(sep));
+			spawnCommand.push('-ArgumentList');
+			spawnCommand.push('"/C","execute.bat"');
+			options.cwd = tmpFolder;
+		} else {
+			// Escape characters for cmd using double quotes:
+			// Escape characters for PowerShell using single quotes:
+			// Escape single quotes for PowerShell using backtick:
+			// See: https://ss64.com/ps/syntax-esc.html
+			spawnCommand.push(`'${executeScriptPath.replace(/'/g, "`'")}'`);
+		}
+		spawnCommand.push('-WindowStyle hidden');
+		spawnCommand.push('-Verb runAs');
+
+		spawn('powershell.exe', spawnCommand);
+
+		// setTimeout(() => {elevated = "granted"}, 5000)
+
+		// we don't spawn or read stdout in the promise otherwise resolving stop the process
+		return new Promise((resolve, reject) => {
+			const checkElevation = setInterval(async () => {
+				try {
+					const result = await readFile(stdoutPath, 'utf-8');
+					const error = await readFile(stderrPath, 'utf-8');
+
+					if (error && error !== '') {
+						throw new Error(error);
+					}
+
+					// TODO: should track something more generic
+					if (result.includes(SUCCESSFUL_AUTH_MARKER)) {
+						clearInterval(checkElevation);
+						resolve({ cancelled: false });
+					}
+				} catch (error) {
+					console.log(
+						'Error while reading flasher elevation script output',
+						error,
+					);
+				}
+			}, 1000);
+
+			// if the elevation didn't occured in 30 seconds we reject the promise
+			setTimeout(() => {
+				clearInterval(checkElevation);
+				reject(new Error('Elevation timeout'));
+			}, 30000);
+		});
+
+		// WindowsWaitForStatus(instance, end)
+
+		// WindowsResult(instance, end)
+	} catch (error) {
+		throw new Error(`Can't elevate process ${error}`);
+	} finally {
+		// TODO: cleanup
+		//   // Remove(instance.path, function (errorRemove) {
+		//   // if (error) return callback(error)
+		//   // if (errorRemove) return callback(errorRemove)
+		//   // callback(undefined, stdout, stderr)
+	}
+}
+
+function windowsNeedsCopyCmd(path: string) {
+	const specialChars = ['&', '`', "'", '"', '<', '>', '|', '^'];
+	for (const specialChar of specialChars) {
+		if (path.includes(specialChar)) {
+			return true;
+		}
+	}
+	return false;
+}

lib/shared/typings/source-selector.ts

@@ -0,0 +1,23 @@
+import type { GPTPartition, MBRPartition } from 'partitioninfo';
+import type { sourceDestination } from 'etcher-sdk';
+import type { DrivelistDrive } from '../drive-constraints';
+
+export type Source = 'File' | 'BlockDevice' | 'Http';
+
+export interface SourceMetadata extends sourceDestination.Metadata {
+	hasMBR?: boolean;
+	partitions?: MBRPartition[] | GPTPartition[];
+	path: string;
+	displayName: string;
+	description: string;
+	SourceType: Source;
+	drive?: DrivelistDrive;
+	extension?: string;
+	archiveExtension?: string;
+	auth?: Authentication;
+}
+
+export interface Authentication {
+	username: string;
+	password: string;
+}

lib/shared/utils.ts

@@ -14,9 +14,6 @@
  * limitations under the License.
  */
 
-import axios from 'axios';
-import { Dictionary } from 'lodash';
-
 import * as errors from './errors';
 
 export function isValidPercentage(percentage: any): boolean {
@@ -38,19 +35,6 @@ export async function delay(duration: number): Promise<void> {
 	});
 }
 
-export function getAppPath(): string {
-	return (
-		(require('electron').app || require('@electron/remote').app)
-			.getAppPath()
-			// 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.
-			.replace(/\.asar$/, () =>
-				process.platform === 'darwin' ? '-' + process.arch : '',
-			)
-	);
-}
-
 export function isJson(jsonString: string) {
 	try {
 		JSON.parse(jsonString);

lib/util/api.ts

@@ -0,0 +1,292 @@
+/*
+ * 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 { WebSocketServer } from 'ws';
+import type { Dictionary } from 'lodash';
+import { values } from 'lodash';
+
+import type { MultiDestinationProgress } from 'etcher-sdk/build/multi-write';
+
+import { toJSON } from '../shared/errors';
+import { GENERAL_ERROR, SUCCESS } from '../shared/exit-codes';
+import type { WriteOptions } from './types/types';
+import { write, cleanup } from './child-writer';
+import { startScanning } from './scanner';
+import { getSourceMetadata } from './source-metadata';
+import type { DrivelistDrive } from '../shared/drive-constraints';
+import type { SourceMetadata } from '../shared/typings/source-selector';
+
+const ETCHER_SERVER_ADDRESS = process.env.ETCHER_SERVER_ADDRESS as string;
+const ETCHER_SERVER_PORT = process.env.ETCHER_SERVER_PORT as string;
+// const ETCHER_SERVER_ID = process.env.ETCHER_SERVER_ID as string;
+
+const ETCHER_TERMINATE_TIMEOUT: number = parseInt(
+	process.env.ETCHER_TERMINATE_TIMEOUT ?? '10000',
+	10,
+);
+
+const host = ETCHER_SERVER_ADDRESS ?? '127.0.0.1';
+const port = parseInt(ETCHER_SERVER_PORT || '3434', 10);
+// const path = ETCHER_SERVER_ID || "etcher";
+
+// TODO: use the path as cheap authentication
+
+const wss = new WebSocketServer({ host, port });
+
+// hold emit functions
+let emitLog: (message: string) => void | undefined;
+let emitState: (state: MultiDestinationProgress) => void | undefined;
+let emitFail: (data: any) => void | undefined;
+let emitDrives: (drives: Dictionary<DrivelistDrive>) => void | undefined;
+let emitSourceMetadata: (
+	sourceMetadata: SourceMetadata | Record<string, never>,
+) => void | undefined; // Record<string, never> means an empty object
+
+// Terminate the child process
+async function terminate(exitCode?: number) {
+	await cleanup(Date.now());
+	process.nextTick(() => {
+		process.exit(exitCode || SUCCESS);
+	});
+}
+
+// kill the process if no initila connections or heartbeat for X sec (default 10)
+function setTerminateTimeout() {
+	if (ETCHER_TERMINATE_TIMEOUT > 0) {
+		return setTimeout(() => {
+			console.log(
+				`no connections or heartbeat for ${ETCHER_TERMINATE_TIMEOUT} ms, terminating`,
+			);
+			terminate();
+		}, ETCHER_TERMINATE_TIMEOUT);
+	} else {
+		return null;
+	}
+}
+
+// terminate the process cleanly on SIGINT
+process.once('SIGINT', async () => {
+	await terminate(SUCCESS);
+});
+
+// terminate the process cleanly on SIGTERM
+process.once('SIGTERM', async () => {
+	await terminate(SUCCESS);
+});
+
+let terminateInterval = setTerminateTimeout();
+
+interface EmitLog {
+	emit: (channel: string, message: object | string) => void;
+	log: (message: string) => void;
+}
+
+function setup(): Promise<EmitLog> {
+	return new Promise((resolve, reject) => {
+		wss.on('connection', (ws) => {
+			console.log('connection established... setting up');
+
+			/**
+			 * @summary Send a message to the IPC server
+			 */
+			function emit(type: string, payload?: object | string) {
+				ws.send(JSON.stringify({ type, payload }));
+				// ipc.of[IPC_SERVER_ID].emit("message", { type, payload });
+			}
+
+			/**
+			 * @summary Print logs and send them back to client
+			 */
+			function log(message: string) {
+				console.log(message);
+				emit('log', message);
+			}
+
+			/**
+			 * @summary Handle `errors`
+			 */
+			async function handleError(error: Error) {
+				emit('error', toJSON(error));
+				await terminate(GENERAL_ERROR);
+			}
+
+			/**
+			 * @summary Handle `abort` from client
+			 */
+			const onAbort = async (exitCode: number) => {
+				log('Abort');
+				emit('abort');
+				await terminate(exitCode);
+			};
+
+			/**
+			 * @summary Handle `skip` from client; skip validation
+			 */
+			const onSkip = async (exitCode: number) => {
+				log('Skip validation');
+				emit('skip');
+				await terminate(exitCode);
+			};
+
+			/**
+			 * @summary Handle `write` from client; start writing to the drives
+			 */
+			const onWrite = async (options: WriteOptions) => {
+				log('write requested');
+
+				// Remove leftover tmp files older than 1 hour
+				cleanup(Date.now() - 60 * 60 * 1000);
+
+				let exitCode = SUCCESS;
+
+				// Write to the drives
+				const results = await write(options);
+
+				// handle potential errors from the write process
+				if (results.errors.length > 0) {
+					results.errors = results.errors.map(toJSON);
+					exitCode = GENERAL_ERROR;
+				}
+
+				// send the results back to the client
+				emit('done', { results });
+
+				// terminate this process
+				await terminate(exitCode);
+			};
+
+			/**
+			 * @summary Handle `sourceMetadata` from client; get source metadata
+			 */
+			const onSourceMetadata = async (params: any) => {
+				log('sourceMetadata requested');
+				const { selected, SourceType, auth } = JSON.parse(params);
+				try {
+					const sourceMatadata = await getSourceMetadata(
+						selected,
+						SourceType,
+						auth,
+					);
+					emitSourceMetadata(sourceMatadata);
+				} catch (error: any) {
+					emitFail(error);
+				}
+			};
+
+			// handle uncaught exceptions
+			process.once('uncaughtException', handleError);
+
+			// terminate the process if the connection is closed
+			ws.on('error', async () => {
+				await terminate(SUCCESS);
+			});
+
+			// route messages from the client by `type`
+			const messagesHandler: any = {
+				// terminate the process
+				terminate: () => terminate(SUCCESS),
+
+				/* 
+				 receive a `heartbeat`, reset the terminate timeout
+				 this mechanism ensure the process will be terminated if the client is disconnected
+				*/
+				heartbeat: () => {
+					if (terminateInterval) {
+						clearTimeout(terminateInterval);
+					}
+					terminateInterval = setTerminateTimeout();
+				},
+
+				// resolve the setup promise when the client is ready
+				ready: () => {
+					log('Ready ...');
+					resolve({ emit, log });
+				},
+
+				// start scanning for drives
+				scan: () => {
+					log('Scan requested');
+					startScanning();
+				},
+
+				// route `cancel` from client
+				cancel: () => onAbort(GENERAL_ERROR),
+
+				// route `skip` from client
+				skip: () => onSkip(GENERAL_ERROR),
+
+				// route `write` from client
+				write: async (options: WriteOptions) => onWrite(options),
+
+				// route `sourceMetadata` from client
+				sourceMetadata: async (params: any) => onSourceMetadata(params),
+			};
+
+			// message handler, parse and route messages coming on WS
+			ws.on('message', async (jsonData: any) => {
+				const data = JSON.parse(jsonData);
+				const message = messagesHandler[data.type];
+				if (message) {
+					await message(data.payload);
+				} else {
+					throw new Error(`Unknown message type: ${data.type}`);
+				}
+			});
+
+			// inform the client that the server is ready to receive messages
+			emit('ready', {});
+
+			ws.on('error', (error) => {
+				reject(error);
+			});
+		});
+	});
+}
+
+// setTimeout(() => console.log('wss', wss.address()), 1000);
+console.log('waiting for connection...');
+
+setup().then(({ emit, log }: EmitLog) => {
+	// connection is established, clear initial terminate timeout
+	if (terminateInterval) {
+		clearInterval(terminateInterval);
+	}
+
+	console.log('waiting for instruction...');
+
+	// set the exportable emit functions
+	emitLog = (message) => {
+		log(message);
+	};
+
+	emitState = (state) => {
+		emit('state', state);
+	};
+
+	emitFail = (data) => {
+		emit('fail', data);
+	};
+
+	emitDrives = (drives) => {
+		emit('drives', JSON.stringify(values(drives)));
+	};
+
+	emitSourceMetadata = (sourceMetadata) => {
+		emit('sourceMetadata', JSON.stringify(sourceMetadata));
+	};
+});
+
+export { emitLog, emitState, emitFail, emitDrives, emitSourceMetadata };

lib/util/child-writer.ts

@@ -0,0 +1,199 @@
+/*
+ * Copyright 2023 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.
+ *
+ * This file handles the writer process.
+ */
+
+import type {
+	OnProgressFunction,
+	OnFailFunction,
+	MultiDestinationProgress,
+} from 'etcher-sdk/build/multi-write';
+import {
+	decompressThenFlash,
+	DECOMPRESSED_IMAGE_PREFIX,
+} from 'etcher-sdk/build/multi-write';
+
+import { totalmem } from 'os';
+
+import { cleanupTmpFiles } from 'etcher-sdk/build/tmp';
+
+import type { SourceDestination } from 'etcher-sdk/build/source-destination';
+import { File, Http, BlockDevice } from 'etcher-sdk/build/source-destination';
+
+import type { WriteResult, FlashError, WriteOptions } from './types/types';
+
+import { isJson } from '../shared/utils';
+import { toJSON } from '../shared/errors';
+import axios from 'axios';
+import { omit } from 'lodash';
+import { emitLog, emitState, emitFail } from './api';
+
+async function write(options: WriteOptions) {
+	/**
+	 * @summary Failure handler (non-fatal errors)
+	 * @param {SourceDestination} destination - destination
+	 * @param {Error} error - error
+	 */
+	const onFail = (destination: SourceDestination, error: Error) => {
+		emitFail({
+			// TODO: device should be destination
+
+			// @ts-ignore (destination.drive is private)
+			device: destination.drive,
+			error: toJSON(error),
+		});
+	};
+
+	/**
+	 * @summary Progress handler
+	 * @param {Object} state - progress state
+	 * @example
+	 * writer.on('progress', onProgress)
+	 */
+	const onProgress = (state: MultiDestinationProgress) => {
+		emitState(state);
+	};
+
+	// Write the image to the destinations
+	const destinations = options.destinations.map((d) => d.device);
+	const imagePath = options.image.path;
+	emitLog(`Image: ${imagePath}`);
+	emitLog(`Devices: ${destinations.join(', ')}`);
+	emitLog(`Auto blockmapping: ${options.autoBlockmapping}`);
+	emitLog(`Decompress first: ${options.decompressFirst}`);
+	const dests = options.destinations.map((destination) => {
+		return new BlockDevice({
+			drive: destination,
+			unmountOnSuccess: true,
+			write: true,
+			direct: true,
+		});
+	});
+	const { SourceType } = options;
+	try {
+		let source;
+		if (options.image.drive) {
+			source = new BlockDevice({
+				drive: options.image.drive,
+				direct: !options.autoBlockmapping,
+			});
+		} else {
+			if (SourceType === File.name) {
+				source = new File({
+					path: imagePath,
+				});
+			} else {
+				const decodedImagePath = decodeURIComponent(imagePath);
+				if (isJson(decodedImagePath)) {
+					const imagePathObject = JSON.parse(decodedImagePath);
+					source = new Http({
+						url: imagePathObject.url,
+						avoidRandomAccess: true,
+						axiosInstance: axios.create(omit(imagePathObject, ['url'])),
+						auth: options.image.auth,
+					});
+				} else {
+					source = new Http({
+						url: imagePath,
+						avoidRandomAccess: true,
+						auth: options.image.auth,
+					});
+				}
+			}
+		}
+
+		const results = await writeAndValidate({
+			source,
+			destinations: dests,
+			verify: true,
+			autoBlockmapping: options.autoBlockmapping,
+			decompressFirst: options.decompressFirst,
+			onProgress,
+			onFail,
+		});
+
+		return results;
+	} catch (error: any) {
+		return { errors: [error] };
+	}
+}
+
+/** @summary clean up tmp files */
+export async function cleanup(until: number) {
+	await cleanupTmpFiles(until, DECOMPRESSED_IMAGE_PREFIX);
+}
+
+/**
+ * @summary writes the source to the destinations and validates the writes
+ * @param {SourceDestination} source - source
+ * @param {SourceDestination[]} destinations - destinations
+ * @param {Boolean} verify - whether to validate the writes or not
+ * @param {Boolean} autoBlockmapping - whether to trim ext partitions before writing
+ * @param {Function} onProgress - function to call on progress
+ * @param {Function} onFail - function to call on fail
+ * @returns {Promise<{ bytesWritten, devices, errors }>}
+ */
+async function writeAndValidate({
+	source,
+	destinations,
+	verify,
+	autoBlockmapping,
+	decompressFirst,
+	onProgress,
+	onFail,
+}: {
+	source: SourceDestination;
+	destinations: BlockDevice[];
+	verify: boolean;
+	autoBlockmapping: boolean;
+	decompressFirst: boolean;
+	onProgress: OnProgressFunction;
+	onFail: OnFailFunction;
+}): Promise<WriteResult> {
+	const { sourceMetadata, failures, bytesWritten } = await decompressThenFlash({
+		source,
+		destinations,
+		onFail,
+		onProgress,
+		verify,
+		trim: autoBlockmapping,
+		numBuffers: Math.min(
+			2 + (destinations.length - 1) * 32,
+			256,
+			Math.floor(totalmem() / 1024 ** 2 / 8),
+		),
+		decompressFirst,
+	});
+	const result: WriteResult = {
+		bytesWritten,
+		devices: {
+			failed: failures.size,
+			successful: destinations.length - failures.size,
+		},
+		errors: [],
+		sourceMetadata,
+	};
+	for (const [destination, error] of failures) {
+		const err = error as FlashError;
+		const drive = destination as BlockDevice;
+		err.device = drive.device;
+		err.description = drive.description;
+		result.errors.push(err);
+	}
+	return result;
+}
+
+export { write };

lib/util/drive-scanner.ts

@@ -15,8 +15,8 @@
  */
 
 import * as sdk from 'etcher-sdk';
+import type { Adapter } from 'etcher-sdk/build/scanner/adapters';
 import {
-	Adapter,
 	BlockDeviceAdapter,
 	UsbbootDeviceAdapter,
 } from 'etcher-sdk/build/scanner/adapters';
@@ -30,14 +30,13 @@ const adapters: Adapter[] = [
 
 // Can't use permissions.isElevated() here as it returns a promise and we need to set
 // module.exports = scanner right now.
-if (platform !== 'linux' || geteuid() === 0) {
+if (platform !== 'linux' || (geteuid && geteuid() === 0)) {
 	adapters.push(new UsbbootDeviceAdapter());
 }
 
 if (platform === 'win32') {
 	const {
 		DriverlessDeviceAdapter: driverless,
-		// tslint:disable-next-line:no-var-requires
 	} = require('etcher-sdk/build/scanner/adapters/driverless');
 	adapters.push(new driverless());
 }

lib/util/scanner.ts

@@ -0,0 +1,184 @@
+import { scanner as driveScanner } from './drive-scanner';
+import * as sdk from 'etcher-sdk';
+import type { DrivelistDrive } from '../shared/drive-constraints';
+import outdent from 'outdent';
+import type { Dictionary } from 'lodash';
+import { values, keyBy, padStart } from 'lodash';
+import { emitDrives } from './api';
+
+let availableDrives: DrivelistDrive[] = [];
+
+export function hasAvailableDrives() {
+	return availableDrives.length > 0;
+}
+
+driveScanner.on('error', (error) => {
+	// Stop the drive scanning loop in case of errors,
+	// otherwise we risk presenting the same error over
+	// and over again to the user, while also heavily
+	// spamming our error reporting service.
+	driveScanner.stop();
+
+	console.log('scanner error', error);
+});
+
+function setDrives(drives: Dictionary<DrivelistDrive>) {
+	availableDrives = values(drives);
+	emitDrives(drives);
+}
+
+function getDrives() {
+	return keyBy(availableDrives, 'device');
+}
+
+async function addDrive(drive: Drive) {
+	const preparedDrive = prepareDrive(drive);
+	if (!(await driveIsAllowed(preparedDrive))) {
+		return;
+	}
+	const drives = getDrives();
+	drives[preparedDrive.device] = preparedDrive;
+
+	setDrives(drives);
+}
+
+function removeDrive(drive: Drive) {
+	const preparedDrive = prepareDrive(drive);
+	const drives = getDrives();
+	delete drives[preparedDrive.device];
+	setDrives(drives);
+}
+
+async function driveIsAllowed(drive: {
+	devicePath: string;
+	device: string;
+	raw: string;
+}) {
+	// const driveBlacklist = (await settings.get("driveBlacklist")) || [];
+	const driveBlacklist: any[] = [];
+	return !(
+		driveBlacklist.includes(drive.devicePath) ||
+		driveBlacklist.includes(drive.device) ||
+		driveBlacklist.includes(drive.raw)
+	);
+}
+
+type Drive =
+	| sdk.sourceDestination.BlockDevice
+	| sdk.sourceDestination.UsbbootDrive
+	| sdk.sourceDestination.DriverlessDevice;
+
+function prepareDrive(drive: Drive) {
+	if (drive instanceof sdk.sourceDestination.BlockDevice) {
+		// @ts-ignore (BlockDevice.drive is private)
+		return drive.drive;
+	} else if (drive instanceof sdk.sourceDestination.UsbbootDrive) {
+		// This is a workaround etcher expecting a device string and a size
+
+		// @ts-ignore
+		drive.device = drive.usbDevice.portId;
+		drive.size = null;
+
+		// @ts-ignore
+		drive.progress = 0;
+		drive.disabled = true;
+		drive.on('progress', (progress) => {
+			updateDriveProgress(drive, progress);
+		});
+		return drive;
+	} else if (drive instanceof sdk.sourceDestination.DriverlessDevice) {
+		const description =
+			COMPUTE_MODULE_DESCRIPTIONS[
+				drive.deviceDescriptor.idProduct.toString()
+			] || 'Compute Module';
+		return {
+			device: `${usbIdToString(
+				drive.deviceDescriptor.idVendor,
+			)}:${usbIdToString(drive.deviceDescriptor.idProduct)}`,
+			displayName: 'Missing drivers',
+			description,
+			mountpoints: [],
+			isReadOnly: false,
+			isSystem: false,
+			disabled: true,
+			icon: 'warning',
+			size: null,
+			link: 'https://www.raspberrypi.com/documentation/computers/compute-module.html#flashing-the-compute-module-emmc',
+			linkCTA: 'Install',
+			linkTitle: 'Install missing drivers',
+			linkMessage: outdent`
+				Would you like to download the necessary drivers from the Raspberry Pi Foundation?
+				This will open your browser.
+
+
+				Once opened, download and run the installer from the "Windows Installer" section to install the drivers
+			`,
+		};
+	}
+}
+
+/**
+ * @summary The radix used by USB ID numbers
+ */
+const USB_ID_RADIX = 16;
+
+/**
+ * @summary The expected length of a USB ID number
+ */
+const USB_ID_LENGTH = 4;
+
+/**
+ * @summary Convert a USB id (e.g. product/vendor) to a string
+ *
+ * @example
+ * console.log(usbIdToString(2652))
+ * > '0x0a5c'
+ */
+function usbIdToString(id: number): string {
+	return `0x${padStart(id.toString(USB_ID_RADIX), USB_ID_LENGTH, '0')}`;
+}
+
+function updateDriveProgress(
+	drive: sdk.sourceDestination.UsbbootDrive,
+	progress: number,
+) {
+	const drives = getDrives();
+
+	// @ts-ignore
+	const driveInMap = drives[drive.device];
+	if (driveInMap) {
+		// @ts-ignore
+		drives[drive.device] = { ...driveInMap, progress };
+		setDrives(drives);
+	}
+}
+
+/**
+ * @summary Product ID of BCM2708
+ */
+const USB_PRODUCT_ID_BCM2708_BOOT = 0x2763;
+
+/**
+ * @summary Product ID of BCM2710
+ */
+const USB_PRODUCT_ID_BCM2710_BOOT = 0x2764;
+
+/**
+ * @summary Compute module descriptions
+ */
+const COMPUTE_MODULE_DESCRIPTIONS: Dictionary<string> = {
+	[USB_PRODUCT_ID_BCM2708_BOOT]: 'Compute Module 1',
+	[USB_PRODUCT_ID_BCM2710_BOOT]: 'Compute Module 3',
+};
+
+const startScanning = () => {
+	driveScanner.on('attach', (drive) => addDrive(drive));
+	driveScanner.on('detach', (drive) => removeDrive(drive));
+	driveScanner.start();
+};
+
+const stopScanning = () => {
+	driveScanner.stop();
+};
+
+export { startScanning, stopScanning };

lib/util/source-metadata.ts

@@ -0,0 +1,94 @@
+/** Get metadata for a source */
+
+import { sourceDestination } from 'etcher-sdk';
+import { replaceWindowsNetworkDriveLetter } from '../gui/app/os/windows-network-drives';
+import type { AxiosRequestConfig } from 'axios';
+import axios from 'axios';
+import { isJson } from '../shared/utils';
+import * as path from 'path';
+import type {
+	SourceMetadata,
+	Authentication,
+	Source,
+} from '../shared/typings/source-selector';
+import type { DrivelistDrive } from '../shared/drive-constraints';
+import { omit } from 'lodash';
+
+function isString(value: any): value is string {
+	return typeof value === 'string';
+}
+
+async function createSource(
+	selected: string,
+	SourceType: Source,
+	auth?: Authentication,
+) {
+	try {
+		selected = await replaceWindowsNetworkDriveLetter(selected);
+	} catch (error: any) {
+		// TODO: analytics.logException(error);
+	}
+
+	if (isJson(decodeURIComponent(selected))) {
+		const config: AxiosRequestConfig = JSON.parse(decodeURIComponent(selected));
+		return new sourceDestination.Http({
+			url: config.url!,
+			axiosInstance: axios.create(omit(config, ['url'])),
+		});
+	}
+
+	if (SourceType === 'File') {
+		return new sourceDestination.File({
+			path: selected,
+		});
+	}
+
+	return new sourceDestination.Http({ url: selected, auth });
+}
+
+async function getMetadata(
+	source: sourceDestination.SourceDestination,
+	selected: string | DrivelistDrive,
+) {
+	const metadata = (await source.getMetadata()) as SourceMetadata;
+	const partitionTable = await source.getPartitionTable();
+	if (partitionTable) {
+		metadata.hasMBR = true;
+		metadata.partitions = partitionTable.partitions;
+	} else {
+		metadata.hasMBR = false;
+	}
+	if (isString(selected)) {
+		metadata.extension = path.extname(selected).slice(1);
+		metadata.path = selected;
+	}
+	return metadata;
+}
+
+async function getSourceMetadata(
+	selected: string | DrivelistDrive,
+	SourceType: Source,
+	auth?: Authentication,
+): Promise<SourceMetadata | Record<string, never>> {
+	// `Record<string, never>` means an empty object
+	if (isString(selected)) {
+		const source = await createSource(selected, SourceType, auth);
+
+		try {
+			const innerSource = await source.getInnerSource();
+
+			const metadata = await getMetadata(innerSource, selected);
+
+			return metadata;
+		} catch (error: any) {
+			// TODO: handle error
+			return {};
+		} finally {
+			await source.close();
+		}
+	} else {
+		return {};
+	}
+}
+
+export { getSourceMetadata };

lib/util/types/types.d.ts

@@ -0,0 +1,33 @@
+import type { Metadata } from 'etcher-sdk/build/source-destination';
+import type { SourceMetadata } from '../../shared/typings/source-selector';
+import type { Drive as DrivelistDrive } from 'drivelist';
+
+export interface WriteResult {
+	bytesWritten?: number;
+	devices?: {
+		failed: number;
+		successful: number;
+	};
+	errors: FlashError[];
+	sourceMetadata?: Metadata;
+}
+
+export interface FlashError extends Error {
+	description: string;
+	device: string;
+	code: string;
+}
+
+export interface FlashResults extends WriteResult {
+	skip?: boolean;
+	cancelled?: boolean;
+}
+
+interface WriteOptions {
+	image: SourceMetadata;
+	destinations: DrivelistDrive[];
+	autoBlockmapping: boolean;
+	decompressFirst: boolean;
+	SourceType: string;
+	httpRequest?: any;
+}

package.json

@@ -2,9 +2,10 @@
   "name": "balena-etcher",
   "private": true,
   "displayName": "balenaEtcher",
-  "version": "1.18.10",
+  "productName": "balenaEtcher",
+  "version": "2.1.0",
   "packageType": "local",
-  "main": "generated/etcher.js",
+  "main": ".webpack/main",
   "description": "Flash OS images to SD cards and USB drives, safely and easily.",
   "productDescription": "Etcher is a powerful OS image flasher built with web technologies to ensure flashing an SDCard or USB drive is a pleasant and safe experience. It protects you from accidentally writing to your hard-drives, ensures every byte of data was written correctly and much more.",
   "homepage": "https://github.com/balena-io/etcher",
@@ -13,119 +14,141 @@
     "url": "git@github.com:balena-io/etcher.git"
   },
   "scripts": {
-    "build": "npm run webpack",
-    "flowzone-preinstall-linux": "sudo apt-get update && sudo apt-get install -y xvfb libudev-dev && cat < electron-builder.yml | yq e .deb.depends[] - | xargs -L1 echo | sed 's/|//g' | xargs -L1 sudo apt-get --ignore-missing install || true",
-    "flowzone-preinstall-macos": "true",
-    "flowzone-preinstall-windows": "npx node-gyp install",
-    "flowzone-preinstall": "npm run flowzone-preinstall-linux",
-    "lint-css": "prettier --write lib/**/*.css",
-    "lint-ts": "balena-lint --fix --typescript typings lib tests scripts/clean-shrinkwrap.ts webpack.config.ts",
-    "lint": "npm run lint-ts && npm run lint-css",
-    "postinstall": "electron-rebuild -t prod,dev,optional",
-    "sanity-checks": "bash scripts/ci/ensure-all-file-extensions-in-gitattributes.sh",
-    "start": "./node_modules/.bin/electron .",
-    "test-gui": "electron-mocha --recursive --reporter spec --window-config tests/gui/window-config.json --require ts-node/register/transpile-only --require-main tests/gui/allow-renderer-process-reuse.ts --full-trace --no-sandbox --renderer tests/gui/**/*.ts",
-    "test-shared": "electron-mocha --recursive --reporter spec --require ts-node/register/transpile-only --require-main tests/gui/allow-renderer-process-reuse.ts --full-trace --no-sandbox tests/shared/**/*.ts",
-    "test-macos": "npm run lint && npm run test-gui && npm run test-shared && npm run sanity-checks",
-    "test-linux": "npm run lint && xvfb-run --auto-servernum npm run test-gui && xvfb-run --auto-servernum npm run test-shared && npm run sanity-checks",
-    "test-windows": "npm run lint && npm run test-gui && npm run test-shared && npm run sanity-checks",
-    "test": "echo npm run test-{linux,windows,macos}",
-    "watch": "webpack serve --no-optimization-minimize --config ./webpack.dev.config.ts",
-    "webpack": "webpack"
+    "prettify": "prettier --write lib/**/*.css && balena-lint --fix --typescript typings lib tests forge.config.ts forge.sidecar.ts webpack.config.ts",
+    "lint": "npm run prettify && catch-uncommitted",
+    "test": "echo 'Only use custom tests; if you want to test locally, use `npm run wdio`' && exit 0",
+    "package": "electron-forge package",
+    "start": "electron-forge start",
+    "make": "electron-forge make",
+    "wdio": "xvfb-maybe wdio run ./wdio.conf.ts"
   },
   "husky": {
     "hooks": {
-      "pre-commit": "lint-staged"
+      "pre-commit": "npm run prettify"
     }
   },
-  "lint-staged": {
-    "./**/*.{ts,tsx}": [
-      "npm run lint-ts"
-    ],
-    "./**/*.css": [
-      "npm run lint-css"
-    ]
-  },
   "author": "Balena Ltd. <hello@balena.io>",
   "license": "Apache-2.0",
-  "devDependencies": {
-    "@balena/lint": "5.4.2",
-    "@balena/sudo-prompt": "9.2.1-workaround-windows-amperstand-in-username-0849e215b947987a643fe5763902aea201255534",
-    "@electron/remote": "^2.0.9",
-    "@fortawesome/fontawesome-free": "5.15.4",
-    "@sentry/electron": "^4.1.2",
-    "@svgr/webpack": "5.5.0",
-    "@types/chai": "4.3.4",
-    "@types/copy-webpack-plugin": "6.4.3",
-    "@types/mime-types": "2.1.1",
-    "@types/mini-css-extract-plugin": "1.4.3",
-    "@types/mocha": "^9.1.1",
-    "@types/node": "^16.18.12",
-    "@types/node-ipc": "9.2.0",
-    "@types/react": "16.14.34",
-    "@types/react-dom": "16.9.17",
-    "@types/semver": "7.3.13",
-    "@types/sinon": "9.0.11",
-    "@types/terser-webpack-plugin": "5.0.4",
-    "@types/tmp": "0.2.3",
-    "@types/webpack-node-externals": "2.5.3",
+  "dependencies": {
+    "@electron/remote": "^2.1.2",
+    "@fortawesome/fontawesome-free": "^6.5.2",
+    "@ronomon/direct-io": "^3.0.1",
+    "@sentry/electron": "^4.24.0",
     "analytics-client": "^2.0.1",
-    "axios": "^0.27.2",
-    "chai": "4.3.7",
-    "copy-webpack-plugin": "7.0.0",
-    "css-loader": "5.2.7",
-    "d3": "4.13.0",
+    "axios": "^1.6.8",
     "debug": "4.3.4",
-    "electron": "^19.1.9",
-    "electron-builder": "^23.6.0",
-    "electron-mocha": "^11.0.2",
-    "electron-notarize": "1.2.2",
-    "electron-rebuild": "^3.2.9",
-    "electron-updater": "5.3.0",
-    "esbuild-loader": "2.20.0",
-    "etcher-sdk": "8.3.1",
-    "file-loader": "6.2.0",
-    "husky": "4.3.8",
-    "i18next": "21.10.0",
+    "drivelist": "^12.0.2",
+    "electron-squirrel-startup": "^1.0.0",
+    "electron-updater": "6.1.8",
+    "etcher-sdk": "9.1.2",
+    "i18next": "23.11.2",
     "immutable": "3.8.2",
-    "lint-staged": "10.5.4",
     "lodash": "4.17.21",
-    "mini-css-extract-plugin": "1.6.2",
-    "mocha": "^9.1.1",
-    "native-addon-loader": "2.0.1",
-    "node-ipc": "9.2.1",
-    "omit-deep-lodash": "1.1.7",
     "outdent": "0.8.0",
     "path-is-inside": "1.0.2",
-    "pnp-webpack-plugin": "1.7.0",
-    "pretty-bytes": "5.6.0",
-    "react": "16.8.5",
-    "react-dom": "16.8.5",
-    "react-i18next": "11.18.6",
-    "redux": "4.2.0",
-    "rendition": "19.3.2",
-    "semver": "7.3.8",
-    "simple-progress-webpack-plugin": "1.1.2",
-    "sinon": "9.2.4",
-    "string-replace-loader": "3.1.0",
-    "style-loader": "2.0.0",
+    "pretty-bytes": "6.1.1",
+    "react": "17.0.2",
+    "react-dom": "17.0.2",
+    "react-i18next": "13.5.0",
+    "redux": "4.2.1",
+    "rendition": "35.2.0",
+    "semver": "7.6.0",
     "styled-components": "5.3.6",
     "sys-class-rgb-led": "3.0.1",
-    "terser-webpack-plugin": "5.3.6",
-    "ts-loader": "8.4.0",
-    "ts-node": "9.1.1",
-    "tslib": "2.4.1",
-    "typescript": "4.4.4",
+    "uuid": "9.0.1",
+    "ws": "^8.16.0"
+  },
+  "devDependencies": {
+    "@balena/lint": "8.0.2",
+    "@electron-forge/cli": "7.4.0",
+    "@electron-forge/maker-deb": "7.4.0",
+    "@electron-forge/maker-dmg": "7.4.0",
+    "@electron-forge/maker-rpm": "7.4.0",
+    "@electron-forge/maker-squirrel": "7.4.0",
+    "@electron-forge/maker-zip": "7.4.0",
+    "@electron-forge/plugin-auto-unpack-natives": "7.4.0",
+    "@electron-forge/plugin-webpack": "7.4.0",
+    "@reforged/maker-appimage": "3.3.2",
+    "@svgr/webpack": "8.1.0",
+    "@types/chai": "4.3.14",
+    "@types/debug": "^4.1.12",
+    "@types/mime-types": "2.1.4",
+    "@types/node": "^20.11.6",
+    "@types/react": "17.0.2",
+    "@types/react-dom": "17.0.2",
+    "@types/semver": "7.5.8",
+    "@types/sinon": "17.0.3",
+    "@types/tmp": "0.2.6",
+    "@vercel/webpack-asset-relocator-loader": "1.7.3",
+    "@wdio/cli": "^8.36.1",
+    "@wdio/local-runner": "^8.36.1",
+    "@wdio/mocha-framework": "^8.36.1",
+    "@wdio/spec-reporter": "^8.36.1",
+    "@yao-pkg/pkg": "^5.11.5",
+    "catch-uncommitted": "^2.0.0",
+    "chai": "4.3.10",
+    "css-loader": "5.2.7",
+    "electron": "30.0.1",
+    "file-loader": "6.2.0",
+    "husky": "8.0.3",
+    "native-addon-loader": "2.0.1",
+    "node-loader": "^2.0.0",
+    "sinon": "^17.0.1",
+    "string-replace-loader": "3.1.0",
+    "style-loader": "3.3.3",
+    "ts-loader": "^9.5.1",
+    "ts-node": "^10.9.2",
+    "tslib": "2.6.2",
+    "typescript": "^5.3.3",
     "url-loader": "4.1.1",
-    "uuid": "8.3.2",
-    "webpack": "5.75.0",
-    "webpack-cli": "4.10.0",
-    "webpack-dev-server": "4.11.1"
+    "wdio-electron-service": "^6.4.1",
+    "xvfb-maybe": "^0.2.1"
+  },
+  "hostDependencies": {
+    "debian": [
+      "libasound2",
+      "libatk1.0-0",
+      "libc6",
+      "libcairo2",
+      "libcups2",
+      "libdbus-1-3",
+      "libexpat1",
+      "libfontconfig1",
+      "libfreetype6",
+      "libgbm1",
+      "libgcc1",
+      "libgdk-pixbuf2.0-0",
+      "libglib2.0-0",
+      "libgtk-3-0",
+      "liblzma5",
+      "libnotify4",
+      "libnspr4",
+      "libnss3",
+      "libpango1.0-0 | libpango-1.0-0",
+      "libstdc++6",
+      "libx11-6",
+      "libxcomposite1",
+      "libxcursor1",
+      "libxdamage1",
+      "libxext6",
+      "libxfixes3",
+      "libxi6",
+      "libxrandr2",
+      "libxrender1",
+      "libxss1",
+      "libxtst6",
+      "polkit-1-auth-agent | policykit-1-gnome | polkit-kde-1"
+    ]
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=20 <21"
   },
   "versionist": {
-    "publishedAt": "2023-07-12T11:21:59.915Z"
+    "publishedAt": "2025-02-27T16:16:57.534Z"
+  },
+  "optionalDependencies": {
+    "bufferutil": "^4.0.8",
+    "utf-8-validate": "^5.0.10",
+    "winusb-driver-generator": "2.1.2"
   }
 }

pkg-sidecar.json

@@ -0,0 +1,12 @@
+{
+  "assets": [
+    "node_modules/usb/**",
+    "node_modules/lzma-native/**",
+    "node_modules/drivelist/**",
+    "node_modules/mountutils/**",
+    "node_modules/winusb-driver-generator/**",
+    "node_modules/node-raspberrypi-usbboot/**",
+    "node_modules/xxhash-addon/**",
+    "node_modules/axios/**"
+  ]
+}

requirements.txt

@@ -1,2 +0,0 @@
-awscli==1.27.28
-shyaml==0.6.2

scripts/ci/ensure-all-file-extensions-in-gitattributes.sh

@@ -1,52 +0,0 @@
-#!/bin/bash
-
-###
-# 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.
-###
-
-set -u
-set -e
-
-# Read list of wildcards from .gitattributes
-wildcards=()
-while IFS='' read -r line || [[ -n "$line" ]]; do
-  if [[ -n "$line" ]]; then
-    if [[ ! "$line" =~ "^#" ]]; then
-      filetype=$(echo "$line" | cut -d ' ' -f 2)
-      if [[ "$filetype" == "text" ]] || [[ "$filetype" == "binary" ]]; then
-        wildcards+=("$(echo "$line" | cut -d ' ' -f 1)")
-      fi
-    fi
-  fi
-done < .gitattributes
-
-# Verify those wildcards against all files stored in the repo
-git ls-tree -r HEAD | while IFS='' read line; do
-  if [[ "$(echo $line | cut -d ' ' -f 2)" == "blob" ]]; then
-    # the cut delimiter in the line below is actually a tab character, not a space
-    filename=$(basename $(echo "$line" | cut -d '	' -f 2))
-    found_match=0
-    for wildcard in "${wildcards[@]}"; do
-      if [[ "$filename" = $wildcard ]]; then
-        found_match=1
-        break
-      fi
-    done
-    if [[ $found_match -eq 0 ]]; then
-      echo "No wildcards match $filename"
-      exit 1
-    fi
-  fi
-done

scripts/clean-shrinkwrap.ts

@@ -1,52 +0,0 @@
-/**
- * This script is in charge of cleaning the `shrinkwrap` file.
- *
- * `npm shrinkwrap` has a bug where it will add optional dependencies
- * to `npm-shrinkwrap.json`, therefore causing errors if these optional
- * dependendencies are platform dependent and you then try to build
- * the project in another platform.
- *
- * As a workaround, we keep a list of platform dependent dependencies in
- * the `platformSpecificDependencies` property of `package.json`,
- * and manually remove them from `npm-shrinkwrap.json` if they exist.
- *
- * See: https://github.com/npm/npm/issues/2679
- */
-
-import { writeFile } from 'fs';
-import * as omit from 'omit-deep-lodash';
-import * as path from 'path';
-import { promisify } from 'util';
-
-import * as shrinkwrap from '../npm-shrinkwrap.json';
-import * as packageInfo from '../package.json';
-
-const writeFileAsync = promisify(writeFile);
-
-const JSON_INDENT = 2;
-const SHRINKWRAP_FILENAME = path.join(__dirname, '..', 'npm-shrinkwrap.json');
-
-async function main() {
-	try {
-		const cleaned = omit(shrinkwrap, packageInfo.platformSpecificDependencies);
-		for (const item of Object.values(cleaned.dependencies)) {
-			// @ts-ignore
-			item.dev = true;
-		}
-		await writeFileAsync(
-			SHRINKWRAP_FILENAME,
-			JSON.stringify(cleaned, null, JSON_INDENT),
-		);
-	} catch (error: any) {
-		console.log(`[ERROR] Couldn't write shrinkwrap file: ${error.stack}`);
-		process.exitCode = 1;
-	}
-	console.log(
-		`[OK] Wrote shrinkwrap file to ${path.relative(
-			__dirname,
-			SHRINKWRAP_FILENAME,
-		)}`,
-	);
-}
-
-main();

scripts/resin

@@ -1 +0,0 @@
-Subproject commit 8dfa21cfc23b1dbc0eaa22b5dbdf1f5c796b0c2c

tests/gui/allow-renderer-process-reuse.ts

@@ -1,8 +1,6 @@
-// tslint:disable-next-line:no-var-requires
 const { app } = require('electron');
 
 if (app !== undefined) {
-	// tslint:disable-next-line:no-var-requires
 	const remoteMain = require('@electron/remote/main');
 
 	remoteMain.initialize();

tests/gui/models/available-drives.spec.ts

@@ -15,7 +15,6 @@
  */
 
 import { expect } from 'chai';
-import { File } from 'etcher-sdk/build/source-destination';
 import * as path from 'path';
 
 import * as availableDrives from '../../../lib/gui/app/models/available-drives';
@@ -165,7 +164,7 @@ describe('Model: availableDrives', function () {
 							extension: 'img',
 							size: 999999999,
 							isSizeEstimated: false,
-							SourceType: File,
+							SourceType: 'File',
 							recommendedDriveSize: 2000000000,
 						});
 					});

tests/gui/models/selection-state.spec.ts

@@ -15,13 +15,12 @@
  */
 
 import { expect } from 'chai';
-import { File } from 'etcher-sdk/build/source-destination';
 import * as path from 'path';
-import { SourceMetadata } from '../../../lib/gui/app/components/source-selector/source-selector';
+import type { SourceMetadata } from '../../../lib/shared/typings/source-selector';
 
 import * as availableDrives from '../../../lib/gui/app/models/available-drives';
 import * as selectionState from '../../../lib/gui/app/models/selection-state';
-import { DrivelistDrive } from '../../../lib/shared/drive-constraints';
+import type { DrivelistDrive } from '../../../lib/shared/drive-constraints';
 
 describe('Model: selectionState', function () {
 	describe('given a clean state', function () {
@@ -375,7 +374,7 @@ describe('Model: selectionState', function () {
 					extension: 'img',
 					size: 999999999,
 					isSizeEstimated: false,
-					SourceType: File,
+					SourceType: 'File',
 				});
 
 				const imagePath = selectionState.getImage()?.path;
@@ -408,7 +407,7 @@ describe('Model: selectionState', function () {
 				extension: 'img',
 				size: 999999999,
 				isSizeEstimated: false,
-				SourceType: File,
+				SourceType: 'File',
 				recommendedDriveSize: 2000000000,
 			};
 
@@ -581,7 +580,7 @@ describe('Model: selectionState', function () {
 			path: 'foo.img',
 			extension: 'img',
 			size: 999999999,
-			SourceType: File,
+			SourceType: 'File',
 			isSizeEstimated: false,
 		};
 
@@ -670,7 +669,7 @@ describe('Model: selectionState', function () {
 			path: 'foo.img',
 			extension: 'img',
 			size: 999999999,
-			SourceType: File,
+			SourceType: 'File',
 			isSizeEstimated: false,
 		};
 

tests/gui/models/settings.spec.ts

@@ -15,7 +15,6 @@
  */
 
 import { expect } from 'chai';
-import * as _ from 'lodash';
 import { stub } from 'sinon';
 
 import * as settings from '../../../lib/gui/app/models/settings';
@@ -47,8 +46,8 @@ describe('Browser: settings', () => {
 			const writeConfigFileStub = stub();
 			writeConfigFileStub.returns(Promise.reject(new Error('settings error')));
 
-			const p = settings.set('foo', 'baz', writeConfigFileStub);
-			await checkError(p, async (error) => {
+			const promise = settings.set('foo', 'baz', writeConfigFileStub);
+			await checkError(promise, async (error) => {
 				expect(error).to.be.an.instanceof(Error);
 				expect(error.message).to.equal('settings error');
 				expect(await settings.get('foo')).to.equal('bar');

tests/gui/modules/child-writer.spec.ts

@@ -1,26 +0,0 @@
-/*
- * Copyright 2018 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 { expect } from 'chai';
-import * as ipc from 'node-ipc';
-
-import('../../../lib/gui/modules/child-writer');
-
-describe('Browser: childWriter', function () {
-	it('should have the ipc config set to silent', function () {
-		expect(ipc.config.silent).to.be.true;
-	});
-});

tests/gui/modules/image-writer.spec.ts

@@ -1,3 +1,10 @@
+/*
+ *
+ * TODO:
+ * This test should be replaced by an E2E test.
+ *
+ */
+
 /*
  * Copyright 2020 balena.io
  *
@@ -15,12 +22,11 @@
  */
 
 import { expect } from 'chai';
-import { Drive as DrivelistDrive } from 'drivelist';
-import { sourceDestination } from 'etcher-sdk';
-import * as ipc from 'node-ipc';
-import { assert, SinonStub, stub } from 'sinon';
+import type { Drive as DrivelistDrive } from 'drivelist';
+import type { SinonStub } from 'sinon';
+import { assert, stub } from 'sinon';
 
-import { SourceMetadata } from '../../../lib/gui/app/components/source-selector/source-selector';
+import type { SourceMetadata } from '../../../lib/shared/typings/source-selector';
 import * as flashState from '../../../lib/gui/app/models/flash-state';
 import * as imageWriter from '../../../lib/gui/app/modules/image-writer';
 
@@ -35,7 +41,7 @@ describe('Browser: imageWriter', () => {
 			description: 'foo.img',
 			displayName: 'foo.img',
 			path: 'foo.img',
-			SourceType: sourceDestination.File,
+			SourceType: 'File',
 			extension: 'img',
 		};
 
@@ -140,11 +146,4 @@ describe('Browser: imageWriter', () => {
 			});
 		});
 	});
-
-	describe('.performWrite()', function () {
-		it('should set the ipc config to silent', function () {
-			// Reset this value as it can persist from other tests
-			expect(ipc.config.silent).to.be.true;
-		});
-	});
 });

tests/gui/modules/progress-status.spec.ts

@@ -15,12 +15,14 @@
  */
 
 import { expect } from 'chai';
+import * as i18next from 'i18next';
+import en_translation from '../../../lib/gui/app/i18n/en';
 
 import * as progressStatus from '../../../lib/gui/app/modules/progress-status';
 
 describe('Browser: progressStatus', function () {
 	describe('.titleFromFlashState()', function () {
-		beforeEach(function () {
+		beforeEach(async function () {
 			this.state = {
 				active: 1,
 				type: 'flashing',
@@ -29,6 +31,13 @@ describe('Browser: progressStatus', function () {
 				eta: 15,
 				speed: 100000000000000,
 			};
+
+			await i18next.init({
+				lng: 'en', // Set the default language
+				resources: {
+					en: en_translation,
+				},
+			});
 		});
 
 		it('should report 0% if percentage == 0 but speed != 0', function () {

tests/gui/os/window-progress.spec.ts

@@ -1,3 +1,10 @@
+/*
+ *
+ * TODO:
+ * This test should be replaced by an E2E test.
+ *
+ */
+
 /*
  * Copyright 2016 balena.io
  *

tests/gui/os/windows-network-drives.spec.ts

@@ -17,7 +17,8 @@
 import { expect } from 'chai';
 import { promises as fs } from 'fs';
 import * as os from 'os';
-import { SinonStub, stub } from 'sinon';
+import type { SinonStub } from 'sinon';
+import { stub } from 'sinon';
 
 import * as wnd from '../../../lib/gui/app/os/windows-network-drives';
 

tests/shared/drive-constraints.spec.ts

@@ -15,9 +15,8 @@
  */
 
 import { expect } from 'chai';
-import { sourceDestination } from 'etcher-sdk';
 import * as path from 'path';
-import { SourceMetadata } from '../../lib/gui/app/components/source-selector/source-selector';
+import type { SourceMetadata } from '../../lib/shared/typings/source-selector';
 
 import * as constraints from '../../lib/shared/drive-constraints';
 import * as messages from '../../lib/shared/messages';
@@ -87,7 +86,7 @@ describe('Shared: DriveConstraints', function () {
 					path: '/Volumes/Untitled/image.img',
 					hasMBR: false,
 					partitions: [],
-					SourceType: sourceDestination.File,
+					SourceType: 'File',
 				},
 			);
 
@@ -101,7 +100,7 @@ describe('Shared: DriveConstraints', function () {
 				path: 'E:\\image.img',
 				hasMBR: false,
 				partitions: [],
-				SourceType: sourceDestination.File,
+				SourceType: 'File',
 			};
 			beforeEach(function () {
 				this.separator = path.sep;
@@ -207,7 +206,7 @@ describe('Shared: DriveConstraints', function () {
 				path: '/Volumes/Untitled/image.img',
 				hasMBR: false,
 				partitions: [],
-				SourceType: sourceDestination.File,
+				SourceType: 'File',
 			};
 			beforeEach(function () {
 				this.separator = path.sep;
@@ -522,7 +521,7 @@ describe('Shared: DriveConstraints', function () {
 			size: 1000000000,
 			isSizeEstimated: false,
 			recommendedDriveSize: 2000000000,
-			SourceType: sourceDestination.File,
+			SourceType: 'File',
 		};
 		it('should return true if the drive size is greater than the recommended size ', function () {
 			const result = constraints.isDriveSizeRecommended(
@@ -626,7 +625,7 @@ describe('Shared: DriveConstraints', function () {
 					description: 'rpi.img',
 					displayName: 'rpi.img',
 					path: '',
-					SourceType: sourceDestination.File,
+					SourceType: 'File',
 					size: 2000000000,
 					isSizeEstimated: false,
 				};
@@ -672,7 +671,7 @@ describe('Shared: DriveConstraints', function () {
 					description: 'rpi.img',
 					displayName: 'rpi.img',
 					path: '',
-					SourceType: sourceDestination.File,
+					SourceType: 'File',
 					size: 2000000000,
 					isSizeEstimated: false,
 				};
@@ -720,7 +719,7 @@ describe('Shared: DriveConstraints', function () {
 				description: 'rpi.img',
 				displayName: 'rpi.img',
 				path: '',
-				SourceType: sourceDestination.File,
+				SourceType: 'File',
 				size: 2000000000,
 				isSizeEstimated: false,
 			};
@@ -829,7 +828,7 @@ describe('Shared: DriveConstraints', function () {
 			};
 
 			this.image = {
-				SourceType: sourceDestination.File,
+				SourceType: 'File',
 				path: path.join(__dirname, 'rpi.img'),
 				size: this.drive.size - 1,
 				isSizeEstimated: false,
@@ -874,7 +873,7 @@ describe('Shared: DriveConstraints', function () {
 			};
 
 			this.image = {
-				SourceType: sourceDestination.File,
+				SourceType: 'File',
 				path: path.join(__dirname, 'rpi.img'),
 				size: this.drive.size - 1,
 				isSizeEstimated: false,
@@ -1156,7 +1155,7 @@ describe('Shared: DriveConstraints', function () {
 						'/dev/disk4',
 						'/dev/disk5',
 						'/dev/disk6',
-				  ];
+					];
 		const drives = [
 			{
 				device: drivePaths[0],
@@ -1227,7 +1226,7 @@ describe('Shared: DriveConstraints', function () {
 			description: 'rpi.img',
 			displayName: 'rpi.img',
 			path: path.join(__dirname, 'rpi.img'),
-			SourceType: sourceDestination.File,
+			SourceType: 'File',
 			// @ts-ignore
 			size: drives[2].size + 1,
 			isSizeEstimated: false,

tests/test.e2e.ts

@@ -0,0 +1,7 @@
+import { browser } from '@wdio/globals';
+
+describe('Electron Testing', () => {
+	it('should print application title', async () => {
+		console.log('Hello', await browser.getTitle(), 'application!');
+	});
+});

tsconfig.json

@@ -1,21 +1,21 @@
 {
-  "compilerOptions": {
-    "strict": true,
-    "target": "es2019",
-    "typeRoots": ["./node_modules/@types", "./typings"],
-    "module": "commonjs",
-    "lib": ["dom", "esnext"],
-    "declaration": true,
-    "declarationMap": true,
-    "jsx": "react",
-    "pretty": true,
-    "sourceMap": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    "moduleResolution": "node",
-    "allowSyntheticDefaultImports": true,
-    "resolveJsonModule": true,
-  }
+	"compilerOptions": {
+		"strict": true,
+		"target": "es2019",
+		"typeRoots": ["./node_modules/@types", "./typings"],
+		"module": "commonjs",
+		"lib": ["dom", "esnext"],
+		"declaration": true,
+		"declarationMap": true,
+		"jsx": "react",
+		"pretty": true,
+		"sourceMap": true,
+		"noUnusedLocals": true,
+		"noUnusedParameters": true,
+		"noImplicitReturns": true,
+		"noFallthroughCasesInSwitch": true,
+		"moduleResolution": "node",
+		"allowSyntheticDefaultImports": true,
+		"resolveJsonModule": true
+	}
 }

tsconfig.sidecar.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "allowJs": false,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "typeRoots": ["./node_modules/@types", "./typings"],
+    "module": "commonjs",
+    "moduleResolution": "Node",
+    "resolveJsonModule": true,
+    "isolatedModules": true
+  },
+  "include": ["lib/util"]
+}

tsconfig.webpack.json

@@ -1,28 +0,0 @@
-{
-  "compilerOptions": {
-    "strict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "resolveJsonModule": true,
-    "moduleResolution": "node",
-    "module": "es2015",
-    "target": "es2019",
-    "jsx": "react",
-    "typeRoots": ["./node_modules/@types", "./typings"],
-    "importHelpers": true,
-    "allowSyntheticDefaultImports": true,
-    "lib": ["dom", "esnext"],
-    "declaration": true,
-    "declarationMap": true,
-    "pretty": true,
-    "sourceMap": true,
-    "baseUrl": "./src",
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    "allowJs": true
-  },
-  "include": [
-    "lib/**/*.ts",
-    "node_modules/electron/**/*.d.ts"
-  ]
-}

typings/pnp-webpack-plugin/index.d.ts

@@ -1 +0,0 @@
-declare module 'pnp-webpack-plugin';

typings/resin-corvus/index.d.ts

@@ -1 +0,0 @@
-declare module 'resin-corvus/browser';

typings/simple-progress-webpack-plugin/index.d.ts

@@ -1 +0,0 @@
-declare module 'simple-progress-webpack-plugin';

wdio.conf.ts

@@ -0,0 +1,318 @@
+/// <reference types="wdio-electron-service" />
+import type { Options } from '@wdio/types';
+
+export const config: Options.Testrunner = {
+	//
+	// ====================
+	// Runner Configuration
+	// ====================
+	// WebdriverIO supports running e2e tests as well as unit and component tests.
+	runner: 'local',
+	autoCompileOpts: {
+		autoCompile: true,
+		tsNodeOpts: {
+			project: './tsconfig.json',
+			transpileOnly: true,
+		},
+	},
+
+	//
+	// ==================
+	// Specify Test Files
+	// ==================
+	// Define which test specs should run. The pattern is relative to the directory
+	// of the configuration file being run.
+	//
+	// The specs are defined as an array of spec files (optionally using wildcards
+	// that will be expanded). The test for each spec file will be run in a separate
+	// worker process. In order to have a group of spec files run in the same worker
+	// process simply enclose them in an array within the specs array.
+	//
+	// The path of the spec files will be resolved relative from the directory of
+	// of the config file unless it's absolute.
+	//
+	specs: ['./tests/**/*.spec.ts'],
+	// Patterns to exclude.
+	// FIXME: Remove the following exclusions once the tests are ported to WDIO
+	exclude: [
+		'tests/gui/modules/image-writer.spec.ts',
+		'tests/gui/os/window-progress.spec.ts',
+		'tests/gui/models/available-drives.spec.ts',
+		'tests/gui/models/flash-state.spec.ts',
+		'tests/gui/models/selection-state.spec.ts',
+		'tests/gui/models/settings.spec.ts',
+		'tests/shared/drive-constraints.spec.ts',
+		'tests/shared/messages.spec.ts',
+		'tests/gui/modules/progress-status.spec.ts',
+	],
+	//
+	// ============
+	// Capabilities
+	// ============
+	// Define your capabilities here. WebdriverIO can run multiple capabilities at the same
+	// time. Depending on the number of capabilities, WebdriverIO launches several test
+	// sessions. Within your capabilities you can overwrite the spec and exclude options in
+	// order to group specific specs to a specific capability.
+	//
+	// First, you can define how many instances should be started at the same time. Let's
+	// say you have 3 different capabilities (Chrome, Firefox, and Safari) and you have
+	// set maxInstances to 1; wdio will spawn 3 processes. Therefore, if you have 10 spec
+	// files and you set maxInstances to 10, all spec files will get tested at the same time
+	// and 30 processes will get spawned. The property handles how many capabilities
+	// from the same test should run tests.
+	//
+	maxInstances: 10,
+	//
+	// If you have trouble getting all important capabilities together, check out the
+	// Sauce Labs platform configurator - a great tool to configure your capabilities:
+	// https://saucelabs.com/platform/platform-configurator
+	//
+	capabilities: [
+		{
+			browserName: 'electron',
+			// Electron service options
+			// see https://webdriver.io/docs/desktop-testing/electron/configuration/#service-options
+			'wdio:electronServiceOptions': {
+				appArgs: process.platform === 'linux' ? ['headless'] : [],
+			},
+		},
+	],
+
+	//
+	// ===================
+	// Test Configurations
+	// ===================
+	// Define all options that are relevant for the WebdriverIO instance here
+	//
+	// Level of logging verbosity: trace | debug | info | warn | error | silent
+	logLevel: 'info',
+	//
+	// Set specific log levels per logger
+	// loggers:
+	// - webdriver, webdriverio
+	// - @wdio/browserstack-service, @wdio/devtools-service, @wdio/sauce-service
+	// - @wdio/mocha-framework, @wdio/jasmine-framework
+	// - @wdio/local-runner
+	// - @wdio/sumologic-reporter
+	// - @wdio/cli, @wdio/config, @wdio/utils
+	// Level of logging verbosity: trace | debug | info | warn | error | silent
+	// logLevels: {
+	//     webdriver: 'info',
+	//     '@wdio/appium-service': 'info'
+	// },
+	//
+	// If you only want to run your tests until a specific amount of tests have failed use
+	// bail (default is 0 - don't bail, run all tests).
+	bail: 0,
+	//
+	// Set a base URL in order to shorten url command calls. If your `url` parameter starts
+	// with `/`, the base url gets prepended, not including the path portion of your baseUrl.
+	// If your `url` parameter starts without a scheme or `/` (like `some/path`), the base url
+	// gets prepended directly.
+	// baseUrl: 'http://localhost:8080',
+	//
+	// Default timeout for all waitFor* commands.
+	waitforTimeout: 10000,
+	//
+	// Default timeout in milliseconds for request
+	// if browser driver or grid doesn't send response
+	connectionRetryTimeout: 120000,
+	//
+	// Default request retries count
+	connectionRetryCount: 3,
+	//
+	// Test runner services
+	// Services take over a specific job you don't want to take care of. They enhance
+	// your test setup with almost no effort. Unlike plugins, they don't add new
+	// commands. Instead, they hook themselves up into the test process.
+	services: ['electron'],
+
+	// Framework you want to run your specs with.
+	// The following are supported: Mocha, Jasmine, and Cucumber
+	// see also: https://webdriver.io/docs/frameworks
+	//
+	// Make sure you have the wdio adapter package for the specific framework installed
+	// before running any tests.
+	framework: 'mocha',
+
+	//
+	// The number of times to retry the entire specfile when it fails as a whole
+	// specFileRetries: 1,
+	//
+	// Delay in seconds between the spec file retry attempts
+	// specFileRetriesDelay: 0,
+	//
+	// Whether or not retried spec files should be retried immediately or deferred to the end of the queue
+	// specFileRetriesDeferred: false,
+	//
+	// Test reporter for stdout.
+	// The only one supported by default is 'dot'
+	// see also: https://webdriver.io/docs/dot-reporter
+	reporters: ['spec'],
+
+	// Options to be passed to Mocha.
+	// See the full list at http://mochajs.org/
+	mochaOpts: {
+		ui: 'bdd',
+		timeout: 60000,
+	},
+
+	//
+	// =====
+	// Hooks
+	// =====
+	// WebdriverIO provides several hooks you can use to interfere with the test process in order to enhance
+	// it and to build services around it. You can either apply a single function or an array of
+	// methods to it. If one of them returns with a promise, WebdriverIO will wait until that promise got
+	// resolved to continue.
+	/**
+	 * Gets executed once before all workers get launched.
+	 * @param {object} config wdio configuration object
+	 * @param {Array.<Object>} capabilities list of capabilities details
+	 */
+	// onPrepare: function (config, capabilities) {
+	// },
+	/**
+	 * Gets executed before a worker process is spawned and can be used to initialize specific service
+	 * for that worker as well as modify runtime environments in an async fashion.
+	 * @param  {string} cid      capability id (e.g 0-0)
+	 * @param  {object} caps     object containing capabilities for session that will be spawn in the worker
+	 * @param  {object} specs    specs to be run in the worker process
+	 * @param  {object} args     object that will be merged with the main configuration once worker is initialized
+	 * @param  {object} execArgv list of string arguments passed to the worker process
+	 */
+	// onWorkerStart: function (cid, caps, specs, args, execArgv) {
+	// },
+	/**
+	 * Gets executed just after a worker process has exited.
+	 * @param  {string} cid      capability id (e.g 0-0)
+	 * @param  {number} exitCode 0 - success, 1 - fail
+	 * @param  {object} specs    specs to be run in the worker process
+	 * @param  {number} retries  number of retries used
+	 */
+	// onWorkerEnd: function (cid, exitCode, specs, retries) {
+	// },
+	/**
+	 * Gets executed just before initialising the webdriver session and test framework. It allows you
+	 * to manipulate configurations depending on the capability or spec.
+	 * @param {object} config wdio configuration object
+	 * @param {Array.<Object>} capabilities list of capabilities details
+	 * @param {Array.<String>} specs List of spec file paths that are to be run
+	 * @param {string} cid worker id (e.g. 0-0)
+	 */
+	// beforeSession: function (config, capabilities, specs, cid) {
+	// },
+	/**
+	 * Gets executed before test execution begins. At this point you can access to all global
+	 * variables like `browser`. It is the perfect place to define custom commands.
+	 * @param {Array.<Object>} capabilities list of capabilities details
+	 * @param {Array.<String>} specs        List of spec file paths that are to be run
+	 * @param {object}         browser      instance of created browser/device session
+	 */
+	// before: function (capabilities, specs) {
+	// },
+	/**
+	 * Runs before a WebdriverIO command gets executed.
+	 * @param {string} commandName hook command name
+	 * @param {Array} args arguments that command would receive
+	 */
+	// beforeCommand: function (commandName, args) {
+	// },
+	/**
+	 * Hook that gets executed before the suite starts
+	 * @param {object} suite suite details
+	 */
+	// beforeSuite: function (suite) {
+	// },
+	/**
+	 * Function to be executed before a test (in Mocha/Jasmine) starts.
+	 */
+	// beforeTest: function (test, context) {
+	// },
+	/**
+	 * Hook that gets executed _before_ a hook within the suite starts (e.g. runs before calling
+	 * beforeEach in Mocha)
+	 */
+	// beforeHook: function (test, context, hookName) {
+	// },
+	/**
+	 * Hook that gets executed _after_ a hook within the suite starts (e.g. runs after calling
+	 * afterEach in Mocha)
+	 */
+	// afterHook: function (test, context, { error, result, duration, passed, retries }, hookName) {
+	// },
+	/**
+	 * Function to be executed after a test (in Mocha/Jasmine only)
+	 * @param {object}  test             test object
+	 * @param {object}  context          scope object the test was executed with
+	 * @param {Error}   result.error     error object in case the test fails, otherwise `undefined`
+	 * @param {*}       result.result    return object of test function
+	 * @param {number}  result.duration  duration of test
+	 * @param {boolean} result.passed    true if test has passed, otherwise false
+	 * @param {object}  result.retries   information about spec related retries, e.g. `{ attempts: 0, limit: 0 }`
+	 */
+	// afterTest: function(test, context, { error, result, duration, passed, retries }) {
+	// },
+
+	/**
+	 * Hook that gets executed after the suite has ended
+	 * @param {object} suite suite details
+	 */
+	// afterSuite: function (suite) {
+	// },
+	/**
+	 * Runs after a WebdriverIO command gets executed
+	 * @param {string} commandName hook command name
+	 * @param {Array} args arguments that command would receive
+	 * @param {number} result 0 - command success, 1 - command error
+	 * @param {object} error error object if any
+	 */
+	// afterCommand: function (commandName, args, result, error) {
+	// },
+	/**
+	 * Gets executed after all tests are done. You still have access to all global variables from
+	 * the test.
+	 * @param {number} result 0 - test pass, 1 - test fail
+	 * @param {Array.<Object>} capabilities list of capabilities details
+	 * @param {Array.<String>} specs List of spec file paths that ran
+	 */
+	// after: function (result, capabilities, specs) {
+	// },
+	/**
+	 * Gets executed right after terminating the webdriver session.
+	 * @param {object} config wdio configuration object
+	 * @param {Array.<Object>} capabilities list of capabilities details
+	 * @param {Array.<String>} specs List of spec file paths that ran
+	 */
+	// afterSession: function (config, capabilities, specs) {
+	// },
+	/**
+	 * Gets executed after all workers got shut down and the process is about to exit. An error
+	 * thrown in the onComplete hook will result in the test run failing.
+	 * @param {object} exitCode 0 - success, 1 - fail
+	 * @param {object} config wdio configuration object
+	 * @param {Array.<Object>} capabilities list of capabilities details
+	 * @param {<Object>} results object containing test results
+	 */
+	// onComplete: function(exitCode, config, capabilities, results) {
+	// },
+	/**
+	 * Gets executed when a refresh happens.
+	 * @param {string} oldSessionId session ID of the old session
+	 * @param {string} newSessionId session ID of the new session
+	 */
+	// onReload: function(oldSessionId, newSessionId) {
+	// }
+	/**
+	 * Hook that gets executed before a WebdriverIO assertion happens.
+	 * @param {object} params information about the assertion to be executed
+	 */
+	// beforeAssertion: function(params) {
+	// }
+	/**
+	 * Hook that gets executed after a WebdriverIO assertion happened.
+	 * @param {object} params information about the assertion that was executed, including its results
+	 */
+	// afterAssertion: function(params) {
+	// }
+};

webpack.config.ts

@@ -14,314 +14,65 @@
  * 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,
-	IgnorePlugin,
-	NormalModuleReplacementPlugin,
-} from 'webpack';
-import * as PnpWebpackPlugin from 'pnp-webpack-plugin';
+import type { Configuration, ModuleOptions } from 'webpack';
+import { resolve } from 'path';
 
-import * as tsconfigRaw from './tsconfig.webpack.json';
+import { BannerPlugin, IgnorePlugin, DefinePlugin } from 'webpack';
 
-/**
- * Don't webpack package.json as 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 findUsbPrebuild(): string[] {
-	const usbPrebuildsFolder = path.join('node_modules', 'usb', 'prebuilds');
-	const prebuildFolders = readdirSync(usbPrebuildsFolder);
-	let bindingFile: string | undefined = 'node.napi.node';
-	const platformFolder = prebuildFolders.find(
-		(f) => f.startsWith(os.platform()) && f.indexOf(os.arch()) > -1,
-	);
-	if (platformFolder === undefined) {
-		throw new Error(
-			'Could not find usb prebuild. Should try fallback to node-gyp and use /build/Release instead of /prebuilds',
-		);
-	}
-
-	const bindingFiles = readdirSync(
-		path.join(usbPrebuildsFolder, platformFolder),
-	);
-
-	if (!bindingFiles.length) {
-		throw new Error('Could not find usb prebuild for platform');
-	}
-
-	if (bindingFiles.length === 1) {
-		bindingFile = bindingFiles[0];
-	}
-
-	// armv6 vs v7 in linux-arm and
-	// glibc vs musl in linux-x64
-	if (bindingFiles.length > 1) {
-		bindingFile = bindingFiles.find((file) => {
-			if (bindingFiles.indexOf('arm') > -1) {
-				const process = require('process');
-				return file.indexOf(process.config.variables.arm_version) > -1;
-			} else {
-				return file.indexOf('glibc') > -1;
-			}
-		});
-	}
-
-	if (bindingFile === undefined) {
-		throw new Error('Could not find usb prebuild for platform');
-	}
-
-	return [platformFolder, bindingFile];
-}
-
-const [USB_BINDINGS_FOLDER, USB_BINDINGS_FILE] = findUsbPrebuild();
-
-function findLzmaNativeBindingsFolder(): string {
-	const files = readdirSync(
-		path.join('node_modules', 'lzma-native', 'prebuilds'),
-	);
-	const bindingsFolder = files.find(
-		(f) =>
-			f.startsWith(os.platform()) &&
-			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 })) },
-	};
-}
-
-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,
-			}),
-		],
+const rules: Required<ModuleOptions>['rules'] = [
+	// Add support for native node modules
+	{
+		// We're specifying native_modules in the test because the asset relocator loader generates a
+		// "fake" .node file which is really a cjs file.
+		test: /native_modules[/\\].+\.node$/,
+		use: 'node-loader',
 	},
+	{
+		test: /[/\\]node_modules[/\\].+\.(m?js|node)$/,
+		parser: { amd: false },
+		use: {
+			loader: '@vercel/webpack-asset-relocator-loader',
+			options: {
+				outputAssetBase: 'native_modules',
+			},
+		},
+	},
+	{
+		test: /\.tsx?$/,
+		exclude: /(node_modules|\.webpack)/,
+		use: {
+			loader: 'ts-loader',
+			options: {
+				transpileOnly: true,
+			},
+		},
+	},
+	{
+		test: /\.css$/,
+		use: ['style-loader', 'css-loader'],
+	},
+	{
+		test: /\.(woff|woff2|eot|ttf|otf)$/,
+		loader: 'file-loader',
+	},
+	{
+		test: /\.svg$/,
+		use: '@svgr/webpack',
+	},
+];
+
+const injectAnalyticsToken = new DefinePlugin({
+	'process.env.SENTRY_TOKEN': JSON.stringify(process.env.SENTRY_TOKEN || ''),
+	'process.env.AMPLITUDE_TOKEN': JSON.stringify(
+		process.env.AMPLITUDE_TOKEN || '',
+	),
+});
+
+export const rendererConfig: Configuration = {
 	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('node-gyp-build')(__dirname);`,
-					replace: `require('./prebuilds/${LZMA_BINDINGS_FOLDER}/electron.napi.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\/usb\/dist\/usb\/bindings\.js$/, {
-				search: `require('node-gyp-build')(path_1.join(__dirname, '..', '..'));`,
-				replace: `require('../../prebuilds/${USB_BINDINGS_FOLDER}/${USB_BINDINGS_FILE}')`,
-			}),
-			// 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')",
-			}),
-			replace(/node_modules\/node-raspberrypi-usbboot\/build\/index\.js$/, {
-				search:
-					"return await readFile(Path.join(__dirname, '..', 'blobs', filename));",
-				replace: outdent`
-					const remote = require('@electron/remote');
-					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.
-							remote.app.getAppPath().replace(/\\.asar$/, () => process.platform === 'darwin' ? '-' + process.arch : ''),
-							'generated',
-							__dirname.replace('node_modules', 'modules'),
-							'..',
-							'blobs',
-							filename
-						)
-					);
-				`,
-			}),
-			// Copy native modules to generated folder
-			{
-				test: /\.node$/,
-				use: [
-					{
-						loader: 'native-addon-loader',
-						options: { name: renameNodeModules },
-					},
-				],
-			},
-		],
-	},
-	resolve: {
-		extensions: ['.node', '.js', '.json', '.ts', '.tsx'],
+		rules,
 	},
 	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',
-		),
 		// Ignore `aws-crt` which is a dependency of (ultimately) `aws4-axios` which is used
 		// by etcher-sdk and does a runtime check to its availability. We’re not currently
 		// using the “assume role” functionality (AFAIU) of aws4-axios and we don’t care that
@@ -330,100 +81,32 @@ const commonConfig = {
 		new IgnorePlugin({
 			resourceRegExp: /^aws-crt$/,
 		}),
-	],
-	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',
-	},
-];
-
-if (os.platform() === 'win32') {
-	// liblzma.dll is required on Windows for lzma-native
-	guiConfigCopyPatterns.push({
-		from: `node_modules/lzma-native/prebuilds/${LZMA_BINDINGS_FOLDER}/liblzma.dll`,
-		to: `modules/lzma-native/prebuilds/${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 }),
+		injectAnalyticsToken,
 	],
-};
 
-const mainConfig = {
-	...commonConfig,
-	target: 'electron-main',
-	node: {
-		__dirname: false,
-		__filename: true,
+	resolve: {
+		extensions: ['.js', '.ts', '.jsx', '.tsx', '.css'],
+		alias: {
+			// need to alias ws to the wrapper to avoid the browser fake version to be used
+			ws: resolve(__dirname, 'node_modules/ws/wrapper.mjs'),
+		},
 	},
 };
 
-const etcherConfig = {
-	...mainConfig,
+export const mainConfig: Configuration = {
 	entry: {
-		etcher: path.join(__dirname, 'lib', 'gui', 'etcher.ts'),
+		etcher: './lib/gui/etcher.ts',
 	},
-};
-
-const childWriterConfig = {
-	...mainConfig,
-	entry: {
-		'child-writer': path.join(
-			__dirname,
-			'lib',
-			'gui',
-			'modules',
-			'child-writer.ts',
-		),
+	module: {
+		rules,
 	},
+	resolve: {
+		extensions: ['.js', '.ts', '.jsx', '.tsx', '.css', '.json'],
+	},
+	plugins: [injectAnalyticsToken],
 };
-
-export default [guiConfig, etcherConfig, childWriterConfig];