Commit inicial, se subio el proyecto
This commit is contained in:
@@ -0,0 +1,68 @@
|
||||
<?php
|
||||
namespace AIOSEO\TableOfContents\Main\Migrations;
|
||||
|
||||
// Exit if accessed directly.
|
||||
if ( ! defined( 'ABSPATH' ) ) {
|
||||
exit;
|
||||
}
|
||||
|
||||
/**
|
||||
* Contract for a discrete, individually-logged migration.
|
||||
*
|
||||
* Migrations registered with the {@see MigrationRunner} are tracked by name in
|
||||
* the migration log option. The runner uses {@see self::verify()} as the source
|
||||
* of truth for completion — up()'s exit status is not trusted, because that's
|
||||
* the failure mode that historically left sites half-applied (the version flag
|
||||
* advanced even when the work hadn't actually landed).
|
||||
*
|
||||
* @since 202607
|
||||
*/
|
||||
interface Migration {
|
||||
/**
|
||||
* Stable identifier. Becomes the key in the migration log option.
|
||||
*
|
||||
* IMPORTANT: never rename after the migration has shipped — the runner
|
||||
* keys log entries off this string. A rename would cause the migration
|
||||
* to re-run on every site that already had it.
|
||||
*
|
||||
* Convention: snake_case verb_noun, no version suffix.
|
||||
*
|
||||
* @since 202607
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function name();
|
||||
|
||||
/**
|
||||
* Release this migration was introduced in. Diagnostic only.
|
||||
*
|
||||
* @since 202607
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function version();
|
||||
|
||||
/**
|
||||
* Perform the migration. Throw on hard failure — the runner catches and
|
||||
* logs as status = 0 so the migration is retried on the next request.
|
||||
*
|
||||
* Must be idempotent: the runner may invoke up() multiple times across
|
||||
* retries (e.g. when verify() returned false after a previous up()).
|
||||
*
|
||||
* @since 202607
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function up();
|
||||
|
||||
/**
|
||||
* Post-condition check. Returns true when the migration's intended state
|
||||
* is in place. Called BEFORE up() to short-circuit when already applied,
|
||||
* and AFTER up() to confirm success.
|
||||
*
|
||||
* @since 202607
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function verify();
|
||||
}
|
||||
@@ -0,0 +1,102 @@
|
||||
<?php
|
||||
namespace AIOSEO\TableOfContents\Main\Migrations;
|
||||
|
||||
// Exit if accessed directly.
|
||||
if ( ! defined( 'ABSPATH' ) ) {
|
||||
exit;
|
||||
}
|
||||
|
||||
/**
|
||||
* Wraps the `aioseo_table_of_contents_migrations_log` option that tracks
|
||||
* per-migration execution state for the {@see MigrationRunner}.
|
||||
*
|
||||
* The option is stored without autoload — healthy sites short-circuit on
|
||||
* `lastSchemaVersion === aioseoTableOfContents()->version` before the runner ever
|
||||
* reads the log, so paying autoload overhead on every request would be wasted
|
||||
* work.
|
||||
*
|
||||
* @since 202607
|
||||
*/
|
||||
class MigrationLog {
|
||||
/**
|
||||
* Option name. Per-plugin namespacing means addons can each own their own
|
||||
* log without colliding with the main plugin's entries.
|
||||
*
|
||||
* @since 202607
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $optionName = 'aioseo_table_of_contents_migrations_log';
|
||||
|
||||
/**
|
||||
* Per-request cache. The runner can call read() multiple times across
|
||||
* migrations within one request — no need to round-trip wp_options each
|
||||
* time.
|
||||
*
|
||||
* Null means "not loaded yet"; array (possibly empty) means "loaded".
|
||||
*
|
||||
* @since 202607
|
||||
*
|
||||
* @var array|null
|
||||
*/
|
||||
private $cache = null;
|
||||
|
||||
/**
|
||||
* Read the full log.
|
||||
*
|
||||
* @since 202607
|
||||
*
|
||||
* @return array Keyed by migration name. Empty array when the option does not exist.
|
||||
*/
|
||||
public function read() {
|
||||
if ( null !== $this->cache ) {
|
||||
return $this->cache;
|
||||
}
|
||||
|
||||
$raw = get_option( $this->optionName, '' );
|
||||
if ( empty( $raw ) ) {
|
||||
$this->cache = [];
|
||||
|
||||
return $this->cache;
|
||||
}
|
||||
|
||||
$decoded = json_decode( $raw, true );
|
||||
if ( ! is_array( $decoded ) ) {
|
||||
$this->cache = [];
|
||||
|
||||
return $this->cache;
|
||||
}
|
||||
|
||||
$this->cache = $decoded;
|
||||
|
||||
return $this->cache;
|
||||
}
|
||||
|
||||
/**
|
||||
* Write the full log.
|
||||
*
|
||||
* On first write the option is created with autoload disabled. Subsequent
|
||||
* writes preserve that flag automatically — WordPress's update_option()
|
||||
* does not change autoload on existing options.
|
||||
*
|
||||
* @since 202607
|
||||
*
|
||||
* @param array $log Log keyed by migration name.
|
||||
* @return void
|
||||
*/
|
||||
public function write( array $log ) {
|
||||
$encoded = wp_json_encode( $log );
|
||||
if ( false === $encoded ) {
|
||||
return;
|
||||
}
|
||||
|
||||
$existing = get_option( $this->optionName, null );
|
||||
if ( null === $existing ) {
|
||||
add_option( $this->optionName, $encoded, '', 'no' );
|
||||
} else {
|
||||
update_option( $this->optionName, $encoded );
|
||||
}
|
||||
|
||||
$this->cache = $log;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,205 @@
|
||||
<?php
|
||||
namespace AIOSEO\TableOfContents\Main\Migrations;
|
||||
|
||||
// Exit if accessed directly.
|
||||
if ( ! defined( 'ABSPATH' ) ) {
|
||||
exit;
|
||||
}
|
||||
|
||||
/**
|
||||
* Discovers, executes, and logs {@see Migration} instances.
|
||||
*
|
||||
* The runner closes the half-applied failure mode: the version flag is only
|
||||
* advanced when EVERY registered migration's verify() returns true. A
|
||||
* concurrent-request lock loser bails without touching state; a lock holder
|
||||
* that dies mid-migration leaves the relevant log entry at status = 0 (or
|
||||
* absent), and the runner retries on the next request until verify() actually
|
||||
* passes.
|
||||
*
|
||||
* @since 202607
|
||||
*/
|
||||
class MigrationRunner {
|
||||
/**
|
||||
* Registered migrations, in registration order.
|
||||
*
|
||||
* @since 202607
|
||||
*
|
||||
* @var Migration[]
|
||||
*/
|
||||
private $migrations = [];
|
||||
|
||||
/**
|
||||
* Log accessor.
|
||||
*
|
||||
* @since 202607
|
||||
*
|
||||
* @var MigrationLog
|
||||
*/
|
||||
private $log;
|
||||
|
||||
/**
|
||||
* Lock name. MySQL GET_LOCK is per-connection, so this serializes across
|
||||
* concurrent PHP processes for the same site.
|
||||
*
|
||||
* @since 202607
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $lockName = 'aioseo_table_of_contents_migration_runner';
|
||||
|
||||
/**
|
||||
* @since 202607
|
||||
*/
|
||||
public function __construct() {
|
||||
$this->log = new MigrationLog();
|
||||
}
|
||||
|
||||
/**
|
||||
* Register a migration. Order is preserved — later registrations run
|
||||
* after earlier ones within the same request.
|
||||
*
|
||||
* @since 202607
|
||||
*
|
||||
* @param Migration $migration The migration to register.
|
||||
* @return void
|
||||
*/
|
||||
public function register( Migration $migration ) {
|
||||
$this->migrations[] = $migration;
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute pending migrations.
|
||||
*
|
||||
* Short-circuits early when the recorded schema version matches the
|
||||
* current plugin version — healthy sites never touch the log option.
|
||||
* Lock losers exit silently and do NOT advance any version flag, so a
|
||||
* future-bumped lastSchemaVersion can't strand work.
|
||||
*
|
||||
* @since 202607
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function run() {
|
||||
if ( aioseoTableOfContents()->internalOptions->internal->lastSchemaVersion === aioseoTableOfContents()->version ) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ( empty( $this->migrations ) ) {
|
||||
aioseoTableOfContents()->internalOptions->internal->lastSchemaVersion = aioseoTableOfContents()->version;
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
if ( ! aioseoTableOfContents()->core->db->acquireLock( $this->lockName, 0 ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
$log = $this->log->read();
|
||||
$allDone = true;
|
||||
|
||||
foreach ( $this->migrations as $migration ) {
|
||||
$name = $migration->name();
|
||||
|
||||
if ( $this->verifySafely( $migration ) ) {
|
||||
if ( ! isset( $log[ $name ] ) || 1 !== ( $log[ $name ]['status'] ?? 0 ) ) {
|
||||
$log[ $name ] = $this->successEntry( $migration, $log );
|
||||
}
|
||||
continue;
|
||||
}
|
||||
|
||||
try {
|
||||
$migration->up();
|
||||
$verified = $this->verifySafely( $migration );
|
||||
|
||||
$log[ $name ] = $verified
|
||||
? $this->successEntry( $migration, $log )
|
||||
: $this->failureEntry( $migration, $log, 'verify() returned false after up()' );
|
||||
|
||||
if ( ! $verified ) {
|
||||
$allDone = false;
|
||||
}
|
||||
} catch ( \Throwable $e ) {
|
||||
$log[ $name ] = $this->failureEntry( $migration, $log, $e->getMessage() );
|
||||
$allDone = false;
|
||||
}
|
||||
}
|
||||
|
||||
$this->log->write( $log );
|
||||
|
||||
if ( $allDone ) {
|
||||
aioseoTableOfContents()->internalOptions->internal->lastSchemaVersion = aioseoTableOfContents()->version;
|
||||
}
|
||||
} finally {
|
||||
// Explicit release shrinks the hold window to the migration work itself.
|
||||
// acquireLock() also registers a shutdown function as belt-and-braces in
|
||||
// case execution exits before we reach this point.
|
||||
aioseoTableOfContents()->core->db->releaseLock( $this->lockName );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Wrap verify() so a throwing implementation degrades to "not verified"
|
||||
* instead of bringing down the runner. The error surfaces via the log's
|
||||
* failureEntry on the next up()/verify() cycle.
|
||||
*
|
||||
* @since 202607
|
||||
*
|
||||
* @param Migration $migration The migration to verify.
|
||||
* @return bool
|
||||
*/
|
||||
private function verifySafely( Migration $migration ) {
|
||||
try {
|
||||
return (bool) $migration->verify();
|
||||
} catch ( \Throwable $e ) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Build a success log entry, preserving the prior attempts counter so
|
||||
* support can see how many retries it took to land.
|
||||
*
|
||||
* @since 202607
|
||||
*
|
||||
* @param Migration $migration The migration.
|
||||
* @param array $log The current log state.
|
||||
* @return array
|
||||
*/
|
||||
private function successEntry( Migration $migration, array $log ) {
|
||||
$name = $migration->name();
|
||||
$attempts = isset( $log[ $name ]['attempts'] ) ? (int) $log[ $name ]['attempts'] : 0;
|
||||
|
||||
return [
|
||||
'version' => $migration->version(),
|
||||
'ran_at' => aioseoTableOfContents()->helpers->timeToMysql( time() ),
|
||||
'status' => 1,
|
||||
'attempts' => $attempts + 1,
|
||||
'last_error' => null
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Build a failure log entry, incrementing attempts so retry pressure is
|
||||
* visible in the log.
|
||||
*
|
||||
* @since 202607
|
||||
*
|
||||
* @param Migration $migration The migration.
|
||||
* @param array $log The current log state.
|
||||
* @param string $error Reason for the failure.
|
||||
* @return array
|
||||
*/
|
||||
private function failureEntry( Migration $migration, array $log, $error ) {
|
||||
$name = $migration->name();
|
||||
$attempts = isset( $log[ $name ]['attempts'] ) ? (int) $log[ $name ]['attempts'] : 0;
|
||||
|
||||
return [
|
||||
'version' => $migration->version(),
|
||||
'ran_at' => aioseoTableOfContents()->helpers->timeToMysql( time() ),
|
||||
'status' => 0,
|
||||
'attempts' => $attempts + 1,
|
||||
'last_error' => $error
|
||||
];
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user