feat(instruments profiler): add new profiler

Author: GuillaumeEgret

packages/platforms/ios-instruments/src/index.ts

@@ -1 +1,40 @@
+import { Measure, Profiler, ProfilerPollingOptions, ScreenRecorder } from "@perf-profiler/types";
 export { killApp } from "./utils/DeviceManager";
+
+export class IOSInstrumentsProfiler implements Profiler {
+  connectedDevice: IdbDevice | undefined;
+  recordingProcess: ChildProcess | undefined;
+  traceFile: string | undefined;
+  pid: number | undefined;
+  bundleId: string | undefined;
+  onMeasure: ((measure: Measure) => void) | undefined;
+  pollPerformanceMeasures(bundleId: string, options: ProfilerPollingOptions): { stop: () => void } {
+    if (!this.pid) throw new Error("Profiler is not ready, app is not running");
+    this.onMeasure = options.onMeasure;
+    return {
+      stop: () => {
+        return;
+      },
+    };
+  }
+
+  detectCurrentBundleId(): string {
+    throw new Error("App Id detection is not implemented on iOS with Instruments");
+  }
+
+  installProfilerOnDevice() {
+    // Do we need anything here?
+  }
+
+  getScreenRecorder(videoPath: string): ScreenRecorder | undefined {
+    return undefined;
+  }
+
+  cleanup: () => void = () => {
+    // Do we need anything here?
+  };
+  async stopApp(bundleId: string): Promise<void> {
+    killApp(bundleId);
+    return new Promise<void>((resolve) => resolve());
+  }
+}

packages/platforms/profiler/package.json

@@ -16,6 +16,7 @@
   "dependencies": {
     "@perf-profiler/android": "^0.10.7",
     "@perf-profiler/ios": "^0.2.0",
+    "@perf-profiler/ios-instruments": "^0.2.0",
     "@perf-profiler/types": "^0.6.0"
   }
 }

packages/platforms/profiler/src/index.ts

@@ -1,9 +1,20 @@
 import { AndroidProfiler } from "@perf-profiler/android";
 import { IOSProfiler } from "@perf-profiler/ios";
+import { IOSInstrumentsProfiler } from "@perf-profiler/ios-instruments";
 import { Profiler } from "@perf-profiler/types";
 
-export const profiler: Profiler =
-  process.env.PLATFORM === "ios" ? new IOSProfiler() : new AndroidProfiler();
+export const profiler: Profiler = (() => {
+  switch (process.env.PLATFORM) {
+    case "android":
+      return new AndroidProfiler();
+    case "ios":
+      return new IOSProfiler();
+    case "ios-instruments":
+      return new IOSInstrumentsProfiler();
+    default:
+      return new AndroidProfiler();
+  }
+})();
 
 // TODO move this to a separate package
 export { waitFor } from "@perf-profiler/android";