Skip to content

Commit

Permalink
chore: rename requestIP to request_ip in payload (#4809)
Browse files Browse the repository at this point in the history
  • Loading branch information
@BonapartePC
BonapartePC authored Jun 18, 2024
1 parent 24fd6d4 commit f5d6043
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
22 changes: 11 additions & 11 deletions gateway/gateway_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -604,7 +604,7 @@ var _ = Describe("Gateway", func() {
strippedPayload, _ = sjson.Delete(strippedPayload, "rudderId")
strippedPayload, _ = sjson.Delete(strippedPayload, "type")
strippedPayload, _ = sjson.Delete(strippedPayload, "receivedAt")
strippedPayload, _ = sjson.Delete(strippedPayload, "requestIP")
strippedPayload, _ = sjson.Delete(strippedPayload, "request_ip")

return strippedPayload
}
Expand Down Expand Up @@ -1554,21 +1554,21 @@ var _ = Describe("Gateway", func() {
Expect(job.Batch[0].MessageID).To(Equal("-a-random-string"))
})

It("doesn't override if receivedAt or requestIP already exists in payload", func() {
It("doesn't override if receivedAt or request_ip already exists in payload", func() {
req := &webRequestT{
reqType: "batch",
authContext: rCtxEnabled,
done: make(chan<- string),
userIDHeader: userIDHeader,
requestPayload: []byte(`{"batch": [{"type": "extract", "receivedAt": "2024-01-01T01:01:01.000000001Z", "requestIP": "dummyIPFromPayload"}]}`),
requestPayload: []byte(`{"batch": [{"type": "extract", "receivedAt": "2024-01-01T01:01:01.000000001Z", "request_ip": "dummyIPFromPayload"}]}`),
}
jobForm, err := gateway.getJobDataFromRequest(req)
Expect(err).To(BeNil())

var job struct {
Batch []struct {
ReceivedAt string `json:"receivedAt"`
RequestIP string `json:"requestIP"`
RequestIP string `json:"request_ip"`
} `json:"batch"`
}
err = json.Unmarshal(jobForm.jobs[0].EventPayload, &job)
Expand All @@ -1577,7 +1577,7 @@ var _ = Describe("Gateway", func() {
Expect(job.Batch[0].RequestIP).To(ContainSubstring("dummyIPFromPayload"))
})

It("adds receivedAt and requestIP in the request payload if it's not already present", func() {
It("adds receivedAt and request_ip in the request payload if it's not already present", func() {
req := &webRequestT{
reqType: "batch",
authContext: rCtxEnabled,
Expand All @@ -1592,7 +1592,7 @@ var _ = Describe("Gateway", func() {
var job struct {
Batch []struct {
ReceivedAt string `json:"receivedAt"`
RequestIP string `json:"requestIP"`
RequestIP string `json:"request_ip"`
} `json:"batch"`
}
err = json.Unmarshal(jobForm.jobs[0].EventPayload, &job)
Expand Down Expand Up @@ -1930,7 +1930,7 @@ var _ = Describe("Gateway", func() {
Expect(err).To(BeNil())
})

It("doesn't override if receivedAt or requestIP already exists in payload", func() {
It("doesn't override if receivedAt or request_ip already exists in payload", func() {
properties := stream.MessageProperties{
MessageID: "messageID",
RoutingKey: "anonymousId_header<<>>anonymousId_1<<>>identified_user_id",
Expand All @@ -1942,7 +1942,7 @@ var _ = Describe("Gateway", func() {
}
msg := stream.Message{
Properties: properties,
Payload: []byte(`{"receivedAt": "dummyReceivedAtFromPayload", "requestIP": "dummyIPFromPayload"}`),
Payload: []byte(`{"receivedAt": "dummyReceivedAtFromPayload", "request_ip": "dummyIPFromPayload"}`),
}
messages := []stream.Message{msg}
payload, err := json.Marshal(messages)
Expand All @@ -1960,7 +1960,7 @@ var _ = Describe("Gateway", func() {
var job struct {
Batch []struct {
ReceivedAt string `json:"receivedAt"`
RequestIP string `json:"requestIP"`
RequestIP string `json:"request_ip"`
} `json:"batch"`
}
Expect(jobForm).To(HaveLen(1))
Expand All @@ -1971,7 +1971,7 @@ var _ = Describe("Gateway", func() {
Expect(job.Batch[0].RequestIP).To(ContainSubstring("dummyIPFromPayload"))
})

It("adds receivedAt and requestIP in the request payload if it's not already present", func() {
It("adds receivedAt and request_ip in the request payload if it's not already present", func() {
properties := stream.MessageProperties{
MessageID: "messageID",
RoutingKey: "anonymousId_header<<>>anonymousId_1<<>>identified_user_id",
Expand Down Expand Up @@ -2000,7 +2000,7 @@ var _ = Describe("Gateway", func() {
var job struct {
Batch []struct {
ReceivedAt string `json:"receivedAt"`
RequestIP string `json:"requestIP"`
RequestIP string `json:"request_ip"`
} `json:"batch"`
}
Expect(jobForm).To(HaveLen(1))
Expand Down
14 changes: 7 additions & 7 deletions gateway/handle.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -409,15 +409,15 @@ func (gw *Handle) getJobDataFromRequest(req *webRequestT) (jobData *jobFromReq,
if _, ok := toSet["receivedAt"]; !ok {
toSet["receivedAt"] = time.Now().Format(misc.RFC3339Milli)
}
if _, ok := toSet["requestIP"]; ok {
if _, ok := toSet["request_ip"]; ok {
var tcOk bool
ipAddr, tcOk = toSet["requestIP"].(string)
ipAddr, tcOk = toSet["request_ip"].(string)
if !tcOk {
gw.logger.Warnf("requestIP is not a string: %v", toSet["requestIP"])
gw.logger.Warnf("request_ip is not a string: %v", toSet["request_ip"])
}

} else {
toSet["requestIP"] = ipAddr
toSet["request_ip"] = ipAddr
}
fillMessageID(toSet)
if eventTypeFromReq == "audiencelist" {
Expand Down Expand Up @@ -834,7 +834,7 @@ func (gw *Handle) extractJobsFromInternalBatchPayload(reqType string, body []byt
}
msg.Payload, err = fillRequestIP(msg.Payload, msg.Properties.RequestIP)
if err != nil {
return nil, fmt.Errorf("filling requestIP: %w", err)
return nil, fmt.Errorf("filling request_ip: %w", err)
}

eventBatch := singularEventBatch{
Expand Down Expand Up @@ -874,8 +874,8 @@ func fillReceivedAt(event []byte, receivedAt time.Time) ([]byte, error) {
}

func fillRequestIP(event []byte, ip string) ([]byte, error) {
if !gjson.GetBytes(event, "requestIP").Exists() {
return sjson.SetBytes(event, "requestIP", ip)
if !gjson.GetBytes(event, "request_ip").Exists() {
return sjson.SetBytes(event, "request_ip", ip)
}
return event, nil
}
Expand Down

0 comments on commit f5d6043

Please sign in to comment.