Skip to content

Fix: Issue #393 #395

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

Open
jxstxn1 wants to merge 6 commits into
base: stable
Choose a base branch
from
Open

Fix: Issue #393 #395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4dcf45c
Add test to reproduce Issue #393
jxstxn1 Oct 27, 2025
e7bc5d7
fix issue
jxstxn1 Oct 27, 2025
1e9c7eb
update test cases
jxstxn1 Oct 27, 2025
b8920c9
make tests more comprehensive to test more cases
jxstxn1 Oct 30, 2025
0431547
approach reseting metadata more gracefully
jxstxn1 Oct 30, 2025
6ac4e0f
test if function gets called
jxstxn1 Oct 30, 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
6 changes: 6 additions & 0 deletions lib/src/core/wiredash_controller.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ class WiredashController {
bool? inheritCupertinoTheme,
WiredashFeedbackOptions? options,
}) async {
print(options != null);
_captureAppTheme(inheritMaterialTheme, inheritCupertinoTheme);
_captureSessionMetaData();
_model.feedbackOptionsOverride = options;
Expand All @@ -173,6 +174,11 @@ class WiredashController {
final result = FeedbackResult(
hasSubmittedFeedback: hasSubmittedFeedback,
);

// reset the metadata at the end of the feedback flow to avoid leaking metadata between feedbacks
_model.customizableMetaData =
_model.customizableMetaData.copyWith(custom: {});

return result;
}

Expand Down
316 changes: 316 additions & 0 deletions test/issues/issue_393_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,316 @@
import 'package:flutter/material.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:wiredash/src/feedback/feedback_model.dart';
import 'package:wiredash/wiredash.dart';

import '../util/invocation_catcher.dart';
import '../util/robot.dart';

void main() {
group('issue 393', () {
group('collectMetaData', () {
testWidgets(
'metadata should be encapsulated per opened Wiredash Feedback and be merged with collectMetaData and modifyMetaData',
(tester) async {
final robot = WiredashTestRobot(tester);

MapEntry<String, String> customMetaData = const MapEntry('foo', 'bar');

await robot.launchApp(
collectMetaData: (metaData) {
return metaData
..userEmail = "user@mail.com"
..userId = "123"
..custom['foz'] = 'baz';
},
builder: (context) {
return Scaffold(
body: Column(
children: [
GestureDetector(
onTap: () async {
final wiredash = Wiredash.of(context);

wiredash.modifyMetaData(
(metaData) {
return metaData
..custom[customMetaData.key] = customMetaData.value;
},
);
wiredash.show();
},
child: const Text('Feedback'),
),
],
),
);
},
);

await robot.submitMinimalFeedback();
AssertableInvocation latestCall =
robot.mockServices.mockApi.sendFeedbackInvocations.latest;
final firstFeedback = latestCall[0] as FeedbackItem?;

expect(firstFeedback!.metadata.userEmail, 'user@mail.com');
expect(firstFeedback.metadata.userId, '123');
expect(firstFeedback.metadata.custom!['foz'], 'baz');
expect(firstFeedback.metadata.custom!['foo'], 'bar');

customMetaData = const MapEntry('bar', 'foo');

await robot.submitMinimalFeedback();
latestCall = robot.mockServices.mockApi.sendFeedbackInvocations.latest;
final secondFeedback = latestCall[0] as FeedbackItem?;
expect(secondFeedback!.metadata.custom, hasLength(2));

expect(secondFeedback.metadata.userEmail, 'user@mail.com');
expect(secondFeedback.metadata.userId, '123');
expect(secondFeedback.metadata.custom!['foz'], 'baz');
expect(secondFeedback.metadata.custom!['bar'], 'foo');
});

testWidgets(
'metadata should be encapsulated per opened Wiredash Feedback and be merged with collectMetaData',
(tester) async {
final robot = WiredashTestRobot(tester);

MapEntry<String, String> customMetaData = const MapEntry('foo', 'bar');

int collectMetaDataFunctionCalls = 0;

await robot.launchApp(
collectMetaData: (metaData) {
return metaData
..userEmail = "user@mail.com"
..userId = "123"
..custom['foz'] = 'baz';
},
builder: (context) {
return Scaffold(
body: Column(
children: [
GestureDetector(
onTap: () async {
final wiredash = Wiredash.of(context);
wiredash.show(
options: WiredashFeedbackOptions(
collectMetaData: (metaData) {
collectMetaDataFunctionCalls++;
return metaData
..custom[customMetaData.key] =
customMetaData.value;
},
),
);
},
child: const Text('Feedback'),
),
],
),
);
},
);

await robot.submitMinimalFeedback();
AssertableInvocation latestCall =
robot.mockServices.mockApi.sendFeedbackInvocations.latest;
final firstFeedback = latestCall[0] as FeedbackItem?;

expect(collectMetaDataFunctionCalls, 1); // we fail here

expect(firstFeedback!.metadata.userEmail, 'user@mail.com');
expect(firstFeedback.metadata.userId, '123');
expect(firstFeedback.metadata.custom!['foz'], 'baz');
expect(firstFeedback.metadata.custom!['foo'], 'bar');

customMetaData = const MapEntry('bar', 'foo');

await robot.submitMinimalFeedback();
latestCall = robot.mockServices.mockApi.sendFeedbackInvocations.latest;
final secondFeedback = latestCall[0] as FeedbackItem?;

expect(secondFeedback!.metadata.custom, hasLength(2));
expect(secondFeedback.metadata.userEmail, 'user@mail.com');
expect(secondFeedback.metadata.userId, '123');
expect(secondFeedback.metadata.custom!['foz'], 'baz');
expect(secondFeedback.metadata.custom!['bar'], 'foo');
});
});
group('WiredashFeedbackOptions.collectMetaData', () {
testWidgets('''
metadata should be encapsulated per opened Wiredash Feedback
and be merged with WiredashFeedbackOptions.collectMetaData when calling modifyMetaData''',
(tester) async {
final robot = WiredashTestRobot(tester);

MapEntry<String, String> customMetaData = const MapEntry('foo', 'bar');

await robot.launchApp(
feedbackOptions: WiredashFeedbackOptions(
collectMetaData: (metaData) {
return metaData
..userEmail = "user@mail.com"
..userId = "123"
..custom['foz'] = 'baz';
},
),
builder: (context) {
return Scaffold(
body: Column(
children: [
GestureDetector(
onTap: () async {
final wiredash = Wiredash.of(context);
wiredash.modifyMetaData(
(metaData) {
return metaData
..custom[customMetaData.key] = customMetaData.value;
},
);
wiredash.show();
},
child: const Text('Feedback'),
),
],
),
);
},
);

await robot.submitMinimalFeedback();
AssertableInvocation latestCall =
robot.mockServices.mockApi.sendFeedbackInvocations.latest;
final firstFeedback = latestCall[0] as FeedbackItem?;

expect(firstFeedback!.metadata.userEmail, 'user@mail.com');
expect(firstFeedback.metadata.userId, '123');
expect(firstFeedback.metadata.custom!['foz'], 'baz');
expect(firstFeedback.metadata.custom!['foo'], 'bar');

customMetaData = const MapEntry('bar', 'foo');

await robot.submitMinimalFeedback();
latestCall = robot.mockServices.mockApi.sendFeedbackInvocations.latest;
final secondFeedback = latestCall[0] as FeedbackItem?;
expect(secondFeedback!.metadata.custom, hasLength(2));
expect(secondFeedback.metadata.userEmail, 'user@mail.com');
expect(secondFeedback.metadata.userId, '123');
expect(secondFeedback.metadata.custom!['foz'], 'baz');
expect(secondFeedback.metadata.custom!['bar'], 'foo');
});

testWidgets('''
metadata should be encapsulated per opened Wiredash Feedback
and feedbackOptions of show should override WiredashFeedbackOptions.collectMetaData''',
(tester) async {
final robot = WiredashTestRobot(tester);

MapEntry<String, String> customMetaData = const MapEntry('foo', 'bar');

await robot.launchApp(
feedbackOptions: WiredashFeedbackOptions(
collectMetaData: (metaData) {
return metaData
..userEmail = "user@mail.com"
..userId = "123"
..custom['foz'] = 'baz';
},
),
builder: (context) {
return Scaffold(
body: Column(
children: [
GestureDetector(
onTap: () async {
final wiredash = Wiredash.of(context);
wiredash.show(
options: WiredashFeedbackOptions(
collectMetaData: (metaData) {
return metaData
..custom[customMetaData.key] =
customMetaData.value;
},
),
);
},
child: const Text('Feedback'),
),
],
),
);
},
);

await robot.submitMinimalFeedback();
AssertableInvocation latestCall =
robot.mockServices.mockApi.sendFeedbackInvocations.latest;
final firstFeedback = latestCall[0] as FeedbackItem?;

expect(firstFeedback!.metadata.custom!['foo'], 'bar');

customMetaData = const MapEntry('bar', 'foo');

await robot.submitMinimalFeedback();
latestCall = robot.mockServices.mockApi.sendFeedbackInvocations.latest;
final secondFeedback = latestCall[0] as FeedbackItem?;
expect(secondFeedback!.metadata.custom, hasLength(1));
expect(secondFeedback.metadata.custom!['bar'], 'foo');
});
});

testWidgets(
'metadata should be encapsulated per opened Wiredash Feedback and be merged with setUserData',
(tester) async {
final robot = WiredashTestRobot(tester);

MapEntry<String, String> customMetaData = const MapEntry('foo', 'bar');

await robot.launchApp(
builder: (context) {
return Scaffold(
body: Column(
children: [
GestureDetector(
onTap: () async {
final wiredash = Wiredash.of(context);
wiredash.show(options: WiredashFeedbackOptions(
collectMetaData: (metaData) {
return metaData
..custom[customMetaData.key] = customMetaData.value;
},
));
},
child: const Text('Feedback'),
),
],
),
);
},
);

robot.wiredashController.setUserProperties(
userEmail: "user@mail.com",
userId: "123",
);

await robot.submitMinimalFeedback();
AssertableInvocation latestCall =
robot.mockServices.mockApi.sendFeedbackInvocations.latest;
final firstFeedback = latestCall[0] as FeedbackItem?;
expect(firstFeedback!.metadata.userEmail, 'user@mail.com');
expect(firstFeedback.metadata.userId, '123');
expect(firstFeedback.metadata.custom!['foo'], 'bar');

customMetaData = const MapEntry('bar', 'foo');

await robot.submitMinimalFeedback();
latestCall = robot.mockServices.mockApi.sendFeedbackInvocations.latest;
final secondFeedback = latestCall[0] as FeedbackItem?;
expect(secondFeedback!.metadata.custom, hasLength(1));
expect(secondFeedback.metadata.userEmail, 'user@mail.com');
expect(secondFeedback.metadata.userId, '123');
expect(secondFeedback.metadata.custom!['bar'], 'foo');
});
});
}
Loading