chore: code cleanup (#278)

awslabs · Oct 14, 2022 · ecbedc0 · ecbedc0
1 parent cb6094e
commit ecbedc0
Show file tree

Hide file tree

Showing 9 changed files with 131 additions and 121 deletions.
diff --git a/packages/scene-composer/__mocks__/mockComponent.tsx b/packages/scene-composer/__mocks__/mockComponent.tsx
@@ -1,8 +1,8 @@
 import React from 'react';
 
-export default (componentName) =>
+export default (componentName) => {
   // eslint-disable-next-line react/prop-types
-  ({ children, ...props }) => {
+  const component = ({ children, ...props }) => {
     const snapshotableProps = {};
     const renderProps = [];
 
@@ -32,3 +32,7 @@ export default (componentName) =>
       </div>
     );
   };
+
+   component.displayName = `Mock${componentName}`;
+   return component
+};
diff --git a/packages/scene-composer/src/SceneViewer.spec.tsx b/packages/scene-composer/src/SceneViewer.spec.tsx
@@ -60,8 +60,10 @@ describe('SceneViewer', () => {
     expect(mockSceneComposerApi.findSceneNodeRefBy).not.toBeCalled();
     expect(mockSceneComposerApi.setCameraTarget).not.toBeCalled();
 
-    onSceneLoadedCb();
-    container.update(<SceneViewer sceneLoader={mockSceneLoader} selectedDataBinding={mockLabel} />);
+    act(() => {
+      onSceneLoadedCb();
+      container.update(<SceneViewer sceneLoader={mockSceneLoader} selectedDataBinding={mockLabel} />);
+    });
 
     // called after scene is loaded
     expect(mockSceneComposerApi.findSceneNodeRefBy).toBeCalledTimes(1);
@@ -87,8 +89,10 @@ describe('SceneViewer', () => {
       container = renderer.create(<SceneViewer sceneLoader={mockSceneLoader} selectedDataBinding={mockLabel} />);
     });
 
-    onSceneLoadedCb();
-    container.update(<SceneViewer sceneLoader={mockSceneLoader} selectedDataBinding={mockLabel} />);
+    act(() => {
+      onSceneLoadedCb();
+      container.update(<SceneViewer sceneLoader={mockSceneLoader} selectedDataBinding={mockLabel} />);
+    });
 
     expect(mockSceneComposerApi.findSceneNodeRefBy).toBeCalledTimes(1);
     expect(mockSceneComposerApi.setCameraTarget).toBeCalledTimes(0);

diff --git a/packages/scene-composer/src/augmentations/three/Anchor.ts b/packages/scene-composer/src/augmentations/three/Anchor.ts
@@ -15,7 +15,6 @@ export class Anchor extends THREE.Object3D {
   protected _visualState: DefaultAnchorStatus | string = DefaultAnchorStatus.Info;
   protected _isSelected = false;
 
-  // @ts-ignore
   public add(visualWithStateName: IVisual): this {
     const stateName = visualWithStateName.name;
     if (!stateName) {

diff --git a/packages/scene-composer/src/common/errors.ts b/packages/scene-composer/src/common/errors.ts
@@ -33,13 +33,15 @@ export class SceneComposerRuntimeError extends CustomError {
   public details: IErrorDetails;
   public innerError?: unknown;
 
-  constructor(
-    level: ErrorLevel,
-    code: ErrorCode,
-    message: string,
-    context?: Record<string, string>,
-    innerError?: unknown,
-  ) {
+  constructor({
+    level,
+    code,
+    message,
+    context,
+    innerError,
+  }: IErrorDetails & {
+    innerError?: unknown;
+  }) {
     super(`[${level}][${code}] ${message}`);
     this.details = {
       level: level,

diff --git a/...cene-composer/src/components/DefaultErrorFallback/__tests__/DefaultErrorFallback.spec.tsx b/...cene-composer/src/components/DefaultErrorFallback/__tests__/DefaultErrorFallback.spec.tsx
@@ -9,13 +9,13 @@ jest.mock('../../../layouts/StaticLayout', () => ({
 }));
 
 describe('DefaultErrorFallback', () => {
-  const sceneComposerRuntimeError = new SceneComposerRuntimeError(
-    ErrorLevel.ERROR,
-    ErrorCode.SC_ERROR_LOAD_SCENE,
-    'Testing a SceneComposerRuntimeError',
-    { test: 'test' },
-    new Error('Testing an innerError'),
-  );
+  const sceneComposerRuntimeError = new SceneComposerRuntimeError({
+    level: ErrorLevel.ERROR,
+    code: ErrorCode.SC_ERROR_LOAD_SCENE,
+    message: 'Testing a SceneComposerRuntimeError',
+    context: { test: 'test' },
+    innerError: new Error('Testing an innerError'),
+  });
   const error = new Error('Testing an error');
   const errorString = 'Testing a string' as any;
   const other = {} as any;

diff --git a/...omponents/DefaultErrorFallback/__tests__/__snapshots__/DefaultErrorFallback.spec.tsx.snap b/...omponents/DefaultErrorFallback/__tests__/__snapshots__/DefaultErrorFallback.spec.tsx.snap
@@ -3,21 +3,21 @@
 exports[`DefaultErrorFallback should render correctly with a Error type 1`] = `
 <StaticLayout
   modalContent={
-    <Styled(Component)
+    <Styled(MockContainer)
       header={
-        <Unknown
+        <MockHeader
           variant="h2"
         >
           Error
-        </Unknown>
+        </MockHeader>
       }
     >
-      <Unknown>
+      <MockTextContent>
         <p>
           Testing an error
         </p>
-      </Unknown>
-    </Styled(Component)>
+      </MockTextContent>
+    </Styled(MockContainer)>
   }
   showModal={true}
 />
@@ -26,21 +26,21 @@ exports[`DefaultErrorFallback should render correctly with a Error type 1`] = `
 exports[`DefaultErrorFallback should render correctly with a SceneComposerRuntimeError type 1`] = `
 <StaticLayout
   modalContent={
-    <Styled(Component)
+    <Styled(MockContainer)
       header={
-        <Unknown
+        <MockHeader
           variant="h2"
         >
           Error
-        </Unknown>
+        </MockHeader>
       }
     >
-      <Unknown>
+      <MockTextContent>
         <p>
           Testing a SceneComposerRuntimeError
         </p>
-      </Unknown>
-    </Styled(Component)>
+      </MockTextContent>
+    </Styled(MockContainer)>
   }
   showModal={true}
 />
@@ -49,21 +49,21 @@ exports[`DefaultErrorFallback should render correctly with a SceneComposerRuntim
 exports[`DefaultErrorFallback should render correctly with a String type 1`] = `
 <StaticLayout
   modalContent={
-    <Styled(Component)
+    <Styled(MockContainer)
       header={
-        <Unknown
+        <MockHeader
           variant="h2"
         >
           Error
-        </Unknown>
+        </MockHeader>
       }
     >
-      <Unknown>
+      <MockTextContent>
         <p>
           Testing a string
         </p>
-      </Unknown>
-    </Styled(Component)>
+      </MockTextContent>
+    </Styled(MockContainer)>
   }
   showModal={true}
 />
@@ -72,21 +72,21 @@ exports[`DefaultErrorFallback should render correctly with a String type 1`] = `
 exports[`DefaultErrorFallback should render correctly with a Unknown type 1`] = `
 <StaticLayout
   modalContent={
-    <Styled(Component)
+    <Styled(MockContainer)
       header={
-        <Unknown
+        <MockHeader
           variant="h2"
         >
           Error
-        </Unknown>
+        </MockHeader>
       }
     >
-      <Unknown>
+      <MockTextContent>
         <p>
           An unexpected error occurred.
         </p>
-      </Unknown>
-    </Styled(Component)>
+      </MockTextContent>
+    </Styled(MockContainer)>
   }
   showModal={true}
 />

diff --git a/packages/scene-composer/src/components/SceneComposerInternal.spec.tsx b/packages/scene-composer/src/components/SceneComposerInternal.spec.tsx
@@ -1,6 +1,7 @@
 import * as React from 'react';
 import renderer, { act } from 'react-test-renderer';
 import str2ab from 'string-to-arraybuffer';
+import flushPromises from 'flush-promises';
 
 import { SceneComposerInternal, SceneComposerApi, useSceneComposerApi } from '..';
 import * as SceneLayoutComponents from '../layouts/SceneLayout';
@@ -43,7 +44,7 @@ describe('SceneComposerInternal', () => {
       );
     });
 
-    await new Promise((resolve) => setTimeout(resolve, 1));
+    await flushPromises();
 
     // shows the scene hierarchy browser
     expect(container).toMatchSnapshot();
@@ -57,7 +58,7 @@ describe('SceneComposerInternal', () => {
       );
     });
 
-    await new Promise((resolve) => setTimeout(resolve, 1));
+    await flushPromises();
 
     // shows the scene hierarchy browser
     expect(container).toMatchSnapshot();
@@ -71,7 +72,7 @@ describe('SceneComposerInternal', () => {
       );
     });
 
-    await new Promise((resolve) => setTimeout(resolve, 1));
+    await flushPromises();
 
     // shows the scene hierarchy browser
     expect(container).toMatchSnapshot();
@@ -88,7 +89,7 @@ describe('SceneComposerInternal', () => {
       );
     });
 
-    await new Promise((resolve) => setTimeout(resolve, 1));
+    await flushPromises();
 
     expect(container).toMatchSnapshot();
   });
@@ -104,7 +105,7 @@ describe('SceneComposerInternal', () => {
       );
     });
 
-    await new Promise((resolve) => setTimeout(resolve, 1));
+    await flushPromises();
 
     expect(container).toMatchSnapshot();
   });
@@ -120,7 +121,7 @@ describe('SceneComposerInternal', () => {
       );
     });
 
-    await new Promise((resolve) => setTimeout(resolve, 1));
+    await flushPromises();
 
     expect(container).toMatchSnapshot();
   });
@@ -136,7 +137,7 @@ describe('SceneComposerInternal', () => {
       );
     });
 
-    await new Promise((resolve) => setTimeout(resolve, 1));
+    await flushPromises();
 
     // verify that 2 different scenes are rendered
     expect(container).toMatchSnapshot();
@@ -156,7 +157,7 @@ describe('SceneComposerInternal', () => {
       );
     });
 
-    await new Promise((resolve) => setTimeout(resolve, 1));
+    await flushPromises();
 
     expect(container).toMatchSnapshot();
   });
@@ -172,7 +173,7 @@ describe('SceneComposerInternal', () => {
       );
     });
 
-    await new Promise((resolve) => setTimeout(resolve, 1));
+    await flushPromises();
 
     expect(container).toMatchSnapshot();
   });
@@ -186,7 +187,7 @@ describe('SceneComposerInternal', () => {
       <SceneComposerInternal config={{ mode: 'Editing' }} sceneLoader={createSceneLoaderMock('')} />,
     );
 
-    await new Promise((resolve) => setTimeout(resolve, 1));
+    await flushPromises();
 
     expect(container).toMatchSnapshot();
 

diff --git a/packages/scene-composer/src/components/__snapshots__/SceneComposerInternal.spec.tsx.snap b/packages/scene-composer/src/components/__snapshots__/SceneComposerInternal.spec.tsx.snap
@@ -55,21 +55,21 @@ exports[`SceneComposerInternal should render a default error view when loading a
 exports[`SceneComposerInternal should render a default error view when unknown error happens 1`] = `
 <StaticLayout
   modalContent={
-    <Styled(Component)
+    <Styled(MockContainer)
       header={
-        <Unknown
+        <MockHeader
           variant="h2"
         >
           Error
-        </Unknown>
+        </MockHeader>
       }
     >
-      <Unknown>
+      <MockTextContent>
         <p>
           failed to render
         </p>
-      </Unknown>
-    </Styled(Component)>
+      </MockTextContent>
+    </Styled(MockContainer)>
   }
   showModal={true}
 />