スクリプトを V8 ランタイムに移行する

Rhino ランタイムを使用する既存のスクリプトがあり、V8 の構文と機能を使用する場合は、スクリプトを V8 に移行する必要があります。

Rhino ランタイムを使用して作成されたスクリプトの多くは、V8 ランタイムを使用して調整することなく実行できます。多くの場合、スクリプトに V8 構文と機能を追加するための前提条件は、V8 ランタイムを有効にすることだけです。

ただし、小さな非互換性とその他の違いにより、V8 ランタイムを有効にした後、スクリプトが想定外の動作をしたり動作が発生したりすることがあります。V8 を使用するようにスクリプトを移行する場合は、スクリプト プロジェクトでこれらの問題を検索し、見つかった問題を修正する必要があります。

V8 の移行手順

スクリプトを V8 に移行するには、次の手順を行います。

  1. スクリプトの V8 ランタイムを有効にします。
  2. 下記の非互換性について入念に確認します。スクリプトを調べて、互換性の問題があるかどうかを確認します。互換性の問題がある場合は、スクリプト コードを調整して、問題を修正または削除します。
  3. 下記のその他の違いを慎重に確認してください。スクリプトを調べ、リストされた相違点のいずれかがコードの動作に影響するかどうかを確認します。動作を修正するためにスクリプトを調整してください。
  4. 検出された非互換性やその他の相違を修正したら、必要に応じて V8 構文およびその他の機能を使用するようにコードを更新できます。
  5. コードの調整が完了したら、スクリプトを十分にテストして、想定どおりに動作することを確認します。
  6. スクリプトがウェブアプリまたは公開アドオンの場合は、V8 調整でスクリプトの新しいバージョンを作成する必要があります。ユーザーが V8 バージョンを使用できるようにするには、そのバージョンでスクリプトを再公開する必要があります。

非互換性

残念ながら、Rhino ベースの元の Apps Script ランタイムでは、いくつかの標準以外の ECMAScript の動作が許可されていました。V8 は標準に準拠しているため、移行後にこれらの動作はサポートされません。これらの問題を解決しないと、V8 ランタイムが有効になった後に、エラーまたはスクリプトの動作が不安定になります。

以降のセクションでは、これらの動作と、V8 への移行中にスクリプト コードを修正するために必要な手順について説明します。

for each(variable in object) を避ける

for each (variable in object) ステートメントは JavaScript 1.6 に追加され、for...of に置き換えられました。

スクリプトを V8 に移行する場合は、for each (variable in object) ステートメントを使用しないでください。

代わりに、for (variable in object) を使用します。

// Rhino runtime
var obj = {a: 1, b: 2, c: 3};

// Don't use 'for each' in V8
for each (var value in obj) {
  Logger.log("value = %s", value);
}
      
// V8 runtime
var obj = {a: 1, b: 2, c: 3};

for (var key in obj) {  // OK in V8
  var value = obj[key];
  Logger.log("value = %s", value);
}

Date.prototype.getYear() を避ける

元の Rhino ランタイムでは、Date.prototype.getYear() は 1900 ～ 1999 年の年については 2 桁の年を返しますが、それ以外の日付の場合は 4 桁の年を返します。これは JavaScript 1.2 以前の動作でした。

V8 ランタイムでは、Date.prototype.getYear() は ECMAScript 標準の要件に従い、年から 1,900 を引いた値を返します。

スクリプトを V8 に移行する場合は、常に Date.prototype.getFullYear() を使用してください。そうすることで、日付に関係なく 4 桁の年が返されます。

予約済みキーワードを名前に使用しない

ECMAScript では、関数や変数の名前に特定の予約済みキーワードを使用することはできません。Rhino ランタイムでは、これらの単語の多くが許可されていたため、コードでそれらが使用されている場合は、関数または変数の名前を変更する必要があります。

スクリプトを V8 に移行する場合は、予約済みキーワードのいずれかを使用して変数や関数に名前を付けることは避けてください。キーワード名を使用しないように変数または関数の名前を変更します。名前にキーワードを使用する一般的な用途は、class、import、export です。

const 変数の再代入を避ける

元の Rhino ランタイムでは、const を使用して変数を宣言できます。つまり、シンボルの値は変更されず、シンボルへの将来の割り当ては無視されます。

新しい V8 ランタイムでは、const キーワードは標準に準拠しており、const として宣言された変数に代入すると TypeError: Assignment to constant variable ランタイム エラーが発生します。

スクリプトを V8 に移行する際に、const 変数の値を再代入しないでください。

// Rhino runtime
const x = 1;
x = 2;          // No error
console.log(x); // Outputs 1
      
// V8 runtime
const x = 1;
x = 2;          // Throws TypeError
console.log(x); // Never executed

XML リテラルと XML オブジェクトを回避する

ECMAScript の標準以外の拡張機能により、Apps Script プロジェクトで XML 構文を直接使用できます。

スクリプトを V8 に移行する場合は、直接 XML リテラルまたは XML オブジェクトを使用しないでください。

代わりに、XmlService を使用して XML を解析します。

// V8 runtime
var incompatibleXml1 = <container><item/></container>;             // Don't use
var incompatibleXml2 = new XML('<container><item/></container>');  // Don't use

var xml3 = XmlService.parse('<container><item/></container>');     // OK

__iterator__ を使用してカスタム イテレータ関数を作成しない

JavaScript 1.7 では、クラスのプロトタイプで __iterator__ 関数を宣言して任意のクラスにカスタム イテレータを追加できる機能を追加しました。これは、デベロッパーの便宜上 Apps Script の Rhino ランタイムにも追加されています。ただし、この機能は ECMA-262 標準に含まれておらず、ECMAScript 準拠の JavaScript エンジンで削除されました。V8 を使用するスクリプトでは、このイテレータ構成は使用できません。

スクリプトを V8 に移行する場合は、__iterator__ 関数を避けてカスタム イテレータを作成します。代わりに、ECMAScript 6 イテレータを使用してください。

次の配列構成について考えてみましょう。

// Create a sample array
var myArray = ['a', 'b', 'c'];
// Add a property to the array
myArray.foo = 'bar';

// The default behavior for an array is to return keys of all properties,
//  including 'foo'.
Logger.log("Normal for...in loop:");
for (var item in myArray) {
  Logger.log(item);            // Logs 0, 1, 2, foo
}

// To only log the array values with `for..in`, a custom iterator can be used.

次のコードサンプルは、Rhino ランタイムでイテレータを構築する方法と、V8 ランタイムで置換イテレータを構築する方法を示しています。

// Rhino runtime custom iterator
function ArrayIterator(array) {
  this.array = array;
  this.currentIndex = 0;
}

ArrayIterator.prototype.next = function() {
  if (this.currentIndex
      >= this.array.length) {
    throw StopIteration;
  }
  return "[" + this.currentIndex
    + "]=" + this.array[this.currentIndex++];
};

// Direct myArray to use the custom iterator
myArray.__iterator__ = function() {
  return new ArrayIterator(this);
}


Logger.log("With custom Rhino iterator:");
for (var item in myArray) {
  // Logs [0]=a, [1]=b, [2]=c
  Logger.log(item);
}
      
// V8 runtime (ECMAScript 6) custom iterator
myArray[Symbol.iterator] = function() {
  var currentIndex = 0;
  var array = this;

  return {
    next: function() {
      if (currentIndex < array.length) {
        return {
          value: "[${currentIndex}]="
            + array[currentIndex++],
          done: false};
      } else {
        return {done: true};
      }
    }
  };
}

Logger.log("With V8 custom iterator:");
// Must use for...of since
//   for...in doesn't expect an iterable.
for (var item of myArray) {
  // Logs [0]=a, [1]=b, [2]=c
  Logger.log(item);
}

条件付き catch 句を使用しない

V8 ランタイムは標準に準拠していないため、catch..if 条件付き catch 句をサポートしていません。

スクリプトを V8 に移行する場合は、キャッチ条件をキャッチ本体内に移動します。

// Rhino runtime

try {
  doSomething();
} catch (e if e instanceof TypeError) {  // Don't use
  // Handle exception
}
      
// V8 runtime
try {
  doSomething();
} catch (e) {
  if (e instanceof TypeError) {
    // Handle exception
  }
}

Object.prototype.toSource() を使用しない

JavaScript 1.3 には、ECMAScript 標準に含まれていなかった Object.prototype.toSource() メソッドが含まれていました。V8 ランタイムではサポートされていません。

スクリプトを V8 に移行する際は、Object.prototype.toSource() を使用しているコードをコードからすべて削除してください。

その他の相違点

スクリプトの互換性を損なう可能性がある上記の非互換性に加え、他にもいくつかの原因があります。これを修正しないと、予期しない V8 ランタイム スクリプトの動作が発生する可能性があります。

以下のセクションでは、予想外の事態を回避するためにスクリプト コードを更新する方法について説明します。

ロケール固有の日時形式を調整する

Date メソッドの toLocaleString()、toLocaleDateString()、toLocaleTimeString() の動作は、Rhino と V8 ランタイムでは異なります。

Rhino のデフォルトの形式は長形式です。渡されたパラメータはすべて無視されます。

V8 ランタイムでは、デフォルトの形式は短い形式であり、渡されたパラメータは ECMA 標準に従って処理されます（詳細については、toLocaleDateString() のドキュメントをご覧ください）。

スクリプトを V8 に移行する際は、ロケール固有の日時メソッドの出力に関するコードの動作をテストして調整します。

// Rhino runtime
var event = new Date(
  Date.UTC(2012, 11, 21, 12));

// Outputs "December 21, 2012" in Rhino
console.log(event.toLocaleDateString());

// Also outputs "December 21, 2012",
//  ignoring the parameters passed in.
console.log(event.toLocaleDateString(
    'de-DE',
    { year: 'numeric',
      month: 'long',
      day: 'numeric' }));
 
// V8 runtime
var event = new Date(
  Date.UTC(2012, 11, 21, 12));

// Outputs "12/21/2012" in V8
console.log(event.toLocaleDateString());

// Outputs "21. Dezember 2012"
console.log(event.toLocaleDateString(
    'de-DE',
    { year: 'numeric',
      month: 'long',
      day: 'numeric' }));

Error.fileName と Error.lineNumber を使用しない

V8 デフォルトの場合、標準の JavaScript Error オブジェクトは、コンストラクタ パラメータまたはオブジェクト プロパティとして fileName または lineNumber をサポートしていません。

スクリプトを V8 に移行する際に、Error.fileName と Error.lineNumber への依存関係をすべて削除します。

または、Error.prototype.stack を使用する方法もあります。このスタックも標準ではありませんが、Rhino と V8 の両方でサポートされています。2 つのプラットフォームによって生成されるスタック トレースの形式は若干異なります。

// Rhino runtime Error.prototype.stack
// stack trace format
at filename:92 (innerFunction)
at filename:97 (outerFunction)



// V8 runtime Error.prototype.stack
// stack trace format
Error: error message
at innerFunction (filename:92:11)
at outerFunction (filename:97:5)

文字列化列挙型オブジェクトの処理を調整

元の Rhino ランタイムでは、enum オブジェクトで JavaScript JSON.stringify() メソッドを使用すると {} のみが返されます。

V8 では、列挙型オブジェクトで同じメソッドを使用すると、列挙型名が変わります。

スクリプトを V8 に移行する場合は、列挙型オブジェクトでの JSON.stringify() の出力に関するコード期待をテストして、調整します。

// Rhino runtime
var enumName =
  JSON.stringify(Charts.ChartType.BUBBLE);

// enumName evaluates to {}
 
// V8 runtime
var enumName =
  JSON.stringify(Charts.ChartType.BUBBLE);

// enumName evaluates to "BUBBLE"

未定義のパラメータの処理を調整する

元の Rhino ランタイムで、パラメータとして undefined をメソッドに渡したところ、文字列 "undefined" がそのメソッドに渡されました。

V8 でメソッドに undefined を渡すことは、null を渡すことと同じです。

スクリプトを V8 に移行する際に、undefined パラメータに関するコードの動作をテストして調整します。

// Rhino runtime
SpreadsheetApp.getActiveRange()
    .setValue(undefined);

// The active range now has the string
// "undefined"  as its value.
      
// V8 runtime
SpreadsheetApp.getActiveRange()
    .setValue(undefined);

// The active range now has no content, as
// setValue(null) removes content from
// ranges.

グローバル this の処理を調整

Rhino ランタイムは、それを使用するスクリプトに暗黙的な特別なコンテキストを定義します。スクリプト コードは、実際のグローバル this とは異なり、この暗黙のコンテキストで実行されます。つまり、コードの「グローバル」this への参照は、実際にはスクリプトで定義されているコードと変数のみを含む特別なコンテキストに評価されます。組み込みの Apps Script サービスと ECMAScript オブジェクトは、この this の使用から除外されます。この状況は、次の JavaScript の構造に似ています。

// Rhino runtime

// Apps Script built-in services defined here, in the actual global context.
var SpreadsheetApp = {
  openById: function() { ... }
  getActive: function() { ... }
  // etc.
};

function() {
  // Implicit special context; all your code goes here. If the global this
  // is referenced in your code, it only contains elements from this context.

  // Any global variables you defined.
  var x = 42;

  // Your script functions.
  function myFunction() {
    ...
  }
  // End of your code.
}();

V8 では、暗黙的な特殊コンテキストが削除されます。スクリプトで定義されたグローバル変数と関数は、組み込みの Apps Script サービスと ECMAScript の組み込み（Math や Date など）の横にグローバル コンテキストで配置されます。

スクリプトを V8 に移行する際は、this がグローバル コンテキストで使用される場合のコードの動作をテストして、調整してください。ほとんどの場合、違いは、コードによってグローバル this オブジェクトのキーまたはプロパティ名を調べる場合にのみ明らかになります。

// Rhino runtime
var myGlobal = 5;

function myFunction() {

  // Only logs [myFunction, myGlobal];
  console.log(Object.keys(this));

  // Only logs [myFunction, myGlobal];
  console.log(
    Object.getOwnPropertyNames(this));
}





      
// V8 runtime
var myGlobal = 5;

function myFunction() {

  // Logs an array that includes the names
  // of Apps Script services
  // (CalendarApp, GmailApp, etc.) in
  // addition to myFunction and myGlobal.
  console.log(Object.keys(this));

  // Logs an array that includes the same
  // values as above, and also includes
  // ECMAScript built-ins like Math, Date,
  // and Object.
  console.log(
    Object.getOwnPropertyNames(this));
}

ライブラリ内の instanceof の処理を調整する

別のプロジェクトの関数にパラメータとして渡されるオブジェクトでライブラリの instanceof を使用すると、偽陰性が生じる可能性があります。V8 ランタイムでは、プロジェクトとそのライブラリが異なる実行コンテキストで実行されるため、グローバルとプロトタイプのチェーンが異なります。

これは、プロジェクトで作成されていないオブジェクトでライブラリが instanceof を使用する場合にのみ当てはまります。プロジェクト内の同じスクリプトまたは別のスクリプトに関係なく、プロジェクトで作成されたオブジェクトで使用することで、想定どおりに機能します。

V8 で実行されているプロジェクトでスクリプトがライブラリとして使用されている場合は、別のプロジェクトから渡されるパラメータでスクリプトが instanceof を使用しているかどうかを確認します。instanceof の使用量を調整し、ユースケースに応じて他の可能な代替方法を使用してください。

a instanceof b の代わりに、プロトタイプ チェーン全体を検索する必要がなく、コンストラクタを確認するだけではない場合に、a のコンストラクタを使用することもできます。使用方法: a.constructor.name == "b"

プロジェクト A とプロジェクト B について考えてみましょう。ここで、プロジェクト A はプロジェクト B をライブラリとして使用します。

//Rhino runtime

//Project A

function caller() {
   var date = new Date();
   // Returns true
   return B.callee(date);
}

//Project B

function callee(date) {
   // Returns true
   return(date instanceof Date);
}

      
//V8 runtime

//Project A

function caller() {
   var date = new Date();
   // Returns false
   return B.callee(date);
}

//Project B

function callee(date) {
   // Incorrectly returns false
   return(date instanceof Date);
   // Consider using return (date.constructor.name ==
   // “Date”) instead.
   // return (date.constructor.name == “Date”) -> Returns
   // true
}

別の方法として、メイン プロジェクトで instanceof をチェックする関数を導入し、ライブラリ関数を呼び出すときに他のパラメータとともに関数を渡すこともできます。渡された関数を使用して、ライブラリ内の instanceof を確認できます。

//V8 runtime

//Project A

function caller() {
   var date = new Date();
   // Returns True
   return B.callee(date, date => date instanceof Date);
}

//Project B

function callee(date, checkInstanceOf) {
  // Returns True
  return checkInstanceOf(date);
}

非共有リソースのライブラリへの引き渡しを調整する

V8 ランタイムでは、メイン スクリプトからライブラリに非共有リソースを渡す方法が異なります。

Rhino ランタイムでは、共有されていないリソースを渡すことはできません。代わりに、ライブラリは独自のリソースを使用します。

V8 ランタイムでは、非共有リソースをライブラリに渡すことができます。ライブラリは、渡された共有されていないリソースを使用します。

共有されていないリソースを関数パラメータとして渡さないでください。非共有リソースは、必ずその同じスクリプトで宣言してください。

プロジェクト A とプロジェクト B について考えてみましょう。ここで、プロジェクト A はプロジェクト B をライブラリとして使用します。この例では、PropertiesService は共有されていないリソースです。

// Rhino runtime
// Project A
function testPassingNonSharedProperties() {
  PropertiesService.getScriptProperties()
      .setProperty('project', 'Project-A');
  B.setScriptProperties();
  // Prints: Project-B
  Logger.log(B.getScriptProperties(
      PropertiesService, 'project'));
}



//Project B
function setScriptProperties() {
  PropertiesService.getScriptProperties()
      .setProperty('project', 'Project-B');
}
function getScriptProperties(
    propertiesService, key) {
  return propertiesService.getScriptProperties()
      .getProperty(key);
}

// V8 runtime
// Project A
function testPassingNonSharedProperties() {
  PropertiesService.getScriptProperties()
      .setProperty('project', 'Project-A');
  B.setScriptProperties();
  // Prints: Project-A
  Logger.log(B.getScriptProperties(
      PropertiesService, 'project'));
}



// Project B
function setProperties() {
  PropertiesService.getScriptProperties()
        .setProperty('project', 'Project-B');
}
function getScriptProperties(
    propertiesService, key) {
  return propertiesService.getScriptProperties()
      .getProperty(key);
}

スタンドアロン スクリプトのアクセス権を更新する

V8 ランタイムで実行されるスタンドアロン スクリプトの場合、スクリプトのトリガーが正しく動作するためには、少なくともスクリプトの閲覧権限をユーザーに付与する必要があります。