autofac / autofac.diagnostics.dotgraph Goto Github PK

What do we think our options are, either around code changes, or documentation, for indicating diagnostics on 'disconnected' operations.

For example, with Owned instances, if I resolve a fairly simple set of dependencies 'normally':

When putting an Owned instance in the middle, I get the following graphs out (in this order):

I don't think there is anything particularly specific to the DotGraph implementation here, but I do wonder if we should figure out a way to associate the two sets of data together.

Problem Statement

It's really difficult to (:-P) use ingenious! package Autofac.Diagnostics.DotGraph. Namely, it is hand-heavy.

Desired Solution

See pull request.

Some of my steps have been automated (attempts to use asynchronous, parallel multi-threaded):

0. Receive DOT output-folder
1. CleanCodeAndImageFolders() <= cleans folders
2. WriteDOTCode(args.TraceContent) <= write DOT per documentation
3. GetImageFileFullPath(args.TraceContent) <= generate image filenames per DOT sources
4. WriteDOTDiagram() <= use the DOT file to write-out the image at generated-filename.

Alternatives You've Considered

Autofac Analysis but I could not get it to function within the time I had.

Additional Context

ToDo1: Parameterize output paths, filename template
ToDo2: Remove performance test
ToDo3: Write functional test
ToDo4: Use plantUML?
ToDo5: Option to filter-out or partition Microsoft assembly-rooted diagrams?

Describe the Bug

Seems the dot diagnostic tracer is incompatible with AF8.

Steps to Reproduce

• Make a new C# project,
• Add Autofac 8.0.0
• Add Autofac.Diagnostics.DotGraph 1.0.0

using Autofac;
using Autofac.Diagnostics.DotGraph;

internal class Program {

    public class Foo {

    }

    private static void Main(string[] args) {

        var cb = new ContainerBuilder();

        cb.RegisterType<Foo>()
            .AsSelf()
            .SingleInstance();

        var scope = cb.Build();

        var tracer = new DotDiagnosticTracer();

        scope.SubscribeToDiagnostics(tracer);

        var foo = scope.Resolve<Foo>();   // <--- exception here

        Console.WriteLine("Hello, World!");
    }
}

Expected Behavior

No exceptions 😉

Exception with Stack Trace

Autofac.Core.DependencyResolutionException
  HResult=0x80131500
  Message=An exception was thrown while executing a resolve operation. See the InnerException for details.
  Source=Autofac
  StackTrace:
   at Autofac.Core.Resolving.ResolveOperation.ExecuteOperation(ResolveRequest& request)
   at Autofac.Core.Resolving.ResolveOperation.Execute(ResolveRequest& request)
   at Autofac.Core.Lifetime.LifetimeScope.ResolveComponent(ResolveRequest& request)
   at Autofac.Core.Container.ResolveComponent(ResolveRequest& request)
   at Autofac.Core.Container.Autofac.IComponentContext.ResolveComponent(ResolveRequest& request)
   at Autofac.ResolutionExtensions.TryResolveService(IComponentContext context, Service service, IEnumerable`1 parameters, Object& instance)
   at Autofac.ResolutionExtensions.ResolveService(IComponentContext context, Service service, IEnumerable`1 parameters)
   at Autofac.ResolutionExtensions.Resolve(IComponentContext context, Type serviceType, IEnumerable`1 parameters)
   at Autofac.ResolutionExtensions.Resolve[TService](IComponentContext context, IEnumerable`1 parameters)
   at Autofac.ResolutionExtensions.Resolve[TService](IComponentContext context)
   at Program.Main(String[] args) in ....\Program.cs:line 24

  This exception was originally thrown at this call stack:
    Autofac.Diagnostics.DiagnosticTracerBase.Write(string, object)
    Autofac.Diagnostics.DiagnosticTracerBase.System.IObserver<System.Collections.Generic.KeyValuePair<string, object>>.OnNext(System.Collections.Generic.KeyValuePair<string, object>)
    System.Diagnostics.DiagnosticListener.Write(string, object)
    Autofac.Diagnostics.DiagnosticSourceExtensions.OperationStart(System.Diagnostics.DiagnosticListener, Autofac.Core.Resolving.IResolveOperation, Autofac.ResolveRequest)
    Autofac.Core.Resolving.ResolveOperation.ExecuteOperation(Autofac.ResolveRequest)

Inner Exception 1:
MissingMethodException: Method not found: 'Autofac.ResolveRequest Autofac.Core.Resolving.IResolveOperation.get_InitiatingRequest()'.

Dependency Versions

Autofac: 8.0.0
Autofac.Diagnostics.DotGraph: 1.0.0

Additional Info

Things worked fine using AF 7.1. Also the dot diagnostics package does not have an upper version limit on its AF dependency, so did not expect things to blow with AF8.

Do you think it's worth prettifying generic type names in the graph? For example, when I resolve an IEnumerable of a Service I get:

It might be nice to be able to give formatted generic names; people use generic services a lot.

In core Autofac, we just added a new constructor parameter to the OperationComplete event args.

Need to update this package with the same before we release it.

Tracking issue for the release of this package when Autofac v6 is released.