IDL compiler: Support context-{in,}dependence of runtime-enabled feat…

…ures

Makes the IDL compiler processes runtime_enabled_features.json5
and makes Exposure aware of context-dependent and context-
independent runtime enabled features.

Bug: 839389
Change-Id: I2d46730f22866f6f677a96dbd7a72644253e4692
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1892973
Commit-Queue: Yuki Shiino <yukishiino@chromium.org>
Reviewed-by: Hitoshi Yoshida <peria@chromium.org>
Cr-Commit-Position: refs/heads/master@{#711998}

third_party/blink/renderer/bindings/BUILD.gn

@@ -88,7 +88,7 @@ collect_idl_files("web_idl_in_core") {
   inputs += [ "${bindings_scripts_dir}/web_idl/migration_adapter.idl" ]
 
   # Additional IDL files to test and demonstrate the new IDL compiler.
-  inputs += [ "${bindings_scripts_dir}/web_idl/idl_compiler_test.idl" ]
+  inputs += [ "${bindings_scripts_dir}/web_idl/demonstration_and_testing.idl" ]
 
   component = "core"
   output = "${bindings_output_dir}/web_idl_in_core.pickle"
@@ -111,7 +111,13 @@ action_with_pydeps("web_idl_database") {
 
   input_data_files = get_target_outputs(":web_idl_in_core") +
                      get_target_outputs(":web_idl_in_modules")
-  inputs = input_data_files
+  runtime_enabled_features_file = "../platform/runtime_enabled_features.json5"
+  runtime_enabled_features_test_file =
+      "${bindings_scripts_dir}/web_idl/runtime_enabled_features.json5"
+  inputs = input_data_files + [
+             runtime_enabled_features_file,
+             runtime_enabled_features_test_file,
+           ]
   output_data_file = "${bindings_output_dir}/web_idl_database.pickle"
   outputs = [
     output_data_file,
@@ -120,6 +126,10 @@ action_with_pydeps("web_idl_database") {
   args = [
            "--output",
            rebase_path(output_data_file, root_build_dir),
+           "--runtime_enabled_features",
+           rebase_path(runtime_enabled_features_file, root_build_dir),
+           "--runtime_enabled_features",
+           rebase_path(runtime_enabled_features_test_file, root_build_dir),
            "--",
          ] + rebase_path(input_data_files, root_build_dir)
 

third_party/blink/renderer/bindings/scripts/build_web_idl_database.py

@@ -19,10 +19,15 @@ def parse_options():
     parser = optparse.OptionParser()
     parser.add_option('--output', type='string',
                       help="filepath of the resulting database")
+    parser.add_option('--runtime_enabled_features', type='string',
+                      action='append',
+                      help="filepath to runtime_enabled_features.json5")
     options, args = parser.parse_args()
 
-    if options.output is None:
-        parser.error("Specify a filepath of the database with --output.")
+    required_option_names = ('output', 'runtime_enabled_features')
+    for opt_name in required_option_names:
+        if getattr(options, opt_name) is None:
+            parser.error("--{} is a required option.".format(opt_name))
 
     if not args:
         parser.error("No argument specified.")
@@ -33,6 +38,9 @@ def parse_options():
 def main():
     options, filepaths = parse_options()
 
+    web_idl.init(
+        runtime_enabled_features_paths=options.runtime_enabled_features)
+
     was_error_reported = [False]
 
     def report_error(message):

third_party/blink/renderer/bindings/scripts/build_web_idl_database.pydeps

@@ -1,5 +1,12 @@
 # Generated by running:
 #   build/print_python_deps.py --root third_party/blink/renderer/bindings/scripts --output third_party/blink/renderer/bindings/scripts/build_web_idl_database.pydeps third_party/blink/renderer/bindings/scripts/build_web_idl_database.py
+../../../../pyjson5/src/json5/__init__.py
+../../../../pyjson5/src/json5/arg_parser.py
+../../../../pyjson5/src/json5/host.py
+../../../../pyjson5/src/json5/lib.py
+../../../../pyjson5/src/json5/parser.py
+../../../../pyjson5/src/json5/tool.py
+../../../../pyjson5/src/json5/version.py
 ../../build/scripts/blinkbuild/__init__.py
 ../../build/scripts/blinkbuild/name_style_converter.py
 build_web_idl_database.py
@@ -33,6 +40,7 @@ web_idl/namespace.py
 web_idl/operation.py
 web_idl/overload_group.py
 web_idl/reference.py
+web_idl/runtime_enabled_features.py
 web_idl/typedef.py
 web_idl/union.py
 web_idl/user_defined_type.py

third_party/blink/renderer/bindings/scripts/collect_idl_files.pydeps

@@ -7,6 +7,13 @@
 ../../../../ply/__init__.py
 ../../../../ply/lex.py
 ../../../../ply/yacc.py
+../../../../pyjson5/src/json5/__init__.py
+../../../../pyjson5/src/json5/arg_parser.py
+../../../../pyjson5/src/json5/host.py
+../../../../pyjson5/src/json5/lib.py
+../../../../pyjson5/src/json5/parser.py
+../../../../pyjson5/src/json5/tool.py
+../../../../pyjson5/src/json5/version.py
 ../../build/scripts/blinkbuild/__init__.py
 ../../build/scripts/blinkbuild/name_style_converter.py
 blink_idl_lexer.py
@@ -43,6 +50,7 @@ web_idl/namespace.py
 web_idl/operation.py
 web_idl/overload_group.py
 web_idl/reference.py
+web_idl/runtime_enabled_features.py
 web_idl/typedef.py
 web_idl/union.py
 web_idl/user_defined_type.py

third_party/blink/renderer/bindings/scripts/generate_bindings.pydeps

@@ -17,6 +17,13 @@
 ../../../../mako/mako/runtime.py
 ../../../../mako/mako/template.py
 ../../../../mako/mako/util.py
+../../../../pyjson5/src/json5/__init__.py
+../../../../pyjson5/src/json5/arg_parser.py
+../../../../pyjson5/src/json5/host.py
+../../../../pyjson5/src/json5/lib.py
+../../../../pyjson5/src/json5/parser.py
+../../../../pyjson5/src/json5/tool.py
+../../../../pyjson5/src/json5/version.py
 ../../build/scripts/blinkbuild/__init__.py
 ../../build/scripts/blinkbuild/name_style_converter.py
 bind_gen/__init__.py
@@ -56,6 +63,7 @@ web_idl/namespace.py
 web_idl/operation.py
 web_idl/overload_group.py
 web_idl/reference.py
+web_idl/runtime_enabled_features.py
 web_idl/typedef.py
 web_idl/union.py
 web_idl/user_defined_type.py

third_party/blink/renderer/bindings/scripts/web_idl/__init__.py

@@ -19,6 +19,8 @@ def _setup_sys_path():
                      'scripts'),
         # //third_party/ply
         os.path.join(root_dir, 'third_party'),
+        # //third_party/pyjson5/src/json5
+        os.path.join(root_dir, 'third_party', 'pyjson5', 'src'),
         # //tools/idl_parser
         os.path.join(root_dir, 'tools'),
     ] + sys.path
@@ -31,6 +33,16 @@ def _setup_sys_path():
 from .composition_parts import Component
 from .database import Database
 from .database_builder import build_database
+from .runtime_enabled_features import RuntimeEnabledFeatures
+
+
+def init(runtime_enabled_features_paths):
+    """
+    Args:
+        runtime_enabled_features_paths: Paths to the definition files of
+            runtime-enabled features ("runtime_enabled_features.json5").
+    """
+    RuntimeEnabledFeatures.init(filepaths=runtime_enabled_features_paths)
 
 
 __all__ = [

third_party/blink/renderer/bindings/scripts/web_idl/database_builder.py

@@ -2,10 +2,10 @@
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
-from .ir_map import IRMap
 from .idl_compiler import IdlCompiler
 from .idl_type import IdlTypeFactory
 from .ir_builder import load_and_register_idl_definitions
+from .ir_map import IRMap
 from .reference import RefByIdFactory
 
 
@@ -20,17 +20,22 @@ def build_database(filepaths, report_error):
             error message of type str and return value is not used.  It's okay
             to terminate the program in this callback.
     """
+    assert isinstance(filepaths, (list, tuple))
+    assert all(isinstance(filepath, str) for filepath in filepaths)
+    assert callable(report_error)
 
     ir_map = IRMap()
     ref_to_idl_type_factory = RefByIdFactory()
     ref_to_idl_def_factory = RefByIdFactory()
     idl_type_factory = IdlTypeFactory()
+
     load_and_register_idl_definitions(
         filepaths=filepaths,
         register_ir=ir_map.register,
         create_ref_to_idl_def=ref_to_idl_def_factory.create,
         create_ref_to_idl_type=ref_to_idl_type_factory.create,
         idl_type_factory=idl_type_factory)
+
     compiler = IdlCompiler(
         ir_map=ir_map,
         ref_to_idl_def_factory=ref_to_idl_def_factory,

third_party/blink/renderer/bindings/scripts/web_idl/idl_compiler_test.idl → third_party/blink/renderer/bindings/scripts/web_idl/demonstration_and_testing.idl

@@ -2,13 +2,19 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
+
+// This file is used only during the development of the new bindings generator
+// (especially until we'll have a good test suite) and pretty much temporary.
+// The IDL definitions in this file are used for half testing purpose and for
+// half demonstration purpose of the new bindings generator.
+
 [
   Exposed=Window
 ] interface TestInterfaceConstructor {
   constructor();
   constructor(DOMString arg1);
   [Custom] constructor(Node node);
-  [RuntimeEnabled=Hoge] constructor(long num);
+  [RuntimeEnabled=TestFeature1] constructor(long num);
 };
 
 namespace TestNamespace {

third_party/blink/renderer/bindings/scripts/web_idl/exposure.py

@@ -2,6 +2,8 @@
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
+from .runtime_enabled_features import RuntimeEnabledFeatures
+
 
 class _GlobalNameAndFeature(object):
     def __init__(self, global_name, feature=None):
@@ -29,12 +31,18 @@ def __init__(self, other=None):
                 other.global_names_and_features)
             self._runtime_enabled_features = tuple(
                 other.runtime_enabled_features)
+            self._context_independent_runtime_enabled_features = tuple(
+                other.context_independent_runtime_enabled_features)
+            self._context_dependent_runtime_enabled_features = tuple(
+                other.context_dependent_runtime_enabled_features)
             self._context_enabled_features = tuple(
                 other.context_enabled_features)
             self._only_in_secure_contexts = other.only_in_secure_contexts
         else:
             self._global_names_and_features = tuple()
             self._runtime_enabled_features = tuple()
+            self._context_independent_runtime_enabled_features = tuple()
+            self._context_dependent_runtime_enabled_features = tuple()
             self._context_enabled_features = tuple()
             self._only_in_secure_contexts = None
 
@@ -54,6 +62,16 @@ def runtime_enabled_features(self):
         """
         return self._runtime_enabled_features
 
+    @property
+    def context_independent_runtime_enabled_features(self):
+        """Returns runtime enabled features that are context-independent."""
+        return self._context_independent_runtime_enabled_features
+
+    @property
+    def context_dependent_runtime_enabled_features(self):
+        """Returns runtime enabled features that are context-dependent."""
+        return self._context_dependent_runtime_enabled_features
+
     @property
     def context_enabled_features(self):
         """
@@ -83,6 +101,8 @@ def __init__(self):
 
         self._global_names_and_features = []
         self._runtime_enabled_features = []
+        self._context_independent_runtime_enabled_features = []
+        self._context_dependent_runtime_enabled_features = []
         self._context_enabled_features = []
         self._only_in_secure_contexts = None
 
@@ -98,6 +118,10 @@ def add_global_name_and_feature(self, global_name, feature_name=None):
 
     def add_runtime_enabled_feature(self, name):
         assert isinstance(name, str)
+        if RuntimeEnabledFeatures.is_context_dependent(name):
+            self._context_dependent_runtime_enabled_features.append(name)
+        else:
+            self._context_independent_runtime_enabled_features.append(name)
         self._runtime_enabled_features.append(name)
 
     def add_context_enabled_feature(self, name):

third_party/blink/renderer/bindings/scripts/web_idl/idl_compiler.py

@@ -13,9 +13,9 @@
 from .database import DatabaseBody
 from .dictionary import Dictionary
 from .enumeration import Enumeration
-from .ir_map import IRMap
 from .idl_type import IdlTypeFactory
 from .interface import Interface
+from .ir_map import IRMap
 from .make_copy import make_copy
 from .namespace import Namespace
 from .operation import OperationGroup

third_party/blink/renderer/bindings/scripts/web_idl/runtime_enabled_features.json5

@@ -0,0 +1,23 @@
+// Copyright 2019 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+
+// This file is used only for testing purposes, and is never used for
+// production.  For production purposes, see the following file:
+//     //third_party/blink/renderer/platform/runtime_enabled_features.json5
+//
+// This file is used to add runtime enabled features in order to test the Web
+// IDL compiler and bindings code generator.
+
+{
+  data: [
+    {
+      name: "TestFeature1",
+    },
+    {
+      name: "TestFeature2",
+      origin_trial_feature_name: "TestFeature2",
+    },
+  ]
+}

third_party/blink/renderer/bindings/scripts/web_idl/runtime_enabled_features.py

@@ -0,0 +1,44 @@
+# Copyright 2019 The Chromium Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+import json5
+
+
+class RuntimeEnabledFeatures(object):
+    """Represents a set of definitions of runtime enabled features."""
+
+    _REQUIRE_INIT_MESSAGE = (
+        "RuntimeEnabledFeatures.init must be called in advance.")
+
+    @classmethod
+    def init(cls, filepaths):
+        """
+        Args:
+            filepaths: Paths to the definition files of runtime-enabled features
+                ("runtime_enabled_features.json5").
+        """
+        assert isinstance(filepaths, list)
+        assert all(isinstance(filepath, str) for filepath in filepaths)
+
+        cls._features = {}
+
+        for filepath in filepaths:
+            with open(filepath) as file_obj:
+                datastore = json5.load(file_obj)
+
+            for entry in datastore["data"]:
+                assert entry["name"] not in cls._features
+                cls._features[entry["name"]] = entry
+
+        cls._is_initialized = True
+
+    @classmethod
+    def is_context_dependent(cls, feature_name):
+        """Returns True if the feature may be enabled per-context."""
+        assert cls._is_initialized, _REQUIRE_INIT_MESSAGE
+        assert isinstance(feature_name, str)
+        assert feature_name in cls._features, (
+            "Unknown runtime-enabled feature: {}".format(feature_name))
+        return cls._features[feature_name].get(
+            "origin_trial_feature_name") is not None