Setting up StoreKit environment with configuration file in Xcode 12

sercand commented 4 years ago

Is your feature request related to a problem? Please describe. Testing IAP flow is impossible with current Detox. Another issue we face is we may not receive the IAP product prices during the test which causes flakiness.

Describe the solution you'd like Apple introduced StoreKit Testing on the latest iOS 14 and Xcode 12. By adding a Configuration.storekit file and selecting it on the Run section of the scheme, we can provide the IAP list. Although using StoreKit configuration fixes the not connecting to AppStore on the Xcode run, it does not affect detox test run.

I don't know if providing complex StoreKit scenarios is possible at all but allowing passing a StoreKit Configuration file to tests is a huge improvement to the current situation.

sercand commented 4 years ago

After digging in StoreKit configuration, I found a workaround to provide StoreKit configuration during the test.

function findId(systemPath: string) {
  return new Promise<string>((resolve, reject) => {
    glob(
      path.join(systemPath, "/**/Documents/Persistence/storeSystem.db"),
      (err, files) => {
        if (err || !files || files.length === 0) {
          return reject(err);
        }
        const ff = files[0].replace(systemPath, "");
        const regex = /\/?([a-zA-Z0-9-]+)\//;
        resolve(regex.exec(ff)[1]);
      }
    );
  });
}

export async function setupStoreKitConfiguration(
  configFile: string,
  bundleId: string
) {
  const systemPath = path.join(
    os.homedir(),
    "Library/Developer/CoreSimulator/Devices/",
    device.id,
    "data/Containers/Data/System"
  );
  const systemId = await findId(systemPath);
  const dataPath = path.join(
    systemPath,
    systemId,
    "Documents/Persistence/Octane/",
    bundleId
  );
  fs.mkdirSync(dataPath, { recursive: true });
  fs.copyFileSync(configFile, path.join(dataPath, "Configuration.storekit"));
}

// USAGE
await setupStoreKitConfiguration("path/to/Configuration.storekit", "com.example.app");
await device.launchApp({});