feat: add Torii local launcher #2663
Conversation
|
Hi @edisontim! You need to be added as a user to interact with me. Please ask @ponderingdemocritus to add you on the settings page. You are receiving this comment because I am set to review all PRs. That is configurable here. |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
|
Warning There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure. 🔧 eslint
client/apps/torii-launcher/forge.config.tsOops! Something went wrong! :( ESLint: 9.18.0 ESLint couldn't find an eslint.config.(js|mjs|cjs) file. From ESLint v9.0.0, the default configuration file is now eslint.config.js. https://eslint.org/docs/latest/use/configure/migration-guide If you still have problems after following the migration guide, please stop by WalkthroughThis pull request introduces a comprehensive configuration and setup for the Torii Launcher, an Electron-based application for the Eternum game. The changes include establishing a new project structure with configuration files for various build tools (Webpack, Vite), styling (Tailwind CSS), and development environments (TypeScript, ESLint). The application features a React frontend with components for syncing state, logo display, and user interactions, along with backend functionality for managing the Torii service and database. Changes
Suggested Reviewers
Possibly Related PRs
Poem
✨ Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
Failed to generate code suggestions for PR |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 22
🧹 Nitpick comments (28)
client/apps/torii-launcher/webpack.rules.js (2)
4-4: Improve the test pattern regex for better file matching.The current regex pattern
/.jsx?$/could potentially match unwanted files. Consider using a more specific pattern.- test: /.jsx?$/, + test: /^[^.]+\.jsx?$/,
1-14: Consider adding TypeScript support for better type safety.Since this is an Electron application, consider adding TypeScript support to improve maintainability and catch potential issues early.
You would need to:
- Install required dependencies (
@babel/preset-typescript,@types/webpack)- Add TypeScript configuration
- Update the test pattern to include
.tsxfilesWould you like me to provide the necessary configuration changes?
client/apps/torii-launcher/webpack.plugins.ts (2)
3-4: Consider future migration to ESM imports.While the current CommonJS require() approach with type assertion works correctly, consider migrating to ESM imports when possible. This would eliminate the need for the ESLint disable comment and provide better static analysis.
🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
7-9: Consider enhancing type checking configuration.The current ForkTsCheckerWebpackPlugin configuration is minimal. Consider adding these options to improve type checking:
async: true- for better build performancetypescript: { configFile: './tsconfig.json' }- explicit TypeScript configissue: { include: [{ file: '**/src/**/*.{ts,tsx}' }] }- scope type checking to source files🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
client/apps/torii-launcher/webpack.rules.ts (2)
11-20: Consider adding optimization options.While the current configuration is correct, consider adding the following optimizations:
- Cache the loader output using
cacheDirectory: true- Add
includepath to limit the scope to your app's node_modules{ test: /[/\\]node_modules[/\\].+\.(m?js|node)$/, parser: { amd: false }, use: { loader: '@vercel/webpack-asset-relocator-loader', options: { outputAssetBase: 'native_modules', + cacheDirectory: true }, }, + include: /node_modules/, },🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
1-31: Fix code formatting.The GitHub Actions pipeline indicates that the code formatting doesn't match Prettier standards. Please run Prettier to format the code:
npx prettier --write client/apps/torii-launcher/webpack.rules.ts🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
client/apps/torii-launcher/webpack.renderer.config.ts (2)
11-34: Consider using array spread for cleaner rule addition.The configuration is correct, but the syntax could be more elegant.
-rules.push( - { - test: /\.tsx?$/, +rules.push(...[ + { + test: /\.tsx?$/, include: [path.resolve(__dirname, "src")], loader: "babel-loader", resolve: { extensions: [".js", ".jsx", ".json", ".ts", ".tsx"], }, }, { test: /\.(html)$/, include: [path.resolve(__dirname, "src")], use: { loader: "html-loader", }, }, { test: /\.css$/, include: [path.resolve(__dirname, "src")], use: ["style-loader", "css-loader", "postcss-loader"], } -); +]);🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
42-50: Ensure consistent extension lists.The resolve.extensions list is shorter than the one defined in the TypeScript rule (missing .jsx and .json).
resolve: { - extensions: [".js", ".ts", ".jsx", ".tsx"], + extensions: [".js", ".jsx", ".json", ".ts", ".tsx"], },🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
client/apps/torii-launcher/public/torii.toml (1)
3-3: Consider environment-specific RPC configuration.While hardcoding the mainnet RPC endpoint aligns with the current PR objectives, consider making this configurable through environment variables for future flexibility.
Example approach:
rpc = "${TORII_RPC_URL:-https://api.cartridge.gg/x/starknet/mainnet}"client/apps/torii-launcher/webpack.main.config.ts (4)
11-11: Consider using path.resolve for the entry point.The relative path './src/index.ts' might cause issues depending on the working directory. Using path.resolve would make this more robust.
+import path from 'path'; + export const mainConfig: Configuration = { - entry: './src/index.ts', + entry: path.resolve(__dirname, './src/index.ts'),🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
12-12: Remove or improve the TODO-style comment.The comment "Put your normal webpack config below here" doesn't provide value and should be removed or replaced with meaningful documentation.
🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
1-20: Fix code formatting.The pipeline shows Prettier formatting issues. Run Prettier to fix the formatting:
#!/bin/bash npx prettier --write "client/apps/torii-launcher/webpack.main.config.ts"🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
6-20: Consider environment-specific configurations.Since this is an Electron app, consider:
- Adding environment-specific settings (development vs production)
- Enabling source maps for development
- Adding optimization settings for production builds
Example structure:
export const mainConfig: Configuration = { ...baseConfig, mode: process.env.NODE_ENV === 'production' ? 'production' : 'development', devtool: process.env.NODE_ENV === 'production' ? false : 'source-map', optimization: process.env.NODE_ENV === 'production' ? { minimize: true, minimizer: [new TerserPlugin()], } : undefined, }🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
client/apps/torii-launcher/src/main.ts (1)
16-19: Consider disablingnodeIntegrationfor improved security.Enabling
nodeIntegrationinwebPreferencescan expose your application to security risks if untrusted content is loaded or if XSS vulnerabilities exist. If Node.js integration is not required in the renderer process, it's recommended to setnodeIntegrationtofalseand use a preload script to expose necessary APIs.Apply this diff to enhance security:
webPreferences: { preload: path.join(__dirname, "preload.js"), - nodeIntegration: true, + nodeIntegration: false, }client/apps/torii-launcher/src/frontend/Logo-animated.tsx (2)
1-5: Code formatting does not match Prettier standards.The code does not adhere to the project's formatting guidelines enforced by Prettier, as indicated by the pipeline failure. Please format your code using Prettier to pass the linting checks.
You can run the following command to format your code:
npm run format🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
3-5: Use PascalCase for component filenames for consistency.React components are typically named using PascalCase. Consider renaming
Logo-animated.tsxtoLogoAnimated.tsxfor consistency with other components and to follow naming conventions.Apply this change:
- Rename file from
Logo-animated.tsxtoLogoAnimated.tsx.🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
client/apps/torii-launcher/src/index.tsx (1)
6-7: Add React.StrictMode and error boundariesConsider wrapping the app with StrictMode for additional runtime checks and error boundaries for graceful error handling.
Apply this diff:
+import { StrictMode } from 'react'; +import { ErrorBoundary } from './components/ErrorBoundary'; const rootElement = document.createElement('div'); rootElement.id = 'root'; document.body.appendChild(rootElement); const root = createRoot(rootElement); -root.render(<App />); +root.render( + <StrictMode> + <ErrorBoundary> + <App /> + </ErrorBoundary> + </StrictMode> +);client/apps/torii-launcher/src/preload.ts (2)
6-6: Use ES modules consistentlyReplace require with import for consistency with the rest of the codebase.
Apply this diff:
-const { contextBridge, ipcRenderer } = require("electron/renderer"); +import { contextBridge, ipcRenderer } from "electron/renderer";
8-10: Improve type safety for IPC communicationConsider adding type definitions for the payload object and declaring the API interface.
Apply this diff:
+interface IpcPayload { + // Add your payload properties here +} + +interface ElectronAPI { + sendMessage: (message: IpcMethod, payload?: IpcPayload) => void; +} + -contextBridge.exposeInMainWorld("electronAPI", { - sendMessage: (message: IpcMethod) => ipcRenderer.send(message, {}), +contextBridge.exposeInMainWorld("electronAPI", { + sendMessage: (message: IpcMethod, payload: IpcPayload = {}) => + ipcRenderer.send(message, payload), } as ElectronAPI);client/apps/torii-launcher/tailwind.config.js (2)
3-3: Expand content glob patternThe current pattern might miss some file extensions. Consider including more file types that might contain Tailwind classes.
Apply this diff:
- content: ["./src/**/*.{html,tsx}"], + content: ["./src/**/*.{html,tsx,ts,jsx,js}"],
6-10: Consider extracting theme valuesMove color definitions to a separate theme file for better maintainability and reusability across the application.
Create a new file
src/theme/colors.ts:export const colors = { brown: "#0C0A08", gold: "#F6C297", red: "#FC4C4C", } as const;Then import it in the Tailwind config:
+const { colors } = require('./src/theme/colors'); module.exports = { theme: { extend: { - colors: { - brown: "#0C0A08", - gold: "#F6C297", - red: "#FC4C4C", - }, + colors,client/apps/torii-launcher/forge.config.ts (1)
24-27: Use environment variables for configurable pathsConsider making asset paths configurable through environment variables for better flexibility across different environments.
Apply this diff:
+const iconPath = process.env.ICON_PATH || "./assets/icon.png"; + config: { - background: "./assets/icon.png", + background: iconPath, format: "ULFO", - icon: "./assets/icon.png", + icon: iconPath, name: "Eternum Launcher", },🧰 Tools
🪛 GitHub Actions: knip
[warning] Unused file detected
client/apps/torii-launcher/src/frontend/Button.tsx (1)
23-42: Consider extracting styles to a separate constants file.The
STYLESobject contains a large number of style definitions that could be better organized in a separate file.Consider creating a new file
ButtonStyles.tsto improve maintainability and reusability.🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
client/apps/torii-launcher/src/frontend/app.tsx (1)
35-44: Consider moving styled components to a separate file.The
DraggableAreastyled component should be defined outside the component to prevent unnecessary re-creation.Move the styled component to a separate file (e.g.,
StyledComponents.ts).client/apps/torii-launcher/package.json (1)
6-6: Update application description.The default Electron application description should be replaced with a meaningful description.
- "description": "My Electron application description", + "description": "Eternum Launcher - A desktop application for managing Torii instances",client/apps/torii-launcher/png_to_isns.sh (3)
18-30: Improve command-line argument handling.
- The initial argument check might interfere with valid flag-only usage (e.g.,
-h).- The case statement combines
hwith the wildcard, making it less explicit.Apply this diff:
-# If no option were passed display usage and exit -if [[ $1 == "" ]] -then - usageFunction -fi - # Iterate over script options while getopts "hi:" opt; do case "$opt" in i ) image_path="$OPTARG" ;; - h | *) usageFunction ;; + h ) usageFunction ;; + * ) usageFunction ;; esac done
89-100: Improve result reporting.
- Use absolute path in success message.
- Provide more specific error information.
- Use appropriate exit codes.
Apply this diff:
# Echo result status icon_path="${icon_name}.${icon_extension}" if [ -f "$icon_path" ] then - echo "INFO: The icon has been successfully created: ./${icon_path}" + echo "INFO: Icon successfully created: $(pwd)/${icon_path}" + exit 0 else - # First print an empty line, to help lisibility - echo "" - echo "ERROR: An error occurred please check the logs above." + echo "ERROR: Failed to create icon '${icon_path}'." + exit 1 fi - -exit 0
3-5: Add comprehensive documentation.Add a documentation section that clearly states:
- Platform requirements (Mac OS only)
- Required commands (sips, iconutil)
- Environment variables (ICON_BASE_NAME)
- Example usage
Add this documentation after the copyright notice:
# PNG to ICNS v1.0 - https://github.com/BenSouchet/png-to-icns # Copyright(C) 2022 Ben Souchet | MIT License + +# Requirements: +# - Mac OS (uses Mac OS specific commands: sips, iconutil) +# +# Environment variables: +# - ICON_BASE_NAME: Optional. Base name for the output icon (default: "icon") +# +# Example usage: +# ./png_to_icns.sh -i input.png # Creates icon.icns +# ICON_BASE_NAME=app ./png_to_icns.sh -i input.png # Creates app.icns
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (10)
.DS_Storeis excluded by!**/.DS_Storeclient/apps/torii-launcher/assets/icon.icois excluded by!**/*.icoclient/apps/torii-launcher/assets/icon.pngis excluded by!**/*.pngclient/apps/torii-launcher/package-lock.jsonis excluded by!**/package-lock.jsonclient/apps/torii-launcher/public/eternum-new.svgis excluded by!**/*.svgclient/apps/torii-launcher/public/favicon.icois excluded by!**/*.icoclient/apps/torii-launcher/public/icon.icois excluded by!**/*.icoclient/apps/torii-launcher/public/icon.pngis excluded by!**/*.pngclient/apps/torii-launcher/src/assets/eternum-new.svgis excluded by!**/*.svgpnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (30)
client/apps/torii-launcher/.eslintrc.json(1 hunks)client/apps/torii-launcher/.gitignore(1 hunks)client/apps/torii-launcher/forge.config.ts(1 hunks)client/apps/torii-launcher/forge.env.d.ts(1 hunks)client/apps/torii-launcher/index.html(1 hunks)client/apps/torii-launcher/package.json(1 hunks)client/apps/torii-launcher/png_to_isns.sh(1 hunks)client/apps/torii-launcher/postcss.config.js(1 hunks)client/apps/torii-launcher/public/torii.toml(1 hunks)client/apps/torii-launcher/src/frontend/Button.tsx(1 hunks)client/apps/torii-launcher/src/frontend/Logo-animated.tsx(1 hunks)client/apps/torii-launcher/src/frontend/SyncingState.tsx(1 hunks)client/apps/torii-launcher/src/frontend/app.tsx(1 hunks)client/apps/torii-launcher/src/index.css(1 hunks)client/apps/torii-launcher/src/index.tsx(1 hunks)client/apps/torii-launcher/src/main.ts(1 hunks)client/apps/torii-launcher/src/preload.ts(1 hunks)client/apps/torii-launcher/src/renderer.ts(1 hunks)client/apps/torii-launcher/src/types.ts(1 hunks)client/apps/torii-launcher/tailwind.config.js(1 hunks)client/apps/torii-launcher/tsconfig.json(1 hunks)client/apps/torii-launcher/vite.main.config.ts(1 hunks)client/apps/torii-launcher/vite.preload.config.ts(1 hunks)client/apps/torii-launcher/vite.renderer.config.ts(1 hunks)client/apps/torii-launcher/webpack.main.config.ts(1 hunks)client/apps/torii-launcher/webpack.plugins.ts(1 hunks)client/apps/torii-launcher/webpack.renderer.config.ts(1 hunks)client/apps/torii-launcher/webpack.rules.js(1 hunks)client/apps/torii-launcher/webpack.rules.ts(1 hunks)notes(0 hunks)
💤 Files with no reviewable changes (1)
- notes
✅ Files skipped from review due to trivial changes (11)
- client/apps/torii-launcher/vite.preload.config.ts
- client/apps/torii-launcher/postcss.config.js
- client/apps/torii-launcher/vite.main.config.ts
- client/apps/torii-launcher/src/index.css
- client/apps/torii-launcher/.gitignore
- client/apps/torii-launcher/forge.env.d.ts
- client/apps/torii-launcher/.eslintrc.json
- client/apps/torii-launcher/src/renderer.ts
- client/apps/torii-launcher/vite.renderer.config.ts
- client/apps/torii-launcher/tsconfig.json
- client/apps/torii-launcher/index.html
🧰 Additional context used
🪛 GitHub Actions: lint
client/apps/torii-launcher/webpack.plugins.ts
[warning] Code formatting does not match Prettier standards
client/apps/torii-launcher/webpack.main.config.ts
[warning] Code formatting does not match Prettier standards
client/apps/torii-launcher/src/frontend/Logo-animated.tsx
[warning] Code formatting does not match Prettier standards
client/apps/torii-launcher/webpack.renderer.config.ts
[warning] Code formatting does not match Prettier standards
client/apps/torii-launcher/webpack.rules.ts
[warning] Code formatting does not match Prettier standards
client/apps/torii-launcher/src/frontend/Button.tsx
[warning] Code formatting does not match Prettier standards
🪛 GitHub Actions: knip
client/apps/torii-launcher/forge.config.ts
[warning] Unused file detected
🪛 Biome (1.9.4)
client/apps/torii-launcher/src/frontend/SyncingState.tsx
[error] 63-63: isNaN is unsafe. It attempts a type coercion. Use Number.isNaN instead.
See the MDN documentation for more details.
Unsafe fix: Use Number.isNaN instead.
(lint/suspicious/noGlobalIsNan)
🔇 Additional comments (14)
client/apps/torii-launcher/webpack.plugins.ts (2)
1-2: LGTM! Clean type import.The type-only import for ForkTsCheckerWebpackPlugin follows TypeScript best practices.
🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
6-10: Fix formatting to match Prettier standards.The configuration looks good, but there are formatting issues reported by the pipeline.
Run this command to fix formatting:
🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
client/apps/torii-launcher/webpack.rules.ts (3)
1-3: LGTM! Good type safety practices.The use of explicit type imports and the
Requiredutility type ensures proper type checking for webpack configuration.🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
4-10: LGTM! Proper native module handling.The configuration correctly handles native Node modules with appropriate path matching for cross-platform compatibility.
🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
21-30: Ensure type checking is handled separately.While using
transpileOnly: trueimproves build performance, it skips type checking. Verify that you haveForkTsCheckerWebpackPluginconfigured in your webpack plugins to run type checking in parallel.✅ Verification successful
Type checking is properly configured ✅
The
ForkTsCheckerWebpackPluginis correctly set up inwebpack.plugins.tsto handle type checking in parallel, which complements thetranspileOnly: truesetting.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Check if ForkTsCheckerWebpackPlugin is properly configured rg -l "ForkTsCheckerWebpackPlugin" client/apps/torii-launcher/Length of output: 108
Script:
#!/bin/bash # Check the content of webpack.plugins.ts cat client/apps/torii-launcher/webpack.plugins.tsLength of output: 416
🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
client/apps/torii-launcher/webpack.renderer.config.ts (2)
1-5: LGTM! Clean and well-structured imports.The imports are properly organized, with clear separation between standard libraries, webpack types, and local configuration files.
🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
1-50: Fix code formatting.The pipeline indicates that the code formatting doesn't match Prettier standards. Please run Prettier to format the file:
🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
client/apps/torii-launcher/public/torii.toml (3)
12-14: Verify world block value and empty contracts configuration.Two concerns:
- The
world_block = 940000seems arbitrary. Consider documenting why this specific block was chosen.- The empty
contractsarray might indicate missing configuration.Let's verify the world block value and expected contracts:
✅ Verification successful
Configuration is valid for the launcher's event consumption role
The
world_blockvalue matches the mainnet configuration, and the emptycontractsarray is appropriate for this launcher configuration file which focuses on event consumption rather than contract interaction.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for world block references rg -A 5 "world_block.*940000" # Search for contract configurations rg -A 5 "contracts.*\[" --type tomlLength of output: 3555
1-2: Uncomment the database directory configuration.The database directory configuration is commented out. This might cause issues if there's no default fallback in the application.
Let's verify if there's a default fallback in the codebase:
✅ Verification successful
The commented database directory configuration is intentional
The database directory appears to be dynamically set based on the network configuration, with a default pattern of "torii.$NETWORK.db". This is consistent across all environment configurations and is handled by the indexer script.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for default database directory configuration rg -A 5 "db_dir" --type rust --type typescriptLength of output: 81
Script:
#!/bin/bash # Search for db_dir and related configuration terms rg "db_dir|database.*dir|DB_DIR" -i # Search for configuration handling files fd -e rs -e ts -e js -e json "config|torii"Length of output: 11860
16-18: Verify events configuration completeness.The events configuration:
- Enables raw event processing which might have performance implications
- Only tracks two trophy-related events (
TrophyCreationandTrophyProgression)Verify if this covers all necessary events for the application.
Let's search for other relevant events in the codebase:
✅ Verification successful
Events configuration is complete and appropriate.
The configuration correctly tracks all trophy-related events:
- TrophyCreation: Captures trophy unlocks
- TrophyProgression: Tracks advancement through trophy levels
Raw event processing is necessary for the trophy achievement system to function properly.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for event definitions and usages rg "s0_eternum-Trophy" --type typescript --type rustLength of output: 87
Script:
#!/bin/bash # Search for eternum events and related patterns rg "s0_eternum-" -A 2 -B 2 # Search for event-related configurations fd "toml$" --exec grep -A 5 -B 5 "\[events\]" {} \; # Search for trophy-related code rg -i "trophy" -A 2 -B 2Length of output: 96379
client/apps/torii-launcher/webpack.main.config.ts (2)
1-4: LGTM! Well-structured imports.Good separation of concerns by keeping rules and plugins in separate files.
🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
17-19: Review resolve.extensions for main process.Since this is the main process configuration (not renderer), including '.css' in the extensions array is unusual as the main process typically doesn't handle CSS files. Consider removing it unless there's a specific need.
✅ Verification successful
Remove '.css' from main process webpack resolve.extensions
The main process code doesn't import any CSS files and handles only Node.js/Electron operations. The '.css' extension should be removed from webpack.main.config.ts as it's unnecessary for the main process.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Check if any CSS imports exist in the main process code rg -t ts -t js --glob '!*.test.*' --glob '!*.spec.*' -l '\.css' ./src/Length of output: 119
Script:
#!/bin/bash # First, let's understand the project structure fd -t f "main" client/apps/torii-launcher/ # Then check for CSS imports in the main process files rg -t ts -t js --glob '!*.test.*' --glob '!*.spec.*' -l '\.css' client/apps/torii-launcher/Length of output: 417
Script:
#!/bin/bash # Let's examine the main process entry point cat client/apps/torii-launcher/src/main.tsLength of output: 3530
🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
client/apps/torii-launcher/src/types.ts (1)
1-4: LGTM!The
IpcMethodenum is well-defined and improves the clarity of IPC communication.client/apps/torii-launcher/forge.config.ts (1)
1-67: Verify file usageThe pipeline reports this file as unused. Please verify that this configuration file is properly referenced in your build scripts.
🧰 Tools
🪛 GitHub Actions: knip
[warning] Unused file detected
| use: { | ||
| loader: "babel-loader", | ||
| options: { | ||
| exclude: /node_modules/, | ||
| presets: ["@babel/preset-react"], | ||
| }, | ||
| }, | ||
| }, |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Restructure the babel-loader configuration for better maintainability and performance.
The current configuration has several areas for improvement:
- The
excludeoption should be at the root level - Missing
includeoption to restrict transpilation scope - Missing environment-specific optimizations
- Could benefit from additional presets
use: {
loader: "babel-loader",
options: {
- exclude: /node_modules/,
presets: ["@babel/preset-react"],
+ presets: [
+ "@babel/preset-react",
+ ["@babel/preset-env", {
+ targets: {
+ electron: process.versions.electron
+ }
+ }]
+ ],
+ cacheDirectory: true
},
},
+ exclude: /node_modules/,
+ include: path.resolve(__dirname, "src"),Committable suggestion skipped: line range outside the PR's diff.
| rules.push({ | ||
| test: /\.css$/, | ||
| use: [{ loader: "style-loader" }, { loader: "css-loader" }], | ||
| }); |
There was a problem hiding this comment.
Remove duplicate CSS rule.
This CSS rule conflicts with the more specific rule defined later (lines 29-33). The later rule is more comprehensive as it includes path restrictions and PostCSS support.
-rules.push({
- test: /\.css$/,
- use: [{ loader: "style-loader" }, { loader: "css-loader" }],
-});🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
| plugins.push( | ||
| new HtmlWebpackPlugin({ | ||
| template: path.resolve(__dirname, "app/src/index.html"), | ||
| filename: "index.html", | ||
| }) | ||
| ); |
There was a problem hiding this comment.
💡 Codebase verification
Fix incorrect template path in HtmlWebpackPlugin configuration
The template path is incorrect. The index.html file exists at the root of the torii-launcher directory, not in app/src.
plugins.push(
new HtmlWebpackPlugin({
- template: path.resolve(__dirname, "app/src/index.html"),
+ template: path.resolve(__dirname, "index.html"),
filename: "index.html",
})
);🔗 Analysis chain
Add missing HtmlWebpackPlugin import.
The HtmlWebpackPlugin is used but not imported.
+import HtmlWebpackPlugin from "html-webpack-plugin";Verify template path consistency.
The template path uses app/src while other rules use src. This might indicate an inconsistent directory structure.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the template file exists and verify directory structure
fd --type f "index.html" --full-path ./client/apps/torii-launcher
Length of output: 105
🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting does not match Prettier standards
| events_chunk_size = 1024 # Size of events page to fetch | ||
| blocks_chunk_size = 1024 # Blocks to process before DB commit | ||
| pending = true # Enable indexing pending blocks | ||
| polling_interval = 500 # Polling interval in milliseconds | ||
| max_concurrent_tasks = 100 # Maximum concurrent indexing tasks |
There was a problem hiding this comment.
💡 Codebase verification
Consider increasing blocks_chunk_size to match other configurations
The current value of blocks_chunk_size = 1024 is significantly lower than the value of 10240 used in other environment configurations (mainnet, sepolia, local). Other parameters like events_chunk_size, polling_interval, and max_concurrent_tasks align with the established patterns across the codebase.
🔗 Analysis chain
Review performance parameters for resource constraints.
The current configuration sets aggressive values that might impact system resources:
- Large chunk sizes (1024 for both events and blocks)
- High number of concurrent tasks (100)
- Frequent polling (500ms)
Consider documenting the rationale for these values and their impact on system resources.
Let's check for any performance-related discussions or issues:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for performance-related discussions
gh issue list --search "performance Torii" --json number,title,body
Length of output: 72
Script:
#!/bin/bash
# Search for documentation and similar config files
echo "=== Searching for documentation ==="
fd -e md -e txt | xargs rg -i "events_chunk|blocks_chunk|concurrent_tasks|polling_interval" -C 2
echo -e "\n=== Searching for similar TOML configs ==="
fd -e toml | xargs rg "events_chunk|blocks_chunk|concurrent_tasks|polling_interval" -C 2
echo -e "\n=== Checking file history ==="
git log -p client/apps/torii-launcher/public/torii.toml
Length of output: 3717
| while (true) { | ||
| fs.mkdirSync(dbPath, { recursive: true }); | ||
| console.log("Launching torii"); | ||
| child = spawn(`${dojoPath}/bin/torii`, [ | ||
| "--world", | ||
| "0x6a9e4c6f0799160ea8ddc43ff982a5f83d7f633e9732ce42701de1288ff705f", | ||
| "--http.cors_origins", | ||
| "*", | ||
| "--config", | ||
| toriiTomlPath, | ||
| "--db-dir", | ||
| dbPath, | ||
| ]); | ||
|
|
||
| child.stdout.on("data", (data: any) => { | ||
| console.log(`stdout: ${data}`); | ||
| }); | ||
|
|
||
| child.stderr.on("data", (data: any) => { | ||
| console.error(`stderr: ${data}`); | ||
| }); | ||
|
|
||
| while (child.exitCode === null) { | ||
| console.log("Torii is still running"); | ||
| await timeout(10000); | ||
| } | ||
| child.removeAllListeners(); | ||
|
|
||
| console.log(`child process exited with code ${child.exitCode}`); | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Implement a retry mechanism with backoff strategy instead of infinite loop.
The infinite while (true) loop may cause rapid restarts if the Torii process fails immediately, potentially leading to resource exhaustion. Consider implementing a retry mechanism with a maximum number of retries or an exponential backoff strategy to handle failures gracefully.
| # Create the iconset | ||
| iconutil -c icns $output_iconset_name | ||
|
|
||
| # Delete the temp folder | ||
| rm -R $output_iconset_name | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add error handling for ICNS creation.
- Add error handling for the
iconutilcommand. - Quote the cleanup command.
- Check for
iconutilavailability.
Apply this diff:
+# Check for iconutil
+if ! command -v iconutil >/dev/null 2>&1; then
+ echo "ERROR: This script requires the 'iconutil' command (Mac OS only)."
+ rm -rf "${output_iconset_name}"
+ exit 1
+fi
+
# Create the iconset
-iconutil -c icns $output_iconset_name
+if ! iconutil -c icns "${output_iconset_name}"; then
+ echo "ERROR: Failed to create ICNS file."
+ rm -rf "${output_iconset_name}"
+ exit 1
+fi
# Delete the temp folder
-rm -R $output_iconset_name
+rm -rf "${output_iconset_name}"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # Create the iconset | |
| iconutil -c icns $output_iconset_name | |
| # Delete the temp folder | |
| rm -R $output_iconset_name | |
| # Check for iconutil | |
| if ! command -v iconutil >/dev/null 2>&1; then | |
| echo "ERROR: This script requires the 'iconutil' command (Mac OS only)." | |
| rm -rf "${output_iconset_name}" | |
| exit 1 | |
| fi | |
| # Create the iconset | |
| if ! iconutil -c icns "${output_iconset_name}"; then | |
| echo "ERROR: Failed to create ICNS file." | |
| rm -rf "${output_iconset_name}" | |
| exit 1 | |
| fi | |
| # Delete the temp folder | |
| rm -rf "${output_iconset_name}" |
| icon_orginal_name="icon" | ||
| icon_name=$icon_orginal_name | ||
| icon_extension="icns" | ||
|
|
||
| # If dest path exists, add suffix number | ||
| # to avoid the new icon file to replace an existing file | ||
| icon_index=2 | ||
| while [ -f "${icon_name}.${icon_extension}" ] | ||
| do | ||
| icon_name="${icon_orginal_name}_${icon_index}" | ||
| icon_index=$((icon_index + 1)) | ||
| done |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Improve output file handling.
- Variables should be quoted to handle spaces correctly.
- Consider making the base icon name configurable.
- Add write permission check for the output directory.
Apply this diff:
-icon_orginal_name="icon"
+# Allow custom base name via environment variable
+icon_original_name="${ICON_BASE_NAME:-icon}"
+icon_name="${icon_original_name}"
+icon_extension="icns"
-icon_name=$icon_orginal_name
-icon_extension="icns"
+# Check if current directory is writable
+if [ ! -w "." ]; then
+ echo "ERROR: Current directory is not writable."
+ exit 1
+fi
# If dest path exists, add suffix number
# to avoid the new icon file to replace an existing file
icon_index=2
-while [ -f "${icon_name}.${icon_extension}" ]
+while [ -f "${icon_name}.${icon_extension}" ]
do
- icon_name="${icon_orginal_name}_${icon_index}"
+ icon_name="${icon_original_name}_${icon_index}"
icon_index=$((icon_index + 1))
done📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| icon_orginal_name="icon" | |
| icon_name=$icon_orginal_name | |
| icon_extension="icns" | |
| # If dest path exists, add suffix number | |
| # to avoid the new icon file to replace an existing file | |
| icon_index=2 | |
| while [ -f "${icon_name}.${icon_extension}" ] | |
| do | |
| icon_name="${icon_orginal_name}_${icon_index}" | |
| icon_index=$((icon_index + 1)) | |
| done | |
| # Allow custom base name via environment variable | |
| icon_original_name="${ICON_BASE_NAME:-icon}" | |
| icon_name="${icon_original_name}" | |
| icon_extension="icns" | |
| # Check if current directory is writable | |
| if [ ! -w "." ]; then | |
| echo "ERROR: Current directory is not writable." | |
| exit 1 | |
| fi | |
| # If dest path exists, add suffix number | |
| # to avoid the new icon file to replace an existing file | |
| icon_index=2 | |
| while [ -f "${icon_name}.${icon_extension}" ] | |
| do | |
| icon_name="${icon_original_name}_${icon_index}" | |
| icon_index=$((icon_index + 1)) | |
| done |
| # if empty image_path, display error message and usage | ||
| if [ -z "$image_path" ] | ||
| then | ||
| echo "ERROR: '-i' parameter cannot be empty." | ||
| usageFunction | ||
| fi | ||
|
|
||
| # if extension not .png, display error message | ||
| if [[ ! $image_path =~ .png$ ]] | ||
| then | ||
| echo "ERROR: image path need to end with .png" | ||
| exit 1 | ||
| fi | ||
|
|
||
| # if image path file doesn't exists, display error message | ||
| if [ ! -f "$image_path" ] | ||
| then | ||
| echo "ERROR: image path doesn't seems to exists on your disk." | ||
| exit 1 | ||
| fi |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance input validation robustness.
- The PNG extension check is case-sensitive and might reject valid files.
- File permissions should be checked.
- Error messages should include the actual path.
Apply this diff:
# if empty image_path, display error message and usage
if [ -z "$image_path" ]
then
- echo "ERROR: '-i' parameter cannot be empty."
+ echo "ERROR: Image path parameter (-i) cannot be empty."
usageFunction
fi
# if extension not .png, display error message
-if [[ ! $image_path =~ .png$ ]]
+if [[ ! $image_path =~ .[pP][nN][gG]$ ]]
then
- echo "ERROR: image path need to end with .png"
+ echo "ERROR: Image path '$image_path' must end with .png"
exit 1
fi
-# if image path file doesn't exists, display error message
-if [ ! -f "$image_path" ]
+# Check if file exists and is readable
+if [ ! -f "$image_path" ] || [ ! -r "$image_path" ]
then
- echo "ERROR: image path doesn't seems to exists on your disk."
+ echo "ERROR: Image '$image_path' doesn't exist or is not readable."
exit 1
fi📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # if empty image_path, display error message and usage | |
| if [ -z "$image_path" ] | |
| then | |
| echo "ERROR: '-i' parameter cannot be empty." | |
| usageFunction | |
| fi | |
| # if extension not .png, display error message | |
| if [[ ! $image_path =~ .png$ ]] | |
| then | |
| echo "ERROR: image path need to end with .png" | |
| exit 1 | |
| fi | |
| # if image path file doesn't exists, display error message | |
| if [ ! -f "$image_path" ] | |
| then | |
| echo "ERROR: image path doesn't seems to exists on your disk." | |
| exit 1 | |
| fi | |
| # if empty image_path, display error message and usage | |
| if [ -z "$image_path" ] | |
| then | |
| echo "ERROR: Image path parameter (-i) cannot be empty." | |
| usageFunction | |
| fi | |
| # if extension not .png, display error message | |
| if [[ ! $image_path =~ .[pP][nN][gG]$ ]] | |
| then | |
| echo "ERROR: Image path '$image_path' must end with .png" | |
| exit 1 | |
| fi | |
| # Check if file exists and is readable | |
| if [ ! -f "$image_path" ] || [ ! -r "$image_path" ] | |
| then | |
| echo "ERROR: Image '$image_path' doesn't exist or is not readable." | |
| exit 1 | |
| fi |
| #!/usr/bin/env bash | ||
|
|
||
| # PNG to ICNS v1.0 - https://github.com/BenSouchet/png-to-icns | ||
| # Copyright(C) 2022 Ben Souchet | MIT License | ||
|
|
||
| usageFunction() | ||
| { | ||
| echo "PNG to ICNS v1.0 - Easily convert your image to Mac OS icon!" | ||
| echo "" | ||
| echo "Usage: $0 -i <path of the .png image>" | ||
| echo -e "\t-i Relative path of the image (.png)" | ||
| echo -e "\t-h Display this usage message" | ||
|
|
||
| # Exit / Stop the script | ||
| exit 1 | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix script naming and usage function exit code.
- The script filename
png_to_isns.shcontains a typo - it should bepng_to_icns.shto match the ICNS format. - The usage function should exit with status 0 when displaying help, as this isn't an error condition.
Apply this diff:
-#!/usr/bin/env bash
+#!/usr/bin/env bash
+set -euo pipefail
# PNG to ICNS v1.0 - https://github.com/BenSouchet/png-to-icns
# Copyright(C) 2022 Ben Souchet | MIT License
usageFunction()
{
echo "PNG to ICNS v1.0 - Easily convert your image to Mac OS icon!"
echo ""
echo "Usage: $0 -i <path of the .png image>"
echo -e "\t-i Relative path of the image (.png)"
echo -e "\t-h Display this usage message"
# Exit / Stop the script
- exit 1
+ exit 0
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| #!/usr/bin/env bash | |
| # PNG to ICNS v1.0 - https://github.com/BenSouchet/png-to-icns | |
| # Copyright(C) 2022 Ben Souchet | MIT License | |
| usageFunction() | |
| { | |
| echo "PNG to ICNS v1.0 - Easily convert your image to Mac OS icon!" | |
| echo "" | |
| echo "Usage: $0 -i <path of the .png image>" | |
| echo -e "\t-i Relative path of the image (.png)" | |
| echo -e "\t-h Display this usage message" | |
| # Exit / Stop the script | |
| exit 1 | |
| } | |
| #!/usr/bin/env bash | |
| set -euo pipefail | |
| # PNG to ICNS v1.0 - https://github.com/BenSouchet/png-to-icns | |
| # Copyright(C) 2022 Ben Souchet | MIT License | |
| usageFunction() | |
| { | |
| echo "PNG to ICNS v1.0 - Easily convert your image to Mac OS icon!" | |
| echo "" | |
| echo "Usage: $0 -i <path of the .png image>" | |
| echo -e "\t-i Relative path of the image (.png)" | |
| echo -e "\t-h Display this usage message" | |
| # Exit / Stop the script | |
| exit 0 | |
| } |
| output_iconset_name="${icon_name}.iconset" | ||
|
|
||
| # Create the temp directory to save the icon sizes | ||
| mkdir $output_iconset_name | ||
|
|
||
| # Create the icon sizes | ||
| sips -z 16 16 -s format png "$image_path" --out "${output_iconset_name}/icon_16x16.png" > /dev/null | ||
| sips -z 32 32 -s format png "$image_path" --out "${output_iconset_name}/[email protected]" > /dev/null | ||
| sips -z 32 32 -s format png "$image_path" --out "${output_iconset_name}/icon_32x32.png" > /dev/null | ||
| sips -z 64 64 -s format png "$image_path" --out "${output_iconset_name}/[email protected]" > /dev/null | ||
| sips -z 128 128 -s format png "$image_path" --out "${output_iconset_name}/icon_128x128.png" > /dev/null | ||
| sips -z 256 256 -s format png "$image_path" --out "${output_iconset_name}/[email protected]" > /dev/null | ||
| sips -z 256 256 -s format png "$image_path" --out "${output_iconset_name}/icon_256x256.png" > /dev/null | ||
| sips -z 512 512 -s format png "$image_path" --out "${output_iconset_name}/[email protected]" > /dev/null | ||
| sips -z 512 512 -s format png "$image_path" --out "${output_iconset_name}/icon_512x512.png" > /dev/null | ||
| sips -z 1024 1024 -s format png "$image_path" --out "${output_iconset_name}/[email protected]" > /dev/null | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add error handling and platform checks.
- Add error handling for
sipscommands. - Quote the mkdir command and handle errors.
- Check for required commands before proceeding.
Apply this diff:
+# Check for required commands
+if ! command -v sips >/dev/null 2>&1; then
+ echo "ERROR: This script requires the 'sips' command (Mac OS only)."
+ exit 1
+fi
+
output_iconset_name="${icon_name}.iconset"
# Create the temp directory to save the icon sizes
-mkdir $output_iconset_name
+if ! mkdir "${output_iconset_name}"; then
+ echo "ERROR: Failed to create temporary directory '${output_iconset_name}'."
+ exit 1
+fi
# Create the icon sizes
-sips -z 16 16 -s format png "$image_path" --out "${output_iconset_name}/icon_16x16.png" > /dev/null
+generate_icon_size() {
+ local size="$1"
+ local output="$2"
+ if ! sips -z "$size" "$size" -s format png "$image_path" --out "$output" > /dev/null 2>&1; then
+ echo "ERROR: Failed to generate ${size}x${size} icon."
+ rm -rf "${output_iconset_name}"
+ exit 1
+ fi
+}
+
+generate_icon_size 16 "${output_iconset_name}/icon_16x16.png"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| output_iconset_name="${icon_name}.iconset" | |
| # Create the temp directory to save the icon sizes | |
| mkdir $output_iconset_name | |
| # Create the icon sizes | |
| sips -z 16 16 -s format png "$image_path" --out "${output_iconset_name}/icon_16x16.png" > /dev/null | |
| sips -z 32 32 -s format png "$image_path" --out "${output_iconset_name}/[email protected]" > /dev/null | |
| sips -z 32 32 -s format png "$image_path" --out "${output_iconset_name}/icon_32x32.png" > /dev/null | |
| sips -z 64 64 -s format png "$image_path" --out "${output_iconset_name}/[email protected]" > /dev/null | |
| sips -z 128 128 -s format png "$image_path" --out "${output_iconset_name}/icon_128x128.png" > /dev/null | |
| sips -z 256 256 -s format png "$image_path" --out "${output_iconset_name}/[email protected]" > /dev/null | |
| sips -z 256 256 -s format png "$image_path" --out "${output_iconset_name}/icon_256x256.png" > /dev/null | |
| sips -z 512 512 -s format png "$image_path" --out "${output_iconset_name}/[email protected]" > /dev/null | |
| sips -z 512 512 -s format png "$image_path" --out "${output_iconset_name}/icon_512x512.png" > /dev/null | |
| sips -z 1024 1024 -s format png "$image_path" --out "${output_iconset_name}/[email protected]" > /dev/null | |
| # Check for required commands | |
| if ! command -v sips >/dev/null 2>&1; then | |
| echo "ERROR: This script requires the 'sips' command (Mac OS only)." | |
| exit 1 | |
| fi | |
| output_iconset_name="${icon_name}.iconset" | |
| # Create the temp directory to save the icon sizes | |
| if ! mkdir "${output_iconset_name}"; then | |
| echo "ERROR: Failed to create temporary directory '${output_iconset_name}'." | |
| exit 1 | |
| fi | |
| # Create the icon sizes | |
| generate_icon_size() { | |
| local size="$1" | |
| local output="$2" | |
| if ! sips -z "$size" "$size" -s format png "$image_path" --out "$output" > /dev/null 2>&1; then | |
| echo "ERROR: Failed to generate ${size}x${size} icon." | |
| rm -rf "${output_iconset_name}" | |
| exit 1 | |
| fi | |
| } | |
| generate_icon_size 16 "${output_iconset_name}/icon_16x16.png" | |
| generate_icon_size 32 "${output_iconset_name}/[email protected]" | |
| generate_icon_size 32 "${output_iconset_name}/icon_32x32.png" | |
| generate_icon_size 64 "${output_iconset_name}/[email protected]" | |
| generate_icon_size 128 "${output_iconset_name}/icon_128x128.png" | |
| generate_icon_size 256 "${output_iconset_name}/[email protected]" | |
| generate_icon_size 256 "${output_iconset_name}/icon_256x256.png" | |
| generate_icon_size 512 "${output_iconset_name}/[email protected]" | |
| generate_icon_size 512 "${output_iconset_name}/icon_512x512.png" | |
| generate_icon_size 1024 "${output_iconset_name}/[email protected]" |
Allows a user to simply download a .dmg file built from this app, install the dmg and then run a local torii pointing to mainnet.
Currently the configuration is very static (i.e. it points to a world address that's fixed and user can't change that, it points to mainnet, etc.), I will iterate on this to make it more dynamic
Summary by CodeRabbit
Based on the comprehensive changes, here are the release notes:
New Features
Configuration Updates
Development Tools
UI Components