Skip to content
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
156 changes: 78 additions & 78 deletions src/controllers/query.controller.ts
Original file line number Diff line number Diff line change
@@ -1,95 +1,95 @@
// controllers/query.controller.ts
import { Context } from "../types/context.types.ts";
import { QueryRequest, QueryResponse, ErrorResponse, RespData } from "../types/api.types.ts";
import { QueryRequest, QueryResponse, ErrorResponse } from "../types/api.types.ts";
import { db } from "../services/database.service.ts";
import { logger } from "../services/logger.service.ts";
import { validateQuery, substituteParams } from "../utils/query.utils.ts";
import { generateTypes } from "https://deno.land/x/dts/mod.ts";

async function getTypes(renderedQuery: string): Promise<RespData> {
const firstRow = (await db.query(renderedQuery))[0];
if (!firstRow) {
return {
status: 400,
type: 'application/json',
body: { error: "No data returned to generate types" }
};
}

const typeDef = await generateTypes(firstRow);
return {
status: 200,
type: 'text/plain',
body: typeDef
};
}

export async function executeQuery(ctx: Context) {
if (!ctx.request.hasBody) {
ctx.response.status = 400;
ctx.response.body = { error: "Request body required" };
return;
}
if (!ctx.request.hasBody) {
ctx.response.status = 400;
ctx.response.type = 'application/json';
ctx.response.body = { error: "Request body required" };
return;
}

const queryParams = new URLSearchParams(ctx.request.url.search);
const dts = queryParams.has('dts');
let respData: RespData;
try {
// Parse request
const body = await ctx.request.body.json();
const reqData: QueryRequest = typeof body === "string" ? JSON.parse(body) : body;
logger.debug(`Request data: ${JSON.stringify(reqData)}`);

try {
const body = await ctx.request.body.json();
logger.debug(`Request body: ${JSON.stringify(body)}`);
// Validate query
const validationError = validateQuery(reqData.query);
if (validationError) {
ctx.response.status = 405;
ctx.response.type = 'application/json';
ctx.response.body = { error: validationError };
return;
}

const reqData: QueryRequest = typeof body === "string" ? JSON.parse(body) : body;
logger.debug(`Request data: ${JSON.stringify(reqData)}`);
// Process query
const renderedQuery = substituteParams(reqData.query, reqData.params);
if(renderedQuery !== reqData.query) {
logger.debug(`Rendered query: ${renderedQuery}`);
}

const renderedQuery = substituteParams(reqData.query, reqData.params);
if(renderedQuery !== reqData.query) {
logger.debug(`Rendered query: ${renderedQuery}`);
}
// Generate types or execute query
const dts = new URLSearchParams(ctx.request.url.search).has('dts');
if (dts) {
const firstRow = (await db.query(renderedQuery))[0];
if (!firstRow) {
ctx.response.status = 400;
ctx.response.type = 'application/json';
ctx.response.body = { error: "No data returned to generate types" };
return;
}
ctx.response.type = 'text/plain';
ctx.response.status = 200;
ctx.response.body = await generateTypes(firstRow);
return;
}

const validationError = validateQuery(reqData.query);
if (validationError) {
ctx.response.status = 405;
ctx.response.body = { error: validationError };
return;
}
// Execute query and return data
const startTime = new Date().toISOString();
const t0 = performance.now();
const rows = await db.query(renderedQuery);

const startTime = new Date().toISOString();
const t0 = performance.now();
const response: QueryResponse = {
data: rows,
...((reqData.showMetadata !== false) && {
metadata: {
operation: {
startTime,
endTime: new Date().toISOString(),
duration: `${performance.now() - t0} ms`,
status: 'OK'
},
result: {
rowCount: rows.length
},
request: {
query: reqData.query,
...(reqData.params && {
params: reqData.params,
renderedQuery
})
}
}
})
};

const rows = await db.query(renderedQuery);

const response: QueryResponse = {
data: rows,
...((reqData.showMetadata !== false) && { // Only exclude if explicitly false
metadata: {
operation: {
startTime,
endTime: new Date().toISOString(),
duration: `${performance.now() - t0} ms`,
status: 'OK'
},
result: {
rowCount: rows.length
},
request: {
query: reqData.query,
...(reqData.params && {
params: reqData.params,
renderedQuery: renderedQuery
})
}
}
})
};
ctx.response.type = 'application/json';
ctx.response.status = 200;
ctx.response.body = response;

ctx.response.body = response;
} catch (error) {
logger.error(`Query execution failed: ${error.message}`);
ctx.response.status = 400;
const errorResponse: ErrorResponse = {
error: error.message.replace(/\n/g, "")
};
ctx.response.body = errorResponse;
}
} catch (error) {
logger.error(`Query execution failed: ${error.message}`);
ctx.response.type = 'application/json';
ctx.response.status = 400;
ctx.response.body = {
error: error.message.replace(/\n/g, "")
};
}
}
36 changes: 36 additions & 0 deletions src/tests/api.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,42 @@ Deno.test("API Integration Tests", async (t) => {
assertEquals(response.status, 200);
assertExists(data.data);
});

await t.step("Query execution - DTS generation", async () => {
const { response, data } = await makeRequest(
"http://localhost:8080/stackql?dts=true",
{
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
query: "DESCRIBE EXTENDED aws.ec2.instances"
})
}
);
assertEquals(response.status, 200);
assertEquals(response.headers.get("content-type"), "text/plain; charset=UTF-8");
assertExists(data.includes("declare module namespace"));
assertExists(data.includes("IRootObject"));
assertExists(data.includes("name: string"));
});

await t.step("Query execution - metadata disabled", async () => {
const { response, data } = await makeRequest(
"http://localhost:8080/stackql",
{
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
query: "SELECT * FROM github.repos.contributors WHERE repo = 'stackql' and owner = 'stackql'",
showMetadata: false
})
}
);
assertEquals(response.status, 200);
assertExists(data.data);
assertEquals(data.metadata, undefined);
});

} finally {
// Clean up all fetch requests
controllers.forEach(controller => controller.abort());
Expand Down
4 changes: 2 additions & 2 deletions src/utils/query.utils.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// utils/query.utils.ts
const ALLOWED_QUERY_TYPES = ['select', 'show', 'describe'];
const ALLOWED_QUERY_TYPES = ['select', 'show', 'describe', 'registry'];

export function validateQuery(query: string): string | null {
if (!query) {
Expand All @@ -8,7 +8,7 @@ export function validateQuery(query: string): string | null {

const queryType = query.trim().toLowerCase().split(' ')[0];
if (!ALLOWED_QUERY_TYPES.includes(queryType)) {
return `Query type '${queryType}' not allowed. Only SELECT, SHOW, and DESCRIBE are supported`;
return `Query type '${queryType}' not allowed. Only SELECT, SHOW, DESCRIBE and REGISTRY are supported`;
}

return null;
Expand Down