-
Notifications
You must be signed in to change notification settings - Fork 132
fix(parquet): make column reader cleanup idempotent #924
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
Changes from 3 commits
3f74f08
4ff63aa
2e618a9
af77792
89c71e3
f92eb21
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package file | ||
|
|
||
| import ( | ||
| "errors" | ||
| "testing" | ||
|
|
||
| "github.com/apache/arrow-go/v18/parquet" | ||
| "github.com/apache/arrow-go/v18/parquet/compress" | ||
| format "github.com/apache/arrow-go/v18/parquet/internal/gen-go/parquet" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| type closeTrackingPage struct { | ||
| releaseCalls int | ||
| } | ||
|
|
||
| func (p *closeTrackingPage) Type() PageType { return PageTypeDataPage } | ||
| func (p *closeTrackingPage) Data() []byte { return nil } | ||
| func (p *closeTrackingPage) Encoding() format.Encoding { return format.Encoding_PLAIN } | ||
| func (p *closeTrackingPage) NumValues() int32 { return 0 } | ||
| func (p *closeTrackingPage) Release() { p.releaseCalls++ } | ||
|
|
||
| type closeTrackingPageReader struct { | ||
| closeCalls int | ||
| closeErr error | ||
| } | ||
|
|
||
| func (r *closeTrackingPageReader) SetMaxPageHeaderSize(int) {} | ||
| func (r *closeTrackingPageReader) Page() Page { return nil } | ||
| func (r *closeTrackingPageReader) Next() bool { return false } | ||
| func (r *closeTrackingPageReader) Err() error { return nil } | ||
| func (r *closeTrackingPageReader) Reset(parquet.BufferedReader, int64, compress.Compression, *CryptoContext) { | ||
| } | ||
| func (r *closeTrackingPageReader) GetDictionaryPage() (*DictionaryPage, error) { return nil, nil } | ||
| func (r *closeTrackingPageReader) SeekToPageWithRow(int64) error { return nil } | ||
| func (r *closeTrackingPageReader) Close() error { | ||
| r.closeCalls++ | ||
| return r.closeErr | ||
| } | ||
|
|
||
| func TestColumnChunkReaderCloseIsIdempotent(t *testing.T) { | ||
| page := &closeTrackingPage{} | ||
| rdr := &closeTrackingPageReader{} | ||
| reader := &columnChunkReader{curPage: page, rdr: rdr} | ||
|
|
||
| require.NoError(t, reader.Close()) | ||
| require.NoError(t, reader.Close()) | ||
| require.Equal(t, 1, page.releaseCalls) | ||
| require.Equal(t, 1, rdr.closeCalls) | ||
| require.Nil(t, reader.curPage) | ||
| require.Nil(t, reader.rdr) | ||
| } | ||
|
|
||
| func TestColumnChunkReaderSetPageReaderReleasesBeforeReplacement(t *testing.T) { | ||
| page := &closeTrackingPage{} | ||
| oldRdr := &closeTrackingPageReader{} | ||
| newRdr := &closeTrackingPageReader{} | ||
| reader := &columnChunkReader{curPage: page, rdr: oldRdr} | ||
|
|
||
| require.NoError(t, reader.setPageReader(newRdr)) | ||
| require.Equal(t, 1, page.releaseCalls) | ||
| require.Equal(t, 1, oldRdr.closeCalls) | ||
| require.Equal(t, 0, newRdr.closeCalls) | ||
| require.Same(t, newRdr, reader.rdr) | ||
| require.Nil(t, reader.curPage) | ||
|
|
||
| require.NoError(t, reader.Close()) | ||
| require.Equal(t, 1, newRdr.closeCalls) | ||
| } | ||
|
|
||
| func TestColumnChunkReaderSetPageReaderPropagatesCloseError(t *testing.T) { | ||
| closeErr := errors.New("page reader close failed") | ||
| page := &closeTrackingPage{} | ||
| oldRdr := &closeTrackingPageReader{closeErr: closeErr} | ||
| newRdr := &closeTrackingPageReader{} | ||
| reader := &columnChunkReader{curPage: page, rdr: oldRdr} | ||
|
|
||
| require.ErrorIs(t, reader.setPageReader(newRdr), closeErr) | ||
| require.ErrorIs(t, reader.err, closeErr) | ||
| require.Equal(t, 1, page.releaseCalls) | ||
| require.Equal(t, 1, oldRdr.closeCalls) | ||
| require.Equal(t, 0, newRdr.closeCalls) | ||
| require.Nil(t, reader.curPage) | ||
| require.Nil(t, reader.rdr) | ||
| require.NoError(t, reader.Close()) | ||
| require.Equal(t, 1, oldRdr.closeCalls) | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package pqarrow | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "context" | ||
| "errors" | ||
| "testing" | ||
|
|
||
| "github.com/apache/arrow-go/v18/arrow" | ||
| "github.com/apache/arrow-go/v18/arrow/array" | ||
| "github.com/apache/arrow-go/v18/arrow/memory" | ||
| "github.com/apache/arrow-go/v18/parquet" | ||
| "github.com/apache/arrow-go/v18/parquet/file" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| type pageReaderReplacementErrorRecordReader struct { | ||
| file.RecordReader | ||
| err error | ||
| seekCalls int | ||
| } | ||
|
|
||
| func (r *pageReaderReplacementErrorRecordReader) SetPageReaderWithError(pr file.PageReader) error { | ||
| if pr != nil { | ||
| _ = pr.Close() | ||
| } | ||
| return r.err | ||
| } | ||
|
|
||
| func (r *pageReaderReplacementErrorRecordReader) SeekToRow(row int64) error { | ||
| r.seekCalls++ | ||
| return r.RecordReader.SeekToRow(row) | ||
| } | ||
|
|
||
| func (r *pageReaderReplacementErrorRecordReader) Release() { | ||
| r.SetPageReader(nil) | ||
| r.RecordReader.Release() | ||
| } | ||
|
|
||
| func TestLeafReaderSeekToRowPropagatesPageReaderReplacementError(t *testing.T) { | ||
| mem := memory.NewCheckedAllocator(memory.DefaultAllocator) | ||
| defer mem.AssertSize(t, 0) | ||
|
|
||
| builder := array.NewInt32Builder(mem) | ||
| builder.AppendValues([]int32{1, 2}, nil) | ||
| values := builder.NewInt32Array() | ||
| builder.Release() | ||
| defer values.Release() | ||
|
|
||
| field := arrow.Field{Name: "value", Type: arrow.PrimitiveTypes.Int32} | ||
| schema := arrow.NewSchema([]arrow.Field{field}, nil) | ||
| column := arrow.NewColumnFromArr(field, values) | ||
| tbl := array.NewTable(schema, []arrow.Column{column}, -1) | ||
| column.Release() | ||
| defer tbl.Release() | ||
|
|
||
| var buf bytes.Buffer | ||
| require.NoError(t, WriteTable(tbl, &buf, tbl.NumRows(), nil, NewArrowWriterProperties(WithAllocator(mem)))) | ||
|
|
||
| pfile, err := file.NewParquetReader(bytes.NewReader(buf.Bytes()), file.WithReadProps(parquet.NewReaderProperties(mem))) | ||
| require.NoError(t, err) | ||
| defer pfile.Close() | ||
|
|
||
| reader, err := NewFileReader(pfile, ArrowReadProperties{}, mem) | ||
| require.NoError(t, err) | ||
|
|
||
| columnReader, err := reader.GetColumn(context.Background(), 0) | ||
| require.NoError(t, err) | ||
| defer columnReader.Release() | ||
|
|
||
| leaf, ok := columnReader.colReaderImpl.(*leafReader) | ||
| require.True(t, ok) | ||
|
|
||
| closeErr := errors.New("page reader close failed") | ||
| wrapped := &pageReaderReplacementErrorRecordReader{ | ||
| RecordReader: leaf.recordRdr, | ||
| err: closeErr, | ||
| } | ||
| leaf.recordRdr = wrapped | ||
|
|
||
| require.ErrorIs(t, columnReader.SeekToRow(0), closeErr) | ||
| require.Zero(t, wrapped.seekCalls) | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -162,13 +162,23 @@ func (lr *leafReader) clearOut() (out *arrow.Chunked) { | |
|
|
||
| func (lr *leafReader) Field() *arrow.Field { return lr.field } | ||
|
|
||
| func (lr *leafReader) setPageReader(pr file.PageReader) error { | ||
| rr, ok := lr.recordRdr.(file.RecordReaderWithError) | ||
| if !ok { | ||
| return errors.New("record reader does not support error-returning page reader replacement") | ||
| } | ||
| return rr.SetPageReaderWithError(pr) | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If |
||
| } | ||
|
|
||
| func (lr *leafReader) SeekToRow(rowIdx int64) error { | ||
| pr, offset, err := lr.input.FindChunkForRow(rowIdx) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| lr.recordRdr.SetPageReader(pr) | ||
| if err := lr.setPageReader(pr); err != nil { | ||
| return err | ||
| } | ||
| return lr.recordRdr.SeekToRow(offset) | ||
| } | ||
|
|
||
|
|
@@ -180,7 +190,9 @@ func (lr *leafReader) nextRowGroup(remainingRows int64) error { | |
| if err != nil { | ||
| return err | ||
| } | ||
| lr.recordRdr.SetPageReader(pr) | ||
| if err := lr.setPageReader(pr); err != nil { | ||
| return err | ||
| } | ||
| lr.curRGUncompressedBytes = uncompressedBytes | ||
| lr.curRGNumRows = numRows | ||
| // When called mid-batch, extend the builder's data buffer for the new row group. | ||
|
|
||
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.
Optional: add a pqarrow-level test that a replacement close-error surfaces via
LoadBatch/SeekToRow; the propagation is currently only covered at the primitive level.