apollographql / apollographql/fullstack-tutorial

Launches pagination implementation is a bad example for reference

Aperta
#78 1 commento 1 reazione 0 assegnatari Vedi su GitHub
Lingua principale
TypeScript
Stelle
1.2k
Fork
808
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

The GraphQL server-side cursor pagination example should be discarded. While the intent of the `paginateResults` function in `final/server/src/utils.js` is good, there are a number of significant flaws with this implementation.

The lowest hanging fruit is that there is a line of code at the end of the function - `results.slice(cursorIndex >= 0 ? cursorIndex + 1 : 0, cursorIndex >= 0);` which is unreachable.

However, the most egregious error is how the `launches` function is defined in `final/server/src/resolvers.js` - which gives the impression that data is being paged responsibly. It is **not**

Every time pagination is invoked, the API request loads ALL THE DATA from the API and then passes it to the pagination function. For the example SpaceX data, there are approximately 76 results that get loaded and then processed to return the 20 results the user is expecting:

```
Query: {
launches: async (_, { pageSize = 20, after }, { dataSources }) => {
const allLaunches = await dataSources.launchAPI.getAllLaunches();
// we want these in reverse chronological order
allLaunches.reverse();

const launches = paginateResults({
after,
pageSize,
results: allLaunches,
});

return {
launches,
cursor: launches.length ? launches[launches.length - 1].cursor : null,
// if the cursor of the end of the paginated results is the same as the
// last item in _all_ results, then there are no more results after this
hasMore: launches.length
? launches[launches.length - 1].cursor !==
allLaunches[allLaunches.length - 1].cursor
: false,
};
},
...
```

If that API endpoint were to return a massive amount of data (imagine 40,000 results), this resolver would load all 40,000 results and then find 20 to return. When the user would click load more, all 40,000 results would be loaded into memory again and then the next 20 results would be returned...effectively processing 80,000 results to display 40 to the user. EEK!

This is definitely something that should be revisited. Imagine a scenario with 30 users following a simple workflow of viewing the first 20 results and then loading an additional 20 results.

Additionally, if the result set grew (imagine 40,001 records), the newest record would never be displayed to the user because it would have been in a spot the cursor presumably has already visited, right?

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Leggi final/server/src/utils.js e final/server/src/resolvers.js, concentrandoti su paginateResults e Query.launches; traccia il modo in cui getAllLaunches fornisce i dati per ogni richiesta. Definisci il comportamento previsto della paginazione e verifica che la prima pagina e quelle successive preservino la semantica di cursor, pageSize, ordering e hasMore senza caricare l’intero insieme dei risultati.

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

Valutazione

Stack tecnologico
graphql, javascript, node.js
Ambito
backend-api-design, performance
Tipo di issue
Refactoring
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
30/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.