Add MeshModel summary filter API integration and unit tests by Amr-Shams · Pull Request #918 · meshery/meshkit

Amr-Shams · 2026-02-28T16:13:30Z

Description
This PR integrates the new MeshModel summary filters into the registry API and adds unit tests for summary aggregation behavior.
This PR fixes #917

Notes for Reviewers

added unit test for both filters

Signed commits

Yes, I signed my commits.

gemini-code-assist · 2026-02-28T16:13:50Z

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the MeshModel registry API by introducing new capabilities for retrieving aggregated summary data for components and relationships. It provides a standardized approach to query and summarize registry entities, offering insights into their distribution across various dimensions. This improvement aims to facilitate better data analysis and management within the MeshModel ecosystem.

Highlights

New Summary Filter Interfaces: Introduced generic Summary and SummaryFilter interfaces to standardize the retrieval of aggregated summary data across different MeshModel entities.
Component Summary API: Implemented a new ComponentSummaryFilter and ComponentSummary structure, along with a GetComponentSummary method in RegistryManager, enabling aggregated queries for MeshModel components based on various dimensions like model, category, and registrant.
Relationship Summary API: Implemented a new RelationshipSummaryFilter and RelationshipSummary structure, along with a GetRelationshipSummary method in RegistryManager, enabling aggregated queries for MeshModel relationships based on dimensions like model, kind, type, and sub-type.
Error Handling Refactoring: Refactored the ErrGetById error creation into a dedicated registry/errors package, centralizing error definitions and improving maintainability.
Comprehensive Unit Tests: Added extensive unit tests for both the new component and relationship summary filters, ensuring the correctness and reliability of the aggregation logic.

Changelog

models/meshmodel/entity/types.go
- Added Summary interface for entities providing key-value and count data.
- Added generic SummaryFilter interface for entities exposing aggregated summary data.
models/meshmodel/registry/error.go
- Imported registryerrors package.
- Refactored ErrGetById to delegate error creation to the new registryerrors package.
models/meshmodel/registry/errors/error.go
- Added new file error.go to define common registry errors.
- Implemented ErrGetById function for consistent error handling across the registry.
models/meshmodel/registry/registry.go
- Imported regv1alpha3 and regv1beta1 packages for summary filters.
- Added GetComponentSummary method to RegistryManager to retrieve component summary data.
- Added GetRelationshipSummary method to RegistryManager to retrieve relationship summary data.
models/meshmodel/registry/v1alpha3/relationship_filter.go
- Updated GetById to use the new registryerrors.ErrGetById function.
models/meshmodel/registry/v1alpha3/relationship_summary.go
- Added new file relationship_summary.go to define RelationshipSummaryFilter and related types.
- Implemented Validate method for RelationshipSummaryFilter to check include dimensions.
- Implemented GetSummary method for RelationshipSummaryFilter to aggregate relationship data based on specified criteria.
models/meshmodel/registry/v1alpha3/relationship_summary_test.go
- Added new file relationship_summary_test.go containing unit tests for RelationshipSummaryFilter.
models/meshmodel/registry/v1beta1/category_filter.go
- Updated GetById to use the new registryerrors.ErrGetById function.
models/meshmodel/registry/v1beta1/component_filter.go
- Updated GetById to use the new registryerrors.ErrGetById function.
- Adjusted formatting for status filtering in the Get method.
models/meshmodel/registry/v1beta1/component_summary.go
- Added new file component_summary.go to define ComponentSummaryFilter and related types.
- Implemented Validate method for ComponentSummaryFilter to check include dimensions.
- Implemented GetSummary method for ComponentSummaryFilter to aggregate component data based on specified criteria.
models/meshmodel/registry/v1beta1/component_summary_test.go
- Added new file component_summary_test.go containing unit tests for ComponentSummaryFilter.
models/meshmodel/registry/v1beta1/model_filter.go
- Updated GetById to use the new registryerrors.ErrGetById function.
models/meshmodel/registry/v1beta1/policy_filter.go
- Updated GetById to use the new registryerrors.ErrGetById function.

Activity

Unit tests were added for both the new component and relationship summary filters.
All commits have been signed off by the author.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request effectively integrates new MeshModel summary filters into the registry API and includes comprehensive unit tests, which is great. The refactoring of error handling into a dedicated package is a good move for code organization. I've provided a couple of suggestions to refactor the new GetSummary methods to reduce code duplication, which will enhance long-term maintainability.

models/meshmodel/registry/v1alpha3/relationship_summary.go

models/meshmodel/registry/v1beta1/component_summary.go

lekaf974 · 2026-03-02T02:41:07Z

Were now using schemas driven development and IMo such struct should be implemented in meshery/schemas

lekaf974 · 2026-03-02T02:43:21Z

models/meshmodel/registry/v1alpha3/relationship_summary.go

+	return nil
+}
+
+func (relationshipFilter *RelationshipSummaryFilter) GetSummary(db *database.Handler) (*RelationshipSummary, error) {


Where this method will be used ?

it is a cross repo issue, here you can check the (meshery/meshery#17457)

Amr-Shams · 2026-03-02T09:16:58Z

Were now using schemas driven development and IMo such struct should be implemented in meshery/schemas

u mean the new filter ?

lekaf974 · 2026-03-02T19:18:49Z

Were now using schemas driven development and IMo such struct should be implemented in meshery/schemas

u mean the new filter ?

I think all structs created should go there to have a unique source of truth but perhaps it needs to be validated.

cc: @leecalcote, @aabidsofi19 any thoughts ?

aabidsofi19 · 2026-03-03T07:03:00Z

@lekaf974 absolutely right . All structs models, requests payload, filters , response should be defined and generated using openapi schemas

lekaf974 · 2026-03-03T16:00:01Z

models/meshmodel/registry/v1alpha3/relationship_summary_test.go

 	"github.com/stretchr/testify/require"
 )

+type relationshipSummaryRecord struct {


As mentionned in other comment this struct should be added in meshery/schemas repo

Yeah fair point, but this one is test-only, not an API struct.

relationshipSummaryRecord is just a small DB seed helper for unit tests.
After switching to generated schema types, using RelationshipDefinition directly in test migrate/seed was failing because of nested ModelReference parsing in GORM.

So this isn’t a new runtime model, and nothing API-related is being defined here.
The actual filter/response shapes are in meshery/schemas.

Amr-Shams · 2026-03-03T16:04:38Z

@lekaf974 i have open a pr, and once the schemes is approved i will push the local changes here

Signed-off-by: Amr-Shams <amr.shams2015.as@gmail.com>

…ount Signed-off-by: Amr-Shams <amr.shams2015.as@gmail.com>

Signed-off-by: Amr-Shams <amr.shams2015.as@gmail.com>

gemini-code-assist bot reviewed Feb 28, 2026

View reviewed changes

models/meshmodel/registry/v1alpha3/relationship_summary.go Outdated Show resolved Hide resolved

models/meshmodel/registry/v1beta1/component_summary.go Outdated Show resolved Hide resolved

lekaf974 reviewed Mar 2, 2026

View reviewed changes

lekaf974 requested review from aabidsofi19 and leecalcote March 2, 2026 19:19

Amr-Shams mentioned this pull request Mar 3, 2026

feat(schemas): add MeshModel component and relationship summary filter/response schemas meshery/schemas#615

Open

lekaf974 reviewed Mar 3, 2026

View reviewed changes

Amr-Shams requested a review from lekaf974 March 3, 2026 16:06

Amr-Shams force-pushed the feat/meshmodel-summary-filters-registry-api branch from a9591a4 to 4b2d740 Compare March 3, 2026 16:14

Amr-Shams added 6 commits March 3, 2026 18:16

refactor(meshmodel reg): removed the cycle dependency

b9c41d1

Signed-off-by: Amr-Shams <amr.shams2015.as@gmail.com>

feat(filters): added two new filters for summary

39ae9c4

Signed-off-by: Amr-Shams <amr.shams2015.as@gmail.com>

refactor(filters): added missing dimesnsion, fork a session for the c…

e157eea

…ount Signed-off-by: Amr-Shams <amr.shams2015.as@gmail.com>

refactor(filters): use dry principle

84ff3cb

Signed-off-by: Amr-Shams <amr.shams2015.as@gmail.com>

refactor to use the new schema from openAPI

a4fbf5c

Signed-off-by: Amr-Shams <amr.shams2015.as@gmail.com>

removing extra an non used types

ab92b53

Signed-off-by: Amr-Shams <amr.shams2015.as@gmail.com>

Amr-Shams force-pushed the feat/meshmodel-summary-filters-registry-api branch from 4b2d740 to ab92b53 Compare March 3, 2026 16:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add MeshModel summary filter API integration and unit tests#918

Add MeshModel summary filter API integration and unit tests#918
Amr-Shams wants to merge 6 commits intomeshery:masterfrom
Amr-Shams:feat/meshmodel-summary-filters-registry-api

Amr-Shams commented Feb 28, 2026

Uh oh!

gemini-code-assist bot commented Feb 28, 2026

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

Uh oh!

Uh oh!

lekaf974 commented Mar 2, 2026

Uh oh!

lekaf974 Mar 2, 2026

Uh oh!

Amr-Shams Mar 2, 2026

Uh oh!

Amr-Shams commented Mar 2, 2026

Uh oh!

lekaf974 commented Mar 2, 2026

Uh oh!

aabidsofi19 commented Mar 3, 2026

Uh oh!

lekaf974 Mar 3, 2026

Uh oh!

Amr-Shams Mar 3, 2026

Uh oh!

Amr-Shams commented Mar 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Amr-Shams commented Feb 28, 2026

Uh oh!

gemini-code-assist bot commented Feb 28, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

lekaf974 commented Mar 2, 2026

Uh oh!

lekaf974 Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Amr-Shams Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Amr-Shams commented Mar 2, 2026

Uh oh!

lekaf974 commented Mar 2, 2026

Uh oh!

aabidsofi19 commented Mar 3, 2026

Uh oh!

lekaf974 Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Amr-Shams Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Amr-Shams commented Mar 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants