UI to support Runtimes recommendation env parameters display #243
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reviewer's GuideAdds conditional rendering and formatting of environment variable parameters in recommendation detail code snippets for both cost and performance views in Local and Remote Monitoring, while normalizing YAML-like output formatting. Class diagram for recommendation details components env handlingclassDiagram
class CostDetailsRemote {
+recommendedData any[]
+currentData any[]
+chartData any
+day any
+endt any
+formatEnvParams(recommendedData any[]): string
+buildRecommendedCode(): string
}
class PerfDetailsRemote {
+recommendedData any[]
+currentData any[]
+chartData any
+day any
+endt any
+formatEnvParams(recommendedData any[]): string
+buildRecommendedCode(): string
}
class CostDetailsLocal {
+recommendedData any[]
+currentData any[]
+chartData any
+day any
+endt any
+experimentType string
+formatEnvParams(recommendedData any[]): string
+buildRecommendedCode(): string
}
class PerfDetailsLocal {
+recommendedData any[]
+currentData any[]
+chartData any
+day any
+endt any
+experimentType string
+formatEnvParams(recommendedData any[]): string
+buildRecommendedCode(): string
}
class RecommendationData {
+requests any
+limits any
+recommendation_engines RecommendationEngines
}
class RecommendationEngines {
+cost RecommendationEngine
+performance RecommendationEngine
}
class RecommendationEngine {
+config RecommendationEngineConfig
+variation any
}
class RecommendationEngineConfig {
+requests any
+limits any
+env EnvParam[]
}
class EnvParam {
+name string
+value string
}
CostDetailsRemote --> RecommendationData : uses_recommendedData
PerfDetailsRemote --> RecommendationData : uses_recommendedData
CostDetailsLocal --> RecommendationData : uses_recommendedData
PerfDetailsLocal --> RecommendationData : uses_recommendedData
RecommendationData --> RecommendationEngines : has
RecommendationEngines --> RecommendationEngine : cost_and_performance
RecommendationEngine --> RecommendationEngineConfig : has
RecommendationEngineConfig --> EnvParam : env_parameters
CostDetailsRemote ..> EnvParam : formats_env_section
PerfDetailsRemote ..> EnvParam : formats_env_section
CostDetailsLocal ..> EnvParam : formats_env_section
PerfDetailsLocal ..> EnvParam : formats_env_section
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've found 2 issues, and left some high level feedback:
- The
envParams→envSectionformatting logic is duplicated across four components; consider extracting this into a shared utility/helper to avoid repetition and keep formatting consistent. - When interpolating
e.valueinto the YAML-like output, consider escaping or sanitizing values (e.g., embedded quotes or newlines) so that the generated snippet remains valid and copy‑paste‑able.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The `envParams` → `envSection` formatting logic is duplicated across four components; consider extracting this into a shared utility/helper to avoid repetition and keep formatting consistent.
- When interpolating `e.value` into the YAML-like output, consider escaping or sanitizing values (e.g., embedded quotes or newlines) so that the generated snippet remains valid and copy‑paste‑able.
## Individual Comments
### Comment 1
<location> `src/app/Analytics/RemoteMonitoring/RecommendationComponents/CostDetails.tsx:38-40` </location>
<code_context>
- const recommended_code = `${resource_name}:
- requests:
+ // Format env parameters if they exist
+ const envParams = props.recommendedData[0]?.recommendation_engines?.cost?.config?.env;
+ const envSection = envParams?.length > 0
+ ? '\nenv:\n' + envParams.map(e => ` - name: ${e.name}\n value: "${e.value}"`).join('\n')
+ : '';
+
</code_context>
<issue_to_address>
**issue (bug_risk):** Environment values are interpolated without escaping, which can break the rendered YAML when values contain quotes or newlines.
Values containing quotes, newlines, or `#` will produce invalid or misleading YAML in this template. It’d be safer to run each `env` value through a quoting/escaping helper (for example, wrapping in single quotes and escaping internal single quotes, and normalizing/removing newlines) before interpolating into the YAML string.
</issue_to_address>
### Comment 2
<location> `src/app/Analytics/RemoteMonitoring/RecommendationComponents/PerfDetails.tsx:37-39` </location>
<code_context>
- const recommended_code = `${resource_name}:
- requests:
+ // Format env parameters if they exist
+ const envParams = props.recommendedData[0]?.recommendation_engines?.performance?.config?.env;
+ const envSection = envParams?.length > 0
+ ? '\nenv:\n' + envParams.map(e => ` - name: ${e.name}\n value: "${e.value}"`).join('\n')
+ : '';
+
</code_context>
<issue_to_address>
**suggestion:** The env formatting logic is duplicated across multiple components and could be centralized.
Similar `envParams` / `envSection` logic now lives in multiple components (including the local monitoring variants). Consider extracting a shared helper (e.g., `formatEnv(envParams)`) to avoid duplication and ensure YAML formatting stays consistent if the behavior changes later.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
+38
to
+40
| const envParams = props.recommendedData[0]?.recommendation_engines?.cost?.config?.env; | ||
| const envSection = envParams?.length > 0 | ||
| ? '\nenv:\n' + envParams.map(e => ` - name: ${e.name}\n value: "${e.value}"`).join('\n') |
There was a problem hiding this comment.
issue (bug_risk): Environment values are interpolated without escaping, which can break the rendered YAML when values contain quotes or newlines.
Values containing quotes, newlines, or # will produce invalid or misleading YAML in this template. It’d be safer to run each env value through a quoting/escaping helper (for example, wrapping in single quotes and escaping internal single quotes, and normalizing/removing newlines) before interpolating into the YAML string.
Comment on lines
+37
to
+39
| const envParams = props.recommendedData[0]?.recommendation_engines?.performance?.config?.env; | ||
| const envSection = envParams?.length > 0 | ||
| ? '\nenv:\n' + envParams.map(e => ` - name: ${e.name}\n value: "${e.value}"`).join('\n') |
There was a problem hiding this comment.
suggestion: The env formatting logic is duplicated across multiple components and could be centralized.
Similar envParams / envSection logic now lives in multiple components (including the local monitoring variants). Consider extracting a shared helper (e.g., formatEnv(envParams)) to avoid duplication and ensure YAML formatting stays consistent if the behavior changes later.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Adds support for displaying environment variable parameters in recommendation configurations.
Changes:
Summary by Sourcery
Add UI support to surface environment variable parameters in recommendation details for both cost and performance views across local and remote monitoring.
New Features:
Enhancements: