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.

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

Add support for serialize_nulls build config option #528

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
55 changes: 38 additions & 17 deletions packages/ferry_generator/lib/graphql_builder.dart
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ import 'package:build/build.dart';
import 'package:code_builder/code_builder.dart';
import 'package:gql_code_builder/ast.dart';
import 'package:gql_code_builder/data.dart';
import 'package:gql_code_builder/var.dart';
import 'package:gql_code_builder/schema.dart';
import 'package:gql_code_builder/var.dart';
import 'package:path/path.dart' as p;

import 'src/utils/locations.dart';
import 'src/allocators/gql_allocator.dart';
import 'src/codegen/req.dart';
import 'src/utils/add_introspection.dart';
import 'src/utils/config.dart';
import 'src/utils/locations.dart';
import 'src/utils/reader.dart';
import 'src/utils/writer.dart';
import 'src/utils/add_introspection.dart';
import 'src/codegen/req.dart';
import 'src/allocators/gql_allocator.dart';

Builder graphqlBuilder(
BuilderOptions options,
Expand Down Expand Up @@ -55,6 +55,21 @@ class GraphqlBuilder implements Builder {
'When extensions require add_typenames to be true. Consider setting add_typenames to true in your build.yaml or disabling when_extensions in your build.yaml.');
}

final schemaOutputAsset =
outputAssetId(config.schemaId, schemaExtension, config.outputDir);

final schemaUrl = schemaOutputAsset.uri.toString();
final schemaAllocator = GqlAllocator(
buildStep.inputId.uri.toString(),
config.sourceExtension,
outputAssetId(buildStep.inputId, schemaExtension, config.outputDir)
.uri
.toString(),
schemaUrl,
config.outputDir,
);

final varAllocator = schemaAllocator;
final libs = <String, Library>{
astExtension: buildAstLibrary(doc),
dataExtension: buildDataLibrary(
Expand All @@ -65,11 +80,12 @@ class GraphqlBuilder implements Builder {
config.whenExtensionConfig,
),
varExtension: buildVarLibrary(
doc,
addTypenames(schema),
p.basename(generatedFilePath(buildStep.inputId, varExtension)),
config.typeOverrides,
),
doc,
addTypenames(schema),
p.basename(generatedFilePath(buildStep.inputId, varExtension)),
config.typeOverrides,
config.serializeNulls,
varAllocator),
reqExtension: buildReqLibrary(
doc,
p.basename(generatedFilePath(buildStep.inputId, reqExtension)),
Expand All @@ -80,6 +96,7 @@ class GraphqlBuilder implements Builder {
config.typeOverrides,
config.enumFallbackConfig,
generatePossibleTypesMap: config.shouldGeneratePossibleTypes,
allocator: schemaAllocator,
),
};

Expand All @@ -89,13 +106,17 @@ class GraphqlBuilder implements Builder {
final schemaOutputAsset =
outputAssetId(config.schemaId, schemaExtension, config.outputDir);

final allocator = GqlAllocator(
buildStep.inputId.uri.toString(),
config.sourceExtension,
generatedAsset.uri.toString(),
schemaOutputAsset.uri.toString(),
config.outputDir,
);
final allocator = entry.key == schemaExtension
? schemaAllocator
: entry.key == varExtension
? varAllocator
: GqlAllocator(
buildStep.inputId.uri.toString(),
config.sourceExtension,
generatedAsset.uri.toString(),
schemaOutputAsset.uri.toString(),
config.outputDir,
);

await writeDocument(generatedAsset, entry.value, allocator, buildStep);
}
Expand Down
2 changes: 2 additions & 0 deletions packages/ferry_generator/lib/src/utils/config.dart
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ class BuilderConfig {
final AssetId schemaId;
final bool shouldAddTypenames;
final bool shouldGeneratePossibleTypes;
final bool serializeNulls;
final Map<String, Reference> typeOverrides;
final Set<Reference> customSerializers;
final EnumFallbackConfig enumFallbackConfig;
Expand All @@ -27,6 +28,7 @@ class BuilderConfig {
typeOverrides = _getTypeOverrides(config['type_overrides']),
shouldGeneratePossibleTypes =
config['generate_possible_types_map'] ?? true,
serializeNulls = config['serialize_nulls'] ?? false,
customSerializers = _getCustomSerializers(config['custom_serializers']),
enumFallbackConfig = _getEnumFallbackConfig(config),
outputDir = config['output_dir'] ?? '__generated__',
Expand Down
9 changes: 9 additions & 0 deletions packages/ferry_generator/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,17 @@ dependencies:
built_value_generator: ^8.1.1
built_value: ^8.1.2
analyzer: ">=4.2.0 <6.0.0"

dev_dependencies:
test: ^1.16.8
build_runner: ^2.0.2
build_test: ^2.0.0
pedantic: ^1.11.0


dependency_overrides:
gql_code_builder:
git:
url: https://github.com/twklessor/gql.git
ref: feature/serialize-nulls
path: codegen/gql_code_builder