-
Notifications
You must be signed in to change notification settings - Fork 16
/
session.py
597 lines (504 loc) · 20.2 KB
/
session.py
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
from __future__ import annotations
from dataclasses import dataclass
from datetime import datetime, timezone as timezone_
from typing import (
Dict,
List,
TYPE_CHECKING,
Optional,
Callable,
Awaitable,
Type,
Any,
)
from sqlglot import Dialect
from sqlglot.dialects import MySQL
from sqlglot import expressions as exp
from sqlglot.executor import execute
from mysql_mimic.charset import CharacterSet
from mysql_mimic.errors import ErrorCode, MysqlError
from mysql_mimic.intercept import (
setitem_kind,
value_to_expression,
expression_to_value,
TRANSACTION_CHARACTERISTICS,
)
from mysql_mimic.schema import (
show_statement_to_info_schema_query,
like_to_regex,
BaseInfoSchema,
ensure_info_schema,
)
from mysql_mimic.constants import INFO_SCHEMA, KillKind
from mysql_mimic.utils import find_dbs
from mysql_mimic.variables import (
Variables,
SessionVariables,
GlobalVariables,
DEFAULT,
parse_timezone,
)
from mysql_mimic.results import AllowedResult
if TYPE_CHECKING:
from mysql_mimic.connection import Connection
Middleware = Callable[["Query"], Awaitable[AllowedResult]]
@dataclass
class Query:
"""
Convenience class that wraps the parameters to middleware.
Args:
expression: current query expression
sql: the original SQL sent by the client
attrs: query attributes
_middlewares: subsequent middleware functions
_query: the ultimate query method
"""
expression: exp.Expression
sql: str
attrs: Dict[str, str]
_middlewares: list[Middleware]
_query: Callable[[exp.Expression, str, dict[str, str]], Awaitable[AllowedResult]]
async def next(self) -> AllowedResult:
"""
Call the next middleware in the chain of middlewares.
Returns:
The final query result.
"""
if not self._middlewares:
return await self._query(self.expression, self.sql, self.attrs)
q = Query(
expression=self.expression,
sql=self.sql,
attrs=self.attrs,
_middlewares=self._middlewares[1:],
_query=self._query,
)
return await self._middlewares[0](q)
async def start(self) -> AllowedResult:
"""
Start the middleware chain.
This should only be called by the framework code
"""
return await self._middlewares[0](self)
class BaseSession:
"""
Session interface.
This defines what the Connection object depends on.
Most applications to implement the abstract `Session`, not this class.
"""
variables: Variables
username: Optional[str]
database: Optional[str]
async def handle_query(self, sql: str, attrs: Dict[str, str]) -> AllowedResult:
"""
Main entrypoint for queries.
Args:
sql: SQL statement
attrs: Mapping of query attributes
Returns:
One of:
- tuple(rows, column_names), where "rows" is a sequence of sequences
and "column_names" is a sequence of strings with the same length
as every row in "rows"
- tuple(rows, result_columns), where "rows" is the same
as above, and "result_columns" is a sequence of mysql_mimic.ResultColumn
instances.
- mysql_mimic.ResultSet instance
"""
async def init(self, connection: Connection) -> None:
"""
Called when connection phase is complete.
"""
async def close(self) -> None:
"""
Called when the client closes the connection.
"""
async def reset(self) -> None:
"""
Called when a client resets the connection and after a COM_CHANGE_USER command.
"""
async def use(self, database: str) -> None:
"""
Use a new default database.
Called when a USE database_name command is received.
Args:
database: database name
"""
class Session(BaseSession):
"""
Abstract session.
This automatically handles lots of behavior that many clients except,
e.g. session variables, SHOW commands, queries to INFORMATION_SCHEMA, and more
"""
dialect: Type[Dialect] = MySQL
def __init__(self, variables: Variables | None = None):
self.variables = variables or SessionVariables(GlobalVariables())
# Query middlewares.
# These allow queries to be intercepted or wrapped.
self.middlewares: list[Middleware] = [
self._set_var_middleware,
self._replace_variables_middleware,
self._set_middleware,
self._static_query_middleware,
self._use_middleware,
self._kill_middleware,
self._show_middleware,
self._describe_middleware,
self._begin_middleware,
self._commit_middleware,
self._rollback_middleware,
self._info_schema_middleware,
]
# Information functions.
# These will be replaced in the AST with their corresponding values.
self._functions = {
"CONNECTION_ID": lambda: self.connection.connection_id,
"USER": lambda: self.variables.get("external_user"),
"CURRENT_USER": lambda: self.username,
"VERSION": lambda: self.variables.get("version"),
"DATABASE": lambda: self.database,
"NOW": lambda: self.timestamp.strftime("%Y-%m-%d %H:%M:%S"),
"CURDATE": lambda: self.timestamp.strftime("%Y-%m-%d"),
"CURTIME": lambda: self.timestamp.strftime("%H:%M:%S"),
}
# Synonyms
self._functions.update(
{
"SYSTEM_USER": self._functions["USER"],
"SESSION_USER": self._functions["USER"],
"SCHEMA": self._functions["DATABASE"],
"CURRENT_TIMESTAMP": self._functions["NOW"],
"LOCALTIME": self._functions["NOW"],
"LOCALTIMESTAMP": self._functions["NOW"],
"CURRENT_DATE": self._functions["CURDATE"],
"CURRENT_TIME": self._functions["CURTIME"],
}
)
self._constants = {
"CURRENT_USER",
"CURRENT_TIME",
"CURRENT_TIMESTAMP",
"CURRENT_DATE",
}
# Current database
self.database = None
# Current authenticated user
self.username = None
# Time when query started
self.timestamp: datetime = datetime.now()
self._connection: Optional[Connection] = None
async def query(
self, expression: exp.Expression, sql: str, attrs: Dict[str, str]
) -> AllowedResult:
"""
Process a SQL query.
Args:
expression: parsed AST of the statement from client
sql: original SQL statement from client
attrs: arbitrary query attributes set by client
Returns:
One of:
- tuple(rows, column_names), where "rows" is a sequence of sequences
and "column_names" is a sequence of strings with the same length
as every row in "rows"
- tuple(rows, result_columns), where "rows" is the same
as above, and "result_columns" is a sequence of mysql_mimic.ResultColumn
instances.
- mysql_mimic.ResultSet instance
"""
return [], []
async def schema(self) -> dict | BaseInfoSchema:
"""
Provide the database schema.
This is used to serve INFORMATION_SCHEMA and SHOW queries.
Returns:
One of:
- Mapping of:
{table: {column: column_type}} or
{db: {table: {column: column_type}}} or
{catalog: {db: {table: {column: column_type}}}}
- Instance of `BaseInfoSchema`
"""
return {}
@property
def connection(self) -> Connection:
"""
Get the connection associated with this session.
"""
if self._connection is None:
raise AttributeError("Session is not yet bound")
return self._connection
async def init(self, connection: Connection) -> None:
"""
Called when connection phase is complete.
"""
self._connection = connection
async def close(self) -> None:
"""
Called when the client closes the connection.
"""
self._connection = None
async def handle_query(self, sql: str, attrs: Dict[str, str]) -> AllowedResult:
self.timestamp = datetime.now(tz=self.timezone())
result = None
for expression in self._parse(sql):
if not expression:
continue
q = Query(
expression=expression,
sql=sql,
attrs=attrs,
_middlewares=self.middlewares,
_query=self.query,
)
result = await q.start()
return result
async def use(self, database: str) -> None:
self.database = database
def _parse(self, sql: str) -> List[exp.Expression]:
return [e for e in self.dialect().parse(sql) if e]
async def _query_info_schema(self, expression: exp.Expression) -> AllowedResult:
return await ensure_info_schema(await self.schema()).query(expression)
async def _set_var_middleware(self, q: Query) -> AllowedResult:
"""Handles any SET_VAR hints, which set system variables for a single statement"""
hints = q.expression.find_all(exp.Hint)
if not hints:
return await q.next()
assignments = {}
# Iterate in reverse order so higher SET_VAR hints get priority
for hint in reversed(list(hints)):
set_var_hint = None
for e in hint.expressions:
if isinstance(e, exp.Func) and e.name == "SET_VAR":
set_var_hint = e
for eq in e.expressions:
assignments[eq.left.name] = expression_to_value(eq.right)
if set_var_hint:
set_var_hint.pop()
# Remove the hint entirely if SET_VAR was the only expression
if not hint.expressions:
hint.pop()
orig = {k: self.variables.get(k) for k in assignments}
try:
for k, v in assignments.items():
self.variables.set(k, v)
return await q.next()
finally:
for k, v in orig.items():
self.variables.set(k, v)
async def _use_middleware(self, q: Query) -> AllowedResult:
"""Intercept USE statements"""
if isinstance(q.expression, exp.Use):
await self.use(q.expression.this.name)
return [], []
return await q.next()
async def _kill_middleware(self, q: Query) -> AllowedResult:
"""Intercept KILL statements"""
if isinstance(q.expression, exp.Kill):
control = self.connection.control
if control:
kind = KillKind[q.expression.text("kind").upper() or "CONNECTION"]
this = q.expression.this.name
try:
connection_id = int(this)
except ValueError as e:
raise MysqlError(
f"Invalid KILL connection ID: {this}",
code=ErrorCode.PARSE_ERROR,
) from e
await control.kill(connection_id, kind)
return [], []
return await q.next()
async def _show_middleware(self, q: Query) -> AllowedResult:
"""Intercept SHOW statements"""
if isinstance(q.expression, exp.Show):
return await self._show(q.expression)
return await q.next()
async def _show(self, expression: exp.Show) -> AllowedResult:
kind = expression.name.upper()
if kind == "VARIABLES":
return self._show_variables(expression)
if kind == "STATUS":
return self._show_status(expression)
if kind == "WARNINGS":
return self._show_warnings(expression)
if kind == "ERRORS":
return self._show_errors(expression)
select = show_statement_to_info_schema_query(expression, self.database)
return await self._query_info_schema(select)
async def _describe_middleware(self, q: Query) -> AllowedResult:
"""Intercept DESCRIBE statements"""
if isinstance(q.expression, exp.Describe):
if isinstance(q.expression.this, exp.Select):
# Mysql parse treats EXPLAIN SELECT as a DESCRIBE SELECT statement
return await q.next()
name = q.expression.this.name
show = self.dialect().parse(f"SHOW COLUMNS FROM {name}")[0]
return await self._show(show) if isinstance(show, exp.Show) else None
return await q.next()
async def _rollback_middleware(self, q: Query) -> AllowedResult:
"""Intercept ROLLBACK statements"""
if isinstance(q.expression, exp.Rollback):
return [], []
return await q.next()
async def _commit_middleware(self, q: Query) -> AllowedResult:
"""Intercept COMMIT statements"""
if isinstance(q.expression, exp.Commit):
return [], []
return await q.next()
async def _begin_middleware(self, q: Query) -> AllowedResult:
"""Intercept BEGIN statements"""
if isinstance(q.expression, exp.Transaction):
return [], []
return await q.next()
async def _replace_variables_middleware(self, q: Query) -> AllowedResult:
"""Replace session variables and information functions with their corresponding values"""
def _transform(node: exp.Expression) -> exp.Expression:
new_node = None
if isinstance(node, exp.Func):
if isinstance(node, exp.Anonymous):
func_name = node.name.upper()
else:
func_name = node.sql_name()
func = self._functions.get(func_name)
if func:
value = func()
new_node = value_to_expression(value)
elif isinstance(node, exp.Column) and node.sql() in self._constants:
value = self._functions[node.sql()]()
new_node = value_to_expression(value)
elif isinstance(node, exp.SessionParameter):
value = self.variables.get(node.name)
new_node = value_to_expression(value)
if (
new_node
and isinstance(node.parent, exp.Select)
and node.arg_key == "expressions"
):
new_node = exp.alias_(new_node, exp.to_identifier(node.sql()))
return new_node or node
if isinstance(q.expression, exp.Set):
for setitem in q.expression.expressions:
if isinstance(setitem.this, exp.Binary):
# In the case of statements like: SET @@foo = @@bar
# We only want to replace variables on the right
setitem.this.set(
"expression",
setitem.this.expression.transform(_transform, copy=True),
)
else:
q.expression.transform(_transform, copy=False)
return await q.next()
async def _static_query_middleware(self, q: Query) -> AllowedResult:
"""
Handle static queries (e.g. SELECT 1).
These very common, as many clients execute commands like SELECT DATABASE() when connecting.
"""
if isinstance(q.expression, exp.Select) and not any(
q.expression.args.get(a)
for a in set(exp.Select.arg_types) - {"expressions", "limit", "hint"}
):
result = execute(q.expression)
return result.rows, result.columns
return await q.next()
async def _set_middleware(self, q: Query) -> AllowedResult:
"""Intercept SET statements"""
if isinstance(q.expression, exp.Set):
expressions = q.expression.expressions
for item in expressions:
assert isinstance(item, exp.SetItem)
kind = setitem_kind(item)
if kind == "VARIABLE":
self._set_variable(item)
elif kind == "CHARACTER SET":
self._set_charset(item)
elif kind == "NAMES":
self._set_names(item)
elif kind == "TRANSACTION":
self._set_transaction(item)
else:
raise MysqlError(
f"Unsupported SET statement: {kind}",
code=ErrorCode.NOT_SUPPORTED_YET,
)
return [], []
return await q.next()
async def _info_schema_middleware(self, q: Query) -> AllowedResult:
"""Intercept queries to INFORMATION_SCHEMA tables"""
dbs = find_dbs(q.expression)
if (self.database and self.database.lower() in INFO_SCHEMA) or (
dbs and all(db.lower() in INFO_SCHEMA for db in dbs)
):
return await self._query_info_schema(q.expression)
return await q.next()
def _set_variable(self, setitem: exp.SetItem) -> None:
assignment = setitem.this
left = assignment.left
if isinstance(left, exp.SessionParameter):
scope = left.text("kind") or "SESSION"
name = left.name
elif isinstance(left, exp.Parameter):
raise MysqlError(
"User-defined variables not supported yet",
code=ErrorCode.NOT_SUPPORTED_YET,
)
else:
scope = setitem.text("kind") or "SESSION"
name = left.name
scope = scope.upper()
value = expression_to_value(assignment.right)
if scope in {"SESSION", "LOCAL"}:
self.variables.set(name, value)
else:
raise MysqlError(
f"Cannot SET variable {name} with scope {scope}",
code=ErrorCode.NOT_SUPPORTED_YET,
)
def _set_charset(self, item: exp.SetItem) -> None:
charset_name: Any
charset_conn: Any
if item.name == "DEFAULT":
charset_name = DEFAULT
charset_conn = DEFAULT
else:
charset_name = item.name
charset_conn = self.variables.get("character_set_database")
self.variables.set("character_set_client", charset_name)
self.variables.set("character_set_results", charset_name)
self.variables.set("character_set_connection", charset_conn)
def _set_names(self, item: exp.SetItem) -> None:
charset_name: Any
collation_name: Any
if item.name == "DEFAULT":
charset_name = DEFAULT
collation_name = DEFAULT
else:
charset_name = item.name
collation_name = (
item.text("collate")
or CharacterSet[charset_name].default_collation.name
)
self.variables.set("character_set_client", charset_name)
self.variables.set("character_set_connection", charset_name)
self.variables.set("character_set_results", charset_name)
self.variables.set("collation_connection", collation_name)
def _set_transaction(self, item: exp.SetItem) -> None:
characteristics = [e.name.upper() for e in item.expressions]
for characteristic in characteristics:
variable, value = TRANSACTION_CHARACTERISTICS[characteristic]
self.variables.set(variable, value)
def _show_variables(self, show: exp.Show) -> AllowedResult:
rows = [(k, None if v is None else str(v)) for k, v in self.variables.list()]
like = show.text("like")
if like:
rows = [(k, v) for k, v in rows if like_to_regex(like).match(k)]
return rows, ["Variable_name", "Value"]
def _show_status(self, show: exp.Show) -> AllowedResult:
return [], ["Variable_name", "Value"]
def _show_warnings(self, show: exp.Show) -> AllowedResult:
return [], ["Level", "Code", "Message"]
def _show_errors(self, show: exp.Show) -> AllowedResult:
return [], ["Level", "Code", "Message"]
def timezone(self) -> timezone_:
tz = self.variables.get("time_zone")
return parse_timezone(tz)