TF-320 Add capability validator for Jmap request
This commit is contained in:
Dat PHAM HOANG
committed by
Dat H. Pham
Dat H. Pham
parent
0d199b5c9a
commit
0c1d069856
@@ -0,0 +1,20 @@
|
||||
import 'package:jmap_dart_client/jmap/core/capability/capability_identifier.dart';
|
||||
import 'package:jmap_dart_client/jmap/core/session/session.dart';
|
||||
import 'package:tmail_ui_user/main/error/request_error.dart';
|
||||
|
||||
void requireCapability(Session session, List<CapabilityIdentifier> requiredCapabilities) {
|
||||
final matchedCapabilities = session.capabilities.keys
|
||||
.fold<Set<CapabilityIdentifier>>(
|
||||
Set<CapabilityIdentifier>(),
|
||||
(previousValue, element) {
|
||||
if (requiredCapabilities.contains(element)) {
|
||||
previousValue.add(element);
|
||||
}
|
||||
return previousValue;
|
||||
}
|
||||
);
|
||||
final missingCapabilities = requiredCapabilities.toSet().difference(matchedCapabilities);
|
||||
if (missingCapabilities.length > 0) {
|
||||
throw SessionMissingCapability(missingCapabilities);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
import 'package:equatable/equatable.dart';
|
||||
import 'package:jmap_dart_client/jmap/core/capability/capability_identifier.dart';
|
||||
|
||||
class SessionMissingCapability extends Equatable implements Exception {
|
||||
final Set<CapabilityIdentifier> capabilityIdentifiers;
|
||||
|
||||
SessionMissingCapability(this.capabilityIdentifiers);
|
||||
|
||||
@override
|
||||
List<Object?> get props => [capabilityIdentifiers];
|
||||
}
|
||||
@@ -0,0 +1,219 @@
|
||||
import 'package:flutter_test/flutter_test.dart';
|
||||
import 'package:jmap_dart_client/jmap/account_id.dart';
|
||||
import 'package:jmap_dart_client/jmap/core/account/account.dart';
|
||||
import 'package:jmap_dart_client/jmap/core/capability/capability_identifier.dart';
|
||||
import 'package:jmap_dart_client/jmap/core/capability/core_capability.dart';
|
||||
import 'package:jmap_dart_client/jmap/core/capability/default_capability.dart';
|
||||
import 'package:jmap_dart_client/jmap/core/capability/mail_capability.dart';
|
||||
import 'package:jmap_dart_client/jmap/core/capability/mdn_capability.dart';
|
||||
import 'package:jmap_dart_client/jmap/core/capability/submission_capability.dart';
|
||||
import 'package:jmap_dart_client/jmap/core/capability/vacation_capability.dart';
|
||||
import 'package:jmap_dart_client/jmap/core/capability/websocket_capability.dart';
|
||||
import 'package:jmap_dart_client/jmap/core/id.dart';
|
||||
import 'package:jmap_dart_client/jmap/core/session/session.dart';
|
||||
import 'package:jmap_dart_client/jmap/core/sort/collation_identifier.dart';
|
||||
import 'package:jmap_dart_client/jmap/core/state.dart';
|
||||
import 'package:jmap_dart_client/jmap/core/unsigned_int.dart';
|
||||
import 'package:jmap_dart_client/jmap/core/user_name.dart';
|
||||
import 'package:tmail_ui_user/main/error/capability_validator.dart';
|
||||
import 'package:tmail_ui_user/main/error/request_error.dart';
|
||||
|
||||
void main() {
|
||||
group('capability_validator_test', () {
|
||||
test('when session missing one capability exception should throw', () {
|
||||
final session = Session(
|
||||
{
|
||||
CapabilityIdentifier.jmapSubmission:
|
||||
SubmissionCapability(UnsignedInt(0), Set()),
|
||||
CapabilityIdentifier.jmapMail: MailCapability(
|
||||
UnsignedInt(10000000),
|
||||
null,
|
||||
UnsignedInt(200),
|
||||
UnsignedInt(20000000),
|
||||
{"receivedAt", "sentAt", "size", "from", "to", "subject"},
|
||||
true),
|
||||
CapabilityIdentifier.jmapWebSocket:
|
||||
WebSocketCapability(true, Uri.parse('ws://domain.com/jmap/ws')),
|
||||
CapabilityIdentifier(
|
||||
Uri.parse('urn:apache:james:params:jmap:mail:quota')):
|
||||
DefaultCapability(Map<String, dynamic>()),
|
||||
CapabilityIdentifier(
|
||||
Uri.parse('urn:apache:james:params:jmap:mail:shares')):
|
||||
DefaultCapability(Map<String, dynamic>()),
|
||||
CapabilityIdentifier.jmapVacationResponse: VacationCapability(),
|
||||
CapabilityIdentifier.jmapMdn: MdnCapability()
|
||||
},
|
||||
{
|
||||
AccountId(Id(
|
||||
'29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6')):
|
||||
Account(AccountName('bob@domain.tld'), true, false, {
|
||||
CapabilityIdentifier.jmapSubmission:
|
||||
SubmissionCapability(UnsignedInt(0), Set()),
|
||||
CapabilityIdentifier.jmapWebSocket: WebSocketCapability(
|
||||
true, Uri.parse('ws://domain.com/jmap/ws')),
|
||||
CapabilityIdentifier.jmapCore: CoreCapability(
|
||||
UnsignedInt(20971520),
|
||||
UnsignedInt(4),
|
||||
UnsignedInt(10000000),
|
||||
UnsignedInt(4),
|
||||
UnsignedInt(16),
|
||||
UnsignedInt(500),
|
||||
UnsignedInt(500),
|
||||
{CollationIdentifier("i;unicode-casemap")}),
|
||||
CapabilityIdentifier.jmapMail: MailCapability(
|
||||
UnsignedInt(10000000),
|
||||
null,
|
||||
UnsignedInt(200),
|
||||
UnsignedInt(20000000),
|
||||
{"receivedAt", "sentAt", "size", "from", "to", "subject"},
|
||||
true),
|
||||
CapabilityIdentifier(
|
||||
Uri.parse('urn:apache:james:params:jmap:mail:quota')):
|
||||
DefaultCapability(Map<String, dynamic>()),
|
||||
CapabilityIdentifier(
|
||||
Uri.parse('urn:apache:james:params:jmap:mail:shares')):
|
||||
DefaultCapability(Map<String, dynamic>()),
|
||||
CapabilityIdentifier.jmapVacationResponse: VacationCapability(),
|
||||
CapabilityIdentifier.jmapMdn: MdnCapability()
|
||||
})
|
||||
},
|
||||
{
|
||||
CapabilityIdentifier.jmapSubmission: AccountId(Id(
|
||||
'29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6')),
|
||||
CapabilityIdentifier.jmapWebSocket: AccountId(Id(
|
||||
'29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6')),
|
||||
CapabilityIdentifier.jmapCore: AccountId(Id(
|
||||
'29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6')),
|
||||
CapabilityIdentifier.jmapMail: AccountId(Id(
|
||||
'29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6')),
|
||||
CapabilityIdentifier(
|
||||
Uri.parse(
|
||||
'urn:apache:james:params:jmap:mail:quota')): AccountId(Id(
|
||||
'29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6')),
|
||||
CapabilityIdentifier(
|
||||
Uri.parse(
|
||||
'urn:apache:james:params:jmap:mail:shares')): AccountId(Id(
|
||||
'29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6')),
|
||||
CapabilityIdentifier.jmapVacationResponse: AccountId(Id(
|
||||
'29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6')),
|
||||
CapabilityIdentifier.jmapMdn: AccountId(Id(
|
||||
'29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6')),
|
||||
},
|
||||
UserName('bob@domain.tld'),
|
||||
Uri.parse('http://domain.com/jmap'),
|
||||
Uri.parse(
|
||||
'http://domain.com/download/{accountId}/{blobId}/?type={type}&name={name}'),
|
||||
Uri.parse('http://domain.com/upload/{accountId}'),
|
||||
Uri.parse(
|
||||
'http://domain.com/eventSource?types={types}&closeAfter={closeafter}&ping={ping}'),
|
||||
State('2c9f1b12-b35a-43e6-9af2-0106fb53a943'));
|
||||
expect(
|
||||
() => requireCapability(session, [CapabilityIdentifier.jmapCore, CapabilityIdentifier.jmapMail]),
|
||||
throwsA(TypeMatcher<SessionMissingCapability>()));
|
||||
});
|
||||
|
||||
test('when session have all required capabilities exception should throw', () {
|
||||
final session = Session(
|
||||
{
|
||||
CapabilityIdentifier.jmapSubmission:
|
||||
SubmissionCapability(UnsignedInt(0), Set()),
|
||||
CapabilityIdentifier.jmapCore: CoreCapability(
|
||||
UnsignedInt(20971520),
|
||||
UnsignedInt(4),
|
||||
UnsignedInt(10000000),
|
||||
UnsignedInt(4),
|
||||
UnsignedInt(16),
|
||||
UnsignedInt(500),
|
||||
UnsignedInt(500),
|
||||
{CollationIdentifier("i;unicode-casemap")}
|
||||
),
|
||||
CapabilityIdentifier.jmapMail: MailCapability(
|
||||
UnsignedInt(10000000),
|
||||
null,
|
||||
UnsignedInt(200),
|
||||
UnsignedInt(20000000),
|
||||
{"receivedAt", "sentAt", "size", "from", "to", "subject"},
|
||||
true),
|
||||
CapabilityIdentifier.jmapWebSocket:
|
||||
WebSocketCapability(true, Uri.parse('ws://domain.com/jmap/ws')),
|
||||
CapabilityIdentifier(
|
||||
Uri.parse('urn:apache:james:params:jmap:mail:quota')):
|
||||
DefaultCapability(Map<String, dynamic>()),
|
||||
CapabilityIdentifier(
|
||||
Uri.parse('urn:apache:james:params:jmap:mail:shares')):
|
||||
DefaultCapability(Map<String, dynamic>()),
|
||||
CapabilityIdentifier.jmapVacationResponse: VacationCapability(),
|
||||
CapabilityIdentifier.jmapMdn: MdnCapability()
|
||||
},
|
||||
{
|
||||
AccountId(Id(
|
||||
'29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6')):
|
||||
Account(AccountName('bob@domain.tld'), true, false, {
|
||||
CapabilityIdentifier.jmapSubmission:
|
||||
SubmissionCapability(UnsignedInt(0), Set()),
|
||||
CapabilityIdentifier.jmapWebSocket: WebSocketCapability(
|
||||
true, Uri.parse('ws://domain.com/jmap/ws')),
|
||||
CapabilityIdentifier.jmapCore: CoreCapability(
|
||||
UnsignedInt(20971520),
|
||||
UnsignedInt(4),
|
||||
UnsignedInt(10000000),
|
||||
UnsignedInt(4),
|
||||
UnsignedInt(16),
|
||||
UnsignedInt(500),
|
||||
UnsignedInt(500),
|
||||
{CollationIdentifier("i;unicode-casemap")}),
|
||||
CapabilityIdentifier.jmapMail: MailCapability(
|
||||
UnsignedInt(10000000),
|
||||
null,
|
||||
UnsignedInt(200),
|
||||
UnsignedInt(20000000),
|
||||
{"receivedAt", "sentAt", "size", "from", "to", "subject"},
|
||||
true),
|
||||
CapabilityIdentifier(
|
||||
Uri.parse('urn:apache:james:params:jmap:mail:quota')):
|
||||
DefaultCapability(Map<String, dynamic>()),
|
||||
CapabilityIdentifier(
|
||||
Uri.parse('urn:apache:james:params:jmap:mail:shares')):
|
||||
DefaultCapability(Map<String, dynamic>()),
|
||||
CapabilityIdentifier.jmapVacationResponse: VacationCapability(),
|
||||
CapabilityIdentifier.jmapMdn: MdnCapability()
|
||||
})
|
||||
},
|
||||
{
|
||||
CapabilityIdentifier.jmapSubmission: AccountId(Id(
|
||||
'29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6')),
|
||||
CapabilityIdentifier.jmapWebSocket: AccountId(Id(
|
||||
'29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6')),
|
||||
CapabilityIdentifier.jmapCore: AccountId(Id(
|
||||
'29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6')),
|
||||
CapabilityIdentifier.jmapMail: AccountId(Id(
|
||||
'29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6')),
|
||||
CapabilityIdentifier(
|
||||
Uri.parse(
|
||||
'urn:apache:james:params:jmap:mail:quota')): AccountId(Id(
|
||||
'29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6')),
|
||||
CapabilityIdentifier(
|
||||
Uri.parse(
|
||||
'urn:apache:james:params:jmap:mail:shares')): AccountId(Id(
|
||||
'29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6')),
|
||||
CapabilityIdentifier.jmapVacationResponse: AccountId(Id(
|
||||
'29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6')),
|
||||
CapabilityIdentifier.jmapMdn: AccountId(Id(
|
||||
'29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6')),
|
||||
},
|
||||
UserName('bob@domain.tld'),
|
||||
Uri.parse('http://domain.com/jmap'),
|
||||
Uri.parse(
|
||||
'http://domain.com/download/{accountId}/{blobId}/?type={type}&name={name}'),
|
||||
Uri.parse('http://domain.com/upload/{accountId}'),
|
||||
Uri.parse(
|
||||
'http://domain.com/eventSource?types={types}&closeAfter={closeafter}&ping={ping}'),
|
||||
State('2c9f1b12-b35a-43e6-9af2-0106fb53a943')
|
||||
);
|
||||
|
||||
expect(
|
||||
() => requireCapability(session, [CapabilityIdentifier.jmapCore, CapabilityIdentifier.jmapMail]),
|
||||
returnsNormally);
|
||||
});
|
||||
});
|
||||
}
|
||||
Reference in New Issue
Block a user