Merge pull request #992 from nextcloud/refactor/dynamite

refactor(dynamite): add default values as described by openapi
nextcloud · Oct 19, 2023 · a160696 · a160696
2 parents 6245160 + 7bae1ab
commit a160696
Show file tree

Hide file tree

Showing 17 changed files with 140 additions and 96 deletions.
diff --git a/packages/dynamite/dynamite/lib/src/builder/client.dart b/packages/dynamite/dynamite/lib/src/builder/client.dart
@@ -234,7 +234,7 @@ Iterable<Method> buildTags(
       ).forEach(code.writeln);
 
       final operationParameters = ListBuilder<Parameter>();
-      final annotations = operation.deprecated ?? false ? refer('Deprecated').call([refer("''")]) : null;
+      final annotations = operation.deprecated ? refer('Deprecated').call([refer("''")]) : null;
       var returnDataType = 'void';
       var returnHeadersType = 'void';
 

diff --git a/packages/dynamite/dynamite/lib/src/builder/header_serializer.dart b/packages/dynamite/dynamite/lib/src/builder/header_serializer.dart
@@ -122,7 +122,7 @@ Iterable<String> deserializeProperty(
       state,
       '${identifier}_${toDartName(propertyName, uppercaseFirstCharacter: true)}',
       propertySchema,
-      nullable: isDartParameterNullable(schema.required?.contains(propertyName), propertySchema),
+      nullable: isDartParameterNullable(schema.required.contains(propertyName), propertySchema),
     );
 
     yield "case '$propertyName':";

diff --git a/packages/dynamite/dynamite/lib/src/builder/resolve_interface.dart b/packages/dynamite/dynamite/lib/src/builder/resolve_interface.dart
@@ -34,7 +34,7 @@ TypeResultObject resolveInterface(
                   '${identifier}_${toDartName(propertyName, uppercaseFirstCharacter: true)}',
                   propertySchema,
                   nullable: isDartParameterNullable(
-                    schema.required?.contains(propertyName),
+                    schema.required.contains(propertyName),
                     propertySchema,
                   ),
                 );

