Enhancement/328 Sophi Overrides API Integration

[faisal-alvi]

Description of the Change

• Integrated the Sophi Override functions (add, remove, replace, ban) into the existing Site Automation block.
• The existing block will not break after this integration because the final code snippet of the block does not change! (i.e. nothing to worry about the migration of existing block).

Closes #328 & Closes #216

Alternate Designs

List view:

image link

---

The 4 Override buttons:

image link

---

Add/Replace Override Popup:

image link

---

Out/Ban Override Popup:

image link

---

Settings page:

image link

---

When posts are received from the Sophi server, but none of them exist in the WordPress site:

image link

---

When posts are received from the Sophi server, but none of them exist in the WordPress site:

image link

Possible Drawbacks

Verification Process

1. Make sure you have configured proper credential details on the Sophi settings page.
2. Add a Site Automation block to a page.
3. Fill in "Page name" and "Widget name" in the block settings on the right sidebar.
4. See the curated post list, it should appear.
5. Select any individual post item and see it has its own settings (Blockcontrol) at the top.
6. Click the gear icon, and a popup should appear.
7. Perform Add/Replace/Remove/Ban actions by filling out the form.
8. For add/replace, the result will appear quickly.
9. But for remove/ban, the Sophi server will take some time to reflect.

Checklist:

• I have read the CONTRIBUTING document.
• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my change.
• All new and existing tests passed.

Changelog Entry

Added - Override feature to the Sophi Site Automation Block.
Added - ??? hook to allow for code-based Override feature integrations.
Changed - Sophi Site Automation Block from a server-side-rendered custom block to a nested block.

Credits

Props @jeffpaul @fabiankaegy @faisal-alvi

[jeffpaul]

Pinging @fabiankaegy for initial code review / feedback on approach here to help guide any iterations or strong recommendations on how best to tweak approach here for an optimal editorial UX.

[fabiankaegy]

if you don't care about the returned value you can also use .forEach here. It doesn't care about a return value

[jeffpaul]

@faisal-alvi for the nested block override buttons, please ensure they're labeled Add, Replace, Remove, and Ban (so update Update to Replace and Trash to Ban).

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
280 Code Smells

No Coverage information
0.9% Duplication