6956692978

Committed 22 Nov 2023 11:32AM UTC coverage: 86.503% (+0.03%) from 86.47%

Build # 6956692978

Build Type

push

github

Committed by

web-flow

Commit Message

fix: Fix the functionality of the overwrite flag (#513)

Run Details

1121 of 1449 branches covered (0.0%)

Branch coverage included in aggregate %.

9 of 9 new or added lines in 3 files covered. (100.0%)

3 existing lines in 3 files now uncovered.

4173 of 4671 relevant lines covered (89.34%)

350.15 hits per line

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

87.3

/src/commands/files/download.js

'use strict';

const { flags } = require('@oclif/command');
const BoxCommand = require('../../box-command');
const fs = require('fs');
const path = require('path');
const progress = require('cli-progress');
const BoxCLIError = require('../../cli-error');
const utils = require('../../util');

class FilesDownloadCommand extends BoxCommand {
        async run() {
                const { flags, args } = this.parse(FilesDownloadCommand);

                let file = await this.client.files.get(args.id);
                let fileName = flags['save-as'] ? flags['save-as'] : file.name;

                let filePath;

                if (flags.destination) {
                        await utils.checkDir(flags.destination, flags['create-path']);
                        filePath = path.join(flags.destination, fileName);
                } else {
                        filePath = path.join(this.settings.boxDownloadsFolderPath, fileName);
                }

                /* eslint-disable no-sync */
                if (!flags.overwrite && fs.existsSync(filePath)) {
                /* eslint-enable no-sync */

                        if (flags.overwrite === false) {
                                this.info(`Downloading the file will not occur because the file ${filePath} already exists, and the --no-overwrite flag is set.`);
                                return;
                        }

                        let shouldOverwrite = await this.confirm(`File ${filePath} already exists — overwrite?`);

                        if (!shouldOverwrite) {
                                return;
                        }
                }

                let options = {};

                if (flags.version) {
                        options.version = flags.version;
                }

                let stream = await this.client.files.getReadStream(args.id, options);
                let output;
                try {
                        output = fs.createWriteStream(filePath);
                        stream.pipe(output);
                } catch (ex) {
                        throw new BoxCLIError(`Could not download to destination file ${filePath}`, ex);
                }

                let progressBar = new progress.Bar({
                        format: '[{bar}] {percentage}% | ETA: {eta_formatted} | {value}/{total} | Speed: {speed} MB/s',
                        stopOnComplete: true,
                });
                let startTime = Date.now();
                progressBar.start(file.size, 0, { speed: 'N/A' });

                let downloadedByte = 0;
                stream.on('data', (chunk) => {
                        downloadedByte += chunk.length;
                });
                let intervalUpdate = setInterval(() => {
                        progressBar.update(downloadedByte, {
                                speed: Math.floor(downloadedByte / (Date.now() - startTime) / 1000),
                        });
                }, 1000);

                /* eslint-disable promise/avoid-new */
                // We need to await the end of the stream to avoid a race condition here
                await new Promise((resolve, reject) => {
                        output.on('close', resolve);
                        stream.on('error', reject);
                });
                clearInterval(intervalUpdate);
                progressBar.update(downloadedByte);
                this.info(`Downloaded file ${fileName}`);
        }
}

FilesDownloadCommand.description = 'Download a file';
FilesDownloadCommand.examples = ['box files:download 11111 --destination /path/to/destinationFolder'];
FilesDownloadCommand._endpoint = 'get_files_id_content';

FilesDownloadCommand.flags = {
        ...BoxCommand.flags,
        version: flags.string({
                description: 'File version ID of the specific file version to download',
        }),
        destination: flags.string({
                description: 'The destination folder to write the file to',
                parse: utils.parsePath,
        }),
        'create-path': flags.boolean({
                description: 'Recursively creates a path to a directory if it does not exist',
                allowNo: true,
                default: true
        }),
        overwrite: flags.boolean({
                description: 'Overwrite a file if it already exists',
                allowNo: true
        }),
        'save-as': flags.string({
                description: 'The filename used when saving the file'
        })
};

FilesDownloadCommand.args = [
        {
                name: 'id',
                required: true,
                hidden: false,
                description: 'ID of the file to download'
        }
];

module.exports = FilesDownloadCommand;

1	'use strict';
2
3	const { flags } = require('@oclif/command');	9✔
4	const BoxCommand = require('../../box-command');	9✔
5	const fs = require('fs');	9✔
6	const path = require('path');	9✔
7	const progress = require('cli-progress');	9✔
8	const BoxCLIError = require('../../cli-error');	9✔
9	const utils = require('../../util');	9✔
10
11	class FilesDownloadCommand extends BoxCommand {
12	async run() {
13	const { flags, args } = this.parse(FilesDownloadCommand);	63✔
14
15	let file = await this.client.files.get(args.id);	63✔
16	let fileName = flags['save-as'] ? flags['save-as'] : file.name;	63✔
17
18	let filePath;
19
20	if (flags.destination) {	63✔
21	await utils.checkDir(flags.destination, flags['create-path']);	36✔
22	filePath = path.join(flags.destination, fileName);	36✔
23	} else {
24	filePath = path.join(this.settings.boxDownloadsFolderPath, fileName);	27✔
25	}
26
27	/* eslint-disable no-sync */
28	if (!flags.overwrite && fs.existsSync(filePath)) {	63✔
29	/* eslint-enable no-sync */
30
31	if (flags.overwrite === false) {	9!
32	this.info(`Downloading the file will not occur because the file ${filePath} already exists, and the --no-overwrite flag is set.`);	9✔
33	return;	9✔
34	}
35
UNCOV 36	let shouldOverwrite = await this.confirm(`File ${filePath} already exists — overwrite?`);	×
37
38	if (!shouldOverwrite) {	×
39	return;	×
40	}
41	}
42
43	let options = {};	54✔
44
45	if (flags.version) {	54✔
46	options.version = flags.version;	9✔
47	}
48
49	let stream = await this.client.files.getReadStream(args.id, options);	54✔
50	let output;
51	try {	54✔
52	output = fs.createWriteStream(filePath);	54✔
53	stream.pipe(output);	54✔
54	} catch (ex) {
55	throw new BoxCLIError(`Could not download to destination file ${filePath}`, ex);	×
56	}
57
58	let progressBar = new progress.Bar({	54✔
59	format: '[{bar}] {percentage}% \| ETA: {eta_formatted} \| {value}/{total} \| Speed: {speed} MB/s',
60	stopOnComplete: true,
61	});
62	let startTime = Date.now();	54✔
63	progressBar.start(file.size, 0, { speed: 'N/A' });	54✔
64
65	let downloadedByte = 0;	54✔
66	stream.on('data', (chunk) => {	54✔
67	downloadedByte += chunk.length;	270✔
68	});
69	let intervalUpdate = setInterval(() => {	54✔
70	progressBar.update(downloadedByte, {	×
71	speed: Math.floor(downloadedByte / (Date.now() - startTime) / 1000),
72	});
73	}, 1000);
74
75	/* eslint-disable promise/avoid-new */
76	// We need to await the end of the stream to avoid a race condition here
77	await new Promise((resolve, reject) => {	54✔
78	output.on('close', resolve);	54✔
79	stream.on('error', reject);	54✔
80	});
81	clearInterval(intervalUpdate);	54✔
82	progressBar.update(downloadedByte);	54✔
83	this.info(`Downloaded file ${fileName}`);	54✔
84	}
85	}
86
87	FilesDownloadCommand.description = 'Download a file';	9✔
88	FilesDownloadCommand.examples = ['box files:download 11111 --destination /path/to/destinationFolder'];	9✔
89	FilesDownloadCommand._endpoint = 'get_files_id_content';	9✔
90
91	FilesDownloadCommand.flags = {	9✔
92	...BoxCommand.flags,
93	version: flags.string({
94	description: 'File version ID of the specific file version to download',
95	}),
96	destination: flags.string({
97	description: 'The destination folder to write the file to',
98	parse: utils.parsePath,
99	}),
100	'create-path': flags.boolean({
101	description: 'Recursively creates a path to a directory if it does not exist',
102	allowNo: true,
103	default: true
104	}),
105	overwrite: flags.boolean({
106	description: 'Overwrite a file if it already exists',
107	allowNo: true
108	}),
109	'save-as': flags.string({
110	description: 'The filename used when saving the file'
111	})
112	};
113
114	FilesDownloadCommand.args = [	9✔
115	{
116	name: 'id',
117	required: true,
118	hidden: false,
119	description: 'ID of the file to download'
120	}
121	];
122
123	module.exports = FilesDownloadCommand;	9✔

box / boxcli / 6956692978

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