SortOrder escaping bug

[oellan]

Expected Behavior

The method void org.neo4j.ogm.session.resolvePropertyAnnotations(Class, SortOrder) should escape the properties in the SortOrder object only once.

Current Behavior

The method void org.neo4j.ogm.session.resolvePropertyAnnotations(Class, SortOrder) is escaping the SortOrder's properties each time it is called.

Possible Solution

Create a private flag to check if the SortOrder's properties are already escaped.

Steps to Reproduce (for bugs)

Call any getAll() method from a session with a provided SortOrder instance with at least one property to sort.

Reference Stacktrace

org.neo4j.driver.v1.exceptions.ClientException: Invalid input 'n': expected '`', '.', whitespace, '(', node labels, '[', "=~", IN, STARTS, ENDS, CONTAINS, IS, '^', '*', '/', '%', '+', '-', '=', "<>", "!=", '<', '>', "<=", ">=", AND, XOR, OR, DESCENDING, DESC, ASCENDING, ASC, ',', SKIP, LIMIT, WHERE, LOAD CSV, FROM, INTO, START, MATCH, UNWIND, MERGE, CREATE GRAPH >>, CREATE >> GRAPH, CREATE GRAPH, CREATE, SET, DELETE GRAPHS, DELETE, REMOVE, FOREACH, WITH, CALL, PERSIST, RELOCATE, RETURN, SNAPSHOT, UNION, ';' or end of input (line 1, column 39 (offset: 38))
"MATCH (n:`Anime`) WITH n ORDER BY n.``name`` RETURN n, ID(n)"
                                       ^

Your Environment

• OGM Version used: 3.1.0
• Java Version used: 10
• Neo4J Version used: 3.5.5
• Bolt Driver Version used: 3.1.0
• Operating System and Version: Windows 10 (64 bits)
• Link to your project: none

[meistermeier]

Thanks for reporting this.
I tried to reproduce the problem but was not successful. Do you have any reference code/sample/snippet/test that will generate the wrong query?
There are tests for simple sorting like you described it in our code base e.g.

neo4j-ogm/test/src/test/java/org/neo4j/ogm/persistence/examples/music/MusicIntegrationTest.java

Line 279 in 8518856

public void shouldSortByDomainPropertyName() {

that do not show any problems even when I run this with Java 10.

[oellan]

Actually, I am reusing the same SortOder instance each time when I fetch nodes with getAll(). In the tests, a new SortOrder instance is created when the getAll() method is called. I think this is why you can't reproduce this bug with the test you provided above.

[meistermeier]

Great, now I can see your problem you have.