Metadata reports generator (Issue #3999)

[IbrahimMNada]

This Pull request fixes #3999

if you have any notes I will fix them at once, thank you

Microsoft Reviewers: Open in CodeFlow

[IbrahimMNada]

@IbrahimMNada please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@dotnet-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@dotnet-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@dotnet-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ), and conveys certain license rights to the .NET Foundation ( “.NET Foundation” ) for Your contributions to .NET Foundation open source projects. This Agreement is effective as of the latest signature date below.

1. Definitions.

“Code” means the computer software code, whether in human-readable or machine-executable form, that is delivered by You to .NET Foundation under this Agreement.

“Project” means any of the projects owned or managed by .NET Foundation and offered under a license approved by the Open Source Initiative (www.opensource.org).

“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any Project, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of discussing and improving that Project, but excluding communication that is conspicuously marked or otherwise designated in writing by You as “Not a Submission.”

“Submission” means the Code and any other copyrightable material Submitted by You, including any associated comments and documentation.

2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any Project. This Agreement covers any and all Submissions that You, now or in the future (except as described in Section 4 below), Submit to any Project.

3. Originality of Work. You represent that each of Your Submissions is entirely Your original work. Should You wish to Submit materials that are not Your original work, You may Submit them separately to the Project if You (a) retain all copyright and license information that was in the materials as you received them, (b) in the description accompanying your Submission, include the phrase "Submission containing materials of a third party:" followed by the names of the third party and any licenses or other restrictions of which You are aware, and (c) follow any other instructions in the Project's written guidelines concerning Submissions.

4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your Submission is made in the course of Your work for an employer or Your employer has intellectual property rights in Your Submission by contract or applicable law, You must secure permission from Your employer to make the Submission before signing this Agreement. In that case, the term “You” in this Agreement will refer to You and the employer collectively. If You change employers in the future and desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement and secure permission from the new employer before Submitting those Submissions.

5. Licenses.

a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third parties.

b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under Your patent claims that are necessarily infringed by the Submission or the combination of the Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and import or otherwise dispose of the Submission alone or with the Project.

c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above licenses. You represent that each of Your Submissions is entirely Your original work (except as You may have disclosed under Section 3 ). You represent that You have secured permission from Your employer to make the Submission in cases where Your Submission is made in the course of Your work for Your employer or Your employer has intellectual property rights in Your Submission by contract or applicable law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You have the necessary authority to bind the listed employer to the obligations contained in this Agreement. You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES EXPRESSLY STATED IN SECTIONS 3, 4, AND 6 , THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or circumstances of which You later become aware that would make Your representations in this Agreement inaccurate in any respect.

8. Information about Submissions. You agree that contributions to Projects and information about contributions may be maintained indefinitely and disclosed publicly, including Your name and other information that You submit with Your Submission.

9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County, Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all defenses of lack of personal jurisdiction and forum non-conveniens.

10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and supersedes any and all prior agreements, understandings or communications, written or oral, between the parties relating to the subject matter hereof. This Agreement may be assigned by .NET Foundation.

.NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1.

@dotnet-policy-service agree

[IbrahimMNada]

Do we need to update this file https://github.com/dotnet/extensions/blob/main/src/Packages/Microsoft.Extensions.AuditReports/README.md ?

I think We need to introduce new bullet in the available repots list :

• Metrics: Reports on the use of source-generated metric definitions in the code.
• Compliance: Reports on the use of privacy-sensitive data in the code, including source-generated logging methods.
• MetaData : Is a Combination of both reports above.

And I also think We need to introduce the new properties to the Available reports Table

Metrics report generator	Compliance report generator	Meta data report generator	Description
<GenerateMetricsReport>	<GenerateComplianceReport>	<GenerateMetadataReport>	Controls whether the report is generated.
<MetricsReportOutputPath>	<ComplianceReportOutputPath>	<MetadataReportOutputPath>	The path to the directory where the report will be generated.

[dotnet-comment-bot]

‼️ Found issues ‼️

Project	Coverage Type	Expected	Actual
Microsoft.Extensions.Caching.Hybrid	Line	86	77.82 🔻
Microsoft.Gen.MetadataExtractor	Line	98	57.35 🔻
Microsoft.Gen.MetadataExtractor	Branch	98	62.5 🔻

🎉 Good job! The coverage increased 🎉
Update MinCodeCoverage in the project files.

Project	Expected	Actual
Microsoft.Extensions.AI	88	89
Microsoft.Extensions.AI.OpenAI	77	78

Full code coverage report: https://dev.azure.com/dnceng-public/public/_build/results?buildId=920916&view=codecoverage-tab

[evgenyfedorov2]

Do we need to update this file https://github.com/dotnet/extensions/blob/main/src/Packages/Microsoft.Extensions.AuditReports/README.md ?

I think We need to introduce new bullet in the available repots list :

• Metrics: Reports on the use of source-generated metric definitions in the code.
• Compliance: Reports on the use of privacy-sensitive data in the code, including source-generated logging methods.
• MetaData : Is a Combination of both reports above.

