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: 微信小程序permission配置项缺少 #35

Merged
merged 1 commit into from
Sep 10, 2024

Conversation

wtto00
Copy link
Contributor

@wtto00 wtto00 commented Sep 8, 2024

Description 描述

修复微信小程序permission配置项缺少 scope.userLocationBackgroundscope.userFuzzyLocation的问题。

相似的问题,在QQ小程序暂时没有发现,相关文档:QQ小程序scope授权注意事项

Linked Issues 关联的 Issues

fix #34

Additional context 额外上下文

附加微信的文档链接:

permission配置项

scope授权注意事项

Summary by CodeRabbit

  • New Features

    • Expanded permissions for the Weixin mini-program to include additional location-related scopes: user location, background location, and fuzzy location.
    • Enhanced clarity and validation rules in the permissions schema, ensuring mandatory descriptions for specific permission requests.
  • Bug Fixes

    • Improved handling of permission requests to prevent additional properties from being included.

Copy link

coderabbitai bot commented Sep 8, 2024

Walkthrough

The pull request modifies the MpWeixin interface to expand the permission property, allowing it to accept multiple location-related permissions. Additionally, the JSON schema for permissions is updated to include definitions for these new scopes, enhancing validation and clarity around permission requests in Weixin mini-programs.

Changes

Files Change Summary
packages/core/src/config/types/mpWeixin.ts, packages/schema/schema.json Expanded the permission property in the MpWeixin interface to include scope.userLocationBackground and scope.userFuzzyLocation. Updated the JSON schema to define these new permissions with descriptions and validation rules.

Assessment against linked issues

Objective Addressed Explanation
Modify permission type to allow multiple permissions (#34)
Ensure TypeScript checks for new permissions are valid (#34)

🐇 In the meadow, permissions grow,
With user locations, we now know!
Background and fuzzy, all in the mix,
Our Weixin app gets new tricks!
Hopping along, we celebrate this feat,
With clearer paths, our code's now neat! 🌼


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3099e76 and 06f9715.

Files selected for processing (2)
  • packages/core/src/config/types/mpWeixin.ts (1 hunks)
  • packages/schema/schema.json (3 hunks)
Additional comments not posted (3)
packages/core/src/config/types/mpWeixin.ts (1)

200-200: Approved: Expanded permission scope in MpWeixin interface.

The modification to the permission property correctly expands its scope to include 'scope.userLocation', 'scope.userLocationBackground', and 'scope.userFuzzyLocation'. This change aligns with the PR objectives and the linked issue.

Please ensure that these new permissions are documented and tested thoroughly to confirm their integration with existing permissions and that they comply with WeChat's official documentation.

packages/schema/schema.json (2)

3261-3274: Review of scope.userLocationBackground Permission Addition

The addition of the scope.userLocationBackground permission is correctly implemented with the required desc property. This property is essential for explaining the purpose of the permission to the user, which aligns with best practices for permission requests in applications.


Line range hint 3275-3288: Review of scope.userFuzzyLocation Permission Addition

The addition of the scope.userFuzzyLocation permission is correctly implemented. The structure includes a desc property, which is mandatory and provides a description of the permission's use. This is crucial for transparency and user trust, especially for permissions related to location data.

@ModyQyW
Copy link
Member

ModyQyW commented Sep 10, 2024

Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

manifest.config.ts指定多个permission权限时类型检查不通过
3 participants