Replace Mock API responses with pre_http_request filter by galbus · Pull Request #474 · beyondwords-io/wordpress-plugin

galbus · 2025-12-15T11:10:57Z

This pull request refactors the test and development environment setup to remove the dependency on the external Mockoon mock API server. Instead, it enables a built-in mock API mode via the BEYONDWORDS_MOCK_API configuration, updates related documentation and scripts, and improves plugin installation in CI. The changes streamline local and CI testing, making the workflow more reliable and easier to maintain.

Test and Environment Configuration:

Replaces usage of the BEYONDWORDS_API_URL environment/config variable with BEYONDWORDS_MOCK_API, enabling a built-in mock API mode for tests and local development (.github/workflows/main.yml, .wp-env.json, .wp-env.override.json.example, doc/running-tests.md, cypress.env.json.example) [1] [2] [3] [4] [5].
Removes Mockoon CLI from CI workflows and project dependencies, including related scripts and documentation references (.github/workflows/main.yml, package.json, doc/running-tests.md) [1] [2] [3] [4] [5].

CI/CD Workflow Improvements:

Updates plugin installation steps in CI to handle both single-file and multi-file plugins, and ensures the mock REST API plugin is installed and activated for tests (.github/workflows/main.yml) [1] [2] [3].
Sets the correct environment variables for PHPUnit and Cypress, and updates the default API URL for Cypress tests (.github/workflows/main.yml, cypress.env.json.example) [1] [2] [3].

Test Code and Plugin Activation:

Ensures the beyondwords-mock-rest-api-responses plugin is activated during Cypress and PHPUnit test setup (cypress.config.js, .github/workflows/main.yml) [1] [2] [3].
Updates a Cypress test comment to reflect the new mock API behavior (tests/cypress/e2e/settings/credentials/credentials.cy.js).

Code Quality and Maintainability:

Refactors category matching logic in src/Component/Post/GenerateAudio/index.js for clarity and maintainability.

linear · 2025-12-15T11:11:01Z

S-6180 Replace Mock API responses with pre_http_request filter

…ttp_request-filter

Copilot

Pull request overview

This PR standardizes test-time API mocking by replacing the Mockoon-based mock server with a WordPress fixture plugin that intercepts BeyondWords API calls via the pre_http_request filter, enabled by the BEYONDWORDS_MOCK_API flag across CI and local environments.

Changes:

Enable BEYONDWORDS_MOCK_API across PHPUnit, wp-env, and GitHub Actions; remove Mockoon CLI usage.
Add a fixture plugin (beyondwords-mock-rest-api-responses) to mock BeyondWords REST API responses during tests.
Update PHPUnit/Cypress setup to load/activate the mock plugin and adjust tests to use Environment::getApiUrl().

Reviewed changes

Copilot reviewed 13 out of 15 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
yarn.lock	Removes Mockoon CLI dependency tree and related packages.
tests/phpunit/bootstrap.php	Defines `BEYONDWORDS_MOCK_API` before WP boots and loads the mock plugin after WP bootstrap.
tests/phpunit/Core/EnvironmentTest.php	Updates API URL expectation to match `Environment::getApiUrl()` behavior.
tests/phpunit/Core/ApiClientTest.php	Uses `Environment::getApiUrl()` instead of a global constant.
tests/fixtures/wp-content/plugins/beyondwords-mock-rest-api-responses/mock-rest-api-responses.php	Adds the WP-based mock API implementation using `pre_http_request`.
tests/fixtures/wp-content/plugins/beyondwords-mock-rest-api-responses/languages.json	Adds a language fixture dataset used by the mock plugin.
tests/cypress/e2e/settings/credentials/credentials.cy.js	Updates comment to refer to the new mock API approach.
package.json	Removes Mockoon CLI devDependency and script.
doc/running-tests.md	Updates local instructions to enable mock mode via `.wp-env.override.json`.
cypress.env.json.example	Updates example `apiUrl` value.
cypress.config.js	Activates the mock plugin during Cypress DB setup.
.wp-env.override.json.example	Adds `BEYONDWORDS_MOCK_API` config example.
.wp-env.json	Enables mock mode for wp-env test config.
.github/workflows/main.yml	Removes Mockoon startup, enables mock mode in wp-config, installs/activates the mock plugin, and adjusts Cypress env wiring.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

.../fixtures/wp-content/plugins/beyondwords-mock-rest-api-responses/mock-rest-api-responses.php

tests/cypress/e2e/settings/credentials/credentials.cy.js

.github/workflows/main.yml

tests/phpunit/bootstrap.php

Co-authored-by: Copilot <[email protected]>

Copilot

Pull request overview

Copilot reviewed 13 out of 15 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

tests/phpunit/bootstrap.php

Copilot

Pull request overview

Copilot reviewed 13 out of 15 changed files in this pull request and generated 7 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

doc/running-tests.md

.../fixtures/wp-content/plugins/beyondwords-mock-rest-api-responses/mock-rest-api-responses.php

cypress.config.js

.github/workflows/main.yml

Co-authored-by: Copilot <[email protected]>

Copilot

Pull request overview

Copilot reviewed 13 out of 15 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

.../fixtures/wp-content/plugins/beyondwords-mock-rest-api-responses/mock-rest-api-responses.php

tests/phpunit/Core/EnvironmentTest.php

Co-authored-by: Copilot <[email protected]>

Copilot

Pull request overview

Copilot reviewed 14 out of 16 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

.../fixtures/wp-content/plugins/beyondwords-mock-rest-api-responses/mock-rest-api-responses.php

tests/fixtures/wp-content/plugins/beyondwords-mock-rest-api-responses/languages.json

Copilot

Pull request overview

Copilot reviewed 14 out of 16 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

tests/phpunit/Core/EnvironmentTest.php

.../fixtures/wp-content/plugins/beyondwords-mock-rest-api-responses/mock-rest-api-responses.php

Replace Mock API responses with pre_http_request filter

5df298c

galbus self-assigned this Dec 15, 2025

galbus added enhancement php Pull requests that update Php code labels Dec 15, 2025

galbus temporarily deployed to production December 15, 2025 11:11 — with GitHub Actions Inactive

galbus had a problem deploying to production December 15, 2025 11:11 — with GitHub Actions Failure

galbus temporarily deployed to production December 15, 2025 11:12 — with GitHub Actions Inactive

Add plugin file to git

dbf44b6

galbus temporarily deployed to production December 15, 2025 11:36 — with GitHub Actions Inactive

galbus temporarily deployed to production December 15, 2025 11:37 — with GitHub Actions Inactive

galbus had a problem deploying to production December 15, 2025 11:39 — with GitHub Actions Failure

galbus added 2 commits December 15, 2025 11:53

Remove Mockoon from deps and docs

9c72f31

Mock language response fixes

4e59fed

galbus temporarily deployed to production December 15, 2025 12:13 — with GitHub Actions Inactive

galbus temporarily deployed to production December 15, 2025 12:14 — with GitHub Actions Inactive

galbus had a problem deploying to production December 15, 2025 12:16 — with GitHub Actions Failure

galbus added the wip Work in Progress label Dec 15, 2025

galbus temporarily deployed to production December 15, 2025 12:50 — with GitHub Actions Inactive

galbus had a problem deploying to production February 28, 2026 12:33 — with GitHub Actions Failure

galbus added 5 commits February 28, 2026 13:40

Merge branch 'main' into s-6180-replace-mock-api-responses-with-pre_h…

c126835

…ttp_request-filter

Merge branch 'main' into s-6180-replace-mock-api-responses-with-pre_h…

0dc2d46

…ttp_request-filter

Merge branch 'main' into s-6180-replace-mock-api-responses-with-pre_h…

0dd4539

…ttp_request-filter

fix: completely remove Mockoon and all API refs

a7a044e

fix: remove stray BEYONDWORDS_API_URL refs

57c015b

Copilot AI reviewed Mar 7, 2026

View reviewed changes

galbus and others added 3 commits March 7, 2026 20:02

Apply suggestions from code review

a6f5b24

Co-authored-by: Copilot <[email protected]>

fix: code review feednback

536bc3f

test: update unit test to match updated mock

966cd5e

Copilot AI reviewed Mar 7, 2026

View reviewed changes

tests/phpunit/bootstrap.php Show resolved Hide resolved

fix: empty not false ===

14c7dc0

Copilot AI reviewed Mar 7, 2026

View reviewed changes

galbus and others added 4 commits March 7, 2026 21:57

Update doc/running-tests.md

dc99600

Co-authored-by: Copilot <[email protected]>

Apply suggestions from code review

0355f68

Co-authored-by: Copilot <[email protected]>

fix: code review feedback

83a2996

Merge

e8e55e0

Copilot AI reviewed Mar 7, 2026

View reviewed changes

.../fixtures/wp-content/plugins/beyondwords-mock-rest-api-responses/mock-rest-api-responses.php Show resolved Hide resolved

tests/phpunit/Core/EnvironmentTest.php Outdated Show resolved Hide resolved

galbus and others added 4 commits March 7, 2026 23:12

fix: array guard

512c11d

Update tests/phpunit/Core/EnvironmentTest.php

a307547

Co-authored-by: Copilot <[email protected]>

fix: coalesce

744b586

Merge

7d1bdad

Copilot AI reviewed Mar 8, 2026

View reviewed changes

.../fixtures/wp-content/plugins/beyondwords-mock-rest-api-responses/mock-rest-api-responses.php Show resolved Hide resolved

tests/fixtures/wp-content/plugins/beyondwords-mock-rest-api-responses/languages.json Outdated Show resolved Hide resolved

fix: review feedback for JSON fixture and preempt guard

63b05d3

Copilot AI reviewed Mar 8, 2026

View reviewed changes

tests/phpunit/Core/EnvironmentTest.php Outdated Show resolved Hide resolved

.../fixtures/wp-content/plugins/beyondwords-mock-rest-api-responses/mock-rest-api-responses.php Show resolved Hide resolved

galbus added 4 commits March 9, 2026 06:43

fix: strlen guard for BEYONDWORDS_API_URL

4e81692

chore: release notes

63e4306

chore: revert changes to GenerateAudio in this branch

be56060

chore: revert changes to GenerateAudio in this branch

ab9c281

nklhtv approved these changes Mar 9, 2026

View reviewed changes

Conversation

galbus commented Dec 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

linear bot commented Dec 15, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

galbus commented Dec 15, 2025 •

edited

Loading