fix(size): more exact truncating of readme (#559)

algolia · Nov 13, 2020 · f6187c1 · f6187c1
1 parent 394cb8c
commit f6187c1
Show file tree

Hide file tree

Showing 2 changed files with 70 additions and 11 deletions.
diff --git a/src/__tests__/formatPkg.test.js b/src/__tests__/formatPkg.test.js
@@ -43,15 +43,15 @@ it('truncates long readmes', () => {
     readme: 'Hello, World! '.repeat(40000),
   };
   const formatted = formatPkg(object);
-  const truncatedEnding = '**TRUNCATED**';
+  const postfix = ' **TRUNCATED**';
   const ending = formatted.readme.substr(
-    formatted.readme.length - truncatedEnding.length
+    formatted.readme.length - postfix.length
   );
 
   const readmeLength = formatted.readme.length;
 
   expect(readmeLength).toBeLessThan(475000);
-  expect(ending).toBe(truncatedEnding);
+  expect(ending).toBe(postfix);
 
   expect(formatted).toMatchSnapshot({
     readme: expect.any(String),

diff --git a/src/formatPkg.js b/src/formatPkg.js
@@ -106,16 +106,75 @@ export default function formatPkg(pkg) {
     },
   };
 
-  const totalSize = sizeof(rawPkg);
-  if (totalSize > config.maxObjSize) {
-    const sizeDiff = sizeof(rawPkg.readme) - totalSize;
-    rawPkg.readme = `${truncate(
-      rawPkg.readme,
-      config.maxObjSize - sizeDiff
-    )} **TRUNCATED**`;
+  const truncated = truncatePackage(rawPkg);
+
+  return traverse(truncated).forEach(maybeEscape);
+}
+
+function checkSize(pkg) {
+  const size = sizeof(pkg);
+  const diff = size - config.maxObjSize;
+
+  return {
+    size,
+    diff,
+    isTooBig: diff > 0,
+  };
+}
+
+function truncatePackage(pkg) {
+  let smallerPkg = { ...pkg };
+
+  {
+    const { diff, isTooBig } = checkSize(smallerPkg);
+    if (isTooBig) {
+      const postfix = ' **TRUNCATED**';
+      // sizeof is * 2 what truncate expects
+      const maxReadmeLength = (sizeof(pkg.readme) - diff - sizeof(postfix)) / 2;
+
+      smallerPkg.readme = truncate(pkg.readme, maxReadmeLength) + postfix;
+    }
+  }
+
+  {
+    const { isTooBig } = checkSize(smallerPkg);
+    if (isTooBig) {
+      smallerPkg.readme =
+        '** TRUNCATED ** this package was too big, so non-essential information was removed';
+      smallerPkg.versions =
+        pkg.versions && pkg.version
+          ? {
+              [pkg.version]: pkg.versions[pkg.version],
+            }
+          : null;
+      smallerPkg.tags =
+        pkg.tags && pkg.tags.latest
+          ? {
+              latest: pkg.tags.latest,
+            }
+          : null;
+      smallerPkg.owners = [smallerPkg.owner];
+    }
+  }
+
+  {
+    const { isTooBig } = checkSize(smallerPkg);
+    if (isTooBig) {
+      smallerPkg = {
+        name: smallerPkg.name,
+        readme: smallerPkg.readme,
+      };
+    }
+  }
+
+  {
+    const { isTooBig } = checkSize(smallerPkg);
+    if (isTooBig) {
+      return null;
+    }
   }
 
-  return traverse(rawPkg).forEach(maybeEscape);
+  return smallerPkg;
 }
 
 function maybeEscape(node) {