chore: Remove dependency of AWS.Lambda.Powertools.Common on all Utilities

[hjgraca]

Please provide the issue number

Issue number: #339

Summary

Utilities have a dependency on the AWS.Lambda.Powertools.Common project.
When the utility is compiled and packaged into a nuget package the AWS.Lambda.Powertools.Common is a dependency.
This behaviour is causing Diamond dependency issues in the project.
To address this we should copy the required files to each utility and make them completely isolated. This allows the client to not have to worry about dependencies between utilities and AWS.Lambda.Powertools.Common.
There is no need to delete the AWS.Lambda.Powertools.Common project but link the files in other projects, this will make it more readable in the solution explorer and makes maintenance easier because it's all in a single project.

Changes

• Remove dependency of AWS.Lambda.Powertools.Common project in all utilities
• Create a Compile Include Link from AWS.Lambda.Powertools.Common files to all utilities csproj
  
• Add a reference to AspectInjector
  
• This will result in linked files in the Common folder of the utility project
  

Updated test project dependencies to latest versions

Please provide a summary of what's being changed

User experience

Please share what the user experience looks like before and after this change

Checklist

Please leave checklist items unchecked if they do not apply to your change.

• Meets tenets criteria
• I have performed a self-review of this change
• Changes have been tested
• Changes are documented
• PR title follows conventional commit semantics

Is this a breaking change?

RFC issue number:

Checklist:

• Migration process documented
• Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

[hjgraca]

After some conversations with @amirkaws and his feedback, I have made some changes to the implementation.

TLDR:

• Add Directory.Build.props and Directory.Build.targets more info
  • These two files allows us to modify all csproj files in the solution or where the files are placed in the folder structure
  • Those files were added to the src folder. They modify all csproj in that folder where all utilities are. Search scope
• Add Central Package Management more info
  • Dependency management is a core feature of NuGet. Managing dependencies for a single project can be easy. Managing dependencies for multi-project solutions can prove to be difficult as they start to scale in size and complexity. In situations where you manage common dependencies for many different projects, you can leverage NuGet's central package management (CPM) features to do all of this from the ease of a single location.
  • Add a file Directory.Packages.props to the src and test folders. This allows us to manage nuget package versions for all projects in a central location. I separated src and tests because tests have many dependencies and can cause confusion. Search scope info

Implementation

Part 1 Directory.Build.props

• Use MSbuild to:
  • Manage all common properties across all projects
  • These properties can be overridden by the project if it wishes to do so
    

Part 2 Directory.Build.targets (changes only happen in Release configuration)

• Use MSbuild to:
  • Copy/Link AWS.Lambda.Powertools.Common *.cs files to the destination project
  • Remove depdendency of Common project by removing <ProjectReference Remove="..\AWS.Lambda.Powertools.Common\AWS.Lambda.Powertools.Common.csproj" />
  • Add PackageReference <PackageReference Include="AspectInjector" />
• This transformation only happens in Release configuration

Once in Release configuration or when running dotnet build -c Release the Common folder is added to the project

Part 3 Central Package Management

Docs

Starting with NuGet 6.2, you can centrally manage your dependencies in your projects with the addition of a Directory.Packages.props file and an MSBuild property.

This means that the versions of the referenced packages will be defined in the central Directory.Packages.props file

File contents:

In the csproj files of the projects the referenced packages will not have a version

If needed individual projects can override the version

Part 4 Nuget package contents

The resulting Release package will have no AWS.Lambda.Powertools.Common reference and will include AspectInjector nuget package. This will make the utility completely independent from AWS.Lambda.Powertools.Common Nuget package at runtime

Old:

New:

[hjgraca]

Also updated nuget packages. Once merged will close dependabot pull requests.

[codecov-commenter]

Codecov Report

Patch coverage has no change and project coverage change: -0.09% ⚠️

Comparison is base (1378d75) 72.34% compared to head (d3505b5) 72.25%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #340      +/-   ##
===========================================
- Coverage    72.34%   72.25%   -0.09%     
===========================================
  Files           82       82              
  Lines         3594     3594              
===========================================
- Hits          2600     2597       -3     
- Misses         994      997       +3     

Flag	Coverage Δ
unittests	72.25% <ø> (-0.09%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[hjgraca]

Removed AWS.Lambda.Powertools.Common project reference from test projects.
This reference now comes from Directory.Build.props. This file was added to test folder.

Contents:

[amirkaws]

LGTM

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information