Skip to content
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.

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

Rename idWardRtdProvider to anonymisedRtdProvider #10176

Merged
merged 15 commits into from Apr 26, 2024

Conversation

kyrylenko
Copy link
Contributor

@kyrylenko kyrylenko commented Jul 3, 2023

Type of change

  • Does this change affect user-facing APIs or examples documented on http://prebid.org?
  • Code style update (formatting, local variables)
  • Other

Description of change

Introduced the anonymisedRtdProvider module as a replacement for the idWardRtdProvider because the company https://id-ward.com/ has been rebranded to https://www.anonymised.io/.
idWardRtdProvider module is maintained for backward compatibility until the next major Prebid release (9.0)
Added bidders optional param.
Added “enable_download: false” flag to prevent installations of the old idWardRtdProvider module (docs)

Other information

A link to a PR on the docs repo: prebid/prebid.github.io#4702

@jon-caines-idward
Copy link

Hi @patmmccann, are you able to share the timeline for Prebid 9.0? Thanks.

@patmmccann
Copy link
Collaborator

patmmccann commented Aug 9, 2023

@jon-caines-idward we're debating a release this year or next; in the meantime, you can change a ton of publisher facing branding without changing the module code or file name. You're welcome to proceed with that. For example #10125

I think @ChrisHuie has a way where it can say one thing on the download page / docs website but still point to the old name for people using build scripts.

@jon-caines-idward
Copy link

Hi, @patmmccann we have further changes to make to the RTD module and wish to prioritise our work accordingly. Are we still expecting v9 in 2024 or could it come earlier? Also is there a better channel over which I can ask such questions? With thanks.

@bretg
Copy link
Collaborator

bretg commented Dec 14, 2023

Renames are unfortunately pretty common, so RTD/ID modules need a way of supporting aliases. How can these guys move forward with allowing publishers to utilize the "anonymised" name for new integrations?

@kyrylenko
Copy link
Contributor Author

Hi @bretg , In my latest commit after your review::

  • Renamed all “ID Ward” mentions to “Anonymised” In the old module
  • Added “enable_download: false” flag to prevent installations of the old idWardRtdProvider module (docs)

So now the changes comply with the how do I change the name of my module guide, except the “change the old file so that it includes the new file” because there is a new parameter introduced in the new module, so re-exporting with the name alias is not an option
I believe now it’s ready to be merged

@bretg
Copy link
Collaborator

bretg commented Jan 5, 2024

@patmmccann - looks like what's happened here is a copy of IDWard to anonymisedRtdProvider. Since it seems unlikely that a pub will include both, this seems like a reasonable compromise until RTD Modules support aliases?

@bretg bretg closed this Jan 5, 2024
@bretg bretg reopened this Jan 5, 2024
@jon-caines-idward
Copy link

Hi @bretg, I'm new to this orgs PR review process. Who can conduct the approving PR and when can we expect this to happen? Will this be during the v9 readiness?

@patmmccann
Copy link
Collaborator

We plan to release prebid 9 in May or June

@patmmccann
Copy link
Collaborator

So now the changes comply with the how do I change the name of my module guide, except the “change the old file so that it includes the new file” because there is a new parameter introduced in the new module, so re-exporting with the name alias is not an option
I believe now it’s ready to be merged

We could potentially merge if you come up with a way to solve this problem

@jon-caines-idward
Copy link

So now the changes comply with the how do I change the name of my module guide, except the “change the old file so that it includes the new file” because there is a new parameter introduced in the new module, so re-exporting with the name alias is not an option
I believe now it’s ready to be merged

We could potentially merge if you come up with a way to solve this problem

@patmmccann can you define the problem we are trying to solve? Are you saying that we cannot update the RTD module to the new version as it has an additional parameter to the last one? Surely, there must be a way to iterate its functionality. Please help me break this down for our engineers to understand. Thanks.

@bretg
Copy link
Collaborator

bretg commented Feb 5, 2024

@jon-caines-idward - the problem is that you aren't allowed to make a breaking change until a major release.

But also it sounds like @patmmccann doesn't want you to completely duplicate the code because of maintenance drift. So perhaps you could come up with a way to "include" the new name as part of the old code base, or some kind of alias?

@patmmccann
Copy link
Collaborator

patmmccann commented Feb 24, 2024

there is a new parameter introduced in the new module, so re-exporting with the name alias is not an option
@patmmccann can you define the problem we are trying to solve?

The problem is you aren't following the guidelines on how to rename an adapter, which requires you to import the new adapter from the old adapter so you don't have enormous code duplication and you don't break people's build scripts. If you are trying to add a new required parameter, that is also a breaking change and not allowed to be done in a minor version. If it is an optional parameter, it seems you can add it to the old adapter as well and import the new adapter from it.

@kyrylenko
Copy link
Contributor Author

Hi @patmmccann , I’ve introduced the correction.
The new parameter I made optional.
All the changes are implemented in the new anonymisedRtdProvider.js, while the old idWardRtdProvider.js module just re-exports the needed functionality.
The current implementation completely follows the guidelines on how to rename an adapter

@kyrylenko
Copy link
Contributor Author

Hi @bretg I wanted to follow up on the pull request I recently updated - I believe now the PR completely fulfills the requirements. Could you please review it at your earliest convenience? Thank you!

@bretg bretg requested a review from ChrisHuie March 25, 2024 13:31
@bretg
Copy link
Collaborator

bretg commented Mar 25, 2024

@ChrisHuie - this looks better to me. Over to you and the team for a proper review.

@jon-caines-idward
Copy link

Hello Team Prebid, is there any news on Prebid v9 and when we could expect our revised RTD module in the solution? WIth thanks c.c. @bretg @ChrisHuie @patmmccann

@patmmccann
Copy link
Collaborator

We're opening the branch week of may 5

@patmmccann
Copy link
Collaborator

Actually this is ready to merge now, thanks for your changes!

@patmmccann patmmccann merged commit 2be3f29 into prebid:master Apr 26, 2024
4 checks passed
@jon-caines-idward
Copy link

Many thanks @patmmccann et all. We will keep an eye out for the release announcements.🙏

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.

None yet

5 participants