@mcpher/gas-fakes 1.2.3 → 1.2.5

package/README.md

@@ -20,6 +20,16 @@ Collaborators should fork the repo and use the local versions of these files - s
 
 Just as on Apps Script, everything is executed synchronously so you don't need to bother with handling Promises/async/await. Just write normal Apps Script code. Usually you would have an associated App Script project if that's your eventual target, but it's not essential that you do. You can get started right away on Node. 
 
+# gas-fakes-cli
+
+Now you can run apps script code directly from your console - for example 
+
+```bash
+gas-fakes  -s "const files=DriveApp.getRootFolder().searchFiles('title contains \"Untitled\"');while (files.hasNext()) {console.log(files.next().getName())};" 
+```
+
+For details see [gas fakes cli](gas-fakes-cli.md)
+
 ### Settings
 
 The optional `gasfakes.json` file holds various location and behavior parameters for your local Node environment. It is not required on GAS, as you can't change anything over there. If you don't provide this file, `gas-fakes` will create one for you with sensible defaults.
@@ -134,12 +144,12 @@ There are a couple of syntactical differences between Node and Apps Script. Not
 // this required on Node but not on Apps Script
 if (ScriptApp.isFake) testFakes()
 ````
-For inspiration on pushing modified files to the IDE, see the togas.sh bash script I use for the test suite. 
+For inspiration on pushing modified files to the IDE, see the togas.sh bash script I use for the test suite. There's also a complete push pull workflow available - see - [push test pull](pull-test-push.md)
+
 
 ## Help
 
 As I mentioned earlier, to take this further, I'm going to need a lot of help to extend the methods and services supported - so if you feel this would be useful to you, and would like to collaborate, please ping me on bruce@mcpher.com and we'll talk.
-
 ## <img src="./logo.png" alt="gas-fakes logo" width="50" align="top">  Further Reading
 
 - [getting started](GETTING_STARTED.md) - how to handle authentication for restricted scopes.
