Add notes for v3.1-beta.5

.gitignore

@@ -332,3 +332,4 @@ ASALocalRun/
 
 # manually ignored files
 /__TODO.txt
+/DataLayer/LibationContext.db

DataLayer/Migrations/20191125182309_Fresh.Designer.cs

@@ -9,7 +9,7 @@ using Microsoft.EntityFrameworkCore.Storage.ValueConversion;
 namespace DataLayer.Migrations
 {
     [DbContext(typeof(LibationContext))]
-    [Migration("20191119144803_Fresh")]
+    [Migration("20191125182309_Fresh")]
     partial class Fresh
     {
         protected override void BuildTargetModel(ModelBuilder modelBuilder)
@@ -129,6 +129,13 @@ namespace DataLayer.Migrations
                     b.HasIndex("Name");
 
                     b.ToTable("Contributors");
+
+                    b.HasData(
+                        new
+                        {
+                            ContributorId = -1,
+                            Name = ""
+                        });
                 });
 
             modelBuilder.Entity("DataLayer.LibraryBook", b =>

DataLayer/Migrations/20191125182309_Fresh.cs

@@ -200,6 +200,11 @@ namespace DataLayer.Migrations
                 columns: new[] { "CategoryId", "AudibleCategoryId", "Name", "ParentCategoryCategoryId" },
                 values: new object[] { -1, "", "", null });
 
+            migrationBuilder.InsertData(
+                table: "Contributors",
+                columns: new[] { "ContributorId", "AudibleContributorId", "Name" },
+                values: new object[] { -1, null, "" });
+
             migrationBuilder.CreateIndex(
                 name: "IX_BookContributor_BookId",
                 table: "BookContributor",

DataLayer/Migrations/LibationContextModelSnapshot.cs

@@ -127,6 +127,13 @@ namespace DataLayer.Migrations
                     b.HasIndex("Name");
 
                     b.ToTable("Contributors");
+
+                    b.HasData(
+                        new
+                        {
+                            ContributorId = -1,
+                            Name = ""
+                        });
                 });
 
             modelBuilder.Entity("DataLayer.LibraryBook", b =>

DataLayer/UNTESTED/EfClasses/Book.cs

@@ -62,7 +62,8 @@ namespace DataLayer
             string description,
             int lengthInMinutes,
 			IEnumerable<Contributor> authors,
-			IEnumerable<Contributor> narrators)
+			IEnumerable<Contributor> narrators,
+			Category category)
         {
             // validate
             ArgumentValidator.EnsureNotNull(audibleProductId, nameof(audibleProductId));
@@ -80,8 +81,7 @@ namespace DataLayer
             _seriesLink = new HashSet<SeriesBook>();
             _supplements = new HashSet<Supplement>();
 
-            // since category/id is never null, nullity means it hasn't been loaded
-            CategoryId = Category.GetEmpty().CategoryId;
+			Category = category;
 
             // simple assigns
             Title = title;
@@ -91,7 +91,7 @@ namespace DataLayer
             // assigns with biz logic
             ReplaceAuthors(authors);
             ReplaceNarrators(narrators);
-        }
+		}
 
         #region contributors, authors, narrators
         // use uninitialised backing fields - this means we can detect if the collection was loaded
@@ -233,8 +233,8 @@ namespace DataLayer
 
         public void UpdateCategory(Category category, DbContext context = null)
         {
-            // since category is never null, nullity means it hasn't been loaded
-            if (Category != null || CategoryId == Category.GetEmpty().CategoryId)
+            // since category is never null, nullity means it hasn't been loaded. non null means we're correctly loaded. just overwrite
+            if (Category != null)
             {
                 Category = category;
                 return;

DataLayer/UNTESTED/EfClasses/Category.cs

@@ -18,8 +18,7 @@ namespace DataLayer
     public class Category
     {
         // Empty is a special case. use private ctor w/o validation
-        public static Category GetEmpty() => new Category { CategoryId = -1, AudibleCategoryId = "", Name = "", ParentCategory = null };
-        public bool IsEmpty() => string.IsNullOrWhiteSpace(AudibleCategoryId) || string.IsNullOrWhiteSpace(Name) || ParentCategory == null;
+        public static Category GetEmpty() => new Category { CategoryId = -1, AudibleCategoryId = "", Name = "" };
 
         internal int CategoryId { get; private set; }
         public string AudibleCategoryId { get; private set; }

DataLayer/UNTESTED/EfClasses/Contributor.cs

@@ -5,21 +5,24 @@ using Dinah.Core;
 namespace DataLayer
 {
     public class Contributor
-    {
-        // contributors search links are just name with url-encoding. space can be + or %20
-        //   author search link:   /search?searchAuthor=Robert+Bevan
-        //   narrator search link: /search?searchNarrator=Robert+Bevan
-        // can also search multiples. concat with comma before url encode
+	{
+		// Empty is a special case. use private ctor w/o validation
+		public static Contributor GetEmpty() => new Contributor { ContributorId = -1, Name = "" };
 
-        // id.s
-        // ----
-        // https://www.audible.com/author/Neil-Gaiman/B000AQ01G2 == https://www.audible.com/author/B000AQ01G2
-        //     goes to summary page
-        //     at bottom "See all titles by Neil Gaiman" goes to https://www.audible.com/search?searchAuthor=Neil+Gaiman
-        // some authors have no id. simply goes to https://www.audible.com/search?searchAuthor=Rufus+Fears
-        // all narrators have no id: https://www.audible.com/search?searchNarrator=Neil+Gaiman
+		// contributors search links are just name with url-encoding. space can be + or %20
+		//   author search link:   /search?searchAuthor=Robert+Bevan
+		//   narrator search link: /search?searchNarrator=Robert+Bevan
+		// can also search multiples. concat with comma before url encode
 
-        internal int ContributorId { get; private set; }
+		// id.s
+		// ----
+		// https://www.audible.com/author/Neil-Gaiman/B000AQ01G2 == https://www.audible.com/author/B000AQ01G2
+		//     goes to summary page
+		//     at bottom "See all titles by Neil Gaiman" goes to https://www.audible.com/search?searchAuthor=Neil+Gaiman
+		// some authors have no id. simply goes to https://www.audible.com/search?searchAuthor=Rufus+Fears
+		// all narrators have no id: https://www.audible.com/search?searchNarrator=Neil+Gaiman
+
+		internal int ContributorId { get; private set; }
         public string Name { get; private set; }
 
         private HashSet<BookContributor> _booksLink;

DataLayer/UNTESTED/LibationContext.cs

@@ -56,10 +56,13 @@ namespace DataLayer
             modelBuilder.ApplyConfiguration(new SeriesBookConfig());
             modelBuilder.ApplyConfiguration(new CategoryConfig());
 
-            // seeds go here. examples in scratch pad
-            modelBuilder
-                .Entity<Category>()
-                .HasData(Category.GetEmpty());
+			// seeds go here. examples in scratch pad
+			modelBuilder
+				.Entity<Category>()
+				.HasData(Category.GetEmpty());
+			modelBuilder
+				.Entity<Contributor>()
+				.HasData(Contributor.GetEmpty());
 
             // views are now supported via "query types" (instead of "entity types"): https://docs.microsoft.com/en-us/ef/core/modeling/query-types
         }

DtoImporterService/BookImporter.cs

@@ -51,77 +51,87 @@ namespace DtoImporterService
 				var book = context.Books.Local.SingleOrDefault(p => p.AudibleProductId == item.ProductId);
 				if (book is null)
 				{
-					// nested logic is required so order of names is retained. else, contributors may appear in the order they were inserted into the db
-					var authors = item
-						.Authors
-						.Select(a => context.Contributors.Local.Single(c => a.Name == c.Name))
-						.ToList();
-
-					// if no narrators listed, author is the narrator
-					if (item.Narrators is null || !item.Narrators.Any())
-						item.Narrators = item.Authors;
-					// nested logic is required so order of names is retained. else, contributors may appear in the order they were inserted into the db
-					var narrators = item
-						.Narrators
-						.Select(n => context.Contributors.Local.Single(c => n.Name == c.Name))
-						.ToList();
-
-					book = context.Books.Add(new Book(
-						new AudibleProductId(item.ProductId),
-						item.Title,
-						item.Description,
-						item.LengthInMinutes,
-						authors,
-						narrators)
-					).Entity;
-
-					var publisherName = item.Publisher;
-					if (!string.IsNullOrWhiteSpace(publisherName))
-					{
-						var publisher = context.Contributors.Local.Single(c => publisherName == c.Name);
-						book.ReplacePublisher(publisher);
-					}
-
+					book = createNewBook(item, context);
 					qtyNew++;
 				}
 
-				// set/update book-specific info which may have changed
-				book.PictureId = item.PictureId;
-				book.UpdateProductRating(item.Product_OverallStars, item.Product_PerformanceStars, item.Product_StoryStars);
-				if (!string.IsNullOrWhiteSpace(item.SupplementUrl))
-					book.AddSupplementDownloadUrl(item.SupplementUrl);
-
-				// important to update user-specific info. this will have changed if user has rated/reviewed the book since last library import
-				book.UserDefinedItem.UpdateRating(item.MyUserRating_Overall, item.MyUserRating_Performance, item.MyUserRating_Story);
-
-				//
-				// this was round 1 when it was a 2 step process
-				//
-				//// update series even for existing books. these are occasionally updated
-				//var seriesIds = item.Series.Select(kvp => kvp.SeriesId).ToList();
-				//var allSeries = context.Series.Local.Where(c => seriesIds.Contains(c.AudibleSeriesId)).ToList();
-				//foreach (var series in allSeries)
-				//	book.UpsertSeries(series);
-
-				// these will upsert over library-scraped series, but will not leave orphans
-				if (item.Series != null)
-				{
-					foreach (var seriesEntry in item.Series)
-					{
-						var series = context.Series.Local.Single(s => seriesEntry.SeriesId == s.AudibleSeriesId);
-						book.UpsertSeries(series, seriesEntry.Index);
-					}
-				}
-
-				// categories are laid out for a breadcrumb. category is 1st, subcategory is 2nd
-				var category = context.Categories.Local.SingleOrDefault(c => c.AudibleCategoryId == item.Categories.LastOrDefault().CategoryId);
-				if (category != null)
-					book.UpdateCategory(category, context);
-
-				book.UpdateBookDetails(item.IsAbridged, item.DatePublished);
+				updateBook(item, book, context);
 			}
 
 			return qtyNew;
 		}
+
+		private static Book createNewBook(Item item, LibationContext context)
+		{
+			// absence of authors is very rare, but possible
+			if (!item.Authors?.Any() ?? true)
+				item.Authors = new[] { new Person { Name = "", Asin = null } };
+
+			// nested logic is required so order of names is retained. else, contributors may appear in the order they were inserted into the db
+			var authors = item
+				.Authors
+				.Select(a => context.Contributors.Local.Single(c => a.Name == c.Name))
+				.ToList();
+
+			var narrators
+				= item.Narrators is null || !item.Narrators.Any()
+				// if no narrators listed, author is the narrator
+				? authors
+				// nested logic is required so order of names is retained. else, contributors may appear in the order they were inserted into the db
+				: item
+					.Narrators
+					.Select(n => context.Contributors.Local.Single(c => n.Name == c.Name))
+					.ToList();
+
+			// categories are laid out for a breadcrumb. category is 1st, subcategory is 2nd
+			// absence of categories is very rare, but possible
+			var lastCategory = item.Categories.LastOrDefault()?.CategoryId ?? "";
+			var category = context.Categories.Local.SingleOrDefault(c => c.AudibleCategoryId == lastCategory);
+
+			var book = context.Books.Add(new Book(
+				new AudibleProductId(item.ProductId),
+				item.Title,
+				item.Description,
+				item.LengthInMinutes,
+				authors,
+				narrators,
+				category)
+			).Entity;
+
+			var publisherName = item.Publisher;
+			if (!string.IsNullOrWhiteSpace(publisherName))
+			{
+				var publisher = context.Contributors.Local.Single(c => publisherName == c.Name);
+				book.ReplacePublisher(publisher);
+			}
+
+			book.UpdateBookDetails(item.IsAbridged, item.DatePublished);
+
+			if (!string.IsNullOrWhiteSpace(item.SupplementUrl))
+				book.AddSupplementDownloadUrl(item.SupplementUrl);
+
+			return book;
+		}
+
+		private static void updateBook(Item item, Book book, LibationContext context)
+		{
+			// set/update book-specific info which may have changed
+			book.PictureId = item.PictureId;
+			book.UpdateProductRating(item.Product_OverallStars, item.Product_PerformanceStars, item.Product_StoryStars);
+
+			// important to update user-specific info. this will have changed if user has rated/reviewed the book since last library import
+			book.UserDefinedItem.UpdateRating(item.MyUserRating_Overall, item.MyUserRating_Performance, item.MyUserRating_Story);
+
+			// update series even for existing books. these are occasionally updated
+			// these will upsert over library-scraped series, but will not leave orphans
+			if (item.Series != null)
+			{
+				foreach (var seriesEntry in item.Series)
+				{
+					var series = context.Series.Local.Single(s => seriesEntry.SeriesId == s.AudibleSeriesId);
+					book.UpsertSeries(series, seriesEntry.Index);
+				}
+			}
+		}
 	}
 }

DtoImporterService/CategoryImporter.cs

@@ -33,8 +33,11 @@ namespace DtoImporterService
 				.Except(localIds)
 				.ToList();
 
+			// load existing => local
+			// remember to include default/empty/missing
+			var emptyName = Contributor.GetEmpty().Name;
 			if (remainingCategoryIds.Any())
-				context.Categories.Where(c => remainingCategoryIds.Contains(c.AudibleCategoryId)).ToList();
+				context.Categories.Where(c => remainingCategoryIds.Contains(c.AudibleCategoryId) || c.Name == emptyName).ToList();
 		}
 
 		// only use after loading contributors => local

