stygian-graph 0.9.2

High-performance graph-based web scraping engine with AI extraction, multi-modal support, and anti-bot capabilities
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
//! Storage adapters — persist and retrieve pipeline [`StorageRecord`](crate::ports::storage::StorageRecord)s.
//!
//! # Adapters
//!
//! | Adapter | Availability | Backing store |
//! | --------- | -------------- | --------------- |
//! | [`NullStorage`](storage::NullStorage) | always | no-op (tests / dry-run) |
//! | [`FileStorage`](storage::FileStorage) | always | `.jsonl` files on local disk |
//! | [`PostgresStorage`](storage::PostgresStorage) | `feature = "postgres"` | PostgreSQL via sqlx |

use crate::domain::error::{Result, ServiceError, StygianError};
use crate::ports::storage::{StoragePort, StorageRecord};
use async_trait::async_trait;
use std::path::PathBuf;
use tokio::io::AsyncWriteExt;

// ─────────────────────────────────────────────────────────────────────────────
// NullStorage
// ─────────────────────────────────────────────────────────────────────────────

/// No-op storage adapter — discards all records.
///
/// Useful for dry-run mode and unit tests where persistence is not required.
///
/// # Example
///
/// ```
/// use stygian_graph::adapters::storage::NullStorage;
/// use stygian_graph::ports::storage::{StoragePort, StorageRecord};
/// use serde_json::json;
///
/// # tokio_test::block_on(async {
/// let s = NullStorage;
/// s.store(StorageRecord::new("p", "n", json!(null))).await.unwrap();
/// let result = s.retrieve("any-id").await.unwrap();
/// assert!(result.is_none());
/// # });
/// ```
pub struct NullStorage;

#[async_trait]
impl StoragePort for NullStorage {
    async fn store(&self, _record: StorageRecord) -> Result<()> {
        Ok(())
    }

    async fn retrieve(&self, _id: &str) -> Result<Option<StorageRecord>> {
        Ok(None)
    }

    async fn list(&self, _pipeline_id: &str) -> Result<Vec<StorageRecord>> {
        Ok(vec![])
    }

    async fn delete(&self, _id: &str) -> Result<()> {
        Ok(())
    }
}

// ─────────────────────────────────────────────────────────────────────────────
// FileStorage
// ─────────────────────────────────────────────────────────────────────────────

/// File-based storage adapter — one `.jsonl` file per pipeline.
///
/// Each pipeline gets its own file: `<dir>/<pipeline_id>.jsonl`.
/// Records are appended one JSON object per line.
///
/// # Example
///
/// ```no_run
/// use stygian_graph::adapters::storage::FileStorage;
/// use stygian_graph::ports::storage::{StoragePort, StorageRecord};
/// use serde_json::json;
/// use std::path::PathBuf;
///
/// # tokio_test::block_on(async {
/// let storage = FileStorage::new(PathBuf::from("/tmp/stygian-results"));
/// let r = StorageRecord::new("pipe-1", "fetch", json!({"url": "https://example.com"}));
/// storage.store(r).await.unwrap();
/// # });
/// ```
pub struct FileStorage {
    dir: PathBuf,
}

impl FileStorage {
    /// Create a [`FileStorage`] backed by `dir`.
    ///
    /// The directory will be created on first write if it does not exist.
    ///
    /// # Example
    ///
    /// ```
    /// use stygian_graph::adapters::storage::FileStorage;
    /// use std::path::PathBuf;
    ///
    /// let s = FileStorage::new(PathBuf::from("/tmp/data"));
    /// ```
    pub const fn new(dir: PathBuf) -> Self {
        Self { dir }
    }

    fn pipeline_file(&self, pipeline_id: &str) -> PathBuf {
        // Sanitise: replace path separators so callers cannot escape the dir
        let safe_id = pipeline_id.replace(['/', '\\', '.', ':'], "_");
        self.dir.join(format!("{safe_id}.jsonl"))
    }
}

