From 456fc9f569491634cd8c99dafadfe2001ef2399e Mon Sep 17 00:00:00 2001 From: Timothee Guerin Date: Wed, 21 Oct 2026 13:51:53 -0400 Subject: [PATCH 1/2] feat(playground): allow overwriting published package bundles --- .../playground-upload-overwrite-2026-10-21.md | 7 ++++++ .../scripts/upload-bundled-emitter.ts | 14 ++++++++--- .../pipelines/jobs/build-packages.yml | 7 +++++- eng/tsp-core/pipelines/publish.yml | 8 +++++++ .../scripts/upload-bundler-packages.ts | 8 +++++++ packages/bundle-uploader/README.md | 24 +++++++++++++++++++ packages/bundle-uploader/src/index.ts | 12 ++++++++-- .../src/upload-browser-package.ts | 23 +++++++++--------- 8 files changed, 85 insertions(+), 18 deletions(-) create mode 100644 .chronus/changes/playground-upload-overwrite-2026-10-21.md create mode 100644 packages/bundle-uploader/README.md diff --git a/.chronus/changes/playground-upload-overwrite-2026-10-21.md b/.chronus/changes/playground-upload-overwrite-2026-10-21.md new file mode 100644 index 00000000000..0af415aa78d --- /dev/null +++ b/.chronus/changes/playground-upload-overwrite-2026-10-21.md @@ -0,0 +1,7 @@ +--- +changeKind: internal +packages: + - "@typespec/bundle-uploader" +--- + +Allow Playground package uploads to replace existing versions with `--overwrite`, and expose the option in the core publish pipeline. diff --git a/eng/emitters/scripts/upload-bundled-emitter.ts b/eng/emitters/scripts/upload-bundled-emitter.ts index 02b7fffd976..4181cbae414 100644 --- a/eng/emitters/scripts/upload-bundled-emitter.ts +++ b/eng/emitters/scripts/upload-bundled-emitter.ts @@ -1,12 +1,20 @@ // @ts-check +import { parseArgs } from "node:util"; import { resolve } from "path"; import { bundleAndUploadStandalonePackage } from "../../../packages/bundle-uploader/dist/src/index.js"; import { repoRoot } from "../../common/scripts/helpers.ts"; -const packageRelativePath = process.argv[2]; +const { values, positionals } = parseArgs({ + options: { + overwrite: { type: "boolean", default: false }, + }, + allowPositionals: true, +}); + +const packageRelativePath = positionals[0]; if (!packageRelativePath) { // eslint-disable-next-line no-console - console.error("Usage: node upload-bundled-emitter.ts "); + console.error("Usage: node upload-bundled-emitter.ts [--overwrite]"); // eslint-disable-next-line no-console console.error(" e.g. node upload-bundled-emitter.ts packages/http-client-csharp"); process.exit(1); @@ -15,4 +23,4 @@ if (!packageRelativePath) { // remove leading slash if exists, then resolve to absolute path const packagePath = resolve(repoRoot, packageRelativePath.replace(/^\//, "")); -await bundleAndUploadStandalonePackage({ packagePath }); +await bundleAndUploadStandalonePackage({ packagePath, overwrite: values.overwrite }); diff --git a/eng/tsp-core/pipelines/jobs/build-packages.yml b/eng/tsp-core/pipelines/jobs/build-packages.yml index a8f6c8ad35a..e20f000bbe5 100644 --- a/eng/tsp-core/pipelines/jobs/build-packages.yml +++ b/eng/tsp-core/pipelines/jobs/build-packages.yml @@ -1,3 +1,8 @@ +parameters: + - name: overwritePlaygroundPackages + type: boolean + default: false + jobs: - job: build displayName: Build Packages @@ -44,7 +49,7 @@ jobs: azureSubscription: "Azure SDK Engineering System" scriptType: bash scriptLocation: inlineScript - inlineScript: node ./eng/tsp-core/scripts/upload-bundler-packages.ts + inlineScript: node ./eng/tsp-core/scripts/upload-bundler-packages.ts ${{ iif(parameters.overwritePlaygroundPackages, '--overwrite', '') }} - task: AzureCLI@2 displayName: Upload scenario manifest diff --git a/eng/tsp-core/pipelines/publish.yml b/eng/tsp-core/pipelines/publish.yml index 2afa30d3e28..0cb1523bb35 100644 --- a/eng/tsp-core/pipelines/publish.yml +++ b/eng/tsp-core/pipelines/publish.yml @@ -14,6 +14,12 @@ trigger: pr: none +parameters: + - name: overwritePlaygroundPackages + displayName: Overwrite existing Playground package versions + type: boolean + default: false + extends: template: /eng/common/pipelines/templates/1es-redirect.yml parameters: @@ -29,6 +35,8 @@ extends: jobs: - template: /eng/tsp-core/pipelines/jobs/build-packages.yml@self + parameters: + overwritePlaygroundPackages: ${{ parameters.overwritePlaygroundPackages }} - template: /eng/tsp-core/pipelines/jobs/build-vs.yml@self - template: /eng/tsp-core/pipelines/jobs/cli/build-tsp-cli-all.yml@self - template: /eng/tsp-core/pipelines/jobs/e2e.yml@self diff --git a/eng/tsp-core/scripts/upload-bundler-packages.ts b/eng/tsp-core/scripts/upload-bundler-packages.ts index 2a858b0545d..ae8491f0285 100644 --- a/eng/tsp-core/scripts/upload-bundler-packages.ts +++ b/eng/tsp-core/scripts/upload-bundler-packages.ts @@ -1,12 +1,20 @@ // @ts-check +import { parseArgs } from "node:util"; import { bundleAndUploadPackages, getPackageVersion, } from "../../../packages/bundle-uploader/dist/src/index.js"; import { repoRoot } from "../../common/scripts/helpers.ts"; +const { values } = parseArgs({ + options: { + overwrite: { type: "boolean", default: false }, + }, +}); + await bundleAndUploadPackages({ repoRoot: repoRoot, + overwrite: values.overwrite, indexName: "typespec", indexVersion: await getPackageVersion(repoRoot, "@typespec/compiler"), packages: [ diff --git a/packages/bundle-uploader/README.md b/packages/bundle-uploader/README.md new file mode 100644 index 00000000000..b97626634a1 --- /dev/null +++ b/packages/bundle-uploader/README.md @@ -0,0 +1,24 @@ +# Playground bundle uploader + +Internal tooling for publishing TypeSpec package bundles to Playground storage. +By default, uploads skip package versions and assets that already exist. + +To replace an incorrectly published package version without deleting its blobs manually, +run the core upload command with `--overwrite`: + +```sh +node eng/tsp-core/scripts/upload-bundler-packages.ts --overwrite +``` + +The publish pipeline exposes the same opt-in behavior through the +**Overwrite existing Playground package versions** parameter, which defaults to `false`. + +Standalone packages can also be replaced with: + +```sh +node eng/emitters/scripts/upload-bundled-emitter.ts path/to/package --overwrite +``` + +Overwrite mode replaces the manifest, JavaScript files, static assets, and bundled peer +dependencies for the uploaded versions. Both `bundleAndUploadPackages` and +`bundleAndUploadStandalonePackage` accept an optional `overwrite: true` setting. diff --git a/packages/bundle-uploader/src/index.ts b/packages/bundle-uploader/src/index.ts index ff1dc91bfb7..bfe810194a3 100644 --- a/packages/bundle-uploader/src/index.ts +++ b/packages/bundle-uploader/src/index.ts @@ -36,6 +36,9 @@ export interface BundleAndUploadStandalonePackageOptions { * Absolute path to the package directory. */ packagePath: string; + + /** Replace existing bundles and assets for the same package version. Defaults to false. */ + overwrite?: boolean; } /** @@ -48,6 +51,7 @@ export interface BundleAndUploadStandalonePackageOptions { */ export async function bundleAndUploadStandalonePackage({ packagePath, + overwrite = false, }: BundleAndUploadStandalonePackageOptions) { const pkgJsonPath = resolve(packagePath, "package.json"); const pkgJson = JSON.parse(await readFile(pkgJsonPath, "utf-8")); @@ -57,7 +61,7 @@ export async function bundleAndUploadStandalonePackage({ const manifest = bundle.manifest; logInfo(`Bundling standalone package: ${manifest.name}@${manifest.version}`); - const uploader = new TypeSpecBundledPackageUploader(new AzureCliCredential()); + const uploader = new TypeSpecBundledPackageUploader(new AzureCliCredential(), { overwrite }); await uploader.createIfNotExists(); const result = await uploader.upload(bundle); @@ -153,6 +157,9 @@ async function uploadPlaygroundAssets( export interface BundleAndUploadPackagesOptions { repoRoot: string; + + /** Replace existing bundles for the same package version. Defaults to false. */ + overwrite?: boolean; /** * List of packages to bundle and upload. */ @@ -193,12 +200,13 @@ export async function bundleAndUploadPackages({ packages, indexName, indexVersion, + overwrite = false, }: BundleAndUploadPackagesOptions) { const allProjects = await findWorkspacePackages(repoRoot); const projects = allProjects.filter((x) => packages.includes(x.manifest.name!)); logInfo("Current index version:", indexVersion); - const uploader = new TypeSpecBundledPackageUploader(new AzureCliCredential()); + const uploader = new TypeSpecBundledPackageUploader(new AzureCliCredential(), { overwrite }); await uploader.createIfNotExists(); const existingIndex = await uploader.getIndex(indexName, indexVersion); diff --git a/packages/bundle-uploader/src/upload-browser-package.ts b/packages/bundle-uploader/src/upload-browser-package.ts index dae00a7fa77..6cc4b9592f8 100644 --- a/packages/bundle-uploader/src/upload-browser-package.ts +++ b/packages/bundle-uploader/src/upload-browser-package.ts @@ -22,9 +22,14 @@ export interface PackageIndex { export class TypeSpecBundledPackageUploader { #container: ContainerClient; + #overwrite: boolean; - constructor(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential) { + constructor( + credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, + options: { overwrite?: boolean } = {}, + ) { this.#container = getCoverageContainer(storageAccountName, credential); + this.#overwrite = options.overwrite ?? false; } async createIfNotExists() { @@ -88,13 +93,11 @@ export class TypeSpecBundledPackageUploader { blobHTTPHeaders: { blobContentType: contentType, }, - conditions: { - ifNoneMatch: "*", - }, + conditions: this.#overwrite ? undefined : { ifNoneMatch: "*" }, }); return { status: "uploaded", url }; } catch (e: any) { - if (e.code === "BlobAlreadyExists") { + if (!this.#overwrite && e.code === "BlobAlreadyExists") { return { status: "already-exists", url }; } throw e; @@ -159,12 +162,10 @@ export class TypeSpecBundledPackageUploader { blobHTTPHeaders: { blobContentType: "application/json; charset=utf-8", }, - conditions: { - ifNoneMatch: "*", - }, + conditions: this.#overwrite ? undefined : { ifNoneMatch: "*" }, }); } catch (e: any) { - if (e.code === "BlobAlreadyExists") { + if (!this.#overwrite && e.code === "BlobAlreadyExists") { return false; } throw e; @@ -180,9 +181,7 @@ export class TypeSpecBundledPackageUploader { blobHTTPHeaders: { blobContentType: "application/javascript; charset=utf-8", }, - conditions: { - ifNoneMatch: "*", - }, + conditions: this.#overwrite ? undefined : { ifNoneMatch: "*" }, }); } } From 7b2d9caaf568b861584b9e0d4976c524f2d38bc1 Mon Sep 17 00:00:00 2001 From: Timothee Guerin Date: Wed, 21 Oct 2026 14:47:40 -0400 Subject: [PATCH 2/2] fix(playground): remove stale imports when overwriting bundles --- packages/bundle-uploader/README.md | 3 +++ packages/bundle-uploader/src/index.ts | 7 +++++++ 2 files changed, 10 insertions(+) diff --git a/packages/bundle-uploader/README.md b/packages/bundle-uploader/README.md index b97626634a1..81116776924 100644 --- a/packages/bundle-uploader/README.md +++ b/packages/bundle-uploader/README.md @@ -22,3 +22,6 @@ node eng/emitters/scripts/upload-bundled-emitter.ts path/to/package --overwrite Overwrite mode replaces the manifest, JavaScript files, static assets, and bundled peer dependencies for the uploaded versions. Both `bundleAndUploadPackages` and `bundleAndUploadStandalonePackage` accept an optional `overwrite: true` setting. + +The shared index also removes obsolete export mappings for successfully overwritten +packages, while preserving mappings for other packages. diff --git a/packages/bundle-uploader/src/index.ts b/packages/bundle-uploader/src/index.ts index bfe810194a3..8f6b75ea46b 100644 --- a/packages/bundle-uploader/src/index.ts +++ b/packages/bundle-uploader/src/index.ts @@ -216,6 +216,13 @@ export async function bundleAndUploadPackages({ const manifest = bundle.manifest; const result = await uploader.upload(bundle); if (result.status === "uploaded") { + if (overwrite) { + for (const key of Object.keys(importMap)) { + if (key === manifest.name || key.startsWith(`${manifest.name}/`)) { + delete importMap[key]; + } + } + } logSuccess(`Bundle for package ${manifest.name}@${manifest.version} uploaded.`); } else { logInfo(`Bundle for package ${manifest.name} already exist for version ${manifest.version}.`);