lancedb 0.40.0

LanceDB: A serverless, low-latency vector database for AI applications
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

// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright The LanceDB Authors

use std::fs;
use std::path::PathBuf;

use lancedb::function::{
    FunctionApplication, FunctionBinding, FunctionVersion, RefreshColumnResult,
};
use lancedb::secrets::{SecretBinding, SecretReference};
use serde_json::Value;

fn fixture(name: &str) -> String {
    let path = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
        .join("tests/fixtures/first_class_functions/v1")
        .join(name);
    fs::read_to_string(path).expect("fixture must be readable")
}

fn job_result(name: &str) -> Value {
    serde_json::from_str::<Value>(&fixture(name)).expect("remote Job fixture")["result"].clone()
}

/// No client value models a resolved credential, at any nesting depth.
fn assert_no_secret_values(value: &Value) {
    match value {
        Value::Object(values) => {
            for (key, value) in values {
                assert!(
                    !matches!(
                        key.as_str(),
                        "secret_value" | "secret_values" | "resolved_secret" | "resolved_secrets"
                    ),
                    "client canonical value must not model resolved secret material"
                );
                assert_no_secret_values(value);
            }
        }
        Value::Array(values) => values.iter().for_each(assert_no_secret_values),
        _ => {}
    }
}

#[test]
fn function_version_job_result_matches_shared_canonical_golden() {
    let result = job_result("remote_function_job.json");
    let version = FunctionVersion::from_json(&result.to_string()).expect("FunctionVersion result");

    assert_eq!(version.name(), "embed");
    assert_eq!(version.version(), "1");
    assert_ne!(version.image().manifest_digest, version.version());
    assert_eq!(
        version.secret_bindings(),
        [SecretBinding::Env {
            variable: "HF_TOKEN".to_string(),
            secret_ref: SecretReference::new("hf-prod"),
        }]
    );
    assert_eq!(
        version.to_canonical_json().expect("canonical JSON"),
        fixture("remote_function_version.canonical.json").trim()
    );
}

#[test]
fn version_identity_is_immutable_and_exact() {
    let original = job_result("remote_function_job.json");
    let version =
        FunctionVersion::from_json(&original.to_string()).expect("FunctionVersion result");
    let reopened = version.clone();
    assert_eq!(reopened, version);
    assert_eq!(reopened.name(), version.name());
    assert_eq!(reopened.version(), version.version());

    let mut changed = original;
    changed["version"] = Value::String("2".to_string());
    let changed = FunctionVersion::from_json(&changed.to_string()).expect("changed version");
    assert_ne!(changed, version);
    assert_eq!(changed.image(), version.image());
    for invalid in [
        version.image().manifest_digest.as_str(),
        "0",
        "01",
        "-1",
        "18446744073709551616",
    ] {
        let mut value = serde_json::to_value(&version).unwrap();
        value["version"] = Value::String(invalid.into());
        assert!(FunctionVersion::from_json(&value.to_string()).is_err());
    }
}

#[test]
fn application_and_binding_match_shared_remote_goldens() {
    let application = FunctionApplication::from_json(&fixture("remote_function_application.json"))
        .expect("application fixture");
    assert_eq!(application.function().version, "1");
    assert_eq!(application.output().kind, "named_struct");
    assert_eq!(application.inputs().len(), 2);
    assert_eq!(
        application.to_canonical_json().expect("canonical JSON"),
        fixture("remote_function_application.canonical.json").trim()
    );

    let binding = FunctionBinding::from_json(&fixture("remote_function_binding.json"))
        .expect("binding fixture");
    assert_eq!(binding.function().version, "1");
    assert_eq!(binding.outputs()[0].output_ordinal, 0);
    assert_eq!(binding.outputs()[1].output_ordinal, 1);
    assert!(binding.input_schema().is_some());
    assert!(binding.output_schema().is_some());
    assert_eq!(
        binding.to_canonical_json().expect("canonical JSON"),
        fixture("remote_function_binding.canonical.json").trim()
    );
}

/// Initialization values travel as JSON on the application, including
/// floats, and as the validated Arrow row on the binding.
#[test]
fn initialized_application_and_binding_match_shared_remote_goldens() {
    let application =
        FunctionApplication::from_json(&fixture("remote_initialized_function_application.json"))
            .expect("application fixture");
    assert!(!application.has_unknown_fields());
    assert_eq!(application.initialization()["temperature"], 0.25);
    assert_eq!(
        application.to_canonical_json().expect("canonical JSON"),
        fixture("remote_initialized_function_application.canonical.json").trim()
    );

    let binding = FunctionBinding::from_json(&fixture("remote_initialized_function_binding.json"))
        .expect("binding fixture");
    assert!(binding.initialization().is_some());
    assert_eq!(
        binding.to_canonical_json().expect("canonical JSON"),
        fixture("remote_initialized_function_binding.canonical.json").trim()
    );
}

#[test]
fn refresh_job_result_matches_shared_canonical_golden() {
    let result = job_result("remote_refresh_job.json");
    let result = RefreshColumnResult::from_json(&result.to_string()).expect("refresh result");
    assert_eq!(result.rows_assigned, 999_998_800);
    assert_eq!(result.rows_filled(), result.rows_assigned);
    assert_eq!(result.version(), result.published_version);
    assert_eq!(
        result.to_canonical_json().expect("canonical JSON"),
        fixture("remote_refresh_result.canonical.json").trim()
    );

    let result = RefreshColumnResult::from_json(&fixture(
        "remote_refresh_result_without_published_version.json",
    ))
    .expect("optional version");
    assert_eq!(result.published_version, None);
    assert_eq!(
        result
            .to_canonical_json()
            .expect("canonical result without version"),
        fixture("remote_refresh_result_without_published_version.canonical.json").trim()
    );
    assert_eq!(
        RefreshColumnResult::from_json(
            &result
                .to_canonical_json()
                .expect("canonical result without version")
        )
        .expect("round-trip result without version"),
        result
    );
}

#[test]
fn unknown_fields_and_discriminators_are_forward_decodable() {
    let mut result = job_result("remote_function_job.json");
    result["future_version_metadata"] = serde_json::json!({"retention_class": "catalog"});
    result["image"]["descriptor"]["future_interface"] = serde_json::json!({"version": 2});
    result["signature"]["output"]["kind"] = Value::String("future_output_shape".to_string());

    let version = FunctionVersion::from_json(&result.to_string()).expect("future remote value");
    assert_eq!(version.image().descriptor["future_interface"]["version"], 2);
    assert_eq!(version.signature().output.kind, "future_output_shape");
    assert_eq!(
        serde_json::from_str::<Value>(
            &version.to_canonical_json().expect("canonical future value")
        )
        .expect("canonical JSON")["image"]["descriptor"]["future_interface"],
        serde_json::json!({"version": 2})
    );
}

#[test]
fn floating_point_application_literals_are_rejected_consistently() {
    let error = FunctionApplication::from_json(&fixture("remote_function_application_float.json"))
        .unwrap_err();
    assert!(
        error
            .to_string()
            .contains("floating-point Function literals")
    );
}

#[test]
fn canonical_client_values_carry_bindings_and_no_credentials() {
    let result = job_result("remote_function_job.json");
    let version = FunctionVersion::from_json(&result.to_string()).expect("FunctionVersion result");
    let canonical: Value = serde_json::from_str(
        &version
            .to_canonical_json()
            .expect("canonical FunctionVersion"),
    )
    .expect("canonical JSON");

    assert_eq!(
        canonical["secret_bindings"],
        serde_json::json!([{"kind": "env", "variable": "HF_TOKEN", "secret_ref": {"name": "hf-prod"}}])
    );
    assert_no_secret_values(&canonical);
}

/// A binding kind a newer server introduces must not fail the whole version.
///
/// This is the cost the union pays for being one field: an unknown variant is
/// a decode error unless it is caught, so it is caught -- and the payload is
/// dropped rather than retained, as `PythonRuntimeSpec` does, because the
/// client does not proxy catalog values.
#[test]
fn an_unknown_binding_kind_is_forward_decodable() {
    let mut result = job_result("remote_function_job.json");
    result["secret_bindings"] = serde_json::json!([
        {"kind": "env", "variable": "HF_TOKEN", "secret_ref": {"name": "hf-prod"}},
        {"kind": "file", "path": "/run/secrets/tok", "secret_ref": {"name": "hf-prod"}},
    ]);

    let version = FunctionVersion::from_json(&result.to_string()).expect("future binding kind");

    let kinds = version
        .secret_bindings()
        .iter()
        .map(|binding| binding.kind())
        .collect::<Vec<_>>();
    assert_eq!(kinds, ["env", "file"]);
    assert_eq!(version.secret_bindings()[1].variable(), None);
    assert_eq!(version.secret_bindings()[1].secret(), None);

    // The unknown kind round-trips as its discriminator and nothing more.
    let canonical: Value =
        serde_json::from_str(&version.to_canonical_json().expect("canonical")).expect("JSON");
    assert_eq!(
        canonical["secret_bindings"][1],
        serde_json::json!({"kind": "file"})
    );
}

/// A Function that binds nothing carries no `secret_bindings` key: absent
/// decodes as an empty list, and an empty list serializes back to absent.
#[test]
fn a_version_without_bindings_omits_the_field_in_both_directions() {
    let mut result = job_result("remote_function_job.json");
    result
        .as_object_mut()
        .expect("Function version object")
        .remove("secret_bindings");
    let version = FunctionVersion::from_json(&result.to_string()).expect("FunctionVersion result");

    assert!(version.secret_bindings().is_empty());
    assert!(
        !version
            .to_canonical_json()
            .expect("canonical FunctionVersion")
            .contains("secret_bindings")
    );
}