GSoC 2025: DashBot and API Authentication

[animator]

Discussions on GSoC 2025 project
https://summerofcode.withgoogle.com/programs/2025/projects/1Yf6TmCm

[Udhay-Adithya]

Can I create a dashbot directory inside lib/test to write dashbot specific tests? Or can I write new tests along with the existing tests?

[animator]

why not have dashbot as a separate package with all features/models/UI and its own tests.
It will be modular and much better approach.

[Udhay-Adithya]

Yes, this approach will work the best

[Udhay-Adithya]

To-dos after the meeting on 05/06/2025

• Isolate Dashbot into a separate package
• Start working on API Authentication Methods (only Basic Auth, API Key, Bearer, and JWT Bearer for now)
  • Create an enum APIAuthType in the apidash_core package to identify various authentication types
  • Create APIAuthModel in apidash_core to handle all authentication data
  • Create an "Authorization" tab to accept authentication details
  • Modify RequestModel to include APIAuthType and APIAuthModel
  • Update http_service.dart in apidash_core to handle all supported authentication methods
  • Improve the UI/UX of the Authorization tab
  • Write tests

[Udhay-Adithya]

To-dos after meeting on 11/06/2025

• Take a look into the JSON format of other api clients for different auths
  • https://gist.github.com/Udhay-Adithya/3215d0ac511a0893d901eb58c6aab059
• Modify the existing implementation to use newly discussed ApiAuthModel
• Add missing fields in JWT
• Extend the Authorization tab support for Histroy Page
• Add Hive support for ApiAuthModel

[animator]

Add link to your research here.

[Udhay-Adithya]

To-dos after meeting on 14/06/2025

• Change Authorization to Auth
• Auth tab should come after Params
• Fix Imports
• Change ApiAuthModel -> AuthModel and authData -> authModel
• Follow APIDash design system for UI
• Split request_auth.dart into maintainable small files
• Upgrade Flutter version to latest and regenerate pubspec.lock files

Find any other way using any external packages to build the request_auth UI

[Udhay-Adithya]

Pre-request and Post-Response Scripting

• Add user guide
• Modify the dropdown to follow APIDash design system
• Add Scripts tab support for request history
• Add Scripts tab support for GraphQL
• Fix code editor UI issues
  • Find a better package for this if possible
• Add tests

[animator]

In scripting, there is console logging mentioned, where are the logs shown to the end user?

[Udhay-Adithya]

Right now it is not displayed anywhere to the end user. If we can have our own built-in Terminal(accessed via a global status bar) then we can display all the logs over there.

[Udhay-Adithya]

To-dos after meeting on 29/06/2025

• Create a separate Logs tab
• Polish the current Authentication PR for review(current priority)
• Work on the remaining Authentication features(current priority)
• Setup a meeting with @DenserMeerkat for testing related doubts tomorrow

[Udhay-Adithya]

Meeting Notes

Date: 30/06/2025

• Cleared generating coverage doubts.
• Cleared Unit testing, Widget testing and Integration testing related doubts.
• Discussed fix for request model being modified when pre-post scripting or post-response scripting is done.
• Fix state issue in scripting and minor ui flaws(#862)

[Udhay-Adithya]

To-dos after meeting on 02/07/2025

• Resolve basic-auth PR as soon as possible and send it for review
• Move AuthModel to where http_request_model.dart is
• Use code_pane.dart as reference for fixing active env id error in scripts

[animator]

@Udhay-Adithya Auth APIs that you added are now live here
https://api.apidash.dev/docs

[animator]

• Testing of pre-request/post-request is pending

[Udhay-Adithya]

PR: #865

[animator]

• Adding api.apidash.dev auth apis as examples and test cases

[Udhay-Adithya]

To-dos after meeting on 18/07/2025

• Write tests for pre-request/post-response scripts
• Implement env var support for Authentication Tab Fields
• Implement OAuth1.0
• Implement OAuth2.0

Try to keep the UI consistent with the existing APIDash UI style

[Udhay-Adithya]

To-dos after meeting on 31/07/2025

• Run a http server locally and listen to it in desktop platforms.
• Store the temporary credential file in same directory where apidash user generated data is stored.
• Document things in this discussion atleaast 3 - 4 times a week

[Udhay-Adithya]

03/08/2025

• Added support to spin up a local http server in desktop platforms for oauth2 callbacks
• Changed the oauth credentials file directory to use apidash workspace directory
• Added improvements to oauth2 ui

I tried using flutter_web_auth_2 to render a web view for completing the OAuth2 flow. This web view inside flutter_web_auth_2 is designed to close itself when the given callback URI scheme is detected. However, it fails to detect the http scheme for some reason. As a result, the browser tab does not close automatically, and when we try to close it manually (even after successful authorization), it throws PlatformException(CANCELED, User canceled login, null, null). exception.
Related issue: Browser / Webview doesn’t close after successful callback on Android

Known bugs:
Unable to cancel oauth2 request when oauth2 authorization tab is closed accidentally or intentionally.

[Udhay-Adithya]

To-dos after meeting on 05/08/2025

• Write tests for oauth.
• Document the limitations of all authentication features in a new dev doc

[animator]

Note: find.descendant approach is better

[Udhay-Adithya]

07/08/2025

• Remove all log statements
• Remove timeago package dependency
• Update oauth1 and oauth2 widgets to use EnvAuthField
• Update oauth1 and oauth2 widget tests to support EnvAuthField
• Add support for env vars using EnvAuthField
• Make credentialsFilePath property nullable
• Use sendHttpRequestV1 in digest auth instead of sendHttpRequest

[Udhay-Adithya]

To-dos after meeting on 09/08/2025

• Write user guide for all Auth related features

[Udhay-Adithya]

To-dos after meeting on 15/08/2025

• Fix the state management for dropdowns in OAuth fields

[Udhay-Adithya]

16/08/2025

• Add setState calls that are missing when the dropdown values change in OAuth fields