@mcpher/gas-fakes 1.1.7 → 1.2.0

package/README.md

@@ -12,7 +12,7 @@ You can get the package from npm:
 npm i @mcpher/gas-fakes
 ```
 
-For a complete guide on how to set up your local environment for authentication and development, please see the consolidated guide: [Getting Started with `gas-fakes`](gas-fakes/GETTING_STARTED.md)
+For a complete guide on how to set up your local environment for authentication and development, please see the consolidated guide: [Getting Started with `gas-fakes`](GETTING_STARTED.md)
 
 Collaborators should fork the repo and use the local versions of these files - see collaborators info.
 

package/package.json

@@ -4,6 +4,7 @@
   },
   "dependencies": {
     "@mcpher/fake-gasenum": "^1.0.2",
+    "@mcpher/gas-flex-cache": "^1.1.0",
     "@sindresorhus/is": "^7.0.1",
     "archiver": "^7.0.1",
     "exceljs": "^4.4.0",
@@ -25,47 +26,47 @@
   },
   "type": "module",
   "scripts": {
-    "test": "node  ./test/test.js",
-    "testdrive": "node  ./test/testdrive.js execute",
-    "testsheetsdatavalidations": "node  ./test/testsheetsdatavalidations.js execute",
-    "testsheetspermissions": "node  ./test/testsheetspermissions.js execute",
-    "testsheetsvalues": "node  ./test/testsheetsvalues.js execute",
-    "testsheets": "node  ./test/testsheets.js execute",
-    "testfetch": "node  ./test/testfetch.js execute",
-    "testsession": "node  ./test/testsession.js execute",
-    "testutilities": "node  ./test/testutilities.js execute",
-    "teststores": "node  ./test/teststores.js execute",
-    "testscriptapp": "node ./test/testscriptapp.js execute",
-    "testfiddler": "node ./test/testfiddler.js execute",
-    "testenums": "node ./test/testenums.js execute",
-    "testsheetssets": "node ./test/testsheetssets.js execute",
-    "testsheetsvui": "node ./test/testsheetsvui.js execute",
-    "testsheetsdeveloper": "node ./test/testsheetsdeveloper.js execute",
-    "testsheetsexotics": "node ./test/testsheetsexotics.js execute",
-    "testsheetsdata": "node ./test/testsheetsdata.js execute",
-    "testdocsadv": "node ./test/testdocsadv.js execute",
-    "testslidesadv": "node ./test/testslidesadv.js execute",
-    "testform": "node ./test/testform.js execute",
-    "testformsadv": "node ./test/testformsadv.js execute",
-    "testdocs": "node ./test/testdocs.js execute",
-    "testslides": "node ./test/testslides.js execute",
-    "testdocsnext": "node ./test/testdocsnext.js execute",
-    "testsheetstext": "node ./test/testsheetstext.js execute",
-    "testsheetsrange": "node ./test/testsheetsrange.js execute",
-    "testdocslistitems": "node ./test/testdocslistitems.js execute",
-    "testdocsall": "node ./test/testdocsall.js",
-    "testdocsheaders": "node ./test/testdocsheaders.js execute",
-    "testdocsfooters": "node ./test/testdocsfooters.js execute",
-    "testdocsfootnotes": "node ./test/testdocsfootnotes.js execute",
-    "testdocsimages": "node ./test/testdocsimages.js execute",
-    "testdocsstyles": "node ./test/testdocsstyles.js execute",
+    "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",
+    "testsheetspermissions": "node --env-file=./.env ./test/testsheetspermissions.js execute",
+    "testsheetsvalues": "node --env-file=./.env ./test/testsheetsvalues.js execute",
+    "testsheets": "node --env-file=./.env ./test/testsheets.js execute",
+    "testfetch": "node --env-file=./.env ./test/testfetch.js execute",
+    "testsession": "node --env-file=./.env ./test/testsession.js execute",
+    "testutilities": "node --env-file=./.env ./test/testutilities.js execute",
+    "teststores": "node --env-file=./.env ./test/teststores.js execute",
+    "testscriptapp": "node --env-file=./.env ./test/testscriptapp.js execute",
+    "testfiddler": "node --env-file=./.env ./test/testfiddler.js execute",
+    "testenums": "node --env-file=./.env ./test/testenums.js execute",
+    "testsheetssets": "node --env-file=./.env ./test/testsheetssets.js execute",
+    "testsheetsvui": "node --env-file=./.env ./test/testsheetsvui.js execute",
+    "testsheetsdeveloper": "node --env-file=./.env ./test/testsheetsdeveloper.js execute",
+    "testsheetsexotics": "node --env-file=./.env ./test/testsheetsexotics.js execute",
+    "testsheetsdata": "node --env-file=./.env ./test/testsheetsdata.js execute",
+    "testdocsadv": "node --env-file=./.env ./test/testdocsadv.js execute",
+    "testslidesadv": "node --env-file=./.env ./test/testslidesadv.js execute",
+    "testform": "node --env-file=./.env ./test/testform.js execute",
+    "testformsadv": "node --env-file=./.env ./test/testformsadv.js execute",
+    "testdocs": "node --env-file=./.env ./test/testdocs.js execute",
+    "testslides": "node --env-file=./.env ./test/testslides.js execute",
+    "testdocsnext": "node --env-file=./.env ./test/testdocsnext.js execute",
+    "testsheetstext": "node --env-file=./.env ./test/testsheetstext.js execute",
+    "testsheetsrange": "node --env-file=./.env ./test/testsheetsrange.js execute",
+    "testdocslistitems": "node --env-file=./.env ./test/testdocslistitems.js execute",
+    "testdocsall": "node --env-file=./.env ./test/testdocsall.js",
+    "testdocsheaders": "node --env-file=./.env ./test/testdocsheaders.js execute",
+    "testdocsfooters": "node --env-file=./.env ./test/testdocsfooters.js execute",
+    "testdocsfootnotes": "node --env-file=./.env ./test/testdocsfootnotes.js execute",
+    "testdocsimages": "node --env-file=./.env ./test/testdocsimages.js execute",
+    "testdocsstyles": "node --env-file=./.env ./test/testdocsstyles.js execute",
     "testsandbox": "node --trace-warnings ./test/testsandbox.js execute",
-    "testgmail": "node ./test/testgmail.js execute",
-    "testlogger": "node ./test/testlogger.js execute",
+    "testgmail": "node --env-file=./.env ./test/testgmail.js execute",
+    "testlogger": "node --env-file=./.env ./test/testlogger.js execute",
     "pub": "npm publish --access public"
   },
   "name": "@mcpher/gas-fakes",
-  "version": "1.1.7",
+  "version": "1.2.0",
   "license": "MIT",
   "main": "main.js",
   "description": "A proof of concept implementation of Apps Script Environment on Node",

package/src/index.js

@@ -5,7 +5,6 @@ import './services/logger/app.js'
 import './services/urlfetchapp/app.js'
 import './services/utilities/app.js'
 import './services/spreadsheetapp/app.js'
-import './services/stores/app.js'
 import './services/gmailapp/app.js'
 import './services/session/app.js'
 import './services/advdrive/app.js'
@@ -17,4 +16,5 @@ import './services/documentapp/app.js'
 import './services/advforms/app.js'
 import './services/formapp/app.js'
 import './services/slidesapp/app.js'
-ScriptApp.isFake
+// should be last
+import './services/stores/app.js'

package/src/services/scriptapp/app.js

@@ -8,6 +8,7 @@ import { Syncit } from '../../support/syncit.js'
 import { Auth } from '../../support/auth.js'
 import { Proxies } from '../../support/proxies.js'
 import { newFakeBehavior } from './behavior.js'
+import { newCacheDropin } from '@mcpher/gas-flex-cache'
 /**
  * fake ScriptApp.getOAuthToken 
  * @return {string} token
@@ -126,6 +127,7 @@ if (typeof globalThis[name] === typeof undefined) {
           FULL: 'FULL'
         },
         __behavior: newFakeBehavior(),
+        __newCacheDropin: newCacheDropin
       }
 
 

package/src/services/stores/fakestores.js

@@ -1,11 +1,46 @@
 import { Proxies } from '../../support/proxies.js'
 import { Syncit } from '../../support/syncit.js'
 import { Auth } from '../../support/auth.js'
+import { Utils } from '../../support/utils.js'
+import { storeModels } from './gasflex.js'
+import { newCacheDropin } from '@mcpher/gas-flex-cache'
+import { notYetImplemented } from '../../support/helpers.js'
+import { file } from 'googleapis/build/src/apis/file/index.js'
+const { is } = Utils
 
+/**
+ * what these props mean
+ * store_type = currently upstash or file - it defines the back end and maps to env variable
+ * service_kind = cache or property 
+ * store_domain = script, document, user
+ */
+/**
+ * domains of store supported
+ * @enum {string}
+ */
+const StoreDomain = Object.freeze({
+  SCRIPT: 'SCRIPT',
+  USER: 'USER',
+  DOCUMENT: 'DOCUMENT'
+})
 
 /**
- * caching support uses node files storage
+ * kinds of store service supported
+ * @enum {string}
  */
+const ServiceKind = Object.freeze({
+  PROPERTIES: 'PROPERTY',
+  CACHE: 'CACHE'
+})
+
+
+/**
+ * types of store supported 
+ */
+const StoreType = Object.freeze({
+  UPSTASH: 'UPSTASH',
+  FILE: 'FILE'
+})
 
 /**
  * default expiration of cache in seconds
@@ -38,78 +73,92 @@ const normExpiry = (secs) => {
  */
 const fixun = (value) => typeof value === typeof undefined ? null : value
 
-/**
- * types of store supported
- * @enum {string}
- */
-const StoreType = Object.freeze({
-  SCRIPT: 'SCRIPT',
-  USER: 'USER',
-  DOCUMENT: 'DOCUMENT'
-})
 
-/**
- * kinds of store service supported
- * @enum {string}
- */
-export const ServiceKind = Object.freeze({
-  PROPERTIES: 'PROPERTIES',
-  CACHE: 'CACHE'
-})
-
-/**
- * check store type is valid
- * @param {StoreType} type 
- * @returns {StoreType}
- */
-const checkStoreType = (type) => {
-  if (!Reflect.has(StoreType, type)) {
-    throw new Error(`invalid store type ${type}`)
+const validateProp = (prop, vob, name = '') => {
+  // this will return the actual value of the enum, not the property name
+  prop = prop.toUpperCase(prop)
+  if (!Reflect.has(vob, prop)) {
+    throw new Error(`invalid ${name} property ${prop}`)
   }
-  return type
+  return vob[prop]
 }
 
 
-/**
- * check store kind is valid
- * @param {ServiceKind} kind  
- * @returns {ServiceKind}
- */
-const checkServiceKind = (kind) => {
-  if (!ServiceKind[kind]) {
-    throw new Error(`invalid store kind ${kind}`)
+
+// this checks to see if we want to override a service with gas-flex-cache
+const whichCache = () => {
+  // this will return the actual value of the enum, not the property name
+  const type = validateProp (process.env.STORE_TYPE || "file", StoreType, 'store_type')
+  if (type === StoreType.UPSTASH) {
+    const url = process.env.UPSTASH_REDIS_REST_URL
+    const token = process.env.UPSTASH_REDIS_REST_TOKEN
+    if (!is.nonEmptyString(token)) throw new Error('UPSTASH_REDIS_REST_TOKEN not found or invalid in .env file')
+    if (!is.nonEmptyString(url)) throw new Error('UPSTASH_REDIS_REST_URL not found or invalid in .env file')
+    return {
+      url,
+      token,
+      type
+    }
+  }
+  return {
+    type
   }
-  return kind
 }
+
 /**
  * create a new FakeService instance
  * @param {ServiceKind} kind of service
  * @returns {FakePropertiesService || FakeCacheService}
  */
 export const newFakeService = (kind) => {
-  checkServiceKind(kind)
-  return Proxies.guard(kind === ServiceKind.CACHE ? new FakeCacheService() : new FakePropertiesService())
+  kind = validateProp (kind, ServiceKind, 'service_kind')
+  const w = whichCache ()
+  console.log (`...${kind} store service is using store type ${w.type} as backend`)
+  return Proxies.guard(kind === ServiceKind.CACHE ? new FakeCacheService(w.type) : new FakePropertiesService(w.type))
 }
 
+const selectCache = (domain, kind, defaultExpirationSeconds) => {
+  // actually we might be overriding the type of service
+  domain = validateProp (domain, StoreDomain, 'store_domain')
+  const which = whichCache()
+  if (which.type === "UPSTASH") {
+    const model = storeModels[domain]
+    if (!model) {
+      throw new Error(`invalid store type model for ${cacheType}`) 
+    }
+    return newCacheDropin ({ creds: {
+      ...model,
+      ...which,
+      type: "upstash",
+      kind: kind.toLowerCase(),
+      defaultExpirationSeconds
+    }})
+  } else if (which.type === StoreType.FILE) {
+    const store = kind === ServiceKind.CACHE ? FakeCache : FakeProperties
+    return Proxies.guard(new store(domain))
+  } else {
+    throw new Error(`invalid store type ${which.type} found in .env file`)
+  }
+}
 
 /**
  * @class FakePropertiesService
  */
 class FakePropertiesService {
-  constructor() {
-    this.kind = StoreType.PROPERTIES
-
+  constructor(type) {
+    this.kind = ServiceKind.PROPERTIES
+    this.type = type
   }
   getDocumentProperties() {
     // apps script needs a bound document to use this store
     if (!Auth.getDocumentId()) return null
-    return Proxies.guard(new FakeProperties(StoreType.DOCUMENT))
+    return selectCache(StoreDomain.DOCUMENT, this.kind)
   }
   getUserProperties() {
-    return Proxies.guard(new FakeProperties(StoreType.USER))
+    return selectCache(StoreDomain.USER, this.kind)
   }
   getScriptProperties() {
-    return Proxies.guard(new FakeProperties(StoreType.SCRIPT))
+     return selectCache(StoreDomain.SCRIPT, this.kind)
   }
 }
 
@@ -117,19 +166,20 @@ class FakePropertiesService {
  * @class FakePropertiesService
  */
 class FakeCacheService {
-  constructor() {
-    this.kind = StoreType.CACHE
+  constructor(type) {
+    this.kind =  ServiceKind.CACHE
+    this.type = type
   }
   getDocumentCache() {
     // apps script needs a bound document to use this store
     if (!Auth.getDocumentId()) return null
-    return Proxies.guard(new FakeCache(StoreType.DOCUMENT))
+    return selectCache(StoreDomain.DOCUMENT, this.kind, DEFAULT_CACHE_EXPIRY)
   }
   getUserCache() {
-    return Proxies.guard(new FakeCache(StoreType.USER))
+    return selectCache(StoreDomain.USER, this.kind,DEFAULT_CACHE_EXPIRY)
   }
   getScriptCache() {
-    return Proxies.guard(new FakeCache(StoreType.SCRIPT))
+     return selectCache(StoreDomain.SCRIPT, this.kind, DEFAULT_CACHE_EXPIRY)
   }
 }
 
@@ -140,32 +190,32 @@ class FakeCacheService {
 class FakeStore {
   /**
    * @constructor
-   * @param {StoreType} type 
+   * @param {string} domain 
    */
-  constructor(type) {
-    checkStoreType(type)
-    this._type = type
+  constructor(domain) {
+    domain = validateProp(domain, StoreDomain, 'store_domain')
+    this._domain = domain
   }
 
   /**
-   * @returns {StoreType}
+   * @returns {string}
    */
-  get type() {
-    return this._type
+  get domain() {
+    return this._domain
   }
 
   getFileName(kind) {
 
-    const t = this.type.substring(0, 1).toLowerCase()
+    const d = this.domain.substring(0, 1).toLowerCase()
     const k = kind.substring(0, 1).toLowerCase()
     const scriptId = Auth.getScriptId()
     const documentId = Auth.getDocumentId()
 
-    let fileName = `${k}${t}-${scriptId}`
-    if (this.type === StoreType.USER) {
+    let fileName = `${k}${d}-${scriptId}`
+    if (this.domain === StoreDomain.USER) {
       fileName += `-${Auth.getHashedUserId()}`
     }
-    else if (this.type === StoreType.DOCUMENT && documentId) {
+    else if (this.domain === StoreDomain.DOCUMENT && documentId) {
       fileName += `-${documentId}`
     }
 
@@ -182,20 +232,20 @@ class FakeStore {
 class FakeProperties extends FakeStore {
   /**
    * @constructor
-   * @param {StoreType} type 
+   * @param {string} domain 
    */
-  constructor(type) {
-    super(type)
-    this._storeArgs =  {
+  constructor(domain) {
+    super(domain)
+    this._storeArgs = {
       inMemory: false,
-      fileName: this.getFileName (ServiceKind.PROPERTIES),
-      storeDir:  Auth.getPropertiesPath()
+      fileName: this.getFileName(ServiceKind.PROPERTIES).toLowerCase(),
+      storeDir: Auth.getPropertiesPath()
     }
   }
 
 
   deleteAllProperties() {
-
+    return notYetImplemented('....try using gas-flex-cache store instead')
   }
   /**
    * delete the entry associated with the given key
@@ -207,10 +257,10 @@ class FakeProperties extends FakeStore {
     return this
   }
   getKeys() {
-
+    return notYetImplemented('....try using gas-flex-cache store instead')
   }
   getProperties() {
-
+    return notYetImplemented('....try using gas-flex-cache store instead')
   }
   /**
    * get a value from prop store
@@ -220,10 +270,10 @@ class FakeProperties extends FakeStore {
   getProperty(key) {
     return fixun(Syncit.fxStore(this._storeArgs, "get", key))
 
-    
+
   }
   setProperties(properties, deleteAllOthers) {
-
+    return notYetImplemented('....try using gas-flex-cache store instead')
   }
   /**
    * set the entry associated with the given key
@@ -239,16 +289,16 @@ class FakeProperties extends FakeStore {
 }
 
 class FakeCache extends FakeStore {
-  constructor(type) {
-    super(type)
-    this._storeArgs =  {
+  constructor(domain) {
+    super(domain)
+    this._storeArgs = {
       inMemory: false,
-      fileName: this.getFileName (ServiceKind.CACHE),
-      storeDir:  Auth.getCachePath()
+      fileName: this.getFileName(ServiceKind.CACHE).toLowerCase(),
+      storeDir: Auth.getCachePath()
     }
   }
   getAll(keys) {
-
+    return notYetImplemented('....try using gas-flex-cache store instead')
   }
 
   /**
@@ -264,7 +314,7 @@ class FakeCache extends FakeStore {
   }
 
   putAll(values, expirationInSeconds) {
-
+    return notYetImplemented('....try using gas-flex-cache store instead')
   }
 
   /**
@@ -278,12 +328,10 @@ class FakeCache extends FakeStore {
   }
 
   removeAll(keys) {
-
+    return notYetImplemented('....try using gas-flex-cache store instead')
   }
   get(key) {
     return fixun(Syncit.fxStore(this._storeArgs, "get", key))
   }
 
 }
-
-

package/src/services/stores/gasflex.js

@@ -0,0 +1,16 @@
+import {Auth} from '../../support/auth.js'
+// these are the default models to match live apps script
+export const storeModels = {
+    SCRIPT: {
+        scriptId: ScriptApp.getScriptId()
+    },
+    USER: {
+        scriptId: ScriptApp.getScriptId(),
+        userId: Session.getEffectiveUser().getEmail()
+    },
+    DOCUMENT: {
+        scriptId: ScriptApp.getScriptId(),
+        documentId: Auth.getDocumentId
+    }
+}
+