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

Tests/book tests (#9075)

Browse Source 
* Conditionally add associatedResource t untitled nb

* Fix Jupyter Book notebook titles (#9039)

* Fix notebook titles

* Fix navigation links for books

* Added comments

Co-authored-by: Chris LaFreniere <40371649+chlafreniere@users.noreply.github.com>

* PR comment nit

* fix book tests

* tslint formatting fixes

* merged master and undid formatting

* added book path to error message

Co-authored-by: Chris LaFreniere <40371649+chlafreniere@users.noreply.github.com>
Co-authored-by: Charles Gagnon <chgagnon@microsoft.com>
This commit is contained in:
Maddy
2020-02-13 11:35:04 -08:00
committed by GitHub
parent 30c8182f16
commit 6e5b13ac8f
4 changed files with 75 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
extensions/notebook/src/book/bookModel.ts
View File

@@ -15,6 +15,7 @@ import * as fs from 'fs-extra';
import * as loc from '../common/localizedConstants';
import { IJupyterBookToc, IJupyterBookSection } from '../contracts/content';
import { isNullOrUndefined } from 'util';
import { ApiWrapper } from '../common/apiWrapper';
const fsPromises = fileServices.promises;
@@ -25,6 +26,9 @@ export class BookModel implements azdata.nb.NavigationProvider {
private _tableOfContentPaths: string[] = [];
readonly providerId: string = 'BookNavigator';
private _errorMessage: string;
private apiWrapper: ApiWrapper = new ApiWrapper();
constructor(public bookPath: string, public openAsUntitled: boolean, private _extensionContext: vscode.ExtensionContext) {
this.bookPath = bookPath;
this.openAsUntitled = openAsUntitled;
@@ -51,25 +55,26 @@ export class BookModel implements azdata.nb.NavigationProvider {
maxDepth = undefined;
}
let p = path.join(folderPath, '**', '_data', 'toc.yml').replace(/\\/g, '/');
let tableOfContentPaths = await glob(p, { deep: maxDepth });
let p: string = path.join(folderPath, '**', '_data', 'toc.yml').replace(/\\/g, '/');
let tableOfContentPaths: string[] = await glob(p, { deep: maxDepth });
if (tableOfContentPaths.length > 0) {
this._tableOfContentPaths = this._tableOfContentPaths.concat(tableOfContentPaths);
vscode.commands.executeCommand('setContext', 'bookOpened', true);
} else {
this._errorMessage = loc.missingTocError;
throw new Error(loc.missingTocError);
}
}
public async readBooks(): Promise<BookTreeItem[]> {
for (const contentPath of this._tableOfContentPaths) {
let root = path.dirname(path.dirname(contentPath));
let root: string = path.dirname(path.dirname(contentPath));
try {
let fileContents = await fsPromises.readFile(path.join(root, '_config.yml'), 'utf-8');
const config = yaml.safeLoad(fileContents.toString());
fileContents = await fsPromises.readFile(contentPath, 'utf-8');
const tableOfContents = yaml.safeLoad(fileContents.toString());
let book = new BookTreeItem({
const tableOfContents: any = yaml.safeLoad(fileContents.toString());
let book: BookTreeItem = new BookTreeItem({
title: config.title,
root: root,
tableOfContents: { sections: this.parseJupyterSections(tableOfContents) },
@@ -85,8 +90,8 @@ export class BookModel implements azdata.nb.NavigationProvider {
);
this._bookItems.push(book);
} catch (e) {
let error = e instanceof Error ? e.message : e;
vscode.window.showErrorMessage(error);
this._errorMessage = loc.readBookError(this.bookPath, e instanceof Error ? e.message : e);
this.apiWrapper.showErrorMessage(this._errorMessage);
}
}
return this._bookItems;
@@ -101,7 +106,7 @@ export class BookModel implements azdata.nb.NavigationProvider {
for (let i = 0; i < sections.length; i++) {
if (sections[i].url) {
if (sections[i].external) {
let externalLink = new BookTreeItem({
let externalLink: BookTreeItem = new BookTreeItem({
title: sections[i].title,
root: root,
tableOfContents: tableOfContents,
@@ -143,15 +148,14 @@ export class BookModel implements azdata.nb.NavigationProvider {
this._allNotebooks.set(path.basename(pathToNotebook), notebook);
notebooks.push(notebook);
}
}
else {
} else {
if (!this._allNotebooks.get(pathToNotebook)) {
this._allNotebooks.set(pathToNotebook, notebook);
notebooks.push(notebook);
}
}
} else if (await fs.pathExists(pathToMarkdown)) {
let markdown = new BookTreeItem({
let markdown: BookTreeItem = new BookTreeItem({
title: sections[i].title,
root: root,
tableOfContents: tableOfContents,
@@ -167,8 +171,8 @@ export class BookModel implements azdata.nb.NavigationProvider {
);
notebooks.push(markdown);
} else {
let error = loc.missingFileError(sections[i].title);
vscode.window.showErrorMessage(error);
this._errorMessage = loc.missingFileError(sections[i].title);
this.apiWrapper.showErrorMessage(this._errorMessage);
}
}
} else {
@@ -184,29 +188,31 @@ export class BookModel implements azdata.nb.NavigationProvider {
*/
private parseJupyterSections(section: any[]): IJupyterBookSection[] {
try {
return section.reduce((acc, val) => Array.isArray(val.sections) ? acc.concat(val).concat(this.parseJupyterSections(val.sections)) : acc.concat(val), []);
} catch (error) {
let err: string = loc.invalidTocFileError(error);
return section.reduce((acc, val) => Array.isArray(val.sections) ?
acc.concat(val).concat(this.parseJupyterSections(val.sections)) : acc.concat(val), []);
} catch (e) {
this._errorMessage = loc.invalidTocFileError();
if (section.length > 0) {
err = loc.invalidTocError(section[0].title);
this._errorMessage = loc.invalidTocError(section[0].title);
}
vscode.window.showErrorMessage(err);
throw err;
throw this._errorMessage;
}
}
public get tableOfContentPaths() {
public get tableOfContentPaths(): string[] {
return this._tableOfContentPaths;
}
getNavigation(uri: vscode.Uri): Thenable<azdata.nb.NavigationResult> {
let notebook = !this.openAsUntitled ? this._allNotebooks.get(uri.fsPath) : this._allNotebooks.get(path.basename(uri.fsPath));
let notebook: BookTreeItem =
!this.openAsUntitled ? this._allNotebooks.get(uri.fsPath) : this._allNotebooks.get(path.basename(uri.fsPath));
let result: azdata.nb.NavigationResult;
if (notebook) {
result = {
hasNavigation: true,
previous: notebook.previousUri ? this.openAsUntitled ? this.getUntitledUri(notebook.previousUri) : vscode.Uri.file(notebook.previousUri) : undefined,
previous: notebook.previousUri ?
this.openAsUntitled ? this.getUntitledUri(notebook.previousUri) : vscode.Uri.file(notebook.previousUri) : undefined,
next: notebook.nextUri ? this.openAsUntitled ? this.getUntitledUri(notebook.nextUri) : vscode.Uri.file(notebook.nextUri) : undefined
};
} else {
@@ -222,4 +228,9 @@ export class BookModel implements azdata.nb.NavigationProvider {
getUntitledUri(resource: string): vscode.Uri {
return vscode.Uri.parse(`untitled:${resource}`);
}
public get errorMessage(): string {
return this._errorMessage;
}
}

6
extensions/notebook/src/book/bookTreeView.ts
View File

@@ -24,8 +24,6 @@ export class BookTreeViewProvider implements vscode.TreeDataProvider<BookTreeIte
private prompter: IPrompter;
private _initializeDeferred: Deferred<void> = new Deferred<void>();
// For testing
private _errorMessage: string;
private _openAsUntitled: boolean;
public viewId: string;
public books: BookModel[];
@@ -292,10 +290,6 @@ export class BookTreeViewProvider implements vscode.TreeDataProvider<BookTreeIte
}
}
public get errorMessage() {
return this._errorMessage;
}
getUntitledNotebookUri(resource: string): vscode.Uri {
let untitledFileName = vscode.Uri.parse(`untitled:${resource}`);
if (!this.currentBook.getAllBooks().get(untitledFileName.fsPath) && !this.currentBook.getAllBooks().get(path.basename(untitledFileName.fsPath))) {