mongo/jstests/aggregation/expressions/date_to_string.js

load("jstests/aggregation/extras/utils.js");  // For assertErrorCode

(function() {
    "use strict";

    const coll = db.date_to_string;
    coll.drop();

    /* --------------------------------------------------------------------------------------- */

    assert.writeOK(coll.insert([
        {_id: 0, date: new ISODate("2017-07-04T14:56:42.911Z"), tz: "UTC"},
        {_id: 1, date: new ISODate("2017-07-04T14:56:42.911Z"), tz: "Europe/London"},
        {_id: 2, date: new ISODate("2017-07-04T14:56:42.911Z"), tz: "America/New_York"},
        {_id: 3, date: new ISODate("2017-07-04T14:56:42.911Z"), tz: "Australia/Eucla"},
        {_id: 4, date: new ISODate("2017-07-04T14:56:42.911Z"), tz: "Asia/Kathmandu"},
        {_id: 5, date: new ISODate("1935-07-10T11:36:37.133Z"), tz: "Europe/Amsterdam"},
        {_id: 6, date: new ISODate("1900-07-10T11:41:22.418Z"), tz: "America/Caracas"},
    ]));

    assert.eq(
        [
          {_id: 0, date: "2017-07-04 14:56:42 +0000 (0 minutes)"},
          {_id: 1, date: "2017-07-04 15:56:42 +0100 (60 minutes)"},
          {_id: 2, date: "2017-07-04 10:56:42 -0400 (-240 minutes)"},
          {_id: 3, date: "2017-07-04 23:41:42 +0845 (525 minutes)"},
          {_id: 4, date: "2017-07-04 20:41:42 +0545 (345 minutes)"},
          {_id: 5, date: "1935-07-10 12:56:09 +0119 (79 minutes)"},
          {_id: 6, date: "1900-07-10 07:13:42 -0427 (-267 minutes)"},
        ],
        coll.aggregate([
                {
                  $project: {
                      date: {
                          $dateToString: {
                              format: "%Y-%m-%d %H:%M:%S %z (%Z minutes)",
                              date: "$date",
                              timezone: "$tz"
                          }
                      }
                  }
                },
                {$sort: {_id: 1}}
            ])
            .toArray());

    /* --------------------------------------------------------------------------------------- */
    coll.drop();

    assert.writeOK(coll.insert([
        {_id: 0, date: new ISODate("2017-01-04T15:08:51.911Z")},
        {_id: 1, date: new ISODate("2017-07-04T15:09:12.911Z")},
        {_id: 2, date: new ISODate("2017-12-04T15:09:14.911Z")},
    ]));

    assert.eq(
        [
          {_id: 0, date: "2017-01-04 10:08:51 -0500 (-300 minutes)"},
          {_id: 1, date: "2017-07-04 11:09:12 -0400 (-240 minutes)"},
          {_id: 2, date: "2017-12-04 10:09:14 -0500 (-300 minutes)"},
        ],
        coll.aggregate([
                {
                  $project: {
                      date: {
                          $dateToString: {
                              format: "%Y-%m-%d %H:%M:%S %z (%Z minutes)",
                              date: "$date",
                              timezone: "America/New_York"
                          }
                      }
                  }
                },
                {$sort: {_id: 1}}
            ])
            .toArray());

    /* --------------------------------------------------------------------------------------- */
    coll.drop();

    assert.writeOK(coll.insert([
        {_id: 0, date: new ISODate("2017-01-04T15:08:51.911Z")},
        {_id: 1, date: new ISODate("2017-07-04T15:09:12.911Z")},
        {_id: 2, date: new ISODate("2017-12-04T15:09:14.911Z")},
    ]));

    assert.eq(
        [
          {_id: 0, date: "2017-01-04 15:08:51 +0000 (0 minutes)"},
          {_id: 1, date: "2017-07-04 15:09:12 +0000 (0 minutes)"},
          {_id: 2, date: "2017-12-04 15:09:14 +0000 (0 minutes)"},
        ],
        coll.aggregate([
                {
                  $project: {
                      date: {
                          $dateToString:
                              {format: "%Y-%m-%d %H:%M:%S %z (%Z minutes)", date: "$date"}
                      }
                  }
                },
                {$sort: {_id: 1}}
            ])
            .toArray());

    /* --------------------------------------------------------------------------------------- */
    /* Test that missing expressions, turn into BSON null values */
    coll.drop();

    assert.writeOK(coll.insert([
        {_id: 0, date: new ISODate("2017-01-04T15:08:51.911Z")},
        {_id: 1, date: new ISODate("2017-01-04T15:08:51.911Z"), timezone: null},
        {_id: 2, date: new ISODate("2017-01-04T15:08:51.911Z"), timezone: undefined},
        {_id: 3, timezone: "Europe/Oslo"},
        {_id: 4, date: null, timezone: "Europe/Oslo"},
        {_id: 5, date: undefined, timezone: "Europe/Oslo"},
    ]));

    assert.eq(
        [
          {_id: 0, date: null},
          {_id: 1, date: null},
          {_id: 2, date: null},
          {_id: 3, date: null},
          {_id: 4, date: null},
          {_id: 5, date: null},
        ],
        coll.aggregate([
                {
                  $project: {
                      date: {
                          $dateToString: {
                              format: "%Y-%m-%d %H:%M:%S %z (%Z minutes)",
                              date: "$date",
                              timezone: "$timezone"
                          }
                      }
                  }
                },
                {$sort: {_id: 1}}
            ])
            .toArray());

    /* --------------------------------------------------------------------------------------- */

    let pipeline = {$project: {date: {$dateToString: {date: "$date", timezone: "$tz"}}}};
    assertErrorCode(coll, pipeline, 18627);

    pipeline = {$project: {date: {$dateToString: {format: "%Y-%m-%d %H:%M:%S", timezone: "$tz"}}}};
    assertErrorCode(coll, pipeline, 18628);

    pipeline = {
        $project:
            {date: {$dateToString: {format: "%Y-%m-%d %H:%M:%S", date: "$date", timezone: 5}}}
    };
    assertErrorCode(coll, pipeline, 40517);

    pipeline = {$project: {date: {$dateToString: {format: "%Y-%m-%d %H:%M:%S", date: 42}}}};
    assertErrorCode(coll, pipeline, 16006);

    pipeline = {
        $project: {
            date: {
                $dateToString:
                    {format: "%Y-%m-%d %H:%M:%S", date: "$date", timezone: "DoesNot/Exist"}
            }
        }
    };
    assertErrorCode(coll, pipeline, 40485);

})();