Add migrations with surrealdb-migrations

Cargo.toml

@@ -22,7 +22,7 @@ serde-aux = "4"
 serde_json = "1"
 serde_with = "3"
 # DB
-surrealdb = { git = "https://github.com/surrealdb/surrealdb.git", tag = "v1.0.0", features = [
+surrealdb = { version = "1.0.0", features = [
   "protocol-http",
   "kv-mem",
 ] }
@@ -62,6 +62,7 @@ jsonwebtoken = "8.3.0"
 lazy-regex = "2"
 strum_macros = "0.24"
 uuid = "1.3.3"
+surrealdb-migrations = "1.0.0-preview.1"
 
 [dev-dependencies]
 reqwest = "0.11.18"

migrations/definitions/_initial.json

@@ -0,0 +1 @@
+{"schemas":"DEFINE TABLE link SCHEMAFULL;\n\nDEFINE FIELD url ON TABLE link TYPE string;\nDEFINE FIELD title ON TABLE link TYPE string;\nDEFINE FIELD note ON TABLE link TYPE string;\nDEFINE FIELD user ON TABLE link TYPE record (user);\nDEFINE FIELD bookmarked_at ON TABLE link TYPE datetime DEFAULT time::now();\nDEFINE INDEX idx_user ON TABLE link COLUMNS user;\n\nDEFINE TABLE script_migration SCHEMAFULL\n    PERMISSIONS\n        FOR select FULL\n        FOR create, update, delete NONE;\n\nDEFINE FIELD script_name ON script_migration TYPE string;\nDEFINE FIELD executed_at ON script_migration TYPE datetime DEFAULT time::now();\n\nDEFINE TABLE token SCHEMAFULL;\n\nDEFINE FIELD token_hash ON TABLE token TYPE string;\nDEFINE FIELD name ON TABLE token TYPE string;\nDEFINE FIELD short_token ON TABLE token TYPE string;\nDEFINE FIELD user ON TABLE token TYPE record (user);\nDEFINE INDEX idx_hash ON TABLE token COLUMNS token_hash UNIQUE;\nDEFINE INDEX idx_user ON TABLE token COLUMNS user;\n\nDEFINE TABLE user SCHEMAFULL;\n\nDEFINE FIELD username ON TABLE user TYPE string;\nDEFINE FIELD password ON TABLE user TYPE string;\nDEFINE INDEX idx_username ON TABLE user COLUMNS username UNIQUE;\n","events":""}

schemas/link.surql

@@ -0,0 +1,8 @@
+DEFINE TABLE link SCHEMAFULL;
+
+DEFINE FIELD url ON TABLE link TYPE string;
+DEFINE FIELD title ON TABLE link TYPE string;
+DEFINE FIELD note ON TABLE link TYPE string;
+DEFINE FIELD user ON TABLE link TYPE record (user);
+DEFINE FIELD bookmarked_at ON TABLE link TYPE datetime DEFAULT time::now();
+DEFINE INDEX idx_user ON TABLE link COLUMNS user;

schemas/script_migration.surql

@@ -0,0 +1,7 @@
+DEFINE TABLE script_migration SCHEMAFULL
+    PERMISSIONS
+        FOR select FULL
+        FOR create, update, delete NONE;
+
+DEFINE FIELD script_name ON script_migration TYPE string;
+DEFINE FIELD executed_at ON script_migration TYPE datetime DEFAULT time::now();

schemas/token.surql

@@ -0,0 +1,8 @@
+DEFINE TABLE token SCHEMAFULL;
+
+DEFINE FIELD token_hash ON TABLE token TYPE string;
+DEFINE FIELD name ON TABLE token TYPE string;
+DEFINE FIELD short_token ON TABLE token TYPE string;
+DEFINE FIELD user ON TABLE token TYPE record (user);
+DEFINE INDEX idx_hash ON TABLE token COLUMNS token_hash UNIQUE;
+DEFINE INDEX idx_user ON TABLE token COLUMNS user;

schemas/user.surql

@@ -0,0 +1,5 @@
+DEFINE TABLE user SCHEMAFULL;
+
+DEFINE FIELD username ON TABLE user TYPE string;
+DEFINE FIELD password ON TABLE user TYPE string;
+DEFINE INDEX idx_username ON TABLE user COLUMNS username UNIQUE;

src/main.rs

@@ -6,6 +6,7 @@ use linkstowr::{
     types::AppState,
 };
 use surrealdb::{engine::any::Any, opt::auth::Root, Surreal};
+use surrealdb_migrations::MigrationRunner;
 use tracing::info;
 
 #[tokio::main]
@@ -65,6 +66,11 @@ async fn get_db(configuration: &Settings) -> Surreal<Any> {
         .await
         .unwrap();
 
+    MigrationRunner::new(&db)
+        .up()
+        .await
+        .expect("Failed to apply migrations");
+
     info!(
         "Connected to namespace: {}, database: {}",
         &configuration.database.ns, &configuration.database.db

tests/api_tests.rs

@@ -1,4 +1,4 @@
-use std::{fs, net::TcpListener};
+use std::net::TcpListener;
 
 use linkstowr::{
     app::get_app,
@@ -13,6 +13,7 @@ use linkstowr::{
 };
 use serde_json::{json, Value};
 use surrealdb::sql::thing;
+use surrealdb_migrations::MigrationRunner;
 use uuid::Uuid;
 
 const TEST_USER_PASSWORD: &str = "password";
@@ -30,12 +31,10 @@ async fn spawn_app() -> TestApp {
     db.use_ns("test").use_db("test").await.unwrap();
 
     // Initialize schema
-    let schema =
-        fs::read_to_string("db/schema.sql").expect("Failed to read schema file from db/schema.sql");
-
-    db.query(schema)
+    MigrationRunner::new(&db)
+        .up()
         .await
-        .expect("Failed to initialize the DB schema");
+        .expect("Failed to apply migrations");
 
     // Setup env var for JWT
     std::env::set_var("JWT_ENCODING_SECRET", JWT_ENCODING_SECRET);