Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ⬆️ to newest Azure Storage SDK for file shares 🗂 #558

Merged
merged 5 commits into from
Jan 11, 2020
Merged

Update ⬆️ to newest Azure Storage SDK for file shares 🗂 #558

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4206cd4
Update SDK
Jan 8, 2020
2ce5e7b
Address PR comments
Jan 10, 2020
c102318
Merge master
Jan 10, 2020
87e8cdc
Link uploadData issue
Jan 10, 2020
50d697b
Merge master
Jan 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -739,6 +739,7 @@
],
"dependencies": {
"@azure/storage-blob": "^12.0.0",
"@azure/storage-file-share": "^12.0.0",
"@types/mime": "^2.0.1",
"azure-arm-resource": "^3.1.1-preview",
"azure-arm-storage": "^5.1.1-preview",
Expand Down
31 changes: 12 additions & 19 deletions src/AzureStorageFS.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*--------------------------------------------------------------------------------------------*/

import { BlobClient, BlobDownloadResponseModel } from "@azure/storage-blob";
import * as azureStorage from "azure-storage";
import { FileDownloadResponseModel, ShareFileClient } from "@azure/storage-file-share";
import * as path from "path";
import * as querystring from "querystring";
import * as vscode from "vscode";
Expand All @@ -18,6 +18,7 @@ import { FileShareTreeItem, IFileShareCreateChildContext } from "./tree/fileShar
import { FileTreeItem } from "./tree/fileShare/FileTreeItem";
import { createBlobClient, createOrUpdateBlockBlob, doesBlobExist, IBlobContainerCreateChildContext } from './utils/blobUtils';
import { doesFileExist, updateFileFromText } from "./utils/fileUtils";
import { createFileClient } from './utils/fileUtils';
import { localize } from "./utils/localize";
import { nonNullValue } from "./utils/nonNull";
import { validateDirectoryName } from "./utils/validateNames";
Expand Down Expand Up @@ -84,9 +85,9 @@ export class AzureStorageFS implements vscode.FileSystemProvider {
let result: [string, vscode.FileType][] = [];
for (const child of children) {
if (child instanceof FileTreeItem) {
result.push([child.file.name, vscode.FileType.File]);
result.push([child.fileName, vscode.FileType.File]);
} else if (child instanceof DirectoryTreeItem) {
result.push([child.directory.name, vscode.FileType.Directory]);
result.push([child.directoryName, vscode.FileType.Directory]);
} else if (child instanceof BlobTreeItem) {
result.push([child.blobName, vscode.FileType.File]);
} else if (child instanceof BlobDirectoryTreeItem) {
Expand Down Expand Up @@ -149,6 +150,8 @@ export class AzureStorageFS implements vscode.FileSystemProvider {
}

async readFile(uri: vscode.Uri): Promise<Uint8Array> {
let client: ShareFileClient | BlobClient;
let downloaded: FileDownloadResponseModel | BlobDownloadResponseModel;
return await callWithTelemetryAndErrorHandling('readFile', async (context) => {
context.telemetry.suppressIfSuccessful = true;
context.errorHandling.rethrow = true;
Expand All @@ -160,22 +163,12 @@ export class AzureStorageFS implements vscode.FileSystemProvider {

try {
if (treeItem instanceof FileShareTreeItem) {
let service: azureStorage.FileService = treeItem.root.createFileService();
let shareName: string = treeItem.share.name;
result = await new Promise<string | undefined>((resolve, reject) => {
service.getFileToText(shareName, parsedUri.parentDirPath, parsedUri.baseName, (error?: Error, text?: string) => {
if (!!error) {
reject(error);
} else {
resolve(text);
}
});
});
client = createFileClient(treeItem.root, treeItem.shareName, parsedUri.parentDirPath, parsedUri.baseName);
} else {
const blobClient: BlobClient = createBlobClient(treeItem.root, treeItem.container.name, parsedUri.filePath);
let downloaded: BlobDownloadResponseModel = await blobClient.download();
result = await this.streamToString(downloaded.readableStreamBody);
client = createBlobClient(treeItem.root, treeItem.container.name, parsedUri.filePath);
}
downloaded = await client.download();
result = await this.streamToString(downloaded.readableStreamBody);
} catch (error) {
let pe = parseError(error);
if (pe.errorType === 'BlobNotFound' || pe.errorType === 'ResourceNotFound') {
Expand Down Expand Up @@ -210,7 +203,7 @@ export class AzureStorageFS implements vscode.FileSystemProvider {

let childExistsRemote: boolean;
if (treeItem instanceof FileShareTreeItem) {
childExistsRemote = await doesFileExist(parsedUri.baseName, treeItem, parsedUri.parentDirPath, treeItem.share);
childExistsRemote = await doesFileExist(parsedUri.baseName, treeItem, parsedUri.parentDirPath, treeItem.shareName);
} else {
childExistsRemote = await doesBlobExist(treeItem, parsedUri.filePath);
}
Expand All @@ -230,7 +223,7 @@ export class AzureStorageFS implements vscode.FileSystemProvider {
progress.report({ message: `Saving ${writeToFileShare ? 'file' : 'blob'} ${parsedUri.filePath}` });

if (treeItem instanceof FileShareTreeItem) {
await updateFileFromText(parsedUri.parentDirPath, parsedUri.baseName, treeItem.share, treeItem.root, content.toString());
await updateFileFromText(parsedUri.parentDirPath, parsedUri.baseName, treeItem.shareName, treeItem.root, content.toString());
} else {
await createOrUpdateBlockBlob(treeItem, parsedUri.filePath, content.toString());
}
Expand Down
2 changes: 1 addition & 1 deletion src/commands/fileShare/fileShareActionHandlers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ async function openFileShareInStorageExplorer(_context: IActionContext, treeItem
let accountId = treeItem.root.storageAccount.id;
let subscriptionid = treeItem.root.subscriptionId;
const resourceType = 'Azure.FileShare';
let resourceName = treeItem.share.name;
let resourceName = treeItem.shareName;

await storageExplorerLauncher.openResource(accountId, subscriptionid, resourceType, resourceName);
}
25 changes: 10 additions & 15 deletions src/editors/FileFileHandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,29 @@
* Licensed under the MIT License. See License.md in the project root for license information.
*--------------------------------------------------------------------------------------------*/

import * as azureStorage from "azure-storage";
import * as azureStorageShare from '@azure/storage-file-share';
import { FileTreeItem } from "../tree/fileShare/FileTreeItem";
import { updateFileFromLocalFile } from '../utils/fileUtils';
import { getExistingCreateOptions } from '../utils/fileUtils';
import { createFileClient } from '../utils/fileUtils';
import { IRemoteFileHandler } from './IRemoteFileHandler';

export class FileFileHandler implements IRemoteFileHandler<FileTreeItem> {
async getSaveConfirmationText(treeItem: FileTreeItem): Promise<string> {
return `Saving '${treeItem.file.name}' will update the file "${treeItem.file.name}" in File Share "${treeItem.share.name}"`;
return `Saving '${treeItem.fileName}' will update the file "${treeItem.fileName}" in File Share "${treeItem.shareName}"`;
}

async getFilename(treeItem: FileTreeItem): Promise<string> {
return treeItem.file.name;
return treeItem.fileName;
}

async downloadFile(treeItem: FileTreeItem, filePath: string): Promise<void> {
let fileService = treeItem.root.createFileService();
await new Promise<void>((resolve, reject) => {
fileService.getFileToLocalFile(treeItem.share.name, treeItem.directoryPath, treeItem.file.name, filePath, (error?: Error, _result?: azureStorage.FileService.FileResult, _response?: azureStorage.ServiceResponse) => {
if (!!error) {
reject(error);
} else {
resolve();
}
});
});
const fileClient = createFileClient(treeItem.root, treeItem.shareName, treeItem.directoryPath, treeItem.fileName);
await fileClient.downloadToFile(filePath);
}

async uploadFile(treeItem: FileTreeItem, filePath: string): Promise<void> {
await updateFileFromLocalFile(treeItem.directoryPath, treeItem.file.name, treeItem.share, treeItem.root, filePath);
const options: azureStorageShare.FileCreateOptions = await getExistingCreateOptions(treeItem.directoryPath, treeItem.fileName, treeItem.shareName, treeItem.root);
const fileClient: azureStorageShare.ShareFileClient = createFileClient(treeItem.root, treeItem.shareName, treeItem.directoryPath, treeItem.fileName);
await fileClient.uploadFile(filePath, options);
}
}
2 changes: 2 additions & 0 deletions src/tree/IStorageRoot.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
*--------------------------------------------------------------------------------------------*/

import * as azureStorageBlob from "@azure/storage-blob";
import * as azureStorageShare from "@azure/storage-file-share";
import * as azureStorage from "azure-storage";
import { ISubscriptionContext } from "vscode-azureextensionui";
import { StorageAccountWrapper } from "../utils/storageWrappers";
Expand All @@ -12,6 +13,7 @@ export interface IStorageRoot extends ISubscriptionContext {
storageAccount: StorageAccountWrapper;
createBlobServiceClient(): azureStorageBlob.BlobServiceClient;
createFileService(): azureStorage.FileService;
createShareServiceClient(): azureStorageShare.ShareServiceClient;
createQueueService(): azureStorage.QueueService;
createTableService(): azureStorage.TableService;
}
8 changes: 7 additions & 1 deletion src/tree/StorageAccountTreeItem.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
*--------------------------------------------------------------------------------------------*/

import * as azureStorageBlob from '@azure/storage-blob';
import * as azureStorageShare from '@azure/storage-file-share';
import { StorageManagementClient } from 'azure-arm-storage';
import { StorageAccountKey } from 'azure-arm-storage/lib/models';
import * as azureStorage from "azure-storage";
Expand All @@ -14,6 +15,7 @@ import { commands, MessageItem, Uri, window } from 'vscode';
import { AzureParentTreeItem, AzureTreeItem, createAzureClient, DialogResponses, IActionContext, ISubscriptionContext, UserCancelledError } from 'vscode-azureextensionui';
import { getResourcesPath, staticWebsiteContainerName } from '../constants';
import { ext } from "../extensionVariables";
import { nonNullProp } from '../utils/nonNull';
import { StorageAccountKeyWrapper, StorageAccountWrapper } from '../utils/storageWrappers';
import { BlobContainerGroupTreeItem } from './blob/BlobContainerGroupTreeItem';
import { BlobContainerTreeItem } from "./blob/BlobContainerTreeItem";
Expand Down Expand Up @@ -160,11 +162,15 @@ export class StorageAccountTreeItem extends AzureParentTreeItem<IStorageRoot> {
storageAccount: this.storageAccount,
createBlobServiceClient: () => {
const credential = new azureStorageBlob.StorageSharedKeyCredential(this.storageAccount.name, this.key.value);
return new azureStorageBlob.BlobServiceClient(this.storageAccount.primaryEndpoints.blob || `https://${this.storageAccount.name}.blob.core.windows.net`, credential);
return new azureStorageBlob.BlobServiceClient(nonNullProp(this.storageAccount.primaryEndpoints, 'blob'), credential);
},
createFileService: () => {
return azureStorage.createFileService(this.storageAccount.name, this.key.value, this.storageAccount.primaryEndpoints.file).withFilter(new azureStorage.ExponentialRetryPolicyFilter());
},
createShareServiceClient: () => {
const credential = new azureStorageShare.StorageSharedKeyCredential(this.storageAccount.name, this.key.value);
return new azureStorageShare.ShareServiceClient(nonNullProp(this.storageAccount.primaryEndpoints, 'file'), credential);
},
createQueueService: () => {
return azureStorage.createQueueService(this.storageAccount.name, this.key.value, this.storageAccount.primaryEndpoints.queue).withFilter(new azureStorage.ExponentialRetryPolicyFilter());
},
Expand Down
1 change: 0 additions & 1 deletion src/tree/blob/BlobContainerTreeItem.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,6 @@ export class BlobContainerTreeItem extends AzureParentTreeItem<IStorageRoot> imp
}

private async listAllBlobs(cancellationToken?: vscode.CancellationToken, properties?: TelemetryProperties): Promise<azureStorageBlob.BlobItem[]> {
// tslint:disable-next-line:no-any
let currentToken: string | undefined;
let response: AsyncIterableIterator<azureStorageBlob.ContainerListBlobFlatSegmentResponse>;
let responseValue: azureStorageBlob.ListBlobsFlatSegmentResponse;
Expand Down
Loading