Skip to content

Cm/desktop location workflow#71362

Merged
carlosmiceli merged 20 commits into
mainfrom
cm/desktopLocation-workflow
Oct 16, 2025
Merged

Cm/desktop location workflow#71362
carlosmiceli merged 20 commits into
mainfrom
cm/desktopLocation-workflow

Conversation

@carlosmiceli

Copy link
Copy Markdown
Contributor

Explanation of Change

Fixed Issues

$
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I verified there are no new alerts related to the canBeMissing param for useOnyx
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@carlosmiceli carlosmiceli requested a review from a team as a code owner September 26, 2025 05:20
@melvin-bot

melvin-bot Bot commented Sep 26, 2025

Copy link
Copy Markdown

Hey, I noticed you changed some webpack configuration files. This can break production builds. Did you remember to run a production build locally to verify they still work?

@melvin-bot melvin-bot Bot requested review from lakchote and removed request for a team September 26, 2025 05:20
@melvin-bot

melvin-bot Bot commented Sep 26, 2025

Copy link
Copy Markdown

@lakchote Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@carlosmiceli carlosmiceli requested review from AndrewGable and removed request for lakchote September 26, 2025 05:21
if (typeof window !== 'undefined' && window.electron?.invoke) {
window.electron
.invoke('check-location-permission')
.then((permissionStatus: unknown) => {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

PERF-6

In useCallback, useMemo, and similar hooks (including promises), specify individual properties as dependencies instead of passing entire objects. The then callback is capturing the entire permissionStatus parameter but only using it as a string conversion.

Consider extracting the string conversion earlier or being more specific about what properties are needed:

window.electron
    .invoke('check-location-permission')
    .then((permissionStatus: string) => {
        if (permissionStatus === 'denied') {
            error(makeError(GeolocationErrorCode.PERMISSION_DENIED, 'Location access denied. Enable location permissions in system settings.'));
            return;
        }
        
        doGeoRequest();
    })

Comment thread desktop/main.ts Outdated

ipcMain.handle(ELECTRON_EVENTS.CHECK_LOCATION_PERMISSION, () => {
try {
const {getAuthStatus} = require('node-mac-permissions') as {getAuthStatus: (authType: AuthType) => PermissionType | 'not determined'};

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

PERF-4

Objects and functions passed as props should be properly memoized or simplified to prevent unnecessary re-renders. The require call creates a new object reference on each function execution.

Consider moving the require statement outside the handler to avoid creating new objects on each invocation:

let nodePermissions: {getAuthStatus: (authType: AuthType) => PermissionType | 'not determined'} | null = null;

try {
    nodePermissions = require('node-mac-permissions');
} catch {
    // Module not available
}

ipcMain.handle(ELECTRON_EVENTS.CHECK_LOCATION_PERMISSION, () => {
    try {
        if (!nodePermissions?.getAuthStatus || typeof nodePermissions.getAuthStatus !== 'function') {
            log.warn('node-mac-permissions not available or invalid, defaulting to denied');
            return Promise.resolve('denied');
        }

        const status = nodePermissions.getAuthStatus('location');
        // ... rest of the logic
    } catch (error) {
        log.warn('Error checking permissions:', (error as Error)?.message);
        return Promise.resolve('denied');
    }
});

@carlosmiceli

Copy link
Copy Markdown
Contributor Author

@AndrewGable to confirm, I should run the adhoc build on this PR now, right?

@github-actions

Copy link
Copy Markdown
Contributor

🚧 @carlosmiceli has triggered a test Expensify/App build. You can view the workflow run here.

@github-actions

This comment has been minimized.

@github-actions

Copy link
Copy Markdown
Contributor

🚧 @AndrewGable has triggered a test Expensify/App build. You can view the workflow run here.

@github-actions

Copy link
Copy Markdown
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪
Built from App PR #71362.

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/71362/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/71362/index.html
Android iOS
Desktop 💻 Web 🕸️
❌ FAILED ❌ https://71362.pr-testing.expensify.com
The QR code can't be generated, because the Desktop build failed Web

👀 View the workflow run that generated this build 👀

@github-actions

github-actions Bot commented Oct 1, 2025

Copy link
Copy Markdown
Contributor

🚧 @carlosmiceli has triggered a test Expensify/App build. You can view the workflow run here.

@github-actions

github-actions Bot commented Oct 1, 2025

Copy link
Copy Markdown
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪
Built from App PR #71362.

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/71362/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/71362/index.html
Android iOS
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/71362/NewExpensify.dmg https://71362.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@carlosmiceli

Copy link
Copy Markdown
Contributor Author

Closing now that adhoc build worked.

- Add node-mac-permissions as optional dependency for system-level permission checking
- Add node-gyp as optional dependency for native module compilation
- These dependencies enable checking macOS location permissions before geolocation requests
- Add NSLocationWhenInUseUsageDescription and NSLocationUsageDescription
- These descriptions are required by macOS App Store for location access
- Provides clear explanation of why the app needs location permissions
- Add com.apple.security.location entitlement to allow location access
- Required for the app to access system-level location services
- Enables proper integration with macOS permission system
- Add CHECK_LOCATION_PERMISSION event to ELECTRON_EVENTS
- Add event to context bridge whitelist for secure IPC communication
- Enables renderer process to request location permission status from main process
- Add IPC handler that uses node-mac-permissions to check system-level location permissions
- Maps macOS permission states to web-compatible permission states (granted/denied/prompt)
- Includes proper error handling and fallback to denied when module is unavailable
- Bridges native macOS permission APIs with web geolocation API
…ecking

- Implement getCurrentPosition for desktop that checks system permissions before geolocation
- Uses IPC to check macOS location permissions via main process
- Provides immediate feedback when permissions are denied instead of 30-second timeout
- Falls back to direct geolocation if IPC is unavailable
- Improves user experience by preventing long loading states on permission denial
- Define AuthType and PermissionType interfaces for node-mac-permissions module
- Provides type safety when using native macOS permission APIs
- Ensures proper typing for location permission checking functionality
- Import optionalDependencies from desktop package.json
- Add optional dependencies to webpack externals configuration
- Ensures node-mac-permissions is properly bundled and available at runtime
- Prevents webpack from trying to bundle native modules
…ilds

- Exclude node-mac-permissions from Android, iOS, and web platforms
- Prevents build failures on platforms where the native module is not available
- Ensures the module is only included in macOS desktop builds where it's needed
@carlosmiceli carlosmiceli reopened this Oct 13, 2025
@carlosmiceli carlosmiceli force-pushed the cm/desktopLocation-workflow branch from ad99e38 to b51ef69 Compare October 13, 2025 17:47
@github-actions

Copy link
Copy Markdown
Contributor

🚧 @carlosmiceli has triggered a test Expensify/App build. You can view the workflow run here.

@github-actions

Copy link
Copy Markdown
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪
Built from App PR #71362.

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/71362/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/71362/index.html
Android iOS
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/71362/NewExpensify.dmg https://71362.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@carlosmiceli carlosmiceli merged commit b66a79c into main Oct 16, 2025
71 of 73 checks passed
@carlosmiceli carlosmiceli deleted the cm/desktopLocation-workflow branch October 16, 2025 22:35
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