[dart-dio-next] Adds an option for using the dio_http package (#10497)

* [dart-dio] Adds an option for using the dio_http package

Relates to #10305

* [dart-dio-next] Generates new dio_http sample

* [dart-dio-next] renames dio_http sample, adds pom.xml

* [dart-dio-next] Removes executions not required

Author: josh-burton

bin/configs/dart-dio-next-dio-http-petstore-client-lib-fake.yaml

@@ -0,0 +1,11 @@
+generatorName: dart-dio-next
+outputDir: samples/openapi3/client/petstore/dart-dio-next/dio_http_petstore_client_lib_fake
+inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml
+templateDir: modules/openapi-generator/src/main/resources/dart/libraries/dio
+typeMappings:
+  Client: "ModelClient"
+  File: "ModelFile"
+  EnumClass: "ModelEnumClass"
+additionalProperties:
+  hideGenerationTimestamp: "true"
+  dioLibrary: "dio_http"

docs/generators/dart-dio-next.md

@@ -9,6 +9,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 | ------ | ----------- | ------ | ------- |
 |allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
 |dateLibrary|Specify Date library|<dl><dt>**core**</dt><dd>[DEFAULT] Dart core library (DateTime)</dd><dt>**timemachine**</dt><dd>Time Machine is date and time library for Flutter, Web, and Server with support for timezones, calendars, cultures, formatting and parsing.</dd></dl>|core|
+|dioLibrary|Specify Dio library|<dl><dt>**dio_http**</dt><dd>dio_http 5.x</dd><dt>**dio**</dt><dd>[DEFAULT] dio 4.x</dd></dl>|dio|
 |disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|<dl><dt>**false**</dt><dd>The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.</dd><dt>**true**</dt><dd>Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.</dd></dl>|true|
 |ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
 |legacyDiscriminatorBehavior|Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C#have this enabled by default).|<dl><dt>**true**</dt><dd>The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.</dd><dt>**false**</dt><dd>The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.</dd></dl>|true|

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/DartDioNextClientCodegen.java

@@ -39,6 +39,11 @@ public class DartDioNextClientCodegen extends AbstractDartCodegen {
 
     private final Logger LOGGER = LoggerFactory.getLogger(DartDioNextClientCodegen.class);
 
+    public static final String DIO_LIBRARY = "dioLibrary";
+    public static final String DIO_ORIGINAL = "dio";
+    public static final String DIO_HTTP = "dio_http";
+    public static final String DIO_LIBRARY_DEFAULT = DIO_ORIGINAL;
+
     public static final String DATE_LIBRARY = "dateLibrary";
     public static final String DATE_LIBRARY_CORE = "core";
     public static final String DATE_LIBRARY_TIME_MACHINE = "timemachine";
@@ -47,11 +52,13 @@ public class DartDioNextClientCodegen extends AbstractDartCodegen {
     public static final String SERIALIZATION_LIBRARY_BUILT_VALUE = "built_value";
     public static final String SERIALIZATION_LIBRARY_DEFAULT = SERIALIZATION_LIBRARY_BUILT_VALUE;
 
-    private static final String DIO_IMPORT = "package:dio/dio.dart";
     private static final String CLIENT_NAME = "clientName";
 
     private String dateLibrary;
 
+    private String dioLibrary;
+    private String dioImport;
+
     private String clientName;
 
     public DartDioNextClientCodegen() {
@@ -80,6 +87,7 @@ public DartDioNextClientCodegen() {
         serializationLibrary.setDefault(SERIALIZATION_LIBRARY_DEFAULT);
         cliOptions.add(serializationLibrary);
 
+        // Date Library Option
         final CliOption dateOption = CliOption.newString(DATE_LIBRARY, "Specify Date library");
         dateOption.setDefault(DATE_LIBRARY_DEFAULT);
 
@@ -88,6 +96,16 @@ public DartDioNextClientCodegen() {
         dateOptions.put(DATE_LIBRARY_TIME_MACHINE, "Time Machine is date and time library for Flutter, Web, and Server with support for timezones, calendars, cultures, formatting and parsing.");
         dateOption.setEnum(dateOptions);
         cliOptions.add(dateOption);
+
+        // Dio Library Option
+        final CliOption dioOption = CliOption.newString(DIO_LIBRARY, "Specify Dio library");
+        dioOption.setDefault(DIO_LIBRARY_DEFAULT);
+
+        final Map<String, String> dioOptions = new HashMap<>();
+        dioOptions.put(DIO_ORIGINAL, "[DEFAULT] dio 4.x");
+        dioOptions.put(DIO_HTTP, "dio_http 5.x");
+        dioOption.setEnum(dioOptions);
+        cliOptions.add(dioOption);
     }
 
     public String getDateLibrary() {
@@ -98,6 +116,14 @@ public void setDateLibrary(String library) {
         this.dateLibrary = library;
     }
 
+    public String getDioLibrary() {
+        return dioLibrary;
+    }
+
+    public void setDioLibrary(String library) {
+        this.dioLibrary = library;
+    }
+
     public String getClientName() {
         return clientName;
     }
@@ -137,6 +163,12 @@ public void processOpts() {
         }
         setDateLibrary(additionalProperties.get(DATE_LIBRARY).toString());
 
+        if (!additionalProperties.containsKey(DIO_LIBRARY)) {
+            additionalProperties.put(DIO_LIBRARY, DIO_LIBRARY_DEFAULT);
+            LOGGER.debug("Dio library not set, using default {}", DIO_LIBRARY_DEFAULT);
+        }
+        setDioLibrary(additionalProperties.get(DIO_LIBRARY).toString());
+
         if (!additionalProperties.containsKey(CLIENT_NAME)) {
             final String name = org.openapitools.codegen.utils.StringUtils.camelize(pubName);
             additionalProperties.put(CLIENT_NAME, name);
@@ -162,15 +194,31 @@ public void processOpts() {
         supportingFiles.add(new SupportingFile("auth/oauth.mustache", authFolder, "oauth.dart"));
         supportingFiles.add(new SupportingFile("auth/auth.mustache", authFolder, "auth.dart"));
 
+        configureDioLibrary();
         configureSerializationLibrary(srcFolder);
         configureDateLibrary(srcFolder);
     }
 
+    private void configureDioLibrary() {
+        switch (dioLibrary) {
+            case DIO_HTTP:
+                dioImport = "package:dio_http/dio_http.dart";
+                break;
+            case DIO_ORIGINAL:
+            default:
+                dioImport = "package:dio/dio.dart";
+                break;
+        }
+    }
+
     private void configureSerializationLibrary(String srcFolder) {
         switch (library) {
             default:
             case SERIALIZATION_LIBRARY_BUILT_VALUE:
                 additionalProperties.put("useBuiltValue", "true");
+                additionalProperties.put("useDioHttp", dioLibrary.equals(DIO_HTTP));
+                additionalProperties.put("dioImport", dioImport);
+                additionalProperties.put("dioLibrary", dioLibrary);
                 configureSerializationLibraryBuiltValue(srcFolder);
                 break;
         }
@@ -195,7 +243,7 @@ private void configureSerializationLibraryBuiltValue(String srcFolder) {
         imports.put("BuiltMap", "package:built_collection/built_collection.dart");
         imports.put("JsonObject", "package:built_value/json_object.dart");
         imports.put("Uint8List", "dart:typed_data");
-        imports.put("MultipartFile", DIO_IMPORT);
+        imports.put("MultipartFile", dioImport);
     }
 
     private void configureDateLibrary(String srcFolder) {
@@ -367,7 +415,7 @@ private Set<String> rewriteImports(Set<String> originalImports, boolean isModel)
         for (String modelImport : originalImports) {
             if (imports.containsKey(modelImport)) {
                 String i = imports.get(modelImport);
-                if (Objects.equals(i, DIO_IMPORT) && !isModel) {
+                if (Objects.equals(i, dioImport) && !isModel) {
                     // Don't add imports to operations that are already imported
                     continue;
                 }

modules/openapi-generator/src/main/resources/dart/libraries/dio/api.mustache

@@ -2,7 +2,7 @@
 import 'dart:async';
 
 {{#useBuiltValue}}import 'package:built_value/serializer.dart';{{/useBuiltValue}}
-import 'package:dio/dio.dart';
+import '{{dioImport}}';
 
 {{#operations}}
 {{#imports}}import '{{.}}';

modules/openapi-generator/src/main/resources/dart/libraries/dio/api_client.mustache

@@ -1,5 +1,5 @@
 {{>header}}
-import 'package:dio/dio.dart';{{#useBuiltValue}}
+import '{{dioImport}}';{{#useBuiltValue}}
 import 'package:built_value/serializer.dart';
 import 'package:{{pubName}}/src/serializers.dart';{{/useBuiltValue}}
 import 'package:{{pubName}}/src/auth/api_key_auth.dart';

modules/openapi-generator/src/main/resources/dart/libraries/dio/auth/api_key_auth.mustache

@@ -1,6 +1,6 @@
 {{>header}}
 
-import 'package:dio/dio.dart';
+import '{{dioImport}}';
 import 'package:{{pubName}}/src/auth/auth.dart';
 
 class ApiKeyAuthInterceptor extends AuthInterceptor {

modules/openapi-generator/src/main/resources/dart/libraries/dio/auth/auth.mustache

@@ -1,5 +1,5 @@
 {{>header}}
-import 'package:dio/dio.dart';
+import '{{dioImport}}';
 
 abstract class AuthInterceptor extends Interceptor {
   /// Get auth information on given route for the given type.

modules/openapi-generator/src/main/resources/dart/libraries/dio/auth/basic_auth.mustache

@@ -1,7 +1,7 @@
 {{>header}}
 import 'dart:convert';
 
-import 'package:dio/dio.dart';
+import '{{dioImport}}';
 import 'package:{{pubName}}/src/auth/auth.dart';
 
 class BasicAuthInfo {

modules/openapi-generator/src/main/resources/dart/libraries/dio/auth/bearer_auth.mustache

@@ -1,5 +1,5 @@
 {{>header}}
-import 'package:dio/dio.dart';
+import '{{dioImport}}';
 import 'package:{{pubName}}/src/auth/auth.dart';
 
 class BearerAuthInterceptor extends AuthInterceptor {

modules/openapi-generator/src/main/resources/dart/libraries/dio/auth/oauth.mustache

@@ -1,5 +1,5 @@
 {{>header}}
-import 'package:dio/dio.dart';
+import '{{dioImport}}';
 import 'package:{{pubName}}/src/auth/auth.dart';
 
 class OAuthInterceptor extends AuthInterceptor {