Refactor CefSharp.Core into CefSharp.Core.Runtime #3311

amaitland · 2020-12-09T07:06:41Z

Summary:

Restructure projects/packages to

Better support .Net Core/5.0
CefSharp.Core.dll is now written in C# with CefSharp.Core.Runtime.dll being the runtime dependency that provides the Mixed Mode CLI/C++ implementation.
Simplify AnyCPU targeting
Resolves issue with pacakges.config based projects having to reload the solution for the dependencies to show up
Remove requirement for package consumers having to change $(Platform) at the solution level ($PlatformTarget) at project level is now sufficient
Greater control over how libcef.dll is loaded.
Potential to add additional runtime checks like validating VC++ is installed.
Upgrade GitLink

Changes:

Convert from x86/x64 to AnyCPU.
- CefSharp.dll
- CefSharp.WinForms.dll
- CefSharp.Wpf.dll
- CefSharp.OffScreen.dll
- Included in lib\net452 folder in Nuget packages, can no longer be moved by setting CefSharpTargetDir property in project file (msbuild).
Rename CefSharp.Core.dll to CefSharp.Core.Runtime.dll
- No longer directly referenced by client applications
- All the Public API methods it exposes are hidden from Visual Studio Intellisense
- Used indirectly through new CefSharp.Core.dll (AnyCPU class library).
Add CefSharp.Core.dll
- Managed (AnyCPU) dll that provides the public API
- In .Net Core there will be a CLR Module Initializer to load libcef.dll from the relevant location where required
- Additional runtime checks can be added to validate if say VC++ is installed
- Generally give more control over loading of the unmanaged resources and setting the relevant paths e.g. BrowserSubProcessPath
- NOTE: In Theory we could use a CLR Module Initializer in .Net 4.5.2 and load the dlls at runtime to support AnyCPU,
  this would require some breaking changes to the public API, so have added support for a app.config transform based on Move platform dependent files to respective directories. #3168

How Has This Been Tested?
Unit tests pass sucessfully. The MinimaExample works in the cases tested so far.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Updated documentation

Checklist:

Tested the code(if applicable)
Commented my code
Changed the documentation(if applicable)
New files have a license disclaimer
The formatting is consistent with the project (project supports .editorconfig)

Partial rename, only Net Core, folder not renamed

Remove GenApi

Move into CefSharp.Core namespace

…ackage

Make sure users don't attempt to load them directly

… variant Attempt to load CefSharp.Core.Runtime at runtime rather than having to use msbuild to copy the correct version

As they are all managed assemblies they can target AnyCPU. Includes CefSharp.dll

Now part of the CefSharp.Core PublicApi

If no RID is specified then we can load libcef.dll using the module initializer

Rewrite common targets

Improve AnyCPU support

Only delete CefSharp.Core.Runtime.dll when AnyCPU

…tCore

amaitland · 2020-12-09T10:16:05Z

TODO:

Determine if we can use Arch Specific folders to get around having to implement the hack added in commit 5d4cd24
It's likely to be a little bit hacky using the .Net 452 dlls in a netcoreapp3 folder
Fix typos in new Cef class ( Fix typos #3306)
Investigate better solution to commit ee05ef2
Had to duplicate the files in lib\netcoreapp3 folder as the lib\net452 dlls weren't being referenced in solution for netcoreapp3.x.
Was unable to find a better solution, tried copying the files into just the runtimes\win-{arch}\lib folder without success. Tested with PacakgeReference targeting .Net 4.5.2 and it appears to pickup the lib\net452 dlls successfully
Automatically generate net452 ref assembly source code as part of build script.
- Investigate if this can be done via MSBuild

Based on cefsharp#3306

For now the powershell build script generates the .cs file based on a x86 release build.ps1 It's not possible to directly install GenApi as it requires a Sdk style project

…tcore/coreruntimesimplified

AppVeyorBot · 2020-12-12T04:24:43Z

❌ Build CefSharp 87.1.11-CI3824 failed (commit 19cdf654f0 by @amaitland)

AppVeyorBot · 2020-12-12T05:27:38Z

❌ Build CefSharp 87.1.11-CI3825 failed (commit fbfa431138 by @amaitland)

AppVeyorBot · 2020-12-12T05:41:59Z

✅ Build CefSharp 87.1.11-CI3826 completed (commit c828f72f22 by @amaitland)

- Move ref assembly source generate into GenerateRefAssemblySource.ps1 - Call before project build Runs locally, see if Appveyor has a problem with the powershell script execution

AppVeyorBot · 2020-12-15T00:39:51Z

✅ Build CefSharp 87.1.11-CI3827 completed (commit 2dc63a7ab2 by @amaitland)

AppVeyorBot · 2020-12-15T01:17:05Z

✅ Build CefSharp 87.1.11-CI3828 completed (commit 5706bce21d by @amaitland)

Not quite sure what the public API should look like as yet, so making internal for now.

AppVeyorBot · 2020-12-16T00:45:06Z

✅ Build CefSharp 87.1.11-CI3829 completed (commit 3ac022aa41 by @amaitland)

amaitland · 2020-12-16T00:46:47Z

I'm going to merge this now, there's still likely a few issues to resolve. Once AppVeyor creates a new set of packages that'll be easier to test with so will resolve them after merge.

amaitland · 2020-12-16T05:44:16Z

The Ref Assemblies don't appear to be build correctly on AppVeyor.

https://ci.appveyor.com/project/cefsharp/cefsharp/builds/36859715/job/lmn6djbvfijk3fui#L591

Nickman87 · 2020-12-19T16:13:39Z

@amaitland Awesome seeing this work towards the new .Net 5! Are these changes already available somehow trough NuGet to try out?

amaitland · 2020-12-19T20:17:11Z

@Nickman87 Yes, packages are available on https://www.myget.org/gallery/cefsharp

Issue #3197 has the Net Core/5 specific details, if you can report your findings there that would be greatly appreciated.

Updated to reflect changes made in #3311

amaitland added 25 commits November 29, 2020 18:02

Net Core - Rename CefSharp.Core.dll to CefSharp.Core.Runtime.dll

54fb53d

Partial rename, only Net Core, folder not renamed

Net Core - Renaem CefSharp.Core.RefAssembly to CefSharp.Core.netcore

870e2d3

Remove GenApi

Core - Rename CefDragDataWrapper to DragData

df1a65c

Move into CefSharp.Core namespace

WinForms/WPF/OffScreen - Migrate from GitLink command line to Nuget p…

b74847e

…ackage

Net Core - Refactor to have CefSharp.Core.dll contain only public Api

d760d75

Net Core - Remove CefSharp.Core.RefAssembly

1edbb52

Net Core - Change CefSharp.Core.netcore output folder

1e93122

Net Core - Restructure nuget packages

c00c57a

Net Core - Add Cefsharp.Core.Runtime.RefAssembly

11ecc77

Net Core - Hide CLI/C++ classes from intellisense

6b7d932

Make sure users don't attempt to load them directly

Rename CefSharp.Core to CefSharp.Core.Runtime

a7214eb

Core - Restructure Net 4.5.2 packages to use CefSharp.Core.dll anycpu…

e511968

… variant Attempt to load CefSharp.Core.Runtime at runtime rather than having to use msbuild to copy the correct version

Rename CefSharp.Core.netcore to CefSharp.Core

c63ad47

WPF/WinForms/OffScreen - Change from x86/64 to AnyCPU

23d10fe

As they are all managed assemblies they can target AnyCPU. Includes CefSharp.dll

Convert RequestContextBuilder from C++ to C#

e999963

Now part of the CefSharp.Core PublicApi

Update version number to 87.1.11

371a1e7

Migrate more of the public Api to C#

3b0d259

Net Core - Basic restructure complete

7b694e9

Net Core - ModuleInitializer (Doesn't work yet)

1d49511

Remove direct references to BrowserSettings

15c9dc1

Net Core - ModuleInitializer load CefShar.Core.Runtime.dl

b310422

Net Core - Load libcef.dll via CLR Module initializer

9fb5cf3

If no RID is specified then we can load libcef.dll using the module initializer

Add version to CefSharp.Core

31fd319

Remove dependency on CefSharp.Core.Runtime

8989f01

Rewrite common targets

AnyCPU app.config transform

2588c74

Improve AnyCPU support

amaitland added this to the 87.0.x milestone Dec 9, 2020

amaitland self-assigned this Dec 9, 2020

amaitland added 2 commits December 9, 2020 17:52

Improve Net Core 3 support

ee05ef2

Only delete CefSharp.Core.Runtime.dll when AnyCPU

Nuget - Add CefSharp.Core.Runtime reference when TargetFramework = Ne…

5d4cd24

…tCore

amaitland added 5 commits December 11, 2020 16:05

Fix Typos

a6884d6

Based on cefsharp#3306

Net Core - Rename CefSharp.Core.Runtime RefAssembly source file

8bf0f66

Net Full - Generate CefSharp.Core.Runtime Ref Assembly

910a5bd

For now the powershell build script generates the .cs file based on a x86 release build.ps1 It's not possible to directly install GenApi as it requires a Sdk style project

Net Core - Old packages copy files to required folders

47d10d9

Merge branch 'master' of https://github.com/cefsharp/CefSharp into ne…

d370d30

…tcore/coreruntimesimplified

amaitland marked this pull request as ready for review December 12, 2020 04:35

Test - Install newer .Net Compiler and set Lang Version to 7.3

e3e4ec7

Net Core - Exclude Net 452 Runtime generated reference source

94c5ed9

amaitland mentioned this pull request Dec 12, 2020

Net Core/Net 5 - Implementation #3197

Closed

20 tasks

amaitland added 2 commits December 15, 2020 10:10

Core - Add Refactoring TODO

2e0c922

Ref Assembly - Generate source as part of build

9179b37

- Move ref assembly source generate into GenerateRefAssemblySource.ps1 - Call before project build Runs locally, see if Appveyor has a problem with the powershell script execution

amaitland mentioned this pull request Dec 15, 2020

Nuget Package Restructure #3319

Closed

amaitland linked an issue Dec 15, 2020 that may be closed by this pull request

Nuget Package Restructure #3319

Closed

Core - Add more factory methods to create instances of managed wrappers

b59c865

Net Core - Make Initialzier properties internal

9f8613f

Not quite sure what the public API should look like as yet, so making internal for now.

amaitland merged commit 8a367fb into cefsharp:master Dec 16, 2020

amaitland added the breaking-change label Dec 16, 2020

This was referenced Dec 31, 2020

Migrate from GitLink to SourceLink #3036

Closed

Upgrade GitLink #2395

Closed

amaitland added a commit that referenced this pull request Jan 9, 2021

Tools - Fix UpdateNugetPackages.ps1 paths

7b45415

Updated to reflect changes made in #3311

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor CefSharp.Core into CefSharp.Core.Runtime #3311

Refactor CefSharp.Core into CefSharp.Core.Runtime #3311

amaitland commented Dec 9, 2020 •

edited

Loading

amaitland commented Dec 9, 2020 •

edited

Loading

AppVeyorBot commented Dec 12, 2020

AppVeyorBot commented Dec 12, 2020

AppVeyorBot commented Dec 12, 2020

AppVeyorBot commented Dec 15, 2020

AppVeyorBot commented Dec 15, 2020

AppVeyorBot commented Dec 16, 2020

amaitland commented Dec 16, 2020

amaitland commented Dec 16, 2020

Nickman87 commented Dec 19, 2020

amaitland commented Dec 19, 2020

Refactor CefSharp.Core into CefSharp.Core.Runtime #3311

Refactor CefSharp.Core into CefSharp.Core.Runtime #3311

Conversation

amaitland commented Dec 9, 2020 • edited Loading

amaitland commented Dec 9, 2020 • edited Loading

AppVeyorBot commented Dec 12, 2020

AppVeyorBot commented Dec 12, 2020

AppVeyorBot commented Dec 12, 2020

AppVeyorBot commented Dec 15, 2020

AppVeyorBot commented Dec 15, 2020

AppVeyorBot commented Dec 16, 2020

amaitland commented Dec 16, 2020

amaitland commented Dec 16, 2020

Nickman87 commented Dec 19, 2020

amaitland commented Dec 19, 2020

amaitland commented Dec 9, 2020 •

edited

Loading

amaitland commented Dec 9, 2020 •

edited

Loading