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

HPCC-31416 CDistributedSuperFile::querySubFile may return incorrect subfile #18385

Merged
merged 1 commit into from
Mar 22, 2024

Conversation

shamser
Copy link
Contributor

@shamser shamser commented Mar 7, 2024

Querying CDistributedSuperFile for a subfile that doesn't exist returned a subfile instead of throwing an exception. By not throwing an error, incorrect code that calls querySubFile may be appear to work. This fix modifies querySubFile so that it throws an exception when the subfile number is not valid.

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:

Copy link

github-actions bot commented Mar 7, 2024

@shamser shamser requested a review from jakesmith March 8, 2024 09:09
Copy link
Member

@jakesmith jakesmith left a comment

Choose a reason for hiding this comment

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

@shamser - looks good, 2 trivial comments

@@ -6271,20 +6271,22 @@ class CDistributedSuperFile: public CDistributedFileBase<IDistributedSuperFile>
virtual IDistributedFile &querySubFile(unsigned idx,bool sub) override
{
CriticalBlock block (sect);
if (sub) {
if (sub)
{
Copy link
Member

Choose a reason for hiding this comment

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

trivial: formatting change, now inconsistent with other existing code below.
This style is preferred, but if changing, need to make the rest of the function consistently use it.

return f;
}
// fall through to error
throw makeStringExceptionV(-1,"CDistributedSuperFile::querySubFile(%u) for superfile %s - subfile doesn't exist ", idx, logicalName.get());
}
return subfiles.item(idx);
Copy link
Member

Choose a reason for hiding this comment

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

trivial: let's make it clear that this is an else now, i.e.:

        }
        else
            return subfiles.item(idx);

@shamser shamser changed the base branch from candidate-9.4.x to candidate-9.6.x March 18, 2024 10:58
@shamser shamser requested a review from jakesmith March 18, 2024 10:59
Copy link
Member

@jakesmith jakesmith left a comment

Choose a reason for hiding this comment

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

@shamser - looks good. Please squash.

Copy link
Member

@jakesmith jakesmith left a comment

Choose a reason for hiding this comment

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

@shamser - looks good

I do wonder whether this should target 9.4, but it's such an old bug.. that has gone unnoticed until now. The only place that hit it, was related to HPCC-31393, that was fixed in 9.4.

I think it's okay to target 9.6.

@ghalliday ghalliday changed the base branch from candidate-9.6.x to candidate-9.4.x March 21, 2024 16:53
@ghalliday
Copy link
Member

@shamser please rebase to 9.4.x since it is a bugfix.

…ubfile

Querying CDistributedSuperFile for a subfile that doesn't exist returned
a subfile instead of throwing an exception. By not throwing an error,
incorrect code that calls querySubFile may be appear to work.  This fix
modifies querySubFile so that it throws an exception when the subfile
number is not valid.

Signed-off-by: Shamser Ahmed <shamser.ahmed@lexisnexis.com>
Copy link
Member

@jakesmith jakesmith left a comment

Choose a reason for hiding this comment

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

@ghalliday - ready to merge.

@ghalliday ghalliday merged commit cf285fd into hpcc-systems:candidate-9.4.x Mar 22, 2024
50 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.

3 participants