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

Validate required fields in writeback forms #23387

Merged
merged 4 commits into from
Jun 16, 2022
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions frontend/src/metabase-lib/lib/metadata/Field.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ class FieldInner extends Base {
name: string;
description: string | null;
semantic_type: string | null;
database_required: boolean;
fingerprint?: FieldFingerprint;
base_type: string | null;
table?: Table;
Expand Down
30 changes: 25 additions & 5 deletions frontend/src/metabase/writeback/containers/WritebackForm.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@ import { t } from "ttag";

import Form from "metabase/containers/Form";

import validate from "metabase/lib/validate";
import { TYPE } from "metabase/lib/types";

import Field from "metabase-lib/lib/metadata/Field";
import Table from "metabase-lib/lib/metadata/Table";

import { isEditableField } from "../utils";
import CategoryFieldPicker from "./CategoryFieldPicker";

export interface WritebackFormProps {
Expand Down Expand Up @@ -55,23 +57,41 @@ function getFieldTypeProps(field: Field) {
return { type: "input" };
}

function getFieldValidationProp(field: Field) {
let validator = validate as any;

if (field.database_required) {
validator = validator.required();
}

return {
validate: validator,
};
}

function WritebackForm({ table, row, onSubmit, ...props }: WritebackFormProps) {
const editableFields = useMemo(
() => table.fields.filter(field => field.id && !field.isPK()),
[table],
);
const editableFields = useMemo(() => table.fields.filter(isEditableField), [
table,
]);

const form = useMemo(() => {
return {
fields: editableFields.map(field => {
const fieldIndex = table.fields.findIndex(f => f.id === field.id);
const initialValue = row ? row[fieldIndex] : undefined;

let title = field.displayName();
if (field.database_required) {
title += " (" + t`required` + ")";
}

return {
name: field.name,
title: field.displayName(),
title,
description: field.description,
initial: initialValue,
...getFieldTypeProps(field),
...getFieldValidationProp(field),
};
}),
};
Expand Down
18 changes: 18 additions & 0 deletions frontend/src/metabase/writeback/utils.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { getTemplateTagParameterTarget } from "metabase/parameters/utils/cards";

import Database from "metabase-lib/lib/metadata/Database";
import Field from "metabase-lib/lib/metadata/Field";

import { Database as IDatabase } from "metabase-types/types/Database";
import { DashCard } from "metabase-types/types/Dashboard";
Expand All @@ -17,6 +18,23 @@ export const isDatabaseWritebackEnabled = (database?: IDatabase | null) =>
export const isWritebackSupported = (database?: Database | null) =>
!!database?.hasFeature(DB_WRITEBACK_FEATURE);

export const isEditableField = (field: Field) => {
const isRealField = typeof field.id === "number";
if (!isRealField) {
// Filters out custom, aggregated columns, etc.
return false;
}

if (field.isPK()) {
// Most of the time PKs are auto-generated,
// but there are rare cases when they're not
// In this case they're marked as `database_required`
return field.database_required;
}

return true;
};

export const isActionButtonDashCard = (dashCard: DashCard) =>
dashCard.visualization_settings?.virtual_card?.display === "action-button";

Expand Down