@nexrender/core 1.49.3 → 1.49.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nexrender/core",
-  "version": "1.49.3",
+  "version": "1.49.4",
   "main": "src/index.js",
   "author": "Inlife",
   "homepage": "https://www.nexrender.com",
@@ -38,5 +38,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "06db22fa02101417e0e6574d97a07b950c5ac3c4"
+  "gitHead": "7dfa1bf539d3a9d006a987ca7dbb59e4454bbaba"
 }

package/src/helpers/patch.js

@@ -1,12 +1,60 @@
 const fs      = require('fs')
 const path    = require('path')
 const mkdirp  = require('mkdirp')
+
 const patchedDefault = require('../assets/commandLineRenderer-default.jsx')
 const patched2022 = require('../assets/commandLineRenderer-2022.jsx')
 
 const writeTo = (data, dst) => fs.writeFileSync(dst, data)
 const copyTo = (src, dst) => fs.writeFileSync(dst, fs.readFileSync(src))
 
+const PATCH_STATUS = {
+    NOT_PATCHED: 0,
+    PATCHED: 1,
+    OUTDATED: 2,
+}
+
+/**
+ * Get the correct patched content for the After Effects command line renderer
+ * @param {string} binary
+ * @returns {string}
+ */
+const getContentForPatch = (binary) => {
+    const afterEffects = path.dirname(binary)
+    const afterEffectsYearMatch = afterEffects.match(/(20[0-9]{2})/);
+
+    if (afterEffectsYearMatch && afterEffectsYearMatch[0] >= "2022") {
+        return patched2022;
+    }
+
+    return patchedDefault;
+}
+
+/**
+ * Get the status of the patch for the After Effects command line renderer
+ * @param {string} binary
+ * @returns {number} PATCH_STATUS
+ */
+const getPatchStatus = (binary) => {
+    const afterEffects = path.dirname(binary)
+    const targetScript = 'commandLineRenderer.jsx'
+    const originalFile = path.join(afterEffects, 'Scripts', 'Startup', targetScript)
+    const data = fs.readFileSync(originalFile, 'utf8')
+
+    if (data.indexOf('nexrender-patch') === -1) {
+        return PATCH_STATUS.NOT_PATCHED
+    }
+
+    const patchedMatch = data.match(/nexrender-patch-v([0-9.]+)/)
+    const existingMatch = getContentForPatch(binary).match(/nexrender-patch-v([0-9.]+)/)
+
+    if (patchedMatch[1] !== existingMatch[1]) {
+        return PATCH_STATUS.OUTDATED
+    }
+
+    return PATCH_STATUS.PATCHED
+}
+
 /**
  * Attempt to patch the After Effect's command line renderer
  * @type {Object}
@@ -14,31 +62,57 @@ const copyTo = (src, dst) => fs.writeFileSync(dst, fs.readFileSync(src))
 module.exports = (settings) => {
     const targetScript  = 'commandLineRenderer.jsx';
 
+    const patched      = getContentForPatch(settings.binary)
     const afterEffects = path.dirname(settings.binary)
-    const afterEffectsYearMatch = afterEffects.match(/(20[0-9]{2})/);
-
-    let patched = patchedDefault;
-    if (afterEffectsYearMatch && afterEffectsYearMatch[0] >= "2022") {
-        patched = patched2022;
-    }
-
     const originalFile = path.join(afterEffects, 'Scripts', 'Startup', targetScript)
     const backupFile   = path.join(afterEffects, 'Backup.Scripts', 'Startup', targetScript)
 
-    const data = fs.readFileSync(originalFile, 'utf8')
-    settings.logger.log('checking After Effects command line renderer patch...')
-
     /* check if file has been patched already */
     /* by looking for 'nexrender' in the text anywhere */
-    if (data.indexOf('nexrender-patch') !== -1) {
-        settings.logger.log('command line patch already is in place')
+    settings.logger.log('checking After Effects command line renderer patch...')
+    const patchStatus = getPatchStatus(settings.binary)
+
+    switch (patchStatus) {
+        // if not patched, then we need to patch it
+        case PATCH_STATUS.NOT_PATCHED:
+            settings.logger.log('backing up original command line script to:')
+            settings.logger.log(' - ' + backupFile)
+
+            try {
+                mkdirp.sync(path.join(afterEffects, 'Backup.Scripts', 'Startup'))
+                copyTo(originalFile, backupFile)
+
+                settings.logger.log('patching the command line script')
+                fs.chmodSync(originalFile, '755');
+                writeTo(patched, originalFile)
+
+                settings.track('Init Patch Install Succeeded')
+            } catch (err) {
+                settings.trackSync('Init Patch Install Failed')
+
+                if (err.code == 'EPERM') {
+                    settings.logger.log('\n\n              -- E R R O R --\n');
+                    settings.logger.log('you need to run application with admin priviledges once');
+                    settings.logger.log('to install Adobe After Effects commandLineRenderer.jsx patch\n');
+
+                    if (process.platform == 'win32') {
+                        settings.logger.log('reading/writing inside Program Files folder on windows is blocked')
+                        settings.logger.log('please run nexrender with Administrator Privilidges only ONE TIME, to install the patch\n\n')
+                    } else {
+                        settings.logger.log('you might need to try to run nexrender with "sudo" only ONE TIME to install the patch\n\n')
+                    }
 
-        const patchedMatch = patched.match(/nexrender-patch-v([0-9.]+)/)
-        const existingMatch = data.match(/nexrender-patch-v([0-9.]+)/)
+                    process.exit(2);
+                } else {
+                    throw err
+                }
+            }
+            break;
 
-        if (patchedMatch[1] !== existingMatch[1]) {
+        // if patched, then we need to check if it's outdated
+        case PATCH_STATUS.OUTDATED:
+            settings.logger.log('out-of-date version of the commandLineRenderer.jsx patch is detected, attepmting to update')
             try {
-                settings.logger.log('out-of-date version of the commandLineRenderer.jsx patch is detected, attepmting to update')
                 settings.track('Init Patch Update Succeeded')
                 writeTo(patched, originalFile)
             } catch (err) {
@@ -61,45 +135,22 @@ module.exports = (settings) => {
                     throw err
                 }
             }
-        }
-
-        if (settings.forceCommandLinePatch) {
-            settings.logger.log('forced rewrite of command line patch')
-            settings.track('Init Patch Forced')
-            writeTo(patched, originalFile)
-        }
-    } else {
-        settings.logger.log('backing up original command line script to:')
-        settings.logger.log(' - ' + backupFile)
-
-        try {
-            mkdirp.sync(path.join(afterEffects, 'Backup.Scripts', 'Startup'))
-            copyTo(originalFile, backupFile)
-
-            settings.logger.log('patching the command line script')
-            fs.chmodSync(originalFile, '755');
-            writeTo(patched, originalFile)
-
-            settings.track('Init Patch Install Succeeded')
-        } catch (err) {
-            settings.trackSync('Init Patch Install Failed')
-
-            if (err.code == 'EPERM') {
-                settings.logger.log('\n\n              -- E R R O R --\n');
-                settings.logger.log('you need to run application with admin priviledges once');
-                settings.logger.log('to install Adobe After Effects commandLineRenderer.jsx patch\n');
-
-                if (process.platform == 'win32') {
-                    settings.logger.log('reading/writing inside Program Files folder on windows is blocked')
-                    settings.logger.log('please run nexrender with Administrator Privilidges only ONE TIME, to install the patch\n\n')
-                } else {
-                    settings.logger.log('you might need to try to run nexrender with "sudo" only ONE TIME to install the patch\n\n')
-                }
+            break;
+
+        // if patched and up-to-date, then we're good, unless forced
+        case PATCH_STATUS.PATCHED:
+            settings.logger.log('command line patch already is in place')
 
-                process.exit(2);
-            } else {
-                throw err
+            if (settings.forceCommandLinePatch) {
+                settings.logger.log('forced rewrite of command line patch')
+                settings.track('Init Patch Forced')
+                writeTo(patched, originalFile)
             }
-        }
+
+            break;
     }
 }
+
+module.exports.PATCH_STATUS = PATCH_STATUS
+module.exports.getPatchStatus = getPatchStatus
+module.exports.getContentForPatch = getContentForPatch

package/src/tasks/script/EnhancedScript.spec.js

@@ -24,7 +24,7 @@ describe('tasks/script/EnhancedScript', () => {
             key: 'unittest_defined_parameter',
             value: 'VALUE'
         },
-    ], 'NX', {}, 'unittest', console);
+    ], 'NX', {}, 'unittest', { log: () => {} });
 
         const anyMissing = enhancedScript.findMissingMatchesInJSX();
         expect(anyMissing).true;
