@suitegeezus/suitecloud-stacker 25.2.128 → 25.2.129

package/README.md

@@ -1,62 +1,12 @@
 Contains helpers for SDF (Node CLI edition)
 
 # Features
-- Collection of pre-configured hooks (commands) to manage ACS problems withing customer account
+- Collection of pre-configured hooks (commands) to manage customer accounts
 - Collection of pre-configured hooks to manage the outer project
 - Pre-defined handlers that you can pick and choose from for a given "command"
 - Types for SDF commands
 - command line enhancements
 
-Missing: Collection of hooks to manage an entire instance -- Cuz we (ACS) don't do this but if you have your own instance / demo account then feel free to create your own suitecloud.config file and use the stackable structure.  Note that most customers don't really do this either -- they often have outside devs who contribute at least sometimes
-
-# Demos
-
-## `account:setup:ci` : Token Auth Memory
-Setup token auth for an account from existing token auths that you have with detection for conflicts and valid naming
-![example](./img/accountsetupci.example1.gif)
-
-## `project:create`: New Account
-Create project to work on a case
-![example](./img/projectcreate.example1.gif)
-
-## `project:create`: New Case on Account
-![example](./img/projectcreate.example2.gif)
-
-## `file:upload`: Globbing that filters out irrelevant files
-![example](./img/fileupload.example1.gif)
-
-## `file:upload`: Upload all files from a deploy.xml file
-![example](./img/fileupload.example3.gif)
-
-## `file:upload`: Compile and / or run tests on files you are uploading
-![example](./img/fileupload.example4.gif)
-
-## `file:import`: Compare your current file with what is in the account
-![example](./img/fileimport.example3.gif)
-
-## `file:import`: Import files that match a glob pattern
-![example](./img/fileimport.example2.gif)
-
-## `file:import`: Import all files from a deploy.xml file
-```shell
-cd /SuiteScripts/ACS/casefolder
-suitecloud file:import --paths ./deploy/deploy.xml
-```
-
-## `object:import`: import objects that match a glob pattern
-![example](./img/objectimport.example1.gif)
-
-## `object:import`: import all objects that are listed in a chosen deploy.xml file
-![example](./img/objectimport.example2.gif)
-
-## `project:deploy`: Choose which project definition to deploy
-
-## `object:import`: Import Objects will organize them into folders by type automatically
-![example](./img/objectOrganization.png)
-
-## Compile and test typescript as you write
-![example](./img/nodemon.example1.gif);
-
 # How SDF works in this project
 
 SDF by default has a certain structure that makes the following (annoying?) assumptions: 
@@ -89,20 +39,10 @@ npm install -g nodemon
 4. Optional: Be able to sync repositories with ALM via OCNA
    - These are entitlements that will help you stay on the latest version of this repo and use customer repos
    - If you can't then you can still use this for your testdrive accounts -- just ask me how
-5. Optional: define `oraclegit` in your ssh **config**  (highly recommended)
-```txt
-HOST oraclegit
-   User gerald.gillespie@fullscript.com
-   HostName alm.oraclecorp.com
-   TCPKeepAlive yes
-   AddKeysToAgent yes
-   UseKeyChain yes
-   IdentityFile ~/.ssh/ed25519ggoracle2
-```
-6. Optional: Create an environment variable for DIFF_TOOL
+5Optional: Create an environment variable for SUITECLOUD_DIFF_TOOL
 ```shell
-#➜  nsaccounts git:(main) ✗ set | grep 'DIFF'
-export DIFF_TOOL='/Applications/./IntelliJ\ IDEA.app/Contents/MacOS/idea'
+#➜  set | grep 'DIFF'
+export SUITECLOUD_DIFF_TOOL='/Applications/./IntelliJ\ IDEA.app/Contents/MacOS/idea'
 ```
 
 ### NetSuite pre-requisites
@@ -112,13 +52,10 @@ You will need to have:
 - SuiteScript, etc enabled
     
 ## Install on Mac / Linux / Windows
-1. clone the repo (not the weird extra slash `:/` ALM needs)
-```shell
-git clone oraclegit:/nscs_suitecloud-stacker_114170/suitecloud-stacker-root.git
-```
-2. Run npm install
+
+Run npm install
 ```shell
-npm install
+npm install @suitegeezus/suitecloud-stacker
 ```
 
 # Usage: Hello World Example
@@ -128,29 +65,8 @@ npm install
 
 
 
-## Pre-Defined Stacks for the Common scenario
-- Collection of hooks meant for ACP subprojects (e.g. a specific case/ project)
-```js
-const safeCommands = require('suitecloud-stacker/safeCommands.js');
-module.exports = {
-            ...projectJson,
-            commands: {...safeCommands.caseCommands},
-        },
-        {debug: false, block: false},
-        module
-    
-```
-
-### Spin up a new SDF project for a case 
-You can use this command to create your own case
-```bash
-cd ~/code/projectRoot
-suitecloud project:create
-# follow-the prompts
-```
-
 ## Stackable / chaining structure for SDF command hooks
-This means your suitecloud.config.js can specify or replace commands something like this:
+This means your sdf.config.js can specify or replace commands something like this:
 
 ```js
 const commands = {
@@ -175,33 +91,29 @@ Also, don't bother with the IDE plugins. not only do they have their own limitat
 
 This has the following usage
 
-### `--authid`
-supports a format like this `2452352:wut` where the value before the `:` is the authid and the value after the colon is the folder name.
-
-if you only specify the first part without any colon then the same value is used for both. i.e. `2452352` is equivalent to `2452352:2452352`
-
-you can create this anywhere.  Wherever you create it you should invoke it from there. 
-e.g. 
-```bash
-cd FileCabinet/SuiteScripts/folder
-suitecloud 
-```
 
 ## working directory
-native `suitecloud` must be called from a directory that has a `suitecloud.config.js` file. 
+`sdf` must be called from a directory that has a `sdf.config.js` file. 
 
-As such if you setup a project using native command and run it then it will work because that process will create a `suitecloud.config.js`. 
+As such if you setup a project using native command and run it then it will work because that process will create a `sdf.config.js`. 
 
-It is recommended that you set your `suitecloud.config.js` file to be the following: 
+It is recommended that you set your `sdf.config.js` file to be the following: 
 
 ```js
-const sdfAcs = require('./sdf/safeCommands'); 
+const safeCommands = require('@suitegeezus/suitecloud-stacker/safeCommands'); 
 
 // create the commands that you want
 const commands = {};
 
