@shopware-ag/dive 1.17.2 → 1.18.0

package/src/scene/root/__test__/Root.test.ts

@@ -14,192 +14,6 @@ import { DIVECommunication } from '../../../com/Communication';
 import { type DIVESceneObject } from '../../../types';
 import { Vector3, Mesh, Box3, Object3D } from 'three';
 
-jest.mock('three', () => {
-    return {
-        Vector3: jest.fn(function (x: number, y: number, z: number) {
-            this.x = x;
-            this.y = y;
-            this.z = z;
-            this.copy = (vec3: Vector3) => {
-                this.x = vec3.x;
-                this.y = vec3.y;
-                this.z = vec3.z;
-                return this;
-            };
-            this.set = (x: number, y: number, z: number) => {
-                this.x = x;
-                this.y = y;
-                this.z = z;
-                return this;
-            };
-            this.multiply = (vec3: Vector3) => {
-                this.x *= vec3.x;
-                this.y *= vec3.y;
-                this.z *= vec3.z;
-                return this;
-            };
-            this.clone = () => {
-                return new Vector3(this.x, this.y, this.z);
-            };
-            this.setY = (y: number) => {
-                this.y = y;
-                return this;
-            };
-            this.add = (vec3: Vector3) => {
-                this.x += vec3.x;
-                this.y += vec3.y;
-                this.z += vec3.z;
-                return this;
-            };
-            this.sub = (vec3: Vector3) => {
-                this.x -= vec3.x;
-                this.y -= vec3.y;
-                this.z -= vec3.z;
-                return this;
-            };
-            return this;
-        }),
-        Object3D: jest.fn(function () {
-            this.isObject3D = true;
-            this.clear = jest.fn();
-            this.color = {};
-            this.intensity = 0;
-            this.layers = {
-                mask: 0,
-            };
-            this.userData = {};
-            this.shadow = {
-                radius: 0,
-                mapSize: { width: 0, height: 0 },
-                bias: 0,
-                camera: {
-                    near: 0,
-                    far: 0,
-                    fov: 0,
-                },
-            };
-            this.add = jest.fn();
-            this.attach = jest.fn();
-            this.remove = jest.fn();
-            this.sub = jest.fn();
-            this.children = [
-                {
-                    visible: true,
-                    material: {
-                        color: {},
-                    },
-                    userData: {},
-                },
-            ];
-            this.userData = {};
-            this.position = new Vector3();
-            this.rotation = {
-                x: 0,
-                y: 0,
-                z: 0,
-                setFromVector3: jest.fn(),
-            };
-            this.scale = {
-                x: 1,
-                y: 1,
-                z: 1,
-                set: jest.fn(),
-            };
-            this.localToWorld = (vec3: Vector3) => {
-                return vec3;
-            };
-            this.mesh = new Mesh();
-            this.traverse = jest.fn((callback) => {
-                callback(this);
-                for (let i = 0; i < this.children.length; i++) {
-                    callback(this.children[i]);
-                }
-            });
-            this.parent = {
-                parent: null,
-            };
-            return this;
-        }),
-        Box3: jest.fn(function () {
-            this.min = new Vector3(Infinity, Infinity, Infinity);
-            this.max = new Vector3(-Infinity, -Infinity, -Infinity);
-            this.getCenter = jest.fn(() => {
-                return new Vector3(0, 0, 0);
-            });
-            this.expandByObject = jest.fn();
-            this.setFromObject = jest.fn();
-
-            return this;
-        }),
-        Raycaster: jest.fn(function () {
-            this.intersectObjects = jest.fn();
-            this.layers = {
-                mask: 0,
-            };
-            return this;
-        }),
-        Mesh: jest.fn(function () {
-            this.geometry = {
-                computeBoundingBox: jest.fn(),
-                boundingBox: new Box3(),
-            };
-            this.material = {};
-            this.castShadow = true;
-            this.receiveShadow = true;
-            this.layers = {
-                mask: 0,
-            };
-            this.updateWorldMatrix = jest.fn();
-            this.traverse = jest.fn();
-            this.removeFromParent = jest.fn();
-            this.localToWorld = (vec3: Vector3) => {
-                return vec3;
-            };
-            return this;
-        }),
-        BufferGeometry: jest.fn(function () {
-            this.setAttribute = jest.fn();
-            this.setIndex = jest.fn();
-            this.translate = jest.fn();
-            return this;
-        }),
-        CylinderGeometry: jest.fn(function () {
-            this.translate = jest.fn();
-            return this;
-        }),
-        SphereGeometry: jest.fn(function () {
-            this.translate = jest.fn();
-            return this;
-        }),
-        BoxGeometry: jest.fn(function () {
-            this.translate = jest.fn();
-            return this;
-        }),
-        ConeGeometry: jest.fn(function () {
-            this.rotateY = jest.fn();
-            this.translate = jest.fn();
-            return this;
-        }),
-        Float32BufferAttribute: jest.fn(function () {
-            return this;
-        }),
-        Uint32BufferAttribute: jest.fn(function () {
-            return this;
-        }),
-        MeshStandardMaterial: jest.fn(function () {
-            this.color = {};
-            this.roughness = 0;
-            this.roughnessMap = undefined;
-            this.metalness = 0;
-            this.metalnessMap = undefined;
-            return this;
-        }),
-        Color: jest.fn(function () {
-            return this;
-        }),
-    };
-});
-
 jest.mock('../../../com/Communication.ts', () => {
     return {
         DIVECommunication: {
@@ -415,6 +229,8 @@ let root: DIVERoot;
 
 let spyConsoleWarn = jest.spyOn(console, 'warn').mockImplementation(() => {});
 
+Object3D.prototype.attach = jest.fn();
+
 describe('DIVE/scene/root/DIVERoot', () => {
     beforeEach(() => {
         root = new DIVERoot();
@@ -598,7 +414,7 @@ describe('DIVE/scene/root/DIVERoot', () => {
         ).not.toThrow();
         expect(() =>
             root.AddSceneObject({
-                id: 'id0',
+                id: 'id10',
                 name: 'Group',
                 entityType: 'group',
                 visible: true,
@@ -705,6 +521,7 @@ describe('DIVE/scene/root/DIVERoot', () => {
                 parentId: 'id_groupparent',
             } as COMGroup),
         ).not.toThrow();
+
         expect(() =>
             root.UpdateSceneObject({
                 id: 'id_groupchild',
@@ -856,7 +673,7 @@ describe('DIVE/scene/root/DIVERoot', () => {
                 visible: true,
             } as COMPrimitive),
         ).not.toThrow();
-        expect(spyConsoleWarn).not.toHaveBeenCalled();
+        expect(spyConsoleWarn).toHaveBeenCalled();
 
         spyConsoleWarn.mockClear();
         expect(() =>
@@ -877,6 +694,7 @@ describe('DIVE/scene/root/DIVERoot', () => {
                 remove: jest.fn(),
             },
         } as unknown as DIVESceneObject);
+
         expect(() =>
             root.DeleteSceneObject({
                 id: 'id',

package/src/toolbox/__test__/BaseTool.test.ts

@@ -1,9 +1,10 @@
 import { DIVEBaseTool } from '../BaseTool';
 import type DIVEOrbitControls from '../../controls/OrbitControls';
 import type { DIVEScene } from '../../scene/Scene';
-import { type Intersection, type Object3D, type Vector3 } from 'three';
+import { Vector3, type Intersection, type Object3D } from 'three';
 import { type DIVEHoverable } from '../../interface/Hoverable';
 import { type DIVEDraggable } from '../../interface/Draggable';
+import { RaycasterIntersectObjectMock } from '../../../__mocks__/three';
 
 /**
  * @jest-environment jsdom
@@ -60,19 +61,17 @@ describe('dive/toolbox/DIVEBaseTool', () => {
 
     it('should raycast', () => {
         const toolBox = new abstractWrapper(mockScene, mockController);
-        const spy = jest
-            .spyOn(toolBox['_raycaster'], 'intersectObjects')
-            .mockImplementationOnce(() => {
-                return [
-                    {
-                        object: {
-                            visible: true,
-                        },
-                    } as unknown as Intersection,
-                ];
-            });
+        RaycasterIntersectObjectMock.mockImplementationOnce(() => {
+            return [
+                {
+                    object: {
+                        visible: true,
+                    },
+                } as unknown as Intersection,
+            ];
+        });
         expect(() => toolBox['raycast']()).not.toThrow();
-        expect(spy).toHaveBeenCalled();
+        expect(RaycasterIntersectObjectMock).toHaveBeenCalled();
     });
 
     it('should raycast with selection of objects', () => {
@@ -179,11 +178,10 @@ describe('dive/toolbox/DIVEBaseTool', () => {
         const toolBox = new abstractWrapper(mockScene, mockController);
         jest.spyOn(toolBox['_raycaster'], 'setFromCamera').mockImplementation();
 
+        const spy = jest.spyOn(toolBox['_raycaster'], 'intersectObjects');
+
         // test with no hit with hovered object before
-        jest.spyOn(
-            toolBox['_raycaster'],
-            'intersectObjects',
-        ).mockReturnValueOnce([]);
+        spy.mockReturnValue([]);
 
         toolBox['_hovered'] = {
             uuid: 'uuid',
@@ -215,10 +213,7 @@ describe('dive/toolbox/DIVEBaseTool', () => {
         ).not.toThrow();
 
         // test with no hovered object
-        jest.spyOn(
-            toolBox['_raycaster'],
-            'intersectObjects',
-        ).mockReturnValueOnce([
+        spy.mockReturnValue([
             {
                 distance: 1,
                 point: {
@@ -259,10 +254,7 @@ describe('dive/toolbox/DIVEBaseTool', () => {
         ).not.toThrow();
 
         // test with no hovered object with onPointerEnter
-        jest.spyOn(
-            toolBox['_raycaster'],
-            'intersectObjects',
-        ).mockReturnValueOnce([
+        spy.mockReturnValue([
             {
                 distance: 1,
                 point: {
@@ -304,10 +296,7 @@ describe('dive/toolbox/DIVEBaseTool', () => {
         ).not.toThrow();
 
         // test with same hovered object
-        jest.spyOn(
-            toolBox['_raycaster'],
-            'intersectObjects',
-        ).mockReturnValueOnce([
+        spy.mockReturnValue([
             {
                 distance: 1,
                 point: {
@@ -357,17 +346,10 @@ describe('dive/toolbox/DIVEBaseTool', () => {
         ).not.toThrow();
 
         // test with different hovered object
-        jest.spyOn(
-            toolBox['_raycaster'],
-            'intersectObjects',
-        ).mockReturnValueOnce([
+        spy.mockReturnValue([
             {
                 distance: 1,
-                point: {
-                    x: 1,
-                    y: 1,
-                    z: 1,
-                } as unknown as Vector3,
+                point: new Vector3(1, 1, 1),
                 object: {
                     uuid: 'uuid2',
                     isHoverable: true,
@@ -457,6 +439,8 @@ describe('dive/toolbox/DIVEBaseTool', () => {
                 offsetY: 100,
             } as PointerEvent),
         ).not.toThrow();
+
+        spy.mockRestore();
     });
 
     it('should execute onPointerUp correctly', () => {
@@ -527,6 +511,10 @@ describe('dive/toolbox/DIVEBaseTool', () => {
         expect(() => toolBox.onDragStart({} as PointerEvent)).not.toThrow();
 
         toolBox['_dragRaycastOnObjects'] = [];
+        jest.spyOn(
+            toolBox['_raycaster'],
+            'intersectObjects',
+        ).mockReturnValueOnce([]);
         expect(() => toolBox.onDragStart({} as PointerEvent)).not.toThrow();
 
         jest.spyOn(
@@ -569,6 +557,10 @@ describe('dive/toolbox/DIVEBaseTool', () => {
                 return;
             },
         } as unknown as Object3D & DIVEDraggable;
+        jest.spyOn(
+            toolBox['_raycaster'],
+            'intersectObjects',
+        ).mockReturnValueOnce([]);
         expect(() => toolBox.onDragStart({} as PointerEvent)).not.toThrow();
     });
 
@@ -577,6 +569,10 @@ describe('dive/toolbox/DIVEBaseTool', () => {
         expect(() => toolBox.onDrag({} as PointerEvent)).not.toThrow();
 
         toolBox['_dragRaycastOnObjects'] = [];
+        jest.spyOn(
+            toolBox['_raycaster'],
+            'intersectObjects',
+        ).mockReturnValueOnce([]);
         expect(() => toolBox.onDrag({} as PointerEvent)).not.toThrow();
 
         toolBox['_draggable'] = {

package/src/toolbox/select/__test__/SelectTool.test.ts

@@ -9,13 +9,6 @@ import { type DIVEBaseTool } from '../../BaseTool';
 import { DIVEAnimationSystem } from '../../../animation/AnimationSystem';
 import { Tween } from '@tweenjs/tween.js';
 
-jest.mock('@tweenjs/tween.js', () => {
-    return {
-        Tween: jest.fn(() => {}),
-        update: jest.fn(),
-    };
-});
-
 jest.mock('../../../renderer/Renderer', () => {
     return jest.fn(function () {
         return this;
@@ -76,74 +69,6 @@ jest.mock('../../../scene/Scene', () => {
     };
 });
 
-const mock_intersectObjects = jest.fn().mockReturnValue([]);
-
-jest.mock('three', () => {
-    return {
-        Vector2: jest.fn(function () {
-            return this;
-        }),
-        Vector3: jest.fn(function () {
-            return this;
-        }),
-        Raycaster: jest.fn(function () {
-            this.setFromCamera = jest.fn();
-            this.intersectObjects = mock_intersectObjects;
-            this.layers = {
-                mask: 0,
-            };
-            return this;
-        }),
-    };
-});
-
-const mock_attach = jest.fn();
-const mock_detach = jest.fn();
-
-jest.mock('three/examples/jsm/controls/TransformControls', () => {
-    return {
-        TransformControls: jest.fn(function () {
-            this.isTransformControls = true;
-            this.addEventListener = jest.fn(
-                (type: string, callback: (e: object) => void) => {
-                    callback({ value: false });
-                    this.object = {};
-                    callback({ value: false });
-                    this.object = {
-                        onMove: 'hello',
-                    };
-                    callback({ value: false });
-                    this.object = {
-                        onMove: jest.fn(),
-                    };
-                    callback({ value: false });
-                },
-            );
-            this.attach = jest.fn((object) => {
-                this.object = object;
-            });
-            this.detach = jest.fn(() => {
-                this.object = null;
-            });
-            this.traverse = function (callback: (obj: object) => void) {
-                callback(this);
-            };
-            this.setMode = jest.fn();
-            this.getRaycaster = jest.fn().mockReturnValue({
-                layers: {
-                    mask: 0,
-                    disableAll: jest.fn(),
-                    enableAll: jest.fn(),
-                },
-            });
-            this.layers = {
-                mask: 0,
-            };
-            return this;
-        }),
-    };
-});
-
 const mockCamera: DIVEPerspectiveCamera = {} as DIVEPerspectiveCamera;
 const mockRenderer = {
     render: jest.fn(),
@@ -157,24 +82,31 @@ const mockController: DIVEOrbitControls = new DIVEOrbitControls(
     mockAnimSystem,
 );
 
+let selectTool: DIVESelectTool;
+let intersectObjectsSpy: jest.SpyInstance;
+
 describe('dive/toolbox/select/DIVESelectTool', () => {
+    beforeEach(() => {
+        selectTool = new DIVESelectTool(mockScene, mockController);
+        intersectObjectsSpy = jest
+            .spyOn(selectTool['_raycaster'], 'intersectObjects')
+            .mockReturnValue([]);
+    });
+
     it('should test if it is SelectTool', () => {
         const selectTool = { isSelectTool: true } as unknown as DIVEBaseTool;
         expect(isSelectTool(selectTool)).toBeDefined();
     });
 
     it('should instantiate', () => {
-        const selectTool = new DIVESelectTool(mockScene, mockController);
         expect(selectTool).toBeDefined();
     });
 
     it('should activate', () => {
-        const selectTool = new DIVESelectTool(mockScene, mockController);
         expect(() => selectTool.Activate()).not.toThrow();
     });
 
     it('should execute onClick without hit', () => {
-        const selectTool = new DIVESelectTool(mockScene, mockController);
         selectTool.AttachGizmo({} as unknown as DIVESelectable);
         expect(() =>
             selectTool.onClick({ offsetX: 0, offsetY: 0 } as PointerEvent),
@@ -182,7 +114,7 @@ describe('dive/toolbox/select/DIVESelectTool', () => {
     });
 
     it('should execute onClick with hit', () => {
-        mock_intersectObjects.mockReturnValueOnce([
+        intersectObjectsSpy.mockReturnValueOnce([
             {
                 object: {
                     uuid: 'test',
@@ -194,7 +126,7 @@ describe('dive/toolbox/select/DIVESelectTool', () => {
                 },
             },
         ]);
-        const selectTool = new DIVESelectTool(mockScene, mockController);
+
         expect(() =>
             selectTool.onClick({ offsetX: 0, offsetY: 0 } as PointerEvent),
         ).not.toThrow();
@@ -203,7 +135,7 @@ describe('dive/toolbox/select/DIVESelectTool', () => {
     it('should execute onClick with same ISelectable hit', () => {
         const mock_onSelect = jest.fn();
 
-        mock_intersectObjects.mockReturnValueOnce([
+        intersectObjectsSpy.mockReturnValueOnce([
             {
                 object: {
                     isSelectable: true,
@@ -217,7 +149,6 @@ describe('dive/toolbox/select/DIVESelectTool', () => {
                 },
             },
         ]);
-        const selectTool = new DIVESelectTool(mockScene, mockController);
         selectTool.AttachGizmo({
             visible: true,
             isSelectable: true,
@@ -231,7 +162,7 @@ describe('dive/toolbox/select/DIVESelectTool', () => {
     it('should execute onClick with ISelectable hit', () => {
         const mock_onSelect = jest.fn();
 
-        mock_intersectObjects.mockReturnValueOnce([
+        intersectObjectsSpy.mockReturnValueOnce([
             {
                 object: {
                     isSelectable: true,
@@ -245,7 +176,6 @@ describe('dive/toolbox/select/DIVESelectTool', () => {
                 },
             },
         ]);
-        const selectTool = new DIVESelectTool(mockScene, mockController);
         selectTool.AttachGizmo({
             isSelectable: true,
             uuid: 'test1',
@@ -258,7 +188,7 @@ describe('dive/toolbox/select/DIVESelectTool', () => {
     it('should execute onClick with IMovable hit', () => {
         const mock_onSelect = jest.fn();
 
-        mock_intersectObjects.mockReturnValueOnce([
+        intersectObjectsSpy.mockReturnValueOnce([
             {
                 object: {
                     isSelectable: true,
@@ -271,14 +201,13 @@ describe('dive/toolbox/select/DIVESelectTool', () => {
                 },
             },
         ]);
-        const selectTool = new DIVESelectTool(mockScene, mockController);
+
         expect(() =>
             selectTool.onClick({ offsetX: 0, offsetY: 0 } as PointerEvent),
         ).not.toThrow();
     });
 
     it('should Select', () => {
-        const selectTool = new DIVESelectTool(mockScene, mockController);
         const mock_onSelect = jest.fn();
         expect(() => selectTool.Select({ isSelectable: true })).not.toThrow();
         expect(() =>
@@ -291,7 +220,6 @@ describe('dive/toolbox/select/DIVESelectTool', () => {
     });
 
     it('should Deselect', () => {
-        const selectTool = new DIVESelectTool(mockScene, mockController);
         const mock_onDeselect = jest.fn();
         expect(() => selectTool.Deselect({ isSelectable: true })).not.toThrow();
         expect(() =>
@@ -304,7 +232,6 @@ describe('dive/toolbox/select/DIVESelectTool', () => {
     });
 
     it('should set gizmo mode', () => {
-        const selectTool = new DIVESelectTool(mockScene, mockController);
         expect(() => selectTool.SetGizmoMode('translate')).not.toThrow();
     });
 });