fix: [WIP] unstable term cursor identical names

[mohjak]

What does this implement/fix? Explain your changes.

This is mainly stabilizing the term cursor when there are more than one term have the same term name.

• Add test that queries for multiple terms with the same name, ordered by name, then paginates and ensures results are as expected (see: https://github.com/wp-graphql/wp-graphql/pull/2930/files#diff-251ad1643c2ec958fb156aeb6b933943b46b1a883c7db694082446f91c2908b4R761)

Does this close any currently open issues?

relates to #2926 but it doesn't close it because there are 2 failed tests after applying the changes:

---------
1) MenuConnectionQueriesTest: Query with first and last
 Test  tests/wpunit/MenuConnectionQueriesTest.php:testQueryWithFirstAndLast
Failed asserting that two arrays are identical.
- Expected | + Actual
@@ @@
Array &0 (
-    'databaseId' => 153
+    'databaseId' => 155
)
#1  /var/www/html/wp-content/plugins/wp-graphql/tests/wpunit/MenuConnectionQueriesTest.php:354
#2  /var/www/html/wp-content/plugins/wp-graphql/vendor/bin/codecept:120

---------
2) TermObjectConnectionQueriesTest: Query with first and last
 Test  tests/wpunit/TermObjectConnectionQueriesTest.php:testQueryWithFirstAndLast
Failed asserting that two arrays are identical.
- Expected | + Actual
@@ @@
Array &0 (
-    'databaseId' => 299
+    'databaseId' => 301
)
#1  /var/www/html/wp-content/plugins/wp-graphql/tests/wpunit/TermObjectConnectionQueriesTest.php:332
#2  /var/www/html/wp-content/plugins/wp-graphql/vendor/bin/codecept:120

EDIT:

closes: #2926

The above tests have been fixed. see: #2930 (comment)

[codeclimate]

Code Climate has analyzed commit dfca9ab and detected 0 issues on this pull request.

View more on Code Climate.

[jasonbahl]

@mohjak I've confirmed that the changes work when testing locally.

I'll take a look at the menu tests 👀 and also ensure we have proper tests for term queries to account for these changes.

[jasonbahl]

@mohjak I pulled down your branch to see if I could diagnose why the 2 tests are failing.

It seems that this change is causing the tests to fail.

I added it back and the tests pass.

---

Below is an overview of the behavior I'm experiencing now.

Similar to your scenario, I've created a category with several child categories, and I've given all the children the same name "Child 1"

BEFORE:

Query for the first 3 categories that are children of category:70 (works roughly as expected. . .I get 3 of the child categories of category:70)

Use the cursor for category:77 as the value for the after cursor.

Expectation: see 3 more categories that are children of category:70

Actual: No results:

AFTER:

Now, with this PR (your changes + my change to add back the previously removed code)...

Query for the first 3 categories that are children of category:70 (I get 3 of the child categories of category:70)

Now, we can take the cursor for category:80 and use it as the after cursor:

Expectation: See categories 79, 78, 77

Actual: see categories 79, 78, 77 ✅

[jasonbahl]

@mohjak I pushed some commits to fix a broken test unrelated to this feature (the akismet plugin had a name change that was causing some plugin query tests to fail)

If you could confirm that this fixes the issue(s) you were running into, that would be great 🙏🏻