@@ -94,7 +94,7 @@ describe('tasks/script/EnhancedScript', () => {
                     }
                 ]
             }
-        ], 'NX', {}, 'unittest', console);
+        ], 'NX', {}, 'unittest', { log: () => {} });
 
         const anyMissing = enhancedScript.findMissingMatchesInJSX();
         expect(anyMissing).false;

package/test/unit-patch.js

@@ -0,0 +1,66 @@
+const fs = require('fs')
+const assert = require('assert').strict;
+const patch = require('../src/helpers/patch')
+
+describe('helpers/patch', function() {
+    // mock the after effects binary path
+    let mockSettings = { logger: { log: () => {} }, trackSync: () => {}, track: () => {} }
+    let mockBinaryDir = __dirname + '/patch-test'
+    let mockBinaryPath = mockBinaryDir + '/After Effects 2022'
+    let mockBinaryFile = mockBinaryPath + '/aerender'
+    let mockBinaryScript = mockBinaryPath + '/Scripts/Startup/commandLineRenderer.jsx'
+    let mockBackupDir = mockBinaryPath + '/Backup.Scripts/Startup/'
+    let mockBinaryPatched = mockBackupDir + 'commandLineRenderer.jsx'
+
+    // prepare after effects binary directory
+    fs.mkdirSync(mockBinaryDir, { recursive: true })
+    fs.mkdirSync(mockBinaryPath, { recursive: true })
+    fs.mkdirSync(mockBinaryPath + '/Scripts', { recursive: true })
+    fs.mkdirSync(mockBinaryPath + '/Scripts/Startup', { recursive: true })
+    fs.writeFileSync(mockBinaryFile, 'binary')
+    fs.writeFileSync(mockBinaryScript, 'original')
+
+    it('should choose the correct patched content for different AE versions', function(done) {
+        assert(patch.getContentForPatch('2022/bin').indexOf('in_mfr_enable') !== -1)
+        assert(patch.getContentForPatch('2021/bin').indexOf('in_mfr_enable') === -1)
+        done()
+    })
+
+    it('should correctly return NOT_PATCHED', function(done) {
+        assert.strictEqual(patch.getPatchStatus(mockBinaryFile), patch.PATCH_STATUS.NOT_PATCHED)
+        done()
+    })
+
+    it('should apply the patch correctly', function(done) {
+        patch({ binary: mockBinaryFile, ...mockSettings })
+        assert.strictEqual(patch.getPatchStatus(mockBinaryFile), patch.PATCH_STATUS.PATCHED)
+        assert.strictEqual(fs.readFileSync(mockBinaryScript, 'utf8').indexOf('nexrender-patch-v') !== -1, true)
+        // check backup exists
+        assert.strictEqual(fs.existsSync(mockBinaryPatched), true)
+        assert.strictEqual(fs.readFileSync(mockBinaryPatched, 'utf8').indexOf('nexrender-patch-v') === -1, true)
+        done()
+    })
+
+    it('should correctly return PATCHED', function(done) {
+        assert.strictEqual(patch.getPatchStatus(mockBinaryFile), patch.PATCH_STATUS.PATCHED)
+        done()
+    })
+
+    it('should correctly return OUTDATED', function(done) {
+        fs.writeFileSync(mockBinaryScript, 'nexrender-patch-v0.0.0\n' + fs.readFileSync(mockBinaryScript, 'utf8'))
+        assert.strictEqual(patch.getPatchStatus(mockBinaryFile), patch.PATCH_STATUS.OUTDATED)
+        done()
+    })
+
+    // Cleanup after tests
+    after(function() {
+        // Remove created files and directories
+        fs.unlinkSync(mockBinaryScript)
+        fs.unlinkSync(mockBinaryFile)
+        fs.rmdirSync(mockBinaryPath + '/Scripts/Startup', { recursive: true })
+        fs.rmdirSync(mockBinaryPath + '/Scripts', { recursive: true })
+        fs.rmdirSync(mockBinaryPath, { recursive: true })
+        fs.rmdirSync(mockBinaryDir, { recursive: true })
+
+    })
+});

package/test.js

@@ -0,0 +1 @@
+require('./test/unit-patch')