Skip to content

Commit

Permalink
code revise
Browse files Browse the repository at this point in the history
  • Loading branch information
Qinyuan Wan committed Mar 24, 2016
1 parent b789377 commit 9c7e28b
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 53 deletions.
83 changes: 45 additions & 38 deletions ClientRuntimes/NodeJS/ms-rest-azure/lib/azureServiceClient.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ function AzureServiceClient(credentials, options) {
if (!credentials) {
throw new Error('Azure clients require credentials.');
}

AzureServiceClient['super_'].call(this, credentials, options);

this.acceptLanguage = 'en-US';
this.generateClientRequestId = true;
this.longRunningOperationRetryTimeout = 30;

if (!options) options = {};

if (options.acceptLanguage !== null && options.acceptLanguage !== undefined) {
this.acceptLanguage = options.acceptLanguage;
}
Expand All @@ -62,7 +62,7 @@ util.inherits(AzureServiceClient, msRest.ServiceClient);
* @param {object} [options]
* @param {object} [options.customHeaders] headers that will be added to request
*/
AzureServiceClient.prototype.getPutOrPatchOperationResult = function(resultOfInitialRequest, options, callback) {
AzureServiceClient.prototype.getPutOrPatchOperationResult = function (resultOfInitialRequest, options, callback) {
var self = this;

if (!callback && typeof options === 'function') {
Expand All @@ -81,12 +81,10 @@ AzureServiceClient.prototype.getPutOrPatchOperationResult = function(resultOfIni
return callback(new Error('Missing resultOfInitialRequest.response'));
}

if (resultOfInitialRequest.response.statusCode !== 200 &&
resultOfInitialRequest.response.statusCode !== 201 &&
resultOfInitialRequest.response.statusCode !== 202 &&
resultOfInitialRequest.response.statusCode !== 204) {
return callback(new Error(util.format('Unexpected polling status code from long running operation \'%s\'',
resultOfInitialRequest.response.statusCode)));
if (this._checkInitialRequestResponseStatusCodeFailed(resultOfInitialRequest)) {
return callback(new Error(util.format('Unexpected polling status code from long running operation \'%s\' for method \'%s\'',
resultOfInitialRequest.response.statusCode,
resultOfInitialRequest.request.method)));
}

var pollingState = null;
Expand Down Expand Up @@ -147,7 +145,7 @@ AzureServiceClient.prototype.getPutOrPatchOperationResult = function(resultOfIni
* @param {object} [options]
* @param {object} [options.customHeaders] headers that will be added to request
*/
AzureServiceClient.prototype.getPostOrDeleteOperationResult = function(resultOfInitialRequest, options, callback) {
AzureServiceClient.prototype.getPostOrDeleteOperationResult = function (resultOfInitialRequest, options, callback) {
var self = this;

if (!callback && typeof options === 'function') {
Expand All @@ -166,12 +164,10 @@ AzureServiceClient.prototype.getPostOrDeleteOperationResult = function(resultOfI
return callback(new Error('Missing resultOfInitialRequest.response'));
}

if (resultOfInitialRequest.response.statusCode !== 200 &&
resultOfInitialRequest.response.statusCode !== 201 &&
resultOfInitialRequest.response.statusCode !== 202 &&
resultOfInitialRequest.response.statusCode !== 204) {
return callback(new Error(util.format('Unexpected polling status code from long running operation \'%s\'',
resultOfInitialRequest.response.statusCode)));
if (this._checkInitialRequestResponseStatusCodeFailed(resultOfInitialRequest)) {
return callback(new Error(util.format('Unexpected polling status code from long running operation \'%s\' for method \'%s\'',
resultOfInitialRequest.response.statusCode,
resultOfInitialRequest.request.method)));
}

var pollingState = null;
Expand All @@ -180,7 +176,6 @@ AzureServiceClient.prototype.getPostOrDeleteOperationResult = function(resultOfI
} catch (error) {
callback(error);
}

var resourceUrl = resultOfInitialRequest.request.url;
this._options = options;

Expand Down Expand Up @@ -226,19 +221,31 @@ AzureServiceClient.prototype.getPostOrDeleteOperationResult = function(resultOfI
});
};

AzureServiceClient.prototype._checkInitialRequestResponseStatusCodeFailed = function (initialRequest) {
if (initialRequest.response.statusCode === 200 ||
initialRequest.response.statusCode === 202 ||
(initialRequest.response.statusCode === 201 && initialRequest.request.method === 'PUT') ||
(initialRequest.response.statusCode === 204 && initialRequest.request.method === 'DELETE')) {
return false;
} else {
return true;
}
};


/**
* Retrieve operation status by polling from 'azure-asyncoperation' header.
* @param {object} [pollingState] - The object to persist current operation state.
* @param {boolean} [inPostOrDelete] - Invoked by Post Or Delete operation.
*/
AzureServiceClient.prototype._updateStateFromAzureAsyncOperationHeader = function(pollingState, inPostOrDelete, callback) {
this._getStatus(pollingState.azureAsyncOperationHeaderLink, function(err, result) {
AzureServiceClient.prototype._updateStateFromAzureAsyncOperationHeader = function (pollingState, inPostOrDelete, callback) {
this._getStatus(pollingState.azureAsyncOperationHeaderLink, function (err, result) {
if (err) return callback(err);

if (!result.body || !result.body.status) {
return callback(new Error('The response from long running operation does not contain a body.'));
}

pollingState.status = result.body.status;
pollingState.error = result.body.error;
pollingState.response = result.response;
Expand All @@ -252,10 +259,10 @@ AzureServiceClient.prototype._updateStateFromAzureAsyncOperationHeader = functio
};

/**
* Retrieve PUT/POST/PATCH/DELETE operation status by polling from 'location' header.
* Retrieve PUT operation status by polling from 'location' header.
* @param {object} [pollingState] - The object to persist current operation state.
*/
AzureServiceClient.prototype._updateStateFromLocationHeader = function(pollingState, callback) {
AzureServiceClient.prototype._updateStateFromLocationHeader = function (pollingState, callback) {
this._getStatus(pollingState.locationHeaderLink, function(err, result) {
if (err) return callback(err);

Expand Down Expand Up @@ -286,29 +293,29 @@ AzureServiceClient.prototype._updateStateFromLocationHeader = function(pollingSt
* @param {function} [resourceUrl] - The url of resource.
* @param {object} [pollingState] - The object to persist current operation state.
*/
AzureServiceClient.prototype._updateStateFromGetResourceOperation = function(resourceUrl, pollingState, callback) {
this._getStatus(resourceUrl, function(err, result) {
AzureServiceClient.prototype._updateStateFromGetResourceOperation = function (resourceUrl, pollingState, callback) {
this._getStatus(resourceUrl, function (err, result) {
if (err) return callback(err);
if (!result.body) {
return callback(new Error('The response from long running operation does not contain a body.'));
}

if (result.body.properties && result.body.properties.provisioningState) {
pollingState.status = result.body.properties.provisioningState;
} else {
pollingState.status = LroStates.Succeeded;
}

//we might not throw an error, but initialize here just in case.
pollingState.error = {
code: pollingState.status,
message: util.format('Long running operation failed with status \'%s\'.', pollingState.status)
};

pollingState.updateResponse(result.response);
pollingState.request = result.request;
pollingState.resource = result.body;

//nothing to return, the 'pollingState' has all the info we care.
callback(null);
});
Expand All @@ -318,35 +325,35 @@ AzureServiceClient.prototype._updateStateFromGetResourceOperation = function(res
* Retrieve operation status by querying the operation URL.
* @param {string} [operationUrl] - URL used to poll operation result.
*/
AzureServiceClient.prototype._getStatus = function(operationUrl, callback) {
AzureServiceClient.prototype._getStatus = function (operationUrl, callback) {
var self = this;
if (!operationUrl) {
return callback(new Error('operationUrl cannot be null.'));
}

// Construct URL
var requestUrl = operationUrl.replace(' ', '%20');

// Create HTTP transport objects
var httpRequest = new WebResource();
httpRequest.method = 'GET';
httpRequest.headers = {};
httpRequest.url = requestUrl;
if (this._options) {
if(this._options) {
for (var headerName in this._options['customHeaders']) {
if (this._options['customHeaders'].hasOwnProperty(headerName)) {
httpRequest.headers[headerName] = this._options['customHeaders'][headerName];
}
}
}
// Send Request
return self.pipeline(httpRequest, function(err, response, responseBody) {
return self.pipeline(httpRequest, function (err, response, responseBody) {
if (err) {
return callback(err);
}
var statusCode = response.statusCode;
if (statusCode !== 200 && statusCode !== 201 && statusCode !== 202 && statusCode !== 204) {
var error = new Error(util.format('Invalid status code with response body "%s" occurred ' +
var error = new Error(util.format('Invalid status code with response body "%s" occurred ' +
'when polling for operation status.', responseBody));
error.statusCode = response.statusCode;
error.request = msRest.stripRequest(httpRequest);
Expand All @@ -371,8 +378,8 @@ AzureServiceClient.prototype._getStatus = function(operationUrl, callback) {
try {
result.body = JSON.parse(responseBody);
} catch (deserializationError) {
var parseError = new Error(util.format('Error "%s" occurred in deserializing the response body - "%s" -' +
' when polling for operation status.', deserializationError, responseBody));
var parseError = new Error(util.format('Error "%s" occurred in deserializing the response body - "%s" -' +
' when polling for operation status.', deserializationError, responseBody));
parseError.request = msRest.stripRequest(httpRequest);
parseError.response = msRest.stripResponse(response);
parseError.body = responseBody;
Expand Down
26 changes: 13 additions & 13 deletions ClientRuntimes/NodeJS/ms-rest-azure/lib/pollingState.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,21 +25,21 @@ function PollingState(resultOfInitialRequest, retryTimeout) {
this.request = resultOfInitialRequest.request;
//Parse response.body & assign it as the resource
try {
if (resultOfInitialRequest.body &&
typeof resultOfInitialRequest.body.valueOf() === 'string' &&
resultOfInitialRequest.body.length > 0) {
if (resultOfInitialRequest.body &&
typeof resultOfInitialRequest.body.valueOf() === 'string' &&
resultOfInitialRequest.body.length > 0) {
this.resource = JSON.parse(resultOfInitialRequest.body);
} else {
this.resource = resultOfInitialRequest.body;
}
}
} catch (error) {
var deserializationError = new Error(util.format('Error "%s" occurred in parsing the responseBody ' +
var deserializationError = new Error(util.format('Error "%s" occurred in parsing the responseBody ' +
'while creating the PollingState for Long Running Operation- "%s"', error, resultOfInitialRequest.body));
deserializationError.request = resultOfInitialRequest.request;
deserializationError.response = resultOfInitialRequest.response;
throw deserializationError;
}

switch (this.response.statusCode) {
case 202:
this.status = LroStates.InProgress;
Expand Down Expand Up @@ -72,7 +72,7 @@ function PollingState(resultOfInitialRequest, retryTimeout) {
* Gets timeout in milliseconds.
* @returns {number} timeout
*/
PollingState.prototype.getTimeout = function() {
PollingState.prototype.getTimeout = function () {
if (this._retryTimeout || this._retryTimeout === 0) {
return this._retryTimeout * 1000;
}
Expand All @@ -86,13 +86,13 @@ PollingState.prototype.getTimeout = function() {
* Update cached data using the provided response object
* @param {object} [response] - provider response object.
*/
PollingState.prototype.updateResponse = function(response) {
PollingState.prototype.updateResponse = function (response) {
this.response = response;
if (response && response.headers) {
if (response.headers['azure-asyncoperation']) {
this.azureAsyncOperationHeaderLink = response.headers['azure-asyncoperation'];
}

if (response.headers['location']) {
this.locationHeaderLink = response.headers['location'];
}
Expand All @@ -103,7 +103,7 @@ PollingState.prototype.updateResponse = function(response) {
* Returns long running operation result.
* @returns {object} HttpOperationResponse
*/
PollingState.prototype.getOperationResponse = function() {
PollingState.prototype.getOperationResponse = function () {
var result = new msRest.HttpOperationResponse();
result.request = this.request;
result.response = this.response;
Expand All @@ -119,7 +119,7 @@ PollingState.prototype.getOperationResponse = function() {
* Returns an Error on operation failure.
* @returns {object} Error
*/
PollingState.prototype.getCloudError = function(err) {
PollingState.prototype.getCloudError = function (err) {
var errMsg;
var errCode;

Expand All @@ -133,11 +133,11 @@ PollingState.prototype.getCloudError = function(err) {
parsedResponse = JSON.parse(this.response.body);
}
} catch (err) {
error.message = util.format('Error "%s" occurred while deserializing the error ' +
error.message = util.format('Error "%s" occurred while deserializing the error ' +
'message "%s" for long running operation.', err.message, this.response.body);
return error;
}

if (err && err.message) {
errMsg = util.format('Long running operation failed with error: \'%s\'.', err.message);
} else {
Expand Down
4 changes: 2 additions & 2 deletions ClientRuntimes/NodeJS/ms-rest-azure/test/azureServiceClientTests.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ describe('AzureServiceClient', function () {

describe('Put', function () {
resultOfInitialRequest.response.statusCode = 201;
it('throw on not Lro related status code', function (done) {
client.getPutOrPatchOperationResult({ response: {statusCode: 10000}, request: { url:"http://foo" }}, function (err, result) {
err.message.should.containEql('Unexpected polling status code from long running operation');
Expand Down Expand Up @@ -205,7 +205,7 @@ describe('AzureServiceClient', function () {
resultOfInitialRequest.body.properties.provisioningState = LroStates.Succeeded;

it('throw on not Lro related status code', function (done) {
client.getPostOrDeleteOperationResult({ response: { statusCode: 203 }, request: {url: url_resource}}, function (err, result) {
client.getPostOrDeleteOperationResult({ response: { statusCode: 201 }, request: {url: url_resource, method: 'POST'}}, function (err, result) {
err.message.should.containEql('Unexpected polling status code from long running operation');
done();
});
Expand Down

0 comments on commit 9c7e28b

Please sign in to comment.