@expo/entity 0.17.0 → 0.21.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 (215) hide show
  1. package/build/EnforcingEntityLoader.js +2 -2
  2. package/build/EnforcingEntityLoader.js.map +1 -1
  3. package/build/Entity.js +8 -2
  4. package/build/Entity.js.map +1 -1
  5. package/build/EntityAssociationLoader.js +3 -3
  6. package/build/EntityAssociationLoader.js.map +1 -1
  7. package/build/EntityCompanion.d.ts +5 -0
  8. package/build/EntityCompanion.js +8 -1
  9. package/build/EntityCompanion.js.map +1 -1
  10. package/build/EntityCompanionProvider.d.ts +1 -1
  11. package/build/EntityCompanionProvider.js +5 -5
  12. package/build/EntityCompanionProvider.js.map +1 -1
  13. package/build/EntityConfiguration.d.ts +1 -1
  14. package/build/EntityConfiguration.js +3 -3
  15. package/build/EntityConfiguration.js.map +1 -1
  16. package/build/EntityDatabaseAdapter.d.ts +4 -4
  17. package/build/EntityDatabaseAdapter.js +13 -13
  18. package/build/EntityDatabaseAdapter.js.map +1 -1
  19. package/build/EntityFieldDefinition.d.ts +77 -0
  20. package/build/EntityFieldDefinition.js +53 -0
  21. package/build/EntityFieldDefinition.js.map +1 -0
  22. package/build/EntityFields.d.ts +1 -77
  23. package/build/EntityFields.js +13 -61
  24. package/build/EntityFields.js.map +1 -1
  25. package/build/EntityLoader.d.ts +3 -1
  26. package/build/EntityLoader.js +19 -15
  27. package/build/EntityLoader.js.map +1 -1
  28. package/build/EntityLoaderFactory.d.ts +3 -1
  29. package/build/EntityLoaderFactory.js +3 -2
  30. package/build/EntityLoaderFactory.js.map +1 -1
  31. package/build/EntityMutationInfo.d.ts +26 -0
  32. package/build/EntityMutationInfo.js +10 -0
  33. package/build/EntityMutationInfo.js.map +1 -0
  34. package/build/EntityMutationTriggerConfiguration.d.ts +4 -4
  35. package/build/EntityMutationValidator.d.ts +3 -3
  36. package/build/EntityMutationValidator.js.map +1 -1
  37. package/build/EntityMutator.d.ts +5 -16
  38. package/build/EntityMutator.js +62 -58
  39. package/build/EntityMutator.js.map +1 -1
  40. package/build/EntityPrivacyPolicy.d.ts +5 -4
  41. package/build/EntityPrivacyPolicy.js +60 -12
  42. package/build/EntityPrivacyPolicy.js.map +1 -1
  43. package/build/EntityQueryContext.d.ts +24 -0
  44. package/build/EntityQueryContext.js +43 -0
  45. package/build/EntityQueryContext.js.map +1 -1
  46. package/build/EntityQueryContextProvider.js +1 -0
  47. package/build/EntityQueryContextProvider.js.map +1 -1
  48. package/build/EntitySecondaryCacheLoader.js +2 -2
  49. package/build/EntitySecondaryCacheLoader.js.map +1 -1
  50. package/build/ReadonlyEntity.js +3 -4
  51. package/build/ReadonlyEntity.js.map +1 -1
  52. package/build/ViewerScopedEntityCompanion.d.ts +5 -0
  53. package/build/ViewerScopedEntityCompanion.js +6 -0
  54. package/build/ViewerScopedEntityCompanion.js.map +1 -1
  55. package/build/__tests__/EnforcingEntityLoader-test.js +82 -82
  56. package/build/__tests__/EnforcingEntityLoader-test.js.map +1 -1
  57. package/build/__tests__/Entity-test.js +6 -6
  58. package/build/__tests__/Entity-test.js.map +1 -1
  59. package/build/__tests__/EntityAssociationLoader-test.js +40 -40
  60. package/build/__tests__/EntityAssociationLoader-test.js.map +1 -1
  61. package/build/__tests__/EntityCommonUseCases-test.js +11 -11
  62. package/build/__tests__/EntityCommonUseCases-test.js.map +1 -1
  63. package/build/__tests__/EntityCompanion-test.js +3 -3
  64. package/build/__tests__/EntityCompanion-test.js.map +1 -1
  65. package/build/__tests__/EntityCompanionProvider-test.js +1 -1
  66. package/build/__tests__/EntityCompanionProvider-test.js.map +1 -1
  67. package/build/__tests__/EntityDatabaseAdapter-test.js +12 -12
  68. package/build/__tests__/EntityDatabaseAdapter-test.js.map +1 -1
  69. package/build/__tests__/EntityEdges-test.js +103 -6
  70. package/build/__tests__/EntityEdges-test.js.map +1 -1
  71. package/build/__tests__/EntityFields-test.js +18 -27
  72. package/build/__tests__/EntityFields-test.js.map +1 -1
  73. package/build/__tests__/EntityLoader-constructor-test.d.ts +22 -0
  74. package/build/__tests__/EntityLoader-constructor-test.js +111 -0
  75. package/build/__tests__/EntityLoader-constructor-test.js.map +1 -0
  76. package/build/__tests__/EntityLoader-test.js +72 -64
  77. package/build/__tests__/EntityLoader-test.js.map +1 -1
  78. package/build/__tests__/EntityMutator-MutationCacheConsistency-test.d.ts +1 -0
  79. package/build/__tests__/EntityMutator-MutationCacheConsistency-test.js +81 -0
  80. package/build/__tests__/EntityMutator-MutationCacheConsistency-test.js.map +1 -0
  81. package/build/__tests__/EntityMutator-test.js +116 -114
  82. package/build/__tests__/EntityMutator-test.js.map +1 -1
  83. package/build/__tests__/EntityPrivacyPolicy-test.js +143 -67
  84. package/build/__tests__/EntityPrivacyPolicy-test.js.map +1 -1
  85. package/build/__tests__/EntityQueryContext-test.d.ts +1 -0
  86. package/build/__tests__/EntityQueryContext-test.js +56 -0
  87. package/build/__tests__/EntityQueryContext-test.js.map +1 -0
  88. package/build/__tests__/EntitySecondaryCacheLoader-test.js +15 -15
  89. package/build/__tests__/EntitySecondaryCacheLoader-test.js.map +1 -1
  90. package/build/__tests__/EntitySelfReferentialEdges-test.js +13 -12
  91. package/build/__tests__/EntitySelfReferentialEdges-test.js.map +1 -1
  92. package/build/__tests__/ReadonlyEntity-test.js +11 -11
  93. package/build/__tests__/ReadonlyEntity-test.js.map +1 -1
  94. package/build/__tests__/ViewerContext-test.js +2 -2
  95. package/build/__tests__/ViewerContext-test.js.map +1 -1
  96. package/build/__tests__/ViewerScopedEntityCompanion-test.js +2 -2
  97. package/build/__tests__/ViewerScopedEntityCompanion-test.js.map +1 -1
  98. package/build/__tests__/ViewerScopedEntityCompanionProvider-test.js +2 -2
  99. package/build/__tests__/ViewerScopedEntityCompanionProvider-test.js.map +1 -1
  100. package/build/__tests__/ViewerScopedEntityLoaderFactory-test.js +5 -5
  101. package/build/__tests__/ViewerScopedEntityLoaderFactory-test.js.map +1 -1
  102. package/build/__tests__/ViewerScopedEntityMutatorFactory-test.js +5 -5
  103. package/build/__tests__/ViewerScopedEntityMutatorFactory-test.js.map +1 -1
  104. package/build/__tests__/cases/TwoEntitySameTableDisjointRows-test.js +5 -5
  105. package/build/__tests__/cases/TwoEntitySameTableDisjointRows-test.js.map +1 -1
  106. package/build/__tests__/cases/TwoEntitySameTableOverlappingRows-test.js +2 -2
  107. package/build/__tests__/cases/TwoEntitySameTableOverlappingRows-test.js.map +1 -1
  108. package/build/__tests__/entityUtils-test.js +21 -21
  109. package/build/__tests__/entityUtils-test.js.map +1 -1
  110. package/build/index.d.ts +3 -0
  111. package/build/index.js +5 -1
  112. package/build/index.js.map +1 -1
  113. package/build/internal/EntityDataManager.js +8 -7
  114. package/build/internal/EntityDataManager.js.map +1 -1
  115. package/build/internal/EntityFieldTransformationUtils.js +2 -2
  116. package/build/internal/EntityFieldTransformationUtils.js.map +1 -1
  117. package/build/internal/ReadThroughEntityCache.js +4 -4
  118. package/build/internal/ReadThroughEntityCache.js.map +1 -1
  119. package/build/internal/__tests__/EntityDataManager-test.js +17 -17
  120. package/build/internal/__tests__/EntityDataManager-test.js.map +1 -1
  121. package/build/internal/__tests__/EntityFieldTransformationUtils-test.js +8 -8
  122. package/build/internal/__tests__/EntityFieldTransformationUtils-test.js.map +1 -1
  123. package/build/internal/__tests__/ReadThroughEntityCache-test.js +48 -48
  124. package/build/internal/__tests__/ReadThroughEntityCache-test.js.map +1 -1
  125. package/build/metrics/EntityMetricsUtils.js +1 -1
  126. package/build/metrics/EntityMetricsUtils.js.map +1 -1
  127. package/build/metrics/IEntityMetricsAdapter.d.ts +16 -0
  128. package/build/metrics/IEntityMetricsAdapter.js +6 -1
  129. package/build/metrics/IEntityMetricsAdapter.js.map +1 -1
  130. package/build/metrics/NoOpEntityMetricsAdapter.d.ts +2 -1
  131. package/build/metrics/NoOpEntityMetricsAdapter.js +1 -0
  132. package/build/metrics/NoOpEntityMetricsAdapter.js.map +1 -1
  133. package/build/rules/__tests__/AlwaysAllowPrivacyPolicyRule-test.js +4 -4
  134. package/build/rules/__tests__/AlwaysAllowPrivacyPolicyRule-test.js.map +1 -1
  135. package/build/rules/__tests__/AlwaysDenyPrivacyPolicyRule-test.js +4 -4
  136. package/build/rules/__tests__/AlwaysDenyPrivacyPolicyRule-test.js.map +1 -1
  137. package/build/rules/__tests__/AlwaysSkipPrivacyPolicyRule-test.js +4 -4
  138. package/build/rules/__tests__/AlwaysSkipPrivacyPolicyRule-test.js.map +1 -1
  139. package/build/testfixtures/DateIDTestEntity.js.map +1 -1
  140. package/build/testfixtures/SimpleTestEntity.js.map +1 -1
  141. package/build/testfixtures/TestEntity.d.ts +5 -5
  142. package/build/testfixtures/TestEntity.js +2 -2
  143. package/build/testfixtures/TestEntity.js.map +1 -1
  144. package/build/testfixtures/TestEntity2.d.ts +5 -5
  145. package/build/testfixtures/TestEntity2.js.map +1 -1
  146. package/build/testfixtures/TestEntityNumberKey.js.map +1 -1
  147. package/build/utils/collections/__tests__/maps-test.js +13 -13
  148. package/build/utils/collections/__tests__/maps-test.js.map +1 -1
  149. package/build/utils/collections/maps.js +1 -1
  150. package/build/utils/collections/maps.js.map +1 -1
  151. package/build/utils/testing/PrivacyPolicyRuleTestUtils.d.ts +6 -6
  152. package/build/utils/testing/PrivacyPolicyRuleTestUtils.js +1 -1
  153. package/build/utils/testing/PrivacyPolicyRuleTestUtils.js.map +1 -1
  154. package/build/utils/testing/StubCacheAdapter.js +1 -1
  155. package/build/utils/testing/StubCacheAdapter.js.map +1 -1
  156. package/build/utils/testing/StubDatabaseAdapter.js +6 -6
  157. package/build/utils/testing/StubDatabaseAdapter.js.map +1 -1
  158. package/build/utils/testing/__tests__/StubDatabaseAdapter-test.js +9 -9
  159. package/build/utils/testing/__tests__/StubDatabaseAdapter-test.js.map +1 -1
  160. package/build/utils/testing/describeFieldTestCase.d.ts +2 -0
  161. package/build/utils/testing/describeFieldTestCase.js +18 -0
  162. package/build/utils/testing/describeFieldTestCase.js.map +1 -0
  163. package/package.json +2 -1
  164. package/src/Entity.ts +10 -2
  165. package/src/EntityAssociationLoader.ts +1 -1
  166. package/src/EntityCompanion.ts +10 -2
  167. package/src/EntityCompanionProvider.ts +5 -9
  168. package/src/EntityConfiguration.ts +1 -1
  169. package/src/EntityDatabaseAdapter.ts +10 -8
  170. package/src/EntityFieldDefinition.ts +124 -0
  171. package/src/EntityFields.ts +2 -125
  172. package/src/EntityLoader.ts +12 -4
  173. package/src/EntityLoaderFactory.ts +5 -2
  174. package/src/EntityMutationInfo.ts +47 -0
  175. package/src/EntityMutationTriggerConfiguration.ts +5 -5
  176. package/src/EntityMutationValidator.ts +10 -4
  177. package/src/EntityMutator.ts +98 -76
  178. package/src/EntityPrivacyPolicy.ts +77 -19
  179. package/src/EntityQueryContext.ts +54 -0
  180. package/src/EntityQueryContextProvider.ts +1 -0
  181. package/src/ReadonlyEntity.ts +3 -2
  182. package/src/ViewerScopedEntityCompanion.ts +8 -0
  183. package/src/__tests__/Entity-test.ts +8 -8
  184. package/src/__tests__/EntityCommonUseCases-test.ts +4 -4
  185. package/src/__tests__/EntityEdges-test.ts +169 -14
  186. package/src/__tests__/EntityFields-test.ts +2 -21
  187. package/src/__tests__/EntityLoader-constructor-test.ts +177 -0
  188. package/src/__tests__/EntityLoader-test.ts +39 -11
  189. package/src/__tests__/EntityMutator-MutationCacheConsistency-test.ts +105 -0
  190. package/src/__tests__/EntityMutator-test.ts +140 -133
  191. package/src/__tests__/EntityPrivacyPolicy-test.ts +215 -78
  192. package/src/__tests__/EntityQueryContext-test.ts +82 -0
  193. package/src/__tests__/EntitySecondaryCacheLoader-test.ts +7 -9
  194. package/src/__tests__/EntitySelfReferentialEdges-test.ts +6 -5
  195. package/src/__tests__/ViewerContext-test.ts +7 -6
  196. package/src/__tests__/ViewerScopedEntityCompanion-test.ts +11 -10
  197. package/src/__tests__/ViewerScopedEntityMutatorFactory-test.ts +4 -3
  198. package/src/__tests__/cases/TwoEntitySameTableDisjointRows-test.ts +6 -6
  199. package/src/__tests__/cases/TwoEntitySameTableOverlappingRows-test.ts +4 -4
  200. package/src/index.ts +3 -0
  201. package/src/internal/EntityDataManager.ts +2 -1
  202. package/src/internal/__tests__/EntityDataManager-test.ts +2 -2
  203. package/src/internal/__tests__/ReadThroughEntityCache-test.ts +15 -13
  204. package/src/metrics/EntityMetricsUtils.ts +56 -50
  205. package/src/metrics/IEntityMetricsAdapter.ts +23 -0
  206. package/src/metrics/NoOpEntityMetricsAdapter.ts +2 -0
  207. package/src/testfixtures/DateIDTestEntity.ts +4 -4
  208. package/src/testfixtures/SimpleTestEntity.ts +4 -4
  209. package/src/testfixtures/TestEntity.ts +4 -4
  210. package/src/testfixtures/TestEntity2.ts +4 -4
  211. package/src/testfixtures/TestEntityNumberKey.ts +4 -4
  212. package/src/utils/testing/StubDatabaseAdapter.ts +2 -2
  213. package/src/utils/testing/__tests__/StubDatabaseAdapter-test.ts +1 -1
  214. package/src/utils/testing/describeFieldTestCase.ts +21 -0
  215. package/CHANGELOG.md +0 -252
