Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Clean orphan charts before generating #17584

Merged
merged 2 commits into from
Jan 22, 2025
Merged

Conversation

peturgq
Copy link
Member

@peturgq peturgq commented Jan 21, 2025

...

Attach a link to issue if relevant

What

Specify what you're trying to achieve

Why

Specify why you need to achieve this

Screenshots / Gifs

Attach Screenshots / Gifs to help reviewers understand the scope of the pull request

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • New Features

    • Added directory cleanup functionality before generating chart values.
    • Improved path management for chart-related operations.
  • Chores

    • Enhanced error handling for directory removal process.

The changes optimize the chart generation workflow by automatically cleaning up orphan directories and centralizing path definitions.

@peturgq peturgq requested a review from a team as a code owner January 21, 2025 11:11
Copy link
Contributor

coderabbitai bot commented Jan 21, 2025

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

warning [email protected]: This version is no longer supported. Please see https://eslint.org/version-support for other options.
warning eslint > @humanwhocodes/[email protected]: Use @eslint/config-array instead
warning eslint > @humanwhocodes/config-array > @humanwhocodes/[email protected]: Use @eslint/object-schema instead
warning eslint > file-entry-cache > flat-cache > [email protected]: Rimraf versions prior to v4 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > [email protected]: Glob versions prior to v9 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > glob > [email protected]: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
warning jest > @jest/core > jest-runtime > [email protected]: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > jest-config > [email protected]: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > @jest/reporters > [email protected]: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > @jest/transform > babel-plugin-istanbul > test-exclude > [email protected]: Glob versions prior to v9 are no longer supported
warning storybook > @storybook/cli > puppeteer-core > [email protected]: Rimraf versions prior to v4 are no longer supported
warning storybook > @storybook/cli > puppeteer-core > rimraf > [email protected]: Glob versions prior to v9 are no longer supported
warning storybook > @storybook/cli > tempy > del > [email protected]: Rimraf versions prior to v4 are no longer supported
warning storybook > @storybook/cli > jscodeshift > temp > [email protected]: Rimraf versions prior to v4 are no longer supported
warning storybook > @storybook/cli > jscodeshift > temp > rimraf > [email protected]: Glob versions prior to v9 are no longer supported
warning storybook > @storybook/cli > jscodeshift > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-class-properties instead.
warning storybook > @storybook/cli > jscodeshift > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-optional-chaining instead.
warning storybook > @storybook/cli > jscodeshift > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-nullish-coalescing-operator instead.
warning react-native > @react-native/codegen > [email protected]: Glob versions prior to v9 are no longer supported
warning react-native > @react-native/community-cli-plugin > [email protected]: The querystring API is considered Legacy. new code should use the URLSearchParams API instead.
warning react-native > @react-native-community/cli > @react-native-community/cli-tools > [email protected]: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.
warning react-native > @react-native/community-cli-plugin > @react-native/dev-middleware > @rnx-kit/chromium-edge-launcher > [email protected]: Rimraf versions prior to v4 are no longer supported
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-class-properties instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-optional-chaining instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-nullish-coalescing-operator instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-object-rest-spread instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-numeric-separator instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-optional-catch-binding instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-logical-assignment-operators instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-async-generator-functions instead.
warning next-auth > [email protected]: The querystring API is considered Legacy. new code should use the URLSearchParams API instead.
warning next-auth > [email protected]: this version is no longer supported
warning next-auth > @next-auth/typeorm-legacy-adapter > typeorm > [email protected]: Glob versions prior to v9 are no longer supported
warning @nx/next > @nx/webpack > stylus > [email protected]: Glob versions prior to v9 are no longer supported
warning @nx/next > @nx/webpack > webpack-dev-server > [email protected]: Rimraf versions prior to v4 are no longer supported
warning @nx/next > @nx/webpack > fork-ts-checker-webpack-plugin > [email protected]: this will be v4
warning @nx/next > @nx/webpack > webpack-dev-server > webpack-dev-middleware > [email protected]: this will be v4
warning workspace-aggregator-17f201e3-9728-4364-ac43-28cd515dfc90 > [email protected]: This version is no longer supported. Please see https://eslint.org/version-support for other options.

Walkthrough

The pull request modifies the generate-chart-values.ts file in the infrastructure CLI, introducing a new function cleanOrphanDirs for removing directories and updating the generateChartValues function. The changes focus on improving directory cleanup and path management by adding a recursive directory removal mechanism with error handling and centralizing the chart directory path definition.

Changes

File Change Summary
infra/src/cli/generate-chart-values.ts - Added cleanOrphanDirs function for recursive directory removal
- Introduced relativeChartDir constant for centralized path management
- Modified generateChartValues to call cleanOrphanDirs before chart generation

Possibly related PRs

Suggested labels

automerge

Suggested reviewers

  • busla
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
infra/src/cli/generate-chart-values.ts (3)

24-24: Consider making the chart directory path more robust.

While the relative path works, consider:

  1. Using path.resolve to get an absolute path
  2. Adding validation to ensure the directory exists before operations
-const relativeChartDir = '../../../charts'
+const chartDir = path.resolve(__dirname, '../../../charts')
+if (!fs.existsSync(chartDir)) {
+  throw new Error(`Charts directory not found: ${chartDir}`)
+}

25-34: Enhance error handling and add success logging.

The error handling could be more specific and include success logging:

 const cleanOrphanDirs = (filePath: string): void => {
   try {
+    if (!fs.existsSync(filePath)) {
+      console.log(`No orphan charts to clean at ${filePath}`)
+      return
+    }
     rmSync(filePath, { recursive: true });
+    console.log(`Successfully cleaned orphan charts at ${filePath}`)
   }
   catch (error) {
-    if (error instanceof Error) {
-      console.error(`Failed to clean orphan directories at ${filePath}: ${error.message}`);
-    }
+    if (error instanceof Error && error.code === 'ENOENT') {
+      console.log(`Directory ${filePath} does not exist`)
+      return
+    }
+    console.error(`Failed to clean orphan directories at ${filePath}:`, 
+      error instanceof Error ? error.message : 'Unknown error');
   }
 }

60-60: Maintain consistency in path construction.

There's an inconsistency in path construction methods:

  • Line 60 uses path.join
  • Line 82 uses string interpolation
-              `${relativeChartDir}/${name}-services`,
+              path.join(relativeChartDir, `${name}-services`),

Also applies to: 82-82

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5f81d55 and 49c5060.

📒 Files selected for processing (1)
  • infra/src/cli/generate-chart-values.ts (5 hunks)
🔇 Additional comments (3)
infra/src/cli/generate-chart-values.ts (3)

3-3: LGTM! Appropriate use of rmSync for directory removal.

The addition of rmSync to the existing fs imports is well-placed and suitable for recursive directory cleanup.


45-46: LGTM! Well-placed cleanup step.

The cleanup step is appropriately placed at the beginning of the chart generation process, with clear logging.


45-46: Verify the impact of chart cleanup.

Let's ensure the cleanup doesn't affect active charts.

✅ Verification successful

Chart cleanup implementation is safe

The cleanup operation only affects the generated charts in the charts/ directory and does not impact the actual Helm charts stored in infra/helm/. The directory is properly recreated with fresh content after cleanup.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for potential active charts that might be affected
fd -t d . charts/ -x sh -c '
  if [ -f "$0/Chart.yaml" ]; then
    echo "Active chart found: $0"
    cat "$0/Chart.yaml" | grep -E "name:|version:"
  fi
'

Length of output: 156


Script:

#!/bin/bash
# Find the actual chart directory structure
fd -t d "chart" .

# Check the cleanOrphanDirs implementation
ast-grep --pattern 'function cleanOrphanDirs($_) {
  $$$
}'

# Look for Chart.yaml files anywhere in the repo
fd "Chart.yaml"

Length of output: 815


Script:

#!/bin/bash
# Find the cleanOrphanDirs implementation
rg "cleanOrphanDirs" -A 5

# Check the relative path configuration
rg "relativeChartDir" -A 2

Length of output: 1997

@datadog-island-is
Copy link

datadog-island-is bot commented Jan 21, 2025

Datadog Report

All test runs 485c172 🔗

10 Total Test Services: 0 Failed, 10 Passed
🔻 Test Sessions change in coverage: 2 decreased, 1 increased (+0.03%), 197 no change

Test Services
This report shows up to 10 services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
air-discount-scheme-backend 0 0 0 63 0 22.73s N/A Link
air-discount-scheme-web 0 0 0 2 0 6.59s N/A Link
api 0 0 0 4 0 2.45s N/A Link
api-catalogue-services 0 0 0 23 0 8.97s N/A Link
api-domains-air-discount-scheme 0 0 0 6 0 16.19s N/A Link
api-domains-assets 0 0 0 3 0 9.48s 1 no change Link
api-domains-auth-admin 0 0 0 18 0 10.23s 1 no change Link
api-domains-communications 0 0 0 5 0 35.81s N/A Link
api-domains-criminal-record 0 0 0 5 0 10.26s 1 no change Link
api-domains-driving-license 0 0 0 23 0 27.17s N/A Link

🔻 Code Coverage Decreases vs Default Branch (2)

  • clients-middlewares - jest 75.38% (-0.29%) - Details
  • application-templates-parental-leave - jest 34.97% (-0.09%) - Details

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
infra/src/cli/generate-chart-values.ts (2)

24-24: Consider using path.join for cross-platform compatibility

The relative path string might be brittle across different platforms. Consider using path.join() to construct the path.

-const relativeChartDir = '../../../charts'
+const relativeChartDir = path.join('..', '..', '..', 'charts')

83-83: Use consistent path joining method

String interpolation is used for path construction instead of path.join() as used elsewhere in the code.

-              `${relativeChartDir}/${name}-services`,
+              path.join(relativeChartDir, `${name}-services`),
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 49c5060 and ab6bc3f.

📒 Files selected for processing (1)
  • infra/src/cli/generate-chart-values.ts (5 hunks)
🔇 Additional comments (2)
infra/src/cli/generate-chart-values.ts (2)

3-3: LGTM: Import statement correctly updated

The addition of rmSync to the fs import is appropriate for the new cleanup functionality.


46-47: Verify cleanup success before proceeding

The cleanup process should be validated before continuing with chart generation.

Consider adding a try-catch block around the cleanup and chart generation:

-  console.log('Cleaning orphan charts')
-  cleanOrphanDirs(path.join(__dirname, relativeChartDir))
-  console.log('Gathering charts')
+  try {
+    console.log('Cleaning orphan charts')
+    cleanOrphanDirs(path.join(__dirname, relativeChartDir))
+    console.log('Gathering charts')
+  } catch (error) {
+    console.error('Failed to clean orphan charts, aborting generation')
+    throw error
+  }

infra/src/cli/generate-chart-values.ts Show resolved Hide resolved
Copy link

codecov bot commented Jan 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 35.57%. Comparing base (33c3794) to head (ab6bc3f).
Report is 20 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #17584      +/-   ##
==========================================
- Coverage   35.57%   35.57%   -0.01%     
==========================================
  Files        7027     7027              
  Lines      150434   150434              
  Branches    42943    42943              
==========================================
- Hits        53522    53519       -3     
- Misses      96912    96915       +3     
Flag Coverage Δ
judicial-system-backend 55.84% <ø> (ø)
services-auth-admin-api 52.51% <ø> (ø)
services-auth-ids-api 52.53% <ø> (-0.03%) ⬇️
services-auth-public-api 49.40% <ø> (ø)
services-university-gateway 49.58% <ø> (ø)
services-user-notification 46.56% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 33c3794...ab6bc3f. Read the comment docs.

@peturgq peturgq enabled auto-merge January 22, 2025 11:39
Copy link
Member

@brynjarorng brynjarorng left a comment

Choose a reason for hiding this comment

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

LGTM

@peturgq peturgq added this pull request to the merge queue Jan 22, 2025
Merged via the queue into main with commit 7a7e894 Jan 22, 2025
271 checks passed
@peturgq peturgq deleted the clean-orphan-charts branch January 22, 2025 13:49
thoreyjona pushed a commit that referenced this pull request Jan 22, 2025
* chore: Clean orphan charts before generating

* chore: nx format:write update dirty files

---------

Co-authored-by: andes-it <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants