mobile/api_builder (deriv-com#3)

https://trello.com/c/2XGWjthy/231-8-mobile-apibuilder-2

* Attempt to sort out our API builder

* Separate out login handling

* mobile/api_builder

* Clear out generated files when building

* Exclude autogenerated files for now

* Fix exclusion

* Restore cache earlier

* dartanalyzer ignores the exclude directives, switch to tuneup

See dart-lang/sdk#25551

* Remove duplicate cache restore

* tuneup trim

* Fix type handling and put the comment before the property

* Handle cases where the array type is not provided

* Rebuilt API

* Remove .idea entirely

* Ignore .idea workspace

* Better handling for multiple types and arrays

* Report stack trace if anything goes wrong

Author: tom-binary

.circleci/config.yml

@@ -20,13 +20,19 @@ jobs:
           name: Link JSON files for API autobuild
           command: ./setup.sh
 
+      - restore_cache:
+          keys:
+              - android-sdk-licenses
+              - gradle
+              - pub-cache
+
       - run:
           name: pub get
           command: flutter pub get
 
       - run:
           name: Build step
-          command: flutter pub run build_runner build
+          command: flutter pub run build_runner build --delete-conflicting-outputs
 
       - run:
           name: Run the application tests
@@ -40,13 +46,8 @@ jobs:
       - run:
           name: Code analysis
           command: |
-              dartanalyzer --options analysis_options.yaml --fatal-warnings lib
-
-      - restore_cache:
-          keys:
-              - android-sdk-licenses
-              - gradle
-              - pub-cache
+              flutter pub global activate tuneup
+              flutter pub global run tuneup check
 
       - run:
           name: Check that the package is ready for publishing

.gitignore

@@ -4,6 +4,8 @@
 .packages
 .pub/
 
+.idea/
+
 build/
 
 lib/api/*.json

.idea/libraries/Dart_SDK.xml

@@ -1,4 +1,6 @@
 analyzer:
+  exclude:
+    - lib/api/**
   strong-mode:
     implicit-dynamic: false
   errors:

.idea/libraries/Flutter_for_Android.xml

@@ -7,8 +7,12 @@ import 'package:recase/recase.dart';
 import 'package:build/build.dart';
 import 'package:dart_style/dart_style.dart';
 
-Builder apiBuilder(_) => APIBuilder();
+Builder apiBuilder(final BuilderOptions _) => APIBuilder();
 
+/// This class is responsible for parsing the morass of JSON schema
+/// definition files for our API, and assembling them into request/response
+/// objects suitable for marshalling and deserialising from our websockets
+/// API.
 class APIBuilder extends Builder {
   static const Map<String, String> typeMap = <String, String>{
     'integer': 'int',
@@ -31,7 +35,7 @@ class APIBuilder extends Builder {
   Future<void> build(BuildStep buildStep) async {
     try {
       log.info('Reading ${buildStep.inputId} as JSON');
-      final schemaDefinition = jsonDecode(await buildStep.readAsString(buildStep.inputId));
+      final Map<dynamic, dynamic> schemaDefinition = jsonDecode(await buildStep.readAsString(buildStep.inputId));
 
       log.info('Processing schema definition from ${buildStep.inputId}');
       final JsonSchema schema = JsonSchema.createSchema(schemaDefinition);
@@ -42,18 +46,39 @@ class APIBuilder extends Builder {
       /* Instead of trying anything too fancy here, we just provide a simple conversion from original
        JSON schema name - which is snake_cased - to something more Dart-suitable, and apply type
        mapping via "it's a string unless we have a better guess" heuristic. */
-      log.info('Iterating over $props');
+      props.sort();
       final String attrList = props.map((String k) {
         final String name = ReCase(k).camelCase;
         final JsonSchema prop = schema.properties[k];
         String type;
+        // Currently we don't handle multiple types, could
+        // treat those as `dynamic` but so far we don't have
+        // enough of them to care too much
         if (prop.typeList?.isNotEmpty ?? false) {
-          type = typeMap[prop.type?.toString() ?? 'string'];
+          // The `.type` values are objects, not strings,
+          // which leads to some confusing results when you
+          // try to compare them as strings or use them as
+          // map lookups... so we extract them out to separate
+          // variables instead.
+          if(prop.oneOf.isNotEmpty) {
+            type = 'dynamic';
+          } else {
+            final String schemaType = prop.type?.toString() ?? 'string';
+            if(schemaType == 'array') {
+              // Some types aren't specified - forget_all for example
+              final String itemType = prop.items?.type?.toString() ?? 'string';
+              type = 'List<${typeMap[itemType]}>';
+            } else {
+              type = typeMap[schemaType] ?? 'String';
+            }
+          }
         } else {
           log.warning('The property $k on ${buildStep.inputId} does not appear to have a type: defaulting to string');
-          type = 'string';
+          type = 'String';
         }
-        return 'final ${type ?? "unknown"} ${name ?? "unknown"};';
+        return '''/// ${prop.description}
+  ${type ?? "unknown"} ${name ?? "unknown"};
+''';
       }).join('\n');
 
       /* Some minor chicanery here to find out which API method we're supposed to be processing */
@@ -79,7 +104,7 @@ class APIBuilder extends Builder {
           // https://stackoverflow.com/questions/51188114/dart-build-runner-can-only-scan-read-write-files-in-the-web-directory
           // AssetId(buildStep.inputId.package, 'lib/api/${className}${schemaTypeMap[schemaType]}.dart'),
           buildStep.inputId.changeExtension('.dart'),
-          DartFormatter().format('''/* Autogenerated from ${buildStep.inputId} */
+          DartFormatter().format('''/// Autogenerated from ${buildStep.inputId}
 import 'dart:async';
 import 'dart:convert';
 import 'package:json_annotation/json_annotation.dart';
@@ -92,7 +117,7 @@ class ${fullClassName} {
   factory ${fullClassName}.fromJson(Map<String, dynamic> json) => _\$${fullClassName}FromJson(json);
   Map<String, dynamic> toJson() => _\$${fullClassName}ToJson(this);
 
-  /* Properties */
+  // Properties
   ${attrList}
 
   // @override
@@ -101,8 +126,9 @@ class ${fullClassName} {
   static int _fromBoolean(bool v) => v ? 1 : 0;
 }
 '''));
-    } catch (e) {
+    } catch (e, stack) {
       log.severe('Failed to process ${buildStep.inputId} - $e');
+      log.severe('Stack trace $stack');
       return;
     }
   }

.idea/modules.xml

@@ -2,13 +2,22 @@ targets:
   $default:
     builders:
       flutter_deriv_api|api:
+        enabled: true
         generate_for:
         - lib/api/*_send.json
         - lib/api/*_receive.json
 builders:
   api:
-    import: 'package:flutter_deriv_api/api_builder.dart'
+    import: './api_builder.dart'
     builder_factories: ["apiBuilder"]
     auto_apply: root_package
     build_extensions: {".json": [".dart"]}
+    is_optional: False
     build_to: source
+    runs_before: ["json_serializable|json_serializable"]
+    defaults:
+      generate_for:
+        include:
+          - lib/api/**
+    #applies_builders:
+    #  - json_serializable|json_serializable

.idea/runConfigurations/example_lib_main_dart.xml

@@ -2,4 +2,4 @@
 
 You can customize the launch screen with your own desired assets by replacing the image files in this directory.
 
-You can also do it by opening your Flutter project's Xcode project with `open ios/Runner.xcworkspace`, selecting `Runner/Assets.xcassets` in the Project Navigator and dropping in the desired images.
+You can also do it by opening your Flutter project's Xcode project with `open ios/Runner.xcworkspace`, selecting `Runner/Assets.xcassets` in the Project Navigator and dropping in the desired images.

.idea/workspace.xml

@@ -158,6 +158,13 @@ packages:
     description: flutter
     source: sdk
     version: "0.0.0"
+  flutter_webview_plugin:
+    dependency: transitive
+    description:
+      name: flutter_webview_plugin
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "0.3.8"
   front_end:
     dependency: transitive
     description:

analysis_options.yaml

@@ -8,7 +8,7 @@
 import 'package:flutter/material.dart';
 import 'package:flutter_test/flutter_test.dart';
 
-import 'package:flutter_deriv_api_example/main.dart';
+import '../lib/main.dart';
 
 void main() {
   testWidgets('Verify Platform version', (WidgetTester tester) async {

lib/api_builder.dart api_builder.dart

@@ -8,11 +8,11 @@
       <excludeFolder url="file://$MODULE_DIR$/.idea" />
       <excludeFolder url="file://$MODULE_DIR$/.pub" />
       <excludeFolder url="file://$MODULE_DIR$/build" />
+      <excludeFolder url="file://$MODULE_DIR$/example/.dart_tool" />
       <excludeFolder url="file://$MODULE_DIR$/example/.pub" />
       <excludeFolder url="file://$MODULE_DIR$/example/build" />
     </content>
     <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="library" name="Dart Packages" level="project" />
     <orderEntry type="library" name="Dart SDK" level="project" />
     <orderEntry type="library" name="Flutter Plugins" level="project" />
   </component>

build.yaml

@@ -0,0 +1,32 @@
+/// Autogenerated from flutter_deriv_api|lib/api/active_symbols_receive.json
+import 'dart:async';
+import 'dart:convert';
+import 'package:json_annotation/json_annotation.dart';
+
+part 'active_symbols_receive.g.dart';
+
+@JsonSerializable(nullable: false, fieldRename: FieldRename.snake)
+class ActiveSymbolsResponse {
+  ActiveSymbolsResponse();
+  factory ActiveSymbolsResponse.fromJson(Map<String, dynamic> json) =>
+      _$ActiveSymbolsResponseFromJson(json);
+  Map<String, dynamic> toJson() => _$ActiveSymbolsResponseToJson(this);
+
+  // Properties
+  /// List of active symbols.
+  List<Map<String, dynamic>> activeSymbols;
+
+  /// Echo of the request made.
+  Map<String, dynamic> echoReq;
+
+  /// Action name of the request made.
+  String msgType;
+
+  /// Optional field sent in request to map to response, present only when request contains req_id.
+  int reqId;
+
+  // @override
+  // String toString() => name;
+  static bool _fromInteger(int v) => (v != 0);
+  static int _fromBoolean(bool v) => v ? 1 : 0;
+}