// Prevent eslint errors on functions defined in other files. /*global isString, isStringLogError, isNull, isUndefined, isNullOrUndefined, isNullOrUndefinedLogError, isElement, isElementLogError, isFunction, isFunctionLogError, getElementByIdLogError, querySelectorLogError, waitForElement, Clusterize */ /*eslint no-undef: "error"*/ const JSON_UPDATE_DEBOUNCE_TIME_MS = 250; const RESIZE_DEBOUNCE_TIME_MS = 250; // Collators used for sorting. const INT_COLLATOR = new Intl.Collator([], {numeric: true}); const STR_COLLATOR = new Intl.Collator("en", {numeric: true, sensitivity: "base"}); class InvalidCompressedJsonDataError extends Error { constructor(message, options) { super(message, options); } } async function decompress(base64string) { /** Decompresses a base64 encoded ZLIB compressed string. */ try { if (isNullOrUndefined(base64string) || base64string === "") { throw new Error("invalid base64 string"); } const ds = new DecompressionStream("deflate"); const writer = ds.writable.getWriter(); const bytes = Uint8Array.from(atob(base64string), c => c.charCodeAt(0)); writer.write(bytes); writer.close(); const arrayBuffer = await new Response(ds.readable).arrayBuffer(); return await JSON.parse(new TextDecoder().decode(arrayBuffer)); } catch (error) { throw new InvalidCompressedJsonDataError(error); } } class ExtraNetworksClusterize { /** Base class for a clusterize list. Cannot be used directly. */ constructor( { tabname, extra_networks_tabname, scroll_id, content_id, data_request_callback, rows_in_block = 10, blocks_in_cluster = 4, show_no_data_row = true, callbacks = {}, } = { rows_in_block: 10, blocks_in_cluster: 4, show_no_data_row: true, callbacks: {}, } ) { // Do not continue if any of the required parameters are invalid. if (!isStringLogError(tabname)) { return; } if (!isStringLogError(extra_networks_tabname)) { return; } if (!isStringLogError(scroll_id)) { return; } if (!isStringLogError(content_id)) { return; } if (!isFunctionLogError(data_request_callback)) { return; } this.tabname = tabname; this.extra_networks_tabname = extra_networks_tabname; this.scroll_id = scroll_id; this.content_id = content_id; this.data_request_callback = data_request_callback; this.rows_in_block = rows_in_block; this.blocks_in_cluster = blocks_in_cluster; this.show_no_data_row = show_no_data_row; this.callbacks = callbacks; this.clusterize = null; this.scroll_elem = null; this.content_elem = null; this.element_observer = null; this.resize_observer = null; this.resize_observer_timer = null; // Used to control logic. Many functions immediately return when disabled. this.enabled = false; // Stores the current encoded string so we can compare against future versions. this.encoded_str = ""; this.no_data_text = "No results."; this.no_data_class = "clusterize-no-data"; this.n_rows = this.rows_in_block; this.n_cols = 1; this.data_obj = {}; this.data_obj_keys_sorted = []; this.sort_fn = this.sortByDivId; this.sort_reverse = false; } reset() { /** Destroy clusterize instance and set all instance variables to defaults. */ this.destroy(); this.teardownElementObservers(); this.teardownResizeObservers(); this.clusterize = null; this.scroll_elem = null; this.content_elem = null; this.enabled = false; this.encoded_str = ""; this.n_rows = this.rows_in_block; this.n_cols = 1; this.data_obj = {}; this.data_obj_keys_sorted = []; this.sort_fn = this.sortByDivId; this.sort_reverse = false; } async setup() { return new Promise(resolve => { // Setup our event handlers only after our elements exist in DOM. Promise.all([ waitForElement(`#${this.scroll_id}`).then((elem) => this.scroll_elem = elem), waitForElement(`#${this.content_id}`).then((elem) => this.content_elem = elem), ]).then(() => { this.setupElementObservers(); this.setupResizeObservers(); return this.fetchData(); }).then(encoded_str => { if (isNullOrUndefined(encoded_str)) { // no new data to load. break from chain. return resolve(); } return this.parseJson(encoded_str); }).then(json => { if (isNullOrUndefined(json)) { return resolve(); } this.clear(); this.updateJson(json); }).then(() => { this.sortData(); }).then(() => { // since calculateDims manually adds an element from our data_obj, // we don't need clusterize initialzied to calculate dims. this.calculateDims(); this.applyFilter(); this.rebuild(this.getFilteredRows()); return resolve(); }).catch(error => { console.error("setup:: error in promise:", error); return resolve(); }); }); } async load() { return new Promise(resolve => { if (isNullOrUndefined(this.clusterize)) { // This occurs whenever we click on a tab before initialization and setup // have fully completed for this instance. return resolve(this.setup()); } if (this.calculateDims()) { // Since dimensions updated, we need to apply the filter and rebuild. this.applyFilter(); this.rebuild(this.getFilteredRows()); } else { this.refresh(true); } return resolve(); }); } async fetchData() { let encoded_str = await this.data_request_callback( this.tabname, this.extra_networks_tabname, this.constructor.name, ); if (this.encoded_str === encoded_str) { // no change to the data since last call. ignore. return null; } this.encoded_str = encoded_str; return this.encoded_str; } async parseJson(encoded_str) { /** promise */ /** Parses a base64 encoded and gzipped JSON string and sets up a clusterize instance. */ return new Promise((resolve, reject) => { Promise.resolve(encoded_str) .then(v => decompress(v)) .then(v => resolve(v)) .catch(error => { return reject(error); }); }); } calculateDims() { let res = false; // Cannot calculate dims if not enabled since our elements won't be visible. if (!this.enabled) { return res; } // Cannot do anything if we have no data. if (this.data_obj_keys_sorted.length <= 0) { return res; } // Repair before anything else so we can actually get dimensions. this.repair(); // Add an element to the container manually so we can calculate dims. const child = htmlStringToElement(this.data_obj[this.data_obj_keys_sorted[0]].html); this.content_elem.prepend(child); let n_cols = calcColsPerRow(this.content_elem, child); let n_rows = calcRowsPerCol(this.scroll_elem, child); n_cols = (isNaN(n_cols) || n_cols <= 0) ? 1 : n_cols; n_rows = (isNaN(n_rows) || n_rows <= 0) ? 1 : n_rows; n_rows += 2; if (n_cols != this.n_cols || n_rows != this.n_rows) { // Sizes have changed. Update the instance values. this.n_cols = n_cols; this.n_rows = n_rows; this.rows_in_block = this.n_rows; res = true; } // Remove the temporary element from DOM. child.remove(); return res; } sortData() { /** Sorts the rows using the instance's `sort_fn`. * * It is expected that a subclass will override this function to update the * instance's `sort_fn` then call `super.sortData()` to apply the sorting. */ this.sort_fn(); if (this.sort_reverse) { this.data_obj_keys_sorted = this.data_obj_keys_sorted.reverse(); } } applyFilter() { /** Should be overridden by child class. */ this.sortData(); if (!isNullOrUndefined(this.clusterize)) { this.update(this.getFilteredRows()); } //this.rebuild(this.getFilteredRows()); } getFilteredRows() { let rows = []; let active_keys = this.data_obj_keys_sorted.filter(k => this.data_obj[k].active); for (let i = 0; i < active_keys.length; i += this.n_cols) { rows.push( active_keys.slice(i, i + this.n_cols) .map(k => this.data_obj[k].html) .join("") ); } return rows; } rebuild(rows) { if (!isNullOrUndefined(this.clusterize)) { this.clusterize.destroy(true); this.clusterize = null; } if (isNullOrUndefined(rows) || !Array.isArray(rows)) { rows = []; } this.clusterize = new Clusterize( { rows: rows, scrollId: this.scroll_id, contentId: this.content_id, rows_in_block: this.rows_in_block, tag: "div", blocks_in_cluster: this.blocks_in_cluster, show_no_data_row: this.show_no_data_row, no_data_text: this.no_data_text, no_data_class: this.no_data_class, callbacks: this.callbacks, } ); } enable(enabled) { /** Enables or disables this instance. */ // All values other than `true` for `enabled` result in this.enabled=false. this.enabled = !(enabled !== true); } updateJson(json) { /** promise */ console.error("Base class method called. Must be overridden by subclass."); return new Promise(resolve => { return resolve(); }); } sortByDivId() { /** Sort data_obj keys (div_id) as numbers. */ this.data_obj_keys_sorted = Object.keys(this.data_obj).sort((a, b) => INT_COLLATOR.compare(a, b)); } updateDivContent(div_id, content) { /** Updates an element's html in the dataset. * * NOTE: This function only updates the dataset. Calling function must call * rebuild() to apply these changes to the view. Adding this call to this * function would be very slow in the case where many divs need their content * updated at the same time. */ if (!(div_id in this.data_obj)) { console.error("div_id not in data_obj:", div_id); } else if (isElement(content)) { this.data_obj[div_id].html = content.outerHTML; return true; } else if (isString(content)) { this.data_obj[div_id].html = content; return true; } else { console.error("Invalid content:", div_id, content); } return false; } getMaxRowWidth() { console.error("getMaxRowWidth:: Not implemented in base class. Must be overridden."); return; } repair() { /** Fixes element association in DOM. Returns whether a fix was performed. */ if (!this.enabled) { return false; } if (!isElement(this.scroll_elem) || !isElement(this.content_elem)) { return false; } // If association for elements is broken, replace them with instance version. if (!this.scroll_elem.isConnected || !this.content_elem.isConnected) { gradioApp().getElementById(this.scroll_id).replaceWith(this.scroll_elem); // Fix resize observers since they are bound to each element individually. if (!isNullOrUndefined(this.resize_observer)) { this.resize_observer.disconnect(); this.resize_observer.observe(this.scroll_elem); this.resize_observer.observe(this.content_elem); } // Make sure to refresh forcefully after updating the dom. this.refresh(true); return true; } return false; } onResize(elem_id) { /** Callback whenever one of our visible elements is resized. */ if (!this.enabled) { return; } this.refresh(true); if (this.calculateDims()) { this.rebuild(this.getFilteredRows()); } } onElementDetached(elem_id) { /** Callback whenever one of our elements has become detached from the DOM. */ switch (elem_id) { case this.scroll_id: this.repair(); break; case this.content_id: this.repair(); break; default: break; } } setupElementObservers() { /** Listens for changes to the data, scroll, and content elements. * * During testing, the scroll/content elements would frequently get removed from * the DOM. Our clusterize instance stores a reference to these elements * which breaks whenever these elements are removed from the DOM. To fix this, * we need to check for these changes and re-attach our stores elements by * replacing the ones in the DOM with the ones in our clusterize instance. * * We also use an observer to detect whenever the data element gets a new set * of JSON data so that we can update our dataset. */ this.element_observer = new MutationObserver((mutations) => { // don't waste time if this object isn't enabled. if (!this.enabled) { return; } let scroll_elem = gradioApp().getElementById(this.scroll_id); if (scroll_elem && scroll_elem !== this.scroll_elem) { this.onElementDetached(scroll_elem.id); } let content_elem = gradioApp().getElementById(this.content_id); if (content_elem && content_elem !== this.content_elem) { this.onElementDetached(content_elem.id); } }); this.element_observer.observe(gradioApp(), {subtree: true, childList: true, attributes: true}); } teardownElementObservers() { if (!isNullOrUndefined(this.element_observer)) { this.element_observer.takeRecords(); this.element_observer.disconnect(); } this.element_observer = null; } setupResizeObservers() { /** Handles any updates to the size of both the Scroll and Content elements. */ this.resize_observer = new ResizeObserver((entries) => { for (const entry of entries) { if (entry.target.id === this.scroll_id || entry.target.id === this.content_id) { // debounce the event clearTimeout(this.resize_observer_timer); this.resize_observer_timer = setTimeout(() => this.onResize(entry.id), RESIZE_DEBOUNCE_TIME_MS); } } }); this.resize_observer.observe(this.scroll_elem); this.resize_observer.observe(this.content_elem); } teardownResizeObservers() { if (!isNullOrUndefined(this.resize_observer)) { this.resize_observer.disconnect(); } if (!isNullOrUndefined(this.resize_observer_timer)) { clearTimeout(this.resize_observer_timer); this.resize_observer_timer = null; } this.resize_observer = null; this.resize_observer_timer = null; } /* ==== Clusterize.Js FUNCTION WRAPPERS ==== */ update(rows) { /** Updates the clusterize rows. */ if (isNullOrUndefined(rows) || !Array.isArray(rows)) { rows = this.getFilteredRows(); } this.clusterize.update(rows); } clear() { /** Clears the clusterize list and this instance's data. */ if (!isNullOrUndefined(this.clusterize)) { this.clusterize.clear(); this.data_obj = {}; this.data_obj_keys_sorted = []; if (isElement(this.content_elem)) { this.content_elem.innerHTML = "