Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Streamline submission filtering and submission error handling #232

Closed
tsaglam opened this issue Nov 22, 2021 · 0 comments · Fixed by #234
Closed

Streamline submission filtering and submission error handling #232

tsaglam opened this issue Nov 22, 2021 · 0 comments · Fixed by #234
Labels
enhancement Issue/PR that involves features, improvements and other changes minor Minor issue/feature/contribution/change
Milestone

Comments

@tsaglam
Copy link
Member

tsaglam commented Nov 22, 2021

Currently, there are multiple ways how submissions are excluded. Some are removed during iterating while parsing (see JPlag.parseSubmissions()), while others are marked as erroneous and then later filtered in a later step. We should streamline this process.
As pointed out by @Alberth289346 in #230:

iter.remove() while parsing/checking submissions feels like the wrong approach. It's slow to remove in a long arraylist, and more importantly, it messes in the job that filterValidSubmissions() should do. I think this needs a decision where invalid submissions are removed. For paranoia checking, it might be useful to check further down the line that only valid submissions exist.

In my opinion, submissions should be marked as erroneous and maybe even given the information why they are erroneous. Then, they should be filtered later on. If we introduce a submission set (i.e. with #231), this could be done in there resulting in two methods: getValidSubmissions() and getInvalidSubmissions(). The latter is also useful for the new report generation, as the current JPlagResult does not expose which submissions were not used for comparison.

@tsaglam tsaglam added enhancement Issue/PR that involves features, improvements and other changes minor Minor issue/feature/contribution/change labels Nov 22, 2021
@tsaglam tsaglam added this to the v3.0.0 milestone Nov 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Issue/PR that involves features, improvements and other changes minor Minor issue/feature/contribution/change
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant