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

fix: file not found issue fixed for build tools and newsroom video script #3422

Merged
merged 2 commits into from
Nov 22, 2024

Conversation

vishvamsinh28
Copy link
Contributor

@vishvamsinh28 vishvamsinh28 commented Nov 22, 2024

This PR fixes the file not found issue for tests of build-tools and newsroom video script

Summary by CodeRabbit

  • Tests
    • Enhanced test setup by adding file creation for necessary JSON files, ensuring they exist before tests run.
    • Maintained error handling tests to cover various failure scenarios related to file access and data retrieval.

Copy link

coderabbitai bot commented Nov 22, 2024

Walkthrough

The changes in this pull request involve enhancements to the test setups for two test files: build-newsroom-videos.test.js and build-tools.test.js. The modifications include adding file creation steps using outputFileSync from the fs-extra module to ensure that specific JSON files are present before the tests are executed. This adjustment aims to prevent errors related to missing files and maintains the integrity of the test cases, which continue to cover various error scenarios.

Changes

File Path Change Summary
tests/build-newsroom-videos.test.js Added outputFileSync import and created an empty JSON file at testFilePath in beforeAll.
tests/build-tools.test.js Added file output operations to initialize automatedToolsPath, toolsPath, and tagsPath as empty JSON files in beforeAll.

Possibly related PRs

  • fix: file write errors for tools and newsroom video #3297: The changes in this PR involve updating file handling in the build-tools.js and its tests to use fs-extra, similar to the main PR's introduction of outputFileSync from fs-extra in the test setup for build-newsroom-videos.test.js. Both PRs enhance file handling capabilities and ensure necessary files are created before tests run.

Suggested labels

ready-to-merge, autoupdate

Suggested reviewers

  • derberg
  • akshatnema
  • magicmatatjahu
  • sambhavgupta0705
  • Mayaleeeee
  • asyncapi-bot-eve
  • anshgoyalevil
  • devilkiller-ag

🐇 In the land of tests, we now create,
JSON files to ensure no fate of late.
With fs-extra by our side,
Errors we’ll swiftly abide.
Each test now runs with glee,
Thanks to files, as they should be! 🌟


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 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.

CodeRabbit Configuration 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.

Copy link

netlify bot commented Nov 22, 2024

Deploy Preview for asyncapi-website ready!

Name Link
🔨 Latest commit b0c7afc
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/6740c93a064ed9000863d69d
😎 Deploy Preview https://deploy-preview-3422--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Nov 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.77%. Comparing base (4c5f284) to head (b0c7afc).
Report is 34 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3422   +/-   ##
=======================================
  Coverage   67.77%   67.77%           
=======================================
  Files          21       21           
  Lines         664      664           
=======================================
  Hits          450      450           
  Misses        214      214           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Nov 22, 2024

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 33
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

Lighthouse ran on https://deploy-preview-3422--asyncapi-website.netlify.app/

Copy link

@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

🧹 Outside diff range and nitpick comments (3)
tests/build-newsroom-videos.test.js (1)

16-16: Fix indentation to match project style.

There's an indentation issue flagged by ESLint.

Apply this fix:

-        outputFileSync(testFilePath, JSON.stringify({}));
+    outputFileSync(testFilePath, JSON.stringify({}));
🧰 Tools
🪛 eslint (1.23.1)

[error] 16-16: Delete ····

(prettier/prettier)

tests/build-tools.test.js (2)

40-42: Fix indentation for consistency.

The implementation effectively solves the file-not-found issue. However, there are some formatting inconsistencies.

Apply this diff to fix the indentation:

-        fs.outputFileSync(automatedToolsPath, JSON.stringify({}));
-fs.outputFileSync(toolsPath, JSON.stringify({}));
-        fs.outputFileSync(tagsPath, JSON.stringify({}));
+        fs.outputFileSync(automatedToolsPath, JSON.stringify({}));
+        fs.outputFileSync(toolsPath, JSON.stringify({}));
+        fs.outputFileSync(tagsPath, JSON.stringify({}));
🧰 Tools
🪛 eslint (1.23.1)

[error] 40-40: Replace ········ with ····

(prettier/prettier)


[error] 41-41: Delete ····

(prettier/prettier)


[error] 42-42: Replace ········ with ····

(prettier/prettier)


40-42: Consider enhancing the file initialization robustness.

While the current implementation works, we could make it more robust and maintainable.

Consider these improvements:

+        const emptyJson = JSON.stringify({});
+        try {
+            await Promise.all([
+                fs.outputFileSync(automatedToolsPath, emptyJson),
+                fs.outputFileSync(toolsPath, emptyJson),
+                fs.outputFileSync(tagsPath, emptyJson)
+            ]);
+        } catch (error) {
+            console.error('Failed to initialize test files:', error);
+            throw error;
+        }
-        fs.outputFileSync(automatedToolsPath, JSON.stringify({}));
-        fs.outputFileSync(toolsPath, JSON.stringify({}));
-        fs.outputFileSync(tagsPath, JSON.stringify({}));

Benefits:

  1. Reuses the empty JSON string
  2. Adds error handling for initialization failures
  3. Parallel file writing for better performance
🧰 Tools
🪛 eslint (1.23.1)

[error] 40-40: Replace ········ with ····

(prettier/prettier)


[error] 41-41: Delete ····

(prettier/prettier)


[error] 42-42: Replace ········ with ····

(prettier/prettier)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1be4431 and 8bce4e0.

📒 Files selected for processing (2)
  • tests/build-newsroom-videos.test.js (2 hunks)
  • tests/build-tools.test.js (1 hunks)
🧰 Additional context used
🪛 eslint (1.23.1)
tests/build-newsroom-videos.test.js

[error] 16-16: Delete ····

(prettier/prettier)

tests/build-tools.test.js

[error] 40-40: Replace ········ with ····

(prettier/prettier)


[error] 41-41: Delete ····

(prettier/prettier)


[error] 42-42: Replace ········ with ····

(prettier/prettier)

🔇 Additional comments (2)
tests/build-newsroom-videos.test.js (2)

1-1: LGTM! The file initialization fix looks good.

The addition of outputFileSync and its usage to create an empty JSON file before tests is a good solution to prevent the "file not found" issue. This ensures that the base file exists while still maintaining all error test cases.

Also applies to: 16-16


Line range hint 28-77: Verify test coverage remains comprehensive.

The test suite maintains good coverage with tests for:

  • Successful video data fetching and file writing
  • Fetch errors
  • Invalid API responses
  • HTTP error status codes
  • File write errors

The addition of file initialization doesn't affect these test cases as they continue to test their respective scenarios effectively.

Let's verify the test coverage:

✅ Verification successful

Test coverage is comprehensive and consistent with codebase patterns

The test suite for buildNewsroomVideos follows the established error handling patterns seen across the codebase:

  • All file operation errors (ENOENT/EACCES) are consistently handled
  • The function is only used within its dedicated test file
  • Error handling patterns match other similar build scripts (build-tools, build-meetings, build-rss)
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if there are any other test files that might need similar file initialization

# Look for similar test patterns that might need the same fix
rg -l "ENOENT|file not found" "tests/"

# Check for other test files using the same buildNewsroomVideos function
rg -l "buildNewsroomVideos" "tests/"

Length of output: 284


Script:

#!/bin/bash
# Let's check the error handling patterns in these test files to ensure consistency
rg -A 5 "ENOENT|file not found" "tests/"

# Also check if buildNewsroomVideos is imported or referenced in other files
rg "buildNewsroomVideos" "tests/"

Length of output: 2861

@akshatnema
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit 1c45062 into asyncapi:master Nov 22, 2024
19 checks passed
@anshgoyalevil anshgoyalevil added the gsoc This label should be used for issues or discussions related to ideas for Google Summer of Code label Dec 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
gsoc This label should be used for issues or discussions related to ideas for Google Summer of Code ready-to-merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants