#13871

Committed 11 Oct 2024 05:08PM UTC coverage: 88.995% (-0.05%) from 89.043%

Build Type

push

Committed by

Commit Message

Merge branch 'master' of https://github.com/rokucommunity/brighterscript into lsp-refactor

Coverage Stats

7205 of 8532 branches covered (84.45%)

Branch coverage included in aggregate %.

8 of 8 new or added lines in 2 files covered. (100.0%)

63 existing lines in 4 files now uncovered.

9607 of 10359 relevant lines covered (92.74%)

1781.83 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

72.35

/src/ProgramBuilder.ts

import * as debounce from 'debounce-promise';
import * as path from 'path';
import { rokuDeploy } from 'roku-deploy';
import type { LogLevel as RokuDeployLogLevel } from 'roku-deploy/dist/Logger';
import type { BsConfig, FinalizedBsConfig } from './BsConfig';
import type { BscFile, BsDiagnostic, FileObj, FileResolver } from './interfaces';
import { Program } from './Program';
import { standardizePath as s, util } from './util';
import { Watcher } from './Watcher';
import { DiagnosticSeverity } from 'vscode-languageserver';
import type { Logger } from './logging';
import { LogLevel, createLogger } from './logging';
import PluginInterface from './PluginInterface';
import * as diagnosticUtils from './diagnosticUtils';
import * as fsExtra from 'fs-extra';
import * as requireRelative from 'require-relative';
import { Throttler } from './Throttler';
import { URI } from 'vscode-uri';

/**
 * A runner class that handles
 */
export class ProgramBuilder {

    public constructor(
        options?: {
            logger?: Logger;
        }
    ) {
        this.logger = options?.logger ?? createLogger();
        this.plugins = new PluginInterface([], { logger: this.logger });

        //add the default file resolver (used to load source file contents).
        this.addFileResolver((filePath) => {
            return fsExtra.readFile(filePath).then((value) => {
                return value.toString();
            });
        });
    }
    /**
     * Determines whether the console should be cleared after a run (true for cli, false for languageserver)
     */
    public allowConsoleClearing = true;

    public options: FinalizedBsConfig = util.normalizeConfig({});
    private isRunning = false;
    private watcher: Watcher | undefined;
    public program: Program | undefined;
    public logger: Logger;
    public plugins: PluginInterface;
    private fileResolvers = [] as FileResolver[];

    /**
     * Add file resolvers that will be able to provide file contents before loading from the file system
     * @param fileResolvers a list of file resolvers
     */
    public addFileResolver(...fileResolvers: FileResolver[]) {
        this.fileResolvers.push(...fileResolvers);
    }

    /**
     * Get the contents of the specified file as a string.
     * This walks backwards through the file resolvers until we get a value.
     * This allow the language server to provide file contents directly from memory.
     */
    public async getFileContents(srcPath: string) {
        srcPath = s`${srcPath}`;
        let reversedResolvers = [...this.fileResolvers].reverse();
        for (let fileResolver of reversedResolvers) {
            let result = await fileResolver(srcPath);
            if (typeof result === 'string') {
                return result;
            }
        }
        throw new Error(`Could not load file "${srcPath}"`);
    }

    /**
     * A list of diagnostics that are always added to the `getDiagnostics()` call.
     */
    private staticDiagnostics = [] as BsDiagnostic[];

    public addDiagnostic(srcPath: string, diagnostic: Partial<BsDiagnostic>) {
        if (!this.program) {
            throw new Error('Cannot call `ProgramBuilder.addDiagnostic` before `ProgramBuilder.run()`');
        }
        let file: BscFile | undefined = this.program.getFile(srcPath);
        if (!file) {
            file = {
                pkgPath: path.basename(srcPath),
                pathAbsolute: srcPath, //keep this for backwards-compatibility. TODO remove in v1
                srcPath: srcPath,
                getDiagnostics: () => {
                    return [<any>diagnostic];
                }
            } as BscFile;
        }
        diagnostic.file = file;
        this.staticDiagnostics.push(<any>diagnostic);
    }

    public getDiagnostics() {
        return [
            ...this.staticDiagnostics,
            ...(this.program?.getDiagnostics() ?? [])
        ];
    }

    public async run(options: BsConfig & { skipInitialValidation?: boolean }) {
        if (options?.logLevel) {
            this.logger.logLevel = options.logLevel;
        }

        if (this.isRunning) {
            throw new Error('Server is already running');
        }
        this.isRunning = true;
        try {
            this.options = util.normalizeAndResolveConfig(options);
            if (this.options?.logLevel !== undefined) {
                this.logger.logLevel = this.options?.logLevel;
            }

            if (this.options.noProject) {
                this.logger.log(`'no-project' flag is set so bsconfig.json loading is disabled'`);
            } else if (this.options.project) {
                this.logger.log(`Using config file: "${this.options.project}"`);
            } else {
                this.logger.log(`No bsconfig.json file found, using default options`);
            }
            this.loadRequires();
            this.loadPlugins();
        } catch (e: any) {
            //For now, just use a default options object so we have a functioning program
            this.options = util.normalizeConfig({
                showDiagnosticsInConsole: options?.showDiagnosticsInConsole
            });

            if (e?.file && e.message && e.code) {
                let err = e as BsDiagnostic;
                this.staticDiagnostics.push(err);
            } else {
                //if this is not a diagnostic, something else is wrong...
                throw e;
            }

            this.printDiagnostics();
        }
        this.logger.logLevel = this.options.logLevel;

        this.createProgram();

        //parse every file in the entire project
        await this.loadAllFilesAST();

        if (this.options.watch) {
            this.logger.log('Starting compilation in watch mode...');
            await this.runOnce({
                skipValidation: options?.skipInitialValidation
            });
            this.enableWatchMode();
        } else {
            await this.runOnce({
                skipValidation: options?.skipInitialValidation
            });
        }
    }

    protected createProgram() {
        this.program = new Program(this.options, this.logger, this.plugins);

        this.plugins.emit('afterProgramCreate', this.program);

        return this.program;
    }

    protected loadPlugins() {
        const cwd = this.options.cwd ?? process.cwd();
        const plugins = util.loadPlugins(
            cwd,
            this.options.plugins ?? [],
            (pathOrModule, err) => this.logger.error(`Error when loading plugin '${pathOrModule}':`, err)
        );
        this.logger.log(`Loading ${this.options.plugins?.length ?? 0} plugins for cwd "${cwd}"`, this.options.plugins);
        for (let plugin of plugins) {
            this.plugins.add(plugin);
        }

        this.plugins.emit('beforeProgramCreate', this);
    }

    /**
     * `require()` every options.require path
     */
    protected loadRequires() {
        for (const dep of this.options.require ?? []) {
            requireRelative(dep, this.options.cwd);
        }
    }

    private clearConsole() {
        if (this.allowConsoleClearing) {
            util.clearConsole();
        }
    }

    /**
     * A handle for the watch mode interval that keeps the process alive.
     * We need this so we can clear it if the builder is disposed
     */
    private watchInterval: NodeJS.Timer | undefined;

    public enableWatchMode() {
        this.watcher = new Watcher(this.options);
        if (this.watchInterval) {
            clearInterval(this.watchInterval);
        }
        //keep the process alive indefinitely by setting an interval that runs once every 12 days
        this.watchInterval = setInterval(() => { }, 1073741824);

        //clear the console
        this.clearConsole();

        let fileObjects = rokuDeploy.normalizeFilesArray(this.options.files ? this.options.files : []);

        //add each set of files to the file watcher
        for (let fileObject of fileObjects) {
            let src = typeof fileObject === 'string' ? fileObject : fileObject.src;
            this.watcher.watch(src);
        }

        this.logger.log('Watching for file changes...');

        let debouncedRunOnce = debounce(async () => {
            this.logger.log('File change detected. Starting incremental compilation...');
            await this.runOnce();
            this.logger.log(`Watching for file changes.`);
        }, 50);

        //on any file watcher event
        this.watcher.on('all', async (event: string, thePath: string) => { //eslint-disable-line @typescript-eslint/no-misused-promises
            if (!this.program) {
                throw new Error('Internal invariant exception: somehow file watcher ran before `ProgramBuilder.run()`');
            }
            thePath = s`${path.resolve(this.rootDir, thePath)}`;
            if (event === 'add' || event === 'change') {
                const fileObj = {
                    src: thePath,
                    dest: rokuDeploy.getDestPath(
                        thePath,
                        this.program.options.files,
                        //some shells will toTowerCase the drive letter, so do it to rootDir for consistency
                        util.driveLetterToLower(this.rootDir)
                    )
                };
                this.program.setFile(
                    fileObj,
                    await this.getFileContents(fileObj.src)
                );
            } else if (event === 'unlink') {
                this.program.removeFile(thePath);
            }
            //wait for change events to settle, and then execute `run`
            await debouncedRunOnce();
        });
    }

    /**
     * The rootDir for this program.
     */
    public get rootDir() {
        if (!this.program) {
            throw new Error('Cannot access `ProgramBuilder.rootDir` until after `ProgramBuilder.run()`');
        }
        return this.program.options.rootDir;
    }

    /**
     * A method that is used to cancel a previous run task.
     * Does nothing if previous run has completed or was already canceled
     */
    private cancelLastRun = () => {
        return Promise.resolve();
    };

    /**
     * Run the entire process exactly one time.
     */
    private runOnce(options?: { skipValidation?: boolean }) {
        //clear the console
        this.clearConsole();
        let cancellationToken = { isCanceled: false };
        //wait for the previous run to complete
        let runPromise = this.cancelLastRun().then(() => {
            //start the new run
            return this._runOnce({
                cancellationToken: cancellationToken,
                skipValidation: options?.skipValidation
            });
        }) as any;

        //a function used to cancel this run
        this.cancelLastRun = () => {
            cancellationToken.isCanceled = true;
            return runPromise;
        };
        return runPromise;
    }

    private printDiagnostics(diagnostics?: BsDiagnostic[]) {
        if (this.options?.showDiagnosticsInConsole === false) {
            return;
        }
        if (!diagnostics) {
            diagnostics = this.getDiagnostics();
        }

        //group the diagnostics by file
        let diagnosticsByFile = {} as Record<string, BsDiagnostic[]>;
        for (let diagnostic of diagnostics) {
            if (!diagnosticsByFile[diagnostic.file.srcPath]) {
                diagnosticsByFile[diagnostic.file.srcPath] = [];
            }
            diagnosticsByFile[diagnostic.file.srcPath].push(diagnostic);
        }

        //get printing options
        const options = diagnosticUtils.getPrintDiagnosticOptions(this.options);
        const { cwd, emitFullPaths } = options;

        let srcPaths = Object.keys(diagnosticsByFile).sort();
        for (let srcPath of srcPaths) {
            let diagnosticsForFile = diagnosticsByFile[srcPath];
            //sort the diagnostics in line and column order
            let sortedDiagnostics = diagnosticsForFile.sort((a, b) => {
                return (
                    (a.range?.start.line ?? -1) - (b.range?.start.line ?? -1) ||
                    (a.range?.start.character ?? -1) - (b.range?.start.character ?? -1)
                );
            });

            let filePath = srcPath;
            if (!emitFullPaths) {
                filePath = path.relative(cwd, filePath);
            }
            //load the file text
            const file = this.program?.getFile(srcPath);
            //get the file's in-memory contents if available
            const lines = file?.fileContents?.split(/\r?\n/g) ?? [];

            for (let diagnostic of sortedDiagnostics) {
                //default the severity to error if undefined
                let severity = typeof diagnostic.severity === 'number' ? diagnostic.severity : DiagnosticSeverity.Error;
                let relatedInformation = (diagnostic.relatedInformation ?? []).map(x => {
                    let relatedInfoFilePath = URI.parse(x.location.uri).fsPath;
                    if (!emitFullPaths) {
                        relatedInfoFilePath = path.relative(cwd, relatedInfoFilePath);
                    }
                    return {
                        filePath: relatedInfoFilePath,
                        range: x.location.range,
                        message: x.message
                    };
                });
                //format output
                diagnosticUtils.printDiagnostic(options, severity, filePath, lines, diagnostic, relatedInformation);
            }
        }
    }

    /**
     * Run the process once, allowing it to be cancelled.
     * NOTE: This should only be called by `runOnce`.
     */
    private async _runOnce(options: { cancellationToken: { isCanceled: any }; skipValidation: boolean }) {
        let wereDiagnosticsPrinted = false;
        try {
            //maybe cancel?
            if (options.cancellationToken.isCanceled === true) {
                return -1;
            }
            //validate program
            if (options.skipValidation !== true) {
                this.validateProject();
            }

            //maybe cancel?
            if (options.cancellationToken.isCanceled === true) {
                return -1;
            }

            const diagnostics = this.getDiagnostics();
            this.printDiagnostics(diagnostics);
            wereDiagnosticsPrinted = true;
            let errorCount = diagnostics.filter(x => x.severity === DiagnosticSeverity.Error).length;

            if (errorCount > 0) {
                this.logger.log(`Found ${errorCount} ${errorCount === 1 ? 'error' : 'errors'}`);
                return errorCount;
            }

            //create the deployment package (and transpile as well)
            await this.createPackageIfEnabled();

            //maybe cancel?
            if (options.cancellationToken.isCanceled === true) {
                return -1;
            }

            //deploy the package
            await this.deployPackageIfEnabled();

            return 0;
        } catch (e) {
            if (wereDiagnosticsPrinted === false) {
                this.printDiagnostics();
            }
            throw e;
        }
    }

    private async createPackageIfEnabled() {
        if (this.options.copyToStaging || this.options.createPackage || this.options.deploy) {

            //transpile the project
            await this.transpile();

            //create the zip file if configured to do so
            if (this.options.createPackage !== false || this.options.deploy) {
                await this.logger.time(LogLevel.log, [`Creating package at ${this.options.outFile}`], async () => {
                    await rokuDeploy.zipPackage({
                        ...this.options,
                        logLevel: this.options.logLevel as unknown as RokuDeployLogLevel,
                        outDir: util.getOutDir(this.options),
                        outFile: path.basename(this.options.outFile)
                    });
                });
            }
        }
    }

    private transpileThrottler = new Throttler(0);
    /**
     * Transpiles the entire program into the staging folder
     */
    public async transpile() {
        await this.transpileThrottler.run(async () => {
            let options = util.cwdWork(this.options.cwd, () => {
                return rokuDeploy.getOptions({
                    ...this.options,
                    logLevel: this.options.logLevel as unknown as RokuDeployLogLevel,
                    outDir: util.getOutDir(this.options),
                    outFile: path.basename(this.options.outFile)

                    //rokuDeploy's return type says all its fields can be nullable, but it sets values for all of them.
                }) as any as Required<ReturnType<typeof rokuDeploy.getOptions>>;
            });

            //get every file referenced by the files array
            let fileMap = await rokuDeploy.getFilePaths(options.files, options.rootDir);

            //remove files currently loaded in the program, we will transpile those instead (even if just for source maps)
            let filteredFileMap = [] as FileObj[];

            for (let fileEntry of fileMap) {
                if (this.program!.hasFile(fileEntry.src) === false) {
                    filteredFileMap.push(fileEntry);
                }
            }

            this.plugins.emit('beforePrepublish', this, filteredFileMap);

            await this.logger.time(LogLevel.log, ['Copying to staging directory'], async () => {
                //prepublish all non-program-loaded files to staging
                await rokuDeploy.prepublishToStaging({
                    ...options,
                    files: filteredFileMap
                });
            });

            this.plugins.emit('afterPrepublish', this, filteredFileMap);
            this.plugins.emit('beforePublish', this, fileMap);

            await this.logger.time(LogLevel.log, ['Transpiling'], async () => {
                //transpile any brighterscript files
                await this.program!.transpile(fileMap, options.stagingDir);
            });

            this.plugins.emit('afterPublish', this, fileMap);
        });
    }

    private async deployPackageIfEnabled() {
        //deploy the project if configured to do so
        if (this.options.deploy) {
            await this.logger.time(LogLevel.log, ['Deploying package to', this.options.host], async () => {
                await rokuDeploy.publish({
                    ...this.options,
                    logLevel: this.options.logLevel as unknown as RokuDeployLogLevel,
                    outDir: util.getOutDir(this.options),
                    outFile: path.basename(this.options.outFile)
                });
            });
        }
    }

    /**
     * Parse and load the AST for every file in the project
     */
    private async loadAllFilesAST() {
        await this.logger.time(LogLevel.log, ['Parsing files'], async () => {
            let files = await this.logger.time(LogLevel.debug, ['getFilePaths'], async () => {
                return util.getFilePaths(this.options);
            });
            this.logger.trace('ProgramBuilder.loadAllFilesAST() files:', files);

            const typedefFiles = [] as FileObj[];
            const sourceFiles = [] as FileObj[];
            let manifestFile: FileObj | null = null;

            for (const file of files) {
                // source files (.brs, .bs, .xml)
                if (/(?<!\.d)\.(bs|brs|xml)$/i.test(file.dest)) {
                    sourceFiles.push(file);

                    // typedef files (.d.bs)
                } else if (/\.d\.bs$/i.test(file.dest)) {
                    typedefFiles.push(file);

                    // manifest file
                } else if (/^manifest$/i.test(file.dest)) {
                    manifestFile = file;
                }
            }

            if (manifestFile) {
                this.program!.loadManifest(manifestFile, false);
            }

            const loadFile = async (fileObj) => {
                try {
                    this.program!.setFile(fileObj, await this.getFileContents(fileObj.src));
                } catch (e) {
                    this.logger.log(e); // log the error, but don't fail this process because the file might be fixable later
                }
            };
            await Promise.all(typedefFiles.map(loadFile)); // preload every type definition file, which eliminates duplicate file loading
            await Promise.all(sourceFiles.map(loadFile)); // parse source files
        });
    }

    /**
     * Remove all files from the program that are in the specified folder path
     * @param srcPath the path to the folder to remove
     */
    public removeFilesInFolder(srcPath: string): boolean {
        let removedSomeFiles = false;
        for (let filePath in this.program.files) {
            //if the file path starts with the parent path and the file path does not exactly match the folder path
            if (filePath.startsWith(srcPath) && filePath !== srcPath) {
                this.program.removeFile(filePath);
                removedSomeFiles = true;
            }
        }
        return removedSomeFiles;
    }

    /**
     * Scan every file and resolve all variable references.
     * If no errors were encountered, return true. Otherwise return false.
     */
    private validateProject() {
        this.program.validate();
    }

    public dispose() {
        if (this.watcher) {
            this.watcher.dispose();
        }
        if (this.program) {
            this.program.dispose?.();
        }
        if (this.watchInterval) {
            clearInterval(this.watchInterval);
        }
    }
}

