fix: do not trigger site.changed when draft pages are deleted

Applies the draft-aware cache invalidation guard to pages and lightens
the status lookups to fetch only the status column. Adds e2e-webhooks
coverage for the bulk-posts path, draft pages (single + bulk), and
guards that published post/page deletion still invalidates the cache.

Author: 9larsons

ghost/core/core/server/api/endpoints/pages.js

@@ -221,6 +221,19 @@ const controller = {
             method: 'destroy'
         },
         async query(frame) {
+            const pagesToDelete = await models.Post.findAll({
+                filter: frame.options.filter,
+                status: 'all',
+                columns: ['status']
+            });
+
+            const allDraft = pagesToDelete.length > 0 && pagesToDelete.every((page) => {
+                return page.get('status') === 'draft';
+            });
+            if (allDraft) {
+                frame.setHeader('X-Cache-Invalidate', '');
+            }
+
             return await postsService.bulkDestroy(frame.options);
         }
     },
@@ -248,7 +261,17 @@ const controller = {
             docName: 'posts',
             unsafeAttrs: UNSAFE_ATTRS
         },
-        query(frame) {
+        async query(frame) {
+            const page = await models.Post.findOne({
+                id: frame.options.id,
+                type: 'page',
+                status: 'all'
+            }, {require: false, columns: ['status']});
+
+            if (page && page.get('status') === 'draft') {
+                frame.setHeader('X-Cache-Invalidate', '');
+            }
+
             return models.Post.destroy({...frame.options, require: true});
         }
     },

ghost/core/core/server/api/endpoints/posts.js

@@ -269,7 +269,7 @@ const controller = {
     bulkDestroy: {
         statusCode: 200,
         headers: {
-            cacheInvalidate: false
+            cacheInvalidate: true
         },
         options: [
             'filter'
@@ -280,14 +280,15 @@ const controller = {
         async query(frame) {
             const postsToDelete = await models.Post.findAll({
                 filter: frame.options.filter,
-                status: 'all'
+                status: 'all',
+                columns: ['status']
             });
 
-            const allDraft = postsToDelete.every((post) => {
+            const allDraft = postsToDelete.length > 0 && postsToDelete.every((post) => {
                 return post.get('status') === 'draft';
             });
-            if (!allDraft) {
-                frame.setHeader('X-Cache-Invalidate', '/*');
+            if (allDraft) {
+                frame.setHeader('X-Cache-Invalidate', '');
             }
 
             return await postsService.bulkDestroy(frame.options);
@@ -297,7 +298,7 @@ const controller = {
     destroy: {
         statusCode: 204,
         headers: {
-            cacheInvalidate: false
+            cacheInvalidate: true
         },
         options: [
             'include',
@@ -320,10 +321,10 @@ const controller = {
             const post = await models.Post.findOne({
                 id: frame.options.id,
                 status: 'all'
-            }, {require: false});
+            }, {require: false, columns: ['status']});
 
-            if (post && post.get('status') !== 'draft') {
-                frame.setHeader('X-Cache-Invalidate', '/*');
+            if (post && post.get('status') === 'draft') {
+                frame.setHeader('X-Cache-Invalidate', '');
             }
 
             return models.Post.destroy({...frame.options, require: true});

ghost/core/test/e2e-webhooks/site.test.js

@@ -163,4 +163,164 @@ describe('site.* events', function () {
             throw new Error('The webhook should not have been sent.');
         }
     });
+
+    it('site.changed event is NOT triggered when only draft posts are bulk deleted', async function () {
+        const webhookURL = 'https://test-webhook-receiver.com/site-changed';
+        await webhookMockReceiver.mock(webhookURL);
+        await fixtureManager.insertWebhook({
+            event: 'site.changed',
+            url: webhookURL
+        });
+
+        await adminAPIAgent
+            .post('posts/')
+            .body({
+                posts: [{
+                    title: 'bulk draft webhookz',
+                    status: 'draft',
+                    mobiledoc: fixtureManager.get('posts', 1).mobiledoc
+                }]
+            })
+            .expectStatus(201);
+
+        const filter = 'title:\'bulk draft webhookz\'';
+
+        await adminAPIAgent
+            .delete('posts/?filter=' + encodeURIComponent(filter))
+            .expectStatus(200);
+
+        const receivedRequest = webhookMockReceiver.receivedRequest().then(() => true);
+        const wait = new Promise((resolve) => {
+            setTimeout(resolve, 2000, false);
+        });
+
+        const requestWasReceived = await Promise.race([
+            receivedRequest,
+            wait
+        ]);
+
+        if (requestWasReceived) {
+            throw new Error('The webhook should not have been sent.');
+        }
+    });
+
+    it('invalidates the cache when a published post is deleted', async function () {
+        const res = await adminAPIAgent
+            .post('posts/')
+            .body({
+                posts: [{
+                    title: 'published webhookz',
+                    status: 'published',
+                    mobiledoc: fixtureManager.get('posts', 1).mobiledoc
+                }]
+            })
+            .expectStatus(201);
+
+        const id = res.body.posts[0].id;
+
+        await adminAPIAgent
+            .delete('posts/' + id)
+            .expectStatus(204)
+            .expectHeader('X-Cache-Invalidate', '/*');
+    });
+
+    it('site.changed event is NOT triggered when a draft page is deleted', async function () {
+        const webhookURL = 'https://test-webhook-receiver.com/site-changed';
+        await webhookMockReceiver.mock(webhookURL);
+        await fixtureManager.insertWebhook({
+            event: 'site.changed',
+            url: webhookURL
+        });
+
+        const res = await adminAPIAgent
+            .post('pages/')
+            .body({
+                pages: [{
+                    title: 'draft page webhookz',
+                    status: 'draft',
+                    mobiledoc: fixtureManager.get('posts', 1).mobiledoc
+                }]
+            })
+            .expectStatus(201);
+
+        const id = res.body.pages[0].id;
+
+        await adminAPIAgent
+            .delete('pages/' + id)
+            .expectStatus(204);
+
+        const receivedRequest = webhookMockReceiver.receivedRequest().then(() => true);
+        const wait = new Promise((resolve) => {
+            setTimeout(resolve, 2000, false);
+        });
+
+        const requestWasReceived = await Promise.race([
+            receivedRequest,
+            wait
+        ]);
+
+        if (requestWasReceived) {
+            throw new Error('The webhook should not have been sent.');
+        }
+    });
+
+    it('site.changed event is NOT triggered when only draft pages are bulk deleted', async function () {
+        const webhookURL = 'https://test-webhook-receiver.com/site-changed';
+        await webhookMockReceiver.mock(webhookURL);
+        await fixtureManager.insertWebhook({
+            event: 'site.changed',
+            url: webhookURL
+        });
+
+        await adminAPIAgent
+            .post('pages/')
+            .body({
+                pages: [{
+                    title: 'bulk draft page webhookz',
+                    status: 'draft',
+                    mobiledoc: fixtureManager.get('posts', 1).mobiledoc
+                }]
+            })
+            .expectStatus(201);
+
+        const filter = 'title:\'bulk draft page webhookz\'';
+
+        await adminAPIAgent
+            .delete('pages/?filter=' + encodeURIComponent(filter))
+            .expectStatus(200);
+
+        const receivedRequest = webhookMockReceiver.receivedRequest().then(() => true);
+        const wait = new Promise((resolve) => {
+            setTimeout(resolve, 2000, false);
+        });
+
+        const requestWasReceived = await Promise.race([
+            receivedRequest,
+            wait
+        ]);
+
+        if (requestWasReceived) {
+            throw new Error('The webhook should not have been sent.');
+        }
+    });
+
+    it('invalidates the cache when a published page is deleted', async function () {
+        const res = await adminAPIAgent
+            .post('pages/')
+            .body({
+                pages: [{
+                    title: 'published page webhookz',
+                    status: 'published',
+                    mobiledoc: fixtureManager.get('posts', 1).mobiledoc
+                }]
+            })
+            .expectStatus(201);
+
+        const id = res.body.pages[0].id;
+
+        await adminAPIAgent
+            .delete('pages/' + id)
+            .expectStatus(204)
+            .expectHeader('X-Cache-Invalidate', '/*');
+    });
 });