Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Allow name field escape configurable #4674

Merged
merged 2 commits into from
Sep 14, 2023

Conversation

weichou1229
Copy link
Member

@weichou1229 weichou1229 commented Sep 7, 2023

BREAKING CHANGE: Add config and modify topic build logic to allow name field escape configurable.

Close #4673

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?)
    link to docs PR

Testing Instructions

Related PRs are opened, you can refer to #4673 (comment) and run services to verify the API.

New Dependency Instructions (If applicable)

@lenny-goodell
Copy link
Member

@weichou1229 , this is not a breaking change. It is the fix to the previous breaking change, correct. Please remove Breaking Change statement from the commit and PR.

@weichou1229 weichou1229 changed the title feat!: Allow name field escape configurable feat: Allow name field escape configurable Sep 12, 2023
Copy link
Member

@lenny-goodell lenny-goodell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, pending dependent PRs

@cloudxxx8
Copy link
Member

@weichou1229 https://github.com/edgexfoundry/go-mod-bootstrap/tree/v3.1.0-dev.34 is ready
please help upgrade the go.mod

@weichou1229
Copy link
Member Author

@lenny-intel
I can't use the latest go-mod-core-contracts tag, because there are some constants that were removed from this PR https://github.com/edgexfoundry/go-mod-core-contracts/pull/856/files.

To upgrade the go-mod-core-contracts, how to use the external topic for core-command?

requestQueryTopic := externalTopics[common.CommandQueryRequestTopicKey]
requestCommandTopic := externalTopics[common.CommandRequestTopicKey]
ExternalMQTT:
  ...
  Topics:
    CommandRequestTopic: edgex/command/request/#             # for subscribing to 3rd party command requests
    CommandResponseTopicPrefix: edgex/command/response       # for publishing responses back to 3rd party systems /<device-name>/<command-name>/<method> will be added to this publish topic prefix
    CommandQueryRequestTopic: edgex/commandquery/request/#   # for subscribing to 3rd party command query request
    CommandQueryResponseTopic: edgex/commandquery/response 

@lenny-goodell
Copy link
Member

lenny-goodell commented Sep 13, 2023

I can't use the latest go-mod-core-contracts tag, because there are some constants that were removed from this PR https://github.com/edgexfoundry/go-mod-core-contracts/pull/856/files.

Right. Dang it, I forgot we left those in configuration.
I'll add those back.

@lenny-goodell
Copy link
Member

lenny-goodell commented Sep 13, 2023

Add config and modify topic build logic to allow name field escape configurable.

Close edgexfoundry#4673

Signed-off-by: bruce <weichou1229@gmail.com>
Upgrade go-mod-bootstrap and go-mod-core-contracts.

Close edgexfoundry#4673

Signed-off-by: bruce <weichou1229@gmail.com>
@sonarcloud
Copy link

sonarcloud bot commented Sep 14, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@weichou1229
Copy link
Member Author

Upgraded the libs.

Copy link
Member

@cloudxxx8 cloudxxx8 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@cloudxxx8 cloudxxx8 dismissed lenny-goodell’s stale review September 14, 2023 08:50

addressed the request changes

@cloudxxx8 cloudxxx8 merged commit 8690ef6 into edgexfoundry:main Sep 14, 2023
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Name field escape configurable
3 participants