omnigraph-engine 0.7.1

Runtime engine for the Omnigraph graph database.
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
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
use std::future::Future;
use std::time::Duration;

use reqwest::Client;
use serde::Deserialize;
use serde_json::{Value, json};
use tokio::time::sleep;

use crate::error::{OmniError, Result};

const DEFAULT_OPENROUTER_BASE_URL: &str = "https://openrouter.ai/api/v1";
const DEFAULT_OPENROUTER_MODEL: &str = "openai/text-embedding-3-large";
const DEFAULT_OPENAI_BASE_URL: &str = "https://api.openai.com/v1";
const DEFAULT_OPENAI_MODEL: &str = "text-embedding-3-large";
const DEFAULT_GEMINI_BASE_URL: &str = "https://generativelanguage.googleapis.com/v1beta";
const DEFAULT_GEMINI_MODEL: &str = "gemini-embedding-2";
const DEFAULT_TIMEOUT_MS: u64 = 30_000;
const DEFAULT_RETRY_ATTEMPTS: usize = 4;
const DEFAULT_RETRY_BACKOFF_MS: u64 = 200;
const DEFAULT_DEADLINE_MS: u64 = 60_000;
const GEMINI_QUERY_TASK_TYPE: &str = "RETRIEVAL_QUERY";
const GEMINI_DOCUMENT_TASK_TYPE: &str = "RETRIEVAL_DOCUMENT";

/// Which embedding API a client speaks. Each variant owns its request shape,
/// auth, and response parsing; everything else (retry, deadline, normalization,
/// tracing) is provider-independent.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Provider {
    /// OpenAI-compatible (`POST {base}/embeddings`, bearer auth,
    /// `{model, input, dimensions}`). Covers OpenRouter (the default gateway),
    /// OpenAI direct, and self-hosted endpoints (vLLM/Ollama/LM Studio).
    OpenAiCompatible,
    /// Google Gemini `generativelanguage` (`POST {base}/models/{model}:embedContent`,
    /// `x-goog-api-key`), with `RETRIEVAL_QUERY` / `RETRIEVAL_DOCUMENT` task types.
    Gemini,
    /// Deterministic, offline. No network, no key.
    Mock,
}

/// Whether the text being embedded is a search query or a stored document.
/// Only Gemini distinguishes these (`RETRIEVAL_QUERY` vs `RETRIEVAL_DOCUMENT`);
/// OpenAI-compatible providers and Mock produce the identical request for both,
/// which is also the same-space property a query relies on.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
enum EmbedRole {
    Query,
    Document,
}

/// The single source of truth for how embedding text becomes a vector:
/// provider + model + endpoint + key. Resolved once (from env for direct
/// engine/CLI callers, or from an applied cluster `providers.embedding` profile
/// at server boot) and shared by the query path and the offline CLI so stored
/// and query vectors stay same-space by construction.
#[derive(Clone, Debug)]
pub struct EmbeddingConfig {
    pub provider: Provider,
    pub model: String,
    pub base_url: String,
    pub api_key: String,
}

impl EmbeddingConfig {
    /// Resolve from the environment. Precedence:
    /// 1. `OMNIGRAPH_EMBEDDINGS_MOCK` → Mock.
    /// 2. `OMNIGRAPH_EMBED_PROVIDER` (`openai-compatible`|`openai`|`gemini`|`mock`);
    ///    unset defaults to `openai-compatible` (OpenRouter).
    /// 3. `OMNIGRAPH_EMBED_BASE_URL` else the provider default.
    /// 4. `OMNIGRAPH_EMBED_MODEL` else the provider default.
    /// 5. provider api-key env (`OPENROUTER_API_KEY`/`OPENAI_API_KEY`, or `GEMINI_API_KEY`).
    pub fn from_env() -> Result<Self> {
        if env_flag("OMNIGRAPH_EMBEDDINGS_MOCK") {
            return Ok(Self::mock());
        }

        let alias = env_string("OMNIGRAPH_EMBED_PROVIDER");
        if alias.as_deref() == Some("mock") {
            return Ok(Self::mock());
        }

        let (provider, default_base, default_model, key_envs) = provider_profile(alias.as_deref())?;
        let base_url = env_string("OMNIGRAPH_EMBED_BASE_URL")
            .unwrap_or_else(|| default_base.to_string())
            .trim_end_matches('/')
            .to_string();
        let model =
            env_string("OMNIGRAPH_EMBED_MODEL").unwrap_or_else(|| default_model.to_string());

        let api_key = key_envs.iter().copied().find_map(env_string).ok_or_else(|| {
            OmniError::manifest_internal(format!(
                "{} is required for the {} embedding provider",
                key_envs.join(" or "),
                alias.as_deref().unwrap_or("openai-compatible")
            ))
        })?;

        Ok(Self {
            provider,
            model,
            base_url,
            api_key,
        })
    }

    /// Build a config from explicit parts — the cluster `providers.embedding` profile path
    /// (RFC-012 Phase 5). `provider`/`base_url`/`model` default exactly as
    /// `from_env` does (shared `provider_profile`); `api_key` is already resolved
    /// (the cluster path resolves a `${NAME}` ref before calling this).
    pub fn from_parts(
        provider: Option<&str>,
        base_url: Option<String>,
        model: Option<String>,
        api_key: String,
    ) -> Result<Self> {
        if provider == Some("mock") {
            // An explicit `model` (e.g. a cluster `providers.embedding` profile) is
            // authoritative — it is what the same-space check compares against —
            // so honor it; fall back to `mock()`'s env-based model only when the
            // caller supplied none. Without this, a profile's `model` is silently
            // dropped and the same-space check resolves to OMNIGRAPH_EMBED_MODEL.
            let mut config = Self::mock();
            if let Some(model) = model {
                config.model = model;
            }
            return Ok(config);
        }
        let (provider, default_base, default_model, _key_envs) = provider_profile(provider)?;
        let base_url = base_url
            .unwrap_or_else(|| default_base.to_string())
            .trim_end_matches('/')
            .to_string();
        let model = model.unwrap_or_else(|| default_model.to_string());
        Ok(Self {
            provider,
            model,
            base_url,
            api_key,
        })
    }

    fn mock() -> Self {
        Self {
            provider: Provider::Mock,
            // Honor OMNIGRAPH_EMBED_MODEL so the same-space check is exercisable
            // under mock; the mock vectors themselves don't depend on the model.
            model: env_string("OMNIGRAPH_EMBED_MODEL").unwrap_or_default(),
            base_url: String::new(),
            api_key: String::new(),
        }
    }
}

#[derive(Clone, Debug)]
pub struct EmbeddingClient {
    config: EmbeddingConfig,
    http: Client,
    retry_attempts: usize,
    retry_backoff_ms: u64,
    /// Total wall-clock budget for one embed call, across all retries
    /// (`OMNIGRAPH_EMBED_DEADLINE_MS`). `0` = unbounded.
    deadline_ms: u64,
}

struct EmbedCallError {
    message: String,
    retryable: bool,
}

#[derive(Debug, Deserialize)]
struct GeminiEmbedResponse {
    embedding: GeminiContentEmbedding,
}

#[derive(Debug, Deserialize)]
struct GeminiContentEmbedding {
    values: Vec<f32>,
}

#[derive(Debug, Deserialize)]
struct GoogleErrorEnvelope {
    error: GoogleErrorBody,
}

#[derive(Debug, Deserialize)]
struct GoogleErrorBody {
    message: String,
}

#[derive(Debug, Deserialize)]
struct OpenAiEmbeddingResponse {
    data: Vec<OpenAiEmbeddingDatum>,
}

#[derive(Debug, Deserialize)]
struct OpenAiEmbeddingDatum {
    index: usize,
    embedding: Vec<f32>,
}

#[derive(Debug, Deserialize)]
struct OpenAiErrorEnvelope {
    error: OpenAiErrorBody,
}

#[derive(Debug, Deserialize)]
struct OpenAiErrorBody {
    message: String,
}

impl EmbeddingClient {
    pub fn from_env() -> Result<Self> {
        Self::new(EmbeddingConfig::from_env()?)
    }

    pub fn new(config: EmbeddingConfig) -> Result<Self> {
        let retry_attempts =
            parse_env_usize("OMNIGRAPH_EMBED_RETRY_ATTEMPTS", DEFAULT_RETRY_ATTEMPTS);
        let retry_backoff_ms =
            parse_env_u64("OMNIGRAPH_EMBED_RETRY_BACKOFF_MS", DEFAULT_RETRY_BACKOFF_MS);
        let deadline_ms =
            parse_env_u64_allow_zero("OMNIGRAPH_EMBED_DEADLINE_MS", DEFAULT_DEADLINE_MS);
        let timeout_ms = parse_env_u64("OMNIGRAPH_EMBED_TIMEOUT_MS", DEFAULT_TIMEOUT_MS);
        let http = Client::builder()
            .timeout(Duration::from_millis(timeout_ms))
            .build()
            .map_err(|e| {
                OmniError::manifest_internal(format!("failed to initialize HTTP client: {}", e))
            })?;

        Ok(Self {
            config,
            http,
            retry_attempts,
            retry_backoff_ms,
            deadline_ms,
        })
    }

