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: API call to query Enum values #1435

Merged
merged 9 commits into from
Jul 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions backend/dataall/base/api/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

from dataall.base.api import gql
from dataall.base.api.constants import GraphQLEnumMapper
from dataall.base.api.queries import enumsQuery


def bootstrap():
Expand Down
11 changes: 11 additions & 0 deletions backend/dataall/base/api/queries.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
from dataall.base.api import gql
from dataall.base.api.resolvers import enum_resolver
from dataall.base.api.types import EnumResult

enumsQuery = gql.QueryField(
name='queryEnums',
args=[gql.Argument(name='enums_names', type=gql.ArrayType(gql.String))],
type=gql.ArrayType(EnumResult),
resolver=enum_resolver,
test_scope='Enums',
)
14 changes: 14 additions & 0 deletions backend/dataall/base/api/resolvers.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
from dataall.base.api.constants import GraphQLEnumMapper


def enum_resolver(context, source, enums_names):
result = []
for enum_class in GraphQLEnumMapper.__subclasses__():
if enum_class.__name__ in enums_names:
result.append(
{
'name': enum_class.__name__,
'items': [{'name': item.name, 'value': str(item.value)} for item in enum_class],
}
)
return result
17 changes: 17 additions & 0 deletions backend/dataall/base/api/types.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
from dataall.base.api import gql

EnumItem = gql.ObjectType(
name='EnumItem',
fields=[
gql.Field(name='name', type=gql.String),
gql.Field(name='value', type=gql.String),
],
)

EnumResult = gql.ObjectType(
name='EnumResult',
fields=[
gql.Field(name='name', type=gql.String),
gql.Field(name='items', type=gql.ArrayType(EnumItem)),
],
)
24 changes: 18 additions & 6 deletions frontend/src/modules/Maintenance/components/MaintenanceViewer.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,11 @@ import {
startMaintenanceWindow,
startReindexCatalog
} from '../services';
import { useClient } from 'services';
import { useClient, fetchEnums } from 'services';
import { SET_ERROR, useDispatch } from 'globalErrors';
import { useSnackbar } from 'notistack';
import { ModuleNames, isModuleEnabled } from 'utils';

const maintenanceModes = [
{ value: 'READ-ONLY', label: 'Read-Only' },
{ value: 'NO-ACCESS', label: 'No-Access' }
];

const START_MAINTENANCE = 'Start Maintenance';
const END_MAINTENANCE = 'End Maintenance';
export const PENDING_STATUS = 'PENDING';
Expand Down Expand Up @@ -314,11 +309,25 @@ export const MaintenanceViewer = () => {
useState(START_MAINTENANCE);
const [maintenanceWindowStatus, setMaintenanceWindowStatus] =
useState(INACTIVE_STATUS);
const [maintenanceModes, setMaintenanceModes] = useState([]);
const [dropDownStatus, setDropDownStatus] = useState(false);
const [refreshingTimer, setRefreshingTimer] = useState('');
const { enqueueSnackbar, closeSnackbar } = useSnackbar();
const dispatch = useDispatch();

const fetchMaintenanceModes = async () => {
const maintenanceModesEnum = await fetchEnums(client, ['MaintenanceModes']);
if (maintenanceModesEnum['MaintenanceModes'].length > 0) {
setMaintenanceModes(
maintenanceModesEnum['MaintenanceModes'].map((elem) => {
return { label: elem.value, value: elem.name };
})
);
} else {
dispatch({ type: SET_ERROR, error: 'Could not fetch maintenance modes' });
}
};

const refreshMaintenanceView = async () => {
setUpdating(true);
setRefreshing(true);
Expand Down Expand Up @@ -468,6 +477,9 @@ export const MaintenanceViewer = () => {
initializeMaintenanceView().catch((e) =>
dispatch({ type: SET_ERROR, e })
);
fetchMaintenanceModes().catch((e) =>
dispatch({ type: SET_ERROR, error: e.message })
);
const setTimer = setInterval(() => {
refreshStatus().catch((e) =>
dispatch({ type: SET_ERROR, error: e.message })
Expand Down
36 changes: 36 additions & 0 deletions frontend/src/services/graphql/Shared/getEnumByName.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
import { gql } from 'apollo-boost';

const getEnumByName = ({ enum_names }) => ({
variables: {
enum_names: enum_names
},
query: gql`
query queryEnums($enum_names: [String]) {
queryEnums(enums_names: $enum_names) {
name
items {
name
value
}
}
}
`
});

/// function to fetch multiple enums
/// output -- dictionary
// {
// 'enumName': [{name: '...', value: '..'}]
// }
export const fetchEnums = async (client, enum_names) => {
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: I'd keep only this method and drop the fetchOneEnum and if I want to query one I'd pass fetchEnums(..., ['EnumName'])

const response = await client.query(
getEnumByName({ enum_names: enum_names })
);
if (!response.errors && response.data.queryEnums != null) {
return Object.assign(
{},
...response.data.queryEnums.map((x) => ({ [x.name]: x.items }))
);
}
return {};
};
1 change: 1 addition & 0 deletions frontend/src/services/graphql/Shared/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from './getEnumByName';
1 change: 1 addition & 0 deletions frontend/src/services/graphql/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ export * from './Notification';
export * from './Organization';
export * from './Principal';
export * from './SavedQuery';
export * from './Shared';
export * from './Search';
export * from './ShareObject';
export * from './Stack';
Expand Down
Loading