feat: Allow Event Reading API to pass numeric parameter #1019

weichou1229 · 2025-08-29T09:38:19Z

Allow Event Reading API to pass a numeric parameter.

Updated the EventClient and ReadingClient interfaces to add a new function XXXXWithQueryParams. This was done to maintain backward compatibility, ensuring that other services using these client libraries won’t need to make significant code changes.

If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/go-mod-core-contracts/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?) not impact

Testing Instructions

New Dependency Instructions (If applicable)

codecov-commenter · 2025-08-29T09:45:28Z

Codecov Report

❌ Patch coverage is 88.88889% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 44.83%. Comparing base (7c1cc7e) to head (9ee158e).

Files with missing lines	Patch %	Lines
clients/http/utils/common.go	0.00%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1019      +/-   ##
==========================================
- Coverage   44.91%   44.83%   -0.08%     
==========================================
  Files         128      128              
  Lines        7555     7554       -1     
==========================================
- Hits         3393     3387       -6     
- Misses       3803     3808       +5     
  Partials      359      359

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Allow Event Reading API to pass numeric parameter Signed-off-by: bruce <[email protected]>

judehung

@weichou1229 For tracking purposes, please include a description in the PR noting that you updated the EventClient and ReadingClient interfaces with XXXXWithQueryParams. This was done to maintain backward compatibility, ensuring that other services using these client libraries won’t need to make significant code changes.

judehung · 2025-09-01T06:03:54Z

dtos/reading.go

+	switch v := aux.Value.(type) {
+	case string: // string, for JSON strings
+		b.Value = v
+	case float64: // float64, for JSON numbers


Add more explanation in comment to describe why only deal with float64 here

Updated according to Cloud's comment. The json lib treats all number type as float64, so we don't need to handle other types.

dtos/reading.go

cloudxxx8 · 2025-09-01T06:41:25Z

clients/interfaces/event.go

 	// limit: The number of items to return. Specify -1 will return all remaining items after offset. The maximum will be the MaxResultCount as defined in the configuration of service. Default is 20.
 	EventsByDeviceName(ctx context.Context, name string, offset, limit int) (responses.MultiEventsResponse, errors.EdgeX)
+	// EventsByDeviceNameWithQueryParams returns a portion of the entire events according to the device name and specified query parameters. Events are sorted in descending order of created time.
+	EventsByDeviceNameWithQueryParams(ctx context.Context, name string, queryParams map[string]string) (responses.MultiEventsResponse, errors.EdgeX)


Suggested change

EventsByDeviceNameWithQueryParams(ctx context.Context, name string, queryParams map[string]string) (responses.MultiEventsResponse, errors.EdgeX)

EventsByDeviceNameWithQueryParams(ctx context.Context, name string, offset, limit int, queryParams map[string]string) (responses.MultiEventsResponse, errors.EdgeX)

The offset and limit are part of the query parameter, so I remove offset, limit int from the function argument.
For example, http://0.0.0.0:59880/api/v3/event/device/name/Random-UnsignedInteger-Device?offset=0&limit=3&numeric=true

Added the offset, limit back.

cloudxxx8 · 2025-09-01T06:41:41Z

clients/interfaces/event.go

 	// limit: The number of items to return. Specify -1 will return all remaining items after offset. The maximum will be the MaxResultCount as defined in the configuration of service. Default is 20.
 	EventsByTimeRange(ctx context.Context, start, end int64, offset, limit int) (responses.MultiEventsResponse, errors.EdgeX)
+	// EventsByTimeRangeWithQueryParams returns events between a given start, end date/time, and specified query parameters. Events are sorted in descending order of created time.
+	EventsByTimeRangeWithQueryParams(ctx context.Context, start, end int64, queryParams map[string]string) (responses.MultiEventsResponse, errors.EdgeX)


Suggested change

EventsByTimeRangeWithQueryParams(ctx context.Context, start, end int64, queryParams map[string]string) (responses.MultiEventsResponse, errors.EdgeX)

EventsByTimeRangeWithQueryParams(ctx context.Context, start, end int64, offset, limit int, queryParams map[string]string) (responses.MultiEventsResponse, errors.EdgeX)

The offset and limit are part of the query parameter, so I remove offset, limit int from the function argument.
For example, http://0.0.0.0:59880/api/v3/event/start/1102168089665565200/end/1840986079160530000?offset=2&numeric=true

Added the offset, limit back.

if the value is not string, let the NumericReading contain the equivalent value Signed-off-by: bruce <[email protected]>

judehung

LGTM

cloudxxx8

generate mock client

Added offset and limit parameters to the Event and Reading client XXXWithQueryParams functions for easier use. Signed-off-by: bruce <[email protected]>

weichou1229 · 2025-09-03T03:21:04Z

generate mock client

Generated Event and Reading mock client.

cloudxxx8

LGTM

weichou1229 force-pushed the numeric-value branch from 436d41d to 6523cb5 Compare September 1, 2025 03:56

feat: Allow Event Reading API to pass numeric parameter

9ee158e

Allow Event Reading API to pass numeric parameter Signed-off-by: bruce <[email protected]>

weichou1229 force-pushed the numeric-value branch from 6523cb5 to 9ee158e Compare September 1, 2025 03:58

weichou1229 requested a review from judehung September 1, 2025 03:59

weichou1229 marked this pull request as ready for review September 1, 2025 04:00

judehung reviewed Sep 1, 2025

View reviewed changes

cloudxxx8 requested changes Sep 1, 2025

View reviewed changes

dtos/reading.go Outdated Show resolved Hide resolved

cloudxxx8 requested changes Sep 1, 2025

View reviewed changes

feat: Change Reading DTO unmarshal func

97fb87a

if the value is not string, let the NumericReading contain the equivalent value Signed-off-by: bruce <[email protected]>

weichou1229 requested review from cloudxxx8 and judehung September 2, 2025 06:57

judehung previously approved these changes Sep 2, 2025

View reviewed changes

cloudxxx8 requested changes Sep 3, 2025

View reviewed changes

feat: Add offset, limit to Event and Reading client func

68b2a7d

Added offset and limit parameters to the Event and Reading client XXXWithQueryParams functions for easier use. Signed-off-by: bruce <[email protected]>

weichou1229 dismissed judehung’s stale review via 68b2a7d September 3, 2025 03:16

weichou1229 requested a review from cloudxxx8 September 3, 2025 03:21

cloudxxx8 approved these changes Sep 3, 2025

View reviewed changes

cloudxxx8 merged commit bb1a0b1 into edgexfoundry:main Sep 3, 2025
3 checks passed

weichou1229 deleted the numeric-value branch September 4, 2025 00:57

	EventsByDeviceNameWithQueryParams(ctx context.Context, name string, queryParams map[string]string) (responses.MultiEventsResponse, errors.EdgeX)
	EventsByDeviceNameWithQueryParams(ctx context.Context, name string, offset, limit int, queryParams map[string]string) (responses.MultiEventsResponse, errors.EdgeX)

	EventsByTimeRangeWithQueryParams(ctx context.Context, start, end int64, queryParams map[string]string) (responses.MultiEventsResponse, errors.EdgeX)
	EventsByTimeRangeWithQueryParams(ctx context.Context, start, end int64, offset, limit int, queryParams map[string]string) (responses.MultiEventsResponse, errors.EdgeX)

feat: Allow Event Reading API to pass numeric parameter #1019

feat: Allow Event Reading API to pass numeric parameter #1019

Uh oh!

Conversation

weichou1229 commented Aug 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Checklist

Testing Instructions

New Dependency Instructions (If applicable)

Uh oh!

codecov-commenter commented Aug 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

judehung left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

judehung left a comment

Choose a reason for hiding this comment

Uh oh!

cloudxxx8 left a comment

Choose a reason for hiding this comment

Uh oh!

weichou1229 commented Sep 3, 2025

Uh oh!

cloudxxx8 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

weichou1229 commented Aug 29, 2025 •

edited

Loading

codecov-commenter commented Aug 29, 2025 •

edited

Loading