@mui/internal-bundle-size-checker 1.0.9-canary.72 → 1.0.9-canary.74

package/build/syncPrComment.d.ts

@@ -8,7 +8,6 @@ export type SyncPrCommentResult = {
 /**
  * Syncs a PR comment via the dashboard API.
  * @param {string} repo - Repository in owner/repo format
- * @param {Record<string, object>} sections - Section-specific parameters
  * @returns {Promise<SyncPrCommentResult>}
  */
-export declare function syncPrComment(repo: string, sections: Record<string, object>): Promise<SyncPrCommentResult>;
+export declare function syncPrComment(repo: string): Promise<SyncPrCommentResult>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/internal-bundle-size-checker",
-  "version": "1.0.9-canary.72",
+  "version": "1.0.9-canary.74",
   "description": "Bundle size checker for MUI packages.",
   "license": "MIT",
   "type": "module",
@@ -27,8 +27,6 @@
     }
   },
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.1008.0",
-    "@aws-sdk/credential-providers": "^3.1008.0",
     "@octokit/rest": "^22.0.1",
     "chalk": "^5.6.2",
     "env-ci": "^11.2.0",
@@ -46,7 +44,7 @@
     "@types/micromatch": "4.0.10",
     "@types/yargs": "17.0.35"
   },
-  "gitSha": "98e99bf28bdaf246aee9618320f28e440148e844",
+  "gitSha": "fcc57442eeb92486028b70bb43a2b7d09eaa7e52",
   "scripts": {
     "build": "tsgo -p tsconfig.build.json",
     "test": "pnpm -w test --project @mui/internal-bundle-size-checker",

package/src/ciReport.js

@@ -25,7 +25,13 @@ const sizeSnapshotEntrySchema = z.object({
   gzip: z.number(),
 });
 
-const sizeSnapshotSchema = z.record(z.string(), sizeSnapshotEntrySchema);
+const snapshotMetadataSchema = z.object({
+  trackedBundles: z.array(z.string()).optional(),
+});
+
+const sizeSnapshotSchema = z
+  .record(z.string(), sizeSnapshotEntrySchema)
+  .and(z.object({ _metadata: snapshotMetadataSchema }).partial());
 
 export const sizeSnapshotUploadSchema = ciReportUploadSchema(
   'size-snapshot',

package/src/cli.js

@@ -93,45 +93,6 @@ async function getBundleSizes(args, config) {
   return sizeArrays.flat();
 }
 
-/**
- * Posts initial "in progress" PR comment via dashboard API.
- * Called for all CI builds — the server resolves the associated PR from
- * OIDC claims. If no PR exists yet (branch pushed before PR created),
- * the server returns a no-op response.
- * @param {NormalizedBundleSizeCheckerConfig} config - The loaded configuration
- * @returns {Promise<void>}
- */
-async function postInitialPrComment(config) {
-  const ciInfo = getCiInfo();
-
-  if (!ciInfo) {
-    return;
-  }
-
-  if (!ciInfo.slug) {
-    throw new Error('PR commenting enabled but repository information missing in CI build');
-  }
-
-  if (!config.upload) {
-    throw new Error('PR commenting requires upload configuration to determine the API URL');
-  }
-
-  try {
-    // eslint-disable-next-line no-console
-    console.log('Posting initial PR comment via dashboard API...');
-
-    const result = await syncPrComment(ciInfo.slug, { bundleSize: { status: 'pending' } });
-
-    // eslint-disable-next-line no-console
-    console.log(
-      result.skipped ? 'No open PR found for this branch, skipping.' : 'Initial PR comment posted.',
-    );
-  } catch (/** @type {any} */ error) {
-    console.error('Failed to post initial PR comment:', error.message);
-    // Don't fail the build for comment failures
-  }
-}
-
 /**
  * Main runner function
  * @param {CommandLineArgs} argv - Command line arguments
@@ -143,19 +104,25 @@ async function run(argv) {
 
   const config = await loadConfig(rootDir);
 
-  // Post initial PR comment if enabled and in CI environment
-  if (config && config.comment) {
-    await postInitialPrComment(config);
-  }
-
   // eslint-disable-next-line no-console
   console.log(`Starting bundle size snapshot creation with ${concurrency} workers...`);
 
   const bundleSizes = await getBundleSizes(argv, config);
+  // Get tracked bundles from config
+  const trackedBundles = config.entrypoints
+    .filter((entry) => entry.track === true)
+    .map((entry) => entry.id);
+
   const sortedBundleSizes = Object.fromEntries(
     bundleSizes.sort((a, b) => a[0].localeCompare(b[0])),
   );
 
+  // Add metadata with tracked bundles to the snapshot
+  if (trackedBundles.length > 0) {
+    // eslint-disable-next-line no-underscore-dangle
+    sortedBundleSizes._metadata = /** @type {any} */ ({ trackedBundles });
+  }
+
   // Ensure output directory exists
   await fs.mkdir(path.dirname(snapshotDestPath), { recursive: true });
   await fs.writeFile(snapshotDestPath, JSON.stringify(sortedBundleSizes, null, 2));
@@ -169,11 +136,7 @@ async function run(argv) {
   if (config && config.upload) {
     try {
       // eslint-disable-next-line no-console
-      console.log(
-        config.upload.legacyUpload
-          ? 'Uploading bundle size snapshot directly to S3 (legacy)...'
-          : 'Uploading bundle size snapshot via dashboard API...',
-      );
+      console.log(`Uploading bundle size snapshot via dashboard API at ${config.upload.apiUrl}...`);
       const { key } = await uploadSnapshot(snapshotDestPath, config.upload);
       // eslint-disable-next-line no-console
       console.log(`Bundle size snapshot uploaded to S3 with key: ${key}`);
@@ -210,17 +173,7 @@ async function run(argv) {
     // eslint-disable-next-line no-console
     console.log('Syncing PR comment via dashboard API...');
 
-    // Get tracked bundles from config
-    const trackedBundles = config.entrypoints
-      .filter((entry) => entry.track === true)
-      .map((entry) => entry.id);
-
-    const result = await syncPrComment(ciInfo.slug, {
-      bundleSize: {
-        status: 'complete',
-        trackedBundles: trackedBundles.length > 0 ? trackedBundles : undefined,
-      },
-    });
+    const result = await syncPrComment(ciInfo.slug);
 
     // eslint-disable-next-line no-console
     console.log(

package/src/configLoader.js

@@ -80,7 +80,10 @@ export function applyUploadConfigDefaults(uploadConfig, ciInfo) {
     throw new Error('Missing required field: upload.branch. Please specify a branch name.');
   }
 
-  const legacyUpload = uploadConfig.legacyUpload ?? false;
+  const apiUrl =
+    uploadConfig.apiUrl ||
+    process.env.CI_REPORT_API_URL ||
+    'https://code-infra-dashboard.onrender.com';
 
   // Return the normalized config
   /** @type {NormalizedUploadConfig} */
@@ -91,7 +94,7 @@ export function applyUploadConfigDefaults(uploadConfig, ciInfo) {
       uploadConfig.isPullRequest !== undefined
         ? Boolean(uploadConfig.isPullRequest)
         : Boolean(isPr),
-    legacyUpload,
+    apiUrl,
   };
 
   // Add PR number from CI environment if available
@@ -211,6 +214,11 @@ async function normalizeEntries(entries, configPath) {
   ).flat();
 
   for (const entry of result) {
+    if (entry.id.startsWith('_')) {
+      throw new Error(
+        `Entry id "${entry.id}" must not start with "_". Ids starting with "_" are reserved for internal metadata.`,
+      );
+    }
     if (usedIds.has(entry.id)) {
       throw new Error(`Duplicate entry id found: "${entry.id}". Entry ids must be unique.`);
     }

package/src/syncPrComment.js

@@ -9,10 +9,9 @@ const DEFAULT_API_URL = 'https://code-infra-dashboard.onrender.com';
 /**
  * Syncs a PR comment via the dashboard API.
  * @param {string} repo - Repository in owner/repo format
- * @param {Record<string, object>} sections - Section-specific parameters
  * @returns {Promise<SyncPrCommentResult>}
  */
-export async function syncPrComment(repo, sections) {
+export async function syncPrComment(repo) {
   const oidcToken = process.env.CIRCLE_OIDC_TOKEN_V2;
   if (!oidcToken) {
     throw new Error('CIRCLE_OIDC_TOKEN_V2 environment variable is required for PR comment sync');
@@ -24,7 +23,7 @@ export async function syncPrComment(repo, sections) {
   const response = await fetch(url, {
     method: 'POST',
     headers: { 'Content-Type': 'application/json', Authorization: `Bearer ${oidcToken}` },
-    body: JSON.stringify({ repo, sections }),
+    body: JSON.stringify({ repo }),
   });
 
   if (!response.ok) {

package/src/types.d.ts

@@ -3,7 +3,7 @@ export interface UploadConfig {
   repo?: string; // The repository name (e.g., "mui/material-ui")
   branch?: string; // Optional branch name (defaults to current Git branch)
   isPullRequest?: boolean; // Whether this is a pull request build (defaults to CI detection)
-  legacyUpload?: boolean; // Upload directly to S3 instead of using the dashboard API
+  apiUrl?: string; // Dashboard API URL (defaults to https://code-infra-dashboard.onrender.com)
 }
 
 // Normalized upload configuration where all properties are defined
@@ -12,7 +12,7 @@ export interface NormalizedUploadConfig {
   branch: string; // Branch name
   isPullRequest: boolean; // Whether this is a pull request build
   prNumber?: string; // PR number (from CI environment)
-  legacyUpload: boolean; // Whether to use direct S3 upload
+  apiUrl: string; // Dashboard API URL
 }
 
 // EntryPoint types

package/src/uploadSnapshot.js

@@ -1,7 +1,5 @@
 import fs from 'node:fs';
-import { S3Client, PutObjectCommand, PutObjectTaggingCommand } from '@aws-sdk/client-s3';
 import { execa } from 'execa';
-import { fromEnv } from '@aws-sdk/credential-providers';
 
 /**
  * @typedef {import('./types.js').NormalizedUploadConfig} NormalizedUploadConfig
@@ -16,29 +14,15 @@ async function getCurrentCommitSHA() {
   return stdout.trim();
 }
 
-/**
- * Sanitizes a string to be used as an S3 tag value
- * See https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-restrictions
- * @param {string} str
- * @returns {string}
- */
-function sanitizeS3TagString(str) {
-  // Replace disallowed characters with underscore
-  const safe = str.replace(/[^a-zA-Z0-9 +\-=.:/@]+/g, '_');
-  // Truncate to max lengths (256 for value)
-  const maxLen = 256;
-  return safe.length > maxLen ? safe.substring(0, maxLen) : safe;
-}
-
 /**
  * Uploads the snapshot via the dashboard API (server-side proxied to S3).
+ * @param {string} apiUrl - Base URL of the CI report API
  * @param {Buffer} fileContent - The file content to upload
  * @param {NormalizedUploadConfig} uploadConfig - The normalized upload configuration
  * @param {string} sha - The commit SHA
  * @returns {Promise<{key:string}>}
  */
-async function uploadViaApi(fileContent, uploadConfig, sha) {
-  const apiUrl = process.env.CI_REPORT_API_URL || 'https://code-infra-dashboard.onrender.com';
+async function uploadViaApi(apiUrl, fileContent, uploadConfig, sha) {
   /** @type {import('./ciReport.js').SizeSnapshotUpload} */
   const requestBody = {
     version: 1,
@@ -78,53 +62,6 @@ async function uploadViaApi(fileContent, uploadConfig, sha) {
   return { key: result.key };
 }
 
-/**
- * Uploads the snapshot directly to S3 using AWS credentials.
- * @param {Buffer} fileContent - The file content to upload
- * @param {NormalizedUploadConfig} uploadConfig - The normalized upload configuration
- * @param {string} sha - The commit SHA
- * @returns {Promise<{key:string}>}
- */
-async function uploadDirectToS3(fileContent, uploadConfig, sha) {
-  const { branch, isPullRequest } = uploadConfig;
-
-  // Create S3 client (uses AWS credentials from environment)
-  const client = new S3Client({
-    region: process.env.AWS_REGION_ARTIFACTS || process.env.AWS_REGION || 'eu-central-1',
-    credentials: fromEnv(),
-  });
-
-  // S3 bucket and key
-  const bucket = 'mui-org-ci';
-  const key = `artifacts/${uploadConfig.repo}/${sha}/size-snapshot.json`;
-
-  // Upload the file first
-  await client.send(
-    new PutObjectCommand({
-      Bucket: bucket,
-      Key: key,
-      Body: fileContent,
-      ContentType: 'application/json',
-    }),
-  );
-
-  // Then add tags to the uploaded object
-  await client.send(
-    new PutObjectTaggingCommand({
-      Bucket: bucket,
-      Key: key,
-      Tagging: {
-        TagSet: [
-          { Key: 'isPullRequest', Value: isPullRequest ? 'yes' : 'no' },
-          { Key: 'branch', Value: sanitizeS3TagString(branch) },
-        ],
-      },
-    }),
-  );
-
-  return { key };
-}
-
 /**
  * Uploads the size snapshot to S3
  * @param {string} snapshotPath - The path to the size snapshot JSON file
@@ -139,9 +76,5 @@ export async function uploadSnapshot(snapshotPath, uploadConfig, commitSha) {
     fs.promises.readFile(snapshotPath),
   ]);
 
-  if (uploadConfig.legacyUpload) {
-    return uploadDirectToS3(fileContent, uploadConfig, sha);
-  }
-
-  return uploadViaApi(fileContent, uploadConfig, sha);
+  return uploadViaApi(uploadConfig.apiUrl, fileContent, uploadConfig, sha);
 }