handbook/design/logging/

[giscus[bot]]

handbook/design/logging/

Serenity/JS helps you model your test scenarios from the perspective of actors performing activities to accomplish their goals.

https://serenity-js.org/handbook/design/logging/

[TurekBot]

When logging the text of a web element, it doesn't give me the actual text like I expect, but instead a description of the text. Do you have any advice?

export const helloWorldH1InDomoApp = () =>
    PageElement.located(By.xpath(`//h1`))
        .describedAs('the h1 of the Hello World app in the preview')

...
.otherwise(Log.the(`No recognizable change found here; this one says, ${ Text.of(helloWorldH1InDomoApp()) }`)),
// Results in `No recognizable change found here; this one says, the text of the h1 of the Hello World app in the preview`

[TurekBot]

🤦 I did figure something out. I just moved the Text out of the template and instead passed it to Log.

.otherwise(Log.the(`No recognizable change found here; this one says,`, Text.of(helloWorldH1InDomoApp())))

Let me know if you have other advice. Thanks!

[jan-molak]

@TurekBot - glad you managed to get to the bottom of this!

Yes, this is the correct syntax:

.otherwise(
  Log.the(`No recognizable change found here; this one says,`, Text.of(helloWorldH1InDomoApp()))
)

Log.the accepts a variable number of arguments, where each parameter that's a Question gets passed through actor.answer(question) to retrieve its underlying value.

The trouble with the original implementation below is that JavaScript converts the string template parameter to string and only then it passes the resulting string as parameter to Log.the. Since the Question object returned by Text.of has a toString() method returning its description, JavaScript calls its toString method when attempting to convert an object to a string, and you see the description instead of the actual value

Log.the(`No recognizable change found here; this one says, ${ Text.of(helloWorldH1InDomoApp()) }`)