Make parsing of dates from ECM timezone-aware (#133)

* Make parsing of dates from ECM timezone-aware

Refs #134

* Set correct tab size for generated code

Refs #134

* Add changelog entry

* Support timezones specified in different formats

Refs #134

* Add new dist files

Refs #134

Author: wabson

.editorconfig

@@ -10,6 +10,12 @@ end_of_line = lf
 insert_final_newline = true
 trim_trailing_whitespace = true
 
+[src/alfresco-activiti-rest-api/**.js]
+indent_size = 2
+
+[src/alfresco-core-rest-api/**.js]
+indent_size = 2
+
 [package.json]
 indent_style = space
 indent_size = 2

CHANGELOG.md

@@ -11,6 +11,7 @@ _This project provides a JavaScript client API into the v1 Alfresco REST API_
 ## fix
 - [/api/enterprise/script-files/controllers sending wrong accept header  #130](https://github.com/Alfresco/alfresco-js-api/pull/130)
 - [CSRF Token is not working #128](https://github.com/Alfresco/alfresco-js-api/pull/128)
+- [Timestamp timezones are ignored #134](https://github.com/Alfresco/alfresco-js-api/issues/134)
 
 <a name="0.5.5"></a>
 # [0.5.5](https://github.com/Alfresco/alfresco-js-api/releases/tag/0.5.5) (09-12-2016)

dist/alfresco-js-api.js

@@ -38,6 +38,7 @@
     "babel-plugin-transform-proto-to-assign": "^6.9.0",
     "browserify": "^13.0.1",
     "chai": "^3.5.0",
+    "chai-datetime": "^1.4.1",
     "expect.js": "~0.3.1",
     "grunt": "~0.4.0",
     "grunt-cli": "^1.1.0",

dist/alfresco-js-api.min.js

@@ -400,12 +400,43 @@
    * @returns {Date} The parsed date object.
    */
   exports.parseDate = function(str) {
+    var dateLength = 10;
+    var separatorPos = str.substring(dateLength).search(/[\+\-]/) + dateLength;
+    var dateStr = separatorPos > dateLength ? str.substring(0, separatorPos) : str;
+    var tzStr = separatorPos > dateLength ? str.substring(separatorPos) : '';
+    var parsedDate = exports.parseDateTime(dateStr);
+    var tzOffsetMins = exports.parseDateTimeZone(tzStr);
+    parsedDate.setTime(parsedDate.getTime() + tzOffsetMins * 60000);
+    return parsedDate;
+  };
+
+  /**
+   * Parses the date component of a ISO-8601 string representation of a date value.
+   * @param {String} str The date value as a string.
+   * @returns {Date} The parsed date object.
+   */
+  exports.parseDateTime = function(str) {
     // TODO: review when Safari 10 is released
     // return new Date(str.replace(/T/i, ' '));
 
     // Compatible with Safari 9.1.2
-    var a = str.split(/[^0-9]/).map(function(s) { return parseInt(s, 10) });
-    return new Date(a[0], a[1]-1 || 0, a[2] || 1, a[3] || 0, a[4] || 0, a[5] || 0, a[6] || 0);
+    var parts = str.split('+');
+    var dateParts = str.split(/[^0-9]/).map(function(s) { return parseInt(s, 10) });
+    return new Date(Date.UTC(dateParts[0], dateParts[1]-1 || 0, dateParts[2] || 1, dateParts[3] || 0, dateParts[4] || 0, dateParts[5] || 0, dateParts[6] || 0));
+  };
+
+  /**
+   * Parses the timezone component of a ISO-8601 string representation of a date value.
+   * @param {String} str The timezone offset as a string, e.g. '+0000', '+2000' or '-0500'.
+   * @returns {number} The number of minutes offset from UTC.
+   */
+  exports.parseDateTimeZone = function(str) {
+    var match = /([\+\-])(\d{2}):?(\d{2})?/.exec(str);
+    if (match !== null) {
+      return (parseInt(match[1] + '1') * -1 * (parseInt(match[2]) * 60) + parseInt(match[3] || 0))
+    } else {
+      return 0;
+    }
   };
 
   /**

package.json

@@ -0,0 +1,47 @@
+/*global describe, it */
+
+var ApiClient = require('../src/alfresco-core-rest-api/src/ApiClient');
+var chai = require('chai');
+var expect = chai.expect;
+
+chai.use(require('chai-datetime'));
+
+describe('Alfresco Core API Client', function () {
+
+    it('should convert dates falling in GMT without a timezone', function () {
+        expect(ApiClient.parseDate('2015-11-17T03:33:17')).to.equalTime(new Date(Date.UTC(2015, 10, 17, 3, 33, 17)));
+    });
+
+    it('should convert dates falling in BST without a timezone', function () {
+        expect(ApiClient.parseDate('2015-10-17T03:33:17')).to.equalTime(new Date(Date.UTC(2015, 9, 17, 3, 33, 17)));
+    });
+
+    it('should convert dates with a UTC Zulu-time timezone', function () {
+        expect(ApiClient.parseDate('2015-11-17T03:33:17Z')).to.equalTime(new Date(Date.UTC(2015, 10, 17, 3, 33, 17)));
+    });
+
+    it('should convert dates with a UTC zero-offset timezone', function () {
+        expect(ApiClient.parseDate('2015-11-17T03:33:17+0000')).to.equalTime(new Date(Date.UTC(2015, 10, 17, 3, 33, 17)));
+    });
+
+    it('should convert dates with a positive offset timezone', function () {
+        expect(ApiClient.parseDate('2015-11-17T03:33:17+0200')).to.equalTime(new Date(Date.UTC(2015, 10, 17, 1, 33, 17)));
+    });
+
+    it('should convert dates with a negative offset timezone', function () {
+        expect(ApiClient.parseDate('2015-11-17T03:33:17-0200')).to.equalTime(new Date(Date.UTC(2015, 10, 17, 5, 33, 17)));
+    });
+
+    it('should convert dates with a part-hour offset', function () {
+        expect(ApiClient.parseDate('2015-11-17T03:23:17-0930')).to.equalTime(new Date(Date.UTC(2015, 10, 17, 12, 53, 17)));
+    });
+
+    it('should convert dates with a timezone HH:MM separator', function () {
+        expect(ApiClient.parseDate('2015-11-17T03:33:17+02:00')).to.equalTime(new Date(Date.UTC(2015, 10, 17, 1, 33, 17)));
+    });
+
+    it('should convert dates with a timezone with hours only', function () {
+        expect(ApiClient.parseDate('2015-11-17T03:33:17+02')).to.equalTime(new Date(Date.UTC(2015, 10, 17, 1, 33, 17)));
+    });
+
+});

src/alfresco-core-rest-api/src/ApiClient.js

@@ -137,6 +137,36 @@ class NodeMock extends BaseMock {
             });
     }
 
+    get200ResponseChildrenNonUTCTimes() {
+        nock(this.host, {'encodedQueryParams': true})
+            .get('/alfresco/api/-default-/public/alfresco/versions/1/nodes/b4cff62a-664d-4d45-9302-98723eac1320/children')
+            .reply(200, {
+                'list': {
+                    'pagination': {
+                        'count': 5,
+                        'hasMoreItems': false,
+                        'totalItems': 5,
+                        'skipCount': 0,
+                        'maxItems': 100
+                    },
+                    'entries': [{
+                        'entry': {
+                            'createdAt': '2011-03-15T12:04:54.290-0500',
+                            'isFolder': true,
+                            'isFile': false,
+                            'createdByUser': {'id': 'mjackson', 'displayName': 'Mike Jackson'},
+                            'modifiedAt': '2011-03-15T12:04:54.290-0500',
+                            'modifiedByUser': {'id': 'mjackson', 'displayName': 'Mike Jackson'},
+                            'name': 'discussions',
+                            'id': '059c5bc7-2d38-4dc5-96b8-d09cd3c69b4c',
+                            'nodeType': 'cm:folder',
+                            'parentId': 'b4cff62a-664d-4d45-9302-98723eac1320'
+                        }
+                    }]
+                }
+            });
+    }
+
     get404ChildrenNotExist() {
         nock(this.host, {'encodedQueryParams': true})
             .get('/alfresco/api/-default-/public/alfresco/versions/1/nodes/b4cff62a-664d-4d45-9302-98723eac1319/children')

test/alfrescoApiClient.spec.js

@@ -1,11 +1,14 @@
 /*global describe, it, beforeEach */
 
 var AlfrescoApi = require('../main');
-var expect = require('chai').expect;
+var chai = require('chai');
+var expect = chai.expect;
 var AuthResponseMock = require('../test/mockObjects/mockAlfrescoApi').Auth;
 var NodeMock = require('../test/mockObjects/mockAlfrescoApi').Node;
 var fs = require('fs');
 
+chai.use(require('chai-datetime'));
+
 describe('Node', function () {
     beforeEach(function (done) {
         this.hostEcm = 'http://127.0.0.1:8080';
@@ -111,6 +114,17 @@ describe('Node', function () {
                 done();
             });
         });
+
+        it('should return dates as timezone-aware', function (done) {
+            this.nodeMock.get200ResponseChildrenNonUTCTimes();
+
+            this.alfrescoJsApi.nodes.getNodeChildren('b4cff62a-664d-4d45-9302-98723eac1320').then(function (data) {
+                expect(data.list.entries.length).to.be.equal(1);
+                expect(data.list.entries[0].entry.createdAt).to.equalTime(new Date(Date.UTC(2011, 2, 15, 17, 4, 54, 290)));
+                done();
+            });
+
+        });
     });
 
     describe('Delete', function () {