[REQUEST] Add batch grouping

Aperta
  • Qualcosa non va?
#359 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
graphql, javascript
Ambito
backend-api-design

Direzione di ricerca

Inizia dal costruttore di DataLoader e rivedi l’opzione esistente cacheKeyFn e il comportamento di batchLoadFn. Definisci come batchGroupFn debba suddividere le chiavi, quante chiamate a batchLoadFn debbano essere effettuate e come i risultati rimangano allineati alle chiavi di input; il lavoro è completato quando il comportamento di raggruppamento proposto è specificato e coperto dai test.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement

What problem are you trying to solve?

Handling different parameters in field resolvers with dataloader is tricky.

Let’s have this GraphQL schema:

type Order {
  orderId: Int
  status: String
}

type User {
  userId: Int
  name: String
  orders(status: String): [Order!]
}

type Query {
  GetUsers(search: String): [User!]
}

schema {
  query: Query
}

Then we have query:

query {
    GetUsers(search: "john") {
        userId
        name
        ordersNew: orders(status: "New") {
            orderId
            status
        }
        ordersCompleted: orders(status: "Completed") {
            orderId
            status
        }
    }
}

Here orders resolver with dataloader:

User: {
    orders: async ({ userId }, { status }) => {
      return await ordersLoader.load({userId: userId, status: status});
    }
  },

Here ordersLoader with batchLoadFn:

const ordersLoader = new DataLoader(
  async (params: { userId: number, status?: string }[]): Promise<Order[][]> => {
...
  }
);

In this batch loader function we need to get orders from a database. If we have all orders stored in one table we can have single query, like:

SELECT * from Orders WHERE userId IN (:userIds) and status IN (:statuses)

Then loop through params and return the result. No real issues, so far.

Now let’s think orders in different statuses can’t be queried with a single query. For example, “New” orders are in “Online” db and “Competed” are moved in some “Archive” db. So, we need to have 2 queries. Then we need to build results properly based on input params. It is doable but even with this simple example not so easy. In real life we may have multiple parameters and we need to handle all permutations of them.

Describe the solution you'd like

I suggest adding a new option to DataLoader constructor. Very similar to existing cacheKeyFn – batchGroupFn?: (key: K) => C;. Based on result of this function batchLoadFn function needs to be called as many times as many different results gives batchGroupFn. I.e. I want to group batches by input keys.

For my example it would be:

batchGroupFn: (key: { userId: number, status?: string }) => (key.status??"")

So for each status it will be separate call of batchLoadFn. It will simplify this function a lot.

Please let me know if this solution is feasible. Or maybe there is alternative/better solution?

Lingua principale
JavaScript
Stelle
13.4k
Fork
522
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di graphql/dataloader

Tutte le issue di graphql/dataloader

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.