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

feat(business-types): initial implementation of SIP-78 #18794

Merged
merged 167 commits into from
May 16, 2022

Conversation

cccs-RyanS
Copy link
Contributor

@cccs-RyanS cccs-RyanS commented Feb 17, 2022

[WIP] feat(advanced-data-types): initial implementation of SIP-78

SUMMARY

This is the initial implementation of the features proposed in SIP-78, this pull request includes:

  • advanced_data_type field added to the TableColumn model, editable through the data source edit modal
  • Addition of the api/v1/chart/advanced_data_type/convert api [GET] endpoint used for converting user entered values into appropriate format
  • Addition of the api/v1/chart/advanced_data_type/types api [GET] used for retrieving list of registered advanced data types
  • AdhocFilterEditPopoverSimpleTabContent changes if a advanced data type is present on a column
    • Populate filter available operator selection based on the current selected columns advanced data type if applicable via call to the conversion endpoint
    • Valid subject based on rules of advanced data type, display a useful error message if an invalid value has been entered and prevent saving
    • Display converted value to the user via a tool tip
  • Addition of the Port and Internet Address advanced data types as examples
  • Modification of the sqla connector model to use advanced data type logic for converting if a advanced data type is present on a column

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Data set modal before / with feature flag disabled

edit.dataset.feature.flag.off.mp4

Data set modal after / with feature flag enabled

edit.dataset.feature.flag.on.mp4

Filter popover before / with feature flag disabled

IP.feature.flag.off.mp4

Filter popover after / with feature flag enabled

IP.feature.flag.on.mp4

Port demo / invalid entry

invalid.port.and.valid.http.demo.mp4

TESTING INSTRUCTIONS

  • set ENABLE_ADVANCED_DATA_TYPES feature flag to be true
  • add a port or internet_address advanced data type to an existing column through the data source editor
  • open the explore view on that that data source
  • add a filter on a column tagged with the advanced data type
  • enter a subject and verify that the converted value is displayed via a tool tip (i.e http will show up as 80 for the case of ports)
  • enter an invalid value and insure you cannot save and an error message is displayed
  • save a valid filter an a column tagged with a advanced data type and run the query
  • verify the query is as expected (i.e a filter with ip_col, EQUALS, 1.1.1.1 should be ip =16843009 in there where caluse )

ADDITIONAL INFORMATION

  • Has associated issue: SIP-78
  • Required feature flags: ENABLE_ADVANCED_DATA_TYPES
  • 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

villebro and others added 30 commits September 27, 2021 16:09
I've thrown in a test.py script as well that will try to connect to the
business_type endpoint.
Very simple api is exposed that will allow someone to call a checkport
endpoint and get back a response.
Just some small changes as described in the title.  I've updated the
test.py as well so it functions with the endpoint changes.
Also changed BusinessTypeResponse to resp.
If a column starts with "cidr_" it will call the code in config.py to
try to translate the filter.  Nothing is changed in the JSON being
executed, just some information is dumped to console.
@cccs-RyanS cccs-RyanS changed the title [WIP] feat(business-types): initial implementation of SIP-78 feat(business-types): initial implementation of SIP-78 Apr 20, 2022
@cccs-RyanS cccs-RyanS changed the title feat(business-types): initial implementation of SIP-78 [WIP] feat(business-types): initial implementation of SIP-78 Apr 20, 2022
@cccs-RyanS cccs-RyanS changed the title [WIP] feat(business-types): initial implementation of SIP-78 feat(business-types): initial implementation of SIP-78 Apr 21, 2022
Copy link
Member

@villebro villebro left a comment

Choose a reason for hiding this comment

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

This is a monumental body of work @cccs-RyanS ! 🎉 🚀 I'm especially impressed with the superbly comprehensive tests across the board (frontend + backend with separate unit and integration tests where applicable). A few last minor nits, but after we get them fixed I'm happy to approve and get this merged upstream.

Copy link
Member

@villebro villebro left a comment

Choose a reason for hiding this comment

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

LGTM!

@villebro villebro merged commit ddc01ea into apache:master May 16, 2022
@villebro villebro deleted the business-types-ui branch May 16, 2022 14:58
philipher29 pushed a commit to ValtechMobility/superset that referenced this pull request Jun 9, 2022
* add BUSINESS_TYPE_ADDONS to config with example callback

* Removing uneeded whitespace

* [Work in progress] Modifying cidr function to allow for  single ip and adding port outline

* Added test REST endpoint, added some more ports

I've thrown in a test.py script as well that will try to connect to the
business_type endpoint.

* Moving code from config.py into the business api

Very simple api is exposed that will allow someone to call a checkport
endpoint and get back a response.

* Removing commented out bits.

* Adding fucntion dict back to the config

* Moving business_type endpoint to charts

* Adding schema for get endpoint

* Removing imports, updating docstring, fixing typo

Just some small changes as described in the title.  I've updated the
test.py as well so it functions with the endpoint changes.

* Adding translation dict

* Fixing ops

* Adding check for list

* Modifying changes to add quotes where needed

Also changed BusinessTypeResponse to resp.

* Adding in some code to call the filter config

If a column starts with "cidr_" it will call the code in config.py to
try to translate the filter.  Nothing is changed in the JSON being
executed, just some information is dumped to console.

* Porting Ryan's changes

