Merge pull request #106 from oat-sa/feature/TR-1207/support-locale-fo…

…rmat-datetime-in-utc

Feature/TR-1207/Add locale format for DateTime in UTC

package.json

@@ -45,7 +45,7 @@
     "@oat-sa/expr-eval": "^1.3.0",
     "@oat-sa/prettier-config": "^0.1.1",
     "@oat-sa/tao-core-libs": "^0.4.3",
-    "@oat-sa/tao-qunit-testrunner": "^0.1.3",
+    "@oat-sa/tao-qunit-testrunner": "1.0.3",
     "async": "^0.2.10",
     "decimal.js": "10.1.1",
     "dompurify": "1.0.11",

src/util/locale.js

@@ -13,7 +13,7 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
- * Copyright (c) 2016-2019 (original work) Open Assessment Technologies SA;
+ * Copyright (c) 2016-2021 (original work) Open Assessment Technologies SA;
  *
  */
 
@@ -115,11 +115,13 @@ export default {
 
     /**
      * Parse unix timestamp
-     * Note that user's (browser's) timezone will be used.
-     * @param {Number} timestamp
+     * Note that user's (browser's) timezone will be used by default, unless the utc parameter is set to true.
+     * @param {Number} timestamp - The timestamp to format. It is considered as in the target timezone.
+     * @param {Boolean} [utc=false] - For the UTC timezone. By default the user's timezone will be used.
      * @return string
      */
-    formatDateTime: function(timestamp) {
-        return moment(timestamp, 'X').format(this.getDateTimeFormat());
+    formatDateTime(timestamp, utc = false) {
+        const datetime = utc ? moment.utc(timestamp, 'X') : moment(timestamp, 'X');
+        return datetime.format(this.getDateTimeFormat());
     }
 };

test/util/locale/momentMock.js

@@ -0,0 +1,54 @@
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2021 Open Assessment Technologies SA ;
+ */
+/**
+ * @author Jean-Sébastien Conan <jean-sebastien@taotesting.com>
+ */
+define([
+    'core/eventifier'
+], function (eventifier) {
+    'use strict';
+
+    const mockValues = {};
+
+    const momentMock = eventifier(function (...args) {
+        momentMock.trigger('moment', ...args);
+        return momentMockFactory(...args);
+    });
+
+    function momentMockFactory(...factoryArgs) {
+        momentMock.trigger('factory', ...factoryArgs);
+
+        return {
+            format(...args) {
+                momentMock.trigger('format', ...args);
+                return mockValues.format;
+            }
+        };
+    }
+
+    return Object.assign(momentMock, {
+        utc(...args) {
+            momentMock.trigger('utc', ...args);
+            return momentMockFactory(...args);
+        },
+
+        mockFormat(value) {
+            mockValues.format = value;
+        }
+    });
+});

test/util/locale/test.html

@@ -7,6 +7,12 @@
         <script type="text/javascript">
             require(['/environment/config.js'], function() {
                 require(['qunitEnv'], function() {
+                    //some mocks
+                    requirejs.config({
+                        paths: {
+                            'moment': 'test/util/locale/momentMock'
+                        }
+                    });
                     require(['test/util/locale/test'], function() {
                         QUnit.start();
                     });

test/util/locale/test.js

@@ -13,15 +13,19 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
- * Copyright (c) 2016 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT);
+ * Copyright (c) 2016-2021 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT);
  *
  * @author Ivan Klimchuk <klimchuk@1pt.com>
  */
-define(['module', 'util/locale'], function(module, locale) {
+define([
+    'module',
+    'moment',
+    'util/locale'
+], function (module, moment, locale) {
     // All tests are grouped in one module because global state is changed during them
     QUnit.module('API');
 
-    QUnit.test('util api, different locales', function(assert) {
+    QUnit.test('util api, different locales', assert => {
         // American style
         locale.setConfig({
             decimalSeparator: '.',
@@ -92,4 +96,89 @@ define(['module', 'util/locale'], function(module, locale) {
             'the valid integer value with dot as decimal separator and comma as thousands separator'
         );
     });
+
+    QUnit.test('util/formatDateTime', assert => {
+        const ready = assert.async();
+        const expectedTimestamp = 1621641600;
+        const expectedOptions = 'X';
+
+        assert.expect(10);
+
+        Promise.resolve()
+            .then(() => {
+                const expectedOutput = '05/21/2021';
+
+                moment.off('.test');
+
+                const promises = [
+                    new Promise(resolve => {
+                        moment.on('moment.test', (ts, options) => {
+                            assert.ok(true, 'Local timezone applied!');
+                            assert.equal(ts, expectedTimestamp, 'The expected timestamp has been supplied');
+                            assert.equal(options, expectedOptions, 'The expected options have been supplied');
+                            resolve();
+                        });
+
+                        moment.on('utc.test', (ts, options) => {
+                            assert.ok(false, 'UTC timezone should not be applied!');
+                            assert.equal(ts, expectedTimestamp, 'The expected timestamp has been supplied');
+                            assert.equal(options, expectedOptions, 'The expected options have been supplied');
+                            resolve();
+                        });
+                    }),
+                    new Promise(resolve => {
+                        moment.on('format.test', () => {
+                            assert.ok(true, 'Local format applied');
+                            resolve();
+                        });
+                    })
+                ];
+
+                moment.mockFormat(expectedOutput);
+                assert.equal(locale.formatDateTime(expectedTimestamp), expectedOutput, 'Format date/time to locale using user timezone');
+
+                return promises;
+            })
+            .then(() => {
+                const expectedOutput = '05/22/2021';
+
+                moment.off('.test');
+
+                const promises = [
+                    new Promise(resolve => {
+                        moment.on('moment.test', (ts, options) => {
+                            assert.ok(false, 'Local timezone should not be applied!');
+                            assert.equal(ts, expectedTimestamp, 'The expected timestamp has been supplied');
+                            assert.equal(options, expectedOptions, 'The expected options have been supplied');
+                            resolve();
+                        });
+
+                        moment.on('utc.test', (ts, options) => {
+                            assert.ok(true, 'UTC timezone applied!');
+                            assert.equal(ts, expectedTimestamp, 'The expected timestamp has been supplied');
+                            assert.equal(options, expectedOptions, 'The expected options have been supplied');
+                            resolve();
+                        });
+                    }),
+                    new Promise(resolve => {
+                        moment.on('format.test', () => {
+                            assert.ok(true, 'Local format applied');
+                            resolve();
+                        });
+                    })
+                ];
+
+                moment.mockFormat(expectedOutput);
+                assert.equal(locale.formatDateTime(expectedTimestamp, true), expectedOutput, 'Format date/time to locale using UTC timezone');
+
+                return promises;
+            })
+            .catch(err => {
+                assert.pushResult({
+                    result: false,
+                    message: err
+                });
+            })
+            .then(ready);
+    });
 });