Skip to content

docs: call out change of after hook result in migration guide #1692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 3, 2021
Merged

docs: call out change of after hook result in migration guide #1692

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6ff3d48
document change of after hook result
davidjgoss Jun 3, 2021
d21c171
better wording
davidjgoss Jun 3, 2021
4dac1f4
whoops
davidjgoss Jun 3, 2021
6a67356
Merge branch 'main' into after-result-migration-doc
aurelien-reeves Jun 3, 2021
bf6af12
Update docs/migration.md
davidjgoss Jun 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 47 additions & 1 deletion docs/migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,52 @@ You'll need to update any `import`/`require` statements in your support code to

(The executable is still `cucumber-js` though.)

## Hooks

The result object passed as the argument to your `After` hook function has a different structure.

Previous in `cucumber`:

```js
{
"sourceLocation": {
"uri": "features/example.feature",
"line": 7
},
"pickle": {...},
"result": {
"duration": 660000000,
"status": "failed",
"exception": {
"name": "AssertionError",
"message": "...",
"showDiff": false,
"stack": "..."
},
"retried": true
}
}
```

Now in `@cucumber/cucumber`:

```js
{
"gherkinDocument": {...}, // schema: https://github.com/cucumber/common/blob/main/messages/jsonschema/GherkinDocument.json
"pickle": {...}, // schema: https://github.com/cucumber/common/blob/main/messages/jsonschema/Pickle.json
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a note, linking to a branch has the potential of going stale. May be better to update these to a tag

"testCaseStartedId": "[uuid]",
"result": {
"status": "FAILED", // one of: UNKNOWN, PASSED, SKIPPED, PENDING, UNDEFINED, AMBIGUOUS, FAILED
"message": "...", // includes stack trace
"duration": {
"seconds": "0",
"nanos": 660000000
},
"willBeRetried": true
}
}
```

## Formatters

The underlying event/data model for cucumber-js is now [cucumber-messages](https://github.com/cucumber/cucumber/tree/master/messages), a shared standard across all official Cucumber implementations. This replaces the old "event protocol".
Expand Down Expand Up @@ -49,4 +95,4 @@ There are a few minor differences to be aware of:
- The type for data tables was named `TableDefinition` - it's now named `DataTable`
- `World` was typed as an interface, but it's actually a class - you should `extend` it when [building a custom formatter](./custom_formatters.md)

Also, your `tsconfig.json` should have the `resolveJsonModule` compiler option switched on. Other than that, a pretty standard TypeScript setup should work as expected.
Also, your `tsconfig.json` should have the `resolveJsonModule` compiler option switched on. Other than that, a pretty standard TypeScript setup should work as expected.