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(j-s): Enable opening uploaded files on iOS #17400

Merged
merged 4 commits into from
Jan 6, 2025
Merged

Conversation

oddsson
Copy link
Member

@oddsson oddsson commented Jan 3, 2025

Enable opening uploaded files on iOS

Asana

What

There is a bug in production where users cannot open uploaded files, i.e. files not generated by RVG, on iOS devices. They can do so on Android devices however and this is due to security measures taken by Apple when opening files in a new tab.

To fix this, we detect whether or not a user is using a mobile device and if so, we don't try to open the file in a new tab but in the same tab rather.

Note that the reason we open files in a new tab on desktop is that users might want to open multiple files and view them simultainiously and that does not apply on mobile devices.

Why

This is a bug.

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
    • Introduced a mobile device detection hook.
    • Enhanced file opening mechanism with mobile responsiveness.
  • Improvements
    • Added logic to open files differently based on device type.
    • Centralized file opening behavior across the application.

@oddsson oddsson requested a review from a team as a code owner January 3, 2025 13:32
Copy link
Contributor

coderabbitai bot commented Jan 3, 2025

Walkthrough

This pull request introduces a new useIsMobile hook and modifies the useFileList hook to incorporate mobile device detection. The changes improve file opening behavior by determining whether to open files in the same or a new tab based on the device type. A custom hook is created to detect mobile devices, and the file opening logic in the existing useFileList hook is updated accordingly.

Changes

File Change Summary
apps/judicial-system/web/src/utils/hooks/useFileList/index.ts Added useIsMobile hook import, created openFile function with mobile-aware URL opening logic. Modified onCompleted callbacks to use openFile.
apps/judicial-system/web/src/utils/hooks/useIsMobile/useIsMobile.ts New custom hook to detect mobile devices using navigator.userAgent.

Sequence Diagram

sequenceDiagram
    participant User
    participant Hook as useFileList
    participant MobileDetector as useIsMobile
    
    User->>Hook: Request to open file
    Hook->>MobileDetector: Check device type
    MobileDetector-->>Hook: Return mobile status
    alt Is Mobile Device
        Hook->>User: Open file in same tab
    else Is Desktop
        Hook->>User: Open file in new tab
    end
Loading

Possibly related PRs

Suggested labels

automerge

Suggested reviewers

  • thordurhhh

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.

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

codecov bot commented Jan 3, 2025

Codecov Report

Attention: Patch coverage is 75.00000% with 4 lines in your changes missing coverage. Please review.

Project coverage is 35.69%. Comparing base (c257544) to head (0a85187).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...al-system/web/src/utils/hooks/useFileList/index.ts 40.00% 3 Missing ⚠️
...tem/web/src/utils/hooks/useIsMobile/useIsMobile.ts 90.90% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #17400      +/-   ##
==========================================
+ Coverage   35.67%   35.69%   +0.02%     
==========================================
  Files        6933     6933              
  Lines      148894   148836      -58     
  Branches    42547    42536      -11     
==========================================
+ Hits        53113    53127      +14     
+ Misses      95781    95709      -72     
Flag Coverage Δ
air-discount-scheme-web 0.00% <ø> (ø)
application-api-files 61.97% <ø> (ø)
application-core 75.60% <ø> (ø)
application-system-api 38.72% <ø> (-0.01%) ⬇️
application-template-api-modules 27.68% <ø> (ø)
application-templates-accident-notification 27.60% <ø> (ø)
application-templates-car-recycling 3.12% <ø> (ø)
application-templates-criminal-record 25.82% <ø> (ø)
application-templates-driving-license 18.17% <ø> (ø)
application-templates-estate 13.67% <ø> (ø)
application-templates-example-payment 24.69% <ø> (ø)
application-templates-financial-aid 14.47% <ø> (ø)
application-templates-general-petition 23.13% <ø> (ø)
application-templates-marriage-conditions 15.21% <ø> (ø)
application-templates-mortgage-certificate 43.70% <ø> (ø)
application-templates-parental-leave 29.92% <ø> (ø)
application-types 6.48% <ø> (ø)
application-ui-components 1.22% <ø> (ø)
application-ui-shell 22.25% <ø> (ø)
clients-charge-fjs-v2 28.88% <ø> (ø)
judicial-system-web 27.81% <75.00%> (+0.05%) ⬆️
web 2.40% <ø> (ø)

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

Files with missing lines Coverage Δ
...tem/web/src/utils/hooks/useIsMobile/useIsMobile.ts 90.90% <90.90%> (ø)
...al-system/web/src/utils/hooks/useFileList/index.ts 39.13% <40.00%> (+1.92%) ⬆️

... and 6 files with indirect coverage changes


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 c257544...0a85187. Read the comment docs.

@datadog-island-is
Copy link

datadog-island-is bot commented Jan 3, 2025

Datadog Report

All test runs 174acc4 🔗

10 Total Test Services: 0 Failed, 10 Passed
⬆️ Test Sessions change in coverage: 1 increased (+0.08%), 93 no change

