UnrealEngineUWP/Engine/Source/Programs/Horde/HordeServer/Models/Device.cs

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

using System;
using MongoDB.Bson;
using MongoDB.Bson.Serialization.Attributes;

using System.Collections.Generic;
using HordeServer.Utilities;

namespace HordeServer.Models
{
	using DeviceId = StringId<IDevice>;
	using DevicePlatformId = StringId<IDevicePlatform>;
	using DevicePoolId = StringId<IDevicePool>;

	/// <summary>
	/// A reservation containing one or more devices
	/// </summary>
	public interface IDeviceReservation
	{
		/// <summary>
		/// Randomly generated unique id for this reservation
		/// </summary>
		public ObjectId Id { get; }

		/// <summary>
		/// Which device pool the reservation is in
		/// </summary>
		public DevicePoolId PoolId { get; }

		/// <summary>
		/// JobID holding reservation
		/// </summary>
		public string? JobId { get; }

		/// <summary>
		/// Job step id holding reservation
		/// </summary>
		public string? StepId { get; }

		/// <summary>
		/// Reservations held by a user, requires a token
		/// </summary>
		public ObjectId? UserId { get; }

		/// <summary>
		/// The hostname of machine holding reservation
		/// </summary>
		string? Hostname { get; }

		/// <summary>
		/// The hostname of machine holding reservation
		/// </summary>
		string? ReservationDetails { get; }

		/// <summary>
		/// The UTC time when the reservation was created
		/// </summary>
		DateTime CreateTimeUtc { get; }

		/// <summary>
		/// The last update time for reservation renewal (for expiration)
		/// </summary>
		DateTime UpdateTimeUtc { get; }

		/// <summary>
		/// The reserved devices
		/// </summary>
		public List<DeviceId> Devices { get; }

		/// <summary>
		/// The legacy reservation system guid, to be removed once can update Gauntlet client in all streams
		/// </summary>
		public string LegacyGuid { get; }
	}


	/// <summary>
	/// A device platform 
	/// </summary>
	public interface IDevicePlatform
	{
		/// <summary>
		/// Unique identifier of device platform 
		/// </summary>
		public DevicePlatformId Id { get; }
		
		/// <summary>
		/// Device platform name, for example Android, PS5, etc
		/// </summary>
		string Name { get; }

		/// <summary>
		/// A list of valid models for the platform
		/// </summary>
		public IReadOnlyList<string>? Models { get; }

	}

    /// <summary>
    /// The type of device pool
    /// </summary>
    public enum DevicePoolType
    {
        /// <summary>
        /// Available to CIS jobs
        /// </summary>
        Automation,

        /// <summary>
        /// Shared by users with remote checking and checkouts
        /// </summary>
        Shared

    }

    /// <summary>
    /// A logical pool of devices
    /// </summary>
    public interface IDevicePool
	{
		/// <summary>
		/// Unique identifier of pool
		/// </summary>
		public DevicePoolId Id { get; }

		/// <summary>
		/// The type of pool 
		/// </summary>
		public DevicePoolType PoolType { get; }

        /// <summary>
        /// Friendly name of the pool
        /// </summary>
        string Name { get; }

		/// <summary>
		/// Acl access to the pool
		/// </summary>
		public Acl? Acl { get; }
	}

	/// <summary>
	/// A device utilization snapshot
	/// </summary>
	public class DeviceUtilizationTelemetry
	{
		/// <summary>
		/// The job id which utilized device
		/// </summary>
		public string? JobId { get; set;}

		/// <summary>
		/// The job's step id
		/// </summary>
		public string? StepId { get; set;}

		/// <summary>
		/// The time device was reserved
		/// </summary>
		public DateTime ReservationStartUtc { get; set;}

		/// <summary>
		/// The time device was freed
		/// </summary>
		public DateTime? ReservationFinishUtc { get; set;}

		/// <summary>
		/// Private constructor
		/// </summary>
		[BsonConstructor]
		private DeviceUtilizationTelemetry()
		{
		}

		/// <summary>
		/// Constructor
		/// </summary>
		/// <param name="ReservationStartUtc"></param>
		public DeviceUtilizationTelemetry( DateTime ReservationStartUtc )
		{
			this.ReservationStartUtc = ReservationStartUtc;
		}

	}


	/// <summary>
	/// A physical device
	/// </summary>
	public interface IDevice
	{
		/// <summary>
		/// The unique id of the device
		/// </summary>
		public DeviceId Id { get; }

		/// <summary>
		/// The platform of the device
		/// </summary>
		public DevicePlatformId PlatformId { get; }

		/// <summary>
		/// Which pool the device belongs to
		/// </summary>
		public DevicePoolId PoolId { get; }

		/// <summary>
		/// Friendly name of the device
		/// </summary>
		public string Name { get; }

		/// <summary>
		/// The model of the device
		/// </summary>
		public string? ModelId { get; }


		/// <summary>
		/// Address if the device supports shared network connections
		/// </summary>
		public string? Address { get; }

		/// <summary>
		/// Whether the device is currently enabled
		/// </summary>
		public bool Enabled { get; }

		/// <summary>
		/// Id of the user that last modified this device
		/// </summary>
		public string? ModifiedByUser { get; }

		/// <summary>
		/// Id of the user that has this device checked out
		/// </summary>
		public string? CheckedOutByUser { get; }

		/// <summary>
		/// The last time this device was checked out
		/// </summary>
		public DateTime? CheckOutTime { get; }


		/// <summary>
		/// The last time a problem was reported
		/// </summary>
		public DateTime? ProblemTimeUtc { get; }

		/// <summary>
		/// The time device was marked for maintenance
		/// </summary>
		public DateTime? MaintenanceTimeUtc { get; }

		/// <summary>
		/// Markdown notes for device if any 
		/// </summary>
		public string? Notes { get; }

		/// <summary>
		/// Device job utilization history 
		/// </summary>
		public List<DeviceUtilizationTelemetry>? Utilization { get; set; }

		/// <summary>
		/// ACL for modifying this device
		/// </summary>
		public Acl? Acl { get; }
	}
}