[desktop] Add additional types for electron auto updating
ClosedPublic
Actions

Authored by michal on Jan 20 2023, 4:02 AM.

Details

Reviewers

tomek
inka
ginsu

Commits

rCOMM0b8a447bab11: [desktop] Add additional types for electron auto updating

Summary

This diff adds types for autoUpdater module and other properties used in the later diffs. They are taken from the official electron documentation. Documentation

Test Plan

Run flow in the desktop workspace. Also run flow including diffs later on in the stack

Diff Detail

Repository

rCOMM Comm

Lint

No Lint Coverage

Unit

No Test Coverage

Event Timeline

michal created this revision.Jan 20 2023, 4:02 AM

Herald added subscribers: atul, ashoat. · View Herald TranscriptJan 20 2023, 4:02 AM

michal added inline comments.Jan 20 2023, 4:03 AM

desktop/flow-typed/npm/electron_v22.0.0.js
217	This can be assigned to return a value from the callback, so I've removed the read-only modifier.

michal added a child revision: D6322: [desktop] Add auto updating.Jan 20 2023, 4:07 AM

Harbormaster completed remote builds in B15495: Diff 21139.Jan 20 2023, 4:16 AM

michal requested review of this revision.Jan 20 2023, 4:16 AM

tomek accepted this revision.Jan 26 2023, 3:50 AM

tomek added inline comments.

desktop/flow-typed/npm/electron_v22.0.0.js
188–192	The doc says that On Windows only releaseName is available. So maybe other props should be marked as optional?
217	Not really sure about this change. It depends on the usage, but we should be able to keep this read only and construct a new object / assign a type just before the return. But it's also possible that the purpose is to return the value by mutating an argument - this is an ugly pattern, but if the lib works that way, we have to reflect that in the types.

This revision is now accepted and ready to land.Jan 26 2023, 3:50 AM

Marked props available only on macOS as optional, thanks for catching that. I've also added a few additional events, because I will be using some of them in the next diffs.

michal added inline comments.Jan 30 2023, 3:52 AM

desktop/flow-typed/npm/electron_v22.0.0.js
217	But it's also possible that the purpose is to return the value by mutating an argument - this is an ugly pattern, but if the lib works that way, we have to reflect that in the types. Yeah, that's how it works for sync communication, unfortunately. `ipcMain.on('event', ev => {ev.returnValue = 123;});`