forked from arduino/arduino-ide
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Prevent overwriting existing libraries and platforms at first IDE sta…
…rt-up (arduino#1169) * move initialization of libs and platforms into new contribution * use noOverwrite when install built-in libraries and platform * catch errors when installing platforms and libraries at first start-up * arduino-cli version 0.25.0-rc1 * refine platforms and libraries initialization in case of errors * add trailing newline when libraries and platform installation fail * use regex to check error if builtin library dependencies are already installed * rename contribution
- Loading branch information
Alberto Iannaccone
authored
Jul 15, 2022
1 parent
46fcc71
commit 73835ec
Showing
14 changed files
with
213 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
97 changes: 97 additions & 0 deletions
97
arduino-ide-extension/src/browser/contributions/first-startup-installer.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| import { LocalStorageService } from '@theia/core/lib/browser'; | ||
| import { inject, injectable } from '@theia/core/shared/inversify'; | ||
| import { BoardsService, LibraryService } from '../../common/protocol'; | ||
| import { Contribution } from './contribution'; | ||
|
|
||
| @injectable() | ||
| export class FirstStartupInstaller extends Contribution { | ||
| @inject(LocalStorageService) | ||
| private readonly localStorageService: LocalStorageService; | ||
| @inject(BoardsService) | ||
| private readonly boardsService: BoardsService; | ||
| @inject(LibraryService) | ||
| private readonly libraryService: LibraryService; | ||
|
|
||
| override async onReady(): Promise<void> { | ||
| const isFirstStartup = !(await this.localStorageService.getData( | ||
| FirstStartupInstaller.INIT_LIBS_AND_PACKAGES | ||
| )); | ||
| if (isFirstStartup) { | ||
| const avrPackage = await this.boardsService.getBoardPackage({ | ||
| id: 'arduino:avr', | ||
| }); | ||
| const builtInLibrary = ( | ||
| await this.libraryService.search({ query: 'Arduino_BuiltIn' }) | ||
| )[0]; | ||
|
|
||
| let avrPackageError: Error | undefined; | ||
| let builtInLibraryError: Error | undefined; | ||
|
|
||
| if (avrPackage) { | ||
| try { | ||
| await this.boardsService.install({ | ||
| item: avrPackage, | ||
| noOverwrite: true, // We don't want to automatically replace custom platforms the user might already have in place | ||
| }); | ||
| } catch (e) { | ||
| // There's no error code, I need to parse the error message: https://github.com/arduino/arduino-cli/commit/ffe4232b359fcfa87238d68acf1c3b64a1621f14#diff-10ffbdde46838dd9caa881fd1f2a5326a49f8061f6cfd7c9d430b4875a6b6895R62 | ||
| if ( | ||
| e.message.includes( | ||
| `Platform ${avrPackage.id}@${avrPackage.installedVersion} already installed` | ||
| ) | ||
| ) { | ||
| // If arduino:avr installation fails because it's already installed we don't want to retry on next start-up | ||
| console.error(e); | ||
| } else { | ||
| // But if there is any other error (e.g.: no interntet cconnection), we want to retry next time | ||
| avrPackageError = e; | ||
| } | ||
| } | ||
| } else { | ||
| avrPackageError = new Error('Could not find platform.'); | ||
| } | ||
|
|
||
| if (builtInLibrary) { | ||
| try { | ||
| await this.libraryService.install({ | ||
| item: builtInLibrary, | ||
| installDependencies: true, | ||
| noOverwrite: true, // We don't want to automatically replace custom libraries the user might already have in place | ||
| }); | ||
| } catch (e) { | ||
| // There's no error code, I need to parse the error message: https://github.com/arduino/arduino-cli/commit/2ea3608453b17b1157f8a1dc892af2e13e40f4f0#diff-1de7569144d4e260f8dde0e0d00a4e2a218c57966d583da1687a70d518986649R95 | ||
| if (/Library (.*) is already installed/.test(e.message)) { | ||
| // If Arduino_BuiltIn installation fails because it's already installed we don't want to retry on next start-up | ||
| console.log('error installing core', e); | ||
| } else { | ||
| // But if there is any other error (e.g.: no interntet cconnection), we want to retry next time | ||
| builtInLibraryError = e; | ||
| } | ||
| } | ||
| } else { | ||
| builtInLibraryError = new Error('Could not find library'); | ||
| } | ||
|
|
||
| if (avrPackageError) { | ||
| this.messageService.error( | ||
| `Could not install Arduino AVR platform: ${avrPackageError}` | ||
| ); | ||
| } | ||
| if (builtInLibraryError) { | ||
| this.messageService.error( | ||
| `Could not install ${builtInLibrary.name} library: ${builtInLibraryError}` | ||
| ); | ||
| } | ||
|
|
||
| if (!avrPackageError && !builtInLibraryError) { | ||
| await this.localStorageService.setData( | ||
| FirstStartupInstaller.INIT_LIBS_AND_PACKAGES, | ||
| true | ||
| ); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| export namespace FirstStartupInstaller { | ||
| export const INIT_LIBS_AND_PACKAGES = 'initializedLibsAndPackages'; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.