Fix the additional lifecycle events to work as documented

[DJMcNab]

Required for Smithay/calloop-wayland-source#1.

I think this only needs to be a patch release, as this just brings the behaviour in-line with the docs

[kchibisov]

it's an internal change, so could be released as a patch release normally.

[kchibisov]

It's a bit unclear what was exactly changed, probably should describe the behavior that could be observed (like endless loop due to use of lifecycle events).

[DJMcNab]

I think this is sufficient because:

1. there are, to my knowledge, no users of this API, so no-one will have run into this
2. The pr is readily available
3. I don't want to make the changelog be really long with useless content

But I'll put whatever you prefer, if you give me the text you want to put here

[kchibisov]

I mean, - Fix infinite loop when using a source with lifecycle events is short enough from what I can say? Or is it not reflecting the situation correctly?

[DJMcNab]

So the infinite loop was only because the events were never getting read - we were still making progress, and other sources would have worked.

That is, the infinite loop is in the WaylandSource - yes because of this issue, but that isn't the only way this could manifest

[kchibisov]

Hm, yeah, that's actually fair. I'm fine with the changelog like that, it's just reads without providing a real value to the user.

[kchibisov]

probably @elinorbgr has a better suggestion on that matter, since we'd need to patch release and maybe yank 0.12.

[elinorbgr]

Overall, I'd prefer to have a quick description of what the bug was, so something like this would be fine imo:

- Fix `EventSource::before_handle_events()` being erroneously give an iterator over synthetic events instead of real events

[kchibisov]

CI should be fixed after #150

[elinorbgr]

👍 with a rebase & changelog adjusment

[codecov]

Codecov Report

Patch coverage: 100.00% and project coverage change: -0.62% ⚠️

Comparison is base (2feb1cf) 86.82% compared to head (a5415ee) 86.20%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #149      +/-   ##
==========================================
- Coverage   86.82%   86.20%   -0.62%     
==========================================
  Files          14       12       -2     
  Lines        1806     1624     -182     
==========================================
- Hits         1568     1400     -168     
+ Misses        238      224      -14     

Flag	Coverage Δ
macos-latest	?
ubuntu-latest	?

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed	Coverage Δ
src/loop_logic.rs	88.69% <100.00%> (+1.78%)	⬆️

... and 4 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[elinorbgr]

Perfect thanks!