@rvoh/dream 2.31.0 → 2.32.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (226) hide show
  1. package/dist/cjs/src/Dream.js +9 -5
  2. package/dist/cjs/src/db/errors.js +2 -0
  3. package/dist/cjs/src/decorators/Decorators.js +45 -5
  4. package/dist/cjs/src/decorators/field/sortable/helpers/cascadeReachesEveryRowInSortScope.js +51 -0
  5. package/dist/cjs/src/decorators/field/sortable/helpers/performSortableDestroyWork.js +5 -2
  6. package/dist/cjs/src/decorators/field/sortable/helpers/prepareSortableFieldsForDestroy.js +39 -25
  7. package/dist/cjs/src/decorators/field/sortable/helpers/sortableCascadeEdge.js +32 -0
  8. package/dist/cjs/src/dream/QueryDriver/Base.js +26 -0
  9. package/dist/cjs/src/dream/QueryDriver/Postgres.js +7 -1
  10. package/dist/cjs/src/dream/internal/destroyAssociatedRecords.js +7 -0
  11. package/dist/cjs/src/dream/internal/destroyDream.js +25 -14
  12. package/dist/cjs/src/dream/internal/undestroyDream.js +55 -32
  13. package/dist/cjs/src/dream/internal/withConcurrentWriterRetry.js +64 -0
  14. package/dist/esm/src/Dream.js +9 -5
  15. package/dist/esm/src/db/errors.js +2 -0
  16. package/dist/esm/src/decorators/Decorators.js +45 -5
  17. package/dist/esm/src/decorators/field/sortable/helpers/cascadeReachesEveryRowInSortScope.js +51 -0
  18. package/dist/esm/src/decorators/field/sortable/helpers/performSortableDestroyWork.js +5 -2
  19. package/dist/esm/src/decorators/field/sortable/helpers/prepareSortableFieldsForDestroy.js +39 -25
  20. package/dist/esm/src/decorators/field/sortable/helpers/sortableCascadeEdge.js +32 -0
  21. package/dist/esm/src/dream/QueryDriver/Base.js +26 -0
  22. package/dist/esm/src/dream/QueryDriver/Postgres.js +7 -1
  23. package/dist/esm/src/dream/internal/destroyAssociatedRecords.js +7 -0
  24. package/dist/esm/src/dream/internal/destroyDream.js +25 -14
  25. package/dist/esm/src/dream/internal/undestroyDream.js +55 -32
  26. package/dist/esm/src/dream/internal/withConcurrentWriterRetry.js +64 -0
  27. package/dist/types/src/Dream.d.ts +9 -5
  28. package/dist/types/src/db/errors.d.ts +2 -0
  29. package/dist/types/src/decorators/Decorators.d.ts +45 -5
  30. package/dist/types/src/decorators/field/sortable/helpers/cascadeReachesEveryRowInSortScope.d.ts +39 -0
  31. package/dist/types/src/decorators/field/sortable/helpers/performSortableDestroyWork.d.ts +6 -1
  32. package/dist/types/src/decorators/field/sortable/helpers/prepareSortableFieldsForDestroy.d.ts +37 -20
  33. package/dist/types/src/decorators/field/sortable/helpers/sortableCascadeEdge.d.ts +20 -0
  34. package/dist/types/src/dream/QueryDriver/Base.d.ts +20 -0
  35. package/dist/types/src/dream/QueryDriver/Postgres.d.ts +2 -0
  36. package/dist/types/src/dream/internal/destroyDream.d.ts +3 -1
  37. package/dist/types/src/dream/internal/undestroyDream.d.ts +6 -4
  38. package/dist/types/src/dream/internal/withConcurrentWriterRetry.d.ts +47 -0
  39. package/docs/assets/hierarchy.js +1 -1
  40. package/docs/assets/search.js +1 -1
  41. package/docs/classes/db.DreamMigrationHelpers.html +11 -11
  42. package/docs/classes/db.KyselyQueryDriver.html +55 -43
  43. package/docs/classes/db.PostgresQueryDriver.html +56 -44
  44. package/docs/classes/db.QueryDriverBase.html +54 -42
  45. package/docs/classes/errors.CannotSaveMissingDream.html +2 -2
  46. package/docs/classes/errors.CheckConstraintViolation.html +3 -3
  47. package/docs/classes/errors.ColumnOverflow.html +3 -3
  48. package/docs/classes/errors.CreateOrFindByFailedToCreateAndFind.html +3 -3
  49. package/docs/classes/errors.DataIncompatibleWithDatabaseField.html +3 -3
  50. package/docs/classes/errors.DataTypeColumnTypeMismatch.html +3 -3
  51. package/docs/classes/errors.DecryptionError.html +2 -2
  52. package/docs/classes/errors.DecryptionParseError.html +2 -2
  53. package/docs/classes/errors.DecryptionRotationError.html +3 -3
  54. package/docs/classes/errors.GlobalNameNotSet.html +3 -3
  55. package/docs/classes/errors.InvalidCalendarDate.html +2 -2
  56. package/docs/classes/errors.InvalidClockTime.html +2 -2
  57. package/docs/classes/errors.InvalidClockTimeTz.html +2 -2
  58. package/docs/classes/errors.InvalidDateTime.html +2 -2
  59. package/docs/classes/errors.MissingSerializersDefinition.html +3 -3
  60. package/docs/classes/errors.NonLoadedAssociation.html +3 -3
  61. package/docs/classes/errors.NotNullViolation.html +3 -3
  62. package/docs/classes/errors.RecordNotFound.html +3 -3
  63. package/docs/classes/errors.SortableScopeDidNotStabilize.html +3 -3
  64. package/docs/classes/errors.SortableScopeLockWaitTimedOut.html +3 -3
  65. package/docs/classes/errors.ValidationError.html +3 -3
  66. package/docs/classes/index.CalendarDate.html +33 -33
  67. package/docs/classes/index.ClockTime.html +32 -32
  68. package/docs/classes/index.ClockTimeTz.html +35 -35
  69. package/docs/classes/index.DateTime.html +86 -86
  70. package/docs/classes/index.Decorators.html +62 -24
  71. package/docs/classes/index.Dream.html +133 -129
  72. package/docs/classes/index.DreamApp.html +10 -10
  73. package/docs/classes/index.DreamTransaction.html +2 -2
  74. package/docs/classes/index.Env.html +2 -2
  75. package/docs/classes/index.Query.html +65 -65
  76. package/docs/classes/system.CliFileWriter.html +4 -4
  77. package/docs/classes/system.DreamBin.html +2 -2
  78. package/docs/classes/system.DreamCLI.html +7 -7
  79. package/docs/classes/system.DreamImporter.html +2 -2
  80. package/docs/classes/system.DreamLogos.html +2 -2
  81. package/docs/classes/system.DreamSerializerBuilder.html +11 -11
  82. package/docs/classes/system.ObjectSerializerBuilder.html +8 -8
  83. package/docs/classes/system.PathHelpers.html +3 -3
  84. package/docs/classes/utils.Encrypt.html +3 -3
  85. package/docs/classes/utils.Range.html +2 -2
  86. package/docs/functions/db.closeAllDbConnections.html +1 -1
  87. package/docs/functions/db.dreamDbConnections.html +1 -1
  88. package/docs/functions/db.untypedDb.html +1 -1
  89. package/docs/functions/db.validateColumn.html +1 -1
  90. package/docs/functions/db.validateTable.html +1 -1
  91. package/docs/functions/errors.pgErrorType.html +1 -1
  92. package/docs/functions/index.DreamSerializer.html +1 -1
  93. package/docs/functions/index.ObjectSerializer.html +1 -1
  94. package/docs/functions/index.ReplicaSafe.html +1 -1
  95. package/docs/functions/index.STI.html +1 -1
  96. package/docs/functions/index.SoftDelete.html +1 -1
  97. package/docs/functions/utils.camelize.html +1 -1
  98. package/docs/functions/utils.capitalize.html +1 -1
  99. package/docs/functions/utils.cloneDeepSafe.html +1 -1
  100. package/docs/functions/utils.compact.html +1 -1
  101. package/docs/functions/utils.groupBy.html +1 -1
  102. package/docs/functions/utils.hyphenize.html +1 -1
  103. package/docs/functions/utils.intersection.html +1 -1
  104. package/docs/functions/utils.isEmpty.html +1 -1
  105. package/docs/functions/utils.normalizeUnicode.html +1 -1
  106. package/docs/functions/utils.pascalize.html +1 -1
  107. package/docs/functions/utils.percent.html +1 -1
  108. package/docs/functions/utils.range.html +1 -1
  109. package/docs/functions/utils.round.html +1 -1
  110. package/docs/functions/utils.sanitizeString.html +1 -1
  111. package/docs/functions/utils.snakeify.html +1 -1
  112. package/docs/functions/utils.sort.html +1 -1
  113. package/docs/functions/utils.sortBy.html +1 -1
  114. package/docs/functions/utils.sortObjectByKey.html +1 -1
  115. package/docs/functions/utils.sortObjectByValue.html +1 -1
  116. package/docs/functions/utils.uncapitalize.html +1 -1
  117. package/docs/functions/utils.uniq.html +1 -1
  118. package/docs/hierarchy.html +1 -1
  119. package/docs/interfaces/openapi.OpenapiDescription.html +2 -2
  120. package/docs/interfaces/openapi.OpenapiSchemaProperties.html +1 -1
  121. package/docs/interfaces/openapi.OpenapiSchemaPropertiesShorthand.html +1 -1
  122. package/docs/interfaces/openapi.OpenapiTypeFieldObject.html +1 -1
  123. package/docs/interfaces/types.BelongsToStatement.html +2 -2
  124. package/docs/interfaces/types.DecoratorContext.html +2 -2
  125. package/docs/interfaces/types.DreamAppInitOptions.html +2 -2
  126. package/docs/interfaces/types.DreamAppOpts.html +2 -2
  127. package/docs/interfaces/types.DreamDbConfig.html +5 -5
  128. package/docs/interfaces/types.DurationObject.html +2 -2
  129. package/docs/interfaces/types.EncryptOptions.html +2 -2
  130. package/docs/interfaces/types.InternalAnyTypedSerializerRendersMany.html +2 -2
  131. package/docs/interfaces/types.InternalAnyTypedSerializerRendersOne.html +2 -2
  132. package/docs/interfaces/types.SerializerRendererOpts.html +2 -2
  133. package/docs/types/openapi.CommonOpenapiSchemaObjectFields.html +1 -1
  134. package/docs/types/openapi.OpenapiAllTypes.html +1 -1
  135. package/docs/types/openapi.OpenapiFormats.html +1 -1
  136. package/docs/types/openapi.OpenapiNumberFormats.html +1 -1
  137. package/docs/types/openapi.OpenapiPrimitiveBaseTypes.html +1 -1
  138. package/docs/types/openapi.OpenapiPrimitiveTypes.html +1 -1
  139. package/docs/types/openapi.OpenapiSchemaArray.html +1 -1
  140. package/docs/types/openapi.OpenapiSchemaArrayShorthand.html +1 -1
  141. package/docs/types/openapi.OpenapiSchemaBase.html +1 -1
  142. package/docs/types/openapi.OpenapiSchemaBody.html +1 -1
  143. package/docs/types/openapi.OpenapiSchemaBodyShorthand.html +1 -1
  144. package/docs/types/openapi.OpenapiSchemaCommonFields.html +1 -1
  145. package/docs/types/openapi.OpenapiSchemaExpressionAllOf.html +2 -2
  146. package/docs/types/openapi.OpenapiSchemaExpressionAnyOf.html +2 -2
  147. package/docs/types/openapi.OpenapiSchemaExpressionOneOf.html +2 -2
  148. package/docs/types/openapi.OpenapiSchemaExpressionRef.html +2 -2
  149. package/docs/types/openapi.OpenapiSchemaExpressionRefSchemaShorthand.html +2 -2
  150. package/docs/types/openapi.OpenapiSchemaInteger.html +1 -1
  151. package/docs/types/openapi.OpenapiSchemaNull.html +2 -2
  152. package/docs/types/openapi.OpenapiSchemaNumber.html +1 -1
  153. package/docs/types/openapi.OpenapiSchemaObject.html +1 -1
  154. package/docs/types/openapi.OpenapiSchemaObjectAllOf.html +1 -1
  155. package/docs/types/openapi.OpenapiSchemaObjectAllOfShorthand.html +1 -1
  156. package/docs/types/openapi.OpenapiSchemaObjectAnyOf.html +1 -1
  157. package/docs/types/openapi.OpenapiSchemaObjectAnyOfShorthand.html +1 -1
  158. package/docs/types/openapi.OpenapiSchemaObjectBase.html +1 -1
  159. package/docs/types/openapi.OpenapiSchemaObjectBaseShorthand.html +1 -1
  160. package/docs/types/openapi.OpenapiSchemaObjectOneOf.html +1 -1
  161. package/docs/types/openapi.OpenapiSchemaObjectOneOfShorthand.html +1 -1
  162. package/docs/types/openapi.OpenapiSchemaObjectShorthand.html +1 -1
  163. package/docs/types/openapi.OpenapiSchemaPrimitiveGeneric.html +1 -1
  164. package/docs/types/openapi.OpenapiSchemaShorthandExpressionAllOf.html +2 -2
  165. package/docs/types/openapi.OpenapiSchemaShorthandExpressionAnyOf.html +2 -2
  166. package/docs/types/openapi.OpenapiSchemaShorthandExpressionOneOf.html +2 -2
  167. package/docs/types/openapi.OpenapiSchemaShorthandExpressionSerializableRef.html +2 -2
  168. package/docs/types/openapi.OpenapiSchemaShorthandExpressionSerializerRef.html +2 -2
  169. package/docs/types/openapi.OpenapiSchemaShorthandPrimitiveGeneric.html +1 -1
  170. package/docs/types/openapi.OpenapiSchemaString.html +1 -1
  171. package/docs/types/openapi.OpenapiShorthandAllTypes.html +1 -1
  172. package/docs/types/openapi.OpenapiShorthandPrimitiveBaseTypes.html +1 -1
  173. package/docs/types/openapi.OpenapiShorthandPrimitiveTypes.html +1 -1
  174. package/docs/types/openapi.OpenapiTypeField.html +1 -1
  175. package/docs/types/system.DreamAppAllowedPackageManagersEnum.html +1 -1
  176. package/docs/types/types.CalendarDateDurationUnit.html +1 -1
  177. package/docs/types/types.CalendarDateObject.html +1 -1
  178. package/docs/types/types.Camelized.html +1 -1
  179. package/docs/types/types.ClockTimeObject.html +1 -1
  180. package/docs/types/types.DbConnectionType.html +1 -1
  181. package/docs/types/types.DbTypes.html +1 -1
  182. package/docs/types/types.DreamAssociationMetadata.html +1 -1
  183. package/docs/types/types.DreamAttributes.html +1 -1
  184. package/docs/types/types.DreamClassAssociationAndStatement.html +1 -1
  185. package/docs/types/types.DreamClassColumn.html +1 -1
  186. package/docs/types/types.DreamColumn.html +1 -1
  187. package/docs/types/types.DreamColumnNames.html +1 -1
  188. package/docs/types/types.DreamLogLevel.html +1 -1
  189. package/docs/types/types.DreamLogger.html +2 -2
  190. package/docs/types/types.DreamModelSerializerType.html +1 -1
  191. package/docs/types/types.DreamOrViewModelClassSerializerKey.html +1 -1
  192. package/docs/types/types.DreamOrViewModelSerializerKey.html +1 -1
  193. package/docs/types/types.DreamParamSafeAttributes.html +1 -1
  194. package/docs/types/types.DreamParamSafeColumnNames.html +1 -1
  195. package/docs/types/types.DreamSerializable.html +1 -1
  196. package/docs/types/types.DreamSerializableArray.html +1 -1
  197. package/docs/types/types.DreamSerializerKey.html +1 -1
  198. package/docs/types/types.DreamSerializers.html +1 -1
  199. package/docs/types/types.DreamVirtualColumns.html +1 -1
  200. package/docs/types/types.DurationUnit.html +1 -1
  201. package/docs/types/types.EncryptAlgorithm.html +1 -1
  202. package/docs/types/types.HasManyStatement.html +1 -1
  203. package/docs/types/types.HasOneStatement.html +1 -1
  204. package/docs/types/types.Hyphenized.html +1 -1
  205. package/docs/types/types.Pascalized.html +1 -1
  206. package/docs/types/types.PrimaryKeyType.html +1 -1
  207. package/docs/types/types.RoundingPrecision.html +1 -1
  208. package/docs/types/types.SerializerCasing.html +1 -1
  209. package/docs/types/types.SimpleObjectSerializerType.html +1 -1
  210. package/docs/types/types.Snakeified.html +1 -1
  211. package/docs/types/types.StrictInterface.html +1 -1
  212. package/docs/types/types.UpdateableAssociationProperties.html +1 -1
  213. package/docs/types/types.UpdateableProperties.html +1 -1
  214. package/docs/types/types.ValidationType.html +1 -1
  215. package/docs/types/types.ViewModel.html +2 -2
  216. package/docs/types/types.ViewModelClass.html +1 -1
  217. package/docs/types/types.WeekdayName.html +1 -1
  218. package/docs/types/types.WhereStatementForDream.html +1 -1
  219. package/docs/types/types.WhereStatementForDreamClass.html +1 -1
  220. package/docs/variables/index.DreamConst.html +1 -1
  221. package/docs/variables/index.ops.html +1 -1
  222. package/docs/variables/openapi.openapiPrimitiveTypes.html +1 -1
  223. package/docs/variables/openapi.openapiShorthandPrimitiveTypes.html +1 -1
  224. package/docs/variables/system.DreamAppAllowedPackageManagersEnumValues.html +1 -1
  225. package/docs/variables/system.primaryKeyTypes.html +1 -1
  226. package/package.json +2 -2
@@ -1837,16 +1837,20 @@ export default class Dream {
1837
1837
  * with no gaps, accounting for the scopes specified in the
1838
1838
  * corresponding Sortable decorator.
1839
1839
  *
1840
- * Each sort scope is renumbered in its own transaction, under the same
1841
- * advisory lock every other position-mutating path takes on that scope, from
1842
- * a read of the scope taken inside that lock — so a concurrent create or
1843
- * destroy cannot make the renumbering land on positions it never read.
1840
+ * Each sort scope is renumbered in its own transaction, under the advisory
1841
+ * lock every direct position-mutating path takes on that scope, from a read
1842
+ * of the scope taken inside that lock — so a concurrent create or direct
1843
+ * destroy cannot make the renumbering land on positions it never read. A
1844
+ * cascaded destroy or undestroy takes no scope lock (see `@deco.Sortable`),
1845
+ * so one running at the same moment can still change a scope under `resort`;
1846
+ * a later `resort` repairs whatever that leaves.
1844
1847
  *
1845
1848
  * **Do not call `resort` from inside a transaction you own.** It opens those
1846
1849
  * transactions itself, on connections of its own, so it can neither join
1847
1850
  * yours nor roll back with it: its writes commit on their own. Worse, if your
1848
1851
  * transaction already holds the scope lock for a scope being renumbered — any
1849
- * position-mutating write to that scope earlier in the transaction takes it —
1852
+ * direct position-mutating write to that scope earlier in the transaction
1853
+ * takes it; a cascaded destroy or undestroy takes none —
1850
1854
  * `resort` waits on that lock from the outside, where no deadlock detector
1851
1855
  * can see the cycle, until the wait bound expires and it throws
1852
1856
  * `SortableScopeLockWaitTimedOut`.
@@ -8,6 +8,7 @@
8
8
  // @ts-ignore
9
9
  import pg from 'pg';
10
10
  export const CHECK_VIOLATION = 'CHECK_VIOLATION';
11
+ export const DEADLOCK_DETECTED = 'DEADLOCK_DETECTED';
11
12
  export const FOREIGN_KEY_VIOLATION = 'FOREIGN_KEY_VIOLATION';
12
13
  export const INTEGRITY_CONSTRAINT_VIOLATION = 'INTEGRITY_CONSTRAINT_VIOLATION';
13
14
  export const INVALID_INPUT_SYNTAX = 'INVALID_INPUT_SYNTAX';
@@ -30,6 +31,7 @@ export const PG_ERRORS = {
30
31
  // a statement Postgres cancelled because its `lock_timeout` elapsed while it
31
32
  // waited for a lock — the bound Dream puts on the sortable scope-lock wait
32
33
  '55P03': LOCK_NOT_AVAILABLE,
34
+ '40P01': DEADLOCK_DETECTED,
33
35
  };
34
36
  function pgErrorFromCode(code) {
35
37
  return PG_ERRORS[code] || null;
@@ -149,7 +149,10 @@ export default class Decorators {
149
149
  /**
150
150
  * Marks an integer column as a sortable position: Dream keeps the positions of
151
151
  * every record in a sort scope contiguous, starting at 1, as records are
152
- * created, moved, destroyed and undestroyed.
152
+ * created, moved, destroyed and undestroyed. A concurrent write racing a
153
+ * cascaded destroy or undestroy, under **Cascaded destroy and undestroy**
154
+ * below, is the one thing that can leave a scope with a gap;
155
+ * `Model.resort('position')` closes it.
153
156
  *
154
157
  * ```ts
155
158
  * class Post extends ApplicationModel {
@@ -176,8 +179,9 @@ export default class Decorators {
176
179
  * then `await post.update({ position: 1 })`.
177
180
  *
178
181
  * Sortable requires a query driver that supports advisory transaction locks —
179
- * the `PostgresQueryDriver` does — since every position write serializes the
180
- * writers of its sort scope on one. This concurrency guarantee first shipped
182
+ * the `PostgresQueryDriver` does — since a position write serializes the
183
+ * writers of its sort scope on one, apart from the cascades described below.
184
+ * This concurrency guarantee first shipped
181
185
  * in Dream 2.28.0 and begins only after every writer is running a lock-aware
182
186
  * release. During the first rolling deployment, older processes take no
183
187
  * advisory locks and can still race the upgraded processes.
@@ -185,8 +189,10 @@ export default class Decorators {
185
189
  * All participating Dream writers of one hot scope serialize. Ordinary saves
186
190
  * and destroys with `skipHooks`, direct query writes, raw SQL, and older
187
191
  * pre-lock Dream processes bypass Sortable maintenance and do not participate
188
- * in its locking protocol. Undestroy still performs stabilized Sortable
189
- * maintenance and acquires scope locks with `skipHooks: true`; locked query
192
+ * in its locking protocol; a cascaded destroy or undestroy performs its
193
+ * maintenance but does not participate either. A direct undestroy still
194
+ * performs stabilized Sortable maintenance and acquires scope locks with
195
+ * `skipHooks: true`; locked query
190
196
  * batches likewise acquire their scope locks during preflight, before any
191
197
  * per-record callbacks, even when those callbacks skip hooks. A waiter that
192
198
  * enters the protocol holds a pooled connection until the holder finishes or
@@ -195,6 +201,40 @@ export default class Decorators {
195
201
  * inside the lock window short, and avoid cross-region database latency for
196
202
  * hot scopes.
197
203
  *
204
+ * **Cascaded destroy and undestroy take no scope lock.** A record destroyed or
205
+ * undestroyed because its owner was — reached through a `dependent: 'destroy'`
206
+ * association, or through the undestroy that restores one — does its position
207
+ * work without the advisory lock, so a cascade holds no lock per sort scope it
208
+ * touches, however many scopes that is. Calling `destroy()` or `undestroy()`
209
+ * on a record yourself is unchanged. Where the cascade is destroying the owner
210
+ * of a sort scope — a `HasMany` whose foreign key is one of the field's scope
211
+ * columns, with no condition and not `through`, not polymorphic, whose target
212
+ * is not an STI child and declares no default scope other than
213
+ * `@deco.SoftDelete` — every row of that scope goes with it, and the cascade
214
+ * neither reads nor compacts it. Any other cascaded destroy compacts the
215
+ * scope it vacates, and every cascaded undestroy appends at the end of its
216
+ * scope, exactly as the direct operations do, only without the lock.
217
+ *
218
+ * Without the lock, a writer of the same sort scope during the cascade — a
219
+ * create, a move, a destroy, a `resort` — is not kept out, which costs one of
220
+ * two things. A gap: positions stay unique and correctly ordered, and
221
+ * `Model.resort('position')` closes it. Or two live rows sharing a position,
222
+ * which the deferrable unique constraint refuses when the later of the two
223
+ * transactions reaches COMMIT — as a unique violation, or as a deadlock when
224
+ * both reach it together — so nothing half-done commits and no commit hook
225
+ * runs. A `destroy()` or `undestroy()` whose transaction Dream opened runs the
226
+ * whole operation again on such a refusal, up to three times, before letting
227
+ * the adapter's error escape. Inside a transaction you opened, that error is
228
+ * your COMMIT failing: retry the transaction from the beginning, as for a
229
+ * deadlock. The other writer can lose the same race and fail at its own
230
+ * COMMIT instead, an ordinary `create` or `update` included, and Dream does
231
+ * not run those again: a bounded, occasional failed request in one contended
232
+ * scope is the deliberate price of cascades that hold no locks, where the
233
+ * lock count would otherwise be set by the data. A sort scope with a
234
+ * nullable column has no such backstop unless its constraint is declared
235
+ * `NULLS NOT DISTINCT`, since a plain unique constraint never sees two NULLs
236
+ * as equal.
237
+ *
198
238
  * `SortableScopeDidNotStabilize` and `SortableScopeLockWaitTimedOut` are the
199
239
  * expected Dream errors an application may choose to retry. Database deadlocks
200
240
  * remain native adapter errors (for example PostgreSQL code `40P01` or MySQL
@@ -0,0 +1,51 @@
1
+ import { SOFT_DELETE_SCOPE_NAME } from '../../../class/SoftDelete.js';
2
+ import sortableScopeColumns from './sortableScopeColumns.js';
3
+ /**
4
+ * @internal
5
+ *
6
+ * Whether a cascade reaching this record through `edge` reaches, and so
7
+ * destroys, every live row of the sortable field's sort scope. Such a scope is
8
+ * left with no survivor, so
9
+ * the compaction a destroy performs would close a vacancy nothing can observe,
10
+ * and the cascade skips it along with the snapshot read it needs. Every clause
11
+ * fails closed: a shape not positively recognized here compacts as a direct
12
+ * destroy does, unlocked, which costs statements and never a lock.
13
+ *
14
+ * The edge is the `dependent: 'destroy'` association the cascade destroyed
15
+ * through, the only kind the caller passes, and the answer is about that edge
16
+ * alone: another dependent edge of the same owner may reach the rows this one
17
+ * does not, and this fails closed rather than look for it.
18
+ *
19
+ * 1. The edge is a `HasMany`. A `HasOne` reaches one row of a scope that may
20
+ * hold others.
21
+ * 2. The edge is not polymorphic, is not a `through` association, and carries
22
+ * no `and`, `andNot`, `andAny`, `selfAnd` or `selfAndNot`. Each of those
23
+ * reaches a subset of the rows sharing the foreign key, and the rest can
24
+ * stay live: a soft-deleted owner's row remains, so no foreign key forces
25
+ * them out, and they keep their positions in a scope the cascade did not
26
+ * empty. (A hard destroy under a database foreign key would have refused to
27
+ * leave them, and compacting there is the harmless direction to be wrong in.)
28
+ * 3. The target is not an STI child, whose rows share a sort scope with its
29
+ * siblings' rows.
30
+ * 4. The target declares no default scope other than SoftDelete, since any
31
+ * other hides rows from the cascade's own load. A soft-deleted row holds no
32
+ * position and so is in no sort scope to begin with.
33
+ * 5. The edge's foreign key is one of the field's scope columns: every row the
34
+ * cascade destroys carries the owner's key, and so does every row of any sort
35
+ * scope that includes that column. Further scope members only partition that
36
+ * same set.
37
+ */
38
+ export default function cascadeReachesEveryRowInSortScope(dream, config, edge) {
39
+ if (edge.type !== 'HasMany')
40
+ return false;
41
+ if (edge.polymorphic || edge.through)
42
+ return false;
43
+ if (edge.and || edge.andNot || edge.andAny || edge.selfAnd || edge.selfAndNot)
44
+ return false;
45
+ const dreamClass = dream.constructor;
46
+ if (dreamClass['isSTIChild'])
47
+ return false;
48
+ if (!dreamClass['scopes'].default.every(scope => scope.method === SOFT_DELETE_SCOPE_NAME))
49
+ return false;
50
+ return sortableScopeColumns(dream, config.scope).includes(edge.foreignKey());
51
+ }
@@ -10,10 +10,13 @@ import afterSortableDestroy from '../hooks/afterSortableDestroy.js';
10
10
  * `afterDestroy` hook — never registered as a hook among them — so every
11
11
  * after-destroy hook observes the compacted scope regardless of where it was
12
12
  * declared, exactly as every after-save hook observes the computed position.
13
+ *
14
+ * @param sortableFields - the fields the preparation phase read a snapshot for,
15
+ * which on a cascaded destroy excludes every field whose whole sort scope the
16
+ * cascade is destroying
13
17
  */
14
- export default async function performSortableDestroyWork(dream, txn) {
18
+ export default async function performSortableDestroyWork(dream, txn, sortableFields) {
15
19
  const dreamClass = dream.constructor;
16
- const sortableFields = dreamClass['sortableFields'];
17
20
  for (const { positionField, scope } of sortableFields) {
18
21
  const query = dreamClass.query().removeDefaultScope(STI_SCOPE_NAME).txn(txn);
19
22
  await afterSortableDestroy({ dream, positionField, query, scope, txn });
@@ -1,40 +1,54 @@
1
1
  import acquireStabilizedSortableScopeLocks from './acquireStabilizedSortableScopeLocks.js';
2
+ import cascadeReachesEveryRowInSortScope from './cascadeReachesEveryRowInSortScope.js';
2
3
  import clearCachedSortableValues from './clearCachedSortableValues.js';
3
- import { cacheSortableSnapshots, clearSortableSnapshot } from './sortableSnapshot.js';
4
+ import { cacheSortableSnapshots, clearSortableSnapshot, readSortableSnapshots } from './sortableSnapshot.js';
4
5
  /**
5
6
  * @internal
6
7
  *
7
8
  * The sortable preparation phase of a destroy. Called from `destroyDream` after
8
9
  * every user `beforeDestroy` hook has run and before the delete — a phase, not
9
- * a hook among them — so the operation's whole advisory key set, across every
10
- * sortable field, is taken in one sorted stabilized acquisition, with one
11
- * snapshot SELECT covering all fields. Per-field acquisition would take
12
- * multi-field keys in declaration order, which deadlocks against the paths
13
- * that acquire sorted.
10
+ * a hook among them — so the row's real position and scope values are read in
11
+ * one snapshot SELECT covering every field while the row still exists.
12
+ * Pre-delete is the only seat for that read: on a hard destroy the row is gone
13
+ * afterwards, and a soft destroy nulls the position columns in the same UPDATE
14
+ * as `deletedAt`. The per-field compactions (`performSortableDestroyWork`)
15
+ * consume the cached snapshots.
14
16
  *
15
- * Pre-delete is the only seat available for the snapshot read: on a hard
16
- * destroy the row is gone afterwards, and a soft destroy nulls the position
17
- * columns in the same UPDATE as `deletedAt`. The lock is taken around the read
18
- * so the snapshot cannot be invalidated between the read and the compaction;
19
- * it is transaction-scoped, and `destroyDream` opens a transaction that spans
20
- * the delete and the after-destroy hooks, so one acquisition covers both.
17
+ * A direct destroy takes the operation's whole advisory key set — every
18
+ * sortable field — in one sorted stabilized acquisition around that read, so
19
+ * the snapshot cannot be invalidated before the compaction; per-field
20
+ * acquisition would take multi-field keys in declaration order and deadlock
21
+ * against the paths that acquire sorted. The lock is transaction-scoped, and
22
+ * `destroyDream` opens a transaction spanning the delete and the after-destroy
23
+ * hooks, so one acquisition covers both.
21
24
  *
22
- * The per-field compactions (`performSortableDestroyWork`) consume the cached
23
- * snapshots.
24
- *
25
- * @returns false when the snapshot read found no row — this destroy has nothing
26
- * to vacate, and compacting from the instance's remembered position would
27
- * shift a scope some other writer has already closed. The delete's own
28
- * affected-row count is the stronger signal (a writer outside the sortable
29
- * path can remove the row after this read), so the caller checks both.
25
+ * A cascaded destroy — one reached through a `dependent: 'destroy'` association,
26
+ * which passes the edge it arrived by — takes no scope lock: a cascade would
27
+ * otherwise hold one per distinct sort scope it touches until the root
28
+ * transaction commits. It reads the same snapshot unlocked and compacts from
29
+ * it, and skips both for a field whose whole sort scope the cascade is
30
+ * destroying, since nothing survives there to observe a compaction.
30
31
  */
31
- export default async function prepareSortableFieldsForDestroy(dream, txn) {
32
- const sortableFields = dream.constructor['sortableFields'];
32
+ export default async function prepareSortableFieldsForDestroy(dream, txn, cascadeEdge) {
33
+ const allSortableFields = dream.constructor['sortableFields'];
34
+ const sortableFields = cascadeEdge
35
+ ? allSortableFields.filter(config => !cascadeReachesEveryRowInSortScope(dream, config, cascadeEdge))
36
+ : allSortableFields;
33
37
  if (!sortableFields.length)
34
- return true;
35
- const { rowExists, snapshots } = await acquireStabilizedSortableScopeLocks(dream, txn, sortableFields);
38
+ return { rowExists: true, sortableFields };
39
+ // A field the predicate does not exempt is compacted *unlocked* on a cascade,
40
+ // by design: the predicate decides only what work is skipped, never whether a
41
+ // lock is taken. Falling back to the lock for such a field would reintroduce
42
+ // a lock count set by the data — one per distinct surviving scope, held to
43
+ // the root COMMIT, drawn from the cluster-wide lock table — with no way for
44
+ // the application to avoid it. The concurrent-writer races the missing lock
45
+ // exposes are accepted and documented on `@deco.Sortable`, and are what
46
+ // `withConcurrentWriterRetry` exists for.
47
+ const { rowExists, snapshots } = cascadeEdge
48
+ ? await readSortableSnapshots(dream, txn, sortableFields)
49
+ : await acquireStabilizedSortableScopeLocks(dream, txn, sortableFields);
36
50
  cacheSortableSnapshots(dream, snapshots);
37
- return rowExists;
51
+ return { rowExists, sortableFields };
38
52
  }
39
53
  /**
40
54
  * @internal
@@ -0,0 +1,32 @@
1
+ /**
2
+ * A symbol-keyed assignment, like the `CASCADE_LOADED` marker in
3
+ * `destroyAssociatedRecords`: excluded from `Object.keys`, `for...in` and
4
+ * `JSON.stringify` without a descriptor, and cheap on a wide cascade tree.
5
+ */
6
+ const SORTABLE_CASCADE_EDGE = Symbol.for('dream:sortableCascadeEdge');
7
+ /**
8
+ * @internal
9
+ *
10
+ * Marks a record a `dependent: 'destroy'` cascade is about to destroy or
11
+ * undestroy, with the association the cascade reached it through. The record's
12
+ * own destroy or undestroy consumes the mark and does its sortable work without
13
+ * the scope lock a direct operation takes.
14
+ */
15
+ export function markSortableCascadeEdge(dream, association) {
16
+ ;
17
+ dream[SORTABLE_CASCADE_EDGE] = association;
18
+ }
19
+ /**
20
+ * @internal
21
+ *
22
+ * The association a cascade reached this record through, or null on a direct
23
+ * destroy or undestroy. Consuming removes the mark, so a later direct operation
24
+ * on the same instance cannot inherit a cascade's optimism.
25
+ */
26
+ export function consumeSortableCascadeEdge(dream) {
27
+ const association = dream[SORTABLE_CASCADE_EDGE];
28
+ if (association === undefined)
29
+ return null;
30
+ delete dream[SORTABLE_CASCADE_EDGE];
31
+ return association;
32
+ }
@@ -214,6 +214,32 @@ export default class QueryDriverBase {
214
214
  * than silently racing on position values.
215
215
  */
216
216
  static supportsAdvisoryTransactionLocks = false;
217
+ /**
218
+ * @internal
219
+ *
220
+ * Whether `error` is the database refusing a write for violating a unique
221
+ * constraint. `withConcurrentWriterRetry` asks this of an error raised at
222
+ * COMMIT, which is where a `DEFERRABLE INITIALLY DEFERRED` constraint — the
223
+ * one `DreamMigrationHelpers.addDeferrableUniqueConstraint` declares — reports
224
+ * a collision. A driver that does not recognize one reports false, and nothing
225
+ * is retried.
226
+ */
227
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
228
+ static isUniqueConstraintViolation(error) {
229
+ return false;
230
+ }
231
+ /**
232
+ * @internal
233
+ *
234
+ * Whether `error` is the database aborting a transaction to break a deadlock
235
+ * with another. `withConcurrentWriterRetry` reruns a transaction of Dream's
236
+ * own that was aborted this way. A driver that does not recognize one reports
237
+ * false, and nothing is retried.
238
+ */
239
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
240
+ static isDeadlock(error) {
241
+ return false;
242
+ }
217
243
  /**
218
244
  * @internal
219
245
  *
@@ -10,7 +10,7 @@ import pg from 'pg';
10
10
  import { sql } from 'kysely';
11
11
  import DreamCLI from '../../cli/index.js';
12
12
  import { isPrimitiveDataType } from '../../db/dataTypes.js';
13
- import { LOCK_NOT_AVAILABLE, pgErrorType } from '../../db/errors.js';
13
+ import { DEADLOCK_DETECTED, LOCK_NOT_AVAILABLE, pgErrorType, UNIQUE_VIOLATION } from '../../db/errors.js';
14
14
  import DreamApp from '../../dream-app/index.js';
15
15
  import SortableScopeLockWaitTimedOut from '../../errors/SortableScopeLockWaitTimedOut.js';
16
16
  import camelize from '../../helpers/camelize.js';
@@ -222,6 +222,12 @@ export default class PostgresQueryDriver extends KyselyQueryDriver {
222
222
  return kyselyQuery.forUpdate(tableAlias);
223
223
  }
224
224
  static supportsAdvisoryTransactionLocks = true;
225
+ static isUniqueConstraintViolation(error) {
226
+ return pgErrorType(error) === UNIQUE_VIOLATION;
227
+ }
228
+ static isDeadlock(error) {
229
+ return pgErrorType(error) === DEADLOCK_DETECTED;
230
+ }
225
231
  /**
226
232
  * @internal
227
233
  *
@@ -1,3 +1,4 @@
1
+ import { markSortableCascadeEdge, } from '../../decorators/field/sortable/helpers/sortableCascadeEdge.js';
1
2
  import loadDependentDestroyTree from './loadDependentDestroyTree.js';
2
3
  /**
3
4
  * @internal
@@ -51,6 +52,7 @@ export default async function destroyAssociatedRecords(dream, txn, options) {
51
52
  // each association in the loop below would trigger its own reload.
52
53
  let dreamWithAssociations = dream;
53
54
  let alreadyLoadedTree = false;
55
+ const associationMetadataMap = dreamClass['associationMetadataMap']();
54
56
  for (const associationName of dreamClass['dependentDestroyAssociationNames']()) {
55
57
  if (!alreadyLoadedTree && !cascadeLoaded(dreamWithAssociations, associationName)) {
56
58
  dreamWithAssociations = await loadDependentDestroyTree(dreamWithAssociations, txn, {
@@ -62,8 +64,13 @@ export default async function destroyAssociatedRecords(dream, txn, options) {
62
64
  }
63
65
  const loaded = dreamWithAssociations[associationName];
64
66
  const records = Array.isArray(loaded) ? loaded : loaded ? [loaded] : [];
67
+ const association = associationMetadataMap[associationName];
65
68
  for (const record of records) {
66
69
  markCascadeLoaded(record);
70
+ // a cascaded destroy does its sortable work without the scope lock, and
71
+ // which edge reached the record decides what it compacts
72
+ if (association)
73
+ markSortableCascadeEdge(record, association);
67
74
  if (reallyDestroy) {
68
75
  await record.txn(txn).reallyDestroy(options);
69
76
  }
@@ -1,14 +1,18 @@
1
1
  import performSortableDestroyWork from '../../decorators/field/sortable/helpers/performSortableDestroyWork.js';
2
2
  import prepareSortableFieldsForDestroy, { clearSortableFieldsForDestroy, } from '../../decorators/field/sortable/helpers/prepareSortableFieldsForDestroy.js';
3
+ import { consumeSortableCascadeEdge } from '../../decorators/field/sortable/helpers/sortableCascadeEdge.js';
3
4
  import DreamApp from '../../dream-app/index.js';
4
5
  import destroyAssociatedRecords from './destroyAssociatedRecords.js';
5
6
  import runHooksFor from './runHooksFor.js';
7
+ import withConcurrentWriterRetry from './withConcurrentWriterRetry.js';
6
8
  /**
7
9
  * @internal
8
10
  *
9
11
  * Destroys the Dream and any `dependent: 'destroy'` associations
10
12
  * within a transaction. If a transaction is passed, it will be used.
11
- * Otherwise, a new transaction will be created automatically.
13
+ * Otherwise, a new transaction will be created automatically, and the
14
+ * whole destroy is run again if that transaction is undone by a concurrent
15
+ * writer (see `withConcurrentWriterRetry`).
12
16
  * If any of the nested associations fails to destroy, then this
13
17
  * record will also fail to destroy. If skipHooks is true, model hooks
14
18
  * will be bypassed.
@@ -19,7 +23,7 @@ export default async function destroyDream(dream, txn = null, options) {
19
23
  }
20
24
  else {
21
25
  const dreamClass = dream.constructor;
22
- return await dreamClass.transaction(async (txn) => await destroyDreamWithTransaction(dream, txn, options));
26
+ return await withConcurrentWriterRetry(dreamClass, async (txn) => await destroyDreamWithTransaction(dream, txn, options));
23
27
  }
24
28
  }
25
29
  /**
@@ -31,6 +35,10 @@ export default async function destroyDream(dream, txn = null, options) {
31
35
  */
32
36
  async function destroyDreamWithTransaction(dream, txn, options) {
33
37
  const { cascade, reallyDestroy, skipHooks } = options;
38
+ // The association a `dependent: 'destroy'` cascade reached this record
39
+ // through, or null on a direct destroy. Consumed first, before a hook or the
40
+ // cascade below can re-enter this function for the same instance.
41
+ const cascadeEdge = consumeSortableCascadeEdge(dream);
34
42
  if (!skipHooks)
35
43
  await runHooksFor('beforeDestroy', dream, true, null, txn);
36
44
  // `preventDeletion` is fail-closed: a veto returns before the
@@ -51,19 +59,22 @@ async function destroyDreamWithTransaction(dream, txn, options) {
51
59
  await destroyAssociatedRecords(dream, txn, options);
52
60
  }
53
61
  // Sortable preparation runs as a phase after every user beforeDestroy hook,
54
- // never as a hook among them: the destroy's whole advisory key set — every
55
- // sortable field — is acquired in one sorted pass, and the row's real
56
- // position and scope values are read in one snapshot SELECT while the row
57
- // still exists. It sits after the cascade so this destroy does not hold the
58
- // scope lock across every descendant's destroy — true of the destroy itself,
59
- // not of the transaction it runs in: under `Query#destroy({ lock: true })`
60
- // the batch's whole key set is already held, taken before any row was
61
- // claimed. A destroy that skips hooks performs no compaction, and one a
62
- // cascaded descendant's hook has vetoed will not delete, so neither needs
63
- // locks or a snapshot.
62
+ // never as a hook among them: the row's real position and scope values are
63
+ // read in one snapshot SELECT while the row still exists, under the
64
+ // destroy's whole advisory key set on a direct destroy and under no scope
65
+ // lock on a cascaded one. It sits after the cascade so a direct destroy does
66
+ // not hold its scope locks across every descendant's destroy — true of the
67
+ // destroy itself, not of the transaction it runs in: under
68
+ // `Query#destroy({ lock: true })` the batch's whole key set is already held,
69
+ // taken before any row was claimed. A destroy that skips hooks performs no
70
+ // compaction, and one a cascaded descendant's hook has vetoed will not
71
+ // delete, so neither needs locks or a snapshot.
64
72
  let rowFoundBeforeDelete = true;
73
+ let compactedSortableFields = [];
65
74
  if (!skipHooks && !dream['_preventDeletion']) {
66
- rowFoundBeforeDelete = await prepareSortableFieldsForDestroy(dream, txn);
75
+ const preparation = await prepareSortableFieldsForDestroy(dream, txn, cascadeEdge);
76
+ rowFoundBeforeDelete = preparation.rowExists;
77
+ compactedSortableFields = preparation.sortableFields;
67
78
  }
68
79
  const rowsRemoved = await maybeDestroyDream(dream, txn, reallyDestroy);
69
80
  // `preventDeletion` can still arrive after the veto check above has passed:
@@ -95,7 +106,7 @@ async function destroyDreamWithTransaction(dream, txn, options) {
95
106
  // among them, so every user afterDestroy hook observes the compacted scope
96
107
  // regardless of where it was declared — the destroy-side counterpart of
97
108
  // performSortablePositionWork running before the after-save hooks.
98
- await performSortableDestroyWork(dream, txn);
109
+ await performSortableDestroyWork(dream, txn, compactedSortableFields);
99
110
  await runHooksFor('afterDestroy', dream, true, null, txn);
100
111
  await runHooksFor('afterDestroyCommit', dream, true, null, txn);
101
112
  }
@@ -1,15 +1,21 @@
1
+ import { SOFT_DELETE_SCOPE_NAME } from '../../decorators/class/SoftDelete.js';
1
2
  import acquireStabilizedSortableScopeLocks from '../../decorators/field/sortable/helpers/acquireStabilizedSortableScopeLocks.js';
2
3
  import filterQueryToScopeValues from '../../decorators/field/sortable/helpers/filterQueryToScopeValues.js';
3
- import { snapshotScopeValue } from '../../decorators/field/sortable/helpers/sortableSnapshot.js';
4
+ import { consumeSortableCascadeEdge, markSortableCascadeEdge, } from '../../decorators/field/sortable/helpers/sortableCascadeEdge.js';
5
+ import { readSortableSnapshots, snapshotScopeValue, } from '../../decorators/field/sortable/helpers/sortableSnapshot.js';
6
+ import associationUpdateQuery from './associations/associationUpdateQuery.js';
4
7
  import runHooksFor from './runHooksFor.js';
8
+ import withConcurrentWriterRetry from './withConcurrentWriterRetry.js';
5
9
  /**
6
10
  * @internal
7
11
  *
8
- * Destroys the Dream and any `dependent: 'destroy'` associations
12
+ * Undestroys the Dream and any `dependent: 'destroy'` associations
9
13
  * within a transaction. If a transaction is passed, it will be used.
10
- * Otherwise, a new transaction will be created automatically.
11
- * If any of the nested associations fails to destroy, then this
12
- * record will also fail to destroy. If skipHooks is true, model hooks
14
+ * Otherwise, a new transaction will be created automatically, and the
15
+ * whole undestroy is run again if that transaction is undone by a
16
+ * concurrent writer (see `withConcurrentWriterRetry`).
17
+ * If any of the nested associations fails to undestroy, then this
18
+ * record will also fail to undestroy. If skipHooks is true, model hooks
13
19
  * will be bypassed.
14
20
  */
15
21
  export default async function undestroyDream(dream, txn = null, options) {
@@ -18,33 +24,35 @@ export default async function undestroyDream(dream, txn = null, options) {
18
24
  }
19
25
  else {
20
26
  const dreamClass = dream.constructor;
21
- return await dreamClass.transaction(async (txn) => await undestroyDreamWithTransaction(dream, txn, options));
27
+ return await withConcurrentWriterRetry(dreamClass, async (txn) => await undestroyDreamWithTransaction(dream, txn, options));
22
28
  }
23
29
  }
24
30
  /**
25
31
  * @internal
26
32
  *
27
- * Given a transaction, applies the destroy query,
33
+ * Given a transaction, applies the undestroy query,
28
34
  * including cascading to child associations and
29
35
  * model hooks.
30
36
  */
31
37
  async function undestroyDreamWithTransaction(dream, txn, options) {
32
38
  const { cascade, skipHooks } = options;
39
+ // Whether a `dependent: 'destroy'` cascade reached this record, which decides
40
+ // whether its restore takes the scope lock. Consumed first, before a hook or
41
+ // the cascade below can re-enter this function for the same instance.
42
+ const cascaded = consumeSortableCascadeEdge(dream) !== null;
33
43
  if (!skipHooks) {
34
44
  await runHooksFor('beforeUpdate', dream, true, null, txn);
35
45
  }
36
- // The cascade runs ahead of the restore, matching `destroyDream`: this
37
- // record's own scope lock is taken inside `doUndestroyDream`, so a cascade
38
- // seated after it would hold that lock across every descendant's undestroy,
39
- // and a parent and its children would take their advisory keys in the
40
- // opposite order to the one the destroy side takes them in. The nested select
41
- // the cascade builds bypasses the soft-delete scope on this record's own
42
- // class (`undestroyOptions`), so it reaches the children while this record is
43
- // still deleted.
46
+ // The cascade runs ahead of the restore, matching `destroyDream`: a direct
47
+ // undestroy takes this record's own scope lock inside `doUndestroyDream`, so
48
+ // a cascade seated after it would hold that lock across every descendant's
49
+ // undestroy. The nested select the cascade builds bypasses the soft-delete
50
+ // scope on this record's own class (`undestroyOptions`), so it reaches the
51
+ // children while this record is still deleted.
44
52
  if (cascade) {
45
53
  await undestroyAssociatedRecords(dream, txn, options);
46
54
  }
47
- const restoredRowCount = await doUndestroyDream(dream, txn);
55
+ const restoredRowCount = await doUndestroyDream(dream, txn, { lock: !cascaded });
48
56
  // A restore of a row that is not deleted — a second `undestroy()`, a job
49
57
  // retry, or a record that was never destroyed, which `Query#undestroy` reaches
50
58
  // routinely since it lifts the soft-delete scope and walks every match —
@@ -68,9 +76,16 @@ async function undestroyDreamWithTransaction(dream, txn, options) {
68
76
  * is computed from, and would move one past itself on every repeat — a
69
77
  * permanent gap in the scope.
70
78
  *
79
+ * @param lock - whether to take each sortable field's scope lock around the
80
+ * position computation. A direct undestroy does; a cascaded one does not,
81
+ * since a cascade would otherwise hold one lock per distinct sort scope it
82
+ * restores into until the root transaction commits. Without the lock the
83
+ * `max(position) + 1` below can race a concurrent writer of the scope onto the
84
+ * same position, which the scope's deferrable unique constraint refuses at
85
+ * COMMIT; see `withConcurrentWriterRetry`.
71
86
  * @returns the number of rows restored: 1, or 0 when the row was not deleted
72
87
  */
73
- async function doUndestroyDream(dream, txn) {
88
+ async function doUndestroyDream(dream, txn, { lock }) {
74
89
  const updateStatement = txn.kyselyTransaction.updateTable(dream.table);
75
90
  let query = updateStatement
76
91
  .where(dream['_primaryKey'], '=', dream.primaryKeyValue())
@@ -79,16 +94,16 @@ async function doUndestroyDream(dream, txn) {
79
94
  const dreamClass = dream.constructor;
80
95
  const sortableFields = (dreamClass['sortableFields'] ?? []);
81
96
  // Undestroy has no sortable hook of its own — the position is recomputed
82
- // inline, below, before `afterUpdate` ever runs — so the scope lock is taken
83
- // here, around that recomputation. Without it the `max(position) + 1`
84
- // subquery races every other writer of the scope the record is being restored
85
- // into.
97
+ // inline, below, before `afterUpdate` ever runs — so a direct undestroy takes
98
+ // the scope lock here, around that recomputation.
86
99
  //
87
100
  // The scope this record is being restored into is the one its row physically
88
101
  // carries, not the one the instance was loaded with: another writer may have
89
- // moved it between scopes while it was soft deleted, which is what the
90
- // stabilized acquisition converges on.
91
- const { snapshots } = await acquireStabilizedSortableScopeLocks(dream, txn, sortableFields);
102
+ // moved it between scopes while it was soft deleted. The stabilized
103
+ // acquisition converges on that scope; the unlocked read simply reads it.
104
+ const { snapshots } = lock
105
+ ? await acquireStabilizedSortableScopeLocks(dream, txn, sortableFields)
106
+ : await readSortableSnapshots(dream, txn, sortableFields);
92
107
  sortableFields.forEach(sortableFieldMetadata => {
93
108
  const positionColumn = sortableFieldMetadata.positionField;
94
109
  const snapshot = snapshots.get(positionColumn);
@@ -113,22 +128,30 @@ async function doUndestroyDream(dream, txn) {
113
128
  /**
114
129
  * @internal
115
130
  *
116
- * Destroys all HasOne/HasMany associations on this
117
- * dream that are marked as `dependent: 'destroy'`
131
+ * Undestroys all HasOne/HasMany associations on this dream that are marked as
132
+ * `dependent: 'destroy'`: the walk `Query#undestroy` makes, with each record
133
+ * marked as reached by this cascade before its own undestroy runs, so that its
134
+ * restore takes no scope lock.
118
135
  */
119
136
  async function undestroyAssociatedRecords(dream, txn, options) {
120
137
  const dreamClass = dream.constructor;
121
138
  for (const associationName of dreamClass['dependentDestroyAssociationNames']()) {
122
- const associationMetadata = dreamClass['associationMetadataMap']()[associationName];
123
- const associatedClass = associationMetadata?.modelCB?.();
139
+ const association = dreamClass['associationMetadataMap']()[associationName];
140
+ const associatedClass = association?.modelCB?.();
124
141
  if (Array.isArray(associatedClass)) {
125
142
  // TODO: decide how to handle polymorphic associations with dependent: destroy
126
143
  // raise?
127
144
  }
128
- else {
129
- if (associatedClass?.['softDelete']) {
130
- await dream.txn(txn).undestroyAssociation(associationName, options);
131
- }
145
+ else if (association && associatedClass?.['softDelete']) {
146
+ const query = associationUpdateQuery(dream, txn, associationName, {
147
+ joinAndStatements: {},
148
+ bypassAllDefaultScopes: options.bypassAllDefaultScopes ?? false,
149
+ defaultScopesToBypass: (options.defaultScopesToBypass ?? []),
150
+ });
151
+ await query.removeDefaultScope(SOFT_DELETE_SCOPE_NAME).findEach(async (record) => {
152
+ markSortableCascadeEdge(record, association);
153
+ await record.txn(txn).undestroy(options);
154
+ });
132
155
  }
133
156
  }
134
157
  }