-// pass them through the sdfAcs layer
-module.exports = sdfAcs.makeSuiteCloudConfig({commands});
+// pass them through the stacker
+safeCommands.makeSafeExports(
+        {
+           defaultProjectFolder: 'src',
+           commands: stackerCommands,
+        },
+        {debug: false, block: false, autoCreateProjectJson: false,},
+        module
+);
 ```
 
 # Errors 
@@ -223,20 +135,18 @@ This should also be true of objects.
 
 We can use SDF for both code (suitescripts) and objects. 
 
-Regardless of how many sandboxen the customer has...
-Regardless of what weird branching strategies they might have... or don't have.
-Regardless of whether we are writing code for the customer's use or writing code the helps us create the solution for the customer...
-Regardless of how many cases are concurrently being worked on for a customer...
-When we write code or create objects it is hella convenient and powerful to have both under source control and to use merging strategies that support the work we are doing for the customer. 
+Regardless of how many sandboxen you have...
+Regardless of what weird branching strategies you might have... or don't have.
+When we write code or create objects it is hella convenient and powerful to have both under source control and to use merging strategies that support the work we are doing... 
 
-In all of the above you can have a real "customer" or it could simply be a concept "customer" 
+In all of the above you can be end-user or a partner
 
-So we have one folder for a customer. 
+So we have one folder for an account. 
 
-If a customer has multiple sandboxes then we probably have multiple branches but it doesn't matter.  Our "master" branch is not the customer's master branch. It is our statement that this code is production worthy and ready to be vetted.  
+If you have sandboxes then we probably have multiple branches, but it doesn't matter.  A "master" branch is our statement that this code is production worthy and ready to be vetted.  
 
 ## But I don't want my customer to be a sub-folder in this project!
 You don't have to. 
-There is nothing stopping you in git from (in fact it supports) having a subfolder be for a different repository. That repository can have different users.  ESS member Bob can have a different set of accounts from Raffi and they can share any overlapping number of them.  But when they want to collaborate on something in source control related to an account they can `pull` from a common view and still work independantly on separate branches and yet have full visibility into the other work. 
+There is nothing stopping you in git from (in fact it supports) having a subfolder be for a different repository.
 
 Further, the ability to `pull` from source control does not mean that you will be able to `file:deploy` to the customer account. You still need to have an authenticated token to do that. And that probably means you'll need to have login privileges to the customer's account (production, sandbox or whatever). 

package/commands/accountManageauth.d.ts

@@ -75,6 +75,7 @@ type BetterAccountList = {
  */
 export declare const fetchAccountList: () => Promise<BetterAccountList[]>;
 export declare const betterList: () => SdfCommand;
+export declare const getEnvironment: (authid: string) => Promise<"PRODUCTION" | "SANDBOX" | "RELEASE_PREVIEW" | "TESTDRIVE" | "UNKNOWN">;
 /**
  * @description - Prompts for account choice. This provides both verification and literal choice. If the choice does not match the current
  * context then an error is forced -- this is because SDF does not recognize a change in the account after launching.

package/commands/accountManageauth.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateList = exports.promptForAccountChoice = exports.betterList = exports.fetchAccountList = exports.saveList = void 0;
+exports.validateList = exports.promptForAccountChoice = exports.getEnvironment = exports.betterList = exports.fetchAccountList = exports.saveList = void 0;
 const pathHelpers = require("../lib/pathHelpers");
 const promptHelpers_1 = require("../lib/promptHelpers");
 const projectJsonHelpers = require("../lib/projectJsonHelpers");
@@ -102,6 +102,26 @@ const betterList = () => {
     };
 };
 exports.betterList = betterList;
+const getEnvironment = async (authid) => {
+    const list = await (0, exports.fetchAccountList)();
+    const match = list.find((item) => (item.authid === authid));
+    const companyId = match?.accountInfo?.companyId;
+    switch (true) {
+        case typeof companyId === 'undefined':
+            return 'UNKNOWN';
+        case /^td/.test(companyId):
+            return 'TESTDRIVE';
+        case /^\d+$/.test(companyId):
+            return 'PRODUCTION';
+        case /_SB\d+$/.test(companyId):
+            return 'SANDBOX';
+        case /_RP\d*$/.test(companyId):
+            return 'RELEASE_PREVIEW';
+        default:
+            return 'UNKNOWN';
+    }
+};
+exports.getEnvironment = getEnvironment;
 /**
  * @description - Prompts for account choice. This provides both verification and literal choice. If the choice does not match the current
  * context then an error is forced -- this is because SDF does not recognize a change in the account after launching.
@@ -112,9 +132,9 @@ const promptForAccountChoice = () => {
     return {
         _origin: origin,
         beforeExecuting: async (options) => {
+            process.stdout.write((0, promptHelpers_1.goColor)('HIGHLIGHT', '\n', options));
             if (options?.arguments?.runhooks === 'quiet')
                 return options;
-            process.stdout.write((0, promptHelpers_1.goColor)('HIGHLIGHT', '\n', options));
             if (!Reflect.has({ ...options?.arguments }, 'authid')) {
                 throw onErrorHelper.makeError(origin, new Error(`${options.command} is missing authid. Perhaps you should not stack ${origin} here`));
             }

package/commands/fileImport.js

@@ -82,14 +82,12 @@ const downloadForDiff = () => {
                 const tempLocations = [];
                 const auths = [options.authId, secondAuth].filter(Boolean);
                 // the temp import can happen all at once
-                await auths.reduce(async (linkedPromises, auth) => {
-                    await linkedPromises;
+                await Promise.all(auths.map(async (auth) => {
                     const rootFolder = auth;
                     tempLocations.push(await (0, pathHelpers_1.makeTempDirForSdf)({ root: rootFolder }));
                     const childArgs = [
                         '--paths', ...candidates,
                         '--calledfromcomparefiles',
-                        '--runhooks none',
                         '--excludeproperties',
                         '--project', rootFolder,
                         // run with noconfig to disconnect from existing project
@@ -113,8 +111,7 @@ const downloadForDiff = () => {
                     if (errorCode !== 0)
                         process.exit(errorCode);
                     // the file location is the
-                    return linkedPromises;
-                }, Promise.resolve(true));
+                }));
                 let diffTool = process.env.SUITECLOUD_DIFF_TOOL;
                 {
                     // console.log(process.env);
@@ -133,8 +130,10 @@ const downloadForDiff = () => {
                         return (0, pathHelpers_1.joinPaths)(location, 'FileCabinet', file);
                     }).filter(Boolean).map((f) => `"${f}"`);
                 });
-                await diffCombos.reduce(async (linked, combo) => {
-                    await linked;
+                await diffCombos.reduce(async (linked, combo, currentIndex) => {
+                    const keepGoing = await linked;
+                    if (!keepGoing)
+                        return keepGoing;
                     const diffChildProc = cp.spawn(diffTool, ['diff', ...combo], {
                         detached: true, // Allows the child to run independently
                         stdio: 'inherit',
@@ -155,25 +154,29 @@ const downloadForDiff = () => {
                     await diffPromise;
                     diffChildProc.unref();
                     const toGet = combo.pop();
+                    // do not prompt when in quiet mode
+                    const choices = {
+                        'Y': 'Yes',
+                        'N': 'No - skip this one',
+                        'OOPS': `No, stop diffing and refuse all remaining ${diffCombos.length - currentIndex} choices`
+                    };
+                    let answer = choices['N'];
                     if (toGet) {
-                        const fixedToGet = toGet.replace(/^.*(.\bSuiteScripts.*)$/, '$1');
-                        // do not prompt when in quiet mode
-                        const choices = { 'Y': 'Yes', 'N': 'No' };
-                        let answer = choices['N'];
+                        const fixedToGet = toGet.replace(/^.*(.\bSuiteScripts.*?)"*$/, '"$1"');
                         options.arguments.paths = [];
                         if (!isQuiet) {
                             answer = await (0, promptHelpers_1.promptChoices)({
                                 choices,
                                 displayChoices: choices,
-                                premessage: fixedToGet,
-                                question: 'Would you like to continue with the import?',
+                                premessage: `${currentIndex} of ${diffCombos.length}\nInclude: ${fixedToGet}?`,
+                                question: 'Would you like to include this file ?',
                                 default: choices['N'],
                             });
                         }
                         if (answer === choices['Y'])
                             options.arguments.paths.push(fixedToGet);
                     }
-                    return linked;
+                    return answer !== choices['OOPS'];
                 }, Promise.resolve(true));
             }
             catch (e) {

package/commands/fileUpload.d.ts

@@ -49,4 +49,6 @@ export declare const compileFilesPrompt: () => SdfCommand;
  * @description - calls jest for the files involved
  * ⚠️ - make sure paths are fixed first
  */
-export declare const testFilesPrompt: () => SdfCommand;
+export declare const testFilesPrompt: (opts?: {
+    nameOfOptionsFlag: "runjest" | string;
+}) => SdfCommand;

package/commands/fileUpload.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.testFilesPrompt = exports.compileFilesPrompt = exports.fixFileUploadPaths = exports.confirmFileList = exports.getFilesFromDeployXml = exports.promptForPath = void 0;
 const nodePath = require("node:path");
+const accountManageauth_1 = require("./accountManageauth");
 const errorHelper = require("../lib/onErrorHelper");
 const compileHelper = require("../lib/compileHelper");
 const promptHelpers = require("../lib/promptHelpers");
@@ -285,7 +286,7 @@ exports.compileFilesPrompt = compileFilesPrompt;
  * @description - calls jest for the files involved
  * ⚠️ - make sure paths are fixed first
  */
-const testFilesPrompt = () => {
+const testFilesPrompt = (opts) => {
     const origin = 'testFilesPrompt';
     let command;
     return {
@@ -293,48 +294,68 @@ const testFilesPrompt = () => {
         isStackable: true,
         beforeExecuting: async (options) => {
             command = options.command || 'unknown';
-            const choices = { 'Y': 'Yes', 'N': 'No' };
-            // remove the "N" choice for prod
-            if (options._isProd)
-                delete choices['N'];
-            let answer;
-            if (spawnSuitecloud.isChildProcess() || options.arguments.runhooks === 'quiet') {
-                answer = choices['Y'];
-            }
-            else {
-                answer = await promptHelpers.promptChoices({
-                    choices: choices,
-                    displayChoices: choices,
-                    premessage: options._isProd ? 'This is PROD' : '',
-                    question: `Would you like to run relatedTests?`,
-                    default: choices['Y']
-                });
-            }
-            if (answer === choices['N'])
-                return options;
-            // make sure paths are correct for jest
-            const didTheyPass = await compileHelper.runJestTest(options.arguments.paths.map((p) => {
+            const jestFlag = opts?.nameOfOptionsFlag || 'runjest';
+            const isQuiet = options.arguments.runhooks === 'quiet';
+            const environment = await (0, accountManageauth_1.getEnvironment)(options.arguments.authid);
+            const forceYes = (options.arguments.customoptions || []).includes(jestFlag);
+            const longTest = !spawnSuitecloud.isChildProcess() && options.arguments.runhooks !== 'quiet';
+            const statesToConsider = ['go'];
+            const filesToTest = options.arguments.paths.map((p) => {
                 return nodePath.join(options.projectPath.replace(/^(.*)(.\bFileCabinet\b.\bSuiteScripts\b.*)?$/, '$1/FileCabinet'), p.replace(/^.*FileCabinet/, ''));
-            }), Boolean(!options._isProd))
-                .then(() => true)
-                .catch((e) => {
-                // TODO turn this on
-                // if (options._isProd) throw errorHelper.makeError(origin,new Error('Tests must exist AND pass for PROD ' + options.command));
-                return false;
             });
-            if (didTheyPass)
+            const allGood = await statesToConsider.reduce(async (bailPromise, state) => {
+                const bail = await bailPromise;
+                const choices = { 'Y': 'Yes', 'N': 'No' };
+                // remove the "N" choice for prod
+                if (environment === 'PRODUCTION')
+                    delete choices['N'];
+                let answer;
+                switch (true) {
+                    case (spawnSuitecloud.isChildProcess()):
+                    case forceYes:
+                        answer = choices['Y'];
+                        break;
+                    case !isQuiet:
+                        answer = await promptHelpers.promptChoices({
+                            choices: choices,
+                            displayChoices: choices,
+                            premessage: `This is ${environment} (${options.arguments.authid})`,
+                            question: `Would you like to run relatedTests?`,
+                            default: choices['Y']
+                        });
+                        break;
+                    case environment === 'PRODUCTION':
+                        answer = choices['Y'];
+                        break;
+                    default:
+                        answer = choices['N'];
+                        break;
+                }
+                if (answer === choices['N'])
+                    return Promise.resolve(true);
+                // make sure paths are correct for jest
+                const didTheyPass = await compileHelper.runJestTest(filesToTest, environment !== 'PRODUCTION' && !forceYes, bail)
+                    .then(() => true)
+                    .catch((e) => {
+                    if (environment === 'PRODUCTION')
+                        throw errorHelper.makeError(origin, new Error('Tests must exist AND pass for PROD ' + options.command));
+                    return false;
+                });
+                return Promise.resolve(didTheyPass);
+            }, Promise.resolve(true));
+            if (allGood)
                 return options;
             if (!spawnSuitecloud.isChildProcess() && options.arguments.runhooks !== 'quiet') {
                 // remove the "N" choice for prod
-                const choices2 = { 'Y': 'Yes' };
+                const choices2 = { 'UPLOAD_ANYWAY': 'Yes' };
                 const answer2 = await promptHelpers.promptChoices({
                     choices: { ...choices2, 'N': 'No' },
                     displayChoices: choices2,
-                    premessage: options._isProd ? 'This is PROD' : '',
-                    question: `Tests failed. Would you like to upload anyway?`,
+                    premessage: options._isProd ? `This is PROD ${options.authId}` : options.authId,
+                    question: `Tests failed. Would you like to upload to ${options.authId} anyway? (You must spell it out)`,
                     default: null,
                 });
-                if (answer2 === 'Yes')
+                if (answer2 === 'UPLOAD_ANYWAY')
                     return options;
                 throw errorHelper.makeError(origin, new Error('User Chose to Quit'));
             }

package/lib/compileHelper.d.ts

@@ -40,5 +40,6 @@ export declare const getAllTestFiles: () => Promise<string[]>;
  * @description - we might be running tests OR we might be testing files
  * @param {string[]} jsFilesToTest - Get the list of files from a dryrun
  * @param {boolean} allowMissing - whether to require tests or not
+ * @param {boolean} bail - bail after one failure
  */
-export declare const runJestTest: (jsFilesToTest: string[], allowMissing?: boolean) => Promise<number>;
+export declare const runJestTest: (jsFilesToTest: string[], allowMissing?: boolean, bail?: boolean) => Promise<number>;

package/lib/compileHelper.js

@@ -142,8 +142,9 @@ exports.getAllTestFiles = getAllTestFiles;
  * @description - we might be running tests OR we might be testing files
  * @param {string[]} jsFilesToTest - Get the list of files from a dryrun
  * @param {boolean} allowMissing - whether to require tests or not
+ * @param {boolean} bail - bail after one failure
  */
-const runJestTest = async (jsFilesToTest, allowMissing) => {
+const runJestTest = async (jsFilesToTest, allowMissing, bail) => {
     const jsOnly = jsFilesToTest.filter((js) => /\.js$/.test(js));
     if (jsOnly.length === 0)
         return 0;
@@ -153,21 +154,19 @@ const runJestTest = async (jsFilesToTest, allowMissing) => {
         // if the list are just files
         jestArgs.push('--findRelatedTests');
         jestArgs.push(...jsOnly);
-        if (allowMissing)
-            jestArgs.push('--passWithNoTests');
-    }
-    else {
-        if (allowMissing)
-            jestArgs.push('--passWithNoTests');
-        // jestArgs.push('./**/*.js');
-        // the list is test.js files
     }
+    if (allowMissing)
+        jestArgs.push('--passWithNoTests');
+    // jestArgs.push('./**/*.js');
+    // the list is test.js files
+    if (bail)
+        jestArgs.push('--bail');
     process.stdout.write(promptHelpers.goColor('WARN', '\nRunning tests', jestArgs, '\n'));
     const p = process;
     return new Promise((ok, no) => {
         const jest = cp.spawn('npx', ['jest',
             //'--showConfig'
-            ...jestArgs
+            ...jestArgs,
         ], {
             cwd: process.cwd(),
             // combination of getting all the data without tripping up the parent error state

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suitegeezus/suitecloud-stacker",
-  "version": "25.2.128",
+  "version": "25.2.129",
   "description": "SuiteCloud Stacker",
   "main": "safeCommands.js",
   "scripts": {

package/templates/customizations.projectroot.d.ts

@@ -4,7 +4,7 @@
 /**
  * @file {1}
  * - only use this once per account
- * - this is auto-generated file based on a search of the account.  See ESS query runner
+ * - this is auto-generated file based on a search of the account.
  * @author Gerald Gillespie <gerald.gillespie@fullscript.com>
  */