chore: skip file access checks on unmapped node (#877)

* chore: skip file access checks on unmapped node

* chore: update configVars

* refactor: add getConfigVars

* refactor: move configVars

Author: HaveAGitGat

FlowPlugins/CommunityFlowPlugins/input/inputFile/1.0.0/index.js

@@ -84,9 +84,10 @@ var details = function () { return ({
 exports.details = details;
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 var plugin = function (args) { return __awaiter(void 0, void 0, void 0, function () {
-    var lib, orignalFolder, _a, fileAccessChecks, pauseNodeIfAccessChecksFail, nodeID, _b, serverIP, serverPort, apiKey, url, pauseNode, checkReadWrite;
-    return __generator(this, function (_c) {
-        switch (_c.label) {
+    var lib, orignalFolder, _a, fileAccessChecks, pauseNodeIfAccessChecksFail, nodeID, _b, serverIP, serverPort, apiKey, url, pauseNode, checkReadWrite, isNotUnmappedNode;
+    var _c, _d;
+    return __generator(this, function (_e) {
+        switch (_e.label) {
             case 0:
                 lib = require('../../../../../methods/lib')();
                 // eslint-disable-next-line @typescript-eslint/no-unused-vars,no-param-reassign
@@ -131,9 +132,11 @@ var plugin = function (args) { return __awaiter(void 0, void 0, void 0, function
                         switch (_a.label) {
                             case 0:
                                 _a.trys.push([0, 2, , 5]);
+                                args.jobLog("Checking read access for: \"".concat(location, "\""));
                                 return [4 /*yield*/, fs_1.promises.access(location, fs_1.promises.constants.R_OK)];
                             case 1:
                                 _a.sent();
+                                args.jobLog('Read access OK');
                                 return [3 /*break*/, 5];
                             case 2:
                                 err_1 = _a.sent();
@@ -163,18 +166,19 @@ var plugin = function (args) { return __awaiter(void 0, void 0, void 0, function
                         }
                     });
                 }); };
-                if (!fileAccessChecks) return [3 /*break*/, 3];
+                isNotUnmappedNode = ((_d = (_c = args === null || args === void 0 ? void 0 : args.configVars) === null || _c === void 0 ? void 0 : _c.config) === null || _d === void 0 ? void 0 : _d.nodeType) !== 'unmapped';
+                if (!(fileAccessChecks && isNotUnmappedNode)) return [3 /*break*/, 3];
                 args.jobLog('Checking file access');
                 return [4 /*yield*/, checkReadWrite(orignalFolder)];
             case 1:
-                _c.sent();
+                _e.sent();
                 return [4 /*yield*/, checkReadWrite(args.librarySettings.cache)];
             case 2:
-                _c.sent();
+                _e.sent();
                 return [3 /*break*/, 4];
             case 3:
                 args.jobLog('Skipping file access checks');
-                _c.label = 4;
+                _e.label = 4;
             case 4: return [2 /*return*/, {
                     outputFileObj: args.inputFileObj,
                     outputNumber: 1,

FlowPluginsTs/CommunityFlowPlugins/input/inputFile/1.0.0/index.ts

@@ -88,7 +88,9 @@ const plugin = async (args: IpluginInputArgs): Promise<IpluginOutputArgs> => {
 
   const checkReadWrite = async (location: string) => {
     try {
+      args.jobLog(`Checking read access for: "${location}"`);
       await fsp.access(location, fsp.constants.R_OK);
+      args.jobLog('Read access OK');
     } catch (err) {
       args.jobLog(JSON.stringify(err));
       if (pauseNodeIfAccessChecksFail) {
@@ -109,7 +111,9 @@ const plugin = async (args: IpluginInputArgs): Promise<IpluginOutputArgs> => {
     }
   };
 
-  if (fileAccessChecks) {
+  const isNotUnmappedNode = args?.configVars?.config?.nodeType !== 'unmapped';
+
+  if (fileAccessChecks && isNotUnmappedNode) {
     args.jobLog('Checking file access');
     await checkReadWrite(orignalFolder);
     await checkReadWrite(args.librarySettings.cache);

FlowPluginsTs/FlowHelpers/1.0.0/interfaces/interfaces.ts

@@ -123,6 +123,37 @@ export interface IpluginOutputArgs {
     variables: Ivariables,
 }
 
+export interface IconfigVars {
+    config: {
+        nodeID: string,
+        nodeName: string,
+        serverURL: string,
+        serverIP: string,
+        serverPort: string,
+        handbrakePath: string,
+        ffmpegPath: string,
+        mkvpropeditPath: string,
+        pathTranslators: {
+            server: string,
+            node: string,
+        }[],
+        platform_arch_isdocker: string,
+        logLevel: string,
+        processPid: number,
+        priority: number,
+        cronPluginUpdate: string,
+        apiKey: string,
+        seededWorkerLimits?:{
+            [index: string]: number,
+        },
+        maxLogSizeMB: number,
+        pollInterval: number,
+        nodeType: 'mapped' | 'unmapped',
+        unmappedNodeCache: string,
+        startPaused: boolean,
+    }
+}
+
 export interface IpluginInputArgs {
     inputFileObj: IFileObject,
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -157,6 +188,7 @@ export interface IpluginInputArgs {
     logOutcome: (outcome: string) => void,
     scanIndividualFile?: (filee: IFileObjectMin, scanTypes: IscanTypes) => Promise<IFileObject>,
     updateStat: (db: string, key: string, inc: number) => Promise<void>,
+    configVars: IconfigVars,
     deps: {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         fsextra: any,
@@ -179,13 +211,7 @@ export interface IpluginInputArgs {
         axios: any,
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         crudTransDBN: (collection: string, mode: string, docID: string, obj: any) => any,
-        configVars: {
-            config: {
-                serverIP: string,
-                serverPort: string,
-                apiKey: string,
-            }
-        }
+        configVars: IconfigVars,
     },
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     installClassicPluginDeps: (deps: string[]) => Promise<any>,

tests/FlowPlugins/CommunityFlowPlugins/basic/basicVideoOrAudio/1.0.0/index.test.ts

@@ -10,6 +10,7 @@ import { details, plugin } from
   '../../../../../../FlowPluginsTs/CommunityFlowPlugins/basic/basicVideoOrAudio/1.0.0/index';
 import { IpluginInputArgs } from '../../../../../../FlowPluginsTs/FlowHelpers/1.0.0/interfaces/interfaces';
 import { IFileObject } from '../../../../../../FlowPluginsTs/FlowHelpers/1.0.0/interfaces/synced/IFileObject';
+import  getConfigVars  from '../../../../configVars';
 
 const sampleH264_1 = require('../../../../../sampleData/media/sampleH264_1.json');
 const sampleAAC = require('../../../../../sampleData/media/sampleAAC_1.json');
@@ -19,6 +20,8 @@ describe('basicVideoOrAudio Plugin', () => {
   let baseArgs: IpluginInputArgs;
 
   beforeEach(() => {
+    const configVars = getConfigVars();
+
     baseArgs = {
       inputs: {
         basicSettingsType: 'video',
@@ -74,6 +77,7 @@ describe('basicVideoOrAudio Plugin', () => {
       lastSuccessfulRun: null,
       updateStat: jest.fn(),
       installClassicPluginDeps: jest.fn(),
+      configVars,
       deps: {
         fsextra: {
           ensureDirSync: jest.fn(),
@@ -96,13 +100,7 @@ describe('basicVideoOrAudio Plugin', () => {
         ncp: jest.fn(),
         axios: {},
         crudTransDBN: jest.fn(),
-        configVars: {
-          config: {
-            serverIP: '127.0.0.1',
-            serverPort: '8266',
-            apiKey: '',
-          },
-        },
+        configVars,
       },
     } as IpluginInputArgs;
   });

tests/FlowPlugins/CommunityFlowPlugins/classic/runClassicFilterPlugin/1.0.0/index.test.ts

@@ -1,6 +1,7 @@
 import { plugin } from
   '../../../../../../FlowPluginsTs/CommunityFlowPlugins/classic/runClassicFilterPlugin/1.0.0/index';
 import { IpluginInputArgs } from '../../../../../../FlowPluginsTs/FlowHelpers/1.0.0/interfaces/interfaces';
+import getConfigVars from '../../../../configVars';
 
 const sampleH264 = require('../../../../../sampleData/media/sampleH264_1.json');
 
@@ -33,7 +34,7 @@ describe('runClassicFilterPlugin 1.0.0', () => {
         requireFromString: jest.fn(),
         axios: {},
         os: {},
-        configVars: {},
+        configVars: getConfigVars(),
       },
     } as unknown as IpluginInputArgs;
   });

tests/FlowPlugins/CommunityFlowPlugins/classic/runClassicTranscodePlugin/1.0.0/index.test.ts

@@ -1,6 +1,7 @@
 import { plugin } from
   '../../../../../../FlowPluginsTs/CommunityFlowPlugins/classic/runClassicTranscodePlugin/1.0.0/index';
 import { IpluginInputArgs } from '../../../../../../FlowPluginsTs/FlowHelpers/1.0.0/interfaces/interfaces';
+import getConfigVars from '../../../../configVars';
 
 const sampleH264 = require('../../../../../sampleData/media/sampleH264_1.json');
 
@@ -47,7 +48,7 @@ describe('runClassicTranscodePlugin 1.0.0', () => {
         requireFromString: jest.fn(),
         axios: {},
         os: {},
-        configVars: {},
+        configVars: getConfigVars(),
       },
       ffmpegPath: '/usr/bin/ffmpeg',
       handbrakePath: '/usr/bin/handbrake',

tests/FlowPlugins/CommunityFlowPlugins/classic/runClassicTranscodePlugin/2.0.0/index.test.ts

@@ -1,6 +1,7 @@
 import { plugin } from
   '../../../../../../FlowPluginsTs/CommunityFlowPlugins/classic/runClassicTranscodePlugin/2.0.0/index';
 import { IpluginInputArgs } from '../../../../../../FlowPluginsTs/FlowHelpers/1.0.0/interfaces/interfaces';
+import getConfigVars from '../../../../configVars';
 
 const sampleH264 = require('../../../../../sampleData/media/sampleH264_1.json');
 
@@ -47,7 +48,7 @@ describe('runClassicTranscodePlugin 2.0.0', () => {
         requireFromString: jest.fn(),
         axios: {},
         os: {},
-        configVars: {},
+        configVars: getConfigVars(),
       },
       ffmpegPath: '/usr/bin/ffmpeg',
       handbrakePath: '/usr/bin/handbrake',

tests/FlowPlugins/CommunityFlowPlugins/ffmpegCommand/ffmpegCommandExecute/1.0.0/index.test.ts

@@ -2,6 +2,7 @@ import { plugin } from
   '../../../../../../FlowPluginsTs/CommunityFlowPlugins/ffmpegCommand/ffmpegCommandExecute/1.0.0/index';
 import { IpluginInputArgs } from '../../../../../../FlowPluginsTs/FlowHelpers/1.0.0/interfaces/interfaces';
 import { IFileObject } from '../../../../../../FlowPluginsTs/FlowHelpers/1.0.0/interfaces/synced/IFileObject';
+import getConfigVars from '../../../../configVars';
 
 const sampleH264 = require('../../../../../sampleData/media/sampleH264_1.json');
 
@@ -22,6 +23,8 @@ describe('ffmpegCommandExecute Plugin', () => {
       runCli: jest.fn().mockResolvedValue({ cliExitCode: 0 }),
     }));
 
+    const configVars = getConfigVars();
+
     baseArgs = {
       inputs: {},
       variables: {
@@ -66,6 +69,7 @@ describe('ffmpegCommandExecute Plugin', () => {
       logOutcome: jest.fn(),
       logFullCliOutput: false,
       workDir: '/tmp/work',
+      configVars,
       deps: {
         fsextra: {
           ensureDirSync: jest.fn(),
@@ -88,13 +92,7 @@ describe('ffmpegCommandExecute Plugin', () => {
         ncp: jest.fn(),
         axios: {},
         crudTransDBN: jest.fn(),
-        configVars: {
-          config: {
-            serverIP: '127.0.0.1',
-            serverPort: '8266',
-            apiKey: '',
-          },
-        },
+        configVars,
       },
     } as Partial<IpluginInputArgs> as IpluginInputArgs;
   });

tests/FlowPlugins/CommunityFlowPlugins/file/compareFileSizeRatio/1.0.0/index.test.ts

@@ -2,6 +2,7 @@ import { plugin } from
   '../../../../../../FlowPluginsTs/CommunityFlowPlugins/file/compareFileSizeRatio/1.0.0/index';
 import { IpluginInputArgs } from '../../../../../../FlowPluginsTs/FlowHelpers/1.0.0/interfaces/interfaces';
 import { IFileObject } from '../../../../../../FlowPluginsTs/FlowHelpers/1.0.0/interfaces/synced/IFileObject';
+import getConfigVars from '../../../../configVars';
 
 const sampleH264 = require('../../../../../sampleData/media/sampleH264_1.json');
 const sampleMP3 = require('../../../../../sampleData/media/sampleMP3_1.json');
@@ -17,6 +18,8 @@ describe('compareFileSizeRatio Plugin', () => {
       file_size: 100.0,
     } as IFileObject;
 
+    const configVars = getConfigVars();
+
     baseArgs = {
       inputs: {
         greaterThan: '40',
@@ -26,6 +29,7 @@ describe('compareFileSizeRatio Plugin', () => {
       inputFileObj: JSON.parse(JSON.stringify(sampleH264)) as IFileObject,
       originalLibraryFile: mockOriginalFile,
       jobLog: jest.fn(),
+      configVars,
     } as Partial<IpluginInputArgs> as IpluginInputArgs;
 
     // Set default working file size (50 MB = 50% of original)

tests/FlowPlugins/CommunityFlowPlugins/file/copyToWorkDirectory/1.0.0/index.test.ts

@@ -2,6 +2,7 @@ import { promises as fsp } from 'fs';
 import { plugin } from
   '../../../../../../FlowPluginsTs/CommunityFlowPlugins/file/copyToWorkDirectory/1.0.0/index';
 import { IpluginInputArgs } from '../../../../../../FlowPluginsTs/FlowHelpers/1.0.0/interfaces/interfaces';
+import getConfigVars from '../../../../configVars';
 
 const sampleH264 = require('../../../../../sampleData/media/sampleH264_1.json');
 
@@ -24,6 +25,8 @@ describe('copyToWorkDirectory Plugin', () => {
   beforeEach(() => {
     jest.clearAllMocks();
 
+    const configVars = getConfigVars();
+
     baseArgs = {
       inputs: {},
       variables: {} as IpluginInputArgs['variables'],
@@ -53,6 +56,7 @@ describe('copyToWorkDirectory Plugin', () => {
       logFullCliOutput: false,
       logOutcome: jest.fn(),
       updateStat: jest.fn(),
+      configVars,
       deps: {
         fsextra: {
           ensureDirSync: mockEnsureDirSync,
@@ -71,13 +75,7 @@ describe('copyToWorkDirectory Plugin', () => {
         ncp: jest.fn(),
         axios: jest.fn(),
         crudTransDBN: jest.fn(),
-        configVars: {
-          config: {
-            serverIP: 'localhost',
-            serverPort: '8265',
-            apiKey: '',
-          },
-        },
+        configVars,
       },
       installClassicPluginDeps: jest.fn(),
     } as IpluginInputArgs;