Is Background Processing for Expo Possible? #187

AhmadHoranieh · 2021-12-01T10:49:20Z

I am interested in implementing a background listener for steps and active calories burnt as it provides a better user experience in my Expo application (preferably without ejection). Is it possible?

jhbarnett · 2022-03-24T18:00:01Z

Attempting to do the same with the config plugin below. Will report back whether I'm successful or not.

const {
  withAppDelegate,
  withEntitlementsPlist
} = require('@expo/config-plugins')
const {
  mergeContents
} = require('@expo/config-plugins/build/utils/generateCode')

const RN_HEALTH_IMPORT = '#import "RCTAppleHealthKit.h"'

const RN_HEALTH_INITIALIZE =
  '[[RCTAppleHealthKit new] initializeBackgroundObservers:bridge];'

function addImport(src) {
  const newSrc = [RN_HEALTH_IMPORT]
  return mergeContents({
    tag: 'healthkit-import',
    src,
    newSrc: newSrc.join('\n'),
    anchor: /#import "AppDelegate\.h"/,
    offset: 1,
    comment: '//'
  })
}

function addInit(src) {
  const newSrc = [RN_HEALTH_INITIALIZE]
  return mergeContents({
    tag: 'healthkit-init',
    src,
    newSrc: newSrc.join('\n'),
    anchor: /UIViewController/,
    offset: -1,
    comment: '//'
  })
}

const withHealthKitObservers = (config, options = {}) => {
  config = withAppDelegate(config, (config) => {
    if (config.modResults.language === 'objc') {
      config.modResults.contents = addImport(
        config.modResults.contents
      ).contents
      config.modResults.contents = addInit(config.modResults.contents).contents
    } else {
      WarningAggregator.addWarningIOS(
        'withHealthKitObservers',
        'Swift AppDelegate files are not supported yet.'
      )
    }
    return config
  })

  config = withEntitlementsPlist(config, (config) => {
    config.modResults[
      'com.apple.developer.healthkit.background-delivery'
    ] = true

    return config
  })

  return config
}

module.exports = withHealthKitObservers

brianfoody · 2022-05-12T05:55:49Z

Any luck @jhbarnett jhbarnett??

jhbarnett · 2022-05-12T14:12:34Z

Yeah @brianfoody it's working 90% great. We're still trying to pinpoint an issue with background delivery when the app is in a killed state, but near as we can tell this plugin is making all the right mods.

jhbarnett · 2022-05-12T14:23:33Z

For anyone else that stumbles upon this, here are the steps to integrate in your own project. I'll explore a PR here once our app has shipped.

jclif · 2022-11-17T00:59:27Z

@jhbarnett How did everything work out in the end?

jclif · 2023-02-06T23:07:33Z

@brianfoody @AhmadHoranieh Y'all had any success with this?

chunghn · 2023-05-12T08:51:16Z

Attempting to do the same with the config plugin below. Will report back whether I'm successful or not.

const {
  withAppDelegate,
  withEntitlementsPlist
} = require('@expo/config-plugins')
const {
  mergeContents
} = require('@expo/config-plugins/build/utils/generateCode')

const RN_HEALTH_IMPORT = '#import "RCTAppleHealthKit.h"'

const RN_HEALTH_INITIALIZE =
  '[[RCTAppleHealthKit new] initializeBackgroundObservers:bridge];'

function addImport(src) {
  const newSrc = [RN_HEALTH_IMPORT]
  return mergeContents({
    tag: 'healthkit-import',
    src,
    newSrc: newSrc.join('\n'),
    anchor: /#import "AppDelegate\.h"/,
    offset: 1,
    comment: '//'
  })
}

function addInit(src) {
  const newSrc = [RN_HEALTH_INITIALIZE]
  return mergeContents({
    tag: 'healthkit-init',
    src,
    newSrc: newSrc.join('\n'),
    anchor: /UIViewController/,
    offset: -1,
    comment: '//'
  })
}

const withHealthKitObservers = (config, options = {}) => {
  config = withAppDelegate(config, (config) => {
    if (config.modResults.language === 'objc') {
      config.modResults.contents = addImport(
        config.modResults.contents
      ).contents
      config.modResults.contents = addInit(config.modResults.contents).contents
    } else {
      WarningAggregator.addWarningIOS(
        'withHealthKitObservers',
        'Swift AppDelegate files are not supported yet.'
      )
    }
    return config
  })

  config = withEntitlementsPlist(config, (config) => {
    config.modResults[
      'com.apple.developer.healthkit.background-delivery'
    ] = true

    return config
  })

  return config
}

module.exports = withHealthKitObservers

For anyone who has build issue with eas build with the above config. WarningAggregator is not imported.

Just do

const {
  withAppDelegate,
  withEntitlementsPlist,
  WarningAggregator,
} = require("@expo/config-plugins")

You will be fine.

chunghn · 2023-05-15T03:58:53Z

Update: I cannot make the above code work, even I updated the AppDelegate.mm to be the same as it should be.

swellander · 2023-10-24T22:56:55Z

Has anyone had success with this?

jclif · 2023-10-25T00:13:43Z

I was able to query the health records in a location-based task, but the problem is that the health records are encrypted when the device is locked. An ideal solution would allow for a bridge to be set up within Expo that allows us to subscribe to new workouts, but I don't think there is a way to do this, currently.

samuthekid · 2024-01-04T19:17:28Z

@jclif @jhbarnett Any success with this? It would be great to be able to fetch the HK data in the background :)

samuthekid · 2024-01-05T13:59:05Z

const {
  withAppDelegate,
  withEntitlementsPlist,
  withInfoPlist,
} = require('@expo/config-plugins')
const {
  mergeContents
} = require('@expo/config-plugins/build/utils/generateCode')

const RN_HEALTH_IMPORT = '#import "RCTAppleHealthKit.h"'
const RN_HEALTH_BRIDGE = '  RCTBridge *bridge = [[RCTBridge alloc] initWithDelegate:self launchOptions:launchOptions];'
const RN_HEALTH_INITIALIZE = '  [[RCTAppleHealthKit new] initializeBackgroundObservers:bridge];'

const HEALTH_SHARE = 'Allow $(PRODUCT_NAME) to check health info'
const HEALTH_UPDATE = 'Allow $(PRODUCT_NAME) to update health info'
const HEALTH_CLINIC_SHARE = 'Allow $(PRODUCT_NAME) to check health clinical info'

function addImport(src) {
  const newSrc = [RN_HEALTH_IMPORT]
  return mergeContents({
    tag: 'healthkit-import',
    src,
    newSrc: newSrc.join('\n'),
    anchor: /#import "AppDelegate\.h"/,
    offset: 1,
    comment: '//'
  })
}

function addInit(src) {
  const newSrc = [RN_HEALTH_BRIDGE, RN_HEALTH_INITIALIZE]
  return mergeContents({
    tag: 'healthkit-init',
    src,
    newSrc: newSrc.join('\n'),
    anchor: /self.initialProps = @{};/,
    offset: 1,
    comment: '  //'
  })
}

const withHealthKit = (
  config,
  { healthSharePermission, healthUpdatePermission, isClinicalDataEnabled, healthClinicalDescription } = {},
) => {
  // Add import
  config = withAppDelegate(config, (config) => {
    if (config.modResults.language === 'objcpp') {
      config.modResults.contents = addImport(config.modResults.contents).contents
      config.modResults.contents = addInit(config.modResults.contents).contents
    }
    return config
  })

  // Add permissions
  config = withInfoPlist(config, (config) => {
    config.modResults.NSHealthShareUsageDescription =
      healthSharePermission ||
      config.modResults.NSHealthShareUsageDescription ||
      HEALTH_SHARE
    config.modResults.NSHealthUpdateUsageDescription =
      healthUpdatePermission ||
      config.modResults.NSHealthUpdateUsageDescription ||
      HEALTH_UPDATE
    isClinicalDataEnabled ?
      config.modResults.NSHealthClinicalHealthRecordsShareUsageDescription =
        healthClinicalDescription ||
        config.modResults.NSHealthClinicalHealthRecordsShareUsageDescription ||
        HEALTH_CLINIC_SHARE :
      null

    return config
  })

  // Add entitlements. These are automatically synced when using EAS build for production apps.
  config = withEntitlementsPlist(config, (config) => {
    config.modResults['com.apple.developer.healthkit'] = true
    config.modResults['com.apple.developer.healthkit.background-delivery'] = true
    if (
      !Array.isArray(config.modResults['com.apple.developer.healthkit.access'])
    ) {
      config.modResults['com.apple.developer.healthkit.access'] = []
    }

    if (isClinicalDataEnabled) {
      config.modResults['com.apple.developer.healthkit.access'].push(
        'health-records',
      )

      // Remove duplicates
      config.modResults['com.apple.developer.healthkit.access'] = [
        ...new Set(config.modResults['com.apple.developer.healthkit.access']),
      ]
    }

    return config
  })

  return config
}
module.exports = withHealthKit

