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

compose: Enforce max topic/content length by code points, following API #1239

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

compose: Enforce max topic/content length by code points, following API #1239

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
eaff325
compose [nfc]: Add a TODO(#1238)
chrisbobbe Dec 30, 2024
10e78de
compose [nfc]: Comment on max-topic-length check about cutting off short
chrisbobbe Dec 30, 2024
fa09289
compose test [nfc]: Give enterTopic a dartdoc
chrisbobbe Dec 30, 2024
f4c5ff3
test [nfc]: Factor out `checkNoErrorDialog` helper
chrisbobbe Dec 30, 2024
3708cb4
compose test: Test topic- and content-max-length validation errors
chrisbobbe Dec 30, 2024
e18196d
compose: Enforce max topic/content length by code points, following API
chrisbobbe Dec 30, 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
46 changes: 36 additions & 10 deletions lib/widgets/compose_box.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,30 @@ const double _composeButtonSize = 44;
///
/// Subclasses must ensure that [_update] is called in all exposed constructors.
abstract class ComposeController<ErrorT> extends TextEditingController {
int get maxLengthUnicodeCodePoints;

String get textNormalized => _textNormalized;
late String _textNormalized;
String _computeTextNormalized();

/// Length of [textNormalized] in Unicode code points,
/// if it might exceed [maxLengthUnicodeCodePoints], else null.
///
/// Use this instead of [String.length]
/// to enforce a max length expressed in code points.
/// [String.length] is conservative and may cut the user off too short.
///
/// Counting code points ([String.runes])
/// is more expensive than getting the number of UTF-16 code units
/// ([String.length]), so we avoid it when the result definitely won't exceed
/// [maxLengthUnicodeCodePoints].
int? get lengthUnicodeCodePointsIfLong => _lengthUnicodeCodePointsIfLong;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if we maintain the length internally, and expose only a method that tests if the content is too long? We already have access to the length limit via maxLengthUnicodeCodePoints and hiding this cache might simplify the checks a bit.

late int? _lengthUnicodeCodePointsIfLong;
int? _computeLengthUnicodeCodePointsIfLong() =>
_textNormalized.length > maxLengthUnicodeCodePoints
? _textNormalized.runes.length
: null;

List<ErrorT> get validationErrors => _validationErrors;
late List<ErrorT> _validationErrors;
List<ErrorT> _computeValidationErrors();
Expand All @@ -40,6 +60,8 @@ abstract class ComposeController<ErrorT> extends TextEditingController {

void _update() {
_textNormalized = _computeTextNormalized();
// uses _textNormalized, so comes after _computeTextNormalized()
_lengthUnicodeCodePointsIfLong = _computeLengthUnicodeCodePointsIfLong();
_validationErrors = _computeValidationErrors();
hasValidationErrors.value = _validationErrors.isNotEmpty;
}
Expand Down Expand Up @@ -74,6 +96,9 @@ class ComposeTopicController extends ComposeController<TopicValidationError> {
// https://zulip.com/help/require-topics
final mandatory = true;

// TODO(#307) use `max_topic_length` instead of hardcoded limit
@override final maxLengthUnicodeCodePoints = kMaxTopicLengthCodePoints;

@override
String _computeTextNormalized() {
String trimmed = text.trim();
Expand All @@ -86,11 +111,10 @@ class ComposeTopicController extends ComposeController<TopicValidationError> {
if (mandatory && textNormalized == kNoTopicTopic)
TopicValidationError.mandatoryButEmpty,

// textNormalized.length is the number of UTF-16 code units, while the server
// API expresses the max in Unicode code points. So this comparison will
// be conservative and may cut the user off shorter than necessary.
// TODO(#1238) stop cutting off shorter than necessary
if (textNormalized.length > kMaxTopicLengthCodePoints)
if (
lengthUnicodeCodePointsIfLong != null
&& lengthUnicodeCodePointsIfLong! > maxLengthUnicodeCodePoints
)
TopicValidationError.tooLong,
];
}
Expand Down Expand Up @@ -121,6 +145,9 @@ class ComposeContentController extends ComposeController<ContentValidationError>
_update();
}

// TODO(#1237) use `max_message_length` instead of hardcoded limit
@override final maxLengthUnicodeCodePoints = kMaxMessageLengthCodePoints;

int _nextQuoteAndReplyTag = 0;
int _nextUploadTag = 0;

Expand Down Expand Up @@ -262,11 +289,10 @@ class ComposeContentController extends ComposeController<ContentValidationError>
if (textNormalized.isEmpty)
ContentValidationError.empty,

// normalized.length is the number of UTF-16 code units, while the server
// API expresses the max in Unicode code points. So this comparison will
// be conservative and may cut the user off shorter than necessary.
// TODO(#1238) stop cutting off shorter than necessary
if (textNormalized.length > kMaxMessageLengthCodePoints)
if (
lengthUnicodeCodePointsIfLong != null
&& lengthUnicodeCodePointsIfLong! > maxLengthUnicodeCodePoints
)
ContentValidationError.tooLong,

if (_quoteAndReplies.isNotEmpty)
Expand Down
38 changes: 26 additions & 12 deletions test/widgets/compose_box_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,13 +259,20 @@ void main() {
doTest('too-long content is rejected',
content: makeStringWithCodePoints(kMaxMessageLengthCodePoints + 1), expectError: true);

// TODO(#1238) unskip
// doTest('max-length content not rejected',
// content: makeStringWithCodePoints(kMaxMessageLengthCodePoints), expectError: false);
doTest('max-length content not rejected',
content: makeStringWithCodePoints(kMaxMessageLengthCodePoints), expectError: false);

// TODO(#1238) replace with above commented-out test
doTest('some content not rejected',
content: 'a' * kMaxMessageLengthCodePoints, expectError: false);
testWidgets('code points not counted unnecessarily', (tester) async {
TypingNotifier.debugEnable = false;
addTearDown(TypingNotifier.debugReset);

final narrow = ChannelNarrow(channel.streamId);
await prepareComposeBox(tester, narrow: narrow, streams: [channel]);
await enterTopic(tester, narrow: narrow, topic: 'some topic');
await enterContent(tester, narrow: narrow, content: 'a' * kMaxMessageLengthCodePoints);

check(controller!.content.lengthUnicodeCodePointsIfLong).isNull();
});
});

group('topic', () {
Expand Down Expand Up @@ -293,13 +300,20 @@ void main() {
doTest('too-long topic is rejected',
topic: makeStringWithCodePoints(kMaxTopicLengthCodePoints + 1), expectError: true);

// TODO(#1238) unskip
// doTest('max-length topic not rejected',
// topic: makeStringWithCodePoints(kMaxTopicLengthCodePoints), expectError: false);
doTest('max-length topic not rejected',
topic: makeStringWithCodePoints(kMaxTopicLengthCodePoints), expectError: false);

// TODO(#1238) replace with above commented-out test
doTest('some topic not rejected',
topic: 'a' * kMaxTopicLengthCodePoints, expectError: false);
testWidgets('code points not counted unnecessarily', (tester) async {
TypingNotifier.debugEnable = false;
addTearDown(TypingNotifier.debugReset);

final narrow = ChannelNarrow(channel.streamId);
await prepareComposeBox(tester, narrow: narrow, streams: [channel]);
await enterTopic(tester, narrow: narrow, topic: 'a' * kMaxTopicLengthCodePoints);
await enterContent(tester, narrow: narrow, content: 'some content');

check((controller as StreamComposeBoxController).topic.lengthUnicodeCodePointsIfLong).isNull();
});
});
});

Expand Down