Et2LinkString & Et2LinkList performance enhancements

- Limit server fetch to a certain amount of links (default 20)
- Load more button for Et2LinkList, More... for Et2LinkString
- Defer server fetch during initial loading for faster initial load
- Use repeat() so LitElement can do node caching magic
This commit is contained in:
nathan 2024-09-24 11:50:38 -06:00
parent 24ccfbf3ab
commit 58763707fd
6 changed files with 246 additions and 145 deletions

View File

@ -10,7 +10,7 @@
*/
import {css, html, TemplateResult} from "lit";
import {css, html, nothing, TemplateResult} from "lit";
import {repeat} from "lit/directives/repeat.js";
import {LinkInfo} from "./Et2Link";
import {egw} from "../../jsapi/egw_global";
@ -46,58 +46,69 @@ export class Et2LinkList extends Et2LinkString
return [
...super.styles,
css`
:host {
display: flex;
flex-direction: column;
column-gap: 10px;
overflow: hidden;
}
:host {
display: flex;
flex-direction: column;
column-gap: 10px;
overflow: hidden;
}
div {
display: flex;
gap: 10px;
}
div {
display: flex;
gap: 10px;
}
div:hover {
background-color: var(--highlight-background-color);
}
div:hover {
background-color: var(--highlight-background-color);
}
div.zip_highlight {
animation-name: new_entry_pulse, new_entry_clear;
animation-duration: 5s;
animation-delay: 0s, 30s;
animation-fill-mode: forwards;
}
div.zip_highlight {
animation-name: new_entry_pulse, new_entry_clear;
animation-duration: 5s;
animation-delay: 0s, 30s;
animation-fill-mode: forwards;
}
/* CSS for child elements */
/* CSS for child elements */
::slotted(*):after {
/* Reset from Et2LinkString */
content: initial;
}
::slotted(*)::part(icon) {
width: 1rem;
}
et2-link::part(title):after {
/* Reset from Et2LinkString */
content: initial;
}
::slotted(et2-link) {
flex: 1 1 auto;
}
et2-link::part(icon) {
width: 1rem;
}
::slotted(.remark) {
flex: 1 1 auto;
width: 20%;
}
et2-link {
display: block;
flex: 1 1 auto;
}
::slotted(.delete_button) {
visibility: hidden;
width: 16px;
order: 5;
}
et2-link:hover {
text-decoration: none;
}
div:hover ::slotted(.delete_button) {
visibility: initial;
}
et2-link::part(base) {
display: flex;
}
.remark {
flex: 1 1 auto;
width: 20%;
}
div et2-image[part=delete-button] {
visibility: hidden;
width: 16px;
order: 5;
cursor: pointer;
}
div:hover et2-image[part=delete-button] {
visibility: initial;
}
`
];
}
@ -115,7 +126,7 @@ export class Et2LinkList extends Et2LinkString
readonly: {type: Boolean}
}
}
private context : egwMenu;
constructor()
@ -164,7 +175,35 @@ export class Et2LinkList extends Et2LinkString
${repeat(this._link_list,
(link) => link.app + ":" + link.id,
(link) => this._rowTemplate(link))
}`;
}
`;
}
protected async moreResultsTemplate()
{
if(this._totalResults <= 0 || !this._loadingPromise)
{
return nothing;
}
return this._loadingPromise.then(() =>
{
const moreCount = this._totalResults - this._link_list.length;
const more = this.egw().lang("%1 more...", moreCount);
return html`${moreCount > 0 ? html`
<et2-button image="box-arrow-down" label="${more}" noSubmit="true"
._parent=${this}
@click="${(e) =>
{
// Change icon for some feedback
e.target.querySelectorAll("[slot=prefix]").forEach(n => n.remove());
e.target.append(Object.assign(document.createElement("sl-spinner"), {slot: "prefix"}));
// Get the next batch
const start = this._link_list.filter(l => l.app !== "file").length;
this.get_links([], start);
}}"
></et2-button>` : nothing}`;
});
}
/**
@ -178,7 +217,6 @@ export class Et2LinkList extends Et2LinkString
{
this._link_list = links;
this.requestUpdate();
this.updateComplete.then(() => super._addLinks(links));
}
/**
@ -193,7 +231,7 @@ export class Et2LinkList extends Et2LinkString
{
const id = typeof link.id === "string" ? link.id : link.link_id;
return html`
<et2-link slot="${this._get_row_id(link)}" app="${link.app}" entryId="${id}" statustext="${link.title}"
<et2-link app="${link.app}" entryId="${id}" statustext="${link.title}"
._parent=${this}
.value=${link}></et2-link>
${this._deleteButtonTemplate(link)}
@ -214,7 +252,7 @@ export class Et2LinkList extends Et2LinkString
return html`
<div id="${this._get_row_id(link)}"
@contextmenu=${this._handleRowContext}>
<slot name="${this._get_row_id(link)}"></slot>
${this._linkTemplate(link)}
</div>`;
}
@ -242,7 +280,24 @@ export class Et2LinkList extends Et2LinkString
{
if(_ev && typeof _ev.currentTarget)
{
this.get_links(_ev.detail || []);
// Add in new links from LinkTo
for(let link of <LinkInfo[]>Object.values(_ev.detail || []))
{
if(!this._link_list.some(l => l.app == link.app && l.id == link.id))
{
this._link_list.unshift(link);
}
}
// No need to ask server if we got it in the event
if(_ev.detail.length)
{
this.requestUpdate();
}
else
{
// Event didn't have it, need to ask
this.get_links();
}
}
}
@ -290,22 +345,27 @@ export class Et2LinkList extends Et2LinkString
*/
protected _delete_link(link : LinkInfo)
{
let link_element = <HTMLElement>this.querySelector("et2-link[slot='" + this._get_row_id(link) + "']");
let link_element = <HTMLElement>this.shadowRoot.querySelector("[id='" + this._get_row_id(link) + "']");
link_element.classList.add("loading");
this.dispatchEvent(new CustomEvent("et2-before-delete", {detail: link}));
let removeLink = () =>
{
this.querySelectorAll("[slot='" + this._get_row_id(link) + "']").forEach(e => e.remove());
this.shadowRoot.querySelectorAll("[id='" + this._get_row_id(link) + "']").forEach(e => e.remove());
if(this._link_list.indexOf(link) != -1)
{
this._link_list.splice(this._link_list.indexOf(link), 1);
this._totalResults--;
}
this.dispatchEvent(new CustomEvent("et2-delete", {bubbles: true, detail: link}));
let change = new Event("change", {bubbles: true});
change['data'] = link;
this.dispatchEvent(change);
this.requestUpdate();
this.updateComplete.then(() =>
{
this.dispatchEvent(new CustomEvent("et2-delete", {bubbles: true, detail: link}));
let change = new Event("change", {bubbles: true});
change['data'] = link;
this.dispatchEvent(change);
})
};
// Unsaved entry, had no ID yet

View File

@ -10,13 +10,14 @@
*/
import {css, html, LitElement, PropertyValues, render, TemplateResult} from "lit";
import {css, html, LitElement, nothing, PropertyValues, render, TemplateResult} from "lit";
import {until} from "lit/directives/until.js";
import {Et2Widget} from "../Et2Widget/Et2Widget";
import {LinkInfo} from "./Et2Link";
import {et2_IDetachedDOM} from "../et2_core_interfaces";
import {property} from "lit/decorators/property.js";
import {customElement} from "lit/decorators/custom-element.js";
import {repeat} from "lit/directives/repeat.js";
/**
* Display a list of entries in a comma separated list
@ -36,30 +37,30 @@ export class Et2LinkString extends Et2Widget(LitElement) implements et2_IDetache
return [
...super.styles,
css`
:host {
list-style-type: none;
display: inline;
padding: 0px;
}
:host {
list-style-type: none;
display: inline;
padding: 0px;
}
::slotted(*) {
display: inline;
}
et2-link, et2-link::part(base) {
display: inline;
}
::slotted(*):hover {
text-decoration: underline;
}
et2-link:hover {
text-decoration: underline;
}
/* CSS for child elements */
/* CSS for child elements */
::slotted(*):after {
content: ", "
}
et2-link::part(title):after {
content: ", "
}
::slotted(*:last-child):after {
content: initial;
}
et2-link:last-child::part(title):after {
content: initial;
}
`
];
}
@ -112,13 +113,14 @@ export class Et2LinkString extends Et2Widget(LitElement) implements et2_IDetache
@property({type: Number})
limit = 20;
protected _link_list : LinkInfo[];
protected _loadingPromise : Promise<LinkInfo[]>;
protected _totalResults : number = 0;
protected _link_list : LinkInfo[] = [];
protected _loadingPromise : Promise<LinkInfo[]> = Promise.resolve([]);
protected _loading = false;
constructor()
{
super();
this._link_list = []
}
async getUpdateComplete()
@ -144,6 +146,12 @@ export class Et2LinkString extends Et2Widget(LitElement) implements et2_IDetache
public set_value(_value : string | { to_app : string, to_id : string } | LinkInfo[])
{
this._link_list = [];
if(typeof _value["total"] !== "undefined")
{
this._totalResults = _value["total"];
delete _value["total"];
}
if(typeof _value == "object" && !Array.isArray(_value) && !_value.to_app && this.application)
{
_value.to_app = this.application;
@ -155,7 +163,12 @@ export class Et2LinkString extends Et2Widget(LitElement) implements et2_IDetache
{
this.application = _value.to_app;
this.entryId = _value.to_id;
this.get_links();
// Let update complete finish first, if it's not done yet
this.updateComplete.then(() =>
{
this.get_links();
})
return;
}
@ -166,9 +179,9 @@ export class Et2LinkString extends Et2Widget(LitElement) implements et2_IDetache
ids.forEach((id) => (<LinkInfo[]>this._link_list).push(<LinkInfo>{app: this.application, id: id}));
}
// List of LinkInfo
else if(Array.isArray(_value))
else if(Array.isArray(_value) || typeof _value[0] == "object")
{
this._link_list = _value;
this._link_list = <LinkInfo[]>Object.values(_value);
}
// List of LinkInfo stuffed into to_id - entry is not yet saved
else if(_value.to_id && typeof _value.to_id !== "string")
@ -179,8 +192,7 @@ export class Et2LinkString extends Et2Widget(LitElement) implements et2_IDetache
this._link_list.push(<LinkInfo>_value.to_id[key]);
});
}
this._addLinks(this._link_list);
super.requestUpdate();
this.requestUpdate();
}
public updated(changedProperties : PropertyValues)
@ -200,20 +212,21 @@ export class Et2LinkString extends Et2Widget(LitElement) implements et2_IDetache
{
// This shows loading template until loadingPromise resolves, then shows _listTemplate
return html`
${this._loadingPromise ? until(
this._loadingPromise?.then(res =>
${until(this._loadingPromise?.then(res =>
{
this._listTemplate();
return this._listTemplate();
}),
this._loadingTemplate()
) : this._listTemplate()}
)}
${until(this.moreResultsTemplate(), nothing)}
`;
}
protected _listTemplate()
{
return html`
<slot></slot>`;
${repeat(this._link_list, l => l.link_id, this._linkTemplate)}
`;
}
/**
@ -227,22 +240,9 @@ export class Et2LinkString extends Et2Widget(LitElement) implements et2_IDetache
{
const id = typeof link.id === "string" ? link.id : link.link_id;
return html`
<et2-link app="${link.app}" entryId="${id}" .value=${link} ._parent=${this}></et2-link>`;
}
/**
* Render "more links available"
*
* @param link
* @returns {TemplateResult}
* @protected
*/
protected _moreAvailableTemplate(link : LinkInfo) : TemplateResult
{
return html`
<et2-button image="${link.icon}" label="${link.title}" .onclick="${() => {
this.get_links();
}}" ._parent=${this} slot="link_exceeded"></et2-button>`;
<et2-link part="link" class="et2_link"
app="${link.app}" entryId="${id}" .value=${link} ._parent=${this}
></et2-link>`;
}
/**
@ -252,7 +252,25 @@ export class Et2LinkString extends Et2Widget(LitElement) implements et2_IDetache
*/
protected _loadingTemplate() : TemplateResult
{
return html`loading...`;
return html`
<div class="search__loading">
<sl-spinner></sl-spinner>
</div>
`;
}
protected async moreResultsTemplate()
{
if(this._totalResults <= 0 || !this._loadingPromise)
{
return nothing;
}
return this._loadingPromise.then(() =>
{
const moreCount = this._totalResults - this._link_list.length;
const more = this.egw().lang("%1 more...", moreCount);
return html`${moreCount > 0 ? more : nothing}`;
});
}
/**
@ -264,6 +282,7 @@ export class Et2LinkString extends Et2Widget(LitElement) implements et2_IDetache
*/
protected _addLinks(links : LinkInfo[])
{
return;
// Remove anything there right now
while(this.lastChild)
{
@ -273,7 +292,7 @@ export class Et2LinkString extends Et2Widget(LitElement) implements et2_IDetache
links.forEach((link) =>
{
let temp = document.createElement("div");
render(link.app === 'exceeded' ? this._moreAvailableTemplate(link) : this._linkTemplate(link), temp);
render(this._linkTemplate(link), temp);
temp.childNodes.forEach((node) => this.appendChild(node));
})
@ -297,8 +316,15 @@ export class Et2LinkString extends Et2Widget(LitElement) implements et2_IDetache
* Called internally to fetch the list. May be called externally to trigger a refresh if a link is added.
*
*/
public get_links(not_saved_links? : LinkInfo[])
public get_links(not_saved_links? : LinkInfo[], offset = 0)
{
if(this._loading)
{
// Already waiting
return;
}
this._loading = true;
if(typeof not_saved_links === "undefined")
{
not_saved_links = [];
@ -308,31 +334,31 @@ export class Et2LinkString extends Et2Widget(LitElement) implements et2_IDetache
to_id: this.entryId,
only_app: this.onlyApp,
show_deleted: this.showDeleted,
limit: this.limit
limit: [offset, /* num_rows: */this.limit]
};
this.limit *= 2; // double number of loaded links on next call
if(this._loadingPromise)
{
// Already waiting
return;
}
this._loadingPromise = <Promise<LinkInfo[]>>(this.egw().jsonq('EGroupware\\Api\\Etemplate\\Widget\\Link::ajax_link_list', [_value]))
.then(_value =>
{
if(_value && Array.isArray(_value))
if(typeof _value.total)
{
for(let link of <LinkInfo[]>_value)
this._totalResults = _value.total;
delete _value.total;
}
if(_value)
{
for(let link of <LinkInfo[]>Object.values(_value))
{
if(!not_saved_links.some(l => l.app == link.app && l.id == link.id))
// Avoid duplicates, files are always sent
if(!not_saved_links.some(l => l.app == link.app && l.id == link.id) &&
!this._link_list.some(l => l.app == link.app && l.id == link.id))
{
not_saved_links.push(link);
this._link_list.push(link);
}
}
}
this._addLinks(not_saved_links);
this._loadingPromise = null;
this._loading = false;
this.requestUpdate();
})
}

View File

@ -201,8 +201,8 @@ class Link extends Etemplate\Widget
$app = $value['to_app'];
$id = $value['to_id'];
$links = Api\Link::get_links($app, $id, $value['only_app'] ?? '', 'link_lastmod DESC', true, $value['show_deleted'], $value['limit'] ?? null);
$limit_exceeded = !empty($value['limit']) && Api\Link::$limit_exceeded;
$links = Api\Link::get_links($app, $id, $value['only_app'], 'link_lastmod DESC, link_id DESC', true, $value['show_deleted'], $value['limit']);
$only_links = [];
if($value['only_app'])
{
@ -244,19 +244,12 @@ class Link extends Etemplate\Widget
$link['help'] = lang('Remove this link (not the entry itself)');
}
}
if ($limit_exceeded)
{
$links[] = [
'app' => 'exceeded',
'id' => 'exceeded',
'title' => lang('Load more links ...'),
'icon' => 'box-arrow-down',
];
}
$response = Api\Json\Response::get();
// Strip keys, unneeded and cause index problems on the client side
$response->data(array_values($links));
$result = array_values($links);
$result['total'] = Api\Link\Storage::$row_count;
$response->data($result);
}
/**

View File

@ -497,7 +497,7 @@ class Link extends Link\Storage
* @param int $limit =null number of entries to return, only affects links, attachments are allways reported!
* @return array id => links pairs if $id is an array or just the links (only_app: ids) or empty array if no matching links found
*/
static function get_links($app, $id, $only_app='', $order='link_lastmod DESC',$cache_titles=false, $deleted=false, $limit=null)
static function get_links($app, $id, $only_app = '', $order = 'link_lastmod DESC, link_id DESC', $cache_titles = false, $deleted = false, $limit = null)
{
if (self::DEBUG) echo "<p>Link::get_links(app='$app',id='$id',only_app='$only_app',order='$order',deleted='$deleted')</p>\n";
@ -529,6 +529,7 @@ class Link extends Link\Storage
if (($vfs_ids = self::list_attached($app,$id)))
{
$ids += $vfs_ids;
self::$row_count += count($vfs_ids);
}
}
//echo "ids=<pre>"; print_r($ids); echo "</pre>\n";
@ -550,6 +551,7 @@ class Link extends Link\Storage
if(!self::title(is_array($link) ? $link['app'] : $only_app, is_array($link) ? $link['id'] : $link))
{
unset($ids[$key]);
self::$row_count--;
}
}
reset($ids);

View File

@ -47,6 +47,7 @@ class Storage
* True if call to get_links or get_3links exceeded limit (contains not all rows)
*/
public static $limit_exceeded = false;
public static int $row_count = 0;
/**
* creates a link between $app1,$id1 and $app2,$id2
@ -122,7 +123,7 @@ class Storage
* @param int|array $limit =null number of entries to return, default null = all or array(offset, num_rows) to return num_rows starting from offset
* @return array id => links pairs if $id is an array or just the links (only_app: ids) or empty array if no matching links found
*/
static function get_links($app, $id, $only_app='', $order='link_lastmod DESC', $deleted=false, $limit=null)
static function get_links($app, $id, $only_app = '', $order = 'link_lastmod DESC', $deleted = false, $limit = null)
{
if (self::DEBUG)
{
@ -132,7 +133,14 @@ class Storage
{
$only_app = substr($only_app,1);
}
$query = self::$db->expression(
self::TABLE, '((',
self::encodeRow(['link_app1' => $app, 'link_id1' => $id,]),
') OR (',
self::encodeRow(['link_app2' => $app, 'link_id2' => $id,]),
'))',
$deleted ? '' : ' AND deleted IS NULL'
);
$offset = false;
if (is_array($limit))
{
@ -142,18 +150,30 @@ class Storage
{
$offset = 0;
}
if($offset !== false) // need to get the total too
{
if(self::$db->Type == 'mysql' && (float)self::$db->ServerInfo['version'] >= 4.0)
{
$mysql_calc_rows = 'SQL_CALC_FOUND_ROWS ';
}
else // can't do a count, have to run the query without limit
{
self::$row_count = self::$db->select(
self::$table_name, '*', $query, __LINE__, __FILE__, false, $order ? " ORDER BY $order" : '', false, 0
)->NumRows();
}
}
$links = array();
try {
foreach(self::$db->select(self::TABLE, '*', self::$db->expression(self::TABLE, '((', self::encodeRow([
'link_app1' => $app,
'link_id1' => $id,
]), ') OR (', self::encodeRow([
'link_app2' => $app,
'link_id2' => $id,
]), '))',
$deleted ? '' : ' AND deleted IS NULL'
), __LINE__, __FILE__, $offset, $order ? " ORDER BY $order" : '', 'phpgwapi', $limit) as $row)
$rs = self::$db->select(self::TABLE, ($mysql_calc_rows ?? '') . '*', $query,
__LINE__, __FILE__, $offset, $order ? " ORDER BY $order" : '', 'phpgwapi', $limit
);
if(!empty($mysql_calc_rows))
{
self::$row_count = self::$db->query('SELECT FOUND_ROWS()')->fetchColumn();
}
foreach($rs as $row)
{
$row = self::decodeRow($row);

View File

@ -1274,7 +1274,7 @@ div.et2_link_entry input.ui-autocomplete-input {
padding-right: 0;
}
.et2_link, et2-link {
.et2_link, et2-link, et2-link-string {
cursor: pointer;
color: #003075;
text-decoration: none;