Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hotfix: Don't request urls every time the document name updates #17710

Merged
merged 4 commits into from
Dec 4, 2024
Merged

Hotfix: Don't request urls every time the document name updates #17710

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4a5ba32
split observables so we don't request url when variantsOptions changes
madsrasmussen Dec 3, 2024
09a38bd
clean up events + debounce requests
madsrasmussen Dec 3, 2024
b57eef5
add loading state
madsrasmussen Dec 3, 2024
953461c
clear lookup before requesting new urls
madsrasmussen Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 85 additions & 21 deletions ...es/documents/documents/workspace/views/info/document-workspace-view-info-links.element.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@ import { UMB_DOCUMENT_WORKSPACE_CONTEXT } from '../../document-workspace.context
import type { UmbDocumentVariantOptionModel } from '../../../types.js';
import { css, customElement, html, map, nothing, state, when } from '@umbraco-cms/backoffice/external/lit';
import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
import type { UmbEntityActionEvent } from '@umbraco-cms/backoffice/entity-action';
import { UmbRequestReloadStructureForEntityEvent } from '@umbraco-cms/backoffice/entity-action';
import { UMB_ACTION_EVENT_CONTEXT } from '@umbraco-cms/backoffice/action';
import { observeMultiple } from '@umbraco-cms/backoffice/observable-api';
import { DocumentVariantStateModel } from '@umbraco-cms/backoffice/external/backend-api';
import { debounce } from '@umbraco-cms/backoffice/utils';

@customElement('umb-document-workspace-view-info-links')
export class UmbDocumentWorkspaceViewInfoLinksElement extends UmbLitElement {
Expand All @@ -24,46 +26,69 @@ export class UmbDocumentWorkspaceViewInfoLinksElement extends UmbLitElement {
@state()
private _lookup: Record<string, string[]> = {};

@state()
private _loading = false;

#documentWorkspaceContext?: typeof UMB_DOCUMENT_WORKSPACE_CONTEXT.TYPE;
#eventContext?: typeof UMB_ACTION_EVENT_CONTEXT.TYPE;

constructor() {
super();

this.consumeContext(UMB_ACTION_EVENT_CONTEXT, (context) => {
context.addEventListener(UmbRequestReloadStructureForEntityEvent.TYPE, () => {
this.#requestUrls();
});
this.#eventContext = context;

this.#eventContext.removeEventListener(
UmbRequestReloadStructureForEntityEvent.TYPE,
this.#onReloadRequest as unknown as EventListener,
);

this.#eventContext.addEventListener(
UmbRequestReloadStructureForEntityEvent.TYPE,
this.#onReloadRequest as unknown as EventListener,
);
});

this.consumeContext(UMB_DOCUMENT_WORKSPACE_CONTEXT, (context) => {
this.observe(
observeMultiple([context.isNew, context.unique, context.variantOptions]),
([isNew, unique, variantOptions]) => {
if (!unique) return;
this._isNew = isNew === true;
this.#documentWorkspaceContext = context;
this.observe(observeMultiple([context.isNew, context.unique]), ([isNew, unique]) => {
if (!unique) return;
this._isNew = isNew === true;

if (unique !== this._unique) {
this._unique = unique;
this._variantOptions = variantOptions;
this.#requestUrls();
},
);
}
});

this.observe(context.variantOptions, (variantOptions) => (this._variantOptions = variantOptions));
});
}

async #requestUrls() {
if (this._isNew) return;
if (!this._unique) return;

this._loading = true;
this._lookup = {};

const { data } = await this.#documentUrlRepository.requestItems([this._unique]);

if (data?.length) {
data[0].urls.forEach((item) => {
const item = data[0];

item.urls.forEach((item) => {
if (item.culture && item.url) {
if(this._lookup[item.culture] == null){
if (this._lookup[item.culture] == null) {
this._lookup[item.culture] = [];
}
this._lookup[item.culture].push(item.url);
}
});
this.requestUpdate('_lookup');
}

this._loading = false;
}

#getStateLocalizationKey(variantOption: UmbDocumentVariantOptionModel) {
Expand All @@ -81,18 +106,41 @@ export class UmbDocumentWorkspaceViewInfoLinksElement extends UmbLitElement {
}
}

#debounceRequestUrls = debounce(() => this.#requestUrls(), 50);

#onReloadRequest = (event: UmbEntityActionEvent) => {
// TODO: Introduce "Published Event". We only need to update the url when the document is published.
if (event.getUnique() !== this.#documentWorkspaceContext?.getUnique()) return;
if (event.getEntityType() !== this.#documentWorkspaceContext.getEntityType()) return;
this.#debounceRequestUrls();
};

override render() {
return html`
<uui-box headline=${this.localize.term('general_links')}>
${when(
this._isNew,
() => this.#renderNotCreated(),
() => this.#renderUrls(),
this._loading,
() => this.#renderLoading(),
() => this.#renderContent(),
)}
</uui-box>
`;
}

#renderLoading() {
return html`<div id="loader-container"><uui-loader></uui-loader></div>`;
}

#renderContent() {
return html`
${when(
this._isNew,
() => this.#renderNotCreated(),
() => this.#renderUrls(),
)}
`;
}

#renderNotCreated() {
return html`
<div class="link-item">
Expand All @@ -114,16 +162,16 @@ export class UmbDocumentWorkspaceViewInfoLinksElement extends UmbLitElement {
const urls = this._lookup[culture];
return when(
urls && urls.length >= 1,
() => html`
${urls.map((url) =>
html`
<a class="link-item" href=${url} target="_blank">
() =>
html` ${urls.map(
(url) =>
html` <a class="link-item" href=${url} target="_blank">
<span>
<span class="culture">${varies ? culture : nothing}</span>
<span>${url}</span>
</span>
<uui-icon name="icon-out"></uui-icon>
</a>`
</a>`,
)}`,
() => html`
<div class="link-item">
Expand All @@ -136,12 +184,28 @@ export class UmbDocumentWorkspaceViewInfoLinksElement extends UmbLitElement {
);
}

override disconnectedCallback(): void {
super.disconnectedCallback();

this.#eventContext?.removeEventListener(
UmbRequestReloadStructureForEntityEvent.TYPE,
this.#onReloadRequest as unknown as EventListener,
);
}

static override styles = [
css`
uui-box {
--uui-box-default-padding: 0;
}

#loader-container {
display: flex;
justify-content: center;
align-items: center;
padding: var(--uui-size-space-2);
}

.link-item {
display: flex;
justify-content: space-between;
Expand Down
Loading