[pigeon] Adds ProxyApi code generation for Dart #5544

bparrishMines · 2023-12-03T00:33:57Z

Part of flutter/flutter#134777

Splits Api into AstHostApi/AstFlutterApi/AstProxyApi. I prefixed it with Ast since the annotations already had the names HostApi, etc...;
Api.location was moved to Method.location since AstProxyApi has methods implemented on the host and Flutter side.
Replaces a few of the methods in lib/functional.dart with the package:collection equivalent.
DartGenerator.writeProxyApi uses code_builder and dart_style which I added to the allowed deps config file.

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

…r_dart

stuartmorgan-g

I left some high-level comments; @tarrinneal should be the main reviewer for most of the details.

I didn't review the generated code since I'm assuming it's not substantially changed from the webview_flutter version. If there's anything there you do want me to look at, let me know!

One thing that wasn't immediately obvious to me without tracing all the logic: are the big blocks of generated code conditional on using them? I.e., would this be basically a no-op for people not using proxy APIs, or would they suddenly get thousands of new lines of generated code they didn't need?

stuartmorgan-g · 2024-01-08T20:26:59Z

packages/pigeon/lib/ast.dart

+}
+
+/// Represents a constructor for an API.
+class Constructor extends Node {


Why does a constructor have to be a special type? It seems like all the properties are standard method properties.

I think this is similar to our discussion about parameter vs field. They overlap but some of the parameters don't apply (e.g. static/isAsynchronous). However, if I consider the Method as the message call and not the AST class member, then I suppose they are essentially the same thing. I still need to distinguish the difference between Constructors for the Dart code generation, so I think I will keep the class and have it extend Method.

stuartmorgan-g · 2024-01-08T20:30:12Z

packages/pigeon/lib/dart_generator.dart

+      },
+    );
+    indent.format('''
+/// Maintains instances used to communicate with the native objects they


I think we should probably put giant strings like this into a helper file, wrapped in a method that takes all the necessary variables, but without any logic ideally.

stuartmorgan-g · 2024-01-08T20:32:19Z

packages/pigeon/lib/dart_generator.dart

+          ]),
+      ),
+    ];
+  }


This is quite a method.

Maybe we could have a separate file for all the proxy-specific code? Then it would be easier to do things like extract helpers for different sections without overwhelming the rest of this file.

stuartmorgan-g · 2024-01-08T20:33:07Z

packages/pigeon/lib/dart_generator.dart

+}''');
+  }
+
+  void _writeFlutterMethodMessageHandler(


Some of these incidental refactors could ideally be done in a prequel PR that would be trivial to review.

stuartmorgan-g · 2024-01-08T20:33:10Z

packages/pigeon/lib/dart_generator.dart

+}''');
+  }
+
+  void _writeFlutterMethodMessageHandler(


Some of these incidental refactors could ideally be done in a prequel PR that would be trivial to review.

stuartmorgan-g · 2024-01-08T20:36:45Z

packages/pigeon/lib/pigeon_lib.dart

@@ -1335,6 +1767,88 @@ class _RootBuilder extends dart_ast_visitor.RecursiveAstVisitor<Object?> {
            message: 'Expected a named type but found "$node".',
            lineNumber: _calculateLineNumber(source, node.offset)));
      }
+    } else if (_currentApi is AstProxyApi) {


Can we extract all of this block to a helper?

Done in #5861

stuartmorgan-g · 2024-01-08T20:38:13Z

packages/pigeon/pigeons/core_tests.dart

@@ -699,3 +699,460 @@ class TestMessage {
  // ignore: always_specify_types, strict_raw_type
  List? testList;
 }
+
+/// The core interface that each host language plugin must implement in


This may be a case where we do actually want to make a second file instead of putting everything into the one giant file?

bparrishMines · 2024-01-10T19:41:40Z

I'm going to mark this as a draft and split it up into simpler PRs. I will still keep this PR open since it is still useful to demonstrate all the changes put together.

…r_dart

bparrishMines · 2024-01-13T22:18:11Z

One thing that wasn't immediately obvious to me without tracing all the logic: are the big blocks of generated code conditional on using them? I.e., would this be basically a no-op for people not using proxy APIs, or would they suddenly get thousands of new lines of generated code they didn't need?

Yes, the generation of the InstanceManager/InstanceManagerApi/ProxyApiCode are all dependent on whether there is a ProxyApi. I will include a test for this in the PR that implements the code generation.

… in the `DartGenerator` (#5859) Separates message call code generation into separate methods in the `DartGenerator` for flutter/flutter#134777. The `ProxyApi` generator uses similar code to the `HostApi` and `FlutterApi`, so this makes the code reusable. Separated from #5544 From suggestion: #5544 (comment)

… in the KotlinGenerator (#5891) Separates message call code generation into separate methods in the KotlinGenerator for flutter/flutter#134777. The ProxyApi generator uses similar code to the HostApi and FlutterApi, so this makes the code reusable. From suggestion: #5544 (comment)

bparrishMines · 2024-02-28T21:48:22Z

closing if favor of #6043

… in the SwiftGenerator (#5959) Separates message call code generation into separate methods in the SwiftGenerator for flutter/flutter#134777. The ProxyApi generator uses similar code to the HostApi and FlutterApi, so this makes the code reusable. From suggestion: #5544 (comment)

… in the SwiftGenerator (flutter#5959) Separates message call code generation into separate methods in the SwiftGenerator for flutter/flutter#134777. The ProxyApi generator uses similar code to the HostApi and FlutterApi, so this makes the code reusable. From suggestion: flutter#5544 (comment)

… in the `DartGenerator` (flutter#5859) Separates message call code generation into separate methods in the `DartGenerator` for flutter/flutter#134777. The `ProxyApi` generator uses similar code to the `HostApi` and `FlutterApi`, so this makes the code reusable. Separated from flutter#5544 From suggestion: flutter#5544 (comment)

… in the KotlinGenerator (flutter#5891) Separates message call code generation into separate methods in the KotlinGenerator for flutter/flutter#134777. The ProxyApi generator uses similar code to the HostApi and FlutterApi, so this makes the code reusable. From suggestion: flutter#5544 (comment)

… in the SwiftGenerator (flutter#5959) Separates message call code generation into separate methods in the SwiftGenerator for flutter/flutter#134777. The ProxyApi generator uses similar code to the HostApi and FlutterApi, so this makes the code reusable. From suggestion: flutter#5544 (comment)

bparrishMines added 2 commits November 30, 2023 13:52

update ast

169cd76

update pigeon_lib

9d4f82c

github-actions bot added the p: pigeon label Dec 3, 2023

fix unit tests

b5d7fcd

github-actions bot added platform-android p: webview_flutter labels Dec 3, 2023

bparrishMines added 7 commits December 3, 2023 00:08

add impls for instancemanager and instancemanager api

740a395

add write proxy api impl

304e1a0

fix comments

968715d

update constructors

4628c70

add field impls

4f643eb

fix methods

8a87f7f

Merge branch 'main' of github.com:flutter/packages into pigeon_wrappe…

eaef031

…r_dart

github-actions bot removed platform-android p: webview_flutter labels Dec 5, 2023

bparrishMines added 6 commits December 5, 2023 14:07

add helper methods to astproxyapi

bb052eb

Merge branch 'main' of github.com:flutter/packages into pigeon_wrappe…

c4b7c26

…r_dart

start of something

e73f881

use dart extends/implements

3898970

validate ast work

e216947

verify constructor parameters and that all classes are proxyapis

2604466

github-actions bot added platform-android p: webview_flutter labels Dec 7, 2023

bparrishMines added 7 commits December 8, 2023 12:05

inheritance chaecker validator

8fdcca4

fix tests

5863c68

undo making validate async

b7ec6ca

finish proxyapi validation (maybe)

be1f9fb

undo pubspec change

abf11b6

Merge branch 'main' of github.com:flutter/packages into pigeon_wrappe…

f31df3b

…r_dart

version bump

8a35b5e

bparrishMines added 12 commits January 2, 2024 23:20

Merge branch 'main' of github.com:flutter/packages into pigeon_wrappe…

036d12c

…r_dart

Merge branch 'main' of github.com:flutter/packages into pigeon_wrappe…

f5c0ee0

…r_dart

Merge branch 'main' of github.com:flutter/packages into pigeon_wrappe…

2e47909

…r_dart

dont have repeating code start

716cd79

fix up host methods

1630fa6

update fields

6fb56be

reuse flutter method call code

139e3df

gross fix for whether to null out handlers

ec6b94f

update setUpMessageHandler with same thing from the commit above

89daaea

fix unit tests

79f9afa

use param

cd58d50

Merge branch 'main' of github.com:flutter/packages into pigeon_wrappe…

f1d4f7a

…r_dart

stuartmorgan-g reviewed Jan 8, 2024

View reviewed changes

bparrishMines marked this pull request as draft January 10, 2024 19:41

Merge branch 'main' of github.com:flutter/packages into pigeon_wrappe…

67f2818

…r_dart

bparrishMines mentioned this pull request Jan 10, 2024

[pigeon] Separates message call code generation into separate methods in the DartGenerator #5859

Merged

11 tasks

bparrishMines mentioned this pull request Jan 13, 2024

[pigeon] Separates message call code generation into separate methods in the KotlinGenerator #5891

Merged

11 tasks

bparrishMines mentioned this pull request Jan 23, 2024

[pigeon] Separates message call code generation into separate methods in the SwiftGenerator #5959

Merged

11 tasks

bparrishMines closed this Feb 28, 2024

bparrishMines deleted the pigeon_wrapper_dart branch February 29, 2024 18:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[pigeon] Adds ProxyApi code generation for Dart #5544

[pigeon] Adds ProxyApi code generation for Dart #5544

bparrishMines commented Dec 3, 2023 •

edited

Loading

stuartmorgan-g left a comment

stuartmorgan-g Jan 8, 2024

bparrishMines Jan 10, 2024

stuartmorgan-g Jan 8, 2024

stuartmorgan-g Jan 8, 2024

stuartmorgan-g Jan 8, 2024

stuartmorgan-g Jan 8, 2024

stuartmorgan-g Jan 8, 2024

bparrishMines Jan 13, 2024

stuartmorgan-g Jan 8, 2024

bparrishMines commented Jan 10, 2024

bparrishMines commented Jan 13, 2024

bparrishMines commented Feb 28, 2024

[pigeon] Adds ProxyApi code generation for Dart #5544

[pigeon] Adds ProxyApi code generation for Dart #5544

Conversation

bparrishMines commented Dec 3, 2023 • edited Loading

Pre-launch Checklist

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bparrishMines commented Jan 10, 2024

bparrishMines commented Jan 13, 2024

bparrishMines commented Feb 28, 2024

bparrishMines commented Dec 3, 2023 •

edited

Loading