fix(api): fix the error message parsing that the `Target with this name already exists` looks for, and provide better output to user

This commit is contained in:
perf3ct 2025-08-06 20:39:20 +00:00
parent e5bd0a1b50
commit 8ce5243c7b
No known key found for this signature in database
GPG Key ID: 569C4EEC436F5232
1 changed files with 46 additions and 8 deletions

View File

@ -150,6 +150,48 @@ class FreeNASApiDriver extends CsiBaseDriver {
} }
} }
/**
* Check if an error response indicates a target already exists.
* This method handles variations in TrueNAS API error messages across different API versions.
*
* @param {string|Object} responseBody - The HTTP response body (string or object)
* @returns {boolean} - true if the error indicates target already exists
*/
isTargetAlreadyExistsError(responseBody) {
// Extract error message more efficiently
let errorString = '';
if (typeof responseBody === 'string') {
errorString = responseBody;
} else if (responseBody && typeof responseBody === 'object') {
// Try common error message fields first to avoid full JSON.stringify
errorString = responseBody.message ||
responseBody.error ||
responseBody.detail ||
JSON.stringify(responseBody);
} else {
return false;
}
// Handle multiple variations of the target already exists error message
const targetExistsPatterns = [
"Target name already exists", // Original pattern in code (API v1)
"Target with this name already exists", // Actual TrueNAS error message (API v2)
"Target\\b.*\\balready\\b.*\\bexists" // Flexible pattern with word boundaries
];
return targetExistsPatterns.some(pattern => {
if (pattern.includes("\\")) {
// Use regex for flexible patterns with word boundaries
const regex = new RegExp(pattern, "i");
return regex.test(errorString);
} else {
// Use case-insensitive simple string matching for exact patterns
return errorString.toLowerCase().includes(pattern.toLowerCase());
}
});
}
/** /**
* only here for the helpers * only here for the helpers
* @returns * @returns
@ -835,14 +877,12 @@ class FreeNASApiDriver extends CsiBaseDriver {
target target
); );
// 409 if invalid // 409 Conflict - target already exists or other validation errors
if (response.statusCode != 201) { if (response.statusCode != 201) {
target = null; target = null;
if ( if (
response.statusCode == 409 && response.statusCode == 409 &&
JSON.stringify(response.body).includes( this.isTargetAlreadyExistsError(response.body)
"Target name already exists"
)
) { ) {
target = await httpApiClient.findResourceByProperties( target = await httpApiClient.findResourceByProperties(
"/services/iscsi/target", "/services/iscsi/target",
@ -1123,14 +1163,12 @@ class FreeNASApiDriver extends CsiBaseDriver {
response = await httpClient.post("/iscsi/target", target); response = await httpClient.post("/iscsi/target", target);
// 409 if invalid // 422 Unprocessable Entity - validation errors including duplicate targets
if (response.statusCode != 200) { if (response.statusCode != 200) {
target = null; target = null;
if ( if (
response.statusCode == 422 && response.statusCode == 422 &&
JSON.stringify(response.body).includes( this.isTargetAlreadyExistsError(response.body)
"Target name already exists"
)
) { ) {
target = await httpApiClient.findResourceByProperties( target = await httpApiClient.findResourceByProperties(
"/iscsi/target", "/iscsi/target",