    pub fn config(&self) -> &EmbeddingConfig {
        &self.config
    }

    #[cfg(test)]
    fn mock_for_tests() -> Self {
        Self::new(EmbeddingConfig::mock()).expect("mock client builds")
    }

    pub async fn embed_query_text(&self, input: &str, expected_dim: usize) -> Result<Vec<f32>> {
        self.embed_text(input, expected_dim, EmbedRole::Query).await
    }

    pub async fn embed_document_text(&self, input: &str, expected_dim: usize) -> Result<Vec<f32>> {
        self.embed_text(input, expected_dim, EmbedRole::Document).await
    }

    async fn embed_text(
        &self,
        input: &str,
        expected_dim: usize,
        role: EmbedRole,
    ) -> Result<Vec<f32>> {
        if expected_dim == 0 {
            return Err(OmniError::manifest_internal(
                "embedding dimension must be greater than zero",
            ));
        }

        let started = std::time::Instant::now();
        let result = self
            .run_with_deadline(self.embed_text_inner(input, expected_dim, role))
            .await;
        let elapsed_ms = started.elapsed().as_millis() as u64;

        match &result {
            Ok(_) => tracing::info!(
                target: "omnigraph::embedding",
                provider = ?self.config.provider,
                model = %self.config.model,
                dim = expected_dim,
                elapsed_ms,
                outcome = "ok",
                "embedding succeeded"
            ),
            Err(err) => tracing::warn!(
                target: "omnigraph::embedding",
                provider = ?self.config.provider,
                model = %self.config.model,
                dim = expected_dim,
                elapsed_ms,
                outcome = "error",
                error = %err,
                "embedding failed"
            ),
        }
        result
    }

    /// Bound the whole embed operation (all retries + backoff) by `deadline_ms`,
    /// so a degraded provider can never hang the caller for the full retry
    /// envelope. Applies to every embed call (query and document). `0` =
    /// unbounded. Embedding has no Lance/manifest side effects, so cancelling the
    /// in-flight request future on elapse is safe.
    async fn run_with_deadline<F>(&self, fut: F) -> Result<Vec<f32>>
    where
        F: Future<Output = Result<Vec<f32>>>,
    {
        if self.deadline_ms == 0 {
            return fut.await;
        }
        match tokio::time::timeout(Duration::from_millis(self.deadline_ms), fut).await {
            Ok(res) => res,
            Err(_elapsed) => Err(OmniError::manifest_internal(format!(
                "embedding deadline exceeded after {} ms (provider={:?}, model={})",
                self.deadline_ms, self.config.provider, self.config.model
            ))),
        }
    }

    async fn embed_text_inner(
        &self,
        input: &str,
        expected_dim: usize,
        role: EmbedRole,
    ) -> Result<Vec<f32>> {
        match self.config.provider {
            Provider::Mock => Ok(mock_embedding(input, expected_dim)),
            Provider::Gemini => {
                self.with_retry(|| self.embed_gemini_once(input, expected_dim, role))
                    .await
            }
            Provider::OpenAiCompatible => {
                self.with_retry(|| self.embed_openai_once(input, expected_dim))
                    .await
            }
        }
    }

    async fn with_retry<T, F, Fut>(&self, mut operation: F) -> Result<T>
    where
        F: FnMut() -> Fut,
        Fut: Future<Output = std::result::Result<T, EmbedCallError>>,
    {
        let max_attempt = self.retry_attempts.max(1);
        let mut attempt = 0usize;
        loop {
            attempt += 1;
            match operation().await {
                Ok(value) => return Ok(value),
                Err(err) => {
                    if !err.retryable || attempt >= max_attempt {
                        return Err(OmniError::manifest_internal(err.message));
                    }
                    tracing::warn!(
                        target: "omnigraph::embedding",
                        provider = ?self.config.provider,
                        model = %self.config.model,
                        attempt,
                        error = %err.message,
                        "embedding attempt failed, retrying"
                    );
                    let shift = (attempt - 1).min(10) as u32;
                    let delay = self.retry_backoff_ms.saturating_mul(1u64 << shift);
                    sleep(Duration::from_millis(delay)).await;
                }
            }
        }
    }

    async fn embed_gemini_once(
        &self,
        input: &str,
        expected_dim: usize,
        role: EmbedRole,
    ) -> std::result::Result<Vec<f32>, EmbedCallError> {
        let task_type = match role {
            EmbedRole::Query => GEMINI_QUERY_TASK_TYPE,
            EmbedRole::Document => GEMINI_DOCUMENT_TASK_TYPE,
        };

        let response = self
            .http
            .post(gemini_endpoint(&self.config.base_url, &self.config.model))
            .header("x-goog-api-key", &self.config.api_key)
            .json(&build_gemini_request(
                &self.config.model,
                input,
                expected_dim,
                task_type,
            ))
            .send()
            .await;
        let response = match response {
            Ok(response) => response,
            Err(err) => {
                let retryable = err.is_timeout() || err.is_connect() || err.is_request();
                return Err(EmbedCallError {
                    message: format!("embedding request failed: {}", err),
                    retryable,
                });
            }
        };

        let status = response.status();
        let body = match response.text().await {
            Ok(body) => body,
            Err(err) => {
                return Err(EmbedCallError {
                    message: format!("embedding response read failed (status {}): {}", status, err),
                    retryable: status.is_server_error() || status.as_u16() == 429,
                });
            }
        };

        if !status.is_success() {
            let message = parse_google_error_message(&body).unwrap_or(body);
            return Err(EmbedCallError {
                message: format!("embedding request failed with status {}: {}", status, message),
                retryable: status.is_server_error() || status.as_u16() == 429,
            });
        }

        let parsed: GeminiEmbedResponse =
            serde_json::from_str(&body).map_err(|err| EmbedCallError {
                message: format!("embedding response decode failed: {}", err),
                retryable: false,
            })?;

        validate_and_normalize_embedding(parsed.embedding.values, expected_dim).map_err(|message| {
            EmbedCallError {
                message,
                retryable: false,
            }
        })
    }

    async fn embed_openai_once(
        &self,
        input: &str,
        expected_dim: usize,
    ) -> std::result::Result<Vec<f32>, EmbedCallError> {
        let response = self
            .http
            .post(format!("{}/embeddings", self.config.base_url))
            .bearer_auth(&self.config.api_key)
            .json(&build_openai_request(&self.config.model, input, expected_dim))
            .send()
            .await;
        let response = match response {
            Ok(response) => response,
            Err(err) => {
                let retryable = err.is_timeout() || err.is_connect() || err.is_request();
                return Err(EmbedCallError {
                    message: format!("embedding request failed: {}", err),
                    retryable,
                });
            }
        };

        let status = response.status();
        let body = match response.text().await {
            Ok(body) => body,
            Err(err) => {
                return Err(EmbedCallError {
                    message: format!("embedding response read failed (status {}): {}", status, err),
                    retryable: status.is_server_error() || status.as_u16() == 429,
                });
            }
        };

        if !status.is_success() {
            let message = parse_openai_error_message(&body).unwrap_or(body);
            return Err(EmbedCallError {
                message: format!("embedding request failed with status {}: {}", status, message),
                retryable: status.is_server_error() || status.as_u16() == 429,
            });
        }

        let parsed: OpenAiEmbeddingResponse =
            serde_json::from_str(&body).map_err(|err| EmbedCallError {
                message: format!("embedding response decode failed: {}", err),
                retryable: false,
            })?;

        // The query path embeds exactly one string, so expect one datum at index 0.
        let datum = parsed
            .data
            .into_iter()
            .find(|d| d.index == 0)
            .ok_or_else(|| EmbedCallError {
                message: "embedding response missing data[0]".to_string(),
                retryable: false,
            })?;

        validate_and_normalize_embedding(datum.embedding, expected_dim).map_err(|message| {
            EmbedCallError {
                message,
                retryable: false,
            }
        })
    }
}

fn gemini_endpoint(base_url: &str, model: &str) -> String {
    format!(
        "{}/models/{}:embedContent",
        base_url.trim_end_matches('/'),
        model
    )
}

fn build_gemini_request(model: &str, input: &str, expected_dim: usize, task_type: &str) -> Value {
    json!({
        "model": format!("models/{}", model),
        "content": {
            "parts": [
                {
                    "text": input
                }
            ]
        },
        "taskType": task_type,
        "outputDimensionality": expected_dim,
    })
}

fn build_openai_request(model: &str, input: &str, expected_dim: usize) -> Value {
    json!({
        "model": model,
        "input": [input],
        "dimensions": expected_dim,
    })
}

fn validate_and_normalize_embedding(
    values: Vec<f32>,
    expected_dim: usize,
) -> std::result::Result<Vec<f32>, String> {
    if values.len() != expected_dim {
        return Err(format!(
            "embedding dimension mismatch: expected {}, got {}",
            expected_dim,
            values.len()
        ));
    }
    Ok(normalize_vector(values))
}

fn normalize_vector(mut values: Vec<f32>) -> Vec<f32> {
    let norm = values
        .iter()
        .map(|v| (*v as f64) * (*v as f64))
        .sum::<f64>()
        .sqrt() as f32;
    if norm > f32::EPSILON {
        for value in &mut values {
            *value /= norm;
        }
    }
    values
}

fn parse_google_error_message(body: &str) -> Option<String> {
    serde_json::from_str::<GoogleErrorEnvelope>(body)
        .ok()
        .map(|e| e.error.message)
        .filter(|msg| !msg.trim().is_empty())
}

fn parse_openai_error_message(body: &str) -> Option<String> {
    serde_json::from_str::<OpenAiErrorEnvelope>(body)
        .ok()
        .map(|e| e.error.message)
        .filter(|msg| !msg.trim().is_empty())
}

/// Map a provider alias to `(provider, default base URL, default model, ordered
/// api-key envs)`. Shared by `from_env` and `from_parts` so both apply identical
/// defaults: `openai-compatible`/unset → the OpenRouter gateway, `openai` →
/// OpenAI's own host. `mock` is handled by callers before this is reached. The
/// `Provider` enum alone would collapse the two openai aliases, so the alias
/// (not the enum) determines the key-env order here.
fn provider_profile(
    alias: Option<&str>,
) -> Result<(Provider, &'static str, &'static str, &'static [&'static str])> {
    Ok(match alias {
        None | Some("openai-compatible") => (
            Provider::OpenAiCompatible,
            DEFAULT_OPENROUTER_BASE_URL,
            DEFAULT_OPENROUTER_MODEL,
            &["OPENROUTER_API_KEY", "OPENAI_API_KEY"],
        ),
        Some("openai") => (
            Provider::OpenAiCompatible,
            DEFAULT_OPENAI_BASE_URL,
            DEFAULT_OPENAI_MODEL,
            &["OPENAI_API_KEY"],
        ),
        Some("gemini") => (
            Provider::Gemini,
            DEFAULT_GEMINI_BASE_URL,
            DEFAULT_GEMINI_MODEL,
            &["GEMINI_API_KEY"],
        ),
        Some(other) => {
            return Err(OmniError::manifest_internal(format!(
                "unknown embedding provider '{}' (expected openai-compatible|openai|gemini|mock)",
                other
            )));
        }
    })
}

fn env_string(name: &str) -> Option<String> {
    std::env::var(name)
        .ok()
        .map(|v| v.trim().to_string())
        .filter(|v| !v.is_empty())
}

fn parse_env_usize(name: &str, default: usize) -> usize {
    std::env::var(name)
        .ok()
        .and_then(|v| v.parse::<usize>().ok())
        .filter(|v| *v > 0)
        .unwrap_or(default)
}

fn parse_env_u64(name: &str, default: u64) -> u64 {
    std::env::var(name)
        .ok()
        .and_then(|v| v.parse::<u64>().ok())
        .filter(|v| *v > 0)
        .unwrap_or(default)
}

/// Like [`parse_env_u64`] but accepts `0` as a meaningful value (the deadline
/// uses `0` for "unbounded").
fn parse_env_u64_allow_zero(name: &str, default: u64) -> u64 {
    std::env::var(name)
        .ok()
        .and_then(|v| v.trim().parse::<u64>().ok())
        .unwrap_or(default)
}

fn env_flag(name: &str) -> bool {
    std::env::var(name)
        .ok()
        .map(|v| {
            let s = v.trim().to_ascii_lowercase();
            s == "1" || s == "true" || s == "yes" || s == "on"
        })
        .unwrap_or(false)
}

fn mock_embedding(input: &str, dim: usize) -> Vec<f32> {
    let mut seed = fnv1a64(input.as_bytes());
    let mut out = Vec::with_capacity(dim);
    for _ in 0..dim {
        seed = xorshift64(seed);
        let ratio = (seed as f64 / u64::MAX as f64) as f32;
        out.push((ratio * 2.0) - 1.0);
    }
    normalize_vector(out)
}

fn fnv1a64(bytes: &[u8]) -> u64 {
    let mut hash = 14695981039346656037u64;
    for byte in bytes {
        hash ^= *byte as u64;
        hash = hash.wrapping_mul(1099511628211u64);
    }
    hash
}

fn xorshift64(mut x: u64) -> u64 {
    x ^= x << 13;
    x ^= x >> 7;
    x ^= x << 17;
    x
}

#[cfg(test)]
mod tests {
    use std::sync::Arc;
    use std::sync::atomic::{AtomicUsize, Ordering};

    use serial_test::serial;

