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.

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

Compare File Size Ratio #473

Merged
merged 2 commits into from
Sep 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.plugin = exports.details = void 0;
/* eslint no-plusplus: ["error", { "allowForLoopAfterthoughts": true }] */
var details = function () { return ({
name: 'Compare File Size Ratio',
description: 'Compare file size ratio of working file compared to original file using percentage.',
style: {
borderColor: 'orange',
},
tags: '',
isStartPlugin: false,
pType: '',
requiresVersion: '2.11.01',
sidebarPosition: -1,
icon: 'faQuestion',
inputs: [
{
name: 'greaterThan',
type: 'number',
defaultValue: '40',
inputUI: {
type: 'text',
},
tooltip: 'Specify lower bound. '
+ 'Default value is 40% so new file size must be at least 40% of original file size.',
},
{
name: 'lessThan',
type: 'number',
defaultValue: '110',
inputUI: {
type: 'text',
},
tooltip: 'Specify upper bound.'
+ ' Default value is 110% so new file size must be at most 110% of original file size.',
},
],
outputs: [
{
number: 1,
tooltip: 'Working file size % is within range',
},
{
number: 2,
tooltip: 'Working file size % is not within range',
},
],
}); };
exports.details = details;
// eslint-disable-next-line @typescript-eslint/no-unused-vars
var plugin = function (args) {
var lib = require('../../../../../methods/lib')();
// eslint-disable-next-line @typescript-eslint/no-unused-vars,no-param-reassign
args.inputs = lib.loadDefaultValues(args.inputs, details);
var isWithinRange = false;
var newFileSizeBytes = args.inputFileObj.file_size;
var origFileSizeBytes = args.originalLibraryFile.file_size;
var greaterThanPerc = Number(args.inputs.greaterThan);
var lessThanPerc = Number(args.inputs.lessThan);
var ratio = (newFileSizeBytes / origFileSizeBytes) * 100;
var sizeText = "New file has size ".concat(newFileSizeBytes.toFixed(3), " MB which is ").concat(ratio, "% ")
+ "of original file size: ".concat(origFileSizeBytes.toFixed(3), " MB");
var getBound = function (bound) { return (bound / 100) * origFileSizeBytes; };
var errText = 'New file size not within limits.';
if (newFileSizeBytes > getBound(lessThanPerc)) {
// Item will be errored in UI
args.jobLog("".concat(errText, " ").concat(sizeText, ". upperBound is ").concat(lessThanPerc, "%"));
}
else if (newFileSizeBytes < getBound(greaterThanPerc)) {
// // Item will be errored in UI
args.jobLog("".concat(errText, " ").concat(sizeText, ". lowerBound is ").concat(greaterThanPerc, "%"));
}
else {
args.jobLog(sizeText);
isWithinRange = true;
}
return {
outputFileObj: args.inputFileObj,
outputNumber: isWithinRange ? 1 : 2,
variables: args.variables,
};
};
exports.plugin = plugin;
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
import {
IpluginDetails,
IpluginInputArgs,
IpluginOutputArgs,
} from '../../../../FlowHelpers/1.0.0/interfaces/interfaces';

/* eslint no-plusplus: ["error", { "allowForLoopAfterthoughts": true }] */
const details = (): IpluginDetails => ({
name: 'Compare File Size Ratio',
description: 'Compare file size ratio of working file compared to original file using percentage.',
style: {
borderColor: 'orange',
},
tags: '',

isStartPlugin: false,
pType: '',
requiresVersion: '2.11.01',
sidebarPosition: -1,
icon: 'faQuestion',
inputs: [
{
name: 'greaterThan',
type: 'number',
defaultValue: '40',
inputUI: {
type: 'text',
},
tooltip: 'Specify lower bound. '
+ 'Default value is 40% so new file size must be at least 40% of original file size.',
},
{
name: 'lessThan',
type: 'number',
defaultValue: '110',
inputUI: {
type: 'text',
},
tooltip: 'Specify upper bound.'
+ ' Default value is 110% so new file size must be at most 110% of original file size.',
},
],
outputs: [
{
number: 1,
tooltip: 'Working file size % is within range',
},
{
number: 2,
tooltip: 'Working file size % is not within range',
},
],
});

// eslint-disable-next-line @typescript-eslint/no-unused-vars
const plugin = (args: IpluginInputArgs): IpluginOutputArgs => {
const lib = require('../../../../../methods/lib')();
// eslint-disable-next-line @typescript-eslint/no-unused-vars,no-param-reassign
args.inputs = lib.loadDefaultValues(args.inputs, details);

let isWithinRange = false;
const newFileSizeBytes = args.inputFileObj.file_size;
const origFileSizeBytes = args.originalLibraryFile.file_size;

const greaterThanPerc = Number(args.inputs.greaterThan);
const lessThanPerc = Number(args.inputs.lessThan);

const ratio = (newFileSizeBytes / origFileSizeBytes) * 100;

const sizeText = `New file has size ${newFileSizeBytes.toFixed(3)} MB which is ${ratio}% `
+ `of original file size: ${origFileSizeBytes.toFixed(3)} MB`;

const getBound = (bound:number) => (bound / 100) * origFileSizeBytes;

const errText = 'New file size not within limits.';
if (newFileSizeBytes > getBound(lessThanPerc)) {
// Item will be errored in UI
args.jobLog(`${errText} ${sizeText}. upperBound is ${lessThanPerc}%`);
} else if (newFileSizeBytes < getBound(greaterThanPerc)) {
// // Item will be errored in UI
args.jobLog(`${errText} ${sizeText}. lowerBound is ${greaterThanPerc}%`);
} else {
args.jobLog(sizeText);
isWithinRange = true;
}

return {
outputFileObj: args.inputFileObj,
outputNumber: isWithinRange ? 1 : 2,
variables: args.variables,
};
};
export {
details,
plugin,
};
Loading