[JavaScript]mochaを使ったテストにおけるthisの意味

Question

お世話になります。
あるスマートコントラクトのテストで下記のようにthisを使って変数を指定している部分があるのですが、このthisがどのような意図で使われているのか分からないので、ご教授いただけると幸いです。

thisがこのcontract自体のオブジェクトだと思うのですが、外からインスタンスを作ってこれらの変数にアクセスしないので、beforeEachの外側でletやconstなどで宣言して、そこに代入でも良いのではと考えています。

正直あまり理解できていないので的外れなことを言っているかもしれないのですが、ご回答よろしくお願いします。

###サンプルコード

contract("SampleContract", function(){
  beforeEach(async () => {
    this.name = "name"
    this.value = "value"
  });

  describe('functions', () => {
    it('should be correct return', async () => {
       await SampleContract.new(this.name, this.value);
       // 以下省略
    });
  })
}

以下追記

変に省略してしまい、逆に混乱させてしまって申し訳ありません。
こちらが参考にしていたテストです。この中の1つが下記のコードです。
コードの中でlet tokenと宣言したり、this.startBlockに代入したり、使い分けている様なのですが、どの様な意図で使い分けているか分からないため質問させて頂きました。

import alis from '../utilities/alis';
import ether from './helpers/ether';
import EVMThrow from './helpers/EVMThrow';

import { AlisToken, AlisCrowdsale, should, cap, tokenCap, rate, icoStartTime,
  initialAlisFundBalance, goal, whiteList,
} from './helpers/alis_helper';

contract('AlisToken', ([wallet]) => {
  let token;
  const expectedTokenSupply = alis(240000000);

  beforeEach(async function () {
    this.startBlock = web3.eth.blockNumber + 10;
    this.endBlock = web3.eth.blockNumber + 20;

    this.crowdsale = await AlisCrowdsale.new(this.startBlock, icoStartTime, this.endBlock,
      rate.base, wallet, ether(cap), alis(tokenCap), initialAlisFundBalance, ether(goal), whiteList);

    token = AlisToken.at(await this.crowdsale.token());
  });

  it('owner should be able to burn tokens', async () => {
    const { logs } = await token.burn(alis(10000000), { from: wallet });

    const balance = await token.balanceOf(wallet);
    balance.should.be.bignumber.equal(expectedTokenSupply);

    const totalSupply = await token.totalSupply();
    totalSupply.should.be.bignumber.equal(expectedTokenSupply);

    const event = logs.find(e => e.event === 'Burn');
    should.exist(event);
  });

  it('cannot burn more tokens than your balance', async () => {
    await token.burn(alis(260000000), { from: wallet })
      .should.be.rejectedWith(EVMThrow);
  });
});

Comments

[Lhankor_Mhy]

> thisがこのcontract自体のオブジェクト
そうなんですか……？
このコードだけでは、そう言えないような気がするのですが、ちょっと混乱してきました。

ログを取って確認するとかはどうでしょうか？

[Lhankor_Mhy]

なかなかご質問の内容が把握できないでいます。
つまり、dounatsuさんは、

function(){
let value = 1;
}

と

function(){
this.value = 1;
}

は、同じことだ、とお考えになっているということですか？

[dounatsu]

混乱させてしまって申し訳ありません。
まず、このthisが何を指すのかがあまり理解できていないくて、仮にグローバルだとして、何故この様に変数を指定するのか疑問だったのが始まりです。
グローバルにするメリットは特に見当たらなくて、普通にletやconstで変数を指定すれば良いだけのところをこの様にthis.value等で指定するには何かしらの理由があるのだろうという質問の意図でした。
このテスト例に限らず、他のテストでも同じ様にthisを使って変数を指定しているものを見かけたので、mochaを使ったテストでこの様に変数を指定する理由をご教授頂きたいと考えています。

[Lhankor_Mhy]

サンプルコードはアロー式ですが、追記のコードは関数式でした。
これはthisの振る舞いに影響を与えるはずなのですが、両方とも正しいコードであると理解していいでしょうか？

[Lhankor_Mhy]

あ、beforeEach についてです。

[dounatsu]

アロー式と関数式の違いについてコメント頂いて思い出しました。アロー式は私が勝手に作ったものなので、正しくは関数式です。申し訳ありません。ですのでthisは呼び出し元のオブジェクトを参照すると思うのですが、何れにせよthis.valueの様に定義するメリットがいまいち理解できません。

Answer 1

このthis自体は"the Mocha context"と呼ばれるもののようですね。
https://mochajs.org/#arrow-functions

例えば、テスト毎のtimeoutを調整するときにthisがずれると扱いづらいのでarrow functionはやめとけって書いてあるようです。

ここの回答も参考になりそうです。
https://stackoverflow.com/questions/27575423/mocha-and-the-this-context

Yep, each describe gets a new Context object. (All the classes I mention can be found in Mocha's source code.)

describeでthisが作られて、this.test.parentの形で親のcontextを取ってこれたり(?)するようです。そこまで複雑なことをするのは稀だとは思いますが..。

---

クロージャで渡すのも基本問題ないと思います。

自分だとdescribe毎の定数的なものはクロージャで、beforeなどで動的に生成するものはthisに格納するというような使い分けをしています。

それから↓みたいなときも、thisで書いてくと扱いやすい。

const {createToken} = require('./utils')

describe('test1', function() {
  before(createToken)
  it('...', function() {
    const {token} = this
    // ...
  })
})
describe('test2', function() {
  before(createToken)
  // ...
})

結論、ケースバイケースで良い気もします。

Comments

[dounatsu]

そういうことなんですね！ありがとうございます！

Answer 2

function contract ( _, f ){
  f();
}
function beforeEach ( f ){
  f();
}

contract("SampleContract", function(){
  beforeEach(() => {
    this.name = "name"
    this.value = "value"
    console.log(this); // === global object
  });
});

枝葉を払ってみたところ、thisはグローバルオブジェクトでした。
なので、ご提示のコードだけではthisが何であるかはわからないと思います。

質問の編集にあわせて追記

元になるモジュールなどが不明のため、「それらは全然違うものだから」という回答になってしまうかと思います。（なお、アロー式ではなく関数式とのことなので、thisはグローバルオブジェクトになりません）

var obj = {
  value: 0,
  method: function(){}
}

var sendToMethod = function(f){
  obj.method = f;
  obj.method();
}

function main(){
  let value = 100;
  sendToMethod(function(){
    this.value = 1;
  });
  console.log(value); // 100
  console.log(this.value); // undefined
  console.log(obj.value); // 1
}

main();

補足いただいた「メリットは特に見当たらない」とお考えになる理由をお示しいただけますと、もう少しお役に立てる回答ができるかもしれません。

Comments

[dounatsu]

ご回答ありがとうございます。コードを追加しました。これで分かれば良いのですが。。。

[Lhankor_Mhy]

追記しました

[dounatsu]

ご回答ありがとうございます。ご回答頂いた例でいうと、インスタンスを作って変数を外から参照するのであればthis.valueの様にして値を代入するのは理解できるのですが、私が添付したテストの例では特にその様にしているコードが見受けられなかった（見落としているだけかもしれませんが。）ので、普通にletを使って変数を定義しても結果は同じなのではと思っています（実際に追記したコードについてlet tokenという記述もあります）。他のテストの例でもthis.valueの様に定義している例を見かけたので、わざわざその様にするテスト特有の理由があるのではないかというのが元々の質問の意図でした。

[Lhankor_Mhy]

回答で例示したとおり、関数式は this を束縛します。
たとえば、beforeEach関数での引数の処理によって this の内容が異なってくるのですが、dounatsu さんは、その内部のコードまで読んで「特にその様にしているコードが見受けられなかった」と書かれているのですか？

[Lhankor_Mhy]

といいますか、コードを読んで悩むより、this の中身を確かめる方が手っ取り早いと思います。

[Lhankor_Mhy]

仮に、dounatsu さんのおっしゃることが正しくて this が束縛されていない場合、this はやはりグローバルオブジェクトを指します。なので this.value のような表現はグローバル変数 value と等価です。
ご質問は「グローバル変数じゃなくてもいいのにグローバル変数にするのはなぜですか」という内容になるのですが、その理解で合っていますか？

[dounatsu]

そうですね。単純にthis.valueをlet valueで宣言し直してテストを行ってもパスする（少なくとも手元の例では）ので、わざわざthis.valueとする理由が知りたいというのが質問です。何かしらの意図を持って使い分けている様に見えるのでその理由が知りたいと考えています。

[Lhankor_Mhy]

なるほど、↓みたいにしてもテスト通るんですね。
let crowdsale = await AlisCrowdsale ...

そうすると、たしかにテストの範囲では無関係ってことになりますね。
あるとすれば、テストの範囲外で必要になる場合でしょうか。やはり、this の中身を調べた方が手っ取り早い気がしますね。

[dounatsu]

thisの中身は正直良く理解できませんでした。プロパティ見る限りitぽいのですが。。。