-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
🪟🎉 Connector builder: Session token and oauth authentication #20712
Merged
flash1293
merged 6 commits into
flash1293/connector-builder-authentication
from
flash1293/oauth-session-auth
Dec 22, 2022
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
a17ab05
session token and oauth authentication
7b6470e
fill in session token variable
84803ce
Merge branch 'flash1293/connector-builder-authentication' into flash1…
4bd0bdc
typos
ca0219b
make sure validation error does not go away
cd79194
Merge branch 'flash1293/connector-builder-authentication' into flash1…
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
179 changes: 179 additions & 0 deletions
179
airbyte-webapp/src/components/connectorBuilder/Builder/AuthenticationSection.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| import { BuilderCard } from "./BuilderCard"; | ||
| import { BuilderField } from "./BuilderField"; | ||
| import { BuilderOneOf } from "./BuilderOneOf"; | ||
| import { BuilderOptional } from "./BuilderOptional"; | ||
| import { KeyValueListField } from "./KeyValueListField"; | ||
| import { UserInputField } from "./UserInputField"; | ||
|
|
||
| export const AuthenticationSection: React.FC = () => { | ||
| return ( | ||
| <BuilderCard> | ||
| <BuilderOneOf | ||
| path="global.authenticator" | ||
| label="Authentication" | ||
| tooltip="Authentication method to use for requests sent to the API" | ||
| options={[ | ||
| { label: "No Auth", typeValue: "NoAuth" }, | ||
| { | ||
| label: "API Key", | ||
| typeValue: "ApiKeyAuthenticator", | ||
| default: { | ||
| api_token: "{{ config['api_key'] }}", | ||
| header: "", | ||
| }, | ||
| children: ( | ||
| <> | ||
| <BuilderField | ||
| type="string" | ||
| path="global.authenticator.header" | ||
| label="Header" | ||
| tooltip="HTTP header which should be set to the API Key" | ||
| /> | ||
| <UserInputField | ||
| label="API Key" | ||
| tooltip="The API key issued by the service. Fill it in in the user inputs" | ||
| /> | ||
| </> | ||
| ), | ||
| }, | ||
| { | ||
| label: "Bearer", | ||
| typeValue: "BearerAuthenticator", | ||
| default: { | ||
| api_token: "{{ config['api_key'] }}", | ||
| }, | ||
| children: ( | ||
| <UserInputField | ||
| label="API Key" | ||
| tooltip="The API key issued by the service. Fill it in in the user inputs" | ||
| /> | ||
| ), | ||
| }, | ||
| { | ||
| label: "Basic HTTP", | ||
| typeValue: "BasicHttpAuthenticator", | ||
| default: { | ||
| username: "{{ config['username'] }}", | ||
| password: "{{ config['password'] }}", | ||
| }, | ||
| children: ( | ||
| <> | ||
| <UserInputField label="Username" tooltip="The username for the login. Fill it in in the user inputs" /> | ||
| <UserInputField label="Password" tooltip="The password for the login. Fill it in in the user inputs" /> | ||
| </> | ||
| ), | ||
| }, | ||
| { | ||
| label: "OAuth", | ||
| typeValue: "OAuthAuthenticator", | ||
| default: { | ||
| client_id: "{{ config['client_id'] }}", | ||
| client_secret: "{{ config['client_secret'] }}", | ||
| refresh_token: "{{ config['client_refresh_token'] }}", | ||
| refresh_request_body: [], | ||
| token_refresh_endpoint: "", | ||
| }, | ||
| children: ( | ||
| <> | ||
| <BuilderField | ||
| type="string" | ||
| path="global.authenticator.token_refresh_endpoint" | ||
| label="Token refresh endpoint" | ||
| tooltip="The URL to call to obtain a new access token" | ||
| /> | ||
| <UserInputField label="Client ID" tooltip="The OAuth client ID" /> | ||
| <UserInputField label="Client secret" tooltip="The OAuth client secret" /> | ||
| <UserInputField label="Refresh token" tooltip="The OAuth refresh token" /> | ||
| <BuilderOptional> | ||
| <BuilderField | ||
| type="array" | ||
| path="global.authenticator.scopes" | ||
| optional | ||
| label="Scopes" | ||
| tooltip="Scopes to request" | ||
| /> | ||
| <BuilderField | ||
| type="array" | ||
| path="global.authenticator.token_expiry_date_format" | ||
| optional | ||
| label="Token expiry date format" | ||
| tooltip="The format of the expiry date of the access token as obtained from the refresh endpoint" | ||
| /> | ||
| <BuilderField | ||
| type="string" | ||
| path="global.authenticator.expires_in_name" | ||
| optional | ||
| label="Token expiry property name" | ||
| tooltip="The name of the property which contains the token exipiry date in the response from the token refresh endpoint" | ||
| /> | ||
| <BuilderField | ||
| type="string" | ||
| path="global.authenticator.access_token_name" | ||
| optional | ||
| label="Access token property name" | ||
| tooltip="The name of the property which contains the access token in the response from the token refresh endpoint" | ||
| /> | ||
| <BuilderField | ||
| type="string" | ||
| path="global.authenticator.grant_type" | ||
| optional | ||
| label="Grant type" | ||
| tooltip="The grant type to request for access_token" | ||
| /> | ||
| <KeyValueListField | ||
| path="global.authenticator.refresh_request_body" | ||
| label="Request Parameters" | ||
| tooltip="The request body to send in the refresh request" | ||
| /> | ||
| </BuilderOptional> | ||
| </> | ||
| ), | ||
| }, | ||
| { | ||
| label: "Session token", | ||
| typeValue: "SessionTokenAuthenticator", | ||
| default: { | ||
| username: "{{ config['username'] }}", | ||
| password: "{{ config['password'] }}", | ||
| session_token: "{{ config['session_token'] }}", | ||
| }, | ||
| children: ( | ||
| <> | ||
| <BuilderField | ||
| type="string" | ||
| path="global.authenticator.header" | ||
| label="Header" | ||
| tooltip="Specific HTTP header of source API for providing session token" | ||
| /> | ||
| <BuilderField | ||
| type="string" | ||
| path="global.authenticator.session_token_response_key" | ||
| label="Session token response key" | ||
| tooltip="Key for retrieving session token from api response" | ||
| /> | ||
| <BuilderField | ||
| type="string" | ||
| path="global.authenticator.login_url" | ||
| label="Login url" | ||
| tooltip="Url for getting a specific session token" | ||
| /> | ||
| <BuilderField | ||
| type="string" | ||
| path="global.authenticator.validate_session_url" | ||
| label="Validate session url" | ||
| tooltip="Url to validate passed session token" | ||
| /> | ||
| <UserInputField label="Username" tooltip="The username" /> | ||
| <UserInputField label="Password" tooltip="The password" /> | ||
| <UserInputField | ||
| label="Session token" | ||
| tooltip="Session token generated by user (if provided username and password are not required)" | ||
| /> | ||
| </> | ||
| ), | ||
| }, | ||
| ]} | ||
| /> | ||
| </BuilderCard> | ||
| ); | ||
| }; |
34 changes: 34 additions & 0 deletions
34
airbyte-webapp/src/components/connectorBuilder/Builder/BuilderOptional.module.scss
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| @use "scss/variables"; | ||
| @use "scss/colors"; | ||
| @use "scss/mixins"; | ||
|
|
||
| .wrapper { | ||
| display: flex; | ||
| flex-direction: column; | ||
| align-items: flex-start; | ||
| border-top: variables.$border-thin solid colors.$grey-100; | ||
| gap: variables.$spacing-lg; | ||
| } | ||
|
|
||
| .container { | ||
| padding-left: variables.$spacing-xl; | ||
| display: flex; | ||
| flex-direction: column; | ||
| align-items: stretch; | ||
| align-self: stretch; | ||
| gap: variables.$spacing-lg; | ||
| } | ||
|
|
||
| .label { | ||
| cursor: pointer; | ||
| background: none; | ||
| border: none; | ||
| display: flex; | ||
| gap: variables.$spacing-sm; | ||
| margin-top: variables.$spacing-lg; | ||
| align-items: center; | ||
|
|
||
| &.closed { | ||
| color: colors.$grey-400; | ||
| } | ||
| } |
25 changes: 25 additions & 0 deletions
25
airbyte-webapp/src/components/connectorBuilder/Builder/BuilderOptional.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| import { faAngleDown, faAngleRight } from "@fortawesome/free-solid-svg-icons"; | ||
| import { FontAwesomeIcon } from "@fortawesome/react-fontawesome"; | ||
| import classNames from "classnames"; | ||
| import React, { useState } from "react"; | ||
| import { FormattedMessage } from "react-intl"; | ||
|
|
||
| import styles from "./BuilderOptional.module.scss"; | ||
|
|
||
| export const BuilderOptional: React.FC<React.PropsWithChildren<unknown>> = ({ children }) => { | ||
| const [isOpen, setIsOpen] = useState(false); | ||
| return ( | ||
| <div className={styles.wrapper}> | ||
| <button | ||
| onClick={() => { | ||
| setIsOpen(!isOpen); | ||
| }} | ||
| className={classNames(styles.label, { [styles.closed]: !isOpen })} | ||
| > | ||
| {isOpen ? <FontAwesomeIcon icon={faAngleDown} /> : <FontAwesomeIcon icon={faAngleRight} />} | ||
| <FormattedMessage id="connectorBuilder.optionalFieldsLabel" /> | ||
| </button> | ||
| {isOpen && <div className={styles.container}>{children}</div>} | ||
| </div> | ||
| ); | ||
| }; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It isn't a huge deal, but when this is clicked it clears out any errors that are shown on the required fields.
To reproduce: select OAuth, click into Token refresh endpoint, click away (Required error is shown), click on Optional fields. Happens both when closing and when opening.
Ideally, the errors shown on the required fields would not go away just because optional fields are opened or closed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Formik is starting to annoy me... I played around a bit and noticed that if you type something into the field, then delete it again it will not remove the error on opening the collapsed section. So I just preset it with an empty string and now it works.