1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
#include "check_format.h"
#include "ast.h"
#include <util/string/builder.h>
#include <yql/essentials/sql/v1/format/sql_format.h>
#include <yql/essentials/sql/v1/lexer/lexer.h>
#include <yql/essentials/sql/v1/lexer/antlr4/lexer.h>
#include <yql/essentials/sql/v1/lexer/antlr4_ansi/lexer.h>
#include <yql/essentials/sql/v1/proto_parser/proto_parser.h>
#include <yql/essentials/sql/v1/proto_parser/statement.h>
#include <yql/essentials/sql/v1/proto_parser/antlr4/proto_parser.h>
#include <yql/essentials/sql/v1/proto_parser/antlr4_ansi/proto_parser.h>
#include <yql/essentials/sql/sql.h>
#include <yql/essentials/sql/v1/sql.h>
#include <yql/essentials/utils/yql_panic.h>
namespace NSQLFormat {
bool ValidateAST(
const TString& original,
TMaybe<const NYql::TAstNode*> originalRes,
const TString& formatted,
const NSQLTranslation::TTranslationSettings& settings,
const NSQLTranslationV1::TLexers& lexers,
const NSQLTranslationV1::TParsers& parsers,
NYql::TIssues& issues)
{
NYql::TAstParseResult originalResHolder;
if (!originalRes.Defined()) {
originalResHolder = NSQLTranslationV1::SqlToYql(lexers, parsers, original, settings);
originalRes = originalResHolder.Root;
}
const NYql::TAstNode* expectedYQLs = *originalRes;
NYql::TAstParseResult formattedRes = NSQLTranslationV1::SqlToYql(lexers, parsers, formatted, settings);
const NYql::TAstNode* formattedYQLs = formattedRes.Root;
const bool formattedIsOk = static_cast<bool>(formattedYQLs);
const bool expectedIsOk = static_cast<bool>(expectedYQLs);
if (expectedIsOk != formattedIsOk) {
issues.AddIssue(
TStringBuilder()
<< "Formatter changed semantics: "
<< "original was " << (expectedIsOk ? "OK" : "BAD")
<< ", but "
<< "formatted is " << (formattedIsOk ? "OK" : "BAD"));
return false;
}
if (expectedYQLs && formattedYQLs) {
TMaybe<bool> areEqual = AreAstEqual(expectedYQLs, formattedYQLs);
if (areEqual && !*areEqual) {
issues.AddIssue("Source query's AST and formatted query's AST are not same");
return false;
}
}
return true;
}
bool ValidateConvergence(
const ISqlFormatter::TPtr& formatter,
const TString& formatted,
NYql::TIssues& issues,
EConvergenceRequirement convergence)
{
switch (convergence) {
case EConvergenceRequirement::None: {
return true;
}
case EConvergenceRequirement::Triple: {
TString formatted2;
if (!formatter->Format(formatted, formatted2, issues)) {
return false;
}
TString formatted3;
if (!formatter->Format(formatted2, formatted3, issues)) {
return false;
}
if (formatted2 != formatted3) {
issues.AddIssue(
TStringBuilder()
<< "Triple formatting check failed. "
<< "Formatting a doubly formatted query yielded a different result.");
return false;
}
return true;
}
case EConvergenceRequirement::Double: {
TString formatted2;
if (!formatter->Format(formatted, formatted2, issues)) {
return false;
}
if (formatted != formatted2) {
issues.AddIssue(
TStringBuilder()
<< "Double formatting check failed. "
<< "Formatting an already formatted query yielded a different result. "
<< "Add /* skip double format */ to suppress");
return false;
}
return true;
}
}
}
TMaybe<TString> CheckedFormat(
const TString& query,
TMaybe<const NYql::TAstNode*> ast,
NSQLTranslation::TTranslationSettings settings,
NYql::TIssues& issues,
EConvergenceRequirement convergence)
{
if (!NSQLTranslation::ParseTranslationSettings(query, settings, issues)) {
return Nothing();
} else if (settings.PgParser) {
return query;
}
NSQLTranslationV1::TLexers lexers = {
.Antlr4 = NSQLTranslationV1::MakeAntlr4LexerFactory(),
.Antlr4Ansi = NSQLTranslationV1::MakeAntlr4AnsiLexerFactory(),
};
NSQLTranslationV1::TParsers parsers = {
.Antlr4 = NSQLTranslationV1::MakeAntlr4ParserFactory(),
.Antlr4Ansi = NSQLTranslationV1::MakeAntlr4AnsiParserFactory(),
};
auto formatter = NSQLFormat::MakeSqlFormatter(lexers, parsers, settings);
TString formatted;
if (!formatter->Format(query, formatted, issues)) {
return Nothing();
}
if (!ValidateAST(query, ast, formatted, settings, lexers, parsers, issues)) {
return Nothing();
}
if (!ValidateConvergence(formatter, formatted, issues, convergence)) {
return Nothing();
}
return formatted;
}
} // namespace NSQLFormat
|