Add simple display encoders for CloudJob, TargetStatus, and Histogram

build/test.ps1

@@ -41,7 +41,7 @@ function Test-Python {
     Write-Host "##[info]Testing Python inside $testFolder"    
     Push-Location (Join-Path $PSScriptRoot $testFolder)
         python --version
-        pytest --log-level=DEBUG
+        pytest -v --log-level=DEBUG
     Pop-Location
 
     if ($LastExitCode -ne 0) {

src/AzureClient/AzureClient.cs

@@ -7,20 +7,18 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using System.Net;
 using System.Threading.Tasks;
 using Microsoft.Azure.Quantum;
 using Microsoft.Azure.Quantum.Client;
 using Microsoft.Azure.Quantum.Client.Models;
-using Microsoft.Azure.Quantum.Storage;
 using Microsoft.Extensions.Logging;
 using Microsoft.Identity.Client;
 using Microsoft.Identity.Client.Extensions.Msal;
 using Microsoft.Jupyter.Core;
 using Microsoft.Quantum.IQSharp.Common;
 using Microsoft.Quantum.Simulation.Common;
 using Microsoft.Rest.Azure;
-using Newtonsoft.Json;
-using Newtonsoft.Json.Linq;
 
 namespace Microsoft.Quantum.IQSharp.AzureClient
 {
@@ -47,6 +45,7 @@ private string ValidExecutionTargetsDisplayText
         }
 
         public AzureClient(
+            IExecutionEngine engine,
             IReferences references,
             IEntryPointGenerator entryPointGenerator,
             ILogger<AzureClient> logger,
@@ -56,6 +55,16 @@ public AzureClient(
             EntryPointGenerator = entryPointGenerator;
             Logger = logger;
             eventService?.TriggerServiceInitialized<IAzureClient>(this);
+
+            if (engine is BaseEngine baseEngine)
+            {
+                baseEngine.RegisterDisplayEncoder(new CloudJobToHtmlEncoder());
+                baseEngine.RegisterDisplayEncoder(new CloudJobToTextEncoder());
+                baseEngine.RegisterDisplayEncoder(new TargetStatusToHtmlEncoder());
+                baseEngine.RegisterDisplayEncoder(new TargetStatusToTextEncoder());
+                baseEngine.RegisterDisplayEncoder(new HistogramToHtmlEncoder());
+                baseEngine.RegisterDisplayEncoder(new HistogramToTextEncoder());
+            }
         }
 
         /// <inheritdoc/>
@@ -148,8 +157,7 @@ public async Task<ExecutionResult> ConnectAsync(IChannel channel,
 
             channel.Stdout($"Connected to Azure Quantum workspace {QuantumClient.WorkspaceName}.");
 
-            // TODO: Add encoder for IEnumerable<TargetStatus> rather than calling ToJupyterTable() here directly.
-            return ValidExecutionTargets.ToJupyterTable().ToExecutionResult();
+            return ValidExecutionTargets.ToExecutionResult();
         }
 
         /// <inheritdoc/>
@@ -162,8 +170,7 @@ public async Task<ExecutionResult> GetConnectionStatusAsync(IChannel channel)
 
             channel.Stdout($"Connected to Azure Quantum workspace {QuantumClient.WorkspaceName}.");
 
-            // TODO: Add encoder for IEnumerable<TargetStatus> rather than calling ToJupyterTable() here directly.
-            return ValidExecutionTargets.ToJupyterTable().ToExecutionResult();
+            return ValidExecutionTargets.ToExecutionResult();
         }
 
         private async Task<ExecutionResult> SubmitOrExecuteJobAsync(IChannel channel, string operationName, Dictionary<string, string> inputParameters, bool execute)
@@ -187,20 +194,20 @@ private async Task<ExecutionResult> SubmitOrExecuteJobAsync(IChannel channel, st
                 return AzureClientError.NoOperationName.ToExecutionResult();
             }
 
-            var machine = QuantumMachineFactory.CreateMachine(ActiveWorkspace, ActiveTarget.TargetName, ConnectionString);
+            var machine = QuantumMachineFactory.CreateMachine(ActiveWorkspace, ActiveTarget.TargetId, ConnectionString);
             if (machine == null)
             {
                 // We should never get here, since ActiveTarget should have already been validated at the time it was set.
-                channel.Stderr($"Unexpected error while preparing job for execution on target {ActiveTarget.TargetName}.");
+                channel.Stderr($"Unexpected error while preparing job for execution on target {ActiveTarget.TargetId}.");
                 return AzureClientError.InvalidTarget.ToExecutionResult();
             }
 
-            channel.Stdout($"Submitting {operationName} to target {ActiveTarget.TargetName}...");
+            channel.Stdout($"Submitting {operationName} to target {ActiveTarget.TargetId}...");
 
             IEntryPoint? entryPoint = null;
             try
             {
-                entryPoint = EntryPointGenerator.Generate(operationName, ActiveTarget.TargetName);
+                entryPoint = EntryPointGenerator.Generate(operationName, ActiveTarget.TargetId);
             }
             catch (UnsupportedOperationException e)
             {
@@ -279,38 +286,38 @@ public async Task<ExecutionResult> GetActiveTargetAsync(IChannel channel)
 
             if (ActiveTarget == null)
             {
-                channel.Stderr("No execution target has been specified. To specify one, run:\n%azure.target <target name>");
+                channel.Stderr("No execution target has been specified. To specify one, run:\n%azure.target <target ID>");
                 channel.Stdout($"Available execution targets: {ValidExecutionTargetsDisplayText}");
                 return AzureClientError.NoTarget.ToExecutionResult();
             }
 
-            channel.Stdout($"Current execution target: {ActiveTarget.TargetName}");
+            channel.Stdout($"Current execution target: {ActiveTarget.TargetId}");
             channel.Stdout($"Available execution targets: {ValidExecutionTargetsDisplayText}");
-            return ActiveTarget.TargetName.ToExecutionResult();
+            return ActiveTarget.TargetId.ToExecutionResult();
         }
 
         /// <inheritdoc/>
-        public async Task<ExecutionResult> SetActiveTargetAsync(IChannel channel, string targetName)
+        public async Task<ExecutionResult> SetActiveTargetAsync(IChannel channel, string targetId)
         {
             if (AvailableProviders == null)
             {
                 channel.Stderr("Please call %azure.connect before setting an execution target.");
                 return AzureClientError.NotConnected.ToExecutionResult();
             }
 
-            // Validate that this target name is valid in the workspace.
-            if (!AvailableTargets.Any(target => targetName == target.Id))
+            // Validate that this target is valid in the workspace.
+            if (!AvailableTargets.Any(target => targetId == target.Id))
             {
-                channel.Stderr($"Target name {targetName} is not available in the current Azure Quantum workspace.");
+                channel.Stderr($"Target {targetId} is not available in the current Azure Quantum workspace.");
                 channel.Stdout($"Available execution targets: {ValidExecutionTargetsDisplayText}");
                 return AzureClientError.InvalidTarget.ToExecutionResult();
             }
 
-            // Validate that we know which package to load for this target name.
-            var executionTarget = AzureExecutionTarget.Create(targetName);
+            // Validate that we know which package to load for this target.
+            var executionTarget = AzureExecutionTarget.Create(targetId);
             if (executionTarget == null)
             {
-                channel.Stderr($"Target name {targetName} does not support executing Q# jobs.");
+                channel.Stderr($"Target {targetId} does not support executing Q# jobs.");
                 channel.Stdout($"Available execution targets: {ValidExecutionTargetsDisplayText}");
                 return AzureClientError.InvalidTarget.ToExecutionResult();
             }
@@ -321,7 +328,7 @@ public async Task<ExecutionResult> SetActiveTargetAsync(IChannel channel, string
             channel.Stdout($"Loading package {ActiveTarget.PackageName} and dependencies...");
             await References.AddPackage(ActiveTarget.PackageName);
 
-            return $"Active target is now {ActiveTarget.TargetName}".ToExecutionResult();
+            return $"Active target is now {ActiveTarget.TargetId}".ToExecutionResult();
         }
 
         /// <inheritdoc/>
@@ -357,19 +364,18 @@ public async Task<ExecutionResult> GetJobResultAsync(IChannel channel, string jo
                 return AzureClientError.JobNotCompleted.ToExecutionResult();
             }
 
-            var stream = new MemoryStream();
-            await new JobStorageHelper(ConnectionString).DownloadJobOutputAsync(jobId, stream);
-            stream.Seek(0, SeekOrigin.Begin);
-            var output = new StreamReader(stream).ReadToEnd();
-            var deserializedOutput = JsonConvert.DeserializeObject<Dictionary<string, JToken>>(output);
-            var histogram = new Dictionary<string, double>();
-            foreach (var entry in deserializedOutput["histogram"] as JObject)
+            try
             {
-                histogram[entry.Key] = entry.Value.ToObject<double>();
+                var request = WebRequest.Create(job.Details.OutputDataUri);
+                using var responseStream = request.GetResponse().GetResponseStream();
+                return responseStream.ToHistogram().ToExecutionResult();
+            }
+            catch (Exception e)
+            {
+                channel.Stderr($"Failed to retrieve results for job ID {jobId}.");
+                Logger?.LogError(e, $"Failed to download the job output for the specified Azure Quantum job: {e.Message}");
+                return AzureClientError.JobOutputDownloadFailed.ToExecutionResult();
             }
-
-            // TODO: Add encoder to visualize IEnumerable<KeyValuePair<string, double>>
-            return histogram.ToExecutionResult();
         }
 
         /// <inheritdoc/>
@@ -399,8 +405,7 @@ public async Task<ExecutionResult> GetJobStatusAsync(IChannel channel, string jo
                 return AzureClientError.JobNotFound.ToExecutionResult();
             }
 
-            // TODO: Add encoder for CloudJob rather than calling ToJupyterTable() here directly.
-            return job.ToJupyterTable().ToExecutionResult();
+            return job.ToExecutionResult();
         }
 
         /// <inheritdoc/>
@@ -419,8 +424,7 @@ public async Task<ExecutionResult> GetJobListAsync(IChannel channel)
                 return AzureClientError.JobNotFound.ToExecutionResult();
             }
 
