Show inlay hints when irregular event property names call for non-obvious syntax

[nblumhardt]

Seq places no constraints on what characters can appear in an event property name. For example, Environment, deployment.environment, deployment environment, and 🤠 are all valid event property names.

Seq does however place constraints on what names are valid to use as-is in searches and queries. For example,

Environment = 'Staging'

is a valid query language filter, but:

deployment environment = 'Staging'

is not, because spaces cannot appear in identifiers.

This gets a little trickier when identifiers are snippets of apparently valid syntax; for example:

deployment.environment = 'Staging'

appears to be a valid filter - and it is - but rather than test the value of a property called deployment.environment, the filter checks the environment sub-property of the deployment property, which is a subtle distinction to communicate.

The user typing this probably means:

@Properties['deployment.environment'] = 'Staging'

In 2023.2, rather than force users to find this out through trial and error, any property whose name is not valid query language syntax will be accompanied by an inlay hint, showing the full syntax for the property:

It's not critical that the entire hint is shown; it may be trimmed if it overflows into the property name. The important thing is to signal to the user that a property requires special handling.

Seq will continue to automatically use the correct escaping when generating filters through the tick/cross menu.