8000 get correct html code for curriculum as well as in level solutions by smallst · Pull Request #8011 · codecombat/codecombat · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

get correct html code for curriculum as well as in level solutions #8011

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

Merged
merged 2 commits into from
Jun 10, 2025

Conversation

smallst
Copy link
Contributor
@smallst smallst commented Jun 6, 2025

image
image
fix ENG-1717

Summary by CodeRabbit

  • New Features

    • Enhanced support for web development levels by prioritizing HTML solutions and sample code.
    • Automatically extracts and displays player code from HTML sources containing a tag.
  • Bug Fixes

    • Improved accuracy in displaying solutions and sample code for web development levels, ensuring the correct code is shown to users.

Copy link
Contributor
coderabbitai bot commented Jun 6, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce special handling for "web-dev" level types in both the solution and sample code retrieval logic. For such levels, the code prioritizes HTML solutions and extracts code within <playercode> tags when present, ensuring these are surfaced correctly for teacher curriculum views and related interfaces.

Changes

File(s) Change Summary
app/core/store/modules/game.js Modified getSolutionSrc getter to handle 'web-dev' levels by extracting or returning HTML code.
app/models/Level.js Updated getSolutionForLanguage and getSampleCodeForLanguage to support 'web-dev' with HTML and <playercode> tag extraction.

Sequence Diagram(s)

sequenceDiagram
    participant TeacherView
    participant GameStore
    participant LevelModel
    participant Utils

    TeacherView->>GameStore: getSolutionSrc(level)
    GameStore->>LevelModel: getSolutionForLanguage('html')
    alt level.type == 'web-dev'
        LevelModel->>LevelModel: Find HTML solution
        LevelModel->>Utils: extractPlayerCodeTag(source)
        Utils-->>LevelModel: Extracted code or raw HTML
        LevelModel-->>GameStore: Solution code
    else
        LevelModel->>LevelModel: Fallback to JS/Python solution
        LevelModel-->>GameStore: Solution code
    end
    GameStore-->>TeacherView: Solution code for display
Loading

Assessment against linked issues

Objective Addressed Explanation
Use the html language solution if it exists for web-dev levels (ENG-1717)
Parse and render HTML solution using the same templating mechanism as player-facing code (ENG-1717)
Display the HTML solution in the teacher interface as the level’s solution for web-dev levels (ENG-1717)

Suggested reviewers

  • mrfinch

Poem

In the warren where code bunnies dwell,
HTML solutions now surface quite well!
With tags like <playercode>, we dig and we find,
The snippets for teachers, so neatly aligned.
No more empty carrots—just code to display,
Thanks to these changes, hip-hip-hooray!
🐰💻✨

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.

npm warn EBADENGINE Unsupported engine {
npm warn EBADENGINE package: 'treema@0.0.0',
npm warn EBADENGINE required: { node: '0.8.x' },
npm warn EBADENGINE current: { node: 'v24.1.0', npm: '11.3.0' }
npm warn EBADENGINE }
npm warn skipping integrity check for git dependency ssh://git@github.com/codecombat/treema.git
npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-06-10T03_28_28_623Z-debug-0.log


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dec1b81 and 49acd31.

📒 Files selected for processing (1)
  • app/core/store/modules/game.js (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

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 (1)
app/core/store/modules/game.js (1)

252-260: Consider extracting common logic to reduce code duplication.

The implementation is correct and handles 'web-dev' levels properly. However, the same logic pattern is repeated across multiple files.

Consider extracting the common web-dev processing logic into a utility function:

// In utils.js
function processWebDevCode(source) {
  if (/<playercode>/.test(source)) {
    return utils.extractPlayerCodeTag(source)
  }
  return source
}

Then update this method:

 if (rootState.game.level.type === 'web-dev') {
   const htmlSource = (_.find(solutions, { language: 'html' }))?.source
   if (htmlSource) {
-    if (/<playercode>/.test(htmlSource)) {
-      return utils.extractPlayerCodeTag(htmlSource)
-    }
-    return htmlSource
+    return utils.processWebDevCode(htmlSource)
   }
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3c000e7 and dec1b81.

📒 Files selected for processing (2)
  • app/core/store/modules/game.js (1 hunks)
  • app/models/Level.js (2 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
app/core/store/modules/game.js (1)
app/models/Level.js (3)
  • solutions (505-505)
  • solutions (540-540)
  • utils (21-21)
app/models/Level.js (4)
app/core/utils.js (1)
  • _ (20-20)
app/views/play/CampaignView.js (1)
  • utils (19-19)
app/views/courses/CoursesView.js (1)
  • utils (36-36)
app/models/LevelSession.js (1)
  • sampleCode (192-192)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: ESLint CI
  • GitHub Check: Node.js CI (18.10.0)
🔇 Additional comments (2)
app/models/Level.js (2)

560-566: LGTM! Good error handling for web-dev levels.

The implementation correctly handles null checks and follows a consistent pattern for extracting player code from HTML sample code.


541-547: ⚠️ Potential issue

Fix potential null access and improve error handling.

The code has a potential null pointer issue when accessing solution.source without proper null checking.

Apply this diff to fix the null safety issue:

 if (this.isType('web-dev')) {
   const solution = _.find(solutions, { language: 'html', succeeds: true })
-  if (/<playercode>/.test(solution?.source)) {
-    solution.source = utils.extractPlayerCodeTag(solution.source)
+  if (solution && /<playercode>/.test(solution.source)) {
+    solution.source = utils.extractPlayerCodeTag(solution.source)
   }
   if (solution) return solution
 }

Likely an incorrect or invalid review comment.

@@ -249,6 +249,15 @@ module.exports = {
} = component.config.programmableMethods

const solutions = _.filter(((plan != null ? plan.solutions : undefined) != null ? (plan != null ? plan.solutions : undefined) : []), s => !s.testOnly && s.succeeds)
if (rootState.game.level.type === 'web-dev') {
Copy link
Contributor

Choose a reason for hiding this comment

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

no optional chaining here? I would be scared 😅

Copy link
Contributor Author
@smallst smallst Jun 10, 2025

Choose a reason for hiding this comment

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

theoretically these chain should be safe. but let me add optional 😂

@smallst smallst merged commit 094ad41 into master Jun 10, 2025
1 of 3 checks passed
@smallst smallst deleted the yuqiang/wd-curriculumn-start-code-fix branch June 10, 2025 03:24
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
0