update azdata-test in notebooks extension #24984
Conversation
kisantia
requested review from
corivera,
cheenamalhotra,
Charles-Gagnon and
barbaravaldez
| @@ -150,7 +150,7 @@ export class BookTocManager implements IBookTocManager { | |||
| } | |||
|
|
|||
| for (const [key, value] of this.tocFiles.entries()) { | |||
| const yamlFile = await yaml.safeLoad(value); | |||
There was a problem hiding this comment.
this wasn't related to the package version update, but it was a red squiggly when I was in the file, so updated this while I was there
| @@ -183,7 +183,7 @@ export class BookModel { | |||
| if (this._tableOfContentsPath) { | |||
| try { | |||
| let fileContents = await fsPromises.readFile(this._configPath, 'utf-8'); | |||
| const config = yaml.safeLoad(fileContents.toString()); | |||
| const config = yaml.safeLoad(fileContents.toString()) as JupyterBookSection; | |||
There was a problem hiding this comment.
@barbaravaldez could you double check if this cast and the one below in bookTocManager.ts are correct or should be changed? The variables in the tests have types specified, but wasn't sure about these
There was a problem hiding this comment.
JupyterBookSection is the only class I'm seeing with a title field for this one, and the tableOfContents variable in bookTocManager already had a JupyterBookSection[] type. Looks good to me.
There was a problem hiding this comment.
Yup! It looks good to me
Pull Request Test Coverage Report for Build 7042003367Warning: This coverage report may be inaccurate.We've detected an issue with your CI configuration that might affect the accuracy of this pull request's coverage report.
💛 - Coveralls |
| @@ -691,7 +691,7 @@ | |||
| "@types/request": "^2.48.1", | |||
| "@types/rimraf": "^2.0.2", | |||
| "@types/sinon": "^9.0.4", | |||
| "@types/tar": "^4.0.3", | |||
| "@types/tar": "^6.1.10", | |||
There was a problem hiding this comment.
I had to update this version to get rid of the error when yarn npm-run-all -lp extensions-ci was getting run in the Compile & Hygiene step of the PR validation pipeline (example failure) .
The problem was that the type definition file for @types/minipass couldn't be located, but when I looked at the @types/minipass folder in notebooks node_modules folder, the readme said that minipass already includes it's types definition, so dependencies on @types/minipass are unnecessary and it's expected that there isn't an index.d.ts file. The @types/minipass package has been marked as deprecated, so it really shouldn't be used.
Version 4.0.3 of @types/tar has a dependency on @types/minipass, but the latest version has a dependency on minipass, so updating the version resolved the issue of the @types/minipass index.d.ts file not being found.
There was a problem hiding this comment.
And we're using v6 of tar anyways, so this is the correct thing to do for that regardless! 😄
This updates the azdata-test dependency in the notebooks extension to fix this dependabot alert: https://github.com/microsoft/azuredatastudio/security/dependabot/603
There were a few updates that needed to be made since a few compilation errors started after the azdata-test package was bumped, since it also bumped several other dependencies. There were the errors:
The fix was to cast the result from those
yaml.safeLoad()calls. It looks like the errors started showing up because the resolved version of @types/js-yaml went from 3.12.1 to 3.12.10 and the return type changed fromanytostring | object | undefined3.12.1:
3.12.10
I also ran the notebook extension unit tests locally and confirmed that they're still passing. The extension unit tests aren't currently running in the pipelines, so that's what I'll look into enabling again next...