flamenco/internal/manager/persistence/db.go

// Package persistence provides the database interface for Flamenco Manager.
package persistence

/* ***** BEGIN GPL LICENSE BLOCK *****
 *
 * Original Code Copyright (C) 2022 Blender Foundation.
 *
 * This file is part of Flamenco.
 *
 * Flamenco is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 *
 * Flamenco is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * Flamenco.  If not, see <https://www.gnu.org/licenses/>.
 *
 * ***** END GPL LICENSE BLOCK ***** */

import (
	"context"
	"database/sql"
	"fmt"

	"github.com/rs/zerolog/log"
	_ "modernc.org/sqlite"

	"gitlab.com/blender/flamenco-goja-test/internal/manager/job_compilers"
	"gitlab.com/blender/flamenco-goja-test/pkg/api"
)

// TODO : have this configurable from the CLI.
const dbURI = "flamenco-manager.sqlite"

// DB provides the database interface.
type DB struct {
	sqldb *sql.DB
}

func OpenDB(ctx context.Context) (*DB, error) {
	log.Info().Str("uri", dbURI).Msg("opening database")
	return openDB(ctx, dbURI)
}

func openDB(ctx context.Context, uri string) (*DB, error) {
	sqldb, err := sql.Open("sqlite", uri)
	if err != nil {
		return nil, fmt.Errorf("unable to open database: %w", err)
	}

	if err := sqldb.PingContext(ctx); err != nil {
		return nil, fmt.Errorf("error accessing database %s: %w", dbURI, err)
	}

	db := DB{
		sqldb: sqldb,
	}
	if err := db.migrate(); err != nil {
		return nil, err
	}

	return &db, err
}

func (db *DB) StoreJob(ctx context.Context, authoredJob job_compilers.AuthoredJob) error {
	tx, err := db.sqldb.BeginTx(ctx, nil)
	if err != nil {
		return err
	}
	defer tx.Rollback()

	_, err = tx.ExecContext(ctx,
		`INSERT INTO jobs (uuid, name, jobType, priority) VALUES (?, ?, ?, ?)`,
		authoredJob.JobID, authoredJob.Name, authoredJob.JobType, authoredJob.Priority,
	)
	if err != nil {
		return err
	}

	for key, value := range authoredJob.Settings {
		_, err := tx.ExecContext(ctx,
			`INSERT INTO job_settings (job_id, key, value) VALUES (?, ?, ?)`,
			authoredJob.JobID, key, value,
		)
		if err != nil {
			return err
		}
	}

	for key, value := range authoredJob.Metadata {
		_, err := tx.ExecContext(ctx,
			`INSERT INTO job_metadata (job_id, key, value) VALUES (?, ?, ?)`,
			authoredJob.JobID, key, value,
		)
		if err != nil {
			return err
		}
	}

	return tx.Commit()
}

func (db *DB) FetchJob(ctx context.Context, jobID string) (*api.Job, error) {
	job := api.Job{}

	err := db.sqldb.
		QueryRowContext(ctx, `SELECT * FROM jobs j where j.uuid=?`, jobID).
		Scan(&job.Id, &job.Name, &job.Type, &job.Priority, &job.Created, &job.Updated)
	if err != nil {
		return nil, err
	}

	var settings api.JobSettings
	rows, err := db.sqldb.QueryContext(ctx, "SELECT key, value FROM job_settings WHERE job_id=?", jobID)
	if err != nil {
		return nil, err
	}
	defer rows.Close()
	for rows.Next() {
		var key, value string
		if err := rows.Scan(&key, &value); err != nil {
			return nil, err
		}
		settings.AdditionalProperties[key] = value
	}
	if err := rows.Close(); err != nil {
		return nil, err
	}
	if err := rows.Err(); err != nil {
		return nil, err
	}

	var metadata api.JobMetadata
	rows, err = db.sqldb.QueryContext(ctx, "SELECT key, value FROM job_metadata WHERE job_id=?", jobID)
	if err != nil {
		return nil, err
	}
	defer rows.Close()
	for rows.Next() {
		var key, value string
		if err := rows.Scan(&key, &value); err != nil {
			return nil, err
		}
		metadata.AdditionalProperties[key] = value
	}
	if err := rows.Close(); err != nil {
		return nil, err
	}
	if err := rows.Err(); err != nil {
		return nil, err
	}

	job.Settings = &settings
	job.Metadata = &metadata

	return &job, nil
}