Skip to content

[#6947] subtask(web): Web UI supports fileset multiple locations #7033

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.

Sign up for GitHub

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

Merged
mchades merged 6 commits into from
Apr 28, 2025
Merged

[#6947] subtask(web): Web UI supports fileset multiple locations #7033

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
00a03ad
[#6947] subtask(web): Web UI supports fileset multiple locations
LauraXia123 Apr 22, 2025
e611f08
format code
LauraXia123 Apr 23, 2025
3b31e6a
fix fileset ci case
LauraXia123 Apr 24, 2025
a67cad0
update storage locations details info
LauraXia123 Apr 27, 2025
a42b12a
format code
LauraXia123 Apr 27, 2025
d964609
handle default location case
LauraXia123 Apr 28, 2025
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
3 changes: 2 additions & 1 deletion ...ion-test/src/test/java/org/apache/gravitino/integration/test/web/ui/CatalogsPageTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ public class CatalogsPageTest extends BaseWebIT {
private static final String FILESET_CATALOG_NAME = "catalog_fileset";
private static final String SCHEMA_NAME = "default";
private static final String SCHEMA_NAME_FILESET = "schema_fileset";
private static final String FILESET_DEFAULT_LOCATION = "fileset_location";
private static final String FILESET_NAME = "fileset1";
private static final String TABLE_NAME = "table1";
private static final String TABLE_NAME_2 = "table2";
Expand Down Expand Up @@ -638,7 +639,7 @@ public void testCreateFileset() throws InterruptedException {
clickAndWait(catalogsPage.createFilesetBtn);
catalogsPage.setFilesetNameField(FILESET_NAME);
String storageLocation = storageLocation(SCHEMA_NAME_FILESET, FILESET_NAME);
catalogsPage.setFilesetStorageLocationField(storageLocation);
catalogsPage.setFilesetStorageLocationField(0, FILESET_DEFAULT_LOCATION, storageLocation);
catalogsPage.setFilesetCommentField("fileset comment");
catalogsPage.addFilesetPropsBtn.click();
catalogsPage.setPropsAt(0, PROPERTIES_KEY1, PROPERTIES_VALUE1);
Expand Down
19 changes: 11 additions & 8 deletions ...n-test/src/test/java/org/apache/gravitino/integration/test/web/ui/pages/CatalogsPage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,14 +318,17 @@ public void setFilesetNameField(String nameField) {
}
}

public void setFilesetStorageLocationField(String storageLocation) {
try {
WebElement filesetStorageLocationFieldInput =
filesetStorageLocationField.findElement(By.tagName("input"));
filesetStorageLocationFieldInput.sendKeys(
Keys.chord(Keys.HOME, Keys.chord(Keys.SHIFT, Keys.END), Keys.DELETE));
filesetStorageLocationFieldInput.clear();
filesetStorageLocationFieldInput.sendKeys(storageLocation);
public void setFilesetStorageLocationField(
int index, String locationName, String storageLocation) {
try {
// Set the indexed storageLocations name
String namePath = "//div[@data-refer='storageLocations-name-" + index + "']//input";
WebElement nameInput = driver.findElement(By.xpath(namePath));
nameInput.sendKeys(locationName);
// Set the indexed storageLocations location
String locationPath = "//div[@data-refer='storageLocations-location-" + index + "']//input";
WebElement locationInput = driver.findElement(By.xpath(locationPath));
locationInput.sendKeys(storageLocation);
} catch (Exception e) {
LOG.error(e.getMessage(), e);
}
Expand Down
253 changes: 208 additions & 45 deletions web/web/src/app/metalakes/metalake/rightContent/CreateFilesetDialog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ import {
MenuItem,
InputLabel,
FormControl,
FormHelperText
FormHelperText,
Tooltip,
Switch
} from '@mui/material'

import Icon from '@/components/Icon'
Expand All @@ -45,7 +47,7 @@ import { useAppDispatch } from '@/lib/hooks/useStore'
import { createFileset, updateFileset } from '@/lib/store/metalakes'

import * as yup from 'yup'
import { useForm, Controller } from 'react-hook-form'
import { useForm, Controller, useFieldArray } from 'react-hook-form'
import { yupResolver } from '@hookform/resolvers/yup'

import { groupBy } from 'lodash-es'
Expand All @@ -56,19 +58,45 @@ import { useSearchParams } from 'next/navigation'
const defaultValues = {
name: '',
type: 'managed',
storageLocation: '',
storageLocations: [{ name: '', location: '', defaultLocation: true }],
comment: '',
propItems: []
}

const schema = yup.object().shape({
name: yup.string().required().matches(nameRegex, nameRegexDesc),
type: yup.mixed().oneOf(['managed', 'external']).required(),
storageLocation: yup.string().when('type', {
is: 'external',
then: schema => schema.required(),
otherwise: schema => schema
}),
storageLocations: yup
.array()
.of(
yup.object().shape({
name: yup.string().when('type', {
is: 'external',
then: schema => schema.required(),
otherwise: schema => schema
}),
location: yup.string().when('name', {
is: name => !!name,
then: schema => schema.required(),
otherwise: schema => schema
})
})
)
.test('unique', 'Location name must be unique', (storageLocations, ctx) => {
const values = storageLocations?.filter(l => !!l.name).map(l => l.name)
const duplicates = values.filter((value, index, self) => self.indexOf(value) !== index)

if (duplicates.length > 0) {
const duplicateIndex = values.lastIndexOf(duplicates[0])

return ctx.createError({
path: `storageLocations.${duplicateIndex}.name`,
message: 'This storage location name is duplicated'
})
}

return true
}),
propItems: yup.array().of(
yup.object().shape({
required: yup.boolean(),
Expand Down Expand Up @@ -111,6 +139,9 @@ const CreateFilesetDialog = props => {
resolver: yupResolver(schema)
})

const defaultLocationProps = watch('propItems').filter(item => item.key === 'default-location-name')[0]
const storageLocationsItems = watch('storageLocations')

const handleFormChange = ({ index, event }) => {
let data = [...innerProps]
data[index][event.target.name] = event.target.value
Expand Down Expand Up @@ -154,6 +185,20 @@ const CreateFilesetDialog = props => {
setValue('propItems', data)
}

const { fields, append, remove } = useFieldArray({
control,
name: 'storageLocations'
})

const onChangeDefaultLocation = ({ index, event }) => {
fields.forEach((item, i) => {
if (i !== index) {
setValue(`storageLocations.${i}.defaultLocation`, false)
}
})
setValue(`storageLocations.${index}.defaultLocation`, event.target.checked)
}

const handleClose = () => {
reset()
setInnerProps([])
Expand Down Expand Up @@ -188,7 +233,16 @@ const CreateFilesetDialog = props => {
const filesetData = {
name: data.name,
type: data.type,
storageLocation: data.storageLocation,
storageLocations: data.storageLocations.reduce((acc, item) => {
if (item.name && item.location) {
acc[item.name] = item.location
if (item.defaultLocation && !properties['default-location-name']) {
properties['default-location-name'] = item.name
}
}

return acc
}, {}),
comment: data.comment,
properties
}
Expand Down Expand Up @@ -238,16 +292,24 @@ const CreateFilesetDialog = props => {
setCacheData(data)
setValue('name', data.name)
setValue('type', data.type)
setValue('storageLocation', data.storageLocation)
setValue('comment', data.comment)

const storageLocations = Object.entries(data.storageLocations).map(([key, value]) => {
return {
name: key,
location: value,
defaultLocation: properties['default-location-name'] === key
}
})

const propsItems = Object.entries(properties).map(([key, value]) => {
return {
key,
value
}
})

setValue('storageLocations', storageLocations)
setInnerProps(propsItems)
setValue('propItems', propsItems)
}
Expand Down Expand Up @@ -329,38 +391,130 @@ const CreateFilesetDialog = props => {
</Grid>

<Grid item xs={12}>
<FormControl fullWidth>
<Controller
name='storageLocation'
control={control}
rules={{ required: true }}
render={({ field: { value, onChange } }) => (
<TextField
value={value}
label='Storage Location'
onChange={onChange}
disabled={type === 'update'}
placeholder=''
error={Boolean(errors.storageLocation)}
data-refer='fileset-storageLocation-field'
/>
)}
/>
{errors.storageLocation ? (
<FormHelperText sx={{ color: 'error.main' }}>{errors.storageLocation.message}</FormHelperText>
) : (
<>
<FormHelperText sx={{ color: 'text.main' }}>
It is optional if the fileset is 'Managed' type and a storage location is already specified at the
parent catalog or schema level.
</FormHelperText>
<FormHelperText sx={{ color: 'text.main' }}>
It becomes mandatory if the fileset type is 'External' or no storage location is defined at the
parent level.
</FormHelperText>
</>
)}
</FormControl>
<Typography sx={{ mb: 2 }} variant='body2'>
Storage Locations
</Typography>
{fields.map((field, index) => {
return (
<Grid key={index} item xs={12} sx={{ '& + &': { mt: 2 } }}>
<FormControl fullWidth>
<Box
key={field.id}
sx={{ display: 'flex', alignItems: 'center', justifyContent: 'space-between', gap: 1 }}
data-refer={`storageLocations-${index}`}
>
<Box>
<Controller
name={`storageLocations.${index}.name`}
control={control}
render={({ field: { value, onChange } }) => (
<TextField
{...field}
value={value}
onChange={onChange}
disabled={type === 'update'}
label={`Name ${index + 1}`}
data-refer={`storageLocations-name-${index}`}
error={!!errors.storageLocations?.[index]?.name || !!errors.storageLocations?.message}
helperText={
errors.storageLocations?.[index]?.name?.message || errors.storageLocations?.message
}
fullWidth
/>
)}
/>
</Box>
<Box>
<Controller
name={`storageLocations.${index}.location`}
control={control}
render={({ field: { value, onChange } }) => (
<TextField
{...field}
value={value}
onChange={onChange}
disabled={type === 'update'}
label={`Location ${index + 1}`}
data-refer={`storageLocations-location-${index}`}
error={
!!errors.storageLocations?.[index]?.location || !!errors.storageLocations?.message
}
helperText={
errors.storageLocations?.[index]?.location?.message ||
errors.storageLocations?.message
}
fullWidth
/>
)}
/>
</Box>
{!defaultLocationProps &&
storageLocationsItems.length > 1 &&
storageLocationsItems[0].name &&
storageLocationsItems[0].location && (
<Box>
<Controller
name={`storageLocations.${index}.defaultLocation`}
control={control}
render={({ field: { value, onChange } }) => (
<Tooltip title='Default Location' placement='top'>
<Switch
checked={value}
onChange={event => onChangeDefaultLocation({ index, event })}
disabled={type === 'update'}
size='small'
/>
</Tooltip>
)}
/>
</Box>
)}
<Box>
{index === 0 ? (
<Box sx={{ minWidth: 40 }}>
<IconButton
sx={{ cursor: type === 'update' ? 'not-allowed' : 'pointer' }}
onClick={() => {
if (type === 'update') return
append({ name: '', location: '', defaultLocation: false })
}}
>
<Icon icon='mdi:plus-circle-outline' />
</IconButton>
</Box>
) : (
<Box sx={{ minWidth: 40 }}>
<IconButton
sx={{ cursor: type === 'update' ? 'not-allowed' : 'pointer' }}
onClick={() => {
if (type === 'update') return
remove(index)
}}
>
<Icon icon='mdi:minus-circle-outline' />
</IconButton>
</Box>
)}
</Box>
</Box>
</FormControl>
</Grid>
)
})}
{errors.storageLocations ? (
<FormHelperText sx={{ color: 'error.main' }}>{errors.storageLocations.message}</FormHelperText>
) : (
<>
<FormHelperText sx={{ color: 'text.main' }}>
It is optional if the fileset is 'Managed' type and a storage location is already specified at the
parent catalog or schema level.
</FormHelperText>
<FormHelperText sx={{ color: 'text.main' }}>
It becomes mandatory if the fileset type is 'External' or no storage location is defined at the
parent level.
</FormHelperText>
</>
)}
</Grid>

<Grid item xs={12}>
Expand Down Expand Up @@ -405,7 +559,10 @@ const CreateFilesetDialog = props => {
name='key'
label='Key'
value={item.key}
disabled={item.disabled || (item.key === 'location' && type === 'update')}
disabled={
item.disabled ||
(['location', 'default-location-name'].includes(item.key) && type === 'update')
}
onChange={event => handleFormChange({ index, event })}
error={item.hasDuplicateKey || item.invalid || !item.key.trim()}
data-refer={`props-key-${index}`}
Expand All @@ -418,14 +575,20 @@ const CreateFilesetDialog = props => {
label='Value'
error={item.required && item.value === ''}
value={item.value}
disabled={item.disabled || (item.key === 'location' && type === 'update')}
disabled={
item.disabled ||
(['location', 'default-location-name'].includes(item.key) && type === 'update')
}
onChange={event => handleFormChange({ index, event })}
data-refer={`props-value-${index}`}
data-prev-refer={`props-${item.key}`}
/>
</Box>

{!(item.disabled || (item.key === 'location' && type === 'update')) ? (
{!(
item.disabled ||
(['location', 'default-location-name'].includes(item.key) && type === 'update')
) ? (
<Box sx={{ minWidth: 40 }}>
<IconButton onClick={() => removeFields(index)}>
<Icon icon='mdi:minus-circle-outline' />
Expand Down
Loading