sync/src/database/tables.js

const LOGGER = require('@calzoneman/jsli')('database/tables');


export async function initTables() {
    const knex = require('../database').getDB().knex;

    async function ensureTable(name, structure) {
        if (!await knex.schema.hasTable(name)) {
            LOGGER.info('Creating table %s', name);
            await knex.schema.createTable(name, structure);
        }
    }

    // TODO: consider un-utf8ing columns that are always ASCII
    // Leaving for now for backwards compatibility

    // TODO: enforce foreign key constraints for tables missing them

    await ensureTable('users', t => {
        t.charset('utf8');
        t.increments('id').notNullable().primary();
        t.string('name', 20).notNullable().unique();
        t.string('password', 60).notNullable();
        t.integer('global_rank').notNullable();
        t.string('email', 255);
        // UTF8MB4 required for non-BMP Unicode -- Just MySQL things (tm)
        t.specificType('profile', 'text character set utf8mb4 not null');
        t.string('ip', 39).notNullable();
        // Registration time, TODO convert to timestamp
        t.bigint('time').notNullable();
        t.string('name_dedupe', 20).defaultTo(null);
    });

    await ensureTable('channels', t => {
        t.charset('utf8');
        t.increments('id').notNullable().primary();
        t.string('name', 30).notNullable().unique();
        t.string('owner', 20).notNullable().index();
        // Registration time, TODO convert to timestamp
        t.bigInteger('time').notNullable();
        t.timestamp('last_loaded').notNullable()
                .defaultTo(knex.raw('0'));
        t.timestamp('owner_last_seen').notNullable()
                .defaultTo(knex.raw('0'));
    });

    await ensureTable('channel_data', t => {
        t.charset('utf8');
        t.integer('channel_id').notNullable()
                .unsigned()
                .references('id').inTable('channels')
                .onDelete('cascade');
        t.string('key', 20).notNullable();
        t.specificType('value', 'mediumtext character set utf8mb4 not null');
        t.primary(['channel_id', 'key']);
    });

    await ensureTable('global_bans', t => {
        t.charset('utf8');
        t.string('ip', 39).notNullable().primary();
        t.string('reason', 255).notNullable();
    });

    await ensureTable('password_reset', t => {
        t.charset('utf8');
        t.string('ip', 39).notNullable();
        t.string('name', 20).notNullable().primary();
        t.string('hash', 64).notNullable();
        t.string('email', 255).notNullable();
        // TODO consider converting to timestamp
        t.bigint('expire').notNullable();
    });

    await ensureTable('user_playlists', t => {
        t.charset('utf8');
        t.string('user', 20).notNullable();
        t.string('name', 255).notNullable();
        t.specificType('contents', 'mediumtext character set utf8mb4 not null');
        t.integer('count').notNullable();
        t.integer('duration').notNullable();
        t.primary(['user', 'name']);
    });

    await ensureTable('aliases', t => {
        t.charset('utf8');
        t.increments('visit_id').notNullable().primary();
        t.string('ip', 39).notNullable().index();
        t.string('name', 20).notNullable();
        // TODO consider converting to timestamp
        t.bigint('time').notNullable();
    });

    await ensureTable('meta', t => {
        t.charset('utf8');
        t.string('key', 255).notNullable().primary();
        t.text('value').notNullable();
    });

    await ensureTable('channel_libraries', t => {
        t.charset('utf8');
        t.string('id', 255).notNullable();
        t.specificType('title', 'varchar(255) character set utf8mb4 not null');
        t.integer('seconds').notNullable();
        t.string('type', 2).notNullable();
        t.text('meta').notNullable();
        t.string('channel', 30).notNullable();
        t.primary(['id', 'channel']);
        // TODO replace title index with FTS or elasticsearch or something
        t.index(['channel', knex.raw('`title`(227)')], 'channel_libraries_channel_title');
    });

    await ensureTable('channel_ranks', t => {
        t.charset('utf8');
        t.string('name', 20).notNullable();
        t.integer('rank').notNullable();
        t.string('channel', 30).notNullable();
        t.primary(['name', 'channel']);
    });

    await ensureTable('channel_bans', t => {
        t.charset('utf8');
        t.increments('id').notNullable().primary();
        t.string('ip', 39).notNullable();
        t.string('name', 20).notNullable();
        t.string('bannedby', 20).notNullable();
        t.specificType('reason', 'varchar(255) character set utf8mb4 not null');
        t.string('channel', 30).notNullable();
        t.unique(['name', 'ip', 'channel']);
        t.index(['ip', 'channel']);
        t.index(['name', 'channel']);
    });
}