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

Core - LoadUrlAsync require url and remove SyncContext param #3842

Closed
3 tasks done
amaitland opened this issue Oct 10, 2021 · 3 comments
Closed
3 tasks done

Core - LoadUrlAsync require url and remove SyncContext param #3842

amaitland opened this issue Oct 10, 2021 · 3 comments
Assignees
@amaitland
Labels
breaking-change
Milestone
95.7.x

Comments

@amaitland
Copy link
Member

amaitland commented Oct 10, 2021 •
edited

Currently it's possible to call await browser.LoadUrlAsync() without passing in a Url.

If you do this and the browser isn't loading then the method will just wait forever.

To provide a predictable behaviour the string url = null will be changed to string url and an ArgumentNullException thrown when string.IsNullOrEmpty(url).

  • Remove default null value for url param.
  • Remove SyncronisationContext param
    upon remove it doesn't make sense
  • Add WaitForInitialLoadAsync method
@amaitland amaitland added this to the 95.7.x milestone Oct 10, 2021
amaitland added a commit that referenced this issue Oct 10, 2021
@amaitland
WinForms/WPF/OffScreen - Add WaitForBrowserInitialLoadAsync
08e5140 
Change all the tests to use WaitForBrowserInitialLoadAsync instead of LoadUrlAsync
as LoadUrlAsync will require a Url as part of #3842
@amaitland
Copy link
Member Author

WaitForBrowserInitialLoadAsync has been added, still needs some additional testing.

The intention of this method is to wait for the browser to finish it's initial load though it's not strictly checking for anything that prevents it from being called later.

I might consider renaming to WaitForBrowserLoadAsync before the 95 branch is created.

odo-leni added a commit to odo-leni/CefSharp that referenced this issue Oct 15, 2021
@odo-leni
Squashed commit of the following:
9e55773 
commit aac5439
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Thu Oct 14 19:37:15 2021 +1000

    Test - Fix compile error

commit 439970d
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Thu Oct 14 19:28:44 2021 +1000

    Test - Fix NetCore test case

commit 1a85419
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Thu Oct 14 13:00:08 2021 +1000

    Test - Output QUnit results if tests failed

commit db9e041
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Thu Oct 14 12:58:42 2021 +1000

    build.ps1 - Remove TernaryReturn as no longer used

commit f904b88
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Thu Oct 14 12:43:35 2021 +1000

    build.ps1 - Improve vswhere programfiles check

commit 221185b
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Thu Oct 14 10:16:27 2021 +1000

    WinForms/WPF/OffScreen - Enable Chromium Site Isolation by default

    Previously was disabled by default

    Can still be disabled via disable-site-isolation-trials command line argument

    Issue cefsharp#2967

commit fd78c0c
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Thu Oct 14 10:11:33 2021 +1000

    Test - CanLoadRequestWithPostData now navigates to domain of same origin first

    When Chromium Site Isolation is enabled we must first navigate to
    a web page of the same origin to use LoadRequest
    When Site Isolation is disabled we can navigate to any web page
    https://magpcss.org/ceforum/viewtopic.php?f=10&t=18672&p=50266#p50249

    Issue cefsharp#2967

commit c72e21c
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Wed Oct 13 20:50:45 2021 +1000

    build.ps1 - Nuget Package only a subset of architectures

    - Can now build/package only a subset of architectures
    - Remove file elements from nuspec if arch wasn't specified
    - Reorder and simplify script

    .\build.ps1 -BuildArches "x64"

    Issue cefsharp#3706

commit 7c2226c
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Wed Oct 13 13:32:38 2021 +1000

    Nuget - Update dependency groups

    Resolves nuget pack warning

