Remotely/Server/Data/AppDb.cs

using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Identity;
using Microsoft.AspNetCore.Identity.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.ChangeTracking;
using Microsoft.EntityFrameworkCore.Diagnostics;
using Microsoft.EntityFrameworkCore.Storage.ValueConversion;
using Microsoft.Extensions.Caching.Memory;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Remotely.Shared.Entities;
using Remotely.Shared.Models;
using Remotely.Shared.Utilities;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;

namespace Remotely.Server.Data;

public class AppDb : IdentityDbContext
{
    private static readonly ValueComparer<string[]> _stringArrayComparer = new(
                (a, b) => (a ?? Array.Empty<string>()).SequenceEqual(b ?? Array.Empty<string>()),
                c => c.Aggregate(0, (a, b) => HashCode.Combine(a, b.GetHashCode())),
                c => c.ToArray());

    private readonly IWebHostEnvironment _hostEnv;

    public AppDb(IWebHostEnvironment hostEnvironment)
    {
        _hostEnv = hostEnvironment;
    }

    public DbSet<Alert> Alerts { get; set; }

    public DbSet<ApiToken> ApiTokens { get; set; }
    public DbSet<BrandingInfo> BrandingInfos { get; set; }
    public DbSet<DeviceGroup> DeviceGroups { get; set; }
    public DbSet<Device> Devices { get; set; }
    public DbSet<InviteLink> InviteLinks { get; set; }
    public DbSet<Organization> Organizations { get; set; }
    public DbSet<SavedScript> SavedScripts { get; set; }
    public DbSet<ScriptResult> ScriptResults { get; set; }
    public DbSet<ScriptRun> ScriptRuns { get; set; }
    public DbSet<ScriptSchedule> ScriptSchedules { get; set; }
    public DbSet<SharedFile> SharedFiles { get; set; }
    public new DbSet<RemotelyUser> Users { get; set; }


    protected override void OnConfiguring(DbContextOptionsBuilder options)
    {
        options.ConfigureWarnings(x => x.Ignore(RelationalEventId.MultipleCollectionIncludeWarning));
        options.LogTo((message) => System.Diagnostics.Debug.Write(message));

        if (_hostEnv.IsDevelopment())
        {
            options.EnableDetailedErrors();
            options.EnableSensitiveDataLogging();
        }
    }