@@ -2,6 +2,9 @@ import { EntityQueryContext } from './EntityQueryContext';
2
2
  import ReadonlyEntity from './ReadonlyEntity';
3
3
  import ViewerContext from './ViewerContext';
4
4
  import EntityNotAuthorizedError from './errors/EntityNotAuthorizedError';
5
+ import IEntityMetricsAdapter, {
6
+ EntityMetricsAuthorizationResult,
7
+ } from './metrics/IEntityMetricsAdapter';
5
8
  import PrivacyPolicyRule, { RuleEvaluationResult } from './rules/PrivacyPolicyRule';
6
9
 
7
10
  export enum EntityPrivacyPolicyEvaluationMode {
@@ -124,14 +127,16 @@ export default abstract class EntityPrivacyPolicy<
124
127
  async authorizeCreateAsync(
125
128
  viewerContext: TViewerContext,
126
129
  queryContext: EntityQueryContext,
127
- entity: TEntity
130
+ entity: TEntity,
131
+ metricsAdapter: IEntityMetricsAdapter
128
132
  ): Promise<TEntity> {
129
133
  return await this.authorizeForRulesetAsync(
130
134
  this.createRules,
131
135
  viewerContext,
132
136
  queryContext,
133
137
  entity,
134
- EntityAuthorizationAction.CREATE
138
+ EntityAuthorizationAction.CREATE,
139
+ metricsAdapter
135
140
  );
136
141
  }
137
142
 
@@ -146,14 +151,16 @@ export default abstract class EntityPrivacyPolicy<
146
151
  async authorizeReadAsync(
147
152
  viewerContext: TViewerContext,
148
153
  queryContext: EntityQueryContext,
149
- entity: TEntity
154
+ entity: TEntity,
155
+ metricsAdapter: IEntityMetricsAdapter
150
156
  ): Promise<TEntity> {
151
157
  return await this.authorizeForRulesetAsync(
152
158
  this.readRules,
153
159
  viewerContext,
154
160
  queryContext,
155
161
  entity,
156
- EntityAuthorizationAction.READ
162
+ EntityAuthorizationAction.READ,
163
+ metricsAdapter
157
164
  );
158
165
  }
159
166
 
@@ -168,14 +175,16 @@ export default abstract class EntityPrivacyPolicy<
168
175
  async authorizeUpdateAsync(
169
176
  viewerContext: TViewerContext,
170
177
  queryContext: EntityQueryContext,
171
- entity: TEntity
178
+ entity: TEntity,
179
+ metricsAdapter: IEntityMetricsAdapter
172
180
  ): Promise<TEntity> {
173
181
  return await this.authorizeForRulesetAsync(
174
182
  this.updateRules,
175
183
  viewerContext,
176
184
  queryContext,
177
185
  entity,
178
- EntityAuthorizationAction.UPDATE
186
+ EntityAuthorizationAction.UPDATE,
187
+ metricsAdapter
179
188
  );
180
189
  }
181
190
 
@@ -190,14 +199,16 @@ export default abstract class EntityPrivacyPolicy<
190
199
  async authorizeDeleteAsync(
191
200
  viewerContext: TViewerContext,
192
201
  queryContext: EntityQueryContext,
193
- entity: TEntity
202
+ entity: TEntity,
203
+ metricsAdapter: IEntityMetricsAdapter
194
204
  ): Promise<TEntity> {
195
205
  return await this.authorizeForRulesetAsync(
196
206
  this.deleteRules,
197
207
  viewerContext,
198
208
  queryContext,
199
209
  entity,
200
- EntityAuthorizationAction.DELETE
210
+ EntityAuthorizationAction.DELETE,
211
+ metricsAdapter
201
212
  );
202
213
  }
203
214
 
@@ -206,48 +217,95 @@ export default abstract class EntityPrivacyPolicy<
206
217
  viewerContext: TViewerContext,
207
218
  queryContext: EntityQueryContext,
208
219
  entity: TEntity,
209
- action: EntityAuthorizationAction
220
+ action: EntityAuthorizationAction,
221
+ metricsAdapter: IEntityMetricsAdapter
210
222
  ): Promise<TEntity> {
211
223
  const privacyPolicyEvaluator = this.getPrivacyPolicyEvaluator(viewerContext);
212
224
  switch (privacyPolicyEvaluator.mode) {
213
225
  case EntityPrivacyPolicyEvaluationMode.ENFORCE:
214
- return await this.authorizeForRulesetInnerAsync(
215
- ruleset,
216
- viewerContext,
217
- queryContext,
218
- entity,
219
- action
220
- );
226
+ try {
227
+ const result = await this.authorizeForRulesetInnerAsync(
228
+ ruleset,
229
+ viewerContext,
230
+ queryContext,
231
+ entity,
232
+ action
233
+ );
234
+ metricsAdapter.logAuthorizationEvent({
235
+ entityClassName: entity.constructor.name,
236
+ action,
237
+ evaluationResult: EntityMetricsAuthorizationResult.ALLOW,
238
+ privacyPolicyEvaluationMode: privacyPolicyEvaluator.mode,
239
+ });
240
+ return result;
241
+ } catch (e) {
242
+ if (!(e instanceof EntityNotAuthorizedError)) {
243
+ throw e;
244
+ }
245
+ metricsAdapter.logAuthorizationEvent({
246
+ entityClassName: entity.constructor.name,
247
+ action,
248
+ evaluationResult: EntityMetricsAuthorizationResult.DENY,
249
+ privacyPolicyEvaluationMode: privacyPolicyEvaluator.mode,
250
+ });
251
+ throw e;
252
+ }
221
253
  case EntityPrivacyPolicyEvaluationMode.ENFORCE_AND_LOG:
222
254
  try {
223
- return await this.authorizeForRulesetInnerAsync(
255
+ const result = await this.authorizeForRulesetInnerAsync(
224
256
  ruleset,
225
257
  viewerContext,
226
258
  queryContext,
227
259
  entity,
228
260
  action
229
261
  );
262
+ metricsAdapter.logAuthorizationEvent({
263
+ entityClassName: entity.constructor.name,
264
+ action,
265
+ evaluationResult: EntityMetricsAuthorizationResult.ALLOW,
266
+ privacyPolicyEvaluationMode: privacyPolicyEvaluator.mode,
267
+ });
268
+ return result;
230
269
  } catch (e) {
231
270
  if (!(e instanceof EntityNotAuthorizedError)) {
232
271
  throw e;
233
272
  }
234
273
  privacyPolicyEvaluator.denyHandler(e);
274
+ metricsAdapter.logAuthorizationEvent({
275
+ entityClassName: entity.constructor.name,
276
+ action,
277
+ evaluationResult: EntityMetricsAuthorizationResult.DENY,
278
+ privacyPolicyEvaluationMode: privacyPolicyEvaluator.mode,
279
+ });
235
280
  throw e;
236
281
  }
237
282
  case EntityPrivacyPolicyEvaluationMode.DRY_RUN:
238
283
  try {
239
- return await this.authorizeForRulesetInnerAsync(
284
+ const result = await this.authorizeForRulesetInnerAsync(
240
285
  ruleset,
241
286
  viewerContext,
242
287
  queryContext,
243
288
  entity,
244
289
  action
245
290
  );
291
+ metricsAdapter.logAuthorizationEvent({
292
+ entityClassName: entity.constructor.name,
293
+ action,
294
+ evaluationResult: EntityMetricsAuthorizationResult.ALLOW,
295
+ privacyPolicyEvaluationMode: privacyPolicyEvaluator.mode,
296
+ });
297
+ return result;
246
298
  } catch (e) {
247
299
  if (!(e instanceof EntityNotAuthorizedError)) {
248
300
  throw e;
249
301
  }
250
302
  privacyPolicyEvaluator.denyHandler(e);
303
+ metricsAdapter.logAuthorizationEvent({
304
+ entityClassName: entity.constructor.name,
305
+ action,
306
+ evaluationResult: EntityMetricsAuthorizationResult.DENY,
307
+ privacyPolicyEvaluationMode: privacyPolicyEvaluator.mode,
308
+ });
251
309
  return entity;
252
310
  }
253
311
  }
@@ -261,7 +319,7 @@ export default abstract class EntityPrivacyPolicy<
261
319
  action: EntityAuthorizationAction
262
320
  ): Promise<TEntity> {
263
321
  for (let i = 0; i < ruleset.length; i++) {
264
- const rule = ruleset[i];
322
+ const rule = ruleset[i]!;
265
323
  const ruleEvaluationResult = await rule.evaluateAsync(viewerContext, queryContext, entity);
266
324
  switch (ruleEvaluationResult) {
267
325
  case RuleEvaluationResult.DENY:
@@ -1,6 +1,12 @@
1
+ import assert from 'assert';
2
+
1
3
  import EntityQueryContextProvider from './EntityQueryContextProvider';
2
4
 
3
5
  export type PostCommitCallback = (...args: any) => Promise<any>;
6
+ export type PreCommitCallback = (
7
+ queryContext: EntityTransactionalQueryContext,
8
+ ...args: any
9
+ ) => Promise<any>;
4
10
 
5
11
  /**
6
12
  * Entity framework representation of transactional and non-transactional database
@@ -43,13 +49,61 @@ export class EntityNonTransactionalQueryContext extends EntityQueryContext {
43
49
  }
44
50
 
45
51
  export class EntityTransactionalQueryContext extends EntityQueryContext {
52
+ private readonly postCommitInvalidationCallbacks: PostCommitCallback[] = [];
46
53
  private readonly postCommitCallbacks: PostCommitCallback[] = [];
47
54
 
55
+ private readonly preCommitCallbacks: { callback: PreCommitCallback; order: number }[] = [];
56
+
57
+ /**
58
+ * Schedule a pre-commit callback. These will be run within the transaction right before it is
59
+ * committed, and will be run in the order specified. Ordering of callbacks scheduled with the
60
+ * same value for the order parameter is undefined within that ordering group.
61
+ * @param callback - callback to schedule
62
+ * @param order - order in which this should be run relative to other scheduled pre-commit callbacks,
63
+ * with higher numbers running later than lower numbers.
64
+ */
65
+ public appendPreCommitCallback(callback: PreCommitCallback, order: number): void {
66
+ assert(
67
+ order >= Number.MIN_SAFE_INTEGER && order <= Number.MAX_SAFE_INTEGER,
68
+ `Invalid order specified: ${order}`
69
+ );
70
+ this.preCommitCallbacks.push({ callback, order });
71
+ }
72
+
73
+ /**
74
+ * Schedule a post-commit cache invalidation callback. These are run before normal
75
+ * post-commit callbacks in order to have cache consistency in normal post-commit callbacks.
76
+ * @param callback - callback to schedule
77
+ */
78
+ public appendPostCommitInvalidationCallback(callback: PostCommitCallback): void {
79
+ this.postCommitInvalidationCallbacks.push(callback);
80
+ }
81
+
82
+ /**
83
+ * Schedule a post-commit callback. These will be run after the transaction has
84
+ * been committed.
85
+ * @param callback - callback to schedule
86
+ */
48
87
  public appendPostCommitCallback(callback: PostCommitCallback): void {
49
88
  this.postCommitCallbacks.push(callback);
50
89
  }
51
90
 
91
+ public async runPreCommitCallbacksAsync(): Promise<void> {
92
+ const callbacks = [...this.preCommitCallbacks]
93
+ .sort((a, b) => a.order - b.order)
94
+ .map((c) => c.callback);
95
+ this.preCommitCallbacks.length = 0;
96
+
97
+ for (const callback of callbacks) {
98
+ await callback(this);
99
+ }
100
+ }
101
+
52
102
  public async runPostCommitCallbacksAsync(): Promise<void> {
103
+ const invalidationCallbacks = [...this.postCommitInvalidationCallbacks];
104
+ this.postCommitInvalidationCallbacks.length = 0;
105
+ await Promise.all(invalidationCallbacks.map((callback) => callback()));
106
+
53
107
  const callbacks = [...this.postCommitCallbacks];
54
108
  this.postCommitCallbacks.length = 0;
55
109
  await Promise.all(callbacks.map((callback) => callback()));
@@ -38,6 +38,7 @@ export default abstract class EntityQueryContextProvider {
38
38
  >()(async (queryInterface) => {
39
39
  const queryContext = new EntityTransactionalQueryContext(queryInterface);
40
40
  const result = await transactionScope(queryContext);
41
+ await queryContext.runPreCommitCallbacksAsync();
41
42
  return [result, queryContext];
42
43
  });
43
44
  await queryContext.runPostCommitCallbacksAsync();
@@ -37,8 +37,9 @@ export default abstract class ReadonlyEntity<
37
37
  private readonly viewerContext: TViewerContext,
38
38
  private readonly databaseFields: Readonly<TFields>
39
39
  ) {
40
- const companionDefinition = (this
41
- .constructor as any).getCompanionDefinition() as EntityCompanionDefinition<
40
+ const companionDefinition = (
41
+ this.constructor as any
42
+ ).getCompanionDefinition() as EntityCompanionDefinition<
42
43
  TFields,
43
44
  TID,
44
45
  TViewerContext,
@@ -5,6 +5,7 @@ import ReadonlyEntity from './ReadonlyEntity';
5
5
  import ViewerContext from './ViewerContext';
6
6
  import ViewerScopedEntityLoaderFactory from './ViewerScopedEntityLoaderFactory';
7
7
  import ViewerScopedEntityMutatorFactory from './ViewerScopedEntityMutatorFactory';
8
+ import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
8
9
 
9
10
  /**
10
11
  * Provides a simpler API for loading and mutating entities by injecting the {@link ViewerContext}
@@ -76,4 +77,11 @@ export default class ViewerScopedEntityCompanion<
76
77
  getQueryContextProvider(): EntityQueryContextProvider {
77
78
  return this.entityCompanion.getQueryContextProvider();
78
79
  }
80
+
81
+ /**
82
+ * Get the {@link IEntityMetricsAdapter} for this companion.
83
+ */
84
+ getMetricsAdapter(): IEntityMetricsAdapter {
85
+ return this.entityCompanion.getMetricsAdapter();
86
+ }
79
87
  }
@@ -102,7 +102,7 @@ class SimpleTestDenyUpdateEntityPrivacyPolicy extends EntityPrivacyPolicy<
102
102
  ViewerContext,
103
103
  SimpleTestDenyUpdateEntity
104
104
  > {
105
- protected readonly readRules = [
105
+ protected override readonly readRules = [
106
106
  new AlwaysAllowPrivacyPolicyRule<
107
107
  TestEntityFields,
108
108
  string,
@@ -110,7 +110,7 @@ class SimpleTestDenyUpdateEntityPrivacyPolicy extends EntityPrivacyPolicy<
110
110
  SimpleTestDenyUpdateEntity
111
111
  >(),
112
112
  ];
113
- protected readonly createRules = [
113
+ protected override readonly createRules = [
114
114
  new AlwaysAllowPrivacyPolicyRule<
115
115
  TestEntityFields,
116
116
  string,
@@ -118,7 +118,7 @@ class SimpleTestDenyUpdateEntityPrivacyPolicy extends EntityPrivacyPolicy<
118
118
  SimpleTestDenyUpdateEntity
119
119
  >(),
120
120
  ];
121
- protected readonly updateRules = [
121
+ protected override readonly updateRules = [
122
122
  new AlwaysDenyPrivacyPolicyRule<
123
123
  TestEntityFields,
124
124
  string,
@@ -126,7 +126,7 @@ class SimpleTestDenyUpdateEntityPrivacyPolicy extends EntityPrivacyPolicy<
126
126
  SimpleTestDenyUpdateEntity
127
127
  >(),
128
128
  ];
129
- protected readonly deleteRules = [
129
+ protected override readonly deleteRules = [
130
130
  new AlwaysAllowPrivacyPolicyRule<
131
131
  TestEntityFields,
132
132
  string,
@@ -142,7 +142,7 @@ class SimpleTestDenyDeleteEntityPrivacyPolicy extends EntityPrivacyPolicy<
142
142
  ViewerContext,
143
143
  SimpleTestDenyDeleteEntity
144
144
  > {
145
- protected readonly readRules = [
145
+ protected override readonly readRules = [
146
146
  new AlwaysAllowPrivacyPolicyRule<
147
147
  TestEntityFields,
148
148
  string,
@@ -150,7 +150,7 @@ class SimpleTestDenyDeleteEntityPrivacyPolicy extends EntityPrivacyPolicy<
150
150
  SimpleTestDenyDeleteEntity
151
151
  >(),
152
152
  ];
153
- protected readonly createRules = [
153
+ protected override readonly createRules = [
154
154
  new AlwaysAllowPrivacyPolicyRule<
155
155
  TestEntityFields,
156
156
  string,
@@ -158,7 +158,7 @@ class SimpleTestDenyDeleteEntityPrivacyPolicy extends EntityPrivacyPolicy<
158
158
  SimpleTestDenyDeleteEntity
159
159
  >(),
160
160
  ];
161
- protected readonly updateRules = [
161
+ protected override readonly updateRules = [
162
162
  new AlwaysAllowPrivacyPolicyRule<
163
163
  TestEntityFields,
164
164
  string,
@@ -166,7 +166,7 @@ class SimpleTestDenyDeleteEntityPrivacyPolicy extends EntityPrivacyPolicy<
166
166
  SimpleTestDenyDeleteEntity
167
167
  >(),
168
168
  ];
169
- protected readonly deleteRules = [
169
+ protected override readonly deleteRules = [
170
170
  new AlwaysDenyPrivacyPolicyRule<
171
171
  TestEntityFields,
172
172
  string,
@@ -66,19 +66,19 @@ class BlahEntityPrivacyPolicy extends EntityPrivacyPolicy<
66
66
  ViewerContext,
67
67
  BlahEntity
68
68
  > {
69
- protected readonly createRules = [
69
+ protected override readonly createRules = [
70
70
  new DenyIfNotOwnerPrivacyPolicyRule(),
71
71
  new AlwaysAllowPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
72
72
  ];
73
- protected readonly readRules = [
73
+ protected override readonly readRules = [
74
74
  new DenyIfNotOwnerPrivacyPolicyRule(),
75
75
  new AlwaysAllowPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
76
76
  ];
77
- protected readonly updateRules = [
77
+ protected override readonly updateRules = [
78
78
  new DenyIfNotOwnerPrivacyPolicyRule(),
79
79
  new AlwaysAllowPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
80
80
  ];
81
- protected readonly deleteRules = [
81
+ protected override readonly deleteRules = [
82
82
  new AlwaysDenyPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
83
83
  ];
84
84
  }
@@ -1,8 +1,12 @@
1
1
  import Entity from '../Entity';
2
2
  import { EntityCompanionDefinition } from '../EntityCompanionProvider';
3
3
  import EntityConfiguration from '../EntityConfiguration';
4
- import { UUIDField, EntityEdgeDeletionBehavior } from '../EntityFields';
4
+ import { EntityEdgeDeletionBehavior } from '../EntityFieldDefinition';
5
+ import { UUIDField } from '../EntityFields';
6
+ import { EntityTriggerMutationInfo, EntityMutationType } from '../EntityMutationInfo';
7
+ import { EntityMutationTrigger } from '../EntityMutationTriggerConfiguration';
5
8
  import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
9
+ import { EntityTransactionalQueryContext } from '../EntityQueryContext';
6
10
  import { CacheStatus } from '../internal/ReadThroughEntityCache';
7
11
  import AlwaysAllowPrivacyPolicyRule from '../rules/AlwaysAllowPrivacyPolicyRule';
8
12
  import TestViewerContext from '../testfixtures/TestViewerContext';
@@ -30,22 +34,141 @@ class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
30
34
  any,
31
35
  any
32
36
  > {
33
- protected readonly readRules = [
37
+ protected override readonly readRules = [
34
38
  new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
35
39
  ];
36
- protected readonly createRules = [
40
+ protected override readonly createRules = [
37
41
  new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
38
42
  ];
39
- protected readonly updateRules = [
43
+ protected override readonly updateRules = [
40
44
  new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
41
45
  ];
42
- protected readonly deleteRules = [
46
+ protected override readonly deleteRules = [
43
47
  new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
44
48
  ];
45
49
  }
46
50
 
47
51
  // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
48
52
  const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) => {
53
+ const triggerExecutionCounts = {
54
+ parent: 0,
55
+ child: 0,
56
+ grandchild: 0,
57
+ };
58
+
59
+ class ParentCheckInfoTrigger extends EntityMutationTrigger<
60
+ ParentFields,
61
+ string,
62
+ TestViewerContext,
63
+ ParentEntity
64
+ > {
65
+ async executeAsync(
66
+ _viewerContext: TestViewerContext,
67
+ _queryContext: EntityTransactionalQueryContext,
68
+ _entity: ParentEntity,
69
+ mutationInfo: EntityTriggerMutationInfo<ParentFields, string, TestViewerContext, ParentEntity>
70
+ ): Promise<void> {
71
+ if (mutationInfo.type !== EntityMutationType.DELETE) {
72
+ return;
73
+ }
74
+
75
+ if (mutationInfo.cascadingDeleteCause !== null) {
76
+ throw new Error('Parent entity should not have casade delete cause');
77
+ }
78
+
79
+ triggerExecutionCounts.parent++;
80
+ }
81
+ }
82
+
83
+ class ChildCheckInfoTrigger extends EntityMutationTrigger<
84
+ ChildFields,
85
+ string,
86
+ TestViewerContext,
87
+ ChildEntity
88
+ > {
89
+ async executeAsync(
90
+ _viewerContext: TestViewerContext,
91
+ _queryContext: EntityTransactionalQueryContext,
92
+ _entity: ChildEntity,
93
+ mutationInfo: EntityTriggerMutationInfo<ChildFields, string, TestViewerContext, ChildEntity>
94
+ ): Promise<void> {
95
+ if (mutationInfo.type !== EntityMutationType.DELETE) {
96
+ return;
97
+ }
98
+
99
+ if (mutationInfo.cascadingDeleteCause === null) {
100
+ throw new Error('Child entity should have casade delete cause');
101
+ }
102
+
103
+ const cascadingDeleteCauseEntity = mutationInfo.cascadingDeleteCause.entity;
104
+ if (!(cascadingDeleteCauseEntity instanceof ParentEntity)) {
105
+ throw new Error('Child entity should have casade delete cause entity of type ParentEntity');
106
+ }
107
+
108
+ const secondLevelCascadingDeleteCause =
109
+ mutationInfo.cascadingDeleteCause.cascadingDeleteCause;
110
+ if (secondLevelCascadingDeleteCause) {
111
+ throw new Error('Child entity should not have two-level casade delete cause');
112
+ }
113
+
114
+ triggerExecutionCounts.child++;
115
+ }
116
+ }
117
+
118
+ class GrandChildCheckInfoTrigger extends EntityMutationTrigger<
119
+ GrandChildFields,
120
+ string,
121
+ TestViewerContext,
122
+ GrandChildEntity
123
+ > {
124
+ async executeAsync(
125
+ _viewerContext: TestViewerContext,
126
+ _queryContext: EntityTransactionalQueryContext,
127
+ _entity: GrandChildEntity,
128
+ mutationInfo: EntityTriggerMutationInfo<
129
+ GrandChildFields,
130
+ string,
131
+ TestViewerContext,
132
+ GrandChildEntity
133
+ >
134
+ ): Promise<void> {
135
+ if (mutationInfo.type !== EntityMutationType.DELETE) {
136
+ return;
137
+ }
138
+
139
+ if (mutationInfo.cascadingDeleteCause === null) {
140
+ throw new Error('GrandChild entity should have cascade delete cause');
141
+ }
142
+
143
+ const cascadingDeleteCauseEntity = mutationInfo.cascadingDeleteCause.entity;
144
+ if (!(cascadingDeleteCauseEntity instanceof ChildEntity)) {
145
+ throw new Error(
146
+ 'GrandChild entity should have cascade delete cause entity of type ChildEntity'
147
+ );
148
+ }
149
+
150
+ const secondLevelCascadingDeleteCause =
151
+ mutationInfo.cascadingDeleteCause.cascadingDeleteCause;
152
+ if (!secondLevelCascadingDeleteCause) {
153
+ throw new Error('GrandChild entity should have two-level casade delete cause');
154
+ }
155
+
156
+ const secondLevelCascadingDeleteCauseEntity = secondLevelCascadingDeleteCause.entity;
157
+ if (!(secondLevelCascadingDeleteCauseEntity instanceof ParentEntity)) {
158
+ throw new Error(
159
+ 'GrandChild entity should have second level casade delete cause entity of type ParentEntity'
160
+ );
161
+ }
162
+
163
+ const thirdLevelCascadingDeleteCause = secondLevelCascadingDeleteCause.cascadingDeleteCause;
164
+ if (thirdLevelCascadingDeleteCause) {
165
+ throw new Error('GrandChild entity should not have three-level casade delete cause');
166
+ }
167
+
168
+ triggerExecutionCounts.grandchild++;
169
+ }
170
+ }
171
+
49
172
  class ParentEntity extends Entity<ParentFields, string, TestViewerContext> {
50
173
  static getCompanionDefinition(): EntityCompanionDefinition<
51
174
  ParentFields,
@@ -143,33 +266,45 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
143
266
  entityClass: ParentEntity,
144
267
  entityConfiguration: parentEntityConfiguration,
145
268
  privacyPolicyClass: TestEntityPrivacyPolicy,
269
+ mutationTriggers: () => ({
270
+ beforeDelete: [new ParentCheckInfoTrigger()],
271
+ afterDelete: [new ParentCheckInfoTrigger()],
272
+ }),
146
273
  });
147
274
 
148
275
  const childEntityCompanion = new EntityCompanionDefinition({
149
276
  entityClass: ChildEntity,
150
277
  entityConfiguration: childEntityConfiguration,
151
278
  privacyPolicyClass: TestEntityPrivacyPolicy,
279
+ mutationTriggers: () => ({
280
+ beforeDelete: [new ChildCheckInfoTrigger()],
281
+ afterDelete: [new ChildCheckInfoTrigger()],
282
+ }),
152
283
  });
153
284
 
154
285
  const grandChildEntityCompanion = new EntityCompanionDefinition({
155
286
  entityClass: GrandChildEntity,
156
287
  entityConfiguration: grandChildEntityConfiguration,
157
288
  privacyPolicyClass: TestEntityPrivacyPolicy,
289
+ mutationTriggers: () => ({
290
+ beforeDelete: [new GrandChildCheckInfoTrigger()],
291
+ afterDelete: [new GrandChildCheckInfoTrigger()],
292
+ }),
158
293
  });
159
294
 
160
295
  return {
161
296
  ParentEntity,
162
297
  ChildEntity,
163
298
  GrandChildEntity,
299
+ triggerExecutionCounts,
164
300
  };
165
301
  };
166
302
 
167
303
  describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
168
304
  describe('EntityEdgeDeletionBehavior.CASCADE_DELETE', () => {
169
305
  it('deletes', async () => {
170
- const { ParentEntity, ChildEntity, GrandChildEntity } = makeEntityClasses(
171
- EntityEdgeDeletionBehavior.CASCADE_DELETE
172
- );
306
+ const { ParentEntity, ChildEntity, GrandChildEntity, triggerExecutionCounts } =
307
+ makeEntityClasses(EntityEdgeDeletionBehavior.CASCADE_DELETE);
173
308
  const companionProvider = createUnitTestEntityCompanionProvider();
174
309
  const viewerContext = new TestViewerContext(companionProvider);
175
310
 
@@ -202,14 +337,20 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
202
337
  await expect(
203
338
  GrandChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(grandchild.getID())
204
339
  ).resolves.toBeNull();
340
+
341
+ // two calls for each trigger, one beforeDelete, one afterDelete
342
+ expect(triggerExecutionCounts).toMatchObject({
343
+ parent: 2,
344
+ child: 2,
345
+ grandchild: 2,
346
+ });
205
347
  });
206
348
  });
207
349
 
208
350
  describe('EntityEdgeDeletionBehavior.SET_NULL', () => {
209
351
  it('sets null', async () => {
210
- const { ParentEntity, ChildEntity, GrandChildEntity } = makeEntityClasses(
211
- EntityEdgeDeletionBehavior.SET_NULL
212
- );
352
+ const { ParentEntity, ChildEntity, GrandChildEntity, triggerExecutionCounts } =
353
+ makeEntityClasses(EntityEdgeDeletionBehavior.SET_NULL);
213
354
 
214
355
  const companionProvider = createUnitTestEntityCompanionProvider();
215
356
  const viewerContext = new TestViewerContext(companionProvider);
@@ -247,14 +388,21 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
247
388
  .enforcing()
248
389
  .loadByIDAsync(grandchild.getID());
249
390
  expect(loadedGrandchild.getField('parent_id')).toEqual(loadedChild.getID());
391
+
392
+ // two calls for only parent trigger, one beforeDelete, one afterDelete
393
+ // when using set null the descendants aren't deleted
394
+ expect(triggerExecutionCounts).toMatchObject({
395
+ parent: 2,
396
+ child: 0,
397
+ grandchild: 0,
398
+ });
250
399
  });
251
400
  });
252
401
 
253
402
  describe('EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE', () => {
254
403
  it('invalidates the cache', async () => {
255
- const { ParentEntity, ChildEntity, GrandChildEntity } = makeEntityClasses(
256
- EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE
257
- );
404
+ const { ParentEntity, ChildEntity, GrandChildEntity, triggerExecutionCounts } =
405
+ makeEntityClasses(EntityEdgeDeletionBehavior.CASCADE_DELETE_INVALIDATE_CACHE);
258
406
 
259
407
  const companionProvider = createUnitTestEntityCompanionProvider();
260
408
  const viewerContext = new TestViewerContext(companionProvider);
@@ -318,6 +466,13 @@ describe('EntityMutator.processEntityDeletionForInboundEdgesAsync', () => {
318
466
  await expect(
319
467
  GrandChildEntity.loader(viewerContext).enforcing().loadByIDNullableAsync(grandchild.getID())
320
468
  ).resolves.not.toBeNull();
469
+
470
+ // two calls for each trigger, one beforeDelete, one afterDelete
471
+ expect(triggerExecutionCounts).toMatchObject({
472
+ parent: 2,
473
+ child: 2,
474
+ grandchild: 2,
475
+ });
321
476
  });
322
477
  });
323
478
  });