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

fix(dynamite): Fix nullable someOf parameters #1272

Merged
merged 1 commit into from
Dec 17, 2023
Merged

fix(dynamite): Fix nullable someOf parameters #1272

Show file tree
Hide file tree
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
5 changes: 4 additions & 1 deletion packages/dynamite/dynamite/lib/src/models/type_result/some_of.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,10 @@ abstract class TypeResultSomeOf extends TypeResult {
return '$dartType $fieldName';
});

return TypeResultBase('({${record.join(',')}})');
return TypeResultBase(
'({${record.join(',')}})',
nullable: nullable,
);
}

late final String typeName = _typeName;
Expand Down
83 changes: 81 additions & 2 deletions packages/dynamite/dynamite_end_to_end_test/lib/parameters.openapi.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import 'package:built_value/standard_json_plugin.dart';
import 'package:dynamite_runtime/built_value.dart';
import 'package:dynamite_runtime/http_client.dart';
import 'package:dynamite_runtime/models.dart';
import 'package:dynamite_runtime/utils.dart' as dynamite_utils;
import 'package:meta/meta.dart';
import 'package:universal_io/io.dart';
import 'package:uri/uri.dart';
Expand Down Expand Up @@ -48,6 +49,8 @@ class Client extends DynamiteClient {
/// * [$double]
/// * [$num]
/// * [object]
/// * [oneOf]
/// * [anyOf]
///
/// Status codes:
/// * 200
Expand All @@ -65,6 +68,8 @@ class Client extends DynamiteClient {
final double? $double,
final num? $num,
final JsonObject? object,
final GetOneOf? oneOf,
final GetAnyOf? anyOf,
}) async {
final rawResponse = $getRaw(
contentString: contentString,
Expand All @@ -77,6 +82,8 @@ class Client extends DynamiteClient {
$double: $double,
$num: $num,
object: object,
oneOf: oneOf,
anyOf: anyOf,
);

return rawResponse.future;
Expand All @@ -98,6 +105,8 @@ class Client extends DynamiteClient {
/// * [$double]
/// * [$num]
/// * [object]
/// * [oneOf]
/// * [anyOf]
///
/// Status codes:
/// * 200
Expand All @@ -116,6 +125,8 @@ class Client extends DynamiteClient {
final double? $double,
final num? $num,
final JsonObject? object,
final GetOneOf? oneOf,
final GetAnyOf? anyOf,
}) {
final parameters = <String, dynamic>{};
final headers = <String, String>{
Expand Down Expand Up @@ -163,9 +174,15 @@ class Client extends DynamiteClient {
final $object = jsonSerializers.serialize(object, specifiedType: const FullType(JsonObject));
parameters['object'] = $object;

final $oneOf = jsonSerializers.serialize(oneOf, specifiedType: const FullType(GetOneOf));
parameters['oneOf'] = $oneOf;

final $anyOf = jsonSerializers.serialize(anyOf, specifiedType: const FullType(GetAnyOf));
parameters['anyOf'] = $anyOf;

final uri = Uri.parse(
UriTemplate(
'/{?content_string*,content_parameter*,array*,bool*,string*,string_binary*,int*,double*,num*,object*}',
'/{?content_string*,content_parameter*,array*,bool*,string*,string_binary*,int*,double*,num*,object*,oneOf*,anyOf*}',
).expand(parameters),
);
return DynamiteRawResponse<JsonObject, void>(
Expand Down Expand Up @@ -349,6 +366,67 @@ class Client extends DynamiteClient {
}
}

typedef GetOneOf = ({bool? $bool, String? string});

typedef GetAnyOf = ({bool? $bool, String? string});

typedef $BoolString = ({bool? $bool, String? string});

extension $BoolStringExtension on $BoolString {
List<dynamic> get _values => [$bool, string];
void validateOneOf() => dynamite_utils.validateOneOf(_values);
void validateAnyOf() => dynamite_utils.validateAnyOf(_values);
static Serializer<$BoolString> get serializer => const _$BoolStringSerializer();
static $BoolString fromJson(final Object? json) => jsonSerializers.deserializeWith(serializer, json)!;
Object? toJson() => jsonSerializers.serializeWith(serializer, this);
}

class _$BoolStringSerializer implements PrimitiveSerializer<$BoolString> {
const _$BoolStringSerializer();

@override
Iterable<Type> get types => const [$BoolString];

@override
String get wireName => r'$BoolString';

@override
Object serialize(
final Serializers serializers,
final $BoolString object, {
final FullType specifiedType = FullType.unspecified,
}) {
dynamic value;
value = object.$bool;
if (value != null) {
return serializers.serialize(value, specifiedType: const FullType(bool))!;
}
value = object.string;
if (value != null) {
return serializers.serialize(value, specifiedType: const FullType(String))!;
}
// Should not be possible after validation.
throw StateError('Tried to serialize without any value.');
}

@override
$BoolString deserialize(
final Serializers serializers,
final Object data, {
final FullType specifiedType = FullType.unspecified,
}) {
bool? $bool;
try {
$bool = serializers.deserialize(data, specifiedType: const FullType(bool))! as bool;
} catch (_) {}
String? string;
try {
string = serializers.deserialize(data, specifiedType: const FullType(String))! as String;
} catch (_) {}
return ($bool: $bool, string: string);
}
}

// coverage:ignore-start
@visibleForTesting
final Serializers serializers = (Serializers().toBuilder()
Expand All @@ -363,7 +441,8 @@ final Serializers serializers = (Serializers().toBuilder()
ContentStringBuilder<BuiltMap<String, JsonObject>>.new,
)
..add(ContentString.serializer)
..addBuilderFactory(const FullType(BuiltList, [FullType(String)]), ListBuilder<String>.new))
..addBuilderFactory(const FullType(BuiltList, [FullType(String)]), ListBuilder<String>.new)
..add($BoolStringExtension.serializer))
.build();

@visibleForTesting
Expand Down
28 changes: 28 additions & 0 deletions packages/dynamite/dynamite_end_to_end_test/lib/parameters.openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,34 @@
"schema": {
"type": "object"
}
},
{
"name": "oneOf",
"in": "query",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
}
},
{
"name": "anyOf",
"in": "query",
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
}
}
],
"responses": {
Expand Down
56 changes: 56 additions & 0 deletions packages/dynamite/dynamite_end_to_end_test/test/parameters_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,62 @@ void main() {
]),
);
});
test('oneOf', () async {
await client.$get(oneOf: ($bool: true, string: null));
var captured = verify(mockHttpClient.openUrl(captureAny, captureAny)).captured;
expect(
captured,
equals([
'get',
Uri.parse('example.com/?oneOf=true'),
]),
);
resetMockitoState();

await client.$get(oneOf: ($bool: null, string: 'value'));
captured = verify(mockHttpClient.openUrl(captureAny, captureAny)).captured;
expect(
captured,
equals([
'get',
Uri.parse('example.com/?oneOf=value'),
]),
);
});

test('anyOf', () async {
await client.$get(anyOf: ($bool: true, string: null));
var captured = verify(mockHttpClient.openUrl(captureAny, captureAny)).captured;
expect(
captured,
equals([
'get',
Uri.parse('example.com/?anyOf=true'),
]),
);
resetMockitoState();

await client.$get(anyOf: ($bool: null, string: 'value'));
captured = verify(mockHttpClient.openUrl(captureAny, captureAny)).captured;
expect(
captured,
equals([
'get',
Uri.parse('example.com/?anyOf=value'),
]),
);
resetMockitoState();

await client.$get(anyOf: ($bool: true, string: 'value'));
captured = verify(mockHttpClient.openUrl(captureAny, captureAny)).captured;
expect(
captured,
equals([
'get',
Uri.parse('example.com/?anyOf=true'),
]),
);
});
});

group('getPathParameter', () {
Expand Down