@@ -158,3 +168,5 @@ As I mentioned earlier, to take this further, I'm going to need a lot of help to
 - [sandbox](sandbox.md)
 - [named range identity](named-range-identity.md)
 - [adc and restricted scopes](https://ramblings.mcpher.com/how-to-allow-access-to-sensitive-scopes-with-application-default-credentials/)
+- [push test pull](pull-test-push.md)
+- [gas fakes cli](gas-fakes-cli.md)

package/gas-fakes.js

@@ -0,0 +1,213 @@
+#!/usr/bin/env node
+
+/**
+ * cli for gas-fakes
+ * v0.0.1
+ */
+import fs from "fs";
+import { Command } from "commander";
+import dotenv from 'dotenv'
+
+const version = "0.0.2";
+
+const program = new Command();
+
+program
+  .name("gas-fakes")
+  .description("CLI tool for gas-fakes")
+  .version(version, "-v, --version", "display the current version");
+
+
+program
+  .description("Execute Google Apps Script using gas-fakes.")
+  .option(
+    "-f, --filename <string>",
+    "filename of the file including Google Apps Script. When this is used, the option --script is ignored."
+  )
+  .option(
+    "-e, --env <path>",
+    "provide path to your .env file for special options."
+  )
+  .option(
+    "-g, --gfsettings <path>",
+    "provide path to your gasfakes.json file for script options."
+  )
+  .option(
+    "-s, --script <string>",
+    "provide Google Apps Script as a string. When this is used, the option --filename is ignored."
+  )
+  .option("-x, --sandbox", "run Google Apps Script in a sandbox.")
+  .option(
+    "-w, --whitelist <string>",
+    "whitelist of file IDs. Set the file IDs in comma-separated list. In this case, the files of the file IDs are used for both read and write. When this is used, the script is run in a sandbox."
+  )
+  .option(
+    "-j, --json <string>",
+    `JSON string including parameters for managing a sandbox. Enclose it with ' or ". When this is used, the option --whitelist is ignored. When this is used, the script is run in a sandbox.`
+  )
+  .option(
+    "-d, --display",
+    `display the created script for executing with gas-fakes. Default is false.`,
+    false
+  )
+  .action((options) => {
+    if (Object.keys(options).length == 0) {
+      program.help();
+    } else {
+      const { filename, script, sandbox, whitelist, json, display, env , gfsettings} = options;
+      const obj = { sandbox: !!sandbox, display };
+      if (!filename && !script) {
+        console.error(
+          "error: Provide the filename or the script of Google Apps Script."
+        );
+        process.exit();
+      }
+      if (gfsettings) {
+        obj.gfSettings= gfsettings
+      }
+      if (env) {
+        dotenv.config({ path: env })
+      }
+      if (filename) {
+        obj.filename = filename;
+      }
+      if (script) {
+        obj.script = script;
+      }
+
+      // for sandbox
+      if (whitelist) {
+        const ar = whitelist.split(",").map((e) => e.trim());
+        if (ar.length > 0) {
+          obj.whitelistItems = ar;
+        }
+      }
+      if (json) {
+        try {
+          const temp = JSON.parse(json);
+          obj.json_sandbox = temp;
+        } catch (err) {
+          console.error("error: Invalid JSON.");
+          process.exit();
+        }
+      }
+      loadScript(obj);
+    }
+  });
+
+program.showHelpAfterError("(add --help for additional information)");
+program.parse();
+
+function __getImportScript(o) {
+  const { scriptText, sandbox, whitelistItems, json_sandbox, gfSettings } = o;
+  if (scriptText.trim() == "") {
+    console.error("error: Google Apps Script was not found.");
+    process.exit();
+  }
+  const gasScriptAr = [];
+  if (json_sandbox) {
+    gasScriptAr.push(
+      `const behavior = ScriptApp.__behavior;`,
+      `behavior.sandboxMode = true;`,
+      `behavior.strictSandbox = true;`
+    );
+    const { whitelistItems, whitelistServices, blacklistServices } =
+      json_sandbox;
+    if (whitelistServices && whitelistServices.length > 0) {
+      const bl = whitelistServices.flatMap(({ className, methodNames }, i) => {
+        if (!className) {
+          console.error(
+            "error: Class name was not found in whitelistServices."
+          );
+          process.exit();
+        }
+        const k = `s${i + 1}`;
+        const temp = [`const ${k} = behavior.sandboxService.${className};`];
+        if (methodNames && methodNames.length > 0) {
+          temp.push(
+            `${k}.setMethodWhitelist([${methodNames.map((e) => `"${e}"`)}]);`
+          );
+        }
+        return temp;
+      });
+      gasScriptAr.push(...bl);
+    }
+    if (blacklistServices && blacklistServices.length > 0) {
+      const bl = blacklistServices.map(
+        (e) => `behavior.sandboxService.${e}.enabled = false;`
+      );
+      gasScriptAr.push(bl);
+    }
+    if (whitelistItems && whitelistItems.length > 0) {
+      const wl = whitelistItems
+        .map(({ itemId = "", read = true, write = false, trash = false }) => {
+          if (!itemId) {
+            console.error("error: itemId was not found in whitelistItems.");
+            process.exit();
+          }
+          return `behavior.newIdWhitelistItem("${itemId}").setRead(${read}).setWrite(${write}).setTrash(${trash})`;
+        })
+        .join(",");
+      gasScriptAr.push(`behavior.setIdWhitelist([${wl}]);`);
+    }
+    gasScriptAr.push(`\n\n${scriptText}\n\n`, `ScriptApp.__behavior.trash();`);
+  } else {
+    if (sandbox && (!whitelistItems || whitelistItems.length === 0)) {
+      gasScriptAr.push(
+        sandbox ? `ScriptApp.__behavior.sandBoxMode = true;` : "",
+        `\n\n${scriptText}\n\n`,
+        sandbox ? `ScriptApp.__behavior.trash();` : ""
+      );
+    } else if (whitelistItems && whitelistItems.length > 0) {
+      const wl = whitelistItems
+        .map((id) => `behavior.newIdWhitelistItem("${id}").setWrite(true)`)
+        .join(",");
+      gasScriptAr.push(
+        `const behavior = ScriptApp.__behavior;`,
+        `behavior.sandboxMode = true;`,
+        `behavior.strictSandbox = true;`,
+        `behavior.setIdWhitelist([${wl}]);`,
+        `\n\n${scriptText}\n\n`,
+        `ScriptApp.__behavior.trash();`
+      );
+    } else {
+      gasScriptAr.push(scriptText);
+    }
+  }
+  const importScriptAr = [
+    `async function runGas() {`,
+    // Pass the settings path to the init function if it's provided
+    gfSettings
+      ? `const settingsPath = "${gfSettings}";`
+      : `const settingsPath = undefined;`,
+    `await import("./main.js");`, // This will trigger the fxInit call
+    ...gasScriptAr,
+    `};`,
+    ``,
+    `runGas();`,
+  ];
+  return {
+    mainScript: importScriptAr.join("\n"),
+    gasScript: gasScriptAr.join("\n"),
+  };
+}
+
+async function loadScript(o) {
+  const { filename, script, display } = o;
+
+  const scriptText = filename ? fs.readFileSync(filename, "utf8") : script;
+  const { mainScript, gasScript } = __getImportScript({ scriptText, ...o });
+  if (display) {
+    console.log(`--- script ---`);
+    console.log(gasScript);
+    console.log(`--- /script ---`);
+  }
+  const gasFunc = new Function(mainScript);
+  // The script needs access to the settings path variable we just created
+  Object.defineProperty(globalThis, "settingsPath", {
+    value: o.gfSettings,
+    writable: true,
+    configurable: true,
+  });
+  gasFunc();
+}

package/gasfakes.json

@@ -1,7 +1,7 @@
 {
   "manifest": "./appsscript.json",
   "clasp": "./.clasp.json",
-  "scriptId": "80bcefe1-604f-4495-a82f-d4d8fab2b3df",
+  "scriptId": "7bcfb7cc-6200-4a7d-9f33-e1a3f3d19529",
   "documentId": null,
   "cache": "/tmp/gas-fakes/cache",
   "properties": "/tmp/gas-fakes/properties"

package/package.json

@@ -7,6 +7,8 @@
     "@mcpher/gas-flex-cache": "^1.1.2",
     "@sindresorhus/is": "^7.0.1",
     "archiver": "^7.0.1",
+    "commander": "^14.0.1",
+    "dotenv": "^17.2.3",
     "exceljs": "^4.4.0",
     "fast-json-stable-stringify": "^2.1.0",
     "get-stream": "^9.0.1",
@@ -26,7 +28,6 @@
   },
   "type": "module",
   "scripts": {
-
     "test": "node --env-file=./.env ./test/test.js",
     "testdrive": "node --env-file=./.env ./test/testdrive.js execute",
     "testsheetsdatavalidations": "node --env-file=./.env ./test/testsheetsdatavalidations.js execute",
@@ -74,10 +75,13 @@
   },
   "name": "@mcpher/gas-fakes",
   "author": "bruce mcpherson",
-  "version": "1.2.3",
+  "version": "1.2.5",
   "license": "MIT",
   "main": "main.js",
   "description": "A proof of concept implementation of Apps Script Environment on Node",
   "repository": "github:brucemcpherson/gas-fakes",
-  "homepage": "https://ramblings.mcpher.com/a-proof-of-concept-implementation-of-apps-script-environment-on-node/"
+  "homepage": "https://ramblings.mcpher.com/a-proof-of-concept-implementation-of-apps-script-environment-on-node/",
+  "bin": {
+    "gas-fakes": "cli/gas-fakes.js"
+  }
 }

