ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-01-22 09:35:37 -05:00
Code Issues Packages Projects Releases Wiki Activity

check for encoded components (#18231)

Browse Source 
* check for encoded components

* address comments

* relocate and simplify test

* move encodeUrl to notebookLinkHandler

* added comments

* add containsEncodedUri to network.ts
This commit is contained in:
Maddy
2022-02-09 13:36:23 -08:00
committed by GitHub
parent fdf7bbcf60
commit f17e70472f
5 changed files with 62 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/sql/workbench/contrib/notebook/browser/cellViews/markdownToolbar.component.ts
View File

@@ -278,8 +278,8 @@ export class MarkdownToolbarComponent extends AngularDisposable {
// Otherwise, re-focus on the output element, and insert the link directly.
this.output?.nativeElement?.focus();
// Need to encode URI here in order for user to click the proper encoded link in WYSIWYG
let encodedLinkURL = encodeURI(linkUrl);
document.execCommand('insertHTML', false, `<a href="${encodedLinkURL}" title="${encodedLinkURL}" is-encoded="true" is-absolute=${notebookLink.isAbsolutePath}>${escape(linkCalloutResult?.insertUnescapedLinkLabel)}</a>`);
let encodedLinkURL = notebookLink.getEncodedLinkUrl();
document.execCommand('insertHTML', false, `<a href="${encodedLinkURL}" title="${linkUrl}" is-encoded="true" is-absolute=${notebookLink.isAbsolutePath}>${escape(linkCalloutResult?.insertUnescapedLinkLabel)}</a>`);
return;
}
} else if (type === MarkdownButtonType.IMAGE_PREVIEW) {

19
src/sql/workbench/contrib/notebook/browser/notebookLinkHandler.ts
View File

@@ -8,6 +8,7 @@ import * as path from 'vs/base/common/path';
import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
import { replaceInvalidLinkPath } from 'sql/workbench/contrib/notebook/common/utils';
import { isWindows } from 'vs/base/common/platform';
import { containsEncodedUriComponentReservedCharacters } from 'sql/base/common/network';
const useAbsolutePathConfigName = 'notebook.useAbsoluteFilePaths';
@@ -118,6 +119,24 @@ export class NotebookLinkHandler {
}
}
/**
* Function to get encoded url, Gets the link URI-encoded link URL
* (https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/encodeURI)
* @returns the encoded url
*/
public getEncodedLinkUrl(): string | undefined {
if (typeof this._link === 'string') {
// Need to encode URI here in order for user to click the proper encoded link in WYSIWYG
// skip encoding it if it's already encoded
if (!containsEncodedUriComponentReservedCharacters(this._link)) {
return encodeURI(this._link);
}
return this._link;
}
// since we only handle strings that come from call out dialogs
return undefined;
}
/**
* Creates a URI for for a link with a anchor (#)
* @param node is the HTMLAnchorElement of the target notebook

1
src/sql/workbench/contrib/notebook/browser/utils.ts
View File

@@ -43,4 +43,3 @@ export function highlightSelectedText(): void {
document.execCommand('hiliteColor', false, 'Yellow');
}
}

27
src/sql/workbench/contrib/notebook/test/browser/notebookLinkHandler.test.ts
View File

@@ -103,4 +103,31 @@ suite('Noteboook Link Handler', function (): void {
result = new NotebookLinkHandler(notebookUri, Object.assign(document.createElement('a'), { href: '/tmp/my%20stuff.png' }), configurationService);
assert.strictEqual(result.getLinkUrl(), `.${path.sep}my%2520stuff.png`, 'Basic link test with %20 filename failed');
});
test('Should return correctly encoded url/filePath', () => {
test('when given an already-encoded URL', () => {
let notebookLinkHandler = new NotebookLinkHandler(notebookUri, 'https://github.com/search/advanced?q=test&r=microsoft%2Fazuredatastudio&type=Code', configurationService);
assert.strictEqual(notebookLinkHandler.getEncodedLinkUrl(), `https://github.com/search/advanced?q=test&r=microsoft%2Fazuredatastudio&type=Code`, 'HTTPS link does not need encoding');
});
test('when given an already encoded URL with non-reserved characters', () => {
let notebookLinkHandler = new NotebookLinkHandler(notebookUri, 'https://github.com/search/advanced?q=test&r=(microsoft%2Fazuredatastudio)&type=Code', configurationService);
assert.strictEqual(notebookLinkHandler.getEncodedLinkUrl(), `https://github.com/search/advanced?q=test&r=(microsoft%2Fazuredatastudio)&type=Code`, '() in HTTP link should not be encoded');
});
test('when given an unencoded URL with a space', () => {
let notebookLinkHandler = new NotebookLinkHandler(notebookUri, 'https://github.com/search/advanced?q=test&r=(microsoft/azuredata studio)&type=Code', configurationService);
assert.strictEqual(notebookLinkHandler.getEncodedLinkUrl(), `https://github.com/search/advanced?q=test&r=(microsoft/azuredata%20studio)&type=Code`, 'space in the url failed to be encoded');
});
test('when given file path with a space', () => {
let notebookLinkHandler = new NotebookLinkHandler(notebookUri, '/Notebooks/Test_Paths/My File.ipynb', configurationService);
assert.strictEqual(notebookLinkHandler.getEncodedLinkUrl(), `/Notebooks/Test_Paths/My%20File.ipynb`, 'space in file path failed to be encoded');
});
test('when given file path has special characters such as %', () => {
let notebookLinkHandler = new NotebookLinkHandler(notebookUri, '/Notebooks/Test_Paths/My%20File.ipynb', configurationService);
assert.strictEqual(notebookLinkHandler.getEncodedLinkUrl(), `/Notebooks/Test_Paths/My%2520File.ipynb`, '% in file path failed to be encoded');
});
});
});