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

Test 1add vitest in utils #2848

Closed

Conversation

shenjunjian
Copy link
Collaborator

@shenjunjian shenjunjian commented Jan 26, 2025

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

Release Notes

  • New Features

    • Added Vitest testing framework to the utils package
    • Enhanced cryptographic utilities with improved SHA-256 hashing
  • Documentation

    • Updated README for utils package with installation instructions
    • Improved logging and XSS utility documentation
  • Refactors

    • Streamlined logging and cryptography modules
    • Simplified module exports in utils package
    • Removed legacy cryptography and nanoid implementations
  • Tests

    • Added new test cases for XSS and cryptography utilities

Copy link

coderabbitai bot commented Jan 26, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request encompasses a comprehensive refactoring of the utility packages, focusing on modularization, testing, and streamlining of various utility functions. The changes primarily involve restructuring import statements, removing deprecated logging and cryptography implementations, and introducing Vitest for testing. The modifications span across multiple packages, including utils, renderless, and vue components, with an emphasis on simplifying module exports and improving code organization.

Changes

File Change Summary
examples/sites/demos/pc/app/grid/editor/custom-edit.spec.js Modified Playwright test case, removing specific row visibility checks and adding a new assertion for a textbox
packages/mobile/components/file-upload/src/renderless/index.ts Updated import statements and function parameter defaults for handleStart and abortDownload
packages/renderless/src/common/index.ts Removed log function and its import
packages/renderless/src/tree/index.ts Updated log import from relative path to package
packages/utils/README.md Added installation header and npm install command
packages/utils/package.json Added type: "module", new test script, and Vitest dependency
packages/utils/src/crypt/* Significant refactoring of cryptography modules, removing core implementation and simplifying SHA-256 hashing
packages/utils/src/index.ts Simplified module exports, removing type declarations
packages/utils/src/log/index.ts New logging utility using getWindow
packages/utils/src/logger/* Removed logger-related files
packages/utils/src/nanoid/* Removed Nano ID implementation and related files
packages/vue/src/grid/package.json Added @opentiny/utils dependency
packages/vue/src/grid/src/tools/logger.ts Updated logging import and method call

Sequence Diagram

sequenceDiagram
    participant Utils as Utility Package
    participant Crypt as Cryptography Module
    participant Log as Logging Module
    participant Window as Window Context

    Utils->>Crypt: Refactor SHA-256 implementation
    Crypt->>Window: Use native crypto.subtle
    
    Utils->>Log: Create new logging utility
    Log->>Window: Access console via getWindow()
    
    Utils->>Utils: Simplify module exports
    Utils->>Utils: Remove deprecated implementations
Loading

Possibly related PRs

Suggested labels

documentation, refactoring, utilities, testing

Suggested reviewers

  • zzcr
  • core-utils-team
  • frontend-architecture

Poem

🐰 Hop, hop, refactor we go!
Utilities dancing, code in a flow
Logs simplified, crypto refined
A rabbit's journey, elegantly designed
Clean code blooms like spring's first rose 🌹


📜 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 cda8521 and ccdef55.

⛔ Files ignored due to path filters (1)
  • packages/utils/src/crypt/__test__/__snapshots__/crypt.test.ts.snap is excluded by !**/*.snap
📒 Files selected for processing (20)
  • examples/sites/demos/pc/app/grid/editor/custom-edit.spec.js (1 hunks)
  • packages/mobile/components/file-upload/src/renderless/index.ts (4 hunks)
  • packages/renderless/src/common/index.ts (1 hunks)
  • packages/renderless/src/tree/index.ts (1 hunks)
  • packages/utils/README.md (1 hunks)
  • packages/utils/package.json (2 hunks)
  • packages/utils/src/crypt/__test__/crypt.test.ts (1 hunks)
  • packages/utils/src/crypt/core.ts (0 hunks)
  • packages/utils/src/crypt/index.ts (1 hunks)
  • packages/utils/src/crypt/sha256.ts (0 hunks)
  • packages/utils/src/index.ts (1 hunks)
  • packages/utils/src/log/index.ts (1 hunks)
  • packages/utils/src/logger/README.md (0 hunks)
  • packages/utils/src/logger/index.ts (0 hunks)
  • packages/utils/src/nanoid/README.md (0 hunks)
  • packages/utils/src/nanoid/index.ts (0 hunks)
  • packages/utils/src/nanoid/nanoid.ts (0 hunks)
  • packages/utils/src/xss/__test__/xss.test.ts (1 hunks)
  • packages/vue/src/grid/package.json (1 hunks)
  • packages/vue/src/grid/src/tools/logger.ts (2 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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

Walkthrough

This pull request primarily focuses on refactoring and updating the utility functions within the @opentiny/utils package. It includes changes to the cryptographic functions, logging mechanisms, and test cases, as well as updates to the package's documentation.

Changes

Files Summary
examples/sites/demos/pc/app/grid/editor/custom-edit.spec.js Modified test cases for grid editor custom edit functionality.
packages/mobile/components/file-upload/src/renderless/index.ts Refactored imports and updated function signatures for file upload components.
packages/renderless/src/common/index.ts, packages/renderless/src/tree/index.ts Updated import paths for logging utilities.
packages/utils/README.md, packages/utils/package.json Updated documentation and package metadata.
packages/utils/src/crypt/__test__/crypt.test.ts, packages/utils/src/crypt/__test__/__snapshots__/crypt.test.ts.snap Added new test cases for cryptographic functions.
packages/utils/src/crypt/core.ts, packages/utils/src/crypt/index.ts, packages/utils/src/crypt/sha256.ts Removed old cryptographic implementations and replaced with new SHA-256 function.
packages/utils/src/index.ts, packages/utils/src/log/index.ts Refactored logging utilities and exports.
packages/utils/src/xss/__test__/xss.test.ts Added test cases for XSS filtering functions.
packages/vue/src/grid/package.json, packages/vue/src/grid/src/tools/logger.ts Updated logging utility imports and package metadata.
🪧 Tips For further assistance, please describe your question in the comments and @petercat-assistant to start a conversation with me.

const msgUint8 = isArrayBuffer ? message : new TextEncoder().encode(message) // 编码为(utf-8)Uint8Array
const hashBuffer = await window.crypto.subtle.digest(algo, msgUint8) // 计算消息的哈希值
const msgUint8 = isArrayBuffer ? message : new TextEncoder().encode(message as string) // 编码为(utf-8)Uint8Array
const hashBuffer = await getWindow().crypto.subtle.digest('SHA-256', msgUint8) // 计算消息的哈希值

Choose a reason for hiding this comment

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

The use of getWindow().crypto.subtle.digest assumes that the crypto API is available in the environment. Ensure that there is a fallback or error handling for environments where this API is not supported, as it may lead to runtime errors.

@zzcr zzcr closed this Jan 26, 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