Add support for build files folder parameter (#235)

Author: denrase

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Features
+
+- Add support for build files folder parameter ([#235](https://github.com/getsentry/sentry-dart-plugin/pull/235))
+
 ## 2.0.0
 
 ### Breaking Changes

README.md

@@ -106,14 +106,16 @@ ignore_missing=true
 | url | URL | e.g. https<area>://mysentry.invalid/ (string)  | no | SENTRY_URL |
 | wait_for_processing | Wait for server-side processing of uploaded files | false (boolean)  | no | - |
 | log_level | Configures the log level for sentry-cli | warn (string)  | no | SENTRY_LOG_LEVEL |
-| release | The release version for source maps, it should match the release set by the SDK | default: name@version from pubspec (string)  | no | SENTRY_RELEASE |
-| dist | The dist/build number for source maps, it should match the dist set by the SDK | default: the number after the '+' char from 'version' pubspec (string)  | no | SENTRY_DIST |
-| web_build_path | The web build folder | default: build/web (string)  | no | - |
-| commits | Release commits integration | default: auto | no | - |
-| ignore_missing | Ignore missing commits previously used in the release | default: false | no | - |
+| release | The release version for source maps, it should match the release set by the SDK | name@version from pubspec (string)  | no | SENTRY_RELEASE |
+| dist | The dist/build number for source maps, it should match the dist set by the SDK | the number after the '+' char from 'version' pubspec (string)  | no | SENTRY_DIST |
+| build_path | The build folder of debug files for upload | `.` current folder (string) | no | - |
+| web_build_path | The web build folder of debug files for upload | `build/web` relative to build_path (string)  | no | - |
+| commits | Release commits integration | auto (string) | no | - |
+| ignore_missing | Ignore missing commits previously used in the release | false (boolean) | no | - |
 | bin_dir | The folder where the plugin downloads the sentry-cli binary | .dart_tool/pub/bin/sentry_dart_plugin (string) | no | - |
 | bin_path | Path to the sentry-cli binary to use instead of downloading. Make sure to use the correct version. | null (string) | no | - |
 
+
 ## Release
 
 Per default, the release is build from pubspec.yaml's name, version & build: `name@version+build`. The build number, if present, is used as the `dist` parameter.

lib/src/configuration.dart

@@ -18,7 +18,7 @@ class Configuration {
   // cannot use ${Directory.current.path}/build since --split-debug-info allows
   // setting a custom path which is a sibling of build
   /// The Build folder, defaults to the current directory.
-  late final String buildFilesFolder = _fs.currentDirectory.path;
+  late String buildFilesFolder;
 
   /// Whether to upload debug symbols, defaults to true
   late bool uploadDebugSymbols;
@@ -131,6 +131,8 @@ class Configuration {
     commits = configValues.commits ?? 'auto';
     ignoreMissing = configValues.ignoreMissing ?? false;
 
+    buildFilesFolder =
+        configValues.buildPath ?? _fs.currentDirectory.path;
     // uploading JS and Map files need to have the correct folder structure
     // otherwise symbolication fails, the default path for the web build folder is build/web
     // but can be customized so making it flexible.

lib/src/configuration_values.dart

@@ -16,6 +16,7 @@ class ConfigurationValues {
   final String? logLevel;
   final String? release;
   final String? dist;
+  final String? buildPath;
   final String? webBuildPath;
   final String? commits;
   final bool? ignoreMissing;
@@ -36,6 +37,7 @@ class ConfigurationValues {
     this.logLevel,
     this.release,
     this.dist,
+    this.buildPath,
     this.webBuildPath,
     this.commits,
     this.ignoreMissing,
@@ -83,6 +85,7 @@ class ConfigurationValues {
       logLevel: sentryArguments['log_level'],
       release: sentryArguments['release'],
       dist: sentryArguments['dist'],
+      buildPath: sentryArguments['build_path'],
       webBuildPath: sentryArguments['web_build_path'],
       commits: sentryArguments['commits'],
       ignoreMissing: boolFromString(sentryArguments['ignore_missing']),
@@ -95,6 +98,7 @@ class ConfigurationValues {
     return ConfigurationValues(
       version: configReader.getString('version'),
       name: configReader.getString('name'),
+
       uploadDebugSymbols: configReader.getBool(
         'upload_debug_symbols',
         deprecatedKey: 'upload_native_symbols',
@@ -112,6 +116,7 @@ class ConfigurationValues {
       logLevel: configReader.getString('log_level'),
       release: configReader.getString('release'),
       dist: configReader.getString('dist'),
+      buildPath: configReader.getString('build_path'),
       webBuildPath: configReader.getString('web_build_path'),
       commits: configReader.getString('commits'),
       ignoreMissing: configReader.getBool('ignore_missing'),
@@ -156,6 +161,7 @@ class ConfigurationValues {
       logLevel: args.logLevel ?? file.logLevel,
       release: platformEnv.release ?? args.release ?? file.release,
       dist: platformEnv.dist ?? args.dist ?? file.dist,
+      buildPath: args.buildPath ?? file.buildPath,
       webBuildPath: args.webBuildPath ?? file.webBuildPath,
       commits: args.commits ?? file.commits,
       ignoreMissing: args.ignoreMissing ?? file.ignoreMissing,

test/configuration_test.dart

@@ -62,6 +62,7 @@ void main() {
         logLevel: 'warning',
         release: 'release-args-config',
         dist: 'dist-args-config',
+        buildPath: 'build_path-args-config',
         webBuildPath: 'web_build_path-args-config',
         commits: 'commits-args-config',
         ignoreMissing: true,
@@ -82,6 +83,7 @@ void main() {
         logLevel: 'debug',
         release: 'release-file-config',
         dist: 'dist-file-config',
+        buildPath: 'build_path-file-config',
         webBuildPath: 'web_build_path-file-config',
         commits: 'commits-file-config',
         ignoreMissing: false,
@@ -108,6 +110,7 @@ void main() {
       expect(sut.logLevel, 'warning');
       expect(sut.release, 'release-args-config');
       expect(sut.dist, 'dist-args-config');
+      expect(sut.buildFilesFolder, 'build_path-args-config');
       expect(
         sut.webBuildFilesFolder,
         fixture.fs.path.join(
@@ -138,6 +141,7 @@ void main() {
         logLevel: 'debug',
         release: 'release-file-config',
         dist: 'dist-file-config',
+        buildPath: 'build_path-file-config',
         webBuildPath: 'web_build_path-file-config',
         commits: 'commits-file-config',
         ignoreMissing: true,
@@ -153,6 +157,7 @@ void main() {
 
       expect(sut.name, 'name-file-config');
       expect(sut.version, 'version-file-config');
+
       expect(sut.uploadDebugSymbols, false);
       expect(sut.uploadSourceMaps, true);
       expect(sut.uploadSources, true);
@@ -164,6 +169,7 @@ void main() {
       expect(sut.logLevel, 'debug');
       expect(sut.release, 'release-file-config');
       expect(sut.dist, 'dist-file-config');
+      expect(sut.buildFilesFolder, 'build_path-file-config');
       expect(
         sut.webBuildFilesFolder,
         fixture.fs.path
@@ -193,6 +199,10 @@ void main() {
       expect(sut.uploadSources, false);
       expect(sut.commits, 'auto');
       expect(sut.ignoreMissing, false);
+      expect(
+        sut.buildFilesFolder,
+        fixture.fs.currentDirectory.path,
+      );
       expect(
         sut.webBuildFilesFolder,
         fixture.fs.path.join(sut.buildFilesFolder, 'build/web'),

test/configureation_values_test.dart

@@ -27,6 +27,7 @@ void main() {
         "--sentry-define=log_level=fixture-log_level",
         "--sentry-define=release=fixture-release",
         "--sentry-define=dist=fixture-dist",
+        "--sentry-define=build_path=fixture-build_path",
         "--sentry-define=web_build_path=fixture-web_build_path",
         "--sentry-define=commits=fixture-commits",
         "--sentry-define=ignore_missing=true",
@@ -35,6 +36,7 @@ void main() {
       final sut = ConfigurationValues.fromArguments(arguments);
       expect(sut.name, 'fixture-name');
       expect(sut.version, 'fixture-version');
+
       expect(sut.uploadDebugSymbols, true);
       expect(sut.uploadSourceMaps, true);
       expect(sut.uploadSources, true);
@@ -46,6 +48,7 @@ void main() {
       expect(sut.logLevel, 'fixture-log_level');
       expect(sut.release, 'fixture-release');
       expect(sut.dist, 'fixture-dist');
+      expect(sut.buildPath, 'fixture-build_path');
       expect(sut.webBuildPath, 'fixture-web_build_path');
       expect(sut.commits, 'fixture-commits');
       expect(sut.ignoreMissing, true);
@@ -76,6 +79,7 @@ void main() {
       final config = '''
       name: fixture-name
       version: fixture-version
+      
       upload_debug_symbols: true
       upload_source_maps: true
       upload_sources: true
@@ -84,6 +88,7 @@ void main() {
       log_level: fixture-log_level
       release: fixture-release
       dist: fixture-dist
+      build_path: fixture-build_path
       web_build_path: fixture-web_build_path
       commits: fixture-commits
       ignore_missing: true
@@ -110,6 +115,7 @@ void main() {
       final sut = ConfigurationValues.fromReader(reader);
       expect(sut.name, 'fixture-name');
       expect(sut.version, 'fixture-version');
+
       expect(sut.uploadDebugSymbols, true);
       expect(sut.uploadSourceMaps, true);
       expect(sut.uploadSources, true);
@@ -121,6 +127,7 @@ void main() {
       expect(sut.logLevel, 'fixture-log_level');
       expect(sut.release, 'fixture-release');
       expect(sut.dist, 'fixture-dist');
+      expect(sut.buildPath, 'fixture-build_path');
       expect(sut.webBuildPath, 'fixture-web_build_path');
       expect(sut.commits, 'fixture-commits');
       expect(sut.ignoreMissing, true);