diff --git a/packages/dynamite/dynamite/lib/src/builder/resolve_mime_type.dart b/packages/dynamite/dynamite/lib/src/builder/resolve_mime_type.dart
@@ -77,7 +77,7 @@ Iterable<String> resolveMimeTypeEncode(
         case 'application/x-www-form-urlencoded':
           final dartParameterRequired = isRequired(
             operation.requestBody!.required,
-            mediaType.schema?.$default,
+            mediaType.schema,
           );
           b.add(
             Parameter(
@@ -100,7 +100,7 @@ Iterable<String> resolveMimeTypeEncode(
         case 'application/octet-stream':
           final dartParameterRequired = isRequired(
             operation.requestBody!.required,
-            mediaType.schema?.$default,
+            mediaType.schema,
           );
           b.add(
             Parameter(

diff --git a/packages/dynamite/dynamite/lib/src/helpers/dynamite.dart b/packages/dynamite/dynamite/lib/src/helpers/dynamite.dart
@@ -18,16 +18,16 @@ String filterMethodName(final String operationId, final String tag) {
 String clientName(final String tag) => '${toDartName(tag, uppercaseFirstCharacter: true)}Client';
 
 bool isDartParameterNullable(
-  final bool? required,
+  final bool required,
   final openapi.Schema? schema,
 ) =>
-    (!(required ?? false) && schema?.$default == null) || (schema?.nullable ?? false);
+    (!required && schema?.$default == null) || (schema?.nullable ?? false);
 
 bool isRequired(
-  final bool? required,
-  final dynamic default_,
+  final bool required,
+  final openapi.Schema? schema,
 ) =>
-    (required ?? false) && default_ == null;
+    required && schema?.$default == null;
 
 int sortRequiredParameters(final openapi.Parameter a, final openapi.Parameter b) {
   if (a.isDartRequired != b.isDartRequired) {

diff --git a/packages/dynamite/dynamite/lib/src/models/openapi/header.dart b/packages/dynamite/dynamite/lib/src/models/openapi/header.dart
@@ -14,7 +14,12 @@ abstract class Header implements Built<Header, HeaderBuilder> {
   @BuiltValueField(compare: false)
   String? get description;
 
-  bool? get required;
+  bool get required;
 
   Schema? get schema;
+
+  @BuiltValueHook(finalizeBuilder: true)
+  static void _defaults(final HeaderBuilder b) {
+    b.required ??= false;
+  }
 }
diff --git a/packages/dynamite/dynamite/lib/src/models/openapi/header.g.dart b/packages/dynamite/dynamite/lib/src/models/openapi/header.g.dart
diff --git a/packages/dynamite/dynamite/lib/src/models/openapi/open_api.dart b/packages/dynamite/dynamite/lib/src/models/openapi/open_api.dart
@@ -21,7 +21,7 @@ abstract class OpenAPI implements Built<OpenAPI, OpenAPIBuilder> {
 
   Info get info;
 
-  BuiltList<Server>? get servers;
+  BuiltList<Server> get servers;
 
   BuiltList<BuiltMap<String, BuiltList<String>>>? get security;
 
@@ -33,6 +33,17 @@ abstract class OpenAPI implements Built<OpenAPI, OpenAPIBuilder> {
 
   bool get hasAnySecurity => components?.securitySchemes?.isNotEmpty ?? false;
 
+  @BuiltValueHook(finalizeBuilder: true)
+  static void _defaults(final OpenAPIBuilder b) {
+    if (b.servers.isEmpty) {
+      b.servers.add(
+        Server(
+          (final b) => b.url = '/',
+        ),
+      );
+    }
+  }
+
   Iterable<String> formattedTagsFor(final String? tag) sync* {
     final matchedTags = tags?.where((final t) => t.name == tag);
 

diff --git a/packages/dynamite/dynamite/lib/src/models/openapi/open_api.g.dart b/packages/dynamite/dynamite/lib/src/models/openapi/open_api.g.dart
diff --git a/packages/dynamite/dynamite/lib/src/models/openapi/operation.dart b/packages/dynamite/dynamite/lib/src/models/openapi/operation.dart
@@ -23,7 +23,7 @@ abstract class Operation implements Built<Operation, OperationBuilder> {
   @BuiltValueField(compare: false)
   String? get description;
 
-  bool? get deprecated;
+  bool get deprecated;
 
   BuiltList<String>? get tags;
 
@@ -35,6 +35,11 @@ abstract class Operation implements Built<Operation, OperationBuilder> {
 
   BuiltList<BuiltMap<String, BuiltList<String>>>? get security;
 
+  @BuiltValueHook(finalizeBuilder: true)
+  static void _defaults(final OperationBuilder b) {
+    b.deprecated ??= false;
+  }
+
   Iterable<String> formattedDescription(
     final String methodName, {
     final bool isRawRequest = false,

diff --git a/packages/dynamite/dynamite/lib/src/models/openapi/operation.g.dart b/packages/dynamite/dynamite/lib/src/models/openapi/operation.g.dart
diff --git a/packages/dynamite/dynamite/lib/src/models/openapi/parameter.dart b/packages/dynamite/dynamite/lib/src/models/openapi/parameter.dart
@@ -22,11 +22,16 @@ abstract class Parameter implements Built<Parameter, ParameterBuilder> {
   @BuiltValueField(compare: false)
   String? get description;
 
-  bool? get required;
+  bool get required;
 
   Schema? get schema;
 
-  bool get isDartRequired => isRequired(required, schema?.$default);
+  @BuiltValueHook(finalizeBuilder: true)
+  static void _defaults(final ParameterBuilder b) {
+    b.required ??= false;
+  }
+
+  bool get isDartRequired => isRequired(required, schema);
 
   String get formattedDescription {
     final name = toDartName(this.name);