Disable copying ProjectReferences in generator projects - #74897

Merged
ViktorHofer merged 1 commit into
dotnet:mainfrom
ericstj:disableCopyGeneratorProjectReferences
Sep 1, 2022
Merged

Disable copying ProjectReferences in generator projects#74897
ViktorHofer merged 1 commit into
dotnet:mainfrom
ericstj:disableCopyGeneratorProjectReferences

Conversation

@ericstj

@ericstjericstj commented Sep 1, 2022

Copy link
Copy Markdown
Member

No description provided.

@ericstj
ericstj requested review from a team, ViktorHofer and jkoritzinskySeptember 1, 2022 00:23
@ghostghost assigned ericstjSep 1, 2022
@ghost

ghost commented Sep 1, 2022

Copy link
Copy Markdown

Tagging subscribers to this area: @dotnet/area-infrastructure-libraries
See info in area-owners.md if you want to be subscribed.

Issue Details

null

Author:ericstj
Assignees:-
Labels:

area-Infrastructure-libraries

Milestone:-

@ericstj

ericstj commented Sep 1, 2022

Copy link
Copy Markdown
MemberAuthor

Generator projects were getting all referenced projects as ReferenceCopyLocalPaths which causes the referenced library and all satellite assemblies to be copied to the output directory. We also default to including these into binplacing - the process that composes the shared framework layout and ref pack layouts. As a result we had multiple projects trying to copy Microsoft.Interop.SourceGeneration.* to the ref-pack. Two of those - JSImportGenerator.csproj and LibraryImportGenerator.csproj - could build in parallel - which causes a race condition binclash in the build.

ViktorHofer
ViktorHofer approved these changes Sep 1, 2022
View reviewed changes

@ViktorHoferViktorHofer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the quick fix. This shows the power and danger of binplacing into a common directory via a push instead of pull mechanism.

@ViktorHofer
ViktorHofer merged commit 6414a0b into dotnet:mainSep 1, 2022
@ViktorHofer

ViktorHofer commented Sep 1, 2022

Copy link
Copy Markdown
Member

/backport to release/7.0-rc1

@github-actions

github-actionsBot commented Sep 1, 2022

Copy link
Copy Markdown
Contributor

Started backporting to release/7.0-rc1: https://github.com/dotnet/runtime/actions/runs/2971758851

@ViktorHofer

ViktorHofer commented Sep 1, 2022

Copy link
Copy Markdown
Member

Backporting as this just happened on a release/7.0 build: https://github.com/dotnet/runtime/pull/74920/checks?check_run_id=8135426753.

@github-actionsgithub-actionsBot mentioned this pull request Sep 1, 2022
Closed
@ViktorHofer

ViktorHofer commented Sep 1, 2022•
edited
Loading

Copy link
Copy Markdown
Member

@ericstj just double checking, doesn't this mean that the Microsoft.Interop.SourceGeneration.dll dependency of the LibraryImportGenerator.dll doesn't get copied into the targeting pack folder?

runtime/src/libraries/System.Runtime.InteropServices/gen/LibraryImportGenerator/LibraryImportGenerator.csproj

Line 35 in 6414a0b

<ProjectReferenceInclude="..\Microsoft.Interop.SourceGeneration\Microsoft.Interop.SourceGeneration.csproj"Pack="true"PackagePath="analyzers/dotnet/cs" />

Asking as Microsoft.Interop.SourceGeneration.dll isn't listed in

runtime/src/libraries/NetCoreAppLibrary.props

Line 186 in 6414a0b

LibraryImportGenerator;
(as it's not a source generator project but a helper class lib).

EDIT: Also does this setting have any impact on source generators being packaged?

@ericstj

ericstj commented Sep 1, 2022

Copy link
Copy Markdown
MemberAuthor

Thanks for the quick fix. This shows the power and danger of binplacing into a common directory via a push instead of pull mechanism.

We have the push tradeoff here because it enables a faster inner-loop for folks - less to rebuild in order to make changes to targeting-pack and test framework. It also enables distributed definition of composition. Both of these were major pieces of feedback we had for years in .NETFramework and DevDiv build - folks hated having to modify "authoring" to define the content of the product and complex set of steps (or full builds) to test. They wanted the definition of the product to be distributed and a local characteristic that they could control in their projects. Probably we can put more guards in place to catch binclashes wherever they might occur for whatever reason to protect us here. That would be a good change regardless since BinClashes can happen for any number of reasons.

Microsoft.Interop.SourceGeneration.dll isn't listed in runtime/src/libraries/NetCoreAppLibrary.props

Yep, that's a problem. We need to explicitly list every binary we want to ship. I'll make a PR that does that.

Also does this setting have any impact on source generators being packaged?

Both LibraryImportGenerator and JSImportGenerator set IsPackable=false. I tried setting IsPackable=true and these were not included in the package. Then I undid this change and tried again - tons of failures since the ProjectReference isn't preserving the resource subdirectory of sattelite dlls in the package.

c:\src\dotnet\runtime\.dotnet\sdk\7.0.100-preview.7.22377.5\Sdks\NuGet.Build.Tasks.Pack\build\NuGet.Build.Tasks.Pack.targets(221,5): error NU5118: File 'C:\src\dotnet\runtime\artifacts\bin\Microsoft.Interop.SourceGeneration\Debug\netstandard2.0\zh-Hans\Microsoft.Interop.SourceGeneration.resources.dll' is not added because the package already contains file 'analyzers\dotnet\cs\Microsoft.Interop.SourceGeneration.resources.dll' [C:\src\dotnet\runtime\src\libraries\System.Runtime.InteropServices\gen\LibraryImportGenerator\LibraryImportGenerator.csproj]
c:\src\dotnet\runtime\.dotnet\sdk\7.0.100-preview.7.22377.5\Sdks\NuGet.Build.Tasks.Pack\build\NuGet.Build.Tasks.Pack.targets(221,5): error NU5118: File 'C:\src\dotnet\runtime\artifacts\bin\Microsoft.Interop.SourceGeneration\Debug\netstandard2.0\zh-Hant\Microsoft.Interop.SourceGeneration.resources.dll' is not added because the package already contains file 'analyzers\dotnet\cs\Microsoft.Interop.SourceGeneration.resources.dll' [C:\src\dotnet\runtime\src\libraries\System.Runtime.InteropServices\gen\LibraryImportGenerator\LibraryImportGenerator.csproj]

Probably these should use the AnalyzerReference mechanism to include them in the package - that handles preserving the subdirectories of the items in the other project through

runtime/src/libraries/Directory.Build.targets

Lines 230 to 232 in 3b706dd

<_AnalyzerPackFileInclude="@(_BuildOutputInPackage)"IsSymbol="false" />
<_AnalyzerPackFileInclude="@(_TargetPathsToSymbols)"IsSymbol="true" />
<_AnalyzerPackFilePackagePath="$(_analyzerPath)/%(TargetPath)" />

Since they aren't currently packing, we can just remove this dead-code metadata on the project reference. I'll put that in the PR and then tag you guys to discuss.

@ViktorHofer

ViktorHofer commented Sep 1, 2022•
edited
Loading

Copy link
Copy Markdown
Member

Yep, that's a problem. We need to explicitly list every binary we want to ship. I'll make a PR that does that.

Any idea why the omission of that dependent assembly did not result in a build break. Don't we use the live built targeting pack's analyzers?

Probably these should use the AnalyzerReference mechanism to include them in the package

I was more interested in the analyzers that are already shipping inside a package ie the Json and the Extensions one. Are those still being included in their corrrsponding package?

@ericstj

ericstj commented Sep 1, 2022

Copy link
Copy Markdown
MemberAuthor

I was more interested in the analyzers that are already shipping inside a package ie the Json and the Extensions one. Are those still being included in their corrrsponding package?

Yeah, those don't rely on project references inside the analyzer project to redistribute other projects. They use the AnalyzerReference mechanism from the src project which produces the package.

@radicalradical mentioned this pull request Sep 1, 2022
Closed
@lewinglewing mentioned this pull request Sep 2, 2022
Merged
@ViktorHoferViktorHofer mentioned this pull request Sep 5, 2022
Closed
@ghostghost locked as resolved and limited conversation to collaborators Oct 1, 2022
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@jkoritzinskyjkoritzinskyjkoritzinsky approved these changes
@ViktorHoferViktorHoferViktorHofer approved these changes
+1 more reviewer
@danmoseleydanmoseleydanmoseley approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@ericstjericstj

Labels

area-Infrastructure-libraries

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@ericstj@ViktorHofer@jkoritzinsky@danmoseley
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Disable copying ProjectReferences in generator projects - #74897
Merged
ViktorHofer merged 1 commit into
dotnet:mainfrom 
ericstj:disableCopyGeneratorProjectReferences
Sep 1, 2022
Merged
Disable copying ProjectReferences in generator projects#74897
ViktorHofer merged 1 commit into
dotnet:mainfrom 
ericstj:disableCopyGeneratorProjectReferences
Conversation
@ericstj
@ericstjericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

Member
 No description provided. 
@ericstj
ericstj
requested review from
a team, ViktorHofer and jkoritzinskySeptember 1, 2022 00:23
@ghostghost
assigned ericstjSep 1, 2022
@ghost
ghost
commented
Sep 1, 2022

Copy link


Copy Markdown

Tagging subscribers to this area: @dotnet/area-infrastructure-libraries

See info in area-owners.md if you want to be subscribed.
Issue Details
null
Author:ericstj
Assignees:-
Labels:
area-Infrastructure-libraries
Milestone:-
@ericstj
ericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

MemberAuthor
Generator projects were getting all referenced projects as ReferenceCopyLocalPaths which causes the referenced library and all satellite assemblies to be copied to the output directory. We also default to including these into binplacing - the process that composes the shared framework layout and ref pack layouts. As a result we had multiple projects trying to copy Microsoft.Interop.SourceGeneration.* to the ref-pack. Two of those - JSImportGenerator.csproj and LibraryImportGenerator.csproj - could build in parallel - which causes a race condition binclash in the build.
ViktorHofer
ViktorHofer
approved these changes
Sep 1, 2022
View reviewed changes
@ViktorHoferViktorHofer
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the quick fix. This shows the power and danger of binplacing into a common directory via a push instead of pull mechanism.
@ViktorHofer
ViktorHofer
merged commit 6414a0b
into
dotnet:mainSep 1, 2022
@ViktorHofer
ViktorHofer
commented
Sep 1, 2022

Copy link


Copy Markdown

Member
/backport to release/7.0-rc1
@github-actions
github-actionsBot
commented
Sep 1, 2022

Copy link


Copy Markdown

Contributor
Started backporting to release/7.0-rc1: https://github.com/dotnet/runtime/actions/runs/2971758851
@ViktorHofer
ViktorHofer
commented
Sep 1, 2022

Copy link


Copy Markdown

Member
Backporting as this just happened on a release/7.0 build: https://github.com/dotnet/runtime/pull/74920/checks?check_run_id=8135426753.
@github-actionsgithub-actionsBot
mentioned this pull request
Sep 1, 2022
 Closed

@ViktorHofer
ViktorHofer
commented
Sep 1, 2022•

edited

Loading

Copy link


Copy Markdown

Member
@ericstj just double checking, doesn't this mean that the Microsoft.Interop.SourceGeneration.dll dependency of the LibraryImportGenerator.dll doesn't get copied into the targeting pack folder? 
runtime/src/libraries/System.Runtime.InteropServices/gen/LibraryImportGenerator/LibraryImportGenerator.csproj

Line 35
in
6414a0b
 <ProjectReferenceInclude="..\Microsoft.Interop.SourceGeneration\Microsoft.Interop.SourceGeneration.csproj"Pack="true"PackagePath="analyzers/dotnet/cs" /> 
Asking as Microsoft.Interop.SourceGeneration.dll isn't listed in 
runtime/src/libraries/NetCoreAppLibrary.props

Line 186
in
6414a0b
 LibraryImportGenerator; 

(as it's not a source generator project but a helper class lib).
EDIT: Also does this setting have any impact on source generators being packaged?
@ericstj
ericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

MemberAuthor
Thanks for the quick fix. This shows the power and danger of binplacing into a common directory via a push instead of pull mechanism.
We have the push tradeoff here because it enables a faster inner-loop for folks - less to rebuild in order to make changes to targeting-pack and test framework. It also enables distributed definition of composition. Both of these were major pieces of feedback we had for years in .NETFramework and DevDiv build - folks hated having to modify "authoring" to define the content of the product and complex set of steps (or full builds) to test. They wanted the definition of the product to be distributed and a local characteristic that they could control in their projects. Probably we can put more guards in place to catch binclashes wherever they might occur for whatever reason to protect us here. That would be a good change regardless since BinClashes can happen for any number of reasons.
Microsoft.Interop.SourceGeneration.dll isn't listed in runtime/src/libraries/NetCoreAppLibrary.props
Yep, that's a problem. We need to explicitly list every binary we want to ship. I'll make a PR that does that.
Also does this setting have any impact on source generators being packaged?
Both LibraryImportGenerator and JSImportGenerator set IsPackable=false. I tried setting IsPackable=true and these were not included in the package. Then I undid this change and tried again - tons of failures since the ProjectReference isn't preserving the resource subdirectory of sattelite dlls in the package.
c:\src\dotnet\runtime\.dotnet\sdk\7.0.100-preview.7.22377.5\Sdks\NuGet.Build.Tasks.Pack\build\NuGet.Build.Tasks.Pack.targets(221,5): error NU5118: File 'C:\src\dotnet\runtime\artifacts\bin\Microsoft.Interop.SourceGeneration\Debug\netstandard2.0\zh-Hans\Microsoft.Interop.SourceGeneration.resources.dll' is not added because the package already contains file 'analyzers\dotnet\cs\Microsoft.Interop.SourceGeneration.resources.dll' [C:\src\dotnet\runtime\src\libraries\System.Runtime.InteropServices\gen\LibraryImportGenerator\LibraryImportGenerator.csproj]
c:\src\dotnet\runtime\.dotnet\sdk\7.0.100-preview.7.22377.5\Sdks\NuGet.Build.Tasks.Pack\build\NuGet.Build.Tasks.Pack.targets(221,5): error NU5118: File 'C:\src\dotnet\runtime\artifacts\bin\Microsoft.Interop.SourceGeneration\Debug\netstandard2.0\zh-Hant\Microsoft.Interop.SourceGeneration.resources.dll' is not added because the package already contains file 'analyzers\dotnet\cs\Microsoft.Interop.SourceGeneration.resources.dll' [C:\src\dotnet\runtime\src\libraries\System.Runtime.InteropServices\gen\LibraryImportGenerator\LibraryImportGenerator.csproj]

Probably these should use the AnalyzerReference mechanism to include them in the package - that handles preserving the subdirectories of the items in the other project through 
runtime/src/libraries/Directory.Build.targets

Lines 230 to 232
in
3b706dd
 <_AnalyzerPackFileInclude="@(_BuildOutputInPackage)"IsSymbol="false" /> 
 <_AnalyzerPackFileInclude="@(_TargetPathsToSymbols)"IsSymbol="true" /> 
 <_AnalyzerPackFilePackagePath="$(_analyzerPath)/%(TargetPath)" /> 


Since they aren't currently packing, we can just remove this dead-code metadata on the project reference. I'll put that in the PR and then tag you guys to discuss.
@ViktorHofer
ViktorHofer
commented
Sep 1, 2022•

edited

Loading

Copy link


Copy Markdown

Member
Yep, that's a problem. We need to explicitly list every binary we want to ship. I'll make a PR that does that.
Any idea why the omission of that dependent assembly did not result in a build break. Don't we use the live built targeting pack's analyzers?
Probably these should use the AnalyzerReference mechanism to include them in the package
I was more interested in the analyzers that are already shipping inside a package ie the Json and the Extensions one. Are those still being included in their corrrsponding package?
@ericstj
ericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

MemberAuthor
I was more interested in the analyzers that are already shipping inside a package ie the Json and the Extensions one. Are those still being included in their corrrsponding package?
Yeah, those don't rely on project references inside the analyzer project to redistribute other projects. They use the AnalyzerReference mechanism from the src project which produces the package.
@radicalradical
mentioned this pull request
Sep 1, 2022

Closed

@lewinglewing
mentioned this pull request
Sep 2, 2022
 Merged

@ViktorHoferViktorHofer
mentioned this pull request
Sep 5, 2022
 Closed

@ghostghost
locked as resolved and limited conversation to collaborators
Oct 1, 2022
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@jkoritzinskyjkoritzinskyjkoritzinsky approved these changes
@ViktorHoferViktorHoferViktorHofer approved these changes

+1 more reviewer

@danmoseleydanmoseleydanmoseley approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@ericstjericstj

Labels

area-Infrastructure-libraries

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

4 participants

@ericstj@ViktorHofer@jkoritzinsky@danmoseley

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Disable copying ProjectReferences in generator projects - #74897
Merged
ViktorHofer merged 1 commit into
dotnet:mainfrom 
ericstj:disableCopyGeneratorProjectReferences
Sep 1, 2022
Merged
Disable copying ProjectReferences in generator projects#74897
ViktorHofer merged 1 commit into
dotnet:mainfrom 
ericstj:disableCopyGeneratorProjectReferences
Conversation
@ericstj
@ericstjericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

Member
 No description provided. 
@ericstj
ericstj
requested review from
a team, ViktorHofer and jkoritzinskySeptember 1, 2022 00:23
@ghostghost
assigned ericstjSep 1, 2022
@ghost
ghost
commented
Sep 1, 2022

Copy link


Copy Markdown

Tagging subscribers to this area: @dotnet/area-infrastructure-libraries

See info in area-owners.md if you want to be subscribed.
Issue Details
null
Author:ericstj
Assignees:-
Labels:
area-Infrastructure-libraries
Milestone:-
@ericstj
ericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

MemberAuthor
Generator projects were getting all referenced projects as ReferenceCopyLocalPaths which causes the referenced library and all satellite assemblies to be copied to the output directory. We also default to including these into binplacing - the process that composes the shared framework layout and ref pack layouts. As a result we had multiple projects trying to copy Microsoft.Interop.SourceGeneration.* to the ref-pack. Two of those - JSImportGenerator.csproj and LibraryImportGenerator.csproj - could build in parallel - which causes a race condition binclash in the build.
ViktorHofer
ViktorHofer
approved these changes
Sep 1, 2022
View reviewed changes
@ViktorHoferViktorHofer
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the quick fix. This shows the power and danger of binplacing into a common directory via a push instead of pull mechanism.
@ViktorHofer
ViktorHofer
merged commit 6414a0b
into
dotnet:mainSep 1, 2022
@ViktorHofer
ViktorHofer
commented
Sep 1, 2022

Copy link


Copy Markdown

Member
/backport to release/7.0-rc1
@github-actions
github-actionsBot
commented
Sep 1, 2022

Copy link


Copy Markdown

Contributor
Started backporting to release/7.0-rc1: https://github.com/dotnet/runtime/actions/runs/2971758851
@ViktorHofer
ViktorHofer
commented
Sep 1, 2022

Copy link


Copy Markdown

Member
Backporting as this just happened on a release/7.0 build: https://github.com/dotnet/runtime/pull/74920/checks?check_run_id=8135426753.
@github-actionsgithub-actionsBot
mentioned this pull request
Sep 1, 2022
 Closed

@ViktorHofer
ViktorHofer
commented
Sep 1, 2022•

edited

Loading

Copy link


Copy Markdown

Member
@ericstj just double checking, doesn't this mean that the Microsoft.Interop.SourceGeneration.dll dependency of the LibraryImportGenerator.dll doesn't get copied into the targeting pack folder? 
runtime/src/libraries/System.Runtime.InteropServices/gen/LibraryImportGenerator/LibraryImportGenerator.csproj

Line 35
in
6414a0b
 <ProjectReferenceInclude="..\Microsoft.Interop.SourceGeneration\Microsoft.Interop.SourceGeneration.csproj"Pack="true"PackagePath="analyzers/dotnet/cs" /> 
Asking as Microsoft.Interop.SourceGeneration.dll isn't listed in 
runtime/src/libraries/NetCoreAppLibrary.props

Line 186
in
6414a0b
 LibraryImportGenerator; 

(as it's not a source generator project but a helper class lib).
EDIT: Also does this setting have any impact on source generators being packaged?
@ericstj
ericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

MemberAuthor
Thanks for the quick fix. This shows the power and danger of binplacing into a common directory via a push instead of pull mechanism.
We have the push tradeoff here because it enables a faster inner-loop for folks - less to rebuild in order to make changes to targeting-pack and test framework. It also enables distributed definition of composition. Both of these were major pieces of feedback we had for years in .NETFramework and DevDiv build - folks hated having to modify "authoring" to define the content of the product and complex set of steps (or full builds) to test. They wanted the definition of the product to be distributed and a local characteristic that they could control in their projects. Probably we can put more guards in place to catch binclashes wherever they might occur for whatever reason to protect us here. That would be a good change regardless since BinClashes can happen for any number of reasons.
Microsoft.Interop.SourceGeneration.dll isn't listed in runtime/src/libraries/NetCoreAppLibrary.props
Yep, that's a problem. We need to explicitly list every binary we want to ship. I'll make a PR that does that.
Also does this setting have any impact on source generators being packaged?
Both LibraryImportGenerator and JSImportGenerator set IsPackable=false. I tried setting IsPackable=true and these were not included in the package. Then I undid this change and tried again - tons of failures since the ProjectReference isn't preserving the resource subdirectory of sattelite dlls in the package.
c:\src\dotnet\runtime\.dotnet\sdk\7.0.100-preview.7.22377.5\Sdks\NuGet.Build.Tasks.Pack\build\NuGet.Build.Tasks.Pack.targets(221,5): error NU5118: File 'C:\src\dotnet\runtime\artifacts\bin\Microsoft.Interop.SourceGeneration\Debug\netstandard2.0\zh-Hans\Microsoft.Interop.SourceGeneration.resources.dll' is not added because the package already contains file 'analyzers\dotnet\cs\Microsoft.Interop.SourceGeneration.resources.dll' [C:\src\dotnet\runtime\src\libraries\System.Runtime.InteropServices\gen\LibraryImportGenerator\LibraryImportGenerator.csproj]
c:\src\dotnet\runtime\.dotnet\sdk\7.0.100-preview.7.22377.5\Sdks\NuGet.Build.Tasks.Pack\build\NuGet.Build.Tasks.Pack.targets(221,5): error NU5118: File 'C:\src\dotnet\runtime\artifacts\bin\Microsoft.Interop.SourceGeneration\Debug\netstandard2.0\zh-Hant\Microsoft.Interop.SourceGeneration.resources.dll' is not added because the package already contains file 'analyzers\dotnet\cs\Microsoft.Interop.SourceGeneration.resources.dll' [C:\src\dotnet\runtime\src\libraries\System.Runtime.InteropServices\gen\LibraryImportGenerator\LibraryImportGenerator.csproj]

Probably these should use the AnalyzerReference mechanism to include them in the package - that handles preserving the subdirectories of the items in the other project through 
runtime/src/libraries/Directory.Build.targets

Lines 230 to 232
in
3b706dd
 <_AnalyzerPackFileInclude="@(_BuildOutputInPackage)"IsSymbol="false" /> 
 <_AnalyzerPackFileInclude="@(_TargetPathsToSymbols)"IsSymbol="true" /> 
 <_AnalyzerPackFilePackagePath="$(_analyzerPath)/%(TargetPath)" /> 


Since they aren't currently packing, we can just remove this dead-code metadata on the project reference. I'll put that in the PR and then tag you guys to discuss.
@ViktorHofer
ViktorHofer
commented
Sep 1, 2022•

edited

Loading

Copy link


Copy Markdown

Member
Yep, that's a problem. We need to explicitly list every binary we want to ship. I'll make a PR that does that.
Any idea why the omission of that dependent assembly did not result in a build break. Don't we use the live built targeting pack's analyzers?
Probably these should use the AnalyzerReference mechanism to include them in the package
I was more interested in the analyzers that are already shipping inside a package ie the Json and the Extensions one. Are those still being included in their corrrsponding package?
@ericstj
ericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

MemberAuthor
I was more interested in the analyzers that are already shipping inside a package ie the Json and the Extensions one. Are those still being included in their corrrsponding package?
Yeah, those don't rely on project references inside the analyzer project to redistribute other projects. They use the AnalyzerReference mechanism from the src project which produces the package.
@radicalradical
mentioned this pull request
Sep 1, 2022

Closed

@lewinglewing
mentioned this pull request
Sep 2, 2022
 Merged

@ViktorHoferViktorHofer
mentioned this pull request
Sep 5, 2022
 Closed

@ghostghost
locked as resolved and limited conversation to collaborators
Oct 1, 2022
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@jkoritzinskyjkoritzinskyjkoritzinsky approved these changes
@ViktorHoferViktorHoferViktorHofer approved these changes

+1 more reviewer

@danmoseleydanmoseleydanmoseley approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@ericstjericstj

Labels

area-Infrastructure-libraries

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

4 participants

@ericstj@ViktorHofer@jkoritzinsky@danmoseley

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Disable copying ProjectReferences in generator projects - #74897
Merged
ViktorHofer merged 1 commit into
dotnet:mainfrom 
ericstj:disableCopyGeneratorProjectReferences
Sep 1, 2022
Merged
Disable copying ProjectReferences in generator projects#74897
ViktorHofer merged 1 commit into
dotnet:mainfrom 
ericstj:disableCopyGeneratorProjectReferences
Conversation
@ericstj
@ericstjericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

Member
 No description provided. 
@ericstj
ericstj
requested review from
a team, ViktorHofer and jkoritzinskySeptember 1, 2022 00:23
@ghostghost
assigned ericstjSep 1, 2022
@ghost
ghost
commented
Sep 1, 2022

Copy link


Copy Markdown

Tagging subscribers to this area: @dotnet/area-infrastructure-libraries

See info in area-owners.md if you want to be subscribed.
Issue Details
null
Author:ericstj
Assignees:-
Labels:
area-Infrastructure-libraries
Milestone:-
@ericstj
ericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

MemberAuthor
Generator projects were getting all referenced projects as ReferenceCopyLocalPaths which causes the referenced library and all satellite assemblies to be copied to the output directory. We also default to including these into binplacing - the process that composes the shared framework layout and ref pack layouts. As a result we had multiple projects trying to copy Microsoft.Interop.SourceGeneration.* to the ref-pack. Two of those - JSImportGenerator.csproj and LibraryImportGenerator.csproj - could build in parallel - which causes a race condition binclash in the build.
ViktorHofer
ViktorHofer
approved these changes
Sep 1, 2022
View reviewed changes
@ViktorHoferViktorHofer
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the quick fix. This shows the power and danger of binplacing into a common directory via a push instead of pull mechanism.
@ViktorHofer
ViktorHofer
merged commit 6414a0b
into
dotnet:mainSep 1, 2022
@ViktorHofer
ViktorHofer
commented
Sep 1, 2022

Copy link


Copy Markdown

Member
/backport to release/7.0-rc1
@github-actions
github-actionsBot
commented
Sep 1, 2022

Copy link


Copy Markdown

Contributor
Started backporting to release/7.0-rc1: https://github.com/dotnet/runtime/actions/runs/2971758851
@ViktorHofer
ViktorHofer
commented
Sep 1, 2022

Copy link


Copy Markdown

Member
Backporting as this just happened on a release/7.0 build: https://github.com/dotnet/runtime/pull/74920/checks?check_run_id=8135426753.
@github-actionsgithub-actionsBot
mentioned this pull request
Sep 1, 2022
 Closed

@ViktorHofer
ViktorHofer
commented
Sep 1, 2022•

edited

Loading

Copy link


Copy Markdown

Member
@ericstj just double checking, doesn't this mean that the Microsoft.Interop.SourceGeneration.dll dependency of the LibraryImportGenerator.dll doesn't get copied into the targeting pack folder? 
runtime/src/libraries/System.Runtime.InteropServices/gen/LibraryImportGenerator/LibraryImportGenerator.csproj

Line 35
in
6414a0b
 <ProjectReferenceInclude="..\Microsoft.Interop.SourceGeneration\Microsoft.Interop.SourceGeneration.csproj"Pack="true"PackagePath="analyzers/dotnet/cs" /> 
Asking as Microsoft.Interop.SourceGeneration.dll isn't listed in 
runtime/src/libraries/NetCoreAppLibrary.props

Line 186
in
6414a0b
 LibraryImportGenerator; 

(as it's not a source generator project but a helper class lib).
EDIT: Also does this setting have any impact on source generators being packaged?
@ericstj
ericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

MemberAuthor
Thanks for the quick fix. This shows the power and danger of binplacing into a common directory via a push instead of pull mechanism.
We have the push tradeoff here because it enables a faster inner-loop for folks - less to rebuild in order to make changes to targeting-pack and test framework. It also enables distributed definition of composition. Both of these were major pieces of feedback we had for years in .NETFramework and DevDiv build - folks hated having to modify "authoring" to define the content of the product and complex set of steps (or full builds) to test. They wanted the definition of the product to be distributed and a local characteristic that they could control in their projects. Probably we can put more guards in place to catch binclashes wherever they might occur for whatever reason to protect us here. That would be a good change regardless since BinClashes can happen for any number of reasons.
Microsoft.Interop.SourceGeneration.dll isn't listed in runtime/src/libraries/NetCoreAppLibrary.props
Yep, that's a problem. We need to explicitly list every binary we want to ship. I'll make a PR that does that.
Also does this setting have any impact on source generators being packaged?
Both LibraryImportGenerator and JSImportGenerator set IsPackable=false. I tried setting IsPackable=true and these were not included in the package. Then I undid this change and tried again - tons of failures since the ProjectReference isn't preserving the resource subdirectory of sattelite dlls in the package.
c:\src\dotnet\runtime\.dotnet\sdk\7.0.100-preview.7.22377.5\Sdks\NuGet.Build.Tasks.Pack\build\NuGet.Build.Tasks.Pack.targets(221,5): error NU5118: File 'C:\src\dotnet\runtime\artifacts\bin\Microsoft.Interop.SourceGeneration\Debug\netstandard2.0\zh-Hans\Microsoft.Interop.SourceGeneration.resources.dll' is not added because the package already contains file 'analyzers\dotnet\cs\Microsoft.Interop.SourceGeneration.resources.dll' [C:\src\dotnet\runtime\src\libraries\System.Runtime.InteropServices\gen\LibraryImportGenerator\LibraryImportGenerator.csproj]
c:\src\dotnet\runtime\.dotnet\sdk\7.0.100-preview.7.22377.5\Sdks\NuGet.Build.Tasks.Pack\build\NuGet.Build.Tasks.Pack.targets(221,5): error NU5118: File 'C:\src\dotnet\runtime\artifacts\bin\Microsoft.Interop.SourceGeneration\Debug\netstandard2.0\zh-Hant\Microsoft.Interop.SourceGeneration.resources.dll' is not added because the package already contains file 'analyzers\dotnet\cs\Microsoft.Interop.SourceGeneration.resources.dll' [C:\src\dotnet\runtime\src\libraries\System.Runtime.InteropServices\gen\LibraryImportGenerator\LibraryImportGenerator.csproj]

Probably these should use the AnalyzerReference mechanism to include them in the package - that handles preserving the subdirectories of the items in the other project through 
runtime/src/libraries/Directory.Build.targets

Lines 230 to 232
in
3b706dd
 <_AnalyzerPackFileInclude="@(_BuildOutputInPackage)"IsSymbol="false" /> 
 <_AnalyzerPackFileInclude="@(_TargetPathsToSymbols)"IsSymbol="true" /> 
 <_AnalyzerPackFilePackagePath="$(_analyzerPath)/%(TargetPath)" /> 


Since they aren't currently packing, we can just remove this dead-code metadata on the project reference. I'll put that in the PR and then tag you guys to discuss.
@ViktorHofer
ViktorHofer
commented
Sep 1, 2022•

edited

Loading

Copy link


Copy Markdown

Member
Yep, that's a problem. We need to explicitly list every binary we want to ship. I'll make a PR that does that.
Any idea why the omission of that dependent assembly did not result in a build break. Don't we use the live built targeting pack's analyzers?
Probably these should use the AnalyzerReference mechanism to include them in the package
I was more interested in the analyzers that are already shipping inside a package ie the Json and the Extensions one. Are those still being included in their corrrsponding package?
@ericstj
ericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

MemberAuthor
I was more interested in the analyzers that are already shipping inside a package ie the Json and the Extensions one. Are those still being included in their corrrsponding package?
Yeah, those don't rely on project references inside the analyzer project to redistribute other projects. They use the AnalyzerReference mechanism from the src project which produces the package.
@radicalradical
mentioned this pull request
Sep 1, 2022

Closed

@lewinglewing
mentioned this pull request
Sep 2, 2022
 Merged

@ViktorHoferViktorHofer
mentioned this pull request
Sep 5, 2022
 Closed

@ghostghost
locked as resolved and limited conversation to collaborators
Oct 1, 2022
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@jkoritzinskyjkoritzinskyjkoritzinsky approved these changes
@ViktorHoferViktorHoferViktorHofer approved these changes

+1 more reviewer

@danmoseleydanmoseleydanmoseley approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@ericstjericstj

Labels

area-Infrastructure-libraries

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

4 participants

@ericstj@ViktorHofer@jkoritzinsky@danmoseley

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Disable copying ProjectReferences in generator projects - #74897
Merged
ViktorHofer merged 1 commit into
dotnet:mainfrom 
ericstj:disableCopyGeneratorProjectReferences
Sep 1, 2022
Merged
Disable copying ProjectReferences in generator projects#74897
ViktorHofer merged 1 commit into
dotnet:mainfrom 
ericstj:disableCopyGeneratorProjectReferences
Conversation
@ericstj
@ericstjericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

Member
 No description provided. 
@ericstj
ericstj
requested review from
a team, ViktorHofer and jkoritzinskySeptember 1, 2022 00:23
@ghostghost
assigned ericstjSep 1, 2022
@ghost
ghost
commented
Sep 1, 2022

Copy link


Copy Markdown

Tagging subscribers to this area: @dotnet/area-infrastructure-libraries

See info in area-owners.md if you want to be subscribed.
Issue Details
null
Author:ericstj
Assignees:-
Labels:
area-Infrastructure-libraries
Milestone:-
@ericstj
ericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

MemberAuthor
Generator projects were getting all referenced projects as ReferenceCopyLocalPaths which causes the referenced library and all satellite assemblies to be copied to the output directory. We also default to including these into binplacing - the process that composes the shared framework layout and ref pack layouts. As a result we had multiple projects trying to copy Microsoft.Interop.SourceGeneration.* to the ref-pack. Two of those - JSImportGenerator.csproj and LibraryImportGenerator.csproj - could build in parallel - which causes a race condition binclash in the build.
ViktorHofer
ViktorHofer
approved these changes
Sep 1, 2022
View reviewed changes
@ViktorHoferViktorHofer
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the quick fix. This shows the power and danger of binplacing into a common directory via a push instead of pull mechanism.
@ViktorHofer
ViktorHofer
merged commit 6414a0b
into
dotnet:mainSep 1, 2022
@ViktorHofer
ViktorHofer
commented
Sep 1, 2022

Copy link


Copy Markdown

Member
/backport to release/7.0-rc1
@github-actions
github-actionsBot
commented
Sep 1, 2022

Copy link


Copy Markdown

Contributor
Started backporting to release/7.0-rc1: https://github.com/dotnet/runtime/actions/runs/2971758851
@ViktorHofer
ViktorHofer
commented
Sep 1, 2022

Copy link


Copy Markdown

Member
Backporting as this just happened on a release/7.0 build: https://github.com/dotnet/runtime/pull/74920/checks?check_run_id=8135426753.
@github-actionsgithub-actionsBot
mentioned this pull request
Sep 1, 2022
 Closed

@ViktorHofer
ViktorHofer
commented
Sep 1, 2022•

edited

Loading

Copy link


Copy Markdown

Member
@ericstj just double checking, doesn't this mean that the Microsoft.Interop.SourceGeneration.dll dependency of the LibraryImportGenerator.dll doesn't get copied into the targeting pack folder? 
runtime/src/libraries/System.Runtime.InteropServices/gen/LibraryImportGenerator/LibraryImportGenerator.csproj

Line 35
in
6414a0b
 <ProjectReferenceInclude="..\Microsoft.Interop.SourceGeneration\Microsoft.Interop.SourceGeneration.csproj"Pack="true"PackagePath="analyzers/dotnet/cs" /> 
Asking as Microsoft.Interop.SourceGeneration.dll isn't listed in 
runtime/src/libraries/NetCoreAppLibrary.props

Line 186
in
6414a0b
 LibraryImportGenerator; 

(as it's not a source generator project but a helper class lib).
EDIT: Also does this setting have any impact on source generators being packaged?
@ericstj
ericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

MemberAuthor
Thanks for the quick fix. This shows the power and danger of binplacing into a common directory via a push instead of pull mechanism.
We have the push tradeoff here because it enables a faster inner-loop for folks - less to rebuild in order to make changes to targeting-pack and test framework. It also enables distributed definition of composition. Both of these were major pieces of feedback we had for years in .NETFramework and DevDiv build - folks hated having to modify "authoring" to define the content of the product and complex set of steps (or full builds) to test. They wanted the definition of the product to be distributed and a local characteristic that they could control in their projects. Probably we can put more guards in place to catch binclashes wherever they might occur for whatever reason to protect us here. That would be a good change regardless since BinClashes can happen for any number of reasons.
Microsoft.Interop.SourceGeneration.dll isn't listed in runtime/src/libraries/NetCoreAppLibrary.props
Yep, that's a problem. We need to explicitly list every binary we want to ship. I'll make a PR that does that.
Also does this setting have any impact on source generators being packaged?
Both LibraryImportGenerator and JSImportGenerator set IsPackable=false. I tried setting IsPackable=true and these were not included in the package. Then I undid this change and tried again - tons of failures since the ProjectReference isn't preserving the resource subdirectory of sattelite dlls in the package.
c:\src\dotnet\runtime\.dotnet\sdk\7.0.100-preview.7.22377.5\Sdks\NuGet.Build.Tasks.Pack\build\NuGet.Build.Tasks.Pack.targets(221,5): error NU5118: File 'C:\src\dotnet\runtime\artifacts\bin\Microsoft.Interop.SourceGeneration\Debug\netstandard2.0\zh-Hans\Microsoft.Interop.SourceGeneration.resources.dll' is not added because the package already contains file 'analyzers\dotnet\cs\Microsoft.Interop.SourceGeneration.resources.dll' [C:\src\dotnet\runtime\src\libraries\System.Runtime.InteropServices\gen\LibraryImportGenerator\LibraryImportGenerator.csproj]
c:\src\dotnet\runtime\.dotnet\sdk\7.0.100-preview.7.22377.5\Sdks\NuGet.Build.Tasks.Pack\build\NuGet.Build.Tasks.Pack.targets(221,5): error NU5118: File 'C:\src\dotnet\runtime\artifacts\bin\Microsoft.Interop.SourceGeneration\Debug\netstandard2.0\zh-Hant\Microsoft.Interop.SourceGeneration.resources.dll' is not added because the package already contains file 'analyzers\dotnet\cs\Microsoft.Interop.SourceGeneration.resources.dll' [C:\src\dotnet\runtime\src\libraries\System.Runtime.InteropServices\gen\LibraryImportGenerator\LibraryImportGenerator.csproj]

Probably these should use the AnalyzerReference mechanism to include them in the package - that handles preserving the subdirectories of the items in the other project through 
runtime/src/libraries/Directory.Build.targets

Lines 230 to 232
in
3b706dd
 <_AnalyzerPackFileInclude="@(_BuildOutputInPackage)"IsSymbol="false" /> 
 <_AnalyzerPackFileInclude="@(_TargetPathsToSymbols)"IsSymbol="true" /> 
 <_AnalyzerPackFilePackagePath="$(_analyzerPath)/%(TargetPath)" /> 


Since they aren't currently packing, we can just remove this dead-code metadata on the project reference. I'll put that in the PR and then tag you guys to discuss.
@ViktorHofer
ViktorHofer
commented
Sep 1, 2022•

edited

Loading

Copy link


Copy Markdown

Member
Yep, that's a problem. We need to explicitly list every binary we want to ship. I'll make a PR that does that.
Any idea why the omission of that dependent assembly did not result in a build break. Don't we use the live built targeting pack's analyzers?
Probably these should use the AnalyzerReference mechanism to include them in the package
I was more interested in the analyzers that are already shipping inside a package ie the Json and the Extensions one. Are those still being included in their corrrsponding package?
@ericstj
ericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

MemberAuthor
I was more interested in the analyzers that are already shipping inside a package ie the Json and the Extensions one. Are those still being included in their corrrsponding package?
Yeah, those don't rely on project references inside the analyzer project to redistribute other projects. They use the AnalyzerReference mechanism from the src project which produces the package.
@radicalradical
mentioned this pull request
Sep 1, 2022

Closed

@lewinglewing
mentioned this pull request
Sep 2, 2022
 Merged

@ViktorHoferViktorHofer
mentioned this pull request
Sep 5, 2022
 Closed

@ghostghost
locked as resolved and limited conversation to collaborators
Oct 1, 2022
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@jkoritzinskyjkoritzinskyjkoritzinsky approved these changes
@ViktorHoferViktorHoferViktorHofer approved these changes

+1 more reviewer

@danmoseleydanmoseleydanmoseley approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@ericstjericstj

Labels

area-Infrastructure-libraries

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

4 participants

@ericstj@ViktorHofer@jkoritzinsky@danmoseley

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Disable copying ProjectReferences in generator projects - #74897
Merged
ViktorHofer merged 1 commit into
dotnet:mainfrom 
ericstj:disableCopyGeneratorProjectReferences
Sep 1, 2022
Merged
Disable copying ProjectReferences in generator projects#74897
ViktorHofer merged 1 commit into
dotnet:mainfrom 
ericstj:disableCopyGeneratorProjectReferences
Conversation
@ericstj
@ericstjericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

Member
 No description provided. 
@ericstj
ericstj
requested review from
a team, ViktorHofer and jkoritzinskySeptember 1, 2022 00:23
@ghostghost
assigned ericstjSep 1, 2022
@ghost
ghost
commented
Sep 1, 2022

Copy link


Copy Markdown

Tagging subscribers to this area: @dotnet/area-infrastructure-libraries

See info in area-owners.md if you want to be subscribed.
Issue Details
null
Author:ericstj
Assignees:-
Labels:
area-Infrastructure-libraries
Milestone:-
@ericstj
ericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

MemberAuthor
Generator projects were getting all referenced projects as ReferenceCopyLocalPaths which causes the referenced library and all satellite assemblies to be copied to the output directory. We also default to including these into binplacing - the process that composes the shared framework layout and ref pack layouts. As a result we had multiple projects trying to copy Microsoft.Interop.SourceGeneration.* to the ref-pack. Two of those - JSImportGenerator.csproj and LibraryImportGenerator.csproj - could build in parallel - which causes a race condition binclash in the build.
ViktorHofer
ViktorHofer
approved these changes
Sep 1, 2022
View reviewed changes
@ViktorHoferViktorHofer
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the quick fix. This shows the power and danger of binplacing into a common directory via a push instead of pull mechanism.
@ViktorHofer
ViktorHofer
merged commit 6414a0b
into
dotnet:mainSep 1, 2022
@ViktorHofer
ViktorHofer
commented
Sep 1, 2022

Copy link


Copy Markdown

Member
/backport to release/7.0-rc1
@github-actions
github-actionsBot
commented
Sep 1, 2022

Copy link


Copy Markdown

Contributor
Started backporting to release/7.0-rc1: https://github.com/dotnet/runtime/actions/runs/2971758851
@ViktorHofer
ViktorHofer
commented
Sep 1, 2022

Copy link


Copy Markdown

Member
Backporting as this just happened on a release/7.0 build: https://github.com/dotnet/runtime/pull/74920/checks?check_run_id=8135426753.
@github-actionsgithub-actionsBot
mentioned this pull request
Sep 1, 2022
 Closed

@ViktorHofer
ViktorHofer
commented
Sep 1, 2022•

edited

Loading

Copy link


Copy Markdown

Member
@ericstj just double checking, doesn't this mean that the Microsoft.Interop.SourceGeneration.dll dependency of the LibraryImportGenerator.dll doesn't get copied into the targeting pack folder? 
runtime/src/libraries/System.Runtime.InteropServices/gen/LibraryImportGenerator/LibraryImportGenerator.csproj

Line 35
in
6414a0b
 <ProjectReferenceInclude="..\Microsoft.Interop.SourceGeneration\Microsoft.Interop.SourceGeneration.csproj"Pack="true"PackagePath="analyzers/dotnet/cs" /> 
Asking as Microsoft.Interop.SourceGeneration.dll isn't listed in 
runtime/src/libraries/NetCoreAppLibrary.props

Line 186
in
6414a0b
 LibraryImportGenerator; 

(as it's not a source generator project but a helper class lib).
EDIT: Also does this setting have any impact on source generators being packaged?
@ericstj
ericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

MemberAuthor
Thanks for the quick fix. This shows the power and danger of binplacing into a common directory via a push instead of pull mechanism.
We have the push tradeoff here because it enables a faster inner-loop for folks - less to rebuild in order to make changes to targeting-pack and test framework. It also enables distributed definition of composition. Both of these were major pieces of feedback we had for years in .NETFramework and DevDiv build - folks hated having to modify "authoring" to define the content of the product and complex set of steps (or full builds) to test. They wanted the definition of the product to be distributed and a local characteristic that they could control in their projects. Probably we can put more guards in place to catch binclashes wherever they might occur for whatever reason to protect us here. That would be a good change regardless since BinClashes can happen for any number of reasons.
Microsoft.Interop.SourceGeneration.dll isn't listed in runtime/src/libraries/NetCoreAppLibrary.props
Yep, that's a problem. We need to explicitly list every binary we want to ship. I'll make a PR that does that.
Also does this setting have any impact on source generators being packaged?
Both LibraryImportGenerator and JSImportGenerator set IsPackable=false. I tried setting IsPackable=true and these were not included in the package. Then I undid this change and tried again - tons of failures since the ProjectReference isn't preserving the resource subdirectory of sattelite dlls in the package.
c:\src\dotnet\runtime\.dotnet\sdk\7.0.100-preview.7.22377.5\Sdks\NuGet.Build.Tasks.Pack\build\NuGet.Build.Tasks.Pack.targets(221,5): error NU5118: File 'C:\src\dotnet\runtime\artifacts\bin\Microsoft.Interop.SourceGeneration\Debug\netstandard2.0\zh-Hans\Microsoft.Interop.SourceGeneration.resources.dll' is not added because the package already contains file 'analyzers\dotnet\cs\Microsoft.Interop.SourceGeneration.resources.dll' [C:\src\dotnet\runtime\src\libraries\System.Runtime.InteropServices\gen\LibraryImportGenerator\LibraryImportGenerator.csproj]
c:\src\dotnet\runtime\.dotnet\sdk\7.0.100-preview.7.22377.5\Sdks\NuGet.Build.Tasks.Pack\build\NuGet.Build.Tasks.Pack.targets(221,5): error NU5118: File 'C:\src\dotnet\runtime\artifacts\bin\Microsoft.Interop.SourceGeneration\Debug\netstandard2.0\zh-Hant\Microsoft.Interop.SourceGeneration.resources.dll' is not added because the package already contains file 'analyzers\dotnet\cs\Microsoft.Interop.SourceGeneration.resources.dll' [C:\src\dotnet\runtime\src\libraries\System.Runtime.InteropServices\gen\LibraryImportGenerator\LibraryImportGenerator.csproj]

Probably these should use the AnalyzerReference mechanism to include them in the package - that handles preserving the subdirectories of the items in the other project through 
runtime/src/libraries/Directory.Build.targets

Lines 230 to 232
in
3b706dd
 <_AnalyzerPackFileInclude="@(_BuildOutputInPackage)"IsSymbol="false" /> 
 <_AnalyzerPackFileInclude="@(_TargetPathsToSymbols)"IsSymbol="true" /> 
 <_AnalyzerPackFilePackagePath="$(_analyzerPath)/%(TargetPath)" /> 


Since they aren't currently packing, we can just remove this dead-code metadata on the project reference. I'll put that in the PR and then tag you guys to discuss.
@ViktorHofer
ViktorHofer
commented
Sep 1, 2022•

edited

Loading

Copy link


Copy Markdown

Member
Yep, that's a problem. We need to explicitly list every binary we want to ship. I'll make a PR that does that.
Any idea why the omission of that dependent assembly did not result in a build break. Don't we use the live built targeting pack's analyzers?
Probably these should use the AnalyzerReference mechanism to include them in the package
I was more interested in the analyzers that are already shipping inside a package ie the Json and the Extensions one. Are those still being included in their corrrsponding package?
@ericstj
ericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

MemberAuthor
I was more interested in the analyzers that are already shipping inside a package ie the Json and the Extensions one. Are those still being included in their corrrsponding package?
Yeah, those don't rely on project references inside the analyzer project to redistribute other projects. They use the AnalyzerReference mechanism from the src project which produces the package.
@radicalradical
mentioned this pull request
Sep 1, 2022

Closed

@lewinglewing
mentioned this pull request
Sep 2, 2022
 Merged

@ViktorHoferViktorHofer
mentioned this pull request
Sep 5, 2022
 Closed

@ghostghost
locked as resolved and limited conversation to collaborators
Oct 1, 2022
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@jkoritzinskyjkoritzinskyjkoritzinsky approved these changes
@ViktorHoferViktorHoferViktorHofer approved these changes

+1 more reviewer

@danmoseleydanmoseleydanmoseley approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@ericstjericstj

Labels

area-Infrastructure-libraries

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

4 participants

@ericstj@ViktorHofer@jkoritzinsky@danmoseley

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Disable copying ProjectReferences in generator projects - #74897
Merged
ViktorHofer merged 1 commit into
dotnet:mainfrom 
ericstj:disableCopyGeneratorProjectReferences
Sep 1, 2022
Merged
Disable copying ProjectReferences in generator projects#74897
ViktorHofer merged 1 commit into
dotnet:mainfrom 
ericstj:disableCopyGeneratorProjectReferences
Conversation
@ericstj
@ericstjericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

Member
 No description provided. 
@ericstj
ericstj
requested review from
a team, ViktorHofer and jkoritzinskySeptember 1, 2022 00:23
@ghostghost
assigned ericstjSep 1, 2022
@ghost
ghost
commented
Sep 1, 2022

Copy link


Copy Markdown

Tagging subscribers to this area: @dotnet/area-infrastructure-libraries

See info in area-owners.md if you want to be subscribed.
Issue Details
null
Author:ericstj
Assignees:-
Labels:
area-Infrastructure-libraries
Milestone:-
@ericstj
ericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

MemberAuthor
Generator projects were getting all referenced projects as ReferenceCopyLocalPaths which causes the referenced library and all satellite assemblies to be copied to the output directory. We also default to including these into binplacing - the process that composes the shared framework layout and ref pack layouts. As a result we had multiple projects trying to copy Microsoft.Interop.SourceGeneration.* to the ref-pack. Two of those - JSImportGenerator.csproj and LibraryImportGenerator.csproj - could build in parallel - which causes a race condition binclash in the build.
ViktorHofer
ViktorHofer
approved these changes
Sep 1, 2022
View reviewed changes
@ViktorHoferViktorHofer
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the quick fix. This shows the power and danger of binplacing into a common directory via a push instead of pull mechanism.
@ViktorHofer
ViktorHofer
merged commit 6414a0b
into
dotnet:mainSep 1, 2022
@ViktorHofer
ViktorHofer
commented
Sep 1, 2022

Copy link


Copy Markdown

Member
/backport to release/7.0-rc1
@github-actions
github-actionsBot
commented
Sep 1, 2022

Copy link


Copy Markdown

Contributor
Started backporting to release/7.0-rc1: https://github.com/dotnet/runtime/actions/runs/2971758851
@ViktorHofer
ViktorHofer
commented
Sep 1, 2022

Copy link


Copy Markdown

Member
Backporting as this just happened on a release/7.0 build: https://github.com/dotnet/runtime/pull/74920/checks?check_run_id=8135426753.
@github-actionsgithub-actionsBot
mentioned this pull request
Sep 1, 2022
 Closed

@ViktorHofer
ViktorHofer
commented
Sep 1, 2022•

edited

Loading

Copy link


Copy Markdown

Member
@ericstj just double checking, doesn't this mean that the Microsoft.Interop.SourceGeneration.dll dependency of the LibraryImportGenerator.dll doesn't get copied into the targeting pack folder? 
runtime/src/libraries/System.Runtime.InteropServices/gen/LibraryImportGenerator/LibraryImportGenerator.csproj

Line 35
in
6414a0b
 <ProjectReferenceInclude="..\Microsoft.Interop.SourceGeneration\Microsoft.Interop.SourceGeneration.csproj"Pack="true"PackagePath="analyzers/dotnet/cs" /> 
Asking as Microsoft.Interop.SourceGeneration.dll isn't listed in 
runtime/src/libraries/NetCoreAppLibrary.props

Line 186
in
6414a0b
 LibraryImportGenerator; 

(as it's not a source generator project but a helper class lib).
EDIT: Also does this setting have any impact on source generators being packaged?
@ericstj
ericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

MemberAuthor
Thanks for the quick fix. This shows the power and danger of binplacing into a common directory via a push instead of pull mechanism.
We have the push tradeoff here because it enables a faster inner-loop for folks - less to rebuild in order to make changes to targeting-pack and test framework. It also enables distributed definition of composition. Both of these were major pieces of feedback we had for years in .NETFramework and DevDiv build - folks hated having to modify "authoring" to define the content of the product and complex set of steps (or full builds) to test. They wanted the definition of the product to be distributed and a local characteristic that they could control in their projects. Probably we can put more guards in place to catch binclashes wherever they might occur for whatever reason to protect us here. That would be a good change regardless since BinClashes can happen for any number of reasons.
Microsoft.Interop.SourceGeneration.dll isn't listed in runtime/src/libraries/NetCoreAppLibrary.props
Yep, that's a problem. We need to explicitly list every binary we want to ship. I'll make a PR that does that.
Also does this setting have any impact on source generators being packaged?
Both LibraryImportGenerator and JSImportGenerator set IsPackable=false. I tried setting IsPackable=true and these were not included in the package. Then I undid this change and tried again - tons of failures since the ProjectReference isn't preserving the resource subdirectory of sattelite dlls in the package.
c:\src\dotnet\runtime\.dotnet\sdk\7.0.100-preview.7.22377.5\Sdks\NuGet.Build.Tasks.Pack\build\NuGet.Build.Tasks.Pack.targets(221,5): error NU5118: File 'C:\src\dotnet\runtime\artifacts\bin\Microsoft.Interop.SourceGeneration\Debug\netstandard2.0\zh-Hans\Microsoft.Interop.SourceGeneration.resources.dll' is not added because the package already contains file 'analyzers\dotnet\cs\Microsoft.Interop.SourceGeneration.resources.dll' [C:\src\dotnet\runtime\src\libraries\System.Runtime.InteropServices\gen\LibraryImportGenerator\LibraryImportGenerator.csproj]
c:\src\dotnet\runtime\.dotnet\sdk\7.0.100-preview.7.22377.5\Sdks\NuGet.Build.Tasks.Pack\build\NuGet.Build.Tasks.Pack.targets(221,5): error NU5118: File 'C:\src\dotnet\runtime\artifacts\bin\Microsoft.Interop.SourceGeneration\Debug\netstandard2.0\zh-Hant\Microsoft.Interop.SourceGeneration.resources.dll' is not added because the package already contains file 'analyzers\dotnet\cs\Microsoft.Interop.SourceGeneration.resources.dll' [C:\src\dotnet\runtime\src\libraries\System.Runtime.InteropServices\gen\LibraryImportGenerator\LibraryImportGenerator.csproj]

Probably these should use the AnalyzerReference mechanism to include them in the package - that handles preserving the subdirectories of the items in the other project through 
runtime/src/libraries/Directory.Build.targets

Lines 230 to 232
in
3b706dd
 <_AnalyzerPackFileInclude="@(_BuildOutputInPackage)"IsSymbol="false" /> 
 <_AnalyzerPackFileInclude="@(_TargetPathsToSymbols)"IsSymbol="true" /> 
 <_AnalyzerPackFilePackagePath="$(_analyzerPath)/%(TargetPath)" /> 


Since they aren't currently packing, we can just remove this dead-code metadata on the project reference. I'll put that in the PR and then tag you guys to discuss.
@ViktorHofer
ViktorHofer
commented
Sep 1, 2022•

edited

Loading

Copy link


Copy Markdown

Member
Yep, that's a problem. We need to explicitly list every binary we want to ship. I'll make a PR that does that.
Any idea why the omission of that dependent assembly did not result in a build break. Don't we use the live built targeting pack's analyzers?
Probably these should use the AnalyzerReference mechanism to include them in the package
I was more interested in the analyzers that are already shipping inside a package ie the Json and the Extensions one. Are those still being included in their corrrsponding package?
@ericstj
ericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

MemberAuthor
I was more interested in the analyzers that are already shipping inside a package ie the Json and the Extensions one. Are those still being included in their corrrsponding package?
Yeah, those don't rely on project references inside the analyzer project to redistribute other projects. They use the AnalyzerReference mechanism from the src project which produces the package.
@radicalradical
mentioned this pull request
Sep 1, 2022

Closed

@lewinglewing
mentioned this pull request
Sep 2, 2022
 Merged

@ViktorHoferViktorHofer
mentioned this pull request
Sep 5, 2022
 Closed

@ghostghost
locked as resolved and limited conversation to collaborators
Oct 1, 2022
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@jkoritzinskyjkoritzinskyjkoritzinsky approved these changes
@ViktorHoferViktorHoferViktorHofer approved these changes

+1 more reviewer

@danmoseleydanmoseleydanmoseley approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@ericstjericstj

Labels

area-Infrastructure-libraries

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

4 participants

@ericstj@ViktorHofer@jkoritzinsky@danmoseley

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Disable copying ProjectReferences in generator projects - #74897
Merged
ViktorHofer merged 1 commit into
dotnet:mainfrom 
ericstj:disableCopyGeneratorProjectReferences
Sep 1, 2022
Merged
Disable copying ProjectReferences in generator projects#74897
ViktorHofer merged 1 commit into
dotnet:mainfrom 
ericstj:disableCopyGeneratorProjectReferences
Conversation
@ericstj
@ericstjericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

Member
 No description provided. 
@ericstj
ericstj
requested review from
a team, ViktorHofer and jkoritzinskySeptember 1, 2022 00:23
@ghostghost
assigned ericstjSep 1, 2022
@ghost
ghost
commented
Sep 1, 2022

Copy link


Copy Markdown

Tagging subscribers to this area: @dotnet/area-infrastructure-libraries

See info in area-owners.md if you want to be subscribed.
Issue Details
null
Author:ericstj
Assignees:-
Labels:
area-Infrastructure-libraries
Milestone:-
@ericstj
ericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

MemberAuthor
Generator projects were getting all referenced projects as ReferenceCopyLocalPaths which causes the referenced library and all satellite assemblies to be copied to the output directory. We also default to including these into binplacing - the process that composes the shared framework layout and ref pack layouts. As a result we had multiple projects trying to copy Microsoft.Interop.SourceGeneration.* to the ref-pack. Two of those - JSImportGenerator.csproj and LibraryImportGenerator.csproj - could build in parallel - which causes a race condition binclash in the build.
ViktorHofer
ViktorHofer
approved these changes
Sep 1, 2022
View reviewed changes
@ViktorHoferViktorHofer
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the quick fix. This shows the power and danger of binplacing into a common directory via a push instead of pull mechanism.
@ViktorHofer
ViktorHofer
merged commit 6414a0b
into
dotnet:mainSep 1, 2022
@ViktorHofer
ViktorHofer
commented
Sep 1, 2022

Copy link


Copy Markdown

Member
/backport to release/7.0-rc1
@github-actions
github-actionsBot
commented
Sep 1, 2022

Copy link


Copy Markdown

Contributor
Started backporting to release/7.0-rc1: https://github.com/dotnet/runtime/actions/runs/2971758851
@ViktorHofer
ViktorHofer
commented
Sep 1, 2022

Copy link


Copy Markdown

Member
Backporting as this just happened on a release/7.0 build: https://github.com/dotnet/runtime/pull/74920/checks?check_run_id=8135426753.
@github-actionsgithub-actionsBot
mentioned this pull request
Sep 1, 2022
 Closed

@ViktorHofer
ViktorHofer
commented
Sep 1, 2022•

edited

Loading

Copy link


Copy Markdown

Member
@ericstj just double checking, doesn't this mean that the Microsoft.Interop.SourceGeneration.dll dependency of the LibraryImportGenerator.dll doesn't get copied into the targeting pack folder? 
runtime/src/libraries/System.Runtime.InteropServices/gen/LibraryImportGenerator/LibraryImportGenerator.csproj

Line 35
in
6414a0b
 <ProjectReferenceInclude="..\Microsoft.Interop.SourceGeneration\Microsoft.Interop.SourceGeneration.csproj"Pack="true"PackagePath="analyzers/dotnet/cs" /> 
Asking as Microsoft.Interop.SourceGeneration.dll isn't listed in 
runtime/src/libraries/NetCoreAppLibrary.props

Line 186
in
6414a0b
 LibraryImportGenerator; 

(as it's not a source generator project but a helper class lib).
EDIT: Also does this setting have any impact on source generators being packaged?
@ericstj
ericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

MemberAuthor
Thanks for the quick fix. This shows the power and danger of binplacing into a common directory via a push instead of pull mechanism.
We have the push tradeoff here because it enables a faster inner-loop for folks - less to rebuild in order to make changes to targeting-pack and test framework. It also enables distributed definition of composition. Both of these were major pieces of feedback we had for years in .NETFramework and DevDiv build - folks hated having to modify "authoring" to define the content of the product and complex set of steps (or full builds) to test. They wanted the definition of the product to be distributed and a local characteristic that they could control in their projects. Probably we can put more guards in place to catch binclashes wherever they might occur for whatever reason to protect us here. That would be a good change regardless since BinClashes can happen for any number of reasons.
Microsoft.Interop.SourceGeneration.dll isn't listed in runtime/src/libraries/NetCoreAppLibrary.props
Yep, that's a problem. We need to explicitly list every binary we want to ship. I'll make a PR that does that.
Also does this setting have any impact on source generators being packaged?
Both LibraryImportGenerator and JSImportGenerator set IsPackable=false. I tried setting IsPackable=true and these were not included in the package. Then I undid this change and tried again - tons of failures since the ProjectReference isn't preserving the resource subdirectory of sattelite dlls in the package.
c:\src\dotnet\runtime\.dotnet\sdk\7.0.100-preview.7.22377.5\Sdks\NuGet.Build.Tasks.Pack\build\NuGet.Build.Tasks.Pack.targets(221,5): error NU5118: File 'C:\src\dotnet\runtime\artifacts\bin\Microsoft.Interop.SourceGeneration\Debug\netstandard2.0\zh-Hans\Microsoft.Interop.SourceGeneration.resources.dll' is not added because the package already contains file 'analyzers\dotnet\cs\Microsoft.Interop.SourceGeneration.resources.dll' [C:\src\dotnet\runtime\src\libraries\System.Runtime.InteropServices\gen\LibraryImportGenerator\LibraryImportGenerator.csproj]
c:\src\dotnet\runtime\.dotnet\sdk\7.0.100-preview.7.22377.5\Sdks\NuGet.Build.Tasks.Pack\build\NuGet.Build.Tasks.Pack.targets(221,5): error NU5118: File 'C:\src\dotnet\runtime\artifacts\bin\Microsoft.Interop.SourceGeneration\Debug\netstandard2.0\zh-Hant\Microsoft.Interop.SourceGeneration.resources.dll' is not added because the package already contains file 'analyzers\dotnet\cs\Microsoft.Interop.SourceGeneration.resources.dll' [C:\src\dotnet\runtime\src\libraries\System.Runtime.InteropServices\gen\LibraryImportGenerator\LibraryImportGenerator.csproj]

Probably these should use the AnalyzerReference mechanism to include them in the package - that handles preserving the subdirectories of the items in the other project through 
runtime/src/libraries/Directory.Build.targets

Lines 230 to 232
in
3b706dd
 <_AnalyzerPackFileInclude="@(_BuildOutputInPackage)"IsSymbol="false" /> 
 <_AnalyzerPackFileInclude="@(_TargetPathsToSymbols)"IsSymbol="true" /> 
 <_AnalyzerPackFilePackagePath="$(_analyzerPath)/%(TargetPath)" /> 


Since they aren't currently packing, we can just remove this dead-code metadata on the project reference. I'll put that in the PR and then tag you guys to discuss.
@ViktorHofer
ViktorHofer
commented
Sep 1, 2022•

edited

Loading

Copy link


Copy Markdown

Member
Yep, that's a problem. We need to explicitly list every binary we want to ship. I'll make a PR that does that.
Any idea why the omission of that dependent assembly did not result in a build break. Don't we use the live built targeting pack's analyzers?
Probably these should use the AnalyzerReference mechanism to include them in the package
I was more interested in the analyzers that are already shipping inside a package ie the Json and the Extensions one. Are those still being included in their corrrsponding package?
@ericstj
ericstj
commented
Sep 1, 2022

Copy link


Copy Markdown

MemberAuthor
I was more interested in the analyzers that are already shipping inside a package ie the Json and the Extensions one. Are those still being included in their corrrsponding package?
Yeah, those don't rely on project references inside the analyzer project to redistribute other projects. They use the AnalyzerReference mechanism from the src project which produces the package.
@radicalradical
mentioned this pull request
Sep 1, 2022

Closed

@lewinglewing
mentioned this pull request
Sep 2, 2022
 Merged

@ViktorHoferViktorHofer
mentioned this pull request
Sep 5, 2022
 Closed

@ghostghost
locked as resolved and limited conversation to collaborators
Oct 1, 2022
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@jkoritzinskyjkoritzinskyjkoritzinsky approved these changes
@ViktorHoferViktorHoferViktorHofer approved these changes

+1 more reviewer

@danmoseleydanmoseleydanmoseley approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@ericstjericstj

Labels

area-Infrastructure-libraries

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

4 participants

@ericstj@ViktorHofer@jkoritzinsky@danmoseley