How do you create a Windows package from Bruno?

[nddipiazza]

is there a nightly release area somewhere?
I want a recent PR merged so i built my own
but now i want to create a windows package so i can share it with another team member.
how do i create the windows packages ?

[pietrygamat]

To build .exe package on Windows 11 I did:

1. Install windows version of nvm
2. Generate self-signed code signing certificate (I failed to figure out how to skip .exe signing). I used keystore explorer for that, because I am familiar with this tool:
   a. File -> New -> PKCS12
   b. Generate Key Pair -> OK
   c. Edit Name -> Enter any name -> OK
   d. Add Extensions -> Use standard template -> Code Signing -> OK
   e. Set key password
   f. Save as .p12 file -> Set store password same as key password
3. Set environment variables pointing to the certificate and password just created

   WIN_CERT_FILEPATH=c:\path\to\my-cert.p12
   WIN_CERT_PASSWORD=my-key-password
   

4. In Windows Terminal (powershell) or Git-Bash, in bruno repo root execute:

   nvm install $(cat .nvmrc)
   nvm use $(cat .nvmrc)
   npm i --legacy-peer-deps
   npm run build:graphql-docs
   npm run build:bruno-query
   npm run build:bruno-common
   npm run build:web
   npm run build:electron
   

In the end, the installer appeared in <bruno-root>/packages/bruno-electron/out.

I would appreciate if someone could shed a light on how to skip signing, because untrusted signature may be worse than no signature at all, depending on how strict your environment is.

[nddipiazza]

From discord:

Install dependencies with npm i

First build all packages:
npm run build:graphql-docs
npm run build:bruno-query
npm run build:bruno-common
npm run build:web

And then you can create a binary with npm run build:electron:win. This creates a binary under packages/bruno-electron/dist.

[nddipiazza]

did not work:

info  - Loaded env from E:\dev\bruno-app\bruno\packages\bruno-app\.env.production
info  - using build directory: E:\dev\bruno-app\bruno\packages\bruno-app\.next
info  - Copying "static build" directory
info  - No "exportPathMap" found in "E:\dev\bruno-app\bruno\packages\bruno-app\next.config.js". Generating map from "./pages"
info  - Launching 3 workers
info  - Copying "public" directory
info  - Exporting (6/6)
Export successful. Files written to E:\dev\bruno-app\bruno\packages\bruno-app\out

> build:electron:win
> ./scripts/build-electron.sh win

'.' is not recognized as an internal or external command,
operable program or batch file.

[nddipiazza]

again echoing our discord conversation:

Looks like the default build script does work on windows. I made a build script for another PR:

const os = require('os');
const fs = require('fs-extra');
const spawn = require('child_process').spawn;

function log(...args) {
  console.log('-> ', ...args);
}
function error(...args) {
  console.log('!> ', ...args);
}

async function deleteFileIfExists(filePath) {
  try {
    const exists = await fs.pathExists(filePath);
    if (exists) {
      await fs.remove(filePath);
      log(`${filePath} has been successfully deleted.`);
    } else {
      log(`${filePath} does not exist.`);
    }
  } catch (err) {
    error(`Error while checking the existence of ${filePath}: ${err}`);
  }
}

async function copyFolderIfExists(srcPath, destPath) {
  try {
    const exists = await fs.pathExists(srcPath);
    if (exists) {
      await fs.copy(srcPath, destPath);
      log(`${srcPath} has been successfully copied.`);
    } else {
      log(`${srcPath} was not copied as it does not exist.`);
    }
  } catch (err) {
    error(`Error while checking the existence of ${srcPath}: ${err}`);
  }
}

async function removeSourceMapFiles(directory) {
  try {
    const files = await fs.readdir(directory);
    for (const file of files) {
      if (file.endsWith('.map')) {
        const filePath = path.join(directory, file);
        await fs.remove(filePath);
        log(`${filePath} has been successfully deleted.`);
      }
    }
  } catch (error) {
    error(`Error while deleting .map files: ${error}`);
  }
}

/**
 * @param {String} command
 * @param {String[]} args
 * @returns {Promise<void>}
 */
async function execCommandWithOutput(command, args) {
  return new Promise(async (resolve, reject) => {
    const childProcess = spawn(command, args, {
      stdio: 'inherit',
      shell: true
    });
    childProcess.on('error', (error) => {
      reject(error);
    });
    childProcess.on('exit', (code) => {
      if (code === 0) {
        resolve();
      } else {
        reject(new Error(`Command exited with code ${code}.`));
      }
    });
  });
}

/**
 * @param {String[]} args
 * @returns {Promise<number>}
 */
async function main(args) {
  let target = args[args.length - 1];
  if (!target || target === __filename) {
    // Auto detect target
    if (os.platform() === 'win32') {
      target = 'win';
    } else if (os.platform() === 'darwin') {
      target = 'mac';
    } else {
      target = 'linux';
    }
    log('Target automatically set to ', target);
  }

  log('Clean up old build artifacts');
  await deleteFileIfExists('packages/bruno-electron/web');
  await deleteFileIfExists('packages/bruno-app/out');

  log('Building web');
  await execCommandWithOutput('npm', ['run', 'build:web']);
  await fs.ensureDir('packages/bruno-electron/web');
  await copyFolderIfExists('packages/bruno-app/out', 'packages/bruno-electron/web');

  // Change paths in next
  const files = await fs.readdir('packages/bruno-electron/web');
  for (const file of files) {
    if (file.endsWith('.html')) {
      let content = await fs.readFile(`packages/bruno-electron/web/${file}`, 'utf8');
      content = content.replace(/\/_next\//g, '_next/');
      await fs.writeFile(`packages/bruno-electron/web/${file}`, content);
    }
  }

  // Run npm dist command
  log(`Building the Electron app for target: ${target}`);
  await execCommandWithOutput('npm', ['run', `dist:${target}`, '--workspace=packages/bruno-electron']);
  log('Build complete');
  return 0;
}

main(process.argv)
  .then((code) => process.exit(code))
  .catch((e) => console.error('An error occurred during build', e) && process.exit(1));

You can just put it in the root dir and excute it with node. This replaces the npm run build:electron:win

You also need to comment out certificateFile & certificatePassword in the electron-builder-config.js

[nddipiazza]

This worked. @pietrygamat - fyi no need for signing was here by commenting out those 2 lines as suggested

[nddipiazza]

re-opening the discussion.
i reached out to @Its-treason on discord. the exe does not seem to update gracefully unless we manually delete the Bruno folder.

steps to reproduce issue:

• build this PR Feat: Add support for PKCS12 / PFX client certificates for mTLS #2336 using method described above
• you get an exe file with the fix
• shut down bruno
• apply exe
• relaunch bruno

notice how the bruno app appears to be busted.

close bruno
delete %LocalAppData%\Programs\bruno

then run the exe again. this time it works.