yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

TextBox: Data-type validation for max chars (fixes #18817) (#20843)

Browse Source 
* configure max chars for textbox

* min 1

* Adds server-side check for text box min and max character validation.

* Applied suggestion from code review.

* Bumped version of test helper

* Fixed test that was creating a text string data type with too large a maximum characters setting.

---------

Co-authored-by: Andy Butland <abutland73@gmail.com>
Co-authored-by: Nhu Dinh <hnd@umbraco.dk>
This commit is contained in:
Niels Lyngsø
2025-11-18 08:16:59 +01:00
committed by GitHub
parent 92b5d11c95
commit c1b3f41f7c
7 changed files with 135 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/Umbraco.Core/PropertyEditors/TextboxConfigurationEditor.cs
View File

@@ -1,7 +1,8 @@
// Copyright (c) Umbraco.
// Copyright (c) Umbraco.
// See LICENSE for more details.
using Umbraco.Cms.Core.IO;
using Umbraco.Cms.Core.PropertyEditors.Validators;
namespace Umbraco.Cms.Core.PropertyEditors;
@@ -10,8 +11,17 @@ namespace Umbraco.Cms.Core.PropertyEditors;
/// </summary>
public class TextboxConfigurationEditor : ConfigurationEditor<TextboxConfiguration>
{
/// <summary>
/// Initializes a new instance of the <see cref="TextboxConfigurationEditor"/> class.
/// </summary>
public TextboxConfigurationEditor(IIOHelper ioHelper)
: base(ioHelper)
{
const int MinChars = 1;
const int MaxChars = 512;
Fields.Add(new ConfigurationField(new IntegerValidator(MinChars, MaxChars))
{
Key = "maxChars",
});
}
}

39
src/Umbraco.Core/PropertyEditors/Validators/IntegerValidator.cs
View File

@@ -5,19 +5,52 @@ using Umbraco.Extensions;
namespace Umbraco.Cms.Core.PropertyEditors.Validators;
/// <summary>
/// A validator that validates that the value is a valid integer
/// A validator that validates that the value is a valid integer.
/// </summary>
public sealed class IntegerValidator : IValueValidator
{
private readonly int? _minValue;
private readonly int? _maxValue;
/// <summary>
/// Initializes a new instance of the <see cref="IntegerValidator"/> class.
/// </summary>
public IntegerValidator()
{
}
/// <summary>
/// Initializes a new instance of the <see cref="IntegerValidator"/> class with minimum and/or maximum values.
/// </summary>
public IntegerValidator(int? minValue, int? maxValue)
{
_minValue = minValue;
_maxValue = maxValue;
}
/// <inheritdoc />
public IEnumerable<ValidationResult> Validate(object? value, string? valueType, object? dataTypeConfiguration, PropertyValidationContext validationContext)
{
if (value != null && value.ToString() != string.Empty)
if (value == null || value.ToString() == string.Empty)
{
yield break;
}
Attempt<int> result = value.TryConvertTo<int>();
if (result.Success == false)
{
yield return new ValidationResult("The value " + value + " is not a valid integer", new[] { "value" });
yield return new ValidationResult("The value " + value + " is not a valid integer", ["value"]);
}
else
{
if (_minValue.HasValue && result.Result < _minValue.Value)
{
yield return new ValidationResult("The value " + value + " is less than the minimum allowed value of " + _minValue.Value, ["value"]);
}
if (_maxValue.HasValue && result.Result > _maxValue.Value)
{
yield return new ValidationResult("The value " + value + " is greater than the maximum allowed value of " + _maxValue.Value, ["value"]);
}
}
}

6
src/Umbraco.Web.UI.Client/src/packages/property-editors/text-box/Umbraco.TextBox.ts
View File

@@ -11,8 +11,12 @@ export const manifest: ManifestPropertyEditorSchema = {
{
alias: 'maxChars',
label: 'Maximum allowed characters',
description: 'If empty, 512 character limit',
propertyEditorUiAlias: 'Umb.PropertyEditorUi.Integer',
config: [
{ alias: 'min', value: 1 },
{ alias: 'max', value: 512 },
{ alias: 'placeholder', value: '512' },
],
},
],
defaultData: [

8
tests/Umbraco.Tests.AcceptanceTest/package-lock.json generated
View File

@@ -8,7 +8,7 @@
"hasInstallScript": true,
"dependencies": {
"@umbraco/json-models-builders": "^2.0.42",
"@umbraco/playwright-testhelpers": "^17.0.8",
"@umbraco/playwright-testhelpers": "^17.0.9",
"camelize": "^1.0.0",
"dotenv": "^16.3.1",
"node-fetch": "^2.6.7"
@@ -67,9 +67,9 @@
}
},
"node_modules/@umbraco/playwright-testhelpers": {
"version": "17.0.8",
"resolved": "https://registry.npmjs.org/@umbraco/playwright-testhelpers/-/playwright-testhelpers-17.0.8.tgz",
"integrity": "sha512-LUVBdsweiS0WpE1F9YTQejmSxdtgEvbcmLHX57e2S2AbNkdVuR8cJ0rYd9TqSKtNU8ckwnk6YRtVikegU0D64w==",
"version": "17.0.9",
"resolved": "https://registry.npmjs.org/@umbraco/playwright-testhelpers/-/playwright-testhelpers-17.0.9.tgz",
"integrity": "sha512-8y2/Rjskhf5gcF+ebJfxUCCkHTcGmKQqtVMLg9hRKVjhI+3bs642+GJL0tK4MPvoSK64JhfiKmo+IhI5zrtokg==",
"license": "MIT",
"dependencies": {
"@umbraco/json-models-builders": "2.0.42",

2
tests/Umbraco.Tests.AcceptanceTest/package.json
View File

@@ -23,7 +23,7 @@
},
"dependencies": {
"@umbraco/json-models-builders": "^2.0.42",
"@umbraco/playwright-testhelpers": "^17.0.8",
"@umbraco/playwright-testhelpers": "^17.0.9",
"camelize": "^1.0.0",
"dotenv": "^16.3.1",
"node-fetch": "^2.6.7"

4
tests/Umbraco.Tests.AcceptanceTest/tests/DefaultConfig/DataType/DataType.spec.ts
View File

@@ -1,4 +1,4 @@
import {test} from '@umbraco/playwright-testhelpers';
import {test} from '@umbraco/playwright-testhelpers';
import {expect} from "@playwright/test";
const dataTypeName = 'TestDataType';
@@ -68,7 +68,7 @@ test('can change property editor in a data type', {tag: '@smoke'}, async ({umbra
const updatedEditorName = 'Text Area';
const updatedEditorAlias = 'Umbraco.TextArea';
const updatedEditorUiAlias = 'Umb.PropertyEditorUi.TextArea';
const maxChars = 999;
const maxChars = 500;
await umbracoApi.dataType.createTextstringDataType(dataTypeName, maxChars);
expect(await umbracoApi.dataType.doesNameExist(dataTypeName)).toBeTruthy();

74
tests/Umbraco.Tests.UnitTests/Umbraco.Core/PropertyEditors/Validators/IntegerValidatorTests.cs Normal file
View File

@@ -0,0 +1,74 @@
// Copyright (c) Umbraco.
// See LICENSE for more details.
using NUnit.Framework;
using Umbraco.Cms.Core.Models.Validation;
using Umbraco.Cms.Core.PropertyEditors;
using Umbraco.Cms.Core.PropertyEditors.Validators;
namespace Umbraco.Cms.Tests.UnitTests.Umbraco.Core.PropertyEditors.Validators;
[TestFixture]
public class IntegerValidatorTests
{
[TestCase(null, true)]
[TestCase("", true)]
[TestCase(" ", false)]
[TestCase("x", false)]
[TestCase("99", true)]
public void Validates_Integer(object? value, bool expectedSuccess)
{
var validator = CreateValidator();
var result = validator.Validate(value, ValueTypes.Integer, null, PropertyValidationContext.Empty());
if (expectedSuccess)
{
Assert.IsEmpty(result);
}
else
{
Assert.AreEqual(1, result.Count());
var validationResult = result.First();
Assert.IsTrue(validationResult.ErrorMessage.Contains("is not a valid integer"));
}
}
public enum RangeResult
{
Success,
BelowMin,
AboveMax,
}
[TestCase("5", RangeResult.BelowMin)]
[TestCase("10", RangeResult.Success)]
[TestCase("15", RangeResult.Success)]
[TestCase("20", RangeResult.Success)]
[TestCase("25", RangeResult.AboveMax)]
public void Validates_Integer_Within_Range(object? value, RangeResult expectedResult)
{
var validator = CreateValidator(10, 20);
var result = validator.Validate(value, ValueTypes.Integer, null, PropertyValidationContext.Empty());
if (expectedResult == RangeResult.Success)
{
Assert.IsEmpty(result);
}
else
{
Assert.AreEqual(1, result.Count());
var validationResult = result.First();
if (expectedResult == RangeResult.BelowMin)
{
Assert.IsTrue(validationResult.ErrorMessage.Contains("less than the minimum allowed value"));
}
else if (expectedResult == RangeResult.AboveMax)
{
Assert.IsTrue(validationResult.ErrorMessage.Contains("greater than the maximum allowed value"));
}
}
}
private static IntegerValidator CreateValidator(int? min = null, int? max = null) =>
min.HasValue is false && max.HasValue is false ? new IntegerValidator() : new IntegerValidator(min, max);
}