frontend icon indicating copy to clipboard operation
frontend copied to clipboard

Add Community Solutions Analysis and Code Examples Management Features

Open ryan-gang opened this issue 6 months ago • 5 comments
trafficstars

Introduce a new StatisticCard component for displaying statistics, enhance the Course Admin Header with a Code Analysis section, and implement the CodeExamplesIndexController and route for managing code examples and language selection. Additionally, add a model for analyzing community solutions statistics.

Checklist:

  • [ ] I've thoroughly self-reviewed my changes
  • [ ] I've added tests for my changes, unless they affect admin-only areas (or are otherwise not worth testing)
  • [ ] I've verified any visual changes using Percy (add a commit with [percy] in the message to trigger)

Summary by CodeRabbit

  • New Features
    • Introduced a "Code Analysis" tab in the course admin section, providing access to a new page for community solutions analysis.
    • Added a language selector to filter analysis data by programming language.
    • Displayed key statistics for each course stage, including solutions count, median changed lines, upvotes, and downvotes, with color-coded indicators and explanatory tooltips.
    • Enabled direct navigation to code examples filtered by stage and language.
    • Provided informative alerts when no data or language selection is available.

ryan-gang avatar May 07 '25 11:05 ryan-gang

Walkthrough

A new "Community Solutions Analysis" feature was introduced to the course admin area. This includes a new route, controller, model, component, and templates for displaying per-stage code solution statistics by language. The implementation covers data fetching, computed statistics, color-coded presentation, and navigation enhancements within the course admin interface.

Changes

File(s) Change Summary
app/components/course-admin/code-examples-index-page/statistic-card.hbs
app/components/course-admin/code-examples-index-page/statistic-card.ts
Added a presentational statistic card component and its backing Glimmer class, accepting a statistic argument for display.
app/components/course-admin/header.ts Added a new "Code Analysis" tab entry to the course admin header's tab list.
app/controllers/course-admin/code-examples-index.ts Introduced a controller for the code examples index page, handling language filtering, navigation, and computed stage-analysis pairing.
app/models/community-solutions-analysis.ts Added a new model representing community solutions analysis, with computed statistics, color coding, and helper methods.
app/router.ts Added a new nested route code-examples-index under course-admin for community solutions analyses.
app/routes/course-admin/code-examples-index.ts Introduced a route class to fetch course, languages, selected language, and filtered analyses based on query params.
app/templates/course-admin/code-examples-index.hbs Added a new template for displaying the analysis dashboard, language selector, statistics by stage, and navigation to code examples.

Sequence Diagram(s)

sequenceDiagram
    participant AdminUser
    participant Router
    participant CodeExamplesIndexRoute
    participant Store
    participant CodeExamplesIndexController
    participant Template

    AdminUser->>Router: Navigates to /course-admin/:slug/community-solutions-analyses
    Router->>CodeExamplesIndexRoute: Activates route with optional language param
    CodeExamplesIndexRoute->>Store: Fetches course, languages
    CodeExamplesIndexRoute->>Store: If language selected, queries analyses for course+language
    CodeExamplesIndexRoute->>Router: Returns model { course, languages, selectedLanguage, analyses }
    Router->>CodeExamplesIndexController: Instantiates controller with model
    CodeExamplesIndexController->>Template: Provides computed properties and actions
    Template->>AdminUser: Renders language selector, statistics cards, and navigation links
    AdminUser->>Template: Selects language from dropdown
    Template->>CodeExamplesIndexController: Calls onLanguageChange (action)
    CodeExamplesIndexController->>Router: Transitions with new language param
    Router->>CodeExamplesIndexRoute: Triggers model refresh with new param

Poem

In burrows deep, the data flows,
New stats and charts the admin shows.
With colored cards and clever code,
Each language’s secrets are now bestowed.
Hop along, explore, don’t lag—
For every stage, a brand new flag!
🐇📊✨

✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

coderabbitai[bot] avatar May 07 '25 11:05 coderabbitai[bot]

Test Results

  1 files  ±0    1 suites  ±0   8m 1s ⏱️ +10s 624 tests ±0  578 ✅  - 1  45 💤 ±0  0 ❌ ±0  1 🔥 +1  624 runs  ±0  577 ✅  - 2  45 💤 ±0  1 ❌ +1  1 🔥 +1 

For more details on these errors, see this check.

Results for commit dfb24a19. ± Comparison against base commit f6fe8ec0.

github-actions[bot] avatar May 07 '25 11:05 github-actions[bot]

:x: 1 Tests Failed:

Tests completed Failed Passed Skipped
579 1 578 45
View the top 1 failed test(s) by shortest run time
Chrome 135.0::Integration | Component | code-mirror > Options > filename: it doesn't break the editor when passed
Stack Traces | 5.04s run time
Test took longer than 5000ms; test timed out.

To view more test analytics, go to the Test Analytics Dashboard 📋 Got 3 mins? Take this short survey to help us improve Test Analytics.

codecov[bot] avatar May 07 '25 11:05 codecov[bot]

Bundle Report

Changes will increase total bundle size by 13.46kB (0.04%) :arrow_up:. This is within the configured threshold :white_check_mark:

Detailed changes
Bundle name Size Change
client-array-push 36.6MB 13.46kB (0.04%) :arrow_up:

Affected Assets, Files, and Routes:

view changes for bundle: client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
assets/chunk.*.js 9.1kB 171.17kB 5.61% :warning:
assets/chunk.*.js 4.36kB 2.84MB 0.15%

Files in assets/chunk.*.js:

  • ./controllers/course-admin/code-examples-index.ts → Total Size: 2.22kB

  • ./routes/course-admin/code-examples-index.ts → Total Size: 1.81kB

Files in assets/chunk.*.js:

  • ./models/community-solutions-analysis.ts → Total Size: 7.32kB

codecov[bot] avatar May 07 '25 11:05 codecov[bot]