Change Temporal.Calendar compare semantics to use .id

Compare semantics for custom calendars that _don't_ extend Temporal.Calendar (and therefore don't have the internal slot) use the value of the .id property, instead of calling toString(). Normative PR: tc39/proposal-temporal#2482
ptomato · Feb 17, 2023 · 6c8c3d8 · 6c8c3d8
1 parent 3204783
commit 6c8c3d8
Show file tree

Hide file tree

Showing 92 changed files with 278 additions and 271 deletions.
diff --git a/harness/temporalHelpers.js b/harness/temporalHelpers.js
@@ -1519,7 +1519,8 @@ var TemporalHelpers = {
         // Remove the HasProperty check resulting from the above constructor call
         assert.sameValue(calls.pop(), `has ${objectName}.calendar`);
         return result;
-      }
+      },
+      id: "iso8601",
     };
     // Automatically generate the other methods that don't need any custom code
     ["toString", "dateUntil", "era", "eraYear", "year", "month", "monthCode", "day", "daysInMonth", "fields", "mergeFields"].forEach((methodName) => {

diff --git a/test/built-ins/Temporal/PlainDate/prototype/equals/argument-object-valid.js b/test/built-ins/Temporal/PlainDate/prototype/equals/argument-object-valid.js
@@ -11,6 +11,6 @@ const instance = new Temporal.PlainDate(2000, 5, 2);
 assert.sameValue(instance.equals({ year: 2000, month: 5, day: 2 }), true, "same date");
 assert.sameValue(instance.equals({ year: 2000, month: 5, day: 4 }), false, "different date");
 
-const calendar = { toString() { return "a" } };
+const calendar = { id: "a" };
 assert.sameValue(instance.withCalendar(calendar).equals({ year: 2000, month: 5, day: 2 }),
   false, "different calendar");
diff --git a/test/built-ins/Temporal/PlainDate/prototype/equals/argument-string.js b/test/built-ins/Temporal/PlainDate/prototype/equals/argument-string.js
@@ -11,5 +11,5 @@ const instance = new Temporal.PlainDate(2000, 5, 2);
 assert.sameValue(instance.equals("2000-05-02"), true, "same date");
 assert.sameValue(instance.equals("2000-05-04"), false, "different date");
 
-const calendar = { toString() { return "a" } };
+const calendar = { id: "a" };
 assert.sameValue(instance.withCalendar(calendar).equals("2000-05-02"), false, "different calendar");
diff --git a/test/built-ins/Temporal/PlainDate/prototype/equals/calendar-call-different.js b/test/built-ins/Temporal/PlainDate/prototype/equals/calendar-call-different.js
@@ -4,27 +4,31 @@
 /*---
 esid: sec-temporal.plaindate.protoype.equals
 description: test if the calendar is compared
+includes: [temporalHelpers.js]
 features: [Temporal]
 ---*/
 
-class CalendarTraceToString extends Temporal.Calendar {
+class CalendarTraceId extends Temporal.Calendar {
   constructor(id) {
     super("iso8601");
     this.id_ = id;
     this.calls = 0;
   }
-  toString() {
+  get id() {
     ++this.calls;
     return this.id_;
   }
+  toString() {
+    TemporalHelpers.assertUnreachable('toString should not be called');
+  }
 };
 
-const calendar1 = new CalendarTraceToString("a");
+const calendar1 = new CalendarTraceId("a");
 const date1 = new Temporal.PlainDate(1914, 2, 23, calendar1);
 
-const calendar2 = new CalendarTraceToString("b");
+const calendar2 = new CalendarTraceId("b");
 const date2 = new Temporal.PlainDate(1914, 2, 23, calendar2);
 
 assert.sameValue(date1.equals(date2), false, "different calendars");
-assert.sameValue(calendar1.calls, 1, "calendar1 toString() calls");
-assert.sameValue(calendar2.calls, 1, "calendar2 toString() calls");
+assert.sameValue(calendar1.calls, 1, "calendar1 id getter calls");
+assert.sameValue(calendar2.calls, 1, "calendar2 id getter calls");
diff --git a/test/built-ins/Temporal/PlainDate/prototype/equals/calendar-call-same.js b/test/built-ins/Temporal/PlainDate/prototype/equals/calendar-call-same.js
@@ -4,6 +4,7 @@
 /*---
 esid: sec-temporal.plaindate.protoype.equals
 description: test if the calendar is compared
+includes: [temporalHelpers.js]
 features: [Temporal]
 ---*/
 
@@ -13,10 +14,13 @@ class CalendarTraceToString extends Temporal.Calendar {
     this.id_ = id;
     this.calls = 0;
   }
-  toString() {
+  get id() {
     ++this.calls;
     return this.id_;
   }
+  toString() {
+    TemporalHelpers.assertUnreachable('toString should not be called');
+  }
 };
 
 const calendar1 = new CalendarTraceToString("a");
@@ -26,5 +30,5 @@ const calendar2 = new CalendarTraceToString("a");
 const date2 = new Temporal.PlainDate(1914, 2, 23, calendar2);
 
 assert.sameValue(date1.equals(date2), true, "same calendar id");
-assert.sameValue(calendar1.calls, 1, "calendar1 toString() calls");
-assert.sameValue(calendar2.calls, 1, "calendar2 toString() calls");
+assert.sameValue(calendar1.calls, 1, "calendar1 id getter calls");
+assert.sameValue(calendar2.calls, 1, "calendar2 id getter calls");
diff --git a/test/built-ins/Temporal/PlainDate/prototype/since/calendar-mismatch.js b/test/built-ins/Temporal/PlainDate/prototype/since/calendar-mismatch.js
@@ -3,12 +3,12 @@
 
 /*---
 esid: sec-temporal.plaindate.prototype.since
-description: RangeError thrown if calendars' toString results do not match
+description: RangeError thrown if calendars' id properties do not match
 features: [Temporal]
 ---*/
 
-const calendar1 = { toString() { return "A"; } };
-const calendar2 = { toString() { return "B"; } };
+const calendar1 = { id: "A" };
+const calendar2 = { id: "B" };
 
 const plainDate1 = new Temporal.PlainDate(2000, 1, 1, calendar1);
 const plainDate2 = new Temporal.PlainDate(2000, 1, 1, calendar2);

diff --git a/test/built-ins/Temporal/PlainDate/prototype/since/order-of-operations.js b/test/built-ins/Temporal/PlainDate/prototype/since/order-of-operations.js
@@ -29,12 +29,8 @@ const expected = [
   "get other.calendar.dateFromFields",
   "call other.calendar.dateFromFields",
   // CalendarEquals
-  "get this.calendar[Symbol.toPrimitive]",
-  "get this.calendar.toString",
-  "call this.calendar.toString",
-  "get other.calendar[Symbol.toPrimitive]",
-  "get other.calendar.toString",
-  "call other.calendar.toString",
+  "get this.calendar.id",
+  "get other.calendar.id",
   // CopyDataProperties
   "ownKeys options",
   "getOwnPropertyDescriptor options.roundingIncrement",

diff --git a/test/built-ins/Temporal/PlainDate/prototype/toString/calendar-tostring.js b/test/built-ins/Temporal/PlainDate/prototype/toString/calendar-tostring.js
@@ -4,14 +4,18 @@
 /*---
 esid: sec-temporal.plaindate.protoype.tostring
 description: Number of observable 'toString' calls on the calendar for each value of calendarName
+includes: [temporalHelpers.js]
 features: [Temporal]
 ---*/
 
 let calls;
 const customCalendar = {
-  toString() {
+  get id() {
     ++calls;
     return "custom";
+  },
+  toString() {
+    TemporalHelpers.assertUnreachable('toString should not be called');
   }
 };
 const date = new Temporal.PlainDate(2000, 5, 2, customCalendar);
@@ -24,6 +28,6 @@ const date = new Temporal.PlainDate(2000, 5, 2, customCalendar);
 ].forEach(([calendarName, expectedResult, expectedCalls]) => {
   calls = 0;
   const result = date.toString({ calendarName });
-  assert.sameValue(result, expectedResult, `toString output for calendarName = ${calendarName}`);
-  assert.sameValue(calls, expectedCalls, `calls to toString for calendarName = ${calendarName}`);
+  assert.sameValue(result, expectedResult, `id for calendarName = ${calendarName}`);
+  assert.sameValue(calls, expectedCalls, `calls to id getter for calendarName = ${calendarName}`);
 });
diff --git a/test/built-ins/Temporal/PlainDate/prototype/toString/calendarname-always.js b/test/built-ins/Temporal/PlainDate/prototype/toString/calendarname-always.js
@@ -9,10 +9,10 @@ features: [Temporal]
 
 const tests = [
   [[], "2000-05-02[u-ca=iso8601]", "built-in ISO"],
-  [[{ toString() { return "custom"; } }], "2000-05-02[u-ca=custom]", "custom"],
-  [[{ toString() { return "iso8601"; } }], "2000-05-02[u-ca=iso8601]", "custom with iso8601 toString"],
-  [[{ toString() { return "ISO8601"; } }], "2000-05-02[u-ca=ISO8601]", "custom with caps toString"],
-  [[{ toString() { return "\u0131so8601"; } }], "2000-05-02[u-ca=\u0131so8601]", "custom with dotless i toString"],
+  [[{ id: "custom" }], "2000-05-02[u-ca=custom]", "custom"],
+  [[{ id: "iso8601" }], "2000-05-02[u-ca=iso8601]", "custom with iso8601 id"],
+  [[{ id: "ISO8601" }], "2000-05-02[u-ca=ISO8601]", "custom with caps id"],
+  [[{ id: "\u0131so8601" }], "2000-05-02[u-ca=\u0131so8601]", "custom with dotless i id"],
 ];
 
 for (const [args, expected, description] of tests) {

diff --git a/test/built-ins/Temporal/PlainDate/prototype/toString/calendarname-auto.js b/test/built-ins/Temporal/PlainDate/prototype/toString/calendarname-auto.js
@@ -9,10 +9,10 @@ features: [Temporal]
 
 const tests = [
   [[], "2000-05-02", "built-in ISO"],
-  [[{ toString() { return "custom"; } }], "2000-05-02[u-ca=custom]", "custom"],
-  [[{ toString() { return "iso8601"; } }], "2000-05-02", "custom with iso8601 toString"],
-  [[{ toString() { return "ISO8601"; } }], "2000-05-02[u-ca=ISO8601]", "custom with caps toString"],
-  [[{ toString() { return "\u0131so8601"; } }], "2000-05-02[u-ca=\u0131so8601]", "custom with dotless i toString"],
+  [[{ id: "custom" }], "2000-05-02[u-ca=custom]", "custom"],
+  [[{ id: "iso8601" }], "2000-05-02", "custom with iso8601 id"],
+  [[{ id: "ISO8601" }], "2000-05-02[u-ca=ISO8601]", "custom with caps id"],
+  [[{ id: "\u0131so8601" }], "2000-05-02[u-ca=\u0131so8601]", "custom with dotless i id"],
 ];
 
 for (const [args, expected, description] of tests) {

diff --git a/test/built-ins/Temporal/PlainDate/prototype/toString/calendarname-critical.js b/test/built-ins/Temporal/PlainDate/prototype/toString/calendarname-critical.js
@@ -11,10 +11,10 @@ features: [Temporal]
 
 const tests = [
   [[], "2000-05-02[!u-ca=iso8601]", "built-in ISO"],
-  [[{ toString() { return "custom"; } }], "2000-05-02[!u-ca=custom]", "custom"],
-  [[{ toString() { return "iso8601"; } }], "2000-05-02[!u-ca=iso8601]", "custom with iso8601 toString"],
-  [[{ toString() { return "ISO8601"; } }], "2000-05-02[!u-ca=ISO8601]", "custom with caps toString"],
-  [[{ toString() { return "\u0131so8601"; } }], "2000-05-02[!u-ca=\u0131so8601]", "custom with dotless i toString"],
+  [[{ id: "custom" }], "2000-05-02[!u-ca=custom]", "custom"],
+  [[{ id: "iso8601" }], "2000-05-02[!u-ca=iso8601]", "custom with iso8601 id"],
+  [[{ id: "ISO8601" }], "2000-05-02[!u-ca=ISO8601]", "custom with caps id"],
+  [[{ id: "\u0131so8601" }], "2000-05-02[!u-ca=\u0131so8601]", "custom with dotless i id"],
 ];
 
 for (const [args, expected, description] of tests) {

diff --git a/test/built-ins/Temporal/PlainDate/prototype/toString/calendarname-never.js b/test/built-ins/Temporal/PlainDate/prototype/toString/calendarname-never.js
@@ -9,10 +9,10 @@ features: [Temporal]
 
 const tests = [
   [[], "2000-05-02", "built-in ISO"],
-  [[{ toString() { return "custom"; } }], "2000-05-02", "custom"],
-  [[{ toString() { return "iso8601"; } }], "2000-05-02", "custom with iso8601 toString"],
-  [[{ toString() { return "ISO8601"; } }], "2000-05-02", "custom with caps toString"],
-  [[{ toString() { return "\u0131so8601"; } }], "2000-05-02", "custom with dotless i toString"],
+  [[{ id: "custom" }], "2000-05-02", "custom"],
+  [[{ id: "iso8601" }], "2000-05-02", "custom with iso8601 id"],
+  [[{ id: "ISO8601" }], "2000-05-02", "custom with caps id"],
+  [[{ id: "\u0131so8601" }], "2000-05-02", "custom with dotless i id"],
 ];
 
 for (const [args, expected, description] of tests) {

diff --git a/test/built-ins/Temporal/PlainDate/prototype/toString/calendarname-undefined.js b/test/built-ins/Temporal/PlainDate/prototype/toString/calendarname-undefined.js
@@ -16,10 +16,10 @@ features: [Temporal]
 
 const tests = [
   [[], "2000-05-02", "built-in ISO"],
-  [[{ toString() { return "custom"; } }], "2000-05-02[u-ca=custom]", "custom"],
-  [[{ toString() { return "iso8601"; } }], "2000-05-02", "custom with iso8601 toString"],
-  [[{ toString() { return "ISO8601"; } }], "2000-05-02[u-ca=ISO8601]", "custom with caps toString"],
-  [[{ toString() { return "\u0131so8601"; } }], "2000-05-02[u-ca=\u0131so8601]", "custom with dotless i toString"],
+  [[{ id: "custom" }], "2000-05-02[u-ca=custom]", "custom"],
+  [[{ id: "iso8601" }], "2000-05-02", "custom with iso8601 id"],
+  [[{ id: "ISO8601" }], "2000-05-02[u-ca=ISO8601]", "custom with caps id"],
+  [[{ id: "\u0131so8601" }], "2000-05-02[u-ca=\u0131so8601]", "custom with dotless i id"],
 ];
 
 for (const [args, expected, description] of tests) {

diff --git a/test/built-ins/Temporal/PlainDate/prototype/toString/calendarname-wrong-type.js b/test/built-ins/Temporal/PlainDate/prototype/toString/calendarname-wrong-type.js
@@ -16,7 +16,7 @@ features: [Temporal]
 ---*/
 
 const calendar = {
-  toString() { return "custom"; }
+  id: "custom",
 };
 const date = new Temporal.PlainDate(2000, 5, 2, calendar);
 

diff --git a/test/built-ins/Temporal/PlainDate/prototype/toString/options-undefined.js b/test/built-ins/Temporal/PlainDate/prototype/toString/options-undefined.js
@@ -8,7 +8,7 @@ features: [Temporal]
 ---*/
 
 const calendar = {
-  toString() { return "custom"; }
+  id: "custom",
 };
 const date1 = new Temporal.PlainDate(2000, 5, 2);
 const date2 = new Temporal.PlainDate(2000, 5, 2, calendar);

diff --git a/test/built-ins/Temporal/PlainDate/prototype/toString/order-of-operations.js b/test/built-ins/Temporal/PlainDate/prototype/toString/order-of-operations.js
@@ -12,9 +12,7 @@ const expected = [
   "get options.calendarName",
   "get options.calendarName.toString",
   "call options.calendarName.toString",
-  "get this.calendar[Symbol.toPrimitive]",
-  "get this.calendar.toString",
-  "call this.calendar.toString",
+  "get this.calendar.id",
 ];
 const actual = [];
 

diff --git a/test/built-ins/Temporal/PlainDate/prototype/until/calendar-mismatch.js b/test/built-ins/Temporal/PlainDate/prototype/until/calendar-mismatch.js
@@ -3,12 +3,12 @@
 
 /*---
 esid: sec-temporal.plaindate.prototype.until
-description: RangeError thrown if calendars' toString results do not match
+description: RangeError thrown if calendars' id properties do not match
 features: [Temporal]
 ---*/
 
-const calendar1 = { toString() { return "A"; } };
-const calendar2 = { toString() { return "B"; } };
+const calendar1 = { id: "A" };
+const calendar2 = { id: "B" };
 
 const plainDate1 = new Temporal.PlainDate(2000, 1, 1, calendar1);
 const plainDate2 = new Temporal.PlainDate(2000, 1, 1, calendar2);

diff --git a/test/built-ins/Temporal/PlainDate/prototype/until/order-of-operations.js b/test/built-ins/Temporal/PlainDate/prototype/until/order-of-operations.js
@@ -29,12 +29,8 @@ const expected = [
   "get other.calendar.dateFromFields",
   "call other.calendar.dateFromFields",
   // CalendarEquals
-  "get this.calendar[Symbol.toPrimitive]",
-  "get this.calendar.toString",
-  "call this.calendar.toString",
-  "get other.calendar[Symbol.toPrimitive]",
-  "get other.calendar.toString",
-  "call other.calendar.toString",
+  "get this.calendar.id",
+  "get other.calendar.id",
   // CopyDataProperties
   "ownKeys options",
   "getOwnPropertyDescriptor options.roundingIncrement",

diff --git a/test/built-ins/Temporal/PlainDateTime/prototype/equals/calendar-checked.js b/test/built-ins/Temporal/PlainDateTime/prototype/equals/calendar-checked.js
@@ -9,26 +9,38 @@ features: [Temporal]
 ---*/
 
 const actual = [];
-const calendar1 = TemporalHelpers.toPrimitiveObserver(actual, "A", "calendar1");
-const calendar2 = TemporalHelpers.toPrimitiveObserver(actual, "A", "calendar2");
-const calendar3 = TemporalHelpers.toPrimitiveObserver(actual, "B", "calendar3");
+
+function makeCalendar(id, objectName) {
+  const calendar = {};
+  TemporalHelpers.observeProperty(actual, calendar, "id", id, objectName);
+  return calendar;
+}
+
+const calendar1 = makeCalendar("A", "calendar1");
+const calendar2 = makeCalendar("A", "calendar2");
+const calendar3 = makeCalendar("B", "calendar3");
 const dt1 = new Temporal.PlainDateTime(1976, 11, 18, 15, 23, 30, 123, 456, 789, calendar1);
 const dt1b = new Temporal.PlainDateTime(1976, 11, 18, 15, 23, 30, 123, 456, 789, calendar1);
 const dt2 = new Temporal.PlainDateTime(1976, 11, 18, 15, 23, 30, 123, 456, 789, calendar2);
 const dt3 = new Temporal.PlainDateTime(1976, 11, 18, 15, 23, 30, 123, 456, 789, calendar3);
+actual.splice(0);  // disregard the HasProperty checks done in the constructor
 
 assert.sameValue(dt1.equals(dt1b), true, "same calendar object");
 assert.compareArray(actual, []);
 
 assert.sameValue(dt1.equals(dt2), true, "same calendar string");
-assert.compareArray(actual, ["get calendar1.toString", "call calendar1.toString", "get calendar2.toString", "call calendar2.toString"]);
+assert.compareArray(actual, ["get calendar1.id", "get calendar2.id"]);
 
 actual.splice(0);  // empty it for the next check
 assert.sameValue(dt1.equals(dt3), false, "different calendar string");
-assert.compareArray(actual, ["get calendar1.toString", "call calendar1.toString", "get calendar3.toString", "call calendar3.toString"]);
+assert.compareArray(actual, ["get calendar1.id", "get calendar3.id"]);
 
-const calendar4 = { toString() { throw new Test262Error("should not call calendar4.toString") } };
-const calendar5 = { toString() { throw new Test262Error("should not call calendar5.toString") } };
+const calendar4 = {
+  get id() { TemporalHelpers.assertUnreachable('should not get calendar4.id'); },
+};
+const calendar5 = {
+  get id() { TemporalHelpers.assertUnreachable('should not get calendar5.id'); },
+};
 const dt4 = new Temporal.PlainDateTime(1976, 11, 18, 15, 23, 30, 123, 456, 789, calendar4);
 const dt5 = new Temporal.PlainDateTime(2019, 10, 29, 10, 46, 38, 271, 986, 102, calendar4);
 const dt6 = new Temporal.PlainDateTime(2019, 10, 29, 10, 46, 38, 271, 986, 102, calendar5);

diff --git a/test/built-ins/Temporal/PlainDateTime/prototype/since/different-calendars-throws.js b/test/built-ins/Temporal/PlainDateTime/prototype/since/different-calendars-throws.js
@@ -8,7 +8,7 @@ features: [Temporal]
 ---*/
 
 const dt1 = new Temporal.PlainDateTime(2000, 1, 1, 0, 0, 0, 0, 0, 0);
-const dt2 = new Temporal.PlainDateTime(2000, 1, 1, 0, 0, 0, 0, 0, 0, {});
+const dt2 = new Temporal.PlainDateTime(2000, 1, 1, 0, 0, 0, 0, 0, 0, { id: "custom" });
 
 assert.throws(
   RangeError,

diff --git a/test/built-ins/Temporal/PlainDateTime/prototype/since/order-of-operations.js b/test/built-ins/Temporal/PlainDateTime/prototype/since/order-of-operations.js
@@ -47,12 +47,8 @@ const expected = [
   "get other.calendar.dateFromFields",
   "call other.calendar.dateFromFields",
   // CalendarEquals
-  "get this.calendar[Symbol.toPrimitive]",
-  "get this.calendar.toString",
-  "call this.calendar.toString",
-  "get other.calendar[Symbol.toPrimitive]",
-  "get other.calendar.toString",
-  "call other.calendar.toString",
+  "get this.calendar.id",
+  "get other.calendar.id",
   // CopyDataProperties
   "ownKeys options",
   "getOwnPropertyDescriptor options.roundingIncrement",

diff --git a/test/built-ins/Temporal/PlainDateTime/prototype/toString/calendar-tostring.js b/test/built-ins/Temporal/PlainDateTime/prototype/toString/calendar-tostring.js
@@ -4,14 +4,18 @@
 /*---
 esid: sec-temporal.plaindatetime.protoype.tostring
 description: Number of observable 'toString' calls on the calendar for each value of calendarName
+includes: [temporalHelpers.js]
 features: [Temporal]
 ---*/
 
 let calls;
 const customCalendar = {
-  toString() {
+  get id() {
     ++calls;
     return "custom";
+  },
+  toString() {
+    TemporalHelpers.assertUnreachable('toString should not be called');
   }
 };
 const date = new Temporal.PlainDateTime(2000, 5, 2, 12, 34, 56, 987, 654, 321, customCalendar);
@@ -24,6 +28,6 @@ const date = new Temporal.PlainDateTime(2000, 5, 2, 12, 34, 56, 987, 654, 321, c
 ].forEach(([calendarName, expectedResult, expectedCalls]) => {
   calls = 0;
   const result = date.toString({ calendarName });
-  assert.sameValue(result, expectedResult, `toString output for calendarName = ${calendarName}`);
-  assert.sameValue(calls, expectedCalls, `calls to toString for calendarName = ${calendarName}`);
+  assert.sameValue(result, expectedResult, `id for calendarName = ${calendarName}`);
+  assert.sameValue(calls, expectedCalls, `calls to id getter for calendarName = ${calendarName}`);
 });