kreuzberg 4.0.0.pre.rc.14 → 4.0.0.pre.rc.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,247 +0,0 @@
1
- use kreuzberg::panic_context::PanicContext;
2
- use std::cell::RefCell;
3
-
4
- /// Structured error that includes both the error message and optional panic context.
5
- #[derive(Debug, Clone)]
6
- pub struct StructuredError {
7
- /// The error message
8
- pub message: String,
9
- /// Optional panic context if this error originated from a panic
10
- pub panic_context: Option<PanicContext>,
11
- /// Error code for programmatic error handling
12
- pub code: ErrorCode,
13
- }
14
-
15
- /// Error codes for different types of errors.
16
- #[derive(Debug, Clone, Copy, PartialEq, Eq)]
17
- #[repr(i32)]
18
- pub enum ErrorCode {
19
- /// No error
20
- Success = 0,
21
- /// Generic error
22
- GenericError = 1,
23
- /// Panic was caught
24
- Panic = 2,
25
- /// Invalid argument
26
- InvalidArgument = 3,
27
- /// IO error
28
- IoError = 4,
29
- /// Parsing error
30
- ParsingError = 5,
31
- /// OCR error
32
- OcrError = 6,
33
- /// Missing dependency
34
- MissingDependency = 7,
35
- }
36
-
37
- impl StructuredError {
38
- /// Creates a new StructuredError from a panic context.
39
- pub fn from_panic(context: PanicContext) -> Self {
40
- Self {
41
- message: context.format(),
42
- panic_context: Some(context),
43
- code: ErrorCode::Panic,
44
- }
45
- }
46
-
47
- /// Creates a new StructuredError from a regular error message.
48
- pub fn from_message(message: String, code: ErrorCode) -> Self {
49
- Self {
50
- message,
51
- panic_context: None,
52
- code,
53
- }
54
- }
55
-
56
- /// Returns the full error message including panic context if available.
57
- pub fn full_message(&self) -> String {
58
- if let Some(ref ctx) = self.panic_context {
59
- format!("{} (at {}:{}:{})", self.message, ctx.file, ctx.line, ctx.function)
60
- } else {
61
- self.message.clone()
62
- }
63
- }
64
- }
65
-
66
- thread_local! {
67
- static LAST_STRUCTURED_ERROR: RefCell<Option<StructuredError>> = const { RefCell::new(None) };
68
- }
69
-
70
- /// Sets the last structured error.
71
- pub fn set_structured_error(error: StructuredError) {
72
- LAST_STRUCTURED_ERROR.with(|last| *last.borrow_mut() = Some(error));
73
- }
74
-
75
- /// Gets the last structured error message (for compatibility with existing code).
76
- pub fn get_last_error_message() -> Option<String> {
77
- LAST_STRUCTURED_ERROR.with(|last| last.borrow().as_ref().map(|e| e.full_message()))
78
- }
79
-
80
- /// Gets the last error code.
81
- pub fn get_last_error_code() -> ErrorCode {
82
- LAST_STRUCTURED_ERROR.with(|last| last.borrow().as_ref().map(|e| e.code).unwrap_or(ErrorCode::Success))
83
- }
84
-
85
- /// Gets the last panic context if the last error was a panic.
86
- pub fn get_last_panic_context() -> Option<PanicContext> {
87
- LAST_STRUCTURED_ERROR.with(|last| last.borrow().as_ref().and_then(|e| e.panic_context.clone()))
88
- }
89
-
90
- /// Clears the last structured error.
91
- pub fn clear_structured_error() {
92
- LAST_STRUCTURED_ERROR.with(|last| *last.borrow_mut() = None);
93
- }
94
-
95
- /// Macro to wrap FFI functions with panic catching.
96
- ///
97
- /// This macro catches panics at FFI boundaries and converts them to structured errors.
98
- /// It captures file, line, and function information for better error reporting.
99
- ///
100
- /// # Usage
101
- ///
102
- /// ```rust,ignore
103
- /// #[no_mangle]
104
- /// pub extern "C" fn my_ffi_function(arg: *const c_char) -> *mut ExtractionResult {
105
- /// ffi_panic_guard!("my_ffi_function", {
106
- /// // Your FFI function body here
107
- /// // Return the result normally
108
- /// })
109
- /// }
110
- /// ```
111
- ///
112
- /// For bool-returning functions:
113
- ///
114
- /// ```rust,ignore
115
- /// #[no_mangle]
116
- /// pub extern "C" fn my_bool_function(arg: *const c_char) -> bool {
117
- /// ffi_panic_guard_bool!("my_bool_function", {
118
- /// // Your FFI function body here
119
- /// // Return true or false normally
120
- /// })
121
- /// }
122
- /// ```
123
- ///
124
- /// The macro will:
125
- /// - Catch any panics that occur in the wrapped code
126
- /// - Create a PanicContext with file/line/function information
127
- /// - Store the structured error in thread-local storage
128
- /// - Return a null pointer (for pointer-returning functions) or false (for bool-returning functions) to indicate failure
129
- #[macro_export]
130
- macro_rules! ffi_panic_guard {
131
- ($function_name:expr, $body:expr) => {{
132
- match std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| $body)) {
133
- Ok(result) => result,
134
- Err(panic_info) => {
135
- let context =
136
- kreuzberg::panic_context::PanicContext::new(file!(), line!(), $function_name, panic_info.as_ref());
137
- $crate::panic_shield::set_structured_error($crate::panic_shield::StructuredError::from_panic(context));
138
- std::ptr::null_mut()
139
- }
140
- }
141
- }};
142
- }
143
-
144
- /// Macro to wrap FFI functions that return bool with panic catching.
145
- ///
146
- /// This variant of ffi_panic_guard returns false on panic (suitable for bool-returning functions).
147
- #[macro_export]
148
- macro_rules! ffi_panic_guard_bool {
149
- ($function_name:expr, $body:expr) => {{
150
- match std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| $body)) {
151
- Ok(result) => result,
152
- Err(panic_info) => {
153
- let context =
154
- kreuzberg::panic_context::PanicContext::new(file!(), line!(), $function_name, panic_info.as_ref());
155
- $crate::panic_shield::set_structured_error($crate::panic_shield::StructuredError::from_panic(context));
156
- false
157
- }
158
- }
159
- }};
160
- }
161
-
162
- #[cfg(test)]
163
- mod tests {
164
- use super::*;
165
-
166
- #[test]
167
- fn test_structured_error_from_panic() {
168
- let panic_msg = "test panic".to_string();
169
- let ctx = PanicContext::new("test.rs", 42, "test_fn", &panic_msg);
170
- let err = StructuredError::from_panic(ctx);
171
-
172
- assert_eq!(err.code, ErrorCode::Panic);
173
- assert!(err.panic_context.is_some());
174
- assert!(err.message.contains("test panic"));
175
- }
176
-
177
- #[test]
178
- fn test_structured_error_from_message() {
179
- let err = StructuredError::from_message("test error".to_string(), ErrorCode::GenericError);
180
-
181
- assert_eq!(err.code, ErrorCode::GenericError);
182
- assert!(err.panic_context.is_none());
183
- assert_eq!(err.message, "test error");
184
- }
185
-
186
- #[test]
187
- fn test_error_storage() {
188
- clear_structured_error();
189
- assert!(get_last_error_message().is_none());
190
-
191
- let err = StructuredError::from_message("test".to_string(), ErrorCode::IoError);
192
- set_structured_error(err);
193
-
194
- assert_eq!(get_last_error_message(), Some("test".to_string()));
195
- assert_eq!(get_last_error_code(), ErrorCode::IoError);
196
-
197
- clear_structured_error();
198
- assert!(get_last_error_message().is_none());
199
- }
200
-
201
- #[test]
202
- fn test_panic_context_extraction() {
203
- clear_structured_error();
204
-
205
- let panic_msg = "panic message".to_string();
206
- let ctx = PanicContext::new("file.rs", 10, "func", &panic_msg);
207
- let err = StructuredError::from_panic(ctx);
208
- set_structured_error(err);
209
-
210
- let retrieved_ctx = get_last_panic_context();
211
- assert!(retrieved_ctx.is_some());
212
-
213
- let ctx = retrieved_ctx.unwrap();
214
- assert_eq!(ctx.file, "file.rs");
215
- assert_eq!(ctx.line, 10);
216
- assert_eq!(ctx.function, "func");
217
- }
218
-
219
- #[test]
220
- fn test_ffi_panic_guard_success() {
221
- let result = crate::ffi_panic_guard!("test_success", { Box::into_raw(Box::new(42)) });
222
- assert!(!result.is_null());
223
- unsafe {
224
- assert_eq!(*result, 42);
225
- let _ = Box::from_raw(result);
226
- }
227
- }
228
-
229
- #[test]
230
- fn test_ffi_panic_guard_panic() {
231
- clear_structured_error();
232
-
233
- let result: *mut i32 = crate::ffi_panic_guard!("test_panic", {
234
- panic!("intentional panic");
235
- #[allow(unreachable_code)]
236
- Box::into_raw(Box::new(42))
237
- });
238
-
239
- assert!(result.is_null());
240
- assert!(get_last_error_message().is_some());
241
- assert_eq!(get_last_error_code(), ErrorCode::Panic);
242
-
243
- let msg = get_last_error_message().unwrap();
244
- assert!(msg.contains("intentional panic"));
245
- assert!(msg.contains("test_panic"));
246
- }
247
- }
@@ -1,48 +0,0 @@
1
- # Disabled Integration Tests
2
-
3
- ## Why These Tests Were Disabled
4
-
5
- These integration tests were attempting to test the C FFI interface from Rust using `extern "C"` declarations. However, this approach has fundamental issues:
6
-
7
- 1. **Linking Problem**: Integration tests in `tests/` directory run as separate binaries. When the library is compiled as `cdylib` or `staticlib`, these crate types don't automatically link to Rust integration tests.
8
-
9
- 2. **Architecture Mismatch**: These tests were trying to use `unsafe extern "C"` blocks to declare functions that are already defined in the same crate. This creates a circular dependency where the test binary expects to dynamically link against symbols that should be statically linked.
10
-
11
- 3. **Wrong Testing Layer**: C FFI functions should be tested from the actual language bindings (Java, Go, etc.) that consume them, not from Rust integration tests.
12
-
13
- ## Testing Strategy
14
-
15
- The FFI layer is thoroughly tested through:
16
-
17
- 1. **Unit tests** in `src/lib.rs` that directly call the public Rust FFI functions
18
- 2. **Language binding tests**:
19
- - Java: `packages/java/src/test/java/`
20
- - Go: `packages/go/v4/*_test.go`
21
- - Python: `packages/python/tests/`
22
- - TypeScript: `packages/typescript/**/*.spec.ts`
23
- - Ruby: `packages/ruby/spec/`
24
-
25
- 3. **E2E tests** in `e2e/` directory that test the complete integration
26
-
27
- ## Error That Led to Disabling
28
-
29
- ```
30
- error: linking with `cc` failed: exit status: 1
31
- rust-lld: error: undefined symbol: kreuzberg_last_error
32
- rust-lld: error: undefined symbol: kreuzberg_load_extraction_config_from_file
33
- rust-lld: error: undefined symbol: kreuzberg_free_string
34
- ```
35
-
36
- This occurred because the integration test binaries couldn't link to the C symbols defined in the FFI crate.
37
-
38
- ## Future Improvements
39
-
40
- If C FFI integration tests are needed from Rust:
41
-
42
- 1. Create a separate C test harness that links against the compiled `.so`/`.dylib`
43
- 2. Move critical tests into unit tests within `src/lib.rs`
44
- 3. Ensure comprehensive coverage through language binding tests instead
45
-
46
- ## CI Impact
47
-
48
- This change resolves CI failures in run 19607600358 on both macOS-14 and Ubuntu runners.
@@ -1,299 +0,0 @@
1
- //! FFI config loading integration tests.
2
- //!
3
- //! Tests the FFI layer for configuration loading from files and discovery.
4
-
5
- use std::ffi::{CStr, CString};
6
- use std::fs;
7
- use std::os::raw::c_char;
8
- use tempfile::TempDir;
9
-
10
- unsafe extern "C" {
11
- fn kreuzberg_load_extraction_config_from_file(file_path: *const c_char) -> *mut c_char;
12
- fn kreuzberg_free_string(s: *mut c_char);
13
- fn kreuzberg_last_error() -> *const c_char;
14
- }
15
-
16
- /// Helper to convert *const c_char to String
17
- unsafe fn c_str_to_string(ptr: *const c_char) -> Option<String> {
18
- if ptr.is_null() {
19
- None
20
- } else {
21
- unsafe { Some(CStr::from_ptr(ptr).to_string_lossy().into_owned()) }
22
- }
23
- }
24
-
25
- /// Helper to get last error message
26
- unsafe fn get_last_error() -> Option<String> {
27
- let error_ptr = unsafe { kreuzberg_last_error() };
28
- unsafe { c_str_to_string(error_ptr) }
29
- }
30
-
31
- /// Test successful config loading from TOML file.
32
- #[test]
33
- fn test_load_config_from_toml_file_succeeds() {
34
- let temp_dir = TempDir::new().unwrap();
35
- let config_path = temp_dir.path().join("config.toml");
36
-
37
- let toml_content = r#"
38
- [ocr]
39
- enabled = true
40
- backend = "tesseract"
41
-
42
- [chunking]
43
- max_chars = 1000
44
- max_overlap = 100
45
- "#;
46
-
47
- fs::write(&config_path, toml_content).unwrap();
48
-
49
- unsafe {
50
- let path_cstr = CString::new(config_path.to_str().unwrap()).unwrap();
51
- let result = kreuzberg_load_extraction_config_from_file(path_cstr.as_ptr());
52
-
53
- assert!(!result.is_null(), "Result should not be null");
54
-
55
- let json_str = c_str_to_string(result).expect("Should have valid JSON");
56
- kreuzberg_free_string(result);
57
-
58
- let json_value: serde_json::Value = serde_json::from_str(&json_str).unwrap();
59
- assert!(json_value.get("ocr").is_some(), "Should have OCR config");
60
- assert!(json_value.get("chunking").is_some(), "Should have chunking config");
61
- }
62
- }
63
-
64
- /// Test successful config loading from YAML file.
65
- #[test]
66
- fn test_load_config_from_yaml_file_succeeds() {
67
- let temp_dir = TempDir::new().unwrap();
68
- let config_path = temp_dir.path().join("config.yaml");
69
-
70
- let yaml_content = r#"
71
- ocr:
72
- enabled: true
73
- backend: tesseract
74
- chunking:
75
- max_chars: 1000
76
- max_overlap: 100
77
- "#;
78
-
79
- fs::write(&config_path, yaml_content).unwrap();
80
-
81
- unsafe {
82
- let path_cstr = CString::new(config_path.to_str().unwrap()).unwrap();
83
- let result = kreuzberg_load_extraction_config_from_file(path_cstr.as_ptr());
84
-
85
- assert!(!result.is_null(), "Result should not be null");
86
-
87
- let json_str = c_str_to_string(result).expect("Should have valid JSON");
88
- kreuzberg_free_string(result);
89
-
90
- let json_value: serde_json::Value = serde_json::from_str(&json_str).unwrap();
91
- assert!(json_value.get("ocr").is_some(), "Should have OCR config");
92
- assert!(json_value.get("chunking").is_some(), "Should have chunking config");
93
- }
94
- }
95
-
96
- /// Test successful config loading from JSON file.
97
- #[test]
98
- fn test_load_config_from_json_file_succeeds() {
99
- let temp_dir = TempDir::new().unwrap();
100
- let config_path = temp_dir.path().join("config.json");
101
-
102
- let json_content = r#"
103
- {
104
- "ocr": {
105
- "enabled": true,
106
- "backend": "tesseract"
107
- },
108
- "chunking": {
109
- "max_chars": 1000,
110
- "max_overlap": 100
111
- }
112
- }
113
- "#;
114
-
115
- fs::write(&config_path, json_content).unwrap();
116
-
117
- unsafe {
118
- let path_cstr = CString::new(config_path.to_str().unwrap()).unwrap();
119
- let result = kreuzberg_load_extraction_config_from_file(path_cstr.as_ptr());
120
-
121
- assert!(!result.is_null(), "Result should not be null");
122
-
123
- let json_str = c_str_to_string(result).expect("Should have valid JSON");
124
- kreuzberg_free_string(result);
125
-
126
- let json_value: serde_json::Value = serde_json::from_str(&json_str).unwrap();
127
- assert!(json_value.get("ocr").is_some(), "Should have OCR config");
128
- assert!(json_value.get("chunking").is_some(), "Should have chunking config");
129
- }
130
- }
131
-
132
- /// Test config loading fails gracefully with invalid file path.
133
- #[test]
134
- fn test_load_config_from_invalid_path_fails_gracefully() {
135
- unsafe {
136
- let invalid_path = CString::new("/nonexistent/path/config.toml").unwrap();
137
- let result = kreuzberg_load_extraction_config_from_file(invalid_path.as_ptr());
138
-
139
- assert!(result.is_null(), "Result should be null for invalid path");
140
-
141
- let error = get_last_error();
142
- assert!(error.is_some(), "Should have error message");
143
- let error_msg = error.unwrap();
144
- assert!(
145
- error_msg.contains("No such file") || error_msg.contains("not found"),
146
- "Error should mention file not found: {}",
147
- error_msg
148
- );
149
- }
150
- }
151
-
152
- /// Test config loading fails gracefully with null pointer.
153
- #[test]
154
- fn test_load_config_from_null_pointer_fails_gracefully() {
155
- unsafe {
156
- let result = kreuzberg_load_extraction_config_from_file(std::ptr::null());
157
-
158
- assert!(result.is_null(), "Result should be null for null pointer");
159
-
160
- let error = get_last_error();
161
- assert!(error.is_some(), "Should have error message");
162
- let error_msg = error.unwrap();
163
- assert!(
164
- error_msg.contains("null") || error_msg.contains("invalid"),
165
- "Error should mention null/invalid: {}",
166
- error_msg
167
- );
168
- }
169
- }
170
-
171
- /// Test config loading fails gracefully with malformed TOML.
172
- #[test]
173
- fn test_load_config_from_malformed_toml_fails_gracefully() {
174
- let temp_dir = TempDir::new().unwrap();
175
- let config_path = temp_dir.path().join("config.toml");
176
-
177
- let malformed_toml = r#"
178
- [ocr
179
- enabled = true
180
- "#;
181
-
182
- fs::write(&config_path, malformed_toml).unwrap();
183
-
184
- unsafe {
185
- let path_cstr = CString::new(config_path.to_str().unwrap()).unwrap();
186
- let result = kreuzberg_load_extraction_config_from_file(path_cstr.as_ptr());
187
-
188
- assert!(result.is_null(), "Result should be null for malformed TOML");
189
-
190
- let error = get_last_error();
191
- assert!(error.is_some(), "Should have error message");
192
- let error_msg = error.unwrap();
193
- assert!(
194
- error_msg.contains("parse") || error_msg.contains("invalid") || error_msg.contains("TOML"),
195
- "Error should mention parsing issue: {}",
196
- error_msg
197
- );
198
- }
199
- }
200
-
201
- /// Test config loading fails gracefully with malformed JSON.
202
- #[test]
203
- fn test_load_config_from_malformed_json_fails_gracefully() {
204
- let temp_dir = TempDir::new().unwrap();
205
- let config_path = temp_dir.path().join("config.json");
206
-
207
- let malformed_json = r#"
208
- {
209
- "ocr": {
210
- "enabled": true
211
- }
212
- "chunking": {}
213
- }
214
- "#;
215
-
216
- fs::write(&config_path, malformed_json).unwrap();
217
-
218
- unsafe {
219
- let path_cstr = CString::new(config_path.to_str().unwrap()).unwrap();
220
- let result = kreuzberg_load_extraction_config_from_file(path_cstr.as_ptr());
221
-
222
- assert!(result.is_null(), "Result should be null for malformed JSON");
223
-
224
- let error = get_last_error();
225
- assert!(error.is_some(), "Should have error message");
226
- let error_msg = error.unwrap();
227
- assert!(
228
- error_msg.contains("parse") || error_msg.contains("invalid") || error_msg.contains("JSON"),
229
- "Error should mention parsing issue: {}",
230
- error_msg
231
- );
232
- }
233
- }
234
-
235
- /// Test config loading with invalid UTF-8 in path.
236
- #[test]
237
- fn test_load_config_with_invalid_utf8_fails_gracefully() {
238
- unsafe {
239
- let invalid_bytes = vec![0xFF, 0xFE, 0xFD];
240
- let invalid_cstr = CString::new(invalid_bytes).unwrap_or_else(|_| CString::new("").unwrap());
241
-
242
- let result = kreuzberg_load_extraction_config_from_file(invalid_cstr.as_ptr());
243
-
244
- assert!(result.is_null(), "Result should be null for invalid UTF-8");
245
-
246
- let error = get_last_error();
247
- assert!(error.is_some(), "Should have error message");
248
- }
249
- }
250
-
251
- /// Test config loading with empty file.
252
- #[test]
253
- fn test_load_config_from_empty_file_uses_defaults() {
254
- let temp_dir = TempDir::new().unwrap();
255
- let config_path = temp_dir.path().join("config.toml");
256
-
257
- fs::write(&config_path, "").unwrap();
258
-
259
- unsafe {
260
- let path_cstr = CString::new(config_path.to_str().unwrap()).unwrap();
261
- let result = kreuzberg_load_extraction_config_from_file(path_cstr.as_ptr());
262
-
263
- assert!(!result.is_null(), "Result should not be null for empty file");
264
-
265
- let json_str = c_str_to_string(result).expect("Should have valid JSON");
266
- kreuzberg_free_string(result);
267
-
268
- let json_value: serde_json::Value = serde_json::from_str(&json_str).unwrap();
269
- assert!(json_value.is_object(), "Should be a JSON object");
270
- }
271
- }
272
-
273
- /// Test format detection from file extension.
274
- #[test]
275
- fn test_config_format_detection_from_extension() {
276
- let temp_dir = TempDir::new().unwrap();
277
-
278
- let yml_path = temp_dir.path().join("config.yml");
279
- let yaml_content = "ocr:\n enabled: true";
280
- fs::write(&yml_path, yaml_content).unwrap();
281
-
282
- unsafe {
283
- let path_cstr = CString::new(yml_path.to_str().unwrap()).unwrap();
284
- let result = kreuzberg_load_extraction_config_from_file(path_cstr.as_ptr());
285
- assert!(!result.is_null(), ".yml extension should be recognized");
286
- kreuzberg_free_string(result);
287
- }
288
-
289
- let json_path = temp_dir.path().join("config.json");
290
- let json_content = r#"{"ocr": {"enabled": true}}"#;
291
- fs::write(&json_path, json_content).unwrap();
292
-
293
- unsafe {
294
- let path_cstr = CString::new(json_path.to_str().unwrap()).unwrap();
295
- let result = kreuzberg_load_extraction_config_from_file(path_cstr.as_ptr());
296
- assert!(!result.is_null(), ".json extension should be recognized");
297
- kreuzberg_free_string(result);
298
- }
299
- }