Update DV360 Protobuf Dependencies (#2778)

* Update protobuf-es

* Update protofile.ts --no-verify

* Fix Uses and Tests

* Comment Tests

* Properly mock protobuf

* Fix broken import

* Fix tests

---------

Co-authored-by: Valerie Ernst <[email protected]>

Author: marinhero

packages/destination-actions/package.json

@@ -31,6 +31,8 @@
     "typecheck": "tsc -p tsconfig.build.json --noEmit"
   },
   "devDependencies": {
+    "@bufbuild/buf": "^1.50.0",
+    "@bufbuild/protoc-gen-es": "^2.2.3",
     "@types/google-libphonenumber": "^7.4.23",
     "@types/jest": "^27.0.0",
     "@types/ssh2-sftp-client": "^9.0.0",
@@ -41,9 +43,7 @@
     "@amplitude/ua-parser-js": "^0.7.25",
     "@aws-sdk/client-eventbridge": "^3.741.0",
     "@aws-sdk/client-s3": "^3.600.0",
-    "@bufbuild/buf": "^1.28.0",
-    "@bufbuild/protobuf": "^1.4.2",
-    "@bufbuild/protoc-gen-es": "^1.4.2",
+    "@bufbuild/protobuf": "^2.2.3",
     "@segment/a1-notation": "^2.1.4",
     "@segment/actions-core": "^3.147.0",
     "@segment/actions-shared": "^1.128.0",
@@ -75,7 +75,8 @@
       "@segment/ajv-human-errors": "<rootDir>/../ajv-human-errors/src",
       "@segment/actions-core": "<rootDir>/../core/src",
       "@segment/actions-shared": "<rootDir>/../actions-shared/src",
-      "@segment/destination-subscriptions": "<rootDir>/../destination-subscriptions/src"
+      "@segment/destination-subscriptions": "<rootDir>/../destination-subscriptions/src",
+      "@bufbuild/protobuf/codegenv1": "<rootDir>/../../node_modules/@bufbuild/protobuf/dist/cjs/codegenv1"
     },
     "setupFilesAfterEnv": [
       "<rootDir>/test/setup-after-env.ts"

packages/destination-actions/src/destinations/display-video-360/__tests__/shared.test.ts

@@ -8,7 +8,13 @@ import {
 } from '../shared'
 import { AudienceSettings } from '../generated-types'
 import { UpdateHandlerPayload } from '../types'
-import { UpdateUsersDataResponse, ErrorCode, ErrorInfo } from '../proto/protofile'
+import {
+  UpdateUsersDataResponseSchema,
+  UpdateUsersDataRequestSchema,
+  ErrorCode,
+  ErrorInfoSchema
+} from '../proto/protofile'
+import * as protobuf from '@bufbuild/protobuf'
 import { StatsContext, Response } from '@segment/actions-core'
 import createRequestClient from '../../../../../core/src/create-request-client'
 
@@ -20,6 +26,9 @@ const oneMockPayload: UpdateHandlerPayload = {
   enable_batching: true
 }
 
+const normalizeJson = (jsonString: string) =>
+  JSON.stringify(JSON.parse(jsonString), Object.keys(JSON.parse(jsonString)).sort())
+
 const mockRequestClient = createRequestClient()
 
 const manyMockPayloads: UpdateHandlerPayload[] = [
@@ -67,24 +76,25 @@ const getRandomError = () => {
 
 // Mock only the error code. The contents of the response are not important.
 const createMockResponse = (errorCode: ErrorCode, payload: UpdateHandlerPayload[]) => {
-  const responseHandler = new UpdateUsersDataResponse()
+  const responseHandler = protobuf.create(UpdateUsersDataResponseSchema, {})
   responseHandler.status = errorCode
 
   if (errorCode === ErrorCode.PARTIAL_SUCCESS) {
     // Making assumptions about IdType and UserId here because
     // we are not currently testing their content therefore, it doesn't matter.
 
     responseHandler.errors = payload.map((p) => {
-      const errorInfo = new ErrorInfo()
-      errorInfo.errorCode = getRandomError()
-      errorInfo.userListId = BigInt(p.external_audience_id.split('/').pop() || '-1')
-      errorInfo.userIdType = 0
-      errorInfo.userId = p.google_gid || p.mobile_advertising_id || p.partner_provided_id || ''
+      const errorInfo = protobuf.create(ErrorInfoSchema, {
+        errorCode: getRandomError(),
+        userListId: BigInt(p.external_audience_id.split('/').pop() || '-1'),
+        userIdType: 0,
+        userId: p.google_gid || p.mobile_advertising_id || p.partner_provided_id || ''
+      })
       return errorInfo
     })
   }
 
-  const b = Buffer.from(responseHandler.toBinary())
+  const b = Buffer.from(protobuf.toBinary(UpdateUsersDataResponseSchema, responseHandler))
   const arrayBuffer = b.buffer.slice(b.byteOffset, b.byteOffset + b.byteLength)
 
   return new Response(arrayBuffer, { status: errorCode === ErrorCode.NO_ERROR ? 200 : 400 })
@@ -202,8 +212,19 @@ describe('shared', () => {
       const r = createUpdateRequest(manyMockPayloads, 'add')
       expect(r.ops.length).toEqual(5)
       expect(r.processConsent).toEqual(true)
-      expect(r.toJsonString()).toMatchInlineSnapshot(
-        `"{\\"ops\\":[{\\"userId\\":\\"CAESEHIV8HXNp0pFdHgi2rElMfk\\",\\"userIdType\\":\\"GOOGLE_USER_ID\\",\\"userListId\\":\\"456\\",\\"delete\\":false},{\\"userId\\":\\"3b6e47b3-1437-4ba2-b3c9-446e4d0cd1e5\\",\\"userIdType\\":\\"IDFA\\",\\"userListId\\":\\"456\\",\\"delete\\":false},{\\"userId\\":\\"my-anon-id-42\\",\\"userIdType\\":\\"PARTNER_PROVIDED_ID\\",\\"userListId\\":\\"456\\",\\"delete\\":false},{\\"userId\\":\\"my-anon-id-43\\",\\"userIdType\\":\\"PARTNER_PROVIDED_ID\\",\\"userListId\\":\\"456\\",\\"delete\\":false},{\\"userId\\":\\"XNp0pFdHgi2rElMfk\\",\\"userIdType\\":\\"GOOGLE_USER_ID\\",\\"userListId\\":\\"456\\",\\"delete\\":false}],\\"processConsent\\":true}"`
+      expect(normalizeJson(protobuf.toJsonString(UpdateUsersDataRequestSchema, r))).toEqual(
+        normalizeJson(
+          JSON.stringify({
+            ops: [
+              { userId: 'CAESEHIV8HXNp0pFdHgi2rElMfk', userIdType: 'GOOGLE_USER_ID', userListId: '456', delete: false },
+              { userId: '3b6e47b3-1437-4ba2-b3c9-446e4d0cd1e5', userIdType: 'IDFA', userListId: '456', delete: false },
+              { userId: 'my-anon-id-42', userIdType: 'PARTNER_PROVIDED_ID', userListId: '456', delete: false },
+              { userId: 'my-anon-id-43', userIdType: 'PARTNER_PROVIDED_ID', userListId: '456', delete: false },
+              { userId: 'XNp0pFdHgi2rElMfk', userIdType: 'GOOGLE_USER_ID', userListId: '456', delete: false }
+            ],
+            processConsent: true
+          })
+        )
       )
     })
 
@@ -230,25 +251,33 @@ describe('shared', () => {
     // The response will contain a list of errors. Its content is unknown.
     // The endpoint will return a 400 status code.
     it('should gracefully fail', async () => {
-      nock('https://cm.g.doubleclick.net').post('/upload?nid=segment').reply(400)
-
-      UpdateUsersDataResponse.prototype.fromBinary = jest.fn(() => {
-        const responseHandler = new UpdateUsersDataResponse()
-        responseHandler.status = ErrorCode.PARTIAL_SUCCESS
-        responseHandler.errors = [
-          {
+      jest.spyOn(protobuf, 'fromBinary').mockImplementation(() => ({
+        status: ErrorCode.PARTIAL_SUCCESS,
+        errors: [
+          protobuf.create(ErrorInfoSchema, {
             errorCode: ErrorCode.BAD_DATA,
             userListId: BigInt(456),
             userIdType: 0,
             userId: 'CAESEHIV8HXNp0pFdHgi2rElMfk'
-          } as ErrorInfo
-        ]
-        return responseHandler
-      })
+          })
+        ],
+        $typeName: 'UpdateUsersDataResponse'
+      }))
 
-      const r = createUpdateRequest(manyMockPayloads, 'add')
-      await sendUpdateRequest(mockRequestClient, r, 'addToAudience', mockStatsContext)
-      expect(mockStatsClient.incr).toHaveBeenCalledWith('addToAudience.error.PARTIAL_SUCCESS', 1, mockStatsContext.tags)
+      try {
+        nock('https://cm.g.doubleclick.net').post('/upload?nid=segment').reply(400)
+
+        const r = createUpdateRequest(manyMockPayloads, 'add')
+        await sendUpdateRequest(mockRequestClient, r, 'addToAudience', mockStatsContext)
+
+        expect(mockStatsClient.incr).toHaveBeenCalledWith(
+          'addToAudience.error.PARTIAL_SUCCESS',
+          1,
+          mockStatsContext.tags
+        )
+      } finally {
+        jest.restoreAllMocks()
+      }
     })
 
     it('should abruptly fail', async () => {