Test: get `/vtrack` endpoint by marki1an · Pull Request #4238 · prebid/prebid-server-java

marki1an · 2025-10-09T22:16:06Z

🔧 Type of changes

✨ What's the context?

What's the context for the changes?

🧠 Rationale behind the change

Why did you choose to make these changes? Were there any trade-offs you had to consider?

🔎 New Bid Adapter Checklist

verify email contact works
NO fully dynamic hostnames
geographic host parameters are NOT required
direct use of HTTP is prohibited - implement an existing Bidder interface that will do all the job
if the ORTB is just forwarded to the endpoint, use the generic adapter - define the new adapter as the alias of the generic adapter
cover an adapter configuration with an integration test

🧪 Test plan

How do you know the changes are safe to ship to production?

🏎 Quality check

Are your changes following our code style guidelines?
Are there any breaking changes in your code?
Does your test coverage exceed 90%?
Are there any erroneous console logs, debuggers or leftover code in your changes?

…st/vtrack-endpoint

osulzhenko · 2025-10-16T09:59:32Z

+        def responseStatusCode = response.statusCode
+        if (responseStatusCode != OK_200.code()) {
+            def responseBody = response.body.asString()
+            log.error(responseBody)
+            throw new PrebidServerException(responseStatusCode, responseBody, getHeaders(response))
+        }


duplicate of checkResponseStatusCode method

osulzhenko · 2025-10-16T10:12:35Z

+    }
+
+    void setInvalidPostResponse() {
+        mockServerClient.when(request().withPath(endpoint), Times.unlimited(), TimeToLive.unlimited(), -10)


If no method is specified, it won’t be limited to POST

Why do you think an error response might not have a body?

If PBC returns with an error, forward that error to the client with the same HTTP code received from PBC.

osulzhenko · 2025-10-16T10:14:50Z

+                                                                            "cache.host"  : CACHE_HOST]
+    private static final Map<String, String> VALID_INTERNAL_CACHE = ["cache.internal.scheme": "http",
+                                                                     "cache.internal.host"  : "$networkServiceContainer.hostAndPort".toString(),
+                                                                     "cache.internal.path"  : "/cache"]


"cache.internal.path" : CACHE_ENDPOINT]

osulzhenko · 2025-10-16T10:16:47Z

+
+    def "PBS should return 200 status code when get vtrack request contain uuid"() {
+        given: "Random uuid"
+        def uuid = UUID.randomUUID().toString()


We use the UUID only once, so maybe no need for a variable

osulzhenko · 2025-10-16T10:21:12Z

+        prebidCache.setResponse(responseBody)
+
+        when: "PBS processes get vtrack request"
+        def response = defaultPbsService.sendGetVtrackRequest(["uuid": uuid, cacheHost: cacheHost])


why cacheHost and not ch? On PBC:

private static final int UNKNOWN_SIZE_VALUE = 1; ServiceType type; static final String ID_KEY = "uuid"; static final String CACHE_HOST_KEY = "ch"; private static final String UUID_DUPLICATION = "UUID duplication.";

osulzhenko · 2025-10-16T10:51:54Z

+                }
+    }
+
+    void setResponse(String responseBody) {


We can use as example TransferValue from PBC get request

osulzhenko · 2025-10-17T15:23:45Z

+
+    static final TransferValue getTransferValue(){
+        return new TransferValue().tap {
+            adm = "<script type=\\\"text/javascript\\\">\\n      rubicon_cb = Math.random(); rubicon_rurl = document.referrer; if(top.location==document.location){rubicon_rurl = document.location;} rubicon_rurl = escape(rubicon_rurl);\\n      window.rubicon_ad = \\\"4073548\\\" + \\\".\\\" + \\\"js\\\";\\n      window.rubicon_creative = \\\"4458534\\\" + \\\".\\\" + \\\"js\\\";\\n    </script>\\n<div style=\\\"width: 0; height: 0; overflow: hidden;\\\"><img border=\\\"0\\\" width=\\\"1\\\" height=\\\"1\\\" src=\\\"http://beacon-us-iad2.rubiconproject.com/beacon/d/f5b45196-4d05-4e42-8190-264d993c3515?accountId=1001&siteId=113932&zoneId=535510&e=6A1E40E384DA563BD667C48E6BE5FF2436D13A174DE937CDDAAF548B67FBAEBDC779E539A868F72E270E87E31888912083DA7E4E4D5AF24E782EF9778EE5B34E9F0ADFB8523971184242CC624DE62CD4BB342D372FA82497B63ADB685D502967FCB404AD24048D03AFEA50BAA8A987A017B93F2D2A1C5933B4A7786F3B6CF76724F5207A2458AD77E82A954C1004678A\\\" alt=\\\"\\\" /></div>\\n\\n\\n<a href=\\\"http://optimized-by.rubiconproject.com/t/1001/113932/535510-15.4073548.4458534?url=http%3A%2F%2Frubiconproject.com\\\" target=\\\"_blank\\\"><img src=\\\"https://secure-assets.rubiconproject.com/campaigns/1001/50/59/48/1476242257campaign_file_q06ab2.png\\\" border=\\\"0\\\" alt=\\\"\\\" /></a><div style=\\\"height:0px;width:0px;overflow:hidden\\\"><script>(function(){document.write('<iframe src=\\\"https://tap2-cdn.rubiconproject.com/partner/scripts/rubicon/emily.html?pc=1001/113932&geo=na&co=us\\\" frameborder=\\\"0\\\" marginwidth=\\\"0\\\" marginheight=\\\"0\\\" scrolling=\\\"NO\\\" width=\\\"0\\\" height=\\\"0\\\" style=\\\"height:0px;width:0px\\\"></iframe>');})();</script></div>\\n\",\n"


adm = PBSUtils.randomString

osulzhenko · 2025-10-17T15:25:20Z

+        new VTrackResponse().tap {
+            statusCode = response.statusCode()
+            responseBody = decode(response.body.asString(), TransferValue)
+        }


you don't need to check it in tests, it's already there, so just:
decode(response.body.asString(), VTrackResponse)

osulzhenko · 2025-10-17T15:25:34Z

+import groovy.transform.ToString
+
+@ToString(includeNames = true, ignoreNulls = true)
+class VTrackResponse {


osulzhenko · 2025-10-17T15:35:08Z

+    void setResponse(TransferValue vTrackResponse) {
+        mockServerClient.when(request().withPath(endpoint), Times.unlimited(), TimeToLive.unlimited(), -10)
+                .respond { request ->
+                    request.withPath(endpoint)
+                            ? response().withStatusCode(OK_200.code()).withBody(encode(vTrackResponse))
+                            : HttpResponse.notFoundResponse()
+                }
+    }


Same here, and rename to setGetResponse

osulzhenko · 2025-10-17T15:43:10Z

+        prebidCache.setResponse(responseBody)
+
+        when: "PBS processes get vtrack request"
+        def response = defaultPbsService.sendGetVtrackRequest(["uuid": uuid, ch: cacheHost])


["uuid": uuid, "ch": cacheHost]

osulzhenko · 2025-10-17T15:43:32Z

+        prebidCache.setResponse(responseBody)
+
+        when: "PBS processes get vtrack request"
+        def response = pbsServiceWithInternalCache.sendGetVtrackRequest(["uuid": uuid, "cacheHost": cacheHost])


["uuid": uuid, "ch": cacheHost]

osulzhenko · 2025-10-17T16:23:01Z

+    int getVTracGetRequestCount() {
+        getRequestCount(request().withMethod("GET")
+                .withPath(CACHE_ENDPOINT))
+    }


This will give you much more information and allow you to verify parameters (lile getRecordedRequests):

mockServerClient.retrieveRecordedRequests( request().withMethod("GET").withPath("/cache"))

osulzhenko · 2025-10-17T16:26:16Z

+        def initialValue = getCurrentMetricValue(defaultPbsService, VTRACK_READ_OK_METRIC)
+
+        and: "Clean cache mock response"
+        prebidCache.reset(CACHE_ENDPOINT)


no need for it, you have cleanup. Same for others

osulzhenko · 2025-10-17T16:27:28Z

+        and: "Random uuid"
+        def uuid = UUID.randomUUID().toString()
+
+        and: "Clean up and set up successful response"


Here and in all others:
"Setup PBC response"
it's doesn't clean anything

marki1an added 7 commits August 1, 2025 12:55

Add functional tests for get /vtrack endpoint

29eb16c

Update naming

8a51f8c

Update naming

987c185

Update test description

c8bf703

Merge remote-tracking branch 'refs/remotes/origin/vtrack-get' into te…

a99655e

…st/vtrack-endpoint

Add more coverage for /get vtrack endpoint

ff51ee3

Add more coverage metrics for /get vtrack endpoint

10d53db

marki1an self-assigned this Oct 9, 2025

marki1an added the tests Functional or other tests label Oct 9, 2025

marki1an added 6 commits October 13, 2025 20:11

Coverage metrics for cache internal /get vtrack endpoint

a9f27be

Minor update

3119892

Divide ft test for VTrack and Cache Spec

a7fdad4

Update after review

82b8b31

Minor update

54ce21f

Few update mock cache logic

550dc60

osulzhenko requested changes Oct 16, 2025

View reviewed changes

Update after review

b7955a2

osulzhenko requested changes Oct 17, 2025

View reviewed changes

marki1an added 3 commits October 21, 2025 11:24

Update after review

ba31754

Update after review

db1a7d7

Add method POST

7af6891

osulzhenko approved these changes Oct 21, 2025

View reviewed changes

osulzhenko merged commit a1591f9 into vtrack-get Oct 22, 2025
1 check passed

osulzhenko deleted the test/vtrack-endpoint branch October 22, 2025 08:18

Conversation

marki1an commented Oct 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔧 Type of changes

✨ What's the context?

🧠 Rationale behind the change

🔎 New Bid Adapter Checklist

🧪 Test plan

🏎 Quality check

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marki1an Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

marki1an commented Oct 9, 2025 •

edited

Loading

marki1an Oct 16, 2025 •

edited

Loading