feat(data): Make MaxEventSize a service configuration setting

[jinlinGuan]

close #3237
25000KB (25MB) by default

Signed-off-by: Ginny Guan [email protected]

If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/edgex-go/blob/main/.github/Contributing.md

PR Checklist

Please check if your PR fulfills the following requirements:

• I am not introducing a breaking change (if you are, flag in conventional commit message with BREAKING CHANGE: describing the break)
• I am not introducing a new dependency (add notes below if you are)
• I have added unit tests for the new feature or bug fix (if not, why?)
• I have fully tested (add details below) this the new feature or bug fix (if not, why?)
• I have opened a PR for the related docs change (if not, why?) will open once this PR approved

Testing Instructions

Build and run Core Data locally with rest of EdgeX non-secure services running in Docker, and

• set maxEventSize to -1
• set maxEventSize to 0
• set maxEventSize to 1 and payload size over 1000 bytes

POST an event
e.g.

curl -ki http://localhost:59880/api/v2/event/Random-Integer-Device/Random-Integer-Device/Int8 -X POST -d '{  "apiVersion": "v2",
  "event": {
    "apiVersion": "v2",
    "deviceName": "Random-Integer-Device",
    "profileName": "Random-Integer-Device",
    "sourceName": "Int8",
    "id": "d5471d59-2810-419a-8744-18eb8fad3d65",
    "origin": 1602168089665565200, 
    "readings": [
      {
        "deviceName": "Random-Integer-Device",
        "resourceName": "Int8",
        "profileName": "Random-Integer-Device",
        "origin": 1602168089665565200,
        "valueType": "Int8",
        "value": "12"
      }
    ]
  }
}'

For message bus,
e.g. curl -ki http://localhost:59900/api/v2/device/name/Random-Binary-Device/Binary\?ds-pushevent\=yes

New Dependency Instructions (If applicable)

[lenny-goodell]

@jinlinGuan , please remember to complete the PR template when you take this PR out of draft.

[cloudxxx8]

Let's hold this PR and discuss the design here #3237 (comment)

[cloudxxx8]

LGTM

[cloudxxx8]

LGTM

[lenny-goodell]

Should check r.ContentLength > config.MaxEventSize*1000 before attempting to read the body, otherwise this new settings doesn't really help since we are reading it no matter what.

[cloudxxx8]

r.ContentLength is a better option, but why do we limit the check for CBOR only?

[cloudxxx8]

@lenny-intel Although the request usually contains ContentLength, it's not a required field.
Should we depend on it? It might be unknown.
https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.4

// ContentLength records the length of the associated content.
// The value -1 indicates that the length is unknown.
// Values >= 0 indicate that the given number of bytes may
// be read from Body.
//
// For client requests, a value of 0 with a non-nil Body is
// also treated as unknown.
ContentLength int64

I suggest to check ContentLength first, and keep the utils.CheckPayloadSize(dataBytes, config.MaxEventSize*1000) step after ReadAll

[lenny-goodell]

Yes, check first, if -1 use utils.CheckPayloadSize

[lenny-goodell]

Looks good once address @cloudxxx8 comment on ContentLength

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[cloudxxx8]

LGTM