commit 8aa0ee5
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Wed Oct 13 13:18:56 2021 +1000

    build.ps1 - Cleanup

    - Fail fast if nuget.exe not found
    - Check for VSWhere at build start
      (should always be installed as it's included in VS2019 and above)
    - Remove netcore31 from $Target valid set, we'll just rely on the
      $TargetFramework
    - Push-Location to working directory for easier debugging

commit 13c725c
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Wed Oct 13 12:08:59 2021 +1000

    build.ps1 - Reorder scripts so functions are declared first

commit 7c57c10
Author: Mitch Capper <mitch.capper@gmail.com>
Date:   Mon Oct 11 02:12:26 2021 -0700

    Add netcore to toolchain (it uses same VS version)

commit da0f33b
Author: Mitch Capper <mitch.capper@gmail.com>
Date:   Mon Oct 11 01:51:53 2021 -0700

    Added vs2022 support and v143 targetting.  VS2022 can also build V142 but requires some additions to the project files to indicate targeting it instead.  This should not change behavior for anyone as you must specific specify the 2022 target for it to work.

commit 2af10bf
Author: Mitch Capper <mitch.capper@gmail.com>
Date:   Sun Oct 10 06:42:02 2021 -0700

    build.ps1 and build.netcore.ps1 merge and architecture target added

commit 66bb6c0
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Wed Oct 13 11:50:00 2021 +1000

    Nuget - Remove netcoreapp3.0 hacks

    For those unable to upgrade to .Net Core 3.1 then the old packages should still be usable by specifying AssetTargetFallback as detailed in https://docs.microsoft.com/en-us/nuget/consume-packages/package-references-in-project-files#assettargetfallback

    Resolves cefsharp#3444

commit 42e7b90
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Wed Oct 13 09:14:22 2021 +1000

    appveyor.yml - Update CefSharp.Test.dll path

    Runtime identifier was changed to win7-x64 so the path changed

commit bd88019
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Wed Oct 13 08:59:03 2021 +1000

    Test - Add RuntimeIdentifiers and fix build.ps1

    - Seems the Nuget restore doesn't work correctly without having RuntimeIdentifiers set
      Must also set RuntimeIdentifier manually so the files are copied correctly.
    - Move the msbuild restore after the vcvarsall.bat call so the script runs successfully

commit ee431d7
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Wed Oct 13 06:45:58 2021 +1000

    Test - Add RuntimeIdentifiers so libcef.dll etc copied to output folder

    - Adding <RuntimeIdentifiers/> didn't work as expected so set RuntimeIdentifier based on PlatformTarget
    - Updated appveyor.yml as output path for CefSharp.Test.dll changed

commit 5356e1b
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Wed Oct 13 05:15:34 2021 +1000

    Test - Update Nuget PackageReferences

    - Forgot to change to the chromiumembeddedframework.runtime package
    - Simplify references

    Follow up to cefsharp@67a08c4

    Issue cefsharp#3706

commit 67a08c4
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Sun Oct 10 15:44:47 2021 +1000

    BrowserSubProcess/Examples/Tests - Migrate to newer SDK Style projects

    - Migrate to new SDK style projects
    - Migrate to chromiumembeddedframework.runtime packages
    - Remove old packages.config files
    - Update post build event for BrowserSubprocess to set TSAware/LargeAddressAware
    - Change project build order

    Issue cefsharp#3706

commit 6953d82
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Mon Oct 11 10:26:35 2021 +1000

    Net Core - Nupkg Include xml files

    Issue cefsharp#3843

commit bfa8ccf
Author: Andrew Smith <andrews@infragistics.com>
Date:   Sun Oct 10 20:16:07 2021 -0400

    WPF - IME Only use GCS_CURSORPOS if an adjacent character is new input (cefsharp#3846)

    * Change Wpf IME handling to only use the cursor pos when an adjacent character is new input

    * Meant to change both character before and after

    * Ensure the cursor pos is > 0 when checking the character before

commit 544abc6
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Mon Oct 11 10:13:55 2021 +1000

    Revert "WinForms/WPF/OffScreen - Add WaitForBrowserInitialLoadAsync"

    Tests started failing so will revisit later.

    This reverts commit 08e5140.

commit 8bbe6a4
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Sun Oct 10 15:01:15 2021 +1000

    WPF - Fix Address Load being called multiple times after browser created

commit 0812ea9
Author: Konstantin Preißer <kpreisser@users.noreply.github.com>
Date:   Sun Oct 10 11:56:50 2021 +0200

    Don't check for presence of "d3dcompiler_47.dll" when running as ARM64, because that file isn't present in the CEF Redist for this architecture. (cefsharp#3841)

    Issue cefsharp#2944

commit 08e5140
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Sun Oct 10 14:41:04 2021 +1000

    WinForms/WPF/OffScreen - Add WaitForBrowserInitialLoadAsync

    Change all the tests to use WaitForBrowserInitialLoadAsync instead of LoadUrlAsync
    as LoadUrlAsync will require a Url as part of cefsharp#3842

commit 15cf58c
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Fri Oct 8 13:05:27 2021 +1000

    Core - Add IRequestContext.GetCookieManagerAsync extension method

    - Will return the cookie manager when the backing store has loaded
      otherwise returns null

commit b82fa05
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Fri Oct 8 12:40:54 2021 +1000

    WinForms/WPF/OffScreen - Update Load(string url) behaviour

    - All three implementations updated to include an IsDisposed check which
      will simply return immediately
    - OffScreen updated to match the WinForms behaviour
    - WPF is more complex because of the initialAddress and Address properties
      initialAddress will be set if the browser hasn't been created, if the browserCreated
      has been created and OnAfterBrowserCreated hasn't been called then we'll set the Address
      dependency property.

    NOTE: For WinForms/OffScreen there's a small window
    here between CreateBrowser and OnAfterBrowserCreated
    where the Address prop will be updated, though LoadUrl
    won't be called.

commit c226d34
Author: Alex Maitland <amaitland@users.noreply.github.com>
Date:   Fri Oct 8 10:21:31 2021 +1000

    WinForms/WPF/OffScreen - Add LoadUrl method (Same as Load(string)).

    A more meaningful name for the method, matches the LoadUrlAsync method
    that was added recently.
@amaitland
Copy link
Member Author

WaitForBrowserInitialLoadAsync has been added, still needs some additional testing.

Was reverted as some of the tests failed.

@amaitland amaitland changed the title Core - LoadUrlAsync require url Core - LoadUrlAsync require url and remove SyncContext param Oct 27, 2021
amaitland added a commit that referenced this issue Oct 27, 2021
@amaitland
WinForms/WPF/OffScreen - Add WaitForBrowserInitialLoadAsync
91b7514 
Second attempt at WaitForBrowserInitialLoadAsync, includes optional
CancellationToken param.

Issue #3842
@amaitland amaitland self-assigned this Oct 28, 2021
amaitland added a commit that referenced this issue Oct 28, 2021
@amaitland
Core - Rename WaitForBrowserInitialLoadAsync to WaitForInitialLoadAsy…
4a07af2 
…nc and simplify

- Initial intention was to have a reusable method that could be used CefSharp.Wpf.HwndHost,
  upon further deliberation I've decided to build the functionality into the ChromiumWebBrowser.Partial.cs
  and will need to duplicate the functionality in CefSharp.Wpf.HwndHost. This guarantees that the
  Task will be resolved in all cases. The previous implementation there was a theoretical change we'd
  miss subscribing to the relevant events
- Remove CancellationToken as it's not possible to cancel

Issue #3842
amaitland added a commit that referenced this issue Oct 28, 2021
@amaitland
Core - LoadUrlAsync require url and remove SyncContext param
4112340 
- Remove url optional null, a Url is now required and an exception will be
  thrown if null or empty. If the browser wasn't loading an null was passed
  in then the task would have never resolved. This provides a predictable behaviour.
  A new WaitForInitialLoadAsync method was added to simplify waiting for initial
  browser load.
- Remove SynchronizationContext param, best to let the framework handle

Issue #3842
@amaitland
Copy link
Member Author

For anyone using LoadUrlAsync() without params then you can switch to using WaitForInitialLoadAsync for the initial page load.

//Before
await browser.LoadUrlAsync();
//After
await browser.WaitForInitialLoadAsync();

amaitland added a commit that referenced this issue Oct 28, 2021
@amaitland
WinForms/WPF/OffScreen - Add WaitForBrowserInitialLoadAsync
3221c4b 
Second attempt at WaitForBrowserInitialLoadAsync, includes optional
CancellationToken param.

Issue #3842
amaitland added a commit that referenced this issue Oct 28, 2021
@amaitland
Core - Rename WaitForBrowserInitialLoadAsync to WaitForInitialLoadAsy…
e8e6eb8 
…nc and simplify

- Initial intention was to have a reusable method that could be used CefSharp.Wpf.HwndHost,
  upon further deliberation I've decided to build the functionality into the ChromiumWebBrowser.Partial.cs
  and will need to duplicate the functionality in CefSharp.Wpf.HwndHost. This guarantees that the
  Task will be resolved in all cases. The previous implementation there was a theoretical change we'd
  miss subscribing to the relevant events
- Remove CancellationToken as it's not possible to cancel

Issue #3842
amaitland added a commit that referenced this issue Oct 28, 2021
@amaitland
Core - LoadUrlAsync require url and remove SyncContext param
b0d19f7 
- Remove url optional null, a Url is now required and an exception will be
  thrown if null or empty. If the browser wasn't loading an null was passed
  in then the task would have never resolved. This provides a predictable behaviour.
  A new WaitForInitialLoadAsync method was added to simplify waiting for initial
  browser load.
- Remove SynchronizationContext param, best to let the framework handle

Issue #3842
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@amaitland amaitland

Labels
breaking-change
Projects
None yet
Milestone
95.7.x
Development

No branches or pull requests
1 participant
@amaitland