Skip to content

fix(migration): reload site nginx after its containers are recreated #1937

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

Open
mrrobot47 wants to merge 2 commits into
base: develop
Choose a base branch
from
+83 −4
Open

fix(migration): reload site nginx after its containers are recreated #1937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af2bd2c
fix(migration): reload site nginx after its containers are recreated
mrrobot47 Sep 25, 2026
0aa9c18
fix(migration): reload site nginx after a rolled-back site migration
mrrobot47 Sep 25, 2026
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
34 changes: 34 additions & 0 deletions php/EE/Migration/Containers.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,8 +312,22 @@ public static function migrate_site_containers( $updated_images ) {

$ee_site_object = SiteContainers::get_site_object( $site['site_type'] );

// The support project's php shares the site's php alias, and nginx resolves it only at (re)load.
$reload_nginx = in_array( $site['site_type'], [ 'wp', 'php' ], true );

if ( $site['site_enabled'] ) {

if ( $reload_nginx ) {
// Undone last for this site: after the old containers are back and the support project is gone.
self::$rsp->add_step(
sprintf( 'reload-site-nginx-on-rollback-%s', $site['site_url'] ),
function () {},
'EE\Migration\SiteContainers::reload_site_nginx',
null,
[ $site['site_url'], $site['site_fs_path'] ]
);
}

/**
* Enable support containers.
*/
Expand All @@ -332,6 +346,16 @@ public static function migrate_site_containers( $updated_images ) {
[ $site ],
[ $site, $ee_site_object ]
);

if ( $reload_nginx ) {
self::$rsp->add_step(
sprintf( 'reload-support-nginx-%s', $site['site_url'] ),
'EE\Migration\SiteContainers::reload_support_nginx',
null,
[ $site['site_url'], $site['site_fs_path'] ],
null
);
}
}

self::$rsp->add_step(
Expand Down Expand Up @@ -369,6 +393,16 @@ public static function migrate_site_containers( $updated_images ) {
[ $site['site_url'], $site['site_fs_path'] ],
[ $site['site_url'], $site['site_fs_path'] ]
);

if ( $reload_nginx ) {
self::$rsp->add_step(
sprintf( 'reload-site-nginx-%s', $site['site_url'] ),
'EE\Migration\SiteContainers::reload_site_nginx',
null,
[ $site['site_url'], $site['site_fs_path'] ],
null
);
}
}
}
}
Expand Down
53 changes: 49 additions & 4 deletions php/EE/Migration/SiteContainers.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,42 @@ public static function reload_nginx( $site_fs_path ) {
}
}

/**
* Reload site's nginx after its support containers are removed, so it drops the support php's IP.
* A failure only warns: the site works, nginx just keeps retrying the dead peer.
*
* @param string $site_url Site URL.
* @param string $site_fs_path Directory containing site's docker-compose.yml.
*/
public static function reload_site_nginx( $site_url, $site_fs_path ) {
EE::debug( sprintf( 'Start reloading nginx of %s', $site_url ) );

try {
self::reload_nginx( $site_fs_path );
} catch ( \Exception $e ) {
EE::warning( sprintf( 'Could not reload nginx of %1$s after recreating its containers. Some requests may take ~3 s until you run `ee site reload %1$s --nginx`.', $site_url ) );

return;
}

EE::debug( sprintf( 'Complete reloading nginx of %s', $site_url ) );
}

/**
* Reload the support nginx after the site's containers are removed, so it drops the old php's IP.
* Best effort: the support nginx only serves until the site's containers are back.
*
* @param string $site_url Site URL.
* @param string $site_fs_path Directory containing site's docker-compose.yml.
*/
public static function reload_support_nginx( $site_url, $site_fs_path ) {
$command = sprintf( "docker-compose --project-name=%s exec nginx sh -c 'nginx -t && nginx -s reload'", self::get_support_project_name( $site_url ) );

if ( ! chdir( $site_fs_path ) || ! EE::exec( $command ) ) {
EE::debug( sprintf( 'Could not reload support nginx of %s', $site_url ) );
}
}

/**
* Function to reload site's php.
*
Expand Down Expand Up @@ -262,8 +298,7 @@ public static function docker_compose_pull( $site_fs_path ) {
public static function enable_support_containers( $site_url, $site_fs_path ) {
EE::debug( sprintf( 'Start enabling containers for %s', $site_url ) );

$site_name = str_replace( '.', '', $site_url );
$project_name = sprintf( 'update-ee-%s', $site_name );
$project_name = self::get_support_project_name( $site_url );

if ( ! chdir( $site_fs_path ) ) {
throw new \Exception( sprintf( '%s does not exist.', $site_fs_path ) );
Expand All @@ -288,8 +323,7 @@ public static function enable_support_containers( $site_url, $site_fs_path ) {
public static function disable_support_containers( $site_url, $site_fs_path ) {
EE::debug( sprintf( 'Start disabling support containers for %s', $site_url ) );

$site_name = str_replace( '.', '', $site_url );
$project_name = sprintf( 'update-ee-%s', $site_name );
$project_name = self::get_support_project_name( $site_url );

if ( ! chdir( $site_fs_path ) ) {
throw new \Exception( sprintf( '%s does not exist.', $site_fs_path ) );
Expand All @@ -302,4 +336,15 @@ public static function disable_support_containers( $site_url, $site_fs_path ) {

EE::debug( sprintf( 'Complete disabling support containers for %s', $site_url ) );
}

/**
* Compose project name of a site's support containers.
*
* @param string $site_url Site URL.
*
* @return string
*/
private static function get_support_project_name( $site_url ) {
return sprintf( 'update-ee-%s', str_replace( '.', '', $site_url ) );
}
}
Loading