1	import * as debounce from 'debounce-promise';	1✔
2	import * as path from 'path';	1✔
3	import { rokuDeploy } from 'roku-deploy';	1✔
4	import type { LogLevel as RokuDeployLogLevel } from 'roku-deploy/dist/Logger';
5	import type { BsConfig, FinalizedBsConfig } from './BsConfig';
6	import type { BscFile, BsDiagnostic, FileObj, FileResolver } from './interfaces';
7	import { Program } from './Program';	1✔
8	import { standardizePath as s, util } from './util';	1✔
9	import { Watcher } from './Watcher';	1✔
10	import { DiagnosticSeverity } from 'vscode-languageserver';	1✔
11	import type { Logger } from './logging';
12	import { LogLevel, createLogger } from './logging';	1✔
13	import PluginInterface from './PluginInterface';	1✔
14	import * as diagnosticUtils from './diagnosticUtils';	1✔
15	import * as fsExtra from 'fs-extra';	1✔
16	import * as requireRelative from 'require-relative';	1✔
17	import { Throttler } from './Throttler';	1✔
18	import { URI } from 'vscode-uri';	1✔
19
20	/**
21	* A runner class that handles
22	*/
23	export class ProgramBuilder {	1✔
24
25	public constructor(
26	options?: {
27	logger?: Logger;
28	}
29	) {
30	this.logger = options?.logger ?? createLogger();	96✔
31	this.plugins = new PluginInterface([], { logger: this.logger });	96✔
32
33	//add the default file resolver (used to load source file contents).
34	this.addFileResolver((filePath) => {	96✔
35	return fsExtra.readFile(filePath).then((value) => {	41✔
36	return value.toString();	41✔
37	});
38	});
39	}
40	/**
41	* Determines whether the console should be cleared after a run (true for cli, false for languageserver)
42	*/
43	public allowConsoleClearing = true;	96✔
44
45	public options: FinalizedBsConfig = util.normalizeConfig({});	96✔
46	private isRunning = false;	96✔
47	private watcher: Watcher \| undefined;
48	public program: Program \| undefined;
49	public logger: Logger;
50	public plugins: PluginInterface;
51	private fileResolvers = [] as FileResolver[];	96✔
52
53	/**
54	* Add file resolvers that will be able to provide file contents before loading from the file system
55	* @param fileResolvers a list of file resolvers
56	*/
57	public addFileResolver(...fileResolvers: FileResolver[]) {
58	this.fileResolvers.push(...fileResolvers);	96✔
59	}
60
61	/**
62	* Get the contents of the specified file as a string.
63	* This walks backwards through the file resolvers until we get a value.
64	* This allow the language server to provide file contents directly from memory.
65	*/
66	public async getFileContents(srcPath: string) {
67	srcPath = s`${srcPath}`;	41✔
68	let reversedResolvers = [...this.fileResolvers].reverse();	41✔
69	for (let fileResolver of reversedResolvers) {	41✔
70	let result = await fileResolver(srcPath);	46✔
71	if (typeof result === 'string') {	46✔
72	return result;	41✔
73	}
74	}
75	throw new Error(`Could not load file "${srcPath}"`);	×
76	}
77
78	/**
79	* A list of diagnostics that are always added to the `getDiagnostics()` call.
80	*/
81	private staticDiagnostics = [] as BsDiagnostic[];	96✔
82
83	public addDiagnostic(srcPath: string, diagnostic: Partial<BsDiagnostic>) {
84	if (!this.program) {	1!
85	throw new Error('Cannot call `ProgramBuilder.addDiagnostic` before `ProgramBuilder.run()`');	×
86	}
87	let file: BscFile \| undefined = this.program.getFile(srcPath);	1✔
88	if (!file) {	1!
89	file = {	1✔
90	pkgPath: path.basename(srcPath),
91	pathAbsolute: srcPath, //keep this for backwards-compatibility. TODO remove in v1
92	srcPath: srcPath,
93	getDiagnostics: () => {
94	return [<any>diagnostic];	×
95	}
96	} as BscFile;
97	}
98	diagnostic.file = file;	1✔
99	this.staticDiagnostics.push(<any>diagnostic);	1✔
100	}
101
102	public getDiagnostics() {
103	return [	188✔
104	...this.staticDiagnostics,
105	...(this.program?.getDiagnostics() ?? [])	1,128!
106	];
107	}
108
109	public async run(options: BsConfig & { skipInitialValidation?: boolean }) {
110	if (options?.logLevel) {	81✔
111	this.logger.logLevel = options.logLevel;	2✔
112	}
113
114	if (this.isRunning) {	81!
UNCOV 115	throw new Error('Server is already running');	×
116	}
117	this.isRunning = true;	81✔
118	try {	81✔
119	this.options = util.normalizeAndResolveConfig(options);	81✔
120	if (this.options?.logLevel !== undefined) {	79!
121	this.logger.logLevel = this.options?.logLevel;	79!
122	}
123
124	if (this.options.noProject) {	79!
UNCOV 125	this.logger.log(`'no-project' flag is set so bsconfig.json loading is disabled'`);	×
126	} else if (this.options.project) {	79✔
127	this.logger.log(`Using config file: "${this.options.project}"`);	29✔
128	} else {
129	this.logger.log(`No bsconfig.json file found, using default options`);	50✔
130	}
131	this.loadRequires();	79✔
132	this.loadPlugins();	79✔
133	} catch (e: any) {
134	//For now, just use a default options object so we have a functioning program
135	this.options = util.normalizeConfig({	2✔
136	showDiagnosticsInConsole: options?.showDiagnosticsInConsole	6!
137	});
138
139	if (e?.file && e.message && e.code) {	2!
140	let err = e as BsDiagnostic;	2✔
141	this.staticDiagnostics.push(err);	2✔
142	} else {
143	//if this is not a diagnostic, something else is wrong...
UNCOV 144	throw e;	×
145	}
146
147	this.printDiagnostics();	2✔
148	}
149	this.logger.logLevel = this.options.logLevel;	81✔
150
151	this.createProgram();	81✔
152
153	//parse every file in the entire project
154	await this.loadAllFilesAST();	81✔
155
156	if (this.options.watch) {	81!
UNCOV 157	this.logger.log('Starting compilation in watch mode...');	×
UNCOV 158	await this.runOnce({	×
159	skipValidation: options?.skipInitialValidation	×
160	});
UNCOV 161	this.enableWatchMode();	×
162	} else {
163	await this.runOnce({	81✔
164	skipValidation: options?.skipInitialValidation	243✔
165	});
166	}
167	}
168
169	protected createProgram() {
170	this.program = new Program(this.options, this.logger, this.plugins);	82✔
171
172	this.plugins.emit('afterProgramCreate', this.program);	82✔
173
174	return this.program;	82✔
175	}
176
177	protected loadPlugins() {
178	const cwd = this.options.cwd ?? process.cwd();	79!
179	const plugins = util.loadPlugins(	79✔
180	cwd,
181	this.options.plugins ?? [],	237!
UNCOV 182	(pathOrModule, err) => this.logger.error(`Error when loading plugin '${pathOrModule}':`, err)	×
183	);
184	this.logger.log(`Loading ${this.options.plugins?.length ?? 0} plugins for cwd "${cwd}"`, this.options.plugins);	79!
185	for (let plugin of plugins) {	79✔
186	this.plugins.add(plugin);	1✔
187	}
188
189	this.plugins.emit('beforeProgramCreate', this);	79✔
190	}
191
192	/**
193	* `require()` every options.require path
194	*/
195	protected loadRequires() {
196	for (const dep of this.options.require ?? []) {	79✔
197	requireRelative(dep, this.options.cwd);	2✔
198	}
199	}
200
201	private clearConsole() {
202	if (this.allowConsoleClearing) {	78!
203	util.clearConsole();	78✔
204	}
205	}
206
207	/**
208	* A handle for the watch mode interval that keeps the process alive.
209	* We need this so we can clear it if the builder is disposed
210	*/
211	private watchInterval: NodeJS.Timer \| undefined;
212
213	public enableWatchMode() {
UNCOV 214	this.watcher = new Watcher(this.options);	×
UNCOV 215	if (this.watchInterval) {	×
216	clearInterval(this.watchInterval);	×
217	}
218	//keep the process alive indefinitely by setting an interval that runs once every 12 days
UNCOV 219	this.watchInterval = setInterval(() => { }, 1073741824);	×
220
221	//clear the console
UNCOV 222	this.clearConsole();	×
223
224	let fileObjects = rokuDeploy.normalizeFilesArray(this.options.files ? this.options.files : []);	×
225
226	//add each set of files to the file watcher
UNCOV 227	for (let fileObject of fileObjects) {	×
UNCOV 228	let src = typeof fileObject === 'string' ? fileObject : fileObject.src;	×
229	this.watcher.watch(src);	×
230	}
231
UNCOV 232	this.logger.log('Watching for file changes...');	×
233
234	let debouncedRunOnce = debounce(async () => {	×
UNCOV 235	this.logger.log('File change detected. Starting incremental compilation...');	×
236	await this.runOnce();	×
237	this.logger.log(`Watching for file changes.`);	×
238	}, 50);
239
240	//on any file watcher event
UNCOV 241	this.watcher.on('all', async (event: string, thePath: string) => { //eslint-disable-line @typescript-eslint/no-misused-promises	×
UNCOV 242	if (!this.program) {	×
243	throw new Error('Internal invariant exception: somehow file watcher ran before `ProgramBuilder.run()`');	×
244	}
245	thePath = s`${path.resolve(this.rootDir, thePath)}`;	×
UNCOV 246	if (event === 'add' \|\| event === 'change') {	×
247	const fileObj = {	×
248	src: thePath,
249	dest: rokuDeploy.getDestPath(
250	thePath,
251	this.program.options.files,
252	//some shells will toTowerCase the drive letter, so do it to rootDir for consistency
253	util.driveLetterToLower(this.rootDir)
254	)
255	};
UNCOV 256	this.program.setFile(	×
257	fileObj,
258	await this.getFileContents(fileObj.src)
259	);
UNCOV 260	} else if (event === 'unlink') {	×
UNCOV 261	this.program.removeFile(thePath);	×
262	}
263	//wait for change events to settle, and then execute `run`
UNCOV 264	await debouncedRunOnce();	×
265	});
266	}
267
268	/**
269	* The rootDir for this program.
270	*/
271	public get rootDir() {
UNCOV 272	if (!this.program) {	×
UNCOV 273	throw new Error('Cannot access `ProgramBuilder.rootDir` until after `ProgramBuilder.run()`');	×
274	}
275	return this.program.options.rootDir;	×
276	}
277
278	/**
279	* A method that is used to cancel a previous run task.
280	* Does nothing if previous run has completed or was already canceled
281	*/
282	private cancelLastRun = () => {	96✔
283	return Promise.resolve();	78✔
284	};
285
286	/**
287	* Run the entire process exactly one time.
288	*/
289	private runOnce(options?: { skipValidation?: boolean }) {
290	//clear the console
291	this.clearConsole();	78✔
292	let cancellationToken = { isCanceled: false };	78✔
293	//wait for the previous run to complete
294	let runPromise = this.cancelLastRun().then(() => {	78✔
295	//start the new run
296	return this._runOnce({	78✔
297	cancellationToken: cancellationToken,
298	skipValidation: options?.skipValidation	234!
299	});
300	}) as any;
301
302	//a function used to cancel this run
303	this.cancelLastRun = () => {	78✔
UNCOV 304	cancellationToken.isCanceled = true;	×
UNCOV 305	return runPromise;	×
306	};
307	return runPromise;	78✔
308	}
309
310	private printDiagnostics(diagnostics?: BsDiagnostic[]) {
311	if (this.options?.showDiagnosticsInConsole === false) {	86!
312	return;	74✔
313	}
314	if (!diagnostics) {	12✔
315	diagnostics = this.getDiagnostics();	6✔
316	}
317
318	//group the diagnostics by file
319	let diagnosticsByFile = {} as Record<string, BsDiagnostic[]>;	12✔
320	for (let diagnostic of diagnostics) {	12✔
321	if (!diagnosticsByFile[diagnostic.file.srcPath]) {	7✔
322	diagnosticsByFile[diagnostic.file.srcPath] = [];	6✔
323	}
324	diagnosticsByFile[diagnostic.file.srcPath].push(diagnostic);	7✔
325	}
326
327	//get printing options
328	const options = diagnosticUtils.getPrintDiagnosticOptions(this.options);	12✔
329	const { cwd, emitFullPaths } = options;	12✔
330
331	let srcPaths = Object.keys(diagnosticsByFile).sort();	12✔
332	for (let srcPath of srcPaths) {	12✔
333	let diagnosticsForFile = diagnosticsByFile[srcPath];	6✔
334	//sort the diagnostics in line and column order
335	let sortedDiagnostics = diagnosticsForFile.sort((a, b) => {	6✔
336	return (	1✔
337	(a.range?.start.line ?? -1) - (b.range?.start.line ?? -1) \|\|	14!
338	(a.range?.start.character ?? -1) - (b.range?.start.character ?? -1)	12!
339	);
340	});
341
342	let filePath = srcPath;	6✔
343	if (!emitFullPaths) {	6!
344	filePath = path.relative(cwd, filePath);	6✔
345	}
346	//load the file text
347	const file = this.program?.getFile(srcPath);	6!
348	//get the file's in-memory contents if available
349	const lines = file?.fileContents?.split(/\r?\n/g) ?? [];	6✔
350
351	for (let diagnostic of sortedDiagnostics) {	6✔
352	//default the severity to error if undefined
353	let severity = typeof diagnostic.severity === 'number' ? diagnostic.severity : DiagnosticSeverity.Error;	7✔
354	let relatedInformation = (diagnostic.relatedInformation ?? []).map(x => {	7!
UNCOV 355	let relatedInfoFilePath = URI.parse(x.location.uri).fsPath;	×
UNCOV 356	if (!emitFullPaths) {	×
357	relatedInfoFilePath = path.relative(cwd, relatedInfoFilePath);	×
358	}
359	return {	×
360	filePath: relatedInfoFilePath,
361	range: x.location.range,
362	message: x.message
363	};
364	});
365	//format output
366	diagnosticUtils.printDiagnostic(options, severity, filePath, lines, diagnostic, relatedInformation);	7✔
367	}
368	}
369	}
370
371	/**
372	* Run the process once, allowing it to be cancelled.
373	* NOTE: This should only be called by `runOnce`.
374	*/
375	private async _runOnce(options: { cancellationToken: { isCanceled: any }; skipValidation: boolean }) {
376	let wereDiagnosticsPrinted = false;	78✔
377	try {	78✔
378	//maybe cancel?
379	if (options.cancellationToken.isCanceled === true) {	78!
UNCOV 380	return -1;	×
381	}
382	//validate program
383	if (options.skipValidation !== true) {	78✔
384	this.validateProject();	6✔
385	}
386
387	//maybe cancel?
388	if (options.cancellationToken.isCanceled === true) {	78!
UNCOV 389	return -1;	×
390	}
391
392	const diagnostics = this.getDiagnostics();	78✔
393	this.printDiagnostics(diagnostics);	78✔
394	wereDiagnosticsPrinted = true;	78✔
395	let errorCount = diagnostics.filter(x => x.severity === DiagnosticSeverity.Error).length;	78✔
396
397	if (errorCount > 0) {	78✔
398	this.logger.log(`Found ${errorCount} ${errorCount === 1 ? 'error' : 'errors'}`);	2!
399	return errorCount;	2✔
400	}
401
402	//create the deployment package (and transpile as well)
403	await this.createPackageIfEnabled();	76✔
404
405	//maybe cancel?
406	if (options.cancellationToken.isCanceled === true) {	76!
UNCOV 407	return -1;	×
408	}
409
410	//deploy the package
411	await this.deployPackageIfEnabled();	76✔
412
413	return 0;	76✔
414	} catch (e) {
UNCOV 415	if (wereDiagnosticsPrinted === false) {	×
UNCOV 416	this.printDiagnostics();	×
417	}
418	throw e;	×
419	}
420	}
421
422	private async createPackageIfEnabled() {
423	if (this.options.copyToStaging \|\| this.options.createPackage \|\| this.options.deploy) {	76✔
424
425	//transpile the project
426	await this.transpile();	4✔
427
428	//create the zip file if configured to do so
429	if (this.options.createPackage !== false \|\| this.options.deploy) {	4✔
430	await this.logger.time(LogLevel.log, [`Creating package at ${this.options.outFile}`], async () => {	2✔
431	await rokuDeploy.zipPackage({	2✔
432	...this.options,
433	logLevel: this.options.logLevel as unknown as RokuDeployLogLevel,
434	outDir: util.getOutDir(this.options),
435	outFile: path.basename(this.options.outFile)
436	});
437	});
438	}
439	}
440	}
441
442	private transpileThrottler = new Throttler(0);	96✔
443	/**
444	* Transpiles the entire program into the staging folder
445	*/
446	public async transpile() {
447	await this.transpileThrottler.run(async () => {	4✔
448	let options = util.cwdWork(this.options.cwd, () => {	4✔
449	return rokuDeploy.getOptions({	4✔
450	...this.options,
451	logLevel: this.options.logLevel as unknown as RokuDeployLogLevel,
452	outDir: util.getOutDir(this.options),
453	outFile: path.basename(this.options.outFile)
454
455	//rokuDeploy's return type says all its fields can be nullable, but it sets values for all of them.
456	}) as any as Required<ReturnType<typeof rokuDeploy.getOptions>>;
457	});
458
459	//get every file referenced by the files array
460	let fileMap = await rokuDeploy.getFilePaths(options.files, options.rootDir);	4✔
461
462	//remove files currently loaded in the program, we will transpile those instead (even if just for source maps)
463	let filteredFileMap = [] as FileObj[];	4✔
464
465	for (let fileEntry of fileMap) {	4✔
466	if (this.program!.hasFile(fileEntry.src) === false) {	4✔
467	filteredFileMap.push(fileEntry);	2✔
468	}
469	}
470
471	this.plugins.emit('beforePrepublish', this, filteredFileMap);	4✔
472
473	await this.logger.time(LogLevel.log, ['Copying to staging directory'], async () => {	4✔
474	//prepublish all non-program-loaded files to staging
475	await rokuDeploy.prepublishToStaging({	4✔
476	...options,
477	files: filteredFileMap
478	});
479	});
480
481	this.plugins.emit('afterPrepublish', this, filteredFileMap);	4✔
482	this.plugins.emit('beforePublish', this, fileMap);	4✔
483
484	await this.logger.time(LogLevel.log, ['Transpiling'], async () => {	4✔
485	//transpile any brighterscript files
486	await this.program!.transpile(fileMap, options.stagingDir);	4✔
487	});
488
489	this.plugins.emit('afterPublish', this, fileMap);	4✔
490	});
491	}
492
493	private async deployPackageIfEnabled() {
494	//deploy the project if configured to do so
495	if (this.options.deploy) {	76!
UNCOV 496	await this.logger.time(LogLevel.log, ['Deploying package to', this.options.host], async () => {	×
UNCOV 497	await rokuDeploy.publish({	×
498	...this.options,
499	logLevel: this.options.logLevel as unknown as RokuDeployLogLevel,
500	outDir: util.getOutDir(this.options),
501	outFile: path.basename(this.options.outFile)
502	});
503	});
504	}
505	}
506
507	/**
508	* Parse and load the AST for every file in the project
509	*/
510	private async loadAllFilesAST() {
511	await this.logger.time(LogLevel.log, ['Parsing files'], async () => {	83✔
512	let files = await this.logger.time(LogLevel.debug, ['getFilePaths'], async () => {	83✔
513	return util.getFilePaths(this.options);	83✔
514	});
515	this.logger.trace('ProgramBuilder.loadAllFilesAST() files:', files);	83✔
516
517	const typedefFiles = [] as FileObj[];	83✔
518	const sourceFiles = [] as FileObj[];	83✔
519	let manifestFile: FileObj \| null = null;	83✔
520
521	for (const file of files) {	83✔
522	// source files (.brs, .bs, .xml)
523	if (/(?<!\.d)\.(bs\|brs\|xml)$/i.test(file.dest)) {	55✔
524	sourceFiles.push(file);	45✔
525
526	// typedef files (.d.bs)
527	} else if (/\.d\.bs$/i.test(file.dest)) {	10✔
528	typedefFiles.push(file);	2✔
529
530	// manifest file
531	} else if (/^manifest$/i.test(file.dest)) {	8✔
532	manifestFile = file;	7✔
533	}
534	}
535
536	if (manifestFile) {	83✔
537	this.program!.loadManifest(manifestFile, false);	7✔
538	}
539
540	const loadFile = async (fileObj) => {	83✔
541	try {	47✔
542	this.program!.setFile(fileObj, await this.getFileContents(fileObj.src));	47✔
543	} catch (e) {
UNCOV 544	this.logger.log(e); // log the error, but don't fail this process because the file might be fixable later	×
545	}
546	};
547	await Promise.all(typedefFiles.map(loadFile)); // preload every type definition file, which eliminates duplicate file loading	83✔
548	await Promise.all(sourceFiles.map(loadFile)); // parse source files	83✔
549	});
550	}
551
552	/**
553	* Remove all files from the program that are in the specified folder path
554	* @param srcPath the path to the folder to remove
555	*/
556	public removeFilesInFolder(srcPath: string): boolean {
UNCOV 557	let removedSomeFiles = false;	×
UNCOV 558	for (let filePath in this.program.files) {	×
559	//if the file path starts with the parent path and the file path does not exactly match the folder path
560	if (filePath.startsWith(srcPath) && filePath !== srcPath) {	×
UNCOV 561	this.program.removeFile(filePath);	×
562	removedSomeFiles = true;	×
563	}
564	}
UNCOV 565	return removedSomeFiles;	×
566	}
567
568	/**
569	* Scan every file and resolve all variable references.
570	* If no errors were encountered, return true. Otherwise return false.
571	*/
572	private validateProject() {
573	this.program.validate();	6✔
574	}
575
576	public dispose() {
577	if (this.watcher) {	90!
UNCOV 578	this.watcher.dispose();	×
579	}
580	if (this.program) {	90!
581	this.program.dispose?.();	90!
582	}
583	if (this.watchInterval) {	90!
UNCOV 584	clearInterval(this.watchInterval);	×
585	}
586	}
587	}

rokucommunity / brighterscript / #13871

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous