@pega/custom-dx-components 24.1.12 → 24.2.10

package/src/tasks/quarantine/index.js

@@ -0,0 +1,84 @@
+import fs from 'fs';
+import path, {join} from 'path';
+import inquirer from 'inquirer';
+import chalk from 'chalk';
+
+
+import {
+  showVersion,
+  addDebugLog,
+  getJestFunctionalTestList } from '../../util.js';
+
+import { JEST_TESTS_FUNCTIONAL_PATH } from '../../constants.js';
+
+
+export const quarnUnquarnTests = async(answers) => {
+  switch (answers.QuarUnQuar) {
+    case "Quarantine" :
+      await quarantineTests(answers);
+      break;
+    case "Unquarantine" :
+      await unquarantineTests(answers);
+      break;
+  }
+}
+
+
+
+export const quarantineTests = async(answers) => {
+  const testList = await getJestFunctionalTestList(answers.whichTests);
+  const functionalPath = join(path.resolve(), JEST_TESTS_FUNCTIONAL_PATH);
+
+  // rename .test to .notest
+  for (const testName of testList) {
+    const quarantineName = testName.replace(".test", ".notest");
+    fs.renameSync(join(functionalPath, testName), join(functionalPath, quarantineName));
+  }
+
+}
+
+export const unquarantineTests = async(answers) => {
+  const testList = await getJestFunctionalTestList(answers.whichTests);
+  const functionalPath = join(path.resolve(), JEST_TESTS_FUNCTIONAL_PATH);
+
+  // rename .test to .notest
+  for (const testName of testList) {
+    const restoreName = testName.replace(".notest", ".test");
+    fs.renameSync(join(functionalPath, testName), join(functionalPath, restoreName));
+  }
+
+}
+
+
+export default async options => {
+
+addDebugLog("quarantine", "", "+");
+
+  await showVersion();
+
+  const quaranAnswers = await inquirer.prompt([
+
+    {
+      name: 'QuarUnQuar',
+      type: 'rawlist',
+      message: `Quarantine or UnQuarantine tests`,
+      choices: ["Quarantine", "Unquarantine"],
+      default: 'Quarantine'
+
+    },
+    {
+      name: 'whichTests',
+      type: 'rawlist',
+      message: (answers) => `Which tests to ${answers.QuarUnQuar}`,
+      default: 'ALL',
+      choices: ["ALL", "Original", "Library"]
+    }
+  ]);
+
+  // await showCurrentStatus();
+  await quarnUnquarnTests(quaranAnswers);
+
+
+addDebugLog("quarantine", "END", "-");
+
+}

package/src/tasks/rename/index.js

@@ -7,7 +7,7 @@ import inquirer from 'inquirer';
 import ncp from 'ncp';
 import chalk from 'chalk';
 
-import { checkPathAccess, showVersion, getComponentsObj, getDirectoryFiles } from '../../util.js';
+import { checkPathAccess, showVersion, getComponentsObj, getDirectoryFiles, addDebugLog, checkLibraryAndArchives, getConfigDefaults, getLibraryBased } from '../../util.js';
 import { TASKS_CONFIG_JSON_FILENAME, COMPONENTS_DIRECTORY_PATH, COMPONENTS_PATH } from '../../constants.js';
 
 
@@ -21,7 +21,6 @@ import {
   convertIntoPascalCase,
   getComponentDirectoryPath,
   getPegaConfig,
-  getComponentDefaults,
   sanitize,
   validateSemver
 } from '../../util.js';
@@ -47,6 +46,8 @@ export const updateConfig = async (
   onlyCompanion = false
 ) => {
 
+addDebugLog("updateConfig", `oldComponentKey: ${oldComponentKey}, newComponentKey: ${newComponentKey}`, "");
+
   let configData = fs.readFileSync(join(targetDirectory, "/config.json"), { encoding: 'utf8' });
   configData = configData && JSON.parse(configData);
 
@@ -83,6 +84,8 @@ export const updateFile = async (
     targetDirectory,
 ) => {
 
+addDebugLog("updateFile", `fileName: ${fileName}, oldComponentKeyPC: ${oldComponentKeyPC}, newComponentKeyPC: ${newComponentKeyPC}, targetDirectory: ${targetDirectory}`, "");
+
   let fileData = fs.readFileSync(join(targetDirectory, "/", fileName), { encoding: 'utf8' });
 
   if (fileData.indexOf(oldComponentKeyPC) >= 0) {
@@ -109,6 +112,7 @@ export const renameComponent = async (
   onlyCompanion = false
 ) => {
 
+addDebugLog("renameComponent", `library: ${library}, organization: ${organization}, componentKey: ${componentKey}`, "");
 
   let pegaConfig = await getPegaConfig();
 
@@ -174,9 +178,13 @@ export const renameComponent = async (
 
 
 export default async options => {
-  showVersion();
+  await showVersion();
+  await checkLibraryAndArchives();
+
+addDebugLog("rename", "", "+");
 
   await checkPathAccess(pegaConfigJsonPath);
+  const isLibraryBased = getLibraryBased();
 
   let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
   data = data && JSON.parse(data);
@@ -193,7 +201,7 @@ export default async options => {
   const { library } = componentData;
   const { organization } = JSON.parse(fs.readFileSync(path.resolve('package.json'), 'utf8'));
 
-  let componentDefaults = await getComponentDefaults();
+  let componentDefaults = getConfigDefaults();
   componentDefaults.library = library;
 
   const localComponents = await getComponentsObj();
@@ -275,7 +283,8 @@ export default async options => {
             return true;
           }
           return 'Please provide value for organization';
-        }
+        },
+        when: () => !isLibraryBased
       },
       {
         name: 'version',
@@ -286,7 +295,8 @@ export default async options => {
             return true;
           }
           return 'Please provide semver compatible version e.g 0.0.1';
-        }
+        },
+        when: () => !isLibraryBased
       },
       {
         name: 'library',
@@ -302,12 +312,14 @@ export default async options => {
             return true;
           }
           return 'Only alphanumeric values are allowed, starting with alphabets';
-        }
+        },
+        when: () => !isLibraryBased
       },
       {
         name: 'allowedApplications',
         message: 'Please enter the application names to be supported (comma-separated). ',
-        suffix: 'Keep empty for all applications'
+        suffix: 'Keep empty for all applications',
+        when: () => !isLibraryBased
       },
       {
         name: 'description',
@@ -323,12 +335,22 @@ export default async options => {
         componentKey = paramComponentKey,
         componentName,
         componentLabel,
+        description,
+      } = answers;
+      let {
         organization,
         library,
         version,
-        description,
-        allowedApplications
-      } = answers;
+        allowedApplications } = answers;
+
+      if (isLibraryBased) {
+        // these answers come from defaults
+        const orgLib = getConfigDefaults();
+        library = orgLib.library;
+        version = orgLib.buildVersion;
+        organization = orgLib.organization;
+        allowedApplications = "";
+      }
 
       await renameComponent(
         {
@@ -347,6 +369,6 @@ export default async options => {
     });
   }
 
-
+addDebugLog("rename", "END", "-");
 
 };

package/src/tasks/rename-lib/index.js

@@ -0,0 +1,332 @@
+import path from 'path';
+import fs from 'fs';
+import { promisify } from 'util';
+import { join } from 'path';
+
+import inquirer from 'inquirer';
+import ncp from 'ncp';
+import chalk from 'chalk';
+
+import {
+  checkPathAccess,
+  showVersion,
+  getComponentsObj,
+  getDirectoryFiles,
+  getLibraryBased,
+  deleteLocalLibrary,
+  getC11NB2STokenAndStaticServer,
+  updateComponentDefaultLibrary,
+  updateDefaultOrganization,
+  addDebugLog,
+  checkLibraryAndArchives,
+  getConfigDefaults
+} from '../../util.js';
+import {
+  TASKS_CONFIG_JSON_FILENAME,
+  COMPONENTS_DIRECTORY_PATH,
+  COMPONENTS_PATH
+} from '../../constants.js';
+
+import { localBuildLibrary } from '@pega/custom-dx-components/src/tasks/build-lib/index.js';
+
+export const DXCB_CONFIG_INTERNAL_JSON_FILENAME = 'src/dxcb.config.json';
+const currentDirectory = process.cwd();
+const pegaConfigJsonPath = join(currentDirectory, TASKS_CONFIG_JSON_FILENAME);
+
+import {
+  convertIntoPascalCase,
+  getComponentDirectoryPath,
+  getComponents,
+  sanitize
+} from '../../util.js';
+
+const copy = promisify(ncp);
+
+
+export const updateConfig = async (
+  {
+    oldComponentKey,
+    newComponentKey,
+    library,
+    organization,
+    componentName,
+    componentLabel,
+    version,
+    description,
+    allowedApplications,
+    targetDirectory
+  },
+  options,
+  onlyCompanion = false
+) => {
+
+addDebugLog("updateConfig", "", "");
+
+  let configData = fs.readFileSync(join(targetDirectory, '/config.json'), { encoding: 'utf8' });
+  configData = configData && JSON.parse(configData);
+
+  configData.name = newComponentKey;
+  configData.label = componentLabel;
+  configData.organization = organization;
+  if (configData.componentKey) configData.componentKey = newComponentKey;
+  configData.library = library;
+  configData.version = version;
+  configData.description = description != '' ? description : componentLabel;
+
+  configData.allowedApplications = allowedApplications;
+
+  // stringify "4", makes the json string look like JSON in the file, formated instead of a single line
+  fs.writeFileSync(join(targetDirectory, '/config.json'), JSON.stringify(configData, null, 4), {
+    encoding: 'utf8',flag:'w'
+  });
+};
+
+export const updateFile = async (
+  fileName,
+  oldComponentKeyPC,
+  newComponentKeyPC,
+  targetDirectory
+) => {
+
+addDebugLog("updateFile", "", "");
+  let fileData = fs.readFileSync(join(targetDirectory, '/', fileName), { encoding: 'utf8' });
+
+  if (fileData.indexOf(oldComponentKeyPC) >= 0) {
+    fileData = fileData.replaceAll(oldComponentKeyPC, newComponentKeyPC);
+
+    fs.writeFileSync(join(targetDirectory, '/', fileName), fileData, { encoding: 'utf8',flag:'w' });
+  }
+};
+
+export const renameLibrary = async ({ library, organization }, options) => {
+addDebugLog("renameLibrary", `library: ${library}, organization: ${organization}`, "");
+  const compDef =  getConfigDefaults();
+  const currentOrganization = compDef.organization;
+  const currentLibrary = compDef.library;
+  const currentVersion = compDef.version;
+
+  let compVersion;
+
+  const tokenAndStaticServer = await getC11NB2STokenAndStaticServer();
+
+  if (tokenAndStaticServer.C11NB2S === undefined) {
+    console.log(
+      chalk.redBright(
+        'Need to authenticate, missing services token.\nBuilding a library requires authentication to acquire a token to build.'
+      )
+    );
+    process.exit(1);
+  }
+
+  const currentOrgLib = currentOrganization.concat('_').concat(currentLibrary);
+  const newOrgLib = organization.concat('_').concat(library);
+
+  // rename all the components
+  const components = await getComponents();
+
+  let wasDevBuild = false;
+
+  for (const index in components) {
+    const componentKey = components[index];
+    const componentName = componentKey.split('_')[2];
+    const currentDirectory = await getComponentDirectoryPath(componentKey);
+
+    let configData = fs.readFileSync(join(currentDirectory, '/config.json'), { encoding: 'utf8' });
+    configData = configData && JSON.parse(configData);
+
+    const componentLabel = configData.label;
+    const description = configData.description;
+    const version = configData.version;
+    compVersion = version;
+
+    // can only rename "devBuilds", so if version doesn't have "-dev", add it and will create dev version
+    if (compVersion && compVersion.indexOf('-dev') != -1) {
+      wasDevBuild = true;
+    }
+    const allowedApplications = configData.allowedApplications;
+
+    await renameComponent(
+      {
+        library,
+        organization,
+        componentKey,
+        componentName,
+        componentLabel,
+        version,
+        description,
+        allowedApplications
+      },
+      options
+    );
+  }
+
+  // delete and rebuild library
+  try {
+    await deleteLocalLibrary(currentOrgLib);
+  } catch (ex) {}
+
+  // update config
+  await updateComponentDefaultLibrary(library);
+  await updateDefaultOrganization(organization);
+
+  // call constellation-dx-components-build-utils build library, which will create a directory of the "buildLibName"
+  // with subdirectories for each version.
+  // If "buildDev", we append to version "-dev".  Currently, only "-dev" versions, when published, can be deleted.
+  if (newOrgLib && compVersion) {
+    await localBuildLibrary(organization, library, currentVersion, wasDevBuild);
+  }
+};
+
+export const renameComponent = async (
+  {
+    library,
+    organization,
+    componentKey,
+    componentName,
+    componentLabel,
+    version,
+    description,
+    allowedApplications
+  },
+  options,
+  onlyCompanion = false
+) => {
+
+addDebugLog("renameComponent", `library: ${library}, organization: ${organization}, componentKey: ${componentKey}`, "");
+
+  const newComponentKey = `${organization}_${library}_${componentName}`;
+
+  const oldComponentKey = componentKey;
+  const newComponentKeyPC = convertIntoPascalCase(newComponentKey);
+  const oldComponentKeyPC = convertIntoPascalCase(oldComponentKey);
+
+  const currentDirectory = await getComponentDirectoryPath(componentKey);
+  const targetDirectory = await getComponentDirectoryPath(newComponentKey);
+
+  // custom component
+  try {
+    fs.renameSync(currentDirectory, targetDirectory);
+  } catch (err) {
+    console.log(err);
+  }
+
+  const targetFileList = await getDirectoryFiles(targetDirectory);
+
+  for (var fileIndex in targetFileList) {
+    const fileName = targetFileList[fileIndex];
+
+    if (fileName === 'config.json') {
+      await updateConfig(
+        {
+          oldComponentKey,
+          newComponentKey,
+          componentName,
+          componentLabel,
+          library,
+          version,
+          description,
+          allowedApplications,
+          organization,
+          targetDirectory
+        },
+        options
+      );
+    } else {
+      await updateFile(fileName, oldComponentKeyPC, newComponentKeyPC, targetDirectory);
+    }
+  } // for
+
+  console.log(chalk.green(`Component ${oldComponentKey} renamed to ${newComponentKey}`));
+};
+
+export default async options => {
+  const isLibraryBased =  getLibraryBased();
+  if (!isLibraryBased) {
+    console.log(`Command only supported for ${chalk.bold.green('library mode')} components.`);
+    process.exit();
+  }
+
+  await showVersion();
+  await checkLibraryAndArchives();
+
+addDebugLog("renameLibrary", "", "+");
+
+  await checkPathAccess(pegaConfigJsonPath);
+
+  let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
+  data = data && JSON.parse(data);
+
+  if (!data[COMPONENTS_DIRECTORY_PATH]) {
+    console.error(
+      `${chalk.red.bold('ERROR')} Could not able find components directory path in config.json`
+    );
+    process.exit(1);
+  }
+
+  const componentData = data[COMPONENTS_PATH];
+
+  const { library } = componentData;
+  const { organization } = JSON.parse(fs.readFileSync(path.resolve('package.json'), 'utf8'));
+
+  let componentDefaults = getConfigDefaults();
+  componentDefaults.library = library;
+
+  const localComponents = await getComponentsObj();
+
+  if (options.params.length >= 5) {
+    const organization = options.params[3];
+    const library = options.params[4];
+
+    await renameLibrary(
+      {
+        library,
+        organization
+      },
+      options
+    );
+  } else {
+    const questions = [
+      {
+        name: 'organization',
+        message: 'Enter new component organization',
+        default: organization,
+        validate: value => {
+          if (value) {
+            return true;
+          }
+          return 'Please provide value for organization';
+        }
+      },
+      {
+        name: 'library',
+        message: 'Enter new library name',
+        default: componentDefaults.library,
+        validate: value => {
+          /* value should not be empty
+            It should not have spaces
+            It should not start with a number
+            Only case-insensitive alphanumeric values are allowed
+          */
+          if (value && !/^\d/.test(value) && value === sanitize(value)) {
+            return true;
+          }
+          return 'Only alphanumeric values are allowed, starting with alphabets';
+        }
+      }
+    ];
+
+    await inquirer.prompt(questions).then(async answers => {
+      const { organization, library } = answers;
+
+      await renameLibrary(
+        {
+          library,
+          organization
+        },
+        options
+      );
+    });
+  }
+
+addDebugLog("renameLibrary", "END", "-");
+};

package/src/tasks/restore-config/index.js

@@ -0,0 +1,56 @@
+import path from 'path';
+import fs from 'fs';
+import { promisify } from 'util';
+import { join } from 'path';
+
+import inquirer from 'inquirer';
+import ncp from 'ncp';
+import chalk from 'chalk';
+
+import { restoreTopLevelConfigFilesFromTemplate,
+         restoreDependenciesFromTemplate,
+         getLibraryBased,
+         showVersion,
+         addDebugLog
+        } from '../../util.js';
+
+
+
+
+export default async options => {
+addDebugLog("restoreConfig", "", "+");
+  const isLibraryBased =  getLibraryBased();
+  if (!isLibraryBased) {
+    console.log(`Command only supported for ${chalk.bold.green('library based')} components.`);
+    process.exit();
+  }
+
+  await showVersion();
+
+  const restoreAns = await inquirer.prompt([
+
+    {
+      name: 'restoreDev',
+      type: 'confirm',
+      message: 'Also restore package dependencies/devDepencies ?',
+      default: false
+    },
+  ]);
+
+  await restoreTopLevelConfigFilesFromTemplate(false);
+  console.log(chalk.green("Original config files restored."));
+
+  if (restoreAns.restoreDev) {
+    await restoreDependenciesFromTemplate();
+    console.log(chalk.green("Package dependencies and devDependencies restored."));
+
+    console.log('\n***************************************************************');
+    console.log(chalk.bold.yellow('Dependencies have changed, recommend updating.'));
+    console.log(`>>> PLEASE run ${chalk.bold.yellow("'npm update'")}.`);
+    console.log('***************************************************************\n');
+  }
+
+
+addDebugLog("restoreConfig", "END", "-");
+
+};

package/src/tasks/revert-webpack/index.js

@@ -1,46 +1,39 @@
-
 import fs from 'fs';
-import path, { join } from 'path';
+import path from 'path';
 
 import chalk from 'chalk';
 
-import {
-  showVersion,
-  updateUseWebPackPromotion
-} from '../../util.js';
-import {
-  WEBPACK_CONFIG_JS_FILENAME
-} from '../../constants.js';
-
-
+import { showVersion, updateUseWebPackPromotion, getLibraryBased, addDebugLog } from '../../util.js';
+import { WEBPACK_CONFIG_JS_FILENAME } from '../../constants.js';
 
 export const renamePromotedWebPack = async () => {
-
-  // call this function from top level
-  // fs.copyFileSync("./webpack.config.js", "webpack.config.js")
+addDebugLog("renamePromotedWebPack","", "");
 
   const promoteWebPackDir = path.resolve(WEBPACK_CONFIG_JS_FILENAME);
-  const renamedPromoteWebPackDir = path.resolve(`${WEBPACK_CONFIG_JS_FILENAME  }.notused`);
+  const renamedPromoteWebPackDir = path.resolve(`${WEBPACK_CONFIG_JS_FILENAME}.notused`);
 
   try {
     fs.renameSync(promoteWebPackDir, renamedPromoteWebPackDir);
-  }
-  catch (ex) {
+  } catch (ex) {
     console.log(chalk.bold.red(`File ${promoteWebPackDir} not found.`));
     process.exit();
   }
 
-  console.log(chalk.bold.green("Bundler reverted to using internal webpack.config.js."));
+  console.log(chalk.bold.green('Bundler reverted to using internal webpack.config.js.'));
   console.log(chalk.bold.green(`File ${promoteWebPackDir} marked as not used.`));
+};
 
-}
-
-
+export default async () => {
+  const isLibraryBased =  getLibraryBased();
+  if (isLibraryBased) {
+    console.log(`Command only supported for ${chalk.bold.green('non library mode')} components.`);
+    process.exit();
+  }
 
-export default async options => {
-  showVersion();
+  await showVersion();
+addDebugLog("revertWebPack","", "+");
 
   await renamePromotedWebPack();
   await updateUseWebPackPromotion(false);
-
+addDebugLog("revertWebPack","END", "-");
 };