auto-select-programmer.ts

importtype{MaybePromise}from'@theia/core/lib/common/types';
import{inject,injectable}from'@theia/core/shared/inversify';
import{
BoardDetails,
Programmer,
isBoardIdentifierChangeEvent,
}from'../../common/protocol';
import{
BoardsDataStore,
findDefaultProgrammer,
isEmptyData,
}from'../boards/boards-data-store';
import{BoardsServiceProvider}from'../boards/boards-service-provider';
import{Contribution}from'./contribution';

/**
 * Before CLI 0.35.0-rc.3, there was no `programmer#default` property in the `board details` response.
 * This method does the programmer migration in the data store. If there is a programmer selected, it's a noop.
 * If no programmer is selected, it forcefully reloads the details from the CLI and updates it in the local storage.
 */
@injectable()
exportclassAutoSelectProgrammerextendsContribution{
 @inject(BoardsServiceProvider)
privatereadonlyboardsServiceProvider: BoardsServiceProvider;
 @inject(BoardsDataStore)
privatereadonlyboardsDataStore: BoardsDataStore;

overrideonStart(): void{
this.boardsServiceProvider.onBoardsConfigDidChange((event)=>{
if(isBoardIdentifierChangeEvent(event)){
this.ensureProgrammerIsSelected();
}
});
}

overrideonReady(): void{
this.boardsServiceProvider.ready.then(()=>
this.ensureProgrammerIsSelected()
);
}

privateasyncensureProgrammerIsSelected(): Promise<boolean>{
returnensureProgrammerIsSelected({
fqbn: this.boardsServiceProvider.boardsConfig.selectedBoard?.fqbn,
getData: (fqbn)=>this.boardsDataStore.getData(fqbn),
loadBoardDetails: (fqbn)=>this.boardsDataStore.loadBoardDetails(fqbn),
selectProgrammer: (arg)=>this.boardsDataStore.selectProgrammer(arg),
});
}
}

interfaceEnsureProgrammerIsSelectedParams{
fqbn: string|undefined;
getData: (fqbn: string|undefined)=>MaybePromise<BoardsDataStore.Data>;
loadBoardDetails: (fqbn: string)=>MaybePromise<BoardDetails|undefined>;
selectProgrammer(options: {
fqbn: string;
selectedProgrammer: Programmer;
}): MaybePromise<boolean>;
}

exportasyncfunctionensureProgrammerIsSelected(
params: EnsureProgrammerIsSelectedParams
): Promise<boolean>{
const{ fqbn, getData, loadBoardDetails, selectProgrammer }=params;
if(!fqbn){
returnfalse;
}
console.debug(`Ensuring a programmer is selected for ${fqbn}...`);
constdata=awaitgetData(fqbn);
if(isEmptyData(data)){
// For example, the platform is not installed.
console.debug(`Skipping. No boards data is available for ${fqbn}.`);
returnfalse;
}
if(data.selectedProgrammer){
console.debug(
`A programmer is already selected for ${fqbn}: '${data.selectedProgrammer.id}'.`
);
returntrue;
}
letprogrammer=findDefaultProgrammer(data.programmers,data);
if(programmer){
// select the programmer if the default info is available
constresult=awaitselectProgrammer({
 fqbn,
selectedProgrammer: programmer,
});
if(result){
console.debug(`Selected '${programmer.id}' programmer for ${fqbn}.`);
returnresult;
}
}
console.debug(`Reloading board details for ${fqbn}...`);
constreloadedData=awaitloadBoardDetails(fqbn);
if(!reloadedData){
console.debug(`Skipping. No board details found for ${fqbn}.`);
returnfalse;
}
if(!reloadedData.programmers.length){
console.debug(`Skipping. ${fqbn} does not have programmers.`);
returnfalse;
}
programmer=findDefaultProgrammer(reloadedData.programmers,reloadedData);
if(!programmer){
console.debug(
`Skipping. Could not find a default programmer for ${fqbn}. Programmers were: `
);
returnfalse;
}
constresult=awaitselectProgrammer({
 fqbn,
selectedProgrammer: programmer,
});
if(result){
console.debug(`Selected '${programmer.id}' programmer for ${fqbn}.`);
}else{
console.debug(
`Could not select '${programmer.id}' programmer for ${fqbn}.`
);
}
returnresult;
}