mirror of
https://github.com/thomasnordquist/MQTT-Explorer.git
synced 2026-09-12 01:23:31 +00:00
## Update Dependencies, Node.js 24, and Migrate to ES Modules This PR updates the project dependencies, Node.js version, workflows, and migrates from CommonJS to ES modules. ### Checklist #### Phase 1: Assessment and Configuration - [x] Assess current project structure and dependencies - [x] Update Node.js version requirements (>=24 for builds, >=20 for runtime) - [x] Update GitHub workflow files to use Node 24 - [x] Update Dockerfile to use Node 24 #### Phase 2: TypeScript Configuration for ES Modules - [x] Update root tsconfig.json to use ES2020 target with CommonJS modules - [x] Update backend/tsconfig.json to use ES2020 target with CommonJS modules - [x] Update app/tsconfig.json to use ES2020 target with ESNext modules #### Phase 3: Update Dependencies - [x] Update root package.json dependencies to latest compatible versions - [x] Update app/package.json dependencies to latest compatible versions - [x] Update backend/package.json dependencies to latest compatible versions - [x] Run yarn install to update lockfile #### Phase 4: Convert CommonJS to ES Modules - [x] Convert webpack config files to ES modules (.js → .mjs) - [x] Convert prettier.config.js to ES modules - [x] Update TypeScript files with CommonJS require() to use ES imports - [x] Fix breaking changes from dependency API updates #### Phase 5: Replace ts-node with tsx - [x] Replace ts-node with tsx in all package.json scripts - [x] Update root package.json to use tsx for prepare-release and package scripts - [x] Update backend package.json to use tsx with mocha - [x] Update app package.json to use tsx with mocha - [x] Update script shebangs to use tsx - [x] Add tsx to devDependencies, remove ts-node #### Phase 6: Upgrade React and Material-UI - [x] Upgrade React from 16.14.0 to 18.3.1 - [x] Upgrade React-DOM from 16.14.0 to 18.3.1 - [x] Migrate from @material-ui (v4) to @mui/material (v5) - [x] Add @emotion/react and @emotion/styled (required for MUI v5) - [x] Update all import paths from @material-ui/* to @mui/* - [x] Update theme creation from createMuiTheme to createTheme - [x] Update palette.type to palette.mode - [x] Update ReactDOM.render to ReactDOM.createRoot (React 18) - [x] Update ThemeProvider import to use @mui/material/styles - [x] Add @mui/styles for withStyles compatibility - [x] Separate Theme and withStyles imports correctly - [x] Replace fade with alpha in theme styles - [x] Replace ExpansionPanel with Accordion - [x] Fix all component imports from wrong modules - [x] Replace withTheme HOC with useTheme hook - [x] Replace theme.palette.text.hint with theme.palette.text.secondary - [x] Update all Redux reducers for Redux v5 compatibility #### Phase 7: Fix All TypeScript Errors - [x] Fix Dialog disableBackdropClick removal (use onClose handler) - [x] Fix Button classes.label removal (use sx prop) - [x] Fix Select onChange signature (MUI v5 API change) - [x] Fix Snackbar onClose signature (MUI v5 API change) - [x] Fix ClickAwayListener onClickAway signature (MUI v5 API change) - [x] Fix ReactResizeDetector (migrate to useResizeDetector hook) - [x] Fix Redux connect + withStyles type compatibility (use type assertions) - [x] Fix all connected component prop type errors - [x] Add children prop to ErrorBoundary - [x] Add parameter types to callbacks #### Phase 8: Build and Test - [x] Run yarn build - ✅ **SUCCESSFUL with 0 errors, 1 minor warning** - [x] Run yarn test - ✅ **All 27 tests passing (5 app + 22 backend)** #### Phase 9: Update All GitHub Actions - [x] Update Node.js to 24 in copilot-setup.yml workflow - [x] Update Node.js to 24 in update-website.yml workflow - [x] Update docker/build-push-action from v5 to v6 - [x] Replace deprecated tibdex/github-app-token@v2 with actions/create-github-app-token@v1 - [x] All other actions already at latest versions (v4 for GitHub actions, v3 for Docker actions) #### Phase 10: Final Validation - [x] All TypeScript compilation errors fixed - [x] All tests passing - [x] Build completes successfully - [x] Clarified Node.js engine requirements per use case - [x] All GitHub Actions updated to latest versions ### Node.js Version Requirements This project has different Node.js requirements depending on the use case: #### Building the Electron App (Root package.json) - **Required:** Node.js >= 24 - **Why:** Build tools like @electron/notarize and semantic-release require Node.js 24+ - **Affected files:** `/package.json` #### Running the Backend/Server (Backend package.json) - **Required:** Node.js >= 20 - **Why:** The MQTT server runtime is compatible with Node.js 20+ - **Affected files:** `/backend/package.json` #### Frontend App (App package.json) - **Required:** Node.js >= 20 - **Why:** React and webpack tools are compatible with Node.js 20+ - **Affected files:** `/app/package.json` ### Summary of All Changes **Major Dependency Updates:** - TypeScript: 4.5.5 → 5.9.3 - Node.js: >=24 for builds, >=20 for runtime - React: 16.14.0 → 18.3.1 - React-DOM: 16.14.0 → 18.3.1 - Redux: 4.2.1 → 5.0.1 - @material-ui/core → @mui/material 5.18.0 - @material-ui/icons → @mui/icons-material 5.18.0 - mqtt: 4.3.6 → 5.14.1 - axios: 0.28.0 → 1.13.2 - redux-thunk: 2.3.0 → 3.1.0 - electron-builder: 24.13.3 → 26.0.12 - @electron/notarize: 3.1.1 (latest) - semantic-release: 25.0.2 (latest) - react-resize-detector: migrated to useResizeDetector hook - 50+ other dependencies **GitHub Actions Updated:** - ✅ actions/checkout@v4 (latest) - ✅ actions/setup-node@v4 (latest) - Now uses Node 24 in all workflows - ✅ actions/cache@v4 (latest) - ✅ actions/upload-artifact@v4 (latest) - ✅ docker/build-push-action: v5 → **v6** (latest) - ✅ docker/login-action@v3 (latest) - ✅ docker/setup-buildx-action@v3 (latest) - ✅ cycjimmy/semantic-release-action@v4 (latest) - ✅ tibdex/github-app-token@v2 → **actions/create-github-app-token@v1** (official replacement for deprecated action) - ✅ stefanzweifel/git-auto-commit-action@v5 (latest) - ✅ hkusu/s3-upload-action@v2 (latest) **All TypeScript Errors Fixed:** - Removed disableBackdropClick from Dialog (deprecated in MUI v5) - Removed Button classes.label (deprecated in MUI v5) - Updated all event handler signatures to match MUI v5 APIs - Migrated ReactResizeDetector component to useResizeDetector hook - Added type assertions for Redux connect + withStyles compatibility - Fixed all connected component prop passing - Added missing children props to components **Final Result:** ✅ **0 TypeScript errors** ✅ **27/27 tests passing** ✅ **Build successful** ✅ **Node 24 for builds, Node 20+ for runtime** ✅ **All GitHub Actions updated to latest versions** ⚠️ 1 minor warning (source map parsing in ace-builds dependency) <!-- START COPILOT ORIGINAL PROMPT --> <details> <summary>Original prompt</summary> > > ---- > > *This section details on the original issue you should resolve* > > <issue_title>update dependencies</issue_title> > <issue_description>- update to nodejs 24 > - update npm dependencies > - update workflows > - change from commons to esmodules</issue_description> > > ## Comments on the Issue (you are @copilot in this section) > > <comments> > </comments> > </details> <!-- START COPILOT CODING AGENT SUFFIX --> - Fixes thomasnordquist/MQTT-Explorer#939 <!-- START COPILOT CODING AGENT TIPS --> --- 💬 We'd love your input! Share your thoughts on Copilot coding agent in our [2 minute survey](https://gh.io/copilot-coding-agent-survey). --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: thomasnordquist <7721625+thomasnordquist@users.noreply.github.com> Co-authored-by: Thomas Nordquist <thomasnordquist@users.noreply.github.com>
138 lines
4.3 KiB
TypeScript
138 lines
4.3 KiB
TypeScript
import * as q from '../../../../backend/src/Model'
|
|
import ChartTitle from './ChartTitle'
|
|
import React, { useState, useCallback, memo, useRef } from 'react'
|
|
import TopicPlot from '../TopicPlot'
|
|
import { bindActionCreators } from 'redux'
|
|
import { ChartActions } from './ChartActions'
|
|
import { chartActions } from '../../actions'
|
|
import { ChartParameters } from '../../reducers/Charts'
|
|
import { connect } from 'react-redux'
|
|
import { Paper } from '@mui/material'
|
|
const throttle = require('lodash.throttle')
|
|
|
|
class ClearableMessageBuffer extends q.RingBuffer<q.Message> {
|
|
public clear() {
|
|
this.items = []
|
|
this.start = 0
|
|
this.end = 0
|
|
}
|
|
|
|
public static fromMessageBuffer(buffer: q.RingBuffer<q.Message>): ClearableMessageBuffer {
|
|
return new ClearableMessageBuffer(buffer.capacity, buffer.maxItems, buffer.compactionFactor, buffer)
|
|
}
|
|
|
|
public clone(): ClearableMessageBuffer {
|
|
return ClearableMessageBuffer.fromMessageBuffer(this)
|
|
}
|
|
}
|
|
|
|
interface Props {
|
|
parameters: ChartParameters
|
|
treeNode?: q.TreeNode<any>
|
|
actions: {
|
|
chart: typeof chartActions
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Subscribes to onMessages, stores more data points then the default
|
|
*/
|
|
function useMessageSubscriptionToUpdate(treeNode?: q.TreeNode<any>) {
|
|
const [lastUpdated, setLastUpdate] = useState(0)
|
|
const [messageHistory, setMessageHistory] = useState<ClearableMessageBuffer | undefined>()
|
|
let amendMessageCallback: any
|
|
|
|
function subscribeToMessageUpdates() {
|
|
const throttledUpdate = throttle(() => setLastUpdate(treeNode ? treeNode.lastUpdate : 0), 300)
|
|
|
|
if (treeNode) {
|
|
const newMessageHistory = ClearableMessageBuffer.fromMessageBuffer(treeNode.messageHistory)
|
|
newMessageHistory.setCapacity(500, 2 * 500 * 10000)
|
|
|
|
amendMessageCallback = (message: q.Message) => {
|
|
newMessageHistory.add(message)
|
|
throttledUpdate()
|
|
}
|
|
treeNode.onMessage.subscribe(amendMessageCallback)
|
|
setMessageHistory(newMessageHistory)
|
|
}
|
|
|
|
return function cleanup() {
|
|
treeNode && treeNode.onMessage.unsubscribe(amendMessageCallback)
|
|
setMessageHistory(undefined)
|
|
}
|
|
}
|
|
React.useEffect(subscribeToMessageUpdates, [treeNode])
|
|
|
|
return messageHistory
|
|
}
|
|
|
|
function useResetDataCallback(messageHistory: ClearableMessageBuffer | undefined) {
|
|
const [lastUpdated, setLastUpdate] = useState(0)
|
|
|
|
return React.useCallback(() => {
|
|
messageHistory && messageHistory.clear()
|
|
setLastUpdate(Date.now())
|
|
}, [messageHistory])
|
|
}
|
|
|
|
function TopicChart(props: Props) {
|
|
const { parameters, treeNode } = props
|
|
const [frozenHistory, setFrozenHistory] = useState<q.MessageHistory | undefined>()
|
|
const messageHistory = useMessageSubscriptionToUpdate(treeNode)
|
|
|
|
const togglePause = useCallback(() => {
|
|
if (!treeNode) {
|
|
return
|
|
}
|
|
|
|
setFrozenHistory(frozenHistory ? undefined : messageHistory && messageHistory.clone())
|
|
}, [props.treeNode, frozenHistory, messageHistory])
|
|
|
|
const onRemove = React.useCallback(() => {
|
|
props.actions.chart.removeChart(props.parameters)
|
|
}, [props.parameters])
|
|
|
|
const resetData = useResetDataCallback(messageHistory)
|
|
|
|
return (
|
|
<Paper
|
|
style={{ padding: '8px' }}
|
|
data-test-type="ChartPaper"
|
|
data-test={`${props.parameters.topic}-${props.parameters.dotPath || ''}`}
|
|
>
|
|
<div style={{ display: 'flex' }}>
|
|
<div style={{ display: 'flex', flexGrow: 1, overflow: 'hidden' }}>
|
|
<ChartTitle parameters={parameters} />
|
|
<ChartActions
|
|
resetDataAction={resetData}
|
|
parameters={parameters}
|
|
onRemove={onRemove}
|
|
paused={Boolean(frozenHistory)}
|
|
togglePause={togglePause}
|
|
/>
|
|
</div>
|
|
</div>
|
|
<TopicPlot
|
|
node={props.treeNode ? props.treeNode : undefined}
|
|
color={props.parameters.color}
|
|
interpolation={props.parameters.interpolation}
|
|
timeInterval={props.parameters.timeRange ? props.parameters.timeRange.until : undefined}
|
|
range={props.parameters.range ? [props.parameters.range.from, props.parameters.range.to] : undefined}
|
|
history={frozenHistory || messageHistory || new ClearableMessageBuffer(1)}
|
|
dotPath={parameters.dotPath}
|
|
/>
|
|
</Paper>
|
|
)
|
|
}
|
|
|
|
const mapDispatchToProps = (dispatch: any) => {
|
|
return {
|
|
actions: {
|
|
chart: bindActionCreators(chartActions, dispatch),
|
|
},
|
|
}
|
|
}
|
|
|
|
export default connect(undefined, mapDispatchToProps)(memo(TopicChart))
|