Skip to content

HPCC-35956 Improve the error reporting when cannot read enough data#21062

Merged
ghalliday merged 1 commit intohpcc-systems:candidate-10.0.xfrom
ghalliday:issue35956
Mar 6, 2026
Merged

HPCC-35956 Improve the error reporting when cannot read enough data#21062
ghalliday merged 1 commit intohpcc-systems:candidate-10.0.xfrom
ghalliday:issue35956

Conversation

@ghalliday
Copy link
Member

@ghalliday ghalliday commented Mar 4, 2026 •
edited
Loading

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:

Copilot AI review requested due to automatic review settings March 4, 2026 17:23
@ghalliday ghalliday added the Improvement An improvement that is not cleaning code up, or adding a feature (e.g. improving testing) label Mar 4, 2026
@ghalliday ghalliday requested a review from dcamper March 4, 2026 17:24
@github-actions
Copy link

github-actions bot commented Mar 4, 2026

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

Jirabot Action Result:
Assigning user: gavin.halliday@lexisnexisrisk.com
Workflow Transition To: Merge Pending
Updated PR

Copilot AI reviewed Mar 4, 2026
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the low-level row-buffer read-ahead logic in the ECL RTL to provide a clearer runtime error when a caller requests more bytes than are available from the underlying input stream.

Changes:

  • Replaces an assertex post-check with a conditional that throws a formatted exception when insufficient data remains after attempting to read-ahead.
  • Adds additional diagnostic details (required bytes, available bytes, offset) to the failure path.

rtl/eclrtl/rtlcommon.hpp Outdated
Comment on lines +136 to +138
peekBytesDirect(required);
assertex(required <= maxAvailable());
if (unlikely(required > maxAvailable()))
throw makeStringExceptionV(0, "Required %u bytes, but only %u available (offset %u)", required, (unsigned)maxAvailable(), readOffset);
Copy link

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

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

ensureAccessible() now calls makeStringExceptionV(), but rtlcommon.hpp does not include jexcept.hpp (where it is declared). This header is included from other headers (e.g. roxie/ccd/ccdkey.hpp) without jlib.hpp, so this change can break compilation depending on include order. Add the needed include (or switch to an exception helper already declared by the current includes).

Copilot uses AI. Check for mistakes.
rtl/eclrtl/rtlcommon.hpp Outdated
peekBytesDirect(required);
assertex(required <= maxAvailable());
if (unlikely(required > maxAvailable()))
throw makeStringExceptionV(0, "Required %u bytes, but only %u available (offset %u)", required, (unsigned)maxAvailable(), readOffset);
Copy link

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

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

The thrown message labels readOffset as just "offset", but readOffset is an offset within the current row, not a file position. Consider clarifying the wording (e.g. "row offset") and/or including the absolute stream position (e.g. tell()+readOffset) to make the error actionable when debugging truncated/corrupt inputs.

Suggested change
throw makeStringExceptionV(0, "Required %u bytes, but only %u available (offset %u)", required, (unsigned)maxAvailable(), readOffset);
throw makeStringExceptionV(0, "Required %u bytes, but only %u available (row offset %u, absolute stream position %u)", required, (unsigned)maxAvailable(), readOffset, (unsigned)(tell() + readOffset));

Copilot uses AI. Check for mistakes.
Copy link
Member Author

@ghalliday ghalliday Mar 5, 2026

Choose a reason for hiding this comment

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

I didn't realise the file offset was available! I will change.

dcamper
dcamper approved these changes Mar 4, 2026
View reviewed changes
Copy link
Contributor

@dcamper dcamper left a comment

Choose a reason for hiding this comment

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

Looks good, though I think both Copilot suggestions make sense as well.

@ghalliday
HPCC-35956 Improve the error reporting when cannot read enough data
fbe89a9 
Signed-off-by: Gavin Halliday <gavin.halliday@lexisnexis.com>
@ghalliday ghalliday merged commit 538c9ad into hpcc-systems:candidate-10.0.x Mar 6, 2026
23 checks passed
@github-actions
Copy link

github-actions bot commented Mar 6, 2026

Jirabot Action Result:
Added fix version: 10.0.44
Added fix version: 10.2.18
Workflow Transition: 'Resolve issue'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@dcamper dcamper dcamper approved these changes

Assignees

No one assigned

Labels

Improvement An improvement that is not cleaning code up, or adding a feature (e.g. improving testing)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ghalliday @dcamper