Skip to content
This repository was archived by the owner on Jan 12, 2024. It is now read-only.

Register new display encoders when loading packages. #179

Merged
cgranade merged 6 commits into from
Jun 25, 2020
Merged

Register new display encoders when loading packages. #179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d0fde28
Register new display encoders when loading packages.
cgranade Jun 24, 2020
09d21a6
Addressing feedback.
cgranade Jun 24, 2020
49214e8
Merge branch 'master' into cgranade/fallback-encoder
Jun 25, 2020
fc176a9
Merge remote-tracking branch 'origin/master' into cgranade/fallback-e…
cgranade Jun 25, 2020
f6d993e
Allowlist Azure Client display encoders.
cgranade Jun 25, 2020
c689748
Fix bug in compiler by updating to include fix.
cgranade Jun 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion build/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ trigger:

variables:
Build.Major: 0
Build.Minor: 11
Build.Minor: 12
Drops.Dir: $(Build.ArtifactStagingDirectory)/drops
IQSharp.Hosting.Env: 'build-agent-iqsharp'

Expand Down
6 changes: 3 additions & 3 deletions src/Core/Core.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@
<PackageReference Include="Microsoft.CSharp" Version="4.5.0" />
<PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="3.0.0" />
<PackageReference Include="Microsoft.Extensions.Logging" Version="3.0.0" />
<PackageReference Include="Microsoft.Quantum.Compiler" Version="0.11.2006.1615-beta" />
<PackageReference Include="Microsoft.Quantum.CsharpGeneration" Version="0.11.2006.1615-beta" />
<PackageReference Include="Microsoft.Quantum.Simulators" Version="0.11.2006.1615-beta" />
<PackageReference Include="Microsoft.Quantum.Compiler" Version="0.12.20062505-beta" />
<PackageReference Include="Microsoft.Quantum.CsharpGeneration" Version="0.12.20062505-beta" />
<PackageReference Include="Microsoft.Quantum.Simulators" Version="0.12.20062505-beta" />
<PackageReference Include="NuGet.Resolver" Version="5.1.0" />
<PackageReference Include="System.Runtime.Loader" Version="4.3.0" />
</ItemGroup>
Expand Down
70 changes: 69 additions & 1 deletion src/Kernel/IQSharpEngine.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
using Microsoft.Jupyter.Core.Protocol;
using Newtonsoft.Json;
using System.Threading.Tasks;
using System.Collections.Immutable;
using Microsoft.Quantum.IQSharp.AzureClient;

namespace Microsoft.Quantum.IQSharp.Kernel
{
Expand All @@ -41,7 +43,8 @@ public IQSharpEngine(
PerformanceMonitor performanceMonitor,
IShellRouter shellRouter,
IEventService eventService,
IMagicSymbolResolver magicSymbolResolver
IMagicSymbolResolver magicSymbolResolver,
IReferences references
) : base(shell, shellRouter, context, logger, services)
{
this.performanceMonitor = performanceMonitor;
Expand Down Expand Up @@ -69,6 +72,8 @@ IMagicSymbolResolver magicSymbolResolver
RegisterSymbolResolver(this.SymbolsResolver);
RegisterSymbolResolver(this.MagicResolver);

RegisterPackageLoadedEvent(services, logger, references);

// Handle new shell messages.
shellRouter.RegisterHandlers<IQSharpEngine>();

Expand All @@ -79,9 +84,72 @@ IMagicSymbolResolver magicSymbolResolver
Process.GetCurrentProcess().Id
);


eventService?.TriggerServiceInitialized<IExecutionEngine>(this);
}