DtoImporterService/ContributorImporter.cs

@@ -19,10 +19,10 @@ namespace DtoImporterService
 			var publishers = items.GetPublishersDistinct().ToList();
 
 			// load db existing => .Local
-			var allNames = authors
-				.Select(a => a.Name)
+			var allNames = publishers
+				.Union(authors.Select(n => n.Name))
 				.Union(narrators.Select(n => n.Name))
-				.Union(publishers)
+				.Where(name => !string.IsNullOrWhiteSpace(name))
 				.ToList();
 			loadLocal_contributors(allNames, context);
 
@@ -36,9 +36,6 @@ namespace DtoImporterService
 
 		private void loadLocal_contributors(List<string> contributorNames, LibationContext context)
 		{
-			contributorNames.Remove(null);
-			contributorNames.Remove("");
-
 			//// BAD: very inefficient
 			// var x = context.Contributors.Local.Where(c => !contribNames.Contains(c.Name));
 
@@ -50,11 +47,10 @@ namespace DtoImporterService
 				.ToList();
 
 			// load existing => local
+			// remember to include default/empty/missing
+			var emptyName = Contributor.GetEmpty().Name;
 			if (remainingContribNames.Any())
-				context.Contributors.Where(c => remainingContribNames.Contains(c.Name)).ToList();
-			// _________________________________^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-			// i tried to extract this pattern, but this part prohibits doing so
-			// wouldn't work anyway for Books.GetBooks()
+				context.Contributors.Where(c => remainingContribNames.Contains(c.Name) || c.Name == emptyName).ToList();
 		}
 
 		// only use after loading contributors => local

