feat: `WebView` enhancements #4018

ndonkoHenri · 2024-09-20T09:48:02Z

Summary by Sourcery

Enhance the WebView component with new event handling capabilities and methods, including platform-specific implementations for mobile, macOS, Windows, and Linux. Deprecate the 'javascript_enabled' property in favor of 'enable_javascript'. Refactor platform detection logic to improve code maintainability. Update dependencies to support new features and remove unused imports from test files.

New Features:

Introduce new event handling capabilities for WebView, including scroll, console message, and JavaScript alert dialog events.
Add support for various WebView methods such as reload, go back, go forward, enable/disable zoom, clear cache, and run JavaScript.
Implement platform-specific WebView handling for mobile, macOS, Windows, and Linux platforms.

Enhancements:

Deprecate the 'javascript_enabled' property in favor of 'enable_javascript' for better clarity and future-proofing.
Refactor platform detection logic to use a new 'platform.dart' utility, improving code readability and maintainability.

Build:

Update dependencies in 'pubspec.yaml' to include new webview-related packages and update existing ones.

Tests:

Remove unused 'pytest' imports from various test files, streamlining the test setup.

sourcery-ai · 2024-09-20T09:48:08Z

Reviewer's Guide by Sourcery

This pull request introduces significant enhancements to the WebView component in the Flet framework, improving its functionality across different platforms (mobile, web, and desktop). The changes include new features, better platform support, and code refactoring for improved maintainability.

File-Level Changes

Change	Details	Files
Enhanced WebView functionality with new methods and events	Added new methods like reload(), can_go_back(), can_go_forward(), go_back(), go_forward() Implemented new events such as on_progress, on_url_change, on_scroll, on_console_message Added support for JavaScript execution and HTML loading Implemented methods for cache and local storage clearing	`sdk/python/packages/flet-core/src/flet_core/webview.py`
Improved cross-platform support for WebView	Created separate implementations for mobile/macOS, web, and Windows/Linux platforms Implemented platform-specific checks to use appropriate WebView implementation Added new utility functions for platform detection	`packages/flet_webview/lib/src/webview_mobile_and_mac.dart` `packages/flet_webview/lib/src/webview_web.dart` `packages/flet_webview/lib/src/webview_windows_and_linux.dart` `packages/flet/lib/src/utils/platform.dart`
Refactored existing code for better maintainability	Moved platform-specific utility functions from desktop.dart to platform.dart Updated import statements across multiple files to use the new platform.dart Refactored WebView control to use the new platform-specific implementations	`packages/flet/lib/src/utils/desktop.dart` `packages/flet/lib/src/controls/webview.dart` `packages/flet/lib/src/controls/page.dart` `packages/flet/lib/src/controls/grid_view.dart` `packages/flet/lib/src/controls/list_view.dart` `packages/flet/lib/src/controls/scrollable_control.dart`
Updated dependencies and configurations	Added new WebView-related dependencies in pubspec.yaml Updated iOS and macOS configurations for WebView support	`packages/flet_webview/pubspec.yaml` `client/ios/Runner/AppDelegate.swift` `client/macos/Flutter/GeneratedPluginRegistrant.swift`

Tips

Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
Continue your discussion with Sourcery by replying directly to review comments.
You can change your review settings at any time by accessing your dashboard:
- Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
- Change the review language;
You can always contact us if you have any questions or feedback.

sourcery-ai

Hey @ndonkoHenri - I've reviewed your changes - here's some feedback:

Overall Comments:

Consider adding more comprehensive error handling for WebView operations, especially for platform-specific implementations.
It might be beneficial to add some performance benchmarks or profiling for the new WebView features, particularly for mobile platforms.

Here's what I looked at during the review

🟡 General issues: 1 issue found
🟡 Security: 1 issue found
🟢 Testing: all looks good
🟡 Complexity: 1 issue found
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

sourcery-ai · 2024-09-20T09:49:40Z

sdk/python/packages/flet-core/src/flet_core/webview.py

+            arguments={"url": url, "method": method.value},
+        )
+
+    def run_javascript(self, value: str):


🚨 suggestion (security): Add security warning for run_javascript method

Consider adding a prominent warning in the method documentation about the potential security risks of executing arbitrary JavaScript.

def run_javascript(self, value: str): """ Execute JavaScript in the WebView. WARNING: This method can pose significant security risks. Only use with trusted input to prevent potential cross-site scripting (XSS) attacks. """

