Skip to content

feat: Implement MySQL dialect #28

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: Implement MySQL dialect #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d352c6f
feat: Implement MySQL dialect
AlejandroYanes Jul 17, 2024
036f83f
feat: export MySQLDialect from the index file
AlejandroYanes Jul 26, 2024
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
252 changes: 252 additions & 0 deletions packages/tql-template/src/dialects/mysql.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,252 @@
import { it, describe, expect, beforeEach, vi } from 'vitest';
import { MySQLDialect } from './mysql.js';
import { TqlTemplateString, TqlParameter, TqlIdentifiers, TqlList, TqlValues, TqlSet } from '../nodes.js';
import { createQueryBuilder } from '../utils.js';
import { TqlError } from '../error.js';

describe('tql dialect: MySQL', () => {
let queryBuilder: ReturnType<typeof createQueryBuilder>;
let d: () => MySQLDialect;

beforeEach(() => {
const qb = createQueryBuilder();
qb.appendToParams = vi.fn().mockImplementation(qb.appendToParams);
qb.appendToQuery = vi.fn().mockImplementation(qb.appendToQuery);
queryBuilder = qb;
d = (): MySQLDialect => new MySQLDialect(qb.appendToQuery, qb.appendToParams);
});

describe('templateString', () => {
it('appends the string', () => {
const dialect = d();
dialect.templateString(new TqlTemplateString('hi'));
expect(queryBuilder.params).toEqual([]);
expect(queryBuilder.query).toBe('hi');
});
});

describe('parameter', () => {
it('appends the parameter', () => {
const dialect = d();
const parameterValue = 'vercelliott';
dialect.parameter(new TqlParameter(parameterValue));
expect(queryBuilder.params).toEqual([parameterValue]);
expect(queryBuilder.query).toBe('?');
});

it("does not change the type of the parameter value, even if it's exotic", () => {
const dialect = d();
const parameterValue = { name: 'dispelliott' };
dialect.parameter(new TqlParameter(parameterValue));
expect(queryBuilder.params).toEqual([parameterValue]);
expect(queryBuilder.query).toBe('?');
});
});

describe('identifiers', () => {
it('adds a single identifier to the query', () => {
const dialect = d();
const identifier = 'name';
dialect.identifiers(new TqlIdentifiers(identifier));
expect(queryBuilder.params).toEqual([]);
expect(queryBuilder.query).toBe('`name`');
});

it.each([
{ input: 'with"quotes', output: '`with"quotes`' },
{
input: 'dotted.identifiers',
output: '`dottedidentifiers`',
},
{
input: 'with.injection" FROM users; SELECT * FROM privileged_information;--',
output: '`withinjection" FROM users; SELECT * FROM privileged_information;--`',
},
])('escapes identifiers', ({ input, output }) => {
const dialect = d();
dialect.identifiers(new TqlIdentifiers(input));
expect(queryBuilder.params).toEqual([]);
expect(queryBuilder.query).toBe(output);
});

it('adds multiple identifiers to the query', () => {
const dialect = d();
const identifier = 'name';
dialect.identifiers(new TqlIdentifiers([identifier, identifier, identifier]));
expect(queryBuilder.params).toEqual([]);
expect(queryBuilder.query).toBe('`name`, `name`, `name`');
});

it.each([
{ input: ['with"quotes', 'with"quotes'], output: '`with"quotes`, `with"quotes`' },
{
input: ['dotted.identifiers'],
output: '`dottedidentifiers`',
},
{
input: ['with.injection" FROM users; SELECT * FROM privileged_information;--', 'blah'],
output: '`withinjection" FROM users; SELECT * FROM privileged_information;--`, `blah`',
},
])('escapes identifiers', ({ input, output }) => {
const dialect = d();
dialect.identifiers(new TqlIdentifiers(input));
expect(queryBuilder.params).toEqual([]);
expect(queryBuilder.query).toBe(output);
});
});

describe('list', () => {
it('adds items to a comma-separated list', () => {
const dialect = d();
const items = [1, 'hi', { complex: 'type' }];
dialect.list(new TqlList(items));
expect(queryBuilder.params).toEqual(items);
expect(queryBuilder.query).toBe('(?, ?, ?)');
});
});

describe('values', () => {
describe('single object', () => {
it('correctly constructs the clause', () => {
const dialect = d();
const item = { name: 'vercelliott', email: '[email protected]' };
dialect.values(new TqlValues(item));
expect(queryBuilder.params).toEqual([item.name, item.email]);
expect(queryBuilder.query).toBe('(`name`, `email`) VALUES (?, ?)');
});

it('avoids SQL injection from identifiers and values', () => {
const dialect = d();
const item = {
'name"; SELECT * FROM privileged_information; --': 'vercelliott; SELECT * FROM privileged_information; --',
email: '[email protected]',
};
dialect.values(new TqlValues(item));
expect(queryBuilder.params).toEqual([item['name"; SELECT * FROM privileged_information; --'], item.email]);
expect(queryBuilder.query).toBe(
'(`name"; SELECT * FROM privileged_information; --`, `email`) VALUES (?, ?)',
);
});

it('retains complex types', () => {
const dialect = d();
const item = {
name: 'vercelliott',
email: '[email protected]',
address: { street: 'go away' },
};
dialect.values(new TqlValues(item));
expect(queryBuilder.params).toEqual([item.name, item.email, item.address]);
expect(queryBuilder.query).toBe('(`name`, `email`, `address`) VALUES (?, ?, ?)');
});
});

describe('multiple objects', () => {
it('correctly constructs the clause', () => {
const dialect = d();
const items = [
{ name: 'vercelliott', email: '[email protected]' },
{ name: 'farewelliott', email: '[email protected]' },
];
dialect.values(new TqlValues(items));
expect(queryBuilder.params).toEqual([items[0].name, items[0].email, items[1].name, items[1].email]);
expect(queryBuilder.query).toBe('(`name`, `email`) VALUES (?, ?), (?, ?)');
});

it('correctly constructs the clause when objects have different key orders', () => {
const dialect = d();
const items = [
{ name: 'vercelliott', email: '[email protected]' },
{ email: '[email protected]', name: 'farewelliott' },
];
dialect.values(new TqlValues(items));
expect(queryBuilder.params).toEqual([items[0].name, items[0].email, items[1].name, items[1].email]);
expect(queryBuilder.query).toBe('(`name`, `email`) VALUES (?, ?), (?, ?)');
});

it('avoids SQL injection from identifiers and values', () => {
const dialect = d();
const items = [
{
'name"; SELECT * FROM privileged_information; --': 'vercelliott; SELECT * FROM privileged_information; --',
email: '[email protected]',
},
{
email: '[email protected]',
'name"; SELECT * FROM privileged_information; --': 'vercelliott; SELECT * FROM privileged_information; --',
},
];
dialect.values(new TqlValues(items));
expect(queryBuilder.params).toEqual([
items[0]['name"; SELECT * FROM privileged_information; --'],
items[0].email,
items[1]['name"; SELECT * FROM privileged_information; --'],
items[1].email,
]);
expect(queryBuilder.query).toBe(
'(`name"; SELECT * FROM privileged_information; --`, `email`) VALUES (?, ?), (?, ?)',
);
});

it('retains complex types', () => {
const dialect = d();
const items = [
{
name: 'carouselliott',
email: '[email protected]',
address: { street: 'go away' },
},
{
name: 'parallelliott',
email: '[email protected]',
address: { street: 'go away' },
},
];
dialect.values(new TqlValues(items));
expect(queryBuilder.params).toEqual([
items[0].name,
items[0].email,
items[0].address,
items[1].name,
items[1].email,
items[1].address,
]);
expect(queryBuilder.query).toBe('(`name`, `email`, `address`) VALUES (?, ?, ?), (?, ?, ?)');
});

it('throws when subsequent value objects have missing keys', () => {
const dialect = d();
const items = [{ name: 'excelliott', email: '[email protected]' }, { name: 'luddite' }];
let error: TqlError<'values_records_mismatch'> | null = null;
try {
dialect.values(new TqlValues(items));
} catch (e) {
error = e;
}
expect(error).toBeInstanceOf(TqlError);
expect(error?.code).toBe('values_records_mismatch');
});
});
});

describe('set', () => {
it('correctly constructs the clause', () => {
const dialect = d();
const setRecord = { name: 'vercelliott', 'address.zip': '00000' };
dialect.set(new TqlSet(setRecord));
expect(queryBuilder.params).toEqual(['vercelliott', '00000']);
expect(queryBuilder.query).toBe('SET `name` = ?, `addresszip` = ?');
});

it('avoids SQL injection from identifiers and values', () => {
const dialect = d();
const item = {
'name"; SELECT * FROM privileged_information; --': 'vercelliott; SELECT * FROM privileged_information; --',
email: '[email protected]',
};
dialect.set(new TqlSet(item));
expect(queryBuilder.params).toEqual([item['name"; SELECT * FROM privileged_information; --'], item.email]);
expect(queryBuilder.query).toBe('SET `name"; SELECT * FROM privileged_information; --` = ?, `email` = ?');
});
});
});
92 changes: 92 additions & 0 deletions packages/tql-template/src/dialects/mysql.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
import { IdenticalColumnValidator } from '../values-object-validator.js';
import type { DialectImpl } from '../types.js';
import { BaseDialect } from '../dialect.js';
import {
type TqlIdentifiers,
type TqlList,
type TqlParameter,
type TqlTemplateString,
type TqlSet,
type TqlValues,
} from '../nodes.js';

export class MySQLDialect extends BaseDialect implements DialectImpl {
templateString(str: TqlTemplateString): void {
this.appendToQuery(str.value);
}

parameter(param: TqlParameter): void {
this.appendToParams(param.value);
this.appendToQuery(`?`);
}

identifiers(ids: TqlIdentifiers): void {
if (Array.isArray(ids.values)) {
this.appendToQuery(ids.values.map((v) => MySQLDialect.escapeIdentifier(v)).join(', '));
} else {
this.appendToQuery(MySQLDialect.escapeIdentifier(ids.values));
}
}

list(vals: TqlList): void {
this.appendToQuery('(');
const queryItems: string[] = [];
for (const param of vals.values) {
this.appendToParams(param);
queryItems.push(`?`);
}
this.appendToQuery(queryItems.join(', '));
this.appendToQuery(')');
}

values(entries: TqlValues): void {
if (Array.isArray(entries.values)) {
// it's multiple entries
const validator = new IdenticalColumnValidator();
let first = true;
let columns: string[] = [];
const rows: string[] = [];
for (const entry of entries.values) {
validator.validate(entry);
if (first) {
first = false;
columns = Object.keys(entry);
this.appendToQuery(`(${columns.map(MySQLDialect.escapeIdentifier).join(', ')}) VALUES `);
}
const queryItems: string[] = [];
for (const column of columns) {
this.appendToParams(entry[column]);
queryItems.push(`?`);
}
rows.push(`(${queryItems.join(', ')})`);
}
this.appendToQuery(rows.join(', '));
} else {
// it's a single entry
const entry = entries.values;
const columns = Object.keys(entry);
this.appendToQuery(`(${columns.map(MySQLDialect.escapeIdentifier).join(', ')}) VALUES `);
const queryItems: string[] = [];
for (const column of columns) {
this.appendToParams(entry[column]);
queryItems.push(`?`);
}
this.appendToQuery(`(${queryItems.join(', ')})`);
}
}

set(entry: TqlSet): void {
this.appendToQuery('SET ');
const columns = Object.keys(entry.values);
const queryItems: string[] = [];
for (const column of columns) {
this.appendToParams(entry.values[column]);
queryItems.push(`${MySQLDialect.escapeIdentifier(column)} = ?`);
}
this.appendToQuery(queryItems.join(', '));
}

private static escapeIdentifier(value: string): string {
return `\`${value.replace(/`/g, '``').replace(/\./g, '')}\``;
}
}
1 change: 1 addition & 0 deletions packages/tql-template/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import type { Tql } from './types.js';
export type * from './nodes.ts';
export type * from './types.js';
export { PostgresDialect } from './dialects/postgres.js';
export { MySQLDialect } from './dialects/mysql.js';

export const init: Init = ({ dialect }) => {
const fragment = Object.defineProperty(
Expand Down