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(service-portal-licenses): Fix async pkpass generation #14969

Merged
merged 3 commits into from
May 28, 2024

Conversation

thorkellmani
Copy link
Member

@thorkellmani thorkellmani commented May 28, 2024

What

useEffect to fix async safari shenanigans

Why

Some threading issue is making the ui funky.
Use useEffect for proper timing

Checklist:

  • I have performed a self-review of my own code
  • 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
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • New Features

    • Enhanced QR code modal functionality to handle response errors more effectively and set the pkpassUrl accordingly.
  • Improvements

    • Improved logic for opening links within the QR code modal.
  • Bug Fixes

    • Fixed issues related to handling response errors in the QR code modal.

@thorkellmani thorkellmani requested a review from a team as a code owner May 28, 2024 11:16
Copy link
Contributor

coderabbitai bot commented May 28, 2024

Walkthrough

The changes in PkPass.tsx primarily involve reordering and adding imports, modifying the logic for opening a link, and updating the getLink function to handle response errors and set the pkpassUrl accordingly. This refactor aims to improve code organization and error handling within the component.

Changes

Files Change Summary
.../service-portal/licenses/src/components/QRCodeModal/PkPass.tsx Reordered imports, added new imports, adjusted link opening logic, and updated getLink function for error handling and setting pkpassUrl.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant PkPassComponent
    participant API
    participant FeatureFlagClient

    User->>PkPassComponent: Open QRCode Modal
    PkPassComponent->>FeatureFlagClient: Check Feature Flags
    FeatureFlagClient-->>PkPassComponent: Return Feature Flags
    PkPassComponent->>API: Request PKPass Link
    API-->>PkPassComponent: Return Link or Error
    PkPassComponent-->>User: Display QRCode or Error Message
Loading

Tip

Early Access Features
  • gpt-4o model for chat

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 as 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 full the 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

Outside diff range and nitpick comments (2)
libs/service-portal/licenses/src/components/QRCodeModal/PkPass.tsx (2)

Line range hint 48-48: The useEffect hook does not specify all of its dependencies: featureFlagClient.getValue.

Consider adding featureFlagClient.getValue to the dependency array of the useEffect to adhere to best practices and avoid potential bugs in reactivity.


Line range hint 51-51: Avoid using template literals if interpolation and special-character handling are not needed.

Consider replacing the template literal with a regular string for the feature flag key to improve performance slightly.

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between d2ce8b8 and 09e4ff8.
Files selected for processing (1)
  • libs/service-portal/licenses/src/components/QRCodeModal/PkPass.tsx (2 hunks)
Additional Context Used
Biome (4)
libs/service-portal/licenses/src/components/QRCodeModal/PkPass.tsx (4)

51-51: Do not use template literals if interpolation and special-character handling are not needed.


4-8: Some named imports are only used as types.


13-14: All these imports are only used as types.


48-48: This hook does not specify all of its dependencies: featureFlagClient.getValue

Path-based Instructions (1)
libs/service-portal/licenses/src/components/QRCodeModal/PkPass.tsx (1)

Pattern libs/**/*: "Confirm that the code adheres to the following:

  • Reusability of components and hooks across different NextJS apps.
  • TypeScript usage for defining props and exporting types.
  • Effective tree-shaking and bundling practices."
Additional comments not posted (1)
libs/service-portal/licenses/src/components/QRCodeModal/PkPass.tsx (1)

1-1: Ensure the new useMutation import is utilized effectively.

@thorkellmani thorkellmani added the automerge Merge this PR as soon as all checks pass label May 28, 2024
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

Outside diff range and nitpick comments (1)
libs/service-portal/licenses/src/components/QRCodeModal/PkPass.tsx (1)

Line range hint 48-48: Ensure all dependencies are specified in the useEffect hook.

- useEffect(() => {
+ useEffect(() => {
+   // Added missing dependency
+ }, [featureFlagClient.getValue])
Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 09e4ff8 and 4ad72d1.
Files selected for processing (1)
  • libs/service-portal/licenses/src/components/QRCodeModal/PkPass.tsx (2 hunks)
Additional Context Used
Biome (5)
libs/service-portal/licenses/src/components/QRCodeModal/PkPass.tsx (5)

51-51: Do not use template literals if interpolation and special-character handling are not needed.


4-8: Some named imports are only used as types.


13-14: All these imports are only used as types.


48-48: This hook does not specify all of its dependencies: featureFlagClient.getValue


78-78: This hook does not specify all of its dependencies: handleError

Path-based Instructions (1)
libs/service-portal/licenses/src/components/QRCodeModal/PkPass.tsx (1)

Pattern libs/**/*: "Confirm that the code adheres to the following:

  • Reusability of components and hooks across different NextJS apps.
  • TypeScript usage for defining props and exporting types.
  • Effective tree-shaking and bundling practices."

@datadog-island-is
Copy link

Datadog Report

All test runs 1e2b4bc 🔗

9 Total Test Services: 0 Failed, 9 Passed
⬆️ Test Sessions change in coverage: 1 increased (+0.02%), 19 no change

Test Services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
api 0 0 0 4 0 3.84s 1 no change Link
application-system-api 0 0 0 111 2 2m 48.31s 1 no change Link
application-template-api-modules 0 0 0 109 0 2m 32.92s 1 increased (+0.02%) Link
application-ui-shell 0 0 0 74 0 1m 9.66s 1 no change Link
clients-regulations 0 0 0 1 0 10.73s 1 no change Link
download-service 0 0 0 1 0 22.52s 1 no change Link
portals-admin-regulations-admin 0 0 0 24 0 15.34s 1 no change Link
regulations 0 0 0 1 0 6.08s 1 no change Link
web 0 0 0 84 0 30.29s 1 no change Link

Copy link

codecov bot commented May 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.13%. Comparing base (07f01fa) to head (340739a).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #14969   +/-   ##
=======================================
  Coverage   37.13%   37.13%           
=======================================
  Files        6373     6373           
  Lines      129703   129703           
  Branches    36999    36999           
=======================================
  Hits        48161    48161           
  Misses      81542    81542           
Flag Coverage Δ
api 3.46% <ø> (ø)
application-system-api 41.96% <ø> (ø)
application-template-api-modules 24.32% <ø> (+0.01%) ⬆️
application-ui-shell 21.72% <ø> (ø)
clients-regulations 41.81% <ø> (ø)
portals-admin-regulations-admin 2.06% <ø> (ø)
regulations 16.78% <ø> (ø)
web 1.91% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 07f01fa...340739a. Read the comment docs.

@kodiakhq kodiakhq bot merged commit eb1b5bf into main May 28, 2024
55 checks passed
@kodiakhq kodiakhq bot deleted the fix/pkpass-async-fix branch May 28, 2024 15:59
thorkellmani added a commit that referenced this pull request May 29, 2024
* fix:init

* fix:try catch

---------

Co-authored-by: Þorkell Máni Þorkelsson <[email protected]>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
thorkellmani added a commit that referenced this pull request May 29, 2024
* fix:init

* fix:try catch

---------

Co-authored-by: Þorkell Máni Þorkelsson <[email protected]>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants