Remove time zone argument from Absolute.toString

Instead of choosing a time zone in which to serialize an Absolute, the recommended way to keep a time stamp with a time zone is LocalDateTime (either serialized or not.) Closes: #741
tc39 · Aug 25, 2020 · 66c59c9 · 66c59c9
1 parent 8266a63
commit 66c59c9
Show file tree

Hide file tree

Showing 14 changed files with 39 additions and 250 deletions.
diff --git a/docs/absolute.md b/docs/absolute.md
@@ -358,11 +358,7 @@ one.equals(two)  // => false
 one.equals(one)  // => true
 ```
 
-### absolute.**toString**(_timeZone_?: object | string) : string
-
-**Parameters:**
-- `timeZone` (optional string or object): the time zone to express `absolute` in, as a `Temporal.TimeZone` object, an object implementing the [time zone protocol](./timezone.md#protocol), or a string.
-  The default is to use UTC.
+### absolute.**toString**() : string
 
 **Returns:** a string in the ISO 8601 date format representing `absolute`.
 
@@ -373,8 +369,6 @@ Example usage:
 ```js
 abs = new Temporal.Absolute(1574074321816000000n);
 abs.toString();  // => 2019-11-18T10:52:01.816Z
-abs.toString(Temporal.TimeZone.from('UTC'));  // => 2019-11-18T10:52:01.816Z
-abs.toString('Asia/Seoul');  // => 2019-11-18T19:52:01.816+09:00[Asia/Seoul]
 ```
 
 ### absolute.**toLocaleString**(_locales_?: string | array&lt;string&gt;, _options_?: object) : string

diff --git a/docs/cookbook/getInstantWithLocalTimeInZone.mjs b/docs/cookbook/getInstantWithLocalTimeInZone.mjs
@@ -51,6 +51,8 @@ function getInstantWithLocalTimeInZone(dateTime, timeZone, disambiguation = 'ear
 const germany = Temporal.TimeZone.from('Europe/Berlin');
 const nonexistentGermanWallTime = Temporal.DateTime.from('2019-03-31T02:45');
 
+// FIXME: these need to use LocalDateTime
+
 const germanResults = {
   earlier: /*     */ '2019-03-31T01:45+01:00[Europe/Berlin]',
   later: /*       */ '2019-03-31T03:45+02:00[Europe/Berlin]',

diff --git a/docs/cookbook/getParseableZonedStringAtInstant.mjs b/docs/cookbook/getParseableZonedStringAtInstant.mjs
@@ -1,3 +1,5 @@
+// FIXME: these need to use LocalDateTime
+
 const absoluteTime = Temporal.Absolute.from('2020-01-03T10:41:51Z');
 
 const result = absoluteTime.toString('Europe/Paris');

diff --git a/docs/cookbook/getParseableZonedStringWithLocalTimeInOtherZone.mjs b/docs/cookbook/getParseableZonedStringWithLocalTimeInOtherZone.mjs
@@ -23,6 +23,7 @@ function getParseableZonedStringWithLocalTimeInOtherZone(
   sourceDisambiguationPolicy = 'reject'
 ) {
   let instant = sourceDateTime.toAbsolute(sourceTimeZone, { disambiguation: sourceDisambiguationPolicy });
+  // FIXME: this needs to use LocalDateTime
   return instant.toString(targetTimeZone);
 }
 

diff --git a/polyfill/index.d.ts b/polyfill/index.d.ts
@@ -212,7 +212,7 @@ export namespace Temporal {
     toDateTime(tzLike: TimeZoneProtocol | string, calendar?: CalendarProtocol | string): Temporal.DateTime;
     toLocaleString(locales?: string | string[], options?: Intl.DateTimeFormatOptions): string;
     toJSON(): string;
-    toString(tzLike?: TimeZoneProtocol | string): string;
+    toString(): string;
   }
 
   export interface CalendarProtocol {

diff --git a/polyfill/lib/absolute.mjs b/polyfill/lib/absolute.mjs
@@ -138,16 +138,9 @@ export class Absolute {
     const two = GetSlot(other, EPOCHNANOSECONDS);
     return bigInt(one).equals(two);
   }
-  toString(temporalTimeZoneLike = 'UTC') {
+  toString() {
     if (!ES.IsTemporalAbsolute(this)) throw new TypeError('invalid receiver');
-    const timeZone = ES.ToTemporalTimeZone(temporalTimeZoneLike);
-    return ES.TemporalAbsoluteToString(this, timeZone);
-  }
-  toJSON() {
-    if (!ES.IsTemporalAbsolute(this)) throw new TypeError('invalid receiver');
-    const TemporalTimeZone = GetIntrinsic('%Temporal.TimeZone%');
-    const timeZone = new TemporalTimeZone('UTC');
-    return ES.TemporalAbsoluteToString(this, timeZone);
+    return ES.TemporalAbsoluteToString(this);
   }
   toLocaleString(...args) {
     if (!ES.IsTemporalAbsolute(this)) throw new TypeError('invalid receiver');
@@ -214,6 +207,7 @@ export class Absolute {
     return 0;
   }
 }
+Absolute.prototype.toJSON = Absolute.prototype.toString;
 
 MakeIntrinsicClass(Absolute, 'Temporal.Absolute');
 

diff --git a/polyfill/lib/ecmascript.mjs b/polyfill/lib/ecmascript.mjs
@@ -686,8 +686,9 @@ export const ES = ObjectAssign({}, ES2019, {
     let post = parts.length ? `.${parts.join('')}` : '';
     return `:${secs}${post}`;
   },
-  TemporalAbsoluteToString: (absolute, timeZone) => {
-    const dateTime = ES.GetTemporalDateTimeFor(timeZone, absolute);
+  TemporalAbsoluteToString: (absolute) => {
+    const ns = GetSlot(absolute, EPOCHNANOSECONDS);
+    const dateTime = ES.GetPartsFromEpoch(ns);
     const year = ES.ISOYearString(dateTime.year);
     const month = ES.ISODateTimePartString(dateTime.month);
     const day = ES.ISODateTimePartString(dateTime.day);
@@ -699,8 +700,7 @@ export const ES = ObjectAssign({}, ES2019, {
       dateTime.microsecond,
       dateTime.nanosecond
     );
-    const timeZoneString = ES.ISOTimeZoneString(timeZone, absolute);
-    return `${year}-${month}-${day}T${hour}:${minute}${seconds}${timeZoneString}`;
+    return `${year}-${month}-${day}T${hour}:${minute}${seconds}Z`;
   },
   TemporalDurationToString: (duration) => {
     function formatNumber(num) {

diff --git a/polyfill/test/Absolute/prototype/toString/argument-missing.js b/polyfill/test/Absolute/prototype/toString/argument-missing.js
diff --git a/polyfill/test/Absolute/prototype/toString/timezone-no-effect.js b/polyfill/test/Absolute/prototype/toString/timezone-no-effect.js
@@ -0,0 +1,17 @@
+// Copyright (C) 2020 Igalia, S.L. All rights reserved.
+// This code is governed by the BSD license found in the LICENSE file.
+
+/*---
+esid: sec-temporal.absolute.prototype.tostring
+includes: [compareArray.js]
+---*/
+
+const absolute = Temporal.Absolute.from("1975-02-02T14:25:36.123456Z");
+
+Object.defineProperty(Temporal.TimeZone, "from", {
+  get() {
+    throw new Test262Error("should not get Temporal.TimeZone.from");
+  },
+});
+
+assert.sameValue(absolute.toString(), "1975-02-02T14:25:36.123456Z");
diff --git a/polyfill/test/Absolute/prototype/toString/timezone-no-tostring.js b/polyfill/test/Absolute/prototype/toString/timezone-no-tostring.js
diff --git a/polyfill/test/Absolute/prototype/toString/timezone.js b/polyfill/test/Absolute/prototype/toString/timezone.js
diff --git a/polyfill/test/absolute.mjs b/polyfill/test/absolute.mjs
@@ -77,17 +77,6 @@ describe('Absolute', () => {
       assert(instant);
       equal(`${instant}`, iso);
     });
-    it('optional time zone parameter UTC', () => {
-      const iso = '1976-11-18T14:23:30.123456789Z';
-      const abs = Absolute.from(iso);
-      const tz = Temporal.TimeZone.from('UTC');
-      equal(abs.toString(tz), iso);
-    });
-    it('optional time zone parameter non-UTC', () => {
-      const abs = Absolute.from('1976-11-18T14:23:30.123456789Z');
-      const tz = Temporal.TimeZone.from('America/New_York');
-      equal(abs.toString(tz), '1976-11-18T09:23:30.123456789-05:00[America/New_York]');
-    });
   });
   describe('Absolute.toJSON() works', () => {
     it('`1976-11-18T15:23:30.123456789+01:00`.toJSON()', () => {
@@ -100,10 +89,6 @@ describe('Absolute', () => {
       assert(abs);
       equal(abs.toJSON(), '1963-02-13T09:36:29.123456789Z');
     });
-    it('argument is ignored', () => {
-      const abs = Absolute.from('1976-11-18T15:23:30.123456789+01:00');
-      equal(abs.toJSON('+01:00'), abs.toJSON());
-    });
   });
   describe('Absolute.getEpochSeconds() works', () => {
     it('post-epoch', () => {

diff --git a/polyfill/test/usertimezone.mjs b/polyfill/test/usertimezone.mjs
@@ -14,6 +14,8 @@ const { equal, throws } = assert;
 
 import * as Temporal from 'proposal-temporal';
 
+// FIXME: add tests to make sure these cases work with LocalDateTime
+
 describe('Userland time zone', () => {
   describe('Trivial subclass', () => {
     class CustomUTCSubclass extends Temporal.TimeZone {
@@ -59,8 +61,6 @@ describe('Userland time zone', () => {
       equal(`${dt.toAbsolute(obj)}`, '1976-11-18T15:23:30.123456789Z');
     });
     it('converts to string', () => equal(`${obj}`, obj.name));
-    it('prints in absolute.toString', () =>
-      equal(abs.toString(obj), '1970-01-01T00:00+00:00[Etc/Custom_UTC_Subclass]'));
     it('has no next transitions', () => assert.equal(obj.getNextTransition(), null));
     it('has no previous transitions', () => assert.equal(obj.getPreviousTransition(), null));
     it('works in Temporal.now', () => {
@@ -95,10 +95,6 @@ describe('Userland time zone', () => {
         const abs = Temporal.Absolute.from('1970-01-01T00:00+00:00[Etc/Custom_UTC_Subclass]');
         equal(`${abs}`, '1970-01-01T00:00Z');
       });
-      it('works for Absolute.toString', () => {
-        const abs = Temporal.Absolute.fromEpochSeconds(0);
-        equal(abs.toString('Etc/Custom_UTC_Subclass'), '1970-01-01T00:00+00:00[Etc/Custom_UTC_Subclass]');
-      });
       it('works for Absolute.toDateTime', () => {
         const abs = Temporal.Absolute.fromEpochSeconds(0);
         equal(`${abs.toDateTime('Etc/Custom_UTC_Subclass')}`, '1970-01-01T00:00');
@@ -147,8 +143,6 @@ describe('Userland time zone', () => {
       equal(`${Temporal.TimeZone.prototype.getAbsoluteFor.call(obj, dt)}`, '1976-11-18T15:23:30.123456789Z');
       equal(`${dt.toAbsolute(obj)}`, '1976-11-18T15:23:30.123456789Z');
     });
-    it('prints in absolute.toString', () =>
-      equal(abs.toString(obj), '1970-01-01T00:00+00:00[Etc/Custom_UTC_Protocol]'));
     it('works in Temporal.now', () => {
       assert(Temporal.now.dateTime(obj) instanceof Temporal.DateTime);
       assert(Temporal.now.date(obj) instanceof Temporal.Date);
@@ -181,10 +175,6 @@ describe('Userland time zone', () => {
         const abs = Temporal.Absolute.from('1970-01-01T00:00+00:00[Etc/Custom_UTC_Protocol]');
         equal(`${abs}`, '1970-01-01T00:00Z');
       });
-      it('works for Absolute.toString', () => {
-        const abs = Temporal.Absolute.fromEpochSeconds(0);
-        equal(abs.toString('Etc/Custom_UTC_Protocol'), '1970-01-01T00:00+00:00[Etc/Custom_UTC_Protocol]');
-      });
       it('works for Absolute.toDateTime', () => {
         const abs = Temporal.Absolute.fromEpochSeconds(0);
         equal(`${abs.toDateTime('Etc/Custom_UTC_Protocol')}`, '1970-01-01T00:00');