Skip to content

feat(cli_tools): Enable override of analytics API URL #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 27, 2025
Merged

feat(cli_tools): Enable override of analytics API URL #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d670ac
docs(cli_tools): Doc comment correction
christerswahn Oct 27, 2025
180bdae
feat(cli_tools): Enable override of analytics API URL
christerswahn Oct 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions packages/cli_tools/lib/src/analytics/analytics.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,26 @@ abstract interface class Analytics {

/// Analytics service for MixPanel.
class MixPanelAnalytics implements Analytics {
static const _defaultEndpoint = 'https://api.mixpanel.com/track';
static const _defaultTimeout = Duration(seconds: 2);

final String _uniqueUserId;
final String _endpoint = 'https://api.mixpanel.com/track';
final String _endpoint;
final String _projectToken;
final String _version;
final Duration _timeout;

MixPanelAnalytics({
required final String uniqueUserId,
required final String projectToken,
required final String version,
final String endpoint = _defaultEndpoint,
final Duration timeout = _defaultTimeout,
}) : _uniqueUserId = uniqueUserId,
_projectToken = projectToken,
_version = version;
_version = version,
_endpoint = endpoint,
_timeout = timeout;
Comment on lines 17 to +37
Copy link

@coderabbitai coderabbitai bot Oct 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Verify test coverage for the new constructor parameters.

Ensure that the new endpoint and timeout parameters are covered by tests, particularly testing with custom values to verify the configuration works as intended.

Run the following script to check for existing tests and instantiations:

🏁 Script executed:

#!/bin/bash
# Description: Find MixPanelAnalytics usage and test coverage

# Find existing instantiations of MixPanelAnalytics
echo "=== Existing MixPanelAnalytics instantiations ==="
rg -nP --type=dart 'MixPanelAnalytics\s*\(' -A 5

# Find test files for analytics
echo -e "\n=== Test files for analytics ==="
fd -e dart test.*analytics -x echo {}
fd -e dart analytics.*test -x echo {}

Length of output: 710

Now let me search for the test file to check what coverage exists:

is not applicable here as we need the repository files.

🏁 Script executed:

#!/bin/bash
# Read the analytics test file to check coverage for MixPanelAnalytics
cat ./packages/cli_tools/test/better_command_runner/analytics_test.dart

Length of output: 99

🏁 Script executed:

#!/bin/bash
# Find all test files and search for analytics-related tests
echo "=== All dart test files matching analytics ==="
find . -name '*test.dart' -o -name '*_test.dart' | grep -i analytics

echo -e "\n=== Search for MixPanelAnalytics instantiations or tests ==="
rg -nP --type=dart 'MixPanelAnalytics' -B 2 -A 10 | head -100

echo -e "\n=== Search for Analytics test references ==="
rg -nP --type=dart 'class.*Test|test\(' --type=dart -l | xargs grep -l -i analytics 2>/dev/null | head -10

Length of output: 2432

🏁 Script executed:

#!/bin/bash
# Try reading the test file with different method
echo "=== Analytics Test File Content ==="
head -200 packages/cli_tools/test/better_command_runner/analytics_test.dart

echo -e "\n=== Search for MixPanelAnalytics instantiation in tests ==="
rg -nP --type=dart 'MixPanelAnalytics|endpoint|timeout' packages/cli_tools/test/better_command_runner/ -A 3 -B 1

Length of output: 4911

🏁 Script executed:

#!/bin/bash
# Find where MixPanelAnalytics is instantiated in the codebase
echo "=== MixPanelAnalytics instantiation (excluding class definition) ==="
rg -nP --type=dart 'MixPanelAnalytics\s*\(' -g '!**/analytics.dart' -A 8

# Check the full analytics.dart file to see how endpoint and timeout are used
echo -e "\n=== Full MixPanelAnalytics implementation ==="
rg -nP --type=dart '_endpoint|_timeout' packages/cli_tools/lib/src/analytics/analytics.dart -B 2 -A 2

# Find any other test files in analytics directory
echo -e "\n=== All files in analytics directory ==="
find packages/cli_tools -path '*analytics*' -type f | grep -E '\.(dart|test)$'

Length of output: 939

Add unit tests for MixPanelAnalytics constructor parameters.

The endpoint and timeout parameters are used in the HTTP request (lines 74 and 80) but lack dedicated test coverage. Create tests to verify:

  • Custom endpoint values are correctly parsed and used
  • Custom timeout values are applied to HTTP requests
  • Default values work as expected
🤖 Prompt for AI Agents 
In packages/cli_tools/lib/src/analytics/analytics.dart around lines 17-37, the
MixPanelAnalytics constructor’s endpoint and timeout parameters lack unit-test
coverage; add tests that instantiate MixPanelAnalytics with custom endpoint and
timeout and with defaults, then exercise the track/send method while using a
mocked HTTP client (or MockClient from package:http) to capture the outgoing
request and assert that (1) the request URL uses the custom endpoint when
provided and the default endpoint when not provided, and (2) the HTTP call uses
the configured timeout duration for custom and default timeout values; place
these tests in the package’s test folder (e.g., test/analytics_test.dart), mock
the network call to avoid real HTTP, and assert the endpoint and timeout
behavior accordingly.

Comment on lines 27 to +37
Copy link

@coderabbitai coderabbitai bot Oct 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion | 🟠 Major

Add documentation for the new constructor parameters.

The new endpoint and timeout parameters lack documentation comments explaining their purpose and valid values.

Apply this diff to add parameter documentation:

   MixPanelAnalytics({
     required final String uniqueUserId,
     required final String projectToken,
     required final String version,
+    /// The MixPanel API endpoint URL. Defaults to the standard MixPanel track endpoint.
     final String endpoint = _defaultEndpoint,
+    /// The timeout duration for analytics API calls. Defaults to 2 seconds.
     final Duration timeout = _defaultTimeout,
   })  : _uniqueUserId = uniqueUserId,
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
MixPanelAnalytics({
required final String uniqueUserId,
required final String projectToken,
required final String version,
final String endpoint = _defaultEndpoint,
final Duration timeout = _defaultTimeout,
}) : _uniqueUserId = uniqueUserId,
_projectToken = projectToken,
_version = version;
_version = version,
_endpoint = endpoint,
_timeout = timeout;
MixPanelAnalytics({
required final String uniqueUserId,
required final String projectToken,
required final String version,
/// The MixPanel API endpoint URL. Defaults to the standard MixPanel track endpoint.
final String endpoint = _defaultEndpoint,
/// The timeout duration for analytics API calls. Defaults to 2 seconds.
final Duration timeout = _defaultTimeout,
}) : _uniqueUserId = uniqueUserId,
_projectToken = projectToken,
_version = version,
_endpoint = endpoint,
_timeout = timeout;
🤖 Prompt for AI Agents 
In packages/cli_tools/lib/src/analytics/analytics.dart around lines 27 to 37,
the constructor’s new parameters endpoint and timeout lack documentation; add
Dartdoc comments for the constructor (placed immediately above the
MixPanelAnalytics constructor) that describe each parameter: explain endpoint as
the Mixpanel ingestion HTTP endpoint (include default value _defaultEndpoint and
acceptable formats, e.g., full URL string), and explain timeout as the network
request timeout Duration (include default _defaultTimeout and valid
ranges/units), referencing the parameter names in brackets ([endpoint],
[timeout]) and keeping the comments concise and idiomatic for Dart
documentation.


@override
void cleanUp() {}
Expand Down Expand Up @@ -69,7 +77,7 @@ class MixPanelAnalytics implements Analytics {
'Accept': 'text/plain',
'Content-Type': 'application/x-www-form-urlencoded',
},
).timeout(const Duration(seconds: 2));
).timeout(_timeout);
} catch (e) {
return;
}
Expand Down
3 changes: 1 addition & 2 deletions packages/cli_tools/lib/src/local_storage_manager/local_storage_manager.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,7 @@ abstract base class LocalStorageManager {
}

/// Tries to fetch and deserialize a json file from the local storage.
/// If the file does not exist or if an error occurs during reading or
/// deserialization, null will be returned.
/// If the file does not exist null will be returned.
///
/// [fileName] The name of the file to fetch.
/// [localStoragePath] The path to the local storage directory.
Expand Down