Skip to content

Showheroes Bid Adapter: rename showheroes bid adapter#14644

Open
FilipStamenkovic wants to merge 2 commits intoprebid:masterfrom
showheroes:showheroes-rename
Open

Showheroes Bid Adapter: rename showheroes bid adapter#14644
FilipStamenkovic wants to merge 2 commits intoprebid:masterfrom
showheroes:showheroes-rename

Conversation

@FilipStamenkovic
Copy link
Copy Markdown
Contributor

Type of change

  • Updated bidder adapter

  • Refactoring (no functional changes, no api changes)

Description of change

Rename showheroes-bs to just showheroes, but keep the showheroes-bs as an alias for backwards compatibility.

Copilot AI review requested due to automatic review settings March 25, 2026 17:11
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 5003925aef

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".


const ENDPOINT = 'https://ads.viralize.tv/openrtb2/auction/';
const BIDDER_CODE = 'showheroes-bs';
const BIDDER_CODE = 'showheroes';
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Preserve legacy module name for build-time compatibility

Changing BIDDER_CODE to showheroes and relying on aliases keeps runtime bidder aliases working, but it does not preserve the old module include name (showheroes-bsBidAdapter) that publishers pass to the build CLI. Because the file was renamed, custom builds that still request the legacy module name now hit the invalid modules path in bundle() (gulpfile.js validates requested module names before bundling), so the intended backward compatibility is incomplete unless you keep a legacy module entry point (e.g., a shim file that re-exports this adapter).

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR renames the ShowHeroes bidder code from showheroes-bs to showheroes, while keeping showheroes-bs as an alias for backward compatibility within the Prebid.js bidder adapter ecosystem.

Changes:

  • Update the adapter’s primary BIDDER_CODE to showheroes and add showheroes-bs as an alias.
  • Update the adapter unit tests to reference the renamed bidder code/module.
  • Update module documentation examples to use showheroes in ad unit configuration.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
test/spec/modules/showheroesBidAdapter_spec.js Switches test setup to the new module import and bidder code (showheroes).
modules/showheroesBidAdapter.md Updates example configuration to use bidder: "showheroes".
modules/showheroesBidAdapter.js Renames primary bidder code to showheroes and adds showheroes-bs to spec.aliases.
Comments suppressed due to low confidence (2)

test/spec/modules/showheroesBidAdapter_spec.js:52

  • PR description states showheroes-bs remains supported for backwards compatibility, but the updated tests no longer cover that alias. Add a unit test that asserts the adapter still exposes/accepts the legacy code (e.g., spec.aliases includes showheroes-bs, and/or that the alias is registered in the bidderFactory/adapterManager if that’s how other adapter tests validate aliases).
    modules/showheroesBidAdapter.md:31
  • Examples were updated to use bidder code showheroes, but the PR also keeps showheroes-bs as a supported alias for backward compatibility. Add a short note near the example config indicating that showheroes-bs is still accepted as an alias (and optionally mention showheroesBs if it remains supported), so existing integrations know they don’t have to migrate immediately.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@FilipStamenkovic
Copy link
Copy Markdown
Contributor Author

FilipStamenkovic commented Mar 25, 2026

Can you include this rename only in the next major release?

EDIT: actually, for us it doesn't have to be the next major release. If you are fine with having a rename in the next PBJS release, let me know to merge this PR into #14643?

@coveralls
Copy link
Copy Markdown
Collaborator

coveralls commented Mar 25, 2026

Coverage Report for CI Build 24424253307

Coverage decreased (-0.001%) to 96.364%

Details

  • Coverage decreased (-0.001%) from the base build.
  • Patch coverage: 5 uncovered changes across 1 file (61 of 66 lines covered, 92.42%).
  • 1 coverage regression across 1 file.

Uncovered Changes

File Changed Covered %
modules/showheroesBidAdapter.js 66 61 92.42%

Coverage Regressions

1 previously-covered line in 1 file lost coverage.

File Lines Losing Coverage Coverage
modules/kinessoIdSystem.js 1 83.15%

Coverage Stats

Coverage Status
Relevant Lines: 227516
Covered Lines: 219244
Line Coverage: 96.36%
Relevant Branches: 52850
Covered Branches: 42934
Branch Coverage: 81.24%
Branches in Coverage %: No
Coverage Strength: 72.81 hits per line

💛 - Coveralls

@patmmccann
Copy link
Copy Markdown
Collaborator

patmmccann commented Apr 13, 2026

please leave the file intact and have it import the spec from the new bidder and open an issue asking for the old file to be deleted in 12

this will cause a linting exception, please disable that linting rule on the old file that imports the spec from the new module

the goal is that no one breaks their build that is referring to your bidder by file

@github-actions
Copy link
Copy Markdown

Whoa there partner! This project is migrating to typescript. Consider changing the new JS files to TS, with well-defined types for what interacts with the prebid public API (for example: bid params and configuration). Thanks!

  • modules/showheroesBidAdapter.js

Tread carefully! This PR adds 1 linter error (possibly disabled through directives):

  • modules/showheroes-bsBidAdapter.js (+1 error)

@FilipStamenkovic
Copy link
Copy Markdown
Contributor Author

@patmmccann Thank you for your review. I think I made the update as you requested. If it's ok, then I also need to make updates to the docs PR.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants