[WIP] feat: add ranking expression support for topN and bottomN filters

[AStaroverov]

No description provided.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 84e65c5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[gemini-code-assist]

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 lays the groundwork for advanced data filtering by introducing support for ranking expressions. It defines the necessary types and interfaces for window functions, integrates them into the existing query expression system, and provides the conversion logic for topN and bottomN filters to utilize these new ranking capabilities. The changes also ensure that these new filter types are exposed and usable within the application's UI.

Highlights

• Ranking Expression Definition: Introduced a new ExprRanking interface and RankingKind type in query_common.ts to define ranking window functions (rank, denseRank, rowNumber) with support for ordering and partitioning.
• Query Expression Integration: Integrated the new ExprRanking type into DataQueryExpression and SpecQueryExpression in query_data.ts and query_spec.ts respectively, allowing ranking expressions to be part of data and specification queries.
• TopN and BottomN Filter Support: Implemented conversion logic in filterToQuery.ts to transform topN and bottomN filters into numericComparison expressions that leverage the newly defined ranking expression, enabling these filters to be processed by the query engine.
• UI Filter Availability: Updated the PlTableFiltersV2.vue component to include topN and bottomN in its list of supported filters, making these new filtering options accessible in the user interface.

Changelog

• lib/model/common/src/drivers/pframe/query/query_common.ts
  • Added RankingKind type for different ranking function types.
  • Added ExprRanking interface to define ranking expressions with kind, orderBy, ascending, and partitionBy properties.
• lib/model/common/src/drivers/pframe/query/query_data.ts
  • Imported ExprRanking type.
  • Extended DataQueryExpression union type to include ExprRanking.
• lib/model/common/src/drivers/pframe/query/query_spec.ts
  • Imported ExprRanking type.
  • Extended SpecQueryExpression union type to include ExprRanking.
• sdk/model/src/filters/converters/filterToQuery.ts
  • Implemented conversion for topN filters to a numericComparison expression using ExprRanking with rank and ascending: false.
  • Implemented conversion for bottomN filters to a numericComparison expression using ExprRanking with rank and ascending: true.
• sdk/ui-vue/src/components/PlTableFilters/PlTableFiltersV2.vue
  • Added topN and bottomN to the supportedFilters array, making them available in the filter UI.

Activity

• The pull request is currently marked as 'Work In Progress' (WIP) by AStaroverov, indicating active development.

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.

Footnotes

1. 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 introduces support for topN and bottomN filters by adding a new ranking expression to the query model. The implementation correctly translates these filters into a query expression using a rank function, which is a great addition. The changes are well-structured, and the new ExprRanking interface is clearly documented. I have one suggestion to improve the consistency of the new interface with the existing query model. As this is a work-in-progress, please also remember to update the unit tests for filterSpecToSpecQueryExpr to reflect the new functionality for topN and bottomN filters.

[gemini-code-assist]

For consistency with other parts of the query model like QuerySort (where ascending is a required property), and to avoid ambiguity about default behavior, it would be better to make the ascending property required here as well. This makes the contract of the ExprRanking interface more explicit. The current implementation for topN/bottomN already provides this property, so it would be a non-breaking change for that use case.

Suggested change

	/** Ascending or descending order */
	ascending?: boolean;
	/** If true, order ascending (A-Z, 0-9); if false, descending */
	ascending: boolean;