@expo/entity 0.48.0 → 0.50.0

package/src/errors/EntityError.ts

@@ -1,11 +1,17 @@
 import ES6Error from 'es6-error';
 
+/**
+ * The state of an entity error, indicating whether it may be transient/retryable.
+ */
 export enum EntityErrorState {
   UNKNOWN,
   TRANSIENT,
   PERMANENT,
 }
 
+/**
+ * Error code for an entity error. Each error code should map to a specific class of Entity error.
+ */
 export enum EntityErrorCode {
   ERR_ENTITY_NOT_AUTHORIZED = 'ERR_ENTITY_NOT_AUTHORIZED',
   ERR_ENTITY_NOT_FOUND = 'ERR_ENTITY_NOT_FOUND',
@@ -17,9 +23,17 @@ export enum EntityErrorCode {
   ERR_ENTITY_DATABASE_ADAPTER_FOREIGN_KEY_CONSTRAINT = 'ERR_ENTITY_DATABASE_ADAPTER_FOREIGN_KEY_CONSTRAINT',
   ERR_ENTITY_DATABASE_ADAPTER_NOT_NULL_CONSTRAINT = 'ERR_ENTITY_DATABASE_ADAPTER_NOT_NULL_CONSTRAINT',
   ERR_ENTITY_DATABASE_ADAPTER_UNIQUE_CONSTRAINT = 'ERR_ENTITY_DATABASE_ADAPTER_UNIQUE_CONSTRAINT',
+  ERR_ENTITY_DATABASE_ADAPTER_EXCESSIVE_INSERT_RESULT = 'ERR_ENTITY_DATABASE_ADAPTER_EXCESSIVE_INSERT_RESULT',
+  ERR_ENTITY_DATABASE_ADAPTER_EMPTY_INSERT_RESULT = 'ERR_ENTITY_DATABASE_ADAPTER_EMPTY_INSERT_RESULT',
+  ERR_ENTITY_DATABASE_ADAPTER_EXCESSIVE_UPDATE_RESULT = 'ERR_ENTITY_DATABASE_ADAPTER_EXCESSIVE_UPDATE_RESULT',
+  ERR_ENTITY_DATABASE_ADAPTER_EMPTY_UPDATE_RESULT = 'ERR_ENTITY_DATABASE_ADAPTER_EMPTY_UPDATE_RESULT',
+  ERR_ENTITY_DATABASE_ADAPTER_EXCESSIVE_DELETE_RESULT = 'ERR_ENTITY_DATABASE_ADAPTER_EXCESSIVE_DELETE_RESULT',
   ERR_ENTITY_CACHE_ADAPTER_TRANSIENT = 'ERR_ENTITY_CACHE_ADAPTER_TRANSIENT',
 }
 
+/**
+ * Base class for all known errors thrown by the entity system.
+ */
 export abstract class EntityError extends ES6Error {
   public abstract readonly state: EntityErrorState;
   public abstract readonly code: EntityErrorCode;

package/src/errors/EntityInvalidFieldValueError.ts

@@ -4,6 +4,9 @@ import { ReadonlyEntity } from '../ReadonlyEntity';
 import { ViewerContext } from '../ViewerContext';
 import { EntityError, EntityErrorCode, EntityErrorState } from './EntityError';
 
+/**
+ * Error thrown when an entity field has an invalid value, either during load or mutation.
+ */
 export class EntityInvalidFieldValueError<
   TFields extends Record<string, any>,
   TIDField extends keyof NonNullable<Pick<TFields, TSelectedFields>>,

package/src/errors/EntityNotAuthorizedError.ts

@@ -3,6 +3,9 @@ import { ReadonlyEntity } from '../ReadonlyEntity';
 import { ViewerContext } from '../ViewerContext';
 import { EntityError, EntityErrorCode, EntityErrorState } from './EntityError';
 
+/**
+ * Error thrown when viewer context is not authorized to perform an action on an entity.
+ */
 export class EntityNotAuthorizedError<
   TFields extends Record<string, any>,
   TIDField extends keyof NonNullable<Pick<TFields, TSelectedFields>>,

package/src/errors/EntityNotFoundError.ts

@@ -31,6 +31,9 @@ type EntityNotFoundOptions<
   fieldValue: TFields[N];
 };
 
+/**
+ * Error thrown when an entity is not found during certain load methods.
+ */
 export class EntityNotFoundError<
   TFields extends Record<string, any>,
   TIDField extends keyof NonNullable<Pick<TFields, TSelectedFields>>,

package/src/utils/__testfixtures__/StubDatabaseAdapter.ts

@@ -234,7 +234,13 @@ export class StubDatabaseAdapter<
     const objectIndex = objectCollection.findIndex((obj) => {
       return obj[tableIdField] === id;
     });
-    invariant(objectIndex >= 0, 'should exist');
+
+    // SQL updates to a nonexistent row succeed but affect 0 rows,
+    // mirror that behavior here for better test simulation
+    if (objectIndex < 0) {
+      return [];
+    }
+
     objectCollection[objectIndex] = {
       ...objectCollection[objectIndex],
       ...object,
@@ -253,9 +259,13 @@ export class StubDatabaseAdapter<
     const objectIndex = objectCollection.findIndex((obj) => {
       return obj[tableIdField] === id;
     });
+
+    // SQL deletes to a nonexistent row succeed and affect 0 rows,
+    // mirror that behavior here for better test simulation
     if (objectIndex < 0) {
       return 0;
     }
+
     objectCollection.splice(objectIndex, 1);
     return 1;
   }