@elliemae/ds-codemods 3.38.0-rc.2 → 3.38.0-rc.4

package/bin/cli/code-mods/command-logics/deprecated-components-usage-report/utils.mjs

@@ -25,10 +25,10 @@ import {
  * @property {regexpInfo} matchSharedPropieties.regexpInfo
  *
  * @typedef { object } matchWithEffortEntryPropeties
- * @property { deprecatedEffortMapEntry } matchWithEffortEntryPropeties.matchingEffortMetainfo
+ * @property { deprecatedEffortMapEntry[] } matchWithEffortEntryPropeties.matchingEffortsMetainfo
  *
  * @typedef { object } matchDeprecatedEntryPropeties
- * @property { dismissedWithExampleEntry } matchDeprecatedEntryPropeties.matchingEffortMetainfo
+ * @property { dismissedWithExampleEntry[] } matchDeprecatedEntryPropeties.matchingEffortsMetainfo
  *
  * @typedef {matchSharedPropieties & matchWithEffortEntryPropeties} matchWithEffortMetaInfo
  * @typedef {matchSharedPropieties & matchDeprecatedEntryPropeties} matchDeprecatedWithExample
@@ -75,11 +75,33 @@ const getSupportingDataStructures = (deprecatedEffortMap, effortCacheUID) => {
       if (!effortsDifferentPackageList.includes(oldPackage)) effortsDifferentPackageList.push(oldPackage);
     }
   });
+  const packagesOnlyAppearingAsOldAndNeverAsNew = [];
+  const oldPackages = new Map();
+  const newPackages = new Map();
+  LEGACY_WITH_NEW_SMALL_MIGRATION_EFFORT.forEach((effort) => {
+    const { oldPackage, newPackage } = effort;
+    oldPackages.set(oldPackage, true);
+    newPackages.set(newPackage, true);
+  });
+  LEGACY_WITH_NEW_MEDIUM_MIGRATION_EFFORT.forEach((effort) => {
+    const { oldPackage, newPackage } = effort;
+    oldPackages.set(oldPackage, true);
+    newPackages.set(newPackage, true);
+  });
+  LEGACY_WITH_NEW_LARGE_MIGRATION_EFFORT.forEach((effort) => {
+    const { oldPackage, newPackage } = effort;
+    oldPackages.set(oldPackage, true);
+    newPackages.set(newPackage, true);
+  });
+  oldPackages.forEach((_, oldPackage) => {
+    if (!newPackages.has(oldPackage)) packagesOnlyAppearingAsOldAndNeverAsNew.push(oldPackage);
+  });
 
   runtimeDeprecatedDSReportCache.set(effortCacheUID, {
     effortsSamePackageList,
     effortsSamePackageOldComponentsList,
     effortsDifferentPackageList,
+    packagesOnlyAppearingAsOldAndNeverAsNew,
   });
 
   return runtimeDeprecatedDSReportCache.get(effortCacheUID);
