8000 ENG-1388 - Chapter 2 student navigation on map by adamkecskes · Pull Request #7837 · codecombat/codecombat · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

ENG-1388 - Chapter 2 student navigation on map #7837

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
Nov 22, 2024

Conversation

adamkecskes
Copy link
Collaborator
@adamkecskes adamkecskes commented Nov 19, 2024

Arrow symbols (◁ and ▷ ) added before and after the pagination dots. Also background added for better highlight.

before after
paginate-before paginate-after

Summary by CodeRabbit

  • New Features
    • Introduced navigation methods for easier page transitions: previousPage and nextPage.
    • Added new navigation options for improved user experience: navigate_to_previous_page and navigate_to_next_page.
    • Updated text strings across the application for clarity and consistency.
  • Style
    • Enhanced layout control with flexbox properties for navigation elements.
    • Updated styling for active and 8000 inactive states of navigation arrows.

Copy link
Contributor
coderabbitai bot commented Nov 19, 2024

Walkthrough

The changes in UnitMapBackground.vue involve structural and functional modifications to enhance the component. Key updates include the addition of trailing commas in various sections for improved syntax consistency, the introduction of navigation methods previousPage and nextPage, and updates to the template for new navigation elements. Styling adjustments were made to improve layout control, particularly for navigation indicators. Overall, these changes aim to improve both the functionality and maintainability of the component.

Changes

File Path Change Summary
ozaria/site/components/play/PageUnitMap/common/UnitMapBackground.vue - Added methods: previousPage, nextPage for navigation.
- Updated props with trailing commas.
- Adjusted template for new navigation arrows.
- Changed active class from active to selected.
- Enhanced styling with flexbox properties and updated margins.
app/locale/en.js - Added new strings: navigate_to_previous_page, navigate_to_next_page for navigation.
- Updated existing text strings for clarity and consistency.

Assessment against linked issues

Objective Addressed Explanation
Improve navigation visibility in chapters (ENG-1388)

Possibly related PRs

Suggested reviewers

  • nwinter
  • smallst

🐰 In the fields where the bunnies play,
New arrows guide us on our way.
With commas trailing, neat and fine,
We hop through pages, oh so divine!
A selected path, we leap and bound,
In our cozy map, joy is found! 🐇✨

Warning

Rate limit exceeded

@adamkecskes has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 12 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between e18d779 and 7fc72df.

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.

warning eslint@8.57.1: This version is no longer supported. Please see https://eslint.org/version-support for other options.
warning eslint > @humanwhocodes/config-array@0.13.0: Use @eslint/config-array instead
warning eslint > @humanwhocodes/config-array > @humanwhocodes/object-schema@2.0.3: Use @eslint/object-schema instead
warning eslint > file-entry-cache > flat-cache > rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > glob > inflight@1.0.6: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
warning eslint-plugin-script-tags@0.5.0: Now published as @mapbox/eslint-plugin-script-tags
warning blockly > jsdom > abab@2.0.6: Use your platform's native atob() and btoa() methods instead
warning blockly > jsdom > data-urls > abab@2.0.6: Use your platform's native atob() and btoa() methods instead
warning blockly > jsdom > domexception@4.0.0: Use your platform's native DOMException instead
warning treema > express > mkdirp@0.3.3: Legacy versions of mkdirp are no longer supported. Please update to mkdirp 1.x. (Note that the API surface has changed to use Promises in 1.x.)
warning treema > express > connect@2.7.2: connect 2.x series is deprecated
warning treema > express > connect > formidable@1.0.11: Please upgrade to latest, formidable@v2 or formidable@v3! Check these notes: https://bit.ly/2ZEqIau
warning vue@2.7.10: Vue 2 has reached EOL and is no longer actively maintained. See https://v2.vuejs.org/eol/ for more details.
warning jasmine > glob@3.2.11: Glob versions prior to v9 are no longer supported
warning jasmine > glob > minimatch@0.3.0: Please update to minimatch 3.0.2 or higher to avoid a RegExp DoS issue
warning karma > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning karma > rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
warning karma > tmp > rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
warning karma > socket.io > debug@4.1.1: Debug versions >=3.2.0 <3.2.7 || >=4 <4.3.1 have a low-severity ReDos regression when used in a Node.js environment. It is recommended you upgrade to 3.2.7 or 4.3.1. (debug-js/debug#797)
warning karma > socket.io > engine.io > debug@4.1.1: Debug versions >=3.2.0 <3.2.7 || >=4 <4.3.1 have a low-severity ReDos regression when used in a Node.js environment. It is recommended you upgrade to 3.2.7 or 4.3.1. (debug-js/debug#797)
warning karma > socket.io > socket.io-parser > debug@4.1.1: Debug versions >=3.2.0 <3.2.7 || >=4 <4.3.1 have a low-severity ReDos regression when used in a Node.js environment. It is recommended you upgrade to 3.2.7 or 4.3.1. (debug-js/debug#797)
warning pug > pug-filters > constantinople > babel-types > babel-runtime > core-js@2.6.12: core-js@<3.23.3 is no longer maintained and not recommended for usage due to the number of issues. Because of the V8 engine whims, feature detection in old core-js versions could cause a slowdown up to 100x even if nothing is polyfilled. Some versions have web compatibility issues. Please, upgrade your dependencies to the actual version of core-js.
warning standard > eslint@8.57.1: This version is no longer supported. Please see https://eslint.org/version-support for other options.
warning @babel/plugin-proposal-optional-chaining@7.21.0: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-optional-chaining instead.
error treema@0.0.0: The engine "node" is incompatible with this module. Expected version "0.8.x". Got "22.9.0"
error Found incompatible module.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e18d779 and 7fc72df.

📒 Files selected for processing (2)
  • app/locale/en.js (1 hunks)
  • ozaria/site/components/play/PageUnitMap/common/UnitMapBackground.vue (7 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • ozaria/site/components/play/PageUnitMap/common/UnitMapBackground.vue
🔇 Additional comments (1)
app/locale/en.js (1)

1206-1207: LGTM! The new navigation strings are clear and well-placed.

The added translation strings for previous/next page navigation are concise and follow the established naming conventions.


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

🧹 Outside diff range and nitpick comments (1)
ozaria/site/components/play/PageUnitMap/common/UnitMapBackground.vue (1)

213-253: Consider adding transitions and hover effects.

The navigation arrows could benefit from smooth transitions and hover effects to improve user experience.

Add transitions and hover effects:

    .arrow
      width: 0
      height: 0
      border-style: solid
      position: relative
      cursor: pointer
+     transition: transform 0.2s ease-in-out

+     &:hover:not(.inactive)
+       transform: scale(1.1)

      &::before
        content: ""
        position: absolute
        width: 0
        height: 0
        border-style: solid
        z-index: 1
+       transition: border-color 0.2s ease-in-out

      &.inactive
        opacity: 0.5
        cursor: default
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7cce909 and e18d779.

📒 Files selected for processing (1)
  • ozaria/site/components/play/PageUnitMap/common/UnitMapBackground.vue (7 hunks)
🔇 Additional comments (2)
ozaria/site/components/play/PageUnitMap/common/UnitMapBackground.vue (2)

124-133: LGTM! Clean navigation implementation.

The previousPage and nextPage methods are well-implemented with proper boundary checks to prevent navigation beyond valid page ranges.


Line range hint 1-134: Verify integration with parent components.

Since this component handles navigation, we should verify that parent components properly handle the page changes and maintain consistent state.

Let's check for parent component usage:

✅ Verification successful

Based on the search results, I can now provide a final response:

Navigation integration is properly handled across the codebase.

The verification shows that:

  • The parent component PageUnitMap/index.vue correctly handles the campaignPage prop and state
  • The navigation through courseWorldMap URLs is consistently implemented across the codebase
  • State management through Vuex stores (unitMap.js and campaigns.js) properly handles campaign page transitions
  • Default values and backward compatibility are maintained throughout the navigation flow
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Find parent components that use UnitMapBackground
# and verify they handle page navigation properly

# Find parent components importing UnitMapBackground
rg -l "import.*UnitMapBackground" --type vue

# Find components watching or handling campaignPage changes
ast-grep --pattern 'watch: {
  $$$
  campaignPage($$$) {
    $$$
  }
  $$$
}'

Length of output: 154


Script:

#!/bin/bash
# Let's try a different approach to find parent components and navigation handling

# Find files importing UnitMapBackground
rg -l "UnitMapBackground"

# Find components with campaignPage prop or data
rg -A 5 "campaignPage"

# Look for router navigation related to campaign pages
rg -A 3 "courseWorldMap|campaignPage"

Length of output: 34463

Comment on lines 18 to +19
required: true,
default: () => {}
default: () => {},
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Reconsider default values for required props.

The props campaignData and levels are marked as required: true but also have default values. This is contradictory as required props should not have default values since they must be provided by the parent component.

Remove the default values:

    campaignData: {
      type: Object,
      required: true,
-     default: () => {},
    },
    levels: {
      type: Object,
      required: true,
-     default: () => {},
    },

Also applies to: 23-24

Comment on lines 161 to 165
<div
class="arrow left"
:class="{ inactive: campaignPage === 1 }"
@click="previousPage"
/>
Copy link
Contributor
@coderabbitai coderabbitai bot Nov 19, 2024

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add ARIA attributes for accessibility.

The navigation arrows lack proper accessibility attributes, which could make it difficult for screen readers to interpret these controls.

Add ARIA attributes to the navigation arrows:

      <div
        class="arrow left"
        :class="{ inactive: campaignPage === 1 }"
+       role="button"
+       :aria-label="'Navigate to previous page'"
+       :aria-disabled="campaignPage === 1"
        @click="previousPage"
      />
      <!-- ... -->
      <div
        class="arrow right"
        :class="{ inactive: campaignPage === totalPages }"
+       role="button"
+       :aria-label="'Navigate to next page'"
+       :aria-disabled="campaignPage === totalPages"
        @click="nextPage"
      />

Also applies to: 175-179

Copy link
Contributor

Choose a reason for hiding this comment

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

@adamkecskes can you add these aria label things? We do support screen readers on Ozaria so adding these should help.

Copy link
Contributor

Choose a reason for hiding this comment

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

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!

<ul>
<li
v-for="page in totalPages"
:key="page"
:class="{ active: page === campaignPage }"
:class="{ selected: page === campaignPage }"
Copy link
Contributor

Choose a reason for hiding this comment

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

not blocking but why do we update the class name ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@smallst For me active suggested that the button is active, and should be clickable.
But this button should be in non-clickable (inactive) state, because it is already selected.

@adamkecskes adamkecskes requested a review from mrfinch November 21, 2024 09:14
@mrfinch mrfinch merged commit 95151cf into master Nov 22, 2024
1 of 2 checks passed
@mrfinch mrfinch deleted the adamk/chapter-2-student-navigation-on-map branch November 22, 2024 10:06
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.

3 participants
0