v0.2.6-alpha.3

Swift: List rejections

rejections(includeDismissed:) reads the local journal a run writes when a write does not survive: the server refused it, an atomic batch it belonged to was aborted, or the retry budget dropped it. Each entry carries the row the server had at the time, so a screen can explain what happened and offer the user a choice.

Examples#

Basic#

// TodoApp/TodoListView.swift (excerpt)
import KizunaSync

let entries = try await kizunasync.rejections()
for entry in entries {
  print("\(entry.table)/\(entry.pk) \(entry.kind) \(entry.reason)")
}

Show the server's version of the row#

// TodoApp/TodoListView.swift (excerpt)
import Foundation
import KizunaSync

let entries = try await kizunasync.rejections()
guard let entry = entries.first, let data = entry.serverRowJson.data(using: .utf8) else { return }
let serverRow = try JSONSerialization.jsonObject(with: data) as? [String: Any]

Parameters#

Name	Type	Required	Description
`includeDismissed`	`Bool`	No	Whether entries already acknowledged with Dismiss a rejection are returned. Default: `false`.

Returns#

[KizunaSyncRejection], newest first, with these fields.

Name	Type	Required	Description
`mutationId`	`String`	—	Id of the write that failed, the same value passed to Insert data or generated for it.
`table`	`String`	—	Table the write targeted.
`pk`	`String`	—	Primary key the write targeted.
`kind`	`String`	—	`REJECTED` for an ordinary refusal, `SUPERSEDED` when a newer write won, `BATCH_ABORTED` for the offender of an atomic batch, and `DEAD_LETTER` for a write the retry budget dropped.
`reason`	`String`	—	`RLS_DENIED`, `COLUMN_DENIED`, `CONSTRAINT`, `PRECONDITION`, `DELETE_WINS`, or `SUPERSEDED` from the server, and `PERMANENT_TRANSPORT` on a dead letter, except a batch-too-large refusal (`KZP02`) of an atomic batch, whose reason is the server's own message.
`changedColumns`	`[String]`	—	The column names the refused write carried.
`serverRowJson`	`String`	—	The row as the server's own policies rendered it, encoded as JSON. Empty when the server sent none, for example because the row is hidden from this user.
`at`	`Int64`	—	When the entry was journalled, in milliseconds since the Unix epoch.
`dismissed`	`Bool`	—	Whether the entry has been acknowledged. Always `false` unless `includeDismissed` is `true`.

Errors#

Code	Condition
`STORE`, `JSON`	The journal could not be read or its stored columns could not be parsed.
`ENGINE_UNAVAILABLE`	The client has no engine because Initializing has not run.

Notes#

The engine reverts a refused write before it appears here. The local row already holds the server's version, so the journal is a record rather than a queue to drain. Re-journalling the same mutation id replaces the entry and clears its dismissal.

MUTATION_REJECTED on Subscribe to events fires as each entry lands, which is the cue to re-read this list. Validate writes shows the screen this list is meant for, and Supabase documents the policies behind a RLS_DENIED under Row Level Security.

← Set access token Dismiss a rejection →

Found a problem? Edit this page on GitHub