    use super::*;

    struct EnvGuard {
        saved: Vec<(&'static str, Option<String>)>,
    }

    impl EnvGuard {
        fn set(vars: &[(&'static str, Option<&str>)]) -> Self {
            let saved = vars
                .iter()
                .map(|(name, _)| (*name, std::env::var(name).ok()))
                .collect::<Vec<_>>();
            for (name, value) in vars {
                unsafe {
                    match value {
                        Some(value) => std::env::set_var(name, value),
                        None => std::env::remove_var(name),
                    }
                }
            }
            Self { saved }
        }
    }

    impl Drop for EnvGuard {
        fn drop(&mut self) {
            for (name, value) in self.saved.drain(..) {
                unsafe {
                    match value {
                        Some(value) => std::env::set_var(name, value),
                        None => std::env::remove_var(name),
                    }
                }
            }
        }
    }

    // Every test that calls `EmbeddingConfig::from_env` clears the full set of
    // embedding env vars first so the host environment can't leak in.
    const EMBED_ENV: &[&str] = &[
        "OMNIGRAPH_EMBEDDINGS_MOCK",
        "OMNIGRAPH_EMBED_PROVIDER",
        "OMNIGRAPH_EMBED_BASE_URL",
        "OMNIGRAPH_EMBED_MODEL",
        "OPENROUTER_API_KEY",
        "OPENAI_API_KEY",
        "GEMINI_API_KEY",
    ];

    fn cleared_env(extra: &[(&'static str, Option<&str>)]) -> EnvGuard {
        let mut vars: Vec<(&'static str, Option<&str>)> =
            EMBED_ENV.iter().map(|n| (*n, None)).collect();
        vars.extend_from_slice(extra);
        EnvGuard::set(&vars)
    }

    #[tokio::test]
    async fn mock_embeddings_are_deterministic() {
        let client = EmbeddingClient::mock_for_tests();
        let a = client.embed_query_text("alpha", 8).await.unwrap();
        let b = client.embed_query_text("alpha", 8).await.unwrap();
        let c = client.embed_query_text("beta", 8).await.unwrap();
        assert_eq!(a, b);
        assert_ne!(a, c);
        assert_eq!(a.len(), 8);
    }

    #[test]
    fn gemini_request_uses_model_retrieval_query_and_dimension() {
        let request =
            build_gemini_request("gemini-embedding-2", "alpha", 4, GEMINI_QUERY_TASK_TYPE);
        assert_eq!(request["model"], "models/gemini-embedding-2");
        assert_eq!(request["taskType"], GEMINI_QUERY_TASK_TYPE);
        assert_eq!(request["outputDimensionality"], 4);
        assert_eq!(request["content"]["parts"][0]["text"], "alpha");
    }

    #[test]
    fn gemini_document_request_uses_retrieval_document_task_type() {
        let request =
            build_gemini_request("gemini-embedding-2", "alpha", 4, GEMINI_DOCUMENT_TASK_TYPE);
        assert_eq!(request["taskType"], GEMINI_DOCUMENT_TASK_TYPE);
    }

    #[test]
    fn openai_request_uses_model_input_array_and_dimensions() {
        let request = build_openai_request("openai/text-embedding-3-large", "alpha", 4);
        assert_eq!(request["model"], "openai/text-embedding-3-large");
        assert_eq!(request["input"][0], "alpha");
        assert!(request["input"].is_array());
        assert_eq!(request["dimensions"], 4);
        assert!(request.get("taskType").is_none());
    }

    #[test]
    fn validate_and_normalize_embedding_enforces_dimension() {
        let normalized = validate_and_normalize_embedding(vec![3.0, 4.0], 2).unwrap();
        assert!((normalized[0] - 0.6).abs() < 1e-6);
        assert!((normalized[1] - 0.8).abs() < 1e-6);

        let err = validate_and_normalize_embedding(vec![1.0, 2.0], 3).unwrap_err();
        assert!(err.contains("expected 3, got 2"));
    }

    #[tokio::test]
    async fn with_retry_retries_retryable_failures() {
        let client = EmbeddingClient::mock_for_tests();
        let attempts = Arc::new(AtomicUsize::new(0));
        let attempts_for_call = Arc::clone(&attempts);

        let value = client
            .with_retry(|| {
                let attempts_for_call = Arc::clone(&attempts_for_call);
                async move {
                    let attempt = attempts_for_call.fetch_add(1, Ordering::SeqCst);
                    if attempt == 0 {
                        Err(EmbedCallError {
                            message: "retry me".to_string(),
                            retryable: true,
                        })
                    } else {
                        Ok("ok")
                    }
                }
            })
            .await
            .unwrap();

        assert_eq!(value, "ok");
        assert_eq!(attempts.load(Ordering::SeqCst), 2);
    }

    #[tokio::test]
    async fn with_retry_stops_on_non_retryable_failures() {
        let client = EmbeddingClient::mock_for_tests();
        let err = client
            .with_retry(|| async {
                Err::<(), _>(EmbedCallError {
                    message: "do not retry".to_string(),
                    retryable: false,
                })
            })
            .await
            .unwrap_err();

        assert!(err.to_string().contains("do not retry"));
    }

    #[tokio::test]
    async fn run_with_deadline_aborts_slow_future() {
        let mut client = EmbeddingClient::mock_for_tests();
        client.deadline_ms = 20;
        let slow = async {
            tokio::time::sleep(Duration::from_secs(5)).await;
            Ok(vec![0.0_f32])
        };
        let err = client.run_with_deadline(slow).await.unwrap_err();
        assert!(err.to_string().contains("deadline exceeded"));
    }

    #[tokio::test]
    async fn run_with_deadline_passes_through_fast_future() {
        let client = EmbeddingClient::mock_for_tests();
        let ok = client
            .run_with_deadline(async { Ok(vec![1.0_f32, 2.0]) })
            .await
            .unwrap();
        assert_eq!(ok, vec![1.0, 2.0]);
    }

    #[tokio::test]
    async fn run_with_deadline_zero_is_unbounded() {
        let mut client = EmbeddingClient::mock_for_tests();
        client.deadline_ms = 0;
        let ok = client
            .run_with_deadline(async { Ok(vec![3.0_f32]) })
            .await
            .unwrap();
        assert_eq!(ok, vec![3.0]);
    }

    #[test]
    #[serial]
    fn from_env_defaults_to_openai_compatible_openrouter() {
        let _guard = cleared_env(&[("OPENROUTER_API_KEY", Some("sk-test"))]);
        let config = EmbeddingConfig::from_env().unwrap();
        assert_eq!(config.provider, Provider::OpenAiCompatible);
        assert_eq!(config.base_url, DEFAULT_OPENROUTER_BASE_URL);
        assert_eq!(config.model, DEFAULT_OPENROUTER_MODEL);
        assert_eq!(config.api_key, "sk-test");
    }

    #[test]
    #[serial]
    fn from_env_openai_alias_uses_openai_host_not_openrouter() {
        let _guard = cleared_env(&[
            ("OMNIGRAPH_EMBED_PROVIDER", Some("openai")),
            ("OPENAI_API_KEY", Some("k")),
        ]);
        let config = EmbeddingConfig::from_env().unwrap();
        assert_eq!(config.provider, Provider::OpenAiCompatible);
        assert_eq!(config.base_url, DEFAULT_OPENAI_BASE_URL); // api.openai.com, not OpenRouter
        assert_eq!(config.model, DEFAULT_OPENAI_MODEL); // text-embedding-3-large, no openai/ prefix
        assert_eq!(config.api_key, "k");
    }

    #[test]
    #[serial]
    fn from_env_openai_alias_prefers_openai_key_over_openrouter() {
        // `openai` targets api.openai.com, so an OpenRouter key must not be sent there.
        let _guard = cleared_env(&[
            ("OMNIGRAPH_EMBED_PROVIDER", Some("openai")),
            ("OPENROUTER_API_KEY", Some("router")),
            ("OPENAI_API_KEY", Some("openai")),
        ]);
        let config = EmbeddingConfig::from_env().unwrap();
        assert_eq!(config.base_url, DEFAULT_OPENAI_BASE_URL);
        assert_eq!(config.api_key, "openai");
    }

    #[test]
    #[serial]
    fn from_env_openai_alias_errors_when_only_openrouter_key_is_set() {
        let _guard = cleared_env(&[
            ("OMNIGRAPH_EMBED_PROVIDER", Some("openai")),
            ("OPENROUTER_API_KEY", Some("router")),
        ]);
        let err = EmbeddingConfig::from_env().unwrap_err();
        assert!(err.to_string().contains("OPENAI_API_KEY"), "got: {err}");
    }

    #[test]
    fn from_parts_applies_provider_defaults_and_overrides() {
        let openrouter = EmbeddingConfig::from_parts(None, None, None, "k".to_string()).unwrap();
        assert_eq!(openrouter.provider, Provider::OpenAiCompatible);
        assert_eq!(openrouter.base_url, DEFAULT_OPENROUTER_BASE_URL);
        assert_eq!(openrouter.model, DEFAULT_OPENROUTER_MODEL);
        assert_eq!(openrouter.api_key, "k");

        let gemini =
            EmbeddingConfig::from_parts(Some("gemini"), None, None, "g".to_string()).unwrap();
        assert_eq!(gemini.provider, Provider::Gemini);
        assert_eq!(gemini.base_url, DEFAULT_GEMINI_BASE_URL);

        let overridden = EmbeddingConfig::from_parts(
            Some("openai"),
            Some("https://x/v1/".to_string()),
            Some("custom".to_string()),
            "k".to_string(),
        )
        .unwrap();
        assert_eq!(overridden.base_url, "https://x/v1"); // trailing slash trimmed
        assert_eq!(overridden.model, "custom");

        let err =
            EmbeddingConfig::from_parts(Some("cohere"), None, None, "k".to_string()).unwrap_err();
        assert!(
            err.to_string().contains("unknown embedding provider"),
            "got: {err}"
        );
    }

    #[test]
    #[serial]
    fn from_parts_mock_honors_an_explicit_model() {
        // A cluster `providers.embedding` profile that sets `kind: mock, model: X`
        // must resolve to model X — it is what the query-time same-space check
        // compares against. Env cleared so the assertion isolates the arg.
        let _guard = cleared_env(&[]);
        let pinned =
            EmbeddingConfig::from_parts(Some("mock"), None, Some("recorded-x".to_string()), String::new())
                .unwrap();
        assert_eq!(pinned.provider, Provider::Mock);
        assert_eq!(pinned.model, "recorded-x");
        // With no explicit model, mock falls back to its env-based default (here
        // empty, since the env is cleared).
        let bare = EmbeddingConfig::from_parts(Some("mock"), None, None, String::new()).unwrap();
        assert_eq!(bare.provider, Provider::Mock);
        assert_eq!(bare.model, "");
    }

    #[test]
    #[serial]
    fn from_env_openai_compatible_prefers_openrouter_key() {
        let _guard = cleared_env(&[
            ("OPENROUTER_API_KEY", Some("router")),
            ("OPENAI_API_KEY", Some("openai")),
        ]);
        let config = EmbeddingConfig::from_env().unwrap();
        assert_eq!(config.api_key, "router");
    }

    #[test]
    #[serial]
    fn from_env_explicit_gemini_provider() {
        let _guard = cleared_env(&[
            ("OMNIGRAPH_EMBED_PROVIDER", Some("gemini")),
            ("GEMINI_API_KEY", Some("g-key")),
        ]);
        let config = EmbeddingConfig::from_env().unwrap();
        assert_eq!(config.provider, Provider::Gemini);
        assert_eq!(config.base_url, DEFAULT_GEMINI_BASE_URL);
        assert_eq!(config.model, DEFAULT_GEMINI_MODEL);
        assert_eq!(config.api_key, "g-key");
    }

    #[test]
    #[serial]
    fn from_env_base_url_and_model_overrides_apply() {
        let _guard = cleared_env(&[
            ("OMNIGRAPH_EMBED_PROVIDER", Some("openai-compatible")),
            ("OMNIGRAPH_EMBED_BASE_URL", Some("https://example.test/v1/")),
            ("OMNIGRAPH_EMBED_MODEL", Some("custom/model")),
            ("OPENAI_API_KEY", Some("k")),
        ]);
        let config = EmbeddingConfig::from_env().unwrap();
        assert_eq!(config.base_url, "https://example.test/v1"); // trailing slash trimmed
        assert_eq!(config.model, "custom/model");
    }

    #[test]
    #[serial]
    fn from_env_unknown_provider_errors() {
        let _guard = cleared_env(&[("OMNIGRAPH_EMBED_PROVIDER", Some("cohere"))]);
        let err = EmbeddingConfig::from_env().unwrap_err();
        assert!(err.to_string().contains("unknown embedding provider"));
    }

    #[test]
    #[serial]
    fn from_env_errors_when_no_key_present() {
        let _guard = cleared_env(&[]);
        let err = EmbeddingConfig::from_env().unwrap_err();
        assert!(err.to_string().contains("OPENROUTER_API_KEY or OPENAI_API_KEY"));
    }

    #[test]
    #[serial]
    fn from_env_mock_flag_wins() {
        let _guard = cleared_env(&[
            ("OMNIGRAPH_EMBEDDINGS_MOCK", Some("1")),
            ("OMNIGRAPH_EMBED_PROVIDER", Some("gemini")),
        ]);
        let config = EmbeddingConfig::from_env().unwrap();
        assert_eq!(config.provider, Provider::Mock);
    }
}