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: re-enable ci tests #156

Merged
merged 1 commit into from
Nov 12, 2024
Merged

fix: re-enable ci tests #156

merged 1 commit into from
Nov 12, 2024

Conversation

thomasdavis
Copy link
Member

@thomasdavis thomasdavis commented Nov 12, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a new dev-script job in the CI workflow for improved development server testing.
  • Bug Fixes

    • Enhanced the Button component by centralizing default prop definitions for better clarity and maintainability.
  • Chores

    • Cleaned up the CI workflow configuration by removing outdated commented sections.

Copy link

changeset-bot bot commented Nov 12, 2024

⚠️ No Changeset found

Latest commit: 8ef5f88

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Nov 12, 2024

Walkthrough

The changes involve updates to the CI workflow configuration and modifications to the Button component in the codebase. A new job named dev-script has been added to the CI configuration, which sets up a Node.js environment and runs a server for testing. The existing test job has been updated to include Playwright tests and artifact uploads. In the Button component, default prop values have been centralized in Button.defaultProps, enhancing clarity without altering the component's functionality.

Changes

File Path Change Summary
.github/workflows/ci.yml Added dev-script job for testing; updated test job for Playwright tests; removed commented-out sections.
apps/registry/app/components/Button/Button.js Removed default values from function parameters; centralized default props in Button.defaultProps.

Poem

In the garden of code, where changes bloom,
A new job hops in, dispelling the gloom.
The Button now knows its size and its hue,
With defaults set right, it’s shiny and new!
So let’s dance with the scripts, let the tests play,
For every small change brings a brighter day! 🐇✨

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.

apps/registry/app/components/Button/Button.js

Oops! Something went wrong! :(

ESLint: 8.57.1

TypeError: Failed to load plugin 'turbo' declared in 'apps/registry/.eslintrc.js » @repo/eslint-config-custom » eslint-config-turbo': Cannot convert undefined or null to object
Referenced from: /node_modules/.pnpm/[email protected][email protected]/node_modules/eslint-config-turbo/index.js
at Function.entries ()
at Ii.generateKey (/node_modules/.pnpm/[email protected][email protected]/node_modules/eslint-plugin-turbo/dist/index.js:74:6559)
at new Ii (/node_modules/.pnpm/[email protected][email protected]/node_modules/eslint-plugin-turbo/dist/index.js:74:6200)
at Object. (/node_modules/.pnpm/[email protected][email protected]/node_modules/eslint-plugin-turbo/dist/index.js:74:10209)
at Module._compile (node:internal/modules/cjs/loader:1546:14)
at Module._extensions..js (node:internal/modules/cjs/loader:1691:10)
at Module.load (node:internal/modules/cjs/loader:1317:32)
at Module._load (node:internal/modules/cjs/loader:1127:12)
at TracingChannel.traceSync (node:diagnostics_channel:315:14)
at wrapModuleLoad (node:internal/modules/cjs/loader:217:24)


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

vercel bot commented Nov 12, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
jsonresume-org-homepage2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 12, 2024 11:55am
jsonresume-org-registry ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 12, 2024 11:55am

Copy link

🤖 No test run has been triggered as your Meticulous project has been deactivated (since you haven't viewed any test results in a while). Click here to reactivate.

Last updated for commit 8ef5f88. This comment will update as new commits are pushed.

@thomasdavis
Copy link
Member Author

thomasdavis commented Nov 12, 2024

@levino I just reverted the commit where I disabled the tests and it works. If you approve this I can merge it back in.

I disabled it, because one night it was just catastrophically failing, and I spent 6 hours before rage commenting it out. (old commits, latest of master, or branches)

It must of been a problem with the github CI

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: 4

🧹 Outside diff range and nitpick comments (1)
apps/registry/app/components/Button/Button.js (1)

113-117: Consider migrating to TypeScript for better type safety.

The defaultProps implementation is correct, but the component could benefit from TypeScript's type system to catch prop-related issues earlier in development.

Example TypeScript implementation:

interface ButtonProps {
  size?: 'small' | 'medium' | 'large';
  color?: 'default' | 'success' | 'danger';
  href?: string | null;
  children: React.ReactNode;
  disabled?: boolean;
}

const Button: React.FC<ButtonProps> = ({
  size = 'medium',
  color = 'default',
  href = null,
  children,
  disabled,
  ...props
}) => {
  // ... existing implementation
};
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c37baa1 and 8ef5f88.

📒 Files selected for processing (2)
  • .github/workflows/ci.yml (2 hunks)
  • apps/registry/app/components/Button/Button.js (2 hunks)
🔇 Additional comments (2)
apps/registry/app/components/Button/Button.js (2)

Line range hint 83-117: Verify that this change resolves the CI test failures.

Since this PR aims to fix CI tests, let's ensure this component change addresses specific test issues.

#!/bin/bash
# Description: Check for recent test failures related to Button default props

# Look for CI logs or test reports
fd -e log -e xml -e json . .github/

# Search for Button-related test failures in recent commits
git log -p --grep="test.*fail.*button" --grep="button.*test.*fail" -i

83-83: LGTM! Moving defaults to defaultProps improves maintainability.

The change follows React's best practices by centralizing default values in defaultProps instead of parameter destructuring.

Let's verify the component's test coverage:

Comment on lines +81 to +82
- name: Run Playwright tests
run: pnpm turbo test:e2e --concurrency 1000 # The high concurrency is due to a bug: https://github.com/vercel/turbo/issues/4291
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add timeout and consider concurrency settings

The Playwright test step should have a timeout, and the high concurrency setting might cause stability issues.

Add timeout and adjust concurrency:

      - name: Run Playwright tests
-       run: pnpm turbo test:e2e --concurrency 1000 # The high concurrency is due to a bug: https://github.com/vercel/turbo/issues/4291
+       run: pnpm turbo test:e2e --concurrency 100 # Lower concurrency for stability
+       timeout-minutes: 30
📝 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
- name: Run Playwright tests
run: pnpm turbo test:e2e --concurrency 1000 # The high concurrency is due to a bug: https://github.com/vercel/turbo/issues/4291
- name: Run Playwright tests
run: pnpm turbo test:e2e --concurrency 100 # Lower concurrency for stability
timeout-minutes: 30

Comment on lines +67 to +76
- uses: actions/setup-node@v3
with:
node-version: 20
- uses: pnpm/action-setup@v2
with:
version: 8
- uses: actions/setup-node@v3
with:
node-version: 20
cache: pnpm
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Remove duplicate Node.js setup

There are two identical Node.js setup steps which is redundant.

Remove the duplicate setup:

      - uses: actions/checkout@v3
-     - uses: actions/setup-node@v3
-       with:
-         node-version: 20
      - uses: pnpm/action-setup@v2
        with:
          version: 8
      - uses: actions/setup-node@v3
        with:
          node-version: 20
          cache: pnpm
📝 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
- uses: actions/setup-node@v3
with:
node-version: 20
- uses: pnpm/action-setup@v2
with:
version: 8
- uses: actions/setup-node@v3
with:
node-version: 20
cache: pnpm
- uses: actions/setup-node@v3
with:
node-version: 20
- uses: pnpm/action-setup@v2
with:
version: 8
- uses: actions/setup-node@v3
with:
node-version: 20
cache: pnpm

Comment on lines +32 to +47
dev-script:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 2
- uses: pnpm/action-setup@v2
with:
version: 8
- uses: actions/setup-node@v3
with:
node-version: 20
cache: 'pnpm'
- run: pnpm install
- run: pnpm start-server-and-test 'turbo dev --filter=registry' 3000 'exit 0;'
working-directory: apps/registry
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Review the dev-script job implementation

The dev-script job has several potential issues:

  1. Using exit 0 forces a success status without actual validation
  2. The server startup validation could be more robust
  3. The hardcoded working directory might make the workflow less maintainable

Consider this improved implementation:

  dev-script:
    runs-on: ubuntu-latest
+   defaults:
+     run:
+       working-directory: apps/registry
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 2
      - uses: pnpm/action-setup@v2
        with:
          version: 8
      - uses: actions/setup-node@v3
        with:
          node-version: 20
          cache: 'pnpm'
+         cache-dependency-path: '**/pnpm-lock.yaml'
      - run: pnpm install
-     - run: pnpm start-server-and-test 'turbo dev --filter=registry' 3000 'exit 0;'
-       working-directory: apps/registry
+     - run: pnpm start-server-and-test 'turbo dev --filter=registry' 3000 'curl -f http://localhost:3000'
📝 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
dev-script:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 2
- uses: pnpm/action-setup@v2
with:
version: 8
- uses: actions/setup-node@v3
with:
node-version: 20
cache: 'pnpm'
- run: pnpm install
- run: pnpm start-server-and-test 'turbo dev --filter=registry' 3000 'exit 0;'
working-directory: apps/registry
dev-script:
runs-on: ubuntu-latest
defaults:
run:
working-directory: apps/registry
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 2
- uses: pnpm/action-setup@v2
with:
version: 8
- uses: actions/setup-node@v3
with:
node-version: 20
cache: 'pnpm'
cache-dependency-path: '**/pnpm-lock.yaml'
- run: pnpm install
- run: pnpm start-server-and-test 'turbo dev --filter=registry' 3000 'curl -f http://localhost:3000'

Comment on lines +83 to +88
- uses: actions/upload-artifact@v3
if: always()
with:
name: playwright-report
path: playwright-report/
retention-days: 30
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Artifact path configuration mismatch

The artifact upload path playwright-report/ does not match the actual test output location apps/registry/playwright-report/.

  • Update the path to apps/registry/playwright-report/
🔗 Analysis chain

Verify the artifact path configuration

The artifact upload step uses a hardcoded path that might not match the actual test output location.

Let's verify the Playwright report path:

Consider making the path more specific:

      - uses: actions/upload-artifact@v3
        if: always()
        with:
          name: playwright-report
-         path: playwright-report/
+         path: apps/registry/playwright-report/
          retention-days: 30
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for Playwright configuration files to verify the correct report path
rg -l "reporter.*html" . --type yaml --type javascript

Length of output: 91


Script:

#!/bin/bash
# Check for Playwright configuration files to verify the correct report path
rg -l "reporter.*html" . --type yaml --type js

Length of output: 85

@levino levino merged commit 4e985c6 into master Nov 12, 2024
7 checks passed
@levino levino deleted the enable-tests branch November 12, 2024 12:04
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.

2 participants