And I also think We need to introduce the new properties to the Available reports Table

Metrics report generator Compliance report generator Meta data report generator Description
<GenerateMetricsReport> <GenerateComplianceReport> <GenerateMetadataReport> Controls whether the report is generated.
<MetricsReportOutputPath> <ComplianceReportOutputPath> <MetadataReportOutputPath> The path to the directory where the report will be generated.

Yes, that makes sense. + maybe a new section like "Example of a metadata report".
Would you be able to update it as part of this PR or in a follow-up, please?

[IbrahimMNada]

Do we need to update this file https://github.com/dotnet/extensions/blob/main/src/Packages/Microsoft.Extensions.AuditReports/README.md ?

I think We need to introduce new bullet in the available repots list :

• Metrics: Reports on the use of source-generated metric definitions in the code.
• Compliance: Reports on the use of privacy-sensitive data in the code, including source-generated logging methods.
• MetaData : Is a Combination of both reports above.

And I also think We need to introduce the new properties to the Available reports Table
Metrics report generator Compliance report generator Meta data report generator Description
<GenerateMetricsReport> <GenerateComplianceReport> <GenerateMetadataReport> Controls whether the report is generated.
<MetricsReportOutputPath> <ComplianceReportOutputPath> <MetadataReportOutputPath> The path to the directory where the report will be generated.

Yes, that makes sense. + maybe a new section like "Example of a metadata report". Would you be able to update it as part of this PR or in a follow-up, please?

I have updated the read me file , hopefully now it algins with the other reports ....

[dotnet-comment-bot]

‼️ Found issues ‼️

Project	Coverage Type	Expected	Actual
Microsoft.Gen.MetadataExtractor	Line	98	57.35 🔻
Microsoft.Gen.MetadataExtractor	Branch	98	62.5 🔻

🎉 Good job! The coverage increased 🎉
Update MinCodeCoverage in the project files.

Project	Expected	Actual
Microsoft.Extensions.AI	88	89
Microsoft.Extensions.AI.OpenAI	77	78

Full code coverage report: https://dev.azure.com/dnceng-public/public/_build/results?buildId=921170&view=codecoverage-tab

[evgenyfedorov2]

Do we need to update this file https://github.com/dotnet/extensions/blob/main/src/Packages/Microsoft.Extensions.AuditReports/README.md ?

I think We need to introduce new bullet in the available repots list :

• Metrics: Reports on the use of source-generated metric definitions in the code.
• Compliance: Reports on the use of privacy-sensitive data in the code, including source-generated logging methods.
• MetaData : Is a Combination of both reports above.

And I also think We need to introduce the new properties to the Available reports Table
Metrics report generator Compliance report generator Meta data report generator Description
<GenerateMetricsReport> <GenerateComplianceReport> <GenerateMetadataReport> Controls whether the report is generated.
<MetricsReportOutputPath> <ComplianceReportOutputPath> <MetadataReportOutputPath> The path to the directory where the report will be generated.

Yes, that makes sense. + maybe a new section like "Example of a metadata report". Would you be able to update it as part of this PR or in a follow-up, please?

I have updated the read me file , hopefully now it algins with the other reports ....

Thank you! I think the PR is in a good shape now, just added some minor comments. Once we confirm the stage policy, it can be merged

[IbrahimMNada]

@evgenyfedorov2 All should be good now

[dotnet-comment-bot]

‼️ Found issues ‼️

Project	Coverage Type	Expected	Actual
Microsoft.Gen.MetadataExtractor	Line	98	57.35 🔻
Microsoft.Gen.MetadataExtractor	Branch	98	62.5 🔻

🎉 Good job! The coverage increased 🎉
Update MinCodeCoverage in the project files.

Project	Expected	Actual
Microsoft.Extensions.AI.OpenAI	77	78
Microsoft.Extensions.AI	88	89

Full code coverage report: https://dev.azure.com/dnceng-public/public/_build/results?buildId=922034&view=codecoverage-tab

[RussKie]

@evgenyfedorov2 @dotnet/dotnet-extensions-compliance this is a breaking change --> dotnet/extensions-samples#645

 error NU1101: Unable to find package Microsoft.Gen.MetadataExtractor. No packages exist with this id in source(s): dotnet-eng, dotnet-public, dotnet9, dotnet9-transport, richnav

We have never published Microsoft.Gen.MetadataExtractor package, and until recently it wasn't needed. Now it is....

[evgenyfedorov2]

Microsoft.Gen.MetadataExtractor is a new package, referenced as a csproj by Microsoft.Extensions.AuditReports, I don't quite understand why it has to be published. And even then, why wasn't it published automatically?

What is the way forward?

[RussKie]

The change needs to be reverted. Microsoft.Gen.MetadataExtractor is an analyzer.

[IbrahimMNada]

Hello ,
I am the one who made that pr if there is anything i can help , I am available