Implement NuGet protocol v3 support

[carlspring]

Task Description

This is the master task for the implementation of NuGet protocol version 3. All the investigation, useful findings should be added here and sub-tasks should be linked to this task.

We currently have support for NuGet protocol version 2 implemented. This version is XML based. The newer version 3 uses JSON.

We need to analyze what needs to be done in order for us to implement support for NuGet v3.

We think we'll need the following:

• A new Spring controller to handle requests for repositories hosting/proxying NuGet v3.
• A new module for the handling of the JSON-based metadata.
• Write more tests that cover the NuGet v3 support.
• Add new tests to the strongbox-web-integration-tests.

Tasks

According to the specification, we need to implement the following:

• Required for minimal core support:
  • PackageBaseAddress : Get package content (.nupkg).
  • PackagePublish : Push and delete (or unlist) packages.
  • RegistrationsBaseUrl : Get package metadata.
  • SearchQueryService : Filter and search for packages by keyword.
• Nice to have. but not mission critical:
  • Catalog : A full record of all package events.
  • PackageDetailsUriTemplate : Construct a URL to access a package details web page.
  • RepositorySignatures : Get certificates used for repository signing.
  • SearchAutocompleteService : Discover package IDs and versions by substring.
  • SymbolPackagePublish : Push symbol packages.

The work will probably have to be carried out in two phases:

• The required features in the new controller : This will allow us to start testing this with the nuget client and it will make it possible to implement new tests in the strongbox-web-integration-tests project. At this point things should be usable from a command-line/shell.
• The not required features : With these features we should have full support for IDE-s, such as Visual Studio.

In addition:

• The proxy support will have to be re-evaluated and we need to investigate if we need to aggregate any metadata, or feeds.
• We need to check, if we need to aggregate any metadata, or feeds.

Follow-up tasks

• Update the documentation, as and when necessary.

Useful Links

• Strongbox: Nuget Layout Provider (v2)
• Strongbox: How To Implement Your Own Repository Format
• NuGet v3 What and Why
• NuGet API: Overview
• NuGet API: Catalog
• NuGet API: Package Metadata
• NuGet API: Package Content
• NuGet API: Search
• NuGet Github Home
• NuGet: Semver 2.0.0 support

Task Relationships

This task:

• Depends on: Investigate what needs to be done to upgrade our Nuget support to use API 3 #1960
• Relates to:
  • How to create own Nuget v3 feed? NuGet/NuGetGallery#2844: How to create own Nuget v3 feed?
  • NuGet.Server for V3 NuGet/NuGetGallery#2632: NuGet.Server for V3

Help

• Our chat
• Points of contact:
  • @carlspring
  • @sbespalov
  • @fuss86