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

feat(admin-social-auth): privacy policy #515

Merged
merged 1 commit into from
Oct 10, 2024

Conversation

martijnvdbrug
Copy link
Member

Description

Added privacy policu on the login screen for Google OAuth approval

Screenshots

image

Checklist

📌 Always:

  • I have set a clear title
  • My PR is small and contains a single feature
  • I have checked my own PR

👍 Most of the time:

  • I have added or updated test cases for important functionality
  • I have updated the README if needed

📦 For publishable packages:

Copy link
Contributor

coderabbitai bot commented Oct 10, 2024

Walkthrough

The pull request introduces several updates to the vendure-plugin-admin-social-auth package. Key changes include the addition of a privacy policy to the login page, enhancements to the README documentation regarding Admin UI branding customization, modifications to the logging behavior in the Google authentication strategy, and updates to the login page's HTML for improved user experience. Additionally, the test server configuration has been simplified by removing the AssetServerPlugin initialization.

Changes

File Path Change Summary
packages/vendure-plugin-admin-social-auth/CHANGELOG.md Updated changelog for version 1.1.2, noting the addition of a privacy policy to the login page.
packages/vendure-plugin-admin-social-auth/README.md Added "Admin UI branding" section with instructions for customizing branding, including new properties in the example.
packages/vendure-plugin-admin-social-auth/src/api/google-auth-strategy.ts Modified logging in authenticate method to be less specific for non-administrator login attempts.
packages/vendure-plugin-admin-social-auth/src/ui/login.html Enhanced login page with a new privacy policy modal and added Alpine.js for interactivity; updated styling.
packages/vendure-plugin-admin-social-auth/test/dev-server.ts Removed AssetServerPlugin initialization and related commented-out block.

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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 539528e and 07587bb.

⛔ Files ignored due to path filters (1)
  • packages/vendure-plugin-admin-social-auth/package.json is excluded by !**/*.json
📒 Files selected for processing (5)
  • packages/vendure-plugin-admin-social-auth/CHANGELOG.md (1 hunks)
  • packages/vendure-plugin-admin-social-auth/README.md (1 hunks)
  • packages/vendure-plugin-admin-social-auth/src/api/google-auth-strategy.ts (1 hunks)
  • packages/vendure-plugin-admin-social-auth/src/ui/login.html (3 hunks)
  • packages/vendure-plugin-admin-social-auth/test/dev-server.ts (0 hunks)
💤 Files with no reviewable changes (1)
  • packages/vendure-plugin-admin-social-auth/test/dev-server.ts
✅ Files skipped from review due to trivial changes (1)
  • packages/vendure-plugin-admin-social-auth/CHANGELOG.md
🧰 Additional context used
🪛 Markdownlint
packages/vendure-plugin-admin-social-auth/README.md

68-68: null
Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (2)
packages/vendure-plugin-admin-social-auth/README.md (1)

51-66: Good addition.

New section on Admin UI branding is helpful.

packages/vendure-plugin-admin-social-auth/src/api/google-auth-strategy.ts (1)

86-88: Good privacy move.

Removing the email from the log is smart. It's safer and still tells us what we need to know.

}),
```

The same goes for customizing the logo on the login page: https://docs.vendure.io/guides/extending-the-admin-ui/admin-ui-theming-branding/#specifying-custom-logos
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

Fix bare URL.

Wrap the URL in angle brackets.

🧰 Tools
🪛 Markdownlint

68-68: null
Bare URL used

(MD034, no-bare-urls)

@click="open = false"
>
<div class="modal">
<span class="close">&times;</span>
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

Add click handler to the close button to enable modal dismissal

The close button doesn't have a click handler, so clicking it won't close the modal.

Apply this fix:

-<span class="close">&times;</span>
+<span class="close" @click="open = false">&times;</span>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<span class="close">&times;</span>
<span class="close" @click="open = false">&times;</span>

@@ -6,10 +6,12 @@
</title>
<link rel="icon" type="image/x-icon" href="/admin/favicon.ico" />
<script src="https://accounts.google.com/gsi/client" async></script>
<script src="//unpkg.com/alpinejs" defer></script>
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

Specify HTTPS in script source for Alpine.js

The script source for Alpine.js should explicitly use HTTPS to ensure secure loading over a secure connection.

Apply this fix:

-<script src="//unpkg.com/alpinejs" defer></script>
+<script src="https://unpkg.com/alpinejs" defer></script>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<script src="//unpkg.com/alpinejs" defer></script>
<script src="https://unpkg.com/alpinejs" defer></script>

@martijnvdbrug martijnvdbrug merged commit a255bdc into main Oct 10, 2024
32 checks passed
@martijnvdbrug martijnvdbrug deleted the feat/social-auth-privacy-policy branch October 10, 2024 06:57
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.

1 participant