feat: define and check dist size limit [KHCP-7179] (#455)

Kong · May 26, 2023 · 02e4d0a · 02e4d0a
1 parent 1b5cdb1
commit 02e4d0a
Show file tree

Hide file tree

Showing 11 changed files with 50 additions and 17 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -172,6 +172,9 @@ jobs:
         # The `...` syntax tells pnpm to include dependent packages
         run: pnpm --stream --filter "...${{steps.changed_packages.outputs.filter}}..." run build
 
+      - name: Check dist bundle size against max-limit
+        uses: Kong/github-action-dist-size-checker@main
+
       - name: Publish Previews
         if: ${{github.event_name == 'pull_request' && steps.changed_packages.outputs.filter != ''}}
         run: |
@@ -229,13 +232,6 @@ jobs:
              ```
           GITHUB_TOKEN: ${{ secrets.KONGPONENTS_BOT_PAT }}
 
-      - name: Upload bundle-analyzer results
-        if: ${{ steps.changed_packages.outputs.filter != '' }}
-        uses: actions/upload-artifact@v3
-        with:
-          name: rollup-plugin-visualizer
-          path:  packages/*/*/bundle-analyzer/stats-treemap.html
-
       - name: Run Unit Tests
         if: ${{ steps.changed_packages.outputs.unitTestFilter != '' }}
         run: pnpm --parallel --stream --filter "${{steps.changed_packages.outputs.unitTestFilter}}" run test:unit

diff --git a/packages/analytics/analytics-utilities/package.json b/packages/analytics/analytics-utilities/package.json
@@ -52,6 +52,9 @@
   "volta": {
     "extends": "../../../package.json"
   },
+  "distSizeChecker": {
+    "errorLimit": "500KB"
+  },
   "dependencies": {
     "date-fns": "^2.30.0"
   }

diff --git a/packages/analytics/metric-cards/package.json b/packages/analytics/metric-cards/package.json
@@ -22,7 +22,8 @@
   "scripts": {
     "dev": "cross-env USE_SANDBOX=true vite",
     "build": "run-s typecheck build:package build:types",
-    "build:package": "BUILD_VISUALIZER='analytics/metric-cards' vite build -m production",
+    "build:package": "vite build -m production",
+    "build:analyzer": "BUILD_VISUALIZER='analytics/metric-cards' vite build -m production",
     "build:types": "vue-tsc -p './tsconfig.build.json' --emitDeclarationOnly",
     "preview:package": "vite preview --port 4173",
     "preview": "cross-env USE_SANDBOX=true PREVIEW_SANDBOX=true run-s build:package preview:package",
@@ -60,5 +61,8 @@
   "license": "Apache-2.0",
   "volta": {
     "extends": "../../../package.json"
+  },
+  "distSizeChecker": {
+    "errorLimit": "500KB"
   }
 }
diff --git a/packages/core/app-layout/package.json b/packages/core/app-layout/package.json
@@ -22,7 +22,8 @@
   "scripts": {
     "dev": "cross-env USE_SANDBOX=true vite",
     "build": "run-s typecheck build:package build:types",
-    "build:package": "BUILD_VISUALIZER='core/app-layout' vite build -m production",
+    "build:package": "vite build -m production",
+    "build:analyzer": "BUILD_VISUALIZER='core/app-layout' vite build -m production",
     "build:types": "vue-tsc -p './tsconfig.build.json' --emitDeclarationOnly",
     "preview:package": "vite preview --port 4173",
     "preview": "cross-env USE_SANDBOX=true PREVIEW_SANDBOX=true run-s build:package preview:package",
@@ -65,5 +66,8 @@
   "license": "Apache-2.0",
   "volta": {
     "extends": "../../../package.json"
+  },
+  "distSizeChecker": {
+    "errorLimit": "500KB"
   }
 }
diff --git a/packages/core/cli/src/__template__/package.json b/packages/core/cli/src/__template__/package.json
@@ -22,7 +22,8 @@
   "scripts": {
     "dev": "cross-env USE_SANDBOX=true vite",
     "build": "run-s typecheck build:package build:types",
-    "build:package": "BUILD_VISUALIZER='{%%WORKSPACE%%}/{%%PACKAGE_NAME%%}' vite build -m production",
+    "build:package": "vite build -m production",
+    "build:analyzer": "BUILD_VISUALIZER='{%%WORKSPACE%%}/{%%PACKAGE_NAME%%}' vite build -m production",
     "build:types": "vue-tsc -p './tsconfig.build.json' --emitDeclarationOnly",
     "preview:package": "vite preview --port 4173",
     "preview": "cross-env USE_SANDBOX=true PREVIEW_SANDBOX=true run-s build:package preview:package",
@@ -52,5 +53,8 @@
   "license": "Apache-2.0",
   "volta": {
     "extends": "../../../package.json"
+  },
+  "distSizeChecker": {
+    "errorLimit": "200KB"
   }
 }
diff --git a/packages/core/copy-uuid/package.json b/packages/core/copy-uuid/package.json
@@ -22,7 +22,8 @@
   "scripts": {
     "dev": "cross-env USE_SANDBOX=true vite",
     "build": "run-s typecheck build:package build:types",
-    "build:package": "BUILD_VISUALIZER='core/copy-uuid' vite build -m production",
+    "build:package": "vite build -m production",
+    "build:analyzer": "BUILD_VISUALIZER='core/copy-uuid' vite build -m production",
     "build:types": "vue-tsc -p './tsconfig.build.json' --emitDeclarationOnly",
     "preview:package": "vite preview --port 4173",
     "preview": "cross-env USE_SANDBOX=true PREVIEW_SANDBOX=true run-s build:package preview:package",
@@ -57,5 +58,8 @@
   "license": "Apache-2.0",
   "volta": {
     "extends": "../../../package.json"
+  },
+  "distSizeChecker": {
+    "errorLimit": "250KB"
   }
 }
diff --git a/packages/core/i18n/package.json b/packages/core/i18n/package.json
@@ -22,7 +22,8 @@
   "scripts": {
     "dev": "cross-env USE_SANDBOX=true vite",
     "build": "run-s typecheck build:package build:types",
-    "build:package": "BUILD_VISUALIZER='core/i18n' vite build -m production",
+    "build:package": "vite build -m production",
+    "build:analyzer": "BUILD_VISUALIZER='core/i18n' vite build -m production",
     "build:types": "vue-tsc -p './tsconfig.build.json' --emitDeclarationOnly",
     "preview:package": "vite preview --port 4173",
     "preview": "cross-env USE_SANDBOX=true PREVIEW_SANDBOX=true run-s build:package preview:package",
@@ -50,6 +51,9 @@
   "volta": {
     "extends": "../../../package.json"
   },
+  "distSizeChecker": {
+    "errorLimit": "300KB"
+  },
   "peerDependencies": {
     "vue": "^3.2.47"
   },

diff --git a/packages/core/misc-widgets/package.json b/packages/core/misc-widgets/package.json
@@ -22,7 +22,8 @@
   "scripts": {
     "dev": "cross-env USE_SANDBOX=true vite",
     "build": "run-s typecheck build:package build:types",
-    "build:package": "BUILD_VISUALIZER='core/misc-widgets' vite build -m production",
+    "build:package": "vite build -m production",
+    "build:analyzer": "BUILD_VISUALIZER='core/misc-widgets' vite build -m production",
     "build:types": "vue-tsc -p './tsconfig.build.json' --emitDeclarationOnly",
     "preview:package": "vite preview --port 4173",
     "preview": "cross-env USE_SANDBOX=true PREVIEW_SANDBOX=true run-s build:package preview:package",
@@ -58,7 +59,9 @@
   "author": "Kong, Inc.",
   "license": "Apache-2.0",
   "volta": {
-    "extends": "../../../package.json",
-    "yarn": "1.22.19"
+    "extends": "../../../package.json"
+  },
+  "distSizeChecker": {
+    "errorLimit": "250KB"
   }
 }
diff --git a/packages/portal/document-viewer/package.json b/packages/portal/document-viewer/package.json
@@ -22,7 +22,8 @@
   "scripts": {
     "dev": "cross-env USE_SANDBOX=true vite",
     "build": "run-s typecheck build:package build:types",
-    "build:package": "BUILD_VISUALIZER='portal/document-viewer' vite build -m production",
+    "build:package": "vite build -m production",
+    "build:analyzer": "BUILD_VISUALIZER='portal/document-viewer' vite build -m production",
     "build:types": "vue-tsc -p './tsconfig.build.json' --emitDeclarationOnly",
     "preview:package": "vite preview --port 4173",
     "preview": "cross-env USE_SANDBOX=true PREVIEW_SANDBOX=true run-s build:package preview:package",
@@ -61,5 +62,8 @@
   "license": "Apache-2.0",
   "volta": {
     "extends": "../../../package.json"
+  },
+  "distSizeChecker": {
+    "errorLimit": "3MB"
   }
 }
diff --git a/packages/portal/spec-renderer/package.json b/packages/portal/spec-renderer/package.json
@@ -22,7 +22,8 @@
   "scripts": {
     "dev": "cross-env USE_SANDBOX=true vite",
     "build": "run-s typecheck build:package build:types",
-    "build:package": "BUILD_VISUALIZER='portal/spec-renderer' vite build -m production",
+    "build:package": "vite build -m production",
+    "build:analyzer": "BUILD_VISUALIZER='portal/spec-renderer' vite build -m production",
     "build:types": "vue-tsc -p './tsconfig.build.json' --emitDeclarationOnly",
     "preview:package": "vite preview --port 4173",
     "preview": "cross-env USE_SANDBOX=true PREVIEW_SANDBOX=true run-s build:package preview:package",
@@ -67,5 +68,8 @@
   "license": "Apache-2.0",
   "volta": {
     "extends": "../../../package.json"
+  },
+  "distSizeChecker": {
+    "errorLimit": "7.5MB"
   }
 }
diff --git a/packages/portal/swagger-ui-web-component/package.json b/packages/portal/swagger-ui-web-component/package.json
@@ -33,6 +33,9 @@
   "volta": {
     "extends": "../../../package.json"
   },
+  "distSizeChecker": {
+    "errorLimit": "3MB"
+  },
   "devDependencies": {
     "css-loader": "^6.7.3",
     "raw-loader": "^4.0.2",