instructure / cocache

JavaScript collection-aware memory storage library.

Cocache library and plugins by Instructure.

Refer to each package's readme under packages/.

Development

Install Lerna:

npm install lerna

Then set up the workspace:

./node_modules/.bin/lerna bootstrap

Then you can use its helpers to run tests and publish. For example:

./node_modules/.bin/lerna run test

Will run test for all the packages.

cocache's Issues

Removing canonical id from cache also removes incorrect records from collections.

This is seen when removing a record from the cache using cache.remove(id). An example cache/collection structure is below:

Prior to removal

• records are added to collections
  • parent record: cache.addToCollection({ dataContextId: 'foo' }, [{ id: '1' }]);
  • child record: cache.addToCollection({ dataContextId: 'foo', parentId: '1' }, [{ id: '2' }]);
• cache.getCollection({ dataContextId: 'foo' }); returns a single object: [{ id: '1' }].
• cache.getCollection({ dataContextId: 'foo', parentId: '1' }); returns a single object: [{ id: '2' }].

Removal

• cache.remove('2')

After removal

• cache.getCollection({ dataContextId: 'foo' }); returns an empty array.
  • this should return [{ id: '1' }]
• cache.getCollection({ dataContextId: 'foo', parentId: '1' }); returns an empty array as expected.

This issue can be worked around by simply resetting the collection and filtering out the desired record: cache.setCollection({ dataContextId: 'foo', parentId: '1' }, cache.getCollection(...).filter(x => x.id !== '2'));