commit 81ce770ba1e2f498e6dda866c5fbc97e0305bdec · kitten.sh/urql

.changeset/spicy-comics-shave.md

···

       1
       +
       ---

     

       2
       +
       '@urql/exchange-graphcache': patch

     

       3
       +
       ---

     

       4
       +
       

     

       5
       +
       Fix reference equality not being preserved. This is a fix on top of [#3165](https://github.com/urql-graphql/urql/pull/3165), and was previously not addressed to avoid having to test for corner cases that are hard to cover. If you experience issues with this fix, please let us know.

+94 -2

exchanges/graphcache/src/operations/query.test.ts

···

       363
        
           expect(previousData).toHaveProperty('todos.0.textB', 'old');

     

       364
        
         });

     

       365
        
       

     

       366
       -
         it('should keep references stable', () => {

     

       367
        
           const QUERY = gql`

     

       368
        
             query todos {

     

       369
        
               __typename

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       370
        
               todos {

     

       371
        
                 __typename

     

       372
        
                 id

     
···

       383
        
               {

     

       384
        
                 __typename: 'Todo',

     

       385
        
                 id: '0',

     

       0
        
       
     

       386
        
               },

     

       387
        
               {

     

       388
        
                 __typename: 'Todo',

     

       389
        
                 id: '1',

     

       0
        
       
     

       390
        
               },

     

       391
        
               {

     

       392
        
                 __typename: 'Todo',

     

       393
        
                 id: '2',

     

       0
        
       
     

       394
        
               },

     

       395
        
             ],

     

       396
        
             __typename: 'query_root',

     
···

       405
        
               todos: [

     

       406
        
                 {

     

       407
        
                   __typename: 'Todo',

     

       408
       -
                   id: 'prev-0',

     

       0
        
       
     

       409
        
                 },

     

       410
        
                 {

     

       411
        
                   __typename: 'Todo',

     

       412
        
                   id: '1',

     

       0
        
       
     

       413
        
                 },

     

       414
        
                 {

     

       415
        
                   __typename: 'Todo',

     

       416
        
                   id: '2',

     

       0
        
       
     

       417
        
                 },

     

       418
        
               ],

     

       419
        
               __typename: 'query_root',

     
···

       426
        
           expect(prevData.todos[0]).toBe(data.todos[0]);

     

       427
        
           expect(prevData.todos[1]).toBe(data.todos[1]);

     

       428
        
           expect(prevData.todos[2]).toBe(data.todos[2]);

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       429
        
         });

     

       430
        
       });

···

       363
        
           expect(previousData).toHaveProperty('todos.0.textB', 'old');

     

       364
        
         });

     

       365
        
       

     

       366
       +
         it('should keep references stable (1)', () => {

     

       367
        
           const QUERY = gql`

     

       368
        
             query todos {

     

       369
        
               __typename

     

       370
       +
               todos {

     

       371
       +
                 __typename

     

       372
       +
                 test

     

       373
       +
               }

     

       374
        
               todos {

     

       375
        
                 __typename

     

       376
        
                 id

     
···

       387
        
               {

     

       388
        
                 __typename: 'Todo',

     

       389
        
                 id: '0',

     

       390
       +
                 test: '0',

     

       391
        
               },

     

       392
        
               {

     

       393
        
                 __typename: 'Todo',

     

       394
        
                 id: '1',

     

       395
       +
                 test: '1',

     

       396
        
               },

     

       397
        
               {

     

       398
        
                 __typename: 'Todo',

     

       399
        
                 id: '2',

     

       400
       +
                 test: '2',

     

       401
        
               },

     

       402
        
             ],

     

       403
        
             __typename: 'query_root',

     
···

       412
        
               todos: [

     

       413
        
                 {

     

       414
        
                   __typename: 'Todo',

     

       415
       +
                   id: '0',

     

       416
       +
                   test: 'prev-0',

     

       417
        
                 },

     

       418
        
                 {

     

       419
        
                   __typename: 'Todo',

     

       420
        
                   id: '1',

     

       421
       +
                   test: '1',

     

       422
        
                 },

     

       423
        
                 {

     

       424
        
                   __typename: 'Todo',

     

       425
        
                   id: '2',

     

       426
       +
                   test: '2',

     

       427
        
                 },

     

       428
        
               ],

     

       429
        
               __typename: 'query_root',

     
···

       436
        
           expect(prevData.todos[0]).toBe(data.todos[0]);

     

       437
        
           expect(prevData.todos[1]).toBe(data.todos[1]);

     

       438
        
           expect(prevData.todos[2]).toBe(data.todos[2]);

     

       439
       +
           expect(prevData.todos).toBe(data.todos);

     

       440
       +
           expect(prevData).toBe(data);

     

       441
       +
         });

     

       442
       +
       

     

       443
       +
         it('should keep references stable (negative test)', () => {

     

       444
       +
           const QUERY = gql`

     

       445
       +
             query todos {

     

       446
       +
               __typename

     

       447
       +
               todos {

     

       448
       +
                 __typename

     

       449
       +
                 id

     

       450
       +
               }

     

       451
       +
               todos {

     

       452
       +
                 __typename

     

       453
       +
                 test

     

       454
       +
               }

     

       455
       +
             }

     

       456
       +
           `;

     

       457
       +
       

     

       458
       +
           const store = new Store({

     

       459
       +
             schema: alteredRoot,

     

       460
       +
           });

     

       461
       +
       

     

       462
       +
           const expected = {

     

       463
       +
             todos: [

     

       464
       +
               {

     

       465
       +
                 __typename: 'Todo',

     

       466
       +
                 id: '0',

     

       467
       +
                 test: '0',

     

       468
       +
               },

     

       469
       +
               {

     

       470
       +
                 __typename: 'Todo',

     

       471
       +
                 id: '1',

     

       472
       +
                 test: '1',

     

       473
       +
               },

     

       474
       +
               {

     

       475
       +
                 __typename: 'Todo',

     

       476
       +
                 id: '2',

     

       477
       +
                 test: '2',

     

       478
       +
               },

     

       479
       +
             ],

     

       480
       +
             __typename: 'query_root',

     

       481
       +
           };

     

       482
       +
       

     

       483
       +
           write(store, { query: QUERY }, expected);

     

       484
       +
       

     

       485
       +
           const prevData = query(

     

       486
       +
             store,

     

       487
       +
             { query: QUERY },

     

       488
       +
             {

     

       489
       +
               todos: [

     

       490
       +
                 {

     

       491
       +
                   __typename: 'Todo',

     

       492
       +
                   id: '0',

     

       493
       +
                   test: 'prev-0',

     

       494
       +
                 },

     

       495
       +
                 {

     

       496
       +
                   __typename: 'Todo',

     

       497
       +
                   id: '1',

     

       498
       +
                   test: '1',

     

       499
       +
                 },

     

       500
       +
                 {

     

       501
       +
                   __typename: 'Todo',

     

       502
       +
                   id: '2',

     

       503
       +
                   test: '2',

     

       504
       +
                 },

     

       505
       +
               ],

     

       506
       +
               __typename: 'query_root',

     

       507
       +
             }

     

       508
       +
           ).data as any;

     

       509
       +
       

     

       510
       +
           expected.todos[0].test = 'x';

     

       511
       +
           write(store, { query: QUERY }, expected);

     

       512
       +
       

     

       513
       +
           const data = query(store, { query: QUERY }, prevData).data as any;

     

       514
       +
           expect(data).toEqual(expected);

     

       515
       +
       

     

       516
       +
           expect(prevData.todos[1]).toBe(data.todos[1]);

     

       517
       +
           expect(prevData.todos[2]).toBe(data.todos[2]);

     

       518
       +
           expect(prevData.todos[0]).not.toBe(data.todos[0]);

     

       519
       +
           expect(prevData.todos).not.toBe(data.todos);

     

       520
       +
           expect(prevData).not.toBe(data);

     

       521
        
         });

     

       522
        
       });

+7 -7

exchanges/graphcache/src/operations/query.ts

···

       523
        
           const _isListNullable = store.schema

     

       524
        
             ? isListNullable(store.schema, typename, fieldName)

     

       525
        
             : false;

     

       526
       -
           const data = new Array(result.length);

     

       527
        
           let hasChanged =

     

       528
       -
             !isOwnedData ||

     

       529
        
             !Array.isArray(prevData) ||

     

       530
        
             result.length !== prevData.length;

     

       531
        
           for (let i = 0, l = result.length; i < l; i++) {

     
···

       561
        
         } else if (!isOwnedData && prevData === null) {

     

       562
        
           return null;

     

       563
        
         } else if (isDataOrKey(result)) {

     

       564
       -
           const data = (prevData || InMemoryData.makeData()) as Data;

     

       565
        
           return typeof result === 'string'

     

       566
        
             ? readSelection(ctx, result, select, data)

     

       567
        
             : readSelection(ctx, key, select, data, result);

     
···

       592
        
           const _isListNullable = store.schema

     

       593
        
             ? isListNullable(store.schema, typename, fieldName)

     

       594
        
             : false;

     

       595
       -
           const newLink = new Array(link.length);

     

       596
        
           let hasChanged =

     

       597
       -
             !isOwnedData ||

     

       598
        
             !Array.isArray(prevData) ||

     

       599
       -
             newLink.length !== prevData.length;

     

       600
        
           for (let i = 0, l = link.length; i < l; i++) {

     

       601
        
             // Add the current index to the walked path before reading the field's value

     

       602
        
             ctx.__internal.path.push(i);

     
···

       632
        
           ctx,

     

       633
        
           link,

     

       634
        
           select,

     

       635
       -
           (prevData || InMemoryData.makeData()) as Data

     

       636
        
         );

     

       637
        
       };

     

       638

···

       523
        
           const _isListNullable = store.schema

     

       524
        
             ? isListNullable(store.schema, typename, fieldName)

     

       525
        
             : false;

     

       526
       +
           const data = InMemoryData.makeData(prevData, true);

     

       527
        
           let hasChanged =

     

       528
       +
             InMemoryData.currentForeignData ||

     

       529
        
             !Array.isArray(prevData) ||

     

       530
        
             result.length !== prevData.length;

     

       531
        
           for (let i = 0, l = result.length; i < l; i++) {

     
···

       561
        
         } else if (!isOwnedData && prevData === null) {

     

       562
        
           return null;

     

       563
        
         } else if (isDataOrKey(result)) {

     

       564
       +
           const data = (prevData || InMemoryData.makeData(prevData)) as Data;

     

       565
        
           return typeof result === 'string'

     

       566
        
             ? readSelection(ctx, result, select, data)

     

       567
        
             : readSelection(ctx, key, select, data, result);

     
···

       592
        
           const _isListNullable = store.schema

     

       593
        
             ? isListNullable(store.schema, typename, fieldName)

     

       594
        
             : false;

     

       595
       +
           const newLink = InMemoryData.makeData(prevData, true);

     

       596
        
           let hasChanged =

     

       597
       +
             InMemoryData.currentForeignData ||

     

       598
        
             !Array.isArray(prevData) ||

     

       599
       +
             link.length !== prevData.length;

     

       600
        
           for (let i = 0, l = link.length; i < l; i++) {

     

       601
        
             // Add the current index to the walked path before reading the field's value

     

       602
        
             ctx.__internal.path.push(i);

     
···

       632
        
           ctx,

     

       633
        
           link,

     

       634
        
           select,

     

       635
       +
           (prevData || InMemoryData.makeData(prevData)) as Data

     

       636
        
         );

     

       637
        
       };

     

       638

+17 -8

exchanges/graphcache/src/store/data.ts

···

       8
        
         SerializedEntries,

     

       9
        
         Dependencies,

     

       10
        
         OperationType,

     

       0
        
       
     

       11
        
         Data,

     

       12
        
       } from '../types';

     

       13
        
       

     
···

       59
        
         storage: StorageAdapter | null;

     

       60
        
       }

     

       61
        
       

     

       62
       -
       let currentOwnership: null | WeakSet<Data> = null;

     

       63
       -
       let currentDataMapping: null | WeakMap<Data, Data> = null;

     

       64
        
       let currentData: null | InMemoryData = null;

     

       65
        
       let currentOptimisticKey: null | number = null;

     

       66
        
       export let currentOperation: null | OperationType = null;

     
···

       68
        
       export let currentForeignData = false;

     

       69
        
       export let currentOptimistic = false;

     

       70
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       71
        
       /** Creates a new data object unless it's been created in this data run */

     

       72
       -
       export const makeData = (data?: Data): Data => {

     

       73
       -
         let newData: Data;

     

       74
        
         if (data) {

     

       75
        
           if (currentOwnership!.has(data)) return data;

     

       76
       -
           newData = currentDataMapping!.get(data) || ({} as Data);

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       77
        
           currentDataMapping!.set(data, newData);

     

       78
       -
         } else {

     

       79
       -
           newData = {} as Data;

     

       80
        
         }

     

       81
        
       

     

       82
        
         currentOwnership!.add(newData);

     

       83
        
         return newData;

     

       84
       -
       };

     

       85
        
       

     

       86
        
       export const ownsData = (data?: Data): boolean =>

     

       87
        
         !!data && currentOwnership!.has(data);

···

       8
        
         SerializedEntries,

     

       9
        
         Dependencies,

     

       10
        
         OperationType,

     

       11
       +
         DataField,

     

       12
        
         Data,

     

       13
        
       } from '../types';

     

       14
        
       

     
···

       60
        
         storage: StorageAdapter | null;

     

       61
        
       }

     

       62
        
       

     

       63
       +
       let currentOwnership: null | WeakSet<any> = null;

     

       64
       +
       let currentDataMapping: null | WeakMap<any, any> = null;

     

       65
        
       let currentData: null | InMemoryData = null;

     

       66
        
       let currentOptimisticKey: null | number = null;

     

       67
        
       export let currentOperation: null | OperationType = null;

     
···

       69
        
       export let currentForeignData = false;

     

       70
        
       export let currentOptimistic = false;

     

       71
        
       

     

       72
       +
       export function makeData(data: DataField | void, isArray?: false): Data;

     

       73
       +
       export function makeData(data: DataField | void, isArray: true): DataField[];

     

       74
       +
       

     

       75
        
       /** Creates a new data object unless it's been created in this data run */

     

       76
       +
       export function makeData(data?: DataField | void, isArray?: boolean) {

     

       77
       +
         let newData: Data | Data[] | undefined;

     

       78
        
         if (data) {

     

       79
        
           if (currentOwnership!.has(data)) return data;

     

       80
       +
           newData = currentDataMapping!.get(data) as any;

     

       81
       +
         }

     

       82
       +
       

     

       83
       +
         if (newData == null) {

     

       84
       +
           newData = (isArray ? [] : {}) as any;

     

       85
       +
         }

     

       86
       +
       

     

       87
       +
         if (data) {

     

       88
        
           currentDataMapping!.set(data, newData);

     

       0
        
       
     

       0
        
       
     

       89
        
         }

     

       90
        
       

     

       91
        
         currentOwnership!.add(newData);

     

       92
        
         return newData;

     

       93
       +
       }

     

       94
        
       

     

       95
        
       export const ownsData = (data?: Data): boolean =>

     

       96
        
         !!data && currentOwnership!.has(data);

packages/site/vercel.json

···

       1
       +
       {

     

       2
       +
         "github": {

     

       3
       +
           "silent": true

     

       4
       +
         }

     

       5
       +
       }