Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

MSIX: initial implement notifications library #1178

Merged
merged 2 commits into from
Feb 4, 2020
Merged

MSIX: initial implement notifications library #1178

merged 2 commits into from
Feb 4, 2020

Conversation

yuyoyuppe
Copy link
Collaborator

@yuyoyuppe yuyoyuppe commented Jan 29, 2020 •
edited
Loading

Summary of the Pull Request

Initial implementation of #1020:

  • simple MessageBox-like toasts
  • toasts with multiple buttons with background activation and easy handler registration

PR Checklist

Detailed Description of the Pull Request / Additional comments

PT is a Desktop Bridge app, not a true UWP app, because we need to run it full-trust to access numerous APIs and have compatibility with MSI. We might want to fully port it to UWP in the future, but as it currently is, the toast notifications' registration is done in a bit roundabout way.

We must implement IBackgroundTask as an in-proc activation server (WinRT analogue of in-proc COM server) if we want reacting to ToastNotification's actions while the PT isn't running.

Since IBackgroundTask implementation class should be in a WinRT component library to be built correctly, it must use the dynamic version of C/C++ runtime. That means it cannot link e.g. common libraries to it, since all PT's modules use static runtime instead. Moreover, it cannot be the activatable DLL directly, since in that case it must be linked to a true UWP app, otherwise we get an obscure error in the Event viewer while Windows was trying to launch our background task:

failed to activate with error code 0x8007007E

After some researching, I've discovered that it actually means that Windows uses WinRT analogue of regsvr32 to load notifications.dll and instantiate IBackgroundTask's class, but fails to do so because of missing msvcp140_app.dll and the like. Those libraries are UWP versions of C/C++ runtime and, as we imagine, shouldn't be distributed with our app directly. Since we're a Desktop Bridge app, dynamic loader isn't made aware of them, and we fail to load our DLL.

That brings us to the following design:

  • notifications is a static WinRT library with a dynamic C/C++ runtime which implements a single IBackgroundTask implementation class which serves as a dispatcher for all background tasks handlers
  • all actual handlers should be implemented in notifications library and registered via handler_functions.cpp:handlers_map
  • notifications_dll is a classic DLL library with a dynamic C/C++ runtime which implements some plumbing and avoids having to deal with 0x8007007E. we register it as a activator in manifest
  • common library and any other PT modules can use new notifications API functions for showing toasts using the src/common/notifications.h header

Validation Steps Performed

  • unit test passed
  • launched multiple toasts

@enricogior
Copy link
Contributor

@ryanbodrug-microsoft
in case this may also be useful for the new modules under development, I would like to have your feedback on it.
It was develop without a spec, so we need to add the documentation now.
@yuyoyuppe your PR detailed description should be part of the documentation. Can you add it to devdocs?

@yuyoyuppe yuyoyuppe mentioned this pull request Jan 30, 2020
Closed
@yuyoyuppe
Copy link
Collaborator Author

yuyoyuppe commented Jan 30, 2020 •
edited
Loading

@enricogior The current description is mostly a rationale of current design due to numerous internal issues I've encountered, which are hopefully shouldn't be encountered again by everyone after this is merged.

I'll provide a separate documentation as part of this PR on how to use the library. I can also copy the PR's description to some "inner workings" doc.

bzoz
bzoz reviewed Jan 30, 2020
View reviewed changes
src/common/notifications.h Outdated Show resolved Hide resolved
bzoz
bzoz reviewed Jan 30, 2020
View reviewed changes
src/common/notifications.h Outdated Show resolved Hide resolved
bzoz
bzoz reviewed Jan 30, 2020
View reviewed changes
src/common/notifications.cpp Outdated Show resolved Hide resolved
@enricogior
Copy link
Contributor

a rationale of current design due to numerous internal issues I've encountered

Those are still useful insights to know. Feel free to reference this PR in the documentation so the info doesn't get lost and will be easily available in the future.

