Improve context resolve failure info

[davidlatwe]

Continue from #971, and based on the suggestion in this comment, here is another take that work no top of context resolve graph.

Say we have these packages and try requesting "pipeline", "maya", "houdini-18":

# test_conflict_pipeline
repo = Repo()
repo.add("pipeline", version="1", requires=["maya-2018+<=2020"])
repo.add("maya", version="2020", requires=["pymel"])
repo.add("pymel", version="2", requires=["python-2"])
repo.add("houdini", version="18", requires=["python-3"])
repo.add("python", version="2")
repo.add("python", version="3")

context = ResolvedContext(["pipeline", "maya", "houdini-18"])
context.print_info()

The output from current master branch:

The context failed to resolve:
The following package conflicts occurred: (python-2 <--!--> python==3)

And here's the output from this PR branch:

resolve failed, by david@DESKTOP-EABK8SP, on Sat May 22 22:58:58 2021, using Rez v2.88.2

requested packages:
pipeline                     
maya                         
houdini-18                   
~platform==windows           (implicit)
~arch==AMD64                 (implicit)
~os==windows-10.0.19041.SP0  (implicit)

The context failed to resolve:
The following package conflicts occurred: (python-2 <--!--> python==3)

Resolve paths starting from initial requests to conflict:
  pipeline ? --> pipeline-1 --> maya-2020 --> pymel-2 >>> python-2
  maya ? --> maya-2020 --> pymel-2 >>> python-2
  houdini-18 ? --> houdini-18 --> python-3

And here's an example on cyclic failure:

# test_big_cycle
repo = Repo()
repo.add("pipeline", version="0", requires=["nuke-10"])
repo.add("nuke", version="10", requires=["cycle", "python==3"])
repo.add("python", version="3")
repo.add("cycle", version="1", requires=["bigger"])
repo.add("bigger", version="5", requires=["nuke"])

context = ResolvedContext(["pipeline", "cycle"])
context.print_info()

The output:

resolve failed, by david@DESKTOP-EABK8SP, on Sat May 22 23:01:24 2021, using Rez v2.88.2

requested packages:
pipeline                     
cycle                        
~platform==windows           (implicit)
~arch==AMD64                 (implicit)
~os==windows-10.0.19041.SP0  (implicit)

The context failed to resolve:
A cyclic dependency was detected: bigger-5 --> nuke-10 --> cycle-1 --> bigger-5

Resolve paths starting from initial requests to cycle:
  pipeline ? --> pipeline-0 --> nuke-10 --> cycle-1 --> bigger-5 --> nuke-10
  cycle ? --> cycle-1 --> bigger-5 --> nuke-10 --> cycle-1

Here is the full code of above testing examples.

[nerdvegas]

Hey David this looks really promising.

Just one minor thing, I think the formatting should be a little different. Eg you have:

Resolve paths starting from initial requests to cycle:
  pipeline ? --> pipeline-0 --> nuke-10 --> cycle-1 --> bigger-5 --> nuke-10
  cycle ? --> cycle-1 --> bigger-5 --> nuke-10 --> cycle-1

I would change to:

Resolve paths starting from initial requests to cycle:
  pipeline --> pipeline-0 --> nuke-10 --> cycle-1
  cycle --> cycle-1 --> bigger-5 --> nuke-10 --> cycle-1

And similarly:

Resolve paths starting from initial requests to conflict:
  pipeline ? --> pipeline-1 --> maya-2020 --> pymel-2 >>> python-2
  maya ? --> maya-2020 --> pymel-2 >>> python-2
  houdini-18 ? --> houdini-18 --> python-3

To:

Resolve paths starting from initial requests to conflict:
  pipeline --> pipeline-1 --> maya-2020 --> pymel-2 --> python-2
  maya --> maya-2020 --> pymel-2 --> python-2
  houdini-18 --> houdini-18 --> python-3

We don't need the extra syntaxes ? and >>> since the description header already gives enough context.

Also though, I'm not clear as to why the cycle output actually shows requirements that go past the cycle package? Here:

pipeline ? --> pipeline-0 --> nuke-10 --> cycle-1 --> bigger-5 --> nuke-10

Finally, I thnk it'd be good to add a line to the output like so:

To see a graph of the failed resolution, write the context to file (using rez-env -o), then view the graph (using rez-context -g)

[nerdvegas]

Ok so on further thought wrt cycle, how about this:

The context failed to resolve:
A cyclic dependency was detected: bigger-5 --> nuke-10 --> cycle-1 --> bigger-5

Resolve paths starting from initial requests to cycle:
  pipeline ? --> pipeline-0 --> nuke-10
  cycle ? --> cycle-1

In other words, just show the dep chain from each request, to where it first hits a pkg in the cycle. Any more info than this is redundant, since the cycle is already identified on that first line.

[davidlatwe]

We don't need the extra syntaxes ? and >>> since the description header already gives enough context.

Yes, I was thinking if it's redundant as well.

Finally, I thnk it'd be good to add a line to the output like so:

Fine touch !

About cyclic path, I was thinking that maybe would be better to show the full cycle for better knowing what's going on in one full path ?

If shorter path is desired, we could stop visiting nodes when hitting the edge that marked as CYCLE.

[davidlatwe]

About the additional hint message for viewing graph, what about rez-env --fail-graph or rez-build --fail-graph ?

[davidlatwe]

Okay, now the message looks like this

resolve failed, by davidlatwe.lai@MoonShineExp27, on Tue May 25 18:41:58 2021, using Rez v2.88.2

requested packages:
pipeline                     
maya                         
houdini-18                   
~platform==windows           (implicit)
~arch==AMD64                 (implicit)
~os==windows-10.0.18362.SP0  (implicit)

The context failed to resolve:
The following package conflicts occurred: (python-2 <--!--> python==3)

Resolve paths starting from initial requests to conflict:
  pipeline --> pipeline-1 --> maya-2020 --> pymel-2 --> python-2
  maya --> maya-2020 --> pymel-2 --> python-2
  houdini-18 --> houdini-18 --> python-3

To see a graph of the failed resolution, add --fail-graph in your rez-env or rez-build command.

And this

resolve failed, by davidlatwe.lai@MoonShineExp27, on Tue May 25 18:42:46 2021, using Rez v2.88.2

requested packages:
pipeline                     
cycle                        
~platform==windows           (implicit)
~arch==AMD64                 (implicit)
~os==windows-10.0.18362.SP0  (implicit)

The context failed to resolve:
A cyclic dependency was detected: cycle-1 --> bigger-5 --> nuke-10 --> cycle-1

Resolve paths starting from initial requests to cycle:
  pipeline --> pipeline-0 --> nuke-10 --> cycle-1
  cycle --> cycle-1

To see a graph of the failed resolution, add --fail-graph in your rez-env or rez-build command.

[nerdvegas]

Indeed yes, I'd forgotten we added --fail-graph a while back. cheers A

…

On Tue, May 25, 2021 at 8:43 PM David Lai ***@***.***> wrote: Okay, now the message looks like this resolve failed, by ***@***.***, on Tue May 25 18:41:58 2021, using Rez v2.88.2 requested packages: pipeline maya houdini-18 ~platform==windows (implicit) ~arch==AMD64 (implicit) ~os==windows-10.0.18362.SP0 (implicit) The context failed to resolve: The following package conflicts occurred: (python-2 <--!--> python==3) Resolve paths starting from initial requests to conflict: pipeline --> pipeline-1 --> maya-2020 --> pymel-2 --> python-2 maya --> maya-2020 --> pymel-2 --> python-2 houdini-18 --> houdini-18 --> python-3 To see a graph of the failed resolution, add --fail-graph in your rez-env or rez-build command. And this resolve failed, by ***@***.***, on Tue May 25 18:42:46 2021, using Rez v2.88.2 requested packages: pipeline cycle ~platform==windows (implicit) ~arch==AMD64 (implicit) ~os==windows-10.0.18362.SP0 (implicit) The context failed to resolve: A cyclic dependency was detected: cycle-1 --> bigger-5 --> nuke-10 --> cycle-1 Resolve paths starting from initial requests to cycle: pipeline --> pipeline-0 --> nuke-10 --> cycle-1 cycle --> cycle-1 To see a graph of the failed resolution, add --fail-graph in your rez-env or rez-build command. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#1083 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAMOUSVZJ4OF4BIA4WIDXELTPN5OJANCNFSM45KXEZ4A> .