appsmith icon indicating copy to clipboard operation
appsmith copied to clipboard

Published 20 hours ago • verified publisher icon appsmithorg

chore: Update incorrect docker tagging and add fargate tag in deployment telemetry

Open trishaanand opened this issue 9 months ago • 4 comments

Description

[!TIP]
Add a TL;DR when the description is longer than 500 words or extremely technical (helps the content, marketing, and DevRel team).

Please also include relevant motivation and context. List any dependencies that are required for this change. Add links to Notion, Figma or any other documents that might be relevant to the PR.

Fixes #Issue Number
or
Fixes Issue URL

[!WARNING]
If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags=""

:mag: Cypress test results

[!CAUTION]
If you modify the content in this section, you are likely to disrupt the CI result for your PR.

Communication

Should the DevRel and Marketing teams inform users about this change?

  • [ ] Yes
  • [ ] No

trishaanand avatar May 15 '24 08:05 trishaanand

Walkthrough

Walkthrough

The recent changes to the generate-infra-details.sh script update default values for the cloud_provider and dep_tool variables, and introduce a new function check_for_fargate. These modifications aim to enhance the script's flexibility and capability to determine if the deployment environment is AWS Fargate based on specific conditions.

Changes

File Path Change Summary
deploy/docker/fs/opt/appsmith/generate-infra-details.sh - Default cloud_provider to "others(including local)" instead of "local".
- Default dep_tool to "likely docker" instead of "docker".
- Added check_for_fargate function to detect Fargate deployments.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant Script

    User->>Script: Run generate-infra-details.sh
    Script->>Script: Set default cloud_provider to "others(including local)"
    Script->>Script: Set default dep_tool to "likely docker"
    Script->>Script: Call check_for_fargate()
    Script->>Script: Determine if Fargate deployment
    Script-->>User: Output deployment details
Recent Review Details

Configuration used: CodeRabbit UI Review profile: CHILL

Commits Files that changed from the base of the PR and between 4c28d83e61d94b3cc5fc776292f3bf25e805661c and 353a05457d33a69109140b763d495b7e6852129d.
Files selected for processing (1)
  • deploy/docker/fs/opt/appsmith/generate-infra-details.sh (2 hunks)
Additional Context Used
ShellCheck (5)
deploy/docker/fs/opt/appsmith/generate-infra-details.sh (5)

[info] 43-43: Note that A && B || C is not if-then-else. C may run when A is true.

[warning] 75-75: Quotes/backslashes will be treated literally. Use an array.

[warning] 78-78: Quotes/backslashes in this variable will not be respected.

[info] 78-78: Double quote to prevent globbing and word splitting.

[info] 78-78: Double quote to prevent globbing and word splitting.

Additional comments not posted (3)
deploy/docker/fs/opt/appsmith/generate-infra-details.sh (3)

35-35: Ensure consistency in the default value of dep_tool.

The change to the default value of dep_tool to "likely docker" is consistent with the PR's objectives to update Docker tagging.

60-65: Review the logic for determining if it's an ECS Fargate deployment.

-  if [[ $cloud_provider == "amazon" && $dep_tool == "likely docker" && $efs == "present" ]]; then
+  if [[ $cloud_provider == "amazon" && $dep_tool == "likely docker" && $efs == "present" ]]; then
    dep_tool="ecs-fargate"
-  fi
+  fi

The logical expression A && B || C is not equivalent to if-then-else. C may run when A is true. Ensure the logic correctly reflects the intended conditions for setting dep_tool to "ecs-fargate".

Likely invalid or redundant comment.

72-72: Verify the call to check_for_fargate in the main block.

Ensure that the function check_for_fargate is called correctly and only once in the main block to maintain the intended flow of the script.

Verification successful

The function check_for_fargate is correctly called once in the main block of the script.

  • Location: deploy/docker/fs/opt/appsmith/generate-infra-details.sh
Scripts Executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the function `check_for_fargate` is called correctly and only once in the main block.

# Test: Search for the function call. Expect: Only one occurrence in the main block.
rg --type bash $'check_for_fargate'

Length of output: 63

Script:

#!/bin/bash
# Description: Verify that the function `check_for_fargate` is called correctly and only once in the main block.

# Test: Search for the function call. Expect: Only one occurrence in the main block.
rg --type sh $'check_for_fargate'

Length of output: 193

Script:

#!/bin/bash
# Description: Verify the context of the `check_for_fargate` function call to ensure it is in the main block.

# Extract 5 lines before and after the function call to check its context.
rg --type sh -C 5 $'check_for_fargate' deploy/docker/fs/opt/appsmith/generate-infra-details.sh

Length of output: 648

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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as 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 full the 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 help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar May 15 '24 08:05 coderabbitai[bot]

/build-deploy-preview skip-tests=true

trishaanand avatar May 15 '24 13:05 trishaanand

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9096240170. Workflow: On demand build Docker image and deploy preview. skip-tests: true. env: ``. PR: 33472. recreate: .

github-actions[bot] avatar May 15 '24 13:05 github-actions[bot]

Deploy-Preview-URL: https://ce-33472.dp.appsmith.com

github-actions[bot] avatar May 15 '24 13:05 github-actions[bot]

/build-deploy-preview skip-tests=true

trishaanand avatar May 23 '24 10:05 trishaanand

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9206524337. Workflow: On demand build Docker image and deploy preview. skip-tests: true. env: ``. PR: 33472. recreate: .

github-actions[bot] avatar May 23 '24 10:05 github-actions[bot]

Deploy-Preview-URL: https://ce-33472.dp.appsmith.com

github-actions[bot] avatar May 23 '24 10:05 github-actions[bot]