Added e2e tests for post.published.edited webhook

[kritikash18]

Added e2e tests for post.published.edited webhook

Refs #15537

[kritikash18]

Hi @naz, I seem to be running into an odd issue with this one.

When I run single test suite with command:
yarn test:single test/e2e-webhooks/posts.test.js

Everything works fine and I get this result:

7 passing (4s)
✨  Done in 6.11s.

But when I run all test suites using this command:
yarn test:all

I get this result:

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

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

- Expected properties  - 7
+ Received value       + 7

@@ -13,13 +13,13 @@
              },
            ],
            "updated_at": StringMatching /\\d\{4\}-\\d\{2\}-\\d\{2\}T\\d\{2\}:\\d\{2\}:\\d\{2\}\\\.000Z/,
          },
        ],
-       "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": "634d776ee8a14c09c4c36ef5",
+       "created_at": "2022-10-17T15:40:30.000Z",
+       "id": "634d776ee8a14c09c4c36ef5",
        "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 {
@@ -28,11 +28,11 @@
              "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/,
        },
-       "published_at": StringMatching /\\d\{4\}-\\d\{2\}-\\d\{2\}T\\d\{2\}:\\d\{2\}:\\d\{2\}\\\.000Z/,
+       "published_at": "2022-10-17T15:40:30.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/,
@@ -41,13 +41,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-17T15:40:30.000Z",
+       "url": "http://127.0.0.1:2369/testing-post-published-edited-webhook/",
+       "uuid": "08c2b1d7-3cd1-4b1f-a15a-016c137029cc",
      },
      "previous": Object {
        "tiers": Array [

Any pointers on what could I be missing?

[codecov]

Codecov Report

Base: 52.92% // Head: 52.91% // Decreases project coverage by -0.00% ⚠️

Coverage data is based on head (58e6153) compared to base (48b033f).
Patch has no changes to coverable lines.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #15642      +/-   ##
==========================================
- Coverage   52.92%   52.91%   -0.01%     
==========================================
  Files        1465     1465              
  Lines       95683    95683              
  Branches    10739    10739              
==========================================
- Hits        50639    50631       -8     
- Misses      43800    43808       +8     
  Partials     1244     1244              

Impacted Files	Coverage Δ
ghost/admin/app/helpers/gh-price-amount.js	44.44% <0.00%> (-22.23%)	⬇️
ghost/admin/app/components/gh-file-uploader.js	82.94% <0.00%> (-3.11%)	⬇️
ghost/admin/app/components/gh-site-iframe.js	43.18% <0.00%> (-2.28%)	⬇️
ghost/admin/app/controllers/offer.js	41.57% <0.00%> (-0.53%)	⬇️

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.

[naz]

Hey-hey @kritikash18 👋 Could this possibly be a problem with matching the "author" propery like the discussed here? 🤔

[halldorbjarni]

Hey @kritikash18, I was curious if this was the same issue that I ran into. It turns out the routing issue is present here but it's actually the reason your single test suite run works.

yarn test:single test/e2e-webhooks/posts.test.js generates a post['current']['url'] = 'http://127.0.0.1:2369/404/' due to the routing bug mentioned above and sends it to the webhook. Luckily this still matches the regex for anyLocalURL perfectly.

However, yarn test:all generates the correct post['current']['url'] = http://127.0.0.1:2369/testing-post-published-edited-webhook/' but here the regex anyLocalURL doesn't match since it doesn't support dashes. To add it you can edit the anyLocalUrl matcher at Ghost/ghost/core/test/utils/e2e-framework.js to be something like stringMatching(/http:\/\/127.0.0.1:2369\/\[w-]+\//),. Other url allowed symbols could be added as well for completeness.

What I'm mostly curious about is why this matching error is not singled out in the output and instead the jest diff points at all the matchers as a potential problem. Any idea here @naz? I'm not sure if it's a jest bug or a bug in how Ghost directly invokes some internal jest packages.

[naz]

Oh hey @halldorbjarni 👋 Thanks for joining the discussion!

matching error is not singled out in the output

I've came across this issue few times now and I think it's worth the investigation and a separate issue in the test framework. It's super hard to figure out which parts did not match with the current output 💯

[halldorbjarni]

I've came across this issue few times now and I think it's worth the investigation and a separate issue in the test framework.

@naz I agree. It reproduces on a minimal example. I've opened a bug on jest. Let's get this fixed!

[kritikash18]

Updated the local URL to support - and it worked. Thanks for the pointers @naz and @halldorbjarni !

[naz]

ohhh! nice catch here 🎣

[naz]

Good to land in the main 👍 Thanks for great work @kritikash18!

[ErisDS]

@kritikash18 merged and labelled 🎉 Thanks so much for your continued contributions, please keep them coming 🙏