#[async_trait]
impl StoragePort for FileStorage {
    async fn store(&self, record: StorageRecord) -> Result<()> {
        tokio::fs::create_dir_all(&self.dir).await.map_err(|e| {
            StygianError::Service(ServiceError::InvalidResponse(format!(
                "FileStorage: create_dir_all failed: {e}"
            )))
        })?;

        let path = self.pipeline_file(&record.pipeline_id);
        let mut line = serde_json::to_string(&record).map_err(|e| {
            StygianError::Service(ServiceError::InvalidResponse(format!(
                "FileStorage: serialise record failed: {e}"
            )))
        })?;
        line.push('\n');

        let mut file = tokio::fs::OpenOptions::new()
            .create(true)
            .append(true)
            .open(&path)
            .await
            .map_err(|e| {
                StygianError::Service(ServiceError::InvalidResponse(format!(
                    "FileStorage: open {}: {e}",
                    path.display()
                )))
            })?;

        file.write_all(line.as_bytes()).await.map_err(|e| {
            StygianError::Service(ServiceError::InvalidResponse(format!(
                "FileStorage: write failed: {e}"
            )))
        })?;

        Ok(())
    }

    async fn retrieve(&self, id: &str) -> Result<Option<StorageRecord>> {
        // Scan all .jsonl files — linear scan is acceptable for moderate volumes
        let Ok(mut dir) = tokio::fs::read_dir(&self.dir).await else {
            return Ok(None);
        };

        while let Ok(Some(entry)) = dir.next_entry().await {
            let path = entry.path();
            if path.extension().and_then(|e| e.to_str()) != Some("jsonl") {
                continue;
            }
            let Ok(content) = tokio::fs::read_to_string(&path).await else {
                continue;
            };
            for line in content.lines() {
                if let Ok(record) = serde_json::from_str::<StorageRecord>(line)
                    && record.id == id
                {
                    return Ok(Some(record));
                }
            }
        }

        Ok(None)
    }

    async fn list(&self, pipeline_id: &str) -> Result<Vec<StorageRecord>> {
        let path = self.pipeline_file(pipeline_id);
        let Ok(content) = tokio::fs::read_to_string(&path).await else {
            return Ok(vec![]);
        };

        let records = content
            .lines()
            .filter(|l| !l.is_empty())
            .filter_map(|line| serde_json::from_str::<StorageRecord>(line).ok())
            .collect();

        Ok(records)
    }

    async fn delete(&self, id: &str) -> Result<()> {
        // Read-filter-rewrite strategy (adequate for typical pipeline sizes)
        let Ok(mut dir) = tokio::fs::read_dir(&self.dir).await else {
            return Ok(()); // dir does not exist → nothing to delete
        };

        while let Ok(Some(entry)) = dir.next_entry().await {
            let path = entry.path();
            if path.extension().and_then(|e| e.to_str()) != Some("jsonl") {
                continue;
            }
            let Ok(content) = tokio::fs::read_to_string(&path).await else {
                continue;
            };

            let (kept, found): (Vec<&str>, bool) = {
                let mut found = false;
                let kept = content
                    .lines()
                    .filter(|line| {
                        if let Ok(r) = serde_json::from_str::<StorageRecord>(line)
                            && r.id == id
                        {
                            found = true;
                            return false;
                        }
                        true
                    })
                    .collect::<Vec<_>>();
                (kept, found)
            };

            if found {
                let new_content = kept.join("\n");
                let new_content = if new_content.is_empty() {
                    new_content
                } else {
                    format!("{new_content}\n")
                };
                tokio::fs::write(&path, new_content.as_bytes())
                    .await
                    .map_err(|e| {
                        StygianError::Service(ServiceError::InvalidResponse(format!(
                            "FileStorage: rewrite after delete failed: {e}"
                        )))
                    })?;
                return Ok(());
            }
        }

        Ok(())
    }
}

// ─────────────────────────────────────────────────────────────────────────────
// PostgresStorage — feature = "postgres"
// ─────────────────────────────────────────────────────────────────────────────

#[cfg(feature = "postgres")]
pub use postgres::PostgresStorage;

#[cfg(feature = "postgres")]
mod postgres {
    //! PostgreSQL-backed storage via sqlx.
    //!
    //! Assumes the following table exists:
    //!
    //! ```sql
    //! CREATE TABLE IF NOT EXISTS pipeline_records (
    //!     id          TEXT PRIMARY KEY,
    //!     pipeline_id TEXT NOT NULL,
    //!     node_name   TEXT NOT NULL,
    //!     data        JSONB NOT NULL,
    //!     metadata    JSONB NOT NULL DEFAULT '{}',
    //!     timestamp_ms BIGINT NOT NULL
    //! );
    //! CREATE INDEX IF NOT EXISTS idx_pipeline_records_pipeline_id
    //!     ON pipeline_records (pipeline_id);
    //! ```

    use crate::domain::error::{Result, ServiceError, StygianError};
    use crate::ports::storage::{StoragePort, StorageRecord};
    use sqlx::{PgPool, Row};

    /// `PostgreSQL` storage adapter.
    ///
    /// # Example
    ///
    /// ```no_run
    /// use stygian_graph::adapters::storage::PostgresStorage;
    /// use sqlx::PgPool;
    ///
    /// # tokio_test::block_on(async {
    /// let pool = PgPool::connect("postgres://localhost/stygian").await.unwrap();
    /// let storage = PostgresStorage::new(pool);
    /// # });
    /// ```
    pub struct PostgresStorage {
        pool: PgPool,
    }

    impl PostgresStorage {
        /// Create a new [`PostgresStorage`] from a connection pool.
        ///
        /// # Example
        ///
        /// ```no_run
        /// use stygian_graph::adapters::storage::PostgresStorage;
        /// use sqlx::PgPool;
        ///
        /// # tokio_test::block_on(async {
        /// let pool = PgPool::connect("postgres://localhost/stygian").await.unwrap();
        /// let s = PostgresStorage::new(pool);
        /// # });
        /// ```
        pub const fn new(pool: PgPool) -> Self {
            Self { pool }
        }
    }

    #[async_trait::async_trait]
    impl StoragePort for PostgresStorage {
        async fn store(&self, record: StorageRecord) -> Result<()> {
            let metadata_json = serde_json::to_value(&record.metadata).map_err(|e| {
                StygianError::Service(ServiceError::InvalidResponse(format!(
                    "PostgresStorage: metadata serialise: {e}"
                )))
            })?;

            sqlx::query(
                "
                INSERT INTO pipeline_records
                    (id, pipeline_id, node_name, data, metadata, timestamp_ms)
                VALUES ($1, $2, $3, $4, $5, $6)
                ON CONFLICT (id) DO NOTHING
                ",
            )
            .bind(&record.id)
            .bind(&record.pipeline_id)
            .bind(&record.node_name)
            .bind(&record.data)
            .bind(metadata_json)
            .bind(i64::try_from(record.timestamp_ms).unwrap_or(i64::MAX))
            .execute(&self.pool)
            .await
            .map_err(|e| {
                StygianError::Service(ServiceError::InvalidResponse(format!(
                    "PostgresStorage: insert failed: {e}"
                )))
            })?;

            Ok(())
        }

        async fn retrieve(&self, id: &str) -> Result<Option<StorageRecord>> {
            let row = sqlx::query(
                "
                SELECT id, pipeline_id, node_name, data, metadata, timestamp_ms
                FROM pipeline_records
                WHERE id = $1
                ",
            )
            .bind(id)
            .fetch_optional(&self.pool)
            .await
            .map_err(|e| {
                StygianError::Service(ServiceError::InvalidResponse(format!(
                    "PostgresStorage: retrieve failed: {e}"
                )))
            })?;

            row.map_or(Ok(None), |r| {
                let metadata = serde_json::from_value(r.get::<serde_json::Value, _>("metadata"))
                    .unwrap_or_default();
                Ok(Some(StorageRecord {
                    id: r.get("id"),
                    pipeline_id: r.get("pipeline_id"),
                    node_name: r.get("node_name"),
                    data: r.get("data"),
                    metadata,
                    timestamp_ms: u64::try_from(r.get::<i64, _>("timestamp_ms")).unwrap_or(0),
                }))
            })
        }