package/src/services/driveapp/driveiterators.js

@@ -32,6 +32,9 @@ export const getFilesIterator = ({
   if (qob) {
     const regex = /(^|\s)title(\s*=\s*|\s+contains\s+|\s*!=\s*|\s*>\s*|\s*<\s*)/gi;
     qob = qob.map(f => {
+      if (!is.string(f)) {
+        throw new Error (`invalid parameters ${JSON.stringify(qob)}`)
+      }
       return f.replace(regex, (match, p1, p2) => {
         // p1 is the start-of-string or whitespace before 'title'
         // p2 is the operator and surrounding whitespace
@@ -39,7 +42,7 @@ export const getFilesIterator = ({
       });
     })
   }
-
+//qob = ["name contains 'Untitled' and '0AN2ExLh4POiZUk9PVA' in parents and mimeType != 'application/vnd.google-apps.folder'"]
   /**
    * this generator will get chunks of matching files from the drive api
    * and yield them 1 by 1 and handle paging if required
@@ -142,6 +145,7 @@ const fileLister = ({
 }) => {
   // enhance any already supplied query params
   qob = Utils.arrify(qob) || []
+  qob = [...qob]
   if (parentId) {
     ScriptApp.__behavior.isAccessible(parentId) // will throw if not accessible
     qob.push(`'${parentId}' in parents`)

package/src/services/spreadsheetapp/fakespreadsheetapp.js

@@ -109,8 +109,7 @@ export class FakeSpreadsheetApp {
     return "SpreadsheetApp";
   }
 
-  /**
-  }
+
   enableBigQueryExecution() {
     const { nargs, matchThrow } = signatureArgs(
       arguments,

package/src/support/sxauth.js

@@ -9,7 +9,7 @@ import got from 'got';
 import { Auth } from './auth.js';
 import { syncError, syncLog } from './workersync/synclogger.js';
 import { homedir } from 'os';
-import {access, readFile, writeFile, mkdir } from 'fs/promises';
+import { access, readFile, writeFile, mkdir } from 'fs/promises';
 import path from 'path'
 
 
@@ -47,10 +47,11 @@ export const sxInit = async ({ manifestPath, claspPath, settingsPath, mainDir, c
   }
 
   // files are relative to this main path
+
   const settingsFile = path.resolve(mainDir, settingsPath)
   const settingsDir = path.dirname(settingsFile)
 
-
+  // syncLog (JSON.stringify({mainDir,settingsPath,settingsDir,settingsFile}))
   // get the setting file if it exists
   const _settings = await getIfExists(path.resolve(mainDir, settingsFile))
   const settings = { ..._settings }
@@ -91,12 +92,27 @@ export const sxInit = async ({ manifestPath, claspPath, settingsPath, mainDir, c
   // Initialize auth. This is async and will discover the project ID.
   const auth = await Auth.setAuth(scopes);
   const projectId = Auth.getProjectId();
-  const accessToken = await auth.getAccessToken()
+  let accessToken = null
+
+  // need to handle an expired refresh token
+  try {
+    accessToken = await auth.getAccessToken()
+  } catch (error) {
+
+  }
   let tokenInfo = null
   try {
     tokenInfo = await got(`https://www.googleapis.com/oauth2/v3/tokeninfo?access_token=${accessToken}`).json()
   } catch (err) {
-    syncError (`failed to get access token info`)
+    syncError(`Application default credentials needs attention`)
+    if (error.code === 400 && error.message.includes('invalid_grant')) {
+      // Log a specific, actionable error for the developer/operator
+      syncError("ADC 'invalid_grant' Error: The underlying Application Default Credentials have expired or been revoked.");
+      syncError("Helpful note: in your admin console under security/access amd data control there are a couple of settings to fiddle with token life")
+      syncError("Use your settaccount.sh to reauthenticate");
+      throw new Error ('failed to get access token info : Use your settaccount.sh to reauthenticate')
+    }
+    throw error; // Re-throw any other errors
   }
 
   /// these all jst exist in this sub process so we need to send them back to parent process

package/src/support/syncit.js

@@ -22,7 +22,7 @@ import { callSync } from "./workersync/synchronizer.js";
 
 const manifestDefaultPath = "./appsscript.json";
 const claspDefaultPath = "./.clasp.json";
-const settingsDefaultPath = "./gasfakes.json";
+const settingsDefaultPath = "./gasfakes.json" || process.env.GF_SETTINGS_PATH;
 const propertiesDefaultPath = "/tmp/gas-fakes/properties";
 const cacheDefaultPath = "/tmp/gas-fakes/cache";
 // note that functions like Sheets.newGridRange() etc create objects that contain get and set functions
@@ -262,7 +262,7 @@ const fxUnzipper = ({ blob }) => {
 const fxInit = ({
   manifestPath = manifestDefaultPath,
   claspPath = claspDefaultPath,
-  settingsPath = settingsDefaultPath,
+  settingsPath = globalThis.settingsPath || settingsDefaultPath,
   cachePath = cacheDefaultPath,
   propertiesPath = propertiesDefaultPath,
 } = {}) => {