5d3ba8dec7
Previously the instructions were included in the golden files to monitor the frequency and rate of the instruction API changes for the purpose of understanding the stability of this API (as it was considered for becoming a public API and deployed to npm via generated code). This experiment has confirmed that the instruction API is not stable enough to be used as public API. We've since also came up with an alternative plan to compile libraries with the Ivy compiler for npm deployment and this plan does not rely on making Ivy instructions public. For these reasons, I'm removing the instructions from the golden files as it's no longer important to track them. The are three instructions that are still being included: `ɵɵdefineInjectable`, `ɵɵinject`, and `ɵɵInjectableDef`. These instructions are already generated by the VE compiler to support tree-shakable providers, and code depending on these instructions is already deployed to npm. For this reason we need to treat them as public api. This change also reduces the code review overhead, because changes to public api golden files now require multiple approvals. PR Close #38224
141 lines
4.6 KiB
Python
141 lines
4.6 KiB
Python
# Copyright 2017 The Bazel Authors. All rights reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
"""Runs ts_api_guardian
|
|
"""
|
|
|
|
load("@build_bazel_rules_nodejs//:index.bzl", "nodejs_binary", "nodejs_test")
|
|
|
|
COMMON_MODULE_IDENTIFIERS = ["angular", "jasmine", "protractor", "Symbol"]
|
|
|
|
def ts_api_guardian_test(
|
|
name,
|
|
golden,
|
|
actual,
|
|
data = [],
|
|
strip_export_pattern = [],
|
|
allow_module_identifiers = COMMON_MODULE_IDENTIFIERS,
|
|
use_angular_tag_rules = True,
|
|
**kwargs):
|
|
"""Runs ts_api_guardian
|
|
"""
|
|
data += [
|
|
# Locally we need to add the TS build target
|
|
# But it will replaced to @npm//ts-api-guardian when publishing
|
|
"@angular//tools/ts-api-guardian:lib",
|
|
"@angular//tools/ts-api-guardian:bin",
|
|
# The below are required during runtime
|
|
"@npm//chalk",
|
|
"@npm//diff",
|
|
"@npm//minimist",
|
|
"@npm//typescript",
|
|
]
|
|
|
|
args = [
|
|
# Needed so that node doesn't walk back to the source directory.
|
|
# From there, the relative imports would point to .ts files.
|
|
"--node_options=--preserve-symlinks",
|
|
]
|
|
|
|
for i in strip_export_pattern:
|
|
# Quote the regexp before passing it via the command line.
|
|
quoted_pattern = "\"%s\"" % i
|
|
args += ["--stripExportPattern", quoted_pattern]
|
|
|
|
for i in allow_module_identifiers:
|
|
args += ["--allowModuleIdentifiers", i]
|
|
|
|
if use_angular_tag_rules:
|
|
args += ["--useAngularTagRules"]
|
|
|
|
nodejs_test(
|
|
name = name,
|
|
data = data,
|
|
entry_point = "@angular//tools/ts-api-guardian:bin/ts-api-guardian",
|
|
tags = kwargs.pop("tags", []) + ["api_guard"],
|
|
templated_args = args + ["--verify", golden, actual],
|
|
**kwargs
|
|
)
|
|
|
|
nodejs_binary(
|
|
name = name + ".accept",
|
|
testonly = True,
|
|
data = data,
|
|
entry_point = "@angular//tools/ts-api-guardian:bin/ts-api-guardian",
|
|
tags = kwargs.pop("tags", []) + ["api_guard"],
|
|
templated_args = args + ["--out", golden, actual],
|
|
**kwargs
|
|
)
|
|
|
|
def ts_api_guardian_test_npm_package(
|
|
name,
|
|
goldenDir,
|
|
actualDir,
|
|
data = [],
|
|
strip_export_pattern = ["^ɵ(?!ɵdefineInjectable|ɵinject|ɵInjectableDef)"],
|
|
allow_module_identifiers = COMMON_MODULE_IDENTIFIERS,
|
|
use_angular_tag_rules = True,
|
|
**kwargs):
|
|
"""Runs ts_api_guardian
|
|
"""
|
|
data += [
|
|
# Locally we need to add the TS build target
|
|
# But it will replaced to @npm//ts-api-guardian when publishing
|
|
"@angular//tools/ts-api-guardian:lib",
|
|
"@angular//tools/ts-api-guardian:bin",
|
|
# The below are required during runtime
|
|
"@npm//chalk",
|
|
"@npm//diff",
|
|
"@npm//minimist",
|
|
"@npm//typescript",
|
|
]
|
|
|
|
args = [
|
|
# Needed so that node doesn't walk back to the source directory.
|
|
# From there, the relative imports would point to .ts files.
|
|
"--node_options=--preserve-symlinks",
|
|
# We automatically discover the enpoints for our NPM package.
|
|
"--autoDiscoverEntrypoints",
|
|
]
|
|
|
|
for i in strip_export_pattern:
|
|
# Quote the regexp before passing it via the command line.
|
|
quoted_pattern = "\"%s\"" % i
|
|
args += ["--stripExportPattern", quoted_pattern]
|
|
|
|
for i in allow_module_identifiers:
|
|
args += ["--allowModuleIdentifiers", i]
|
|
|
|
if use_angular_tag_rules:
|
|
args += ["--useAngularTagRules"]
|
|
|
|
nodejs_test(
|
|
name = name,
|
|
data = data,
|
|
entry_point = "@angular//tools/ts-api-guardian:bin/ts-api-guardian",
|
|
tags = kwargs.pop("tags", []) + ["api_guard"],
|
|
templated_args = args + ["--autoDiscoverEntrypoints", "--verifyDir", goldenDir, "--rootDir", "$(rlocation %s)" % actualDir],
|
|
**kwargs
|
|
)
|
|
|
|
nodejs_binary(
|
|
name = name + ".accept",
|
|
testonly = True,
|
|
data = data,
|
|
entry_point = "@angular//tools/ts-api-guardian:bin/ts-api-guardian",
|
|
tags = kwargs.pop("tags", []) + ["api_guard"],
|
|
templated_args = args + ["--autoDiscoverEntrypoints", "--outDir", goldenDir, "--rootDir", "$(rlocation %s)" % actualDir],
|
|
**kwargs
|
|
)
|