Skip to content

Fix Allure reporter historyId — use capability key instead of cid#15112

Merged
christian-bromann merged 4 commits intowebdriverio:mainfrom
todti:allure-reporter-fix-history-if
Apr 14, 2026
Merged

Fix Allure reporter historyId — use capability key instead of cid#15112
christian-bromann merged 4 commits intowebdriverio:mainfrom
todti:allure-reporter-fix-history-if

Conversation

@todti
Copy link
Copy Markdown
Contributor

@todti todti commented Feb 24, 2026 •
edited
Loading

Proposed changes

Fixes Allure reporter historyId calculation so it remains stable across runs while still distinguishing the same test run in different environments. The hash is now based on the test's full title and a capability key (browser/device + version) derived from the test run. cid is not used in the hash so Allure history and trends work correctly.

Why cid must NOT be used in historyId

  • cid is unstable across runs. It is a runtime worker/session identifier (e.g. 0-0, 0-1) and depends on the order in which workers or test results start. The same logical test on the same browser can get different cid values in different runs.

  • historyId must be stable for the same test. Allure uses it for history/trends and deduplication. Including cid would make the same test get different historyId values in different runs, breaking history and trends.

  • Uniqueness of result files is ensured by unique result identifiers (e.g. UUID), not by varying historyId per worker.

Changes

  • Removed cid from the hash. No more md5(fullTitle + '#' + cid) fix(@wdio/allure-reporter): include cid in historyId for multi-capabi… #14907 .

  • Added capability-based key. historyId is now md5(fullTitle + '#' + capabilityKey) when capabilities are present. capabilityKey is built from the current test run context only (no filesystem, no cid): e.g. browserName + browserVersion → chrome-68, or deviceName + platformVersion for Appium. Same test in different browsers gets different historyId; same test in the same environment gets the same historyId across runs.

Types of changes

  • Polish (an improvement for an existing feature)
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (improvements to the project's docs)
  • Specification changes (updates to WebDriver command specifications)
  • Internal updates (everything related to internal scripts, governance documentation and CI files)

Checklist

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have added the necessary documentation (if appropriate)
  • I have added proper type definitions for new commands (if appropriate)

Backport Request

//: # (The current main branch is the development branch for WebdriverIO v9. If your change should be released to the current major version of WebdriverIO (v8), please raise another PR with the same changes against the v8 branch.)

  • This change is solely for v9 and doesn't need to be back-ported
  • Back-ported PR at #XXXXX

Further comments

Reviewers: @webdriverio/project-committers

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Feb 24, 2026 •
edited
Loading

Open in StackBlitz

create-wdio

npm i https://pkg.pr.new/webdriverio/webdriverio/create-wdio@15112

eslint-plugin-wdio

npm i https://pkg.pr.new/webdriverio/webdriverio/eslint-plugin-wdio@15112

@wdio/allure-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/allure-reporter@15112

@wdio/appium-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/appium-service@15112

@wdio/browser-runner

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/browser-runner@15112

@wdio/browserstack-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/browserstack-service@15112

@wdio/cli

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/cli@15112

@wdio/concise-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/concise-reporter@15112

@wdio/config

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/config@15112

@wdio/cucumber-framework

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/cucumber-framework@15112

@wdio/dot-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/dot-reporter@15112

@wdio/firefox-profile-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/firefox-profile-service@15112

@wdio/globals

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/globals@15112

@wdio/jasmine-framework

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/jasmine-framework@15112

@wdio/json-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/json-reporter@15112

@wdio/junit-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/junit-reporter@15112

@wdio/lighthouse-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/lighthouse-service@15112

@wdio/local-runner

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/local-runner@15112

@wdio/logger

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/logger@15112

@wdio/mocha-framework

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/mocha-framework@15112

@wdio/protocols

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/protocols@15112

@wdio/repl

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/repl@15112

@wdio/reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/reporter@15112

@wdio/runner

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/runner@15112

@wdio/sauce-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/sauce-service@15112

@wdio/shared-store-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/shared-store-service@15112

@wdio/smoke-test-cjs-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-cjs-service@15112

@wdio/smoke-test-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-reporter@15112

@wdio/smoke-test-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-service@15112

@wdio/spec-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/spec-reporter@15112

@wdio/static-server-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/static-server-service@15112

@wdio/sumologic-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/sumologic-reporter@15112

@wdio/testingbot-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/testingbot-service@15112

@wdio/types

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/types@15112

@wdio/utils

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/utils@15112

@wdio/webdriver-mock-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/webdriver-mock-service@15112

@wdio/xvfb

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/xvfb@15112

webdriver

npm i https://pkg.pr.new/webdriverio/webdriverio/webdriver@15112

webdriverio

npm i https://pkg.pr.new/webdriverio/webdriverio@15112

commit: d19ab12

@christian-bromann
Copy link
Copy Markdown
Member

christian-bromann commented Mar 7, 2026

Thanks @todti , mind updating your branch and resolving the conflict?

@todti todti force-pushed the allure-reporter-fix-history-if branch from f8822ac to bedcf83 Compare March 9, 2026 10:54
@todti
Copy link
Copy Markdown
Contributor Author

todti commented Mar 9, 2026

@christian-bromann done

@todti
Copy link
Copy Markdown
Contributor Author

todti commented Mar 17, 2026

@christian-bromann done with conflicts

@todti
Copy link
Copy Markdown
Contributor Author

todti commented Mar 27, 2026

@christian-bromann

@todti
Copy link
Copy Markdown
Contributor Author

todti commented Apr 13, 2026

@epszaw @christian-bromann could you approve this, please?

@christian-bromann christian-bromann merged commit 59dba38 into webdriverio:main Apr 14, 2026
59 checks passed
@christian-bromann christian-bromann added the PR: Bug Fix 🐛 PRs that contain bug fixes label Apr 14, 2026
@torbenkohlmeier
Copy link
Copy Markdown
Contributor

torbenkohlmeier commented Apr 21, 2026

@todti @christian-bromann
So historyId is now based on capabilityKey which contains the browser version? This means that with every new major browser version (which happens quite often with Chrome) the history is empty. We had this behavior before and it was fixed, did we really introduce it again?

@todti
Copy link
Copy Markdown
Contributor Author

todti commented Apr 21, 2026

I'll remove browser version from historyId asap

@todti todti mentioned this pull request Apr 21, 2026
Open
13 tasks
@torbenkohlmeier
Copy link
Copy Markdown
Contributor

torbenkohlmeier commented Apr 22, 2026

Great, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@christian-bromann christian-bromann christian-bromann approved these changes

Assignees

No one assigned

Labels

PR: Bug Fix 🐛 PRs that contain bug fixes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@todti @christian-bromann @torbenkohlmeier