Cannot handle types defined in Flutter dart:ui

[diablodale]

UPDATE: Likely due to and blocked by dart-lang/build#733

Color fields with @JsonKey(fromJson: _colorFromJson, toJson: _colorToJson) annotations fail.

Setup

• json_serializable 0.5.7
• json_annotation 0.2.8
• flutter 0.4.4

Repo

1. Use the following code

@JsonSerializable(nullable: true, includeIfNull: false)
class TestClass extends Object with _$TestClassSerializerMixin {
  @JsonKey(fromJson: _colorFromJson, toJson: _colorToJson)
  Color color;

  TestClass();
  factory TestClass.fromJson(Map<String, dynamic> jsonMap) => _$TestClassFromJson(jsonMap);
}

Color _colorFromJson(String colorString) {
  int intColor = int.tryParse(colorString, radix: 16);
  if (intColor == null)
    return null;
  else
    return new Color(intColor);
}

String _colorToJson(Color color) => color.value.toRadixString(16);

2. Run flutter packages pub run build_runner build

Result

Build fails. No usable xxx.g.dart file created. Errors on screen.

[SEVERE] json_serializable on lib/data/xxx.dart:
Error running JsonSerializableGenerator
At least one field has an invalid type: `color`.
package:xxxxxxxx/data/xxxx.dart:63:9
  Color color;
        ^^^^^

Comments

Seems related to functionality in #133 (comment) by @kevmoo .

[kevmoo]

That is super weird.

