Nadro/3079/screenshot improvements

[nadr0]

closes #3079

Documentation https://www.electronjs.org/docs/latest/api/desktop-capturer

Issue

html2canvas or html2canvas-pro work but are fragile and not robust enough. Overtime with libraries being updated or new components we create the "screenshot" feature with this library will break.

Proof of breaking

html2canvas-pro is broken in electron, chrome browser, and edge browser while using linux OS.

Solution

If users are using the browser based application the screenshot tool will default to taking a snapshot from the video element.

If users are using the desktop application in electron it will default to the native desktop solution in electron to take a screenshot. If the electron desktop screenshot fails, it will fall back to video element stream.

I added an extra comment to the github issue to indicate that browser screenshots are limited.

I removed the html2canvas-pro package.

Example from browser

Example from electron

[qa-wolf]

QA Wolf here! As you write new code it's important that your test coverage is keeping up.
Click here to request test coverage for this PR!

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
modeling-app	✅ Ready (Inspect)	Visit Preview	Sep 20, 2024 4:42pm

[jtran]

Can this be a constant so that we refer to the same title that is used when creating the window?

[nadr0]

https://github.com/KittyCAD/modeling-app/pull/3917/files#diff-4fab5baaca5c14d2de62d8d2fceef376ddddcc8e9509d86cfa5643f51b89ce3dR175-R176

I've updated this to use the productName from package.json since that is what is used in electron-builder.
I think this patter is okay.

We do not use the API defined in Browser-Window to set the title of the browser window. So we don't have another reference within the code base. It is only defined in the package.json.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.

Project coverage is 87.14%. Comparing base (01cc9e7) to head (26d79e3).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
src/wasm-lib/kcl/src/coredump/mod.rs	0.00%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3917      +/-   ##
==========================================
- Coverage   87.15%   87.14%   -0.02%     
==========================================
  Files          69       69              
  Lines       25121    25124       +3     
==========================================
  Hits        21894    21894              
- Misses       3227     3230       +3     

Flag	Coverage Δ
wasm-lib	87.14% <0.00%> (-0.02%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[nadr0]

I read that MacOS can prevent screenshots by default. I can get access to see if it is enabled or not.

I cannot ask for one time permissions for a screenshot though since the ask API does not allow screen.

My new plan:

Table based on the documentation of operating systems when asking for media

System	Native Screenshot	Video Canvas Stream screenshot
Browsers	❌	✔️
Linux	✔️	fallback if native fails
Windows	✔️	fallback if native fails
MacOS	needs to enable in system preferences	default or fallback if native fails

We can always come back to how to improve the MacOS workflow. If a user wants to enable it manually they will get native screenshot support otherwise it will default to the video canvas stream.

I've updated the github bug ticket to have an HTML comment that says

<!--
  If you are capturing from a browser there is limited support for screenshots, only captures the modeling scene.
  If you are on MacOS native screenshots may be disabled by default. To enable native screenshots add Zoo Modeling App to System Settings -> Screen & SystemAudio Recording for native screenshots.
-->