Skip to content
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 35 additions & 16 deletions .github/workflows/ci-client-cyclic-deps-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,51 +55,70 @@ jobs:
id: count-cyclic-deps-in-pr
if: steps.changed-files.outputs.any_changed == 'true'
run: |
dpdm "./src/**/*.{js,jsx,ts,tsx}" --circular --warning=false --tree=false > pr_circular_deps.txt
npx dpdm "./src/**/*.{js,jsx,ts,tsx}" --circular --warning=false --tree=false \
| sed '1d; s/^[[:space:]]*[0-9]\{4\})[[:space:]]*/• /; /^[[:space:]]*$/d' \
| sort | sed '/^[[:space:]]*$/d' > pr_circular_deps.txt
# awk 'NF' pr_circular_deps.txt: Filter out empty lines from the file
# wc -l: Count the number of lines in the file
# awk '{print $1 - 1}': Subtract 1 from the count because the first line is the header 'Circular Dependencies'
pr_count="$(awk 'NF' pr_circular_deps.txt | wc -l | awk '{print $1 - 1}')"
pr_count="$(awk 'NF' pr_circular_deps.txt | wc -l)"
echo "pr_count=$pr_count" >> $GITHUB_OUTPUT
cat pr_circular_deps.txt

- name: Checkout release branch
- name: Checkout base branch
uses: actions/checkout@v4
if: steps.changed-files.outputs.any_changed == 'true'
with:
ref: release
ref: ${{ github.event.pull_request.base.ref }}
clean: false

# Install all the dependencies
- name: Install dependencies
if: steps.changed-files.outputs.any_changed == 'true'
run: |
yarn install --immutable

- name: Count circular dependencies on release branch
id: count-cyclic-deps-in-release
- name: Count circular dependencies on base branch
id: count-cyclic-deps-in-base
if: steps.changed-files.outputs.any_changed == 'true'
run: |
dpdm "./src/**/*.{js,jsx,ts,tsx}" --circular --warning=false --tree=false > release_circular_deps.txt
# awk 'NF' release_circular_deps.txt: Filter out empty lines from the file
npx dpdm "./src/**/*.{js,jsx,ts,tsx}" --circular --warning=false --tree=false \
| sed '1d; s/^[[:space:]]*[0-9]\{4\})[[:space:]]*/• /; /^[[:space:]]*$/d' \
| sort | sed '/^[[:space:]]*$/d' > > base_branch_circular_deps.txt

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Critical: Fix Redirection Operator in Base Branch Dependency Count
There is an extra > in the redirection operator on line 86 (> > base_branch_circular_deps.txt), which will cause a syntax error during execution. Please remove the duplicate redirection symbol. Also, note there is trailing whitespace on line 84 per static analysis.

Diff suggestion:

-          | sort | sed '/^[[:space:]]*$/d' > > base_branch_circular_deps.txt
+          | sort | sed '/^[[:space:]]*$/d' > base_branch_circular_deps.txt
📝 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.

Suggested change
npx dpdm "./src/**/*.{js,jsx,ts,tsx}" --circular --warning=false --tree=false \
| sed '1d; s/^[[:space:]]*[0-9]\{4\})[[:space:]]*/• /; /^[[:space:]]*$/d' \
| sort | sed '/^[[:space:]]*$/d' > > base_branch_circular_deps.txt
npx dpdm "./src/**/*.{js,jsx,ts,tsx}" --circular --warning=false --tree=false \
| sed '1d; s/^[[:space:]]*[0-9]\{4\})[[:space:]]*/• /; /^[[:space:]]*$/d' \
| sort | sed '/^[[:space:]]*$/d' > base_branch_circular_deps.txt
🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 84-84: trailing spaces

(trailing-spaces)

# awk 'NF' base_branch_circular_deps.txt: Filter out empty lines from the file
# wc -l: Count the number of lines in the file
# awk '{print $1 - 1}': Subtract 1 from the count because the first line is the header 'Circular Dependencies'
release_count="$(awk 'NF' release_circular_deps.txt | wc -l | awk '{print $1 - 1}')"
echo "release_count=$release_count" >> $GITHUB_OUTPUT
cat release_circular_deps.txt
base_branch_count="$(awk 'NF' base_branch_circular_deps.txt | wc -l)"
echo "base_branch_count=$base_branch_count" >> $GITHUB_OUTPUT
cat base_branch_circular_deps.txt

- name: Compare circular dependencies
id: compare-deps
if: steps.changed-files.outputs.any_changed == 'true'
run: |
release_count="${{ steps.count-cyclic-deps-in-release.outputs.release_count }}"
base_branch_count="${{ steps.count-cyclic-deps-in-base.outputs.base_branch_count }}"
pr_count="${{ steps.count-cyclic-deps-in-pr.outputs.pr_count }}"
diff="$((pr_count - release_count))"
diff="$((pr_count - base_branch_count))"

if [ "$diff" -gt 0 ]; then
echo "has_more_cyclic_deps=true" >> "$GITHUB_OUTPUT"
echo "diff=$diff" >> "$GITHUB_OUTPUT"
fi

- name: Log circular dependencies
id: log-compare-deps
if: steps.compare-deps.outputs.has_more_cyclic_deps == 'true' && steps.changed-files.outputs.any_changed == 'true'
run: |
sed -i '' '10,14d' pr_circular_deps.txt
sed -i '' '20,29d' base_branch_circular_deps.txt
diff_output=$(diff -u base_branch_circular_deps.txt pr_circular_deps.txt)
{
echo "Dependencies removed:"
echo "$diff_output" | grep -E '^-[^-]'
echo ""
echo "Dependencies added:"
echo "$diff_output" | grep -E '^\+[^+]'
} > diff.txt

cat diff.txt
# Comment on the PR if cyclic dependencies are found
- name: Comment the result on PR
if: steps.compare-deps.outputs.has_more_cyclic_deps == 'true' && steps.changed-files.outputs.any_changed == 'true'
Expand All @@ -108,7 +127,7 @@ jobs:
github-token: ${{secrets.GITHUB_TOKEN}}
script: |
const prNumber = context.payload.pull_request.number;
const message = `🔴🔴🔴 Cyclic Dependency Check:\n\nThis PR has increased the number of cyclic dependencies by ${{steps.compare-deps.outputs.diff}}, when compared with the release branch.\n\nRefer [this document](https://appsmith.notion.site/How-to-check-cyclic-dependencies-c47b08fe5f2f4261a3a234b19e13f2db) to identify the cyclic dependencies introduced by this PR.`;
const message = `🔴🔴🔴 Cyclic Dependency Check:\n\nThis PR has increased the number of cyclic dependencies by ${{steps.compare-deps.outputs.diff}}, when compared with the ${{github.event.pull_request.base.ref}} branch.\n\nRefer [this document](https://appsmith.notion.site/How-to-check-cyclic-dependencies-c47b08fe5f2f4261a3a234b19e13f2db) to identify the cyclic dependencies introduced by this PR.`;

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dvj1988 Can we also list the new added cyclic dependencies? Maybe not in the message, but at least in the log.

github.issues.createComment({
...context.repo,
issue_number: prNumber,
Expand Down
1 change: 1 addition & 0 deletions app/client/src/instrumentation/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import { isTracingEnabled } from "instrumentation/utils";
const { appVersion, observability } = getAppsmithConfigs();
const { deploymentName, serviceInstanceId, serviceName, tracingUrl } =
observability;
//

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe it should be deleted.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@KelvinOm you are right. Missed this.

Comment thread
dvj1988 marked this conversation as resolved.
Outdated

let faro: Faro | null = null;

Expand Down