Skip to content

Added peeking to EventReader #13809

Closed
BobG1983 wants to merge 36 commits intobevyengine:mainfrom
BobG1983:peekable_eventreader
Closed

Added peeking to EventReader #13809
BobG1983 wants to merge 36 commits intobevyengine:mainfrom
BobG1983:peekable_eventreader

Conversation

@BobG1983
Copy link
Contributor

@BobG1983 BobG1983 commented Jun 11, 2024

Added peekability to EventReader for when you want to view an event but not mark it as read

Objective

  • Allow the ability to view an event without marking it as read

Solution

  • Copied the existing iterators and implemented them for peeking, ie. they no longer move the "last_read" onwards.
  • I also took this opportunity to improve the documentation on EventReader given I was adding explanations for peeking.

Testing

  • Wrote a number of tests to confirm that the new peek iterators work as expected. Renamed a bunch of the existing tests to specify they test read and wrote peek equivalents. Also wrote tests for combination of reading and peeking to make sure behavior was as expected.

@BobG1983
Copy link
Contributor Author

BobG1983 commented Jun 11, 2024

No idea why the MacOS build fails given I didn't touch those files at all?

@alice-i-cecile alice-i-cecile added A-ECS Entities, components, systems, and events C-Usability A targeted quality-of-life change that makes Bevy easier to use S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jun 11, 2024
@BobG1983
Copy link
Contributor Author

BobG1983 commented Jun 11, 2024

The issue is that par_read doesn't mark events as seen like read which I assumed it did, I ended up rewriting the tests to validate that behavior. Which par_read then failed.

It looks like this has always been the behavior of par_read

@BobG1983
Copy link
Contributor Author

BobG1983 commented Jun 13, 2024 •
edited
Loading

Added the fix from #13836 to this pull request too given I'm going to squash the files and tests associated with it.

@BobG1983 BobG1983 mentioned this pull request Jun 13, 2024
Merged
mnmaita
mnmaita reviewed Jun 14, 2024
View reviewed changes
Copy link
Member

@mnmaita mnmaita left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool feature and great additions to documentation! Leaving a few nits and suggestions in doc comments.

@BD103 BD103 added the S-Blocked This cannot move forward until something else changes label Jun 15, 2024
@BD103
Copy link
Member

BD103 commented Jun 15, 2024

I'm marking this as blocked by #13836. Once that gets merged and this gets enough reviews, this can be merged :)

kristoff3r
kristoff3r suggested changes Jun 17, 2024
View reviewed changes
@BobG1983
Copy link
Contributor Author

BobG1983 commented Jun 17, 2024

@BD103 I wouldn’t say this is blocked. In fact. This has the fix in it already so if this is merged the other PR doesn’t need to be.

@BobG1983
Copy link
Contributor Author

BobG1983 commented Jun 17, 2024

Failed because of a formatting requirement that I can’t really fix on my phone. Will take a look tomorrow.

@BD103
Copy link
Member

BD103 commented Jun 18, 2024

@BD103 I wouldn’t say this is blocked. In fact. This has the fix in it already so if this is merged the other PR doesn’t need to be.

I would prefer we split it up into two different PRs, but I'll defer to maintainers on this. :)

@BobG1983
Copy link
Contributor Author

BobG1983 commented Jun 18, 2024

Only reason I included it in here is because I squash the existing iterator file anyway.

BobG1983 and others added 9 commits June 18, 2024 09:45
@BobG1983
Tidied up multi_threaded feature support
e1d327e
@BobG1983
Fixed formatting of use statements
6c265fd
@BobG1983
Fixed cfg for ParIter
f927c43
@BobG1983 @atornity
Apply suggestions from code review
9061ce3 
Co-authored-by: poopy <gonesbird@gmail.com>
@BobG1983
Updating comment in example.
6802742
@BobG1983
Created EventCursor, replacing ManualEventReader, marked ManualEventR…
de0f0a8 
…eader as deprecated. Updated all uses of ManualEventReader to EventCursor. Deprecated Events::get_reader and replaced it with Events::get_cursor everywhere. Also took the opportunity to tidy up the events tests. Removed unrequried tests of Mutator and Reader and replaced them with tests of EventCursor, also removed unrequried E event and replaced with TestEvent in all tests. Sorted tests so they're easier to follow
@BobG1983
Updated engine and examples to use new EventCursor
becd0c3
@BobG1983
Fixed typo in test
29c4174
@BobG1983
Fixed more typos in test
3ace983
@BobG1983 BobG1983 force-pushed the peekable_eventreader branch from 50adea1 to 5a35f6b Compare June 24, 2024 17:46
@BobG1983
Copy link
Contributor Author

BobG1983 commented Jun 24, 2024

This branch is now stacked on top of #13818

@BobG1983 BobG1983 force-pushed the peekable_eventreader branch from 1519b84 to bfe9dd9 Compare July 5, 2024 18:08
@alice-i-cecile
Copy link
Member

alice-i-cecile commented Jul 14, 2024 •
edited
Loading

Completed in #13818

@BobG1983 BobG1983 deleted the peekable_eventreader branch July 15, 2024 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@mnmaita mnmaita mnmaita left review comments

@kristoff3r kristoff3r kristoff3r approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

A-ECS Entities, components, systems, and events C-Usability A targeted quality-of-life change that makes Bevy easier to use S-Blocked This cannot move forward until something else changes S-Needs-Review Needs reviewer attention (from anyone!) to move forward

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@BobG1983 @BD103 @alice-i-cecile @kristoff3r @mnmaita