Added e2e tests for page.tag.attached webhook (#15648)

refs: https://github.com/TryGhost/Ghost/issues/15537 - snapshot test created to add confidence to webhook stability and increase overall test coverage.
2024-11-24 14:43:08 +03:00 · 2022-10-30 23:45:51 +07:00 · 2022-10-30 23:45:51 +07:00 · 7df2b7625f
commit 7df2b7625f
parent 3f0713fbc4
2 changed files with 318 additions and 7 deletions
--- a/ghost/core/test/e2e-webhooks/snapshots/pages.test.js.snap
+++ b/ghost/core/test/e2e-webhooks/snapshots/pages.test.js.snap
@ -783,6 +783,262 @@ Object {
 }
 `;

+exports[`page.* events page.tag.attached event is triggered 1: [headers] 1`] = `
+Object {
+  "accept-encoding": "gzip, deflate",
+  "content-length": Any<Number>,
+  "content-type": "application/json",
+  "content-version": StringMatching /v\\\\d\\+\\\\\\.\\\\d\\+/,
+  "user-agent": StringMatching /Ghost\\\\/\\\\d\\+\\\\\\.\\\\d\\+\\\\\\.\\\\d\\+\\\\s\\\\\\(https:\\\\/\\\\/github\\.com\\\\/TryGhost\\\\/Ghost\\\\\\)/,
+}
+`;
+
+exports[`page.* events page.tag.attached event is triggered 2: [body] 1`] = `
+Object {
+  "page": Object {
+    "current": Object {
+      "authors": Array [
+        Object {
+          "accessibility": null,
+          "bio": "bio",
+          "comment_notifications": true,
+          "cover_image": null,
+          "created_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+          "email": "jbloggs@example.com",
+          "facebook": null,
+          "free_member_signup_notification": true,
+          "id": "1",
+          "last_seen": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+          "location": "location",
+          "meta_description": null,
+          "meta_title": null,
+          "name": "Joe Bloggs",
+          "paid_subscription_canceled_notification": false,
+          "paid_subscription_started_notification": true,
+          "profile_image": "https://example.com/super_photo.jpg",
+          "roles": Array [
+            Object {
+              "created_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+              "description": "Blog Owner",
+              "id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+              "name": "Owner",
+              "updated_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+            },
+          ],
+          "slug": "joe-bloggs",
+          "status": "active",
+          "tour": null,
+          "twitter": null,
+          "updated_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+          "url": StringMatching /http:\\\\/\\\\/127\\.0\\.0\\.1:2369\\\\/\\[A-Za-z0-9_-\\]\\+\\\\//,
+          "website": null,
+        },
+      ],
+      "canonical_url": null,
+      "codeinjection_foot": null,
+      "codeinjection_head": null,
+      "comment_id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+      "count": Object {
+        "negative_feedback": 0,
+        "paid_conversions": 0,
+        "positive_feedback": 0,
+        "signups": 0,
+      },
+      "created_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+      "custom_excerpt": null,
+      "custom_template": null,
+      "excerpt": null,
+      "feature_image": null,
+      "feature_image_alt": null,
+      "feature_image_caption": null,
+      "featured": false,
+      "frontmatter": null,
+      "html": null,
+      "id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+      "meta_description": null,
+      "meta_title": null,
+      "mobiledoc": "{\\"version\\":\\"0.3.1\\",\\"ghostVersion\\":\\"4.0\\",\\"markups\\":[],\\"atoms\\":[],\\"cards\\":[],\\"sections\\":[[1,\\"p\\",[[0,[],0,\\"\\"]]]]}",
+      "og_description": null,
+      "og_image": null,
+      "og_title": null,
+      "primary_author": Object {
+        "accessibility": null,
+        "bio": "bio",
+        "comment_notifications": true,
+        "cover_image": null,
+        "created_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+        "email": "jbloggs@example.com",
+        "facebook": null,
+        "free_member_signup_notification": true,
+        "id": "1",
+        "last_seen": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+        "location": "location",
+        "meta_description": null,
+        "meta_title": null,
+        "name": "Joe Bloggs",
+        "paid_subscription_canceled_notification": false,
+        "paid_subscription_started_notification": true,
+        "profile_image": "https://example.com/super_photo.jpg",
+        "roles": Array [
+          Object {
+            "created_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+            "description": "Blog Owner",
+            "id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+            "name": "Owner",
+            "updated_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+          },
+        ],
+        "slug": "joe-bloggs",
+        "status": "active",
+        "tour": null,
+        "twitter": null,
+        "updated_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+        "url": StringMatching /http:\\\\/\\\\/127\\.0\\.0\\.1:2369\\\\/\\[A-Za-z0-9_-\\]\\+\\\\//,
+        "website": null,
+      },
+      "primary_tag": Object {
+        "accent_color": null,
+        "canonical_url": null,
+        "codeinjection_foot": null,
+        "codeinjection_head": null,
+        "created_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+        "description": null,
+        "feature_image": null,
+        "id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+        "meta_description": null,
+        "meta_title": null,
+        "name": "Blogs",
+        "og_description": null,
+        "og_image": null,
+        "og_title": null,
+        "slug": "blogs",
+        "twitter_description": null,
+        "twitter_image": null,
+        "twitter_title": null,
+        "updated_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+        "url": "http://127.0.0.1:2369/404/",
+        "visibility": "public",
+      },
+      "published_at": null,
+      "slug": "testing-page-tag-attached-webhook",
+      "status": "draft",
+      "tags": Array [
+        Object {
+          "accent_color": null,
+          "canonical_url": null,
+          "codeinjection_foot": null,
+          "codeinjection_head": null,
+          "created_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+          "description": null,
+          "feature_image": null,
+          "id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+          "meta_description": null,
+          "meta_title": null,
+          "name": "Blogs",
+          "og_description": null,
+          "og_image": null,
+          "og_title": null,
+          "slug": "blogs",
+          "twitter_description": null,
+          "twitter_image": null,
+          "twitter_title": null,
+          "updated_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+          "url": "http://127.0.0.1:2369/404/",
+          "visibility": "public",
+        },
+      ],
+      "tiers": Array [
+        Object {
+          "active": true,
+          "created_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+          "currency": "usd",
+          "description": null,
+          "id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+          "monthly_price": 500,
+          "monthly_price_id": null,
+          "name": "Default Product",
+          "slug": "default-product",
+          "trial_days": 0,
+          "type": "paid",
+          "updated_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+          "visibility": "public",
+          "welcome_page_url": null,
+          "yearly_price": 5000,
+          "yearly_price_id": null,
+        },
+        Object {
+          "active": true,
+          "created_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+          "currency": null,
+          "description": null,
+          "id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+          "monthly_price": null,
+          "monthly_price_id": null,
+          "name": "Free",
+          "slug": "free",
+          "trial_days": 0,
+          "type": "free",
+          "updated_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+          "visibility": "public",
+          "welcome_page_url": null,
+          "yearly_price": null,
+          "yearly_price_id": null,
+        },
+      ],
+      "title": "testing page.tag.attached webhook",
+      "twitter_description": null,
+      "twitter_image": null,
+      "twitter_title": null,
+      "updated_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+      "url": StringMatching /http:\\\\/\\\\/127\\.0\\.0\\.1:2369\\\\/\\[A-Za-z0-9_-\\]\\+\\\\//,
+      "uuid": StringMatching /\\[a-f0-9\\]\\{8\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{12\\}/,
+      "visibility": "public",
+    },
+    "previous": Object {
+      "tags": Array [],
+      "tiers": Array [
+        Object {
+          "active": true,
+          "created_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+          "currency": "usd",
+          "description": null,
+          "id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+          "monthly_price": 500,
+          "monthly_price_id": null,
+          "name": "Default Product",
+          "slug": "default-product",
+          "trial_days": 0,
+          "type": "paid",
+          "updated_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+          "visibility": "public",
+          "welcome_page_url": null,
+          "yearly_price": 5000,
+          "yearly_price_id": null,
+        },
+        Object {
+          "active": true,
+          "created_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+          "currency": null,
+          "description": null,
+          "id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
+          "monthly_price": null,
+          "monthly_price_id": null,
+          "name": "Free",
+          "slug": "free",
+          "trial_days": 0,
+          "type": "free",
+          "updated_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
+          "visibility": "public",
+          "welcome_page_url": null,
+          "yearly_price": null,
+          "yearly_price_id": null,
+        },
+      ],
+    },
+  },
+}
+`;
+
 exports[`page.* events page.tag.detached event is triggered 1: [headers] 1`] = `
 Object {
  "accept-encoding": "gzip, deflate",
--- a/ghost/core/test/e2e-webhooks/pages.test.js
+++ b/ghost/core/test/e2e-webhooks/pages.test.js
@ -12,8 +12,7 @@ const {
    anyISODateTime,
    anyObjectId,
    anyContentVersion,
-    anyNumber,
-    anyString
+    anyNumber
 } = matchers;

 const tierSnapshot = {
@ -70,15 +69,15 @@ const buildPreviousPageSnapshotWithTiers = (tiersCount) => {
 };

 const buildPreviousPageSnapshotWithTiersAndTags = ({tiersCount, tags}) => {
-    const prevSnap = {
+    const prevSnapshot = {
        tags: tags ? new Array(1).fill(tagSnapshot) : []
    };

    if (tiersCount > 0) {
-        prevSnap.tiers = new Array(tiersCount).fill(tierSnapshot);
+        return {...prevSnapshot, tiers: new Array(tiersCount).fill(tierSnapshot)};
    }

-    return prevSnap;
+    return prevSnapshot;
 };

 describe('page.* events', function () {
@ -209,7 +208,7 @@ describe('page.* events', function () {
                ]
            })
            .expectStatus(201);
-        
+
        const id = res.body.pages[0].id;
        const updatedPage = res.body.pages[0];
        updatedPage.title = 'updated test page';
@ -333,7 +332,7 @@ describe('page.* events', function () {
                'content-length': anyNumber,
                'user-agent': anyGhostAgent
            })
-            .matchBodySnapshot({               
+            .matchBodySnapshot({
                page: {
                    current: buildPageSnapshotWithTiers({
                        published: true,
@ -406,4 +405,60 @@ describe('page.* events', function () {
                }
            });
    });
+
+    it('page.tag.attached event is triggered', async function () {
+        const webhookURL = 'https://test-webhook-receiver.com/page-tag-attached/';
+        await webhookMockReceiver.mock(webhookURL);
+        await fixtureManager.insertWebhook({
+            event: 'page.tag.attached',
+            url: webhookURL
+        });
+
+        const res = await adminAPIAgent
+            .post('pages/')
+            .body({
+                pages: [
+                    {
+                        title: 'testing page.tag.attached webhook',
+                        status: 'draft'
+                    }
+                ]
+            })
+            .expectStatus(201);
+
+        const id = res.body.pages[0].id;
+        const pageTagAttached = res.body.pages[0];
+        pageTagAttached.status = 'draft';
+        pageTagAttached.tags = ['Blogs'];
+
+        await adminAPIAgent
+            .put('pages/' + id)
+            .body({
+                pages: [pageTagAttached]
+            })
+            .expectStatus(200);
+
+        await webhookMockReceiver.receivedRequest();
+
+        webhookMockReceiver
+            .matchHeaderSnapshot({
+                'content-version': anyContentVersion,
+                'content-length': anyNumber,
+                'user-agent': anyGhostAgent
+            })
+            .matchBodySnapshot({
+                page: {
+                    current: buildPageSnapshotWithTiers({
+                        published: false,
+                        tiersCount: 2,
+                        tags: true,
+                        roles: true
+                    }),
+                    previous: buildPreviousPageSnapshotWithTiersAndTags({
+                        tiersCount: 2,
+                        tags: false
+                    })
+                }
+            });
+    });
 });