UnrealEngineUWP/Engine/Source/Programs/Horde/Horde.Build/Projects/ProjectCollection.cs

// Copyright Epic Games, Inc. All Rights Reserved.

using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Linq;
using System.Threading.Tasks;
using Horde.Build.Acls;
using Horde.Build.Configuration;
using Horde.Build.Server;
using Horde.Build.Utilities;
using Microsoft.Extensions.Logging;
using MongoDB.Bson.Serialization.Attributes;
using MongoDB.Driver;

namespace Horde.Build.Projects
{
	using ProjectId = StringId<IProject>;

	/// <summary>
	/// Wraps functionality for manipulating projects
	/// </summary>
	public class ProjectCollection : IProjectCollection
	{
		/// <summary>
		/// Represents a project
		/// </summary>
		class ProjectDocument : IProject
		{
			public const int DefaultOrder = 128;

			[BsonRequired, BsonId]
			public ProjectId Id { get; set; }

			[BsonRequired]
			public string ConfigRevision { get; set; } = null!;

			public int Order { get; set; } = DefaultOrder;
			public Acl? Acl { get; set; }

			[BsonIgnoreIfDefault, BsonDefaultValue(false)]
			public bool Deleted { get; set; }

			#region IProject interface

			[BsonIgnore]
			public string Name => Config?.Name!;

			[BsonIgnore]
			public ProjectConfig Config { get; private set; } = null!;

			public async Task PostLoadAsync(ConfigCollection configCollection, ILogger logger)
			{
				try
				{
					if (Deleted)
					{
						Config = new ProjectConfig();
					}
					else
					{
						Config = await configCollection.GetConfigAsync<ProjectConfig>(ConfigRevision);
					}
				}
				catch (Exception)
				{
					logger.LogError("Unable to get stream config for {StreamId} at {Revision}", Id, ConfigRevision);
					throw;
				}
			}

			#endregion
		}

		/// <summary>
		/// Logo for a project
		/// </summary>
		class ProjectLogoDocument : IProjectLogo
		{
			public ProjectId Id { get; set; }

			public string Path { get; set; } = String.Empty;
			public string Revision { get; set; } = String.Empty;
			public string MimeType { get; set; } = String.Empty;

			public byte[] Data { get; set; } = Array.Empty<byte>();
		}

		/// <summary>
		/// Projection of a project definition to just include permissions info
		/// </summary>
		[SuppressMessage("Design", "CA1812: Class is never instantiated")]
		class ProjectPermissions : IProjectPermissions
		{
			/// <summary>
			/// ACL for the project
			/// </summary>
			public Acl? Acl { get; set; }

			/// <summary>
			/// Projection to extract the permissions info from the project
			/// </summary>
			public static readonly ProjectionDefinition<ProjectDocument> Projection = Builders<ProjectDocument>.Projection.Include(x => x.Acl);
		}

		readonly IMongoCollection<ProjectDocument> _projects;
		readonly IMongoCollection<ProjectLogoDocument> _projectLogos;
		readonly ConfigCollection _configCollection;
		readonly ILogger _logger;

		/// <summary>
		/// Constructor
		/// </summary>
		public ProjectCollection(MongoService mongoService, ConfigCollection configCollection, ILogger<ProjectCollection> logger)
		{
			_projects = mongoService.GetCollection<ProjectDocument>("Projects");
			_projectLogos = mongoService.GetCollection<ProjectLogoDocument>("ProjectLogos");
			_configCollection = configCollection;
			_logger = logger;
		}

		/// <inheritdoc/>
		public async Task<IProject?> AddOrUpdateAsync(ProjectId id, string configRevision, int order)
		{
			ProjectConfig config = await _configCollection.GetConfigAsync<ProjectConfig>(configRevision);

			ProjectDocument newProject = new ProjectDocument();
			newProject.Id = id;
			newProject.ConfigRevision = configRevision;
			newProject.Order = order;
			newProject.Acl = Acl.Merge(new Acl(), config.Acl);

			ProjectDocument result = await _projects.FindOneAndReplaceAsync<ProjectDocument>(x => x.Id == id, newProject, new FindOneAndReplaceOptions<ProjectDocument> { IsUpsert = true, ReturnDocument = ReturnDocument.After });
			await result.PostLoadAsync(_configCollection, _logger);
			return result;
		}

		/// <inheritdoc/>
		public async Task<List<IProject>> FindAllAsync()
		{
			List<ProjectDocument> results = await _projects.Find(x => !x.Deleted).ToListAsync();
			foreach (ProjectDocument result in results)
			{
				await result.PostLoadAsync(_configCollection, _logger);
			}
			return results.OrderBy(x => x.Order).ThenBy(x => x.Name).Select<ProjectDocument, IProject>(x => x).ToList();
		}

		/// <inheritdoc/>
		public async Task<IProject?> GetAsync(ProjectId projectId)
		{
			ProjectDocument? project = await _projects.Find<ProjectDocument>(x => x.Id == projectId).FirstOrDefaultAsync();
			if (project != null)
			{
				await project.PostLoadAsync(_configCollection, _logger);
			}
			return project;
		}

		/// <inheritdoc/>
		public async Task<IProjectLogo?> GetLogoAsync(ProjectId projectId)
		{
			return await _projectLogos.Find(x => x.Id == projectId).FirstOrDefaultAsync();
		}

		/// <inheritdoc/>
		public async Task SetLogoAsync(ProjectId projectId, string logoPath, string logoRevision, string mimeType, byte[] data)
		{
			ProjectLogoDocument logo = new ProjectLogoDocument();
			logo.Id = projectId;
			logo.Path = logoPath;
			logo.Revision = logoRevision;
			logo.MimeType = mimeType;
			logo.Data = data;
			await _projectLogos.ReplaceOneAsync(x => x.Id == projectId, logo, new ReplaceOptions { IsUpsert = true });
		}

		/// <inheritdoc/>
		public async Task<IProjectPermissions?> GetPermissionsAsync(ProjectId projectId)
		{
			return await _projects.Find<ProjectDocument>(x => x.Id == projectId).Project<ProjectPermissions>(ProjectPermissions.Projection).FirstOrDefaultAsync();
		}

		/// <inheritdoc/>
		public async Task DeleteAsync(ProjectId projectId)
		{
			await _projects.UpdateOneAsync(x => x.Id == projectId, Builders<ProjectDocument>.Update.Set(x => x.Deleted, true));
		}
	}
}