-            // TODO: Add encoder for IEnumerable<CloudJob> rather than calling ToJupyterTable() here directly.
-            return jobs.ToJupyterTable().ToExecutionResult();
+            return jobs.ToExecutionResult();
         }
 
         private async Task<CloudJob?> GetCloudJob(string jobId)

src/AzureClient/AzureExecutionTarget.cs

@@ -11,28 +11,28 @@ internal enum AzureProvider { IonQ, Honeywell, QCI }
 
     internal class AzureExecutionTarget
     {
-        public string TargetName { get; private set; }
-        public string PackageName => $"Microsoft.Quantum.Providers.{GetProvider(TargetName)}";
+        public string TargetId { get; private set; }
+        public string PackageName => $"Microsoft.Quantum.Providers.{GetProvider(TargetId)}";
 
-        public static bool IsValid(string targetName) => GetProvider(targetName) != null;
+        public static bool IsValid(string targetId) => GetProvider(targetId) != null;
 
-        public static AzureExecutionTarget? Create(string targetName) =>
-            IsValid(targetName)
-            ? new AzureExecutionTarget() { TargetName = targetName }
+        public static AzureExecutionTarget? Create(string targetId) =>
+            IsValid(targetId)
+            ? new AzureExecutionTarget() { TargetId = targetId }
             : null;
 
         /// <summary>
         ///     Gets the Azure Quantum provider corresponding to the given execution target.
         /// </summary>
-        /// <param name="targetName">The Azure Quantum execution target name.</param>
+        /// <param name="targetId">The Azure Quantum execution target ID.</param>
         /// <returns>The <see cref="AzureProvider"/> enum value representing the provider.</returns>
         /// <remarks>
-        ///     Valid target names are structured as "provider.target".
+        ///     Valid target IDs are structured as "provider.target".
         ///     For example, "ionq.simulator" or "honeywell.qpu".
         /// </remarks>
-        private static AzureProvider? GetProvider(string targetName)
+        private static AzureProvider? GetProvider(string targetId)
         {
-            var parts = targetName.Split('.', 2);
+            var parts = targetId.Split('.', 2);
             if (Enum.TryParse(parts[0], true, out AzureProvider provider))
             {
                 return provider;

src/AzureClient/Extensions.cs

@@ -4,16 +4,12 @@
 #nullable enable
 
 using System;
+using System.Collections;
 using System.Collections.Generic;
 using System.ComponentModel;
-using System.Linq;
 using System.Threading.Tasks;
-using Microsoft.Azure.Quantum;
-using Microsoft.Azure.Quantum.Client;
-using Microsoft.Azure.Quantum.Client.Models;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Jupyter.Core;
-using Microsoft.Quantum.Runtime;
 
 namespace Microsoft.Quantum.IQSharp.AzureClient
 {
@@ -37,7 +33,7 @@ public static void AddAzureClient(this IServiceCollection services)
         /// <param name="azureClientError">
         ///      The result of an IAzureClient API call.
         /// </param>
-        public static ExecutionResult ToExecutionResult(this AzureClientError azureClientError) =>
+        internal static ExecutionResult ToExecutionResult(this AzureClientError azureClientError) =>
             new ExecutionResult
             {
                 Status = ExecuteStatus.Error,
@@ -50,7 +46,7 @@ public static ExecutionResult ToExecutionResult(this AzureClientError azureClien
         /// </summary>
         /// <param name="azureClientError"></param>
         /// <returns></returns>
-        public static string ToDescription(this AzureClientError azureClientError)
+        internal static string ToDescription(this AzureClientError azureClientError)
         {
             var attributes = azureClientError
                 .GetType()
@@ -65,60 +61,21 @@ public static string ToDescription(this AzureClientError azureClientError)
         /// <param name="task">
         ///      A task which will return the result of an IAzureClient API call.
         /// </param>
-        public static async Task<ExecutionResult> ToExecutionResult(this Task<AzureClientError> task) =>
+        internal static async Task<ExecutionResult> ToExecutionResult(this Task<AzureClientError> task) =>
             (await task).ToExecutionResult();
 
-        internal static Table<CloudJob> ToJupyterTable(this CloudJob cloudJob) =>
-            new List<CloudJob> { cloudJob }.ToJupyterTable();
-
-        internal static Table<CloudJob> ToJupyterTable(this IEnumerable<CloudJob> jobsList) =>
-            new Table<CloudJob>
-            {
-                Columns = new List<(string, Func<CloudJob, string>)>
-                    {
-                        ("JobId", cloudJob => cloudJob.Id),
-                        ("JobName", cloudJob => cloudJob.Details.Name),
-                        ("JobStatus", cloudJob => cloudJob.Status),
-                        ("Provider", cloudJob => cloudJob.Details.ProviderId),
-                        ("Target", cloudJob => cloudJob.Details.Target),
-                    },
-                Rows = jobsList.ToList()
-            };
-
-        internal static Table<IQuantumMachineJob> ToJupyterTable(this IQuantumMachineJob job) =>
-            new Table<IQuantumMachineJob>
-            {
-                Columns = new List<(string, Func<IQuantumMachineJob, string>)>
-                    {
-                        ("JobId", job => job.Id),
-                        ("JobStatus", job => job.Status),
-                    },
-                Rows = new List<IQuantumMachineJob>() { job }
-            };
-
-        internal static Table<IQuantumClient> ToJupyterTable(this IQuantumClient quantumClient) =>
-            new Table<IQuantumClient>
-            {
-                Columns = new List<(string, Func<IQuantumClient, string>)>
-                    {
-                        ("SubscriptionId", quantumClient => quantumClient.SubscriptionId),
-                        ("ResourceGroupName", quantumClient => quantumClient.ResourceGroupName),
-                        ("WorkspaceName", quantumClient => quantumClient.WorkspaceName),
-                    },
-                Rows = new List<IQuantumClient>() { quantumClient }
-            };
-
-        internal static Table<TargetStatus> ToJupyterTable(this IEnumerable<TargetStatus> targets) =>
-            new Table<TargetStatus>
-            {
-                Columns = new List<(string, Func<TargetStatus, string>)>
-                    {
-                        ("TargetId", target => target.Id),
-                        ("CurrentAvailability", target => target.CurrentAvailability),
-                        ("AverageQueueTime", target => target.AverageQueueTime.ToString()),
-                        ("StatusPage", target => target.StatusPage),
-                    },
-                Rows = targets.ToList()
-            };
+        /// <summary>
+        ///     Returns the provided argument as an enumeration of the specified type.
+        /// </summary>
+        /// <returns>
+        ///     If the argument is already an <see cref="IEnumerable{T}"/> of the specified type,
+        ///     the argument is returned. If the argument is of type <c>T</c>, then an 
+        ///     enumeration is returned with this argument as the only element.
+        ///     Otherwise, null is returned.
+        /// </returns>
+        internal static IEnumerable<T>? AsEnumerableOf<T>(this object? source) =>
+            source is T singleton ? new List<T> { singleton } :
+            source is IEnumerable<T> collection ? collection :
+            null;
     }
 }

src/AzureClient/IAzureClient.cs

@@ -51,6 +51,12 @@ public enum AzureClientError
         [Description(Resources.AzureClientErrorJobNotCompleted)]
         JobNotCompleted,
 
+        /// <summary>
+        /// The job output failed to be downloaded from the Azure storage location.
+        /// </summary>
+        [Description(Resources.AzureClientErrorJobOutputDownloadFailed)]
+        JobOutputDownloadFailed,
+
         /// <summary>
         /// No Q# operation name was provided where one was required.
         /// </summary>
@@ -139,13 +145,13 @@ public Task<ExecutionResult> ConnectAsync(IChannel channel,
         /// <returns>
         /// Success if the target is valid, or an error if the target cannot be set.
         /// </returns>
-        public Task<ExecutionResult> SetActiveTargetAsync(IChannel channel, string targetName);
+        public Task<ExecutionResult> SetActiveTargetAsync(IChannel channel, string targetId);
 
         /// <summary>
         /// Gets the currently specified target for job submission.
         /// </summary>
         /// <returns>
-        /// The target name.
+        /// The target ID.
         /// </returns>
         public Task<ExecutionResult> GetActiveTargetAsync(IChannel channel);