@yuyoyuppe yuyoyuppe requested a review from bzoz January 30, 2020 09:40
@yuyoyuppe
Copy link
Collaborator Author

a rationale of current design due to numerous internal issues I've encountered

Those are still useful insights to know. Feel free to reference this PR in the documentation so the info doesn't get lost and will be easily available in the future.

done.

enricogior
enricogior approved these changes Feb 4, 2020
View reviewed changes
Copy link
Contributor

@enricogior enricogior left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, excellent work.

@yuyoyuppe
Copy link
Collaborator Author

rebased to resolve conflicts w/ master.

@yuyoyuppe yuyoyuppe merged commit 5089729 into microsoft:master Feb 4, 2020
@yuyoyuppe yuyoyuppe deleted the issue_1020 branch February 4, 2020 16:41
@yuyoyuppe yuyoyuppe mentioned this pull request Feb 4, 2020
Closed
udit3333 pushed a commit to udit3333/PowerToys that referenced this pull request Feb 19, 2020
@yuyoyuppe @udit3333
MSIX: implement initial version of notifications library (microsoft#1178
689c710 
)
udit3333 pushed a commit to udit3333/PowerToys that referenced this pull request Feb 19, 2020
@yuyoyuppe @udit3333
MSIX: implement initial version of notifications library (microsoft#1178
eda6203 
)
udit3333 pushed a commit to udit3333/PowerToys that referenced this pull request Feb 20, 2020
@yuyoyuppe @udit3333
MSIX: implement initial version of notifications library (microsoft#1178
7c13a27 
)
udit3333 pushed a commit to udit3333/PowerToys that referenced this pull request Feb 20, 2020
@yuyoyuppe @udit3333
MSIX: implement initial version of notifications library (microsoft#1178
295aa11 
)
udit3333 pushed a commit to udit3333/PowerToys that referenced this pull request Feb 20, 2020
@yuyoyuppe @udit3333
MSIX: implement initial version of notifications library (microsoft#1178
29909a8 
)
udit3333 pushed a commit to udit3333/PowerToys that referenced this pull request Feb 20, 2020
@yuyoyuppe @udit3333
MSIX: implement initial version of notifications library (microsoft#1178
550eefb 
)
udit3333 pushed a commit that referenced this pull request Feb 20, 2020
@yuyoyuppe @udit3333
MSIX: implement initial version of notifications library (#1178)
c8f468d
arjunbalgovind added a commit to arjunbalgovind/PowerToys that referenced this pull request Mar 3, 2020
@arjunbalgovind @alekhyareddy28
@vldmr11080 @yuyoyuppe @bzoz @crutkas @enricogior @betsegaw @saahmedm @jerone @shanselman @stefansjfw @SeraphimaZykova @chrdavis @jyuwono @yevhenii44-zz @PrzemyslawTusinski @torchgm
User/arbalgov/rebase test1 (#18)
6973bb1 
* added the helper functions

* localized dllmain powerrename

* localized powerRenameExt

* localized the settings file

* built the proj

* Modified resourceIDs for strings in the table

* added common as a reference project

* Removed get_res_string_wchar and used the get_resource_string() function instead which returns a wstring typecast into wchar*

* Added new lines to the end of the file

* Removed string resources from the settings.cpp file

* rebuilt project PowerRename

* moved app name to constructor to init only once

* updated formatting of common.cpp

* reverting formatting of files

* Removed some IDs from resource file. Changed SHIFT to Shift

* Localizing C# Project of FancyZones (FancyZonesEditor) (microsoft#199) (microsoft#1122)

* removed hardcoded strings from CanvasEditorWindow.xaml

* removed hardcoded strings from GridEditorWindow.xaml

* loc

* Localized MainWindow

* reverting MainWindow.xaml as it is not rendering the window as expected

* Changed the resource settings from internal to public

* the culture is set based on the culture of the system UI set in the system settings

* Removed the french resource files used for testing

* Localized canvasWindow and mainwindow

* Removed setting the UI culture explicitly as it would be implicitly set to the culture of system UI

* Removed redundant header file

* Localize the Shortcut guide PowerToy (microsoft#199) (microsoft#1126)

* Localized shortcut_guide.cpp

* localized overlay_window.cpp

* formatting changes

* Localize overlay window

* removed the README link from the set of localized resources

* Typo: changed upper to lower

* Localize C++ Projects of FancyZones (microsoft#1130)

* localized dllmain.cpp  of fancyzones project

* localized FancyZones.cpp

* format fancyzones.rc file

* Moved SuperFancyZones back to being a string instead of having it in the resource file as it is the window class name

* reverted changes for window name

* Formatted fancyzones rc file

* Align zone dimensions from layout preview with those from grid editor (microsoft#1115)

* MSIX: add a dedicated .rc for UWPUI which joins both UI and DLL .rc's (microsoft#1139)

* Runner: fix restarting with same elevation (microsoft#1133)

* MSIX: reinstall script uses bundle instead of .msi to be able to reinstall in all cases

* Changes for microsoft#1140 and microsoft#569 (microsoft#1152)

* Settings: initialize COM security to allow communication between elevated Settings and WebView

* Common: implement on_scope_exit helper and typed_storage

* Telemetry: add WebView init failure errors

* MSIX build instructions adjustmnet (microsoft#1170)

* MSIX: update identity name and publisher (microsoft#1176)

* MSIX: hide the "Run at Startup" option if running as packaged

* Runner: fix startup task state setting for MSIX (microsoft#1181)

* Import the source code for Window Walker (microsoft#1177)

Import the codebase for Window Walker 

- Not loaded into the module list 
- Not added it to the installer list.

* Adding KeyManager spec (microsoft#1112)

* Adding KeyManager spec

* adding req changes

* req changes

* changed wording

* md edits

* edit md

* Update doc/specs/KeyboardManager.md

Co-Authored-By: Jeroen van Warmerdam <jeronevw@hotmail.com>

* further edits

* Update KeyboardManager.md

* Update KeyboardManager.md

Co-authored-by: Jeroen van Warmerdam <jeronevw@hotmail.com>

* Update README.md (microsoft#1198)

* Fancyzones: unify window filtering (microsoft#1184)

Makes FancyZone use the same code for filtering windows when windows are
being dragged and when moved by WinKey + arrows.

* MSIX: fix uninstallation from msix_reinstall and split the scripts (microsoft#1183)

* MSIX: implement initial version of notifications library (microsoft#1178)

* FancyZones: allow windows with invisible or zero-sized owner to be zonable (microsoft#1216)

* FancyZones: filter out WM_POPUP windows if they dont have maximize/minimize button or a sizable frame (microsoft#1212)

This filters out TaskView and Win32 menus.

* FancyZones: if window is not interesting, allow Windows snap (microsoft#1186)

Do not swallow WinKey+Arrow events for non-interesting windows. This makes apps that are in the "excluded apps" list behave as if "Override windows snap keys" is disabled - they will react to the Windows default snap.

* Common: remove hwnd_data_cache (microsoft#1223)

The cache was introduced to improve performance by not querying the
OS for the window process path every time we need to check if the window
is interesting to FancyZones. Since then other changes were made to the
the way we check the windows. Right now, the IsInterestingWindow function is
called when:

  1) WinKey + arrows are used
  2) window is started to be dragged
  3) window is created

1) and 2) are initiated by the user, happen only once per interaction so
their performance impact can be dismissed. The 3) happens all the time
but for the most part the check for WS_CHILD or
GetAncestor(window, GA_ROOT) == window will filter those out. In the
end, only top-level windows will be queried for their path.

Removing the cache improves code readability and will make code
maintenance easier.

* MSIX: keep PowerRename local COM server in memory (microsoft#1222)

* ShortcutGuide, FancyZones: split window filtering (microsoft#1225)

Splits the code use to filter windows for FancyZones and the
"active window" for the ShortcutGuide. The FancyZones logic is preserved
and merged into a single function. We keep it in common.h, as it might
be also used in other PowerToys, like maximized to new desktop. We do
however change the return type to be more descriptive. It also returns
a separate flag for if the window has a visible owner. This can be used
to implement the approved apps list.

For the ShortcutGuide, the logic is relaxed to include more windows. One
example are Explorer properties windows. Those are (and should) filtered
by the FancyZones, but should appear in the window preview in the SCG.

The new return type also includes information if the window will react
to the default Windows Snap. This is not ideal though. Currently, SCG
can only disable the entire "Windows Controls" group. OTOH windows like
"Save As..." dialogs can be snapped to corners etc., but cannot be
minimized nor maximized. Until SCG can separately disable those buttons
we will display the buttons in the enabled state only if the window
supports all settings. In the future, we should integrate FancyZones
snap override here too.

* Update MSIX Readme with sideloading steps (microsoft#1237)

* Small English grammer issue "in the desktop" -> "on the desktop" (microsoft#1238)

Small English grammer issue "in the desktop" -> "on the desktop"

* sln: fix project dependency order (microsoft#1249)

* Migrate FancyZones data persisting from Registry to JSON file (microsoft#1194)

* Migrate FancyZones data persisting from Registry to JSON file

* Address PR comment: Remove redundant check

* Addres PR comment: Remove unused Dpi and add CmdArgs enum

* Address PR comment: Make methods const and inline

* Address PR comments: Expose GenerateUniqueId function and use const ref instead of passing wstring by value

* Address PR comment: Use lamdba as callback

* Address PR comment: Move GenerateUniqueId to ZoneWindowUtils namespace

* Address PR comment: Use regular comparison instead of std::wstring::compare

* Address PR comment: Use std::wstring_view for tmp file paths

* Address PR comment: Use scoped lock when accessing member data

* Address PR comment: Remove typedefs to increase code readability

* Address PR comment: removed nullptr checks with corresponding tests

* Address PR comment: Move ZoneSet object instead of copying

* Address PR comment: Make FancyZonesData instance const where possible

* Remove unnecessary gutter variable during calculating zone coordinates

* Remove uneeded subclass

* Avoid unnecessary copying and reserve space for vector if possible

* Save FancyZones data after exiting editor

* App zone history (#18)

* added window and zone set ids to app zone history

* Rename JSON file

* Remove AppZoneHistory migration

* Move parsing of ZoneWindow independent temp files outside of it

* Unit tests update (#19)

* check device existence in map
* updated ZoneSet tests
* updated JsonHelpers tests

* Use single zone count information

* Remove uneeded tests

* Remove one more test

* Remove uneeded line

* Address PR comments - Missing whitespace

* Update zoneset data for new virtual desktops (microsoft#21)

* update active zone set with actual data

* Introduce Blank zone set (used to indicate that no layout applied yet). Move parsing completely outside of ZoneWindow.

* Fix unit tests to match modifications in implementation

* Fix applying layouts on startup (second monitor)

Co-authored-by: vldmr11080 <57061786+vldmr11080@users.noreply.github.com>
Co-authored-by: Seraphima <zykovas91@gmail.com>

* Fix crash when saving any module settings while module being disabled (microsoft#1259)

* Unit-tests fixes (microsoft#1265)

* fixed typecast warnings
* removed unneded tests

* Persist app zone history in real time (microsoft#1257)

* save settings every time changes are performed
* settings are not saved on app exit

* Set the rename button to the default button on the dialog. Prior to this change, users would setup the rename inputs and hit return only to discover the cancel button had the key focus and all work would be lost. (microsoft#1271)

* Add design change request for improvements in virtual desktops handling (microsoft#1270)

* Add telemetry event for general settings (microsoft#1269)

* telemetry for general settings

* Update FancyZones telemetry event for settings changed (microsoft#1268)

* Update FancyZones-DCR.md (microsoft#1280)

* removing done specs to wiki (microsoft#1276)

* Added PowerLauncher spec and images (microsoft#1109)

* Added PowerLauncher spec and images

* Fixed images path

* Addressed review comments

* Fixed images

* Addressed review comments, and added link to keyboard shortcut manager PowerToy

* Added Ueli in comparison table

* Added keyboard input element

* Added suggestions from community

* Moved default shell and terminal settings

* Addressed feedback

* Added community suggestion

* Modified spec based on feedback

* Modified spec based on suggestions

* Added keyboard shortcuts to context menu options

* Add telemetry event for PowerRename settings  (microsoft#1279)

* moved MAX_INPUT_STRING_LEN constant
* added settings changed event log

* MSIX: add missing dependencies for the FancyZonesEditor (microsoft#1298)

* moving stuff to wiki (microsoft#1302)

* Thread safety for FanncyZonesData (microsoft#1281)

* FancyZones: make FancyZonesData thread-safe

* fixup: format affected sources

* fixup: clang-format case-style and format FancyZones.cpp

* fixup! add missing lock

* PowerRename: bring the rename dialog to foreground

* MSIX: do not kill explorer.exe, since it's only necessary for the MSI version

* Add telemetry event for FZ editor (microsoft#1294)

* trace zones settings changes

* Introduce handling of new/old work areas (microsoft#1296)

* Introduce handling of new/old work areas (defined by virtual desktop id and monitor)

* Save data to JSON storage only once after we register all deleted virtual desktops

* Update saving mechanism

* Remove resolution from unique identifier

* Update comments related to new unique identifier

* Don't handle NULL GUID as it is default one

* Revert "Remove resolution from unique identifier"

This reverts commit 5a36651.

* Revert "Update comments related to new unique identifier"

This reverts commit 8e89802.

* removed MigrateDeviceInfoFromRegistry

Co-authored-by: Seraphima Zykova <zykovas91@gmail.com>

* MSIX: prompt and uninstall MSI PT version (microsoft#1248)

* v1 spec (microsoft#1275)

* v1 spec, from here we'll create a roadmap much like Terminal.  (https://github.com/microsoft/terminal/blob/master/doc/terminal-v1-roadmap.md)

* adding in more issue xref links

* add in UX migration time

* Update v1.0.md

* Update v1.0.md

* Update v1.0.md

* Update v1.0.md

* moving to https://github.com/microsoft/PowerToys/wiki/Version-1.0-Strategy (microsoft#1315)

* "Always run as administrator" and "Restart as ..." only for administrator account (microsoft#1318)

* Setup: sign PowerRenameExt.dll (microsoft#1313)

* runner: fix Restart as... option

* settings: fix general settings hanging on save for a non-admin user

* settings: remove Restart as a user button in an elevated context (microsoft#1328)

* settings: add a clarifying label if running as elevated (microsoft#1330)

* Adding in HitTester App

* bug fix

* Runner check for MSI and MSIX (microsoft#1345)

* Add startup check for the MSI version of PT

* Alert if another instance of PowerToys is already running

* MSIX is "Experimental" (microsoft#1348)

* tools: add tool to debug FancyZones zonable windows (microsoft#1355)

Uses FancyZones logic to test if window is zonable or not. Displays
window styles and results for various tests if the window should be
zonable or not.

* [CDPx] update SDK, restore telemetry, build MSIX (microsoft#1358)

* Removed FancyZones unit-test  (microsoft#1360)

* Swallow shift keyboard event when dragging window (microsoft#1362)

* [CDPx] update nuget feed (microsoft#1364)

* Revert "Swallow shift keyboard event when dragging window (microsoft#1362)" (microsoft#1363)

This reverts commit 2f9b753.

* [CDPx] remove nuget.config and update restore script (microsoft#1370)

* [CDPx] fix for makeappx, update SDK for MSI (microsoft#1373)

* common: always use 0 for build number and make get_product_version return "vX.X.X"

* runner: periodically check if there's a new version available on github and offer a visit

* Now updater is comparing versions instead of comparing thier strings

* notifications: add support for unpackaged apps and protocol activation

* increment version to 0.15 🎉

* Change Windows Store to Microsoft Store in README (microsoft#1369)

The Windows Store was renamed to the Microsoft Store back in 2017, best to keep things up-to-date to avoid potential confusion.

* Update BinSkim exclude list (microsoft#1377)

* Fix typo in powerrenamer README (microsoft#1378)

* wix: add missing libs for FZ editor

* Secure acces from multiple threads to JSONHelpers (add missing lock) (microsoft#1375)

* adding preview tag for desktop and start menu (microsoft#1384)

* [CDPx] sign MSIX package and bundle (microsoft#1389)

* [CDPx] remove 'signing_options' for package (microsoft#1390)

A global signing option is already defined.

* [CDPx] use explicit filenames for the MSIX assets (microsoft#1393)

Approved

* [CDPx] move build script out of .pipeline (microsoft#1394)

* Update pipeline.user.windows.yml (microsoft#1398)

* wix: add (Preview) for MSI product name

* [CDPx] archive symbols to Symbol Server (microsoft#1407)

* build break, seeing if this was root case

* Skip cloning device information from parent virtual desktop if it is deleted. (microsoft#1415)

* Update README.md (microsoft#1412)

* Changed default enable setting

* 0.15 update to readme to master (microsoft#1408)

* Getting ready for v0.15 update for readme.

* getting ready for 0.15

* spelling tweak

* filled in update section

* fixed spelling mistakes

* updating to what POR is

* Update README.md

* Update README.md

* adding back in MSI

* getting readme ready for 0.15

* tweaks

* adding oss to oss links

* fixing links

* tweaking file names

* Update README.md

* Update README.md

* Update README.md

fixing typo

* Update README.md

* Sanity check for imported settings that may have invalid data. (microsoft#1426)

* Fix migrating never applied custom zonesets (microsoft#1427)

Co-authored-by: Alekhya  <reddykalekhya@gmail.com>
Co-authored-by: vldmr11080 <57061786+vldmr11080@users.noreply.github.com>
Co-authored-by: Andrey Nekrasov <yuyoyuppe@users.noreply.github.com>
Co-authored-by: Bartosz Sosnowski <bzoz@users.noreply.github.com>
Co-authored-by: Clint Rutkas <clint@rutkas.com>
Co-authored-by: Enrico Giordani <enricogior@users.noreply.github.com>
Co-authored-by: Betsegaw Tadele <betsegaw.ta@gmail.com>
Co-authored-by: sakariya <58789616+saahmedm@users.noreply.github.com>
Co-authored-by: Jeroen van Warmerdam <jeronevw@hotmail.com>
Co-authored-by: Scott Hanselman <scott@hanselman.com>
Co-authored-by: stefansjfw <57057282+stefansjfw@users.noreply.github.com>
Co-authored-by: Seraphima Zykova <zykovas91@gmail.com>
Co-authored-by: Chris Davis <chrisdavis@outlook.com>
Co-authored-by: Jessica Yuwono <8364748+jyuwono@users.noreply.github.com>
Co-authored-by: Yevhenii Holovachov <55396981+yevhenii44@users.noreply.github.com>
Co-authored-by: PrzemyslawTusinski <61138537+PrzemyslawTusinski@users.noreply.github.com>
Co-authored-by: TorchGM <31840547+torchgm@users.noreply.github.com>
udit3333 pushed a commit to udit3333/PowerToys that referenced this pull request Mar 10, 2020
@yuyoyuppe @udit3333
MSIX: implement initial version of notifications library (microsoft#1178
b273c05 
)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ryanbodrug-microsoft ryanbodrug-microsoft ryanbodrug-microsoft left review comments

@enricogior enricogior enricogior approved these changes

@bzoz bzoz Awaiting requested review from bzoz

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@yuyoyuppe @enricogior @bzoz @ryanbodrug-microsoft