re_redap_tests 0.34.0

Official test suite for the Rerun Data Protocol
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
use re_log_types::EntryId;
use re_protos::cloud::v1alpha1::ReadTableEntryRequest;
use re_protos::cloud::v1alpha1::ext::{
    CreateDatasetEntryRequest, DatasetDetails, DatasetEntry, EntryDetailsUpdate, TableDetails,
    TableEntry, UpdateDatasetEntryRequest, UpdateEntryRequest, UpdateEntryResponse,
    UpdateTableEntryRequest,
};
use re_protos::cloud::v1alpha1::rerun_cloud_service_server::RerunCloudService;
use re_protos::common::v1alpha1::ext::SegmentId;

use super::common::{create_table_entry_with_name, entry_name};

pub async fn update_entry_tests(service: impl RerunCloudService) {
    //
    // Create a dataset
    //

    let dataset_name = "initial_name";

    let dataset_entry = create_dataset_entry(&service, dataset_name).await.unwrap();

    assert_eq!(dataset_entry.details.name, entry_name(dataset_name));

    let dataset_id = dataset_entry.details.id;

    //
    // No-op dataset update should succeed
    //

    let response = update_entry(
        &service,
        UpdateEntryRequest {
            id: dataset_id,
            entry_details_update: EntryDetailsUpdate { name: None },
        },
    )
    .await
    .unwrap();

    assert_eq!(response.entry_details.name, entry_name(dataset_name));

    //
    // Dataset rename should succeed
    //

    let new_dataset_name = "new_name";
    let response = update_entry(
        &service,
        UpdateEntryRequest {
            id: dataset_id,
            entry_details_update: EntryDetailsUpdate {
                name: Some(entry_name(new_dataset_name)),
            },
        },
    )
    .await
    .unwrap();

    assert_eq!(response.entry_details.name, entry_name(new_dataset_name));

    //
    // Create another dataset
    //

    let dataset2_name = "dataset_2";

    let dataset2_entry = create_dataset_entry(&service, dataset2_name).await.unwrap();

    let dataset2_id = dataset2_entry.details.id;

    //
    // Renaming to an existing name should fail.
    //

    let status = update_entry(
        &service,
        UpdateEntryRequest {
            id: dataset2_id,
            entry_details_update: EntryDetailsUpdate {
                name: Some(entry_name(new_dataset_name)),
            },
        },
    )
    .await
    .unwrap_err();

    assert_eq!(
        status.code(),
        tonic::Code::AlreadyExists,
        "unexpected status: {status:?}",
    );

    //
    // Create a table
    //

    let table_dir = tempfile::tempdir().expect("create temp dir");
    let table_name = "table_1";

    let table_entry = create_table_entry_with_name(&service, table_name, &table_dir).await;

    assert_eq!(table_entry.details.name, entry_name(table_name));
    let table_id = table_entry.details.id;

    //
    // Update table name
    //

    let new_table_name = "new_table_name";
    let response = update_entry(
        &service,
        UpdateEntryRequest {
            id: table_id,
            entry_details_update: EntryDetailsUpdate {
                name: Some(entry_name(new_table_name)),
            },
        },
    )
    .await
    .unwrap();

    assert_eq!(response.entry_details.name, entry_name(new_table_name));

    //
    // Updating table name to an existing dataset name should fail.
    //

    let status = update_entry(
        &service,
        UpdateEntryRequest {
            id: table_id,
            entry_details_update: EntryDetailsUpdate {
                name: Some(entry_name(dataset2_name)),
            },
        },
    )
    .await
    .unwrap_err();

    assert_eq!(
        status.code(),
        tonic::Code::AlreadyExists,
        "unexpected status: {status:?}",
    );

    //
    // Create another table.
    //

    let table2_name = "table_2";
    let table2_dir = tempfile::tempdir().expect("create temp dir");

    let table2_entry = create_table_entry_with_name(&service, table2_name, &table2_dir).await;
    let table2_id = table2_entry.details.id;

    //
    // Rename to an existing table name should fail.
    //

    let status = update_entry(
        &service,
        UpdateEntryRequest {
            id: table2_id,
            entry_details_update: EntryDetailsUpdate {
                name: Some(entry_name(new_table_name)),
            },
        },
    )
    .await
    .unwrap_err();

    assert_eq!(
        status.code(),
        tonic::Code::AlreadyExists,
        "unexpected status: {status:?}",
    );
}

pub async fn update_table_entry_blueprint_details(service: impl RerunCloudService) {
    let table_dir = tempfile::tempdir().expect("create temp dir");
    let table_entry =
        create_table_entry_with_name(&service, "table_with_blueprint", &table_dir).await;
    let table_id = table_entry.details.id;
    let blueprint_dataset = table_entry
        .table_details
        .blueprint_dataset
        .expect("tables should get an implicit blueprint dataset");
    let default_blueprint_segment = SegmentId::from("default_table_blueprint");

    let updated = update_table_entry(
        &service,
        UpdateTableEntryRequest {
            id: table_id,
            table_details: TableDetails {
                blueprint_dataset: Some(blueprint_dataset),
                default_blueprint_segment: Some(default_blueprint_segment.clone()),
            },
        },
    )
    .await
    .unwrap();

    assert_eq!(
        updated.table_details.blueprint_dataset,
        Some(blueprint_dataset)
    );
    assert_eq!(
        updated.table_details.default_blueprint_segment,
        Some(default_blueprint_segment.clone())
    );

    let read_back = read_table_entry(&service, table_id).await.unwrap();
    assert_eq!(
        read_back.table_details.blueprint_dataset,
        Some(blueprint_dataset)
    );
    assert_eq!(
        read_back.table_details.default_blueprint_segment,
        Some(default_blueprint_segment)
    );
}

pub async fn update_table_entry_rejects_invalid_blueprint_details(service: impl RerunCloudService) {
    let table_dir = tempfile::tempdir().expect("create temp dir");
    let table_entry =
        create_table_entry_with_name(&service, "table_with_invalid_blueprint", &table_dir).await;
    let table_id = table_entry.details.id;
    let implicit_blueprint = table_entry
        .table_details
        .blueprint_dataset
        .expect("tables should get an implicit blueprint dataset");

    let status = update_table_entry(
        &service,
        UpdateTableEntryRequest {
            id: EntryId::new(),
            table_details: TableDetails {
                blueprint_dataset: Some(implicit_blueprint),
                default_blueprint_segment: None,
            },
        },
    )
    .await
    .unwrap_err();
    assert_eq!(
        status.code(),
        tonic::Code::NotFound,
        "unexpected status: {status:?}"
    );

    let status = update_table_entry(
        &service,
        UpdateTableEntryRequest {
            id: table_id,
            table_details: TableDetails {
                blueprint_dataset: Some(EntryId::new()),
                default_blueprint_segment: None,
            },
        },
    )
    .await
    .unwrap_err();
    assert_eq!(
        status.code(),
        tonic::Code::InvalidArgument,
        "unexpected status: {status:?}"
    );

    let recording_dataset = create_dataset_entry(&service, "recording_is_not_table_blueprint")
        .await
        .unwrap();
    let status = update_table_entry(
        &service,
        UpdateTableEntryRequest {
            id: table_id,
            table_details: TableDetails {
                blueprint_dataset: Some(recording_dataset.details.id),
                default_blueprint_segment: None,
            },
        },
    )
    .await
    .unwrap_err();
    assert_eq!(
        status.code(),
        tonic::Code::InvalidArgument,
        "unexpected status: {status:?}"
    );
}

pub async fn update_dataset_entry_rejects_invalid_blueprint_details(
    service: impl RerunCloudService,
) {
    let dataset_entry = create_dataset_entry(&service, "dataset_with_blueprint_validation")
        .await
        .unwrap();
    let dataset_id = dataset_entry.details.id;
    let hidden_blueprint = dataset_entry
        .dataset_details
        .blueprint_dataset
        .expect("recording datasets should get an implicit blueprint dataset");
    let default_blueprint_segment = SegmentId::from("default_dataset_blueprint");
    let default_segment_table_blueprint_segment =
        SegmentId::from("default_dataset_segment_table_blueprint");

    let updated = update_dataset_entry(
        &service,
        UpdateDatasetEntryRequest {
            id: dataset_id,
            dataset_details: DatasetDetails {
                blueprint_dataset: Some(hidden_blueprint),
                default_blueprint_segment: Some(default_blueprint_segment.clone()),
                default_segment_table_blueprint_segment: Some(
                    default_segment_table_blueprint_segment.clone(),
                ),
            },
        },
    )
    .await
    .unwrap();
    assert_eq!(
        updated.dataset_details.blueprint_dataset,
        Some(hidden_blueprint)
    );
    assert_eq!(
        updated.dataset_details.default_blueprint_segment,
        Some(default_blueprint_segment)
    );
    assert_eq!(
        updated
            .dataset_details
            .default_segment_table_blueprint_segment,
        Some(default_segment_table_blueprint_segment)
    );

    let status = update_dataset_entry(
        &service,
        UpdateDatasetEntryRequest {
            id: dataset_id,
            dataset_details: DatasetDetails {
                blueprint_dataset: None,
                default_blueprint_segment: Some(SegmentId::from("missing_blueprint_dataset")),
                default_segment_table_blueprint_segment: None,
            },
        },
    )
    .await
    .unwrap_err();
    assert_eq!(
        status.code(),
        tonic::Code::InvalidArgument,
        "unexpected status: {status:?}"
    );

    let status = update_dataset_entry(
        &service,
        UpdateDatasetEntryRequest {
            id: dataset_id,
            dataset_details: DatasetDetails {
                blueprint_dataset: Some(EntryId::new()),
                default_blueprint_segment: None,
                default_segment_table_blueprint_segment: None,
            },
        },
    )
    .await
    .unwrap_err();
    assert_eq!(
        status.code(),
        tonic::Code::InvalidArgument,
        "unexpected status: {status:?}"
    );

    let recording_dataset = create_dataset_entry(&service, "recording_is_not_dataset_blueprint")
        .await
        .unwrap();
    let status = update_dataset_entry(
        &service,
        UpdateDatasetEntryRequest {
            id: dataset_id,
            dataset_details: DatasetDetails {
                blueprint_dataset: Some(recording_dataset.details.id),
                default_blueprint_segment: None,
                default_segment_table_blueprint_segment: None,
            },
        },
    )
    .await
    .unwrap_err();
    assert_eq!(
        status.code(),
        tonic::Code::InvalidArgument,
        "unexpected status: {status:?}"
    );
}

pub async fn update_entry_bumps_timestamp(service: impl RerunCloudService) {
    //
    // Create a dataset
    //

    let dataset_name = "timestamp_test_dataset";
    let dataset_entry = create_dataset_entry(&service, dataset_name).await.unwrap();

    let dataset_id = dataset_entry.details.id;
    let initial_updated_at = dataset_entry.details.updated_at;

    // Small delay to ensure timestamp difference
    tokio::time::sleep(tokio::time::Duration::from_millis(10)).await;

    //
    // Rename the dataset - this should update the timestamp
    //

    let new_name = "renamed_dataset";
    let response = update_entry(
        &service,
        UpdateEntryRequest {
            id: dataset_id,
            entry_details_update: EntryDetailsUpdate {
                name: Some(entry_name(new_name)),
            },
        },
    )
    .await
    .unwrap();

    let after_rename_updated_at = response.entry_details.updated_at;

    assert!(
        after_rename_updated_at > initial_updated_at,
        "Timestamp should be updated after rename. Initial: {initial_updated_at:?}, After rename: {after_rename_updated_at:?}"
    );

    // Small delay to ensure timestamp difference
    tokio::time::sleep(tokio::time::Duration::from_millis(10)).await;

    //
    // Rename to the same name
    //

    let response2 = update_entry(
        &service,
        UpdateEntryRequest {
            id: dataset_id,
            entry_details_update: EntryDetailsUpdate {
                name: Some(entry_name(new_name)),
            },
        },
    )
    .await
    .unwrap();

    let after_second_rename_updated_at = response2.entry_details.updated_at;

    assert_eq!(
        after_second_rename_updated_at, after_rename_updated_at,
        "Timestamp should NOT be updated when renaming to the same name. After first rename: {after_rename_updated_at:?}, After second rename: {after_second_rename_updated_at:?}"
    );
}

// ---

async fn create_dataset_entry(
    service: &impl RerunCloudService,
    name: &str,
) -> tonic::Result<DatasetEntry> {
    service
        .create_dataset_entry(tonic::Request::new(
            CreateDatasetEntryRequest {
                name: entry_name(name),
                id: None,
            }
            .into(),
        ))
        .await
        .map(|result| result.into_inner().dataset.unwrap().try_into().unwrap())
}

async fn update_entry(
    service: &impl RerunCloudService,
    request: UpdateEntryRequest,
) -> tonic::Result<UpdateEntryResponse> {
    service
        .update_entry(tonic::Request::new(request.into()))
        .await
        .map(|response| response.into_inner().try_into().unwrap())
}

async fn update_dataset_entry(
    service: &impl RerunCloudService,
    request: UpdateDatasetEntryRequest,
) -> tonic::Result<DatasetEntry> {
    service
        .update_dataset_entry(tonic::Request::new(request.into()))
        .await
        .map(|response| response.into_inner().dataset.unwrap().try_into().unwrap())
}

async fn update_table_entry(
    service: &impl RerunCloudService,
    request: UpdateTableEntryRequest,
) -> tonic::Result<TableEntry> {
    service
        .update_table_entry(tonic::Request::new(request.into()))
        .await
        .map(|response| response.into_inner().table.unwrap().try_into().unwrap())
}

async fn read_table_entry(
    service: &impl RerunCloudService,
    table_id: EntryId,
) -> tonic::Result<TableEntry> {
    service
        .read_table_entry(tonic::Request::new(ReadTableEntryRequest {
            id: Some(table_id.into()),
        }))
        .await
        .map(|response| response.into_inner().table.unwrap().try_into().unwrap())
}