Skip to content

ABI checker: we should also print ABI breakages when diagnostics are serialized #60834

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

Merged
merged 1 commit into from
Aug 30, 2022
Merged
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
15 changes: 6 additions & 9 deletions include/swift/APIDigester/ModuleDiagsConsumer.h
Original file line number Diff line number Diff line change
Expand Up @@ -44,23 +44,20 @@ class ModuleDifferDiagsConsumer: public PrintingDiagnosticConsumer {

class FilteringDiagnosticConsumer: public DiagnosticConsumer {
bool HasError = false;
std::unique_ptr<DiagnosticConsumer> subConsumer;
std::vector<std::unique_ptr<DiagnosticConsumer>> subConsumers;
std::unique_ptr<llvm::StringSet<>> allowedBreakages;
bool shouldProceed(const DiagnosticInfo &Info);
public:
FilteringDiagnosticConsumer(std::unique_ptr<DiagnosticConsumer> subConsumer,
FilteringDiagnosticConsumer(std::vector<std::unique_ptr<DiagnosticConsumer>> subConsumers,
std::unique_ptr<llvm::StringSet<>> allowedBreakages):
subConsumer(std::move(subConsumer)),
subConsumers(std::move(subConsumers)),
allowedBreakages(std::move(allowedBreakages)) {}
~FilteringDiagnosticConsumer() = default;

bool finishProcessing() override { return subConsumer->finishProcessing(); }
void flush() override;
void informDriverOfIncompleteBatchModeCompilation() override;
bool finishProcessing() override;
bool hasError() const { return HasError; }
void flush() override { subConsumer->flush(); }

void informDriverOfIncompleteBatchModeCompilation() override {
subConsumer->informDriverOfIncompleteBatchModeCompilation();
}

void handleDiagnostic(SourceManager &SM,
const DiagnosticInfo &Info) override;
Expand Down
27 changes: 24 additions & 3 deletions lib/APIDigester/ModuleDiagsConsumer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,27 @@ swift::ide::api::ModuleDifferDiagsConsumer::~ModuleDifferDiagsConsumer() {
}
}

bool swift::ide::api::
FilteringDiagnosticConsumer::shouldProceed(const DiagnosticInfo &Info) {
void swift::ide::api::FilteringDiagnosticConsumer::flush() {
for (auto &consumer: subConsumers) {
consumer->flush();
}
}

void swift::ide::api::
FilteringDiagnosticConsumer::informDriverOfIncompleteBatchModeCompilation() {
for (auto &consumer: subConsumers) {
consumer->informDriverOfIncompleteBatchModeCompilation();
}
}

bool swift::ide::api::FilteringDiagnosticConsumer::finishProcessing() {
for (auto &consumer: subConsumers) {
consumer->finishProcessing();
}
return false;
}

bool swift::ide::api::FilteringDiagnosticConsumer::shouldProceed(const DiagnosticInfo &Info) {
if (allowedBreakages->empty()) {
return true;
}
Expand All @@ -145,6 +164,8 @@ FilteringDiagnosticConsumer::handleDiagnostic(SourceManager &SM,
if (Info.Kind == DiagnosticKind::Error) {
HasError = true;
}
subConsumer->handleDiagnostic(SM, Info);
for (auto &consumer: subConsumers) {
consumer->handleDiagnostic(SM, Info);
}
}
}
11 changes: 7 additions & 4 deletions lib/DriverTool/swift_api_digester_main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1827,19 +1827,22 @@ static void findTypeMemberDiffs(NodePtr leftSDKRoot, NodePtr rightSDKRoot,
}
}

static std::unique_ptr<DiagnosticConsumer>
static std::vector<std::unique_ptr<DiagnosticConsumer>>
createDiagConsumer(llvm::raw_ostream &OS, bool &FailOnError, bool DisableFailOnError,
bool CompilerStyleDiags, StringRef SerializedDiagPath) {
std::vector<std::unique_ptr<DiagnosticConsumer>> results;
if (!SerializedDiagPath.empty()) {
FailOnError = !DisableFailOnError;
return serialized_diagnostics::createConsumer(SerializedDiagPath);
results.emplace_back(std::make_unique<PrintingDiagnosticConsumer>());
results.emplace_back(serialized_diagnostics::createConsumer(SerializedDiagPath));
} else if (CompilerStyleDiags) {
FailOnError = !DisableFailOnError;
return std::make_unique<PrintingDiagnosticConsumer>();
results.emplace_back(std::make_unique<PrintingDiagnosticConsumer>());
} else {
FailOnError = false;
return std::make_unique<ModuleDifferDiagsConsumer>(true, OS);
results.emplace_back(std::make_unique<ModuleDifferDiagsConsumer>(true, OS));
}
return results;
}

static int readFileLineByLine(StringRef Path, llvm::StringSet<> &Lines) {
Expand Down
3 changes: 2 additions & 1 deletion test/api-digester/serialized-diagnostics.swift
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
// RUN: %empty-directory(%t)

// RUN: %target-swift-frontend -disable-objc-attr-requires-foundation-module -emit-module -o %t/color.swiftmodule %S/Inputs/cake_baseline/color.swift -parse-as-library -enable-library-evolution %clang-importer-sdk-nosource -module-name color
// RUN: %api-digester -diagnose-sdk -serialize-diagnostics-path %t/result.dia -empty-baseline -I %t %clang-importer-sdk-nosource -module color -abi
// RUN: %api-digester -diagnose-sdk -serialize-diagnostics-path %t/result.dia -empty-baseline -I %t %clang-importer-sdk-nosource -module color -abi 2>&1 | %FileCheck %s -check-prefix CHECK-STDERR
// RUN: c-index-test -read-diagnostics %t/result.dia 2>&1 | %FileCheck %s -check-prefix CHECK-DIA
// RUN: %api-digester -diagnose-sdk -serialize-diagnostics-path %t/result.dia -empty-baseline -I %t %clang-importer-sdk-nosource -module color -abi -disable-fail-on-error
// RUN: c-index-test -read-diagnostics %t/result.dia 2>&1 | %FileCheck %s -check-prefix CHECK-DIA

// Ensure the 'api-digester-breaking-change' category is included in the serialized diagnostics file.
// CHECK-DIA: warning: ABI breakage: enum Color is a new API without @available attribute [] [api-digester-breaking-change]
// CHECK-STDERR: warning: ABI breakage: enum Color is a new API without @available attribute