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

HPCC4J-569 Correct EOS character handling #671

Merged
merged 1 commit into from
Jan 29, 2024
Merged

HPCC4J-569 Correct EOS character handling #671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 30 additions & 11 deletions dfsclient/src/main/java/org/hpccsystems/dfs/client/BinaryRecordWriter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ public class BinaryRecordWriter implements IRecordWriter
private static final int QSTR_COMPRESSED_CHUNK_LEN = 3;
private static final int QSTR_EXPANDED_CHUNK_LEN = 4;

private static final byte NULL_TERMINATOR = '\0';

private byte[] scratchBuffer = new byte[SCRATCH_BUFFER_SIZE];

private OutputStream outputStream = null;
Expand Down Expand Up @@ -307,7 +309,7 @@ private void writeField(FieldDef fd, Object fieldValue) throws Exception
fillLength = SCRATCH_BUFFER_SIZE;
}

Arrays.fill(scratchBuffer, 0, fillLength, (byte) '\0');
Arrays.fill(scratchBuffer, 0, fillLength, NULL_TERMINATOR);
writeByteArray(scratchBuffer, 0, fillLength);
numFillBytes -= fillLength;
}
Expand Down Expand Up @@ -462,7 +464,7 @@ else if (fd.getDataLen() == 8)
}
case CHAR:
{
byte c='\0';
byte c = NULL_TERMINATOR;
if (fieldValue!=null)
{
String value = (String) fieldValue;
Expand All @@ -475,10 +477,13 @@ else if (fd.getDataLen() == 8)
case STRING:
{
String value = fieldValue != null ? (String) fieldValue : "";
int eosIdx = value.indexOf('\0');
if (eosIdx > -1)
if (fd.getFieldType() == FieldType.VAR_STRING)
Copy link
Member

Choose a reason for hiding this comment

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

minor: why not introduce nullByte (from L:614) earlier or as static final and use that throughout instead of the literal '\0'

{
value = value.substring(0,eosIdx);
int eosIdx = value.indexOf(NULL_TERMINATOR);
if (eosIdx > -1)
{
value = value.substring(0,eosIdx);
}
}

byte[] data = new byte[0];
Expand Down Expand Up @@ -573,10 +578,10 @@ else if (fd.getSourceType() == HpccSrcType.QSTRING)
{
if (fd.getFieldType() == FieldType.VAR_STRING && bytesToWrite > 0)
{
data[bytesToWrite - 1] = '\0';
data[bytesToWrite - 1] = NULL_TERMINATOR;
if (fd.getSourceType().isUTF16() && bytesToWrite > 1)
{
data[bytesToWrite - 2] = '\0';
data[bytesToWrite - 2] = NULL_TERMINATOR;
}
}

Expand All @@ -594,7 +599,7 @@ else if (fd.getSourceType() == HpccSrcType.QSTRING)
fillLength = SCRATCH_BUFFER_SIZE;
}

Arrays.fill(scratchBuffer, 0, fillLength, (byte) '\0');
Arrays.fill(scratchBuffer, 0, fillLength, NULL_TERMINATOR);
writeByteArray(scratchBuffer, 0, fillLength);
numFillBytes -= fillLength;
}
Expand All @@ -608,11 +613,25 @@ else if (fd.getSourceType() == HpccSrcType.QSTRING)

if (fd.getFieldType() == FieldType.VAR_STRING)
{
byte nullByte = '\0';
this.buffer.put(nullByte);
if (fd.getSourceType().isUTF16())
{
this.buffer.put(nullByte);
boolean needsNullAdded = data.length < 2
|| data[data.length - 1] != NULL_TERMINATOR
|| data[data.length - 2] != NULL_TERMINATOR;
if (needsNullAdded)
{
this.buffer.put(NULL_TERMINATOR);
this.buffer.put(NULL_TERMINATOR);
}
}
else
{
boolean needsNullAdded = data.length < 1
|| data[data.length - 1] != NULL_TERMINATOR;
if (needsNullAdded)
{
this.buffer.put(NULL_TERMINATOR);
}
}
}
}
Expand Down
87 changes: 87 additions & 0 deletions dfsclient/src/test/java/org/hpccsystems/dfs/client/DFSReadWriteTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,93 @@ public void readWithForcedTimeoutTest() throws Exception
assertEquals("Not all records loaded",expectedCounts[0], records.size());
}

