The CorsRule type is of type CorsRule array, but when getProperties is called on a blob service client with no Cors rules it returns an empty string instead of an empty array. #11071
Assignees
Labels
Azure.Core
bug
This issue requires a change to an existing behavior in the product in order to be resolved.
Client
This issue points to a problem in the data-plane of the library.
customer-reported
Issues that are reported by GitHub users external to the Azure organization.
Storage
Storage Service (Queues, Blobs, Files)
Milestone
Comments
ghost
added
needs-triage
ramya-rao-a
added
Client
ghost
removed
the
needs-triage
ghost
added
the
needs-team-attention
|
Thanks @avenmia, I'm following up this issue with colleagues working on auto generated deserialization. |
jiacfan
added
the
bug
|
Looks like a deserialization issue in core-http. Will investigate further and work on a fix. |
jeremymeng
added a commit
to jeremymeng/azure-sdk-for-js
that referenced
this issue
Sep 18, 2020
When de-serializing an empty list of xml elements we expect to get an empty array `[]` back. However, currently we get the empty string `''` instead.
The cause of the issue is that when de-serializing wrapped xml list, we were re-using the variable `unwrappedProperty`, and a short-circuit:
```typescript
unwrappedProperty = responseBody[xmlName!]; // line.1
unwrappedProperty = unwrappedProperty && unwrappedProperty[xmlElementName!]; // line.2
```
In a normal case of
```xml
<Cors>
<CorsRule>...</CorsRule>
<CorsRule>...</CorsRule>
</Cors>
```
The parsed object (`responseBody`) from xml parser is
```js
{ Cors: { CorsRule: [{...}, {...}] } }
```
After line.1, we have `unwrappedProperty` with value `{ CorsRule: [{...}, {...}] }`. Then after line.2, we have `unwrappedProperty` with the array as its value. So far so good.
However, in the failing case of
```xml
<Cors />
```
The parsed object from xml parser is
```js
{ Cors: '' }
```
After the first line, we have `unwrappedProperty` as the empty string `''`, the short-circuit on line two keeps `unwrappedProperty` as `''`, which fails the condition
```typescript
const isEmptyWrappedList = unwrappedProperty === undefined;
```
therefore, the expected empty array is not assigned.
This change removes the confusing mutable variable and the short-circuit. Now we just pick the empty array if the wrapped property is falsy.
Fixes Azure#11071
ramya-rao-a
removed
question
jeremymeng
added a commit
that referenced
this issue
Sep 24, 2020
) * [core-http] de-serialize empty wrapped xml element list properly When de-serializing an empty list of xml elements we expect to get an empty array `[]` back. However, currently we get the empty string `''` instead. The cause of the issue is that when de-serializing wrapped xml list, we were re-using the variable `unwrappedProperty`, and a short-circuit: ```typescript unwrappedProperty = responseBody[xmlName!]; // line.1 unwrappedProperty = unwrappedProperty && unwrappedProperty[xmlElementName!]; // line.2 ``` In a normal case of ```xml <Cors> <CorsRule>...</CorsRule> <CorsRule>...</CorsRule> </Cors> ``` The parsed object (`responseBody`) from xml parser is ```js { Cors: { CorsRule: [{...}, {...}] } } ``` After line.1, we have `unwrappedProperty` with value `{ CorsRule: [{...}, {...}] }`. Then after line.2, we have `unwrappedProperty` with the array as its value. So far so good. However, in the failing case of ```xml <Cors /> ``` The parsed object from xml parser is ```js { Cors: '' } ``` After the first line, we have `unwrappedProperty` as the empty string `''`, the short-circuit on line two keeps `unwrappedProperty` as `''`, which fails the condition ```typescript const isEmptyWrappedList = unwrappedProperty === undefined; ``` therefore, the expected empty array is not assigned. This change removes the confusing mutable variable and the short-circuit. Now we just pick the empty array if the wrapped property is falsy. Fixes #11071 * Address CR feedback replace ternary with ?. and ?? * Port fix and test to core-client * Move new tests from serviceClientTests to deserializationPolicyTests
deyaaeldeen
pushed a commit
to deyaaeldeen/azure-sdk-for-js
that referenced
this issue
Sep 25, 2020
…re#11344) * [core-http] de-serialize empty wrapped xml element list properly When de-serializing an empty list of xml elements we expect to get an empty array `[]` back. However, currently we get the empty string `''` instead. The cause of the issue is that when de-serializing wrapped xml list, we were re-using the variable `unwrappedProperty`, and a short-circuit: ```typescript unwrappedProperty = responseBody[xmlName!]; // line.1 unwrappedProperty = unwrappedProperty && unwrappedProperty[xmlElementName!]; // line.2 ``` In a normal case of ```xml <Cors> <CorsRule>...</CorsRule> <CorsRule>...</CorsRule> </Cors> ``` The parsed object (`responseBody`) from xml parser is ```js { Cors: { CorsRule: [{...}, {...}] } } ``` After line.1, we have `unwrappedProperty` with value `{ CorsRule: [{...}, {...}] }`. Then after line.2, we have `unwrappedProperty` with the array as its value. So far so good. However, in the failing case of ```xml <Cors /> ``` The parsed object from xml parser is ```js { Cors: '' } ``` After the first line, we have `unwrappedProperty` as the empty string `''`, the short-circuit on line two keeps `unwrappedProperty` as `''`, which fails the condition ```typescript const isEmptyWrappedList = unwrappedProperty === undefined; ``` therefore, the expected empty array is not assigned. This change removes the confusing mutable variable and the short-circuit. Now we just pick the empty array if the wrapped property is falsy. Fixes Azure#11071 * Address CR feedback replace ternary with ?. and ?? * Port fix and test to core-client * Move new tests from serviceClientTests to deserializationPolicyTests
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Describe the bug
A clear and concise description of what the bug is.
When calling getProperties() on a BlobServiceClient it returned a Cors property with the value: '' (empty string). When I modify the a different property (deleteRetentionPolicy) and try to call setProperties I get an error stating that cors needs to be of type array.
"{"message":"blobServiceProperties.Cors must be of type Array.","stack":"Error: blobServiceProperties.Cors must be of type Array.\n at serializeSequenceType "
To Reproduce
Steps to reproduce the behavior:
Expected behavior
A clear and concise description of what you expected to happen.
When calling getProperties on a blob service client with no Cors settings it should return an empty array in the Cors property. This will allow setProperties to be called without issues.
Screenshots
If applicable, add screenshots to help explain your problem.
After calling getProperties()
Additional context
Add any other context about the problem here.
Here is my current workaround:
Azure/azure-storage-node#655 (comment)
@jiacfan
The text was updated successfully, but these errors were encountered: