【Firefox】super();呼ばなかったときのエラーメッセージを改善した【SpiderMonkey】

# はじめに

大学の実験でFirefoxのJavaScriptエンジン「SpiderMonkey」にコントリビュートする機会が得られたので、そのときに行った手順を具体的に残したいと思います。
SpiderMonkeyに変更を加えたい人の参考に少しでもなれば幸いです。

# あわせて読みたい

この記事は実験で実際に解決したSpiderMonkeyのIssueのうち「その2」についてです。

- [この実験についての詳細](http://snowman-mh.hatenablog.com/entry/2017/11/14/172328)
- [SpiderMonkeyのコミッターになる方法](https://qiita.com/snowman_mh/items/b2bc19d2af54d79c271a)
- [解決したIssueその1](https://qiita.com/snowman_mh/items/e52202eee378e8481d3b)
- [解決したIssueその3](https://qiita.com/snowman_mh/items/f71029c1bb3b942295d1)

# 変更内容

## バグレポート

今回取り組んだIssueはこちら。
https://bugzilla.mozilla.org/show_bug.cgi?id=1380990

つまり、

```js
$ cd js/src/build_DBG.OBJ
$ ./dist/bin/js temp1.js
ReferenceError: |this| used uninitialized in A class constructor
$ ./dist/bin/js temp2.js
ReferenceError: |this| used uninitialized in arrow function in class constructor
```

```js:temp1.js
class B {};
class A extends B {
    constructor() {
      this.someValue = 'value';
    }
}
new A();
```

```js:temp2.js
class B {};
class A extends B {
    constructor() {
        (() => {
            this.someValue = 'value';
        })()
    }
}
new A();
```

となっていたものを

```js
$ ./dist/bin/js temp1.js
ReferenceError: must call super constructor before using |this| in A class constructor
$ ./dist/bin/js temp2.js
ReferenceError: must call super constructor before using |this| in arrow function in derived class constructor
```

となるように変更しました。

## パッチ

今回行った変更内容のdiffはこちら。
https://hg.mozilla.org/mozilla-central/rev/fdb23b22f19a

## エラーメッセージ出力の仕組み

2, 3日ソースコードを眺めただけのやつが言うことなので、間違っているところ、勘違いしているところは多々あるかと思うので、優しく指摘していただけると嬉しいです。

- `js.msg`というファイルにエラーメッセージ一覧が定義されている
- `Parser.cpp`でパースするときや、`Interpreter.cpp`でバイトコードが解釈されるときに例外が起こったとき、`ReportなんとかErrorなんとか(...)`みたいな関数でエラーメッセージが出力される

## どう変更したか

具体的にどのような変更を行ったのか、先に簡単に紹介します。
といっても今回は文字列を変えただけなので超簡単な変更でした。

1. `js.msg`に定義されているエラーメッセージ2つを次のように変更

    ```js:Before
MSG_DEF(JSMSG_UNINITIALIZED_THIS,       1, JSEXN_REFERENCEERR, "|this| used uninitialized in {0} class constructor")
MSG_DEF(JSMSG_UNINITIALIZED_THIS_ARROW, 0, JSEXN_REFERENCEERR, "|this| used uninitialized in arrow function in class constructor")
    ```
    ```js:After
MSG_DEF(JSMSG_UNINITIALIZED_THIS,       1, JSEXN_REFERENCEERR, "must call super constructor before using |this| in {0} class constructor")
MSG_DEF(JSMSG_UNINITIALIZED_THIS_ARROW, 0, JSEXN_REFERENCEERR, "must call super constructor before using |this| in arrow function in derived class constructor")
    ```
1. エラーメッセージを変更したので、`js/src/jit-test/tests/debug/bug1385843.js`で期待する文字列も変更

    ```js:Before
assertEq(ex.message.includes("uninitialized"), true);
    ```
    ```js:After
assertEq(ex.message.includes("call super constructor"), true);
    ```
1. `js/src/tests/ecma_6/Class/uninitializedThisError.js`も同様に期待するエラーメッセージを変更

    ```js:Before
if (className !== "")
        expected = "|this| used uninitialized in " + className + " class constructor";
else
        expected = "|this| used uninitialized in arrow function in class constructor";
    ```
    ```js:After
if (className !== "")
        expected = "must call super constructor before using |this| in " + className + " class constructor";
    else
        expected = "must call super constructor before using |this| in arrow function in derived class constructor";
    ```

# どう手探ったか

それでは上記の変更箇所を具体的にどのように手探っていったかを残していきます。
例によって[Searchfox](https://searchfox.org/mozilla-central/source/)とか[DXR](https://dxr.mozilla.org/mozilla-central/source/)とかを利用すると快適にコードサーチできます。

1. `"|this| used uninitialized in"`で検索
2. 以下の2つのエラーメッセージが見つかる(と同時にこのエラーメッセージをテストしているテストケースも見つかる)

    ```js
MSG_DEF(JSMSG_UNINITIALIZED_THIS,       1, JSEXN_REFERENCEERR, "|this| used uninitialized in {0} class constructor")
MSG_DEF(JSMSG_UNINITIALIZED_THIS_ARROW, 0, JSEXN_REFERENCEERR, "|this| used uninitialized in arrow function in class constructor")
    ```
3. `"JSMSG_UNINITIALIZED_THIS"`で検索すると、使用されているところは1箇所しかなかったので、文字列を変えるだけで問題なさそうということが分かる。
4. 文字列を変更！
5. 次に`"JSMSG_UNINITIALIZED_THIS_ARROW"`で検索すると、こちらも使用箇所が1箇所しかなかったので、文字列を変えるだけで問題なさそうと分かる。
6. 文字列を変更！
7. `js/src/tests/ecma_6/Class/uninitializedThisError.js`でこのエラーメッセージに関するテストをしていることを最初に見つけていたので、今回の変更に合わせてテストを変更
8. 文字列変えるだけのお仕事だったぜ！と意気揚々とパッチを作ってBugzillaに投げ、レビューもしてもらってtry-runを走らせてもらいました。
9. しかし、try-runが落ちた！ try-runのログから原因を探してみると、`jit-test`というもので落ちていることが分かった。
10. `js/src/jit-test/tests/debug/bug1385843.js`で同じくエラーメッセージのテストをしているところを発見したので、ここも今回の変更に沿うように修正
11. 次はtry-runも通って無事本体に取り込まれました！