Addition of Saving and Loading of Filter Presets [WIP] by feyruzb · Pull Request #4755 · Ericsson/codechecker

feyruzb · 2026-01-15T13:48:52Z

This pull request introduces a new "filter preset" feature to CodeChecker, allowing users to create, manage, and apply named collections of filter configurations for analysis results. It includes updates to the Thrift API, CLI commands, and versioning to support this functionality. The most important changes are outlined below.

Filter Preset Feature Implementation

Added a new FilterPreset struct and related API endpoints (storeFilterPreset, getFilterPreset, deleteFilterPreset, listFilterPreset) to report_server.thrift for managing filter presets on the server. [1] [2]
Added new menu and buttons for applying the Presets in Products.

Updated the CLI (cmd.py) to support new filter-preset subcommands (list, new, delete) for managing filter presets, and added a --filter-preset argument to allow users to apply a preset when running commands. [1] [2] [3]
list option can be used in 2 modes, first is json flag that displays full detailed information the rest like csv , plaintext and table uses summarization function that only displays existing filters in object.
Implemented logic in the CLI to load and merge filter presets from the server with command-line arguments, giving precedence to CLI arguments. [1] [2]
Added client helper methods for new filter preset API calls in results.py.

Versioning and Compatibility Updates

Bumped API and package versions to 6.68.0 in package.json, setup.py, and version.py to reflect the new feature and maintain compatibility.

Developer Tooling

Added a new script completly-rebuild-thrift.sh to automate rebuilding the Thrift API and related environments for developers.

Other API Enhancements

Added a getNameByValueForFilter endpoint to the Thrift API for resolving names based on values and class names. !THIS FUNCTION IS GOING TO BE DELETED, IT IS IN PR UNTIL DECIDED OTHERWISE!

gulyasgergely902

Overall good work, I've found only minor issues (even nitpicks) which can be fixed in no time. Please check the TODOs and comments with question marks and make them clear for the future. What I'm missing are the tests for the new functions. Please check them and write tests in the corresponding unit test folders.

gulyasgergely902 · 2026-02-11T08:59:58Z

web/api/completly-rebuild-thrift.sh

+export PATH="$HOME/codechecker/build/CodeChecker/bin:$PATH"
+
+echo "CodeChecker rebuild completed successfully!"
+echo "You can now use CodeChecker commands."


Add a new line to the end of the file, git can complain about missing new lines at the end of any text files.

gulyasgergely902 · 2026-02-11T09:11:54Z

web/api/report_server.thrift

+  // if the id is -1 a new preset filter is created
+  // the filter preset name must be unique.
+  // An error must be thrown if another preset exists with the same name.
+  // The encoding of the name must be unicode. (whitespaces allowed?)


In this line, "whitespaces allowed?" suggests me that this part is not yet complete. Please decide if either allowed or not and edit the comment accordingly.

gulyasgergely902 · 2026-02-11T09:21:00Z

web/api/report_server.thrift

+  // Filter grouping api calls.
+  //============================================
+
+  // Stores the given FilterPreset with the given id


I got a few questions / remarks regarding this part:

Does it check the id of the incoming FilterPreset to decide if it exists or not? If so, please modify the first line accordingly (e.g. "If ~~the~~ a preset exists with the given id, it overwrites the name, and all preset values.")

Fix the second line to match the first: "If the preset does not exist yet, it creates it with the given id.".

The line "if the id is -1 a new preset filter is created" is confusing so if I add -1 as an id, it forcibly creates the filter? And if so, what will be the actual id after creation?

Please make all new sentences start with a capital letter and finish with a dot.

gulyasgergely902 · 2026-02-11T09:22:42Z

web/api/report_server.thrift

+  FilterPreset getFilterPreset(1: i64 id)
+                            throws (1: codechecker_api_shared.RequestFailed requestError);
+
+  // Removes the filterpreset with the given id


It should be written as "FilterPreset" to be uniform to the other comments.

gulyasgergely902 · 2026-02-11T09:37:30Z

web/server/codechecker_server/api/report_server.py

                                       description=description))
            return results

+    # Stores the given FilterPreset with the given id


I suggest you do the same modifications I've suggested above for the same comment.

gulyasgergely902 · 2026-02-11T09:50:52Z

web/server/codechecker_server/api/report_server.py

+            if preset is None:
+                return None
+
+            # convert ORM to dict for ReportFilter


Suggested change

# convert ORM to dict for ReportFilter

# Convert ORM to dict for ReportFilter

gulyasgergely902 · 2026-02-11T09:52:04Z

web/server/codechecker_server/api/report_server.py

+            if not token:
+                return ""
+
+            # special case for formatting confirmed bug. IN UI for some reason


Suggested change

# special case for formatting confirmed bug. IN UI for some reason

# Special case for formatting confirmed bug. IN UI for some reason

gulyasgergely902 · 2026-02-11T10:19:17Z

web/server/codechecker_server/api/report_server.py

+            session.add(preset_entry)
+            session.commit()
+            return int(preset_entry.id)
+        return -1


Not a terrible thing but some linters may complain about using magic numbers. You could create a const for it either here or in a global file (there might be already a file for status and error codes in codechecker) which you could use as a return value. E.g. FILTER_PRESET_ERROR = -1 or similar.

gulyasgergely902 · 2026-02-11T10:19:39Z

web/server/codechecker_server/api/report_server.py

+        Delete preset from products list based on preset_id.
+        """
+        self.__require_admin()
+        LOG.info("deleting filter preset by id")


Suggested change

LOG.info("deleting filter preset by id")

LOG.info("Deleting filter preset by ID")

gulyasgergely902 · 2026-02-11T10:21:43Z

web/server/codechecker_server/api/report_server.py

+        Returns the FilterPreset identified by id.
+        """
+        self.__require_view()
+        LOG.info("Returning filter Preset by id")


Suggested change

LOG.info("Returning filter Preset by id")

LOG.info("Returning filter Preset by ID")

gulyasgergely902 · 2026-02-12T08:51:50Z

One more thing which I've missed: Besides the unit tests, please also write functional tests, for the API too.

bruntib · 2026-02-19T00:55:23Z

web/api/report_server.thrift

+
+  // Return name based on mapping based on value and classname.
+  // PERMISSION: PRODUCT_VIEW
+  string getNameByValueForFilter(1: string classname,


Where is this function used? If not needed, then it should be removed.

bruntib · 2026-02-22T09:03:30Z

web/client/codechecker_client/cli/cmd.py

                        help="Get report details for reports such as bug path "
                             "events, bug report points etc.")

+    parser.add_argument('--filterPreset',


Let's follow the naming conventions: --filter-preset.

bruntib · 2026-02-22T09:04:38Z

web/client/codechecker_client/cli/cmd.py

+                             "is loaded from the server and applied to the "
+                             "results. You can override specific filters by "
+                             "providing additional filter arguments. Use "
+                             "'CodeChecker cmd filterPreset list' to see "


Let's rename it filter-preset.

bruntib · 2026-02-22T09:05:32Z

web/client/codechecker_client/cli/cmd.py

+                            action='store_true',
+                            dest='force',
+                            required=False,
+                            help="Force deletion without confirmation.")


Resetting is forced here instead of deletion.

Fixed, --force is deleted.

bruntib · 2026-02-22T10:47:57Z

web/client/codechecker_client/cli/cmd.py

    __add_common_arguments(tasks, needs_product_url=False)

+    filter_preset = subcommands.add_parser(
+        'filter_preset',


Suggested change

'filter_preset',

'filter-preset',

bruntib · 2026-02-23T12:35:37Z

web/client/codechecker_client/filter_preset_client.py

+            LOG.info("Filter preset was not deleted.")
+            sys.exit(0)
+
+    success = client.deleteFilterPreset(args.preset_id)


The function returns -1 in case of failure. That should be checked in the next statement. It would be even better if the function would throw an exception instead of returning -1 because that could explain the reason of error better.

bruntib · 2026-02-23T12:36:23Z

web/api/report_server.thrift

+
+  // Removes the filterpreset with the given id
+  // returns the id of the filter preset removed
+  // and -1 in case of error.


The function should throw an error in case of error.

bruntib · 2026-02-23T12:40:33Z

web/server/codechecker_server/api/report_server.py

+                )
+
+            if preset is None:
+                return -1


An error should be thrown. The return value of this function is FilterPreset according to the .thrift file.

bruntib · 2026-02-23T12:41:50Z

web/server/codechecker_server/api/report_server.py

+
+            # Convert ORM to dict for ReportFilter
+            rf = preset.report_filter
+            if isinstance(rf, str):


How can this field be a different type? If it's possibly None, then that should be checked. I have the same question for the next fields, too.

bruntib · 2026-02-23T14:07:25Z

web/server/codechecker_server/api/report_server.py

+            if not all_presets:
+                return []
+
+            list_of_all_presets = [self.getFilterPreset(preset.id) for preset in all_presets]


The content of getFilterPreset() could go to a helper function that assembles a ReportFilter object based on a PresetFilter. This way it wouldn't be needed to do as many database queries as many presets we have.

def transform(dbFilterPreset) return thriftfilterpreset getFilterPreset(id) x = dbQuery(id) transform(x) listFilterPreset() all = dbQuery for blabla in all: transform(blabla)

…oading presets when button pressed

…ation

feyruzb requested review from bruntib and vodorok as code owners January 15, 2026 13:48

feyruzb requested review from dkrupp and gulyasgergely902 January 15, 2026 13:49

feyruzb self-assigned this Jan 16, 2026

gulyasgergely902 requested changes Feb 11, 2026

View reviewed changes

feyruzb force-pushed the feat/filter-preset-feature branch 14 times, most recently from 3383a3f to a738d47 Compare February 18, 2026 16:04

feyruzb force-pushed the feat/filter-preset-feature branch 3 times, most recently from 481c8ad to 60a96ba Compare February 19, 2026 09:29

bruntib requested changes Feb 23, 2026

View reviewed changes

feyruzb force-pushed the feat/filter-preset-feature branch from 9aa6c06 to 3491e07 Compare February 25, 2026 17:42

feyruzb added 9 commits February 25, 2026 19:04

add thift api changes, add vue component, update api version

95740d0

add migration script

8ca0a56

correct save button location

d304eca

add new loading systems for presets

251a336

add cli flow for filter preset add/list/delete/load

424d306

add functional tests for thrift functions

92c6635

linter fixing phase

5a3a5ca

change database querying, now 2 times less requests, fix bug of not l…

3ef93d6

…oading presets when button pressed

rebase

afc62e0

feyruzb force-pushed the feat/filter-preset-feature branch from 3491e07 to afc62e0 Compare February 26, 2026 10:38

feyruzb added 2 commits February 26, 2026 14:04

fix wrong naming of --filter-preset and remove filter merging

5f2e79e

fix wrong naming of preset-filter for cli

e2f8db5

feyruzb force-pushed the feat/filter-preset-feature branch from 847d099 to 68e1cd3 Compare February 27, 2026 14:16

add change on preset detection, fix diff-type wrong load content

0132c0c

feyruzb force-pushed the feat/filter-preset-feature branch from 68e1cd3 to 0132c0c Compare February 27, 2026 14:41

feyruzb added 2 commits March 2, 2026 14:49

add overriding and saving as new extension to saving presets

1400422

modify behavior of function according to new agreed one

003fad6

feyruzb force-pushed the feat/filter-preset-feature branch from fa220f6 to 003fad6 Compare March 2, 2026 13:59

feyruzb added 7 commits March 2, 2026 16:23

Load saved, overridden, or newly created preset after successful oper…

462d44e

…ation

remove extra wait, remove --force cli option

53cd471

fix majority of comments

cbf1265

fix wrong date build, move default values to avoid circular import

2f98c8d

fix functional tests, fix cli date loading

cda9d3e

fix no meaning field loading bug, fix bug path length dead code bug

799513f

add new funtionality and fix comments

bc6698d

	# convert ORM to dict for ReportFilter
	# Convert ORM to dict for ReportFilter

	# special case for formatting confirmed bug. IN UI for some reason
	# Special case for formatting confirmed bug. IN UI for some reason

	LOG.info("deleting filter preset by id")
	LOG.info("Deleting filter preset by ID")

	LOG.info("Returning filter Preset by id")
	LOG.info("Returning filter Preset by ID")

Conversation

feyruzb commented Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gulyasgergely902 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

feyruzb Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gulyasgergely902 commented Feb 12, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

feyruzb commented Jan 15, 2026 •

edited

Loading

gulyasgergely902 left a comment •

edited

Loading

feyruzb Feb 19, 2026 •

edited

Loading

bruntib Feb 23, 2026 •

edited

Loading