Skip to content
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

[feat] auto switch GET -> POST when request body is added #181

Closed
wants to merge 5 commits into from
+96 −1
Closed

[feat] auto switch GET -> POST when request body is added #181

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0cd5c91
proposed fix with test
opxdelwin Feb 24, 2024
9c37218
add snackbar
opxdelwin Feb 24, 2024
28781b0
restore files
opxdelwin Feb 26, 2024
42bdd47
[refactor] remove unused import
opxdelwin Mar 3, 2024
1235176
Merge branch 'main' into issue-178
animator Mar 20, 2024
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
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

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

Revert all changes made to this file. You can keep a local version and not commit it to the PR.

Copy link
Member

Choose a reason for hiding this comment

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

@opxdelwin Why did you mark this conversation as resolved. It is the reviewer's task to review the changes and mark it resolved. Also, you have still not reverted all the changes that you made to this file.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I apologize for marking the conversation as resolved prematurely. I wasn't aware that it's the reviewer's responsibility to mark it resolved.

Regarding the .gitignore change, I made it to prevent the auto-generated hive files during testing from cluttering the codebase. Let me know whether to still revert changes.

I understand now that I should have let the reviewers close the conversation. I'll make sure to follow the correct process next time. Thanks for bringing it to my attention.

Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ migrate_working_dir/
.pub-cache/
.pub/
/build/
pubspec.lock

# Symbolication related
app.*.symbols
Expand All @@ -57,3 +58,6 @@ coverage/*
installers/*
.metadata
.fvm/

# unit tests hive storage
test/unit-test-hive-storage/
42 changes: 26 additions & 16 deletions lib/providers/collection_providers.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,23 +133,33 @@ class CollectionStateNotifier
String? message,
ResponseModel? responseModel,
}) {
// Switch from GET to POST if request has payload of any kind
// primarily, text, json and formData
if ((requestBody != null || requestFormDataList != null) &&
state![id]!.method == HTTPVerb.get) {
ref.read(autoSwitchPOSTStateProvider.notifier).state = true;
method = HTTPVerb.post;
ref.read(autoSwitchPOSTStateProvider.notifier).state = false;
}

final newModel = state![id]!.copyWith(
method: method,
url: url,
name: name,
description: description,
requestTabIndex: requestTabIndex,
requestHeaders: requestHeaders,
requestParams: requestParams,
isHeaderEnabledList: isHeaderEnabledList,
isParamEnabledList: isParamEnabledList,
requestBodyContentType: requestBodyContentType,
requestBody: requestBody,
requestFormDataList: requestFormDataList,
responseStatus: responseStatus,
message: message,
responseModel: responseModel);
//print(newModel);
method: method,
url: url,
name: name,
description: description,
requestTabIndex: requestTabIndex,
requestHeaders: requestHeaders,
requestParams: requestParams,
isHeaderEnabledList: isHeaderEnabledList,
isParamEnabledList: isParamEnabledList,
requestBodyContentType: requestBodyContentType,
requestBody: requestBody,
requestFormDataList: requestFormDataList,
responseStatus: responseStatus,
message: message,
responseModel: responseModel,
);

var map = {...state!};
map[id] = newModel;
state = map;
Expand Down
5 changes: 5 additions & 0 deletions lib/providers/ui_providers.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ final sentRequestIdStateProvider = StateProvider<String?>((ref) => null);
final codePaneVisibleStateProvider = StateProvider<bool>((ref) => false);
final saveDataStateProvider = StateProvider<bool>((ref) => false);
final clearDataStateProvider = StateProvider<bool>((ref) => false);

/// As part of UX, when body is added to GET requests, they're
/// auto converted to POST requests. UI Snackbar trigger for the same
final autoSwitchPOSTStateProvider = StateProvider<bool>((ref) => false);

// final nameTextFieldControllerProvider =
// StateProvider.autoDispose<TextEditingController>((ref) {
// TextEditingController controller = TextEditingController(text: "");
Expand Down
13 changes: 12 additions & 1 deletion lib/screens/home_page/editor_pane/details_card/request_pane/request_pane.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import 'package:flutter/material.dart';
import 'package:flutter/scheduler.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:apidash/providers/providers.dart';
import 'package:apidash/widgets/widgets.dart';
Expand All @@ -14,7 +15,8 @@ class EditRequestPane extends ConsumerWidget {
final selectedId = ref.watch(selectedIdStateProvider);
final codePaneVisible = ref.watch(codePaneVisibleStateProvider);
final tabIndex = ref.watch(
selectedRequestModelProvider.select((value) => value?.requestTabIndex));
selectedRequestModelProvider.select((value) => value?.requestTabIndex),
);

final headerLength = ref.watch(selectedRequestModelProvider
.select((value) => value?.headersMap.length));
Expand All @@ -23,6 +25,15 @@ class EditRequestPane extends ConsumerWidget {
final bodyLength = ref.watch(selectedRequestModelProvider
.select((value) => value?.requestBody?.length));

// show snackbar when auto switch triggers
ref.listen(autoSwitchPOSTStateProvider, (_, currentValue) {
if (currentValue) {
final sm = ScaffoldMessenger.of(context);
sm.hideCurrentSnackBar();
sm.showSnackBar(getSnackBar('Switching to POST Request'));
}
});

return RequestPane(
selectedId: selectedId,
codePaneVisible: codePaneVisible,
Expand Down
Loading