Update the wp-comments package to use the WP REST API directly

[michalczaplinski]

What:

Update the implementation of the wp-comments package to use the REST API directly.

Why:

The previous implementation has a problem with following redirects as outlined in the Feature Discussion: https://community.frontity.org/t/wordpress-comments-package/1267/53?u=mmczaplinski

How:

• Updating thewp-comments package to use the REST API directly
• Add the data returned by the REST API when POSTing a new comment directly to state.source.data and state.source.comment. This is handled inside of the submit() action.
• Store the validation errors returned from WordPress in the state. The REST API returns the validation errors for each of the fields in the comment. E.g. if you send a request with a malformed author_email
• Add a new type of data to @frontity/source
• Removing the query, route & link from the non-URL entities that are fetched from the REST API.

Also additionally:

• Add a new load-db.js script for local testing using the e2e testing system.
• It also includes some improvements to the e2e testing system (adding retries & migrating the plugins file and the wp-comments e2e test file to typescript)

Tasks:

• Code
• TSDocs
• TypeScript
• End to end tests
• Unit tests
• Update other packages
• Update community discussions https://community.frontity.org/t/wordpress-comments-package/1267/82
• Open an issue for this feature in the docs repo: https://github.com/frontity/docs/issues/174
• Add a changeset (with link to its Feature Discussion if it exists)

Unrelated Tasks

• TypeScript tests
• Update starter themes

[changeset-bot]

🦋 Changeset is good to go

Latest commit: 557b2f5

We got this.

This PR includes changesets to release 3 packages

Name	Type
@frontity/source	Minor
@frontity/wp-comments	Patch
@frontity/wp-source	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[michalczaplinski]

We are receiving same error on this PR as reported by @luisherranz previously in bradennapier/eslint-plus-action#45
Failed to generate URL to download artifact 😕

[michalczaplinski]

The e2e tests are failing on the previous version of WP - I will look into this, but in the meantime you can already review it @DAreRodz :)

[michalczaplinski]

More info on this: https://www.cypress.io/blog/2020/08/19/introducing-test-retries-in-cypress-5-0/

[michalczaplinski]

The e2e tests are failing on the previous version of WP - I will look into this, but in the meantime you can already review it @DAreRodz :)

The test failures were really weird and had multiple causes:

1. In WordPress 5.4 & 5.3, the default comment with ID == 1 that is present in the database (The one that starts with This is a test. If you want to get started with moderation... is not being returned from the REST API. You can fetch it using GET post/1/comments/1, but it's missing from the list of all comments in GET post/1/comments/! I

   I'm not quit sure why that is the case, but I've just worked around it by deleting the default comment and just adding my own to the database.

2. Another problem seems to be that the approved / hold status of the comments depends on some factors that we have not anticipated. In the e2e tests, when I submit a test comment, the same comment appeared to be approved in 5.4 but is hold in 5.5 !

   I have first tried to work around it by checking the WP version and basically check that: wpVersion < 5.5 ? "approved" : "hold". However, with some more testing it turns out that sometimes the same comment also gets stuck on hold in 5.4.
   My only conclusion is that the approve/hold status of the comments depends on some other factors that are hard to control like time since last posted a comment from a particular IP or that the classification is non-deterministic.

[DAreRodz]

It looks great, @michalczaplinski! 👌

[michalczaplinski]

I will merge this now, despite the eslint failure as I have no eslint issues locally so it was most likely just a problem with the github action.

Note that I have added the /* eslint-disable */ to silence the warnings as Luis has already implemented the TSDocs in another PR