[interop] Refactoring Generator to make use of configuration options (#408)

* Added function var args config

* added config test case

* Completed Configuration Integration

* analysis issue

* resolved some issues with config

* used specific subtypes

* fixed minor analysis

Author: nikeokoronkwo

web_generator/lib/src/config.dart

@@ -3,9 +3,17 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:dart_style/dart_style.dart';
+import 'package:path/path.dart' as p;
 import 'package:pub_semver/pub_semver.dart';
 import 'package:yaml/yaml.dart';
 
+class FunctionConfig {
+  /// The number of variable arguments
+  final int? varArgs;
+
+  const FunctionConfig({this.varArgs});
+}
+
 abstract interface class Config {
   /// The name for the configuration
   String? get name;
@@ -28,13 +36,23 @@ abstract interface class Config {
   /// The Dart Language Version to use
   Version get languageVersion;
 
+  /// Function configuration
+  FunctionConfig? get functions;
+
   bool get singleFileOutput => input.length == 1;
 
-  factory Config({
-    required List<String> input,
-    required String output,
-    required Version languageVersion,
-  }) = ConfigImpl._;
+  /// Include the following declarations when generating JS interop code
+  ///
+  /// This could be a plain name for a declaration, or a [RegExp] pattern
+  /// If empty, all declarations will be generated by default
+  List<String> get includedDeclarations;
+
+  factory Config(
+      {required List<String> input,
+      required String output,
+      required Version languageVersion,
+      FunctionConfig? functions,
+      List<String> includedDeclarations}) = ConfigImpl._;
 }
 
 class ConfigImpl implements Config {
@@ -59,14 +77,20 @@ class ConfigImpl implements Config {
   @override
   String? preamble;
 
-  ConfigImpl._({
-    required this.input,
-    required this.output,
-    required this.languageVersion,
-  });
+  @override
+  FunctionConfig? functions;
+
+  @override
+  List<String> includedDeclarations;
+
+  ConfigImpl._(
+      {required this.input,
+      required this.output,
+      required this.languageVersion,
+      this.functions,
+      this.includedDeclarations = const []});
 
   @override
-  // TODO: implement singleFileOutput
   bool get singleFileOutput => input.length == 1;
 }
 
@@ -95,36 +119,58 @@ class YamlConfig implements Config {
   @override
   String? preamble;
 
+  @override
+  FunctionConfig? functions;
+
+  @override
+  List<String> includedDeclarations;
+
   YamlConfig._(
       {required this.filename,
       required this.input,
       required this.output,
       this.description,
       this.name,
       this.preamble,
+      this.functions,
+      this.includedDeclarations = const [],
       String? languageVersion})
       : languageVersion = languageVersion == null
             ? DartFormatter.latestLanguageVersion
             : Version.parse(languageVersion);
 
-  factory YamlConfig.fromYaml(YamlMap yaml, {required String filename}) {
-    List<String> input;
+  factory YamlConfig.fromYaml(YamlMap yaml,
+      {required String filename, List<String>? input, String? output}) {
+    List<String> inputFiles;
     final yamlInput = yaml['input'];
     if (yamlInput is YamlList) {
-      input = yamlInput.map((y) => y is String ? y : y.toString()).toList();
+      inputFiles =
+          yamlInput.map((y) => y is String ? y : y.toString()).toList();
     } else if (yamlInput is String) {
-      input = [yamlInput];
+      inputFiles = [yamlInput];
+    } else if (input != null) {
+      inputFiles = input;
     } else {
       throw TypeError();
     }
 
     return YamlConfig._(
         filename: Uri.file(filename),
-        input: input,
-        output: yaml['output'] as String,
+        input: inputFiles
+            .map((file) => p.join(p.dirname(filename), file))
+            .toList(),
+        output:
+            p.join(p.dirname(filename), (yaml['output'] ?? output) as String),
         name: yaml['name'] as String?,
         description: yaml['description'] as String?,
         languageVersion: yaml['language_version'] as String?,
-        preamble: yaml['preamble'] as String?);
+        preamble: yaml['preamble'] as String?,
+        // TODO: Can we consider using `json_serializable`?
+        functions: FunctionConfig(
+            varArgs: (yaml['functions'] as YamlMap?)?['varargs'] as int?),
+        includedDeclarations: (yaml['include'] as YamlList?)
+                ?.map<String>((node) => node.toString())
+                .toList() ??
+            []);
   }
 }

web_generator/lib/src/dart_main.dart

@@ -48,8 +48,10 @@ void main(List<String> args) async {
       final configContent = fs.readFileSync(
           filename.toJS, JSReadFileOptions(encoding: 'utf8'.toJS)) as JSString;
       final yaml = loadYamlDocument(configContent.toDart);
-      config =
-          YamlConfig.fromYaml(yaml.contents as YamlMap, filename: filename);
+      config = YamlConfig.fromYaml(
+        yaml.contents as YamlMap,
+        filename: filename,
+      );
     } else {
       config = Config(
         input: argResult['input'] as List<String>,
@@ -67,19 +69,23 @@ Future<void> generateJSInteropBindings(Config config) async {
   final jsDeclarations = parseDeclarationFiles(config.input);
 
   // transform declarations
-  final dartDeclarations = transform(jsDeclarations);
+  final dartDeclarations = transform(jsDeclarations, config: config);
 
   // generate
-  final generatedCodeMap = dartDeclarations.generate();
+  final generatedCodeMap = dartDeclarations.generate(config);
+
+  final configOutput = config.output;
+
+  if (generatedCodeMap.isEmpty) return;
 
   // write code to file
   if (generatedCodeMap.length == 1) {
     final entry = generatedCodeMap.entries.first;
-    fs.writeFileSync(config.output.toJS, entry.value.toJS);
+    fs.writeFileSync(configOutput.toJS, entry.value.toJS);
   } else {
     for (final entry in generatedCodeMap.entries) {
       fs.writeFileSync(
-          p.join(config.output, p.basename(entry.key)).toJS, entry.value.toJS);
+          p.join(configOutput, p.basename(entry.key)).toJS, entry.value.toJS);
     }
   }
 }

web_generator/lib/src/interop_gen/transform.dart

@@ -2,40 +2,59 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
+import 'dart:convert';
 import 'dart:js_interop';
 
 import 'package:code_builder/code_builder.dart';
 import 'package:dart_style/dart_style.dart';
 
 import '../ast/base.dart';
+import '../config.dart';
 import '../js/typescript.dart' as ts;
 import '../js/typescript.types.dart';
 import 'namer.dart';
 import 'parser.dart';
 import 'transform/transformer.dart';
 
+void _setGlobalOptions(Config config) {
+  GlobalOptions.variardicArgsCount = config.functions?.varArgs ?? 4;
+}
+
 class TransformResult {
   ProgramDeclarationMap programMap;
 
   TransformResult._(this.programMap);
 
   // TODO(https://github.com/dart-lang/web/issues/388): Handle union of overloads
   //  (namespaces + functions, multiple interfaces, etc)
-  Map<String, String> generate() {
+  Map<String, String> generate(Config config) {
     final emitter = DartEmitter.scoped(useNullSafetySyntax: true);
     final formatter = DartFormatter(
         languageVersion: DartFormatter.latestShortStyleLanguageVersion);
+
+    _setGlobalOptions(config);
+
     return programMap.map((file, declMap) {
       final specs = declMap.decls.values.map((d) {
         return switch (d) {
           final Declaration n => n.emit(),
           final Type _ => null,
         };
       }).whereType<Spec>();
-      final lib = Library((l) => l
-        ..ignoreForFile.addAll(
-            ['constant_identifier_names', 'non_constant_identifier_names'])
-        ..body.addAll(specs));
+      final lib = Library((l) {
+        if (config.preamble case final preamble?) {
+          l.comments.addAll(const LineSplitter().convert(preamble).map((l) {
+            if (l.startsWith('//')) {
+              return l.replaceFirst(RegExp(r'^\/\/\s*'), '');
+            }
+            return l;
+          }));
+        }
+        l
+          ..ignoreForFile.addAll(
+              ['constant_identifier_names', 'non_constant_identifier_names'])
+          ..body.addAll(specs);
+      });
       return MapEntry(
           file,
           formatter.format('${lib.accept(emitter)}'
@@ -60,26 +79,31 @@ extension type NodeMap._(Map<String, Node> decls) implements Map<String, Node> {
 
 typedef ProgramDeclarationMap = Map<String, NodeMap>;
 
-TransformResult transform(ParserResult parsedDeclarations) {
+TransformResult transform(ParserResult parsedDeclarations,
+    {required Config config}) {
   final programDeclarationMap = <String, NodeMap>{};
 
   for (final file in parsedDeclarations.files) {
     if (programDeclarationMap.containsKey(file)) continue;
 
-    transformFile(parsedDeclarations.program, file, programDeclarationMap);
+    transformFile(parsedDeclarations.program, file, programDeclarationMap,
+        config: config);
   }
 
   return TransformResult._(programDeclarationMap);
 }
 
 void transformFile(ts.TSProgram program, String file,
-    Map<String, NodeMap> programDeclarationMap) {
+    Map<String, NodeMap> programDeclarationMap,
+    {required Config config}) {
   final src = program.getSourceFile(file);
+
   if (src == null) return;
 
   final typeChecker = program.getTypeChecker();
 
-  final transformer = Transformer(programDeclarationMap, typeChecker);
+  final transformer = Transformer(programDeclarationMap, typeChecker,
+      filterDeclSet: config.includedDeclarations);
 
   ts.forEachChild(
       src,

web_generator/lib/src/interop_gen/transform/transformer.dart

@@ -23,17 +23,28 @@ class Transformer {
   /// The type checker for the given program
   final ts.TSTypeChecker typeChecker;
 
-  /// A set of declarations to export
+  /// A set of declarations to export updated during transformation
   final Set<String> exportSet;
 
+  /// A set of declarations to filter for
+  final List<String> filterDeclSet;
+
+  /// The declarations as globs
+  List<RegExp> get filterDeclSetPatterns => filterDeclSet.map((decl) {
+        final escapedDecl = RegExp.escape(decl);
+        if (escapedDecl == decl) return RegExp('^$decl\$');
+        return RegExp(decl);
+      }).toList();
+
   /// namer, for giving elements unique names
   final UniqueNamer namer;
 
   final ProgramDeclarationMap programMap;
 
   Transformer(this.programMap, this.typeChecker,
-      {Iterable<String> exportSet = const []})
+      {Set<String> exportSet = const {}, List<String> filterDeclSet = const []})
       : exportSet = exportSet.toSet(),
+        filterDeclSet = filterDeclSet.toList(),
         namer = UniqueNamer();
 
   void transform(TSNode node) {
@@ -433,14 +444,13 @@ class Transformer {
 
     // filter out for export declarations
     nodeMap.forEach((id, node) {
-      if (exportSet.contains(node.name)) {
-        filteredDeclarations[id] = node;
-      }
-
       // get decls with `export` keyword
       switch (node) {
         case final ExportableDeclaration e:
-          if (e.exported) {
+          if (e.exported &&
+              (filterDeclSet.isEmpty ||
+                  filterDeclSetPatterns
+                      .any((pattern) => pattern.hasMatch(e.name)))) {
             filteredDeclarations.add(e);
           }
           break;

web_generator/test/assets/config.yaml

@@ -0,0 +1,18 @@
+name: Interop Config Test
+preamble: |
+  // This preamble is for testing only.
+  // GENERATED FILE: DO NOT EDIT
+  // 
+  // Created by `web_generator`
+input: test.d.ts
+output: '../../.dart_tool/test_config.dart'
+include:
+  - APP_NAME
+  - "(.*)User" # Glob
+  - "user*" # Glob
+  - currentUserCount
+  - toggleAdminMode
+  - systemStatus
+  - changeRoleOfSetOfUsers
+functions:
+  varargs: 8

web_generator/test/assets/test.d.ts

@@ -0,0 +1,32 @@
+declare enum UserRole {
+    Guest = 0,
+    Viewer = 1,
+    Editor = 2,
+    Administrator = 3
+}
+declare enum HttpStatusCode {
+    OK = "200 OK",
+    CREATED = "201 Created",
+    BAD_REQUEST = "400 Bad Request",
+    UNAUTHORIZED = "401 Unauthorized",
+    NOT_FOUND = "404 Not Found",
+    INTERNAL_SERVER_ERROR = "500 Internal Server Error"
+}
+export declare const APP_NAME: string;
+export declare const APP_NAMES: string;
+declare let currentUserCount: number;
+declare let isAdminMode: boolean;
+declare let systemStatus: string;
+type User = string;
+export declare function initializeApp(): void;
+export declare function loginUser(username: string, role: UserRole): User;
+export declare function changeRoleOfUser(user: User, newRole: UserRole): User;
+export declare function changeRoleOfUsers(newRole: UserRole, ...users: User[]): User[]; /* Once we add maps, make this a map */
+export declare function changeRoleOfSetOfUsers(newRole: UserRole, ...users: User[]): User[];
+export declare function logoutUser(user: User): void;
+export declare function changeSystemStatus(newStatus: string): void;
+export declare function toggleAdminMode(): void;
+export declare function processHttpRequest(statusCode: HttpStatusCode): void;
+export declare const user1: User;
+export declare const user2: User;
+export declare const adminUser: User;