remove generateId from crud plugin as it's generally unreliable, hard to make work reliably, and is not really a pattern we want to encourage

Author: jmeistrich

src/sync-plugins/crud.ts

@@ -85,7 +85,6 @@ export interface SyncedCrudPropsBase<TRemote extends object, TLocal = TRemote>
     fieldDeletedList?: string;
     updatePartial?: boolean;
     changesSince?: 'all' | 'last-sync';
-    generateId?: () => string | number;
     subscribe?: (params: SyncedSubscribeParams<TRemote[]>) => (() => void) | void;
     waitForSet?:
         | ((params: WaitForSetCrudFnParams<TLocal>) => any)
@@ -115,13 +114,6 @@ function transformOut<T1, T2>(data: T1, transform: undefined | ((value: T1) => T
     return transform ? transform(clone(data)) : data;
 }
 
-function ensureId(obj: any, fieldId: string, generateId: () => string | number) {
-    if (!obj[fieldId]) {
-        obj[fieldId] = generateId();
-    }
-    return obj[fieldId];
-}
-
 function computeLastSync(data: any[], fieldUpdatedAt: string | undefined, fieldCreatedAt: string | undefined) {
     let newLastSync = 0;
     for (let i = 0; i < data.length; i++) {
@@ -238,7 +230,6 @@ export function syncedCrud<TRemote extends object, TLocal = TRemote, TAsOption e
         onSaved,
         mode: modeParam,
         changesSince,
-        generateId,
         waitForSet: waitForSetParam,
         retry,
         ...rest
@@ -407,11 +398,8 @@ export function syncedCrud<TRemote extends object, TLocal = TRemote, TAsOption e
                       const { path, prevAtPath, valueAtPath, pathTypes } = change;
                       if (asType === 'value') {
                           if (value) {
-                              let id = value?.[fieldId];
+                              const id = value?.[fieldId];
                               let isCreate = fieldCreatedAt ? !value[fieldCreatedAt!] : !prevAtPath;
-                              if (isNullOrUndefined(id) && generateId) {
-                                  id = ensureId(value, fieldId, generateId);
-                              }
                               if (!isNullOrUndefined(id)) {
                                   changesById.set(id, change);
                                   if (pendingCreates.has(id)) {
@@ -509,9 +497,6 @@ export function syncedCrud<TRemote extends object, TLocal = TRemote, TAsOption e
                                         ? !item[fieldUpdatedAt] && !prev?.[fieldCreatedAt!]
                                         : isNullOrUndefined(prev));
                               if (isCreate) {
-                                  if (generateId) {
-                                      ensureId(item, fieldId, generateId);
-                                  }
                                   if (!item[fieldId]) {
                                       console.error('[legend-state]: added item without an id');
                                   }

tests/crud.test.ts

@@ -2418,13 +2418,12 @@ describe('onSaved', () => {
                     created = clone(input);
                     return input;
                 },
-                generateId: () => 'id1',
             }),
         );
 
         await promiseTimeout(1);
 
-        obs.id1.set({ test: 'hello', id: undefined as unknown as string });
+        obs.id1.set({ test: 'hello', id: 'id1' });
 
         await promiseTimeout(1);
 
@@ -2633,7 +2632,6 @@ describe('onSaved', () => {
                 create: async (input: BasicValue) => {
                     return input;
                 },
-                generateId: () => 'id1',
                 onSaved(params) {
                     saved = params.saved;
                 },
@@ -2642,7 +2640,7 @@ describe('onSaved', () => {
 
         await promiseTimeout(1);
 
-        obs.id1.set({ test: 'hello', id: undefined as unknown as string });
+        obs.id1.set({ test: 'hello', id: 'id1' });
 
         await promiseTimeout(1);