Add refresh button to remote (lazy) widgets

[christian-byrne]

Updates remote widgets to support refresh button option. Additionally, adds max_retries, timeout, and control_after_refresh options. There are also changes to improve memory management.

The hook has also been refactored so that it can work with any widget type instead of just COMBO. The hook is designed to proxy any property of the widget.

refresh-button-lazy-widget.mp4

Node from video:

class LoadImageOutputRefresh(LoadImage):
    @classmethod
    def INPUT_TYPES(s):
        return {"required":
                    {"image": ("COMBO", {
                        "image_upload": True,
                        "image_folder": "output",
                        "remote" : {
                            "route": "/internal/files/output",
                            "refresh_button": True,
                            "control_after_refresh": "first",
                        }
                    })},
                }

    @classmethod
    def VALIDATE_INPUTS(s, image):
        return True

    CATEGORY = "image"

    RETURN_TYPES = ("IMAGE", "MASK")
    FUNCTION = "load_image_output"

    def load_image_output(self, image):
        return self.load_image(f"{image} [output]")

┆Issue is synchronized with this Notion page by Unito

[christian-byrne]

1) [chromium] › remoteWidgets.spec.ts:212:5 › Remote COMBO Widget › Refresh Behavior › retries failed requests with backoff 

    Error: expect(received).toBeGreaterThan(expected)

    Matcher error: received value must be a number or bigint

    Received has value: undefined

      [22](https://github.com/Comfy-Org/ComfyUI_frontend/actions/runs/13238967000/job/36949864898?pr=2494#step:4:23)8 |       // Verify exponential backoff between retries
      229 |       const intervals = timestamps.slice(1).map((t, i) => t - timestamps[i])
    > [23](https://github.com/Comfy-Org/ComfyUI_frontend/actions/runs/13238967000/job/36949864898?pr=2494#step:4:24)0 |       expect(intervals[1]).toBeGreaterThan(intervals[0])
          |                            ^
      231 |     })
      232 |   })
      233 |

This test now fails because timeout and max_retries are handled manually. The test will be adjusted to force re-fetch in accordance with timeout of test nodes.

[ltdrdata]

How about adding a refresh icon to the combo widget instead of using a refresh button?

[christian-byrne]

How about adding a refresh icon to the combo widget instead of using a refresh button?

That's a great idea. I think this was what was envisioned in the RFC originally. There's a draft PR that implements this as well:

• Add an extended number widget with support for annotations #994

I can add support on litegraph side and simply change this function:

ComfyUI_frontend/src/composables/widgets/useRemoteWidget.ts

Lines 205 to 210 in 779c253

	/**
	* Add a refresh button to the node that, when clicked, will force the widget to refresh
	*/
	function addRefreshButton() {
	node.addWidget('button', 'refresh', 'refresh', refreshValue)
	}

Right now, the litegraph code is being refactored and is somewhat volatile.