/// <summary>
/// Registers an event handler that searches newly loaded packages
/// for extensions to this engine (in particular, for result encoders).
/// </summary>
private void RegisterPackageLoadedEvent(IServiceProvider services, ILogger logger, IReferences references)
{
var knownAssemblies = references
.Assemblies
.Select(asm => asm.Assembly.GetName())
.ToImmutableHashSet()
// Except assemblies known at compile-time as well.
.Add(typeof(StateVectorToHtmlResultEncoder).Assembly.GetName())
.Add(typeof(AzureClientErrorToHtmlEncoder).Assembly.GetName());
foreach (var knownAssembly in knownAssemblies) System.Console.WriteLine($"{knownAssembly.FullName}");

// Register new display encoders when packages load.
references.PackageLoaded += (sender, args) =>
{
logger.LogDebug("Scanning for display encoders after loading {Package}.", args.PackageId);
foreach (var assembly in references.Assemblies
.Select(asm => asm.Assembly)
.Where(asm => !knownAssemblies.Contains(asm.GetName()))
)
{
// Look for display encoders in the new assembly.
logger.LogDebug("Found new assembly {Name}, looking for display encoders.", assembly.FullName);
var relevantTypes = assembly
.GetTypes()
.Where(type =>
!type.IsAbstract &&
!type.IsInterface &&
typeof(IResultEncoder).IsAssignableFrom(type)
);

foreach (var type in relevantTypes)
{
logger.LogDebug(
"Found display encoder {TypeName} in {AssemblyName}; registering.",
type.FullName,
assembly.FullName
);

// Try and instantiate the new result encoder, but if it fails, that is likely
// a non-critical failure that should result in a warning.
try
{
RegisterDisplayEncoder(ActivatorUtilities.CreateInstance(services, type) as IResultEncoder);
}
catch (Exception ex)
{
logger.LogWarning(
ex,
"Encountered exception loading result encoder {TypeName} from {AssemblyName}.",
type.FullName, assembly.FullName
);
}
}
knownAssemblies = knownAssemblies.Add(assembly.GetName());
}
};
}

internal ISnippets Snippets { get; }

internal ISymbolResolver SymbolsResolver { get; }
Expand Down
31 changes: 16 additions & 15 deletions src/Tool/appsettings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,26 @@
},
"AllowedHosts": "*",
"DefaultPackageVersions": [
"Microsoft.Quantum.Compiler::0.11.2006.1615-beta",
"Microsoft.Quantum.Compiler::0.12.20062505-beta",

"Microsoft.Quantum.CsharpGeneration::0.11.2006.1615-beta",
"Microsoft.Quantum.Development.Kit::0.11.2006.1615-beta",
"Microsoft.Quantum.Simulators::0.11.2006.1615-beta",
"Microsoft.Quantum.Xunit::0.11.2006.1615-beta",
"Microsoft.Quantum.CsharpGeneration::0.12.20062505-beta",
"Microsoft.Quantum.Development.Kit::0.12.20062505-beta",
"Microsoft.Quantum.Simulators::0.12.20062505-beta",
"Microsoft.Quantum.Xunit::0.12.20062505-beta",

"Microsoft.Quantum.Standard::0.11.2006.1615-beta",
"Microsoft.Quantum.Chemistry::0.11.2006.1615-beta",
"Microsoft.Quantum.Chemistry.Jupyter::0.11.2006.1615-beta",
"Microsoft.Quantum.MachineLearning::0.11.2006.1615-beta",
"Microsoft.Quantum.Numerics::0.11.2006.1615-beta",
"Microsoft.Quantum.Standard::0.12.20062505-beta",
"Microsoft.Quantum.Chemistry::0.12.20062505-beta",
"Microsoft.Quantum.Chemistry.Jupyter::0.12.20062505-beta",
"Microsoft.Quantum.MachineLearning::0.12.20062505-beta",
"Microsoft.Quantum.Numerics::0.12.20062505-beta",

"Microsoft.Quantum.Katas::0.11.2006.1615-beta",
"Microsoft.Quantum.Katas::0.12.20062505-beta",

"Microsoft.Quantum.Research::0.11.2006.1615-beta",
"Microsoft.Quantum.Research::0.12.20062505-beta",


"Microsoft.Quantum.Providers.IonQ::0.11.2006.1615-beta",
"Microsoft.Quantum.Providers.Honeywell::0.11.2006.1615-beta",
"Microsoft.Quantum.Providers.QCI::0.11.2006.1615-beta",
"Microsoft.Quantum.Providers.IonQ::0.12.20062505-beta",
"Microsoft.Quantum.Providers.Honeywell::0.12.20062505-beta",
"Microsoft.Quantum.Providers.QCI::0.12.20062505-beta"
]
}