@akashic/engine-files-reftest-helper 0.1.4 → 1.3.0-beta.0

package/LICENSE

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/README.md

@@ -1,21 +1,24 @@
 # engine-files-reftest-helper
 
 <p align="center">
-<img src="https://github.com/akashic-games/engine-files-reftest-helper/blob/ae1x-main/img/akashic.png"/>
+<img src="https://github.com/akashic-games/engine-files-reftest-helper/blob/main/img/akashic.png"/>
 </p>
 
 **engine-files-reftest-helper**は、engine-files-reftestでコンテンツを自動実行させるための補助ツールです。
 このツールでできることは以下の通りです。
 * playlogのうち、MessageEventを受け取って`data.type` が `scenario` の時、`msg.data.command.name` の値に応じて処理を実行します。
-  * `msg.data.command.name` が `screenshot` の時、スクリーンショットをBASE64でエンコードした文字列をconsole上に出力します。
+  * `msg.data.command.name` が `screenshot` の時、スクリーンショットをBASE64でエンコードした文字列を指定された形式で出力します。
     * engine-files-reftest側で、その文字列をデコードして `msg.data.command.options.fileName` で指定されたファイル名でその画像を保存します。
-  * `msg.data.command.name` が `finish` の時、engine-files-reftest側にスクリーンショット取得処理の要求を意味する文字列をconsole上に出力します。
+  * `msg.data.command.name` が `finish` の時、engine-files-reftest側にスクリーンショット取得処理の要求を意味する文字列を指定された形式で出力します。
+  * `msg.data.command.name` が `init` の時に、以下のように出力形式を指定することができます。
+    * `msg.data.command.options.outputType`: `console`でコンソール出力して、`post`で任意の HTTP エンドポイントに POST リクエストを送信します。出力形式はデフォルトではコンソール出力になっています。
+    * `msg.data.command.options.outputUrl`:`post`の時の送信先URLを指定します。
 
 ## 使い方
 engine-files-reftestのテスト対象コンテンツのディレクトリで以下のコマンドを実行します。
 
 ```sh
-akashic install @akashic/engine-files-reftest-helper@0
+akashic install @akashic/engine-files-reftest-helper
 ```
 
 そのコンテンツのエントリーポイントで以下のコードを追記します
@@ -45,9 +48,24 @@ npm run build
 ```sh
 npm test
 ```
+
+## 注意事項
+本ライブラリはブラウザ上で使うことを想定していますが、IE11等`globalThis.fetch`が無い環境では正しく動作しませんので、`globalThis.fetch`が存在する環境で本ライブラリを使用してください。
+
+TODO: `globalThis.fetch`が無い環境でも動作できるようにする
+
+## 開発者向け
+
+### 本ツールの publish について
+* 以下の手順を踏むことで publish が行われます。
+  1. package.json の version を更新したコミットを作成
+  2. 1 のコミットで master ブランチを更新する
+  3. GitHub Actions のリリースワークフローが実行される
+* package-lock.json が原因で publish に失敗した場合は、`npm i --before <実行時の7日前の日付(yyyy-mm-dd)>` を実行して package-lock.json を更新し、再度 publish 処理を行なってください。
+
 ## ライセンス
 本リポジトリは MIT License の元で公開されています。
-詳しくは [LICENSE](https://github.com/akashic-games/engine-files-reftest-helper/blob/ae1x-main/LICENSE) をご覧ください。
+詳しくは [LICENSE](https://github.com/akashic-games/engine-files-reftest-helper/blob/main/LICENSE) をご覧ください。
  
 ただし、画像ファイルおよび音声ファイルは
 [CC BY 2.1 JP](https://creativecommons.org/licenses/by/2.1/jp/) の元で公開されています。

package/lib/command.d.ts

@@ -0,0 +1,11 @@
+import type { ConsoleApiParameter, CustomWindow, OutputType } from "./types";
+/** engine-files-reftest側にスクリーンショットの保存を要求するためのメッセージ */
+export declare const SCREENSHOT_NOTIFICATION_MESSAGE = "engine-files-reftest:image";
+/** engine-files-reftest側にコンテンツ実行終了を要求するためのメッセージ */
+export declare const END_NOTIFICATION_MESSAGE = "engine-files-reftest:finish";
+export declare function postConsole(param: ConsoleApiParameter): Promise<Response>;
+export declare function screenshot(fileName: string, base64: string): Promise<Response | void>;
+export declare function finish(): Promise<Response | void>;
+export declare function getImageDataUrlFromCanvas(): string;
+export declare function getCustomWindow(): CustomWindow;
+export declare function setPropsToCustomWindow(outputType: OutputType, consoleApiUrl: string): void;

package/lib/command.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.END_NOTIFICATION_MESSAGE = exports.SCREENSHOT_NOTIFICATION_MESSAGE = void 0;
+exports.postConsole = postConsole;
+exports.screenshot = screenshot;
+exports.finish = finish;
+exports.getImageDataUrlFromCanvas = getImageDataUrlFromCanvas;
+exports.getCustomWindow = getCustomWindow;
+exports.setPropsToCustomWindow = setPropsToCustomWindow;
+// TODO 以下2つの定数は大規模化したら別リポジトリに切り出す
+/** engine-files-reftest側にスクリーンショットの保存を要求するためのメッセージ */
+exports.SCREENSHOT_NOTIFICATION_MESSAGE = "engine-files-reftest:image";
+/** engine-files-reftest側にコンテンツ実行終了を要求するためのメッセージ */
+exports.END_NOTIFICATION_MESSAGE = "engine-files-reftest:finish";
+function postConsole(param) {
+    const windowAsCustom = getCustomWindow();
+    const headers = {
+        "Accept": "application/json",
+        "Content-Type": "application/json; charset=utf-8"
+    };
+    return fetch(windowAsCustom.consoleApiUrl, { method: "POST", headers, body: JSON.stringify(param) });
+}
+function screenshot(fileName, base64) {
+    const windowAsCustom = getCustomWindow();
+    switch (windowAsCustom.outputType) {
+        case "post":
+            return postConsole({ commandName: "screenshot", screenshotData: { fileName, base64 } });
+        case "console":
+            console.log(exports.SCREENSHOT_NOTIFICATION_MESSAGE, fileName, base64);
+            return Promise.resolve();
+    }
+}
+function finish() {
+    const windowAsCustom = getCustomWindow();
+    switch (windowAsCustom.outputType) {
+        case "post":
+            return postConsole({ commandName: "finish" });
+        case "console":
+            console.log(exports.END_NOTIFICATION_MESSAGE);
+            return Promise.resolve();
+    }
+}
+function getImageDataUrlFromCanvas() {
+    getCustomWindow(); // window の存在確認 のために呼び出す
+    g.game.render(); // 描画がスキップされてしまうことがあるので、スクリーンショット取得前に現フレームでの描画を行う
+    const canvasElements = window.document.getElementsByTagName("canvas");
+    const imageUrl = canvasElements[0].toDataURL("image/png");
+    const data = imageUrl.match(/^data:image\/png;base64,(.+)$/);
+    if (!data) {
+        throw new Error("Invalid image data URL");
+    }
+    return data[1];
+}
+function getCustomWindow() {
+    if (typeof window === "undefined") {
+        throw new Error("window is undefined");
+    }
+    return window;
+}
+function setPropsToCustomWindow(outputType, consoleApiUrl) {
+    const windowAsCustom = getCustomWindow();
+    windowAsCustom.outputType = outputType;
+    windowAsCustom.consoleApiUrl = consoleApiUrl;
+}

package/lib/index.d.ts

@@ -1,4 +1 @@
-/** engine-files-reftest側にスクリーンショットの保存を要求するためのメッセージ */
-export declare const SCREENSHOT_NOTIFICATION_MESSAGE = "engine-files-reftest:image";
-/** engine-files-reftest側にコンテンツ実行終了を要求するためのメッセージ */
-export declare const END_NOTIFICATION_MESSAGE = "engine-files-reftest:finish";
+export {};

package/lib/index.js

@@ -1,37 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.END_NOTIFICATION_MESSAGE = exports.SCREENSHOT_NOTIFICATION_MESSAGE = void 0;
-let outputType = "console"; // デフォルトはコンソール出力とする
-let consoleApiUrl = "";
-// TODO 以下2つの定数は大規模化したら別リポジトリに切り出す
-/** engine-files-reftest側にスクリーンショットの保存を要求するためのメッセージ */
-exports.SCREENSHOT_NOTIFICATION_MESSAGE = "engine-files-reftest:image";
-/** engine-files-reftest側にコンテンツ実行終了を要求するためのメッセージ */
-exports.END_NOTIFICATION_MESSAGE = "engine-files-reftest:finish";
-function postConsole(param) {
-    const headers = {
-        "Accept": "application/json",
-        "Content-Type": "application/json; charset=utf-8"
-    };
-    return fetch(consoleApiUrl, { method: "POST", headers, body: JSON.stringify(param) });
-}
-function screenshot(fileName, base64) {
-    switch (outputType) {
-        case "post":
-            return postConsole({ commandName: "screenshot", screenshotData: { fileName, base64 } });
-        case "console":
-            console.log(exports.SCREENSHOT_NOTIFICATION_MESSAGE, fileName, base64);
-            return Promise.resolve();
-    }
+const command_1 = require("./command");
+try {
+    (0, command_1.setPropsToCustomWindow)("console", "");
 }
-function finish() {
-    switch (outputType) {
-        case "post":
-            return postConsole({ commandName: "finish" });
-        case "console":
-            console.log(exports.END_NOTIFICATION_MESSAGE);
-            return Promise.resolve();
-    }
+catch (e) {
+    // window がない環境で必ずエラーになるので無視する
 }
 if (typeof g !== "undefined") {
     const screenshotPromises = [];
@@ -42,32 +16,35 @@ if (typeof g !== "undefined") {
             switch (eventData.command.name) {
                 case "init":
                     const option = eventData.command.options;
-                    outputType = option.outputType;
-                    consoleApiUrl = option.outputUrl;
+                    try {
+                        (0, command_1.setPropsToCustomWindow)(option.outputType, option.outputUrl);
+                    }
+                    catch (e) {
+                        // window がない環境で必ずエラーになるので無視する
+                    }
                     break;
                 case "screenshot":
-                    if (typeof window !== "undefined") {
-                        g.game.render(); // 描画がスキップされてしまうことがあるので、スクリーンショット取得前に現フレームでの描画を行う
-                        const canvasElements = window.document.getElementsByTagName("canvas");
-                        const imageUrl = canvasElements[0].toDataURL("image/png");
-                        const data = imageUrl.match(/^data:image\/png;base64,(.+)$/);
-                        if (data.length === 2) {
-                            screenshotPromises.push(screenshot(eventData.command.options.fileName, data[1]));
-                        }
+                    try {
+                        const url = (0, command_1.getImageDataUrlFromCanvas)();
+                        screenshotPromises.push((0, command_1.screenshot)(eventData.command.options.fileName, url));
+                    }
+                    catch (e) {
+                        // window がない環境で必ずエラーになるので無視する
                     }
                     break;
                 case "finish":
                     // スクリーンショット送信よりも finish() の通知が先に完了してしまうと、実行が中断されてスクリーンショットが取れない場合がある。それを避けるために完了を待ってから finish() する
-                    Promise.all(screenshotPromises).then(() => finish());
+                    Promise.all(screenshotPromises).then(() => (0, command_1.finish)());
                     break;
                 default:
                     throw new Error(`${eventData.command.name} is undefined.`);
             }
         }
     };
-    g.game._sceneChanged.handle((scene) => {
-        if (!scene.message.isHandled(handleScenario)) {
-            scene.message.handle(handleScenario);
+    const handlerName = "reftest-helper";
+    g.game._sceneChanged.add((scene) => {
+        if (!scene.message.contains({ name: handlerName })) {
+            scene.message.add({ func: handleScenario, name: handlerName });
         }
     });
 }

package/lib/types/CustomWindow.d.ts

@@ -0,0 +1,5 @@
+import type { OutputType } from ".";
+export interface CustomWindow extends Window {
+    consoleApiUrl: string;
+    outputType: OutputType;
+}

package/lib/types/CustomWindow.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/index.d.ts

@@ -3,3 +3,4 @@ export * from "./ConsoleApiParameter";
 export * from "./InitCommandOption";
 export * from "./OutputType";
 export * from "./ScreenshotData";
+export * from "./CustomWindow";

package/lib/types/index.js

@@ -19,3 +19,4 @@ __exportStar(require("./ConsoleApiParameter"), exports);
 __exportStar(require("./InitCommandOption"), exports);
 __exportStar(require("./OutputType"), exports);
 __exportStar(require("./ScreenshotData"), exports);
+__exportStar(require("./CustomWindow"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akashic/engine-files-reftest-helper",
-  "version": "0.1.4",
+  "version": "1.3.0-beta.0",
   "description": "engine-files-reftestでコンテンツを自動実行するためのライブラリ",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -14,7 +14,7 @@
   "author": "DWANGO Co., Ltd.",
   "license": "MIT",
   "devDependencies": {
-    "@akashic/akashic-engine": "~1.14.0",
+    "@akashic/akashic-engine": "~2.6.7",
     "@akashic/remark-preset-lint": "^0.1.2",
     "remark-cli": "^12.0.0",
     "tslint": "^5.20.1",
@@ -25,13 +25,12 @@
     "package.json",
     "README.md"
   ],
+  "publishConfig": {
+    "@akashic:registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
   "repository": {
     "type": "git",
     "url": "akashic-games/engine-files-reftest-helper.git"
-  },
-  "publishConfig": {
-    "@akashic:registry": "https://registry.npmjs.org/",
-    "access": "public",
-    "tag": "for_ae1x"
   }
 }