-
Notifications
You must be signed in to change notification settings - Fork 89
Making sure delete endpoint happens before adding a new endpoint here #1656
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
base: master
Are you sure you want to change the base?
Making sure delete endpoint happens before adding a new endpoint here #1656
Conversation
Summary of ChangesHello @brdandu, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses an issue where endpoint deletion and addition operations might not execute in the correct sequence, leading to inconsistent state. It ensures that the deletion of an endpoint completes successfully before a new one is created by leveraging promise-based asynchronous control flow. Additionally, enhanced logging has been introduced to provide better visibility into endpoint attribute update requests. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request correctly addresses a race condition by ensuring an endpoint is deleted before a new one is created, using promise chaining. The changes to enable this in the Vuex action and the component are well-implemented. My review includes a suggestion to improve error handling propagation in the component and a note on some verbose logging that was added, which might be better suited for a debug level.
env.logWarningToFile(`httpPostAttributeUpdate - Request data: endpointTypeIdList: ${JSON.stringify(endpointTypeIdList)}, | ||
selectedEndpoint: ${selectedEndpoint}, | ||
action: ${action}, | ||
id: ${id}, | ||
value: ${value}, | ||
listType: ${listType}, | ||
clusterRef: ${clusterRef}, | ||
attributeSide: ${attributeSide}, | ||
reportMinInterval: ${reportMinInterval}, | ||
reportMaxInterval: ${reportMaxInterval}, | ||
reportableChange: ${reportableChange} | ||
}`) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This verbose logging of the entire request body at a warning
level could be problematic in a production environment. It might expose sensitive user data in the logs and create unnecessary noise. For detailed debugging information like this, it's better to use a more appropriate log level, such as debug
.
env.logWarningToFile(`httpPostAttributeUpdate - Request data: endpointTypeIdList: ${JSON.stringify(endpointTypeIdList)}, | |
selectedEndpoint: ${selectedEndpoint}, | |
action: ${action}, | |
id: ${id}, | |
value: ${value}, | |
listType: ${listType}, | |
clusterRef: ${clusterRef}, | |
attributeSide: ${attributeSide}, | |
reportMinInterval: ${reportMinInterval}, | |
reportMaxInterval: ${reportMaxInterval}, | |
reportableChange: ${reportableChange} | |
}`) | |
env.logDebugToFile(`httpPostAttributeUpdate - Request data: endpointTypeIdList: ${JSON.stringify(endpointTypeIdList)}, | |
selectedEndpoint: ${selectedEndpoint}, | |
action: ${action}, | |
id: ${id}, | |
value: ${value}, | |
listType: ${listType}, | |
clusterRef: ${clusterRef}, | |
attributeSide: ${attributeSide}, | |
reportMinInterval: ${reportMinInterval}, | |
reportMaxInterval: ${reportMaxInterval}, | |
reportableChange: ${reportableChange} | |
}`) |
JIRA: ZAPP-1672