BibliothecaDAO / eternum

onchain eternal game
https://eternum.realms.world
MIT License
49 stars 37 forks source link

implements zod env checking #2138

Open credence0x opened 4 hours ago

credence0x commented 4 hours ago

Summary by CodeRabbit

Release Notes

These changes improve the application's configuration management and streamline the handling of environment variables, enhancing overall performance and maintainability.

vercel[bot] commented 4 hours ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
eternum ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 23, 2024 1:36am
eternum-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 23, 2024 1:36am
eternum-landing ❌ Failed (Inspect) Nov 23, 2024 1:36am
mentatbot[bot] commented 4 hours ago

You are out of MentatBot reviews. Your usage will refresh November 25 at 08:00 AM.

coderabbitai[bot] commented 4 hours ago

Walkthrough

The changes in this pull request introduce multiple new environment variables across various configuration files, specifically in the client and landing directories. These variables include settings for token addresses, API endpoints, and flags for application features. Additionally, modifications were made to how environment variables are accessed within the codebase, transitioning from direct access via import.meta.env to a centralized env module, enhancing type safety and consistency in variable management.

Changes

File Change Summary
client/.env.preview Added multiple environment variables including VITE_PUBLIC_FEE_TOKEN_ADDRESS, VITE_PUBLIC_CHAIN, and various URLs.
client/.env.production Added similar environment variables as in .env.preview.
client/dojoConfig.ts Updated environment variable access from import.meta.env to env, changed VITE_PUBLIC_DEV comparison from string to boolean.
client/env.ts Introduced a validation schema for environment variables using Zod, defined and exported env and Env type.
client/package.json Added dependency "zod": "^3.23.8".
client/src/hooks/context/DojoContext.tsx Updated environment variable access to use env, modified type of requiredEnvs.
client/src/hooks/context/starknet-provider.tsx Changed access to VITE_PUBLIC_NODE_URL to use env.
client/src/main.tsx Updated access to environment variables to use env, changed boolean comparisons.
client/src/three/helpers/GUIManager.ts Modified autoPlace property assignment to use env.
client/src/three/scenes/HexagonScene.ts Updated condition for adding lightHelper to use env.
client/src/ui/layouts/World.tsx Changed access to environment variables for Leva and VersionDisplay components to use env.
client/src/ui/modules/onboarding/Steps.tsx Updated condition for VITE_PUBLIC_DEV to use env.
landing/.env Removed file containing various environment variable declarations.
landing/.env.preview Added new environment variables and updated existing ones, including VITE_PUBLIC_FEE_TOKEN_ADDRESS and various URLs.
landing/.env.production Added similar environment variables as in .env.preview.
landing/dojoConfig.ts Updated environment variable access from import.meta.env to env, changed VITE_PUBLIC_DEV comparison from string to boolean.
landing/env.ts Introduced a validation schema for environment variables using Zod, defined and exported env and Env type.
landing/package.json Added dependency "zod": "^3.23.8".
landing/src/components/providers/Starknet.tsx Changed access to VITE_PUBLIC_NODE_URL to use env.
landing/src/config.ts Updated various address assignments to use env.
landing/src/dojo/setupNetwork.ts Updated condition for VITE_PUBLIC_DEV to use env.
landing/src/hooks/context/DojoContext.tsx Updated environment variable access to use env, modified type of requiredEnvs and feeTokenAddress.
landing/src/lib/ark/getCollectionTokens.ts Changed access to environment variables to use env.
landing/src/routes/mint.lazy.tsx Changed access to environment variables to use env.
landing/tsconfig.app.json Updated include property to include env.ts.

Possibly related PRs

🐇 In the land of code so bright,
New variables spring to light.
From .env to env we go,
Type safety blooms, like a garden's glow.
With Zod to guard our precious keys,
Our app now dances with greater ease! 🌼

[!WARNING]

Rate limit exceeded

@credence0x has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 51 seconds before requesting another review.

⌛ How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
🚦 How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://docs.coderabbit.ai/faq) for further information.
📥 Commits Reviewing files that changed from the base of the PR and between 53e16184d236235b5b5dc5f7d5a8bb98fbf79863 and c0f9eb4388c9d6aa8972c7bc0bcb4217e5043923.

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?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.