        async fn list(&self, pipeline_id: &str) -> Result<Vec<StorageRecord>> {
            let rows = sqlx::query(
                "
                SELECT id, pipeline_id, node_name, data, metadata, timestamp_ms
                FROM pipeline_records
                WHERE pipeline_id = $1
                ORDER BY timestamp_ms ASC
                ",
            )
            .bind(pipeline_id)
            .fetch_all(&self.pool)
            .await
            .map_err(|e| {
                StygianError::Service(ServiceError::InvalidResponse(format!(
                    "PostgresStorage: list failed: {e}"
                )))
            })?;

            let records = rows
                .into_iter()
                .map(|r| {
                    let metadata =
                        serde_json::from_value(r.get::<serde_json::Value, _>("metadata"))
                            .unwrap_or_default();
                    StorageRecord {
                        id: r.get("id"),
                        pipeline_id: r.get("pipeline_id"),
                        node_name: r.get("node_name"),
                        data: r.get("data"),
                        metadata,
                        timestamp_ms: u64::try_from(r.get::<i64, _>("timestamp_ms")).unwrap_or(0),
                    }
                })
                .collect();

            Ok(records)
        }

        async fn delete(&self, id: &str) -> Result<()> {
            sqlx::query("DELETE FROM pipeline_records WHERE id = $1")
                .bind(id)
                .execute(&self.pool)
                .await
                .map_err(|e| {
                    StygianError::Service(ServiceError::InvalidResponse(format!(
                        "PostgresStorage: delete failed: {e}"
                    )))
                })?;

            Ok(())
        }
    }
}

// ─────────────────────────────────────────────────────────────────────────────
// Tests
// ─────────────────────────────────────────────────────────────────────────────

#[cfg(test)]
#[allow(clippy::unwrap_used, clippy::indexing_slicing)]
mod tests {
    use super::{FileStorage, NullStorage};
    use crate::ports::storage::{StoragePort, StorageRecord};
    use serde_json::json;

    #[tokio::test]
    async fn null_storage_store_and_retrieve() {
        let s = NullStorage;
        let r = StorageRecord::new("p", "n", json!(null));
        s.store(r.clone()).await.unwrap();
        let got = s.retrieve(&r.id).await.unwrap();
        assert!(got.is_none(), "NullStorage must always return None");
    }

    #[tokio::test]
    async fn null_storage_list_and_delete_are_noops() {
        let s = NullStorage;
        let list = s.list("any").await.unwrap();
        assert!(list.is_empty());
        s.delete("any-id").await.unwrap();
    }

    #[tokio::test]
    async fn file_storage_roundtrip() {
        let dir = tempfile::tempdir().unwrap();
        let storage = FileStorage::new(dir.path().to_path_buf());

        let r = StorageRecord::new(
            "pipe-roundtrip",
            "fetch",
            json!({"url": "https://example.com"}),
        );
        let id = r.id.clone();

        storage.store(r).await.unwrap();

        let retrieved = storage.retrieve(&id).await.unwrap().unwrap();
        assert_eq!(retrieved.id, id);
        assert_eq!(retrieved.pipeline_id, "pipe-roundtrip");
        assert_eq!(retrieved.node_name, "fetch");
    }

    #[tokio::test]
    async fn file_storage_list_scoped_to_pipeline() {
        let dir = tempfile::tempdir().unwrap();
        let storage = FileStorage::new(dir.path().to_path_buf());

        storage
            .store(StorageRecord::new("pipe-a", "step1", json!(1)))
            .await
            .unwrap();
        storage
            .store(StorageRecord::new("pipe-a", "step2", json!(2)))
            .await
            .unwrap();
        storage
            .store(StorageRecord::new("pipe-b", "step1", json!(3)))
            .await
            .unwrap();

        let pipe_a = storage.list("pipe-a").await.unwrap();
        assert_eq!(pipe_a.len(), 2);

        let pipe_b = storage.list("pipe-b").await.unwrap();
        assert_eq!(pipe_b.len(), 1);
    }