sourcery-ai · 2024-09-20T09:49:40Z

sdk/python/packages/flet-core/src/flet_core/control.py

@@ -337,6 +337,9 @@ def invoke_method(
        assert (
            self.__page
        ), f"{self.__class__.__qualname__} Control must be added to the page first"
+        if arguments:


suggestion: Consider moving argument processing to a separate method

Extracting the argument processing logic to a separate method could improve readability and reusability, especially since it's duplicated in invoke_method_async.

def _process_arguments(self, arguments): if arguments: return {k: str(v) for k, v in arguments.items() if v is not None} return {} if arguments: arguments = self._process_arguments(arguments)

sdk/python/packages/flet-core/src/flet_core/webview.py

…pported platform

Muddassir-Farooq-official · 2024-09-28T18:29:08Z

Kindly merge and one more thing add permission in manifest for Android to display local html files in web view

packages/flet_webview/pubspec.yaml

client/pubspec.lock

kalatawei · 2024-10-29T19:13:42Z

Is there any chance for supporting WebView CookieManager ?

cayubweeums · 2024-11-06T17:05:16Z

This looks great! Can't wait to implement this in my project once it gets merged to main!!

sdk/python/packages/flet/src/flet/canvas/__init__.py

sdk/python/packages/flet/src/flet/map/__init__.py

sdk/python/packages/flet/src/flet/matplotlib_chart.py

sdk/python/packages/flet/src/flet/plotly_chart.py

ndonkoHenri · 2024-11-07T00:36:51Z

@sourcery-ai review

Muddassir-Farooq-official · 2024-11-09T19:27:42Z

Have documentation updated in flet docs?

ndonkoHenri · 2024-11-10T10:48:58Z

Working on it.

Benitmulindwa · 2024-11-10T20:02:50Z

Good stuff @ndonkoHenri 😎! But i have some questions, are we going to get the run_javascripts() methods support on other platforms soon? I thought this PR would add WV support for the windows,

ndonkoHenri · 2024-11-10T21:33:10Z

Windows and Linux are not yet supported. Will have a look at them after we release 0.25.0.

Benitmulindwa · 2024-11-11T06:00:32Z

Would be great to have the run_javascripts() method on Web too

Edit: Am not able to update the url value when running on web. Is it a bug or that’s how it’s supposed to be?

Benitmulindwa · 2024-11-11T12:55:20Z

Am able to change the url value outside of a function,… but once am inside a function/eventhandler an error is shown saying that the method is supported on Android, iOS and macOS only.

ndonkoHenri · 2024-11-11T13:00:03Z

@Benitmulindwa let's continue this in a new discussion. Can you create one and explain the issues you face?

Benitmulindwa · 2024-11-11T16:07:08Z

@ndonkoHenri all right lemme do it

Benitmulindwa · 2024-11-11T16:54:15Z

#4356

icstos · 2024-11-29T00:43:21Z

On Windows, an error is reported: Webview is not yet supported on this Platform.

ndonkoHenri · 2024-11-29T09:13:25Z

Windows and Linux support is still to be added.

ndonkoHenri added 3 commits September 18, 2024 01:06

initial commit

d061078

new methods

0a8e53c

add more events

ab80ff6

sourcery-ai bot reviewed Sep 20, 2024

View reviewed changes

raise FletUnsupportedPlatformException if a method is used on an unsu…

b30cb92

…pported platform

This comment has been minimized.

Sign in to view

This comment was marked as spam.

Sign in to view

FeodorFitsner reviewed Oct 17, 2024

View reviewed changes

packages/flet_webview/pubspec.yaml Outdated Show resolved Hide resolved

ndonkoHenri added 3 commits October 19, 2024 02:24

remove abutil from pubspec.yaml

a7af4db

merge 'main' branch

801a493

merge 'main' branch

46f3f4c

FeodorFitsner reviewed Oct 29, 2024

View reviewed changes

client/pubspec.lock Outdated Show resolved Hide resolved

ndonkoHenri added 6 commits October 29, 2024 20:45

Merge 'main‘ branch

5d7da4d

bump webview_flutter package

a74dbea

update pubspec.lock (removes abutil)

0b366a9

Merge 'main‘ branch

fb9235f

delete webview-all.dart

8a394c7

export Flet exceptions

b8a91de

ndonkoHenri requested a review from FeodorFitsner October 30, 2024 12:31

Merge branch 'main' into webview-enhancement

32e4c70

FeodorFitsner reviewed Nov 6, 2024

View reviewed changes

sdk/python/packages/flet/src/flet/canvas/__init__.py Outdated Show resolved Hide resolved

FeodorFitsner reviewed Nov 6, 2024

View reviewed changes

sdk/python/packages/flet/src/flet/map/__init__.py Outdated Show resolved Hide resolved

FeodorFitsner reviewed Nov 6, 2024

View reviewed changes

sdk/python/packages/flet/src/flet/matplotlib_chart.py Outdated Show resolved Hide resolved

FeodorFitsner reviewed Nov 6, 2024

View reviewed changes

sdk/python/packages/flet/src/flet/plotly_chart.py Outdated Show resolved Hide resolved

ndonkoHenri added 2 commits November 7, 2024 01:27

Merge branch 'main' into webview-enhancement

f62b9ea

restore exports

7e01a7a

flet-dev deleted a comment from sourcery-ai bot Nov 7, 2024

ndonkoHenri requested a review from FeodorFitsner November 7, 2024 00:38

This comment was marked as spam.

Sign in to view

FeodorFitsner approved these changes Nov 8, 2024

View reviewed changes

FeodorFitsner merged commit 20216b0 into main Nov 8, 2024
2 checks passed

FeodorFitsner deleted the webview-enhancement branch November 8, 2024 19:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: `WebView` enhancements #4018

feat: `WebView` enhancements #4018

ndonkoHenri commented Sep 20, 2024 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Sep 20, 2024 •

edited

Loading

sourcery-ai bot left a comment

sourcery-ai bot Sep 20, 2024

sourcery-ai bot Sep 20, 2024

Muddassir-Farooq-official commented Sep 28, 2024 •

edited

Loading

This comment has been minimized.

This comment was marked as spam.

kalatawei commented Oct 29, 2024

cayubweeums commented Nov 6, 2024

ndonkoHenri commented Nov 7, 2024

This comment was marked as spam.

Muddassir-Farooq-official commented Nov 9, 2024

ndonkoHenri commented Nov 10, 2024

Benitmulindwa commented Nov 10, 2024

ndonkoHenri commented Nov 10, 2024

Benitmulindwa commented Nov 11, 2024 •

edited

Loading

Benitmulindwa commented Nov 11, 2024

ndonkoHenri commented Nov 11, 2024

Benitmulindwa commented Nov 11, 2024

Benitmulindwa commented Nov 11, 2024

icstos commented Nov 29, 2024

ndonkoHenri commented Nov 29, 2024

feat: WebView enhancements #4018

feat: WebView enhancements #4018

Conversation

ndonkoHenri commented Sep 20, 2024 • edited by sourcery-ai bot Loading

Summary by Sourcery

sourcery-ai bot commented Sep 20, 2024 • edited Loading

Reviewer's Guide by Sourcery

File-Level Changes

sourcery-ai bot left a comment

Choose a reason for hiding this comment

sourcery-ai bot Sep 20, 2024

Choose a reason for hiding this comment

sourcery-ai bot Sep 20, 2024

Choose a reason for hiding this comment

Muddassir-Farooq-official commented Sep 28, 2024 • edited Loading

This comment has been minimized.

This comment was marked as spam.

kalatawei commented Oct 29, 2024

cayubweeums commented Nov 6, 2024

ndonkoHenri commented Nov 7, 2024

This comment was marked as spam.

Muddassir-Farooq-official commented Nov 9, 2024

ndonkoHenri commented Nov 10, 2024

Benitmulindwa commented Nov 10, 2024

ndonkoHenri commented Nov 10, 2024

Benitmulindwa commented Nov 11, 2024 • edited Loading

Benitmulindwa commented Nov 11, 2024

ndonkoHenri commented Nov 11, 2024

Benitmulindwa commented Nov 11, 2024

Benitmulindwa commented Nov 11, 2024

icstos commented Nov 29, 2024

ndonkoHenri commented Nov 29, 2024

feat: `WebView` enhancements #4018

feat: `WebView` enhancements #4018

ndonkoHenri commented Sep 20, 2024 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Sep 20, 2024 •

edited

Loading

Muddassir-Farooq-official commented Sep 28, 2024 •

edited

Loading

Benitmulindwa commented Nov 11, 2024 •

edited

Loading