More new tables: media_uploads, audit_logs

.idea/dictionaries/bt.xml

@@ -10,6 +10,8 @@
       <w>hifigan</w>
       <w>scrollback</w>
       <w>tacotron</w>
+      <w>transcoded</w>
+      <w>transcodings</w>
       <w>upserting</w>
       <w>vocoder</w>
       <w>vocoders</w>

_migrations/2022-12-15-060826_media_uploads/down.sql

@@ -0,0 +1,5 @@
+-- noinspection SqlDialectInspectionForFile
+-- noinspection SqlNoDataSourceInspectionForFile
+-- noinspection SqlResolveForFile
+
+drop table media_uploads;

_migrations/2022-12-15-060826_media_uploads/up.sql

@@ -0,0 +1,129 @@
+-- noinspection SqlDialectInspectionForFile
+-- noinspection SqlNoDataSourceInspectionForFile
+-- noinspection SqlResolveForFile
+
+CREATE TABLE media_uploads (
+
+  -- Not used for anything except replication.
+  id BIGINT(20) NOT NULL AUTO_INCREMENT,
+
+  -- Effective "primary key" (PUBLIC)
+  -- This is so the in-progress results can be looked up by the UI.
+  token VARCHAR(32) NOT NULL,
+
+  -- Idempotency token from client
+  -- This is so the frontend client doesn't submit duplicate jobs.
+  uuid_idempotency_token VARCHAR(36) NOT NULL,
+
+  -- ========== MEDIA DETAILS ==========
+
+  -- Type of media:
+  --   * 'audio' for wav, mp3, etc.
+  --   * 'video' for a variety of video types.
+  media_type VARCHAR(16) NOT NULL,
+
+  -- The original filename of the media
+  maybe_original_filename VARCHAR(255) DEFAULT NULL,
+
+  -- The original (non-transcoded or truncated) file size
+  original_file_size_bytes INT(10) NOT NULL DEFAULT 0,
+
+  -- The original (non-transcoded or truncated) duration in millis.
+  original_duration_millis INT(10) NOT NULL DEFAULT 0,
+
+  -- The original file's mime type.
+  maybe_original_mime_type VARCHAR(32) DEFAULT NULL,
+
+  -- Audio encoder details
+  -- Only present if the file was audio or a video that had audio.
+  maybe_original_audio_encoding VARCHAR(32) DEFAULT NULL,
+
+  -- Video encoder details
+  -- Only present if the file was a video.
+  maybe_original_video_encoding VARCHAR(32) DEFAULT NULL,
+
+  -- For videos, the original frame width.
+  maybe_original_frame_width INT(5) DEFAULT NULL,
+
+  -- For videos, the original frame height.
+  maybe_original_frame_height INT(5) DEFAULT NULL,
+
+  -- Checksum of the original media
+  -- SHA1 hash [SHA2 = CHAR(64), SHA1 = CHAR(40), MD5 = CHAR(32)]
+  -- checksum_sha1 CHAR(40) NOT NULL,
+
+  -- Checksum of the original media
+  -- SHA2 hash [SHA2 = CHAR(64), SHA1 = CHAR(40), MD5 = CHAR(32)]
+  -- Note that SHA2 is a hash family (SHA-228, SHA-256, SHA-384, SHA-512, SHA-512/224, SHA-512/256, ...)
+  -- and produces different lengths output depending on the choice of algorithm.
+  checksum_sha2 CHAR(64) NOT NULL,
+
+  -- ========== UPLOAD, TRANSCODING, AND TRUNCATION DETAILS ==========
+
+  -- The directory this media is uploaded to will be exclusive for this file.
+  -- Only this given record will live in this bucket, but the directory may include
+  -- other transcodings or truncations.
+  public_bucket_directory_full_path VARCHAR(255) NOT NULL,
+
+  -- We'll likely transcode (and potentially truncate) most media given to us.
+  -- This will store a json-encoded struct that details the changes.
+  -- TEXT = 65,535 bytes (64 KiB), ~= 4 bytes per UTF-8 character, ~ 16383 characters.
+  extra_file_modification_info TEXT DEFAULT NULL,
+
+  -- ========== CREATOR DETAILS AND PREFERENCES ==========
+
+  -- Foreign key to user
+  maybe_creator_user_token VARCHAR(32) DEFAULT NULL,
+
+  -- Based on a cookie sent by the frontend.
+  -- We'll save this even if the user is logged in.
+  maybe_creator_anonymous_visitor_token VARCHAR(32) DEFAULT NULL,
+
+  -- For abuse tracking.
+  -- Wide enough for IPv4/6
+  creator_ip_address VARCHAR(40) NOT NULL,
+
+  -- The creator can set a desired visibility for their data.
+  -- This does not always apply to every upload type.
+  -- Additionally, some upload types may require moderator approval prior
+  -- to being publicly listed, and this field has no bearing on that.
+  -- NB: DO NOT CHANGE THE ORDER OF THE ENUM VALUES DURING SCHEMA MIGRATIONS.
+  creator_set_visibility ENUM(
+    'public',
+    'hidden',
+    'private'
+    ) NOT NULL DEFAULT 'public',
+
+  -- The synthetic id associated with this result.
+  -- These ids are incremented on a per-user basis to help users
+  -- sequence their own work. They serve no other purpose.
+  maybe_creator_synthetic_id BIGINT(20) DEFAULT NULL,
+
+  -- ========== MODERATION DETAILS ==========
+
+  -- The last moderator that made changes last.
+  -- We should also build an audit table to supersede this.
+  maybe_mod_user_token VARCHAR(32) DEFAULT NULL,
+
+  -- ========== TIMESTAMPS ==========
+
+  created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
+
+  -- If this is removed by a mod or the creator.
+  user_deleted_at TIMESTAMP NULL,
+  mod_deleted_at TIMESTAMP NULL,
+
+  -- INDICES --
+  PRIMARY KEY (id),
+  UNIQUE KEY (token),
+  UNIQUE KEY (uuid_idempotency_token),
+  KEY index_media_type (media_type),
+  KEY index_checksum_sha2 (checksum_sha2),
+  KEY fk_maybe_creator_user_token (maybe_creator_user_token),
+  KEY fk_maybe_mod_user_token (maybe_mod_user_token),
+  KEY index_creator_ip_address (creator_ip_address),
+  KEY index_user_deleted_at (user_deleted_at),
+  KEY index_mod_deleted_at (mod_deleted_at)
+
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin;

_migrations/2022-12-15-060830_audit_logs/down.sql

@@ -0,0 +1,5 @@
+-- noinspection SqlDialectInspectionForFile
+-- noinspection SqlNoDataSourceInspectionForFile
+-- noinspection SqlResolveForFile
+
+drop table audit_logs;

_migrations/2022-12-15-060830_audit_logs/up.sql

@@ -0,0 +1,48 @@
+-- noinspection SqlDialectInspectionForFile
+-- noinspection SqlNoDataSourceInspectionForFile
+-- noinspection SqlResolveForFile
+
+CREATE TABLE audit_logs (
+
+  -- Not used for anything except replication.
+  id BIGINT(20) NOT NULL AUTO_INCREMENT,
+
+  -- Effective "primary key" of the audit log item (in case we add a UI or notes)
+  token VARCHAR(32) NOT NULL,
+
+  -- The type of entity mutated
+  entity_type VARCHAR(32) NOT NULL,
+
+  -- The token of the entity mutated
+  entity_token VARCHAR(32) NOT NULL,
+
+  -- The type of action taken on the entity
+  entity_action VARCHAR(32) NOT NULL,
+
+  -- Typically only signed in users will be performing actions on known entities,
+  -- but we're leaving this null just in case. This is the corresponding user that
+  -- made the change.
+  maybe_actor_user_token VARCHAR(32) DEFAULT NULL,
+
+  -- Based on a cookie sent by the frontend.
+  -- We'll save this even if the user is logged in.
+  maybe_actor_anonymous_visitor_token VARCHAR(32) DEFAULT NULL,
+
+  -- Whether the actor has some sort of moderator privilege.
+  is_actor_moderator BOOLEAN NOT NULL DEFAULT FALSE,
+
+  -- For abuse tracking.
+  -- Wide enough for IPv4/6
+  actor_ip_address VARCHAR(40) NOT NULL,
+
+  created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
+
+  -- INDICES --
+  PRIMARY KEY (id),
+  UNIQUE KEY (token),
+  KEY fk_entity_type (entity_type),
+  KEY fk_entity_token (entity_token),
+  KEY fk_maybe_actor_user_token (maybe_actor_user_token)
+
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin;