feat(cli): 1db0a9eb156f01910a68942446640661d433a56f

Author: serverpod_cloud

serverpod_cloud_cli/lib/commands/deploy/deploy.dart

@@ -66,6 +66,18 @@ abstract class Deploy {
             beneath: includedSubPaths,
             fileReadPoolSize: concurrency,
             showFiles: showFiles,
+            fileContentModifier: (final relativePath, final contentReader) async {
+              final isPubspec =
+                  relativePath.endsWith('pubspec.yaml') &&
+                  !relativePath.contains('.scloud/');
+              if (isPubspec) {
+                final content = await contentReader();
+                return WorkspaceProject.stripDevDependenciesFromPubspecContent(
+                  content,
+                );
+              }
+              return null;
+            },
           );
           return true;
         } on ProjectZipperExceptions catch (e) {

serverpod_cloud_cli/lib/commands/deploy/prepare_workspace.dart

@@ -203,6 +203,28 @@ abstract class WorkspaceProject {
     );
   }
 
+  /// Strips dev_dependencies from pubspec.yaml content in memory.
+  /// Returns the modified content, or null if no changes were needed.
+  static String? stripDevDependenciesFromPubspecContent(
+    final String pubspecContent,
+  ) {
+    try {
+      final pubspecYaml = yamlDecode(pubspecContent);
+      if (pubspecYaml is! Map) {
+        return null;
+      }
+
+      if (pubspecYaml.containsKey('dev_dependencies')) {
+        final modifiedPubspec = Map.from(pubspecYaml);
+        modifiedPubspec.remove('dev_dependencies');
+        return yamlEncode(modifiedPubspec);
+      }
+      return null;
+    } on Exception {
+      return null;
+    }
+  }
+
   /// Throws a [WorkspaceException] with one or more error messages.
   static Never _throwWorkspaceException({
     final String? message,

serverpod_cloud_cli/lib/project_zipper/project_zipper.dart

@@ -1,3 +1,4 @@
+import 'dart:convert';
 import 'dart:io';
 import 'package:archive/archive_io.dart';
 import 'package:pool/pool.dart';
@@ -31,6 +32,11 @@ abstract final class ProjectZipper {
   /// The [beneath] is the list of relative paths under [rootDirectory] that will be included,
   /// all by default.
   /// The [fileReadPoolSize] is the number of files that are processed concurrently.
+  /// The [fileContentModifier] is an optional callback that can modify file content before
+  /// it is added to the archive. It receives the relative path and a content reader function.
+  /// The callback should return the modified content as a string, or null if no modification
+  /// is needed (in which case the file will be added as binary). The content reader is only
+  /// called when the modifier decides it needs to read the file content.
   ///
   /// All exceptions thrown by this method are subclasses of [ProjectZipperExceptions].
   /// Throws [ProjectDirectoryDoesNotExistException] if the project directory
@@ -46,6 +52,11 @@ abstract final class ProjectZipper {
     final Iterable<String> beneath = const ['.'],
     final int fileReadPoolSize = 5,
     final bool showFiles = false,
+    final Future<String?> Function(
+      String relativePath,
+      Future<String> Function() contentReader,
+    )?
+    fileContentModifier,
   }) async {
     final projectPath = rootDirectory.path;
 
@@ -86,12 +97,24 @@ abstract final class ProjectZipper {
       if (!file.existsSync()) return;
 
       await fileReadPool.withResource(() async {
-        final length = await file.length();
-        final bytes = await file.readAsBytes();
-
-        archive.addFile(
-          ArchiveFile(stripRoot(projectPath, path), length, bytes),
-        );
+        final relativePath = stripRoot(projectPath, path);
+
+        List<int> bytes;
+        if (fileContentModifier != null) {
+          final modifiedContent = await fileContentModifier(
+            relativePath,
+            () => file.readAsString(),
+          );
+          if (modifiedContent != null) {
+            bytes = utf8.encode(modifiedContent);
+          } else {
+            bytes = await file.readAsBytes();
+          }
+        } else {
+          bytes = await file.readAsBytes();
+        }
+
+        archive.addFile(ArchiveFile(relativePath, bytes.length, bytes));
       });
     }
 

serverpod_cloud_cli/test/prepare_workspace_unit_test.dart

@@ -458,4 +458,78 @@ environment: not-a-map
       expect(result, contains('environment: "not-a-map"'));
     });
   });
+
+  group('WorkspaceProject.stripDevDependenciesFromPubspecContent -', () {
+    test('Given pubspec content with dev_dependencies, '
+        'when called, then removes dev_dependencies', () {
+      const pubspecContent =
+          '''
+name: test_package
+version: 1.0.0
+environment:
+  sdk: ${ProjectFactory.validSdkVersion}
+dependencies:
+  serverpod: ${ProjectFactory.validServerpodVersion}
+dev_dependencies:
+  test: ^1.0.0
+  build_runner: ^2.0.0
+''';
+
+      final result = WorkspaceProject.stripDevDependenciesFromPubspecContent(
+        pubspecContent,
+      );
+      expect(result, isNot(contains('dev_dependencies:')));
+      expect(result, contains('dependencies:'));
+      expect(result, contains('test_package'));
+      expect(result, isNot(contains('test: ^1.0.0')));
+      expect(result, isNot(contains('build_runner: ^2.0.0')));
+    });
+
+    test('Given pubspec content without dev_dependencies, '
+        'when called, then returns null', () {
+      const originalContent =
+          '''
+name: test_package
+version: 1.0.0
+environment:
+  sdk: ${ProjectFactory.validSdkVersion}
+dependencies:
+  serverpod: ${ProjectFactory.validServerpodVersion}
+''';
+
+      final result = WorkspaceProject.stripDevDependenciesFromPubspecContent(
+        originalContent,
+      );
+      expect(result, isNull);
+    });
+
+    test('Given invalid YAML content, '
+        'when called, then returns null', () {
+      const invalidContent = 'not valid yaml: [';
+
+      final result = WorkspaceProject.stripDevDependenciesFromPubspecContent(
+        invalidContent,
+      );
+      expect(result, isNull);
+    });
+
+    test('Given pubspec content with only dev_dependencies, '
+        'when called, then removes dev_dependencies', () {
+      const pubspecContent =
+          '''
+name: test_package
+version: 1.0.0
+environment:
+  sdk: ${ProjectFactory.validSdkVersion}
+dev_dependencies:
+  test: ^1.0.0
+''';
+
+      final result = WorkspaceProject.stripDevDependenciesFromPubspecContent(
+        pubspecContent,
+      );
+      expect(result, isNot(contains('dev_dependencies:')));
+      expect(result, contains('test_package'));
+    });
+  });
 }

serverpod_cloud_cli/test_integration/commands/deploy_command_test.dart

@@ -5,6 +5,8 @@ import 'dart:async';
 import 'dart:convert';
 import 'dart:io';
 
+import 'package:archive/archive.dart';
+import 'package:archive/archive_io.dart';
 import 'package:args/command_runner.dart';
 import 'package:mocktail/mocktail.dart';
 import 'package:path/path.dart' as p;
@@ -891,4 +893,67 @@ dependencies:
       });
     },
   );
+
+  group('Given a project with dev_dependencies in pubspec.yaml', () {
+    late String testProjectDir;
+
+    setUp(() async {
+      await d.dir('project', [
+        d.file('pubspec.yaml', '''
+name: test_server
+version: 1.0.0
+environment:
+  sdk: ${ProjectFactory.validSdkVersion}
+dependencies:
+  serverpod: ${ProjectFactory.validServerpodVersion}
+dev_dependencies:
+  test: ^1.0.0
+  build_runner: ^2.0.0
+  mockito: ^5.0.0
+'''),
+        d.dir('bin', [d.file('main.dart', 'void main() {}')]),
+      ]).create();
+      testProjectDir = p.join(d.sandbox, 'project');
+
+      when(() => client.deploy.createUploadDescription(any())).thenAnswer(
+        (final _) async => BucketUploadDescription.uploadDescription,
+      );
+    });
+
+    group('when deploying through CLI', () {
+      late Future cliCommandFuture;
+      setUp(() async {
+        cliCommandFuture = cli.run([
+          'deploy',
+          '--project',
+          BucketUploadDescription.projectId,
+          '--project-dir',
+          testProjectDir,
+        ]);
+      });
+
+      test(
+        'then dev_dependencies are stripped from pubspec.yaml in zip',
+        () async {
+          await cliCommandFuture;
+
+          expect(mockFileUploader.uploadedData, isNotEmpty);
+
+          final archive = ZipDecoder().decodeBytes(
+            mockFileUploader.uploadedData,
+          );
+          final pubspecFile = archive.findFile('pubspec.yaml');
+          expect(pubspecFile, isNotNull);
+
+          final pubspecContent = utf8.decode(pubspecFile!.content);
+          expect(pubspecContent, isNot(contains('dev_dependencies:')));
+          expect(pubspecContent, isNot(contains('test: ^1.0.0')));
+          expect(pubspecContent, isNot(contains('build_runner: ^2.0.0')));
+          expect(pubspecContent, isNot(contains('mockito: ^5.0.0')));
+          expect(pubspecContent, contains('dependencies:'));
+          expect(pubspecContent, contains('serverpod:'));
+        },
+      );
+    });
+  });
 }