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

Adds filter to monorepo path #25443

Merged
merged 2 commits into from
Aug 12, 2022
Merged

Adds filter to monorepo path #25443

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
432df36
Adds filter to monorepo path for running development plugin outside d…
creativecoder Aug 11, 2022
78b7a96
Add docblock for filter
creativecoder Aug 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion tools/docker/mu-plugins/01-monorepo.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,14 @@ class Monorepo {
* Class constructor.
*/
public function __construct() {
$this->monorepo = '/usr/local/src/jetpack-monorepo/';
/**
* Filter the monorepo path for development environments.
*
* @since $$next-version$$
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this will ever increment since it isn't in a project, but we can remove it later. Not going to block you for it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to know!

*
* @param string $path Monorepo file path.
*/
$this->monorepo = apply_filters( 'jetpack_monorepo_path', '/usr/local/src/jetpack-monorepo/' );
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was dealing with the symlink issue on local environment without Docker.

What about defining JETPACK_MONOREPO_PATH? So we just define it directly in the wp-config.php file.

$this->monorepo = defined( 'JETPACK_MONOREPO_PATH' ) ? JETPACK_MONOREPO_PATH : '/usr/local/src/jetpack-monorepo/';

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no preference between a filter vs a constant. I find I put a lot of local dev overrides in a 0-local.php mu-plugin file, so a filter fits in in well here.

But a constant makes a lot of sense, as the monorepo path isn't something that's likely to change dynamically.

For reference, here's some of the content of my 0-local.php mu-plugin file:

// Register theme project directories (that are symlinked to wp-content/).
register_theme_directory( 'wpcom-themes' );
register_theme_directory( 'theme-experiments' );

// Compensate for symlinked wpcomsh mu-plugin.
add_action( 'plugins_url', function( $url ) {
	if ( false !== strpos( $url, 'wpcomsh' ) ) {
		return str_replace( '/plugins/Users/Grant/Automattic/Sites', '/mu-plugins', $url );
	}

	return $url;
} );

// Run jetpack monorepo outside a docker container.
add_filter( 'jetpack_monorepo_path', function( $path ) {
	return '/Users/Grant/Automattic/Sites/jetpack/';
} );

// Fix an issue when running WordPress behind a reverse proxy,
// such as jurassic.tube tunneling for Jetpack development.
add_filter( 'redirect_canonical', function( $redirect_url, $requested_url ) {
	$redirect_host  = wp_parse_url( $redirect_url, PHP_URL_HOST );
	$requested_host = wp_parse_url( $requested_url, PHP_URL_HOST );

	if (
		// Is redirecting to the reverse proxy host
		$_SERVER['HTTP_X_FORWARDED_HOST'] === $redirect_host &&
		// and is requesting the local (valet) domain
		$_SERVER['HTTP_HOST'] === $requested_host
	) {
		return false;
	}

	return $redirect_url;
}, 10, 2 );

$this->plugins = $this->monorepo . 'projects/plugins/';
$this->packages = $this->monorepo . 'projects/packages/';
}
Expand Down
Loading