osrg/gobgp

Breaking change in WatchEvent API introduced in v3.24.0

rastislavs opened this issue ยท 10 comments

The v3.24.0 introduced a breaking change in WatchEvent API by the commit aff055b

As of this commit, Path in generated events no longer has Nlri and Pattrs attributes set (they are always nil), and instead NlriBinary and PattrsBinary attributes are set.

Not sure what was the motivation behind this change, but as it changes the behavior of the API, it is breaking for the API consumers.

Thanks for the report! Sounds like needs to be reverted.

Right, reverting the changes on the 3 modified lines in BgpServer.WatchEvent should be also sufficient - maybe @bayrinat could tell us what was the intention behind this change?

The intention is adding EOR support to the EventAPI.

The intention is adding EOR support to the EventAPI.

Ah, I meant specifically, switching the onlyBinary argument of toPathApi calls in WatchEvent from false to true.

Oops, understood.

Hello, my bad. This change wasn't suppose to be there.

@rastislavs Thanks for the quick revert, I'll do the proper change soon.

I prefer clean revert:
#2779

I reverted two commits. The API should work as before.

Yes, I just tested that on top of the commit 9d05544 everything works as expected. Thank you.

The second attempt without breaking changes - #2780