keystonejs/keystone-classic

Deprecate List.prototype.paginate

Open

#4126 opened on Mar 20, 2017

View on GitHub
 (2 comments) (2 reactions) (0 assignees)JavaScript (14,656 stars) (2,288 forks)batch import
help wanted

Description

Basically, this is too opinionated and fragile for us to continue supporting.

It used to work well with mongoose 3 and callback patterns but with promises now more popular thanks to async/await, and issues where the find() and count() queries may get out of sync with .where() / etc chaining, I think the best option is to deprecate the whole thing and let users deal with it however is most appropriate for their specific use-case.

Let's add a deprecation warning on first use to Keystone 4, and remove in the next major.

Contributor guide

Tech stack
javascriptnodejs
Domain
backend
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptKeystone basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Locate the `List.prototype.paginate` method in the Keystone source code (likely in the models directory). Add a deprecation warning on first use using `console.warn`. Review issue comments for any additional context.