DtoImporterService/ImporterBase.cs

@@ -20,12 +20,28 @@ namespace DtoImporterService
 				}
 			}
 
-			var exceptions = Validate(param);
-			if (exceptions != null && exceptions.Any())
-				throw new AggregateException($"Device Jobs Service configuration validation failed", exceptions);
+			try
+			{
+				var exceptions = Validate(param);
+				if (exceptions != null && exceptions.Any())
+					throw new AggregateException($"Importer validation failed", exceptions);
+			}
+			catch (Exception ex)
+			{
+				Serilog.Log.Logger.Error(ex, "Import error: validation");
+				throw;
+			}
 
-			var result = func(param, context);
-			return result;
+			try
+			{
+				var result = func(param, context);
+				return result;
+			}
+			catch (Exception ex)
+			{
+				Serilog.Log.Logger.Error(ex, "Import error: post-validation importing");
+				throw;
+			}
 		}
 		IEnumerable<Exception> Validate(T param);
 	}

DtoImporterService/SeriesImporter.cs

@@ -17,17 +17,17 @@ namespace DtoImporterService
 			var series = items.GetSeriesDistinct().ToList();
 
 			// load db existing => .Local
-			var seriesIds = series.Select(s => s.SeriesId).ToList();
-			loadLocal_series(seriesIds, context);
+			loadLocal_series(series, context);
 
 			// upsert
 			var qtyNew = upsertSeries(series, context);
 			return qtyNew;
 		}
 
-		private void loadLocal_series(List<string> seriesIds, LibationContext context)
+		private void loadLocal_series(List<AudibleApiDTOs.Series> series, LibationContext context)
 		{
-			var localIds = context.Series.Local.Select(s => s.AudibleSeriesId);
+			var seriesIds = series.Select(s => s.SeriesId).ToList();
+			var localIds = context.Series.Local.Select(s => s.AudibleSeriesId).ToList();
 			var remainingSeriesIds = seriesIds
 				.Distinct()
 				.Except(localIds)

InternalUtilities/UNTESTED/AudibleApiActions.cs

@@ -28,7 +28,7 @@ namespace InternalUtilities
 
 		private async Task<List<Item>> getItemsAsync(ILoginCallback callback)
 		{
-			var api = await EzApiCreator.GetApiAsync(AudibleApiStorage.IdentityTokensFile, callback, Configuration.Instance.LocaleCountryCode);
+			var api = await getApiAsync(callback);
 			var items = await AudibleApiExtensions.GetAllLibraryItemsAsync(api);
 
 			// remove episode parents
@@ -62,6 +62,20 @@ namespace InternalUtilities
 			return items;
 		}
 
+		private async Task<Api> getApiAsync(ILoginCallback callback)
+		{
+			try
+			{
+				return await EzApiCreator.GetApiAsync(AudibleApiStorage.IdentityTokensFile, callback, Configuration.Instance.LocaleCountryCode);
+			}
+			catch (Exception ex)
+			{
+				Serilog.Log.Logger.Error(ex, "Error getting Audible API");
+				throw;
+			}
+
+		}
+
 		private static List<IValidator> getValidators()
 		{
 			var type = typeof(IValidator);

InternalUtilities/UNTESTED/AudibleApiExtensions.cs

@@ -27,8 +27,19 @@ namespace InternalUtilities
 					ResponseGroups = LibraryOptions.ResponseGroupOptions.ALL_OPTIONS
 				});
 
-				// important! use this convert method
-				var libResult = LibraryDtoV10.FromJson(page.ToString());
+				string pageStr = null;
+				LibraryDtoV10 libResult;
+				try
+				{
+					pageStr = page.ToString();
+					// important! use this convert method
+					libResult = LibraryDtoV10.FromJson(pageStr);
+				}
+				catch (Exception ex)
+				{
+					Serilog.Log.Logger.Error(ex, "Error converting library for importing use. Full library:\r\n" + pageStr);
+					throw;
+				}
 
 				if (!libResult.Items.Any())
 					break;