    protected override void OnModelCreating(ModelBuilder builder)
    {
        var jsonOptions = JsonSerializerOptions.Default;

        base.OnModelCreating(builder);

        builder.Entity<IdentityUser>().ToTable("RemotelyUsers");

        builder.Entity<Organization>()
            .HasMany(x => x.Devices)
            .WithOne(x => x.Organization);
        builder.Entity<Organization>()
            .HasMany(x => x.RemotelyUsers)
            .WithOne(x => x.Organization);
        builder.Entity<Organization>()
            .HasMany(x => x.DeviceGroups)
            .WithOne(x => x.Organization);
        builder.Entity<Organization>()
          .HasMany(x => x.InviteLinks)
          .WithOne(x => x.Organization);
        builder.Entity<Organization>()
          .HasMany(x => x.SharedFiles)
          .WithOne(x => x.Organization)
          .IsRequired(false);
        builder.Entity<Organization>()
          .HasMany(x => x.ApiTokens)
          .WithOne(x => x.Organization);
        builder.Entity<Organization>()
            .HasMany(x => x.Alerts)
            .WithOne(x => x.Organization);
        builder.Entity<Organization>()
            .HasMany(x => x.ScriptRuns)
            .WithOne(x => x.Organization);
        builder.Entity<Organization>()
            .HasMany(x => x.ScriptSchedules)
            .WithOne(x => x.Organization);
        builder.Entity<Organization>()
            .HasMany(x => x.ScriptResults)
            .WithOne(x => x.Organization);
        builder.Entity<Organization>()
            .HasMany(x => x.SavedScripts)
            .WithOne(x => x.Organization);
        builder.Entity<Organization>()
            .HasOne(x => x.BrandingInfo)
            .WithOne(x => x.Organization)
            .HasForeignKey<BrandingInfo>(x => x.OrganizationId);

        builder.Entity<RemotelyUser>()
           .HasOne(x => x.Organization)
           .WithMany(x => x.RemotelyUsers);

        builder.Entity<RemotelyUser>()
            .HasMany(x => x.DeviceGroups)
            .WithMany(x => x.Users);
        builder.Entity<RemotelyUser>()
            .HasMany(x => x.Alerts)
            .WithOne(x => x.User);
        builder.Entity<RemotelyUser>()
            .Property(x => x.UserOptions)
            .HasConversion(
                x => JsonSerializer.Serialize(x, jsonOptions),
                x => JsonSerializer.Deserialize<RemotelyUserOptions>(x, jsonOptions));
        builder.Entity<RemotelyUser>()
            .HasMany(x => x.SavedScripts)
            .WithOne(x => x.Creator);
        builder.Entity<RemotelyUser>()
            .HasMany(x => x.ScriptSchedules)
            .WithOne(x => x.Creator);

        builder.Entity<RemotelyUser>()
            .HasIndex(x => x.UserName);

        builder.Entity<Device>()
            .Property(x => x.Drives)
            .HasConversion(
                x => JsonSerializer.Serialize(x, jsonOptions),
                x => TryDeserializeProperty<List<Drive>>(x, jsonOptions));
        builder.Entity<Device>()
           .Property(x => x.Drives)
           .Metadata.SetValueComparer(new ValueComparer<List<Drive>>(true));
        builder.Entity<Device>()
            .HasIndex(x => x.DeviceName);
        builder.Entity<Device>()
            .HasMany(x => x.Alerts)
            .WithOne(x => x.Device);
        builder.Entity<Device>()
            .HasMany(x => x.ScriptRuns)
            .WithMany(x => x.Devices);
        builder.Entity<Device>()
            .HasMany(x => x.ScriptSchedules)
            .WithMany(x => x.Devices);
        builder.Entity<Device>()
            .HasOne(x => x.DeviceGroup)
            .WithMany(x => x.Devices)
            .IsRequired(false);
        builder.Entity<Device>()
            .Property(x => x.MacAddresses)
            .HasConversion(
                x => JsonSerializer.Serialize(x, jsonOptions),
                x => DeserializeStringArray(x, jsonOptions),
                valueComparer: _stringArrayComparer);

        builder.Entity<DeviceGroup>()
            .HasMany(x => x.Devices)
            .WithOne(x => x.DeviceGroup)
            .IsRequired(false);
        builder.Entity<DeviceGroup>()
            .HasMany(x => x.ScriptSchedules)
            .WithMany(x => x.DeviceGroups);

        builder.Entity<ScriptRun>()
            .HasMany(x => x.Devices)
            .WithMany(x => x.ScriptRuns);
        builder.Entity<ScriptRun>()
            .HasMany(x => x.Results)
            .WithOne(x => x.ScriptRun)
            .IsRequired(false);
        builder.Entity<ScriptRun>()
            .HasOne(x => x.SavedScript)
            .WithMany(x => x.ScriptRuns)
            .IsRequired(false);

        builder.Entity<ScriptResult>()
          .Property(x => x.ErrorOutput)
          .HasConversion(
              x => JsonSerializer.Serialize(x, jsonOptions),
              x => DeserializeStringArray(x, jsonOptions))
          .Metadata
          .SetValueComparer(_stringArrayComparer);

        builder.Entity<ScriptResult>()
          .Property(x => x.StandardOutput)
          .HasConversion(
              x => JsonSerializer.Serialize(x, jsonOptions),
              x => DeserializeStringArray(x, jsonOptions))
          .Metadata
          .SetValueComparer(_stringArrayComparer);
        builder.Entity<ScriptResult>()
            .HasOne(x => x.ScriptRun)
            .WithMany(x => x.Results)
            .IsRequired(false);
        builder.Entity<ScriptResult>()
           .HasOne(x => x.SavedScript)
           .WithMany(x => x.ScriptResults)
           .IsRequired(false);

        builder.Entity<Alert>()
            .HasOne(x => x.User)
            .WithMany(x => x.Alerts);


        if (Database.ProviderName == "Microsoft.EntityFrameworkCore.Sqlite")
        {
            // SQLite does not have proper support for DateTimeOffset via Entity Framework Core, see the limitations
            // here: https://docs.microsoft.com/en-us/ef/core/providers/sqlite/limitations#query-limitations
            // To work around this, when the SQLite database provider is used, all model properties of type DateTimeOffset
            // use the DateTimeOffsetToBinaryConverter
            // Based on: https://github.com/aspnet/EntityFrameworkCore/issues/10784#issuecomment-415769754
            // This only supports millisecond precision, but should be sufficient for most use cases.
            foreach (var entityType in builder.Model.GetEntityTypes())
            {
                if (entityType.IsKeyless)
                {
                    continue;
                }
                var properties = entityType.ClrType.GetProperties().Where(p => p.PropertyType == typeof(DateTimeOffset)
                                                                            || p.PropertyType == typeof(DateTimeOffset?));
                foreach (var property in properties)
                {
                    builder
                         .Entity(entityType.Name)
                         .Property(property.Name)
                         .HasConversion(new DateTimeOffsetToStringConverter());
                }
            }
        }

    }

    private static string[] DeserializeStringArray(string value, JsonSerializerOptions jsonOptions)
    {
        try
        {
            if (string.IsNullOrEmpty(value))
            {
                return Array.Empty<string>();
            }
            return JsonSerializer.Deserialize<string[]>(value, jsonOptions) ?? Array.Empty<string>();
        }
        catch
        {
            return Array.Empty<string>();
        }
    }

    private static T TryDeserializeProperty<T>(string value, JsonSerializerOptions jsonOptions)
        where T: new()
    {
        try
        {
            if (string.IsNullOrEmpty(value))
            {
                return new();
            }
            return JsonSerializer.Deserialize<T>(value, jsonOptions) ?? new();
        }
        catch
        {
            return new();
        }
    }
}