feat: add custom dialog option

[ArthurLobopro]

Hello, how you merged the PR #105 I rewrite the PR #97 to avoid merge conflicts. I am unable to test the feature on windows or macos so if someone can test it I will be grateful :)

Closes #116

[dsanders11]

Needs semicolons to match coding style.

[ArthurLobopro]

I think I added all the missing semicolons, did I forget someone?

[erickzhao]

Some general feedback on the approach:

@ArthurLobopro have you considered instead exposing an API that allows users to hook in their own custom dialog code?

I wonder if a more generalized approach would be better than adding individual API options for the individual buttons.

[ArthurLobopro]

@erickzhao I think the most people that want to change something on the dialog only wants to change the update message to something different (Like the Issue #116 ) or in another language (this is my case).

Somehow, a way to do my own custom dialog can be interesting I think. How would you implements that?

[dsanders11]

I think the possibility to localize the text is a reasonable feature, and should probably be supported without requiring users to re-implement the dialog all together.

For customizing the dialog more deeply, though, we could look at providing a hook, say IUpdateElectronAppOptions .onNotifyUser which takes a function. Then we could export a makeUserNotifier(options: IDialogMessages), which has this code moved to it and returns a function.

update-electron-app/src/index.ts

Lines 186 to 202 in 0637390

	(event, releaseNotes, releaseName, releaseDate, updateURL) => {
	log('update-downloaded', [event, releaseNotes, releaseName, releaseDate, updateURL]);
	const { title, restartButtonText, laterButtonText, detail } = opts.dialog;
	const dialogOpts = {
	type: 'info',
	buttons: [restartButtonText, laterButtonText],
	title,
	message: process.platform === 'win32' ? releaseNotes : releaseName,
	detail,
	};
	dialog.showMessageBox(dialogOpts).then(({ response }) => {
	if (response === 0) autoUpdater.quitAndInstall();
	});
	},

Then to do localization the user would do:

updateElectronApp({
  ...,
  onNotifyUser: makeUserNotifier({ 
    restartButtonText: 'Restart!!'
  })
})

And if they wanted to more deeply customize the notify they have a hook to do whatever they'd like:

updateElectronApp({
  ...,
  onNotifyUser: (event, releaseNotes, releaseName, releaseDate, updateURL) => {
    if (releaseName === 'AwesomeRelease') {
      // Do fireworks
    }
  }
})

Stale

[ArthurLobopro]

@dsanders11 great idea! @erickzhao what do you think about that?

[ArthurLobopro]

I realize if we provide the hook we will lose the logger context, because the logger is declared inside the updateElectronApp function.

update-electron-app/src/index.ts

Lines 154 to 156 in 0637390

	function log(...args: any[]) {
	logger.log(...args);
	}

To solve it I think we can add a listener just to log it:

 autoUpdater.on(
      'update-downloaded',
      (event, releaseNotes, releaseName, releaseDate, updateURL) => {
        log('update-downloaded', [event, releaseNotes, releaseName, releaseDate, updateURL]);
      },
    );
    
 autoUpdater.on(
  'update-downloaded',
  (event, releaseNotes, releaseName, releaseDate, updateURL) => { 
      const { title, restartButtonText, laterButtonText, detail } = opts.dialog;

      const dialogOpts = {
        type: 'info',
        buttons: [restartButtonText, laterButtonText],
        title,
        message: process.platform === 'win32' ? releaseNotes : releaseName,
        detail,
     };

    dialog.showMessageBox(dialogOpts).then(({ response }) => {
        if (response === 0) autoUpdater.quitAndInstall();
    });
  },);

[ArthurLobopro]

I found another thing.

When we create the dialog, we pick the dialog API from electron in the options

update-electron-app/src/index.ts

Line 124 in 0637390

const { updateSource, updateInterval, logger, electron } = opts;

update-electron-app/src/index.ts

Line 132 in 0637390

const { app, autoUpdater, dialog } = electron;

But to create a separated function to create the notifier, maybe we will need to import directly from electron.

[dsanders11]

When we create the dialog, we pick the dialog API from electron in the options

It looks like this is just an undocumented option for testing purposes (I'm not familiar with this code base, but that's my take from a quick read), so it could similarly be an undocumented option on IDialogMessages, or we could tweak the signature of the proposed onNotifyUser to receive an object and it could be an undocumented value there:

updateElectronApp({
  ...,
  onNotifyUser: (info) => {
    const { event, releaseNotes, releaseName, releaseDate, updateURL } = info;
    // info.electron is an undocumented value for tests
    if (releaseName === 'AwesomeRelease') {
      // Do fireworks
    }
  }
})

[ArthurLobopro]

I don't know why this error happens. The Electron namespace is already referenced here:

update-electron-app/src/index.ts

Line 207 in 1c9e970

const electron: typeof Electron.Main = (opts as any).electron || require('electron');

[ArthurLobopro]

Can someone test it on Windows or Macos? I am using Linux on my PC.

[ArthurLobopro]

Do we had any progress here?

[doctorXWrites]

Any update here? I'm looking for some way to be able to show release notes in update dialog.

[ArthurLobopro]

@doctorXWrites Just waiting for approval, but maybe the reviewer forgot this PR because Github stops showing PRs with no activity after 2 weeks.

I will mark he here to confirm this

@dsanders11

[erickzhao]

I have a few things to change that I'm planning on pushing up. Sorry for the wait @ArthurLobopro!

[ArthurLobopro]

@erickzhao No problem, I'm available to help if necessary

[erickzhao]

Here's a pre-requisite PR that makes the testing experience more delightful: #171

I have my implementation changes ready at the moment locally but wanted to improve test coverage when landing a new features.

edit: another PR to make linting/formatting more consistent with this repo: #172

[erickzhao]

Okay, all PRs have been merged, will write tests for my implementation changes and request reviews from other maintainers.

[erickzhao]

Hey @ArthurLobopro, I just pushed up all changes and rebased against main.

The biggest difference is that the default implementation for makeUserNotifier is used if notifyUser is true but no onNotifyUser function is passed through. I also added tests for makeUserNotifier.

Do you mind giving this a spin to test it out?

stale review

[erikian]

Looking good!

[continuous-auth]

🎉 This PR is included in version 3.1.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