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] Refine when a report is regarded as outstanding for tags #3995

Merged
merged 1 commit into from
Sep 20, 2023

Conversation

Szelethus
Copy link
Contributor

@Szelethus Szelethus commented Aug 28, 2023

Despite only two lines of code, this patch is many things all in once:

  • We fix a bug where diffing tags returned unexpected (and percieved to
    be incorrect) results,
  • We redefine what we expect from diffing tags,
  • We redefine the expected heaviour around review status rules.

Previously, we regarded review status rules are a timeless property, but
what is even more true, we didn't really know what we expect from them
when it came to diffing tags. This lead to confusion on the developer
side and on the user side as well, and lead to whack-a-mole issues and
patches like #3675, that was more driven by what users expected from
this feature than a comprehensive plan.

This is okay -- the review status feature and the tag feature grew in
their own world, and nobody can be faulted for being on top of these
features having a very solid specifications right out of the gate. This
patch solved this issue.

From this point on, our stance is the following: when we diff runs, we
always check whether a report is outstanding at the time of the query,
and for diffing tags or timestamps, we check whether a report is
outstanding at the time of the tag/timestamp.

A user-facing documentation is written in #4006, and can be previewed
here:
https://github.com/Szelethus/codechecker/blob/diff_docs_rewrite/docs/web/diff.md

@Szelethus Szelethus added this to the release 6.23.0 milestone Aug 28, 2023
@Szelethus Szelethus requested a review from cservakt August 28, 2023 11:21
@Szelethus Szelethus marked this pull request as draft August 28, 2023 11:22
@Szelethus Szelethus added the WIP 💣 Work In Progress label Aug 28, 2023
@Szelethus Szelethus removed the WIP 💣 Work In Progress label Sep 8, 2023
@Szelethus Szelethus marked this pull request as ready for review September 8, 2023 12:58
@@ -70,6 +70,14 @@
SQLITE_MAX_COMPOUND_SELECT = 500


def dumpSql(q):
Copy link
Contributor

Choose a reason for hiding this comment

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

Function not used.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Intentionally, this is meant to be a debug function for occasional use.

Despite only two lines of code, this patch is many things all in once:
* We fix a bug where diffing tags returned unexpected (and percieved to
  be incorrect) results,
* We redefine what we expect from diffing tags,
* We redefine the expected heaviour around review status rules.

Previously, we regarded review status rules are a timeless property, but
what is even more true, we didn't really know what we expect from them
when it came to diffing tags. This lead to confusion on the developer
side and on the user side as well, and lead to whack-a-mole issues and
patches like Ericsson#3675, that was more driven by what users expected from
this feature than a comprehensive plan.

This is okay -- the review status feature and the tag feature grew in
their own world, and nobody can be faulted for being on top of these
features having a very solid specifications right out of the gate. This
patch solved this issue.

From this point on, our stance is the following: when we diff runs, we
always check whether a report is outstanding _at the time of the query_,
and for diffing tags or timestamps, we check whether a report is
outstanding _at the time of the tag/timestamp_.

A user-facing documentation is written in Ericsson#4006, and can be previewed
here:
https://github.com/Szelethus/codechecker/blob/diff_docs_rewrite/docs/web/diff.md
@bruntib bruntib merged commit d41434b into Ericsson:master Sep 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants