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
use std::collections::HashSet;
use std::pin::pin;

use anyhow::{anyhow, Context};
use async_stream::stream;
use futures_util::{
    stream::{FusedStream, FuturesOrdered},
    Stream, StreamExt,
};
use uuid::Uuid;

use crate::{
    api::{self, *},
    models::*,
};

pub mod visitor;
pub use visitor::Visitor;

pub mod setter;

pub mod getter;
use getter::*;

mod accessors;

use self::setter::SetterExt as _;

enum State {
    Executing(String, Vec<Image>),
    Finished(Vec<(String, Vec<Image>)>),
}

/// Output from a node.
#[derive(Debug, Clone)]
pub struct NodeOutput {
    /// The identifier of the node.
    pub node: String,
    /// The image generated by the node.
    pub image: Vec<u8>,
}

/// Errors that can occur opening API endpoints.
#[derive(thiserror::Error, Debug)]
#[non_exhaustive]
pub enum ComfyApiError {
    /// Error parsing endpoint URL
    #[error("Failed to create API")]
    CreateApiFailed(#[from] api::ApiError),
    /// Execution was interrupted
    #[error("Execution was interrupted: node {} ({})", response.node_id, response.node_type)]
    ExecutionInterrupted { response: ExecutionInterrupted },
    /// Error occurred during execution
    #[error("Error occurred during execution: {exception_type}: {exception_message}")]
    ExecutionError {
        exception_type: String,
        exception_message: String,
    },
    /// Connection error occurred during prompt execution
    #[error("Failed to get prompt execution update")]
    ReceiveUpdateFailure(#[from] api::WebSocketApiError),
    /// Prompt task not found
    #[error("Failed to get task for prompt")]
    PromptTaskNotFound(#[source] api::HistoryApiError),
    /// Error sending prompt to API
    #[error("Failed to send prompt to API")]
    SendPromptFailed(#[from] PromptApiError),
    /// Error getting image from API
    #[error("Failed to get image from API")]
    GetImageFailed(#[from] ViewApiError),
    /// Error uploading image to API
    #[error("Failed to upload image to API")]
    UploadImageFailed(#[from] UploadApiError),
}

type Result<T> = std::result::Result<T, ComfyApiError>;

/// Higher-level API for interacting with the ComfyUI API.
#[derive(Clone, Debug)]
pub struct Comfy {
    api: Api,
    history: HistoryApi,
    upload: UploadApi,
    view: ViewApi,
}

impl Default for Comfy {
    fn default() -> Self {
        let api = Api::default();
        Self {
            history: api.history().expect("failed to create history api"),
            upload: api.upload().expect("failed to create upload api"),
            view: api.view().expect("failed to create view api"),
            api,
        }
    }
}

impl Comfy {
    /// Returns a new `Comfy` instance with default settings.
    pub fn new() -> Result<Self> {
        let api = Api::default();
        Ok(Self {
            history: api.history()?,
            upload: api.upload()?,
            view: api.view()?,
            api,
        })
    }

    /// Returns a new `Comfy` instance with the given URL as a string value.
    ///
    /// # Arguments
    ///
    /// * `url` - A string that specifies the ComfyUI API URL endpoint.
    ///
    /// # Errors
    ///
    /// If the URL fails to parse, an error will be returned.
    pub fn new_with_url<S>(url: S) -> Result<Self>
    where
        S: AsRef<str>,
    {
        let api = Api::new_with_url(url.as_ref())?;
        Ok(Self {
            history: api.history()?,
            upload: api.upload()?,
            view: api.view()?,
            api,
        })
    }

    /// Returns a new `Comfy` instance with the given `reqwest::Client` and URL as a string value.
    ///
    /// # Arguments
    ///
    /// * `client` - An instance of `reqwest::Client`.
    /// * `url` - A string that specifies the ComfyUI API URL endpoint.
    ///
    /// # Errors
    ///
    /// If the URL fails to parse, an error will be returned.
    pub fn new_with_client_and_url<S>(client: reqwest::Client, url: S) -> Result<Self>
    where
        S: AsRef<str>,
    {
        let api = Api::new_with_client_and_url(client, url.as_ref())?;
        Ok(Self {
            history: api.history()?,
            upload: api.upload()?,
            view: api.view()?,
            api,
        })
    }

    async fn filter_update(&self, update: Update, target_prompt_id: Uuid) -> Result<Option<State>> {
        match update {
            Update::Executing(data) => {
                if data.node.is_none() {
                    if let Some(prompt_id) = data.prompt_id {
                        if prompt_id != target_prompt_id {
                            return Ok(None);
                        }
                        let task = self
                            .history
                            .get_prompt(&prompt_id)
                            .await
                            .map_err(ComfyApiError::PromptTaskNotFound)?;
                        let images = task
                            .outputs
                            .nodes
                            .into_iter()
                            .filter_map(|(key, value)| {
                                if let NodeOutputOrUnknown::NodeOutput(output) = value {
                                    Some((key, output.images))
                                } else {
                                    None
                                }
                            })
                            .collect::<Vec<(String, Vec<Image>)>>();
                        return Ok(Some(State::Finished(images)));
                    }
                }
                Ok(None)
            }
            Update::Executed(data) => {
                if data.prompt_id != target_prompt_id {
                    return Ok(None);
                }
                Ok(Some(State::Executing(data.node, data.output.images)))
            }
            Update::ExecutionInterrupted(data) => {
                if data.prompt_id != target_prompt_id {
                    return Ok(None);
                }
                Err(ComfyApiError::ExecutionInterrupted { response: data })
            }
            Update::ExecutionError(data) => {
                if data.execution_status.prompt_id != target_prompt_id {
                    return Ok(None);
                }
                Err(ComfyApiError::ExecutionError {
                    exception_type: data.exception_type,
                    exception_message: data.exception_message,
                })
            }
            _ => Ok(None),
        }
    }

    async fn prompt_impl<'a>(
        &'a self,
        prompt: &Prompt,
    ) -> Result<impl Stream<Item = Result<State>> + 'a> {
        let client_id = Uuid::new_v4();
        let prompt_api = self.api.prompt_with_client(client_id)?;
        let websocket_api = self.api.websocket_with_client(client_id)?;
        let stream = websocket_api
            .updates()
            .await
            .map_err(ComfyApiError::ReceiveUpdateFailure)?;
        let response = prompt_api.send(prompt).await?;
        let prompt_id = response.prompt_id;
        Ok(stream.filter_map(move |msg| async move {
            match msg {
                Ok(msg) => match self.filter_update(msg, prompt_id).await {
                    Ok(Some(images)) => Some(Ok(images)),
                    Ok(None) => None,
                    Err(e) => Some(Err(e)),
                },
                Err(e) => Some(Err(ComfyApiError::ReceiveUpdateFailure(e))),
            }
        }))
    }

    /// Executes a prompt and returns a stream of generated images.
    ///
    /// # Arguments
    ///
    /// * `prompt` - A `Prompt` to send to the ComfyUI API.
    ///
    /// # Returns
    ///
    /// A `Result` containing a `Stream` of `Result<NodeOutput>` values on success, or an error if the request failed.
    pub async fn stream_prompt<'a>(
        &'a self,
        prompt: &Prompt,
    ) -> Result<impl FusedStream<Item = Result<NodeOutput>> + 'a> {
        let stream = self.prompt_impl(prompt).await?;
        Ok(stream! {
            let mut executed = HashSet::new();
            for await msg in stream {
                match msg {
                    Ok(State::Executing(node, images)) => {
                        executed.insert(node.clone());
                        let fut = images.into_iter().map(|image| async move {
                            self.view.get(&image).await
                        }).collect::<FuturesOrdered<_>>();
                        for await image in fut {
                            yield Ok(NodeOutput { node: node.clone(), image: image? });
                        }
                    }
                    Ok(State::Finished(images)) => {
                        for (node, images) in images {
                            if executed.contains(&node) {
                                continue;
                            }
                            let fut = images.into_iter().map(|image| async move {
                                self.view.get(&image).await
                            }).collect::<FuturesOrdered<_>>();
                            for await image in fut {
                                yield Ok(NodeOutput { node: node.clone(), image: image? });
                            }
                        }
                        return;
                    }
                    Err(e) => Err(e)?,
                }
            }
        })
    }

    /// Executes a prompt and returns the generated images.
    ///
    /// # Arguments
    ///
    /// * `prompt` - A `Prompt` to send to the ComfyUI API.
    ///
    /// # Returns
    ///
    /// A `Result` containing a `Vec<NodeOutput>` on success, or an error if the request failed.
    pub async fn execute_prompt(&self, prompt: &Prompt) -> Result<Vec<NodeOutput>> {
        let mut images = vec![];
        let mut stream = pin!(self.stream_prompt(prompt).await?);
        while let Some(image) = stream.next().await {
            match image {
                Ok(image) => images.push(image),
                Err(e) => return Err(e),
            }
        }
        Ok(images)
    }

    /// Uploads a file to the ComfyUI API and returns information about the uploaded image.
    ///
    /// # Arguments
    ///
    /// * `file` - A `Vec<u8>` containing the file data to upload.
    ///
    /// # Returns
    ///
    /// A `Result` containing an `ImageUpload` on success, or an error if the request failed.
    pub async fn upload_file(&self, file: Vec<u8>) -> Result<ImageUpload> {
        Ok(self.upload.image(file).await?)
    }
}

/// Information about the generated image.
#[derive(Debug, Clone, Default)]
pub struct ImageInfo {
    /// The prompt used to generate the image.
    pub prompt: Option<String>,
    /// The negative prompt used to generate the image.
    pub negative_prompt: Option<String>,
    /// The model used to generate the image.
    pub model: Option<String>,
    /// The width of the image.
    pub width: Option<u32>,
    /// The height of the image.
    pub height: Option<u32>,
    /// The seed used to generate the image.
    pub seed: Option<i64>,
}

impl ImageInfo {
    /// Returns a new `ImageInfo` instance based on the given `Prompt` and output node.
    ///
    /// # Arguments
    ///
    /// * `prompt` - A `Prompt` describing the workflow used to generate an image.
    /// * `output_node` - The output node that produced the image.
    ///
    /// # Returns
    ///
    /// A `Result` containing a new `ImageInfo` instance on success, or an error if the output node was not found.
    pub fn new_from_prompt(prompt: &Prompt, output_node: &str) -> anyhow::Result<ImageInfo> {
        let mut image_info = ImageInfo::default();
        if let Some(node) = prompt.get_node_by_id(output_node) {
            image_info.visit(prompt, node);
        } else {
            return Err(anyhow!("Output node not found: {}", output_node));
        }
        Ok(image_info)
    }
}

#[derive(Debug, Clone)]
struct OverrideNode<T> {
    node: Option<String>,
    value: T,
}

impl<T> Default for OverrideNode<T>
where
    T: Default,
{
    fn default() -> Self {
        Self {
            node: Default::default(),
            value: Default::default(),
        }
    }
}

/// A builder for creating a `Prompt` instance.
#[derive(Debug, Clone)]
pub struct PromptBuilder {
    base_prompt: Prompt,
    output_node: Option<String>,
    prompt: Option<OverrideNode<String>>,
    negative_prompt: Option<OverrideNode<String>>,
    model: Option<OverrideNode<String>>,
    width: Option<OverrideNode<u32>>,
    height: Option<OverrideNode<u32>>,
    seed: Option<OverrideNode<i64>>,
}

impl PromptBuilder {
    /// Constructs a new `PromptBuilder` instance.
    ///
    /// # Arguments
    ///
    /// * `base_prompt` - The base `Prompt` to use as a starting point.
    /// * `output_node` - The output node to use when building the prompt.
    ///
    /// # Returns
    ///
    /// A new `PromptBuilder` instance.
    pub fn new(base_prompt: &Prompt, output_node: Option<String>) -> Self {
        Self {
            prompt: None,
            negative_prompt: None,
            model: None,
            width: None,
            height: None,
            seed: None,
            base_prompt: base_prompt.clone(),
            output_node,
        }
    }

    /// Sets the prompt.
    ///
    /// # Arguments
    ///
    /// * `value` - The prompt value to use.
    /// * `node` - The node to set the prompt on.
    pub fn prompt(mut self, value: String, node: Option<String>) -> Self {
        self.prompt = Some(OverrideNode { node, value });
        self
    }

    /// Sets the negative prompt.
    ///
    /// # Arguments
    ///
    /// * `value` - The negative prompt value to use.
    /// * `node` - The node to set the negative prompt on.
    pub fn negative_prompt(mut self, value: String, node: Option<String>) -> Self {
        self.negative_prompt = Some(OverrideNode { node, value });
        self
    }

    /// Sets the model.
    ///
    /// # Arguments
    ///
    /// * `value` - The model value to use.
    /// * `node` - The node to set the model on.
    pub fn model(mut self, value: String, node: Option<String>) -> Self {
        self.model = Some(OverrideNode { node, value });
        self
    }

    /// Sets the width.
    ///
    /// # Arguments
    ///
    /// * `value` - The width value to use.
    /// * `node` - The node to set the width on.
    pub fn width(mut self, value: u32, node: Option<String>) -> Self {
        self.width = Some(OverrideNode { node, value });
        self
    }

    /// Sets the height.
    ///
    /// # Arguments
    ///
    /// * `value` - The height value to use.
    /// * `node` - The node to set the height on.
    pub fn height(mut self, value: u32, node: Option<String>) -> Self {
        self.height = Some(OverrideNode { node, value });
        self
    }

    /// Sets the seed.
    ///
    /// # Arguments
    ///
    /// * `value` - The seed value to use.
    /// * `node` - The node to set the seed on.
    pub fn seed(mut self, value: i64, node: Option<String>) -> Self {
        self.seed = Some(OverrideNode { node, value });
        self
    }

    /// Builds a new `Prompt` instance based on the given parameters.
    ///
    /// # Returns
    ///
    /// A `Result` containing a new `Prompt` instance on success, or an error if a suitable output node could not be found.
    pub fn build(mut self) -> anyhow::Result<Prompt> {
        let mut new_prompt = self.base_prompt.clone();

        if self.output_node.is_none() {
            self.output_node = Some(
                find_output_node(&new_prompt).context("failed to find a suitable output node")?,
            );
        }

        if let Some(ref prompt) = self.prompt {
            if let Some(ref node) = prompt.node {
                new_prompt.set_node::<accessors::Prompt>(node, prompt.value.clone())?;
            } else {
                new_prompt.set_from::<accessors::Prompt>(
                    &self.output_node.clone().unwrap(),
                    prompt.value.clone(),
                )?;
            }
        }
        if let Some(ref negative_prompt) = self.negative_prompt {
            if let Some(ref node) = negative_prompt.node {
                new_prompt
                    .set_node::<accessors::NegativePrompt>(node, negative_prompt.value.clone())?;
            } else {
                new_prompt.set_from::<accessors::NegativePrompt>(
                    &self.output_node.clone().unwrap(),
                    negative_prompt.value.clone(),
                )?;
            }
        }
        if let Some(ref model) = self.model {
            if let Some(ref node) = model.node {
                new_prompt.set_node::<accessors::Model>(node, model.value.clone())?;
            } else {
                new_prompt.set_from::<accessors::Model>(
                    &self.output_node.clone().unwrap(),
                    model.value.clone(),
                )?;
            }
        }
        if let Some(width) = self.width {
            if let Some(ref node) = width.node {
                new_prompt.set_node::<accessors::Width>(node, width.value)?;
            } else {
                new_prompt.set_from::<accessors::Width>(
                    &self.output_node.clone().unwrap(),
                    width.value,
                )?;
            }
        }
        if let Some(height) = self.height {
            if let Some(ref node) = height.node {
                new_prompt.set_node::<accessors::Height>(node, height.value)?;
            } else {
                new_prompt.set_from::<accessors::Height>(
                    &self.output_node.clone().unwrap(),
                    height.value,
                )?;
            }
        }
        if let Some(ref seed) = self.seed {
            if let Some(ref node) = seed.node {
                new_prompt.set_node::<accessors::Seed>(node, seed.value)?;
            } else {
                new_prompt
                    .set_from::<accessors::Seed>(&self.output_node.clone().unwrap(), seed.value)?;
            }
        }
        Ok(new_prompt)
    }
}