Implementing Repository Management actions + Database changes.

common/Services/INavigationService.cs

@@ -49,4 +49,7 @@ public static class KnownPageKeys
  public static readonly string Feedback = "DevHome.Settings.ViewModels.FeedbackViewModel";
  public static readonly string Environments = "DevHome.Environments.ViewModels.LandingPageViewModel";
  public static readonly string SetupFlow = "DevHome.SetupFlow.ViewModels.SetupFlowViewModel";
+
+ // Will not work with navigation service natively. Used for the dictionary in SetupFlowViewModel
+ public static readonly string RepositoryConfiguration = "RepositoryConfiguration";
 }

common/TelemetryEvents/DevHomeDatabase/DatabaseContextErrorEvent.cs

@@ -0,0 +1,38 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System;
+using System.Diagnostics.Tracing;
+using DevHome.Telemetry;
+using Microsoft.Diagnostics.Telemetry.Internal;
+
+namespace DevHome.Common.TelemetryEvents.DevHomeDatabase;
+
+[EventData]
+public class DatabaseContextErrorEvent : EventBase
+{
+ public override PartA_PrivTags PartA_PrivTags => PartA_PrivTags.ProductAndServicePerformance;
+
+ public string Action { get; } = string.Empty;
+
+ public int HResult { get; }
+
+ public string ExceptionMessage { get; } = string.Empty;
+
+ public DatabaseContextErrorEvent(string action)
+ {
+ Action = action;
+ }
+
+ public DatabaseContextErrorEvent(string action, Exception ex)
+ {
+ Action = action;
+ HResult = ex.HResult;
+ ExceptionMessage = ex.Message;
+ }
+
+ public override void ReplaceSensitiveStrings(Func<string, string> replaceSensitiveStrings)
+ {
+ // no sensitive strings to replace.
+ }
+}

common/TelemetryEvents/DevHomeDatabase/DatabaseEvent.cs

@@ -0,0 +1,38 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System;
+using System.Diagnostics.Tracing;
+using DevHome.Telemetry;
+using Microsoft.Diagnostics.Telemetry.Internal;
+
+namespace DevHome.Common.TelemetryEvents.DevHomeDatabase;
+
+[EventData]
+public class DatabaseEvent : EventBase
+{
+ public override PartA_PrivTags PartA_PrivTags => PartA_PrivTags.ProductAndServicePerformance;
+
+ public string Step { get; } = string.Empty;
+
+ public int HResult { get; }
+
+ public string ExceptionMessage { get; } = string.Empty;
+
+ public DatabaseEvent(string step)
+ {
+ Step = step;
+ }
+
+ public DatabaseEvent(string step, Exception ex)
+ {
+ Step = step;
+ HResult = ex.HResult;
+ ExceptionMessage = ex.Message;
+ }
+
+ public override void ReplaceSensitiveStrings(Func<string, string> replaceSensitiveStrings)
+ {
+ // No sensitive strings to replace.
+ }
+}

common/TelemetryEvents/RepositoryManagement/RepositoryDataAccessErrorEvent.cs

@@ -0,0 +1,37 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System;
+using System.Collections.Generic;
+using System.Diagnostics.Tracing;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using DevHome.Telemetry;
+using Microsoft.Diagnostics.Telemetry.Internal;
+
+namespace DevHome.Common.TelemetryEvents.RepositoryManagement;
+
+[EventData]
+public class RepositoryDataAccessErrorEvent : EventBase
+{
+ public override PartA_PrivTags PartA_PrivTags => PartA_PrivTags.ProductAndServicePerformance;
+
+ public string Action { get; } = string.Empty;
+
+ public int HResult { get; }
+
+ public string ErrorMessage { get; } = string.Empty;
+
+ public RepositoryDataAccessErrorEvent(string action, int hResult, string errorMessage)
+ {
+ Action = action;
+ HResult = hResult;
+ ErrorMessage = errorMessage;
+ }
+
+ public override void ReplaceSensitiveStrings(Func<string, string> replaceSensitiveStrings)
+ {
+ // No sensative strings to replace
+ }
+}

common/TelemetryEvents/RepositoryManagement/RepositoryDataAccessEvent.cs

@@ -0,0 +1,34 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System;
+using System.Collections.Generic;
+using System.Diagnostics.Tracing;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using DevHome.Telemetry;
+using Microsoft.Diagnostics.Telemetry.Internal;
+
+namespace DevHome.Common.TelemetryEvents.RepositoryManagement;
+
+[EventData]
+public class RepositoryDataAccessEvent : EventBase
+{
+ public override PartA_PrivTags PartA_PrivTags => PartA_PrivTags.ProductAndServicePerformance;
+
+ public string Action { get; } = string.Empty;
+
+ public string Message { get; } = string.Empty;
+
+ public RepositoryDataAccessEvent(string action, string message)
+ {
+ Action = action;
+ Message = message;
+ }
+
+ public override void ReplaceSensitiveStrings(Func<string, string> replaceSensitiveStrings)
+ {
+ // No sensative strings to replace
+ }
+}

common/TelemetryEvents/RepositoryManagement/RepositoryLineItemErrorEvent.cs

@@ -0,0 +1,36 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System;
+using System.Diagnostics.Tracing;
+using DevHome.Telemetry;
+using Microsoft.Diagnostics.Telemetry.Internal;
+
+namespace DevHome.Common.TelemetryEvents.RepositoryManagement;
+
+[EventData]
+public class RepositoryLineItemErrorEvent : EventBase
+{
+ public override PartA_PrivTags PartA_PrivTags => PartA_PrivTags.ProductAndServicePerformance;
+
+ public string Action { get; } = string.Empty;
+
+ public int Hresult { get; }
+
+ public string ErrorMessage { get; } = string.Empty;
+
+ public string RepositoryName { get; } = string.Empty;
+
+ public RepositoryLineItemErrorEvent(string action, int hresult, string errorMessage, string repositoryName)
+ {
+ Action = action;
+ Hresult = hresult;
+ ErrorMessage = errorMessage;
+ RepositoryName = repositoryName;
+ }
+
+ public override void ReplaceSensitiveStrings(Func<string, string> replaceSensitiveStrings)
+ {
+ // No sensitive strings to replace
+ }
+}

common/TelemetryEvents/RepositoryManagement/RepositoryLineItemEvent.cs

@@ -0,0 +1,34 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System;
+using System.Collections.Generic;
+using System.Diagnostics.Tracing;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using DevHome.Telemetry;
+using Microsoft.Diagnostics.Telemetry.Internal;
+
+namespace DevHome.Common.TelemetryEvents.RepositoryManagement;
+
+[EventData]
+public class RepositoryLineItemEvent : EventBase
+{
+ public override PartA_PrivTags PartA_PrivTags => PartA_PrivTags.ProductAndServiceUsage;
+
+ public string Action { get; } = string.Empty;
+
+ public string RepositoryName { get; } = string.Empty;
+
+ public RepositoryLineItemEvent(string action, string repositoryName)
+ {
+ Action = action;
+ RepositoryName = repositoryName;
+ }
+
+ public override void ReplaceSensitiveStrings(Func<string, string> replaceSensitiveStrings)
+ {
+ // no sensitive strings to replace
+ }
+}

database/DevHome.Database/DatabaseModels/RepositoryManagement/Repository.cs

@@ -20,11 +20,17 @@ public class Repository
 
  public string? RepositoryClonePath { get; set; }
 
+ public bool IsHidden { get; set; }
+
+ public bool HasAConfigurationFile => !string.IsNullOrEmpty(ConfigurationFileLocation);
+
+ public string? ConfigurationFileLocation { get; set; }
+
+ // Use string here. Add-Migration is running into an issue with the Uri class.
+ // This causes any fluent API statements to get ignored.
+ public string? RepositoryUri { get; set; }
+
  public DateTime? CreatedUTCDate { get; set; }
 
  public DateTime? UpdatedUTCDate { get; set; }
-
- // 1:1 relationship. Repository is the parent and needs only
- // the object of the dependant.
- public RepositoryMetadata? RepositoryMetadata { get; set; }
 }

database/DevHome.Database/DevHomeDatabaseContext.cs

@@ -2,28 +2,39 @@
 // Licensed under the MIT License.
 
 using System;
-using System.ComponentModel.DataAnnotations.Schema;
 using System.IO;
+using System.Linq.Expressions;
+using DevHome.Common.TelemetryEvents.DevHomeDatabase;
 using DevHome.Database.DatabaseModels.RepositoryManagement;
+using DevHome.Telemetry;
 using Microsoft.EntityFrameworkCore;
+using Microsoft.EntityFrameworkCore.Storage.ValueConversion;
+using Serilog;
 
 namespace DevHome.Database;
 
