Added e2e tests for page.published webhook #15662

Dark-Knight11 · 2022-10-19T16:54:41Z

This adds an e2e test and test snapshot for the page.published webhook so we can prevent regressions and bugs in the future

Got some code for us? Awesome 🎊!

Please include a description of your change & check your PR against this list, thanks!

There's a clear use-case for this code change, explained below
Commit message has a short title & references relevant issues
The build will pass (run yarn test:all and yarn lint)

We appreciate your contribution!

Also, if you'd be interested in writing code like this for us more regularly, we're hiring:
https://careers.ghost.org

Dark-Knight11 · 2022-10-19T17:01:22Z

I need some help with this test
My test for page.published event runs successfully when I run yarn test:single test/e2e-webhooks/page.tests.js
But it fails on yarn test:all
yarn lint also passes all tests
Not sure what's the issue here

naz · 2022-10-20T01:46:19Z

Hey @Dark-Knight11 the issue you are running into might have to do with the "authors" matcher behaving slightly differently when run solo or as a part of all suites. This same issue was discussed deeper in a recent PR. The solution might be adding anyLocalUrl matcher to the authors property matcher. Let me know if that works!

codecov · 2022-10-20T01:52:06Z

Codecov Report

Base: 52.75% // Head: 52.76% // Increases project coverage by +0.00% 🎉

Coverage data is based on head (664bf5e) compared to base (0d3d85d).
Patch has no changes to coverable lines.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #15662   +/-   ##
=======================================
  Coverage   52.75%   52.76%           
=======================================
  Files        1468     1468           
  Lines       95976    95976           
  Branches    10740    10740           
=======================================
+ Hits        50636    50640    +4     
+ Misses      44092    44087    -5     
- Partials     1248     1249    +1

Impacted Files	Coverage Δ
ghost/admin/app/controllers/offer.js	`42.10% <0.00%> (+0.52%)`	⬆️
ghost/admin/app/components/gh-site-iframe.js	`45.45% <0.00%> (+2.27%)`	⬆️
ghost/admin/app/helpers/gh-price-amount.js	`66.66% <0.00%> (+22.22%)`	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Dark-Knight11 · 2022-10-20T10:57:51Z

Hey @Dark-Knight11 the issue you are running into might have to do with the "authors" matcher behaving slightly differently when run solo or as a part of all suites. This same issue was discussed deeper in a recent PR. The solution might be adding anyLocalUrl matcher to the authors property matcher. Let me know if that works!

Nope that didn't work

ErisDS · 2022-10-21T17:54:26Z

Looks to me like you need to update your snapshots?

naz · 2022-10-24T06:04:39Z

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

