fix: add support for non-root base-href #75

holzgeist · 2024-09-18T10:23:31Z

Description

if a web-app is deployed using --base-href=/path/to/deployed/flutter/app during build, the URLs starting with ./assets won't work anymore. Using assetManager will properly resolve them. It uses assetBase from the loader config specified here

NB ⚠️

I only tested the url.startsWith('assets/') code path as it's the only one used in the library. It should work the same for ./ though

if a web-app is deployed using `--base-href` during build, the URLs starting with `./assets` won't work anymore. Use `assetManager` to properly resolve them

diegotori

@holzgeist Before I run the workflow, there is one thing that I need you to do.

In other words, we need to move assets/no_sleep.js into the lib folder as per this StackOverflow post. Eventually, it'll be under wakelock_plus/lib/assets/no_sleep.js. The reason being is that it should be moved there so that it's in line with how every other library exposes assets to its users.

You'll also have to modify the existing asset entry in pubspec.yaml so that it points to packages/assets/wakelock_plus/assets/no_sleep.js.

diegotori · 2024-09-30T23:02:45Z

@holzgeist Please let me know if you're still gonna work on this change. Otherwise, I can commandeer it for you and take it to the finish line. Thanks.

holzgeist · 2024-10-01T07:42:49Z

Hi @diegotori ,

thanks for the feedback. I'm going to work on it, probably today, maybe tomorrow

holzgeist · 2024-10-01T11:26:48Z

@diegotori actually I need to solve some other issues before I have a working web-build to test this one. If you could commandeer this, it would be great, thanks 🙏

…ed to when its added to the registrar.

diegotori · 2024-12-03T15:26:19Z

@holzgeist please verify the fixes made to this PR. I was able to do a bit of cleanup and/or fixes. Thanks.

…a script element.

…hat it awaits asynchronous calls from the various wakelock related callbacks. As a result, the Dart layer no longer needs to manually await before calling WakelockPlus.enabled.

diegotori · 2024-12-03T17:43:28Z

@holzgeist If you have an angle on the latest no_sleep.js changes that I made, which now awaits for the web layer to enable the wakelock before considering it enabled, please feel free to review.

@ditman the above also applies to you as well, if you're able to review the JS changes that I made. Thanks.

…Libraries.

ditman

I left some comments, but I'm not an actual owner of the plugin, so please, take/ignore as you please from my comments.

Thanks for getting this fix over the finish line, and apologies for the delay in the review, it took me a long while to see this notification!

wakelock_plus/example/.gitignore

wakelock_plus/lib/assets/no_sleep.js

wakelock_plus/lib/src/wakelock_plus_web_plugin.dart

ditman · 2025-01-08T03:18:01Z

wakelock_plus/lib/src/web_impl/import_js_library.dart


-import 'package:web/web.dart';
+import 'package:web/web.dart' as web;


Hell yeah, package:web powerrrrr!

wakelock_plus/lib/src/web_impl/import_js_library.dart

ditman · 2025-01-08T03:38:51Z

wakelock_plus/lib/assets/no_sleep.js

-              console.error(err.name + ', ' + err.message)
+              _this2.nativeEnabled = false
+              var errorMessage = err.name + ', ' + err.message
+              console.error(errorMessage)


Try to limit the amount of console logging in the JS code, if possible. Since you're completing with an error, it might be better to log from Dart, so you can use things like if (kIsDebug) to not log in production and stuff like that? (or not :P)

I'll comment out the logs if that makes things better.

I think it's fine that the plugin logs/warns on these recoverable errors, but I'd log from Dart, instead of JS.

I removed the log. All the errors are passed via Promise.reject or completeError, so the user of the plugin can chose to handle and/or log them

wakelock_plus/lib/src/wakelock_plus_web_plugin.dart

ditman · 2025-01-08T03:48:09Z

wakelock_plus/lib/src/web_impl/import_js_library.dart

-      if ((element as HTMLScriptElement).src.endsWith(url)) {
+      if ((element as web.HTMLScriptElement).src.endsWith(url)) {


I know this change is unrelated, but consider adding an id attribute to your script element, that way this method can be simplified to:

return head.querySelector('#$idForScriptElement') != null;

You may need to keep a small map of urls to each of its idForScriptElement String (probably it'll only contain a single element?)

done. I hope the locking part works out as planned. These things are really hard to test. The happy path works though

ditman · 2025-01-08T03:51:22Z

wakelock_plus/test/wakelock_plus_web_plugin_test.dart

@@ -6,13 +6,21 @@ import 'package:wakelock_plus/src/wakelock_plus_web_plugin.dart';
 import 'package:wakelock_plus/wakelock_plus.dart';
 import 'package:wakelock_plus_platform_interface/wakelock_plus_platform_interface.dart';

+///
+/// Run these tests with:
+///   flutter run -d chrome test/wakelock_plus_web_plugin_test.dart


This is better than nothing, but super non-standard! If you want to run tests like this, I'd suggest you try to migrate them to flutter drive, like what we did in flutter/packages, for example:

https://github.com/flutter/packages/tree/main/packages/video_player/video_player_web/example <- this "example" actually contains the integration_test and all that jazz. The README.md should have some links to the docs on how to run those.

wakelock_plus/lib/assets/no_sleep.js

holzgeist · 2025-01-08T07:16:50Z

@diegotori thanks for working on this. But unfortunately this grew way outside of my comfort zone wrt flutter/web so I have to pass on reviewing this 🙈

Co-authored-by: David Iglesias <[email protected]>

diegotori · 2025-01-08T17:08:28Z

I left some comments, but I'm not an actual owner of the plugin, so please, take/ignore as you please from my comments.

Thanks for getting this fix over the finish line, and apologies for the delay in the review, it took me a long while to see this notification!

Thanks for reviewing this. Since you have a better handle on the JS side of things, I'll let you take point on what I should modify. Feel free to call out more things as you see them.

holzgeist · 2025-02-20T13:03:47Z

Hi there!
I'm back to actively working on a flutter/web port of our app. Is there anything I can help with on this PR?

holzgeist · 2025-02-20T15:46:09Z

ok, thanks to @ditman 's super detailed review and suggestions I actually was able to understand everything that's going on and apply the suggestions (apart from testing). They definitely all look and feel like improvements, thanks again for the through review 🙏

@diegotori @ditman any thoughts?

fix: add support for non-root base-href

8892812

if a web-app is deployed using `--base-href` during build, the URLs starting with `./assets` won't work anymore. Use `assetManager` to properly resolve them

diegotori requested changes Sep 27, 2024

View reviewed changes

diegotori added 7 commits December 2, 2024 21:18

Moved no_sleep.js to lib/assets.

31526ae

Added web alias to all package:web calls in import_js_library.dart.

606ade6

Added more simplified library URL method in import_js_library.dart.

b4114a9

WakelockPlusWebPlugin now lazily loads no_sleep.js on demand as oppos…

e948054

…ed to when its added to the registrar.

Got the WakelockPlusWebPlugin tests passing.

9e1fd5b

Fixed example app web-related depreactions.

39f6598

Added straggler from previous commit.

f2542bd

This was referenced Dec 3, 2024

Loading of no_sleep.js does not respect assetBase #19

Open

(Do not merge!) Poked around wakelock_plus (web) #25

Closed

diegotori approved these changes Dec 3, 2024

View reviewed changes

diegotori added 3 commits December 3, 2024 10:33

Added correct script tag error handling by checking if the target is …

b8d0b58

…a script element.

Upgraded flutter_lints to latest version.

bd3e7a7

Revamped the no_sleep.js script to use a Promise-based Completer so t…

4900aaf

…hat it awaits asynchronous calls from the various wakelock related callbacks. As a result, the Dart layer no longer needs to manually await before calling WakelockPlus.enabled.

diegotori added 4 commits December 3, 2024 12:55

Fixed a dart lint issue due to HTML in the documentation of _importJS…

ac4e069

…Libraries.

Added minor comments to no_sleep.js.

a7ddb22

Merge branch 'main' into fix-support-non-root-base-href

897dca4

Fixed a pubspec straggler from the previous commit.

f5d5bc4

ditman reviewed Jan 8, 2025

View reviewed changes

Update wakelock_plus/lib/assets/no_sleep.js due to typo

8f38c22

Co-authored-by: David Iglesias <[email protected]>

chore: apply suggestions

bb3d4ca

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: add support for non-root base-href #75

fix: add support for non-root base-href #75

holzgeist commented Sep 18, 2024

diegotori left a comment •

edited

Loading

diegotori commented Sep 30, 2024

holzgeist commented Oct 1, 2024

holzgeist commented Oct 1, 2024

diegotori commented Dec 3, 2024

diegotori commented Dec 3, 2024

ditman left a comment

ditman Jan 8, 2025

ditman Jan 8, 2025

diegotori Jan 8, 2025

ditman Jan 9, 2025

holzgeist Feb 20, 2025

ditman Jan 8, 2025

holzgeist Feb 20, 2025

ditman Jan 8, 2025

holzgeist commented Jan 8, 2025

diegotori commented Jan 8, 2025

holzgeist commented Feb 20, 2025

holzgeist commented Feb 20, 2025


		import 'package:web/web.dart';
		import 'package:web/web.dart' as web;

		if ((element as HTMLScriptElement).src.endsWith(url)) {
		if ((element as web.HTMLScriptElement).src.endsWith(url)) {

fix: add support for non-root base-href #75

Are you sure you want to change the base?

fix: add support for non-root base-href #75

Conversation

holzgeist commented Sep 18, 2024

Description

NB ⚠️

diegotori left a comment • edited Loading

Choose a reason for hiding this comment

diegotori commented Sep 30, 2024

holzgeist commented Oct 1, 2024

holzgeist commented Oct 1, 2024

diegotori commented Dec 3, 2024

diegotori commented Dec 3, 2024

ditman left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

holzgeist commented Jan 8, 2025

diegotori commented Jan 8, 2025

holzgeist commented Feb 20, 2025

holzgeist commented Feb 20, 2025

diegotori left a comment •

edited

Loading