Fix Sentry CLI and plist compatibility

sunnylqm · sunnylqm · commit 656539f01fc1 · 2026-05-21T17:55:33.000+08:00
diff --git a/src/bundle-runner.ts b/src/bundle-runner.ts
@@ -557,6 +557,51 @@ export async function copyDebugidForSentry(
   fs.removeSync(path.join(outputFolder, `${bundleName}.txt.map`));
 }
 
+export function buildSentrySourcemapsUploadArgs(
+  sentryCliPath: string,
+  bundleName: string,
+  outputFolder: string,
+  version: string,
+  useStandaloneSourcemapsCommand = true,
+): string[] {
+  const uploadArgs = [
+    '--strip-prefix',
+    path.join(process.cwd(), outputFolder),
+    path.join(outputFolder, bundleName),
+    path.join(outputFolder, `${bundleName}.map`),
+  ];
+
+  if (!useStandaloneSourcemapsCommand) {
+    return [
+      sentryCliPath,
+      'releases',
+      'files',
+      version,
+      'upload-sourcemaps',
+      ...uploadArgs,
+    ];
+  }
+
+  return [
+    sentryCliPath,
+    'sourcemaps',
+    'upload',
+    '--release',
+    version,
+    ...uploadArgs,
+  ];
+}
+
+function supportsStandaloneSentrySourcemapsUpload(sentryCliPath: string) {
+  const result = spawnJavaScriptSync(
+    [sentryCliPath, 'sourcemaps', 'upload', '--help'],
+    {
+      stdio: 'ignore',
+    },
+  );
+  return !result.error && result.status === 0;
+}
+
 export async function uploadSourcemapForSentry(
   bundleName: string,
   outputFolder: string,
@@ -595,17 +640,13 @@ export async function uploadSourcemapForSentry(
   console.log(t('uploadingSourcemap'));
   assertSuccessfulSyncProcess(
     spawnJavaScriptSync(
-      [
+      buildSentrySourcemapsUploadArgs(
         sentryCliPath,
-        'releases',
-        'files',
+        bundleName,
+        outputFolder,
         version,
-        'upload-sourcemaps',
-        '--strip-prefix',
-        path.join(process.cwd(), outputFolder),
-        path.join(outputFolder, bundleName),
-        path.join(outputFolder, `${bundleName}.map`),
-      ],
+        supportsStandaloneSentrySourcemapsUpload(sentryCliPath),
+      ),
       {
         stdio: 'inherit',
       },
diff --git a/src/utils/app-info-parser/ipa.ts b/src/utils/app-info-parser/ipa.ts
@@ -1,4 +1,3 @@
-const parsePlist = require('plist').parse;
 const parseBplist = require('bplist-parser').parseBuffer;
 const cgbiToPng = require('cgbi-to-png');
 
@@ -8,57 +7,77 @@ import { Zip } from './zip';
 const PlistName = /payload\/[^/]+?.app\/info.plist$/i;
 const ProvisionName = /payload\/.+?\.app\/embedded.mobileprovision/;
 
-export class IpaParser extends Zip {
-  parse(): Promise<any> {
-    return new Promise((resolve, reject) => {
-      this.getEntries([PlistName, ProvisionName])
-        .then((buffers: any) => {
-          if (!buffers[PlistName as any]) {
-            throw new Error("Info.plist can't be found.");
-          }
-          const plistInfo = this._parsePlist(buffers[PlistName as any]);
-          const provisionInfo = this._parseProvision(
-            buffers[ProvisionName as any],
-          );
-          plistInfo.mobileProvision = provisionInfo;
+type ParsePlist = (content: string) => Record<string, any>;
+
+let parsePlistPromise: Promise<ParsePlist> | undefined;
 
-          const iconRegex = new RegExp(
-            findIpaIconPath(plistInfo).toLowerCase(),
-          );
-          this.getEntry(iconRegex)
-            .then((iconBuffer: any) => {
-              try {
-                plistInfo.icon = iconBuffer
-                  ? getBase64FromBuffer(cgbiToPng.revert(iconBuffer))
-                  : null;
-              } catch (err) {
-                if (isBrowser()) {
-                  plistInfo.icon = iconBuffer
-                    ? getBase64FromBuffer(
-                        window.btoa(String.fromCharCode(...iconBuffer)),
-                      )
-                    : null;
-                } else {
-                  plistInfo.icon = null;
-                  console.warn('[Warning] failed to parse icon: ', err);
-                }
-              }
-              resolve(plistInfo);
-            })
-            .catch((e: any) => {
-              reject(e);
-            });
-        })
-        .catch((e: any) => {
-          reject(e);
-        });
+function loadParsePlist(): Promise<ParsePlist> {
+  if (!parsePlistPromise) {
+    parsePlistPromise = Promise.resolve().then(async () => {
+      try {
+        return require('plist').parse as ParsePlist;
+      } catch (requireError) {
+        const importModule = new Function(
+          'specifier',
+          'return import(specifier)',
+        ) as (specifier: string) => Promise<{
+          parse?: ParsePlist;
+          default?: { parse?: ParsePlist };
+        }>;
+        const plistModule = await importModule('plist');
+        const parsePlist = plistModule.parse ?? plistModule.default?.parse;
+        if (!parsePlist) {
+          throw requireError;
+        }
+        return parsePlist;
+      }
     });
   }
+  return parsePlistPromise;
+}
+
+export class IpaParser extends Zip {
+  async parse(): Promise<any> {
+    const parsePlist = await loadParsePlist();
+    const buffers = await this.getEntries([PlistName, ProvisionName]);
+    if (!buffers[PlistName as any]) {
+      throw new Error("Info.plist can't be found.");
+    }
+    const plistInfo = this._parsePlist(
+      buffers[PlistName as any] as Buffer,
+      parsePlist,
+    );
+    const provisionInfo = this._parseProvision(
+      buffers[ProvisionName as any] as Buffer | undefined,
+      parsePlist,
+    );
+    plistInfo.mobileProvision = provisionInfo;
+
+    const iconRegex = new RegExp(findIpaIconPath(plistInfo).toLowerCase());
+    const iconBuffer = await this.getEntry(iconRegex);
+    try {
+      plistInfo.icon = iconBuffer
+        ? getBase64FromBuffer(cgbiToPng.revert(iconBuffer))
+        : null;
+    } catch (err) {
+      if (isBrowser()) {
+        plistInfo.icon = iconBuffer
+          ? getBase64FromBuffer(
+              window.btoa(String.fromCharCode(...(iconBuffer as Buffer))),
+            )
+          : null;
+      } else {
+        plistInfo.icon = null;
+        console.warn('[Warning] failed to parse icon: ', err);
+      }
+    }
+    return plistInfo;
+  }
   /**
    * Parse plist
    * @param {Buffer} buffer // plist file's buffer
    */
-  private _parsePlist(buffer: Buffer) {
+  private _parsePlist(buffer: Buffer, parsePlist: ParsePlist) {
     let result: any;
     const bufferType = buffer[0];
     if (bufferType === 60 || bufferType === 239) {
@@ -74,7 +93,7 @@ export class IpaParser extends Zip {
    * parse provision
    * @param {Buffer} buffer // provision file's buffer
    */
-  private _parseProvision(buffer: Buffer | undefined) {
+  private _parseProvision(buffer: Buffer | undefined, parsePlist: ParsePlist) {
     let info: Record<string, any> = {};
     if (buffer) {
       let content = buffer.toString('utf-8');
diff --git a/tests/app-info-zip.test.ts b/tests/app-info-zip.test.ts
@@ -3,6 +3,7 @@ import fs from 'fs';
 import os from 'os';
 import path from 'path';
 import { ZipFile as YazlZipFile } from 'yazl';
+import { IpaParser } from '../src/utils/app-info-parser/ipa';
 import { Zip } from '../src/utils/app-info-parser/zip';
 
 function mkTempDir(prefix: string): string {
@@ -11,12 +12,15 @@ function mkTempDir(prefix: string): string {
 
 async function writeZip(
   zipPath: string,
-  entries: Record<string, string>,
+  entries: Record<string, string | Buffer>,
 ): Promise<void> {
   await new Promise<void>((resolve, reject) => {
     const zipFile = new YazlZipFile();
     for (const [name, content] of Object.entries(entries)) {
-      zipFile.addBuffer(Buffer.from(content), name);
+      zipFile.addBuffer(
+        Buffer.isBuffer(content) ? content : Buffer.from(content),
+        name,
+      );
     }
     zipFile.outputStream.on('error', reject);
     zipFile.outputStream.pipe(fs.createWriteStream(zipPath)).on('close', () => {
@@ -58,4 +62,35 @@ describe('app-info-parser Zip', () => {
     );
     expect((buffers['res/icon.png'] as Buffer).toString()).toBe('icon');
   });
+
+  test('parses ipa plist with current plist package exports', async () => {
+    const ipaPath = path.join(tempRoot, 'app.ipa');
+    await writeZip(ipaPath, {
+      'Payload/Test.app/Info.plist': `<?xml version="1.0" encoding="UTF-8"?>
+<plist version="1.0">
+<dict>
+  <key>CFBundleIdentifier</key>
+  <string>cn.reactnative.test</string>
+  <key>CFBundleShortVersionString</key>
+  <string>1.2.3</string>
+</dict>
+</plist>`,
+      'Payload/Test.app/embedded.mobileprovision': `prefix
+<?xml version="1.0" encoding="UTF-8"?>
+<plist version="1.0">
+<dict>
+  <key>TeamName</key>
+  <string>ReactNativeCN</string>
+</dict>
+</plist>
+suffix`,
+    });
+
+    const info = await new IpaParser(ipaPath).parse();
+
+    expect(info.CFBundleIdentifier).toBe('cn.reactnative.test');
+    expect(info.CFBundleShortVersionString).toBe('1.2.3');
+    expect(info.mobileProvision.TeamName).toBe('ReactNativeCN');
+    expect(info.icon).toBe(null);
+  });
 });
diff --git a/tests/bundle-runner.test.ts b/tests/bundle-runner.test.ts
@@ -3,6 +3,7 @@ import fs from 'fs';
 import os from 'os';
 import path from 'path';
 import {
+  buildSentrySourcemapsUploadArgs,
   hasProjectDependency,
   resolveExpoCli,
   resolveHermesCommand,
@@ -203,3 +204,50 @@ describe('resolveHermesCommand', () => {
     expect(resolveHermesCommand(tempRoot)).toBe(hermesCommand);
   });
 });
+
+describe('buildSentrySourcemapsUploadArgs', () => {
+  test('uses the Sentry sourcemaps command supported by current CLI versions', () => {
+    const args = buildSentrySourcemapsUploadArgs(
+      '/bin/sentry-cli',
+      'index.android.bundle',
+      'build/intermedia',
+      '1.0.0',
+    );
+
+    expect(args).toEqual([
+      '/bin/sentry-cli',
+      'sourcemaps',
+      'upload',
+      '--release',
+      '1.0.0',
+      '--strip-prefix',
+      path.join(process.cwd(), 'build/intermedia'),
+      path.join('build/intermedia', 'index.android.bundle'),
+      path.join('build/intermedia', 'index.android.bundle.map'),
+    ]);
+    expect(args).not.toContain('files');
+    expect(args).not.toContain('upload-sourcemaps');
+  });
+
+  test('keeps the legacy releases files command for old Sentry CLI versions', () => {
+    const args = buildSentrySourcemapsUploadArgs(
+      '/bin/sentry-cli',
+      'index.android.bundle',
+      'build/intermedia',
+      '1.0.0',
+      false,
+    );
+
+    expect(args).toEqual([
+      '/bin/sentry-cli',
+      'releases',
+      'files',
+      '1.0.0',
+      'upload-sourcemaps',
+      '--strip-prefix',
+      path.join(process.cwd(), 'build/intermedia'),
+      path.join('build/intermedia', 'index.android.bundle'),
+      path.join('build/intermedia', 'index.android.bundle.map'),
+    ]);
+  });
+});