+            .body({
+                pages: [
+                    {
+                        title: 'testing page.published webhook',


The snapshot tests here are failing most likely because the post title is a bit long and the "anyLocalUrl" matcher did not handle it properly (here is a fix for it form another PR). to make things easier, might just give the page a single-word title OR reuse the fix from the linked above PR

github-actions · 2022-10-24T06:58:07Z

Note from our bot: Some changes have been requested on this pull request. Updating your code is great, but won't notify us, so please leave a comment so that we (and our bot) can see when you've made the changes. Thank you 🙏

Dark-Knight11 · 2022-10-24T08:09:55Z

I think I'm facing some other issue over here

page.* events
       page.published event is triggered:
     "response.body" does not match snapshot.

Snapshot name: `page.* events page.published event is triggered 2: [body] 1`

- Expected properties  - 7
+ Received value       + 7

@@ -14,13 +14,13 @@
            ],
            "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\\/\\w\+\\//,
          },
        ],
-       "comment_id": StringMatching /\[a-f0-9\]\{24\}/,
-       "created_at": StringMatching /\\d\{4\}-\\d\{2\}-\\d\{2\}T\\d\{2\}:\\d\{2\}:\\d\{2\}\\\.000Z/,
-       "id": StringMatching /\[a-f0-9\]\{24\}/,
+       "comment_id": "635647ba4af07d143fc522eb",
+       "created_at": "2022-10-24T08:07:22.000Z",
+       "id": "635647ba4af07d143fc522eb",
        "primary_author": Object {
          "created_at": StringMatching /\\d\{4\}-\\d\{2\}-\\d\{2\}T\\d\{2\}:\\d\{2\}:\\d\{2\}\\\.000Z/,
          "last_seen": StringMatching /\\d\{4\}-\\d\{2\}-\\d\{2\}T\\d\{2\}:\\d\{2\}:\\d\{2\}\\\.000Z/,
          "roles": Array [
            Object {
@@ -30,11 +30,11 @@
            },
          ],
          "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\\/\\w\+\\//,
        },
-       "published_at": StringMatching /\\d\{4\}-\\d\{2\}-\\d\{2\}T\\d\{2\}:\\d\{2\}:\\d\{2\}\\\.000Z/,
+       "published_at": "2022-10-24T08:07:22.000Z",
        "tiers": Array [
          Object {
            "created_at": StringMatching /\\d\{4\}-\\d\{2\}-\\d\{2\}T\\d\{2\}:\\d\{2\}:\\d\{2\}\\\.000Z/,
            "id": StringMatching /\[a-f0-9\]\{24\}/,
            "updated_at": StringMatching /\\d\{4\}-\\d\{2\}-\\d\{2\}T\\d\{2\}:\\d\{2\}:\\d\{2\}\\\.000Z/,
@@ -43,13 +43,13 @@
            "created_at": StringMatching /\\d\{4\}-\\d\{2\}-\\d\{2\}T\\d\{2\}:\\d\{2\}:\\d\{2\}\\\.000Z/,
            "id": StringMatching /\[a-f0-9\]\{24\}/,
            "updated_at": StringMatching /\\d\{4\}-\\d\{2\}-\\d\{2\}T\\d\{2\}:\\d\{2\}:\\d\{2\}\\\.000Z/,
          },
        ],
-       "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\\/\\w\+\\//,
-       "uuid": StringMatching /\[a-f0-9\]\{8\}-\[a-f0-9\]\{4\}-\[a-f0-9\]\{4\}-\[a-f0-9\]\{4\}-\[a-f0-9\]\{12\}/,
+       "updated_at": "2022-10-24T08:07:22.000Z",
+       "url": "http://127.0.0.1:2369/page-published/",
+       "uuid": "e07748f9-c5a1-4cef-9235-2307f9884178",
      },
      "previous": Object {
        "tiers": Array [
          Object {
            "created_at": StringMatching /\\d\{4\}-\\d\{2\}-\\d\{2\}T\\d\{2\}:\\d\{2\}:\\d\{2\}\\\.000Z/,
  AssertionError [ERR_ASSERTION]: undefined undefined undefined
      at new AssertionError (node:internal/assert/assertion_error:467:5)
      at WebhookMockReceiver.matchBodySnapshot (/workspace/Ghost/node_modules/@tryghost/webhook-mock-receiver/lib/webhook-mock-receiver.js:53:23)
      at Context.<anonymous> (test/e2e-webhooks/pages.test.js:124:14)

ErisDS · 2022-10-24T13:53:49Z

config.development.json

+  "server": {
+    "host": "0.0.0.0"
+  }
+}


This should not be in the commit 😬

oh sorry my bad
it wasn't there before though
I'll remove it

ErisDS · 2022-10-24T19:01:02Z

Just to be clear - the above comment from Naz is correct, the tests are failing because your snapshots need to be regenerated.

As you work through these kinds of changes, the snapshots need to be regenerated regularly, especially as there is more than one person working on this - it means we're always adding new snapshots and in this case, there's been a change to one of the matcher regexes.

ref TryGhost#15537 - this adds an e2e test and test snapshot for the page.published webhook so we can prevent regressions and bugs in the future

Dark-Knight11 · 2022-10-25T04:42:52Z

Just to be clear - the above comment from Naz is correct, the tests are failing because your snapshots need to be regenerated.

As you work through these kinds of changes, the snapshots need to be regenerated regularly, especially as there is more than one person working on this - it means we're always adding new snapshots and in this case, there's been a change to one of the matcher regexes.

Yeah but like I do test them on updated snapshots and the tests still fail for test:all and always pass for test:single

Dark-Knight11 · 2022-10-25T05:15:18Z

fixed the issue 👍

Dark-Knight11 · 2022-10-26T13:52:50Z

closing it as someone already made a PR for it

naz self-assigned this Oct 20, 2022

Dark-Knight11 force-pushed the page-published branch from e5f7483 to bdfb6ea Compare October 20, 2022 11:00

Dark-Knight11 closed this Oct 21, 2022

Dark-Knight11 force-pushed the page-published branch from bdfb6ea to 9720459 Compare October 21, 2022 19:23

Dark-Knight11 reopened this Oct 21, 2022

naz reviewed Oct 24, 2022

View reviewed changes

naz added the changes requested label Oct 24, 2022

Dark-Knight11 force-pushed the page-published branch from 6eb08cc to 37f87d1 Compare October 24, 2022 07:38

ErisDS reviewed Oct 24, 2022

View reviewed changes

ErisDS force-pushed the page-published branch from 6f61ef8 to 8927432 Compare October 24, 2022 18:48

Dark-Knight11 and others added 2 commits October 25, 2022 10:06

Added e2e tests for page.published webhook

7db7682

ref TryGhost#15537 - this adds an e2e test and test snapshot for the page.published webhook so we can prevent regressions and bugs in the future

Delete config.development.json

bb0aa06

Dark-Knight11 force-pushed the page-published branch from 8927432 to bb0aa06 Compare October 25, 2022 04:36

Fix test:all fail issue

664bf5e

Dark-Knight11 requested a review from naz October 25, 2022 05:16

Dark-Knight11 closed this Oct 26, 2022

Dark-Knight11 deleted the page-published branch November 1, 2022 08:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added e2e tests for page.published webhook #15662

Added e2e tests for page.published webhook #15662

Dark-Knight11 commented Oct 19, 2022 •

edited

Loading

Dark-Knight11 commented Oct 19, 2022

naz commented Oct 20, 2022

codecov bot commented Oct 20, 2022 •

edited

Loading

Dark-Knight11 commented Oct 20, 2022

ErisDS commented Oct 21, 2022

naz Oct 24, 2022

github-actions bot commented Oct 24, 2022

Dark-Knight11 commented Oct 24, 2022

ErisDS Oct 24, 2022 •

edited

Loading

Dark-Knight11 Oct 24, 2022

ErisDS commented Oct 24, 2022

Dark-Knight11 commented Oct 25, 2022

Dark-Knight11 commented Oct 25, 2022

Dark-Knight11 commented Oct 26, 2022

Added e2e tests for page.published webhook #15662

Added e2e tests for page.published webhook #15662

Conversation

Dark-Knight11 commented Oct 19, 2022 • edited Loading

Dark-Knight11 commented Oct 19, 2022

naz commented Oct 20, 2022

codecov bot commented Oct 20, 2022 • edited Loading

Codecov Report

Dark-Knight11 commented Oct 20, 2022

ErisDS commented Oct 21, 2022

naz Oct 24, 2022

Choose a reason for hiding this comment

github-actions bot commented Oct 24, 2022

Dark-Knight11 commented Oct 24, 2022

ErisDS Oct 24, 2022 • edited Loading

Choose a reason for hiding this comment

Dark-Knight11 Oct 24, 2022

Choose a reason for hiding this comment

ErisDS commented Oct 24, 2022

Dark-Knight11 commented Oct 25, 2022

Dark-Knight11 commented Oct 25, 2022

Dark-Knight11 commented Oct 26, 2022

Dark-Knight11 commented Oct 19, 2022 •

edited

Loading

codecov bot commented Oct 20, 2022 •

edited

Loading

ErisDS Oct 24, 2022 •

edited

Loading