feat: Update database permissions in async mode (#32231)

Author: Vitor-Avila

superset-frontend/src/pages/DatabaseList/index.tsx

@@ -71,6 +71,7 @@ interface DatabaseDeleteObject extends DatabaseObject {
 interface DatabaseListProps {
   addDangerToast: (msg: string) => void;
   addSuccessToast: (msg: string) => void;
+  addInfoToast: (msg: string) => void;
   user: {
     userId: string | number;
     firstName: string;
@@ -101,6 +102,7 @@ function BooleanDisplay({ value }: { value: Boolean }) {
 
 function DatabaseList({
   addDangerToast,
+  addInfoToast,
   addSuccessToast,
   user,
 }: DatabaseListProps) {
@@ -121,6 +123,9 @@ function DatabaseList({
   const fullUser = useSelector<any, UserWithPermissionsAndRoles>(
     state => state.user,
   );
+  const shouldSyncPermsInAsyncMode = useSelector<any, boolean>(
+    state => state.common?.conf.SYNC_DB_PERMISSIONS_IN_ASYNC_MODE,
+  );
   const showDatabaseModal = getUrlParam(URL_PARAMS.showDatabaseModal);
 
   const [query, setQuery] = useQueryParams({
@@ -335,6 +340,44 @@ function DatabaseList({
     setPreparingExport(true);
   }
 
+  function handleDatabasePermSync(database: DatabaseObject) {
+    if (shouldSyncPermsInAsyncMode) {
+      addInfoToast(t('Validating connectivity for %s', database.database_name));
+    } else {
+      addInfoToast(t('Syncing permissions for %s', database.database_name));
+    }
+    SupersetClient.post({
+      endpoint: `/api/v1/database/${database.id}/sync_permissions/`,
+    }).then(
+      ({ response }) => {
+        // Sync request
+        if (response.status === 200) {
+          addSuccessToast(
+            t('Permissions successfully synced for %s', database.database_name),
+          );
+        }
+        // Async request
+        else {
+          addInfoToast(
+            t(
+              'Syncing permissions for %s in the background',
+              database.database_name,
+            ),
+          );
+        }
+      },
+      createErrorHandler(errMsg =>
+        addDangerToast(
+          t(
+            'An error occurred while syncing permissions for %s: %s',
+            database.database_name,
+            errMsg,
+          ),
+        ),
+      ),
+    );
+  }
+
   const initialSort = [{ id: 'changed_on_delta_humanized', desc: true }];
 
   const columns = useMemo(
@@ -426,6 +469,7 @@ function DatabaseList({
             handleDatabaseEditModal({ database: original, modalOpen: true });
           const handleDelete = () => openDatabaseDeleteModal(original);
           const handleExport = () => handleDatabaseExport(original);
+          const handleSync = () => handleDatabasePermSync(original);
           if (!canEdit && !canDelete && !canExport) {
             return null;
           }
@@ -481,6 +525,23 @@ function DatabaseList({
                   </span>
                 </Tooltip>
               )}
+              {canEdit && (
+                <Tooltip
+                  id="sync-action-tooltip"
+                  title={t('Sync Permissions')}
+                  placement="bottom"
+                >
+                  <span
+                    role="button"
+                    data-test="database-sync-perm"
+                    tabIndex={0}
+                    className="action-button"
+                    onClick={handleSync}
+                  >
+                    <Icons.Refresh />
+                  </span>
+                </Tooltip>
+              )}
             </Actions>
           );
         },

superset/commands/database/exceptions.py

@@ -88,11 +88,21 @@ def __init__(self, key: str = "") -> None:
         )
 
 
+class DatabaseConnectionSyncPermissionsError(CommandException):
+    status = 500
+    message = _("Unable to sync permissions for this database connection.")
+
+
 class DatabaseNotFoundError(CommandException):
     status = 404
     message = _("Database not found.")
 
 
+class UserNotFoundInSessionError(CommandException):
+    status = 500
+    message = _("Could not validate the user in the current session.")
+
+
 class DatabaseSchemaUploadNotAllowed(CommandException):
     status = 403
     message = _("Database schema is not allowed for csv uploads.")