Test Services
This report shows up to 10 services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
air-discount-scheme-web 0 0 0 2 0 6.66s 1 no change Link
api 0 0 0 4 0 2.6s 1 no change Link
application-api-files 0 0 0 2 0 4.41s 1 no change Link
application-core 0 0 0 97 0 15.4s 1 no change Link
application-system-api 0 0 0 46 0 2m 9.07s 1 no change Link
application-template-api-modules 0 0 0 118 0 2m 3.22s 1 no change Link
application-templates-accident-notification 0 0 0 140 0 13.12s 1 no change Link
application-templates-criminal-record 0 0 0 2 0 9.77s 1 no change Link
application-templates-driving-license 0 0 0 13 0 12.75s 1 no change Link
application-templates-example-payment 0 0 0 2 0 9.84s 1 no change Link

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

🧹 Nitpick comments (2)
apps/judicial-system/web/src/utils/hooks/useIsMobile/useIsMobile.ts (1)

6-15: Explore a More Robust Mobile Detection Method
Relying solely on userAgent checks can be brittle. Consider using navigator.userAgentData (if supported) or a well-tested library for mobile detection. This reduces the risk of false positives/negatives when new devices emerge.

apps/judicial-system/web/src/utils/hooks/useFileList/index.ts (1)

28-30: Validate the Third Parameter of window.open
While 'noopener, noreferrer' is a valid "window features" string, it’s more common to separate those features with no spaces (e.g., 'noopener,noreferrer'). Ensure you’re meeting your security and feature requirements with this parameter.

-window.open(url, isMobile ? '_self' : '_blank', 'noopener, noreferrer')
+window.open(url, isMobile ? '_self' : '_blank', 'noopener,noreferrer')
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dd1b223 and dfeb617.

📒 Files selected for processing (2)
  • apps/judicial-system/web/src/utils/hooks/useFileList/index.ts (4 hunks)
  • apps/judicial-system/web/src/utils/hooks/useIsMobile/useIsMobile.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
apps/judicial-system/web/src/utils/hooks/useIsMobile/useIsMobile.ts (1)

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

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
apps/judicial-system/web/src/utils/hooks/useFileList/index.ts (1)

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

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
🔇 Additional comments (4)
apps/judicial-system/web/src/utils/hooks/useIsMobile/useIsMobile.ts (1)

20-20: Default Export Looks Good
Exporting the hook by default promotes clarity and simpler imports across the codebase.

apps/judicial-system/web/src/utils/hooks/useFileList/index.ts (3)

12-12: Importing useIsMobile
The import of useIsMobile properly centralizes the mobile detection logic, which helps ensure consistency and prevents duplication across your application.


25-25: Good Use of useIsMobile
Using a dedicated hook to detect mobile devices preserves clarity in the code, making it clear why and how the UI experience changes for mobile users.


40-40: Centralized File Opening Logic
Leveraging openFile at these lines ensures the device-aware file opening is consistently applied. This approach simplifies future maintenance or additional checks, such as logging or analytics.

Also applies to: 56-56

@oddsson oddsson requested a review from thorhildurt January 6, 2025 13:16
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

♻️ Duplicate comments (1)
apps/judicial-system/web/src/utils/hooks/useIsMobile/useIsMobile.ts (1)

8-11: ⚠️ Potential issue

Fix the SSR check condition.

The current SSR check if (!window) will throw a ReferenceError. Use typeof window === 'undefined' instead.

-      if (!window) {
+      if (typeof window === 'undefined') {
         return false
       }
🧹 Nitpick comments (3)
apps/judicial-system/web/src/utils/hooks/useIsMobile/useIsMobile.ts (3)

1-4: Add TypeScript return type annotation.

Following the coding guidelines for optimal TypeScript usage, add a return type annotation to the hook.

-const useIsMobile = () => {
+const useIsMobile = (): boolean => {

13-17: Consider using a more reliable mobile detection approach.

The current user agent-based detection might not be future-proof and can be spoofed. Consider using CSS media queries or the window.matchMedia() API for a more reliable approach.

-      const userAgent = navigator.userAgent
-      const mobileRegex =
-        /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i
-      return mobileRegex.test(userAgent)
+      return window.matchMedia('(max-width: 768px)').matches

6-20: Optimize the effect implementation.

The current implementation is good as it runs only once on mount. However, consider these improvements:

  1. Add a cleanup function to handle component unmounting
  2. Add an event listener for screen resize to handle orientation changes
   useEffect(() => {
     const checkMobile = () => {
       if (typeof window === 'undefined') return false
-      const userAgent = navigator.userAgent
-      const mobileRegex =
-        /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i
-      return mobileRegex.test(userAgent)
+      return window.matchMedia('(max-width: 768px)').matches
     }
 
+    const handleResize = () => {
+      setIsMobile(checkMobile())
+    }
+
     setIsMobile(checkMobile())
+    window.addEventListener('resize', handleResize)
+
+    return () => {
+      window.removeEventListener('resize', handleResize)
+    }
   }, [])
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dfeb617 and 9043af2.

📒 Files selected for processing (1)
  • apps/judicial-system/web/src/utils/hooks/useIsMobile/useIsMobile.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
apps/judicial-system/web/src/utils/hooks/useIsMobile/useIsMobile.ts (1)

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

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."

@oddsson oddsson added the automerge Merge this PR as soon as all checks pass label Jan 6, 2025
@kodiakhq kodiakhq bot merged commit f643adc into main Jan 6, 2025
87 checks passed
@kodiakhq kodiakhq bot deleted the j-s/fix-open-file-ios branch January 6, 2025 14:44
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