Extend device detection module with new fields

Author: legendko

modules/fiftyonedegrees/devicedetection/device_detector.go

@@ -68,6 +68,8 @@ func buildEngineOptions(moduleConfig *config, configHash *dd.ConfigHash) []onpre
 			"HardwareModel",
 			"HardwareFamily",
 			"HardwareModelVariants",
+			"HardwareNamePrefix",
+			"HardwareNameVersion",
 			"ScreenInchesHeight",
 			"IsCrawler",
 		}),

modules/fiftyonedegrees/devicedetection/device_info_extractor.go

@@ -44,6 +44,8 @@ const (
 	deviceInfoHardwareFamily        deviceInfoProperty = "HardwareFamily"
 	deviceInfoHardwareModelVariants deviceInfoProperty = "HardwareModelVariants"
 	deviceInfoScreenInchesHeight    deviceInfoProperty = "ScreenInchesHeight"
+	deviceInfoHardwareNamePrefix    deviceInfoProperty = "HardwareNamePrefix"
+	deviceInfoHardwareNameVersion   deviceInfoProperty = "HardwareNameVersion"
 )
 
 func (x deviceInfoExtractor) extract(results Results, ua string) (*deviceInfo, error) {
@@ -69,6 +71,8 @@ func (x deviceInfoExtractor) extract(results Results, ua string) (*deviceInfo, e
 	hardwareFamily := x.getValue(results, deviceInfoHardwareFamily)
 	hardwareModelVariants := x.getValue(results, deviceInfoHardwareModelVariants)
 	screenInchedHeight, _ := strconv.ParseFloat(x.getValue(results, deviceInfoScreenInchesHeight), 10)
+	hardwareNamePrefix := x.getValue(results, deviceInfoHardwareNamePrefix)
+	hardwareNameVersion := x.getValue(results, deviceInfoHardwareNameVersion)
 
 	p := &deviceInfo{
 		HardwareVendor:        hardwareVendor,
@@ -90,6 +94,8 @@ func (x deviceInfoExtractor) extract(results Results, ua string) (*deviceInfo, e
 		HardwareModel:         hardwareModel,
 		HardwareFamily:        hardwareFamily,
 		HardwareModelVariants: hardwareModelVariants,
+		HardwareNamePrefix:    hardwareNamePrefix,
+		HardwareNameVersion:   hardwareNameVersion,
 		ScreenInchesHeight:    screenInchedHeight,
 	}
 

modules/fiftyonedegrees/devicedetection/device_info_extractor_test.go

@@ -107,6 +107,8 @@ func mockValues(results *ResultsHashMock) {
 	mockValue(results, "HardwareModel", "Macbook")
 	mockValue(results, "HardwareFamily", "Macbook")
 	mockValue(results, "HardwareModelVariants", "Macbook")
+	mockValue(results, "HardwareNamePrefix", "Macbook")
+	mockValue(results, "HardwareNameVersion", "Pro")
 	mockValue(results, "ScreenInchesHeight", "12")
 }
 
@@ -124,6 +126,8 @@ func assertDeviceInfo(t *testing.T, deviceInfo *deviceInfo) {
 	assert.Equal(t, deviceInfo.PixelRatio, float64(223))
 	assert.Equal(t, deviceInfo.Javascript, true)
 	assert.Equal(t, deviceInfo.GeoLocation, true)
+	assert.Equal(t, deviceInfo.HardwareNamePrefix, "Macbook")
+	assert.Equal(t, deviceInfo.HardwareNameVersion, "Pro")
 }
 
 func mockValue(results *ResultsHashMock, name string, value string) {

modules/fiftyonedegrees/devicedetection/hook_raw_auction_request.go

@@ -117,6 +117,10 @@ func setMissingFields(deviceObj map[string]any, fiftyOneDd *deviceInfo) map[stri
 			return val
 		},
 		"model": func() any {
+			if fiftyOneDd.HardwareNamePrefix != "" && fiftyOneDd.HardwareNamePrefix != ddUnknown {
+				return fiftyOneDd.HardwareNamePrefix
+			}
+			// Fallback: HardwareModel → HardwareName
 			newVal := fiftyOneDd.HardwareModel
 			if newVal == ddUnknown {
 				newVal = fiftyOneDd.HardwareName
@@ -126,6 +130,12 @@ func setMissingFields(deviceObj map[string]any, fiftyOneDd *deviceInfo) map[stri
 			}
 			return nil
 		},
+		"hwv": func() any {
+			if fiftyOneDd.HardwareNameVersion != "" && fiftyOneDd.HardwareNameVersion != ddUnknown {
+				return fiftyOneDd.HardwareNameVersion
+			}
+			return nil
+		},
 		"ppi": func() any {
 			if fiftyOneDd.ScreenPixelsHeight > 0 && fiftyOneDd.ScreenInchesHeight > 0 {
 				ppi := float64(fiftyOneDd.ScreenPixelsHeight) / fiftyOneDd.ScreenInchesHeight

modules/fiftyonedegrees/devicedetection/models.go

@@ -62,6 +62,8 @@ type deviceInfo struct {
 	HardwareFamily        string
 	HardwareModel         string
 	HardwareModelVariants string
+	HardwareNamePrefix    string
+	HardwareNameVersion   string
 	UserAgent             string
 	DeviceId              string
 	ScreenInchesHeight    float64

modules/fiftyonedegrees/devicedetection/module_test.go

@@ -252,7 +252,7 @@ func TestHandleRawAuctionHookEnrichment(t *testing.T) {
 	deviceDetectorM.On("getDeviceInfo", mock.Anything, mock.Anything).Return(
 		&deviceInfo{
 			HardwareVendor:        "Apple",
-			HardwareName:          "Macbook",
+			HardwareName:          "Macbook Pro",
 			DeviceType:            "device",
 			PlatformVendor:        "Apple",
 			PlatformName:          "MacOs",
@@ -268,6 +268,8 @@ func TestHandleRawAuctionHookEnrichment(t *testing.T) {
 			HardwareFamily:        "Macbook",
 			HardwareModel:         "Macbook",
 			HardwareModelVariants: "Macbook",
+			HardwareNamePrefix:    "Macbook",
+			HardwareNameVersion:   "Pro",
 			UserAgent:             "ua",
 			DeviceId:              "",
 		},
@@ -401,7 +403,7 @@ func TestHandleRawAuctionHookEnrichment(t *testing.T) {
 				"architecture": "arm",
 				"model": ""
 			}
-		,"devicetype":2,"ua":"ua","make":"Apple","model":"Macbook","os":"MacOs","osv":"14","h":1080,"w":1024,"pxratio":223,"js":1,"geoFetch":1}
+		,"devicetype":2,"ua":"ua","make":"Apple","model":"Macbook","hwv":"Pro","os":"MacOs","osv":"14","h":1080,"w":1024,"pxratio":223,"js":1,"geoFetch":1}
 	}`)
 
 	var deviceDetectorErrM mockDeviceDetector
@@ -454,7 +456,7 @@ func TestHandleRawAuctionHookEnrichmentWithErrors(t *testing.T) {
 	mockDeviceDetector.On("getDeviceInfo", mock.Anything, mock.Anything).Return(
 		&deviceInfo{
 			HardwareVendor:        "Apple",
-			HardwareName:          "Macbook",
+			HardwareName:          "Macbook Pro",
 			DeviceType:            "device",
 			PlatformVendor:        "Apple",
 			PlatformName:          "MacOs",
@@ -470,6 +472,8 @@ func TestHandleRawAuctionHookEnrichmentWithErrors(t *testing.T) {
 			HardwareFamily:        "Macbook",
 			HardwareModel:         "Macbook",
 			HardwareModelVariants: "Macbook",
+			HardwareNamePrefix:    "Macbook",
+			HardwareNameVersion:   "Pro",
 			UserAgent:             "ua",
 			DeviceId:              "",
 			ScreenInchesHeight:    7,
@@ -500,7 +504,7 @@ func TestHandleRawAuctionHookEnrichmentWithErrors(t *testing.T) {
 
 	mutationResult, err := mutation.Apply(hookstage.RawAuctionRequestPayload(`{"device":{}}`))
 	assert.NoError(t, err)
-	require.JSONEq(t, string(mutationResult), `{"device":{"devicetype":2,"ua":"ua","make":"Apple","model":"Macbook","os":"MacOs","osv":"14","h":1080,"w":1024,"pxratio":223,"js":1,"geoFetch":1,"ppi":154,"ext":{"fiftyonedegrees_deviceId":""}}}`)
+	require.JSONEq(t, string(mutationResult), `{"device":{"devicetype":2,"ua":"ua","make":"Apple","model":"Macbook","hwv":"Pro","os":"MacOs","osv":"14","h":1080,"w":1024,"pxratio":223,"js":1,"geoFetch":1,"ppi":154,"ext":{"fiftyonedegrees_deviceId":""}}}`)
 }
 
 func TestConfigHashFromConfig(t *testing.T) {
@@ -633,7 +637,7 @@ func TestBuilderHandleDeviceDetectorError(t *testing.T) {
 func TestHydrateFields(t *testing.T) {
 	deviceInfo := &deviceInfo{
 		HardwareVendor:        "Apple",
-		HardwareName:          "Macbook",
+		HardwareName:          "Macbook Pro",
 		DeviceType:            "device",
 		PlatformVendor:        "Apple",
 		PlatformName:          "MacOs",
@@ -649,6 +653,8 @@ func TestHydrateFields(t *testing.T) {
 		HardwareFamily:        "Macbook",
 		HardwareModel:         "Macbook",
 		HardwareModelVariants: "Macbook",
+		HardwareNamePrefix:    "Macbook",
+		HardwareNameVersion:   "Pro",
 		UserAgent:             "ua",
 		DeviceId:              "dev-ide",
 	}
@@ -699,7 +705,7 @@ func TestHydrateFields(t *testing.T) {
 
 	require.JSONEq(
 		t,
-		`{"devicetype":2,"dnt":0,"ext":{"fiftyonedegrees_deviceId":"dev-ide","h":"901","w":843},"geoFetch":1,"h":901,"js":1,"language":"en","make":"Apple","model":"Macintosh","os":"MacOs","osv":"14","pxratio":223,"sua":{"browsers":[{"brand":"Not/A)Brand","version":["99","0","0","0"]},{"brand":"Samsung Internet","version":["23","0","1","1"]},{"brand":"Chromium","version":["115","0","5790","168"]}],"mobile":1,"model":"SM-A037U","platform":{"brand":"Android","version":["13","0","0"]},"source":2},"ua":"Mozilla/5.0 (Linux; Android 13; SAMSUNG SM-A037U) AppleWebKit/537.36 (KHTML, like Gecko) SamsungBrowser/23.0 Chrome/115.0.0.0 Mobile Safari/537.36","w":843}`,
+		`{"devicetype":2,"dnt":0,"ext":{"fiftyonedegrees_deviceId":"dev-ide","h":"901","w":843},"geoFetch":1,"h":901,"hwv":"Pro","js":1,"language":"en","make":"Apple","model":"Macintosh","os":"MacOs","osv":"14","pxratio":223,"sua":{"browsers":[{"brand":"Not/A)Brand","version":["99","0","0","0"]},{"brand":"Samsung Internet","version":["23","0","1","1"]},{"brand":"Chromium","version":["115","0","5790","168"]}],"mobile":1,"model":"SM-A037U","platform":{"brand":"Android","version":["13","0","0"]},"source":2},"ua":"Mozilla/5.0 (Linux; Android 13; SAMSUNG SM-A037U) AppleWebKit/537.36 (KHTML, like Gecko) SamsungBrowser/23.0 Chrome/115.0.0.0 Mobile Safari/537.36","w":843}`,
 		string(deviceHolder.Device),
 	)
 }