{"id":194,"date":"2023-02-28T07:00:00","date_gmt":"2023-02-28T15:00:00","guid":{"rendered":"https:\/\/dejal.com\/blog\/?p=194"},"modified":"2023-02-27T13:56:40","modified_gmt":"2023-02-27T21:56:40","slug":"a-simon-filters-case-study","status":"publish","type":"post","link":"https:\/\/dejal.com\/blog\/a-simon-filters-case-study\/","title":{"rendered":"A Simon filters case study"},"content":{"rendered":"

<\/p>\n

Before I moved the Dejal blog<\/a> to WordPress, I had a test that was bundled with Simon called \u201cDejal posts\u201d (you may still have this if you\u2019re a long-time customer). This was a great example of using multiple filters to narrow down the output of a Web Page<\/strong> service. While the URL it monitored is no longer valid, it remains a useful example for you to learn more about creating your own filters.<\/p>\n

The general idea of this test was to look at a \u201cRecent Posts\u201d page of the Dejal site, which listed all recent blog, forum, FAQ etc posts and their comments, and output some tidy text describing the most recent one, along with a changed state when a new post or comment is added.<\/p>\n

Firstly, here\u2019s the Service<\/strong> page; nothing remarkable here (the cookies are automatically recorded, and unimportant for this test):<\/p>\n

$\"Service\"$ <\/p>\n

The most interesting page is the Filters<\/strong> one:<\/p>\n

$\"Filters\"$ <\/p>\n

When you check the test and look in the Activity<\/strong> log, you can see the output from each of those filters (from bottom to top):<\/p>\n

$\"Activity\"$ <\/p>\n

Another way to view the output is via the Preview<\/strong> pane, which includes not only the service response and headers, but also the full output of each filter, to help you diagnose each step.<\/p>\n

Here\u2019s the output of the service; the full HTML of the web page:<\/p>\n

$\"Preview0\"$ <\/p>\n

Let\u2019s break down each of the filters, via the Preview<\/strong> filter output.<\/p>\n

The first filter, a Block<\/strong> one, takes the service response as its Input<\/strong>, and has Start<\/strong> text of <tbody><\/code> and End<\/strong> text of <td class=\"replies\"><\/code>. This finds the first occurrence of each of those bits of HTML in the service response, which corresponds with the most recent post information:<\/p>\n

<\/p>\n

This filter outputs that:<\/p>\n

<\/p>\n

The second filter is another Block<\/strong> one. It takes the output of the first filter as its input, and narrows it down further to just the title of the post. Notice that it also uses options disclosed on the right-hand-side of the filter configuration: it looks for the second occurrence of the Start<\/strong> text, searching from the beginning of the input:<\/p>\n

<\/p>\n

The output of this filter is the post title:<\/p>\n

<\/p>\n

The third filter is yet another Block<\/strong> (it is one of the most useful filters), but the input is different: this time it uses the output of the first filter, instead of the previous one (as is the default). It also has an option to look for the third occurrence:<\/p>\n

<\/p>\n

It extracts the author information:<\/p>\n

<\/p>\n

Filter number four is different. It uses an Ignore Links<\/strong> filter to extract out just the author name from the previous filter output. The previous filter doesn\u2019t do this as when you were not logged in on the Dejal site, only the name is included (in which case this filter has no effect):<\/p>\n

<\/p>\n

The output is just the non-HTML part of the input:<\/p>\n

<\/p>\n

Next we\u2019re back to a Block<\/strong> filter again, but this time looking at the original service response text to extract the number of replies to the post:<\/p>\n

<\/p>\n

This should always output a number:<\/p>\n

<\/p>\n

We then use a Singular or Plural<\/strong> filter, to take the number found in the previous filter and output \u201creply<\/code>\u201d if it is one, or \u201creplies<\/code>\u201d for any other number:<\/p>\n

<\/p>\n

As seen in the preview:<\/p>\n

<\/p>\n

The last filter puts it all together: an Override Custom<\/strong> filter uses variables to combine the output of several filters in a nice readable way. In this case all the variables are variations of the filter output, but other variables are available too. Something that isn\u2019t immediately obvious is that you can insert numbers to reference specific filters (otherwise it refers to the previous one):<\/p>\n

<\/p>\n

Which results in:<\/p>\n

<\/p>\n

So now that we\u2019ve got some nice output text, what do we do with it? Of course, you can just see it in the Tests<\/strong> list, if you have the last change and failure displayed:<\/p>\n

<\/p>\n

But you\u2019ll probably want to get a notification:<\/p>\n

<\/p>\n

I hope this case study is helpful. Most tests don\u2019t need a series of filters like this, and there are other ways to achieve similar effects (like writing all the logic in a script), but it can be very useful when you want it. You can use similar techniques in your own tests.<\/p>\n

<\/p>\n<\/body>","protected":false},"excerpt":{"rendered":"

Before I moved the Dejal blog to WordPress, I had a test that was bundled with Simon called \u201cDejal posts\u201d (you may still have this if you\u2019re a long-time customer). This was a great example of using multiple filters to narrow down the output of a Web Page service. While the URL it monitored is […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[16,4],"tags":[],"class_list":["post-194","post","type-post","status-publish","format-standard","hentry","category-faq","category-simon"],"jetpack_featured_media_url":"","jetpack-related-posts":[],"jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/dejal.com\/blog\/wp-json\/wp\/v2\/posts\/194","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/dejal.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/dejal.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/dejal.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/dejal.com\/blog\/wp-json\/wp\/v2\/comments?post=194"}],"version-history":[{"count":2,"href":"https:\/\/dejal.com\/blog\/wp-json\/wp\/v2\/posts\/194\/revisions"}],"predecessor-version":[{"id":196,"href":"https:\/\/dejal.com\/blog\/wp-json\/wp\/v2\/posts\/194\/revisions\/196"}],"wp:attachment":[{"href":"https:\/\/dejal.com\/blog\/wp-json\/wp\/v2\/media?parent=194"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/dejal.com\/blog\/wp-json\/wp\/v2\/categories?post=194"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/dejal.com\/blog\/wp-json\/wp\/v2\/tags?post=194"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}