@kensio/yulin 1.21.18 → 1.21.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,29 @@
1
+ import type { SimAthenaResolvedResult } from "../result/sim-athena-resolved-result.js";
2
+ /**
3
+ * What the engine came to for one query.
4
+ *
5
+ * A turn-down carries why, because a strict engine fails the query with it and
6
+ * a reader of that failing test has to learn which of them it hit.
7
+ */
8
+ export interface SimAthenaEngineAnswer {
9
+ /** The rows, where the engine ran the statement. */
10
+ readonly result: SimAthenaResolvedResult | undefined;
11
+ /** What the engine could not do, where it turned the query down. */
12
+ readonly turnedDown: string | undefined;
13
+ /** Why Athena refuses the statement, where the engine found it invalid. */
14
+ readonly rejected: string | undefined;
15
+ }
16
+ /** One answer the engine ran for real. */
17
+ export declare function simAthenaEngineAnswered(result: SimAthenaResolvedResult): SimAthenaEngineAnswer;
18
+ /** One query the engine turned down, and why. */
19
+ export declare function simAthenaEngineTurnedDown(turnedDown: string): SimAthenaEngineAnswer;
20
+ /**
21
+ * One statement Athena refuses, and why.
22
+ *
23
+ * The engine ran nothing. A query that reaches this fails whether or not the
24
+ * engine is strict, since the alternative is a green test on SQL the service
25
+ * rejects.
26
+ */
27
+ export declare function simAthenaEngineRejected(rejected: string): SimAthenaEngineAnswer;
28
+ /** An engine nobody turned on, which has no opinion about the query. */
29
+ export declare function simAthenaEngineSilent(): SimAthenaEngineAnswer;
@@ -0,0 +1,22 @@
1
+ /** One answer the engine ran for real. */
2
+ export function simAthenaEngineAnswered(result) {
3
+ return { result, turnedDown: undefined, rejected: undefined };
4
+ }
5
+ /** One query the engine turned down, and why. */
6
+ export function simAthenaEngineTurnedDown(turnedDown) {
7
+ return { result: undefined, turnedDown, rejected: undefined };
8
+ }
9
+ /**
10
+ * One statement Athena refuses, and why.
11
+ *
12
+ * The engine ran nothing. A query that reaches this fails whether or not the
13
+ * engine is strict, since the alternative is a green test on SQL the service
14
+ * rejects.
15
+ */
16
+ export function simAthenaEngineRejected(rejected) {
17
+ return { result: undefined, turnedDown: undefined, rejected };
18
+ }
19
+ /** An engine nobody turned on, which has no opinion about the query. */
20
+ export function simAthenaEngineSilent() {
21
+ return { result: undefined, turnedDown: undefined, rejected: undefined };
22
+ }
@@ -1,25 +1,9 @@
1
1
  import type { SimAwsCaller } from "../../aws/caller/sim-aws-caller.js";
2
2
  import type { SimAthenaPlannedTable } from "../execution/sim-athena-query-refusal.js";
3
- import type { SimAthenaResolvedResult } from "../result/sim-athena-resolved-result.js";
3
+ import { type SimAthenaEngineAnswer } from "./sim-athena-engine-answer.js";
4
4
  import type { SimAthenaSqlParser } from "./sim-athena-parser-module.js";
5
5
  import type { SimAthenaSqliteModule } from "./sim-athena-sqlite-module.js";
6
6
  import type { SimAthenaTableObjects } from "./sim-athena-table-objects.js";
7
- /**
8
- * What the engine came to for one query.
9
- *
10
- * A turn-down carries why, because a strict engine fails the query with it and
11
- * a reader of that failing test has to learn which of them it hit.
12
- */
13
- export interface SimAthenaEngineAnswer {
14
- /** The rows, where the engine ran the statement. */
15
- readonly result: SimAthenaResolvedResult | undefined;
16
- /** What the engine could not do, where it turned the query down. */
17
- readonly turnedDown: string | undefined;
18
- }
19
- /** One answer the engine ran for real. */
20
- export declare function simAthenaEngineAnswered(result: SimAthenaResolvedResult): SimAthenaEngineAnswer;
21
- /** One query the engine turned down, and why. */
22
- export declare function simAthenaEngineTurnedDown(turnedDown: string): SimAthenaEngineAnswer;
23
7
  /** What one query is run with, once the engine is on and has somewhere to read. */
24
8
  export interface SimAthenaEngineRun {
25
9
  readonly parser: SimAthenaSqlParser;
@@ -1,15 +1,8 @@
1
+ import { simAthenaEngineAnswered, simAthenaEngineTurnedDown, } from "./sim-athena-engine-answer.js";
1
2
  import { simAthenaRunFailure } from "./sim-athena-turn-down.js";
2
3
  import { simAthenaEngineResult } from "./sim-athena-engine-result.js";
3
4
  import { simAthenaSqliteDatabase } from "./sim-athena-sqlite-database.js";
4
5
  import { simAthenaLoadedTables } from "./sim-athena-loaded-tables.js";
5
- /** One answer the engine ran for real. */
6
- export function simAthenaEngineAnswered(result) {
7
- return { result, turnedDown: undefined };
8
- }
9
- /** One query the engine turned down, and why. */
10
- export function simAthenaEngineTurnedDown(turnedDown) {
11
- return { result: undefined, turnedDown };
12
- }
13
6
  /**
14
7
  * Load the tables, build the database and run the statement.
15
8
  *
@@ -1,6 +1,6 @@
1
1
  import type { SimAwsCaller } from "../../aws/caller/sim-aws-caller.js";
2
2
  import type { SimAthenaPlannedTable } from "../execution/sim-athena-query-refusal.js";
3
- import { type SimAthenaEngineAnswer } from "./sim-athena-engine-run.js";
3
+ import { type SimAthenaEngineAnswer } from "./sim-athena-engine-answer.js";
4
4
  import type { SimAthenaTableObjects } from "./sim-athena-table-objects.js";
5
5
  /** How one scope's engine is turned on. */
6
6
  export interface SimAthenaEngineOptions {
@@ -1,4 +1,5 @@
1
- import { simAthenaEngineRun, simAthenaEngineTurnedDown, } from "./sim-athena-engine-run.js";
1
+ import { simAthenaEngineRejected, simAthenaEngineSilent, simAthenaEngineTurnedDown, } from "./sim-athena-engine-answer.js";
2
+ import { simAthenaEngineRun } from "./sim-athena-engine-run.js";
2
3
  import { simAthenaSqlParser, } from "./sim-athena-parser-module.js";
3
4
  import { simAthenaSqliteModule, } from "./sim-athena-sqlite-module.js";
4
5
  import { simAthenaSqliteSql } from "./sim-athena-sql-translation.js";
@@ -63,7 +64,7 @@ export class SimAthenaQueryEngine {
63
64
  const sqlite = this.#sqlite;
64
65
  const { objects } = request;
65
66
  if (parser === undefined || sqlite === undefined) {
66
- return { result: undefined, turnedDown: undefined };
67
+ return simAthenaEngineSilent();
67
68
  }
68
69
  if (objects === undefined) {
69
70
  return simAthenaEngineTurnedDown(simAthenaNoObjects);
@@ -73,6 +74,9 @@ export class SimAthenaQueryEngine {
73
74
  athenaSql: request.queryString,
74
75
  tables: request.tables.map((planned) => planned.table),
75
76
  });
77
+ if (translated.rejected !== undefined) {
78
+ return simAthenaEngineRejected(translated.rejected);
79
+ }
76
80
  return translated.sql === undefined
77
81
  ? simAthenaEngineTurnedDown(translated.turnedDown)
78
82
  : simAthenaEngineRun({
@@ -0,0 +1,14 @@
1
+ /**
2
+ * Why Athena refuses one parsed statement, where it does.
3
+ *
4
+ * Everything here is a statement SQLite runs happily and the real service
5
+ * rejects. A translation that hands such a statement to SQLite answers a test
6
+ * with rows, and the command then fails against AWS. Each shape is spotted on
7
+ * the tree the Athena grammar produced, before anything is written out for
8
+ * SQLite.
9
+ *
10
+ * Trino and SQLite resolve names by different rules in more places than this.
11
+ * One shape is covered, the one seen reaching production. Add the next when a
12
+ * query hits it.
13
+ */
14
+ export declare function simAthenaRejectedStatement(ast: unknown): string | undefined;
@@ -0,0 +1,103 @@
1
+ import { isColumnRef, simAthenaAstNodes, } from "./sim-athena-ast-nodes.js";
2
+ /**
3
+ * Why Athena refuses one parsed statement, where it does.
4
+ *
5
+ * Everything here is a statement SQLite runs happily and the real service
6
+ * rejects. A translation that hands such a statement to SQLite answers a test
7
+ * with rows, and the command then fails against AWS. Each shape is spotted on
8
+ * the tree the Athena grammar produced, before anything is written out for
9
+ * SQLite.
10
+ *
11
+ * Trino and SQLite resolve names by different rules in more places than this.
12
+ * One shape is covered, the one seen reaching production. Add the next when a
13
+ * query hits it.
14
+ */
15
+ export function simAthenaRejectedStatement(ast) {
16
+ for (const node of simAthenaAstNodes(ast)) {
17
+ const sort = node["orderby"];
18
+ const columns = node["columns"];
19
+ if (!Array.isArray(sort) || !Array.isArray(columns)) {
20
+ continue;
21
+ }
22
+ const alias = aggregatedAlias(sort, columns);
23
+ if (alias !== undefined) {
24
+ return orderByAggregateOverAlias(alias);
25
+ }
26
+ }
27
+ return undefined;
28
+ }
29
+ /** What Athena says about an `ORDER BY` aggregate over an aggregate alias. */
30
+ function orderByAggregateOverAlias(alias) {
31
+ return (`Athena refuses this statement. Its ORDER BY aggregates over ${alias}, ` +
32
+ `and the select list names ${alias} as the output alias of an aggregate. ` +
33
+ `Trino resolves a bare name in ORDER BY against the select list before ` +
34
+ `the table. That makes the sort an aggregate over an aggregate, and the ` +
35
+ `service answers "Invalid reference to output projection attribute from ` +
36
+ `ORDER BY aggregation". Sort by ${alias} on its own, or give the alias a ` +
37
+ `name the sort leaves alone.`);
38
+ }
39
+ /**
40
+ * The output alias one `ORDER BY` aggregates over, where the alias aggregates
41
+ * too.
42
+ *
43
+ * A select list of `sum(qty) AS qty` sorted by `ORDER BY sum(qty)` is the
44
+ * shape. SQLite reads that `qty` as the table's column and sorts correctly.
45
+ * Trino reads it as the alias and refuses the query.
46
+ *
47
+ * `ORDER BY qty` over the same select list is the form Athena takes, with no
48
+ * aggregate wrapped around the name. An aggregate over a name the select list
49
+ * leaves alone is legal too, as in `ORDER BY sum(revenue_total)` beside
50
+ * `coalesce(sum(revenue_total), 0) AS revenue`. The aliases are what tell this
51
+ * shape from those two.
52
+ */
53
+ function aggregatedAlias(sort, columns) {
54
+ const aliases = aggregateAliases(columns);
55
+ if (aliases.size === 0) {
56
+ return undefined;
57
+ }
58
+ for (const node of simAthenaAstNodes(sort)) {
59
+ if (!isAggregate(node)) {
60
+ continue;
61
+ }
62
+ const arguments_ = simAthenaAstNodes(node["args"]);
63
+ for (const inner of arguments_) {
64
+ const alias = isColumnRef(inner) && inner.table === null
65
+ ? aliases.get(inner.column.toLowerCase())
66
+ : undefined;
67
+ if (alias !== undefined) {
68
+ return alias;
69
+ }
70
+ }
71
+ }
72
+ return undefined;
73
+ }
74
+ /** Every output alias of one select list whose own expression aggregates. */
75
+ function aggregateAliases(columns) {
76
+ const aliases = new Map();
77
+ for (const column of columns) {
78
+ const alias = column["as"];
79
+ if (typeof alias === "string" && holdsAggregate(column["expr"])) {
80
+ aliases.set(alias.toLowerCase(), alias);
81
+ }
82
+ }
83
+ return aliases;
84
+ }
85
+ /** Whether anything under this expression aggregates. */
86
+ function holdsAggregate(expression) {
87
+ for (const node of simAthenaAstNodes(expression)) {
88
+ if (isAggregate(node)) {
89
+ return true;
90
+ }
91
+ }
92
+ return false;
93
+ }
94
+ /**
95
+ * Whether this node is a grouped aggregate call.
96
+ *
97
+ * A window function carries `over` and is computed once the grouped aggregates
98
+ * have been. It takes an output alias in `ORDER BY` happily, and stays out of
99
+ * this.
100
+ */
101
+ function isAggregate(node) {
102
+ return node["type"] === "aggr_func" && (node["over"] ?? null) === null;
103
+ }
@@ -1,12 +1,18 @@
1
1
  import type { SimAthenaCatalogTable } from "../table/sim-athena-catalog-table.js";
2
2
  import type { SimAthenaSqlParser } from "./sim-athena-parser-module.js";
3
- /** One statement translated for SQLite, or why it could not be. */
3
+ /** One statement translated for SQLite, or why it was not. */
4
4
  export type SimAthenaTranslatedSql = {
5
5
  readonly sql: string;
6
6
  readonly turnedDown: undefined;
7
+ readonly rejected: undefined;
7
8
  } | {
8
9
  readonly sql: undefined;
9
10
  readonly turnedDown: string;
11
+ readonly rejected: undefined;
12
+ } | {
13
+ readonly sql: undefined;
14
+ readonly turnedDown: undefined;
15
+ readonly rejected: string;
10
16
  };
11
17
  interface SimAthenaSqlTranslationRequest {
12
18
  readonly parser: SimAthenaSqlParser;
@@ -15,13 +21,18 @@ interface SimAthenaSqlTranslationRequest {
15
21
  readonly tables: readonly SimAthenaCatalogTable[];
16
22
  }
17
23
  /**
18
- * One Athena statement written back out for SQLite, or why it cannot be.
24
+ * One Athena statement written back out for SQLite, or why it is not.
25
+ *
26
+ * Three things turn the query down, and each is told apart because a strict
27
+ * engine fails the query with the reason. The Athena grammar can refuse the
28
+ * statement, an `UNNEST` in it can have no `json_each` to become, and the
29
+ * parser can decline to write the statement back out. A lenient engine answers
30
+ * all three the same way, by letting the declared result take the query.
19
31
  *
20
- * Three things stop it, and each is told apart because a strict engine fails
21
- * the query with the reason. The Athena grammar can refuse the statement, an
22
- * `UNNEST` in it can have no `json_each` to become, and the parser can decline
23
- * to write the statement back out. A lenient engine answers all three the same
24
- * way, by turning the query down and letting the declared result take it.
32
+ * A rejection is the fourth outcome and a different thing. The statement
33
+ * parsed, and Athena would still refuse to run it. That fails the query
34
+ * whether or not the engine is strict, since falling back would leave a test
35
+ * green on SQL the service rejects.
25
36
  */
26
37
  export declare function simAthenaSqliteSql(request: SimAthenaSqlTranslationRequest): SimAthenaTranslatedSql;
27
38
  export {};
@@ -1,14 +1,20 @@
1
1
  import { simAthenaSqlForParser, simAthenaSqlForSqlite, } from "./sim-athena-sql-rewrites.js";
2
2
  import { simAthenaUnparsedStatement, simAthenaUnrewrittenUnnest, simAthenaUnwrittenStatement, } from "./sim-athena-turn-down.js";
3
+ import { simAthenaRejectedStatement } from "./sim-athena-rejected-statement.js";
3
4
  import { simAthenaRewriteUnnest } from "./sim-athena-unnest-rewrite.js";
4
5
  /**
5
- * One Athena statement written back out for SQLite, or why it cannot be.
6
+ * One Athena statement written back out for SQLite, or why it is not.
6
7
  *
7
- * Three things stop it, and each is told apart because a strict engine fails
8
- * the query with the reason. The Athena grammar can refuse the statement, an
9
- * `UNNEST` in it can have no `json_each` to become, and the parser can decline
10
- * to write the statement back out. A lenient engine answers all three the same
11
- * way, by turning the query down and letting the declared result take it.
8
+ * Three things turn the query down, and each is told apart because a strict
9
+ * engine fails the query with the reason. The Athena grammar can refuse the
10
+ * statement, an `UNNEST` in it can have no `json_each` to become, and the
11
+ * parser can decline to write the statement back out. A lenient engine answers
12
+ * all three the same way, by letting the declared result take the query.
13
+ *
14
+ * A rejection is the fourth outcome and a different thing. The statement
15
+ * parsed, and Athena would still refuse to run it. That fails the query
16
+ * whether or not the engine is strict, since falling back would leave a test
17
+ * green on SQL the service rejects.
12
18
  */
13
19
  export function simAthenaSqliteSql(request) {
14
20
  const { parser } = request;
@@ -21,6 +27,10 @@ export function simAthenaSqliteSql(request) {
21
27
  catch {
22
28
  return turnedDown(simAthenaUnparsedStatement);
23
29
  }
30
+ const rejected = simAthenaRejectedStatement(ast);
31
+ if (rejected !== undefined) {
32
+ return { sql: undefined, turnedDown: undefined, rejected };
33
+ }
24
34
  try {
25
35
  if (!simAthenaRewriteUnnest({
26
36
  ast,
@@ -32,6 +42,7 @@ export function simAthenaSqliteSql(request) {
32
42
  return {
33
43
  sql: simAthenaSqlForSqlite(parser.sqlify(ast, { database: "sqlite" })),
34
44
  turnedDown: undefined,
45
+ rejected: undefined,
35
46
  };
36
47
  }
37
48
  catch {
@@ -39,5 +50,5 @@ export function simAthenaSqliteSql(request) {
39
50
  }
40
51
  }
41
52
  function turnedDown(reason) {
42
- return { sql: undefined, turnedDown: reason };
53
+ return { sql: undefined, turnedDown: reason, rejected: undefined };
43
54
  }
@@ -48,6 +48,10 @@ interface SimAthenaQueryAnswerRequest {
48
48
  * A strict engine is the exception, and it fails the query it turned down.
49
49
  * The declaration keeps its place ahead of that, since a test writing one
50
50
  * against this exact statement has already said what the engine gets wrong.
51
+ *
52
+ * A statement Athena refuses fails whichever mode the engine is in. That is
53
+ * SQL the service would never have run, and falling back would leave the query
54
+ * green on it.
51
55
  */
52
56
  export declare function simAthenaQueryAnswer(request: SimAthenaQueryAnswerRequest): Promise<SimAthenaQueryAnswer>;
53
57
  export {};
@@ -15,6 +15,10 @@ import { simAthenaStrictRefusal } from "../engine/sim-athena-turn-down.js";
15
15
  * A strict engine is the exception, and it fails the query it turned down.
16
16
  * The declaration keeps its place ahead of that, since a test writing one
17
17
  * against this exact statement has already said what the engine gets wrong.
18
+ *
19
+ * A statement Athena refuses fails whichever mode the engine is in. That is
20
+ * SQL the service would never have run, and falling back would leave the query
21
+ * green on it.
18
22
  */
19
23
  export async function simAthenaQueryAnswer(request) {
20
24
  const forQuery = request.results.declaredForQuery(request.queryString);
@@ -35,7 +39,7 @@ export async function simAthenaQueryAnswer(request) {
35
39
  return {
36
40
  result: request.declared,
37
41
  source: "declaration",
38
- refusal: strictRefusal(request.engine, computed.turnedDown),
42
+ refusal: computed.rejected ?? strictRefusal(request.engine, computed.turnedDown),
39
43
  };
40
44
  }
41
45
  /**
@@ -381,6 +381,36 @@ Strict mode is off unless a test asks for it, and `disable()` takes it off with
381
381
  declaration written against one exact query text still answers, with no failure, because that is a
382
382
  test's own statement about a query the engine gets wrong.
383
383
 
384
+ ### Failing a statement Athena refuses
385
+
386
+ One failure ignores strict mode. Where the engine can see that Athena would refuse a statement
387
+ outright, the query fails whether strict mode is on or off. A turn-down means the engine reached its
388
+ limits, and a declaration is a fair answer to that. A rejection means the SQL is invalid, and
389
+ answering from a declaration would leave a test green on a query that fails against AWS.
390
+
391
+ The one shape it catches today is an `ORDER BY` that aggregates over an output alias which is itself
392
+ an aggregate.
393
+
394
+ ```sql
395
+ SELECT sku, coalesce(sum(qty), 0) AS qty
396
+ FROM rainlytics.lines
397
+ GROUP BY sku
398
+ ORDER BY sum(qty) DESC
399
+ ```
400
+
401
+ Trino resolves the bare `qty` in `ORDER BY` against the select list before the table. The sort then
402
+ asks for an aggregate over an aggregate, and Athena answers `COLUMN_NOT_FOUND: Invalid reference to
403
+ output projection attribute from ORDER BY aggregation`. SQLite resolves the same name against the
404
+ table's column, runs the statement and orders it correctly. That is how a green test shipped a
405
+ command that failed against the service.
406
+
407
+ `ORDER BY qty DESC` over the same select list is the form Athena takes, and it is what to write.
408
+ `ORDER BY sum(revenue_total) DESC` beside `coalesce(sum(revenue_total), 0) AS revenue` is fine as
409
+ well, since the two names differ and nothing shadows.
410
+
411
+ Trino and SQLite resolve names by different rules in other places too, and the engine catches this
412
+ one. A statement that behaves differently under the two is worth reporting.
413
+
384
414
  ### The objects it reads
385
415
 
386
416
  The SerDe class name in the table's storage descriptor says how its objects are decoded.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kensio/yulin",
3
- "version": "1.21.18",
3
+ "version": "1.21.19",
4
4
  "description": "AWS system behaviour simulation for isolated unit testing",
5
5
  "repository": "https://github.com/KensioSoftware/yulin",
6
6
  "homepage": "https://yulinsim.dev/",
@@ -299,7 +299,7 @@
299
299
  "hyparquet": "^1.29.2",
300
300
  "hyparquet-writer": "^0.16.9",
301
301
  "node-sql-parser": "^5.4.0",
302
- "oxfmt": "^0.65.0",
302
+ "oxfmt": "^0.66.0",
303
303
  "oxlint": "^1.77.0",
304
304
  "oxlint-tsgolint": "^7.0.2001",
305
305
  "semantic-release": "25.0.9",