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.

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

Introduce New Templates for Custom Authenticators #6226

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

Shenali-SJ
Copy link
Contributor

@Shenali-SJ Shenali-SJ commented Dec 19, 2024

Proposed changes in this pull request

This PR introduces new JSON files related to custom authenticators. Three types of custom authenticators are introduced which will be grouped under a generic custom-authentication template.

Following are the template-ids of the newly added templates.

  • custom-authentication (group)
  • external-custom-authentication
  • internal-custom-authentication
  • twofactor-custom-authentication

The following is the proposed UI design that'd display the rendered content. This will be added to the product as a new connection.
image

Related Emails:
[Architecture] Facilitate user authentication via a external service (custom authentication extension)

Related Issue

When should this PR be merged

[Please describe any preconditions that need to be addressed before we
can merge this pull request.]

Follow up actions

[List any possible follow-up actions here; for instance, testing data
migrations, software that we need to install on staging and production
environments.]

Checklist (for reviewing)

General

  • Is this PR explained thoroughly? All code changes must be accounted for in the PR description.
  • Is the PR labeled correctly?

Functionality

  • Are all requirements met? Compare implemented functionality with the requirements specification.
  • Does the UI work as expected? There should be no Javascript errors in the console; all resources should load. There should be no unexpected errors. Deliberately try to break the feature to find out if there are corner cases that are not handled.

Code

  • Do you fully understand the introduced changes to the code? If not ask for clarification, it might uncover ways to solve a problem in a more elegant and efficient way.
  • Does the PR introduce any inefficient database requests? Use the debug server to check for duplicate requests.
  • Are all necessary strings marked for translation? All strings that are exposed to users via the UI must be marked for translation.

Tests

  • Are there sufficient test cases? Ensure that all components are tested individually; models, forms, and serializers should be tested in isolation even if a test for a view covers these components.
  • If this is a bug fix, are tests for the issue in place? There must be a test case for the bug to ensure the issue won’t regress. Make sure that the tests break without the new code to fix the issue.
  • If this is a new feature or a significant change to an existing feature? has the manual testing spreadsheet been updated with instructions for manual testing?

Security

  • Confirm this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets.
  • Are all UI and API inputs run through forms or serializers?
  • Are all external inputs validated and sanitized appropriately?
  • Does all branching logic have a default case?
  • Does this solution handle outliers and edge cases gracefully?
  • Are all external communications secured and restricted to SSL?

Documentation

  • Are changes to the UI documented in the platform docs? If this PR introduces new platform site functionality or changes existing ones, the changes should be documented.
  • Are changes to the API documented in the API docs? If this PR introduces new API functionality or changes existing ones, the changes must be documented.
  • Are reusable components documented? If this PR introduces components that are relevant to other developers (for instance a mixin for a view or a generic form) they should be documented in the Wiki.

Copy link

codecov bot commented Dec 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 45.65%. Comparing base (b492a3d) to head (0861eb8).
Report is 75 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff              @@
##             master    #6226      +/-   ##
============================================
- Coverage     45.66%   45.65%   -0.02%     
- Complexity    14040    14209     +169     
============================================
  Files          1632     1638       +6     
  Lines        100532   102651    +2119     
  Branches      17421    16959     -462     
============================================
+ Hits          45911    46865     +954     
- Misses        47931    48962    +1031     
- Partials       6690     6824     +134     
Flag Coverage Δ
unit 28.40% <ø> (+0.10%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

"name": "Custom Authentication",
"description": "Enable login for users with external authentication service.",
"image": "",
"category": "DEFAULT",
Copy link
Contributor

Choose a reason for hiding this comment

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

What is meant by this param. What are the other available categories

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Currently, all the available connections fall under the DEFAULT category. If we are introducing a new category with custom authentication, we would have to initiate that separately.

"description": "Enable login for users with external authentication service.",
"image": "",
"category": "DEFAULT",
"displayOrder": -1,
Copy link
Contributor

Choose a reason for hiding this comment

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

What is meant by -1. What is purpose of this parameter

Copy link
Contributor Author

@Shenali-SJ Shenali-SJ Dec 19, 2024

Choose a reason for hiding this comment

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

This is to represent the order in which the card will be displayed on the connections page. -1 implies that the specific card would be skipped from the order by and will be displayed at the end of the list.

@CLAassistant
Copy link

CLAassistant commented Jan 2, 2025

CLA assistant check
All committers have signed the CLA.

@Shenali-SJ Shenali-SJ force-pushed the custom-authentication branch from 0b87e26 to 2187fe9 Compare January 2, 2025 07:07
@Shenali-SJ Shenali-SJ force-pushed the custom-authentication branch from bfecc94 to 8e22f37 Compare January 2, 2025 07:12
Copy link

sonarqubecloud bot commented Jan 2, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants