ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-02-17 02:51:36 -05:00
Code Issues Packages Projects Releases Wiki Activity

Replace URL and use vscode.URI on local paths (#11624)

Browse Source 
* Use vscode.URI for local paths

* Use vscode.uri file method to set the name for remotebookfull path compressed file

* Add await on extract tar function

* Replace remote paths too

* Use vscode.uri.file instead of parse for local paths
This commit is contained in:
Barbara Valdez
2020-08-04 13:22:28 -07:00
committed by GitHub
parent 9df51b9936
commit e7ec278ef2
6 changed files with 37 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
extensions/notebook/src/book/githubRemoteBook.ts
View File

@@ -15,14 +15,14 @@ import { IAsset } from './remoteBookController';
import * as constants from '../common/constants'; import * as constants from '../common/constants';
export class GitHubRemoteBook extends RemoteBook { export class GitHubRemoteBook extends RemoteBook {
constructor(public remotePath: URL, public outputChannel: vscode.OutputChannel, protected _asset: IAsset) { constructor(public remotePath: vscode.Uri, public outputChannel: vscode.OutputChannel, protected _asset: IAsset) {
super(remotePath, outputChannel, _asset); super(remotePath, outputChannel, _asset);
} }
public async createLocalCopy(): Promise<void> { public async createLocalCopy(): Promise<void> {
this.outputChannel.show(true); this.outputChannel.show(true);
this.setLocalPath(); this.setLocalPath();
this.outputChannel.appendLine(loc.msgDownloadLocation(this._localPath.href)); this.outputChannel.appendLine(loc.msgDownloadLocation(this._localPath.fsPath));
this.outputChannel.appendLine(loc.msgRemoteBookDownloadProgress); this.outputChannel.appendLine(loc.msgRemoteBookDownloadProgress);
this.createDirectory(); this.createDirectory();
let notebookConfig = vscode.workspace.getConfiguration(constants.notebookConfigKey); let notebookConfig = vscode.workspace.getConfiguration(constants.notebookConfigKey);
@@ -35,7 +35,7 @@ export class GitHubRemoteBook extends RemoteBook {
'timeout': downloadTimeout 'timeout': downloadTimeout
} }
}; };
let downloadRequest = request.get(this._asset.browserDownloadUrl.href, options) let downloadRequest = request.get(this._asset.browserDownloadUrl.toString(false), options)
.on('error', (error) => { .on('error', (error) => {
this.outputChannel.appendLine(loc.msgRemoteBookDownloadError); this.outputChannel.appendLine(loc.msgRemoteBookDownloadError);
this.outputChannel.appendLine(error.message); this.outputChannel.appendLine(error.message);
@@ -47,8 +47,8 @@ export class GitHubRemoteBook extends RemoteBook {
return reject(new Error(loc.httpRequestError(response.statusCode, response.statusMessage))); return reject(new Error(loc.httpRequestError(response.statusCode, response.statusMessage)));
} }
}); });
let remoteBookFullPath = new URL(this._localPath.href.concat('.zip')); let remoteBookFullPath = vscode.Uri.file(this._localPath.fsPath.concat('.', this._asset.format));
downloadRequest.pipe(fs.createWriteStream(remoteBookFullPath.href)) downloadRequest.pipe(fs.createWriteStream(remoteBookFullPath.fsPath))
.on('close', async () => { .on('close', async () => {
resolve(this.extractFiles(remoteBookFullPath)); resolve(this.extractFiles(remoteBookFullPath));
}) })
@@ -62,34 +62,32 @@ export class GitHubRemoteBook extends RemoteBook {
} }
public async createDirectory(): Promise<void> { public async createDirectory(): Promise<void> {
let fileName = this._asset.book.concat('-').concat(this._asset.version).concat('-').concat(this._asset.language); let fileName = this._asset.book.concat('-').concat(this._asset.version).concat('-').concat(this._asset.language);
this._localPath = new URL(path.join(this._localPath.href, fileName)); this._localPath = vscode.Uri.file(path.join(this._localPath.fsPath, fileName));
try { try {
let exists = await fs.pathExists(this._localPath.href); let exists = await fs.pathExists(this._localPath.fsPath);
if (exists) { if (exists) {
await fs.remove(this._localPath.href); await fs.remove(this._localPath.fsPath);
} }
await fs.promises.mkdir(this._localPath.href); await fs.promises.mkdir(this._localPath.fsPath);
} catch (error) { } catch (error) {
this.outputChannel.appendLine(loc.msgRemoteBookDirectoryError); this.outputChannel.appendLine(loc.msgRemoteBookDirectoryError);
this.outputChannel.appendLine(error.message); this.outputChannel.appendLine(error.message);
} }
} }
public async extractFiles(remoteBookFullPath: URL): Promise<void> { public async extractFiles(remoteBookFullPath: vscode.Uri): Promise<void> {
try { try {
if (utils.getOSPlatform() === utils.Platform.Windows || utils.getOSPlatform() === utils.Platform.Mac) { if (utils.getOSPlatform() === utils.Platform.Windows || utils.getOSPlatform() === utils.Platform.Mac) {
let zippedFile = new zip(remoteBookFullPath.href); let zippedFile = new zip(remoteBookFullPath.fsPath);
zippedFile.extractAllTo(this._localPath.href); zippedFile.extractAllTo(this._localPath.fsPath);
} else { } else {
tar.extract({ file: remoteBookFullPath.href, cwd: this._localPath.href }).catch(error => { await tar.extract({ file: remoteBookFullPath.fsPath, cwd: this._localPath.fsPath });
this.outputChannel.appendLine(loc.msgRemoteBookUnpackingError);
this.outputChannel.appendLine(error.message);
});
} }
await fs.promises.unlink(remoteBookFullPath.href); await fs.promises.unlink(remoteBookFullPath.fsPath);
this.outputChannel.appendLine(loc.msgRemoteBookDownloadComplete); this.outputChannel.appendLine(loc.msgRemoteBookDownloadComplete);
vscode.commands.executeCommand('notebook.command.openNotebookFolder', this._localPath.href, undefined, true); vscode.commands.executeCommand('notebook.command.openNotebookFolder', this._localPath.fsPath, undefined, true);
} }
catch (err) { catch (err) {
this.outputChannel.appendLine(loc.msgRemoteBookUnpackingError);
this.outputChannel.appendLine(err.message); this.outputChannel.appendLine(err.message);
} }
} }

8
extensions/notebook/src/book/remoteBook.ts
View File

@@ -8,9 +8,9 @@ import * as utils from '../common/utils';
import { IAsset } from './remoteBookController'; import { IAsset } from './remoteBookController';
export abstract class RemoteBook { export abstract class RemoteBook {
protected _localPath: URL; protected _localPath: vscode.Uri;
constructor(public remotePath: URL, public outputChannel: vscode.OutputChannel, protected _asset?: IAsset) { constructor(public remotePath: vscode.Uri, public outputChannel: vscode.OutputChannel, protected _asset?: IAsset) {
this.remotePath = remotePath; this.remotePath = remotePath;
} }
@@ -21,10 +21,10 @@ export abstract class RemoteBook {
if (vscode.workspace.workspaceFolders !== undefined) { if (vscode.workspace.workspaceFolders !== undefined) {
// Get workspace root path // Get workspace root path
let folders = vscode.workspace.workspaceFolders; let folders = vscode.workspace.workspaceFolders;
this._localPath = new URL(folders[0].uri.fsPath); this._localPath = vscode.Uri.file(folders[0].uri.fsPath);
} else { } else {
//If no workspace folder is opened then path is Users directory //If no workspace folder is opened then path is Users directory
this._localPath = new URL(utils.getUserHome()); this._localPath = vscode.Uri.file(utils.getUserHome());
} }
} }
} }

20
extensions/notebook/src/book/remoteBookController.ts
View File

@@ -17,7 +17,7 @@ export class RemoteBookController {
constructor(public model: RemoteBookDialogModel, public outputChannel: vscode.OutputChannel) { constructor(public model: RemoteBookDialogModel, public outputChannel: vscode.OutputChannel) {
} }
public async setRemoteBook(url: URL, remoteLocation: string, asset?: IAsset): Promise<void> { public async setRemoteBook(url: vscode.Uri, remoteLocation: string, asset?: IAsset): Promise<void> {
if (remoteLocation === 'GitHub') { if (remoteLocation === 'GitHub') {
this.model.remoteBook = new GitHubRemoteBook(url, this.outputChannel, asset); this.model.remoteBook = new GitHubRemoteBook(url, this.outputChannel, asset);
} else { } else {
@@ -26,7 +26,7 @@ export class RemoteBookController {
return await this.model.remoteBook.createLocalCopy(); return await this.model.remoteBook.createLocalCopy();
} }
public async getReleases(url?: URL): Promise<IRelease[]> { public async getReleases(url?: vscode.Uri): Promise<IRelease[]> {
if (url) { if (url) {
this.model.releases = []; this.model.releases = [];
let options = { let options = {
@@ -35,7 +35,7 @@ export class RemoteBookController {
} }
}; };
return new Promise<IRelease[]>((resolve, reject) => { return new Promise<IRelease[]>((resolve, reject) => {
request.get(url.href, options, (error, response, body) => { request.get(url.toString(false), options, (error, response, body) => {
if (error) { if (error) {
return reject(error); return reject(error);
} }
@@ -50,7 +50,7 @@ export class RemoteBookController {
let keys = Object.keys(releases); let keys = Object.keys(releases);
keys.forEach(key => { keys.forEach(key => {
try { try {
bookReleases.push({ name: releases[key].name, assetsUrl: new URL(releases[key].assets_url) }); bookReleases.push({ name: releases[key].name, assetsUrl: vscode.Uri.parse(releases[key].assets_url) });
} }
catch (error) { catch (error) {
return reject(error); return reject(error);
@@ -84,7 +84,7 @@ export class RemoteBookController {
} }
}; };
return new Promise<IAsset[]>((resolve, reject) => { return new Promise<IAsset[]>((resolve, reject) => {
request.get(release.assetsUrl.href, options, (error, response, body) => { request.get(release.assetsUrl.toString(false), options, (error, response, body) => {
if (error) { if (error) {
return reject(error); return reject(error);
} }
@@ -98,9 +98,9 @@ export class RemoteBookController {
let keys = Object.keys(assets); let keys = Object.keys(assets);
keys.forEach(key => { keys.forEach(key => {
let asset = {} as IAsset; let asset = {} as IAsset;
asset.url = new URL(assets[key].url); asset.url = vscode.Uri.parse(assets[key].url);
asset.name = assets[key].name; asset.name = assets[key].name;
asset.browserDownloadUrl = new URL(assets[key].browser_download_url); asset.browserDownloadUrl = vscode.Uri.parse(assets[key].browser_download_url);
let groupsRe = asset.name.match(assetNameRE); let groupsRe = asset.name.match(assetNameRE);
if (groupsRe) { if (groupsRe) {
asset.book = groupsRe[1]; asset.book = groupsRe[1];
@@ -128,7 +128,7 @@ export class RemoteBookController {
export interface IRelease { export interface IRelease {
name: string; name: string;
assetsUrl: URL; assetsUrl: vscode.Uri;
} }
export interface IAsset { export interface IAsset {
@@ -137,6 +137,6 @@ export interface IAsset {
version: string; version: string;
language: string; language: string;
format: string; format: string;
url: URL; url: vscode.Uri;
browserDownloadUrl: URL; browserDownloadUrl: vscode.Uri;
} }

2
extensions/notebook/src/book/sharedRemoteBook.ts
View File

@@ -7,7 +7,7 @@ import * as vscode from 'vscode';
export class SharedRemoteBook extends RemoteBook { export class SharedRemoteBook extends RemoteBook {
constructor(public remotePath: URL, public outputChannel: vscode.OutputChannel) { constructor(public remotePath: vscode.Uri, public outputChannel: vscode.OutputChannel) {
super(remotePath, outputChannel); super(remotePath, outputChannel);
} }
public async createLocalCopy(): Promise<void> { public async createLocalCopy(): Promise<void> {

5
extensions/notebook/src/dialog/remoteBookDialog.ts
View File

@@ -7,6 +7,7 @@ import * as azdata from 'azdata';
import * as loc from '../common/localizedConstants'; import * as loc from '../common/localizedConstants';
import { RemoteBookController, IAsset } from '../book/remoteBookController'; import { RemoteBookController, IAsset } from '../book/remoteBookController';
import * as utils from '../common/utils'; import * as utils from '../common/utils';
import * as vscode from 'vscode';
const tigerToolboxRepo = 'repos/microsoft/tigertoolbox'; const tigerToolboxRepo = 'repos/microsoft/tigertoolbox';
const urlGithubRE = /^(?:https:\/\/(?:github\.com|api\.github\.com\/repos)|(?:\/)?(?:\/)?repos)([\w-.?!=&%*+:@\/]*)/g; const urlGithubRE = /^(?:https:\/\/(?:github\.com|api\.github\.com\/repos)|(?:\/)?(?:\/)?repos)([\w-.?!=&%*+:@\/]*)/g;
@@ -185,7 +186,7 @@ export class RemoteBookDialog {
let groupsRe = url.match(urlGithubRE); let groupsRe = url.match(urlGithubRE);
if (groupsRe?.length > 0) { if (groupsRe?.length > 0) {
url = apiGitHub(groupsRe[0]); url = apiGitHub(groupsRe[0]);
let releases = await this.controller.getReleases(new URL(url)); let releases = await this.controller.getReleases(vscode.Uri.parse(url));
if (releases) { if (releases) {
this.releaseDropdown.enabled = true; this.releaseDropdown.enabled = true;
await this.fillReleasesDropdown(); await this.fillReleasesDropdown();
@@ -232,7 +233,7 @@ export class RemoteBookDialog {
await this.controller.setRemoteBook(selected_asset.url, this.remoteLocationValue, selected_asset); await this.controller.setRemoteBook(selected_asset.url, this.remoteLocationValue, selected_asset);
} else { } else {
let url = utils.getDropdownValue(this.githubRepoDropdown); let url = utils.getDropdownValue(this.githubRepoDropdown);
let newUrl = new URL(url); let newUrl = vscode.Uri.parse(url);
await this.controller.setRemoteBook(newUrl, this.remoteLocationValue); await this.controller.setRemoteBook(newUrl, this.remoteLocationValue);
} }
return true; return true;

6
extensions/notebook/src/test/book/remoteBookController.test.ts
View File

@@ -30,7 +30,7 @@ describe('Remote Book Controller', function () {
it('Verify that errorMessage is thrown, when fetchReleases call returns empty', async function (): Promise<void> { it('Verify that errorMessage is thrown, when fetchReleases call returns empty', async function (): Promise<void> {
let expectedBody = JSON.stringify([]); let expectedBody = JSON.stringify([]);
let expectedURL = new URL('https://api.github.com/repos/microsoft/test/releases'); let expectedURL = vscode.Uri.parse('https://api.github.com/repos/microsoft/test/releases');
getStub.yields(null, { statusCode: 200 }, expectedBody); getStub.yields(null, { statusCode: 200 }, expectedBody);
try { try {
@@ -72,7 +72,7 @@ describe('Remote Book Controller', function () {
browser_download_url: 'https://api.github.com/repos/microsoft/test/releases/download/1/test-1.1-FR.tgz', browser_download_url: 'https://api.github.com/repos/microsoft/test/releases/download/1/test-1.1-FR.tgz',
} }
]); ]);
let expectedURL = new URL('https://api.github.com/repos/microsoft/test/releases/1/assets'); let expectedURL = vscode.Uri.parse('https://api.github.com/repos/microsoft/test/releases/1/assets');
let expectedRelease: IRelease = { let expectedRelease: IRelease = {
name: 'Test Release', name: 'Test Release',
assetsUrl: expectedURL assetsUrl: expectedURL
@@ -102,7 +102,7 @@ describe('Remote Book Controller', function () {
browser_download_url: 'https://api.github.com/repos/microsoft/test/releases/download/1/test-1.2.zip', browser_download_url: 'https://api.github.com/repos/microsoft/test/releases/download/1/test-1.2.zip',
}, },
]); ]);
let expectedURL = new URL('https://api.github.com/repos/microsoft/test/releases/1/assets'); let expectedURL = vscode.Uri.parse('https://api.github.com/repos/microsoft/test/releases/1/assets');
let expectedRelease: IRelease = { let expectedRelease: IRelease = {
name: 'Test Release', name: 'Test Release',
assetsUrl: expectedURL assetsUrl: expectedURL