Skip to content

V15: Adds validation on date from/to inputs in the schedule modal #18437

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

Merged
iOvergaard merged 1 commit into from
Feb 25, 2025
Merged

V15: Adds validation on date from/to inputs in the schedule modal #18437

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
194 changes: 135 additions & 59 deletions .../documents/documents/publishing/schedule-publish/modal/document-schedule-modal.element.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { UmbDocumentVariantState, type UmbDocumentVariantOptionModel } from '../../../types.js';

Check notice on line 1 in src/Umbraco.Web.UI.Client/src/packages/documents/documents/publishing/schedule-publish/modal/document-schedule-modal.element.ts

View check run for this annotation

CodeScene Delta Analysis / CodeScene Cloud Delta Analysis (v15/dev)

✅ Getting better: String Heavy Function Arguments 

The ratio of strings in function arguments decreases from 41.18% to 40.00%, threshold = 39.0%. The functions in this file have a high ratio of strings as arguments. Avoid adding more.
import { isNotPublishedMandatory } from '../../utils.js';
import { UmbDocumentVariantLanguagePickerElement } from '../../../modals/index.js';
import type {
Expand All @@ -6,12 +6,13 @@
UmbDocumentScheduleModalValue,
UmbDocumentScheduleSelectionModel,
} from './document-schedule-modal.token.js';
import { css, customElement, html, repeat, state, when } from '@umbraco-cms/backoffice/external/lit';
import { css, customElement, html, ref, repeat, state, when } from '@umbraco-cms/backoffice/external/lit';
import { UmbModalBaseElement } from '@umbraco-cms/backoffice/modal';
import { UmbTextStyles } from '@umbraco-cms/backoffice/style';
import { UmbSelectionManager } from '@umbraco-cms/backoffice/utils';
import { umbBindToValidation, UmbValidationContext } from '@umbraco-cms/backoffice/validation';
import type { UmbInputDateElement } from '@umbraco-cms/backoffice/components';
import type { UUIBooleanInputElement } from '@umbraco-cms/backoffice/external/uui';
import type { UUIBooleanInputElement, UUIButtonState } from '@umbraco-cms/backoffice/external/uui';

@customElement('umb-document-schedule-modal')
export class UmbDocumentScheduleModalElement extends UmbModalBaseElement<
Expand All @@ -35,6 +36,11 @@
@state()
_internalValues: Array<UmbDocumentScheduleSelectionModel> = [];

@state()
private _submitButtonState?: UUIButtonState;

#validation = new UmbValidationContext(this);

#pickableFilter = (option: UmbDocumentVariantOptionModel) => {
if (isNotPublishedMandatory(option)) {
return true;
Expand Down Expand Up @@ -91,11 +97,20 @@
this.#selectionManager.setSelection(selected);
}

#submit() {
this.value = {
selection: this._internalValues,
};
this.modalContext?.submit();
async #submit() {
this._submitButtonState = 'waiting';
try {
await this.#validation.validate();
this._submitButtonState = 'success';
this.value = {
selection: this._internalValues,
};
this.modalContext?.submit();
} catch {
this._submitButtonState = 'failed';
} finally {
this._submitButtonState = undefined;
}
}

#close() {
Expand Down Expand Up @@ -146,6 +161,7 @@
<div slot="actions">
<uui-button label=${this.localize.term('general_close')} @click=${this.#close}></uui-button>
<uui-button
.state=${this._submitButtonState}
label="${this.localize.term('buttons_schedulePublish')}"
look="primary"
color="positive"
Expand Down Expand Up @@ -203,59 +219,115 @@
`;
}

#attachValidatorsToPublish(element: UmbInputDateElement | null) {
if (!element) return;

element.addValidator(
'badInput',
() => this.localize.term('speechBubbles_scheduleErrReleaseDate1'),
() => {
const value = element.value.toString();
if (!value) return false;
const date = new Date(value);
return date < new Date();
},
);
}

#attachValidatorsToUnpublish(element: UmbInputDateElement | null, unique: string) {
if (!element) return;

element.addValidator(
'badInput',
() => this.localize.term('speechBubbles_scheduleErrExpireDate1'),
() => {
const value = element.value.toString();
if (!value) return false;
const date = new Date(value);
return date < new Date();
},
);

element.addValidator(
'customError',
() => this.localize.term('speechBubbles_scheduleErrExpireDate2'),
() => {
const value = element.value.toString();
if (!value) return false;

// Check if the unpublish date is before the publish date
const variant = this._internalValues.find((s) => s.unique === unique);
if (!variant) return false;
const publishTime = variant.schedule?.publishTime;
if (!publishTime) return false;

const date = new Date(value);
const publishDate = new Date(publishTime);
return date < publishDate;
},
);
}

#renderPublishDateInput(option: UmbDocumentVariantOptionModel, fromDate: string | null, toDate: string | null) {
return html`<div class="publish-date">
<uui-form-layout-item>
<uui-label slot="label"><umb-localize key="content_releaseDate">Publish at</umb-localize></uui-label>
<div>
<umb-input-date
type="datetime-local"
.value=${this.#formatDate(fromDate)}
@change=${(e: Event) => this.#onFromDateChange(e, option.unique)}
label=${this.localize.term('general_publishDate')}>
<div slot="append">
${when(
fromDate,
() => html`
<uui-button
compact
label=${this.localize.term('general_clear')}
title=${this.localize.term('general_clear')}
@click=${() => this.#removeFromDate(option.unique)}>
<uui-icon name="remove"></uui-icon>
</uui-button>
`,
)}
</div>
</umb-input-date>
</div>
</uui-form-layout-item>
<uui-form-layout-item>
<uui-label slot="label"><umb-localize key="content_unpublishDate">Unpublish at</umb-localize></uui-label>
<div>
<umb-input-date
type="datetime-local"
.value=${this.#formatDate(toDate)}
@change=${(e: Event) => this.#onToDateChange(e, option.unique)}
label=${this.localize.term('general_publishDate')}>
<div slot="append">
${when(
toDate,
() => html`
<uui-button
compact
label=${this.localize.term('general_clear')}
title=${this.localize.term('general_clear')}
@click=${() => this.#removeToDate(option.unique)}>
<uui-icon name="remove"></uui-icon>
</uui-button>
`,
)}
</div>
</umb-input-date>
</div>
</uui-form-layout-item>
</div>`;
return html`
<div class="publish-date">
<uui-form-layout-item>
<uui-label slot="label"><umb-localize key="content_releaseDate">Publish at</umb-localize></uui-label>
<div>
<umb-input-date
${ref((e) => this.#attachValidatorsToPublish(e as UmbInputDateElement))}
${umbBindToValidation(this)}
type="datetime-local"
.value=${this.#formatDate(fromDate)}
@change=${(e: Event) => this.#onFromDateChange(e, option.unique)}
label=${this.localize.term('general_publishDate')}>
<div slot="append">
${when(
fromDate,
() => html`
<uui-button
compact
label=${this.localize.term('general_clear')}
title=${this.localize.term('general_clear')}
@click=${() => this.#removeFromDate(option.unique)}>
<uui-icon name="remove"></uui-icon>
</uui-button>
`,
)}
</div>
</umb-input-date>
</div>
</uui-form-layout-item>

<uui-form-layout-item>
<uui-label slot="label"><umb-localize key="content_unpublishDate">Unpublish at</umb-localize></uui-label>
<div>
<umb-input-date
${ref((e) => this.#attachValidatorsToUnpublish(e as UmbInputDateElement, option.unique))}
${umbBindToValidation(this)}
type="datetime-local"
.value=${this.#formatDate(toDate)}
@change=${(e: Event) => this.#onToDateChange(e, option.unique)}
label=${this.localize.term('general_publishDate')}>
<div slot="append">
${when(
toDate,
() => html`
<uui-button
compact
label=${this.localize.term('general_clear')}
title=${this.localize.term('general_clear')}
@click=${() => this.#removeToDate(option.unique)}>
<uui-icon name="remove"></uui-icon>
</uui-button>
`,
)}
</div>
</umb-input-date>
</div>
</uui-form-layout-item>
</div>
`;
}

#fromDate(unique: string): string | null {
Expand All @@ -275,6 +347,7 @@
...variant.schedule,
publishTime: null,
};
this.#validation.validate();

Check warning on line 350 in src/Umbraco.Web.UI.Client/src/packages/documents/documents/publishing/schedule-publish/modal/document-schedule-modal.element.ts

View check run for this annotation

CodeScene Delta Analysis / CodeScene Cloud Delta Analysis (v15/dev)

❌ New issue: Code Duplication 

The module contains 4 functions with similar structure: UmbDocumentScheduleModalElement.onFromDateChange,UmbDocumentScheduleModalElement.onToDateChange,UmbDocumentScheduleModalElement.removeFromDate,UmbDocumentScheduleModalElement.removeToDate. Avoid duplicated, aka copy-pasted, code inside the module. More duplication lowers the code health.
this.requestUpdate('_internalValues');
}

Expand All @@ -285,6 +358,7 @@
...variant.schedule,
unpublishTime: null,
};
this.#validation.validate();
this.requestUpdate('_internalValues');
}

Expand Down Expand Up @@ -325,6 +399,7 @@
...variant.schedule,
publishTime: this.#getDateValue(e),
};
this.#validation.validate();
this.requestUpdate('_internalValues');
}

Expand All @@ -335,6 +410,7 @@
...variant.schedule,
unpublishTime: this.#getDateValue(e),
};
this.#validation.validate();
this.requestUpdate('_internalValues');
}

Expand Down
Loading