Release version 2

Changes:
* Added Postman v9.x.x support
* Simplified usage [pass one argument to postman folder instead of requester.js or app.asar]
* Simplified patching process
* Added -v flag to enable verbose output
* Updated dependencies

Author: 3omar-mostafa

.github/workflows/postman.yml

@@ -9,7 +9,7 @@ on:
     inputs:
       version:
         default: "latest"
-        description: "Postman Version, accepted values: ['latest', 'version/8.x.x']"
+        description: "Postman Version, accepted values: ['latest', 'version/8.x.x', 'version/9.x.x']"
         required: true
 
 
@@ -43,7 +43,7 @@ jobs:
 
       - uses: actions/setup-node@v2
         with:
-          node-version: '14'
+          node-version: '16'
 
       - name : "Install aria2 downloader" 
         run: sudo apt update && sudo apt install aria2
@@ -70,33 +70,24 @@ jobs:
           echo "VERSION=${version}" >> $GITHUB_ENV
           rm -v ${file}
         
-      - name : "Find requester.js/app.asar file" 
+      - name : "Check if app.asar file is found" 
         run: |
-          path=$(grep -R --text 'getWorkingInScratchpadBanner' $PWD/Postman* | cut -d':' -f1 | uniq | egrep 'requester|app.asar')
+          path=$(grep -R --text 'getWorkingInScratchpadBanner' $PWD/Postman* | cut -d':' -f1 | uniq | grep 'app.asar')
           
-          if [[ "${path}" == *requester.js ]]; then
-            echo "requester.js path: ${path}"
-            echo "REQUESTER_JS=${path}" >> $GITHUB_ENV
-          else
+          if [[ "${path}" == *app.asar ]]; then
             echo "app.asar path: ${path}"
-            echo "APP_ASAR=${path}" >> $GITHUB_ENV
+          else
+            echo "No app.asar file"
+            echo "NO_APP_ASAR=True" >> $GITHUB_ENV
           fi
           
-          
-      - name : "Fix Scratch Pad Banner [requester.js]" 
-        if: ${{ env.REQUESTER_JS }}
+      - name : "Fix Scratch Pad Banner" 
         run: |
           npm install
-          node fix.js -r ${{ env.REQUESTER_JS }}
-      
-      - name : "Fix Scratch Pad Banner [app.asar]" 
-        if: ${{ env.APP_ASAR }}
-        run: |
-          npm install
-          node fix.js -a ${{ env.APP_ASAR }}
-      
-      - name : "Postman Cleanup [requester.js]" 
-        if: ${{ env.REQUESTER_JS }}
+          node fix.js -p ./Postman* -v
+ 
+      - name : "Postman Cleanup" 
+        if: ${{ env.NO_APP_ASAR }}
         continue-on-error: true
         run: |
           curl -sf 'https://gobinaries.com/tj/node-prune' | sudo sh
@@ -109,11 +100,11 @@ jobs:
           
       - name : "Calculate Checksum" 
         run: |
-          echo -e "\nChecksum - ${{ matrix.os_name }}\n" >> checksum
-          echo -n "SHA1: " >> checksum
-          sha1sum Postman*.tar.xz >> checksum
-          echo -n "SHA256: " >> checksum
-          sha256sum Postman*.tar.xz >> checksum
+          echo -e "\nChecksum - ${{ matrix.os_name }}\n" | tee -a checksum
+          echo -n "SHA1: " | tee -a checksum
+          sha1sum Postman*.tar.xz | tee -a checksum
+          echo -n "SHA256: " | tee -a checksum
+          sha256sum Postman*.tar.xz | tee -a checksum
 
       - name: Release Files
         uses: softprops/action-gh-release@v1

README.md

@@ -1,5 +1,5 @@
 # Postman Scratchpad Banner Fix
-### Remove Scratchpad Banner from Postman 8.x.x
+### Remove Scratchpad Banner from Postman 8.x.x and 9.x.x
 
 # Description
 Starting from [Postman](https://www.postman.com/) v8, working locally in scratchpad mode introduces this annoying banner which can't be disabled completely.
@@ -8,69 +8,32 @@ Starting from [Postman](https://www.postman.com/) v8, working locally in scratch
 
 Therefore, I've created this repo to solve the problem, I've patched postman files to disable the scratchpad banner
 
-Tested on Postman versions from *`8.1.0`* to *`8.10.0`*
+Tested on Postman versions from *`8.1.0`* to *`9.3.1`*
 
 # Install
 * Install [node.js](https://nodejs.org/en/download/)
 * Clone this repo `git clone https://github.com/3omar-mostafa/Postman-Scratchpad-Banner-Fix.git`
 * `cd Postman-Scratchpad-Banner-Fix`
 * Run ***`npm install`*** to install dependencies
 
-# Linux
 # Usage
 ## Patch your already installed postman
-Run ***`node fix.js -r ${requester_js}`*** , where ***`${requester_js}`*** is Postman file (***`requester.js`***) which renders scratchpad banner
-
-### requester.js path:
-It can be found on path like this: ***`${Postman_install_dir}/resources/app/js/requester.js`***
+Run ***`node fix.js -p ${postman_dir}`*** , where ***`${postman_dir}`*** is Postman installation directory
 
 ## Download patched postman
-You can find downloads for linux and macos at [Releases](https://github.com/3omar-mostafa/Postman-Scratchpad-Banner-Fix/releases)
-
-# MacOS
-# Usage
-## Patch your already installed postman
-
-* For Postman version `8.0.0` to `8.10.0`
-  * Run ***`node fix.js -r ${requester_js}`*** , where ***`${requester_js}`*** is Postman file (***`requester.js`***) which renders scratchpad banner
-  * ***`${requester_js}`*** can be found on path like this: ***`${Postman_install_dir}/Contents/Resources/app/js/requester.js`***
-
-* For Postman version `8.11.0` or above
-  * Run ***`node fix.js -a ${app_asar}`*** , where ***`${app_asar}`*** is Postman file (***`app.asar`***) which is like a `tar` archive and contains most of postman's files 
-  * ***`${app_asar}`*** can be found on path like this: ***`${Postman_install_dir}/Contents/Resources/app.asar`***
-  * You can learn more about *`asar`* file format [from here](https://github.com/electron/asar).
-
-## Download patched postman
-You can find downloads for linux and macos at [Releases](https://github.com/3omar-mostafa/Postman-Scratchpad-Banner-Fix/releases)
-
-# Windows
-# Usage
-## Patch your already installed postman
-Run ***`node fix.js -a ${app_asar}`*** , where ***`${app_asar}`*** is Postman file (***`app.asar`***) which is like a `tar` archive and contains most of postman's files 
-
-### app.asar path:
-It can be found on path like this: ***`%localappdata%\Postman\app-8.10.0\resources\app.asar`***
-
-You can learn more about *`asar`* file format [from here](https://github.com/electron/asar).
-
-## Download patched postman
-Windows is not included because its installer is *`exe`* file which I can extract and patch the files, but unfortunately I can not re-create the same installer, but you can still patch you existing installation
+* You can find downloads for Linux and MacOS at [Releases](https://github.com/3omar-mostafa/Postman-Scratchpad-Banner-Fix/releases)
+* Windows is not included because its installer is *`exe`* file which I can extract and patch the files, but unfortunately I can not re-create the same installer, but you can still patch you existing installation
 
 # Methodology and Manual Patching
-The file which is responsible for displaying scratchpad banner is ***`requester.js`***
+* There are some files which are responsible for displaying scratchpad banner as ***`requester.js`*** and ***`scratchpad.js`*** in newer versions
+* These files contains ***`getWorkingInScratchpadBanner`*** , ***`getScratchpadBannerMode`*** functions and  ***`SHOW_BANNER_IN_SCRATCHPAD`*** flag
 
-I've made three changes to the file (they are redundant and any one of them is enough, but made three for more reliability)
+I've made changes to these files
 
 * ***`getWorkingInScratchpadBanner`***
     * Modified this function to automatically close the scratchpad banner instead of creating it, using ***`this.closeBanner()`*** function call
 
-* ***`SHOW_BANNER_IN_SCRATCHPAD`***
-    * Modified this constant to equal ***`HIDE_SCRATCHPAD_BANNER`*** instead
-
-* ***`_constants_ScratchpadConstants__WEBPACK_IMPORTED_MODULE_8__["SHOW_BANNER_IN_SCRATCHPAD"]`***
-    * Modified this object to return ***`HIDE_SCRATCHPAD_BANNER`*** instead
-
-If you are on windows/macos, you can use [asar](https://github.com/electron/asar#command-line-utility) to extract ***`app.asar`*** and modify ***`requester.js`*** then repack it again
+If you are on windows/macos, you may find no code in Postman installation directory, instead you may find ***`app.asar`*** file (which is like a tar archive file) and you can use [asar](https://github.com/electron/asar#command-line-utility) to extract ***`app.asar`*** and modify the files then repack it again
 
 # Notes
 This repo use github actions to automate checking for new releases every month, also can run manually for custom version

fix.js

@@ -6,9 +6,28 @@ let os = require('os')
 let esprima = require('esprima');
 let colors = require('chalk'); // print colored text into console
 let asar = require('asar');
+let replace = require("replace");
 let { args } = require('./parse_args');
 let { findNestedObject, replaceRangeInString, printDebug } = require("./utils");
 
+/**
+ * Get Relevant Files to process, these files are javascript files containing `getWorkingInScratchpadBanner` function,
+ * or asar archives
+ * @param postmanDirectory Postman Directory to search in
+ * @returns Array of strings containing found file paths
+ */
+function getRelevantFilePaths(postmanDirectory) {
+  let searchResults = replace({
+    regex: "getWorkingInScratchpadBanner",
+    include: "*.js,app.asar",
+    exclude: "*CommonLazyChunk.js", // This file causes parsing errors and has no effect on showing/hiding scratchpad
+    paths: [postmanDirectory],
+    recursive: true,
+    silent: true,
+  });
+  return searchResults.map(obj => obj.path);
+}
+
 
 function injectCode(rawFileData, searchQuery, replaceString) {
   // We need to reparse the data after each manipulation because we have changed their position
@@ -23,6 +42,8 @@ function injectCode(rawFileData, searchQuery, replaceString) {
 
 
 async function fixPostmanScratchpadBanner(requester_js_path) {
+  console.log(colors.yellow(`[INFO] Processing ${requester_js_path}`));
+  try {
 
     let data = String(await fs.readFileSync(requester_js_path));
 
@@ -36,48 +57,45 @@ async function fixPostmanScratchpadBanner(requester_js_path) {
 
     data = injectCode(data, getWorkingInScratchpadBanner.query, getWorkingInScratchpadBanner.replaceString);
 
-    let RETURN_SHOW_BANNER_IN_SCRATCHPAD = {
-      query: {
-        type: 'ReturnStatement',
-        argument: { type: 'Identifier', name: 'SHOW_BANNER_IN_SCRATCHPAD' }
-      },
-      replaceString: "return HIDE_SCRATCHPAD_BANNER;"
-    };
-
-    data = injectCode(data, RETURN_SHOW_BANNER_IN_SCRATCHPAD.query, RETURN_SHOW_BANNER_IN_SCRATCHPAD.replaceString);
-
-    let CONST_SHOW_BANNER_IN_SCRATCHPAD = {
-      query: {
-        type: 'VariableDeclarator',
-        id: { type: 'Identifier', name: 'SHOW_BANNER_IN_SCRATCHPAD' }
-      },
-      replaceString: "SHOW_BANNER_IN_SCRATCHPAD = HIDE_SCRATCHPAD_BANNER;"
-    };
-
-    data = injectCode(data, CONST_SHOW_BANNER_IN_SCRATCHPAD.query, CONST_SHOW_BANNER_IN_SCRATCHPAD.replaceString);
-
-    console.log(colors.yellow(`[INFO] Saving the file into ${requester_js_path}`))
+    console.log(colors.yellow(`[INFO] Saving the file into ${requester_js_path}`));
     await fs.writeFileSync(requester_js_path, data);
 
+  } catch (e) {
+    if (args.verbose) {
+      console.log(colors.red(`------------------------------------------------`));
+      console.log(colors.red(`[ERROR] Error Processing ${requester_js_path}`));
+      console.log(colors.red(`[ERROR] ${e.stack}`));
+      console.log(colors.red(`------------------------------------------------`));
+    }
+  }
+
+  console.log(colors.yellow(`------------------------------------------------`));
 }
 
+
+// Main function
 (async function () {
 
-    if (args.app_asar) {
-      let tmpDir = path.join(os.tmpdir(), "postman_app.asar_extracted");
-      asar.extractAll(args.app_asar, tmpDir);
-      console.log(colors.yellow(`[INFO] Extracted ${args.app_asar} into ${tmpDir}`));
-      let requester_js = path.join(tmpDir, 'js', 'requester.js');
+    let postmanDirectory = args.postman_dir;
 
-      await fixPostmanScratchpadBanner(requester_js);
+    for (let filepath of getRelevantFilePaths(postmanDirectory)) {
+      if (filepath.toLowerCase().endsWith("app.asar")) {
+        let app_asar = filepath;
+        let tmpDir = path.join(os.tmpdir(), "postman_app.asar_extracted");
+        asar.extractAll(app_asar, tmpDir);
+        console.log(colors.yellow(`[INFO] Extracted ${app_asar} into ${tmpDir}`));
 
-      await asar.createPackage(tmpDir, args.app_asar);
-      console.log(colors.yellow(`[INFO] Archived ${tmpDir} back into ${args.app_asar}`));
-      await fs.rmSync(tmpDir, { recursive: true });
+        for (let filepath of getRelevantFilePaths(tmpDir)) {
+          await fixPostmanScratchpadBanner(filepath);
+        }
 
-    } else {
-      await fixPostmanScratchpadBanner(args.requester_js);
-    }
+        await asar.createPackage(tmpDir, app_asar);
+        console.log(colors.yellow(`[INFO] Archived ${tmpDir} back into ${app_asar}`));
+        await fs.rmSync(tmpDir, { recursive: true });
 
+      } else {
+        await fixPostmanScratchpadBanner(filepath);
+      }
+    }
   }
 )()