    #[tokio::test]
    async fn file_storage_delete_removes_record() {
        let dir = tempfile::tempdir().unwrap();
        let storage = FileStorage::new(dir.path().to_path_buf());

        let r1 = StorageRecord::new("pipe-del", "n", json!(1));
        let r2 = StorageRecord::new("pipe-del", "n", json!(2));
        let id1 = r1.id.clone();

        storage.store(r1).await.unwrap();
        storage.store(r2).await.unwrap();

        storage.delete(&id1).await.unwrap();

        let records = storage.list("pipe-del").await.unwrap();
        assert_eq!(records.len(), 1);
        assert_ne!(records[0].id, id1);
    }

    #[tokio::test]
    async fn file_storage_retrieve_not_found_returns_none() {
        let dir = tempfile::tempdir().unwrap();
        let storage = FileStorage::new(dir.path().to_path_buf());
        let result = storage.retrieve("no-such-id").await.unwrap();
        assert!(result.is_none());
    }

    #[tokio::test]
    async fn file_storage_path_sanitises_separators() {
        let dir = tempfile::tempdir().unwrap();
        let storage = FileStorage::new(dir.path().to_path_buf());

        // pipeline_id with slashes should not escape the base directory
        let r = StorageRecord::new("../../etc/passwd", "n", json!(null));
        storage.store(r).await.unwrap();

        let files: Vec<_> = std::fs::read_dir(dir.path())
            .unwrap()
            .filter_map(Result::ok)
            .collect();
        // File must be inside the temp dir, not some other directory
        assert_eq!(files.len(), 1);
        let fname = files[0].file_name();
        assert!(
            fname.to_string_lossy().contains("__"),
            "separators must be sanitised: got {fname:?}"
        );
    }

    #[tokio::test]
    async fn file_storage_retrieve_finds_correct_record() {
        let dir = tempfile::tempdir().unwrap();
        let storage = FileStorage::new(dir.path().to_path_buf());

        // Store records across two pipelines to exercise full-dir scan in retrieve
        let r1 = StorageRecord::new("pipe-x", "node-1", json!({"val": 1}));
        let r2 = StorageRecord::new("pipe-y", "node-2", json!({"val": 2}));
        let id1 = r1.id.clone();
        let id2 = r2.id.clone();

        storage.store(r1).await.unwrap();
        storage.store(r2).await.unwrap();

        let found = storage.retrieve(&id1).await.unwrap().unwrap();
        assert_eq!(found.id, id1);
        assert_eq!(found.pipeline_id, "pipe-x");

        let found2 = storage.retrieve(&id2).await.unwrap().unwrap();
        assert_eq!(found2.id, id2);
        assert_eq!(found2.pipeline_id, "pipe-y");
    }

    #[tokio::test]
    async fn file_storage_retrieve_missing_returns_none() {
        let dir = tempfile::tempdir().unwrap();
        let storage = FileStorage::new(dir.path().to_path_buf());
        // Store something so the dir exists and the scan loop runs
        storage
            .store(StorageRecord::new("p", "n", json!(0)))
            .await
            .unwrap();
        let result = storage.retrieve("nonexistent-id").await.unwrap();
        assert!(result.is_none());
    }

    #[tokio::test]
    async fn file_storage_delete_nonexistent_dir_is_noop() {
        // Dir is never created — delete should return Ok without panicking
        let storage = FileStorage::new(std::path::PathBuf::from("/tmp/stygian-no-such-dir-xyz"));
        storage.delete("any-id").await.unwrap();
    }

    #[tokio::test]
    async fn file_storage_delete_id_not_present_is_noop() {
        let dir = tempfile::tempdir().unwrap();
        let storage = FileStorage::new(dir.path().to_path_buf());
        let r = StorageRecord::new("pipe-z", "n", json!(42));
        storage.store(r).await.unwrap();
        // Deleting a non-existent id should not modify the file
        storage.delete("totally-unknown-id").await.unwrap();
        let records = storage.list("pipe-z").await.unwrap();
        assert_eq!(records.len(), 1);
    }

    #[tokio::test]
    async fn file_storage_list_missing_pipeline_returns_empty() {
        let dir = tempfile::tempdir().unwrap();
        let storage = FileStorage::new(dir.path().to_path_buf());
        let records = storage.list("never-stored").await.unwrap();
        assert!(records.is_empty());
    }
}