InternalUtilities/UNTESTED/AudibleApiValidators.cs

@@ -29,12 +29,12 @@ namespace InternalUtilities
 		{
 			var exceptions = new List<Exception>();
 
+			// a book having no authors is rare but allowed
+
 			if (items.Any(i => string.IsNullOrWhiteSpace(i.ProductId)))
 				exceptions.Add(new ArgumentException($"Collection contains item(s) with blank {nameof(Item.ProductId)}", nameof(items)));
 			if (items.Any(i => string.IsNullOrWhiteSpace(i.Title)))
 				exceptions.Add(new ArgumentException($"Collection contains item(s) with blank {nameof(Item.Title)}", nameof(items)));
-			if (items.Any(i => i.Authors is null))
-				exceptions.Add(new ArgumentException($"Collection contains item(s) with null {nameof(Item.Authors)}", nameof(items)));
 
 			return exceptions;
 		}

LibationWinForm/UNTESTED/Dialogs/IndexLibraryDialog.cs

@@ -1,4 +1,5 @@
-using System.Windows.Forms;
+using System;
+using System.Windows.Forms;
 using ApplicationServices;
 
 namespace LibationWinForm
@@ -20,9 +21,11 @@ namespace LibationWinForm
 			{
 				(TotalBooksProcessed, NewBooksAdded) = await LibraryCommands.IndexLibraryAsync(new Login.WinformResponder());
 			}
-			catch
+			catch (Exception ex)
 			{
-				MessageBox.Show("Error importing library. Please try again. If this happens after 2 or 3 tries, contact administrator", "Error importing library", MessageBoxButtons.OK, MessageBoxIcon.Error);
+				var msg = "Error importing library. Please try again. If this happens after 2 or 3 tries, contact administrator";
+				Serilog.Log.Logger.Error(ex, msg);
+				MessageBox.Show(msg, "Error importing library", MessageBoxButtons.OK, MessageBoxIcon.Error);
 			}
 
 			this.Close();

LibationWinForm/UNTESTED/Program.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Windows.Forms;
+using Serilog;
 
 namespace LibationWinForm
 {
@@ -14,6 +15,8 @@ namespace LibationWinForm
 			if (!createSettings())
 				return;
 
+			init();
+
 			Application.Run(new Form1());
 		}
 
@@ -29,7 +32,7 @@ Please fill in a few settings on the following page. You can also change these s
 After you make your selections, get started by importing your library.
 Go to Import > Scan Library
 ".Trim();
-			MessageBox.Show(welcomeText, "Welcom to Libation", MessageBoxButtons.OK);
+			MessageBox.Show(welcomeText, "Welcome to Libation", MessageBoxButtons.OK);
 			var dialogResult = new SettingsDialog().ShowDialog();
 			if (dialogResult != DialogResult.OK)
 			{
@@ -39,5 +42,14 @@ Go to Import > Scan Library
 
 			return true;
 		}
+
+		private static void init()
+		{
+			var logPath = System.IO.Path.Combine(FileManager.Configuration.Instance.LibationFiles, "Log.log");
+			Log.Logger = new LoggerConfiguration()
+				.MinimumLevel.Debug()
+				.WriteTo.File(logPath, rollingInterval: RollingInterval.Month)
+				.CreateLogger();
+		}
 	}
 }

REFERENCE.txt

@@ -1,6 +1,9 @@
 -- begin VERSIONING ---------------------------------------------------------------------------------------------------------------------
 https://github.com/rmcrackan/Libation/releases
 
+v3.1-beta.5 : Improved importing
+v3.1-beta.4 : Added beta-specific logging
+v3.1-beta.3 : fixed known performance issue: Full-screen grid is slow to respond loading when books aren't liberated
 v3.1-beta.2 : fixed known performance issue: Tag add/edit
 v3.1-beta.1 : RELEASE TO BETA
 v3.0.3 : Switch to SQLite. No longer relies on LocalDB, which must be installed separately