Skip to content

DT Migration Plugin - Troubleshooting Of Abrupt Migration Flow Stops #18

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

Merged
corsacca merged 9 commits into from
May 6, 2026
Merged

DT Migration Plugin - Troubleshooting Of Abrupt Migration Flow Stops #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
577d07e
Implement file job management in Disciple.Tools Migration plugin
kodinkat Apr 27, 2026
b833ac8
Enhance documentation for file import jobs in Disciple.Tools Migratio…
kodinkat Apr 27, 2026
d733aa5
Refactor AJAX handling for file job payloads in migration import process
kodinkat Apr 27, 2026
72ce1b6
Refactor file name handling in migration import process
kodinkat Apr 27, 2026
057f962
Merge branch 'master' into dt-migration-plugin-abrupt-stop-troublesho…
corsacca Apr 29, 2026
8322066
When importing users make sure they are added to the current subsite.
corsacca May 6, 2026
509dbfc
Fix exporting private meta and link and task fields
corsacca May 6, 2026
8620c48
Fix deleting Past uploads
corsacca May 6, 2026
58855a8
Sync file and API strategies.
corsacca May 6, 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
3 changes: 2 additions & 1 deletion admin/admin-menu-and-tabs.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,8 @@ public static function get_settings(): array {
'jwt_token_set_at' => 0,
],
'file' => [
'compression' => 'zip',
'compression' => 'zip',
'job_max_age_days' => defined( 'DT_MIGRATION_FILE_JOB_MAX_AGE_DAYS' ) ? (int) constant( 'DT_MIGRATION_FILE_JOB_MAX_AGE_DAYS' ) : 7,
],
];

Expand Down
230 changes: 216 additions & 14 deletions admin/class-dt-migration-import-ajax.php
View file
Open in desktop

Large diffs are not rendered by default.

175 changes: 171 additions & 4 deletions admin/class-dt-migration-tab-import.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,22 @@ class Disciple_Tools_Migration_Tab_Import {
*/
private $import_preview_channel = null;

/**
* Active file-mode job id (JSON stored in options) for the current preview, if any.
*
* @var string
*/
private $active_file_job_id = '';

public function content() {
$settings = Disciple_Tools_Migration_Menu::get_settings();

// Process any submitted connection test form before rendering.
$this->process_form_fields( $settings );
$settings = Disciple_Tools_Migration_Menu::get_settings();
if ( ! empty( $settings['enabled'] ) ) {
$this->try_load_file_job_from_query( $settings );
}

?>
<div class="wrap">
Expand Down Expand Up @@ -368,11 +378,12 @@ class="dt-migration-record-checkbox"
<?php endif; ?>
</div>
<hr style="margin: 28px 0;">
<div class="dt-migration-import-section" data-import-channel="file">
<div class="dt-migration-import-section" data-import-channel="file" data-file-job-id="<?php echo esc_attr( $this->active_file_job_id ); ?>">
<h3><?php esc_html_e( 'Upload & preview (JSON file)', 'disciple-tools-migration' ); ?></h3>
<p>
<?php esc_html_e( 'Upload a migration export JSON file from another Disciple.Tools site, then preview and import.', 'disciple-tools-migration' ); ?>
</p>
<?php $this->render_past_file_jobs_table( $settings ); ?>
<?php if ( ! empty( $this->connection_error ) ) : ?>
<div class="notice notice-error" style="margin-top:10px;">
<p><?php echo esc_html( $this->connection_error ); ?></p>
Expand Down Expand Up @@ -489,7 +500,7 @@ class="dt-migration-record-checkbox"
</p>
<?php endif; ?>
</div>
<?php if ( ! empty( $this->settings_preview ) ) : ?>
<?php if ( ! empty( $this->settings_preview ) && ( $this->import_preview_channel === 'api' || $this->import_preview_channel === 'file' ) ) : ?>
<?php $this->render_import_modal_and_progress(); ?>
<?php endif; ?>
<?php endif; ?>
Expand Down Expand Up @@ -919,9 +930,58 @@ private function process_file_upload( array $settings ) : void {
return;
}

$transient_key = 'dt_migration_file_payload_' . get_current_user_id();
set_transient( $transient_key, $payload, 15 * MINUTE_IN_SECONDS );
if ( ! class_exists( 'Disciple_Tools_Migration_File_Job_Store' ) ) {
$this->connection_error = esc_html__( 'Migration file jobs are not available. Please reload the page.', 'disciple-tools-migration' );
return;
}

$raw_name = isset( $_FILES['dt_migration_import_file']['name'] ) ? (string) wp_unslash( $_FILES['dt_migration_import_file']['name'] ) : ''; // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Client-provided upload name; sanitized with sanitize_file_name() on next line. Nonce verified above.
$filename = ( $raw_name !== '' ) ? sanitize_file_name( $raw_name ) : 'export.json';
$job_id = Disciple_Tools_Migration_File_Job_Store::create_job( get_current_user_id(), $payload, $filename );
if ( $job_id === '' ) {
$this->connection_error = esc_html__( 'Could not store the migration file for import. The server may be out of space or the export may be too large for your database settings.', 'disciple-tools-migration' );
return;
}
$this->active_file_job_id = $job_id;
$this->build_file_preview_state_from_payload( $payload );
if ( class_exists( 'Disciple_Tools_Migration_File_Job_Store' ) ) {
Disciple_Tools_Migration_File_Job_Store::prune_expired_jobs();
}
}

/**
* Fills preview state from a GET ?file_job= request (retry a past job).
*
* @param array $settings
* @return void
*/
private function try_load_file_job_from_query( array $settings ) : void {
if ( ! class_exists( 'Disciple_Tools_Migration_File_Job_Store' ) || $this->settings_preview !== null ) {
return;
}
if ( ! isset( $_GET['file_job'] ) ) {
return;
}
$raw = sanitize_text_field( wp_unslash( $_GET['file_job'] ) );
$id = Disciple_Tools_Migration_File_Job_Store::sanitize_job_id( $raw );
if ( $id === '' ) {
return;
}
$user_id = get_current_user_id();
$payload = Disciple_Tools_Migration_File_Job_Store::get_payload( $user_id, $id );
if ( $payload === null || ! Disciple_Tools_Migration_File_Job_Store::is_valid_migration_payload( $payload ) ) {
$this->connection_error = esc_html__( 'That migration file job was not found, completed without a retriable copy, or you do not have access. Upload the JSON again.', 'disciple-tools-migration' );
return;
}
$this->active_file_job_id = $id;
$this->build_file_preview_state_from_payload( $payload );
}

/**
* @param array $payload Full export payload.
* @return void
*/
private function build_file_preview_state_from_payload( array $payload ) : void {
$dt_settings = $payload['export']['dt_settings'] ?? [];
$post_types = $dt_settings['dt_post_types_settings']['values'] ?? [];
$tiles_all = $dt_settings['dt_tiles_settings']['values'] ?? [];
Expand All @@ -947,4 +1007,111 @@ private function process_file_upload( array $settings ) : void {

$this->import_preview_channel = 'file';
}

/**
* Renders a table of past file import jobs for the current user.
*
* @param array $settings
* @return void
*/
private function render_past_file_jobs_table( array $settings ) : void {
if ( ! class_exists( 'Disciple_Tools_Migration_File_Job_Store' ) || empty( $settings['enabled'] ) ) {
return;
}
$user_id = get_current_user_id();
$rows = Disciple_Tools_Migration_File_Job_Store::list_jobs_for_user( $user_id );
$page_token = Disciple_Tools_Migration_Menu::instance()->token;
$url_base = add_query_arg(
[
'page' => $page_token,
'tab' => 'import',
],
admin_url( 'admin.php' )
);
?>
<h4 class="dt-migration-past-jobs-heading"><?php esc_html_e( 'Recent file migration jobs', 'disciple-tools-migration' ); ?></h4>
<p class="description">
<?php esc_html_e( 'Each upload is kept until you delete it, it succeeds (payload cleared), or it is older than the day limit on the Settings tab. Use Retry to load a failed or interrupted job. Completed jobs that no longer have a stored file cannot be retried.', 'disciple-tools-migration' ); ?>
</p>
<table class="widefat striped dt-migration-past-jobs" style="margin: 12px 0 20px;">
<thead>
<tr>
<th scope="col"><?php esc_html_e( 'Date', 'disciple-tools-migration' ); ?></th>
<th scope="col"><?php esc_html_e( 'File', 'disciple-tools-migration' ); ?></th>
<th scope="col"><?php esc_html_e( 'Status', 'disciple-tools-migration' ); ?></th>
<th scope="col"><?php esc_html_e( 'Size', 'disciple-tools-migration' ); ?></th>
<th scope="col"><?php esc_html_e( 'Actions', 'disciple-tools-migration' ); ?></th>
</tr>
</thead>
<tbody>
<?php if ( ! $rows ) : ?>
<tr>
<td colspan="5"><?php esc_html_e( 'No file migration jobs yet. Upload a JSON file above to create one.', 'disciple-tools-migration' ); ?></td>
</tr>
<?php else : ?>
<?php
foreach ( $rows as $row ) {
$job_id = isset( $row['job_id'] ) ? (string) $row['job_id'] : '';
$status = isset( $row['status'] ) ? (string) $row['status'] : 'ready';
$label = isset( $row['label'] ) ? (string) $row['label'] : '';
$ts = isset( $row['stored_at'] ) ? (int) $row['stored_at'] : 0;
$bytes = isset( $row['byte_size'] ) ? (int) $row['byte_size'] : 0;
$date_str = $ts > 0 ? date_i18n( get_option( 'date_format' ) . ' ' . get_option( 'time_format' ), $ts ) : '—';
$size_str = $bytes > 0
/* translators: %s: file size e.g. 2 MB */
? size_format( $bytes, 1 )
: '—';
$has_payload = $job_id !== '' && Disciple_Tools_Migration_File_Job_Store::job_has_stored_payload( $job_id );
$can_retry = $has_payload && in_array( $status, [ Disciple_Tools_Migration_File_Job_Store::STATUS_READY, Disciple_Tools_Migration_File_Job_Store::STATUS_FAILED, Disciple_Tools_Migration_File_Job_Store::STATUS_CANCELLED, Disciple_Tools_Migration_File_Job_Store::STATUS_RUNNING ], true );
$retry_url = add_query_arg( 'file_job', $job_id, $url_base );
$pill_class = 'dt-migration-job-pill dt-migration-job-pill--neutral';
if ( $status === Disciple_Tools_Migration_File_Job_Store::STATUS_SUCCESS ) {
$pill_class = 'dt-migration-job-pill dt-migration-job-pill--success';
} elseif ( in_array( $status, [ Disciple_Tools_Migration_File_Job_Store::STATUS_FAILED, Disciple_Tools_Migration_File_Job_Store::STATUS_CANCELLED ], true ) ) {
$pill_class = 'dt-migration-job-pill dt-migration-job-pill--failed';
}
$status_label = $status;
switch ( $status ) {
case Disciple_Tools_Migration_File_Job_Store::STATUS_SUCCESS:
$status_label = __( 'Success', 'disciple-tools-migration' );
break;
case Disciple_Tools_Migration_File_Job_Store::STATUS_FAILED:
$status_label = __( 'Failed', 'disciple-tools-migration' );
break;
case Disciple_Tools_Migration_File_Job_Store::STATUS_CANCELLED:
$status_label = __( 'Cancelled', 'disciple-tools-migration' );
break;
case Disciple_Tools_Migration_File_Job_Store::STATUS_RUNNING:
$status_label = __( 'In progress', 'disciple-tools-migration' );
break;
case Disciple_Tools_Migration_File_Job_Store::STATUS_READY:
default:
$status_label = __( 'Ready', 'disciple-tools-migration' );
break;
}
?>
<tr>
<td><?php echo esc_html( $date_str ); ?></td>
<td><?php echo esc_html( $label !== '' ? $label : '—' ); ?></td>
<td>
<span class="<?php echo esc_attr( $pill_class ); ?>"><?php echo esc_html( $status_label ); ?></span>
</td>
<td><?php echo esc_html( $size_str ); ?></td>
<td>
<?php if ( $can_retry ) : ?>
<a class="button button-small" href="<?php echo esc_url( $retry_url ); ?>"><?php esc_html_e( 'Retry', 'disciple-tools-migration' ); ?></a>
<?php else : ?>
<span class="description" aria-label="<?php esc_attr_e( 'No retry for this job', 'disciple-tools-migration' ); ?>">—</span>
<?php endif; ?>
<button type="button" class="button button-small button-link-delete dt-migration-file-job-delete" data-job-id="<?php echo esc_attr( $job_id ); ?>" style="margin-left:6px;">
<?php esc_html_e( 'Delete', 'disciple-tools-migration' ); ?>
</button>
</td>
</tr>
<?php } ?>
<?php endif; ?>
</tbody>
</table>
<?php
}
}
47 changes: 46 additions & 1 deletion admin/class-dt-migration-tab-settings.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,33 @@ public function main_column( array $settings ) {
</p>
</fieldset>
</td>
</tr>
<tr>
<th colspan="2" scope="colgroup">
<?php esc_html_e( 'File import jobs', 'disciple-tools-migration' ); ?>
</th>
</tr>
<tr>
<td>
<label for="dt_migration_file_job_max_age_days">
<?php esc_html_e( 'Remove file migration jobs after (days)', 'disciple-tools-migration' ); ?>
</label>
</td>
<td>
<input
type="number"
id="dt_migration_file_job_max_age_days"
name="dt_migration_file_job_max_age_days"
class="small-text"
min="1"
max="365"
step="1"
value="<?php echo esc_attr( (string) ( (int) ( $settings['file']['job_max_age_days'] ?? 7 ) ) ); ?>"
/>
<p class="description">
<?php esc_html_e( 'Completed uploads and their metadata on the Import tab are removed automatically when older than this many days. The default is 7. Lower this if you need to free database space sooner.', 'disciple-tools-migration' ); ?>
</p>
</td>
</tr>
<tr>
<td>
Expand Down Expand Up @@ -187,7 +214,25 @@ public function process_form_fields(): void {
$settings['allowed_items']['records'][ $post_type ] = ! empty( $incoming_records[ $post_type ] );
}

$days = isset( $post_vars['dt_migration_file_job_max_age_days'] ) ? (int) $post_vars['dt_migration_file_job_max_age_days'] : 7;
if ( $days < 1 ) {
$days = 1;
}
if ( $days > 365 ) {
$days = 365;
}
if ( ! isset( $settings['file'] ) || ! is_array( $settings['file'] ) ) {
$settings['file'] = [
'compression' => 'zip',
];
}
$settings['file']['job_max_age_days'] = $days;

Disciple_Tools_Migration_Menu::update_settings( $settings );

if ( class_exists( 'Disciple_Tools_Migration_File_Job_Store' ) ) {
Disciple_Tools_Migration_File_Job_Store::prune_expired_jobs();
}
}

/**
Expand Down Expand Up @@ -224,4 +269,4 @@ public function right_column( array $settings ) {
<!-- End Box -->
<?php
}
}
}
Loading
Loading