mattermost-mobile-upstream/app/database/migration/server/index.ts
Guillermo Vayá 354e956f43 feat(drafts): Phase 1 synchronized-drafts storage foundation
Adds the durable storage foundation for synchronized drafts (mobile-only,
no network behavior yet):

- Fix draft batch dedup in handleDraft to key by the composite
  (channel_id, root_id) instead of channel_id alone, so a channel draft
  and its thread reply drafts in the same batch no longer collapse.
- Add Draft columns: server_update_at (nullable ancestry hint, not a
  revision), props (JSON), file_ids (JSON portable server attachment IDs).
- Add the DraftOutbox table (one durable pending op per draft key) with
  operation/status const objects, generation, keep_local, retry fields,
  and a deleted_fingerprint column for delete-vs-newer-write disambiguation.
- Add buildDraftOutboxId, the serialized mutateDraftAndOutbox writer
  primitive (enters database.write before querying both tables, commits one
  batch), and deterministic repairDuplicateDrafts.
- Bump server schema 20 -> 21 with addColumns + createTable migration;
  register schema/model in the database managers, mocks, types, and docs.

Tests: composite-key survival, concurrent-mutation serialization, batch
failure atomicity, duplicate repair winner, model round-trip / migration
compatibility, and migration definition.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-23 16:18:48 +02:00

465 lines
17 KiB
TypeScript

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
// NOTE : To implement migration, please follow this document
// https://nozbe.github.io/WatermelonDB/Advanced/Migrations.html
import {BOARDS_TABLES} from '@boards/constants/database';
import {addColumns, createTable, schemaMigrations, unsafeExecuteSql} from '@nozbe/watermelondb/Schema/migrations';
import {AGENTS_TABLES} from '@agents/constants/database';
import {MM_TABLES} from '@constants/database';
import {PLAYBOOK_TABLES} from '@playbooks/constants/database';
const {
CHANNEL,
CHANNEL_BOOKMARK,
CHANNEL_INFO,
CUSTOM_PROFILE_ATTRIBUTE,
CUSTOM_PROFILE_FIELD,
DRAFT,
DRAFT_OUTBOX,
FILE,
MY_CHANNEL,
POST,
PROPERTY_FIELD,
PROPERTY_VALUE,
SCHEDULED_POST,
} = MM_TABLES.SERVER;
const {PLAYBOOK_RUN, PLAYBOOK_CHECKLIST, PLAYBOOK_CHECKLIST_ITEM, PLAYBOOK_RUN_ATTRIBUTE, PLAYBOOK_RUN_ATTRIBUTE_VALUE} = PLAYBOOK_TABLES;
const {AI_BOT, AI_THREAD} = AGENTS_TABLES;
const {BOARD_VIEW} = BOARDS_TABLES;
export default schemaMigrations({migrations: [
{
toVersion: 21,
steps: [
addColumns({
table: DRAFT,
columns: [
{name: 'server_update_at', type: 'number', isOptional: true},
{name: 'props', type: 'string', isOptional: true},
{name: 'file_ids', type: 'string', isOptional: true},
],
}),
createTable({
name: DRAFT_OUTBOX,
columns: [
{name: 'channel_id', type: 'string', isIndexed: true},
{name: 'root_id', type: 'string', isIndexed: true},
{name: 'team_id', type: 'string', isIndexed: true},
{name: 'operation', type: 'string'},
{name: 'generation', type: 'number'},
{name: 'keep_local', type: 'boolean'},
{name: 'attempt_count', type: 'number'},
{name: 'next_attempt_at', type: 'number'},
{name: 'status', type: 'string'},
{name: 'last_error_code', type: 'string', isOptional: true},
{name: 'deleted_fingerprint', type: 'string', isOptional: true},
],
}),
],
},
{
toVersion: 20,
steps: [
createTable({
name: BOARD_VIEW,
columns: [
{name: 'channel_id', type: 'string', isIndexed: true},
{name: 'type', type: 'string'},
{name: 'creator_id', type: 'string'},
{name: 'title', type: 'string'},
{name: 'description', type: 'string', isOptional: true},
{name: 'sort_order', type: 'number'},
{name: 'props', type: 'string', isOptional: true},
{name: 'create_at', type: 'number'},
{name: 'update_at', type: 'number', isIndexed: true},
{name: 'delete_at', type: 'number'},
],
}),
createTable({
name: PROPERTY_FIELD,
columns: [
{name: 'group_id', type: 'string'},
{name: 'name', type: 'string'},
{name: 'type', type: 'string'},
{name: 'attrs', type: 'string', isOptional: true},
{name: 'object_type', type: 'string'},
{name: 'target_id', type: 'string', isIndexed: true},
{name: 'target_type', type: 'string'},
{name: 'protected', type: 'boolean'},
{name: 'permission_field', type: 'string', isOptional: true},
{name: 'permission_values', type: 'string', isOptional: true},
{name: 'permission_options', type: 'string', isOptional: true},
{name: 'create_at', type: 'number'},
{name: 'update_at', type: 'number', isIndexed: true},
{name: 'delete_at', type: 'number'},
{name: 'created_by', type: 'string'},
{name: 'updated_by', type: 'string'},
],
}),
createTable({
name: PROPERTY_VALUE,
columns: [
{name: 'field_id', type: 'string', isIndexed: true},
{name: 'target_id', type: 'string', isIndexed: true},
{name: 'target_type', type: 'string'},
{name: 'group_id', type: 'string'},
{name: 'value', type: 'string'},
{name: 'create_at', type: 'number'},
{name: 'update_at', type: 'number'},
{name: 'delete_at', type: 'number'},
{name: 'created_by', type: 'string'},
{name: 'updated_by', type: 'string'},
],
}),
],
},
{
toVersion: 19,
steps: [
createTable({
name: AI_BOT,
columns: [
{name: 'display_name', type: 'string'},
{name: 'username', type: 'string'},
{name: 'last_icon_update', type: 'number'},
{name: 'dm_channel_id', type: 'string', isIndexed: true},
{name: 'channel_access_level', type: 'number'},
{name: 'channel_ids', type: 'string'},
{name: 'user_access_level', type: 'number'},
{name: 'user_ids', type: 'string'},
{name: 'team_ids', type: 'string'},
],
}),
createTable({
name: AI_THREAD,
columns: [
{name: 'message', type: 'string'},
{name: 'title', type: 'string'},
{name: 'channel_id', type: 'string', isIndexed: true},
{name: 'reply_count', type: 'number'},
{name: 'update_at', type: 'number', isIndexed: true},
],
}),
],
},
{
toVersion: 18,
steps: [
addColumns({
table: MY_CHANNEL,
columns: [
{name: 'autotranslation_disabled', type: 'boolean'},
],
}),
addColumns({
table: CHANNEL,
columns: [
{name: 'autotranslation', type: 'boolean'},
],
}),
],
},
{
toVersion: 17,
steps: [
addColumns({
table: PLAYBOOK_RUN_ATTRIBUTE_VALUE,
columns: [
{name: 'update_at', type: 'number'},
],
}),
],
},
{
toVersion: 16,
steps: [
addColumns({
table: SCHEDULED_POST,
columns: [
{name: 'type', type: 'string', isOptional: true},
],
}),
addColumns({
table: DRAFT,
columns: [
{name: 'type', type: 'string', isOptional: true},
],
}),
],
},
{
toVersion: 15,
steps: [
addColumns({
table: PLAYBOOK_RUN,
columns: [
{name: 'type', type: 'string'},
],
}),
],
},
{
toVersion: 14,
steps: [
createTable({
name: PLAYBOOK_RUN_ATTRIBUTE,
columns: [
{name: 'group_id', type: 'string'},
{name: 'name', type: 'string'},
{name: 'type', type: 'string'},
{name: 'target_id', type: 'string'},
{name: 'target_type', type: 'string'},
{name: 'create_at', type: 'number'},
{name: 'update_at', type: 'number'},
{name: 'delete_at', type: 'number'},
{name: 'attrs', type: 'string', isOptional: true},
],
}),
createTable({
name: PLAYBOOK_RUN_ATTRIBUTE_VALUE,
columns: [
{name: 'attribute_id', type: 'string', isIndexed: true},
{name: 'run_id', type: 'string', isIndexed: true},
{name: 'value', type: 'string'},
],
}),
],
},
{
toVersion: 13,
steps: [
addColumns({
table: PLAYBOOK_CHECKLIST_ITEM,
columns: [
{name: 'condition_action', type: 'string'},
{name: 'condition_reason', type: 'string'},
],
}),
],
},
{
toVersion: 12,
steps: [
createTable({
name: PLAYBOOK_RUN,
columns: [
{name: 'playbook_id', type: 'string'},
{name: 'name', type: 'string'},
{name: 'description', type: 'string'},
{name: 'is_active', type: 'boolean', isIndexed: true},
{name: 'owner_user_id', type: 'string'},
{name: 'team_id', type: 'string'},
{name: 'channel_id', type: 'string', isIndexed: true},
{name: 'post_id', type: 'string', isOptional: true},
{name: 'create_at', type: 'number'},
{name: 'end_at', type: 'number'},
{name: 'active_stage', type: 'number'},
{name: 'active_stage_title', type: 'string'},
{name: 'participant_ids', type: 'string'}, // JSON string
{name: 'summary', type: 'string'},
{name: 'current_status', type: 'string', isIndexed: true},
{name: 'last_status_update_at', type: 'number'},
{name: 'previous_reminder', type: 'number'},
{name: 'items_order', type: 'string'},
{name: 'retrospective_enabled', type: 'boolean'},
{name: 'retrospective', type: 'string'},
{name: 'retrospective_published_at', type: 'number'},
{name: 'update_at', type: 'number'},
{name: 'sync', type: 'string', isIndexed: true, isOptional: true},
{name: 'last_sync_at', type: 'number', isOptional: true},
],
}),
createTable({
name: PLAYBOOK_CHECKLIST,
columns: [
{name: 'run_id', type: 'string', isIndexed: true},
{name: 'items_order', type: 'string'},
{name: 'title', type: 'string'},
{name: 'update_at', type: 'number'},
{name: 'sync', type: 'string', isIndexed: true, isOptional: true},
{name: 'last_sync_at', type: 'number', isOptional: true},
],
}),
createTable({
name: PLAYBOOK_CHECKLIST_ITEM,
columns: [
{name: 'checklist_id', type: 'string', isIndexed: true},
{name: 'title', type: 'string'},
{name: 'state', type: 'string', isIndexed: true},
{name: 'state_modified', type: 'number'},
{name: 'assignee_id', type: 'string', isOptional: true},
{name: 'assignee_modified', type: 'number'},
{name: 'command', type: 'string', isOptional: true},
{name: 'command_last_run', type: 'number'},
{name: 'description', type: 'string'},
{name: 'due_date', type: 'number'},
{name: 'completed_at', type: 'number'},
{name: 'task_actions', type: 'string', isOptional: true}, // JSON string
{name: 'update_at', type: 'number'},
{name: 'sync', type: 'string', isIndexed: true, isOptional: true},
{name: 'last_sync_at', type: 'number', isOptional: true},
],
}),
addColumns({
table: MY_CHANNEL,
columns: [
{name: 'last_playbook_runs_fetch_at', type: 'number'},
],
}),
],
},
{
toVersion: 11,
steps: [
addColumns({
table: CHANNEL,
columns: [
{name: 'abac_policy_enforced', type: 'boolean', isOptional: true},
],
}),
],
},
{
toVersion: 10,
steps: [
addColumns({
table: FILE,
columns: [
{name: 'is_blocked', type: 'boolean'},
],
}),
],
},
{
toVersion: 9,
steps: [
createTable({
name: SCHEDULED_POST,
columns: [
{name: 'channel_id', type: 'string', isIndexed: true},
{name: 'message', type: 'string'},
{name: 'files', type: 'string'},
{name: 'root_id', type: 'string', isIndexed: true},
{name: 'metadata', type: 'string', isOptional: true},
{name: 'create_at', type: 'number'},
{name: 'update_at', type: 'number'},
{name: 'scheduled_at', type: 'number'},
{name: 'processed_at', type: 'number'},
{name: 'error_code', type: 'string'},
],
}),
],
},
{
toVersion: 8,
steps: [
createTable({
name: CUSTOM_PROFILE_ATTRIBUTE,
columns: [
{name: 'field_id', type: 'string', isIndexed: true},
{name: 'user_id', type: 'string', isIndexed: true},
{name: 'value', type: 'string'},
],
}),
createTable({
name: CUSTOM_PROFILE_FIELD,
columns: [
{name: 'group_id', type: 'string', isIndexed: true},
{name: 'name', type: 'string'},
{name: 'type', type: 'string'},
{name: 'target_id', type: 'string'},
{name: 'target_type', type: 'string'},
{name: 'create_at', type: 'number'},
{name: 'update_at', type: 'number'},
{name: 'delete_at', type: 'number', isOptional: true},
{name: 'attrs', type: 'string', isOptional: true},
],
}),
],
},
{
toVersion: 7,
steps: [
addColumns({
table: CHANNEL,
columns: [
{name: 'banner_info', type: 'string', isOptional: true},
],
}),
],
},
{
toVersion: 6,
steps: [
unsafeExecuteSql('CREATE INDEX IF NOT EXISTS Post_type ON Post (type);'),
],
},
{
toVersion: 5,
steps: [
addColumns({
table: DRAFT,
columns: [
{name: 'update_at', type: 'number'},
],
}),
],
},
{
toVersion: 4,
steps: [
createTable({
name: CHANNEL_BOOKMARK,
columns: [
{name: 'create_at', type: 'number'},
{name: 'update_at', type: 'number'},
{name: 'delete_at', type: 'number'},
{name: 'channel_id', type: 'string', isIndexed: true},
{name: 'owner_id', type: 'string'},
{name: 'file_id', type: 'string', isOptional: true},
{name: 'display_name', type: 'string'},
{name: 'sort_order', type: 'number'},
{name: 'link_url', type: 'string', isOptional: true},
{name: 'image_url', type: 'string', isOptional: true},
{name: 'emoji', type: 'string', isOptional: true},
{name: 'type', type: 'string'},
{name: 'original_id', type: 'string', isOptional: true},
{name: 'parent_id', type: 'string', isOptional: true},
],
}),
],
},
{
toVersion: 3,
steps: [
addColumns({
table: POST,
columns: [
{name: 'message_source', type: 'string'},
],
}),
],
},
{
toVersion: 2,
steps: [
addColumns({
table: CHANNEL_INFO,
columns: [
{name: 'files_count', type: 'number'},
],
}),
addColumns({
table: DRAFT,
columns: [
{name: 'metadata', type: 'string', isOptional: true},
],
}),
],
},
]});