apify-client 0.6.0

An official, but experimental, AI-generated and AI-maintained Rust client for the Apify API (https://apify.com).
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
//! Integration tests for the Actor resource (collection + CRUD).
//!
//! These create a private Actor on the test account, build it, and clean it up.

mod common;

use serde_json::json;

/// Simple GET: listing the account's Actors.
#[tokio::test(flavor = "multi_thread")]
async fn list_actors() {
    let client = require_client!();
    let page = client
        .actors()
        .list(Default::default())
        .await
        .expect("listing actors should succeed");
    assert!(page.total >= 0);
}

fn actor_name(prefix: &str) -> String {
    let name = common::unique_name(prefix).replace('-', ""); // actor names are stricter
    format!("a{}", &name[..name.len().min(20)])
}

/// Minimal Actor definition with one inline source-files version.
fn actor_definition(name: &str) -> serde_json::Value {
    json!({
        "name": name,
        "isPublic": false,
        "versions": [{
            "versionNumber": "0.0",
            "sourceType": "SOURCE_FILES",
            "buildTag": "latest",
            "sourceFiles": [
                {
                    "name": "Dockerfile",
                    "format": "TEXT",
                    "content": "FROM apify/actor-node:20\nCOPY . ./\nCMD node main.js"
                },
                {
                    "name": "main.js",
                    "format": "TEXT",
                    "content": "console.log('hello from rust client test');"
                }
            ]
        }]
    })
}

/// Simple GET: fetch a single Actor by ID.
#[tokio::test(flavor = "multi_thread")]
async fn get_actor() {
    let client = require_client!();
    let name = actor_name("actor-get");
    let actor = client
        .actors()
        .create(&actor_definition(&name))
        .await
        .expect("create actor");

    let cleanup_client = client.clone();
    let id = actor.id.clone();
    let _guard = common::Cleanup::new(move || async move {
        let _ = cleanup_client.actor(&id).delete().await;
    });

    let fetched = client
        .actor(&actor.id)
        .get()
        .await
        .expect("get actor by id")
        .expect("actor should exist");
    assert_eq!(fetched.id, actor.id);
}

/// Iteration: the Actor collection iterator yields a just-created Actor across pages.
#[tokio::test(flavor = "multi_thread")]
async fn iterate_actors() {
    let client = require_client!();
    let name = actor_name("actor-iter");
    let actor = client
        .actors()
        .create(&actor_definition(&name))
        .await
        .expect("create actor");

    let cleanup_client = client.clone();
    let id = actor.id.clone();
    let _guard = common::Cleanup::new(move || async move {
        let _ = cleanup_client.actor(&id).delete().await;
    });

    // Restrict to the caller's own Actors, newest-first, with a small page size.
    let target = actor.id.clone();
    assert!(
        common::iter_contains_eventually(
            || {
                client
                    .actors()
                    .iterate(apify_client::ActorListOptions {
                        my: Some(true),
                        desc: Some(true),
                        ..Default::default()
                    })
                    .with_chunk_size(5)
            },
            move |a| a.id == target,
        )
        .await,
        "actor iteration should yield the created actor"
    );
}

/// Iteration: the Actor version iterator yields the Actor's initial version.
#[tokio::test(flavor = "multi_thread")]
async fn iterate_actor_versions() {
    let client = require_client!();
    let name = actor_name("ver-iter");
    let actor = client
        .actors()
        .create(&actor_definition(&name))
        .await
        .expect("create actor");

    let cleanup_client = client.clone();
    let id = actor.id.clone();
    let _guard = common::Cleanup::new(move || async move {
        let _ = cleanup_client.actor(&id).delete().await;
    });

    assert!(
        common::iter_contains_eventually(
            || client
                .actor(&actor.id)
                .versions()
                .iterate(Default::default()),
            |v| v.version_number == "0.0",
        )
        .await,
        "version iteration should yield the initial 0.0 version"
    );
}

/// Iteration: the environment-variable iterator yields a variable we just created.
#[tokio::test(flavor = "multi_thread")]
async fn iterate_actor_env_vars() {
    use apify_client::models::ActorEnvVar;

    let client = require_client!();
    let name = actor_name("envit");
    let actor = client
        .actors()
        .create(&actor_definition(&name))
        .await
        .expect("create actor");

    let cleanup_client = client.clone();
    let id = actor.id.clone();
    let _guard = common::Cleanup::new(move || async move {
        let _ = cleanup_client.actor(&id).delete().await;
    });

    let version_client = client.actor(&actor.id).version("0.0");
    version_client
        .env_vars()
        .create(&ActorEnvVar {
            name: "ITER_VAR".to_string(),
            value: Some("v".to_string()),
            is_secret: Some(false),
            extra: Default::default(),
        })
        .await
        .expect("create env var");

    assert!(
        common::iter_contains_eventually(
            || version_client.env_vars().iterate(),
            |e| e.name == "ITER_VAR",
        )
        .await,
        "env-var iteration should yield the created variable"
    );
}

/// Complex flow: create an Actor with a single version, get it, update it, list builds,
/// and delete it.
#[tokio::test(flavor = "multi_thread")]
async fn actor_crud_flow() {
    let client = require_client!();
    let name = actor_name("actor");

    let actor = client
        .actors()
        .create(&actor_definition(&name))
        .await
        .expect("create actor");
    assert_eq!(actor.name.as_deref(), Some(name.as_str()));

    let cleanup_client = client.clone();
    let cleanup_id = actor.id.clone();
    let _guard = common::Cleanup::new(move || async move {
        let _ = cleanup_client.actor(&cleanup_id).delete().await;
    });

    let actor_client = client.actor(&actor.id);

    // Get.
    let fetched = actor_client.get().await.expect("get actor");
    assert!(fetched.is_some(), "created actor should be retrievable");

    // Update (set title).
    let updated = actor_client
        .update(&json!({ "title": "Rust client test actor" }))
        .await
        .expect("update actor");
    assert_eq!(updated.title.as_deref(), Some("Rust client test actor"));

    // List builds (should succeed even if empty).
    let builds = actor_client
        .builds()
        .list(Default::default())
        .await
        .expect("list actor builds");
    assert!(builds.total >= 0);

    // List versions.
    let versions = actor_client
        .versions()
        .list(Default::default())
        .await
        .expect("list versions");
    assert!(versions.items.iter().any(|v| v.version_number == "0.0"));

    // Delete.
    actor_client.delete().await.expect("delete actor");
    assert!(actor_client
        .get()
        .await
        .expect("get after delete")
        .is_none());
}

/// Actor versions: create -> get -> list -> update -> delete on a fresh Actor.
#[tokio::test(flavor = "multi_thread")]
async fn actor_version_crud_flow() {
    use apify_client::models::ActorVersion;

    let client = require_client!();
    let name = actor_name("ver");

    // Create the Actor with its initial 0.0 version.
    let actor = client
        .actors()
        .create(&actor_definition(&name))
        .await
        .expect("create actor");

    let cleanup_client = client.clone();
    let cleanup_id = actor.id.clone();
    let _guard = common::Cleanup::new(move || async move {
        let _ = cleanup_client.actor(&cleanup_id).delete().await;
    });

    let actor_client = client.actor(&actor.id);

    // Create a new version (0.1) via the collection.
    let new_version = json!({
        "versionNumber": "0.1",
        "sourceType": "SOURCE_FILES",
        "buildTag": "beta",
        "sourceFiles": [
            {
                "name": "Dockerfile",
                "format": "TEXT",
                "content": "FROM apify/actor-node:20\nCOPY . ./\nCMD node main.js"
            },
            {
                "name": "main.js",
                "format": "TEXT",
                "content": "console.log('v0.1');"
            }
        ]
    });
    let created = actor_client
        .versions()
        .create(&new_version)
        .await
        .expect("create version");
    assert_eq!(created.version_number, "0.1");

    // Simple GET: fetch the version by its number.
    let version_client = actor_client.version("0.1");
    let fetched = version_client
        .get()
        .await
        .expect("get version")
        .expect("version 0.1 should exist");
    assert_eq!(fetched.version_number, "0.1");

    // List should include both 0.0 and 0.1.
    let versions = actor_client
        .versions()
        .list(Default::default())
        .await
        .expect("list versions");
    assert!(versions.items.iter().any(|v| v.version_number == "0.1"));

    // Update the version (change its build tag).
    let updated = version_client
        .update(&ActorVersion {
            version_number: "0.1".to_string(),
            source_type: Some("SOURCE_FILES".to_string()),
            extra: serde_json::from_value(json!({
                "buildTag": "latest",
                "sourceFiles": [
                    {
                        "name": "Dockerfile",
                        "format": "TEXT",
                        "content": "FROM apify/actor-node:20\nCOPY . ./\nCMD node main.js"
                    },
                    { "name": "main.js", "format": "TEXT", "content": "console.log('v0.1');" }
                ]
            }))
            .expect("build version extra"),
        })
        .await
        .expect("update version");
    assert_eq!(updated.version_number, "0.1");

    // Delete the version.
    version_client.delete().await.expect("delete version");
    assert!(
        actor_client
            .version("0.1")
            .get()
            .await
            .expect("get after delete")
            .is_none(),
        "version 0.1 should be gone after delete"
    );
}

/// Actor version environment variables: create -> get -> list -> update -> delete.
#[tokio::test(flavor = "multi_thread")]
async fn actor_env_var_crud_flow() {
    use apify_client::models::ActorEnvVar;

    let client = require_client!();
    let name = actor_name("env");

    let actor = client
        .actors()
        .create(&actor_definition(&name))
        .await
        .expect("create actor");

    let cleanup_client = client.clone();
    let cleanup_id = actor.id.clone();
    let _guard = common::Cleanup::new(move || async move {
        let _ = cleanup_client.actor(&cleanup_id).delete().await;
    });

    let version_client = client.actor(&actor.id).version("0.0");

    // Create an environment variable on version 0.0.
    let created = version_client
        .env_vars()
        .create(&ActorEnvVar {
            name: "MY_VAR".to_string(),
            value: Some("hello".to_string()),
            is_secret: Some(false),
            extra: Default::default(),
        })
        .await
        .expect("create env var");
    assert_eq!(created.name, "MY_VAR");

    // Simple GET: fetch the env var by name.
    let env_var_client = version_client.env_var("MY_VAR");
    let fetched = env_var_client
        .get()
        .await
        .expect("get env var")
        .expect("env var should exist");
    assert_eq!(fetched.name, "MY_VAR");

    // List should include it.
    let env_vars = version_client
        .env_vars()
        .list()
        .await
        .expect("list env vars");
    assert!(env_vars.items.iter().any(|e| e.name == "MY_VAR"));

    // Update its value.
    let updated = env_var_client
        .update(&ActorEnvVar {
            name: "MY_VAR".to_string(),
            value: Some("world".to_string()),
            is_secret: Some(false),
            extra: Default::default(),
        })
        .await
        .expect("update env var");
    assert_eq!(updated.name, "MY_VAR");

    // Delete it.
    env_var_client.delete().await.expect("delete env var");
    assert!(
        version_client
            .env_var("MY_VAR")
            .get()
            .await
            .expect("get after delete")
            .is_none(),
        "env var should be gone after delete"
    );
}