Better Mock updates

[goosewobbler]

TODO:

• Use @vitest/spy
• Update E2E tests for mock
• Add E2Es for mockReturnValue
• Unit tests - execute
• Unit tests - removeMocks
• Improve types
• Fix linting

[christian-bromann]

@goosewobbler feel free to adjust the test coverage if necessary, we can always increase it later as well.

[goosewobbler]

I think this is good for review, the documentation / API deprecation updates can be done on the main PR and we can follow up with more units.

[christian-bromann]

Great work, I have one suggestion on the API design

[christian-bromann]

I wonder if it makes more sense to just call

const mockedShowOpenDialog = await browser.electron.mock('dialog', 'showOpenDialog')

instead of doing this. It would more align to vitest and jest APIs so user are more familiar with what they need to do.

Is there any advantage of an additional getMock / setMock call?

[christian-bromann]

You would call unmock via:

browser.electron.unmock('dialog', 'showOpenDialog')

see https://vitest.dev/api/vi.html#vi-unmock

[goosewobbler]

I'll see what I can do here, it does make sense to have a single-liner for mocking (and unmocking) an API function but there is a reason I did it this way -- I was running into trouble getting the mock value to update after being called - because it needs to get the calls from the inner mock in the electron main process and re-apply them. I messed around with getters for a while and some other approaches but wasn't able to make the following work:

const mockedShowOpenDialog = await browser.electron.mock('dialog', 'showOpenDialog');
await browser.electron.execute(
  async (electron) =>
    await electron.dialog.showOpenDialog({
      title: 'my dialog',
      properties: ['openFile', 'openDirectory'],
    }),
);

expect(mockedShowOpenDialog).toHaveBeenCalledTimes(1);
expect(mockedShowOpenDialog).toHaveBeenCalledWith({
  title: 'my dialog',
  properties: ['openFile', 'openDirectory'],
});

So, we may be able to condense setMock into mock but a separate call to update the outer mock may well be unavoidable (perhaps e.g. mockedShowOpenDialog.update()), unless there's another way of doing it that I'm not aware of...

[goosewobbler]

getting there...

[christian-bromann]

@goosewobbler I wonder if there is a way to have a bidirectional messaging between service and injected Electron code to have these mocks autoupdate, wdyt?

[goosewobbler]

@christian-bromann makes sense that could work, I'll merge this to the original PR and work on it there.