feat(shorebird_cli): include link percentage in patch metadata (#1837)

shorebirdtech · Mar 28, 2024 · 2f2645b · 2f2645b
1 parent fcd4eb8
commit 2f2645b
Show file tree

Hide file tree

Showing 12 changed files with 44 additions and 1 deletion.
diff --git a/packages/shorebird_cli/lib/src/commands/patch/patch_aar_command.dart b/packages/shorebird_cli/lib/src/commands/patch/patch_aar_command.dart
@@ -287,6 +287,7 @@ ${summary.join('\n')}
             hasAssetChanges: diffStatus.hasAssetChanges,
             usedIgnoreNativeChangesFlag: allowNativeDiffs,
             hasNativeChanges: diffStatus.hasNativeChanges,
+            linkPercentage: null,
             environment: BuildEnvironmentMetadata(
               operatingSystem: platform.operatingSystem,
               operatingSystemVersion: platform.operatingSystemVersion,

diff --git a/packages/shorebird_cli/lib/src/commands/patch/patch_android_command.dart b/packages/shorebird_cli/lib/src/commands/patch/patch_android_command.dart
@@ -387,6 +387,7 @@ ${summary.join('\n')}
             hasAssetChanges: diffStatus.hasAssetChanges,
             usedIgnoreNativeChangesFlag: allowNativeDiffs,
             hasNativeChanges: diffStatus.hasNativeChanges,
+            linkPercentage: null,
             environment: BuildEnvironmentMetadata(
               operatingSystem: platform.operatingSystem,
               operatingSystemVersion: platform.operatingSystemVersion,

diff --git a/packages/shorebird_cli/lib/src/commands/patch/patch_ios_command.dart b/packages/shorebird_cli/lib/src/commands/patch/patch_ios_command.dart
@@ -427,6 +427,7 @@ ${summary.join('\n')}
             hasAssetChanges: diffStatus.hasAssetChanges,
             usedIgnoreNativeChangesFlag: allowNativeDiffs,
             hasNativeChanges: diffStatus.hasNativeChanges,
+            linkPercentage: percentLinked,
             environment: BuildEnvironmentMetadata(
               operatingSystem: platform.operatingSystem,
               operatingSystemVersion: platform.operatingSystemVersion,

diff --git a/packages/shorebird_cli/lib/src/commands/patch/patch_ios_framework_command.dart b/packages/shorebird_cli/lib/src/commands/patch/patch_ios_framework_command.dart
@@ -345,6 +345,7 @@ ${summary.join('\n')}
             hasAssetChanges: diffStatus.hasAssetChanges,
             usedIgnoreNativeChangesFlag: allowNativeDiffs,
             hasNativeChanges: diffStatus.hasNativeChanges,
+            linkPercentage: null,
             environment: BuildEnvironmentMetadata(
               operatingSystem: platform.operatingSystem,
               operatingSystemVersion: platform.operatingSystemVersion,

diff --git a/packages/shorebird_cli/test/src/commands/patch/patch_aar_command_test.dart b/packages/shorebird_cli/test/src/commands/patch/patch_aar_command_test.dart
@@ -900,6 +900,7 @@ Please re-run the release command for this version or create a new release.'''),
             hasAssetChanges: false,
             usedIgnoreNativeChangesFlag: false,
             hasNativeChanges: false,
+            linkPercentage: null,
             environment: BuildEnvironmentMetadata(
               shorebirdVersion: packageVersion,
               operatingSystem: operatingSystem,

diff --git a/packages/shorebird_cli/test/src/commands/patch/patch_android_command_test.dart b/packages/shorebird_cli/test/src/commands/patch/patch_android_command_test.dart
@@ -983,6 +983,7 @@ Please re-run the release command for this version or create a new release.'''),
             hasAssetChanges: false,
             usedIgnoreNativeChangesFlag: false,
             hasNativeChanges: false,
+            linkPercentage: null,
             environment: BuildEnvironmentMetadata(
               shorebirdVersion: packageVersion,
               operatingSystem: operatingSystem,

diff --git a/packages/shorebird_cli/test/src/commands/patch/patch_ios_command_test.dart b/packages/shorebird_cli/test/src/commands/patch/patch_ios_command_test.dart
@@ -1344,6 +1344,20 @@ Please re-run the release command for this version or create a new release.'''),
       });
 
       test('generates diff base and publishes the appropriate patch', () async {
+        const linkPercentage = 99.9;
+        when(
+          () => aotTools.link(
+            base: any(named: 'base'),
+            patch: any(named: 'patch'),
+            analyzeSnapshot: any(named: 'analyzeSnapshot'),
+            genSnapshot: any(named: 'genSnapshot'),
+            kernel: any(named: 'kernel'),
+            workingDirectory: any(named: 'workingDirectory'),
+            outputPath: any(named: 'outputPath'),
+          ),
+        ).thenAnswer(
+          (_) async => linkPercentage,
+        );
         await runWithOverrides(command.run);
         verify(
           () => codePushClientWrapper.publishPatch(
@@ -1362,6 +1376,7 @@ Please re-run the release command for this version or create a new release.'''),
               hasAssetChanges: false,
               usedIgnoreNativeChangesFlag: false,
               hasNativeChanges: false,
+              linkPercentage: linkPercentage,
               environment: BuildEnvironmentMetadata(
                 shorebirdVersion: packageVersion,
                 operatingSystem: operatingSystem,
@@ -1651,6 +1666,7 @@ flavors:
             hasAssetChanges: false,
             usedIgnoreNativeChangesFlag: false,
             hasNativeChanges: false,
+            linkPercentage: null,
             environment: BuildEnvironmentMetadata(
               shorebirdVersion: packageVersion,
               operatingSystem: operatingSystem,

diff --git a/packages/shorebird_cli/test/src/commands/patch/patch_ios_framework_command_test.dart b/packages/shorebird_cli/test/src/commands/patch/patch_ios_framework_command_test.dart
@@ -980,6 +980,7 @@ Please re-run the release command for this version or create a new release.'''),
             hasAssetChanges: false,
             usedIgnoreNativeChangesFlag: false,
             hasNativeChanges: false,
+            linkPercentage: null,
             environment: BuildEnvironmentMetadata(
               shorebirdVersion: packageVersion,
               operatingSystem: operatingSystem,

diff --git a/packages/shorebird_code_push_protocol/lib/src/models/create_patch_metadata.dart b/packages/shorebird_code_push_protocol/lib/src/models/create_patch_metadata.dart
@@ -23,6 +23,7 @@ class CreatePatchMetadata extends Equatable {
     required this.hasAssetChanges,
     required this.usedIgnoreNativeChangesFlag,
     required this.hasNativeChanges,
+    required this.linkPercentage,
     required this.environment,
   });
 
@@ -35,6 +36,7 @@ class CreatePatchMetadata extends Equatable {
     bool hasAssetChanges = false,
     bool usedIgnoreNativeChangesFlag = false,
     bool hasNativeChanges = false,
+    double? linkPercentage,
     BuildEnvironmentMetadata? environment,
   }) =>
       CreatePatchMetadata(
@@ -43,6 +45,7 @@ class CreatePatchMetadata extends Equatable {
         hasAssetChanges: hasAssetChanges,
         usedIgnoreNativeChangesFlag: usedIgnoreNativeChangesFlag,
         hasNativeChanges: hasNativeChanges,
+        linkPercentage: linkPercentage,
         environment: environment ?? BuildEnvironmentMetadata.forTest(),
       );
   // coverage:ignore-end
@@ -83,6 +86,12 @@ class CreatePatchMetadata extends Equatable {
   /// behavior in a patch.
   final bool hasNativeChanges;
 
+  /// The percentage of code that was linked in the patch.
+  /// Generally, the higher the percentage, the better the patch performance
+  /// since more code will be run on the CPU as opposed to the simulator.
+  /// Note: link percentage is currently only available for iOS patches.
+  final double? linkPercentage;
+
   /// Properties about the environment in which the patch was created.
   ///
   /// Reason: see [BuildEnvironmentMetadata].
@@ -95,6 +104,7 @@ class CreatePatchMetadata extends Equatable {
         hasAssetChanges,
         usedIgnoreNativeChangesFlag,
         hasNativeChanges,
+        linkPercentage,
         environment,
       ];
 }
diff --git a/packages/shorebird_code_push_protocol/lib/src/models/create_patch_metadata.g.dart b/packages/shorebird_code_push_protocol/lib/src/models/create_patch_metadata.g.dart
diff --git a/...horebird_code_push_protocol/test/src/messages/create_patch/create_patch_request_test.dart b/...horebird_code_push_protocol/test/src/messages/create_patch/create_patch_request_test.dart
@@ -15,6 +15,7 @@ void main() {
           usedIgnoreNativeChangesFlag: false,
           hasAssetChanges: true,
           hasNativeChanges: false,
+          linkPercentage: 99.9,
           environment: BuildEnvironmentMetadata(
             operatingSystem: 'linux',
             operatingSystemVersion: '1.0.0',

diff --git a/packages/shorebird_code_push_protocol/test/src/models/create_patch_metadata_test.dart b/packages/shorebird_code_push_protocol/test/src/models/create_patch_metadata_test.dart
@@ -10,6 +10,7 @@ void main() {
         hasAssetChanges: false,
         usedIgnoreNativeChangesFlag: false,
         hasNativeChanges: false,
+        linkPercentage: 99.9,
         environment: BuildEnvironmentMetadata(
           operatingSystem: 'macos',
           operatingSystemVersion: '1.2.3',
@@ -31,6 +32,7 @@ void main() {
           hasAssetChanges: false,
           usedIgnoreNativeChangesFlag: false,
           hasNativeChanges: false,
+          linkPercentage: 99.9,
           environment: BuildEnvironmentMetadata(
             operatingSystem: 'macos',
             operatingSystemVersion: '1.2.3',
@@ -44,6 +46,7 @@ void main() {
           hasAssetChanges: false,
           usedIgnoreNativeChangesFlag: false,
           hasNativeChanges: false,
+          linkPercentage: 99.9,
           environment: BuildEnvironmentMetadata(
             operatingSystem: 'macos',
             operatingSystemVersion: '1.2.3',
@@ -61,6 +64,7 @@ void main() {
           hasAssetChanges: false,
           usedIgnoreNativeChangesFlag: false,
           hasNativeChanges: false,
+          linkPercentage: null,
           environment: BuildEnvironmentMetadata(
             operatingSystem: 'macos',
             operatingSystemVersion: '1.2.3',
@@ -74,6 +78,7 @@ void main() {
           hasAssetChanges: false,
           usedIgnoreNativeChangesFlag: false,
           hasNativeChanges: false,
+          linkPercentage: null,
           environment: BuildEnvironmentMetadata(
             operatingSystem: 'macos',
             operatingSystemVersion: '1.2.3',