Mockstore how to work with collections?

[sporto]

Reading the documentation for Mockstore I have no clue on how to work with collections there. e.g. how to add, remove and retrieve.

For example if I had a mutation that sets a user e.g.

store.set("User", "12", "name", "Sam")

Then in my resolver for users I want that user to be in the returned collection.

Could you give me some examples on how to worh with collections in Mockstore?
Thanks

[ardatan]

@alexstrat cc

[alexstrat]

If, in your schema, a given field returns a list of object type (or abstract type), then, in the MockStore, the corresponding field value will be an array of Refs, ie references to entities in the store. Therefore, working with lists means working with this array of Refs: get, set, push, filter, pop etc..

The default mock resolvers will interpret these Refs properly, and deep resolve the fields values.

With your example:

For the sake of clarity, I'm assuming we are working with such schema:

type User {
  id: ID!
  name: String!
}
type Query {
  users: [User!]!
}

Accessing, the value in the store for the query users:

store.get('Query', 'ROOT',  'users')
> [{ $ref: { key: 'abc-737dh-djdjd', typeName: 'User' } }, { $ref: { key: 'def-888dh-lklkl', typeName: 'User' } }]

Note, as explained in the doc, the root types (Query, Mutation), which necessarily have only one entity, will use the special store key ROOT to reference this only entity.

Adding an entity in the list:

const userRefs = store.get('Query', 'ROOT',  'users')
const newUser = store.get('User', '12'); // will return a ref for user entity with id='12'
const newUserRefs = [...userRefs, newUser];
store.set('Query', 'ROOT',  'users', newUserRefs);

store.get('Query', 'ROOT',  'users')
> [{ $ref: { key: 'abc-737dh-djdjd', typeName: 'User' } }, { $ref: { key: 'def-888dh-lklkl', typeName: 'User' } },  { $ref: { key: '12', typeName: 'User' } }]

Removing by name:

const userRefs = store.get('Query', 'ROOT',  'users')
const newUserRefs = userRefs.filter((ref) => store.get(ref, 'name') !== 'Sam')
store.set('Query', 'ROOT',  'users', newUserRefs);

@sporto Is this clearer with these examples? If so, what point was missing in the doc according to you?

---

Notes on improving the doc:

• Ref deserves a tsdoc, even simple
• MockStore recipes found in docs get and set may need better structuring so that it's quicker for reader to jump on what's needed
• it may be a good idea that the lib exports a constant RootTypesStoreKey = 'ROOT'

[sporto]

@alexstrat thanks for this. I will get back to you to tell if this is clear for me and I can make this work for us.

[sporto]

Thanks, another question please.

Let say that I have a client with users.
I want to store the users so I can return then in two ways:

query {
	viewer {
		client {
			users { ... }
		}
	}
}

Or

query {
	viewer {
		user(id: ...) {
			...
		}
	}
}

I also need to test mutations that add, modify and remove users.

What is the best way to go about this?

At the moment I have a function to add mock data to the store each time I reset the tests. I add the client to the mock store, but I'm unsure on how to add the users to the client in a way that is retrievable in the two ways shown above.

I'm trying something like this:

mockStore.set("Client", "Client/1", "name", "Acme")
let clientRef = mockStore.get("Client", "Client/1")

userFixture.forEach((user) => {
	mockStore.set("User", user.id, user)
})

// Then how do I get the users to put here?
// Fetch each by id from the store?
mockStore.set(clientRef, "users", ???)

[alexstrat]

I'm sorry, I barely understand your question. To make it clearer, I would:

• explicit the schema you are working with (or a sufficient subset of it)
• explicit exactly the mutations you want to "test" — even more because it is the core of your question. For instance, make them appear in the schema, and explicit how you use it and what you are expecting.
• explain the context or, better, de-contextualize your issue (ie expose it in a way that is independent of your context and that stays in the perimeter of graphql-tools/mock): you are mentioning "tests" and "reseting tests" without explaining what it refers to or what you test.
• (the best) provide a runnable and contained example of your problem, for instance using https://codesandbox.io/

Though, let me complete your example in a way that I'm hoping will help you:

userFixture.forEach((user) => {
  mockStore.set("User", user.id, user)
})
mockStore.set(clientRef, "users", userFixture.map((user) => mockStore.get("User", user.id)))

[chetankumar-dhandapani-by]

Very poor documentation. graphql tools is quite helpful. but when it comes to documentation, even the simplest things have very poor documentation.
in my store i got X,Y,Z types and if i want to add to X, there is no single documentation that tells me how to do that.

[Urigo]

@chetankumar-dhandapani-by are you able to help us improving the docs around the subject you found issues with?

[ViggoV]

How would one go about replicating the functionality of MockList in a mock resolver? I need the arguments, which have been stripped from mocks and I can't just return an empty array in a mock resolver. Mocks seem to be entirely ignored if resolvers are provided to addMocksToSchema