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

The New Query Api (aka [1]007 with the license to kill redundant frontend boilerplate) #1007

Open
5 tasks done
EagleoutIce opened this issue Sep 22, 2024 · 7 comments
Open
5 tasks done
Assignees
Labels
cli Refers to a Command Line Interface enhancement New feature or request query api relates to the query api question Further information is requested server Has to do with flowR's server

Comments

@EagleoutIce
Copy link
Member

EagleoutIce commented Sep 22, 2024

Alongside #980 i am creating a new query API which should be used to consume the following features:

This should be part of 2.1 which will start to deprecate the other messages. Comments are open until #980 is stable and in main, for now, you may refer to https://github.com/flowr-analysis/flowr/blob/980-context-sensitive-call-pattern-queries/wiki/Query%20API.md for the evolving documentation of the Query API.

As a benefit this would provide server/cli/... integration for new queries with just one definition, drastically reducing the boiler plate. Additionally, this allows the (re-) use of virtual queries like the compound query to group and pre-determine arguments!

@EagleoutIce EagleoutIce added enhancement New feature or request question Further information is requested cli Refers to a Command Line Interface server Has to do with flowR's server labels Sep 22, 2024
@EagleoutIce EagleoutIce self-assigned this Sep 22, 2024
@EagleoutIce
Copy link
Member Author

Feel free to comment @SunVal, @LukasPietzschmann, @Ellpeck, @allaboutmeme.

@EagleoutIce EagleoutIce changed the title The New Query Api The New Query Api (aka [1]007 with the license to kill redundant frontend boilerplate) Sep 22, 2024
@LukasPietzschmann
Copy link
Collaborator

I only have one question: did you intentionally wait until the issue could be #[1]007?

@EagleoutIce
Copy link
Member Author

No, as you may see from the title change this was just a nice coincidence :D

@EagleoutIce EagleoutIce added this to the v2.1.0 milestone Sep 22, 2024
@EagleoutIce EagleoutIce added the query api relates to the query api label Sep 30, 2024
@LukasPietzschmann
Copy link
Collaborator

LukasPietzschmann commented Oct 3, 2024

Once #1021 is finished, I think it location based restrictions could become useful. For instance, consider the following example where only nodes originating from the test_file.R file would be included in the search scope.

[
  {
    "type": "call-context",
    "callName": "^except_.*$",
    "kind": "check",
    "subkind": "except",
    "location": [ "path/to/test_file.R"	]
  }
]

What do you think about that (as this could theoretically also be implemented client side)?

@EagleoutIce
Copy link
Member Author

Thank you for the proposal, i think this should be part of the query api, but probably be outsourced into another issue, can you please create one?

@EagleoutIce EagleoutIce removed this from the v2.1.0 (Query API) milestone Oct 3, 2024
@EagleoutIce
Copy link
Member Author

To speedup the release of 2.1.0, we no longer schedule the inclusion of all of these messages with 2.1.0 but will do so with later releases based on the demand.

@LukasPietzschmann
Copy link
Collaborator

I think this should be part of the query api, but probably be outsourced into another issue, can you please create one?

Sure, it's now tracked in (or with?) #1030

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli Refers to a Command Line Interface enhancement New feature or request query api relates to the query api question Further information is requested server Has to do with flowR's server
Projects
None yet
Development

No branches or pull requests

2 participants