Refactor app-info-parser: migrate utility functions to TypeScript, remove deprecated utils.js, and enhance AAB and APK parsing with improved error handling and resource mapping.

Author: sunnylqm

src/utils/app-info-parser/aab.ts

@@ -1,9 +1,13 @@
-import fs from 'fs-extra';
-import path from 'path';
+import { spawn } from 'child_process';
 import os from 'os';
+import path from 'path';
+import fs from 'fs-extra';
 import { open as openZipFile } from 'yauzl';
-import { Zip } from './zip';
 import { t } from '../i18n';
+import { ResourceFinder } from './resource-finder';
+import { mapInfoResource } from './utils';
+import { ManifestParser } from './xml-parser/manifest';
+import { Zip } from './zip';
 
 export class AabParser extends Zip {
   file: string | File;
@@ -16,20 +20,40 @@ export class AabParser extends Zip {
   async extractApk(
     outputPath: string,
     {
-      includeAllSplits = true,
+      includeAllSplits,
       splits,
     }: { includeAllSplits?: boolean; splits?: string[] | null },
   ) {
-    const { exec } = require('child_process');
-    const util = require('util');
-    const execAsync = util.promisify(exec);
     const normalizedSplits = Array.isArray(splits)
       ? splits.map((item) => item.trim()).filter(Boolean)
       : [];
     const modules = includeAllSplits
       ? null
       : Array.from(new Set(['base', ...normalizedSplits]));
-    const modulesArg = modules ? ` --modules="${modules.join(',')}"` : '';
+    const modulesArgs = modules ? [`--modules=${modules.join(',')}`] : [];
+
+    const runCommand = (command: string, args: string[]) =>
+      new Promise<void>((resolve, reject) => {
+        const child = spawn(command, args, {
+          stdio: ['ignore', 'pipe', 'pipe'],
+        });
+        let stderr = '';
+        child.stderr?.on('data', (chunk) => {
+          stderr += chunk.toString();
+        });
+        child.on('error', reject);
+        child.on('close', (code) => {
+          if (code === 0) {
+            resolve();
+            return;
+          }
+          reject(
+            new Error(
+              stderr.trim() || `Command failed: ${command} (code ${code})`,
+            ),
+          );
+        });
+      });
 
     // Create a temp file for the .apks output
     const tempDir = os.tmpdir();
@@ -41,14 +65,28 @@ export class AabParser extends Zip {
       // User might need keystore to sign it properly but for simple extraction we stick to default debug key if possible or unsigned?
       // actually bundletool build-apks signs with debug key by default if no keystore provided.
 
-      let cmd = `bundletool build-apks --mode=universal --bundle="${this.file}" --output="${tempApksPath}" --overwrite${modulesArg}`;
       try {
-        await execAsync(cmd);
+        await runCommand('bundletool', [
+          'build-apks',
+          '--mode=universal',
+          `--bundle=${this.file}`,
+          `--output=${tempApksPath}`,
+          '--overwrite',
+          ...modulesArgs,
+        ]);
       } catch (e) {
         // Fallback to npx node-bundletool if bundletool is not in PATH
         // We use -y to avoid interactive prompt for installation
-        cmd = `npx -y node-bundletool build-apks --mode=universal --bundle="${this.file}" --output="${tempApksPath}" --overwrite${modulesArg}`;
-        await execAsync(cmd);
+        await runCommand('npx', [
+          '-y',
+          'node-bundletool',
+          'build-apks',
+          '--mode=universal',
+          `--bundle=${this.file}`,
+          `--output=${tempApksPath}`,
+          '--overwrite',
+          ...modulesArgs,
+        ]);
       }
 
       // 2. Extract universal.apk from the .apks (zip) file
@@ -119,7 +157,6 @@ export class AabParser extends Zip {
         const resourceBuffer = await this.getEntry(ResourceName);
         if (resourceBuffer) {
           const resourceMap = this._parseResourceMap(resourceBuffer as Buffer);
-          const { mapInfoResource } = require('./utils');
           apkInfo = mapInfoResource(apkInfo, resourceMap);
         }
       } catch (e: any) {
@@ -137,8 +174,7 @@ export class AabParser extends Zip {
    */
   private _parseManifest(buffer: Buffer) {
     try {
-      const ManifestXmlParser = require('./xml-parser/manifest');
-      const parser = new ManifestXmlParser(buffer, {
+      const parser = new ManifestParser(buffer, {
         ignore: [
           'application.activity',
           'application.service',
@@ -159,7 +195,6 @@ export class AabParser extends Zip {
    */
   private _parseResourceMap(buffer: Buffer) {
     try {
-      const ResourceFinder = require('./resource-finder');
       return new ResourceFinder().processResourceTable(buffer);
     } catch (e: any) {
       throw new Error(t('aabParseResourcesError', { error: e?.message ?? e }));

src/utils/app-info-parser/apk.ts

@@ -1,12 +1,11 @@
+import { ResourceFinder } from './resource-finder';
 import { findApkIconPath, getBase64FromBuffer, mapInfoResource } from './utils';
+import { ManifestParser } from './xml-parser/manifest';
 import { Zip } from './zip';
 
 const ManifestName = /^androidmanifest\.xml$/;
 const ResourceName = /^resources\.arsc$/;
 
-const ManifestXmlParser = require('./xml-parser/manifest');
-const ResourceFinder = require('./resource-finder');
-
 export class ApkParser extends Zip {
   parse(): Promise<any> {
     return new Promise((resolve, reject) => {
@@ -61,7 +60,7 @@ export class ApkParser extends Zip {
    */
   private _parseManifest(buffer: Buffer) {
     try {
-      const parser = new ManifestXmlParser(buffer, {
+      const parser = new ManifestParser(buffer, {
         ignore: [
           'application.activity',
           'application.service',

src/utils/app-info-parser/index.ts

@@ -1,7 +1,7 @@
+import { AabParser } from './aab';
 import { ApkParser } from './apk';
-const IpaParser = require('./ipa');
 import { AppParser } from './app';
-import { AabParser } from './aab';
+import { IpaParser } from './ipa';
 const supportFileTypes = ['ipa', 'apk', 'app', 'aab'];
 
 class AppInfoParser {

src/utils/app-info-parser/ipa.js src/utils/app-info-parser/ipa.tssrc/utils/app-info-parser/ipa.js renamed to src/utils/app-info-parser/ipa.ts

@@ -2,39 +2,37 @@ const parsePlist = require('plist').parse;
 const parseBplist = require('bplist-parser').parseBuffer;
 const cgbiToPng = require('cgbi-to-png');
 
+import { findIpaIconPath, getBase64FromBuffer, isBrowser } from './utils';
 import { Zip } from './zip';
-const { findIpaIconPath, getBase64FromBuffer, isBrowser } = require('./utils');
 
 const PlistName = /payload\/[^\/]+?.app\/info.plist$/i;
 const ProvisionName = /payload\/.+?\.app\/embedded.mobileprovision/;
 
-class IpaParser extends Zip {
-  parse() {
+export class IpaParser extends Zip {
+  parse(): Promise<any> {
     return new Promise((resolve, reject) => {
       this.getEntries([PlistName, ProvisionName])
-        .then((buffers) => {
-          if (!buffers[PlistName]) {
+        .then((buffers: any) => {
+          if (!buffers[PlistName as any]) {
             throw new Error("Info.plist can't be found.");
           }
-          const plistInfo = this._parsePlist(buffers[PlistName]);
-          // parse mobile provision
-          const provisionInfo = this._parseProvision(buffers[ProvisionName]);
+          const plistInfo = this._parsePlist(buffers[PlistName as any]);
+          const provisionInfo = this._parseProvision(
+            buffers[ProvisionName as any],
+          );
           plistInfo.mobileProvision = provisionInfo;
 
-          // find icon path and parse icon
           const iconRegex = new RegExp(
             findIpaIconPath(plistInfo).toLowerCase(),
           );
           this.getEntry(iconRegex)
-            .then((iconBuffer) => {
+            .then((iconBuffer: any) => {
               try {
-                // In general, the ipa file's icon has been specially processed, should be converted
                 plistInfo.icon = iconBuffer
                   ? getBase64FromBuffer(cgbiToPng.revert(iconBuffer))
                   : null;
               } catch (err) {
                 if (isBrowser()) {
-                  // Normal conversion in other cases
                   plistInfo.icon = iconBuffer
                     ? getBase64FromBuffer(
                         window.btoa(String.fromCharCode(...iconBuffer)),
@@ -47,11 +45,11 @@ class IpaParser extends Zip {
               }
               resolve(plistInfo);
             })
-            .catch((e) => {
+            .catch((e: any) => {
               reject(e);
             });
         })
-        .catch((e) => {
+        .catch((e: any) => {
           reject(e);
         });
     });
@@ -60,8 +58,8 @@ class IpaParser extends Zip {
    * Parse plist
    * @param {Buffer} buffer // plist file's buffer
    */
-  _parsePlist(buffer) {
-    let result;
+  private _parsePlist(buffer: Buffer) {
+    let result: any;
     const bufferType = buffer[0];
     if (bufferType === 60 || bufferType === '<' || bufferType === 239) {
       result = parsePlist(buffer.toString());
@@ -76,8 +74,8 @@ class IpaParser extends Zip {
    * parse provision
    * @param {Buffer} buffer // provision file's buffer
    */
-  _parseProvision(buffer) {
-    let info = {};
+  private _parseProvision(buffer: Buffer | undefined) {
+    let info: Record<string, any> = {};
     if (buffer) {
       let content = buffer.toString('utf-8');
       const firstIndex = content.indexOf('<?xml');
@@ -90,5 +88,3 @@ class IpaParser extends Zip {
     return info;
   }
 }
-
-module.exports = IpaParser;