[bgen] Adjust logic to handle protocol-backed events. #19689
Conversation
Previously we used the presence of the [Protocolize] attribute to detect Delegate properties returning protocols that should be specially handled if the delegate in question supported events (in particular the Delegate property would get additional code to ensure the developer didn't use both the event pattern and the delegate pattern, because then one or the other wouldn't work properly). However, the presence of the [Protocolize] attribute does not take into account that there's another way to declare that a Delegate property uses a protocol: the property could use the protocol directly as the property type, without a [Protocolize] attribute. So change the logic to detect either the [Protocolize] attribute or an actual protocol. This is a slight breaking change in that we'll now add the special code to more Delegate properties, and we'll throw an exception if the developer uses both the event pattern and the delegate pattern in more cases. In theory this should be a good thing (we're detecting more broken developer code), and if it turns out to be an incorrect check, developers can opt out of this extra check anyway.
💻 [CI Build] Windows Integration Tests passed 💻✅ All Windows Integration Tests passed. Pipeline on Agent |
📚 [PR Build] Artifacts 📚Packages generatedView packagesPipeline on Agent |
💻 [CI Build] Tests on macOS M1 - Mac Big Sur (11.5) passed 💻✅ All tests on macOS M1 - Mac Big Sur (11.5) passed. Pipeline on Agent |
💻 [CI Build] Tests on macOS M1 - Mac Ventura (13.0) passed 💻✅ All tests on macOS M1 - Mac Ventura (13.0) passed. Pipeline on Agent |
✅ API diff for current PR / commitLegacy Xamarin (No breaking changes)
NET (empty diffs)
✅ API diff vs stableLegacy Xamarin (No breaking changes).NET (No breaking changes)ℹ️ Generator diffGenerator Diff: vsdrops (html) vsdrops (raw diff) gist (raw diff) - Please review changes) Pipeline on Agent |
🚀 [CI Build] Test results 🚀Test results✅ All tests passed on VSTS: simulator tests. 🎉 All 235 tests passed 🎉 Tests counts✅ bcl: All 69 tests passed. Html Report (VSDrops) Download Pipeline on Agent |
Previously we used the presence of the [Protocolize] attribute to detect
Delegate properties returning protocols that should be specially handled if
the delegate in question supported events (in particular the Delegate property
would get additional code to ensure the developer didn't use both the event
pattern and the delegate pattern, because then one or the other wouldn't work
properly).
However, the presence of the [Protocolize] attribute does not take into
account that there's another way to declare that a Delegate property uses a
protocol: the property could use the protocol directly as the property type,
without a [Protocolize] attribute.
So change the logic to detect either the [Protocolize] attribute or an actual
protocol.
This is a slight breaking change in that we'll now add the special code to
more Delegate properties, and we'll throw an exception if the developer uses
both the event pattern and the delegate pattern in more cases. In theory this
should be a good thing (we're detecting more broken developer code), and if it
turns out to be an incorrect check, developers can opt out of this extra check
anyway.