Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

cli: create writeFile destination if necessary #15990

Merged
merged 6 commits into from
Nov 14, 2024
Merged

cli: create writeFile destination if necessary #15990

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9492cba
fix(cli/printer.js): ensure writeFile creates filePath directories if…
servusdei2018 May 10, 2024
5ea6d4d
Merge branch 'main' into main
servusdei2018 Nov 13, 2024
7c9b5b8
tests(cli): ensure missing directories are created when writing to file
servusdei2018 Nov 13, 2024
cc3815e
fix: format code
servusdei2018 Nov 13, 2024
6c1bfe8
Merge branch 'main' into main
servusdei2018 Nov 13, 2024
80d47d9
fix: throws for invalid paths test case
servusdei2018 Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions cli/printer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
*/

import fs from 'fs';
import path from 'path';

import log from 'lighthouse-logger';

Expand Down Expand Up @@ -58,13 +59,17 @@ function writeToStdout(output) {
*/
function writeFile(filePath, output, outputMode) {
return new Promise((resolve, reject) => {
// TODO: make this mkdir to the filePath.
fs.writeFile(filePath, output, (err) => {
if (err) {
fs.mkdir(path.dirname(filePath), {recursive: true}, (err) => {
if (err && err.code !== 'EEXIST') {
return reject(err);
}
log.log('Printer', `${OutputMode[outputMode]} output written to ${filePath}`);
resolve();
fs.writeFile(filePath, output, (err) => {
if (err) {
return reject(err);
}
log.log('Printer', `${OutputMode[outputMode]} output written to ${filePath}`);
resolve();
});
});
});
}
Expand Down
23 changes: 19 additions & 4 deletions cli/test/cli/printer-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

import assert from 'assert/strict';
import fs from 'fs';
import path from 'path';

import {readJson} from '../../../core/test/test-utils.js';
import * as Printer from '../../printer.js';
Expand Down Expand Up @@ -34,11 +35,9 @@ describe('Printer', () => {
});

it('throws for invalid paths', () => {
const path = '!/#@.json';
const path = '//#@.json';
const report = JSON.stringify(sampleResults);
return Printer.write(report, 'html', path).catch(err => {
assert.ok(err.code === 'ENOENT');
});
return assert.rejects(Printer.write(report, 'html', path));
});

it('returns output modes', () => {
Expand All @@ -49,4 +48,20 @@ describe('Printer', () => {
assert.strictEqual(typeof mode, 'string');
});
});

it('creates missing directories when writing to file', () => {
const dirPath = './non/existent/directory/.test-file.json';
const report = JSON.stringify(sampleResults);
const dir = path.dirname(dirPath);
if (fs.existsSync(dir)) {
fs.rmdirSync(dir, {recursive: true});
}
return Printer.write(report, 'json', dirPath).then(_ => {
assert.ok(fs.existsSync(dir), `Directory ${dir} should exist now`);
const fileContents = fs.readFileSync(dirPath, 'utf8');
assert.ok(/lighthouseVersion/gim.test(fileContents));
fs.unlinkSync(dirPath);
fs.rmdirSync(dir, {recursive: true});
});
});
});
Loading