@akashic/engine-files-reftest-helper 1.2.3

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 DWANGO Co., Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+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.

package/README.md

@@ -0,0 +1,62 @@
+# engine-files-reftest-helper
+
+<p align="center">
+<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でエンコードした文字列を指定された形式で出力します。
+    * engine-files-reftest側で、その文字列をデコードして `msg.data.command.options.fileName` で指定されたファイル名でその画像を保存します。
+  * `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
+```
+
+そのコンテンツのエントリーポイントで以下のコードを追記します
+
+```javascript
+require("@akashic/engine-files-reftest-helper");
+```
+
+## ビルド方法
+
+**engine-files-reftest-helper** はTypeScriptで書かれたjsモジュールであるため、ビルドにはNode.jsが必要です。
+
+`npm run build` によりビルドできます。
+
+```sh
+npm install
+npm run build
+```
+
+## テスト方法
+
+1. [TSLint](https://github.com/palantir/tslint "TSLint")を使ったTypeScriptファイルのLint
+2. [remark](https://remark.js.org/ "remark")を使ったMarkdownファイルのLint
+
+がそれぞれ実行されます。
+
+```sh
+npm test
+```
+
+## 注意事項
+本ライブラリはブラウザ上で使うことを想定していますが、IE11等`globalThis.fetch`が無い環境では正しく動作しませんので、`globalThis.fetch`が存在する環境で本ライブラリを使用してください。
+
+TODO: `globalThis.fetch`が無い環境でも動作できるようにする
+
+## ライセンス
+本リポジトリは MIT 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/index.d.ts

@@ -0,0 +1,4 @@
+/** 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";

package/lib/index.js

@@ -0,0 +1,74 @@
+"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();
+    }
+}
+function finish() {
+    switch (outputType) {
+        case "post":
+            return postConsole({ commandName: "finish" });
+        case "console":
+            console.log(exports.END_NOTIFICATION_MESSAGE);
+            return Promise.resolve();
+    }
+}
+if (typeof g !== "undefined") {
+    const screenshotPromises = [];
+    const handleScenario = (msg) => {
+        var _a;
+        if (((_a = msg.data) === null || _a === void 0 ? void 0 : _a.type) === "scenario" && msg.data.command) {
+            const eventData = msg.data;
+            switch (eventData.command.name) {
+                case "init":
+                    const option = eventData.command.options;
+                    outputType = option.outputType;
+                    consoleApiUrl = option.outputUrl;
+                    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]));
+                        }
+                    }
+                    break;
+                case "finish":
+                    // スクリーンショット送信よりも finish() の通知が先に完了してしまうと、実行が中断されてスクリーンショットが取れない場合がある。それを避けるために完了を待ってから finish() する
+                    Promise.all(screenshotPromises).then(() => finish());
+                    break;
+                default:
+                    throw new Error(`${eventData.command.name} is undefined.`);
+            }
+        }
+    };
+    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/CommandName.d.ts

@@ -0,0 +1 @@
+export type CommandName = "init" | "screenshot" | "finish";

package/lib/types/CommandName.js

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

package/lib/types/ConsoleApiParameter.d.ts

@@ -0,0 +1,6 @@
+import type { CommandName } from "./CommandName";
+import type { ScreenshotData } from "./ScreenshotData";
+export interface ConsoleApiParameter {
+    commandName: CommandName;
+    screenshotData?: ScreenshotData;
+}

package/lib/types/ConsoleApiParameter.js

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

package/lib/types/InitCommandOption.d.ts

@@ -0,0 +1,5 @@
+import type { OutputType } from "./OutputType";
+export interface InitCommandOption {
+    outputType: OutputType;
+    outputUrl: string;
+}

package/lib/types/InitCommandOption.js

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

package/lib/types/OutputType.d.ts

@@ -0,0 +1 @@
+export type OutputType = "post" | "console";

package/lib/types/OutputType.js

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

package/lib/types/ScreenshotData.d.ts

@@ -0,0 +1,4 @@
+export interface ScreenshotData {
+    fileName: string;
+    base64: string;
+}

package/lib/types/ScreenshotData.js

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

package/lib/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./CommandName";
+export * from "./ConsoleApiParameter";
+export * from "./InitCommandOption";
+export * from "./OutputType";
+export * from "./ScreenshotData";

package/lib/types/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./CommandName"), exports);
+__exportStar(require("./ConsoleApiParameter"), exports);
+__exportStar(require("./InitCommandOption"), exports);
+__exportStar(require("./OutputType"), exports);
+__exportStar(require("./ScreenshotData"), exports);

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@akashic/engine-files-reftest-helper",
+  "version": "1.2.3",
+  "description": "engine-files-reftestでコンテンツを自動実行するためのライブラリ",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "scripts": {
+    "prepublish": "npm run build",
+    "build": "tsc -p .",
+    "test": "npm run lint:ts && npm run lint:md",
+    "lint:ts": "tslint -c tslint.json src/**/*.ts --project ./tsconfig.json",
+    "lint:md": "remark ./*.md --frail --no-stdout --quiet --rc-path ./.remarkrc"
+  },
+  "author": "DWANGO Co., Ltd.",
+  "license": "MIT",
+  "devDependencies": {
+    "@akashic/akashic-engine": "~2.6.7",
+    "@akashic/remark-preset-lint": "^0.1.2",
+    "remark-cli": "^12.0.0",
+    "tslint": "^5.20.1",
+    "typescript": "^5.3.3"
+  },
+  "files": [
+    "lib",
+    "package.json",
+    "README.md"
+  ],
+  "publishConfig": {
+    "@akashic:registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "akashic-games/engine-files-reftest-helper.git"
+  }
+}