8000 Valentin/Catalyst upgrades by Bryukh · Pull Request #7996 · codecombat/codecombat · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Valentin/Catalyst upgrades #7996

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 4 commits into from
May 22, 2025
Merged

Valentin/Catalyst upgrades #7996

merged 4 commits into from
May 22, 2025

Conversation

Bryukh
Copy link
Collaborator
@Bryukh Bryukh commented May 22, 2025
  • removed teacher pop-up again (to prove it doesn't matter)
  • shifted islands
  • increased probability for FullStory for catalyst

Summary by CodeRabbit

  • Bug Fixes

    • Adjusted when the anonymous classroom signup prompt is shown to exclude users in the Catalyst experiment.
  • Style

    • Improved layout consistency in the Catalyst portal by introducing new variables and updating margin and height calculations.
  • Refactor

    • Clarified internal logic for experiment assignment and tracking eligibility, resulting in more predictable behavior for experiments and tracking.

@Bryukh Bryukh requested a review from mrfinch May 22, 2025 12:18
Copy link
Contributor
coderabbitai bot commented May 22, 2025

Walkthrough

This update refines experiment logic and styling for the Catalyst feature. It adjusts probability thresholds and experiment checks in tracking and user experiment assignment, clarifies control flow in experiment value determination, centralizes styling variables for Catalyst portal layout, and prevents anonymous signup prompts for Catalyst experiment users.

Changes

File(s) Change Summary
app/core/Tracker2/FullStoryTracker.js Adjusted probability thresholds for tracking activation and updated experiment check to use getCatalystExperimentValue() instead of getM7ExperimentValue().
app/models/User.js Refactored getCatalystExperimentValue for early return when experiment is inactive, clarifying control flow and assignment logic.
app/styles/play/campaign-view.sass Introduced SASS variables for Catalyst portal dimensions and margins; replaced hardcoded values with variable-based calculations for layout consistency.
app/views/play/CampaignView.js Updated shouldShow logic to prevent anonymous classroom signup prompt from displaying to users in the Catalyst experiment.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CampaignView
    participant FullStoryTracker

    User->User: getCatalystExperimentValue()
    alt Experiment inactive
        User-->Caller: 'control'
    else Experiment active
        User-->Caller: 'beta' or 'control' (probabilistic)
    end

    FullStoryTracker->User: getCatalystExperimentValue()
    FullStoryTracker->FullStoryTracker: decideEnabled() (probabilistic based on experiment value)

    CampaignView->User: isCatalyst (via getCatalystExperimentValue)
    CampaignView->CampaignView: shouldShow()
    alt User is in Catalyst
        CampaignView-->UI: Do not show anonymous classroom signup
    else Not in Catalyst
        CampaignView-->UI: Show prompt if other conditions met
    end
Loading

Possibly related PRs

Suggested reviewers

  • nwinter
  • mrfinch
  • smallst

Poem

A Catalyst breeze through the portal blows,
With margins and heights now neatly composed.
Experiments refined, the logic is clear—
Anonymous prompts now disappear.
The rabbit hops, code tidy and bright,
In Catalyst’s garden, all feels right!
🐇✨

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 config production Use --omit=dev instead.
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.0.2', 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-05-22T12_24_51_927Z-debug-0.log

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 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 ad6dc8e and 2a22853.

📒 Files selected for processing (4)
  • app/core/Tracker2/FullStoryTracker.js (1 hunks)
  • app/models/User.js (1 hunks)
  • app/styles/play/campaign-view.sass (4 hunks)
  • app/views/play/CampaignView.js (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (4)
  • app/core/Tracker2/FullStoryTracker.js
  • app/views/play/CampaignView.js
  • app/models/User.js
  • app/styles/play/campaign-view.sass
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: ESLint CI
  • GitHub Check: Node.js CI (18.10.0)
✨ 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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 07ae36f and ad6dc8e.

📒 Files selected for processing (6)
  • app/core/Tracker2/FullStoryTracker.js (1 hunks)
  • app/core/utils.js (2 hunks)
  • app/locale/en.js (1 hunks)
  • app/models/User.js (1 hunks)
  • app/styles/play/campaign-view.sass (4 hunks)
  • app/views/play/CampaignView.js (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: ESLint CI
  • GitHub Check: Node.js CI (18.10.0)
🔇 Additional comments (10)
app/models/User.js (1)

1336-1340: Control flow improvement for better clarity and efficiency

The refactored code now immediately returns 'control' when the experiment probability is null instead of continuing with unnecessary execution. This is a cleaner approach that prevents the code from running unneeded probability calculations.

app/locale/en.js (1)

4985-4986: Swap of season labels aligns with updated arena metadata.

The updated values for season_14 ("Racing Rivals") and season_15 ("Soccer Showdown") correctly mirror the corresponding changes in the season configuration and scheduling. This ensures that the displayed season names remain consistent across the UI and underlying logic.

app/views/play/CampaignView.js (1)

2200-2201: Suppress classroom signup dialog for Catalyst experiment users

The condition !this.isCatalyst is added to prevent showing the anonymous classroom signup dialog to users who are part of the Catalyst experiment. This aligns with the PR objective of removing the teacher pop-up to test its impact.

app/core/Tracker2/FullStoryTracker.js (3)

109-109: Reduced tracking probability for anonymous users

The probability threshold for enabling FullStory tracking for anonymous users has been lowered from 0.25% to 0.15%, reducing the overall tracking footprint.


112-114: Updated experiment name from M7 to Catalyst

The code now checks for getCatalystExperimentValue() instead of getM7ExperimentValue() while maintaining the same 5% probability threshold. The log message has been appropriately updated to reflect this change.


115-115: Reduced tracking probability for non-parent teachers

The probability threshold for enabling FullStory tracking for teachers who are not parents has been reduced from 2% to 1%.

app/styles/play/campaign-view.sass (3)

9-11: Added variables for Catalyst portal layout

These new SASS variables improve maintainability by centralizing layout constants for the Catalyst portal. This makes future adjustments easier and ensures consistent values across the stylesheet.


1375-1375: Replaced hardcoded margin values with variables

Using the $catalystMarginTopBase variable with appropriate offsets improves code maintainability and makes the relationship between different margin values clearer.

Also applies to: 1383-1383, 1386-1386


1455-1457: Replaced hardcoded height values with variables

Using the $sideCampaignPortalHeight variable instead of hardcoded pixel values improves consistency and makes it easier to adjust the layout proportionally if needed in the future.

Also applies to: 1472-1472

app/core/utils.js (1)

1383-1384: AILeagueSeasons configuration updated to match arena changes

The championshipType and image properties for seasons 14 and 15 have been swapped to match the arena changes:

  • Season 14: now 'clash' type with 'grand-prix-clash' image
  • Season 15: now 'blitz' type with 'golden-goal-blitz' image

This change aligns with the arena slug changes in the arenas array.

@Bryukh Bryukh force-pushed the catalyst-upgrades branch from ad6dc8e to 2a22853 Compare May 22, 2025 12:23
@Bryukh Bryukh merged commit 37e46af into master May 22, 2025
3 checks passed
@Bryukh Bryukh deleted the catalyst-upgrades branch May 22, 2025 13:40
@coderabbitai coderabbitai bot mentioned this pull request Jun 3, 2025
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