Skip to content

Commit

Permalink
Merge pull request #4985 from open-formulieren/issue/4978-make-object…
Browse files Browse the repository at this point in the history 
…s-v2-config-default

🗑️ [#4978] Make v2 Objects API config the default
  • Loading branch information
@sergei-maertens
sergei-maertens authored Jan 6, 2025
2 parents 7f8fd3b + 3a1b5b7 commit c375347
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 78 deletions.
31 changes: 20 additions & 11 deletions ...s/js/components/admin/form_design/registrations/objectsapi/ObjectsApiOptionsFormFields.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,20 @@ import {
import LegacyConfigFields from './LegacyConfigFields';
import V2ConfigFields from './V2ConfigFields';

const VERSION_TO_INDEX_MAP = {
2: 0, // first tab
1: 1, // second tab
};

const INDEX_TO_VERSION_MAP = Object.fromEntries(
Object.entries(VERSION_TO_INDEX_MAP).map(([version, index]) => [index, parseInt(version, 10)])
);

const ObjectsApiOptionsFormFields = ({name, apiGroupChoices}) => {
const intl = useIntl();
const {values, setValues} = useFormikContext();
const validationErrors = useContext(ValidationErrorContext);
const {version = 1} = values;
const {version = 2} = values;

const v1SwitchMessage = intl.formatMessage({
defaultMessage: `Switching to the legacy registration options will remove the existing variables mapping.
Expand Down Expand Up @@ -48,7 +57,7 @@ const ObjectsApiOptionsFormFields = ({name, apiGroupChoices}) => {
} = useConfirm();

const changeVersion = async tabIndex => {
const newVersion = tabIndex + 1;
const newVersion = INDEX_TO_VERSION_MAP[tabIndex];

// change form fields values depending on the newly selected version
const newValues = {...values, version: newVersion};
Expand Down Expand Up @@ -82,30 +91,30 @@ const ObjectsApiOptionsFormFields = ({name, apiGroupChoices}) => {
const relevantErrors = filterErrors(name, validationErrors);
return (
<ValidationErrorsProvider errors={relevantErrors}>
<Tabs selectedIndex={version - 1} onSelect={changeVersion}>
<Tabs selectedIndex={VERSION_TO_INDEX_MAP[version]} onSelect={changeVersion}>
<TabList>
<Tab>
<FormattedMessage
defaultMessage="Legacy"
description="Objects API registration backend options 'Legacy' tab label"
defaultMessage="Variables Mapping"
description="Objects API registration backend options 'Variables Mapping' tab label"
/>
</Tab>
<Tab>
<FormattedMessage
defaultMessage="Variables Mapping"
description="Objects API registration backend options 'Variables Mapping' tab label"
defaultMessage="Legacy"
description="Objects API registration backend options 'Legacy' tab label"
/>
</Tab>
</TabList>

{/* Legacy format, template based */}
{/* Tight objecttypes integration */}
<TabPanel>
<LegacyConfigFields apiGroupChoices={apiGroupChoices} />
<V2ConfigFields apiGroupChoices={apiGroupChoices} />
</TabPanel>

{/* Tight objecttypes integration */}
{/* Legacy format, template based */}
<TabPanel>
<V2ConfigFields apiGroupChoices={apiGroupChoices} />
<LegacyConfigFields apiGroupChoices={apiGroupChoices} />
</TabPanel>
</Tabs>
<ConfirmationModalV1 {...confirmationModalV1Props} message={v1SwitchMessage} />
Expand Down
85 changes: 19 additions & 66 deletions ...ponents/admin/form_design/registrations/objectsapi/ObjectsApiOptionsFormFields.stories.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,18 +84,8 @@ export const SwitchToV2Empty = {
play: async ({canvasElement, step}) => {
const canvas = within(canvasElement);

await step('Activate v2 tab', async () => {
const v2Tab = canvas.getByRole('tab', {name: 'Variabelekoppelingen'});
await userEvent.click(v2Tab);
// Close the confirmation modal
await userEvent.click(
within(await canvas.findByRole('dialog')).getByRole('button', {name: 'Accepteren'})
);
// Wait for v2Tab to be the selected tab
await waitFor(() => {
expect(v2Tab).toHaveAttribute('aria-selected', 'true');
});
});
const v2Tab = canvas.getByRole('tab', {name: 'Variabelekoppelingen'});
expect(v2Tab).toHaveAttribute('aria-selected', 'true');

const groupSelect = canvas.getByLabelText('API-groep');
await rsSelect(groupSelect, 'Objects API group 1');
Expand Down Expand Up @@ -132,43 +122,28 @@ export const SwitchToV2Existing = {
const canvas = within(canvasElement);

const v2Tab = canvas.getByRole('tab', {name: 'Variabelekoppelingen'});
await userEvent.click(v2Tab);

await waitFor(async () => {
// Close the confirmation modal
await userEvent.click(
within(await canvas.findByRole('dialog')).getByRole('button', {
name: 'Accepteren',
})
);

// Expect v2Tab to be the selected tab
expect(v2Tab).toHaveAttribute('aria-selected', 'true');
});
expect(v2Tab).toHaveAttribute('aria-selected', 'true');

const testForm = await canvas.findByTestId('test-form');

await waitFor(() => {
expect(testForm).toHaveFormValues({
objectsApiGroup: '1',
objecttype: '2c77babf-a967-4057-9969-0200320d23f2',
objecttypeVersion: '1',
});
expect(await canvas.findByText('Person (open)')).toBeVisible();
expect(await canvas.findByText('1 (published)')).toBeVisible();
expect(testForm).toHaveFormValues({
objectsApiGroup: '1',
objecttype: '2c77babf-a967-4057-9969-0200320d23f2',
objecttypeVersion: '1',
});
expect(canvas.getByText('Person (open)')).toBeVisible();
expect(canvas.getByText('1 (published)')).toBeVisible();

const v1Tab = canvas.getByRole('tab', {name: 'Verouderd (sjabloon)'});
await userEvent.click(v1Tab);

await waitFor(async () => {
// Close the confirmation modal
await userEvent.click(
within(await canvas.findByRole('dialog')).getByRole('button', {
name: 'Accepteren',
})
);

// Close the confirmation modal
await userEvent.click(
within(await canvas.findByRole('dialog')).getByRole('button', {
name: 'Accepteren',
})
);
await waitFor(() => {
// Expect v1Tab to be the selected tab
expect(v1Tab).toHaveAttribute('aria-selected', 'true');
});
Expand All @@ -194,18 +169,8 @@ export const SwitchToV2NonExisting = {
play: async ({canvasElement, step}) => {
const canvas = within(canvasElement);

await step('Activate v2 tab', async () => {
const v2Tab = canvas.getByRole('tab', {name: 'Variabelekoppelingen'});
await userEvent.click(v2Tab);
// Close the confirmation modal
await userEvent.click(
within(await canvas.findByRole('dialog')).getByRole('button', {name: 'Accepteren'})
);
// Wait for v2Tab to be the selected tab
await waitFor(() => {
expect(v2Tab).toHaveAttribute('aria-selected', 'true');
});
});
const v2Tab = canvas.getByRole('tab', {name: 'Variabelekoppelingen'});
expect(v2Tab).toHaveAttribute('aria-selected', 'true');

const testForm = await canvas.findByTestId('test-form');
await waitFor(() => {
Expand All @@ -230,19 +195,7 @@ export const APIFetchError = {
const canvas = within(canvasElement);

const v2Tab = canvas.getByRole('tab', {name: 'Variabelekoppelingen'});
await userEvent.click(v2Tab);

await waitFor(async () => {
// Close the confirmation modal
await userEvent.click(
within(await canvas.findByRole('dialog')).getByRole('button', {
name: 'Accepteren',
})
);

// Expect v2Tab to be the selected tab
expect(v2Tab).toHaveAttribute('aria-selected', 'true');
});
expect(v2Tab).toHaveAttribute('aria-selected', 'true');

await step('Retrieving object types', async () => {
const groupSelect = canvas.getByLabelText('API-groep');
Expand Down
2 changes: 1 addition & 1 deletion src/openforms/registrations/contrib/objects_api/config.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ class ObjectsAPIOptionsSerializer(JsonSchemaSerializerMixin, serializers.Seriali
"The schema version of the objects API Options. Not to be confused with the objecttype version."
),
choices=VersionChoices.choices,
default=1,
default=2,
)
objecttype = serializers.UUIDField(
label=_("objecttype"),
Expand Down

0 comments on commit c375347

Please sign in to comment.