Skip to content

Enhance CSV import error handling and validation #996

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

Closed
stephdl wants to merge 2 commits into from
Closed

Enhance CSV import error handling and validation #996

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec2cec0
feat: add CSV error handling messages for import process
stephdl Dec 6, 2025
59242a3
feat: enhance CSV import error handling and validation
stephdl Dec 6, 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
11 changes: 10 additions & 1 deletion core/ui/public/i18n/en/translation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1753,6 +1753,15 @@
"no_import_users_description": "The CSV file does not contain any user to import.",
"invalid_csv_format_not_expected_columns": "Invalid CSV format: unexpected number of columns",
"file_read_error": "File read error",
"importing_data_on_domain_name": "Importing data on domain {name}"
"importing_data_on_domain_name": "Importing data on domain {name}",
"csv_missing_header": "CSV file is missing the header row.",
"expected_columns": "Expected columns: {columns}",
"found_columns": "Found: {columns}",
"csv_missing_columns": "CSV file is missing required columns: {columns}",
"no_header_found": "no header row detected",
"csv_parse_errors": "CSV parsing errors detected:",
"csv_column_mismatch": "Line {line}: expected {expected} columns, found {found}",
"line": "Line",
"and_more_errors": "... and {count} more errors"
}
}
120 changes: 82 additions & 38 deletions core/ui/src/components/domains/ImportUsersModal.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,8 @@
<div
v-if="error.uploadCsvFile"
class="validation-failed-invalid-message"
>
{{ $t(error.uploadCsvFile) }}
</div>
v-html="$t(error.uploadCsvFile)"
></div>
<label class="bx--label">
{{ $t("import_users.manage_existing_users") }}
<cv-interactive-tooltip
Expand Down Expand Up @@ -294,50 +293,92 @@ export default {
reader.onload = (e) => {
try {
const csvContent = e.target.result;

// First parse with auto-detection to determine delimiter
const detectionResults = Papa.parse(csvContent, {
preview: 1,
skipEmptyLines: true,
});

// Check if first row contains valid headers
const firstRow = detectionResults.data[0] || [];
const trimmedFirstRow = firstRow.map((cell) =>
typeof cell === "string" ? cell.trim() : cell
);

// Detect if header row is present by checking if first row matches expected columns
const hasValidHeaders = this.tableColumns.every((col) =>
trimmedFirstRow.includes(col)
);

if (!hasValidHeaders) {
// Show which columns are expected with line breaks
const expectedCols = this.tableColumns.join(", ");
const foundCols = trimmedFirstRow.length > 0
? trimmedFirstRow.join(", ")
: this.$t("import_users.no_header_found");

this.error.uploadCsvFile =
this.$t("import_users.csv_missing_header") +
"<br>" +
this.$t("import_users.expected_columns", { columns: expectedCols }) +
"<br>" +
this.$t("import_users.found_columns", { columns: foundCols });
this.loading.getPreviewData = false;
return;
}

// Parse with detected delimiter and header support
const results = Papa.parse(csvContent, {
header: false, // Important: no header, we process columns by index
header: true, // Use first row as headers
skipEmptyLines: true,
delimiter: detectionResults.meta.delimiter, // Use auto-detected delimiter
transformHeader: (header) => header.trim(), // Trim header names
});

// Check if Papa parse encountered errors
if (results.errors && results.errors.length > 0) {
this.error.uploadCsvFile = "import_users.invalid_csv_format";
// Build detailed error message showing line-by-line issues
const errorDetails = results.errors
.slice(0, 5) // Show first 5 errors max
.map(err => {
if (err.type === 'FieldMismatch') {
return this.$t('import_users.csv_column_mismatch', {
line: err.row + 2, // +2 because row is 0-indexed and we have header
expected: results.meta.fields.length,
found: err.row < results.data.length ? Object.keys(results.data[err.row]).length : '?'
});
}
return `${this.$t('import_users.line')} ${err.row + 2}: ${err.message}`;
})
.join('<br>');

const moreErrors = results.errors.length > 5
? '<br>' + this.$t('import_users.and_more_errors', { count: results.errors.length - 5 })
: '';

this.error.uploadCsvFile =
this.$t('import_users.csv_parse_errors') + '<br>' + errorDetails + moreErrors;
this.loading.getPreviewData = false;
return;
}

// Check if first row is the header and remove it
const headerString =
"user,display_name,password,mail,groups,locked,must_change_password,no_password_expiration";
if (
results.data.length > 0 &&
results.data[0].join(",") === headerString
) {
results.data = results.data.slice(1);
}
// Validate that all required columns are present (double-check after parsing)
const requiredColumns = this.tableColumns;
const headers = results.meta.fields || [];

// Define expected column
let expectedColumns = this.tableColumns.length;
// Validate column count in all rows
for (let i = 0; i < results.data.length; i++) {
if (results.data[i].length !== expectedColumns) {
this.error.uploadCsvFile =
"import_users.invalid_csv_format_not_expected_columns";
this.loading.getPreviewData = false;
return;
}
}
const missingColumns = requiredColumns.filter(
(col) => !headers.includes(col)
);

let COLUMN_MAPPING = {
0: "user",
1: "display_name",
2: "password",
3: "mail",
4: "groups",
5: "locked",
6: "must_change_password",
7: "no_password_expiration",
};
if (missingColumns.length > 0) {
this.error.uploadCsvFile = this.$t(
"import_users.csv_missing_columns",
{ columns: missingColumns.join(", ") }
);
this.loading.getPreviewData = false;
return;
}

// Define which fields should be booleans
const booleanFields = [
Expand All @@ -346,11 +387,13 @@ export default {
"no_password_expiration",
];

// Transform rows into objects with correct keys
// Transform rows - Papa.parse already created objects with headers as keys
this.importData = results.data.map((row) => {
const obj = {};
Object.entries(COLUMN_MAPPING).forEach(([index, key]) => {
let value = row[index];

// Process each expected column
this.tableColumns.forEach((key) => {
let value = row[key];

// Trim whitespace from string values
if (typeof value === "string") {
Expand Down Expand Up @@ -378,6 +421,7 @@ export default {
}
obj[key] = value;
});

return obj;
});

Expand Down