|
| 1 | +import type { MaybePromise } from '@theia/core/lib/common/types'; |
| 2 | +import { inject, injectable } from '@theia/core/shared/inversify'; |
| 3 | +import { |
| 4 | + BoardDetails, |
| 5 | + Programmer, |
| 6 | + isBoardIdentifierChangeEvent, |
| 7 | +} from '../../common/protocol'; |
| 8 | +import { BoardsDataStore, isEmptyData } from '../boards/boards-data-store'; |
| 9 | +import { BoardsServiceProvider } from '../boards/boards-service-provider'; |
| 10 | +import { Contribution } from './contribution'; |
| 11 | + |
| 12 | +/** |
| 13 | + * Before CLI 0.35.0-rc.3, there was no `programmer#default` property in the `board details` response. |
| 14 | + * This method does the programmer migration in the data store. If there is a programmer selected, it's a noop. |
| 15 | + * If no programmer is selected, it forcefully reloads the details from the CLI and updates it in the local storage. |
| 16 | + */ |
| 17 | +@injectable() |
| 18 | +export class AutoSelectProgrammer extends Contribution { |
| 19 | + @inject(BoardsServiceProvider) |
| 20 | + private readonly boardsServiceProvider: BoardsServiceProvider; |
| 21 | + @inject(BoardsDataStore) |
| 22 | + private readonly boardsDataStore: BoardsDataStore; |
| 23 | + |
| 24 | + override onStart(): void { |
| 25 | + this.boardsServiceProvider.onBoardsConfigDidChange((event) => { |
| 26 | + if (isBoardIdentifierChangeEvent(event)) { |
| 27 | + this.ensureProgrammerIsSelected(); |
| 28 | + } |
| 29 | + }); |
| 30 | + } |
| 31 | + |
| 32 | + override onReady(): void { |
| 33 | + this.boardsServiceProvider.ready.then(() => |
| 34 | + this.ensureProgrammerIsSelected() |
| 35 | + ); |
| 36 | + } |
| 37 | + |
| 38 | + private async ensureProgrammerIsSelected(): Promise<boolean> { |
| 39 | + return ensureProgrammerIsSelected({ |
| 40 | + fqbn: this.boardsServiceProvider.boardsConfig.selectedBoard?.fqbn, |
| 41 | + getData: (fqbn) => this.boardsDataStore.getData(fqbn), |
| 42 | + loadBoardDetails: (fqbn) => this.boardsDataStore.loadBoardDetails(fqbn), |
| 43 | + selectProgrammer: (arg) => this.boardsDataStore.selectProgrammer(arg), |
| 44 | + }); |
| 45 | + } |
| 46 | +} |
| 47 | + |
| 48 | +interface EnsureProgrammerIsSelectedParams { |
| 49 | + fqbn: string | undefined; |
| 50 | + getData: (fqbn: string | undefined) => MaybePromise<BoardsDataStore.Data>; |
| 51 | + loadBoardDetails: (fqbn: string) => MaybePromise<BoardDetails | undefined>; |
| 52 | + selectProgrammer(options: { |
| 53 | + fqbn: string; |
| 54 | + selectedProgrammer: Programmer; |
| 55 | + }): MaybePromise<boolean>; |
| 56 | +} |
| 57 | + |
| 58 | +export async function ensureProgrammerIsSelected( |
| 59 | + params: EnsureProgrammerIsSelectedParams |
| 60 | +): Promise<boolean> { |
| 61 | + const { fqbn, getData, loadBoardDetails, selectProgrammer } = params; |
| 62 | + if (!fqbn) { |
| 63 | + return false; |
| 64 | + } |
| 65 | + console.debug(`Ensuring a programmer is selected for ${fqbn}...`); |
| 66 | + const data = await getData(fqbn); |
| 67 | + if (isEmptyData(data)) { |
| 68 | + // For example, the platform is not installed. |
| 69 | + console.debug(`Skipping. No boards data is available for ${fqbn}.`); |
| 70 | + return false; |
| 71 | + } |
| 72 | + if (data.selectedProgrammer) { |
| 73 | + console.debug( |
| 74 | + `A programmer is already selected for ${fqbn}: '${data.selectedProgrammer.id}'.` |
| 75 | + ); |
| 76 | + return true; |
| 77 | + } |
| 78 | + let programmer = data.programmers.find((p) => p.default); |
| 79 | + if (programmer) { |
| 80 | + // select the programmer if the default info is available |
| 81 | + const result = await selectProgrammer({ |
| 82 | + fqbn, |
| 83 | + selectedProgrammer: programmer, |
| 84 | + }); |
| 85 | + if (result) { |
| 86 | + console.debug(`Selected '${programmer.id}' programmer for ${fqbn}.`); |
| 87 | + return result; |
| 88 | + } |
| 89 | + } |
| 90 | + console.debug(`Reloading board details for ${fqbn}...`); |
| 91 | + const reloadedData = await loadBoardDetails(fqbn); |
| 92 | + if (!reloadedData) { |
| 93 | + console.debug(`Skipping. No board details found for ${fqbn}.`); |
| 94 | + return false; |
| 95 | + } |
| 96 | + if (!reloadedData.programmers.length) { |
| 97 | + console.debug(`Skipping. ${fqbn} does not have programmers.`); |
| 98 | + return false; |
| 99 | + } |
| 100 | + programmer = reloadedData.programmers.find((p) => p.default); |
| 101 | + if (!programmer) { |
| 102 | + console.debug( |
| 103 | + `Skipping. Could not find a default programmer for ${fqbn}. Programmers were: ` |
| 104 | + ); |
| 105 | + return false; |
| 106 | + } |
| 107 | + const result = await selectProgrammer({ |
| 108 | + fqbn, |
| 109 | + selectedProgrammer: programmer, |
| 110 | + }); |
| 111 | + if (result) { |
| 112 | + console.debug(`Selected '${programmer.id}' programmer for ${fqbn}.`); |
| 113 | + } else { |
| 114 | + console.debug( |
| 115 | + `Could not select '${programmer.id}' programmer for ${fqbn}.` |
| 116 | + ); |
| 117 | + } |
| 118 | + return result; |
| 119 | +} |
0 commit comments