Improve the dependency path exception message

[andriy-dmytruk]

This improves the readability of message for long paths, large class names or classes with many parameters, as each class from the path is immediately visible. I changed the tests to use longer class names, which is more realistic.

The type names are also in fully-qualified shortened form, which makes them clickable in IDEs.

As a comparison this message

Message: No bean of type [io.micronaut.inject.failures.NestedDependencyFailureSpec$MyClassD] exists. 
| Path Taken: new MyClassB() --> MyClassB.propA --> new MyClassA([MyClassC propC]) --> new MyClassC([MyClassD propD])

will change to

Message: No bean of type [io.micronaut.inject.failures.NestedDependencyFailureSpec$MyClassD] exists.
Path Taken:
new i.m.i.f.N$MyClassB()
\---> i.m.i.f.N$MyClassB#propA
      \---> new i.m.i.f.N$MyClassA([MyClassC propC])
            \---> new i.m.i.f.N$MyClassC([MyClassD propD])

Part of the change is similar to visualization change for circular dependencies: #11299.

[sdelamo]

maybe this should target 4.8.x

[dstepanov]

Consider adding a full class name. I think IntelliJ will provide a link to the class

[dstepanov]

How does it look with a factory method / field?

[andriy-dmytruk]

There is an example of field here

[andriy-dmytruk]

How does it look with a factory method / field?

For factory there is a circular dependency test:

micronaut-core/inject-groovy/src/test/groovy/io/micronaut/inject/failures/FactoryCircularDependencyFailureSpec.groovy

Lines 41 to 48 in da67f65

	Message: Circular dependency detected
	Path Taken:
	new ElectricalGrid(List<ElectricStation E> stations)
	\\---> new ElectricalGrid([List<ElectricStation E> stations])
	^ \\---> ElectricStationFactory.nuclearStation([MeasuringEquipment equipment])
	| \\---> MeasuringEquipment.grid
	| |
	+--------------+'''

[graemerocher]

Consider adding a full class name. I think IntelliJ will provide a link to the class

this is a good point, with the new lines maybe we can include qualified names. Can you check this link works in IntelliJ?

[andriy-dmytruk]

Yes, the classnames are clickable:

This is more readable, though:

I think both are good. Wdyt?

[graemerocher]

@dstepanov WDYT?

[dstepanov]

Intellij supports even shortened names, so we can reduce it if it's too large:

try:

    public static void main(String[] args) {
        System.out.println("io.m.r.Micronaut!");
    }

[graemerocher]

@andriy-dmytruk can you try that?

[andriy-dmytruk]

Yes, this is actually amazing! Now there are actually 2 options:

1. Shorten type owner names:
   
   When clicked:
   

2. Do not shorten:
   

I would say the first one is the overall best.

[dstepanov]

Maybe we can have something like 200-300 characters per name and start reducing when it's more.

[graemerocher]

the first one is the best yes

[andriy-dmytruk]

I went for using the first form always, as it is shortest, but is still clickable. We can also extend it at a later point if we experience issues with it.

Maybe we can have something like 200-300 characters per name and start reducing when it's more.

We can start a GitHub discussion, but I think shortest should be good in most cases. The chances of conflict are pretty low. If we do need this, the typical line limits are 80, 100, 120, which would mean around 60 chars limit for the name alone.

[graemerocher]

just two small tweaks before merging.

[graemerocher]

check type name doesn't == null

[andriy-dmytruk]

That is not checked in other methods, so I assume it is not typical for typeName to be null. Added @NonNull though.

[andriy-dmytruk]

@yawkat I don't understand the issue. Can you take a look?

https://ge.micronaut.io/s/szoo56vrxva66

[yawkat]

that test is just flakey. i dont know why

[sonarcloud]

Quality Gate passed

Issues
0 New issues
2 Accepted issues

Measures
0 Security Hotspots
93.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud