Skip to content

Add user synchronization #156

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
wants to merge 19 commits into
base: develop
Choose a base branch
from
Open

Add user synchronization #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
60668a3
Add User sync settings.
iamdharmesh May 7, 2025
a6fe5d5
Install action scheduler dependency.
iamdharmesh May 13, 2025
abbb7fb
Some updates to User sync settings and added initial background proce…
iamdharmesh May 13, 2025
267f675
Add user sync status rendering and auto refresh every 30 seconds.
iamdharmesh May 13, 2025
5291e25
Update user count in the note for the additional charges note.
iamdharmesh May 13, 2025
c48fe3d
Display Sync errors and better sync status.
iamdharmesh May 14, 2025
80aa4d1
Some code improvements.
iamdharmesh May 14, 2025
b4a561f
Merge branch 'develop' of github.com:mailchimp/wordpress into enhance…
iamdharmesh May 14, 2025
214f424
Move develop changes to new files.
iamdharmesh May 14, 2025
1f4aa9e
Listen for the user updates.
iamdharmesh May 14, 2025
05c06e2
Add spinner loader for the delete error logs.
iamdharmesh May 14, 2025
16ac064
Fixed PHP compatibility issue.
iamdharmesh May 15, 2025
9e19666
Improvements in logs table.
iamdharmesh May 15, 2025
d499200
Add User sync start CTA.
iamdharmesh May 15, 2025
8f3673e
Move logs behind filter and disable by default.
iamdharmesh May 15, 2025
0e75892
Stop sync if list get changed.
iamdharmesh May 15, 2025
b1b0373
E2E: Add E2E tests for user sync.
iamdharmesh May 15, 2025
5e18285
E2E: Disable auto core update in wp-env.
iamdharmesh May 15, 2025
2253e6a
Fix spacing issue with wp-env.json
iamdharmesh May 15, 2025
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
4 changes: 4 additions & 0 deletions .wp-env.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,9 @@
},
"lifecycleScripts": {
"afterStart": "bash ./tests/bin/initialize.sh"
},
"config": {
"ALTERNATE_WP_CRON": true,
"WP_AUTO_UPDATE_CORE": false
}
}
148 changes: 145 additions & 3 deletions assets/css/admin.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@
table.mc-user,
.mc-list-row,
.mc-list-note,
.mc-section {
.mc-section,
.mailchimp-sf-nav-tab-wrapper {
max-width: 900px;
width: 100%;
}
Expand All @@ -38,17 +39,23 @@ table.mc-user,
}

/* Sections */
table.mc-widefat {
table.mc-widefat, .mailchimp-sf-user-sync-page table.form-table {
background: var(--mailchimp-color-white);
border: 2px solid var(--mailchimp-color-header-bg) !important;
border-radius: 6px;
margin: 2.75rem 0 2.25rem;
}

.mailchimp-sf-user-sync-page table.form-table {
display: block;
}

.mailchimp-sf-user-sync-page table.form-table tr:first-child,
table.mc-widefat tr:first-child {
background: var(--mailchimp-color-header-bg);
}

.mailchimp-sf-user-sync-page table.form-table tr:first-child th,
table.mc-widefat tr:first-child th {
color: var(--mailchimp-color-text);
font-weight: 500;
Expand Down Expand Up @@ -181,13 +188,17 @@ table.mc-list-select {
}

/* Table */
.mailchimp-sf-user-sync-page table.form-table td,
.mailchimp-sf-user-sync-page table.form-table th,
table.mc-widefat td,
table.mc-widefat th {
padding: 18px;
text-align: left;
text-shadow: none;
}

.mailchimp-sf-user-sync-page table.form-table .last-row td,
.mailchimp-sf-user-sync-page table.form-table .last-row th,
table.mc-widefat .last-row td,
table.mc-widefat .last-row th {
border-bottom: none !important;
Expand All @@ -199,6 +210,11 @@ table.mc-widefat th {
width: 130px;
}

.mailchimp-sf-user-sync-page table.form-table th {
color: var(--mailchimp-color-text-light);
font-weight: 500;
}

table.mc-widefat td label {
display: block;
font-size: 0.75rem;
Expand All @@ -213,6 +229,7 @@ table.mc-widefat td {
line-height: 1.125 !important;
}

.mailchimp-sf-user-sync-page table.form-table td input,
table.mc-widefat td input {
display: inline-block;
font-style: normal;
Expand Down Expand Up @@ -261,6 +278,31 @@ th.mailchimp-connect {
margin-top: 26px;
}

/**
* Navigation
*/
.mailchimp-sf-nav-tab-wrapper {
margin-top: 1em;
}

.mailchimp-sf-nav-tab-wrapper a.nav-tab {
border: 0px;
background: transparent;
color: #000;
margin-left: 0;
font-weight: 500;
padding: 5px 12px;
}

.mailchimp-sf-nav-tab-wrapper a.nav-tab:hover {
color: var(--mailchimp-color-link);
}

.mailchimp-sf-nav-tab-wrapper a.nav-tab.nav-tab-active {
border-bottom: 2px solid var(--mailchimp-color-link);
color: var(--mailchimp-color-link);
}

/**
* Mailchimp OAuth CSS
*/
Expand Down Expand Up @@ -390,6 +432,11 @@ body.toplevel_page_mailchimp_sf_options a {
color: var(--mailchimp-color-link);
}

body.admin_page_mailchimp_sf_create_account a:hover,
body.toplevel_page_mailchimp_sf_options a:hover {
color: #006570;
}

body.admin_page_mailchimp_sf_create_account #footer-upgrade,
body.toplevel_page_mailchimp_sf_options #footer-upgrade {
display: none;
Expand Down Expand Up @@ -516,7 +563,8 @@ body.toplevel_page_mailchimp_sf_options #footer-upgrade {
cursor: not-allowed;
}

.button.mailchimp-sf-button.small {
.button.mailchimp-sf-button.small,
.button.mailchimp-sf-button.user-sync-settings-submit {
padding: 8px 16px;
line-height: 14px;
float: right;
Expand Down Expand Up @@ -749,3 +797,97 @@ body.toplevel_page_mailchimp_sf_options #footer-upgrade {
column-gap: 16px;
}
}

.mailchimp-sf-user-sync-page {
max-width: 900px;
}

.mailchimp-sf-user-sync-page .subscribe_status_label {
font-weight: 500;
}

.mailchimp-sf-user-sync-page p.description_small {
font-size: 0.9em;
margin-bottom: 10px;
}

.mailchimp-sf-user-sync-status {
margin: 15px 0;
padding: 10px;
background: #fff;
border: 1px solid #ccd0d4;
border-radius: 4px;
}
.mailchimp-sf-user-sync-status .mailchimp-sf-sync-progress {
display: flex;
align-items: center;
flex-direction: row;
}
.mailchimp-sf-user-sync-status .sync-status-text {
font-size: 14px;
line-height: 1.4;
}

.button.mailchimp-cancel-user-sync-button {
margin-left: auto;
}

@media screen and (max-width: 480px) {
.mailchimp-sf-user-sync-status .mailchimp-sf-sync-progress {
flex-direction: column;
align-items: flex-start;
}

.button.mailchimp-cancel-user-sync-button {
margin-left: 0px;
margin-top: 10px;
}
}

.mailchimp-sf-user-sync-errors {
margin-top: 2rem;
}

.mailchimp-sf-user-sync-errors-header {
display: flex;
justify-content: space-between;
align-items: center;
}

.mailchimp-sf-user-sync-error-action {
min-width: 120px;
text-align: right;
}

.mailchimp-sf-start-user-sync-wrapper {
width: 100%;
margin-top: 2em;
background-color: #ffffff;
border: 1px solid #ccd0d4;
border-radius: 6px;
}

.mailchimp-sf-start-user-sync-box {
display: flex;
justify-content: space-between;
align-items: center;
padding: 1rem;
}

.mailchimp-sf-start-user-sync-box h2 {
margin: 0;
}

.mailchimp-sf-start-user-sync-box p {
margin-top: 0.5rem;
}

.mailchimp-sf-start-user-sync-box .mailchimp-sf-button {
float: none;
margin-right: 8px;
}

.mailchimp-sf-start-user-sync-box a {
text-decoration: none;
}

140 changes: 140 additions & 0 deletions assets/js/admin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,3 +414,143 @@
});
});
})(jQuery); // eslint-disable-line no-undef

// User Sync Settings.
(function ($) {
const userSyncSettingsPage = $('.mailchimp-sf-user-sync-page');
if (userSyncSettingsPage.length > 0) {
const syncExistingContactsOnly = $(
'tr.mailchimp-user-sync-existing-contacts-only input[type="checkbox"]',
);
if (syncExistingContactsOnly) {
syncExistingContactsOnly.change(function () {
if (this.checked) {
$('tr.mailchimp-user-sync-subscriber-status').hide();
} else {
$('tr.mailchimp-user-sync-subscriber-status').show();
}
});

// Trigger change event to hide/show subscriber status.
syncExistingContactsOnly.trigger('change');
}
}
})(jQuery); // eslint-disable-line no-undef

// Update the user sync status.
(function ($) {
const statusWrapper = $('.mailchimp-sf-user-sync-status');
const processRunning = statusWrapper.length;
if (!processRunning) {
return;
}

const params = window.mailchimp_sf_admin_params || {};
const ajaxUrl = params.ajax_url;
const ajaxNonce = params.user_sync_status_nonce;

const intervalId = setInterval(function () {
$.ajax({
url: ajaxUrl,
type: 'POST',
data: {
action: 'mailchimp_sf_get_user_sync_status',
nonce: ajaxNonce,
},
success(response) {
if (response.success && response.data) {
if (response.data.is_running && response.data.status) {
// Update the sync status on the page
statusWrapper.html(response.data.status);
} else {
// Clear interval and reload the page.
clearInterval(intervalId);
window.location.reload();
}
}
},
error(jqXHR, textStatus, errorThrown) {
// eslint-disable-next-line no-console
console.error('Error: ', textStatus, ', Details: ', errorThrown);
},
});
}, 30000); // 30000 milliseconds = 30 seconds
})(jQuery); // eslint-disable-line no-undef

// User Sync Error logs.
(function ($) {
const userSyncErrors = $('.mailchimp-sf-user-sync-errors');
if (!userSyncErrors) {
return;
}

const params = window.mailchimp_sf_admin_params || {};
const tableSelector = 'table.mailchimp-sf-user-sync-errors-table';
const noErrorsFoundRow =
'<tr><td colspan="4"><em>' + params.no_errors_found + '</em></td></tr>';
$('#mailchimp-sf-clear-user-sync-errors').on('click', function (e) {
e.preventDefault();
$(this).prop('disabled', true);
$('.mailchimp-sf-user-sync-errors-header-actions .spinner').addClass('is-active');

$.ajax({
url: params.ajax_url,
type: 'POST',
data: {
action: 'mailchimp_sf_delete_user_sync_error',
id: 'all',
nonce: params.delete_user_sync_error_nonce,
},
success(response) {
if (response && response.success) {
$(tableSelector + ' tbody').html(noErrorsFoundRow);
$('.mailchimp-sf-user-sync-errors-header-actions .spinner').removeClass(
'is-active',
);
} else {
window.location.reload();
}
},
error(jqXHR, textStatus, errorThrown) {
// eslint-disable-next-line no-console
console.error('Error: ', textStatus, ', Details: ', errorThrown);
window.location.reload();
},
});
});

$(tableSelector).on('click', '.mailchimp-sf-user-sync-error-delete', function (e) {
e.preventDefault();

const errorId = $(this).data('id');
const rowId = '#row-' + errorId;
$(rowId).find('.mailchimp-sf-user-sync-error-action .spinner').addClass('is-active');
$(this).prop('disabled', true);
$.ajax({
url: params.ajax_url,
type: 'POST',
data: {
action: 'mailchimp_sf_delete_user_sync_error',
nonce: params.delete_user_sync_error_nonce,
id: errorId,
},
success(response) {
if (response && response.success) {
$(rowId).remove();

if (!$(tableSelector + ' tbody tr').length) {
$(tableSelector + ' tbody').html(noErrorsFoundRow);
$('#mailchimp-sf-clear-user-sync-errors').prop('disabled', true);
}
} else {
window.location.reload();
}
},
error(jqXHR, textStatus, errorThrown) {
// eslint-disable-next-line no-console
console.error('Error: ', textStatus, ', Details: ', errorThrown);
window.location.reload();
},
});
});
})(jQuery); // eslint-disable-line no-undef
5 changes: 3 additions & 2 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
],
"prefer-stable": true,
"require": {
"php": ">=7.0"
"php": ">=7.0",
"woocommerce/action-scheduler": "3.8.2"
},
"require-dev": {
"10up/phpcs-composer": "^3.0",
Expand All @@ -37,4 +38,4 @@
"scripts": {
"lint": "phpcs --standard=./phpcs.xml -p -s ."
}
}
}
Loading