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.

Sign up for GitHub

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

Jump to bottom

HPCC-32052 Improve WsStore fetch miss message #18840

Merged
merged 1 commit into from
Jul 17, 2024
Merged

HPCC-32052 Improve WsStore fetch miss message #18840

merged 1 commit into from
Jul 17, 2024

Conversation

rpastrana
Copy link
Member

@rpastrana rpastrana commented Jun 28, 2024 •
edited
Loading

  • Changes log message to clarify simple fetch miss
  • Bumps up logging level to debug

Type of change:

  • This change is a bug fix (non-breaking change which fixes an issue).
  • This change is a new feature (non-breaking change which adds functionality).
  • This change improves the code (refactor or other change that does not change the functionality)
  • This change fixes warnings (the fix does not alter the functionality or the generated code)
  • This change is a breaking change (fix or feature that will cause existing behavior to change).
  • This change alters the query API (existing queries will have to be recompiled)

Checklist:

  • My code follows the code style of this project.
    • My code does not create any new warnings from compiler, build system, or lint.
  • The commit message is properly formatted and free of typos.
    • The commit message title makes sense in a changelog, by itself.
    • The commit is signed.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly, or...
    • I have created a JIRA ticket to update the documentation.
    • Any new interfaces or exported functions are appropriately commented.
  • I have read the CONTRIBUTORS document.
  • The change has been fully tested:
    • I have added tests to cover my changes.
    • All new and existing tests passed.
    • I have checked that this change does not introduce memory leaks.
    • I have used Valgrind or similar tools to check for potential issues.
  • I have given due consideration to all of the following potential concerns:
    • Scalability
    • Performance
    • Security
    • Thread-safety
    • Cloud-compatibility
    • Premature optimization
    • Existing deployed queries will not be broken
    • This change fixes the problem, not just the symptom
    • The target branch of this pull request is appropriate for such a change.
  • There are no similar instances of the same problem that should be addressed
    • I have addressed them here
    • I have raised JIRA issues to address them separately
  • This is a user interface / front-end modification
    • I have tested my changes in multiple modern browsers
    • The component(s) render as expected

Smoketest:

  • Send notifications about my Pull Request position in Smoketest queue.
  • Test my draft Pull Request.

Testing:

@github-actions GitHub Actions
Copy link

Jira Issue: https://hpccsystems.atlassian.net//browse/HPCC-32052

Jirabot Action Result:
Workflow Transition: Merge Pending
Updated PR

@rpastrana rpastrana requested a review from ghalliday June 28, 2024 22:01
ghalliday
ghalliday approved these changes Jul 10, 2024
View reviewed changes
Copy link
Member

@ghalliday ghalliday left a comment

Choose a reason for hiding this comment

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

@rpastrana I can merge this as-is, or you can address the comments. Please let me know which you prefer.

esp/services/ws_store/espstorelib/daliKVStore.cpp Outdated
@@ -402,7 +402,7 @@ bool CDALIKVStore::fetch(const char * storename, const char * ns, const char * k
xpath.appendf("/%s", key);
if(!storetree->hasProp(xpath.str()))
{
throw makeStringExceptionV(ECLWATCH_INVALID_QUERY_KEY, "DALI Keystore fetch: invalid key '%s' detected!", key);
throw makeStringExceptionV(ECLWATCH_INVALID_QUERY_KEY, "DALI Keystore fetch: Could not find key '%s'!", key);
Copy link
Member

Choose a reason for hiding this comment

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

This is a slightly picky comment, but exceptions should not be used for expected behaviour. In this case it is expected that users will query they value of keys that do not exist - because the first time the value is used it will not be present.
Better would be to log at this point, return false and for the caller to make use of the return value..

esp/services/ws_store/espstorelib/daliKVStore.cpp Outdated
@@ -402,7 +402,7 @@ bool CDALIKVStore::fetch(const char * storename, const char * ns, const char * k
xpath.appendf("/%s", key);
if(!storetree->hasProp(xpath.str()))
{
throw makeStringExceptionV(ECLWATCH_INVALID_QUERY_KEY, "DALI Keystore fetch: invalid key '%s' detected!", key);
throw makeStringExceptionV(ECLWATCH_INVALID_QUERY_KEY, "DALI Keystore fetch: Could not find key '%s'!", key);
}
else
{
Copy link
Member

Choose a reason for hiding this comment

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

Line 412 should be "return true;" - the return type is boolean, and this has a const char * argument (which will always be non-null).

@rpastrana
Copy link
Member Author

@rpastrana I can merge this as-is, or you can address the comments. Please let me know which you prefer.

The Line 412 return type issue should be fixed, it's outside the scope of this jira, but I don't mind fixing it in this pr, up to you. I agree w/ the exception issue in general, I supposed one could argue the missed hit is not expected, but more importantly, that change should be in it's own pr.

@rpastrana rpastrana requested a review from ghalliday July 11, 2024 16:14
ghalliday
ghalliday approved these changes Jul 16, 2024
View reviewed changes
Copy link
Member

@ghalliday ghalliday left a comment

Choose a reason for hiding this comment

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

Thanks, I appreciate the changes. Please squash.

@rpastrana rpastrana force-pushed the HPCC-32052-WsStoreFetchMissMessage branch from 52ac968 to 89e45de Compare July 16, 2024 15:26
@rpastrana
Copy link
Member Author

@ghalliday squashed

@rpastrana
HPCC-32052 Improve WsStore fetch miss message
8d2b067 
- Changes log message to clarify simple fetch miss
- Removes dependancy on exception on misses
- Removes dbg logging of misses
- Fixes invalid response type in CDALIKVStore::fetch

Signed-off-by: Rodrigo Pastrana <[email protected]>
@rpastrana rpastrana force-pushed the HPCC-32052-WsStoreFetchMissMessage branch from 89e45de to 8d2b067 Compare July 17, 2024 15:22
@rpastrana rpastrana changed the title HPCC-32052 Improve WsStore fech miss message HPCC-32052 Improve WsStore fetch miss message Jul 17, 2024
@ghalliday ghalliday merged commit c3c5e24 into hpcc-systems:candidate-9.4.x Jul 17, 2024
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ghalliday ghalliday ghalliday approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rpastrana @ghalliday