Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add network support via fetch() #724

Merged
merged 15 commits into from Nov 8, 2023
Merged

Add network support via fetch() #724

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
2c7b1a7
Enable network support via js_module_onMessage and fetch()
adamziel Oct 25, 2023
76790ad
Filter proxy domains more explicitly to ensure fonts are supported an…
adamziel Oct 25, 2023
a856ed4
Document all the changes
adamziel Oct 25, 2023
e47f358
Rebuild web PHP releases
adamziel Oct 25, 2023
ed77992
Add a Blueprint option to disable networking
adamziel Nov 6, 2023
dd0c57b
Document the `features` option
adamziel Nov 6, 2023
ed1622d
Unit test the request handler
adamziel Nov 6, 2023
729bfb5
Don't stringify/reassemble fetch but use the original object instead
adamziel Nov 6, 2023
3858cfd
Document how the response body is protected from malicious headers
adamziel Nov 6, 2023
4602f6e
Fix JS-ism
adamziel Nov 6, 2023
57deb94
Make the response storing code clearer
adamziel Nov 6, 2023
82893b1
Filter out certain headers in the get_request_headers function
adamziel Nov 6, 2023
91a0733
Merge branch 'trunk' into add/network-support
adamziel Nov 6, 2023
a730bf9
Adjust the type signature of MessageListener
adamziel Nov 6, 2023
9dede92
Only set up the Fetch network transport if the networking feature is …
adamziel Nov 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/docs/site/docs/08-query-api/01-index.md
View file
Open in desktop
Expand Up @@ -24,8 +24,9 @@ You can go ahead and try it out. The Playground will automatically install the t
| Option | Default Value | Description |
| ---------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `php` | `8.0` | Loads the specified PHP version. Supported values: `5.6`, `7.0`, `7.1`, `7.2`, `7.3`, `7.4`, `8.0`, `8.1`, `8.2`, `latest` |
| `wp` | `latest` | Loads the specified WordPress version. Supported values: `5.9`, `6.0`, `6.1`, `6.2`, `6.3`, `latest`, `nightly`, `beta` |
| `wp` | `latest` | Loads the specified WordPress version. Supported values: `5.9`, `6.0`, `6.1`, `6.2`, `6.3`, `latest`, `nightly`, `beta` |
| `php-extension-bundle` | | Loads a bundle of PHP extensions. Supported bundles: `kitchen-sink` (for gd, mbstring, iconv, libxml, xml, dom, simplexml, xmlreader, xmlwriter) |
| `networking` | `yes` or `no` | Enables or disables the networking support for Playground. Defaults to `yes` |
| `plugin` | | Installs the specified plugin. Use the plugin name from the plugins directory URL, e.g. for a URL like `https://wordpress.org/plugins/wp-lazy-loading/`, the plugin name would be `wp-lazy-loading`. You can pre-install multiple plugins by saying `plugin=coblocks&plugin=wp-lazy-loading&…`. Installing a plugin automatically logs the user in as an admin |
| `theme` | | Installs the specified theme. Use the theme name from the themes directory URL, e.g. for a URL like `https://wordpress.org/themes/disco/`, the theme name would be `disco`. Installing a theme automatically logs the user in as an admin |
| `url` | `/wp-admin/` | Load the specified initial page displaying WordPress |
Expand Down
9 changes: 9 additions & 0 deletions packages/docs/site/docs/09-blueprints-api/03-data-format.md
View file
Open in desktop
Expand Up @@ -22,6 +22,9 @@ import BlueprintExample from '@site/src/components/Blueprints/BlueprintExample.m
"wp": "5.9"
},
"phpExtensionBundles": ["kitchen-sink"],
"features": {
"networking": true
},
"steps": [
{
"step": "login",
Expand Down Expand Up @@ -55,3 +58,9 @@ The `preferredVersions` property, unsurprisingly, declares the preferred of PHP
The `phpExtensionBundles` property is an array of PHP extension bundles to load. The following bundles are supported:

- `kitchen-sink`: Installs `gd`, `mbstring`, `iconv`, `libxml`, `xml`, `dom`, `simplexml`, `xmlreader`, `xmlwriter`

## Features

The `features` property is used to enable or disable certain features of the Playground. It can contain the following properties:

- `networking`: Defaults to `true`. Enables or disables the networking support for Playground. If enabled, `wp_safe_remote_get` and similar WordPress functions will actually use `fetch()` to make HTTP requests. If disabled, they will immediately fail instead.
2 changes: 1 addition & 1 deletion packages/php-wasm/universal/src/lib/universal-php.ts
View file
Open in desktop
Expand Up @@ -416,7 +416,7 @@ export interface IsomorphicLocalPHP extends RequestHandler {

export type MessageListener = (
data: string
) => Promise<string> | Promise<Uint8Array> | Promise<void> | string | void;
) => Promise<string | Uint8Array | void> | string | void;
interface EventEmitter {
on(event: string, listener: (...args: any[]) => void): this;
emit(event: string, ...args: any[]): boolean;
Expand Down