Merge branch 'dev/1.4' of https://github.com/galacean/engine into fea…

…t/editor_module

e2e/README.md

@@ -0,0 +1,43 @@
+### Note: Require install git-lfs
+We use [git-lfs](https://git-lfs.com/) (Install by official website) to manage baseline images for e2e tests, so it's necessary to install it, ignore if already installed.
+### 1. Create a case page in the e2e/case directory
+You can refer to e2e/case/animator-play.ts.
+### 2. Configure your e2e test in e2e/config.ts
+The threshold is color difference threshold (from 0 to 1). Less more precise.
+### 3. Debug your test cases:
+#### Launch the Case page:
+
+```
+npm run e2e:case
+```
+
+After successfully launching the case page, run:
+
+```
+git lfs pull
+```
+Pull image from github, then run
+
+```
+npm run e2e:debug
+```
+
+Open the Cypress client for debugging.
+Cypress will capture screenshots of your case pages.
+Review the screenshots in e2e/downloads folder, store them in the e2e/fixtures/originImage directory if there are no issues, then rerun the test cases. If the test cases pass, the debugging is complete.
+
+### 4. Run the complete e2e tests:
+```
+npm run e2e
+```
+Note: The e2e testing framework for this project is Cypress. For detailed usage instructions, please refer to https://www.cypress.io/.
+
+
+### Add new e2e case
+
+1. modify `config.ts` based on the new test case.
+2. run `npm run e2e:debug`
+
+the new image of test case for comparison will be present under directory `e2e/downloads`, you need to copy it into directory `e2e/fixtures/originImage`.
+
+

e2e/case/project-loader.ts

@@ -0,0 +1,29 @@
+/**
+ * @title Project loader
+ * @category Advance
+ */
+import { Logger, WebGLEngine, AssetType, Camera } from "@galacean/engine";
+import { ShaderLab } from "@galacean/engine-shader-lab";
+import { registerIncludes } from "@galacean/engine-toolkit";
+import { initScreenshot, updateForE2E } from './.mockForE2E';
+
+// Create ShaderLab
+const shaderLab = new ShaderLab();
+registerIncludes();
+
+Logger.enable();
+WebGLEngine.create({ canvas: "canvas", shaderLab }).then( (engine) => {
+  engine.canvas.resizeByClientSize(2);
+  engine.resourceManager
+    .load({
+      type: AssetType.Project,
+      url: "https://mdn.alipayobjects.com/oasis_be/afts/file/A*o15SSopTBh0AAAAAAAAAAAAADkp5AQ/project.json"
+    }).then(() => {
+      updateForE2E(engine);
+
+      const cameraEntity =
+        engine.sceneManager.activeScene.findEntityByName('Camera');
+      const camera = cameraEntity.getComponent(Camera)
+      initScreenshot(engine, camera)
+    })
+});

e2e/config.ts

@@ -226,5 +226,12 @@ export const E2E_CONFIG = {
       caseFileName: "text-typed",
       threshold: 0.4
     }
-  }
+  },
+  Other: {
+    ProjectLoader: {
+      category: "Advance",
+      caseFileName: "project-loader",
+      threshold: 0.4
+    }
+  },
 };

e2e/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@galacean/engine-e2e",
   "private": true,
-  "version": "1.3.15",
+  "version": "1.3.20",
   "license": "MIT",
   "scripts": {
     "case": "vite serve .dev --config .dev/vite.config.js",
     "b:types": "echo hi"
   },
   "files": [],
   "dependencies": {
-    "@galacean/engine-toolkit": "^1.0.0-beta.1",
+    "@galacean/engine-toolkit": "^1.3.9",
     "@galacean/engine-shader-lab": "workspace:*",
     "@galacean/engine": "workspace:*",
     "@galacean/engine-core": "workspace:*",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-root",
-  "version": "1.3.15",
+  "version": "1.3.20",
   "packageManager": "pnpm@9.3.0",
   "private": true,
   "scripts": {

packages/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-core",
-  "version": "1.3.15",
+  "version": "1.3.20",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"

packages/core/src/Background.ts

@@ -1,5 +1,5 @@
 import { Color, Vector2, Vector3 } from "@galacean/engine-math";
-import { CompareFunction, Material, ModelMesh, Shader } from ".";
+import { CompareFunction, ContentRestorer, Material, ModelMesh, Shader } from ".";
 import { Engine } from "./Engine";
 import { BackgroundMode } from "./enums/BackgroundMode";
 import { BackgroundTextureFillMode } from "./enums/BackgroundTextureFillMode";
@@ -134,7 +134,20 @@ export class Background {
   }
 
   private _initMesh(engine: Engine): void {
-    this._mesh = this._createPlane(engine);
+    const mesh = (this._mesh = this._createPlane(engine));
+    engine.resourceManager.addContentRestorer(
+      new (class extends ContentRestorer<ModelMesh> {
+        constructor() {
+          super(mesh);
+        }
+        restoreContent() {
+          mesh.setPositions(mesh.getPositions());
+          mesh.setUVs(mesh.getUVs());
+          mesh.setIndices(mesh.getIndices());
+          mesh.uploadData(false);
+        }
+      })()
+    );
     this._mesh._addReferCount(1);
   }
 

packages/core/src/BasicResources.ts

@@ -171,8 +171,19 @@ export class BasicResources {
     const mesh = new ModelMesh(engine);
     mesh._addReferCount(1);
     mesh.setVertexElements([new VertexElement("POSITION_UV", 0, VertexElementFormat.Vector4, 0)]);
-    mesh.setVertexBufferBinding(new Buffer(engine, BufferBindFlag.VertexBuffer, vertices, BufferUsage.Static), 16);
+    const buffer = new Buffer(engine, BufferBindFlag.VertexBuffer, vertices, BufferUsage.Static, true);
+    mesh.setVertexBufferBinding(buffer, 16);
     mesh.addSubMesh(0, 3, MeshTopology.Triangles);
+    engine.resourceManager.addContentRestorer(
+      new (class extends ContentRestorer<ModelMesh> {
+        constructor() {
+          super(mesh);
+        }
+        restoreContent() {
+          buffer.setData(buffer.data);
+        }
+      })()
+    );
     return mesh;
   }
 

packages/core/src/Utils.ts

@@ -78,6 +78,12 @@ export class Utils {
       return relativeUrl;
     }
 
+    if (!/^https?:/.test(baseUrl)) {
+      const fileSchema = "files://";
+      baseUrl = fileSchema + baseUrl;
+      return new URL(relativeUrl, baseUrl).href.substring(fileSchema.length);
+    }
+
     return relativeUrl ? new URL(relativeUrl, baseUrl).href : baseUrl;
   }
 

packages/core/src/asset/Loader.ts

@@ -41,5 +41,4 @@ export abstract class Loader<T> {
   constructor(public readonly useCache: boolean) {}
   initialize?(engine: Engine, configuration: EngineConfiguration): Promise<void>;
   abstract load(item: LoadItem, resourceManager: ResourceManager): AssetPromise<T>;
-  request: <U>(url: string, config: RequestConfig) => AssetPromise<U> = request;
 }