Change Provider APIs to use name and version instead of libraryId

- Separates the data objects from Manifest and LibraryInstallationState
- Remove libraryId from from ILibraryInstallationState
- Adapt all clients and use cases to use name and version instead of
libraryId
- Fix all tests to use name and version instead of libraryId

Author: prafullbhosale

src/LibraryManager.Contracts/ILibraryCatalog.cs

@@ -20,12 +20,13 @@ public interface ILibraryCatalog
         Task<CompletionSet> GetLibraryCompletionSetAsync(string value, int caretPosition);
 
         /// <summary>
-        /// Gets the library group from the specified <paramref name="libraryId"/>.
+        /// Gets the library group from the specified <paramref name="libraryName"/>.
         /// </summary>
-        /// <param name="libraryId">The unique library identifier.</param>
+        /// <param name="libraryName">The name of the library.</param>
+        /// <param name="version">The version of the library</param>
         /// <param name="cancellationToken">A token that allows the search to be cancelled.</param>
         /// <returns>An instance of <see cref="ILibraryGroup"/> or <code>null</code>.</returns>
-        Task<ILibrary> GetLibraryAsync(string libraryId, CancellationToken cancellationToken);
+        Task<ILibrary> GetLibraryAsync(string libraryName, string version, CancellationToken cancellationToken);
 
         /// <summary>
         /// Searches the catalog for the specified search term.
@@ -38,10 +39,10 @@ public interface ILibraryCatalog
         /// <summary>
         /// Gets the latest version of the library.
         /// </summary>
-        /// <param name="libraryId">The library identifier.</param>
+        /// <param name="libraryName">The library identifier.</param>
         /// <param name="includePreReleases">if set to <c>true</c> includes pre-releases.</param>
         /// <param name="cancellationToken">A token that allows the search to be cancelled.</param>
         /// <returns>The library identifier of the latest released version.</returns>
-        Task<string> GetLatestVersion(string libraryId, bool includePreReleases, CancellationToken cancellationToken);
+        Task<string> GetLatestVersion(string libraryName, bool includePreReleases, CancellationToken cancellationToken);
     }
 }

src/LibraryManager.Contracts/ILibraryGroup.cs

@@ -23,10 +23,10 @@ public interface ILibraryGroup
         string Description { get; }
 
         /// <summary>
-        /// Gets a list of IDs for the different versions of the library.
+        /// Gets a list of versions of the library.
         /// </summary>
         /// <param name="cancellationToken">A token that allows cancellation of the operation.</param>
         /// <returns>A list of library IDs used to display library information to the user.</returns>
-        Task<IEnumerable<string>> GetLibraryIdsAsync(CancellationToken cancellationToken);
+        Task<IEnumerable<string>> GetLibraryVersions(CancellationToken cancellationToken);
     }
-}
+}

src/LibraryManager.Contracts/ILibraryInstallationState.cs

@@ -10,11 +10,6 @@ namespace Microsoft.Web.LibraryManager.Contracts
     /// </summary>
     public interface ILibraryInstallationState
     {
-        /// <summary>
-        /// The identifyer to uniquely identify the library
-        /// </summary>
-        string LibraryId { get; }
-
         /// <summary>
         /// The name of the library.
         /// </summary>
@@ -39,5 +34,15 @@ public interface ILibraryInstallationState
         /// The path relative to the working directory to copy the files to.
         /// </summary>
         string DestinationPath { get; }
+
+        /// <summary>
+        /// Indicates whether the library is using the default destination
+        /// </summary>
+        bool IsUsingDefaultDestination { get; }
+
+        /// <summary>
+        /// Indicates whether the library is using the default provider
+        /// </summary>
+        bool IsUsingDefaultProvider { get; }
     }
 }

src/LibraryManager.Contracts/PredefinedErrors.cs

@@ -44,6 +44,19 @@ public static IError ProviderUnknown(string providerId)
         public static IError UnableToResolveSource(string libraryId, string providerId)
             => new Error("LIB002", string.Format(Text.ErrorUnableToResolveSource, libraryId, providerId));
 
+        /// <summary>
+        /// The <see cref="IProvider"/> is unable to resolve the source.
+        /// </summary>
+        /// <param name="libraryName">Name of the library</param>
+        /// <param name="version">Version of the library</param>
+        /// <param name="providerId">The ID of the <see cref="IProvider"/> that could not resolve the resource.</param>
+        /// <returns>The error code LIB002</returns>
+        public static IError UnableToResolveSource(string libraryName, string version, string providerId)
+        {
+            string libraryId = string.IsNullOrEmpty(version) ? libraryName : $"{libraryName}@{version}";
+            return UnableToResolveSource(libraryId, providerId);
+        }
+
         /// <summary>
         /// The <see cref="IProvider"/> failed to write a file in the <see cref="ILibraryInstallationState.Files"/> array.
         /// </summary>

src/LibraryManager.Vsix/ErrorList/ErrorList.cs

@@ -5,6 +5,7 @@
 using System.IO;
 using System.Linq;
 using Microsoft.Web.LibraryManager.Contracts;
+using Microsoft.Web.LibraryManager.LibraryNaming;
 
 namespace Microsoft.Web.LibraryManager.Vsix
 {
@@ -42,7 +43,9 @@ public bool HandleErrors(IEnumerable<ILibraryOperationResult> results)
 
         private static void AddLineAndColumn(IEnumerable<string> lines, ILibraryInstallationState state, DisplayError[] errors)
         {
-            if (string.IsNullOrEmpty(state?.LibraryId))
+            string libraryId = LibraryIdToNameAndVersionConverter.Instance.GetLibraryId(state?.Name, state?.Version, state?.ProviderId);
+
+            if(string.IsNullOrEmpty(libraryId))
             {
                 return;
             }
@@ -58,7 +61,7 @@ private static void AddLineAndColumn(IEnumerable<string> lines, ILibraryInstalla
                     if (line.Trim() == "{")
                         index = i;
 
-                    if (line.Contains(state.LibraryId))
+                    if (line.Contains(libraryId))
                     {
                         error.Line = index > 0 ? index : i;
                         break;

src/LibraryManager.Vsix/Json/Completion/FilesCompletionProvider.cs

@@ -39,7 +39,7 @@ protected override IEnumerable<JSONCompletionEntry> GetEntries(JSONCompletionCon
             if (!JsonHelpers.TryGetInstallationState(parent, out ILibraryInstallationState state))
                 yield break;
 
-            if (string.IsNullOrEmpty(state.LibraryId))
+            if (string.IsNullOrEmpty(state.Name))
                 yield break;
 
             var dependencies = Dependencies.FromConfigFile(ConfigFilePath);
@@ -49,7 +49,7 @@ protected override IEnumerable<JSONCompletionEntry> GetEntries(JSONCompletionCon
             if (catalog == null)
                 yield break;
 
-            Task<ILibrary> task = catalog.GetLibraryAsync(state.LibraryId, CancellationToken.None);
+            Task<ILibrary> task = catalog.GetLibraryAsync(state.Name, state.Version, CancellationToken.None);
             FrameworkElement presenter = GetPresenter(context);
             IEnumerable<string> usedFiles = GetUsedFiles(context);
 

src/LibraryManager.Vsix/Json/JsonHelpers.cs

@@ -6,6 +6,7 @@
 using Microsoft.JSON.Core.Parser;
 using Microsoft.JSON.Core.Parser.TreeItems;
 using Microsoft.Web.LibraryManager.Contracts;
+using Microsoft.Web.LibraryManager.Json;
 
 namespace Microsoft.Web.LibraryManager.Vsix
 {
@@ -64,7 +65,7 @@ internal static int FindInsertIndex(JSONParseItemList jsonParseItems, int rangeS
             return max + 1;
         }
 
-        public static bool TryGetInstallationState(JSONObject parent, out ILibraryInstallationState installationState)
+        public static bool TryGetInstallationState(JSONObject parent, out ILibraryInstallationState installationState, string defaultProvider = null)
         {
             installationState = null;
 
@@ -73,7 +74,7 @@ public static bool TryGetInstallationState(JSONObject parent, out ILibraryInstal
                 return false;
             }
 
-            var state = new LibraryInstallationState();
+            var state = new LibraryInstallationStateOnDisk();
 
             foreach (JSONMember child in parent.Children.OfType<JSONMember>())
             {
@@ -124,7 +125,8 @@ public static bool TryGetInstallationState(JSONObject parent, out ILibraryInstal
                 }
             }
 
-            installationState = state;
+            var converter = new LibraryStateToFileConverter(defaultProvider, defaultDestination: null);
+            installationState = converter.ConvertToLibraryInstallationState(state);
 
             return !string.IsNullOrEmpty(installationState.ProviderId);
         }

src/LibraryManager.Vsix/Json/SuggestedActions/SuggestedActionProvider.cs

@@ -63,7 +63,7 @@ public bool HasSuggestedActions(ITextView textView, ITextBuffer textBuffer, int
             ConfigFilePath = doc.FilePath;
             LibraryObject = parent;
 
-            return !string.IsNullOrEmpty(InstallationState.LibraryId);
+            return !string.IsNullOrEmpty(InstallationState.Name);
         }
     }
 }

src/LibraryManager.Vsix/Json/SuggestedActions/UninstallSuggestedActions.cs

@@ -9,6 +9,8 @@
 using System.Threading;
 using Microsoft.VisualStudio.Shell;
 using Microsoft.JSON.Core.Parser;
+using Microsoft.Web.LibraryManager.Contracts;
+using Microsoft.Web.LibraryManager.LibraryNaming;
 
 namespace Microsoft.Web.LibraryManager.Vsix
 {
@@ -29,7 +31,8 @@ public UninstallSuggestedAction(SuggestedActionProvider provider, ILibraryComman
 
         private static string GetDisplayText(SuggestedActionProvider provider)
         {
-            string cleanId = provider.InstallationState.LibraryId;
+            ILibraryInstallationState state = provider.InstallationState;
+            string cleanId = LibraryIdToNameAndVersionConverter.Instance.GetLibraryId(state.Name, state.Version, state.ProviderId);
 
             if (cleanId.Length > _maxlength + 10)
             {
@@ -44,7 +47,9 @@ public override async void Invoke(CancellationToken cancellationToken)
             try
             {
                 Telemetry.TrackUserTask("Invoke-UninstallFromSuggestedAction");
-                await _libraryCommandService.UninstallAsync(_provider.ConfigFilePath, _provider.InstallationState.LibraryId, cancellationToken).ConfigureAwait(false);
+                var state = _provider.InstallationState;
+                await _libraryCommandService.UninstallAsync(_provider.ConfigFilePath, state.Name, state.Version, state.ProviderId, cancellationToken)
+                    .ConfigureAwait(false);
 
                 await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
                 using (ITextEdit edit = TextBuffer.CreateEdit())

src/LibraryManager.Vsix/Json/SuggestedActions/UpdateSuggestedActionSet.cs

@@ -76,23 +76,23 @@ private async Task<IEnumerable<SuggestedActionSet>> GetActionSetAsync()
         private async Task<List<ISuggestedAction>> GetListOfActionsAsync(ILibraryCatalog catalog, CancellationToken cancellationToken)
         {
             var list = new List<ISuggestedAction>();
-            string latestStableVersion = await catalog.GetLatestVersion(_provider.InstallationState.LibraryId, false, cancellationToken).ConfigureAwait(false);
+            string latestStableVersion = await catalog.GetLatestVersion(_provider.InstallationState.Name, false, cancellationToken).ConfigureAwait(false);
             string latestStable = LibraryIdToNameAndVersionConverter.Instance.GetLibraryId(
                             _provider.InstallationState.Name,
                             latestStableVersion,
                             _provider.InstallationState.ProviderId);
 
-            if (!string.IsNullOrEmpty(latestStableVersion) && latestStable != _provider.InstallationState.LibraryId)
+            if (!string.IsNullOrEmpty(latestStableVersion) && latestStableVersion != _provider.InstallationState.Version)
             {
                 list.Add(new UpdateSuggestedAction(_provider, latestStable, $"Stable: {latestStable}"));
             }
 
-            string latestPreVersion = await catalog.GetLatestVersion(_provider.InstallationState.LibraryId, true, cancellationToken).ConfigureAwait(false);
+            string latestPreVersion = await catalog.GetLatestVersion(_provider.InstallationState.Name, true, cancellationToken).ConfigureAwait(false);
             string latestPre = LibraryIdToNameAndVersionConverter.Instance.GetLibraryId(_provider.InstallationState.Name,
                             latestPreVersion,
                             _provider.InstallationState.ProviderId);
 
-            if (!string.IsNullOrEmpty(latestPreVersion) && latestPre != _provider.InstallationState.LibraryId && latestPre != latestStable)
+            if (!string.IsNullOrEmpty(latestPreVersion) && latestPreVersion != _provider.InstallationState.Version && latestPre != latestStable)
             {
                 list.Add(new UpdateSuggestedAction(_provider, latestPre, $"Pre-release: {latestPre}"));
             }