+/// <summary>
+/// To make the database please run the following in Package Manager Console
+/// Update-Database -StartupProject DevHome.Database -Project DevHome.Database
+///
+/// TODO: Remove this comment after database migration is implemeneted.
+/// TODO: Set up Github detection for files in this project.
+/// TODO: Add documentation around migration and Entity Framework in DevHome.
+/// </summary>
 public class DevHomeDatabaseContext : DbContext
 {
- public DbSet<Repository> Repositories { get; set; }
+ private const string DatabaseFileName = "DevHome.db";
+
+ private readonly ILogger _log = Log.ForContext("SourceContext", nameof(DevHomeDatabaseContext));
 
- public DbSet<RepositoryMetadata> RepositoryMetadatas { get; set; }
+ public DbSet<Repository> Repositories { get; set; }
 
  public string DbPath { get; }
 
  public DevHomeDatabaseContext()
  {
- // TODO: make the default path Application data if an MSIX.
- // Otherwise use a temp location. Location to be determined later.
- var folder = Environment.SpecialFolder.LocalApplicationData;
- var path = Environment.GetFolderPath(folder);
- DbPath = Path.Join(path, "DevHome.db");
+ // TODO: How to run the DevHome in VS and not have the file move to the per app location.
+ DbPath = Path.Join(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), DatabaseFileName);
  }
 
  protected override void OnModelCreating(ModelBuilder modelBuilder)
@@ -32,27 +43,34 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
  // models using fluent API. Currently, not needed, but will as this method
  // will expand as more entities are added.
  // If that is too much work these definitions can be placed inside the C# class.
- var repositoryEntity = modelBuilder.Entity<Repository>();
- if (repositoryEntity != null)
+ try
  {
- repositoryEntity.Property(x => x.RepositoryClonePath).HasDefaultValue(string.Empty).IsRequired(true);
- repositoryEntity.Property(x => x.RepositoryName).HasDefaultValue(string.Empty).IsRequired(true);
- repositoryEntity.Property(x => x.CreatedUTCDate).HasDefaultValueSql("datetime()");
- repositoryEntity.Property(x => x.UpdatedUTCDate).HasDefaultValue(new DateTime(1, 1, 1, 0, 0, 0, DateTimeKind.Utc));
- repositoryEntity.ToTable("Repository");
+ // TODO: How to update "UpdatedAt"?
+ var repositoryEntity = modelBuilder.Entity<Repository>();
+ if (repositoryEntity != null)
+ {
+ repositoryEntity.Property(x => x.ConfigurationFileLocation).HasDefaultValue(string.Empty);
+ repositoryEntity.Property(x => x.RepositoryClonePath).HasDefaultValue(string.Empty).IsRequired(true);
+ repositoryEntity.Property(x => x.RepositoryName).HasDefaultValue(string.Empty).IsRequired(true);
+ repositoryEntity.Property(x => x.CreatedUTCDate).HasDefaultValueSql("datetime()");
+ repositoryEntity.Property(x => x.UpdatedUTCDate).HasDefaultValueSql("datetime()");
+ repositoryEntity.Property(x => x.RepositoryUri).HasDefaultValue(string.Empty);
+ repositoryEntity.ToTable("Repository");
+ }
  }
-
- var repositoryMetadataEntity = modelBuilder.Entity<RepositoryMetadata>();
- if (repositoryMetadataEntity != null)
+ catch (Exception ex)
  {
- repositoryMetadataEntity.Property(x => x.IsHiddenFromPage).HasDefaultValue(false).IsRequired(true);
- repositoryMetadataEntity.Property(x => x.UtcDateHidden).HasDefaultValue(new DateTime(1, 1, 1, 0, 0, 0, DateTimeKind.Utc)).IsRequired(true);
- repositoryMetadataEntity.Property(x => x.CreatedUTCDate).HasDefaultValueSql("datetime()");
- repositoryMetadataEntity.Property(x => x.UpdatedUTCDate).HasDefaultValue(new DateTime(1, 1, 1, 0, 0, 0, DateTimeKind.Utc));
- repositoryMetadataEntity.ToTable("RepositoryMetadata");
+ // TODO: Notify user the database could not initialize.
+ _log.Error(ex, "Can not build the database model");
+ TelemetryFactory.Get<ITelemetry>().Log(
+ "DevHome_DatabaseContext_Event",
+ LogLevel.Critical,
+ new DatabaseContextErrorEvent("CreatingModel", ex));
  }
  }
 
  protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
- => optionsBuilder.UseSqlite($"Data Source={DbPath}");
+ {
+ optionsBuilder.UseSqlite($"Data Source={DbPath}");
+ }
 }