CreatedAt search with date range in listHandler #296

alsabbahy · 2022-05-12T13:16:05Z

Hello, I've been trying to add the dateRange to rest-hapi querying. And I was wondering if you've had already implemented it or it exists to query with date range for field attribute like "createdAt".

bitbay · 2022-05-12T17:20:59Z

Isn't this akin to what's mentioned at mongoose tutorials on working with dates - querying?

Users.find({ createdAt: { $gte: '2009-01-02', $lte: '2022-05-12' } }).
  then(users => {
    //
});

EDIT: My bad, was missing the "in listHandler" part from the title. 🤦

JKHeadley · 2022-05-12T23:27:13Z

@alsabbahy @bitbay Hi! Thanks for the great questions. @bitbay is on the right track. This is not yet a feature included out-of-the-box, however there are some tricks that should get you what you need without too much effort.

We can add this query option by including a dateRange model property (with appropriate validation properties), then handling query parameters for that property in middleware.

For example:

example-model.js

...
var Schema = new mongoose.Schema(
    {
      ...
      dateRange: {
        type: Types.String,
        allowOnCreate: false,
        allowOnUpdate: false,
      }
    },
    { collection: modelName }
  );
...

Schema.statics = {
    collectionName: modelName,
    routeOptions: {
    ...
      list: {
        pre: async function (query, request, Log) {
          if (query.dateRange) {
            let dateRange
            try {
              dateRange = JSON.parse(query.dateRange)
            } catch {
              throw Boom.badRequest('Invalid JSON for \'dateRange\'');
            }
            const validate = RestHapi.joi.object({
              start: RestHapi.joi.string().required(),
              end: RestHapi.joi.string().required(),
            })
            const test = validate.validate(dateRange)
            if (test.error) {
              throw Boom.badRequest(test.error)
            }
            query.$where = `{ 
              "createdAt": {
                "$gte": "${dateRange.start}",
                "$lte": "${dateRange.end}"
              }
            }`
            delete query.dateRange
          }
          return query
        }
      }
    ...

This would allow you to query a dateRange based on createdAt for this model using a query string such as:

http://localhost:8080/example?dateRange={"start": "2020-04-11T22:26:26.564Z", "end": "2020-04-11T22:40:20.266Z"}

You could easily modify this to accept other properties to compare against other than createdAt. Note that if you would like to apply this functionality to multiple models I believe you could alternatively implement a custom policy. If you would like an example of this let me know.

Hope this helps!

alsabbahy · 2022-05-13T10:48:01Z

@JKHeadley thanks for the quick reply.
Your example is very helpful, I'll try it and will try to make a policy for all models.
I'll let you know if I need help with policy.

alsabbahy mentioned this issue May 15, 2022

Added support for querying "createdAt" date range in listHandler #297

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CreatedAt search with date range in listHandler #296

CreatedAt search with date range in listHandler #296

CreatedAt search with date range in listHandler #296

CreatedAt search with date range in listHandler #296

Comments