* Adding migration script (as per Ryan's PR)

* Fixing typo

* Prettier fixes

* [CLDN-1043] Adding rough version of filter changes for business types

* fix down migration

* Fixing bugs after merge

* adding functionality to appy filters in back end

* Fixing linting issues

* fix down revision

* Changing conversion callback to handle multiple values at once

* Adding string representation of values

* Code cleanup plus fixing debouce to only be called once for each entry

* Removing non needed logginh

* Changing operator list to use sting values

* Using text value operators

* Removing clear operator call

* Moving business type endpoints

* fix down revision

* Adding port functions

* update migration

* fix bad rebase and add ff

* implement validator

* dont add invalid values to response

* [CLDN-1205] Added a new exception type for a business type translation error. Added the error message in the display_value field within the business type response. Modified the IP and Port business types to populate the error message field in the response if an error occurs

* [CLDN-1205] Added meaningful error message for port translation errors

* Removing status field from businesstype Response and adding in error message

* [CLDN-1205] Added check to make sure the port business type is within the valid range of ports, if it is not, it will populate the error message

* [CLDN-1205] Fixed the if statement that checks to see if the string_value is in the valid range of port numbers. It did not corrently verify this before now.

* [CLDN-1205] Fixed an error where it was trying to use string_value in <= statements. I just casted string_value to an integer if it is numeric, which allows <= operators to be used on it

* [CLDN-1207] Added unit tests for the cidr_func and port_translation_func functions which are located in /superset/config.py

* [CLDN-1207] removed the assertRaises line as it does not work with the cidr_func and port_translation_func functions

* [CLDN-1207] Added the skeleton of the test_cidr_translate_filter_func unit test, still need to update what the expected response from the function will be.

* [CLDN-1207] Added the remainder of the back-end unit tests for the business types

* [CLDN-1207] Fixed the syntax error which caused the test_cidr_translate_filter_func_NOT_IN_double unit test to fail

* [CLDN-1207] Removed the logging that was added for debugging purposes

* [CLDN-1207] Formatted the commands_tests.py file to make it nicer to look at/read through

* [CLDN-1207] Fixed the code so that it conformed to the pylint requirements (i.e., pylint no longer complains about the code in commands_tests.py)

* [CLDN-1207] Modified some of the docstrings so they made better use of the 100 character per line, line limit

* [CLDN-1207] Added the beginnings of the unit tests for the
business types API

* [CLDN-1207] Added a comment to the top of the commands_tests.py file explaining how to run the unit tests. This prevents the next person who tries to run them from having to waste time trying the different forms of testing that Superset supports (e.g., pytest, tox, etc.)

* [CLDN-1207] Added a grammar fix to the comments describing how to run the unit tests

* [CLDN-1207] Modified the description of the business_type API endpoints as they did not represent what the API was actually doing

* [CLDN-1207] Added further instructions on how to run the unit tests that are within the business_type/api_tests.py file

* add request validation

* disable request if business type missing

* [CLDN-1207] Unit tests for the business type API are now working, however, they need to be modified to make use of @mock as we don't want to have to run the server to be able to run the unit tests

* Removing businesss types deffinitons from config

* Adding select to only show valid business types

* Fixed Enzyme tests

* Added scalfolding for selecting filter dropdown

* Adding intigration tests

* fix revision

* fix typos and unnecessary requests

* break out useBusinessTypes

* Added front-end RTL unit tests for the business type API endpoint

* Fixed error from unit tests

* Added a unit test to ensure the operator list is updated after a business type API response is received

* Removing elect compoenet for business types

* Adding feature flag and allowing saving when no business type present

* fixing useEffect hooks

* Adding feature flag to model

* Changing behavior such that an empty string returns a default response

* add form validation

* Modified comments in unit test as command to run test has changed

* Modified comments in unit test as filename to run test has changed

* Modified the api_tests.py file to conform to the linting requirements

* Changed the name of one of the tests to reflect what the test is actually testing

* Added cypress back to the package.json

* Added informative comments

* Updated comments in files as well as removed imports which were not being used

* Changes made by npm run prettier

* Fixed spelling mistakes

* Updated models.py to remove placeholder comments used in development

* Added feature flag mocking in unit test

* Fixing open api failure

* Fixing business types to pass unit tests

* Reverting unsafe connections back to false

* Removing print statement

* Adding business tpye to export test

* setting default feature flag to false for business type

* Reverting pre commit

* Reverting pre commit and running pre commit

* Reverting pre commit and running pre commit

* Fixing formatting

* Adding license

* Fixing Linting

* Protecting api enpoints

* updating model

* Fixing code path when business type exists

* Linting

* Linting

* Fixing linting

* Fixing spelling

* Fixing schemas

* Fixing app import

* fixing item render

* Added RTL test to make sure business type operator list is updated after API response

* Fixing linting

* fix migration

* Changing unit tests

* Fixing import and DB migration after rebase

* Renaming to advanced types

* Fixing Linting

* More renaming

* Removing uneeded change

* Fixing linting and test errors

* Removing unused imports

* linting

* Adding more detailed name for migration

* Moving files to plugins

* more renaming

* Fixing schema name

* Disabling feature flag that should not be enabled by default

* Adding extra cehck

* NameChange

* formatting

* Fixing equals check

* Moveing all advanced type classes and types to one file, and converting tests to functional

* Adding advanced type to test and fix linitng

Co-authored-by: Ville Brofeldt <ville.v.brofeldt@gmail.com>
Co-authored-by: Dan Parent <daniel.parent@cse-cst.gc.ca>
Co-authored-by: GITHUB_USERNAME <EMAIL>
Co-authored-by: cccs-Dustin <96579982+cccs-Dustin@users.noreply.github.com>
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 2.0.0 labels Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels size/XXL 🚢 2.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants