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

fix(oonimkall): only set annotations on success #821

Merged
merged 1 commit into from
Jul 1, 2022
Merged

Conversation

bassosimone
Copy link
Contributor

@bassosimone bassosimone commented Jun 29, 2022

Checklist

Description

This bug is one of these bugs that definitely help one to stay
humble and focused on improving the codebase.

Of course I <facepalmed> when I understood the root cause.

We did not move the annotations below the if which is checking
whether the measurement was successful when we refactored the
codebase to support returning multiple measurements per run, which
happened in #527.

While I am not going to whip myself too much because of this, it's
clearly a bummer that we didn't notice this bug back then. On top
of this, it's also quite sad it took us so much time to notice that
there was this bug inside the tree.

The lesson (hopefully) learned is probably that we need to be more
careful when we refactor and we should always ask the question of
whether, not only we have tests, but whether these tests could maybe
be improved to give us even more confidence about correctness.

This bug is one of these bugs that definitely help one to stay
humble and focused on improving the codebase.

Of course I <facepalmed> when I understood the root cause.

We did not move the annotations below the `if` which is checking
whether the measurement was successful when we refactored the
codebase to support returning multiple measurements per run, which
happened in #527.

While I am not going to whip myself too much because of this, it's
clearly a bummer that we didn't notice this bug back then. On top
of this, it's also quite sad it took us so much time to notice that
there was this bug inside the tree.

The lesson (hopefully) learned is probably that we need to be more
careful when we refactor and we should always ask the question of
whether, not only we have tests, but whether these tests could maybe
be improved to give us even more confidence about correctness.

The reference issue is ooni/probe#2173.
@bassosimone bassosimone requested a review from aanorbel June 29, 2022 09:20
@bassosimone bassosimone requested a review from hellais as a code owner June 29, 2022 09:20
Copy link
Member

@aanorbel aanorbel left a comment

Choose a reason for hiding this comment

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

LGTM

@bassosimone
Copy link
Contributor Author

Thanks, @aanorbel !

@bassosimone bassosimone merged commit 9b08dca into master Jul 1, 2022
@bassosimone bassosimone deleted the issue/2173 branch July 1, 2022 07:54
bassosimone added a commit that referenced this pull request Jul 1, 2022
This commit backports 9b08dca
from the master branch. Originaly commit message follows:

- - -

This bug is one of these bugs that definitely help one to stay
humble and focused on improving the codebase.

Of course I `<facepalmed>` when I understood the root cause.

We did not move the annotations below the `if` which is checking
whether the measurement was successful when we refactored the
codebase to support returning multiple measurements per run, which
happened in #527.

While I am not going to whip myself too much because of this, it's
clearly a bummer that we didn't notice this bug back then. On top
of this, it's also quite sad it took us so much time to notice that
there was this bug inside the tree.

The lesson (hopefully) learned is probably that we need to be more
careful when we refactor and we should always ask the question of
whether, not only we have tests, but whether these tests could maybe
be improved to give us even more confidence about correctness.

The reference issue is ooni/probe#2173.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants