[ExpressionLanguage] Add `Parser->parseWithoutContext` #50144

homersimpsons · 2023-04-24T21:48:36Z

Q	A
Branch?	6.4
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets	Fix #50105
License	MIT
Doc PR	symfony/symfony-docs/pull/18298

Always add tests and ensure they pass.
For new features, provide some code snippets to help understand usage.
Changelog entry should follow https://symfony.com/doc/current/contributing/code/conventions.html#writing-a-changelog-entry
Never break backward compatibility (see https://symfony.com/bc).
Doc PR (📝 Document Parser->parseWithoutContext symfony-docs#18298)
Is it possible to backport it to Symfony 5.4 ?

Code snippet

Let say we want to check that all our #[Security] attributes have an is_granted call with a subject given.

Note that the following example is for illustration purpose and does not really handle all possible outcomes (for instance is_granted(.., ..) || is_granted(.., ..).

$lexer = new Lexer();
$parser = new Parser([]);

$attributes = /* fetch all `#[Security]` attributes */
foreach ($attributes as $attribute) {
    $intance = $attribute->newInstance();
    $parsed = $parser->parseWithoutContext($instance->getExpression()); // Here we can parse without taking care of the possible symbols
    if (
        $parsed instanceof FunctionNode
        && isset($parsed->nodes['arguments'][1])
        && $parsed->nodes['arguments'][1] instanceof NameNode
    ) {
      continue; // it is an `is_granted` call with a subject
    }

    throw new SecurityException('Attribute with expression `' . $instance->getExpression() . '` does not have a valid `is_granted` call.');
}

Other use cases may involve:

Executing the expression in another language (such as in browser in JavaScript)
Extracting variable name in a first pass to get their values from a database or something else, then evaluating the expression in a second pass

carsonbot · 2023-04-24T21:48:41Z

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

Always add tests
Keep backward compatibility (see https://symfony.com/bc).
Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
Features and deprecations must be submitted against the 6.3 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

carsonbot · 2023-04-24T21:48:42Z

Hey!

Thanks for your PR. You are targeting branch "6.3" but it seems your PR description refers to branch "6.3 for features / 5.4 or 6.2 for bug fixes".
Could you update the PR description or change target branch? This helps core maintainers a lot.

Cheers!

Carsonbot

homersimpsons · 2023-04-24T22:02:16Z

Test failure in "Unit Tests / Unit Tests (8.1, low-deps) (pull_request)" is not because of this Pull Request
Test failure in "continuous-integration/appveyor/pr" is not because of this Pull Request
~~Where am I supposed to add the code sample ?~~ I added a code sample to this Pull Request description

homersimpsons · 2023-05-19T16:20:57Z

I just rebased this Pull Request to latest upstream changes, it is ready for review.

homersimpsons · 2023-05-25T08:01:47Z

@stof Can you review this please ?

Note: Sorry for the ping, but it seems you reviewed another PR about ExpressionLanguage and it looks like fabbot is not assigning anyone (is it supposed to?).

homersimpsons · 2023-06-27T23:48:38Z

@fabpot Is there any chance you could assign someone to my PR ? Or tell me what I am missing ?

Note: Sorry for the ping but I still have no human feedback while my PR is ready for review.

homersimpsons · 2023-08-05T18:18:03Z

Psalm reports the method as PossiblyUnusedMethod. In fact it is not used by any internal API as the goal is to expose it as a public API.

I could not find any @psalm-api in the codebase so I don't know what is the good practice in symfony for this error.

fancyweb · 2023-08-08T12:54:11Z

It looks like your use case sits between lint() and parse(). A lint() that returns, or a parse that doesn't validate the variables 🤷‍♂️ I'm not sure adding a third method is the good move 🤔

Maybe we could "change" lint() return type (since it's void) and starts returning the node?
Or we could deprecate lint() and add a third argument to parse() directly? Maybe a bit mask of what the parse should check..
WDYT @nicolas-grekas?

fabpot · 2024-02-06T10:53:39Z

See #53806 for an alternative implementation.

fabpot · 2024-02-06T15:33:03Z

Closing in favor of #53806

…arsing/linting methods (fabpot) This PR was merged into the 7.1 branch. Discussion ---------- [ExpressionLanguage] Add more configurability to the parsing/linting methods | Q | A | ------------- | --- | Branch? | 7.1 | Bug fix? | no | New feature? | yes | Deprecations? | yes | Issues | Fixes #50144 | License | MIT When linting/parsing an expression, two kinds of errors can be thrown: a syntax error (for which the parser cannot recover) or an unknown variable/function error (which does not block the parser). When linting an expression, currently you can ignore unknown variables by passing `null` instead of the valid variable names to `lint()` or `parse()`, but you cannot ignore unknown functions. For some use cases, it might be needed to just validate the syntax. This PR allows developers to ignore functions and/or variables the "proper way" with flags as a new argument to these methods: ```php $parser->lint($expr, flags: Parser::IGNORE_UNKNOWN_FUNCTIONS | Parser::IGNORE_UNKNOWN_VARIABLES); $parser->parse($expr, flags: Parser::IGNORE_UNKNOWN_FUNCTIONS | Parser::IGNORE_UNKNOWN_VARIABLES); ``` Passing `null` to the `$names` argument is deprecated: **Before**: ```php $parser->lint($expr, null); ``` **After**: ```php $parser->lint($expr, flags: Parser::IGNORE_UNKNOWN_VARIABLES); ``` Commits ------- c6182c0 [ExpressionLanguage] Add more configurability to the parsing/linting methods

carsonbot added Status: Needs Work ExpressionLanguage Feature labels Apr 24, 2023

carsonbot added this to the 6.3 milestone Apr 24, 2023

carsonbot changed the title ~~[WIP] [ExpressionLanguage] Add Parser->parseWithoutContext~~ [ExpressionLanguage] [WIP] Add Parser->parseWithoutContext Apr 24, 2023

homersimpsons force-pushed the feature/expression-language-parse-without-context branch 2 times, most recently from cf5cb7f to a2ca917 Compare April 24, 2023 21:52

homersimpsons changed the title ~~[ExpressionLanguage] [WIP] Add Parser->parseWithoutContext~~ [WIP] [ExpressionLanguage] Add Parser->parseWithoutContext Apr 24, 2023

homersimpsons mentioned this pull request May 9, 2023

📝 Document Parser->parseWithoutContext symfony/symfony-docs#18298

Closed

homersimpsons changed the title ~~[WIP] [ExpressionLanguage] Add Parser->parseWithoutContext~~ [ExpressionLanguage] Add Parser->parseWithoutContext May 9, 2023

homersimpsons force-pushed the feature/expression-language-parse-without-context branch from a2ca917 to b58cff5 Compare May 19, 2023 16:14

nicolas-grekas modified the milestones: 6.3, 6.4 May 23, 2023

[ExpressionLanguage] Add Parser->parseWithoutContext

15ce692

homersimpsons force-pushed the feature/expression-language-parse-without-context branch from b58cff5 to 15ce692 Compare August 5, 2023 17:49

nicolas-grekas modified the milestones: 6.4, 7.1 Nov 15, 2023

fabpot mentioned this pull request Feb 6, 2024

[ExpressionLanguage] Add more configurability to the parsing/linting methods #53806

Merged

fabpot closed this Feb 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

[ExpressionLanguage] Add `Parser->parseWithoutContext` #50144

[ExpressionLanguage] Add `Parser->parseWithoutContext` #50144

Uh oh!

homersimpsons commented Apr 24, 2023 •

edited

Loading

Uh oh!

carsonbot commented Apr 24, 2023

Uh oh!

carsonbot commented Apr 24, 2023

Uh oh!

homersimpsons commented Apr 24, 2023 •

edited

Loading

Uh oh!

homersimpsons commented May 19, 2023

Uh oh!

homersimpsons commented May 25, 2023

Uh oh!

homersimpsons commented Jun 27, 2023

Uh oh!

homersimpsons commented Aug 5, 2023

Uh oh!

fancyweb commented Aug 8, 2023

Uh oh!

fabpot commented Feb 6, 2024

Uh oh!

fabpot commented Feb 6, 2024

Uh oh!

Uh oh!

Uh oh!

[ExpressionLanguage] Add Parser->parseWithoutContext #50144

[ExpressionLanguage] Add Parser->parseWithoutContext #50144

Uh oh!

Conversation

homersimpsons commented Apr 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code snippet

Uh oh!

carsonbot commented Apr 24, 2023

Uh oh!

carsonbot commented Apr 24, 2023

Uh oh!

homersimpsons commented Apr 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

homersimpsons commented May 19, 2023

Uh oh!

homersimpsons commented May 25, 2023

Uh oh!

homersimpsons commented Jun 27, 2023

Uh oh!

homersimpsons commented Aug 5, 2023

Uh oh!

fancyweb commented Aug 8, 2023

Uh oh!

fabpot commented Feb 6, 2024

Uh oh!

fabpot commented Feb 6, 2024

Uh oh!

Uh oh!

[ExpressionLanguage] Add `Parser->parseWithoutContext` #50144

[ExpressionLanguage] Add `Parser->parseWithoutContext` #50144

homersimpsons commented Apr 24, 2023 •

edited

Loading

homersimpsons commented Apr 24, 2023 •

edited

Loading