redisctl-core 0.10.1

Core library for Redis CLI tools - config, workflows, and shared logic
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
//! Cloud workflows - multi-step operations
//!
//! These workflows compose Layer 1 operations with progress tracking
//! and additional logic.

use crate::error::{CoreError, Result};
use crate::progress::{ProgressCallback, poll_task};
use redis_cloud::databases::{
    Database, DatabaseBackupRequest, DatabaseCreateRequest, DatabaseImportRequest,
    DatabaseUpdateRequest,
};
use redis_cloud::subscriptions::{
    BaseSubscriptionUpdateRequest, Subscription, SubscriptionCreateRequest,
};
use redis_cloud::{CloudClient, DatabaseHandler, SubscriptionHandler};
use std::time::Duration;

/// Create a database and wait for completion
///
/// This is a convenience workflow that:
/// 1. Creates a database (returns task)
/// 2. Polls the task until completion
/// 3. Fetches and returns the created database
///
/// # Arguments
///
/// * `client` - The Cloud API client
/// * `subscription_id` - The subscription to create the database in
/// * `request` - The database creation request
/// * `timeout` - Maximum time to wait for completion
/// * `on_progress` - Optional callback for progress updates
///
/// # Example
///
/// ```rust,ignore
/// use redis_cloud::databases::DatabaseCreateRequest;
/// use redisctl_core::cloud::create_database_and_wait;
/// use std::time::Duration;
///
/// let request = DatabaseCreateRequest::builder()
///     .name("my-database")
///     .memory_limit_in_gb(1.0)
///     .build();
///
/// let database = create_database_and_wait(
///     &client,
///     subscription_id,
///     &request,
///     Duration::from_secs(600),
///     None,  // No progress callback
/// ).await?;
///
/// println!("Created database: {}", database.name.unwrap_or_default());
/// ```
pub async fn create_database_and_wait(
    client: &CloudClient,
    subscription_id: i32,
    request: &DatabaseCreateRequest,
    timeout: Duration,
    on_progress: Option<ProgressCallback>,
) -> Result<Database> {
    let handler = DatabaseHandler::new(client.clone());

    // Step 1: Create (returns task)
    let task = handler.create(subscription_id, request).await?;
    let task_id = task
        .task_id
        .ok_or_else(|| CoreError::TaskFailed("No task ID returned".to_string()))?;

    // Step 2: Poll until complete
    let completed = poll_task(
        client,
        &task_id,
        timeout,
        Duration::from_secs(10),
        on_progress,
    )
    .await?;

    // Step 3: Fetch the created resource
    let resource_id = completed
        .response
        .and_then(|r| r.resource_id)
        .ok_or_else(|| CoreError::TaskFailed("No resource ID in completed task".to_string()))?;

    let db = handler.get(subscription_id, resource_id as i32).await?;
    Ok(db)
}

/// Delete a database and wait for completion
///
/// # Arguments
///
/// * `client` - The Cloud API client
/// * `subscription_id` - The subscription containing the database
/// * `database_id` - The database to delete
/// * `timeout` - Maximum time to wait for completion
/// * `on_progress` - Optional callback for progress updates
pub async fn delete_database_and_wait(
    client: &CloudClient,
    subscription_id: i32,
    database_id: i32,
    timeout: Duration,
    on_progress: Option<ProgressCallback>,
) -> Result<()> {
    let handler = DatabaseHandler::new(client.clone());

    // Step 1: Delete (returns task)
    let task = handler.delete(subscription_id, database_id).await?;
    let task_id = task
        .task_id
        .ok_or_else(|| CoreError::TaskFailed("No task ID returned".to_string()))?;

    // Step 2: Poll until complete
    poll_task(
        client,
        &task_id,
        timeout,
        Duration::from_secs(10),
        on_progress,
    )
    .await?;

    Ok(())
}

/// Update a database and wait for completion
///
/// # Arguments
///
/// * `client` - The Cloud API client
/// * `subscription_id` - The subscription containing the database
/// * `database_id` - The database to update
/// * `request` - The database update request
/// * `timeout` - Maximum time to wait for completion
/// * `on_progress` - Optional callback for progress updates
///
/// # Example
///
/// ```rust,ignore
/// use redis_cloud::databases::DatabaseUpdateRequest;
/// use redisctl_core::cloud::update_database_and_wait;
/// use std::time::Duration;
///
/// let request = DatabaseUpdateRequest::builder()
///     .name("new-name")
///     .memory_limit_in_gb(2.0)
///     .build();
///
/// let database = update_database_and_wait(
///     &client,
///     subscription_id,
///     database_id,
///     &request,
///     Duration::from_secs(600),
///     None,
/// ).await?;
/// ```
pub async fn update_database_and_wait(
    client: &CloudClient,
    subscription_id: i32,
    database_id: i32,
    request: &DatabaseUpdateRequest,
    timeout: Duration,
    on_progress: Option<ProgressCallback>,
) -> Result<Database> {
    let handler = DatabaseHandler::new(client.clone());

    // Step 1: Update (returns task)
    let task = handler
        .update(subscription_id, database_id, request)
        .await?;
    let task_id = task
        .task_id
        .ok_or_else(|| CoreError::TaskFailed("No task ID returned".to_string()))?;

    // Step 2: Poll until complete
    poll_task(
        client,
        &task_id,
        timeout,
        Duration::from_secs(10),
        on_progress,
    )
    .await?;

    // Step 3: Fetch the updated database
    let db = handler.get(subscription_id, database_id).await?;
    Ok(db)
}

/// Backup a database and wait for completion
///
/// # Arguments
///
/// * `client` - The Cloud API client
/// * `subscription_id` - The subscription containing the database
/// * `database_id` - The database to backup
/// * `region_name` - Optional region name (required for Active-Active databases)
/// * `timeout` - Maximum time to wait for completion
/// * `on_progress` - Optional callback for progress updates
pub async fn backup_database_and_wait(
    client: &CloudClient,
    subscription_id: i32,
    database_id: i32,
    region_name: Option<&str>,
    timeout: Duration,
    on_progress: Option<ProgressCallback>,
) -> Result<()> {
    let handler = DatabaseHandler::new(client.clone());

    // Build backup request
    let request = if let Some(region) = region_name {
        DatabaseBackupRequest::builder().region_name(region).build()
    } else {
        DatabaseBackupRequest::builder().build()
    };

    // Step 1: Trigger backup (returns task)
    let task = handler
        .backup_database(subscription_id, database_id, &request)
        .await?;
    let task_id = task
        .task_id
        .ok_or_else(|| CoreError::TaskFailed("No task ID returned".to_string()))?;

    // Step 2: Poll until complete
    poll_task(
        client,
        &task_id,
        timeout,
        Duration::from_secs(10),
        on_progress,
    )
    .await?;

    Ok(())
}

/// Import data into a database and wait for completion
///
/// WARNING: This will overwrite existing data in the database!
///
/// # Arguments
///
/// * `client` - The Cloud API client
/// * `subscription_id` - The subscription containing the database
/// * `database_id` - The database to import into
/// * `request` - The import request specifying source type and URIs
/// * `timeout` - Maximum time to wait for completion
/// * `on_progress` - Optional callback for progress updates
///
/// # Example
///
/// ```rust,ignore
/// use redis_cloud::databases::DatabaseImportRequest;
/// use redisctl_core::cloud::import_database_and_wait;
/// use std::time::Duration;
///
/// let request = DatabaseImportRequest::builder()
///     .source_type("aws-s3")
///     .import_from_uri(vec!["s3://bucket/file.rdb".to_string()])
///     .build();
///
/// import_database_and_wait(
///     &client,
///     subscription_id,
///     database_id,
///     &request,
///     Duration::from_secs(1800), // Imports can take longer
///     None,
/// ).await?;
/// ```
pub async fn import_database_and_wait(
    client: &CloudClient,
    subscription_id: i32,
    database_id: i32,
    request: &DatabaseImportRequest,
    timeout: Duration,
    on_progress: Option<ProgressCallback>,
) -> Result<()> {
    let handler = DatabaseHandler::new(client.clone());

    // Step 1: Start import (returns task)
    let task = handler
        .import_database(subscription_id, database_id, request)
        .await?;
    let task_id = task
        .task_id
        .ok_or_else(|| CoreError::TaskFailed("No task ID returned".to_string()))?;

    // Step 2: Poll until complete
    poll_task(
        client,
        &task_id,
        timeout,
        Duration::from_secs(10),
        on_progress,
    )
    .await?;

    Ok(())
}

/// Flush all data from a database and wait for completion
///
/// WARNING: This permanently deletes ALL data in the database!
///
/// # Arguments
///
/// * `client` - The Cloud API client
/// * `subscription_id` - The subscription containing the database
/// * `database_id` - The database to flush
/// * `timeout` - Maximum time to wait for completion
/// * `on_progress` - Optional callback for progress updates
pub async fn flush_database_and_wait(
    client: &CloudClient,
    subscription_id: i32,
    database_id: i32,
    timeout: Duration,
    on_progress: Option<ProgressCallback>,
) -> Result<()> {
    let handler = DatabaseHandler::new(client.clone());

    // Step 1: Flush (returns task)
    let task = handler.flush_database(subscription_id, database_id).await?;
    let task_id = task
        .task_id
        .ok_or_else(|| CoreError::TaskFailed("No task ID returned".to_string()))?;

    // Step 2: Poll until complete
    poll_task(
        client,
        &task_id,
        timeout,
        Duration::from_secs(5),
        on_progress,
    )
    .await?;

    Ok(())
}

// =============================================================================
// Subscription Workflows
// =============================================================================

/// Create a subscription and wait for completion
///
/// This workflow:
/// 1. Creates a subscription (returns task)
/// 2. Polls the task until completion
/// 3. Fetches and returns the created subscription
///
/// Note: Subscription creation requires complex nested structures (cloudProviders,
/// databases arrays). Use `SubscriptionCreateRequest::builder()` from redis-cloud
/// to construct the request.
///
/// # Arguments
///
/// * `client` - The Cloud API client
/// * `request` - The subscription creation request
/// * `timeout` - Maximum time to wait for completion
/// * `on_progress` - Optional callback for progress updates
///
/// # Example
///
/// ```rust,ignore
/// use redis_cloud::subscriptions::{
///     SubscriptionCreateRequest, SubscriptionSpec, SubscriptionRegionSpec,
///     SubscriptionDatabaseSpec,
/// };
/// use redisctl_core::cloud::create_subscription_and_wait;
/// use std::time::Duration;
///
/// let request = SubscriptionCreateRequest::builder()
///     .name("my-subscription")
///     .cloud_providers(vec![SubscriptionSpec {
///         provider: Some("AWS".to_string()),
///         cloud_account_id: Some(1),
///         regions: vec![SubscriptionRegionSpec {
///             region: "us-east-1".to_string(),
///             ..Default::default()
///         }],
///     }])
///     .databases(vec![SubscriptionDatabaseSpec { /* ... */ }])
///     .build();
///
/// let subscription = create_subscription_and_wait(
///     &client,
///     &request,
///     Duration::from_secs(1800), // Subscriptions can take longer
///     None,
/// ).await?;
/// ```
pub async fn create_subscription_and_wait(
    client: &CloudClient,
    request: &SubscriptionCreateRequest,
    timeout: Duration,
    on_progress: Option<ProgressCallback>,
) -> Result<Subscription> {
    let handler = SubscriptionHandler::new(client.clone());

    // Step 1: Create (returns task)
    let task = handler.create_subscription(request).await?;
    let task_id = task
        .task_id
        .ok_or_else(|| CoreError::TaskFailed("No task ID returned".to_string()))?;

    // Step 2: Poll until complete
    let completed = poll_task(
        client,
        &task_id,
        timeout,
        Duration::from_secs(15), // Subscriptions take longer, poll less frequently
        on_progress,
    )
    .await?;

    // Step 3: Fetch the created resource
    let resource_id = completed
        .response
        .and_then(|r| r.resource_id)
        .ok_or_else(|| CoreError::TaskFailed("No resource ID in completed task".to_string()))?;

    let subscription = handler.get_subscription_by_id(resource_id).await?;
    Ok(subscription)
}

/// Update a subscription and wait for completion
///
/// # Arguments
///
/// * `client` - The Cloud API client
/// * `subscription_id` - The subscription to update
/// * `request` - The update request
/// * `timeout` - Maximum time to wait for completion
/// * `on_progress` - Optional callback for progress updates
///
/// # Example
///
/// ```rust,ignore
/// use redis_cloud::subscriptions::BaseSubscriptionUpdateRequest;
/// use redisctl_core::cloud::update_subscription_and_wait;
/// use std::time::Duration;
///
/// let request = BaseSubscriptionUpdateRequest {
///     subscription_id: None,
///     command_type: None,
/// };
///
/// let subscription = update_subscription_and_wait(
///     &client,
///     123,
///     &request,
///     Duration::from_secs(600),
///     None,
/// ).await?;
/// ```
pub async fn update_subscription_and_wait(
    client: &CloudClient,
    subscription_id: i32,
    request: &BaseSubscriptionUpdateRequest,
    timeout: Duration,
    on_progress: Option<ProgressCallback>,
) -> Result<Subscription> {
    let handler = SubscriptionHandler::new(client.clone());

    // Step 1: Update (returns task)
    let task = handler
        .update_subscription(subscription_id, request)
        .await?;
    let task_id = task
        .task_id
        .ok_or_else(|| CoreError::TaskFailed("No task ID returned".to_string()))?;

    // Step 2: Poll until complete
    poll_task(
        client,
        &task_id,
        timeout,
        Duration::from_secs(10),
        on_progress,
    )
    .await?;

    // Step 3: Fetch the updated subscription
    let subscription = handler.get_subscription_by_id(subscription_id).await?;
    Ok(subscription)
}

/// Delete a subscription and wait for completion
///
/// WARNING: This will delete the subscription and all its databases!
/// Ensure all databases are deleted first or this operation may fail.
///
/// # Arguments
///
/// * `client` - The Cloud API client
/// * `subscription_id` - The subscription to delete
/// * `timeout` - Maximum time to wait for completion
/// * `on_progress` - Optional callback for progress updates
pub async fn delete_subscription_and_wait(
    client: &CloudClient,
    subscription_id: i32,
    timeout: Duration,
    on_progress: Option<ProgressCallback>,
) -> Result<()> {
    let handler = SubscriptionHandler::new(client.clone());

    // Step 1: Delete (returns task)
    let task = handler.delete_subscription_by_id(subscription_id).await?;
    let task_id = task
        .task_id
        .ok_or_else(|| CoreError::TaskFailed("No task ID returned".to_string()))?;

    // Step 2: Poll until complete
    poll_task(
        client,
        &task_id,
        timeout,
        Duration::from_secs(10),
        on_progress,
    )
    .await?;

    Ok(())
}