Fix/example build (#437)

* update node version * fix errors * remove null agent export and format * revert change * make sure to send a copy * check for null * Update src/visGeometry/index.ts Co-authored-by: Peyton Lee <[email protected]> --------- Co-authored-by: Peyton Lee <[email protected]>
simularium · Jan 15, 2025 · 852e5bd · 852e5bd
1 parent e0c98a7
commit 852e5bd
Show file tree

Hide file tree

Showing 10 changed files with 85 additions and 76 deletions.
diff --git a/.github/workflows/nightly-build.yml b/.github/workflows/nightly-build.yml
@@ -1,42 +1,42 @@
 name: github pages
 
 on:
-  schedule:
-    - cron: "0 0 * * *"
+    schedule:
+        - cron: "0 0 * * *"
 
 jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
+    deploy:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
 
-      - name: Setup Node
-        uses: actions/setup-node@v3
-        with:
-          node-version: "16.x"
+            - name: Setup Node
+              uses: actions/setup-node@v3
+              with:
+                  node-version: "20.x"
 
-      - name: Cache dependencies
- 
-        uses: actions/cache@v3
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
-            
-      - run: npm ci
-      - run: npm run gh-build
-      - name: Prepare tag
-        id: prepare_tag
-        if: startsWith(github.ref, 'refs/tags/')
-        run: |
-          TAG_NAME="${GITHUB_REF##refs/tags/}"
-          echo "::set-output name=tag_name::${TAG_NAME}"
-          echo "::set-output name=deploy_tag_name::deploy-${TAG_NAME}"
-      - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./public
-          tag_name: ${{ steps.prepare_tag.outputs.deploy_tag_name }}
-          tag_message: 'Deployment to gh-pages to test new viewer ${{ steps.prepare_tag.outputs.tag_name }}'
+            - name: Cache dependencies
+
+              uses: actions/cache@v3
+              with:
+                  path: ~/.npm
+                  key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+                  restore-keys: |
+                      ${{ runner.os }}-node-
+
+            - run: npm ci
+            - run: npm run gh-build
+            - name: Prepare tag
+              id: prepare_tag
+              if: startsWith(github.ref, 'refs/tags/')
+              run: |
+                  TAG_NAME="${GITHUB_REF##refs/tags/}"
+                  echo "::set-output name=tag_name::${TAG_NAME}"
+                  echo "::set-output name=deploy_tag_name::deploy-${TAG_NAME}"
+            - name: Deploy
+              uses: peaceiris/actions-gh-pages@v3
+              with:
+                  github_token: ${{ secrets.GITHUB_TOKEN }}
+                  publish_dir: ./public
+                  tag_name: ${{ steps.prepare_tag.outputs.deploy_tag_name }}
+                  tag_message: "Deployment to gh-pages to test new viewer ${{ steps.prepare_tag.outputs.tag_name }}"
diff --git a/examples/package-lock.json b/examples/package-lock.json
diff --git a/examples/src/Components/AgentMetadata.tsx b/examples/src/Components/AgentMetadata.tsx
@@ -6,7 +6,7 @@ interface AgentMetadataProps {
 }
 
 const AgentMetadata = ({ agentData }: AgentMetadataProps): JSX.Element => {
-    if (agentData.instanceId === -1) {
+    if (!agentData || agentData.instanceId === -1) {
         return <div className="ui-container">No agent selected</div>;
     }
     return (
@@ -15,7 +15,8 @@ const AgentMetadata = ({ agentData }: AgentMetadataProps): JSX.Element => {
             <div> uniqueID: {agentData.instanceId}</div>
             <div> agentType: {agentData.type}</div>
             <div>
-                position: x = {agentData.x}, y = {agentData.y}, z = {agentData.z}
+                position: x = {agentData.x}, y = {agentData.y}, z ={" "}
+                {agentData.z}
             </div>
             <div>
                 rotation: x = {agentData.xrot}, y = {agentData.yrot}, z ={" "}

diff --git a/examples/src/Viewer.tsx b/examples/src/Viewer.tsx
@@ -1,5 +1,5 @@
 import React from "react";
-import { isEqual, findIndex, reduce } from "lodash";
+import { isEqual, findIndex, reduce, map } from "lodash";
 import { v4 as uuidv4 } from "uuid";
 import { InputParams } from "tweakpane";
 
@@ -12,7 +12,6 @@ import SimulariumViewer, {
     ErrorLevel,
     NetConnectionParams,
     TrajectoryFileInfo,
-    nullAgent,
     TrajectoryType,
 } from "@aics/simularium-viewer";
 import type {
@@ -119,7 +118,7 @@ const initialState: ViewerState = {
     trajectoryTitle: "",
     initialPlay: true,
     firstFrameTime: 0,
-    followObjectData: nullAgent(),
+    followObjectData: null,
 };
 
 class Viewer extends React.Component<InputParams, ViewerState> {

diff --git a/examples/webpack.dev.js b/examples/webpack.dev.js
@@ -2,7 +2,7 @@ const HtmlWebpackPlugin = require("html-webpack-plugin");
 const CopyWebpackPlugin = require("copy-webpack-plugin");
 const path = require("path");
 const MiniCssExtractPlugin = require("mini-css-extract-plugin");
-const webpack = require('webpack');
+const webpack = require("webpack");
 
 module.exports = {
     entry: "./src/index.tsx",
@@ -28,11 +28,13 @@ module.exports = {
             ],
         }),
         new webpack.DefinePlugin({
-            SIMULARIUM_USE_LOCAL_BACKEND: Boolean(process.env.npm_config_localserver),
+            SIMULARIUM_USE_LOCAL_BACKEND: Boolean(
+                process.env.npm_config_localserver
+            ),
         }),
     ],
     devServer: {
-        devMiddleware:{
+        devMiddleware: {
             publicPath: "/public/",
         },
         open: ["public/"],
@@ -48,6 +50,9 @@ module.exports = {
                         loader: "babel-loader",
                     },
                 ],
+                resolve: {
+                    fullySpecified: false,
+                },
             },
             {
                 test: /\.css/,

diff --git a/src/constants.ts b/src/constants.ts
@@ -34,22 +34,6 @@ export const enum TrajectoryType {
 
 export const DEFAULT_FRAME_RATE = 60; // frames per second
 
-export const nullAgent = (): AgentData => {
-    return {
-        visType: -1,
-        instanceId: -1,
-        type: -1,
-        x: 0,
-        y: 0,
-        z: 0,
-        xrot: 0,
-        yrot: 0,
-        zrot: 0,
-        cr: 0,
-        subpoints: [],
-    };
-};
-
 // the size of the header before the agent data in the binary file
 export const AGENT_HEADER_SIZE = 3; // frameNumber, time, agentCount
 

diff --git a/src/index.ts b/src/index.ts
@@ -27,6 +27,6 @@ export {
     ClientMessageEnum,
 } from "./simularium/index.js";
 export { compareTimes, loadSimulariumFile } from "./util.js";
-export { DEFAULT_CAMERA_SPEC, nullAgent, TrajectoryType } from "./constants.js";
+export { DEFAULT_CAMERA_SPEC, TrajectoryType } from "./constants.js";
 
 export default Viewport;
diff --git a/src/util.ts b/src/util.ts
@@ -6,8 +6,8 @@ import {
     AgentData,
     CachedFrame,
 } from "./simularium/types.js";
-import { nullAgent } from "./constants.js";
 import { FrontEndError } from "./simularium/index.js";
+import VisGeometry from "./visGeometry/index.js";
 
 export const compareTimes = (
     time1: number,
@@ -102,7 +102,7 @@ export const getAgentDataFromBuffer = (
             "Invalid offset: Not enough data in the buffer for agent data."
         );
     }
-    const agentData: AgentData = nullAgent();
+    const agentData: AgentData = VisGeometry.getNullAgent();
     for (let i = 0; i < AGENT_OBJECT_KEYS.length; i++) {
         agentData[AGENT_OBJECT_KEYS[i]] = view[offset + i];
     }

diff --git a/src/viewport/index.tsx b/src/viewport/index.tsx
@@ -5,20 +5,20 @@ import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
 import { faSyncAlt } from "@fortawesome/free-solid-svg-icons";
 import { forOwn, isEqual } from "lodash";
 
-import SimulariumController from "../controller/index.js"
+import SimulariumController from "../controller/index.js";
 import {
     TrajectoryFileInfo,
     SelectionInterface,
     SelectionStateInfo,
     UIDisplayData,
-} from "../simularium/index.js"
-import { AgentData, TrajectoryFileInfoAny } from "../simularium/types.js"
-import { updateTrajectoryFileInfoFormat } from "../simularium/versionHandlers.js"
-import { FrontEndError, ErrorLevel } from "../simularium/FrontEndError.js"
-import { RenderStyle, VisGeometry, NO_AGENT } from "../visGeometry/index.js"
-import { ColorAssignment } from "../visGeometry/types.js"
-import FrameRecorder from "../simularium/FrameRecorder.js"
-import { DEFAULT_FRAME_RATE } from "../constants.js"
+} from "../simularium/index.js";
+import { AgentData, TrajectoryFileInfoAny } from "../simularium/types.js";
+import { updateTrajectoryFileInfoFormat } from "../simularium/versionHandlers.js";
+import { FrontEndError, ErrorLevel } from "../simularium/FrontEndError.js";
+import { RenderStyle, VisGeometry, NO_AGENT } from "../visGeometry/index.js";
+import { ColorAssignment } from "../visGeometry/types.js";
+import FrameRecorder from "../simularium/FrameRecorder.js";
+import { DEFAULT_FRAME_RATE } from "../constants.js";
 
 export type PropColor = string | number | [number, number, number];
 

diff --git a/src/visGeometry/index.ts b/src/visGeometry/index.ts
@@ -41,7 +41,6 @@ import { FrontEndError, ErrorLevel } from "../simularium/FrontEndError.js";
 import {
     DEFAULT_CAMERA_Z_POSITION,
     DEFAULT_CAMERA_SPEC,
-    nullAgent,
     AGENT_HEADER_SIZE,
 } from "../constants.js";
 import {
@@ -95,6 +94,20 @@ const MIN_ZOOM = 0.16;
 const CANVAS_INITIAL_WIDTH = 100;
 const CANVAS_INITIAL_HEIGHT = 100;
 
+const NULL_AGENT = {
+    visType: -1,
+    instanceId: NO_AGENT,
+    type: -1,
+    x: 0,
+    y: 0,
+    z: 0,
+    xrot: 0,
+    yrot: 0,
+    zrot: 0,
+    cr: 0,
+    subpoints: [],
+};
+
 export enum RenderStyle {
     WEBGL1_FALLBACK,
     WEBGL2_PREFERRED,
@@ -115,6 +128,9 @@ const coordsToVector = ({ x, y, z }: Coordinates3d) => new Vector3(x, y, z);
 type Bounds = readonly [number, number, number, number, number, number];
 
 class VisGeometry {
+    static getNullAgent(): AgentData {
+        return { ...NULL_AGENT };
+    }
     public onError: (error: FrontEndError) => void;
     public renderStyle: RenderStyle;
     public backgroundColor: Color;
@@ -667,9 +683,13 @@ class VisGeometry {
     }
 
     public getObjectData(id: number): AgentData {
+        if (id === NO_AGENT) {
+            // initial state
+            return VisGeometry.getNullAgent();
+        }
         const data = this.visAgentInstances.get(id);
         if (!data) {
-            return nullAgent();
+            return VisGeometry.getNullAgent();
         }
         return data.agentData;
     }