feat: database extension registry #23174

betodealmeida · 2023-02-23T17:17:32Z

SUMMARY

Allow the implementation of custom extensions to customize databases via setupExtensions.ts.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

WIP

TESTING INSTRUCTIONS

Writing tests.

ADDITIONAL INFORMATION

Has associated issue:
Required feature flags:
Changes UI
Includes DB Migration (follow approval process in SIP-59)
- Migration is atomic, supports rollback & is backwards-compatible
- Confirm DB migration upgrade and downgrade tested
- Runtime estimates and downtime expectations provided
Introduces new feature or API
Removes existing feature or API

codecov · 2023-02-24T01:08:43Z

Codecov Report

Merging #23174 (825467a) into master (f0a26fd) will decrease coverage by 0.02%.
The diff coverage is 23.68%.

❗ Current head 825467a differs from pull request most recent head 710185c. Consider uploading reports for the commit 710185c to get more accurate results

@@            Coverage Diff             @@
##           master   #23174      +/-   ##
==========================================
- Coverage   56.98%   56.97%   -0.02%     
==========================================
  Files        1951     1951              
  Lines       75412    75448      +36     
  Branches     8185     8196      +11     
==========================================
+ Hits        42976    42984       +8     
- Misses      30333    30358      +25     
- Partials     2103     2106       +3

Flag	Coverage Δ
javascript	`54.67% <23.68%> (-0.04%)`	⬇️

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

Impacted Files	Coverage Δ
...set-ui-core/src/ui-overrides/ExtensionsRegistry.ts	`100.00% <ø> (ø)`
...end/src/features/databases/DatabaseModal/styles.ts	`77.66% <ø> (ø)`
superset-frontend/src/pages/DatabaseList/index.tsx	`66.03% <0.00%> (ø)`
...end/src/features/databases/DatabaseModal/index.tsx	`43.63% <11.53%> (-1.73%)`	⬇️
.../features/databases/DatabaseModal/ExtraOptions.tsx	`64.70% <42.85%> (-5.67%)`	⬇️
superset-frontend/src/pages/DatasetList/index.tsx	`57.76% <66.66%> (+0.16%)`	⬆️
.../src/explore/components/controls/SelectControl.jsx	`64.28% <100.00%> (ø)`

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

superset-frontend/src/views/CRUD/data/database/DatabaseModal/ExtraOptions.tsx

eschutho · 2023-03-18T00:32:45Z

superset-frontend/src/views/CRUD/data/database/DatabaseModal/index.tsx

@@ -566,6 +602,93 @@ const DatabaseModal: FunctionComponent<DatabaseModalProps> = ({

  const [useSSHTunneling, setUseSSHTunneling] = useState<boolean>(false);

+  const createPostProcessingCallbacks = useRef<any>({});
+  const updatePostProcessingCallbacks = useRef<any>({});


If I understand this correctly, it looks like the child is sending a function from a lower level component up to the a higher component by attaching it to a ref, is that right? Would it be easier to import the extension into this parent index component, and then you can call the create and update callbacks later in the parent and then pass down just the visual components to the ExtraOptions? That way you don't have to pass the callbacks up to the parent. I'm not sure if that's necessarily the solution, but I know that these extension points are complicated, so trying to help suggest a simpler solution if there is one.

betodealmeida

Nice! I like the simplified approach. I can work on the onsave method in shell, if you haven't started it.

betodealmeida · 2023-03-30T00:29:51Z

superset-frontend/src/views/CRUD/data/database/DatabaseModal/ExtraOptions.tsx

@@ -16,9 +16,13 @@
 * specific language governing permissions and limitations
 * under the License.
 */
-import React, { ChangeEvent, EventHandler } from 'react';
+import React, { ChangeEvent, EventHandler, FunctionComponent } from 'react';


This is no longer needed and is causing tests to fail.

eschutho · 2023-04-26T23:06:46Z

superset-frontend/src/features/databases/DatabaseModal/styles.ts

@@ -573,6 +573,7 @@ export const StyledStickyHeader = styled.div`
  top: 0;
  z-index: ${({ theme }) => theme.zIndex.max};
  background: ${({ theme }) => theme.colors.grayscale.light5};
+  height: ${({ theme }) => theme.gridUnit * 16}px;


fixing this height so that it doesn't jump when loading.

eschutho · 2023-04-27T17:40:13Z

superset-frontend/src/features/databases/DatabaseModal/index.tsx

@@ -715,6 +734,8 @@ const DatabaseModal: FunctionComponent<DatabaseModalProps> = ({
  };

  const onSave = async () => {
+    // TODO: Elizabeth - add some error handling or promise/callback here
+    dbConfigExtraExtension?.onSave(extraExtensionComponentState, db);


we can remove this

fix(dbt cloud): modal header overlap in db connection

Co-authored-by: Elizabeth Thompson <[email protected]> Co-authored-by: Lily Kuang <[email protected]>

pull-request-size bot added the size/L label Feb 23, 2023

betodealmeida force-pushed the database-registry branch from bc80e94 to 238a3a0 Compare February 24, 2023 00:20

betodealmeida requested a review from hughhhh March 13, 2023 22:08

eschutho reviewed Mar 18, 2023

View reviewed changes

superset-frontend/src/views/CRUD/data/database/DatabaseModal/ExtraOptions.tsx Outdated Show resolved Hide resolved

eschutho reviewed Mar 18, 2023

View reviewed changes

betodealmeida force-pushed the database-registry branch 2 times, most recently from 00d00af to c09c4a9 Compare March 23, 2023 19:25

eschutho force-pushed the database-registry branch 2 times, most recently from cafea86 to 5f839a8 Compare March 29, 2023 23:04

pull-request-size bot added size/M and removed size/L labels Mar 29, 2023

betodealmeida commented Mar 30, 2023

View reviewed changes

eschutho force-pushed the database-registry branch from 5f839a8 to 3597c2c Compare April 26, 2023 22:28

pull-request-size bot added size/L and removed size/M labels Apr 26, 2023

eschutho force-pushed the database-registry branch from 3597c2c to 79eed09 Compare April 26, 2023 22:40

eschutho reviewed Apr 26, 2023

View reviewed changes

eschutho reviewed Apr 27, 2023

View reviewed changes

betodealmeida and others added 6 commits May 17, 2023 16:28

feat: database extension registry

b940e2f

Pass component as icon

a8b59fa

Pass component as description

42004cb

limit db extra extension to one element

c2e2472

add callbacks for onsave in the database modal

084a1c3

remove comment

5a9710d

betodealmeida force-pushed the database-registry branch from 2790991 to 5a9710d Compare May 17, 2023 23:29

Extensions for modals

843fe63

betodealmeida requested a review from lilykuang May 17, 2023 23:42

lilykuang added 2 commits May 17, 2023 17:15

fix(dbt cloud): modal header overlap in db connection

c89b3cb

Merge pull request #514 from preset-io/modal-header-fix

710185c

fix(dbt cloud): modal header overlap in db connection

hughhhh approved these changes May 18, 2023

View reviewed changes

betodealmeida merged commit 6b54591 into apache:master May 19, 2023
26 checks passed

betodealmeida deleted the database-registry branch May 19, 2023 00:00

betodealmeida added a commit to preset-io/superset that referenced this pull request May 19, 2023

feat: database extension registry (apache#23174)

c178f06

Co-authored-by: Elizabeth Thompson <[email protected]> Co-authored-by: Lily Kuang <[email protected]>

mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 3.0.0 labels Mar 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: database extension registry #23174

feat: database extension registry #23174

betodealmeida commented Feb 23, 2023

codecov bot commented Feb 24, 2023 •

edited

Loading

eschutho Mar 18, 2023

betodealmeida left a comment

betodealmeida Mar 30, 2023

eschutho Apr 26, 2023

eschutho Apr 27, 2023

feat: database extension registry #23174

feat: database extension registry #23174

Conversation

betodealmeida commented Feb 23, 2023

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

codecov bot commented Feb 24, 2023 • edited Loading

Codecov Report

eschutho Mar 18, 2023

Choose a reason for hiding this comment

betodealmeida left a comment

Choose a reason for hiding this comment

betodealmeida Mar 30, 2023

Choose a reason for hiding this comment

eschutho Apr 26, 2023

Choose a reason for hiding this comment

eschutho Apr 27, 2023

Choose a reason for hiding this comment

codecov bot commented Feb 24, 2023 •

edited

Loading