which modifies the AppDelegate.mm to the following:

#import "AppDelegate.h"
// @generated begin healthkit-import - expo prebuild (DO NOT MODIFY) sync-283e92dde8b719d45e241f992dc4e0cceb751e1e
#import "RCTAppleHealthKit.h"
// @generated end healthkit-import

#import <React/RCTBundleURLProvider.h>
#import <React/RCTLinkingManager.h>

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
  self.moduleName = @"main";

  // You can add your custom initial props in the dictionary below.
  // They will be passed down to the ViewController used by React Native.
  self.initialProps = @{};
  // @generated begin healthkit-init - expo prebuild (DO NOT MODIFY) sync-f4def85acdf20e650ea4209ec70a05de7e0ebb70
  RCTBridge *bridge = [[RCTBridge alloc] initWithDelegate:self launchOptions:launchOptions];
  [[RCTAppleHealthKit new] initializeBackgroundObservers:bridge];
  // @generated end healthkit-init

  return [super application:application didFinishLaunchingWithOptions:launchOptions];
}

I'm still testing if this works, but I think I'm in the right path!
PS: I'm using the latest version of this lib and Expo 49

rickyhonline · 2024-01-17T03:46:46Z

@samuthekid any success with fetching HK data in background?

samuthekid · 2024-01-22T12:07:43Z

@rickyhonline I didn't leave any feedback, but yeah! It works very well!

Right now, I'm using patch-package for this, so here's my patch:

diff --git a/node_modules/react-native-health/app.plugin.js b/node_modules/react-native-health/app.plugin.js
index 8dbb66a..b003319 100644
--- a/node_modules/react-native-health/app.plugin.js
+++ b/node_modules/react-native-health/app.plugin.js
@@ -1,13 +1,57 @@
-const { withEntitlementsPlist, withInfoPlist } = require('@expo/config-plugins')
+const {
+  withAppDelegate,
+  withEntitlementsPlist,
+  withInfoPlist,
+} = require('@expo/config-plugins')
+const {
+  mergeContents
+} = require('@expo/config-plugins/build/utils/generateCode')
+
+const RN_HEALTH_IMPORT = '#import "RCTAppleHealthKit.h"'
+const RN_HEALTH_BRIDGE = '  RCTBridge *bridge = [[RCTBridge alloc] initWithDelegate:self launchOptions:launchOptions];'
+const RN_HEALTH_INITIALIZE = '  [[RCTAppleHealthKit new] initializeBackgroundObservers:bridge];'
 
 const HEALTH_SHARE = 'Allow $(PRODUCT_NAME) to check health info'
 const HEALTH_UPDATE = 'Allow $(PRODUCT_NAME) to update health info'
 const HEALTH_CLINIC_SHARE = 'Allow $(PRODUCT_NAME) to check health clinical info'
 
+function addImport(src) {
+  const newSrc = [RN_HEALTH_IMPORT]
+  return mergeContents({
+    tag: 'healthkit-import',
+    src,
+    newSrc: newSrc.join('\n'),
+    anchor: /#import "AppDelegate\.h"/,
+    offset: 1,
+    comment: '//'
+  })
+}
+
+function addInit(src) {
+  const newSrc = [RN_HEALTH_BRIDGE, RN_HEALTH_INITIALIZE]
+  return mergeContents({
+    tag: 'healthkit-init',
+    src,
+    newSrc: newSrc.join('\n'),
+    anchor: /self.initialProps = @{};/,
+    offset: 1,
+    comment: '  //'
+  })
+}
+
 const withHealthKit = (
   config,
   { healthSharePermission, healthUpdatePermission, isClinicalDataEnabled, healthClinicalDescription } = {},
 ) => {
+  // Add import
+  config = withAppDelegate(config, (config) => {
+    if (config.modResults.language === 'objcpp') {
+      config.modResults.contents = addImport(config.modResults.contents).contents
+      config.modResults.contents = addInit(config.modResults.contents).contents
+    }
+    return config
+  })
+
   // Add permissions
   config = withInfoPlist(config, (config) => {
     config.modResults.NSHealthShareUsageDescription =
@@ -31,6 +75,7 @@ const withHealthKit = (
   // Add entitlements. These are automatically synced when using EAS build for production apps.
   config = withEntitlementsPlist(config, (config) => {
     config.modResults['com.apple.developer.healthkit'] = true
+    config.modResults['com.apple.developer.healthkit.background-delivery'] = true
     if (
       !Array.isArray(config.modResults['com.apple.developer.healthkit.access'])
     ) {

which is located in the root folder like this:

samuthekid · 2024-01-22T12:13:43Z

I think the owners could make a little update with this new version of the expo plugin ;)

brandon-austin-lark · 2024-05-22T10:14:00Z

Does anyone have experience with this implementation? Does it work for your managed expo app?

garygcchiu · 2024-06-18T17:39:13Z

What's the delay like for receiving data from the background listeners? I.e. how long it takes before the callback is called and data is received

samuthekid · 2024-11-07T10:34:10Z

Does anyone have experience with this implementation? Does it work for your managed expo app?

I'm using it in a prod app and it's working great! I build my app in EAS and I don't have any problems

What's the delay like for receiving data from the background listeners? I.e. how long it takes before the callback is called and data is received

There's no delay... you just get the values when the iOS triggers a broadcast of the new values. From my tests, it usually triggers when the user unlocks the phone a couple minutes after new values have been added to the Health app

AhmadHoranieh added the bug Something isn't working label Dec 1, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Is Background Processing for Expo Possible? #187

Is Background Processing for Expo Possible? #187

AhmadHoranieh commented Dec 1, 2021

jhbarnett commented Mar 24, 2022 •

edited

Loading

brianfoody commented May 12, 2022

jhbarnett commented May 12, 2022

jhbarnett commented May 12, 2022

jclif commented Nov 17, 2022

jclif commented Feb 6, 2023

chunghn commented May 12, 2023

chunghn commented May 15, 2023

swellander commented Oct 24, 2023

jclif commented Oct 25, 2023

samuthekid commented Jan 4, 2024

samuthekid commented Jan 5, 2024 •

edited

Loading

rickyhonline commented Jan 17, 2024

samuthekid commented Jan 22, 2024 •

edited

Loading

samuthekid commented Jan 22, 2024

brandon-austin-lark commented May 22, 2024

garygcchiu commented Jun 18, 2024

samuthekid commented Nov 7, 2024

Is Background Processing for Expo Possible? #187

Is Background Processing for Expo Possible? #187

Comments

AhmadHoranieh commented Dec 1, 2021

jhbarnett commented Mar 24, 2022 • edited Loading

brianfoody commented May 12, 2022

jhbarnett commented May 12, 2022

jhbarnett commented May 12, 2022

jclif commented Nov 17, 2022

jclif commented Feb 6, 2023

chunghn commented May 12, 2023

chunghn commented May 15, 2023

swellander commented Oct 24, 2023

jclif commented Oct 25, 2023

samuthekid commented Jan 4, 2024

samuthekid commented Jan 5, 2024 • edited Loading

rickyhonline commented Jan 17, 2024

samuthekid commented Jan 22, 2024 • edited Loading

samuthekid commented Jan 22, 2024

brandon-austin-lark commented May 22, 2024

garygcchiu commented Jun 18, 2024

samuthekid commented Nov 7, 2024

jhbarnett commented Mar 24, 2022 •

edited

Loading

samuthekid commented Jan 5, 2024 •

edited

Loading

samuthekid commented Jan 22, 2024 •

edited

Loading