[Azure Storage Files] Bug with getting shared access signature

[gmantri]

• Package Name: @azure/storage-file-share
• Package Version: 12.2.0
• Operating system: macOS
• nodejs
  • version: 10.16.3
• browser
  • name/version:
• typescript
  • version:
• Is the bug related to documentation in
  • README.md
  • source code documentation
  • SDK API docs on https://docs.microsoft.com

Describe the bug

2 Issues actually:

1. When fetching access policies for a file share that has null value for either the start date or end date results in invalid date for that null value.

2. Getting a Type Error exception occurs while fetching access policies when an access policy has only defined an identifier and nothing else i.e. null start/end date and no permissions.

TypeError: Cannot read property 'expiresOn' of undefined
    at ShareClient.<anonymous> (ShareClient.ts:993)

The issue is coming from the following lines of code:

      for (const identifier of response) {
        res.signedIdentifiers.push({
          accessPolicy: {
            expiresOn: new Date(identifier.accessPolicy!.expiresOn!),
            permissions: identifier.accessPolicy!.permissions!,
            startsOn: new Date(identifier.accessPolicy!.startsOn!)
          },
          id: identifier.id
        });
      }

Two issues with the code above:

1. It does not check whether expiresOn and startsOn are defined and not null in accessPolicy. This would cause the 1st issue I mentioned above.

2. If I create an access policy with just an identifier, then the result will not even have an accessPolicy element. This is causing the 2nd issue.

I looked up code for getAccessPolicy method on QueueClient here: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-queue/src/QueueClient.ts#L934, and it is implemented correctly.

      for (const identifier of response) {
        let accessPolicy: any = undefined;
        if (identifier.accessPolicy) {
          accessPolicy = {
            permissions: identifier.accessPolicy.permissions
          };

          if (identifier.accessPolicy.expiresOn) {
            accessPolicy.expiresOn = new Date(identifier.accessPolicy.expiresOn);
          }

          if (identifier.accessPolicy.startsOn) {
            accessPolicy.startsOn = new Date(identifier.accessPolicy.startsOn);
          }
        }

        res.signedIdentifiers.push({
          accessPolicy,
          id: identifier.id
        });
      }

[XiaoningLiu]

Thanks for reporting! @gmantri Put this into our backlog for following releases. Welcome contribution too and marked with good first issue.

[ljian3377]

The temporary fix now is available in @azure/storage-file-share@12.3.0-beta.

[ljian3377]

Does the fix solve your problem? @gmantri

[gmantri]

@ljian3377 Thanks for following up. Unfortunately I haven't had the opportunity to try it out yet. I noticed that you made a beta release for this. Can you tell me an ETA for a general release? Considering we're using all features of Azure Storage in our application, I would rather not take a dependency on a beta version. I will wait for a general release of the next version of SDK. Thanks.

[ljian3377]

The next GA release would be in the early November.

[gmantri]

Thanks @ljian3377. I will wait till then. Thank you for your prompt response. It is very much appreciated.

[ljian3377]

The fix is now available in @azure/storage-file-share@12.3.0.

[ghost]

Hi, we're sending this friendly reminder because we haven't heard back from you in a while. We need more information about this issue to help address it. Please be sure to give us your input within the next 7 days. If we don't hear back from you within 14 days of this comment the issue will be automatically closed. Thank you!