Feature/bidding and auction #619
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @chasinandrew, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request focuses on improving the Bidding & Auction demo documentation. The changes include updates to the demo's goals, assumptions, and steps, as well as modifications to console logging in SSP components. The documentation updates aim to clarify the demo's purpose and provide more detailed instructions for users.
Highlights
- Documentation Updates: The
bidding-and-auction.mdfile has been updated to clarify the demo's goals, assumptions, and key exclusions. The steps have been revised to provide more precise instructions for users. - Console Logging: Console log messages in
ssp-a,ssp-x, andssp-ycomponents have been modified to provide more context about the auction configurations. - Code Cleanup: Unnecessary code related to encoding requests has been removed from
ssp-y/construct-component-auction.ts.
Changelog
Click here to see the changelog
- docker-compose.yml
- Commented out the
ipamconfiguration for theadnetworknetwork.
- Commented out the
- services/ad-tech/src/public/js/ssp/usecase/bidding-and-auction/ssp-a/construct-component-auction.ts
- Updated console log message to include '[on-device]' to clarify the auction configuration.
- services/ad-tech/src/public/js/ssp/usecase/bidding-and-auction/ssp-x/construct-component-auction.ts
- Updated console log message to include '[B&A only]' to clarify the auction configuration.
- services/ad-tech/src/public/js/ssp/usecase/bidding-and-auction/ssp-y/construct-component-auction.ts
- Removed the
#encodeRequestfunction. - Updated console log message to include '[B&A mixed mode]' to clarify the auction configuration.
- Removed the
- services/home/docs/demos/bidding-and-auction.md
- Updated the demo's goals to emphasize server-side Bidding & Auction services.
- Added a link to the Protected Audience API documentation.
- Clarified the exclusion of more than 2 B&A buyers per seller.
- Updated the Bidding Auction API Flow image URL to use
raw.githubusercontent.com. - Updated the User Journey sequence diagram to reflect the current Bidding & Auction flow.
- Added instructions to delete the docker network before running
npm run start. - Removed
BIDDING_SIGNALS_FETCH_MODEfrom thestart_bfecommands. - Updated the steps to navigate to the shop and news sites with the
bidding-and-auctionquery parameter. - Added details about the differences in the
SSP-Ysub-component auction for B&A.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
In auction's digital dance,
Bids rise with a fleeting glance,
Code whispers the price,
In a server's precise slice,
For ads in a user's trance.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
The pull request includes changes to the bidding and auction demo documentation and some minor code modifications. The documentation updates aim to clarify the demo's purpose and steps, while the code changes involve adding context to console logs and adjusting how auction results are handled. Overall, the changes seem beneficial for improving the demo's usability and understanding.
Summary of Findings
- Documentation Clarity: The updates to the bidding-and-auction.md file enhance the clarity of the demo's goals, assumptions, and steps, making it easier for developers to understand and use the demo.
- Console Log Context: The addition of context to the console logs in the SSP-A, SSP-X, and SSP-Y files provides more information about the type of auction being run, which can be helpful for debugging and understanding the demo's behavior.
- Code Simplification: The removal of the
new Uint8Arraywrapper inssp-y/construct-component-auction.tssimplifies the code and may improve performance, as it avoids unnecessary object creation. - TODO comments in documentation: The documentation contains TODO comments that should be addressed to improve the completeness and accuracy of the documentation.
Merge Readiness
The pull request is almost ready for merging. The documentation updates and code modifications enhance the demo's usability and understanding. However, the TODO comments in the documentation should be addressed before merging to ensure completeness and accuracy. I am unable to approve this pull request, and recommend that others review and approve this code before merging.
* add uint array back * fix bug for contextual * Linter fixes for EJS templates (#618) * Feature/bidding and auction (#619) Documentation Updates: The bidding-and-auction.md file has been updated to clarify the demo's goals, assumptions, and key exclusions. The steps have been revised to provide more precise instructions for users. Console Logging: Console log messages in ssp-a, ssp-x, and ssp-y components have been modified to provide more context about the auction configurations. Code Cleanup: Unnecessary code related to encoding requests has been removed from ssp-y/construct-component-auction.ts. * Bugfix/bna demo for April 18th release (#617) * [docker-compose] ad network configuration Setting network configuration to allow integration with bidding and auction demo. Privacy Sandbox Demos will use 172.16.128.0/24 range to not collide with Bidding and Auction services with fixed ips on 172.16.0.0/24 * package.json scripts - update start command to be able to refresh a specific service. use `npm run start -- [service-name]` - update stop command to remove volumes - update build command to build without cache * docker-compose : fix race condition on ad-tech services ad-tech services are using the same codebase and were all mounting the local ./services/ad-tech folder causing race conditions. Often one of the ad-tech services would not start properly. as a temporary workaround we are removing the filesystem mounted volume. * Bugfix/mmt-multi-touch (#620) * add xxx-news services in firebase for Multi Touch Attribution Demo * multi-touch attribution demo doc : update link * fix firebase_deploy.sh * Bugfix/home docs (#626) * demo docs fixes : - fix issue #624 - fix issue #623 - fix issue #622 - fix issue #621 Documentation Fixes: The PR resolves multiple documentation issues by fixing relative file paths and URLs in the markdown files. It also updates image links to use relative paths instead of absolute URLs. Docusaurus Configuration: The Docusaurus configuration is updated to throw an exception when Markdown links are broken, ensuring link integrity. The trailingSlash option is enabled to add trailing slashes to URLs. Nginx Configuration: The Nginx configuration is strengthened by upgrading Nginx to version 1.27.5-alpine and adding directives for security and optimization. The configuration file is now directly copied to /etc/nginx/nginx.conf instead of using a template. Docker Compose Update: The docker-compose.yml file is updated to use the newer Nginx image version 1.27.5-alpine. Markdown file paths are preferred. see https://docusaurus.io/docs/next/markdown-features/links updated docusaurus config to throw an exception when Markdown links are broken * [home] strenghten nginx configuration upgrade nginx add nginx.conf directives for security and optimization * fix docs link to full sized image hosted on Github * [home] Reintroduce nginx.conf.template (#628) Allows env vars (PORT) in nginx conf --------- Co-authored-by: chasinandrew <[email protected]> Co-authored-by: Severin FERRAND <[email protected]> Co-authored-by: Sid Sahoo <[email protected]>
Description
Affected services
Other: