chore: shutter env variables #2017
Conversation
WalkthroughThe changes introduce new environment variables to configure the Shutter API endpoint across both backend and frontend environments. Hardcoded Shutter API URLs in scripts and utilities are replaced with references to these environment variables, allowing for dynamic configuration of the API base URL. No other logic or control flow is altered. Changes
Sequence Diagram(s)sequenceDiagram
participant App/Script
participant Env
participant ShutterAPI
App/Script->>Env: Read SHUTTER_API or REACT_APP_SHUTTER_API
App/Script->>ShutterAPI: Make API request using configured base URL
ShutterAPI-->>App/Script: Return response
Poem
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (1)
contracts/scripts/shutter.ts (1)
93-93: Same environment variable validation issue applies here.This line also uses the potentially undefined
SHUTTER_APIvariable, which could result in malformed URLs.
🧹 Nitpick comments (4)
contracts/.env.example (1)
22-22: Ensure consistent quoting in.enventries.All other variables in this example file are unquoted (e.g.,
INFURA_API_KEY=...). Wrapping the URL in double quotes may introduce unexpected literal quotes when parsed by some tools. Consider removing the surrounding quotes for consistency:- SHUTTER_API="https://shutter-api.chiado.staging.shutter.network/api" + SHUTTER_API=https://shutter-api.chiado.staging.shutter.network/apiweb/.env.devnet-university.public (1)
11-11: Verify environment variable exposure in production builds.Similar to the local config, confirm that
REACT_APP_SHUTTER_APIis injected intoimport.meta.envat runtime. If not, switch to theVITE_prefix and remove the quotes for consistency:- export REACT_APP_SHUTTER_API="https://shutter-api.chiado.staging.shutter.network/api" + export VITE_SHUTTER_API=https://shutter-api.chiado.staging.shutter.network/apiweb/.env.devnet.public (1)
10-10: Ensure correct env var naming and consistency.Double-check that your environment loader exposes
REACT_APP_SHUTTER_API. If you’re on Vite, rename toVITE_SHUTTER_APIand consider dropping the quotes:- export REACT_APP_SHUTTER_API="https://shutter-api.chiado.staging.shutter.network/api" + export VITE_SHUTTER_API=https://shutter-api.chiado.staging.shutter.network/apiweb/src/utils/shutter.ts (1)
33-33: Guard against missing base URL and DRY up fetch calls.If
REACT_APP_SHUTTER_APIis undefined, your fetch calls will target"undefined/...at runtime. Extract and validate the base URL once, then reuse it:+ // After imports + const SHUTTER_BASE_URL = import.meta.env.REACT_APP_SHUTTER_API; + if (!SHUTTER_BASE_URL) { + throw new Error("Missing environment variable REACT_APP_SHUTTER_API"); + } --- fetchShutterData --------------------- - const response = await fetch(`${import.meta.env.REACT_APP_SHUTTER_API}/register_identity`, { + const response = await fetch(`${SHUTTER_BASE_URL}/register_identity`, { method: "POST", ... }); --- fetchDecryptionKey ------------------- - const response = await fetch(`${import.meta.env.REACT_APP_SHUTTER_API}/get_decryption_key?identity=${identity}`, { + const response = await fetch(`${SHUTTER_BASE_URL}/get_decryption_key?identity=${identity}`, { method: "GET", ... });Also applies to: 80-80
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
contracts/.env.example(1 hunks)contracts/scripts/shutter.ts(3 hunks)web/.env.devnet-neo.public(1 hunks)web/.env.devnet-university.public(1 hunks)web/.env.devnet.public(1 hunks)web/.env.local.public(1 hunks)web/.env.mainnet-neo.public(1 hunks)web/.env.testnet.public(1 hunks)web/src/utils/shutter.ts(2 hunks)
🔇 Additional comments (3)
web/.env.local.public (1)
9-9: Align variable prefix with Vite’s requirements.Your frontend code uses
import.meta.env.REACT_APP_SHUTTER_API, but Vite only exposes env vars prefixed withVITE_by default. Please verify your build config supportsREACT_APP_*, or rename toVITE_SHUTTER_APIfor seamless injection:- export REACT_APP_SHUTTER_API="https://shutter-api.chiado.staging.shutter.network/api" + export VITE_SHUTTER_API=https://shutter-api.chiado.staging.shutter.network/apiweb/.env.testnet.public (1)
11-11: LGTM! Appropriate staging URL for testnet environment.The staging Shutter API URL is correctly configured for the testnet environment.
web/.env.devnet-neo.public (1)
12-12: LGTM! Appropriate staging URL for devnet environment.The staging Shutter API URL is correctly configured for the devnet-neo environment.
| import { encryptData, decrypt as shutterDecrypt } from "@shutter-network/shutter-sdk"; | ||
| import { Hex, stringToHex, hexToString } from "viem"; | ||
| import crypto from "crypto"; | ||
| import "isomorphic-fetch"; | ||
|
|
||
| const SHUTTER_API = env.optionalNoDefault("SHUTTER_API"); |
There was a problem hiding this comment.
Add validation for the required environment variable.
The SHUTTER_API environment variable is declared as optional with no default value, which means it could be undefined. This will cause runtime errors when constructing API URLs in the fetch functions.
Add proper validation to ensure the environment variable is set:
-const SHUTTER_API = env.optionalNoDefault("SHUTTER_API");
+const SHUTTER_API = env.required("SHUTTER_API");Or if you want to keep it optional, add validation:
-const SHUTTER_API = env.optionalNoDefault("SHUTTER_API");
+const SHUTTER_API = env.optionalNoDefault("SHUTTER_API");
+if (!SHUTTER_API) {
+ throw new Error("SHUTTER_API environment variable is required but not set");
+}📝 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.
| const SHUTTER_API = env.optionalNoDefault("SHUTTER_API"); | |
| -const SHUTTER_API = env.optionalNoDefault("SHUTTER_API"); | |
| +const SHUTTER_API = env.required("SHUTTER_API"); |
| const SHUTTER_API = env.optionalNoDefault("SHUTTER_API"); | |
| const SHUTTER_API = env.optionalNoDefault("SHUTTER_API"); | |
| +if (!SHUTTER_API) { | |
| + throw new Error("SHUTTER_API environment variable is required but not set"); | |
| +} |
🤖 Prompt for AI Agents
In contracts/scripts/shutter.ts at line 7, the SHUTTER_API environment variable
is declared as optional without a default, which can lead to undefined values
and runtime errors. Modify the code to validate that SHUTTER_API is defined
before using it by either making it required with env.required or adding a
runtime check that throws an error if SHUTTER_API is undefined, ensuring safe
usage in API URL construction.
There was a problem hiding this comment.
I actually handle it like this in the feat/shutter-dispute-kit branch. I will change it when merging.
There was a problem hiding this comment.
@jaybuidl Thanks for the confirmation! That sounds like a good approach to handle the environment variable validation in the feature branch and apply it during the merge. I appreciate you keeping track of these improvements across branches.
| @@ -38,7 +40,7 @@ | |||
| const identityPrefix = generateRandomBytes32(); | |||
| console.log(`Generated identity prefix: ${identityPrefix}`); | |||
|
|
|||
| const response = await fetch("https://shutter-api.shutter.network/api/register_identity", { | |||
| const response = await fetch(`${SHUTTER_API}/register_identity`, { | |||
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify the environment variable is properly set.
Since SHUTTER_API could be undefined, this URL construction could result in "undefined/register_identity", causing API calls to fail.
Ensure the environment variable is properly configured across all deployment environments:
🏁 Script executed:
#!/bin/bash
# Description: Check if SHUTTER_API is defined in environment configuration files
# Look for SHUTTER_API definitions in env files
fd -e env -e example | xargs grep -l "SHUTTER_API" || echo "No SHUTTER_API found in env files"
# Check if there are any default values or fallbacks defined
rg "SHUTTER_API.*=" -A 2 -B 2Length of output: 1202
🏁 Script executed:
#!/bin/bash
set -e
# Search for definition of optionalNoDefault to understand its behavior
rg "optionalNoDefault" -n -C 3Length of output: 3790
Use a required environment variable for SHUTTER_API
The env.optionalNoDefault("SHUTTER_API") call can return undefined, leading to requests against "undefined/register_identity". Instead, make SHUTTER_API mandatory so the script fails fast if it’s unset.
• In contracts/scripts/shutter.ts (at the top, around line 7)
- const SHUTTER_API = env.optionalNoDefault("SHUTTER_API");
+ const SHUTTER_API = env.require("SHUTTER_API");• This change will throw a clear error at startup if SHUTTER_API is not defined, preventing invalid fetch URLs.
• Ensure your deployment/CI environments define SHUTTER_API.
📝 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.
| const response = await fetch(`${SHUTTER_API}/register_identity`, { | |
| // contracts/scripts/shutter.ts (around the top of the file) | |
| -import { env } from "..."; | |
| -const SHUTTER_API = env.optionalNoDefault("SHUTTER_API"); | |
| +const SHUTTER_API = env.require("SHUTTER_API"); |
🤖 Prompt for AI Agents
In contracts/scripts/shutter.ts around line 7, change the environment variable
retrieval for SHUTTER_API from an optional call to a required one so that the
script throws an error immediately if SHUTTER_API is not set. This prevents
constructing fetch URLs with "undefined" and ensures the script fails fast.
Update the code to use a method that enforces SHUTTER_API presence and verify
that all deployment and CI environments define this variable.
| export NODE_OPTIONS='--max-old-space-size=7680' | ||
| export REACT_APP_SHUTTER_API="https://shutter-api.chiado.staging.shutter.network/api" |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify if staging URL is appropriate for mainnet environment.
The mainnet (production) environment is configured to use the staging Shutter API URL. This may cause reliability issues if the staging environment has different uptime guarantees or gets reset.
Please confirm if this is intentional or if a production Shutter API URL should be used instead:
🌐 Web query:
What is the production URL for the Shutter API? Is there a difference between staging and production endpoints?
💡 Result:
Based on the search results, the Shutter API has different endpoints for staging and production environments.
Shutter API Endpoints
The production and staging URLs for Shutter API are environment-specific. According to the information available, the Shutter API can be accessed through the following endpoint for the Chiado environment:
https://shutter-api.chiado
This appears to be one of the available endpoints where you can query the API[2]. However, the complete production URL structure isn't fully specified in the provided information.
Staging vs. Production Environments
There is indeed a difference between staging and production environments for APIs, including the Shutter API. These differences typically include:
-
Separate Endpoints: Organizations often provide distinct URLs for staging and production environments[6][10].
-
Different Rate Limits: Staging environments may have lower rate limits compared to production environments[6][10].
-
Method Restrictions: Some API methods or endpoints might be restricted in staging environments but available in production, or vice versa. This allows testing new features safely before making them available to all users[6].
-
Traffic Separation: In proper implementations, staging and production traffic is separated to allow for better analytics and monitoring[6][10].
One common approach is to use different application plans for each environment with distinct rate limits and method availability. This helps developers test their applications in a controlled environment before moving to production[6][10].
While the specific differences between Shutter API's staging and production endpoints aren't explicitly detailed in the search results, it follows standard API management practices of providing separate environments for development/testing and production use.
Citations:
- 1: https://api-reference.shutterstock.com
- 2: https://github.com/shutter-network/shutter-api
- 3: https://www.shutterstock.com/developers/documentation/authentication
- 4: https://www.youtube.com/watch?v=qurxvE7lhX0
- 5: https://developers.shotgridsoftware.com/rest-api/
- 6: https://docs.redhat.com/en/documentation/red_hat_3scale_api_management/2.3/html/api_devops/differentiate-environments
- 7: https://www.npmjs.com/package/shutterstock-api
- 8: https://community.weweb.io/t/staging-vs-production-environment/14003
- 9: https://developer.cybersource.com/docs/cybs/en-us/endpoints/reference/all/na/endpoints/endpoints.html
- 10: https://docs.redhat.com/en/documentation/red_hat_3scale_api_management/2.1/html/api_devops/differentiate-environments
Use Production Shutter API Endpoint in Mainnet Environment
The web/.env.mainnet-neo.public file is currently pointing at the staging API (https://shutter-api.chiado.staging.shutter.network/api), but the production Chiado endpoint should be different.
• File: web/.env.mainnet-neo.public
Line 12:
- export REACT_APP_SHUTTER_API="https://shutter-api.chiado.staging.shutter.network/api"
+ export REACT_APP_SHUTTER_API="https://shutter-api.chiado/api"Please confirm the exact production URL (e.g. include or omit /api) and update this variable to avoid relying on the staging service in production.
📝 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.
| export REACT_APP_SHUTTER_API="https://shutter-api.chiado.staging.shutter.network/api" | |
| export REACT_APP_SHUTTER_API="https://shutter-api.chiado/api" |
🤖 Prompt for AI Agents
In web/.env.mainnet-neo.public at line 12, the REACT_APP_SHUTTER_API is set to
the staging URL, which is inappropriate for the mainnet production environment.
Replace the staging URL with the correct production Shutter API endpoint for
Chiado, ensuring you confirm whether the path should include "/api" or not.
Update the environment variable to point to the verified production URL to avoid
using the staging service in production.
|
jaybuidl
added
Type: Feature🗿
Package: Web
PR-Codex overview
This PR focuses on adding the
REACT_APP_SHUTTER_APIenvironment variable to various.envfiles and updating thefetchcalls in the code to utilize this new variable for API requests instead of hardcoded URLs.Detailed summary
REACT_APP_SHUTTER_APIto multiple.envfiles.fetchcalls inweb/src/utils/shutter.tsto use${import.meta.env.REACT_APP_SHUTTER_API}for API requests.SHUTTER_APIconstant incontracts/scripts/shutter.tsto utilize the environment variable for API requests.Summary by CodeRabbit