@Test
public void nullCharTests() throws Exception
{
// Unicode
{
FieldDef recordDef = null;
{
FieldDef[] fieldDefs = new FieldDef[2];
fieldDefs[0] = new FieldDef("uni", FieldType.STRING, "STRING", 100, false, false, HpccSrcType.UTF16LE, new FieldDef[0]);
fieldDefs[1] = new FieldDef("fixedUni", FieldType.STRING, "STRING", 100, true, false, HpccSrcType.UTF16LE, new FieldDef[0]);

recordDef = new FieldDef("RootRecord", FieldType.RECORD, "rec", 4, false, false, HpccSrcType.LITTLE_ENDIAN, fieldDefs);
}

List<HPCCRecord> records = new ArrayList<HPCCRecord>();
int maxUTF16BMPChar = Character.MAX_CODE_POINT;
for (int i = 0; i < maxUTF16BMPChar; i++) {
String strMidEOS = "";
for (int j = 0; j < 98; j++, i++) {
if (j == 50) {
strMidEOS += "\0";
}
strMidEOS += Character.toString((char) i);
}

Object[] fields = {strMidEOS, strMidEOS};
records.add(new HPCCRecord(fields, recordDef));
}

String fileName = "unicode::all_chars::test";
writeFile(records, fileName, recordDef, connTO);

HPCCFile file = new HPCCFile(fileName, connString , hpccUser, hpccPass);
List<HPCCRecord> readRecords = readFile(file, 10000, false, false, BinaryRecordReader.TRIM_STRINGS);

for (int i = 0; i < records.size(); i++) {
HPCCRecord record = records.get(i);
HPCCRecord readRecord = readRecords.get(i);
if (readRecord.equals(record) == false)
{
System.out.println("Record: " + i + " did not match\n" + record + "\n" + readRecord);
}
}
}

// SBC / ASCII
{
FieldDef recordDef = null;
{
FieldDef[] fieldDefs = new FieldDef[2];
fieldDefs[0] = new FieldDef("str", FieldType.STRING, "STRING", 10, false, false, HpccSrcType.SINGLE_BYTE_CHAR, new FieldDef[0]);
fieldDefs[1] = new FieldDef("fixedStr", FieldType.STRING, "STRING", 10, true, false, HpccSrcType.SINGLE_BYTE_CHAR, new FieldDef[0]);

recordDef = new FieldDef("RootRecord", FieldType.RECORD, "rec", 4, false, false, HpccSrcType.LITTLE_ENDIAN, fieldDefs);
}

List<HPCCRecord> records = new ArrayList<HPCCRecord>();
for (int i = 0; i < 255; i++) {
String strMidEOS = "";
for (int j = 0; j < 9; j++, i++) {
if (j == 5) {
strMidEOS += "\0";
}
strMidEOS += Character.toString((char) i);
}

Object[] fields = {strMidEOS, strMidEOS};
records.add(new HPCCRecord(fields, recordDef));
}

String fileName = "ascii::all_chars::test";
writeFile(records, fileName, recordDef, connTO);

HPCCFile file = new HPCCFile(fileName, connString , hpccUser, hpccPass);
List<HPCCRecord> readRecords = readFile(file, 10000, false, false, BinaryRecordReader.TRIM_STRINGS);

for (int i = 0; i < records.size(); i++) {
HPCCRecord record = records.get(i);
HPCCRecord readRecord = readRecords.get(i);
if (readRecord.equals(record) == false)
{
System.out.println("Record: " + i + " did not match\n" + record + "\n" + readRecord);
}
}
}
}

@Test
public void integrationReadWriteBackTest() throws Exception
{
Expand Down
Loading