Skip to content

feat: add session replay mode argument to reprosteps api #398

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.

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 6 commits into from
Sep 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
import com.instabug.library.invocation.InstabugInvocationEvent;
import com.instabug.library.model.NetworkLog;
import com.instabug.library.ui.onboarding.WelcomeMessage;
import com.instabug.library.visualusersteps.State;

import org.json.JSONObject;

Expand Down Expand Up @@ -276,7 +275,7 @@ public void run() {
}

@Override
public void setReproStepsConfig(@Nullable String bugMode, @Nullable String crashMode) {
public void setReproStepsConfig(@Nullable String bugMode, @Nullable String crashMode, @Nullable String sessionReplayMode) {
try {
final ReproConfigurations.Builder builder = new ReproConfigurations.Builder();

Expand All @@ -290,6 +289,11 @@ public void setReproStepsConfig(@Nullable String bugMode, @Nullable String crash
builder.setIssueMode(IssueType.Crash, resolvedCrashMode);
}

if (sessionReplayMode != null) {
final Integer resolvedSessionReplayMode = ArgsRegistry.reproModes.get(sessionReplayMode);
builder.setIssueMode(IssueType.SessionReplay, resolvedSessionReplayMode);
}

final ReproConfigurations config = builder.build();

Instabug.setReproConfigurations(config);
Expand Down
3 changes: 3 additions & 0 deletions android/src/test/java/com/instabug/flutter/ApmApiTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@

import com.instabug.apm.APM;
import com.instabug.apm.model.ExecutionTrace;
import com.instabug.apm.networking.APMNetworkLogger;
import com.instabug.flutter.generated.ApmPigeon;
import com.instabug.flutter.modules.ApmApi;
import com.instabug.flutter.util.GlobalMocks;
Expand Down Expand Up @@ -205,6 +206,7 @@ public void testNetworkLogAndroid() {
data.put("duration", requestDuration);
data.put("serverErrorMessage", serverErrorMessage);

MockedConstruction<APMNetworkLogger> mAPMNetworkLogger = mockConstruction(APMNetworkLogger.class);
MockedConstruction<JSONObject> mJSONObject = mockConstruction(JSONObject.class, (mock, context) -> when(mock.toString(anyInt())).thenReturn("{}"));

api.networkLogAndroid(data);
Expand All @@ -228,6 +230,7 @@ public void testNetworkLogAndroid() {
serverErrorMessage
));

mAPMNetworkLogger.close();
mJSONObject.close();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -379,19 +379,21 @@ public void testGetUserAttributes() {
public void testSetReproStepsConfig() {
String bug = "ReproStepsMode.enabled";
String crash = "ReproStepsMode.disabled";
String sessionReplay = "ReproStepsMode.disabled";

ReproConfigurations config = mock(ReproConfigurations.class);
MockedConstruction<ReproConfigurations.Builder> mReproConfigurationsBuilder = mockConstruction(ReproConfigurations.Builder.class, (mock, context) -> {
when(mock.setIssueMode(anyInt(), anyInt())).thenReturn(mock);
when(mock.build()).thenReturn(config);
});

api.setReproStepsConfig(bug, crash);
api.setReproStepsConfig(bug, crash, sessionReplay);

ReproConfigurations.Builder builder = mReproConfigurationsBuilder.constructed().get(0);

verify(builder).setIssueMode(IssueType.Bug, ReproMode.EnableWithScreenshots);
verify(builder).setIssueMode(IssueType.Crash, ReproMode.Disable);
verify(builder).setIssueMode(IssueType.SessionReplay, ReproMode.Disable);
verify(builder).build();

mInstabug.verify(() -> Instabug.setReproConfigurations(config));
Expand Down
5 changes: 3 additions & 2 deletions example/ios/InstabugTests/ApmApiTests.m
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@ - (void)testStartExecutionTraceWhenTraceNotNil {
NSString *name = @"trace-name";
XCTestExpectation *expectation = [self expectationWithDescription:@"Call completion handler"];

OCMStub([self.mAPM startExecutionTraceWithName:name]).andReturn([IBGExecutionTrace new]);
IBGExecutionTrace *mTrace = OCMClassMock([IBGExecutionTrace class]);
OCMStub([self.mAPM startExecutionTraceWithName:name]).andReturn(mTrace);

[self.api startExecutionTraceId:expectedId name:name completion:^(NSString *actualId, FlutterError *error) {
[expectation fulfill];
Expand Down Expand Up @@ -124,7 +125,7 @@ - (void)testStartUITrace {

- (void)testEndUITrace {
FlutterError *error;

[self.api endUITraceWithError:&error];

OCMVerify([self.mAPM endUITrace]);
Expand Down
4 changes: 3 additions & 1 deletion example/ios/InstabugTests/InstabugApiTests.m
Original file line number Diff line number Diff line change
Expand Up @@ -285,12 +285,14 @@ - (void)testGetUserAttributes {
- (void)testSetReproStepsConfig {
NSString *bugMode = @"ReproStepsMode.enabled";
NSString *crashMode = @"ReproStepsMode.disabled";
NSString *sessionReplayMode = @"ReproStepsMode.disabled";
FlutterError *error;

[self.api setReproStepsConfigBugMode:bugMode crashMode:crashMode error:&error];
[self.api setReproStepsConfigBugMode:bugMode crashMode:crashMode sessionReplayMode:sessionReplayMode error:&error];

OCMVerify([self.mInstabug setReproStepsFor:IBGIssueTypeBug withMode:IBGUserStepsModeEnable]);
OCMVerify([self.mInstabug setReproStepsFor:IBGIssueTypeCrash withMode:IBGUserStepsModeDisable]);
OCMVerify([self.mInstabug setReproStepsFor:IBGIssueTypeSessionReplay withMode:IBGUserStepsModeDisable]);
}

- (void)testReportScreenChange {
Expand Down
7 changes: 6 additions & 1 deletion ios/Classes/Modules/InstabugApi.m
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ - (void)getUserAttributesWithCompletion:(nonnull void (^)(NSDictionary<NSString
completion(Instabug.userAttributes, nil);
}

- (void)setReproStepsConfigBugMode:(nullable NSString *)bugMode crashMode:(nullable NSString *)crashMode error:(FlutterError * _Nullable __autoreleasing * _Nonnull)error {
- (void)setReproStepsConfigBugMode:(nullable NSString *)bugMode crashMode:(nullable NSString *)crashMode sessionReplayMode:(nullable NSString *)sessionReplayMode error:(FlutterError * _Nullable __autoreleasing * _Nonnull)error {
if (bugMode != nil) {
IBGUserStepsMode resolvedBugMode = ArgsRegistry.reproModes[bugMode].integerValue;
[Instabug setReproStepsFor:IBGIssueTypeBug withMode:resolvedBugMode];
Expand All @@ -159,6 +159,11 @@ - (void)setReproStepsConfigBugMode:(nullable NSString *)bugMode crashMode:(nulla
IBGUserStepsMode resolvedCrashMode = ArgsRegistry.reproModes[crashMode].integerValue;
[Instabug setReproStepsFor:IBGIssueTypeCrash withMode:resolvedCrashMode];
}

if (sessionReplayMode != nil) {
IBGUserStepsMode resolvedSessionReplayMode = ArgsRegistry.reproModes[sessionReplayMode].integerValue;
[Instabug setReproStepsFor:IBGIssueTypeSessionReplay withMode:resolvedSessionReplayMode];
}
}

- (UIImage *)getImageForAsset:(NSString *)assetName {
Expand Down
12 changes: 9 additions & 3 deletions lib/src/modules/instabug.dart
Original file line number Diff line number Diff line change
Expand Up @@ -351,31 +351,36 @@ class Instabug {
}
}

/// Sets the repro steps mode for bugs and crashes.
/// Sets the repro steps mode for Bug Reporting, Crash Reporting and Session Replay.
///
/// [bug] repro steps mode for bug reports.
/// [crash] repro steps mode for crash reports.
/// [all] repro steps mode for both bug and crash reports, when present it
/// overrides [bug] and [crash].
/// [sessionReplay] repro steps mode for session replay.
/// [all] repro steps mode for bug reports, crash reports and session replay.
/// If [all] is set, it will override the other modes.
///
/// Example:
/// ```dart
/// Instabug.setReproStepsConfig(
/// bug: ReproStepsMode.enabled,
/// crash: ReproStepsMode.disabled,
/// sessionReplay: ReproStepsMode.enabled,
/// );
/// ```
static Future<void> setReproStepsConfig({
ReproStepsMode? bug,
ReproStepsMode? crash,
ReproStepsMode? sessionReplay,
ReproStepsMode? all,
}) async {
var bugMode = bug;
var crashMode = crash;
var sessionReplayMode = sessionReplay;

if (all != null) {
bugMode = all;
crashMode = all;
sessionReplayMode = all;
}

// There's an issue with crashes repro steps with screenshots in the iOS SDK
Expand All @@ -389,6 +394,7 @@ class Instabug {
return _host.setReproStepsConfig(
bugMode.toString(),
crashMode.toString(),
sessionReplayMode.toString(),
);
}

Expand Down
6 changes: 5 additions & 1 deletion pigeons/instabug.api.dart
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,11 @@ abstract class InstabugHostApi {
@async
Map<String, String>? getUserAttributes();

void setReproStepsConfig(String? bugMode, String? crashMode);
void setReproStepsConfig(
String? bugMode,
String? crashMode,
String? sessionReplayMode,
);
void reportScreenChange(String screenName);

void setCustomBrandingImage(String light, String dark);
Expand Down
10 changes: 8 additions & 2 deletions test/instabug_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -276,16 +276,22 @@ void main() {
test('[setReproStepsConfig] should call host method', () async {
const bug = ReproStepsMode.enabled;
const crash = ReproStepsMode.enabledWithNoScreenshots;
const sessionReplay = ReproStepsMode.disabled;

when(mBuildInfo.isIOS).thenReturn(false);

await Instabug.setReproStepsConfig(
bug: bug,
crash: crash,
sessionReplay: sessionReplay,
);

verify(
mHost.setReproStepsConfig(bug.toString(), crash.toString()),
mHost.setReproStepsConfig(
bug.toString(),
crash.toString(),
sessionReplay.toString(),
),
).called(1);
});

Expand All @@ -297,7 +303,7 @@ void main() {
await Instabug.setReproStepsConfig(all: all);

verify(
mHost.setReproStepsConfig(all.toString(), all.toString()),
mHost.setReproStepsConfig(all.toString(), all.toString(), all.toString()),
).called(1);
});

Expand Down