Merge pull request #157 from privacysandbox/dev

Release dev to main and deploy to prod. v1.1

.env

@@ -5,7 +5,7 @@ EXTERNAL_PORT=443
 PORT=8080
 
 # list of service names
-SERVICES=("home" "news" "shop" "travel" "dsp" "ssp" "idp")
+SERVICES=("home" "news" "shop" "travel" "dsp" "ssp" "idp" "topics" "topics-server")
 
 # home
 HOME_HOST=privacy-sandbox-demos-home.dev
@@ -52,3 +52,14 @@ COLLECTOR_DETAIL="Collect, transform and batch Aggregatable Reports produced by
 IDP_HOST=privacy-sandbox-demos-idp.dev
 IDP_TOKEN=""
 IDP_DETAIL="Identity Provider for relying parties. Also Issuing Private State Token"
+
+## Topics related
+## site to observe topics
+TOPICS_MOTO_HOST=motorcycles.privacy-sandbox-demos-news.dev
+TOPICS_SOCCER_HOST=soccer.privacy-sandbox-demos-news.dev
+TOPICS_GARDENING_HOST=gardening.privacy-sandbox-demos-news.dev
+TOPICS_DETAIL="Topics page"
+
+## server to request topics with headers
+TOPICS_SERVER_HOST=topics-server.privacy-sandbox-demos-news.dev
+TOPICS_SERVER_DETAIL="Topics server"

.gcloudignore

@@ -9,4 +9,5 @@ services/home/.docusaurus
 services/shop/.next
 
 # include services/home/build/* files into `gcloud builds submit` command
-!services/home/build
+# DEPRECATED as we now build html files with ci/cd
+# !services/home/build

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,17 +1,17 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,15 +24,17 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
 
 **Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,10 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 **Is your feature request related to a problem? Please describe.**

.github/PULL_REQUEST_TEMPLATE.md

@@ -4,13 +4,10 @@
 
 Please describe a summary of the changes.
 
-
-
 ## Related Issue
 
 - Fixes #xxx
 
-
 ## Affected services
 
 - [ ] Home

.github/dependabot.yml

@@ -8,134 +8,134 @@ updates:
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-        interval: "monthly"
+      interval: "monthly"
     rebase-strategy: disabled
     commit-message:
-        prefix: "[github-actions] "
-        include: "scope"
+      prefix: "[github-actions] "
+      include: "scope"
   - package-ecosystem: docker
     directory: "/services/home"
     schedule:
       interval: "monthly"
     rebase-strategy: disabled
     commit-message:
-        prefix: "[home] "
-        include: "scope"
+      prefix: "[home] "
+      include: "scope"
     open-pull-requests-limit: 3
   - package-ecosystem: docker
     directory: "/services/dsp"
     schedule:
       interval: "monthly"
     rebase-strategy: disabled
     commit-message:
-        prefix: "[dsp] "
-        include: "scope"
+      prefix: "[dsp] "
+      include: "scope"
     open-pull-requests-limit: 3
   - package-ecosystem: docker
     directory: "/services/ssp"
     schedule:
       interval: "monthly"
     rebase-strategy: disabled
     commit-message:
-        prefix: "[ssp] "
-        include: "scope"
+      prefix: "[ssp] "
+      include: "scope"
     open-pull-requests-limit: 3
   - package-ecosystem: docker
     directory: "/services/news"
     schedule:
       interval: "monthly"
     rebase-strategy: disabled
     commit-message:
-        prefix: "[news] "
-        include: "scope"
+      prefix: "[news] "
+      include: "scope"
     open-pull-requests-limit: 3
   - package-ecosystem: docker
     directory: "/services/shop"
     schedule:
       interval: "monthly"
     rebase-strategy: disabled
     commit-message:
-        prefix: "[shop] "
-        include: "scope"
+      prefix: "[shop] "
+      include: "scope"
     open-pull-requests-limit: 3
   - package-ecosystem: docker
     directory: "/services/travel"
     schedule:
       interval: "monthly"
     rebase-strategy: disabled
     commit-message:
-        prefix: "[travel] "
-        include: "scope"
+      prefix: "[travel] "
+      include: "scope"
     open-pull-requests-limit: 3
   - package-ecosystem: docker
     directory: "/services/collector"
     schedule:
       interval: "monthly"
     rebase-strategy: disabled
     commit-message:
-        prefix: "[collector] "
-        include: "scope"
+      prefix: "[collector] "
+      include: "scope"
     open-pull-requests-limit: 3
   - package-ecosystem: npm
     directory: "/services/home"
     schedule:
       interval: "monthly"
     rebase-strategy: disabled
     commit-message:
-        prefix: "[home] "
-        include: "scope"
+      prefix: "[home] "
+      include: "scope"
     open-pull-requests-limit: 3
   - package-ecosystem: npm
     directory: "/services/dsp"
     schedule:
       interval: "monthly"
     rebase-strategy: disabled
     commit-message:
-        prefix: "[dsp] "
-        include: "scope"
+      prefix: "[dsp] "
+      include: "scope"
     open-pull-requests-limit: 3
   - package-ecosystem: npm
     directory: "/services/ssp"
     schedule:
       interval: "monthly"
     rebase-strategy: disabled
     commit-message:
-        prefix: "[ssp] "
-        include: "scope"
+      prefix: "[ssp] "
+      include: "scope"
     open-pull-requests-limit: 3
   - package-ecosystem: npm
     directory: "/services/news"
     schedule:
       interval: "monthly"
     rebase-strategy: disabled
     commit-message:
-        prefix: "[news] "
-        include: "scope"
+      prefix: "[news] "
+      include: "scope"
     open-pull-requests-limit: 3
   - package-ecosystem: npm
     directory: "/services/shop"
     schedule:
       interval: "monthly"
     rebase-strategy: disabled
     commit-message:
-        prefix: "[shop] "
-        include: "scope"
+      prefix: "[shop] "
+      include: "scope"
     open-pull-requests-limit: 3
   - package-ecosystem: npm
     directory: "/services/travel"
     schedule:
       interval: "monthly"
     rebase-strategy: disabled
     commit-message:
-        prefix: "[travel] "
-        include: "scope"
+      prefix: "[travel] "
+      include: "scope"
     open-pull-requests-limit: 3
   - package-ecosystem: gomod
     directory: "/services/collector/src"
     schedule:
       interval: "monthly"
     rebase-strategy: disabled
     commit-message:
-        prefix: "[collector] "
-        include: "scope"
+      prefix: "[collector] "
+      include: "scope"
     open-pull-requests-limit: 3

.github/workflows/scorecard.yml

@@ -10,9 +10,9 @@ on:
   # To guarantee Maintained check is occasionally updated. See
   # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
   schedule:
-    - cron: '19 9 * * 4'
+    - cron: "19 9 * * 4"
   push:
-    branches: [ "main" ]
+    branches: ["main"]
 
 # Declare default permissions as read only.
 permissions: read-all

README.md

@@ -29,10 +29,11 @@ If you are a developer we recommend you follow the [deployment instructions](doc
 
 The current release supports the following use cases:
 
-| **Use Case**                        | **Description**                                                                                     | **APIs**                             |
-| ----------------------------------- | --------------------------------------------------------------------------------------------------- | ------------------------------------ |
-| Remarking                           | Show relevant ads to a user who has researched a brand or product online.                           | Protected Audience <br> Fenced Frame |
-| Single-touch conversion Attribution | Measure conversion after seeing ads on a news site and buying a project on an online shopping site. | Attribution Reporting API            |
+|         **Category**          |                                **Use Case**                                |            **Privacy Sandbox APIs**            |        **Relevant for**         |
+| :---------------------------: | :------------------------------------------------------------------------: | :--------------------------------------------: | :-----------------------------: |
+|    Show Relevant Video Ads    |       [VAST Video Protected Audience](vast-video-protected-audience)       |             Protected Audience API             | Publisher, SSP, Advertiser, DSP |
+| Show Relevant Content and Ads |            [Retargeting / Remarketing](retargeting-remarketing)            |             Protected Audience API             | Publisher, SSP, Advertiser, DSP |
+|      Measure Digital Ads      | [Single-touch conversion Attribution](single-touch-conversion-attribution) | Attribution Reporting API, Aggregation Service | Publisher, SSP, Advertiser, DSP |
 
 These use cases are based on a set of demo apps and services that we have developed to simulate the actors in the ad tech ecosystem :
 

cicd/.env.dev

@@ -0,0 +1,66 @@
+# External Port (bind by Nginx)
+EXTERNAL_PORT=443
+
+# Bind by each Application Server (fixed value)
+PORT=8080
+
+# list of service names
+SERVICES=("home" "news" "shop" "travel" "dsp" "ssp" "idp" "topics" "topics-server")
+
+# home
+HOME_HOST=privacy-sandcastle-dev-home.web.app
+HOME_TOKEN=""
+HOME_DETAIL="Home page of Privacy Sandbox Demos"
+
+# Publisher
+## news
+NEWS_HOST=privacy-sandcastle-dev-news.web.app
+NEWS_TOKEN=""
+NEWS_DETAIL="Publisher: News media site"
+
+
+# Advertizer
+## shop
+SHOP_HOST=privacy-sandcastle-dev-shop.web.app
+SHOP_TOKEN=""
+SHOP_DETAIL="Advertiser: EC shopping site"
+
+## travel
+TRAVEL_HOST=privacy-sandcastle-dev-travel.web.app
+TRAVEL_TOKEN=""
+TRAVEL_DETAIL="Advertiser: EC travel site"
+
+
+# Adtech
+## dsp
+DSP_HOST=privacy-sandcastle-dev-dsp.web.app
+DSP_TOKEN="A0nDunxZWFAhYvrWCRTblhlyK3D9m0czMNY/m9t2+pG3i1JHkMDasm8m66CwZS54qMeOepb+d9DYjawtBDbDrQgAAACYeyJvcmlnaW4iOiJodHRwczovL3ByaXZhY3ktc2FuZGNhc3RsZS1kZXYtZHNwLndlYi5hcHA6NDQzIiwiZmVhdHVyZSI6IlByaXZhY3lTYW5kYm94QWRzQVBJcyIsImV4cGlyeSI6MTY5NTE2Nzk5OSwiaXNTdWJkb21haW4iOnRydWUsImlzVGhpcmRQYXJ0eSI6dHJ1ZX0="
+DSP_DETAIL="Ad-Platform: DSP for advertiser"
+
+## ssp
+SSP_HOST=privacy-sandcastle-dev-ssp.web.app
+SSP_TOKEN="A3Jo3gcicBIWHTI+QzCeb2h+B4TJX/y8PSngoHtoHeCpnRi2Ny/TFjJ/QtSQhBeS+2x43Jtd5GfksanOOglcVgIAAACYeyJvcmlnaW4iOiJodHRwczovL3ByaXZhY3ktc2FuZGNhc3RsZS1kZXYtc3NwLndlYi5hcHA6NDQzIiwiZmVhdHVyZSI6IlByaXZhY3lTYW5kYm94QWRzQVBJcyIsImV4cGlyeSI6MTY5NTE2Nzk5OSwiaXNTdWJkb21haW4iOnRydWUsImlzVGhpcmRQYXJ0eSI6dHJ1ZX0="
+SSP_DETAIL="Ad-Platform: SSP for publisher"
+
+## Collector for Aggregation Service
+COLLECTOR_HOST=privacy-sandcastle-dev-collector.web.app
+COLLECTOR_TOKEN=""
+COLLECTOR_DETAIL="Collect, transform and batch Aggregatable Reports produced by the Attribution Reporting API and Private Aggregation API."
+
+
+# IDP
+IDP_HOST=privacy-sandcastle-dev-idp.web.app
+IDP_TOKEN=""
+IDP_DETAIL="Identity Provider for relying parties. Also Issuing Private State Token"
+
+## Topics related
+## site to observe topics
+TOPICS_MOTO_HOST=privacy-sandcastle-dev-motorcycles.web.app
+TOPICS_SOCCER_HOST=privacy-sandcastle-dev-soccer-foot.web.app
+TOPICS_GARDENING_HOST=privacy-sandcastle-dev-gardening-potager.web.app
+TOPICS_DETAIL="Topics page"
+
+## server to request topics with headers
+TOPICS_SERVER_HOST=privacy-sandcastle-dev-topics-server.web.app
+TOPICS_SERVER_DETAIL="Topics server"
+