fix target idempotency, bump binary versions

Signed-off-by: Travis Glenn Hansen <travisghansen@yahoo.com>
This commit is contained in:
Travis Glenn Hansen
2025-10-31 09:45:28 -06:00
parent b3292da53d
commit ddf6b0d320
5 changed files with 148 additions and 26 deletions
+69 -8
View File
@@ -178,6 +178,49 @@ 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());
}
});
}
/**
* should create any necessary share resources
* should set the SHARE_VOLUME_CONTEXT_PROPERTY_NAME propery
@@ -884,21 +927,30 @@ class FreeNASApiDriver extends CsiBaseDriver {
target
);
// 409 if invalid
// 409 Conflict - target already exists or other validation errors
if (response.statusCode != 201) {
target = null;
if (
response.statusCode == 409 &&
JSON.stringify(response.body).includes(
"Target name already exists"
)
this.isTargetAlreadyExistsError(response.body)
) {
this.ctx.logger.debug(
"iSCSI target already exists, attempting to find existing target with name: %s",
iscsiName
);
target = await httpApiClient.findResourceByProperties(
"/services/iscsi/target",
{
iscsi_target_name: iscsiName,
}
);
if (target) {
this.ctx.logger.debug(
"Found existing iSCSI target with ID: %s, name: %s",
target.id,
target.iscsi_target_name
);
}
} else {
throw new GrpcError(
grpc.status.UNKNOWN,
@@ -1175,21 +1227,30 @@ class FreeNASApiDriver extends CsiBaseDriver {
response = await httpClient.post("/iscsi/target", target);
// 409 if invalid
// 422 Unprocessable Entity - validation errors including duplicate targets
if (response.statusCode != 200) {
target = null;
if (
response.statusCode == 422 &&
JSON.stringify(response.body).includes(
"Target name already exists"
)
this.isTargetAlreadyExistsError(response.body)
) {
this.ctx.logger.debug(
"iSCSI target already exists, attempting to find existing target with name: %s",
iscsiName
);
target = await httpApiClient.findResourceByProperties(
"/iscsi/target",
{
name: iscsiName,
}
);
if (target) {
this.ctx.logger.debug(
"Found existing iSCSI target with ID: %s, name: %s",
target.id,
target.name
);
}
} else {
throw new GrpcError(
grpc.status.UNKNOWN,
+1 -1
View File
@@ -67,7 +67,7 @@ class Api {
// crude stoppage attempt
let response = await httpClient.get(endpoint, queryParams);
if (lastReponse) {
if (JSON.stringify(lastReponse) == JSON.stringify(response)) {
if (JSON.stringify(lastReponse.body) == JSON.stringify(response.body)) {
break;
}
}
+70 -9
View File
@@ -228,7 +228,7 @@ class FreeNASSshDriver extends ControllerZfsBaseDriver {
// crude stoppage attempt
let response = await httpClient.get(endpoint, queryParams);
if (lastReponse) {
if (JSON.stringify(lastReponse) == JSON.stringify(response)) {
if (JSON.stringify(lastReponse.body) == JSON.stringify(response.body)) {
break;
}
}
@@ -273,6 +273,49 @@ class FreeNASSshDriver extends ControllerZfsBaseDriver {
return target;
}
/**
* 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());
}
});
}
/**
* should create any necessary share resources
* should set the SHARE_VOLUME_CONTEXT_PROPERTY_NAME propery
@@ -982,21 +1025,30 @@ class FreeNASSshDriver extends ControllerZfsBaseDriver {
target
);
// 409 if invalid
// 409 Conflict - target already exists or other validation errors
if (response.statusCode != 201) {
target = null;
if (
response.statusCode == 409 &&
JSON.stringify(response.body).includes(
"Target name already exists"
)
this.isTargetAlreadyExistsError(response.body)
) {
this.ctx.logger.debug(
"iSCSI target already exists, attempting to find existing target with name: %s",
iscsiName
);
target = await this.findResourceByProperties(
"/services/iscsi/target",
{
iscsi_target_name: iscsiName,
}
);
if (target) {
this.ctx.logger.debug(
"Found existing iSCSI target with ID: %s, name: %s",
target.id,
target.iscsi_target_name
);
}
} else {
throw new GrpcError(
grpc.status.UNKNOWN,
@@ -1271,21 +1323,30 @@ class FreeNASSshDriver extends ControllerZfsBaseDriver {
response = await httpClient.post("/iscsi/target", target);
// 409 if invalid
// 422 Unprocessable Entity - validation errors including duplicate targets
if (response.statusCode != 200) {
target = null;
if (
response.statusCode == 422 &&
JSON.stringify(response.body).includes(
"Target name already exists"
)
this.isTargetAlreadyExistsError(response.body)
) {
this.ctx.logger.debug(
"iSCSI target already exists, attempting to find existing target with name: %s",
iscsiName
);
target = await this.findResourceByProperties(
"/iscsi/target",
{
name: iscsiName,
}
);
if (target) {
this.ctx.logger.debug(
"Found existing iSCSI target with ID: %s, name: %s",
target.id,
target.name
);
}
} else {
throw new GrpcError(
grpc.status.UNKNOWN,