@@ -93,8 +115,12 @@ const getSupportingDataStructures = (deprecatedEffortMap, effortCacheUID) => {
  * @returns {Map<string, matchWithEffortMetaInfo>} - a map of matched statements
  */
 const checkDeprecatedEffort = (importStatements, deprecatedEffortMap, effortCacheUID = '') => {
-  const { effortsSamePackageList, effortsSamePackageOldComponentsList, effortsDifferentPackageList } =
-    getSupportingDataStructures(deprecatedEffortMap, effortCacheUID);
+  const {
+    effortsSamePackageList,
+    effortsSamePackageOldComponentsList,
+    effortsDifferentPackageList,
+    packagesOnlyAppearingAsOldAndNeverAsNew,
+  } = getSupportingDataStructures(deprecatedEffortMap, effortCacheUID);
 
   const matchedEfforts = new Map();
 
@@ -104,11 +130,13 @@ const checkDeprecatedEffort = (importStatements, deprecatedEffortMap, effortCach
     //  we do not care if the package is not in the list of packages that are deprecated
     // when the deprecated component and live components lives in different packages we know for sure that the statement is deprecated
     const statementIsDeprecatedForSure =
+      packagesOnlyAppearingAsOldAndNeverAsNew.findIndex((pck) => subStringAdhocDSMatcher(pck, packageName)) !== -1 ||
       effortsDifferentPackageList.findIndex((pck) => subStringAdhocDSMatcher(pck, packageName)) !== -1;
     // when the new and old lives under the same package (E.G. tooltip -> tooltipv3 from ds-tooltip, buttonv2 -> buttonv3 from ds-button-v2 ...)
     //  we need to check if the component itself is deprecated or not, just the "from ..." part is not enough
     const statementIsPotentiallyDeprecated =
       effortsSamePackageList.findIndex((pck) => subStringAdhocDSMatcher(pck, packageName)) !== -1;
+
     let isStatementActuallyDeprecated = false;
     if (!statementIsDeprecatedForSure && statementIsPotentiallyDeprecated) {
       effortsSamePackageOldComponentsList.forEach((deprecatedComponent) => {
@@ -120,13 +148,17 @@ const checkDeprecatedEffort = (importStatements, deprecatedEffortMap, effortCach
       // we iterate the deprecatedEffortMap again now that we know the statement is deprecated,
       // we do this so we can reach the constant meta-informations (like the new package name, severityTags, etc...)
       // technically this is O(n * m) where n is ~<10 and m is ~<50 so even the worst case is not that bad...
-      const matchingEffortMetainfoIndx = deprecatedEffortMap.findIndex((effortMetainfo) =>
+      // const matchingEffortMetainfoIndx = deprecatedEffortMap.findIndex((effortMetainfo) =>
+      //   subStringAdhocDSMatcher(importedComponent, effortMetainfo.component),
+      // );
+      const matchingDeprecations = deprecatedEffortMap.filter((effortMetainfo) =>
         subStringAdhocDSMatcher(importedComponent, effortMetainfo.component),
       );
-      if (matchingEffortMetainfoIndx === -1) return;
+      if (matchingDeprecations.length < 1) return;
+      // if (matchingEffortMetainfoIndx === -1) return;
       matchedEfforts.set(fullMatch, {
         regexpInfo: { fullMatch, importedComponent, packageName },
-        matchingEffortMetainfo: deprecatedEffortMap[matchingEffortMetainfoIndx],
+        matchingEffortsMetainfo: matchingDeprecations,
       });
     }
   });
@@ -165,16 +197,16 @@ export const checkDeprecatedDismissed = (importStatements) => {
   const matchedEfforts = new Map();
   importStatements.forEach((importStatement) => {
     const [fullMatch, importedComponent, packageName] = importStatement;
-    const matchingEffortMetainfoIndx = DISMISSED_WITH_EXAMPLE.findIndex(
+    const matchingDeprecations = DISMISSED_WITH_EXAMPLE.filter(
       (effortMetainfo) =>
         subStringAdhocDSMatcher(importedComponent, effortMetainfo.component) &&
         // {DSGroupBox} from 'ds-mobile' is not (yet) deprecated, DSGroupBox is a repeated component name, we need the extra package check
         subStringAdhocDSMatcher(packageName, effortMetainfo.oldPackage),
     );
-    if (matchingEffortMetainfoIndx === -1) return;
+    if (matchingDeprecations.length < 1) return;
     matchedEfforts.set(fullMatch, {
       regexpInfo: { fullMatch, importedComponent, packageName },
-      matchingEffortMetainfo: DISMISSED_WITH_EXAMPLE[matchingEffortMetainfoIndx],
+      matchingEffortsMetainfo: matchingDeprecations,
     });
   });
   return matchedEfforts;
@@ -211,15 +243,15 @@ export const checkFileForDeprecatedComponents = (filePath) => {
 
 /**
  * Helper function to generate a csv row from a "matched effort" object
- * @param {matchedEffortMapValue} matchedEffort
+ * @param {deprecatedEffortMapEntry | dismissedWithExampleEntry} matchedEffort
  * @param {string} filePath
  * @param {string} org - optional, if present an extra column will be added to the report
  * @param {string} repo - optional, if present an extra column will be added to the report
  * @returns {string} - csv row
  */
-const generateCsvRowFromMatchedEffort = (matchedEffort, filePath, org, repo) => {
+const generateCsvRowFromMatchedEffort = (matchingEffortMetainfo, filePath, org, repo) => {
   // "Legacy Component,Org(?),Repository(?),Legacy Package,Filename,File Path,Effort Size,Story Points"
-  const { matchingEffortMetainfo } = matchedEffort;
+
   // matchingEffortMetainfo type is deprecatedEffortMapEntry | dismissedWithExampleEntry
   // they share 'component' and 'oldPackage' properties and for the current use case we only care about those
   // if we want to expand the csv in the future we have to take care of this difference in the types
@@ -254,17 +286,29 @@ export const generateCsvRows = (fileReport, filePath, org, repo) => {
   //  this is not a perfect "detect the root" solution, but should work in our CI/CD pipeline
   const csvRows = [];
   deprecatedSmallEffort.forEach((effort) => {
-    csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo));
+    const { matchingEffortsMetainfo } = effort;
+    matchingEffortsMetainfo.forEach((effort) => {
+      csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo));
+    });
   });
   deprecatedMediumEffort.forEach((effort) => {
-    csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo));
+    const { matchingEffortsMetainfo } = effort;
+    matchingEffortsMetainfo.forEach((effort) => {
+      csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo));
+    });
   });
   deprecatedLargeEffort.forEach((effort) => {
-    csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo));
+    const { matchingEffortsMetainfo } = effort;
+    matchingEffortsMetainfo.forEach((effort) => {
+      csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo));
+    });
   });
 
   deprecatedDismissed.forEach((effort) => {
-    csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo));
+    const { matchingEffortsMetainfo } = effort;
+    matchingEffortsMetainfo.forEach((effort) => {
+      csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo));
+    });
   });
 
   return csvRows;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/ds-codemods",
-  "version": "3.38.0-rc.2",
+  "version": "3.38.0-rc.4",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Code Mods",
   "files": [