Merge pull request #14 from DIMO-Network/feature/si-2686-handle-acron…

…ym-casing-in-signal-names

Update JSON name creation

Makefile

@@ -13,7 +13,7 @@ VERSION   := $(shell git describe --tags || echo "v0.0.0")
 VER_CUT   := $(shell echo $(VERSION) | cut -c2-)
 
 # Dependency versions
-GOLANGCI_VERSION   = v1.57.2
+GOLANGCI_VERSION   = latest
 
 build:
 	@CGO_ENABLED=0 GOOS=$(GOOS) GOARCH=$(ARCH) \

pkg/schema/signal.go

@@ -4,6 +4,7 @@ package schema
 import (
 	"regexp"
 	"strings"
+	"unicode"
 )
 
 const (
@@ -109,16 +110,13 @@ func NewSignalInfo(record []string) *SignalInfo {
 		sig.BaseGQLType = gqlTypeFromVSPEC(baseType)
 	}
 	sig.GOName = goName(sig.Name)
-	sig.JSONName = JSONName(sig.Name)
+	sig.JSONName = jsonName(sig.Name)
 
 	return sig
 }
 
 // MergeWithDefinition merges the signal with the definition information.
 func (s *SignalInfo) MergeWithDefinition(definition *DefinitionInfo) {
-	if definition.GoType != "" {
-		s.BaseGoType = definition.GoType
-	}
 	if definition.IsArray != nil {
 		s.IsArray = *definition.IsArray
 	}
@@ -146,23 +144,51 @@ func (s *SignalInfo) GQLType() string {
 	return s.BaseGQLType
 }
 
+// goName returns the golang formated name of the signal.
+// Removes the root Prefix and nonAlphaNumeric characters from the name and capitalizes the first letter.
 func goName(name string) string {
-	return nonAlphaNum.ReplaceAllString(removePrefix(name), "")
+	firstComponent, rest := splitAndSantizeName(name)
+	var nameBuilder strings.Builder
+	_, _ = nameBuilder.WriteRune(unicode.ToUpper(rune(firstComponent[0])))
+	_, _ = nameBuilder.WriteString(firstComponent[1:])
+	_, _ = nameBuilder.WriteString(rest)
+	return nameBuilder.String()
 }
 
-// JSONName returns the json name of the signal.
-func JSONName(name string) string {
-	n := goName(name)
-	// lowercase the first letter
-	return strings.ToLower(n[:1]) + n[1:]
+// jsonName returns the JSON formated name of the signal.
+// Removes the root Prefix and nonAlphaNumeric characters from the name and lowercases the first word.
+func jsonName(name string) string {
+	firstComponent, rest := splitAndSantizeName(name)
+	if firstComponent == "" {
+		return ""
+	}
+
+	var nameBuilder strings.Builder
+	for i, r := range firstComponent {
+		if i == 0 || unicode.IsUpper(r) {
+			// Lowercase first and any initial consecutive uppercase letters
+			_, _ = nameBuilder.WriteRune(unicode.ToLower(r))
+			continue
+		}
+		// write the remainging characters of the first component
+		_, _ = nameBuilder.WriteString(firstComponent[i:])
+		break
+	}
+	_, _ = nameBuilder.WriteString(rest)
+	return nameBuilder.String()
 }
 
-func removePrefix(name string) string {
-	idx := strings.IndexByte(name, '.')
-	if idx != -1 {
-		return name[idx+1:]
+// splitAndSantizeName removes the root branch prefix from the name and returns the first component separate from rest of the name with nonAlphaNumeric characters removed.
+func splitAndSantizeName(name string) (string, string) {
+	splitName := strings.Split(name, ".")
+
+	if len(splitName) == 1 {
+		return nonAlphaNum.ReplaceAllString(splitName[0], ""), ""
 	}
-	return name
+	// remove branch prefix if it exists i.e. Vehcile.Speed -> Speed
+	splitName = splitName[1:]
+
+	return nonAlphaNum.ReplaceAllString(splitName[0], ""), nonAlphaNum.ReplaceAllString(strings.Join(splitName[1:], ""), "")
 }
 
 // goTypeFromVSPEC converts vspec type to golang types.

pkg/schema/signal_test.go

@@ -0,0 +1,56 @@
+package schema
+
+import "testing"
+
+func TestJSONName(t *testing.T) {
+	tests := []struct {
+		input    string
+		expected string
+	}{
+		{
+			input:    "Vehicle.CurrentLocation.Altitude",
+			expected: "currentLocationAltitude",
+		},
+		{
+			input:    "Vechicle.DIMO.Source",
+			expected: "dimoSource",
+		},
+		{
+			input:    "Vehicle.DIMO.WPAState",
+			expected: "dimoWPAState",
+		},
+		{
+			input:    "Vehicle.DIMO.Aftemarket.HDOP",
+			expected: "dimoAftemarketHDOP",
+		},
+		{
+			input:    "Vehicle.DIMO.Aftemarket.WPAState",
+			expected: "dimoAftemarketWPAState",
+		},
+		{
+			input:    "Vehicle.Powertrain.CombustionEngine.ECT", //nolint:misspell // ECT is an abbreviation
+			expected: "powertrainCombustionEngineECT",
+		},
+		{
+			input:    "Vehicle.Powertrain.CombustionEngine.Tps",
+			expected: "powertrainCombustionEngineTps",
+		},
+		{
+			input:    "",
+			expected: "",
+		},
+		{
+			input:    "Vehicle",
+			expected: "vehicle",
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.input, func(t *testing.T) {
+			result := jsonName(test.input)
+			if result != test.expected {
+				t.Errorf("Unexpected result. Expected: %s, Got: %s", test.expected, result)
+			}
+		})
+	}
+}

pkg/vss/convert/payloadv1_test.go

@@ -109,9 +109,9 @@ var (
 		{TokenID: 123, Timestamp: ts, Name: "vehicleIdentificationYear", ValueNumber: 2020, Source: "dimo/integration/123"},
 		{TokenID: 123, Timestamp: ts, Name: "exteriorAirTemperature", ValueNumber: 25, Source: "dimo/integration/123"},
 		{TokenID: 123, Timestamp: ts, Name: "lowVoltageBatteryCurrentVoltage", ValueNumber: 12.5, Source: "dimo/integration/123"},
-		{TokenID: 123, Timestamp: ts, Name: "oBDBarometricPressure", ValueNumber: 1013.25, Source: "dimo/integration/123"},
-		{TokenID: 123, Timestamp: ts, Name: "oBDEngineLoad", ValueNumber: 75, Source: "dimo/integration/123"},
-		{TokenID: 123, Timestamp: ts, Name: "oBDIntakeTemp", ValueNumber: 30, Source: "dimo/integration/123"},
-		{TokenID: 123, Timestamp: ts, Name: "oBDRunTime", ValueNumber: 1200, Source: "dimo/integration/123"},
+		{TokenID: 123, Timestamp: ts, Name: "obdBarometricPressure", ValueNumber: 1013.25, Source: "dimo/integration/123"},
+		{TokenID: 123, Timestamp: ts, Name: "obdEngineLoad", ValueNumber: 75, Source: "dimo/integration/123"},
+		{TokenID: 123, Timestamp: ts, Name: "obdIntakeTemp", ValueNumber: 30, Source: "dimo/integration/123"},
+		{TokenID: 123, Timestamp: ts, Name: "obdRunTime", ValueNumber: 1200, Source: "dimo/integration/123"},
 	}
 )

pkg/vss/convert/payloadv2_test.go

@@ -131,16 +131,16 @@ var fullV2InputJSON = `{
 var expectedV2Signals = []vss.Signal{
 	{TokenID: tokenID, Timestamp: time.Date(2024, time.April, 18, 17, 20, 26, 633000000, time.UTC), Name: "powertrainCombustionEngineECT", ValueNumber: 107, ValueString: "", Source: "dimo/integration/123"},
 	{TokenID: tokenID, Timestamp: time.Date(2024, time.April, 18, 17, 20, 27, 173000000, time.UTC), Name: "powertrainCombustionEngineMAF", ValueNumber: 475.79, ValueString: "", Source: "dimo/integration/123"},
-	{TokenID: tokenID, Timestamp: time.Date(2024, time.April, 18, 17, 20, 29, 314000000, time.UTC), Name: "oBDEngineLoad", ValueNumber: 12.54912, ValueString: "", Source: "dimo/integration/123"},
+	{TokenID: tokenID, Timestamp: time.Date(2024, time.April, 18, 17, 20, 29, 314000000, time.UTC), Name: "obdEngineLoad", ValueNumber: 12.54912, ValueString: "", Source: "dimo/integration/123"},
 	{TokenID: tokenID, Timestamp: time.Date(2024, time.April, 18, 17, 20, 29, 844000000, time.UTC), Name: "powertrainCombustionEngineTPS", ValueNumber: 23.529600000000002, ValueString: "", Source: "dimo/integration/123"},
 	{TokenID: tokenID, Timestamp: time.Date(2024, time.April, 18, 17, 20, 37, 235000000, time.UTC), Name: "powertrainCombustionEngineTPS", ValueNumber: 23.529600000000002, ValueString: "", Source: "dimo/integration/123"},
 	{TokenID: tokenID, Timestamp: time.Date(2024, time.April, 18, 17, 20, 42, 256000000, time.UTC), Name: "powertrainCombustionEngineMAF", ValueNumber: 475.79, ValueString: "", Source: "dimo/integration/123"},
-	{TokenID: tokenID, Timestamp: time.Date(2024, time.April, 18, 17, 20, 44, 422000000, time.UTC), Name: "oBDEngineLoad", ValueNumber: 12.54912, ValueString: "", Source: "dimo/integration/123"},
+	{TokenID: tokenID, Timestamp: time.Date(2024, time.April, 18, 17, 20, 44, 422000000, time.UTC), Name: "obdEngineLoad", ValueNumber: 12.54912, ValueString: "", Source: "dimo/integration/123"},
 	{TokenID: tokenID, Timestamp: time.Date(2024, time.April, 18, 17, 20, 44, 962000000, time.UTC), Name: "powertrainCombustionEngineTPS", ValueNumber: 23.529600000000002, ValueString: "", Source: "dimo/integration/123"},
 	{TokenID: tokenID, Timestamp: time.Date(2024, time.April, 18, 17, 20, 46, 435000000, time.UTC), Name: "currentLocationLongitude", ValueNumber: -56.50151833333334, ValueString: "", Source: "dimo/integration/123"},
 	{TokenID: tokenID, Timestamp: time.Date(2024, time.April, 18, 17, 20, 46, 435000000, time.UTC), Name: "currentLocationLatitude", ValueNumber: 56.27014, ValueString: "", Source: "dimo/integration/123"},
-	{TokenID: tokenID, Timestamp: time.Date(2024, time.April, 18, 17, 20, 46, 435000000, time.UTC), Name: "dIMOAftermarketHDOP", ValueNumber: 1.4, ValueString: "", Source: "dimo/integration/123"},
-	{TokenID: tokenID, Timestamp: time.Date(2024, time.April, 18, 17, 20, 46, 435000000, time.UTC), Name: "dIMOAftermarketNSAT", ValueNumber: 6, ValueString: "", Source: "dimo/integration/123"},
-	{TokenID: tokenID, Timestamp: time.Date(2024, time.April, 18, 17, 20, 46, 435000000, time.UTC), Name: "dIMOAftermarketWPAState", ValueNumber: 0, ValueString: "COMPLETED", Source: "dimo/integration/123"},
-	{TokenID: tokenID, Timestamp: time.Date(2024, time.April, 18, 17, 20, 46, 435000000, time.UTC), Name: "dIMOAftermarketSSID", ValueNumber: 0, ValueString: "foo", Source: "dimo/integration/123"},
+	{TokenID: tokenID, Timestamp: time.Date(2024, time.April, 18, 17, 20, 46, 435000000, time.UTC), Name: "dimoAftermarketHDOP", ValueNumber: 1.4, ValueString: "", Source: "dimo/integration/123"},
+	{TokenID: tokenID, Timestamp: time.Date(2024, time.April, 18, 17, 20, 46, 435000000, time.UTC), Name: "dimoAftermarketNSAT", ValueNumber: 6, ValueString: "", Source: "dimo/integration/123"},
+	{TokenID: tokenID, Timestamp: time.Date(2024, time.April, 18, 17, 20, 46, 435000000, time.UTC), Name: "dimoAftermarketWPAState", ValueNumber: 0, ValueString: "COMPLETED", Source: "dimo/integration/123"},
+	{TokenID: tokenID, Timestamp: time.Date(2024, time.April, 18, 17, 20, 46, 435000000, time.UTC), Name: "dimoAftermarketSSID", ValueNumber: 0, ValueString: "foo", Source: "dimo/integration/123"},
 }