1. Have you run pub upgrade lately?
2. What is the Dart version when your run flutter --version (after `Tools).

[diablodale]

1. Yes. Ran it again now for goodness. All was already up to date.

Flutter 0.4.4 • channel beta • https://dalep-cli@github.com/flutter/flutter.git
Framework • revision f9bb4289e9 (5 weeks ago) • 2018-05-11 21:44:54 -0700
Engine • revision 06afdfe54e
Tools • Dart 2.0.0-dev.54.0.flutter-46ab040e58

[kevmoo]

Try this

> flutter packages pub run build_runner clean
> flutter packages pub run build_runner build --verbose

[kevmoo]

...and paste the output

[diablodale]

Sure.

flutter packages pub run build_runner clean

[INFO] Generating build script...
[INFO] Generating build script completed, took 4.0s

[WARNING] Deleting cache and generated source files.
This shouldn't be necessary for most applications, unless you have made intentional edits to generated files (i.e. for testing). Consider filing a bug at https://github.com/dart-lang/build/issues/new if you are using this to work around an apparent (and reproducible) bug.
[INFO] Cleaning up source outputs...
[INFO] Cleaning up source outputs completed, took 1.3s

[INFO] Cleaning up cache directory...
[INFO] Cleaning up cache directory completed, took 13ms

flutter packages pub run build_runner build --verbose

[INFO] Generating build script...
[INFO] Generating build script completed, took 4.0s

[INFO] BuildDefinition:Initializing inputs
[INFO] BuildDefinition:Building new asset graph...
[INFO] BuildDefinition:Building new asset graph completed, took 2.1s

[INFO] BuildDefinition:Checking for unexpected pre-existing outputs....
[INFO] BuildDefinition:Checking for unexpected pre-existing outputs. completed, took 24ms

[INFO] Build:Running build...
[FINE] json_serializable on lib/redacted.dart:Running JsonSerializableGenerator - 1 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonLiteralGenerator - 2 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonSerializableGenerator - 1 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonLiteralGenerator - 2 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonSerializableGenerator - 1 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonLiteralGenerator - 2 of 2
[INFO] Heartbeat:12.2s elapsed, 3/20 actions completed.
[FINE] json_serializable on lib/redacted.dart:Running JsonSerializableGenerator - 1 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonSerializableGenerator - 1 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonLiteralGenerator - 2 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonLiteralGenerator - 2 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonLiteralGenerator - 2 of 2
[INFO] Heartbeat:15.0s elapsed, 6/20 actions completed.
[INFO] Heartbeat:16.2s elapsed, 6/20 actions completed.
[FINE] json_serializable on lib/redacted.dart:Running JsonSerializableGenerator - 1 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonSerializableGenerator - 1 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonSerializableGenerator - 1 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonSerializableGenerator - 1 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonLiteralGenerator - 2 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonLiteralGenerator - 2 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonLiteralGenerator - 2 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonLiteralGenerator - 2 of 2
[INFO] Heartbeat:20.0s elapsed, 6/20 actions completed.
[INFO] Heartbeat:21.1s elapsed, 10/20 actions completed.
[SEVERE] json_serializable on lib/notaproblemredacted.dart:
Unable to resolve asset ID for "dart:ui"
[FINE] json_serializable on lib/redacted.dart:Running JsonSerializableGenerator - 1 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonSerializableGenerator - 1 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonSerializableGenerator - 1 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonSerializableGenerator - 1 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonSerializableGenerator - 1 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonSerializableGenerator - 1 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonSerializableGenerator - 1 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonSerializableGenerator - 1 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonSerializableGenerator - 1 of 2
[FINE] json_serializable on test/widget_test.dart:Running JsonSerializableGenerator - 1 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonLiteralGenerator - 2 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonLiteralGenerator - 2 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonLiteralGenerator - 2 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonLiteralGenerator - 2 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonLiteralGenerator - 2 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonLiteralGenerator - 2 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonLiteralGenerator - 2 of 2
[FINE] json_serializable on test/widget_test.dart:Running JsonLiteralGenerator - 2 of 2
[SEVERE] json_serializable on lib/redacted.dart:
Error running JsonSerializableGenerator
At least one field has an invalid type: `color`.
package:redactedproblemfile.dart:48:9
  Color color;
        ^^^^^
package:json_serializable/src/utils.dart 148:5                          createSortedFieldSet
package:json_serializable/src/generator_helper.dart 94:24               _GeneratorHelper._writeCtor
package:json_serializable/src/generator_helper.dart 67:28               _GeneratorHelper._generate
package:json_serializable/src/generator_helper.dart 32:17               generate
package:json_serializable/src/json_serializable_generator.dart 159:7    JsonSerializableGenerator.generateForAnnotatedElement
package:source_gen/src/generator_for_annotation.dart 40:15              GeneratorForAnnotation.generate.<fn>
dart:async                                                              Future.wait
package:source_gen/src/generator_for_annotation.dart 39:34              GeneratorForAnnotation.generate
package:source_gen/src/builder.dart 214:35                              _generate
package:source_gen/src/builder.dart 76:15                               _Builder._generateForLibrary
package:source_gen/src/builder.dart 67:11                               _Builder.build
package:build                                                           runBuilder
package:build_runner_core/src/generate/build_impl.dart 424:15           _SingleBuild._runForInput.<fn>
package:build_runner_core/src/generate/performance_tracker.dart 246:73  _NoOpBuilderActionTracker.track
package:build_runner_core/src/generate/build_impl.dart 423:19           _SingleBuild._runForInput
package:build_runner_core/src/generate/build_impl.dart 349:38           _SingleBuild._runBuilder.<fn>
dart:async                                                              Future.wait
package:build_runner_core/src/generate/build_impl.dart 348:36           _SingleBuild._runBuilder
package:build_runner_core/src/generate/build_impl.dart 296:32           _SingleBuild._runPhases.<fn>
package:build_runner_core/src/generate/performance_tracker.dart 140:15  _NoOpBuildPerformanceTracker.trackBuildPhase
package:build_runner_core/src/generate/build_impl.dart 292:33           _SingleBuild._runPhases
package:build_runner_core/src/logging/logging.dart 25:30                logTimedAsync
package:build_runner_core/src/generate/build_impl.dart 260:26           _SingleBuild._safeBuild.<fn>
dart:async                                                              runZoned
package:build_runner_core/src/generate/build_impl.dart 255:5            _SingleBuild._safeBuild
package:build_runner_core/src/generate/build_impl.dart 185:24           _SingleBuild.run
package:build_runner_core/src/generate/build_impl.dart 89:30            BuildImpl.run
package:build_runner_core/src/generate/build_runner.dart 23:14          BuildRunner.run
package:build_runner                                                    BuildCommand.run
package:args/command_runner.dart 194:27                                 CommandRunner.runCommand
package:args/command_runner.dart 109:29                                 CommandRunner.run.<fn>
dart:async                                                              new Future.sync
package:args/command_runner.dart 109:11                                 CommandRunner.run
package:build_runner                                                    run
.dart_tool\build\entrypoint\build.dart 11:22                            main

[FINE] json_serializable on lib/redacted.dart:Running JsonLiteralGenerator - 2 of 2
[FINE] json_serializable on lib/redacted.dart:Running JsonLiteralGenerator - 2 of 2
[INFO] Build:Running build completed, took 34.5s

[INFO] Build:Caching finalized dependency graph...
[INFO] Build:Caching finalized dependency graph completed, took 305ms

[INFO] Build:Succeeded after 34.9s with 6 outputs (20 actions)

[kevmoo]

Where is the Color type defined? Is it in the current package or somewhere else?

[diablodale]

Color is a core Flutter class.

At the top of the file having this error, I have the line import 'package:flutter/material.dart';

Somewhere within that core Flutter package it leads to the Color definition in <fluttersdkdir>\bin\cache\pkg\sky_engine\lib\ui\painting.dart

[kevmoo]

I bet you anything that's the issue. Will look into it. Thanks!

…

On Wed, Jun 13, 2018 at 6:07 AM Dale Phurrough ***@***.***> wrote: Color is a core Flutter library type. At the top of the file having this error, I have the line import 'package:flutter/material.dart'; Somewhere within that core Flutter package it leads to the Color definition in <fluttersdkdir>\bin\cache\pkg\sky_engine\lib\ui\painting.dart — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#236 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABCimPlG-1mDnNdj4OvLPe3jmxKj0mNks5t8Q59gaJpZM4UlYuD> .

[diablodale]

Thanks for considering. I poked around myself, but haven't gotten my head around everything needed to address it.

I did also look at type helpers and thought of writing a custom one for Color for my app to perhaps get around this issue and enable it globally. Though, I again haven't yet enough combined knowledge of build, dart, and this package to write it and enable it. Though, the helper code itself, like in the recent helper for Uri, doesn't look that difficult.

[kevmoo]

@diablodale look up the log you sent

[SEVERE] json_serializable on lib/notaproblemredacted.dart:
Unable to resolve asset ID for "dart:ui"

Looking into this now...

[kevmoo]

I hacked into build_resolver to add a stack there.

@jakemac53 Could this be a bug in build_resolvers? Or pkg:analyzer?

[SEVERE] json_serializable on lib/example.dart:
Unable to resolve asset ID for "dart:ui"
oops
package:build_resolvers/src/resolver.dart 292:24                        _AssetUriResolver.resolveAbsolute
package:analyzer/src/context/source.dart 259:34                         SourceFactoryImpl._internalResolveUri.<fn>
dart:collection                                                         _HashMap.putIfAbsent
package:analyzer/src/context/source.dart 257:38                         SourceFactoryImpl._internalResolveUri
package:analyzer/src/context/source.dart 158:14                         SourceFactoryImpl.resolveUri
package:analyzer/src/task/dart.dart 3944:36                             ParseDartTask._resolveUri
package:analyzer/src/task/dart.dart 3897:23                             ParseDartTask._resolveDirective
package:analyzer/src/task/dart.dart 3797:37                             ParseDartTask.internalPerform
package:analyzer/src/task/api/model.dart 323:9                          AnalysisTask._safelyPerform
package:analyzer/src/task/api/model.dart 222:7                          AnalysisTask.perform
package:analyzer/src/task/driver.dart 285:10                            AnalysisDriver.performWorkItem
package:analyzer/src/task/driver.dart 110:22                            AnalysisDriver.computeResult
package:analyzer/src/context/context.dart 722:14                        AnalysisContextImpl.computeResult
package:analyzer/src/context/context.dart 680:14                        AnalysisContextImpl.computeKindOf
package:build_resolvers/src/resolver.dart 99:16                         AnalyzerResolver._isLibrary
package:build_resolvers/src/resolver.dart 95:30                         AnalyzerResolver.isLibrary
package:build_resolvers/src/resolver.dart 61:56                         PerActionResolver.isLibrary
package:build                                                           _DelayedResolver.isLibrary
package:source_gen/src/builder.dart 65:25                               _Builder.build
package:build                                                           runBuilder
package:build_runner_core/src/generate/build_impl.dart 424:15           _SingleBuild._runForInput.<fn>
package:build_runner_core/src/generate/performance_tracker.dart 246:73  _NoOpBuilderActionTracker.track
package:build_runner_core/src/generate/build_impl.dart 423:19           _SingleBuild._runForInput
package:build_runner_core/src/generate/build_impl.dart 349:38           _SingleBuild._runBuilder.<fn>
dart:async                                                              Future.wait
package:build_runner_core/src/generate/build_impl.dart 348:36           _SingleBuild._runBuilder
package:build_runner_core/src/generate/build_impl.dart 296:32           _SingleBuild._runPhases.<fn>
package:build_runner_core/src/generate/performance_tracker.dart 140:15  _NoOpBuildPerformanceTracker.trackBuildPhase
package:build_runner_core/src/generate/build_impl.dart 292:33           _SingleBuild._runPhases
package:build_runner_core/src/logging/logging.dart 25:30                logTimedAsync
package:build_runner_core/src/generate/build_impl.dart 260:26           _SingleBuild._safeBuild.<fn>
dart:async                                                              runZoned
package:build_runner_core/src/generate/build_impl.dart 255:5            _SingleBuild._safeBuild
package:build_runner_core/src/generate/build_impl.dart 185:24           _SingleBuild.run
package:build_runner_core/src/generate/build_impl.dart 89:30            BuildImpl.run
package:build_runner                                                    WatchCommand.run
package:args/command_runner.dart 194:27                                 CommandRunner.runCommand
package:args/command_runner.dart 109:29                                 CommandRunner.run.<fn>
dart:async                                                              new Future.sync
package:args/command_runner.dart 109:11                                 CommandRunner.run
package:build_runner                                                    run
.dart_tool/build/entrypoint/build.dart 11:22                            main

[kevmoo]

Here's the crux, it seems - dart-lang/build#733

[diablodale]

That is a known issue. As in google/built_value.dart#282

That specific error has always been there for me. And it caused no harm to any generated files. I can fully use json_serializable and ignore that error. FYI, also that error comes from a separate dart file than the Color example I gave.

Ahh, I see you typing above. This is the first time that I have defining a custom to/fromJson handler for a Flutter type. Other times I have used types outside Flutter.