fediglam/src/sql/lib.zig

const std = @import("std");
const util = @import("util");

const postgres = @import("./engines/postgres.zig");
//const postgres = @import("./engines/null.zig");
const sqlite = @import("./engines/sqlite.zig");
//const sqlite = @import("./engines/null.zig");
const common = @import("./engines/common.zig");
const Allocator = std.mem.Allocator;

const errors = @import("./errors.zig").library_errors;

pub const OpenError = errors.OpenError;
pub const QueryError = errors.QueryError;
pub const RowError = errors.RowError;
pub const QueryRowError = errors.QueryRowError;
pub const BeginError = errors.BeginError;
pub const CommitError = errors.CommitError;

pub const QueryOptions = common.QueryOptions;

pub const Engine = enum {
    postgres,
    sqlite,
};

pub const Config = union(Engine) {
    postgres: struct {
        pg_conn_str: [:0]const u8,
    },
    sqlite: struct {
        sqlite_file_path: [:0]const u8,
    },
};

const RawResults = union(Engine) {
    postgres: postgres.Results,
    sqlite: sqlite.Results,

    fn finish(self: RawResults) void {
        switch (self) {
            .postgres => |pg| pg.finish(),
            .sqlite => |lite| lite.finish(),
        }
    }

    fn columnCount(self: RawResults) !u15 {
        return try switch (self) {
            .postgres => |pg| pg.columnCount(),
            .sqlite => |lite| lite.columnCount(),
        };
    }

    fn columnIndex(self: RawResults, name: []const u8) error{ NotFound, Unexpected }!u15 {
        return switch (self) {
            .postgres => |pg| pg.columnIndex(name),
            .sqlite => |lite| lite.columnIndex(name),
        } catch |err| switch (err) {
            error.OutOfRange => error.Unexpected,
            error.NotFound => error.NotFound,
        };
    }

    fn row(self: *RawResults) RowError!?Row {
        return switch (self.*) {
            .postgres => |*pg| if (try pg.row()) |r| Row{ .postgres = r } else null,
            .sqlite => |*lite| if (try lite.row()) |r| Row{ .sqlite = r } else null,
        };
    }
};

// Represents a set of results.
// row() must be called until it returns null, or the query may not complete
// Must be deallocated by a call to finish()
pub fn Results(comptime T: type) type {
    // would normally make this a declaration of the struct, but it causes the compiler to crash
    const fields = if (T == void) .{} else std.meta.fields(T);
    return struct {
        const Self = @This();

        underlying: RawResults,
        column_indices: [fields.len]u15,

        fn from(underlying: RawResults) QueryError!Self {
            if (std.debug.runtime_safety and fields.len != underlying.columnCount() catch unreachable) {
                std.log.err("Expected {} columns in result, got {}", .{ fields.len, underlying.columnCount() catch unreachable });
                return error.ColumnMismatch;
            }

            return Self{ .underlying = underlying, .column_indices = blk: {
                var indices: [fields.len]u15 = undefined;
                inline for (fields) |f, i| {
                    indices[i] = if (!std.meta.trait.isTuple(T))
                        underlying.columnIndex(f.name) catch {
                            std.log.err("Could not find column index for field {s}", .{f.name});
                            return error.ColumnMismatch;
                        }
                    else
                        i;
                }
                break :blk indices;
            } };
        }

        pub fn finish(self: Self) void {
            self.underlying.finish();
        }

        // Returns the next row of results, or null if there are no more rows.
        // Caller owns all memory allocated. The entire object can be deallocated with a
        // call to util.deepFree
        pub fn row(self: *Self, alloc: ?Allocator) RowError!?T {
            if (try self.underlying.row()) |row_val| {
                var result: T = undefined;
                var fields_allocated: usize = 0;
                errdefer inline for (fields) |f, i| {
                    // Iteration bounds must be defined at comptime (inline for) but the number of fields we could
                    // successfully allocate is defined at runtime. So we iterate over the entire field array and
                    // conditionally deallocate fields in the loop.
                    if (i < fields_allocated) util.deepFree(alloc, @field(result, f.name));
                };

                inline for (fields) |f, i| {
                    // TODO: Causes compiler segfault. why?
                    //const F = f.field_type;
                    const F = @TypeOf(@field(result, f.name));
                    @field(result, f.name) = row_val.get(F, self.column_indices[i], alloc) catch |err| {
                        std.log.err("SQL: Error getting column {s} of type {}", .{ f.name, F });
                        return err;
                    };
                    fields_allocated += 1;
                }

                return result;
            } else return null;
        }
    };
}

// Row is invalidated by the next call to result.row()
const Row = union(Engine) {
    postgres: postgres.Row,
    sqlite: sqlite.Row,

    // Returns a value of type T from the zero-indexed column given by idx.
    // Not all types require an allocator to be present. If an allocator is needed but
    // not required, it will return error.AllocatorRequired.
    // The caller is responsible for deallocating T, if relevant.
    fn get(self: Row, comptime T: type, idx: u15, alloc: ?Allocator) common.GetError!T {
        if (T == void) return;
        return switch (self) {
            .postgres => |pg| pg.get(T, idx, alloc),
            .sqlite => |lite| lite.get(T, idx, alloc),
        };
    }
};

const QueryHelper = union(Engine) {
    postgres: postgres.Db,
    sqlite: sqlite.Db,

    // internal helper fn
    fn queryInternal(
        self: QueryHelper,
        sql: [:0]const u8,
        args: anytype,
        opt: QueryOptions,
    ) QueryError!RawResults {
        return switch (self) {
            .postgres => |pg| RawResults{ .postgres = try pg.exec(sql, args, opt) },
            .sqlite => |lite| RawResults{ .sqlite = try lite.exec(sql, args, opt) },
        };
    }

    fn queryWithOptions(
        self: QueryHelper,
        comptime RowType: type,
        sql: [:0]const u8,
        args: anytype,
        options: QueryOptions,
    ) QueryError!Results(RowType) {
        return Results(RowType).from(try self.queryInternal(sql, args, options));
    }

    // Executes a query and returns the result set
    fn query(
        self: QueryHelper,
        comptime RowType: type,
        sql: [:0]const u8,
        args: anytype,
        alloc: ?Allocator,
    ) QueryError!Results(RowType) {
        return self.queryWithOptions(RowType, sql, args, .{ .prep_allocator = alloc });
    }

    // Executes a query without returning results
    fn exec(
        self: QueryHelper,
        sql: [:0]const u8,
        args: anytype,
        alloc: ?Allocator,
    ) QueryError!void {
        _ = self.queryRow(void, sql, args, alloc) catch |err| return switch (err) {
            error.NoRows => {},
            error.TooManyRows => error.SqlException,
            error.ResultTypeMismatch => unreachable,
            else => |err2| err2,
        };
    }

    // Runs a query and returns a single row
    fn queryRow(
        self: QueryHelper,
        comptime RowType: type,
        q: [:0]const u8,
        args: anytype,
        alloc: ?Allocator,
    ) QueryRowError!RowType {
        var results = try self.query(RowType, q, args, alloc);
        defer results.finish();

        const row = (try results.row(alloc)) orelse return error.NoRows;
        errdefer util.deepFree(alloc, row);

        // execute query to completion
        var more_rows = false;
        while (try results.row(alloc)) |r| {
            util.deepFree(alloc, r);
            more_rows = true;
        }
        if (more_rows) return error.TooManyRows;

        return row;
    }

    // Inserts a single value into a table
    fn insert(
        self: QueryHelper,
        comptime table: []const u8,
        value: anytype,
        alloc: ?std.mem.Allocator,
    ) !void {
        const ValueType = comptime @TypeOf(value);

        const fields = std.meta.fields(ValueType);
        comptime var types: [fields.len]type = undefined;
        comptime var table_spec: []const u8 = table ++ "(";
        comptime var value_spec: []const u8 = "(";
        inline for (fields) |field, i| {
            // This causes a compile error. Why?
            //const F = field.field_type;
            const F = @TypeOf(@field(std.mem.zeroes(ValueType), field.name));
            // causes issues if F is @TypeOf(null), use dummy type
            types[i] = if (F == @TypeOf(null)) ?i64 else F;
            table_spec = comptime (table_spec ++ field.name ++ ",");
            value_spec = comptime value_spec ++ std.fmt.comptimePrint("${},", .{i + 1});
        }
        table_spec = comptime table_spec[0 .. table_spec.len - 1] ++ ")";
        value_spec = comptime value_spec[0 .. value_spec.len - 1] ++ ")";
        const q = comptime std.fmt.comptimePrint(
            "INSERT INTO {s} VALUES {s}",
            .{ table_spec, value_spec },
        );

        var args_tuple: std.meta.Tuple(&types) = undefined;
        inline for (fields) |field, i| {
            args_tuple[i] = @field(value, field.name);
        }
        try self.exec(q, args_tuple, alloc);
    }
};

pub const ConstraintMode = enum {
    deferred,
    immediate,
};

pub const Db = struct {
    tx_open: bool = false,
    engine: QueryHelper,

    pub const is_transaction = false;

    pub fn open(cfg: Config) OpenError!Db {
        return switch (cfg) {
            .postgres => |postgres_cfg| Db{
                .engine = .{
                    .postgres = try postgres.Db.open(postgres_cfg.pg_conn_str),
                },
            },
            .sqlite => |lite_cfg| Db{
                .engine = .{
                    .sqlite = try sqlite.Db.open(lite_cfg.sqlite_file_path),
                },
            },
        };
    }

    pub fn close(self: *Db) void {
        switch (self.engine) {
            .postgres => |pg| pg.close(),
            .sqlite => |lite| lite.close(),
        }
    }

    pub fn queryWithOptions(
        self: *Db,
        comptime RowType: type,
        sql: [:0]const u8,
        args: anytype,
        opt: QueryOptions,
    ) QueryError!Results(RowType) {
        if (self.tx_open) return error.BadTransactionState;
        return self.engine.queryWithOptions(RowType, sql, args, opt);
    }

    pub fn query(
        self: *Db,
        comptime RowType: type,
        sql: [:0]const u8,
        args: anytype,
        alloc: ?Allocator,
    ) QueryError!Results(RowType) {
        if (self.tx_open) return error.BadTransactionState;
        return self.engine.query(RowType, sql, args, alloc);
    }

    pub fn exec(
        self: *Db,
        sql: [:0]const u8,
        args: anytype,
        alloc: ?Allocator,
    ) QueryError!void {
        if (self.tx_open) return error.BadTransactionState;
        return self.engine.exec(sql, args, alloc);
    }

    pub fn queryRow(
        self: *Db,
        comptime RowType: type,
        sql: [:0]const u8,
        args: anytype,
        alloc: ?Allocator,
    ) QueryRowError!RowType {
        if (self.tx_open) return error.BadTransactionState;
        return self.engine.queryRow(RowType, sql, args, alloc);
    }

    pub fn insert(
        self: *Db,
        comptime table: []const u8,
        value: anytype,
        alloc: ?std.mem.Allocator,
    ) !void {
        if (self.tx_open) return error.BadTransactionState;
        return self.engine.insert(table, value, alloc);
    }

    pub fn sqlEngine(self: *Db) Engine {
        return self.engine;
    }

    // Begins a transaction
    pub fn begin(self: *Db) !Tx {
        if (self.tx_open) return error.BadTransactionState;

        try self.exec("BEGIN", {}, null);
        self.tx_open = true;

        return Tx{ .db = self };
    }
};

pub const Tx = struct {
    db: *Db,

    pub const is_transaction = true;

    pub fn queryWithOptions(
        self: Tx,
        comptime RowType: type,
        sql: [:0]const u8,
        args: anytype,
        options: QueryOptions,
    ) QueryError!Results(RowType) {
        if (!self.db.tx_open) return error.BadTransactionState;
        return self.db.engine.queryWithOptions(RowType, sql, args, options);
    }

    // Executes a query and returns the result set
    pub fn query(
        self: Tx,
        comptime RowType: type,
        sql: [:0]const u8,
        args: anytype,
        alloc: ?Allocator,
    ) QueryError!Results(RowType) {
        if (!self.db.tx_open) return error.BadTransactionState;
        return self.db.engine.query(RowType, sql, args, alloc);
    }

    // Executes a query without returning results
    pub fn exec(
        self: Tx,
        sql: [:0]const u8,
        args: anytype,
        alloc: ?Allocator,
    ) QueryError!void {
        if (!self.db.tx_open) return error.BadTransactionState;
        return self.db.engine.exec(sql, args, alloc);
    }

    // Runs a query and returns a single row
    pub fn queryRow(
        self: Tx,
        comptime RowType: type,
        sql: [:0]const u8,
        args: anytype,
        alloc: ?Allocator,
    ) QueryRowError!RowType {
        if (!self.db.tx_open) return error.BadTransactionState;
        return self.db.engine.queryRow(RowType, sql, args, alloc);
    }

    // Inserts a single value into a table
    pub fn insert(
        self: Tx,
        comptime table: []const u8,
        value: anytype,
        alloc: ?std.mem.Allocator,
    ) !void {
        if (!self.db.tx_open) return error.BadTransactionState;
        return self.db.engine.insert(table, value, alloc);
    }

    pub fn sqlEngine(self: Tx) Engine {
        return self.db.engine;
    }

    // Allows relaxing *some* constraints for the lifetime of the transaction.
    // You should generally not do this, but it's useful when bootstrapping
    // the initial admin community and cluster operator user.
    pub fn setConstraintMode(self: Tx, mode: ConstraintMode) QueryError!void {
        if (!self.db.tx_open) return error.BadTransactionState;
        switch (self.db.engine) {
            .sqlite => try self.exec(
                switch (mode) {
                    .immediate => "PRAGMA defer_foreign_keys = FALSE",
                    .deferred => "PRAGMA defer_foreign_keys = TRUE",
                },
                {},
                null,
            ),
            .postgres => try self.exec(
                switch (mode) {
                    .immediate => "SET CONSTRAINTS ALL IMMEDIATE",
                    .deferred => "SET CONSTRAINTS ALL DEFERRED",
                },
                {},
                null,
            ),
        }
    }

    pub fn rollback(self: Tx) void {
        if (!self.db.tx_open) @panic("Transaction not open");
        self.exec("ROLLBACK", {}, null) catch |err| {
            std.log.err("Error occured during rollback operation: {}", .{err});
        };
        self.db.tx_open = false;
    }

    pub fn commit(self: Tx) CommitError!void {
        if (!self.db.tx_open) return error.BadTransactionState;
        self.exec("COMMIT", {}, null) catch |err| switch (err) {
            error.BindException,
            error.OutOfMemory,
            error.UnusedArgument,
            error.AllocatorRequired,
            => return error.Unexpected,

            // use a new capture because it's got a smaller error set
            else => |err2| return err2,
        };
        self.db.tx_open = false;
    }
};