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: login expired modal z-index #5145

Merged
merged 2 commits into from
Dec 15, 2024
Merged

Conversation

mynetfan
Copy link
Collaborator

@mynetfan mynetfan commented Dec 15, 2024

Description

确保令牌过期登录弹窗的层级最高。
fix #5089

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • New Features

    • Introduced a dynamic z-index calculation for the login expired modal, ensuring it displays above other elements.
  • Documentation

    • Added comments in Chinese to describe the new functionality.

Copy link

changeset-bot bot commented Dec 15, 2024

⚠️ No Changeset found

Latest commit: 6a46a24

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 Dec 15, 2024

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.

packages/effects/common-ui/src/ui/authentication/login-expired-modal.vue

Oops! Something went wrong! :(

ESLint: 9.16.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/node_modules/@vben/eslint-config/dist/index.mjs' imported from /eslint.config.mjs
at finalizeResolution (node:internal/modules/esm/resolve:257:11)
at moduleResolve (node:internal/modules/esm/resolve:914:10)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

Walkthrough

The pull request introduces modifications to the login-expired-modal.vue file, adding an optional zIndex property to the Props interface. It implements a computed property getZIndex to dynamically determine the modal's z-index, ensuring it appears above other elements. A new function calcZIndex is introduced to calculate the maximum z-index from existing elements. The modal's :z-index property is now bound to getZIndex, allowing for dynamic adjustments based on the highest current z-index in the document.

Changes

File Change Summary
packages/effects/common-ui/src/ui/authentication/login-expired-modal.vue Added optional zIndex property, computed property getZIndex, and function calcZIndex for dynamic z-index handling.

Assessment against linked issues

Objective Addressed Explanation
Resolve z-index setting problem for login expired modal [#5089]
Prevent modal from being obscured by other elements

Possibly related PRs

  • chore: update modal.vue #4987: This PR updates the modal.vue file, which is related to modal components, similar to the changes made in the login-expired-modal.vue file in the main PR.
  • fix: modal radius not follow preferences #5063: This PR also modifies the modal.vue file, focusing on styling aspects that could be relevant to the changes made in the login-expired-modal.vue file regarding dynamic styling and properties.

Suggested labels

bug

Suggested reviewers

  • anncwb
  • vince292007

Poem

🐰 In the realm of modals, a z-index quest,
To rise above others, to be the best.
With calcZIndex, it takes to the sky,
No longer obscured, it’s ready to fly!
A rabbit’s cheer for the modal's new height,
Hopping with joy, all is now right! 🎉


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f446cbf and 6a46a24.

📒 Files selected for processing (1)
  • packages/effects/common-ui/src/ui/authentication/login-expired-modal.vue (2 hunks)
🔇 Additional comments (1)
packages/effects/common-ui/src/ui/authentication/login-expired-modal.vue (1)

Line range hint 31-58: Verify modal visibility across different scenarios

While the implementation ensures highest z-index, please verify:

  1. Modal visibility when multiple modals/overlays are present
  2. Behavior with dynamically added elements
  3. Interaction with third-party components that might manipulate z-index
✅ Verification successful

Let me gather more information about z-index usage and modal implementations.


Based on the comprehensive search results, I can now generate the final response:

Implementation of z-index calculation is appropriate for login expired modal

The current implementation ensures the login expired modal appears on top by:

  1. Using getMaxZIndex() to dynamically calculate the highest z-index in the DOM
  2. Being used consistently across different UI frameworks (Antd, Element, Naive)
  3. Working in conjunction with the app's loginExpiredMode setting which can be configured as 'modal' or 'page'

The z-index calculation is particularly important because:

  • The modal needs to appear above all other UI elements when login expires
  • The app has multiple layers with different z-index values (layout header: 200, sidebar: varies, other modals: 1000)
  • The implementation handles dynamic z-index values from third-party components
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other components that might compete for z-index
rg -l "z-index|zIndex" --type vue

# Look for other modal implementations
ast-grep --pattern 'Modal'

Length of output: 488


Script:

#!/bin/bash
# Search for z-index related code with context
rg "z-index|zIndex" -A 3 -B 3 --no-ignore-vcs

# Look for modal component implementations with context
ast-grep --pattern $'const Modal = defineComponent({
  $$$
})'

# Search for other login-expired or session-related modals
rg -i "login.*expired|session.*expired" -A 3 -B 3

Length of output: 59185

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)
packages/effects/common-ui/src/ui/authentication/login-expired-modal.vue (1)

38-40: Use English for code comments

For better maintainability and international collaboration, consider translating the Chinese comment to English:

-/**
- * 获取最大的zIndex值
- */
+/**
+ * Get the maximum z-index value from the document
+ */
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6a46a24 and 4e31cd8.

📒 Files selected for processing (1)
  • packages/effects/common-ui/src/ui/authentication/login-expired-modal.vue (3 hunks)
🔇 Additional comments (6)
packages/effects/common-ui/src/ui/authentication/login-expired-modal.vue (6)

4-4: LGTM: Required imports added correctly

The necessary Vue imports are properly included.


11-11: LGTM: Props interface properly extended

The zIndex property is correctly typed as an optional number.


18-21: LGTM: Appropriate default value set

The default z-index of 0 is a sensible choice.


34-36: Consider using cached computed property for better performance

The current implementation may impact performance as noted in previous reviews.


64-64: LGTM: Proper z-index binding

The z-index is correctly bound to the computed property.


41-52: 🛠️ Refactor suggestion

Optimize z-index calculation performance

The current implementation queries and processes all DOM elements, which is inefficient.

Consider this optimized version:

function calcZIndex() {
  let maxZ = 0;
-  const elements = document.querySelectorAll('*');
-  [...elements].forEach((element) => {
+  const elements = document.querySelectorAll('div[style*="z-index"], .modal, .popup, .overlay');
+  elements.forEach((element) => {
    const style = window.getComputedStyle(element);
    const zIndex = style.getPropertyValue('z-index');
    if (zIndex && !Number.isNaN(Number.parseInt(zIndex))) {
      maxZ = Math.max(maxZ, Number.parseInt(zIndex));
    }
  });
  return maxZ + 1;
}

Likely invalid or redundant comment.

@mynetfan mynetfan merged commit ce4af37 into vbenjs:main Dec 15, 2024
14 checks passed
@mynetfan mynetfan deleted the fix/login-modal-zindex branch December 15, 2024 15:25
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.

Bug: 过期登录弹窗 AuthenticationLoginExpiredModal 的z-index设置问题
1 participant