Ability to inherit auth credentials #917

orbaps · 2025-10-31T20:49:21Z

🚀 Pull Request: Auth Inheritance Feature

🧩 PR Description

This PR implements the Auth Inheritance Feature for the APIDash project — enabling requests to inherit authentication credentials from their active environment.

🌍 Overview

This brings Postman/Insomnia-like behavior, where users can define authentication at the environment level and reuse it across multiple requests automatically.

🔧 Problem

Previously, APIDash only supported per-request authentication, forcing users to manually configure identical credentials for multiple requests — causing:

Repetitive setup
Difficult credential management
Lack of centralized control

💡 Solution

Auth inheritance adds the ability for requests to use the environment’s default authentication when selected.
Implemented by:

Extending EnvironmentModel to include default authentication
Adding authInheritanceType in HttpRequestModel (Enum: none, environment)
Modifying CollectionStateNotifier to apply inherited auth dynamically
Enhancing the UI to manage and visualize inheritance states

⚙️ Key Technical Changes

Added defaultAuthModel field in EnvironmentModel
Added authInheritanceType field (AuthInheritanceType enum) in HttpRequestModel
Created AuthInheritanceType enum with values:
- none → Use request-specific auth
- environment → Inherit from environment
Updated request processing logic in CollectionStateNotifier
Added UI components:
- Dropdown for inheritance type selection
- Environment Auth tab for environment-level credentials
Added comprehensive test coverage for all new models, logic, and UI elements

🧠 Benefits

✅ Reduced Duplication: Single configuration for multiple requests
✅ Centralized Management: Modify environment-level auth once, apply everywhere
✅ Familiar Workflow: Mirrors Postman/Insomnia UX
✅ Backward Compatible: Default behavior unchanged (none)
✅ Environment Variable Support: Works with inherited credentials

🔗 Related Issues

Ability to inherit auth credentials #881

✅ Checklist

I have gone through the contributing guide
I have updated my branch and synced it with project main before making this PR
I am using the latest Flutter stable branch (flutter upgrade)
I have run all tests (flutter test) and verified they pass

🧪 Added / Updated Tests

We encourage you to add relevant test cases.

Yes
No, and this is why: please explain

💻 OS Used for Development and Testing

Windows
macOS
Linux

🧩 References

🧑‍💻 Author: @orbaps
📅 Date: 1st November

…edentials from environments

Copilot

Pull request overview

This PR implements an auth inheritance feature that allows HTTP requests to inherit authentication credentials from their active environment, similar to Postman/Insomnia behavior. This eliminates repetitive authentication configuration across multiple requests by centralizing auth at the environment level.

Key Changes:

Added AuthInheritanceType enum with none and environment values to control inheritance behavior
Extended EnvironmentModel with defaultAuthModel field to store environment-level authentication
Added authInheritanceType field to HttpRequestModel to specify whether a request inherits auth
Implemented auth resolution logic in CollectionStateNotifier that applies environment auth when inheritance is enabled
Created new UI components including environment auth editor tab and inheritance type dropdown

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
`test/models/environment_models_test.dart`	Added test cases for EnvironmentModel with defaultAuthModel field, covering copyWith, toJson, and fromJson operations
`test/models/environment_models.dart`	Added test data for EnvironmentModel with auth (`environmentModelWithAuth`) and corresponding JSON representation
`packages/better_networking/lib/models/http_request_model.dart`	Added `authInheritanceType` field to enable requests to specify their auth inheritance behavior
`packages/better_networking/lib/consts.dart`	Defined `AuthInheritanceType` enum with `none` and `environment` values for controlling auth inheritance
`packages/apidash_core/lib/models/environment_model.g.dart`	Updated generated JSON serialization code to handle `defaultAuthModel` field
`packages/apidash_core/lib/models/environment_model.dart`	Added `defaultAuthModel` field to store default authentication configuration at environment level
`lib/utils/envvar_utils.dart`	Added placeholder code block for auth inheritance (actual logic implemented in CollectionStateNotifier)
`lib/screens/home_page/editor_pane/details_card/request_pane/request_auth.dart`	Integrated auth inheritance type selection into request auth UI, passing callbacks to update state
`lib/screens/envvar/environment_editor.dart`	Restructured UI to use TabBar with Variables and Auth tabs for environment configuration
`lib/screens/envvar/environment_auth_editor.dart`	New component for managing environment-level default authentication configuration
`lib/screens/common_widgets/auth/auth_page.dart`	Enhanced to support auth inheritance dropdown and conditionally display auth fields based on inheritance type
`lib/providers/environment_providers.dart`	Updated `updateEnvironment` method to support updating `defaultAuthModel` field
`lib/providers/collection_providers.dart`	Implemented core auth inheritance logic that substitutes environment auth when inheritance is enabled

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-04T17:52:41Z

lib/providers/environment_providers.dart

    final updatedEnvironment = environment.copyWith(
      name: name ?? environment.name,
      values: values ?? environment.values,
+      defaultAuthModel: defaultAuthModel ?? environment.defaultAuthModel,


The defaultAuthModel update logic has a potential issue. When defaultAuthModel is null in the function arguments but exists in the current environment, it will preserve the existing value due to the ?? operator. However, if you want to explicitly remove the defaultAuthModel (set it to null), this logic prevents that.

Consider using a different pattern to allow explicit null values, such as using an Optional<T> wrapper or checking if the parameter was provided.

Copilot · 2025-12-04T17:52:41Z

lib/screens/common_widgets/auth/auth_page.dart

+            // Auth inheritance selection
+            if (!readOnly) ...[
+              ADPopupMenu<AuthInheritanceType>(
+                value: (authInheritanceType ?? AuthInheritanceType.none).displayType,
+                values: AuthInheritanceType.values
+                    .map((type) => (type, type.displayType))
+                    .toList(),
+                tooltip: "Select auth inheritance type",
+                isOutlined: true,
+                onChanged: onChangedAuthInheritanceType,
+              ),
+              const SizedBox(height: 16),
+            ],


The auth inheritance dropdown is shown for all non-readonly scenarios, but it should only be shown in the request auth editor, not in the environment auth editor. Environment-level auth is the source of inherited auth, so showing an inheritance dropdown there doesn't make logical sense.

Consider adding a parameter to conditionally show the inheritance dropdown, or pass a flag to disable it when used in environment context.

Copilot · 2025-12-04T17:52:42Z

lib/providers/collection_providers.dart

+    // Handle auth inheritance
+    HttpRequestModel processedRequestModel = httpRequestModel;
+    if (httpRequestModel.authInheritanceType == AuthInheritanceType.environment && 
+        activeEnvId != null && 
+        environments != null && 
+        environments[activeEnvId] != null) {
+
+      final environment = environments[activeEnvId]!;
+      if (environment.defaultAuthModel != null) {
+        processedRequestModel = httpRequestModel.copyWith(
+          authModel: environment.defaultAuthModel,
+        );
+      }
+    }


The auth inheritance logic in getSubstitutedHttpRequestModel lacks test coverage. Given the complexity of this feature and that it's a core part of the PR, tests should verify:

Auth is inherited when authInheritanceType is environment and environment has defaultAuthModel

Request-specific auth is used when authInheritanceType is none or null

Behavior when environment doesn't have defaultAuthModel

Behavior when no active environment is selected

Copilot · 2025-12-04T17:52:42Z

test/models/environment_models_test.dart

+      final environmentModelcopyWith =
+          environmentModel.copyWith(defaultAuthModel: newAuthModel);


Variable name environmentModelcopyWith should follow camelCase convention and have proper spacing. It should be environmentModelCopyWith (capital C in CopyWith).

This naming issue also appears on line 11 where it's first declared correctly but here it lacks proper casing.

Copilot · 2025-12-04T17:52:42Z

lib/utils/envvar_utils.dart

+  // Handle auth inheritance
+  AuthModel? finalAuthModel = httpRequestModel.authModel;
+  if (httpRequestModel.authInheritanceType == AuthInheritanceType.environment && 
+      activeEnvironmentId != null) {
+    // Get the environment model to access its default auth
+    // This would require access to the full environment models, not just variables
+    // For now, we'll handle this in the request processing where we have full environment access
+  }


This code block is incomplete and serves no purpose - it only contains a comment stating that functionality will be handled elsewhere. This is dead code that adds confusion.

Either remove this entire auth inheritance handling block (lines 74-81) since the actual implementation is in CollectionStateNotifier.getSubstitutedHttpRequestModel(), or add a comment explaining why this placeholder exists.

Copilot · 2025-12-04T17:52:43Z

packages/better_networking/lib/models/http_request_model.dart

    List<NameValueModel>? headers,
    List<NameValueModel>? params,
    @Default(AuthModel(type: APIAuthType.none)) AuthModel? authModel,
+    AuthInheritanceType? authInheritanceType, // Add auth inheritance type


The authInheritanceType field is added to HttpRequestModel but there are no tests covering its serialization, deserialization, or behavior. Given that other fields in this model have test coverage (as seen in http_request_model_test.dart), this field should have similar coverage to ensure:

It correctly serializes to/from JSON

It defaults to the correct value when missing from JSON

The copyWith method works correctly with it

Copilot · 2025-12-04T17:52:43Z

packages/better_networking/lib/consts.dart

+enum AuthInheritanceType {
+  none("None"),
+  environment("Environment");
+
+  const AuthInheritanceType(this.displayType);
+  final String displayType;
+}


The AuthInheritanceType enum lacks documentation explaining what each value means and when to use them. Consider adding documentation:

/// Defines how authentication credentials are determined for a request. enum AuthInheritanceType { /// Use request-specific authentication configuration. none("None"), /// Inherit authentication from the active environment's default auth. environment("Environment"); const AuthInheritanceType(this.displayType); final String displayType; }

Copilot · 2025-12-04T17:52:43Z

lib/screens/envvar/environment_editor.dart

+                                      SizedBox(width: 30),
+                                      Text("Variable"),
+                                      SizedBox(width: 30),
+                                      Text("Value"),
+                                      SizedBox(width: 40),


[nitpick] These SizedBox widgets should use const for better performance since they have constant dimensions:

const SizedBox(width: 30), Text("Variable"), const SizedBox(width: 30), Text("Value"), const SizedBox(width: 40),

Note: The Text widgets cannot be const as they are not literal strings in this context.

Copilot · 2025-12-04T17:52:43Z

lib/screens/common_widgets/auth/auth_page.dart

            SizedBox(
              height: 8,
            ),
-            ADPopupMenu<APIAuthType>(
-              value: authModel?.type.displayType,
-              values: APIAuthType.values
-                  .map((type) => (type, type.displayType))
-                  .toList(),
-              tooltip: kTooltipSelectAuth,
-              isOutlined: true,
-              onChanged: readOnly ? null : onChangedAuthType,
-            ),
-            const SizedBox(height: 48),
-            switch (authModel?.type) {
-              APIAuthType.basic => BasicAuthFields(
-                  readOnly: readOnly,
-                  authData: authModel,
-                  updateAuth: updateAuthData,
-                ),
-              APIAuthType.bearer => BearerAuthFields(
-                  readOnly: readOnly,
-                  authData: authModel,
-                  updateAuth: updateAuthData,
+            // Auth inheritance selection
+            if (!readOnly) ...[
+              ADPopupMenu<AuthInheritanceType>(
+                value: (authInheritanceType ?? AuthInheritanceType.none).displayType,
+                values: AuthInheritanceType.values
+                    .map((type) => (type, type.displayType))
+                    .toList(),
+                tooltip: "Select auth inheritance type",
+                isOutlined: true,
+                onChanged: onChangedAuthInheritanceType,
+              ),
+              const SizedBox(height: 16),


[nitpick] These SizedBox widgets should use const for better performance:

const SizedBox(height: 8),

and

const SizedBox(height: 16),

“Amarendra” added 2 commits November 1, 2025 01:52

Implement auth inheritance feature: Allow requests to inherit auth cr…

9133070

…edentials from environments

Fix missing imports for auth inheritance feature

4505b21

animator linked an issue Nov 12, 2025 that may be closed by this pull request

Ability to inherit auth credentials #881

Open

animator changed the title ~~Ability to inherit auth credentials #881~~ Ability to inherit auth credentials Nov 12, 2025

animator requested a review from Copilot December 4, 2025 17:43

Copilot started reviewing on behalf of animator December 4, 2025 17:43 View session

Copilot finished reviewing on behalf of animator December 4, 2025 17:48

Copilot AI reviewed Dec 4, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Ability to inherit auth credentials #917

Ability to inherit auth credentials #917

orbaps commented Oct 31, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Dec 4, 2025

Uh oh!

Copilot AI Dec 4, 2025

Uh oh!

Copilot AI Dec 4, 2025

Uh oh!

Copilot AI Dec 4, 2025

Uh oh!

Copilot AI Dec 4, 2025

Uh oh!

Copilot AI Dec 4, 2025

Uh oh!

Copilot AI Dec 4, 2025

Uh oh!

Copilot AI Dec 4, 2025

Uh oh!

Copilot AI Dec 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

		final environmentModelcopyWith =
		environmentModel.copyWith(defaultAuthModel: newAuthModel);

Ability to inherit auth credentials #917

Are you sure you want to change the base?

Ability to inherit auth credentials #917

Conversation

orbaps commented Oct 31, 2025

🚀 Pull Request: Auth Inheritance Feature

🧩 PR Description

🌍 Overview

🔧 Problem

💡 Solution

⚙️ Key Technical Changes

🧠 Benefits

🔗 Related Issues

✅ Checklist

🧪 Added / Updated Tests

💻 OS Used for Development and Testing

🧩 References

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant