-
Notifications
You must be signed in to change notification settings - Fork 19
feat: Add custom metadata support for IPC messages and RecordBatch #361
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
Merged
+416
−19
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
bdb2047
feat: Add custom metadata support for IPC messages and RecordBatch
rustyconover ceaff66
feat: Add custom metadata support for RecordBatchWriter.write()
rustyconover 466cd88
fix: add test file
rustyconover d9ca7ec
fix: make metadata live on the RecordBatch object and simplify the AP…
rustyconover File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| // 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. | ||
|
|
||
| import { readFileSync } from 'node:fs'; | ||
| import path from 'node:path'; | ||
| import { tableFromIPC, RecordBatch } from 'apache-arrow'; | ||
|
|
||
| // Path to the test file with message-level metadata | ||
| // Use process.cwd() since tests are run from project root | ||
| const testFilePath = path.resolve(process.cwd(), 'test/data/test_message_metadata.arrow'); | ||
|
|
||
| describe('RecordBatch message metadata', () => { | ||
| const buffer = readFileSync(testFilePath); | ||
| const table = tableFromIPC(buffer); | ||
|
|
||
| test('should read RecordBatch metadata from IPC file', () => { | ||
| expect(table.batches).toHaveLength(3); | ||
|
|
||
| for (let i = 0; i < table.batches.length; i++) { | ||
| const batch = table.batches[i]; | ||
| expect(batch).toBeInstanceOf(RecordBatch); | ||
| expect(batch.metadata).toBeInstanceOf(Map); | ||
| expect(batch.metadata.size).toBeGreaterThan(0); | ||
|
|
||
| // Verify specific metadata keys exist | ||
| expect(batch.metadata.has('batch_index')).toBe(true); | ||
| expect(batch.metadata.has('batch_id')).toBe(true); | ||
| expect(batch.metadata.has('producer')).toBe(true); | ||
|
|
||
| // Verify batch_index matches the batch position | ||
| expect(batch.metadata.get('batch_index')).toBe(String(i)); | ||
| expect(batch.metadata.get('batch_id')).toBe(`batch_${String(i).padStart(4, '0')}`); | ||
| } | ||
| }); | ||
|
|
||
| test('should read unicode metadata values', () => { | ||
| const batch = table.batches[0]; | ||
| expect(batch.metadata.has('unicode_test')).toBe(true); | ||
| expect(batch.metadata.get('unicode_test')).toBe('Hello 世界 🌍 مرحبا'); | ||
| }); | ||
|
|
||
| test('should handle empty metadata values', () => { | ||
| const batch = table.batches[0]; | ||
| expect(batch.metadata.has('optional_field')).toBe(true); | ||
| expect(batch.metadata.get('optional_field')).toBe(''); | ||
| }); | ||
|
|
||
| test('should read JSON metadata values', () => { | ||
| const batch = table.batches[0]; | ||
| expect(batch.metadata.has('batch_info_json')).toBe(true); | ||
| const jsonStr = batch.metadata.get('batch_info_json')!; | ||
| const parsed = JSON.parse(jsonStr); | ||
| expect(parsed.batch_number).toBe(0); | ||
| expect(parsed.processing_stage).toBe('final'); | ||
| expect(parsed.tags).toEqual(['validated', 'complete']); | ||
| }); | ||
|
|
||
| describe('metadata preservation', () => { | ||
| test('should preserve metadata through slice()', () => { | ||
| const batch = table.batches[0]; | ||
| const sliced = batch.slice(0, 2); | ||
| expect(sliced.metadata).toBeInstanceOf(Map); | ||
| expect(sliced.metadata.size).toBe(batch.metadata.size); | ||
| expect(sliced.metadata.get('batch_index')).toBe(batch.metadata.get('batch_index')); | ||
| }); | ||
|
|
||
| test('should preserve metadata through select()', () => { | ||
| const batch = table.batches[0]; | ||
| const selected = batch.select(['id', 'name']); | ||
| expect(selected.metadata).toBeInstanceOf(Map); | ||
| expect(selected.metadata.size).toBe(batch.metadata.size); | ||
| expect(selected.metadata.get('batch_index')).toBe(batch.metadata.get('batch_index')); | ||
| }); | ||
|
|
||
| test('should preserve metadata through selectAt()', () => { | ||
| const batch = table.batches[0]; | ||
| const selectedAt = batch.selectAt([0, 1]); | ||
| expect(selectedAt.metadata).toBeInstanceOf(Map); | ||
| expect(selectedAt.metadata.size).toBe(batch.metadata.size); | ||
| expect(selectedAt.metadata.get('batch_index')).toBe(batch.metadata.get('batch_index')); | ||
| }); | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.