Prebid Upgrade v2.32.0

.github/workflows/adapter-code-coverage.yml

@@ -1,27 +1,30 @@
-name: Adapter code coverage
+name: Adapter Code Coverage
+
 on:
   pull_request_target:
     paths: ["adapters/*/*.go"]
+
 permissions:
   pull-requests: write
   contents: write
+
 jobs:
   run-coverage:
     runs-on: ubuntu-latest
     steps:
       - name: Install Go
         uses: actions/setup-go@v5
         with:
-          go-version: 1.20.5
+          go-version: 1.22.3
 
-      - name: Checkout pull request branch
+      - name: Checkout Code
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
           ref: ${{github.event.pull_request.head.ref}}
           repository: ${{github.event.pull_request.head.repo.full_name}}
 
-      - name: Get adapter directories
+      - name: Discover Adapter Directories
         id: get_directories
         uses: actions/github-script@v7
         with:
@@ -40,7 +43,7 @@ jobs:
             // run coverage for maximum of 2 directories
             return (directories.length == 0 || directories.length > 2) ? "" : JSON.stringify(directories)
 
-      - name: Run coverage tests
+      - name: Run Coverage Tests
         id: run_coverage
         if: steps.get_directories.outputs.result != ''
         run: |
@@ -74,14 +77,14 @@ jobs:
           TOKEN: ${{ secrets.PM_OPENWRAP_CICD_PASSWORD }}
           USERNAME: ${{ secrets.PM_OPENWRAP_CICD_USERNAME }}
 
-      - name: Checkout coverage-preview branch
+      - name: Checkout Coverage Preview Branch
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
           ref: coverage-preview
           repository: PubMatic-OpenWrap/prebid-server
 
-      - name: Commit coverage files to coverage-preview branch
+      - name: Upload Coverage Results
         if: steps.run_coverage.outputs.coverage_dir != ''
         id: commit_coverage
         run: |
@@ -95,11 +98,11 @@ jobs:
           git push origin coverage-preview
           echo "remote_coverage_preview_dir=${directory}" >> $GITHUB_OUTPUT
 
-      - name: Checkout master branch
+      - name: Checkout Master Branch
         if: steps.get_directories.outputs.result != ''
         run: git checkout master
 
-      - name: Add coverage summary to pull request
+      - name: Add Coverage Summary To Pull Request
         if: steps.run_coverage.outputs.coverage_dir != '' && steps.commit_coverage.outputs.remote_coverage_preview_dir != ''
         uses: actions/github-script@v7
         with:

.github/workflows/semgrep.yml

@@ -1,21 +1,24 @@
-name: Adapter semgrep checks
+name: Adapter Semgrep Check
+
 on:
   pull_request_target:
     paths: ["adapters/*/*.go"]
+
 permissions: 
     pull-requests: write
+
 jobs:
   semgrep-check:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout repo
+      - name: Checkout Code
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
           ref: ${{github.event.pull_request.head.ref}}
           repository: ${{github.event.pull_request.head.repo.full_name}}
 
-      - name: Calculate diff
+      - name: Calculate Code Diff
         id: calculate_diff
         uses: actions/github-script@v7
         with:
@@ -29,7 +32,7 @@ jobs:
             const helper = utils.diffHelper({github, context, fileNameFilter, event: "${{github.event.action}}", testName: "${{github.job}}"})
             return await helper.buildDiff()
 
-      - name: Should run semgrep
+      - name: Check For Changes
         id: should_run_semgrep
         run: |
           hasChanges=$(echo '${{ steps.calculate_diff.outputs.result }}' | jq .pullRequest.hasChanges)
@@ -41,15 +44,15 @@ jobs:
           pip3 install semgrep==1.22.0
           semgrep --version
 
-      - name: Run semgrep tests
+      - name: Run Semgrep
         id: run_semgrep_tests
         if: contains(steps.should_run_semgrep.outputs.hasChanges, 'true')
         run: |
           unqouted_string=$(echo '${{ steps.calculate_diff.outputs.result }}' | jq .pullRequest.files | tr -d '"')
           outputs=$(semgrep --gitlab-sast --config=.semgrep/adapter $unqouted_string  | jq '[.vulnerabilities[] | {"file": .location.file, "severity": .severity, "start": .location.start_line, "end": .location.end_line, "message": (.message | gsub("\\n"; "\n"))}]' | jq -c | jq -R)
           echo "semgrep_result=${outputs}" >> "$GITHUB_OUTPUT"
 
-      - name: Add pull request comment
+      - name: Add Pull Request Comment
         id: add_pull_request_comment
         if: contains(steps.should_run_semgrep.outputs.hasChanges, 'true')
         uses: actions/github-script@v7
@@ -66,7 +69,7 @@ jobs:
             const { previousScan, currentScan } = await helper.addReviewComments()
             return previousScan.unAddressedComments + currentScan.newComments
 
-      - name: Adapter semgrep checks result
+      - name: Check Results
         if: contains(steps.should_run_semgrep.outputs.hasChanges, 'true')
         run: |
           if [ "${{steps.add_pull_request_comment.outputs.result}}" -ne "0" ]; then

.github/workflows/validate-merge.yml

@@ -15,7 +15,7 @@ jobs:
     - name: Install Go
       uses: actions/setup-go@v5
       with:
-        go-version: 1.20.5
+        go-version: 1.22.3
 
     - name: Checkout Merged Branch
       uses: actions/checkout@v4

.github/workflows/validate.yml

@@ -16,7 +16,7 @@ jobs:
   validate:
     strategy:
       matrix:
-        go-version: [1.20.x]
+        go-version: [1.21.x, 1.22.x]
         os: [ubuntu-20.04]
     runs-on: ${{ matrix.os }}
 

.gitignore

@@ -8,6 +8,7 @@ _obj
 _test
 .cover/
 .idea/
+.vscode/
 
 # Architecture specific extensions/prefixes
 *.[568vq]
@@ -44,11 +45,8 @@ analytics/config/xyz*
 analytics/build/xyz*
 analytics/filesystem/testFiles/
 
-# autogenerated version file
-# static/version.txt
-
-.idea/
-.vscode/
+# autogenerated files
+prebid-server.iml
 
 # autogenerated mac file
 

Dockerfile

@@ -3,18 +3,22 @@ RUN apt-get update && \
     apt-get -y upgrade && \
     apt-get install -y wget
 WORKDIR /tmp
-RUN wget https://dl.google.com/go/go1.20.5.linux-amd64.tar.gz && \
-    tar -xf go1.20.5.linux-amd64.tar.gz && \
+RUN wget https://dl.google.com/go/go1.22.3.linux-amd64.tar.gz && \
+    tar -xf go1.22.3.linux-amd64.tar.gz && \
     mv go /usr/local
 RUN mkdir -p /app/prebid-server/
 WORKDIR /app/prebid-server/
 ENV GOROOT=/usr/local/go
 ENV PATH=$GOROOT/bin:$PATH
 ENV GOPROXY="https://proxy.golang.org"
+
+# Installing gcc as cgo uses it to build native code of some modules
 RUN apt-get update && \
-    apt-get install -y git && \
+    apt-get install -y git gcc && \
     apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
-ENV CGO_ENABLED 0
+
+# CGO must be enabled because some modules depend on native C code
+ENV CGO_ENABLED 1
 COPY ./ ./
 RUN go mod tidy
 RUN go mod vendor
@@ -30,8 +34,10 @@ RUN chmod a+xr prebid-server
 COPY static static/
 COPY stored_requests/data stored_requests/data
 RUN chmod -R a+r static/ stored_requests/data
+
+# Installing libatomic1 as it is a runtime dependency for some modules
 RUN apt-get update && \
-    apt-get install -y ca-certificates mtr && \
+    apt-get install -y ca-certificates mtr libatomic1 && \
     apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
 RUN adduser prebid_user
 USER prebid_user

README.md

@@ -35,11 +35,16 @@ or compile a standalone binary using the command:
 ``` bash
 go build .
 ```
+**Note:** if building from source there are a couple dependencies to be aware of: 
+1. *Compile-time*. Some modules ship native code that requires `cgo` (comes with the `go` compiler) being enabled - by default it is and environment variable `CGO_ENABLED=1` do NOT set it to `0`.
+2. *Compile-time*. `cgo` depends on the C-compiler, which usually is `gcc`, but can be changed by setting the value of `CC` env var, f.e. `CC=clang`.  On ubuntu `gcc` can be installed via `sudo apt-get install gcc`. 
+3. *Runtime*. Some modules require `libatomic`.  On ubuntu it is installed by running `sudo apt-get install libatomic1`.  `libatomic1` is a dependency of `gcc`, so if you are building with `gcc` and running on the same machine, it is likely that `libatomic1` is already installed.   
+
 Ensure that you deploy the `/static` directory, as Prebid Server requires those files at startup.
 
 ## Developing
 
-Prebid Server requires [Go](https://go.dev) version 1.19 or newer. You can develop on any operating system that Go supports; however, please note that our helper scripts are written in bash.
+Prebid Server requires [Go](https://go.dev) version 1.21 or newer. You can develop on any operating system that Go supports; however, please note that our helper scripts are written in bash.
 
 ```bash
 cd YOUR_DIRECTORY

adapters/adapterstest/test_json.go

@@ -226,9 +226,10 @@ type expectedBidResponse struct {
 }
 
 type expectedBid struct {
-	Bid  json.RawMessage `json:"bid"`
-	Type string          `json:"type"`
-	Seat string          `json:"seat"`
+	Bid   json.RawMessage `json:"bid"`
+	Type  string          `json:"type"`
+	Seat  string          `json:"seat"`
+	Video json.RawMessage `json:"video,omitempty"`
 }
 
 // ---------------------------------------
@@ -342,6 +343,9 @@ func diffBids(t *testing.T, description string, actual *adapters.TypedBid, expec
 	assert.Equal(t, string(expected.Seat), string(actual.Seat), fmt.Sprintf(`%s.seat "%s" does not match expected "%s."`, description, string(actual.Seat), string(expected.Seat)))
 	assert.Equal(t, string(expected.Type), string(actual.BidType), fmt.Sprintf(`%s.type "%s" does not match expected "%s."`, description, string(actual.BidType), string(expected.Type)))
 	assert.NoError(t, diffOrtbBids(fmt.Sprintf("%s.bid", description), actual.Bid, expected.Bid))
+	if expected.Video != nil {
+		assert.NoError(t, diffBidVideo(fmt.Sprintf("%s.video", description), actual.BidVideo, expected.Video))
+	}
 }
 
 // diffOrtbBids compares the actual Bid made by the adapter to the expectation from the JSON file.
@@ -358,6 +362,15 @@ func diffOrtbBids(description string, actual *openrtb2.Bid, expected json.RawMes
 	return diffJson(description, actualJson, expected)
 }
 
+func diffBidVideo(description string, actual *openrtb_ext.ExtBidPrebidVideo, expected json.RawMessage) error {
+	actualJson, err := json.Marshal(actual)
+	if err != nil {
+		return fmt.Errorf("%s failed to marshal actual Bid Video into JSON. %v", description, err)
+	}
+
+	return diffJson(description, actualJson, []byte(expected))
+}
+
 // diffJson compares two JSON byte arrays for structural equality. It will produce an error if either
 // byte array is not actually JSON.
 func diffJson(description string, actual []byte, expected []byte) error {

adapters/adgeneration/adgeneration_test.go

@@ -259,6 +259,7 @@ func checkBidResponse(t *testing.T, bidderResponse *adapters.BidderResponse, exp
 	var expectedCrID string = "Dummy_supership.jp"
 	var extectedDealID string = "test-deal-id"
 
+	//nolint: staticcheck // false positive SA5011: possible nil pointer dereference
 	assert.Equal(t, expectedCurrency, bidderResponse.Currency)
 	assert.Equal(t, 1, len(bidderResponse.Bids))
 	assert.Equal(t, expectedID, bidderResponse.Bids[0].Bid.ID)