🎨 Removed member bulk deletion safeguard from safe queries (#20747)

fixes https://linear.app/tryghost/issue/ENG-1484

- in Ghost release
[v5.89.0](https://github.com/TryGhost/Ghost/releases/tag/v5.89.0), we
have added a safeguard around bulk member deletion, due to a limitation
in NQL for member filters (commit: 2484a77)
- with this change, we limit the safeguard to only the cases we know are
problematic, and remove it for other useful and safe queries
- more precisely, the safeguard is in place only when:
    - Multiple newsletters exist, and the filter contains 2 or more
newsletter filters
    - If any of the following stripe filters are used even once:
        - Billing period
        - Stripe subscription status
        - Paid start date
        - Next billing date
        - Subscription started on post/page
        - Offers

ghost/admin/README.md

@@ -12,7 +12,7 @@ Run all tests in the browser by running `yarn dev` in the Ghost monorepo and vis
 
 ---
 
-Tip: You can use `await this.pauseTest()` in your tests to temporarily pause the execution of browser tests. Use the browser console to inspect and debug the DOM, then resume tests by running `resumeTest()` directly in the browser console ([docs](https://guides.emberjs.com/v3.28.0/testing/testing-application/#toc_debugging-your-tests))
+Tip: You can use `this.timeout(0); await this.pauseTest();` in your tests to temporarily pause the execution of browser tests. Use the browser console to inspect and debug the DOM, then resume tests by running `resumeTest()` directly in the browser console ([docs](https://guides.emberjs.com/v3.28.0/testing/testing-application/#toc_debugging-your-tests))
 
 
 ### Running tests in the CLI

ghost/admin/app/components/members/filter.js

@@ -137,6 +137,10 @@ class Filter {
         return this.properties.options ?? [];
     }
 
+    get group() {
+        return this.properties.group;
+    }
+
     get isValid() {
         if (Array.isArray(this.value)) {
             return !!this.value.length;

ghost/admin/app/components/members/filters/created-at.js

@@ -1,8 +1,8 @@
 import {DATE_RELATION_OPTIONS} from './relation-options';
 
 export const CREATED_AT_FILTER = {
-    label: 'Created', 
+    label: 'Created',
-    name: 'created_at', 
+    name: 'created_at',
-    valueType: 'date', 
+    valueType: 'date',
     relationOptions: DATE_RELATION_OPTIONS
 };

ghost/admin/app/components/members/filters/email-clicked.js

@@ -1,10 +1,10 @@
 import {MATCH_RELATION_OPTIONS} from './relation-options';
 
 export const EMAIL_CLICKED_FILTER = {
-    label: 'Clicked email', 
+    label: 'Clicked email',
-    name: 'clicked_links.post_id', 
+    name: 'clicked_links.post_id',
-    valueType: 'string', 
+    valueType: 'string',
-    resource: 'email', 
+    resource: 'email',
     relationOptions: MATCH_RELATION_OPTIONS,
     columnLabel: 'Clicked email',
     setting: 'emailTrackClicks',

ghost/admin/app/components/members/filters/email-count.js

@@ -2,10 +2,10 @@ import {NUMBER_RELATION_OPTIONS} from './relation-options';
 import {formatNumber} from 'ghost-admin/helpers/format-number';
 
 export const EMAIL_COUNT_FILTER = {
-    label: 'Emails sent (all time)', 
+    label: 'Emails sent (all time)',
-    name: 'email_count', 
+    name: 'email_count',
-    columnLabel: 'Email count', 
+    columnLabel: 'Email count',
-    valueType: 'number', 
+    valueType: 'number',
     relationOptions: NUMBER_RELATION_OPTIONS,
     getColumnValue: (member) => {
         return {

ghost/admin/app/components/members/filters/email-open-rate.js

@@ -1,9 +1,9 @@
 import {NUMBER_RELATION_OPTIONS} from './relation-options';
 
 export const EMAIL_OPEN_RATE_FILTER = {
-    label: 'Open rate (all time)', 
+    label: 'Open rate (all time)',
-    name: 'email_open_rate', 
+    name: 'email_open_rate',
-    valueType: 'number', 
+    valueType: 'number',
     setting: 'emailTrackOpens',
     relationOptions: NUMBER_RELATION_OPTIONS
 };

ghost/admin/app/components/members/filters/email-opened-count.js

@@ -2,10 +2,10 @@ import {NUMBER_RELATION_OPTIONS} from './relation-options';
 import {formatNumber} from 'ghost-admin/helpers/format-number';
 
 export const EMAIL_OPENED_COUNT_FILTER = {
-    label: 'Emails opened (all time)', 
+    label: 'Emails opened (all time)',
-    name: 'email_opened_count', 
+    name: 'email_opened_count',
-    columnLabel: 'Email opened count', 
+    columnLabel: 'Email opened count',
-    valueType: 'number', 
+    valueType: 'number',
     relationOptions: NUMBER_RELATION_OPTIONS,
     getColumnValue: (member) => {
         return {

ghost/admin/app/components/members/filters/email-opened.js

@@ -1,10 +1,10 @@
 import {MATCH_RELATION_OPTIONS} from './relation-options';
 
 export const EMAIL_OPENED_FILTER = {
-    label: 'Opened email', 
+    label: 'Opened email',
-    name: 'opened_emails.post_id', 
+    name: 'opened_emails.post_id',
-    valueType: 'string', 
+    valueType: 'string',
-    resource: 'email', 
+    resource: 'email',
     relationOptions: MATCH_RELATION_OPTIONS,
     columnLabel: 'Opened email',
     setting: 'emailTrackOpens',

ghost/admin/app/components/members/filters/email.js

@@ -1,8 +1,8 @@
 import {CONTAINS_RELATION_OPTIONS} from './relation-options';
 
 export const EMAIL_FILTER = {
-    label: 'Email', 
+    label: 'Email',
     name: 'email',
-    valueType: 'string', 
+    valueType: 'string',
     relationOptions: CONTAINS_RELATION_OPTIONS
 };

ghost/admin/app/components/members/filters/label.js

@@ -1,10 +1,10 @@
 import {MATCH_RELATION_OPTIONS} from './relation-options';
 
 export const LABEL_FILTER = {
-    label: 'Label', 
+    label: 'Label',
-    name: 'label', 
+    name: 'label',
-    valueType: 'array', 
+    valueType: 'array',
-    columnLabel: 'Label', 
+    columnLabel: 'Label',
     relationOptions: MATCH_RELATION_OPTIONS,
     getColumnValue: (member) => {
         return {

ghost/admin/app/components/members/filters/last-seen.js

@@ -2,10 +2,10 @@ import {DATE_RELATION_OPTIONS} from './relation-options';
 import {getDateColumnValue} from './columns/date-column';
 
 export const LAST_SEEN_FILTER = {
-    label: 'Last seen', 
+    label: 'Last seen',
-    name: 'last_seen_at', 
+    name: 'last_seen_at',
-    valueType: 'date', 
+    valueType: 'date',
-    columnLabel: 'Last seen at', 
+    columnLabel: 'Last seen at',
     relationOptions: DATE_RELATION_OPTIONS,
     getColumnValue: (member, filter) => {
         return getDateColumnValue(member.lastSeenAtUTC, filter);

ghost/admin/app/components/members/filters/name.js

@@ -1,8 +1,8 @@
 import {CONTAINS_RELATION_OPTIONS} from './relation-options';
 
 export const NAME_FILTER = {
-    label: 'Name', 
+    label: 'Name',
-    name: 'name', 
+    name: 'name',
-    valueType: 'string', 
+    valueType: 'string',
     relationOptions: CONTAINS_RELATION_OPTIONS
 };

ghost/admin/app/components/members/filters/offers.js

@@ -1,7 +1,7 @@
 import {MATCH_RELATION_OPTIONS} from './relation-options';
 
 export const OFFERS_FILTER = {
-    label: 'Offers', 
+    label: 'Offers',
     name: 'offer_redemptions',
     group: 'Subscription',
     relationOptions: MATCH_RELATION_OPTIONS,

ghost/admin/app/components/members/filters/signup-attribution.js

@@ -1,10 +1,10 @@
 import {MATCH_RELATION_OPTIONS} from './relation-options';
 
 export const SIGNUP_ATTRIBUTION_FILTER = {
-    label: 'Signed up on post/page', 
+    label: 'Signed up on post/page',
-    name: 'signup', 
+    name: 'signup',
-    valueType: 'string', 
+    valueType: 'string',
-    resource: 'post', 
+    resource: 'post',
     relationOptions: MATCH_RELATION_OPTIONS,
     columnLabel: 'Signed up on',
     setting: 'membersTrackSources',

ghost/admin/app/components/members/filters/status.js

@@ -1,8 +1,8 @@
 import {MATCH_RELATION_OPTIONS} from './relation-options';
 
 export const STATUS_FILTER = {
-    label: 'Member status', 
+    label: 'Member status',
-    name: 'status', 
+    name: 'status',
     relationOptions: MATCH_RELATION_OPTIONS,
     valueType: 'options',
     options: [

ghost/admin/app/components/members/filters/subscription-attribution.js

@@ -1,10 +1,10 @@
 import {MATCH_RELATION_OPTIONS} from './relation-options';
 
 export const SUBSCRIPTION_ATTRIBUTION_FILTER = {
-    label: 'Subscription started on post/page', 
+    label: 'Subscription started on post/page',
-    name: 'conversion', 
+    name: 'conversion',
-    valueType: 'string', 
+    valueType: 'string',
-    resource: 'post', 
+    resource: 'post',
     relationOptions: MATCH_RELATION_OPTIONS,
     columnLabel: 'Subscription started on',
     setting: 'membersTrackSources',

ghost/admin/app/components/members/filters/tier.js

@@ -1,10 +1,10 @@
 import {MATCH_RELATION_OPTIONS} from './relation-options';
 
 export const TIER_FILTER = {
-    label: 'Membership tier', 
+    label: 'Membership tier',
-    name: 'tier_id', 
+    name: 'tier_id',
-    valueType: 'array', 
+    valueType: 'array',
-    columnLabel: 'Membership tier', 
+    columnLabel: 'Membership tier',
     relationOptions: MATCH_RELATION_OPTIONS,
     getColumnValue: (member) => {
         return {

ghost/admin/app/controllers/members.js

@@ -209,8 +209,44 @@ export default class MembersController extends Controller {
         return uniqueColumns.splice(0, 2); // Maximum 2 columns
     }
 
-    get isMultiFiltered() {
+    /* Due to a limitation with NQL when multiple member filters are used in combination, we currently have a safeguard around member bulk deletion.
-        return this.isFiltered && this.filters.length >= 2;
+     * Member bulk deletion is not permitted when:
+     *   1) Multiple newsletters exist, and 2 or more newsletter filters are in use
+     *   2) If any of the following Stripe filters are used, even once:
+     *     - Billing period
+     *     - Stripe subscription status
+     *     - Paid start date
+     *     - Next billing date
+     *     - Subscription started on post/page
+     *     - Offers
+     *
+     * See issue https://linear.app/tryghost/issue/ENG-1484 for more context
+     */
+    get isBulkDeletePermitted() {
+        if (!this.isFiltered) {
+            return false;
+        }
+
+        const newsletterFilters = this.filters.filter(f => f.group === 'Newsletters');
+
+        if (newsletterFilters && newsletterFilters.length >= 2) {
+            return false;
+        }
+
+        const stripeFilters = this.filters.filter(f => [
+            'subscriptions.plan_interval',
+            'subscriptions.status',
+            'subscriptions.start_date',
+            'subscriptions.current_period_end',
+            'conversion',
+            'offer_redemptions'
+        ].includes(f.type));
+
+        if (stripeFilters && stripeFilters.length >= 1) {
+            return false;
+        }
+
+        return true;
     }
 
     includeTierQuery() {

ghost/admin/app/templates/members.hbs

@@ -104,14 +104,14 @@
                                         </button>
                                     </li>
                                 {{/if}}
-                                {{#unless this.isMultiFiltered}}
+                                {{#if this.isBulkDeletePermitted}}
                                     <li class="divider"></li>
                                     <li>
                                         <button class="mr2" data-test-button="delete-selected" type="button" {{on "click" this.bulkDelete}}>
                                             <span class="red">Delete selected members ({{this.members.length}})</span>
                                         </button>
                                     </li>
-                                {{/unless}}
+                                {{/if}}
                             {{/if}}
                         </GhDropdown>
                     </span>

ghost/admin/mirage/factories/newsletter.js

@@ -0,0 +1,10 @@
+import moment from 'moment-timezone';
+import {Factory} from 'miragejs';
+
+export default Factory.extend({
+    name(i) { return `Newsletter ${i}`; },
+    slug(i) { return `newsletter-${i}`; },
+    status() { return 'active'; },
+    createdAt() { return moment.utc().toISOString(); },
+    updatedAt() { return moment.utc().toISOString(); }
+});

ghost/admin/tests/acceptance/members-test.js

@@ -143,51 +143,133 @@ describe('Acceptance: Members', function () {
                 .to.equal('example@domain.com');
         });
 
-        /* NOTE: Bulk deletion is disabled temporarily when multiple filters are applied, due to a NQL limitation.
+        /* Due to a limitation with NQL when multiple member filters are used in combination, we currently have a safeguard around member bulk deletion.
-         * Delete this test once we have fixed the root NQL limitation.
+        *  Member bulk deletion is not permitted when:
-         * See https://linear.app/tryghost/issue/ONC-203
+        *   1) Multiple newsletters exist, and 2 or more newsletter filters are in use
+        *   2) If any of the following Stripe filters are used, even once:
+        *     - Billing period
+        *     - Stripe subscription status
+        *     - Paid start date
+        *     - Next billing date
+        *     - Subscription started on post/page
+        *     - Offers
+        *
+        * See code: ghost/admin/app/controllers/members.js:isBulkDeletePermitted
+        * See issue https://linear.app/tryghost/issue/ENG-1484 for more context
+        *
+        * TODO: delete this block of tests once the guardrail has been removed
         */
-        it('cannot bulk delete members if more than 1 filter is selected', async function () {
+        describe('[Temp] Guardrail against bulk deletion', function () {
-            // Members with label
+            it('cannot bulk delete members if more than 1 newsletter filter is used', async function () {
-            const labelOne = this.server.create('label');
+                // Create two newsletters and members subscribed to 1 or 2 newsletters
-            const labelTwo = this.server.create('label');
+                const newsletterOne = this.server.create('newsletter');
-            this.server.createList('member', 2, {labels: [labelOne]});
+                const newsletterTwo = this.server.create('newsletter');
-            this.server.createList('member', 2, {labels: [labelOne, labelTwo]});
+                this.server.createList('member', 2).forEach(member => member.update({newsletters: [newsletterOne], email_disabled: 0}));
+                this.server.createList('member', 2).forEach(member => member.update({newsletters: [newsletterOne, newsletterTwo], email_disabled: 0}));
 
-            await visit('/members');
+                await visit('/members');
-            expect(findAll('[data-test-member]').length).to.equal(4);
+                expect(findAll('[data-test-member]').length).to.equal(4);
 
-            // The delete button should not be visible by default
+                // The delete button should not be visible by default
-            await click('[data-test-button="members-actions"]');
+                await click('[data-test-button="members-actions"]');
-            expect(find('[data-test-button="delete-selected"]')).to.not.exist;
+                expect(find('[data-test-button="delete-selected"]')).to.not.exist;
 
-            // Apply a single filter
+                // Apply a first filter
-            await click('[data-test-button="members-filter-actions"]');
+                await click('[data-test-button="members-filter-actions"]');
-            await fillIn('[data-test-members-filter="0"] [data-test-select="members-filter"]', 'label');
+                await fillIn('[data-test-members-filter="0"] [data-test-select="members-filter"]', `newsletters.slug:${newsletterOne.slug}`);
-            await click('.gh-member-label-input input');
+                await click(`[data-test-button="members-apply-filter"]`);
-            await click(`[data-test-label-filter="${labelOne.name}"]`);
-            await click(`[data-test-button="members-apply-filter"]`);
 
-            expect(findAll('[data-test-member]').length).to.equal(4);
+                expect(findAll('[data-test-member]').length).to.equal(4);
-            expect(currentURL()).to.equal(`/members?filter=label%3A%5B${labelOne.slug}%5D`);
+                expect(currentURL()).to.equal(`/members?filter=(newsletters.slug%3A${newsletterOne.slug}%2Bemail_disabled%3A0)`);
 
-            await click('[data-test-button="members-actions"]');
+                // Bulk deletion is permitted
-            expect(find('[data-test-button="delete-selected"]')).to.exist;
+                await click('[data-test-button="members-actions"]');
+                expect(find('[data-test-button="delete-selected"]')).to.exist;
 
-            // Apply a second filter
+                // Apply a second filter
-            await click('[data-test-button="members-filter-actions"]');
+                await click('[data-test-button="members-filter-actions"]');
-            await click('[data-test-button="add-members-filter"]');
+                await click('[data-test-button="add-members-filter"]');
+                await fillIn('[data-test-members-filter="1"] [data-test-select="members-filter"]', `newsletters.slug:${newsletterTwo.slug}`);
+                await click(`[data-test-button="members-apply-filter"]`);
 
-            await fillIn('[data-test-members-filter="1"] [data-test-select="members-filter"]', 'label');
+                expect(findAll('[data-test-member]').length).to.equal(2);
-            await click('[data-test-members-filter="1"] .gh-member-label-input input');
+                expect(currentURL()).to.equal(`/members?filter=(newsletters.slug%3A${newsletterOne.slug}%2Bemail_disabled%3A0)%2B(newsletters.slug%3A${newsletterTwo.slug}%2Bemail_disabled%3A0)`);
-            await click(`[data-test-members-filter="1"] [data-test-label-filter="${labelTwo.name}"]`);
-            await click(`[data-test-button="members-apply-filter"]`);
 
-            expect(findAll('[data-test-member]').length).to.equal(2);
+                // Bulk deletion is not permitted anymore
-            expect(currentURL()).to.equal(`/members?filter=label%3A%5B${labelOne.slug}%5D%2Blabel%3A%5B${labelTwo.slug}%5D`);
+                await click('[data-test-button="members-actions"]');
+                expect(find('[data-test-button="delete-selected"]')).to.not.exist;
+            });
 
-            await click('[data-test-button="members-actions"]');
+            it('can bulk delete members if a non-Stripe subscription filter is in use (member tier, status)', async function () {
-            expect(find('[data-test-button="delete-selected"]')).to.not.exist;
+                const tier = this.server.create('tier', {id: 'qwerty123456789'});
+                this.server.createList('member', 2, {status: 'free'});
+                this.server.createList('member', 2, {status: 'paid', tiers: [tier]});
+
+                await visit('/members');
+                expect(findAll('[data-test-member]').length).to.equal(4);
+
+                // The delete button should not be visible by default
+                await click('[data-test-button="members-actions"]');
+                expect(find('[data-test-button="delete-selected"]')).to.not.exist;
+
+                // 1) Membership tier filter: permitted
+                await visit(`/members?filter=tier_id:[${tier.id}]`);
+                expect(findAll('[data-test-member]').length).to.equal(2);
+                await click('[data-test-button="members-actions"]');
+                expect(find('[data-test-button="delete-selected"]')).to.exist;
+
+                // 2) Member status filter: permitted
+                await visit('/members?filter=status%3Afree');
+                expect(findAll('[data-test-member]').length).to.equal(2);
+                await click('[data-test-button="members-actions"]');
+                expect(find('[data-test-button="delete-selected"]')).to.exist;
+            });
+
+            it('cannot bulk delete members if a Stripe subscription filter is in use', async function () {
+                // Create free and paid members
+                const tier = this.server.create('tier');
+                const offer = this.server.create('offer', {tier: {id: tier.id}, createdAt: moment.utc().subtract(1, 'day').valueOf()});
+                this.server.createList('member', 2, {status: 'free'});
+                this.server.createList('member', 2, {status: 'paid'}).forEach(member => this.server.create('subscription', {member, planInterval: 'month', status: 'active', start_date: '2000-01-01T00:00:00.000Z', current_period_end: '2000-02-01T00:00:00.000Z', offer: offer, tier: tier}));
+                this.server.createList('member', 2, {status: 'paid'}).forEach(member => this.server.create('subscription', {member, planInterval: 'year', status: 'active'}));
+
+                await visit('/members');
+                expect(findAll('[data-test-member]').length).to.equal(6);
+
+                // The delete button should not be visible by default
+                await click('[data-test-button="members-actions"]');
+                expect(find('[data-test-button="delete-selected"]')).to.not.exist;
+
+                // 1) Stripe billing period filter: not permitted
+                await visit('/members?filter=subscriptions.plan_interval%3Amonth');
+                expect(findAll('[data-test-member]').length).to.equal(2);
+                await click('[data-test-button="members-actions"]');
+                expect(find('[data-test-button="delete-selected"]')).to.not.exist;
+
+                // 2) Stripe subscription status filter: not permitted
+                await visit('/members?filter=subscriptions.status%3Aactive');
+                expect(findAll('[data-test-member]').length).to.equal(4);
+                await click('[data-test-button="members-actions"]');
+                expect(find('[data-test-button="delete-selected"]')).to.not.exist;
+
+                // 3) Stripe paid start date filter: not permitted
+                await visit(`/members?filter=subscriptions.start_date%3A>'1999-01-01%2005%3A59%3A59'`);
+                expect(findAll('[data-test-member]').length).to.equal(2);
+                await click('[data-test-button="members-actions"]');
+                expect(find('[data-test-button="delete-selected"]')).to.not.exist;
+
+                // 4) Next billing date filter: not permitted
+                await visit(`/members?filter=subscriptions.current_period_end%3A>'2000-01-01%2005%3A59%3A59'`);
+                expect(findAll('[data-test-member]').length).to.equal(2);
+                await click('[data-test-button="members-actions"]');
+                expect(find('[data-test-button="delete-selected"]')).to.not.exist;
+
+                // 5) Offers redeemed filter: not permitted
+                await visit('/members?filter=' + encodeURIComponent(`offer_redemptions:'${offer.id}'`));
+                expect(findAll('[data-test-member]').length).to.equal(2);
+                await click('[data-test-button="members-actions"]');
+                expect(find('[data-test-button="delete-selected"]')).to.not.exist;
+            });
         });
 
         it('can bulk delete members', async function () {