Appointment Challenge

Implementation for appointment challenge

Install

Please run the "install" command first:

$ npm install

This will install all of the required dependencies, as stated in package.jsonfile.

How to use ?

To start the server, run:

$ npm run start

In order to see all the logs as well, run:

$ DEBUG=appointment-challenge:* npm run start

If you don't have local mongodb setup, you can use remote mongodb instance:

$ MONGO_MODE=remote npm run start

This way, all collections will be created on remote mongodb instance which is hosted by MongoLab.

Clean-up

There are also couple of clean-up scripts, which basically wipe the whole database created by the project.

In order to clean-up local mongodb database, run:

$ npm run drop-db-local

And in order to clean-up remote mongodb database, run:

$ npm run drop-db-remote

Minor /availability modifications

Beside regular query parameters that must be provided: begin, end and duration I have also added 2 more: useAllDayEvent and showIds.

These are, of course, optional parameters. Let me explain why I added them.

useAllDayEvent - the only valid value for this parameter is 'yes'. If it is provided, in-between requested days will be considered as whole days.

Example:

GET: /availability?begin=2018-08-12T10:00:00Z&end=2018-08-14T12:00:00Z&duration=30&useAllDayEvent=yes

Availability algorithm will then look for these days:

begin: 2018-08-12 10:00 end: 2018-08-12 23:59
begin: 2018-08-13 00:00 end: 2018-08-13 23:59
begin: 2018-08-14 00:00 end: 2018-08-14 12:00

Otherwise, the days will look like this:

begin: 2018-08-12 10:00 end: 2018-08-12 12:00
begin: 2018-08-13 10:00 end: 2018-08-13 12:00
begin: 2018-08-14 10:00 end: 2018-08-14 12:00

showIds - if provided with 'yes', it will display the doctor/room ids in the response as well, beside begin, end time. Also, the result will contain all combinations of time-slots, even if they are the same.

For example:

GET: /availability?begin=2018-08-12T10:00:00Z&end=2018-08-14T12:00:00Z&duration=30&showIds=yes

Result might look look like this:

[
    {
        "begin": "2018-08-12T12:00:00.000Z",
        "end": "2018-08-12T15:00:00.000Z",
        "doctorId": "doctor1",
        "roomId": "room1"
    },
    {
        "begin": "2018-08-12T12:00:00.000Z",
        "end": "2018-08-12T15:00:00.000Z",
        "doctorId": "doctor2",
        "roomId": "room2"
    },
    {
        "begin": "2018-08-12T12:00:00.000Z",
        "end": "2018-08-12T15:00:00.000Z",
        "doctorId": "doctor3",
        "roomId": "room4"
    }
]

As you can see, the same timestamp is returned twice, for every combination of doctor/room that was found.

However, default behavior (showIds="falsy value") will only present unique timestamps, no matter how many combinations of doctor/room there is:

[
    {
        "begin": "2018-08-12T12:00:00.000Z",
        "end": "2018-08-12T15:00:00.000Z",
    }
]

I've enabled this to make testing/debugging easier, but it can be easily disabled.