diff --git a/.github/workflows/ui-test-vscuse-others.yml b/.github/workflows/ui-test-vscuse-others.yml
index 8c834668a83..abdfbe30e26 100644
--- a/.github/workflows/ui-test-vscuse-others.yml
+++ b/.github/workflows/ui-test-vscuse-others.yml
@@ -714,7 +714,7 @@ jobs:
if [ -n "$work_item_links" ]; then
work_item_links="$work_item_links, "
fi
- work_item_links="$work_item_links$item_id"
+ work_item_links="$work_item_links$item_id"
fi
fi
done
@@ -752,7 +752,7 @@ jobs:
if [ -z "$report_url" ] || [ "$report_url" = "null" ]; then
report_url="N/A"
else
- report_url="Report"
+ report_url="Report"
fi
echo "Report URL: $report_url"
@@ -781,18 +781,21 @@ jobs:
label=""
+ row_style=""
if [ "$status" == "success" ]; then
passed=$((passed+1))
- label="PASSED"
+ row_style="background-color:#f0fdf4;"
+ label="PASSED"
else
failed=$((failed+1))
- label="FAILED"
+ row_style="background-color:#fef2f2;"
+ label="FAILED"
fi
echo "Job result label: $label"
url=$(echo "$jobs" | jq --arg case "$case" -r '[.[] | select(.name == $case)] | last | .html_url')
display_name=$(echo "$name" | sed 's/^Case-//')
- url="$display_name"
+ url="$display_name"
echo "Job URL: $url"
linked_bugs=""
@@ -846,7 +849,7 @@ jobs:
if [ -n "$bug_links" ]; then
bug_links="$bug_links, "
fi
- bug_links="$bug_links🐞$bug_id"
+ bug_links="$bug_links🐞$bug_id"
done
linked_bugs="$bug_links"
echo "Found linked bugs: $linked_bugs"
@@ -857,7 +860,7 @@ jobs:
fi
fi
- row=" | $url | $label | $owner | $work_item_url | $linked_bugs | $duration | $report_url | $error_info |
"
+ row=" | $url | $label | $owner | $work_item_url | $linked_bugs | $duration | $report_url | $error_info |
"
echo "Generated row: $row"
if [[ "$status" == "success" && $passed -lt $passedlimit ]]; then
@@ -872,7 +875,7 @@ jobs:
echo "Final failed list: $failedlist"
echo "Final passed list: $passedlist"
- body="Test report link.
| CASE | STATUS | OWNER | WORK ITEM | LINKED BUG(S) | DURATION | REPORT | Failed Step |
$lists
"
+ body="Test report link| CASE | STATUS | OWNER | WORK ITEM | LINKED BUG(S) | DURATION | REPORT | Failed Step |
|---|
$lists
"
echo "Generated email body: $body"
total=$((passed+failed))
@@ -886,18 +889,21 @@ jobs:
fi
echo "Final subject: $subject"
- echo "body=$body" >> $GITHUB_OUTPUT
+ printf '%s' "$body" > email-body.html
+ echo "BODY_FILE=$(pwd)/email-body.html" >> $GITHUB_ENV
echo "to=$emails" >> $GITHUB_OUTPUT
echo "subject=$subject" >> $GITHUB_OUTPUT
- - name: Prepare email body file
+ - name: Verify email body file
if: always()
- env:
- EMAIL_BODY: ${{ steps.list-jobs.outputs.body }}
run: |
- printf '%s' "$EMAIL_BODY" > email-body.html
- echo "BODY_FILE=$(pwd)/email-body.html" >> $GITHUB_ENV
+ if [ ! -f "email-body.html" ]; then
+ echo "email-body.html not found, creating empty file"
+ touch email-body.html
+ echo "BODY_FILE=$(pwd)/email-body.html" >> $GITHUB_ENV
+ fi
+ echo "Email body file size: $(wc -c < email-body.html) bytes"
- name: Send E-mail
uses: ./.github/actions/send-email-report-vscuse
diff --git a/.github/workflows/ui-test-vscuse-template.yml b/.github/workflows/ui-test-vscuse-template.yml
index 50e100c6948..2554909a7eb 100644
--- a/.github/workflows/ui-test-vscuse-template.yml
+++ b/.github/workflows/ui-test-vscuse-template.yml
@@ -297,7 +297,7 @@ jobs:
echo "$failed_step_id" > error.txt
fi
else
- echo "No failed step found" > error.txt
+ echo " " > error.txt
fi
echo "Extracted errors:"
@@ -714,7 +714,7 @@ jobs:
if [ -n "$work_item_links" ]; then
work_item_links="$work_item_links, "
fi
- work_item_links="$work_item_links$item_id"
+ work_item_links="$work_item_links$item_id"
fi
fi
done
@@ -752,7 +752,7 @@ jobs:
if [ -z "$report_url" ] || [ "$report_url" = "null" ]; then
report_url="N/A"
else
- report_url="Report"
+ report_url="Report"
fi
echo "Report URL: $report_url"
@@ -782,18 +782,21 @@ jobs:
label=""
+ row_style=""
if [ "$status" == "success" ]; then
passed=$((passed+1))
- label="PASSED"
+ row_style="background-color:#f0fdf4;"
+ label="PASSED"
else
failed=$((failed+1))
- label="FAILED"
+ row_style="background-color:#fef2f2;"
+ label="FAILED"
fi
echo "Job result label: $label"
url=$(echo "$jobs" | jq --arg case "$case" -r '[.[] | select(.name == $case)] | last | .html_url')
display_name=$(echo "$name" | sed 's/^Case-//')
- url="$display_name"
+ url="$display_name"
echo "Job URL: $url"
linked_bugs=""
@@ -847,7 +850,7 @@ jobs:
if [ -n "$bug_links" ]; then
bug_links="$bug_links, "
fi
- bug_links="$bug_links🐞$bug_id"
+ bug_links="$bug_links🐞$bug_id"
done
linked_bugs="$bug_links"
echo "Found linked bugs: $linked_bugs"
@@ -858,7 +861,7 @@ jobs:
fi
fi
- row=" | $url | $label | $owner | $work_item_url | $linked_bugs | $duration | $report_url | $error_info |
"
+ row=" | $url | $label | $owner | $work_item_url | $linked_bugs | $duration | $report_url | $error_info |
"
echo "Generated row: $row"
if [[ "$status" == "success" && $passed -lt $passedlimit ]]; then
@@ -873,7 +876,7 @@ jobs:
echo "Final failed list: $failedlist"
echo "Final passed list: $passedlist"
- body="Test report link.
| CASE | STATUS | OWNER | WORK ITEM | LINKED BUG(S) | DURATION | REPORT | Failed Step |
$lists
"
+ body="Test report link| CASE | STATUS | OWNER | WORK ITEM | LINKED BUG(S) | DURATION | REPORT | Failed Step |
|---|
$lists
"
echo "Generated email body: $body"
total=$((passed+failed))
@@ -887,18 +890,21 @@ jobs:
fi
echo "Final subject: $subject"
- echo "body=$body" >> $GITHUB_OUTPUT
+ printf '%s' "$body" > email-body.html
+ echo "BODY_FILE=$(pwd)/email-body.html" >> $GITHUB_ENV
echo "to=$emails" >> $GITHUB_OUTPUT
echo "subject=$subject" >> $GITHUB_OUTPUT
- - name: Prepare email body file
+ - name: Verify email body file
if: always()
- env:
- EMAIL_BODY: ${{ steps.list-jobs.outputs.body }}
run: |
- printf '%s' "$EMAIL_BODY" > email-body.html
- echo "BODY_FILE=$(pwd)/email-body.html" >> $GITHUB_ENV
+ if [ ! -f "email-body.html" ]; then
+ echo "email-body.html not found, creating empty file"
+ touch email-body.html
+ echo "BODY_FILE=$(pwd)/email-body.html" >> $GITHUB_ENV
+ fi
+ echo "Email body file size: $(wc -c < email-body.html) bytes"
- name: Send E-mail
uses: ./.github/actions/send-email-report-vscuse
diff --git a/Localize/loc/cs/packages/fx-core/resource/package.nls.json.lcl b/Localize/loc/cs/packages/fx-core/resource/package.nls.json.lcl
index a36c2539744..7eb47833a9e 100644
--- a/Localize/loc/cs/packages/fx-core/resource/package.nls.json.lcl
+++ b/Localize/loc/cs/packages/fx-core/resource/package.nls.json.lcl
@@ -3841,6 +3841,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -3868,6 +3877,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -7984,6 +8002,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -9520,6 +9547,15 @@
+ -
+
+
+
+
+
+
+
+
-
diff --git a/Localize/loc/de/packages/fx-core/resource/package.nls.json.lcl b/Localize/loc/de/packages/fx-core/resource/package.nls.json.lcl
index d2345fa7d8c..287b7d340fe 100644
--- a/Localize/loc/de/packages/fx-core/resource/package.nls.json.lcl
+++ b/Localize/loc/de/packages/fx-core/resource/package.nls.json.lcl
@@ -3841,6 +3841,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -3868,6 +3877,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -7984,6 +8002,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -9520,6 +9547,15 @@
+ -
+
+
+
+
+
+
+
+
-
diff --git a/Localize/loc/es/packages/fx-core/resource/package.nls.json.lcl b/Localize/loc/es/packages/fx-core/resource/package.nls.json.lcl
index 04cb9444c65..8122a5bf4b3 100644
--- a/Localize/loc/es/packages/fx-core/resource/package.nls.json.lcl
+++ b/Localize/loc/es/packages/fx-core/resource/package.nls.json.lcl
@@ -3841,6 +3841,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -3868,6 +3877,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -7984,6 +8002,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -9520,6 +9547,15 @@
+ -
+
+
+
+
+
+
+
+
-
diff --git a/Localize/loc/fr/packages/fx-core/resource/package.nls.json.lcl b/Localize/loc/fr/packages/fx-core/resource/package.nls.json.lcl
index 2b5f516ea48..e7a57437773 100644
--- a/Localize/loc/fr/packages/fx-core/resource/package.nls.json.lcl
+++ b/Localize/loc/fr/packages/fx-core/resource/package.nls.json.lcl
@@ -3841,6 +3841,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -3868,6 +3877,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -7984,6 +8002,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -9520,6 +9547,15 @@
+ -
+
+
+
+
+
+
+
+
-
diff --git a/Localize/loc/it/packages/fx-core/resource/package.nls.json.lcl b/Localize/loc/it/packages/fx-core/resource/package.nls.json.lcl
index a797afc4d2f..a2f86b099a1 100644
--- a/Localize/loc/it/packages/fx-core/resource/package.nls.json.lcl
+++ b/Localize/loc/it/packages/fx-core/resource/package.nls.json.lcl
@@ -3841,6 +3841,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -3868,6 +3877,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -7984,6 +8002,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -9520,6 +9547,15 @@
+ -
+
+
+
+
+
+
+
+
-
diff --git a/Localize/loc/ja/packages/fx-core/resource/package.nls.json.lcl b/Localize/loc/ja/packages/fx-core/resource/package.nls.json.lcl
index 4c095351bb9..cc104b97d98 100644
--- a/Localize/loc/ja/packages/fx-core/resource/package.nls.json.lcl
+++ b/Localize/loc/ja/packages/fx-core/resource/package.nls.json.lcl
@@ -3841,6 +3841,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -3868,6 +3877,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -7984,6 +8002,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -9520,6 +9547,15 @@
+ -
+
+
+
+
+
+
+
+
-
diff --git a/Localize/loc/ko/packages/fx-core/resource/package.nls.json.lcl b/Localize/loc/ko/packages/fx-core/resource/package.nls.json.lcl
index 8934fd790be..30b6a670a6b 100644
--- a/Localize/loc/ko/packages/fx-core/resource/package.nls.json.lcl
+++ b/Localize/loc/ko/packages/fx-core/resource/package.nls.json.lcl
@@ -3841,6 +3841,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -3868,6 +3877,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -7984,6 +8002,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -9520,6 +9547,15 @@
+ -
+
+
+
+
+
+
+
+
-
diff --git a/Localize/loc/pl/packages/fx-core/resource/package.nls.json.lcl b/Localize/loc/pl/packages/fx-core/resource/package.nls.json.lcl
index c796630a701..72383572a2f 100644
--- a/Localize/loc/pl/packages/fx-core/resource/package.nls.json.lcl
+++ b/Localize/loc/pl/packages/fx-core/resource/package.nls.json.lcl
@@ -3841,6 +3841,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -3868,6 +3877,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -7984,6 +8002,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -9520,6 +9547,15 @@
+ -
+
+
+
+
+
+
+
+
-
diff --git a/Localize/loc/pt-BR/packages/fx-core/resource/package.nls.json.lcl b/Localize/loc/pt-BR/packages/fx-core/resource/package.nls.json.lcl
index d1aa3acd6e7..21cbc8c2588 100644
--- a/Localize/loc/pt-BR/packages/fx-core/resource/package.nls.json.lcl
+++ b/Localize/loc/pt-BR/packages/fx-core/resource/package.nls.json.lcl
@@ -3841,6 +3841,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -3868,6 +3877,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -7984,6 +8002,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -9520,6 +9547,15 @@
+ -
+
+
+
+
+
+
+
+
-
diff --git a/Localize/loc/ru/packages/fx-core/resource/package.nls.json.lcl b/Localize/loc/ru/packages/fx-core/resource/package.nls.json.lcl
index d1fdbe55664..6e2de8f3397 100644
--- a/Localize/loc/ru/packages/fx-core/resource/package.nls.json.lcl
+++ b/Localize/loc/ru/packages/fx-core/resource/package.nls.json.lcl
@@ -3841,6 +3841,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -3868,6 +3877,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -7984,6 +8002,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -9520,6 +9547,15 @@
+ -
+
+
+
+
+
+
+
+
-
diff --git a/Localize/loc/tr/packages/fx-core/resource/package.nls.json.lcl b/Localize/loc/tr/packages/fx-core/resource/package.nls.json.lcl
index 550a67a401a..39e2e678b88 100644
--- a/Localize/loc/tr/packages/fx-core/resource/package.nls.json.lcl
+++ b/Localize/loc/tr/packages/fx-core/resource/package.nls.json.lcl
@@ -3841,6 +3841,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -3868,6 +3877,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -7984,6 +8002,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -9520,6 +9547,15 @@
+ -
+
+
+
+
+
+
+
+
-
diff --git a/Localize/loc/zh-Hans/packages/fx-core/resource/package.nls.json.lcl b/Localize/loc/zh-Hans/packages/fx-core/resource/package.nls.json.lcl
index b9466f7a0d5..354a3829044 100644
--- a/Localize/loc/zh-Hans/packages/fx-core/resource/package.nls.json.lcl
+++ b/Localize/loc/zh-Hans/packages/fx-core/resource/package.nls.json.lcl
@@ -3841,6 +3841,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -3868,6 +3877,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -7984,6 +8002,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -9520,6 +9547,15 @@
+ -
+
+
+
+
+
+
+
+
-
diff --git a/Localize/loc/zh-Hant/packages/fx-core/resource/package.nls.json.lcl b/Localize/loc/zh-Hant/packages/fx-core/resource/package.nls.json.lcl
index 0a6806e2734..48a1c030e6a 100644
--- a/Localize/loc/zh-Hant/packages/fx-core/resource/package.nls.json.lcl
+++ b/Localize/loc/zh-Hant/packages/fx-core/resource/package.nls.json.lcl
@@ -3841,6 +3841,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -3868,6 +3877,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -7984,6 +8002,15 @@
+ -
+
+
+
+
+
+
+
+
-
@@ -9520,6 +9547,15 @@
+ -
+
+
+
+
+
+
+
+
-
diff --git a/commitlint.config.js b/commitlint.config.js
index 735a2f59a60..38b94fea1b1 100644
--- a/commitlint.config.js
+++ b/commitlint.config.js
@@ -6,5 +6,10 @@ module.exports = {
'always',
['feat', 'fix', 'docs', 'style', 'refactor', 'test', 'revert', 'perf', "ci", "build"],
],
+ // Disable body/footer line length limits so trailer lines such as
+ // `Agent-Logs-Url: ` (auto-appended by automation) do not
+ // block otherwise-valid conventional commits.
+ 'body-max-line-length': [0, 'always'],
+ 'footer-max-line-length': [0, 'always'],
},
};
\ No newline at end of file
diff --git a/packages/cli/package.json b/packages/cli/package.json
index 4b2bf0e0296..d4c4b798834 100644
--- a/packages/cli/package.json
+++ b/packages/cli/package.json
@@ -1,6 +1,6 @@
{
"name": "@microsoft/m365agentstoolkit-cli",
- "version": "1.1.7",
+ "version": "1.1.8",
"author": "Microsoft Corporation",
"description": "Microsoft 365 Agents Toolkit CLI",
"license": "MIT",
diff --git a/packages/cli/src/commands/models/accountShow.ts b/packages/cli/src/commands/models/accountShow.ts
index 8b6d995917f..dee6966212b 100644
--- a/packages/cli/src/commands/models/accountShow.ts
+++ b/packages/cli/src/commands/models/accountShow.ts
@@ -18,6 +18,7 @@ import { TelemetryEvent } from "../../telemetry/cliTelemetryEvents";
import { listAllTenants } from "@microsoft/teamsfx-core/build/common/tools";
import { env } from "../../commonlib/common/constant";
import { AzureSpCrypto } from "../../commonlib/cacheAccess";
+import { getUsernameFromClaims } from "../../commonlib/accountInfoUtils";
class AccountUtils {
outputAccountInfoOffline(accountType: string, username: string): boolean {
@@ -41,7 +42,7 @@ class AccountUtils {
if (tid) {
await M365TokenProvider.switchTenant(tid);
}
- const username = (result as any).upn ?? (result as any).unique_name;
+ const username = getUsernameFromClaims(result as Record);
if (commandType === "login") {
logger.outputSuccess(strings["account.login.m365"]);
}
@@ -89,7 +90,7 @@ class AccountUtils {
await azureProvider.switchTenant(tenantId);
}
const subscriptions = await azureProvider.listSubscriptions();
- const username = (result as any).upn ?? (result as any).unique_name;
+ const username = getUsernameFromClaims(result as Record);
if (commandType === "login") {
logger.outputSuccess(strings["account.login.azure"]);
}
@@ -153,7 +154,7 @@ export const accountShowCommand: CLICommand = {
? await accountUtils.outputM365Info("show")
: accountUtils.outputAccountInfoOffline(
"Microsoft 365",
- (m365Status.accountInfo as any).upn
+ getUsernameFromClaims(m365Status.accountInfo as Record)
);
}
@@ -161,7 +162,10 @@ export const accountShowCommand: CLICommand = {
if (azureStatus.status === signedIn) {
(await accountUtils.checkIsOnline())
? await accountUtils.outputAzureInfo("show")
- : accountUtils.outputAccountInfoOffline("Azure", (azureStatus.accountInfo as any).upn);
+ : accountUtils.outputAccountInfoOffline(
+ "Azure",
+ getUsernameFromClaims(azureStatus.accountInfo as Record)
+ );
}
if (m365Status.status !== signedIn && azureStatus.status !== signedIn) {
diff --git a/packages/cli/src/commonlib/accountInfoUtils.ts b/packages/cli/src/commonlib/accountInfoUtils.ts
new file mode 100644
index 00000000000..a2dbc3640d7
--- /dev/null
+++ b/packages/cli/src/commonlib/accountInfoUtils.ts
@@ -0,0 +1,19 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+export function getUsernameFromClaims(claims?: object): string {
+ const tokenClaims = (claims ?? {}) as Record;
+ return (
+ (tokenClaims.upn as string | undefined) ??
+ (tokenClaims.unique_name as string | undefined) ??
+ (tokenClaims.preferred_username as string | undefined) ??
+ (tokenClaims.email as string | undefined) ??
+ ""
+ );
+}
+
+export function getInternalFlagFromTokenClaims(tokenJson: object): string {
+ return getUsernameFromClaims(tokenJson).toLowerCase().endsWith("@microsoft.com")
+ ? "true"
+ : "false";
+}
diff --git a/packages/cli/src/commonlib/azureLogin.ts b/packages/cli/src/commonlib/azureLogin.ts
index a0c1c80963e..aac1027b83c 100644
--- a/packages/cli/src/commonlib/azureLogin.ts
+++ b/packages/cli/src/commonlib/azureLogin.ts
@@ -51,6 +51,7 @@ import { LoginStatus, login } from "./common/login";
import CLILogProvider from "./log";
import { MemoryCache } from "./memoryCache";
import ui from "../userInteraction";
+import { getUsernameFromClaims } from "./accountInfoUtils";
const accountName = "azure";
const scopes = ["https://management.core.windows.net/user_impersonation"];
@@ -244,7 +245,7 @@ export class AzureAccountManager extends login implements AzureAccountProvider {
if (!AzureAccountManager.domain) {
AzureAccountManager.domain = (tokenJson as any).tid;
}
- AzureAccountManager.username = (tokenJson as any).upn ?? (tokenJson as any).unique_name;
+ AzureAccountManager.username = getUsernameFromClaims(tokenJson as Record);
tokenJson = ConvertTokenToJson(accessToken);
const tokenExpiresIn =
Math.round(new Date().getTime() / 1000) - ((tokenJson as any).iat as number);
@@ -262,7 +263,7 @@ export class AzureAccountManager extends login implements AzureAccountProvider {
expiresOn: {},
resource: env.activeDirectoryResourceId,
accessToken: accessToken,
- userId: (tokenJson as any).upn ?? (tokenJson as any).unique_name,
+ userId: getUsernameFromClaims(tokenJson as Record),
_clientId: getConfig().auth.clientId,
_authority: env.activeDirectoryEndpointUrl + (tokenJson as any).tid,
},
diff --git a/packages/cli/src/commonlib/codeFlowLogin.ts b/packages/cli/src/commonlib/codeFlowLogin.ts
index e60bb8a77db..ba1559ff317 100644
--- a/packages/cli/src/commonlib/codeFlowLogin.ts
+++ b/packages/cli/src/commonlib/codeFlowLogin.ts
@@ -47,6 +47,7 @@ import CliCodeLogInstance from "./log";
import { decodeClaimsChallenge } from "./common/utils";
import { getAccountByHomeId } from "./common/tokenCacheUtils";
import { featureFlagManager, FeatureFlags } from "@microsoft/teamsfx-core";
+import { getInternalFlagFromTokenClaims } from "./accountInfoUtils";
export class ErrorMessage {
static readonly loginFailureTitle = "LoginFail";
@@ -272,9 +273,7 @@ export class CodeFlowLogin {
[TelemetryProperty.AccountType]: this.accountName,
[TelemetryProperty.Success]: TelemetrySuccess.Yes,
[TelemetryProperty.UserId]: (tokenJson as any).oid ? (tokenJson as any).oid : "",
- [TelemetryProperty.Internal]: (tokenJson as any).upn?.endsWith("@microsoft.com")
- ? "true"
- : "false",
+ [TelemetryProperty.Internal]: getInternalFlagFromTokenClaims(tokenJson),
});
}
server.close();
@@ -363,9 +362,7 @@ export class CodeFlowLogin {
[TelemetryProperty.AccountType]: this.accountName,
[TelemetryProperty.Success]: TelemetrySuccess.Yes,
[TelemetryProperty.UserId]: (tokenJson as any).oid ? (tokenJson as any).oid : "",
- [TelemetryProperty.Internal]: (tokenJson as any).upn?.endsWith("@microsoft.com")
- ? "true"
- : "false",
+ [TelemetryProperty.Internal]: getInternalFlagFromTokenClaims(tokenJson),
});
}
}
diff --git a/packages/cli/tests/unit/commonlib/accountInfoUtils.tests.ts b/packages/cli/tests/unit/commonlib/accountInfoUtils.tests.ts
new file mode 100644
index 00000000000..aa62e3ce8ea
--- /dev/null
+++ b/packages/cli/tests/unit/commonlib/accountInfoUtils.tests.ts
@@ -0,0 +1,39 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import "mocha";
+import { expect } from "../utils";
+import {
+ getInternalFlagFromTokenClaims,
+ getUsernameFromClaims,
+} from "../../../src/commonlib/accountInfoUtils";
+
+describe("accountInfoUtils", () => {
+ it("getUsernameFromClaims should return empty string when claims is undefined", () => {
+ const result = getUsernameFromClaims(undefined);
+ expect(result).to.equal("");
+ });
+
+ it("getUsernameFromClaims should use fallback order upn -> unique_name -> preferred_username -> email", () => {
+ expect(
+ getUsernameFromClaims({ upn: "u@microsoft.com", unique_name: "x", email: "y" })
+ ).to.equal("u@microsoft.com");
+ expect(
+ getUsernameFromClaims({ unique_name: "unique@test.com", email: "email@test.com" })
+ ).to.equal("unique@test.com");
+ expect(
+ getUsernameFromClaims({ preferred_username: "preferred@test.com", email: "email@test.com" })
+ ).to.equal("preferred@test.com");
+ expect(getUsernameFromClaims({ email: "email@test.com" })).to.equal("email@test.com");
+ });
+
+ it("getInternalFlagFromTokenClaims should return true for microsoft accounts", () => {
+ const result = getInternalFlagFromTokenClaims({ preferred_username: "User@Microsoft.com" });
+ expect(result).to.equal("true");
+ });
+
+ it("getInternalFlagFromTokenClaims should return false for non-microsoft or missing account", () => {
+ expect(getInternalFlagFromTokenClaims({ email: "user@example.com" })).to.equal("false");
+ expect(getInternalFlagFromTokenClaims({})).to.equal("false");
+ });
+});
diff --git a/packages/cli/webpack.config.js b/packages/cli/webpack.config.js
index ba442b5d91c..52c48c49c3c 100644
--- a/packages/cli/webpack.config.js
+++ b/packages/cli/webpack.config.js
@@ -27,6 +27,8 @@ const config = {
devtool: "source-map",
externals: {
keytar: "commonjs keytar",
+ "@azure/msal-node-extensions": "commonjs @azure/msal-node-extensions",
+ "@azure/msal-node-runtime": "commonjs @azure/msal-node-runtime",
},
resolve: {
// support reading TypeScript and JavaScript files, 📖 -> https://github.com/TypeStrong/ts-loader
diff --git a/packages/fx-core/package.json b/packages/fx-core/package.json
index de3a905437f..73e5f4e6df0 100644
--- a/packages/fx-core/package.json
+++ b/packages/fx-core/package.json
@@ -108,7 +108,7 @@
"@microsoft/dev-tunnels-contracts": "1.1.9",
"@microsoft/dev-tunnels-management": "1.1.9",
"@modelcontextprotocol/sdk": "^1.27.1",
- "@microsoft/kiota": "1.29.0",
+ "@microsoft/kiota": "1.31.1",
"@microsoft/m365-spec-parser": "workspace:^",
"@microsoft/teamsfx-api": "workspace:*",
"adm-zip": "^0.5.10",
diff --git a/packages/fx-core/pnpm-lock.yaml b/packages/fx-core/pnpm-lock.yaml
index 9b1c5cb8b3e..b3fc049c849 100644
--- a/packages/fx-core/pnpm-lock.yaml
+++ b/packages/fx-core/pnpm-lock.yaml
@@ -45,8 +45,8 @@ dependencies:
specifier: 1.1.9
version: 1.1.9
'@microsoft/kiota':
- specifier: 1.29.0
- version: 1.29.0
+ specifier: 1.31.1
+ version: 1.31.1
'@microsoft/m365-spec-parser':
specifier: workspace:^
version: link:../spec-parser
@@ -1545,8 +1545,8 @@ packages:
- supports-color
dev: false
- /@microsoft/kiota@1.29.0:
- resolution: {integrity: sha512-qqIlTz48OJ5ZMRoTA/uQA70B7ltS4lPSs9atG5PUn+dKZcgXny3LzQPe12B1LsKoBJYbwhaU3fD8/C1DsLW6Cw==}
+ /@microsoft/kiota@1.31.1:
+ resolution: {integrity: sha512-YlAI2jC0grK2p2fvxDV9Hin5EtRXL6yOMhLKqtjRVlH8Q0+hI9UWFl7RhLWSZjsbDyl+0LIlI2HjlcbsUhXGsQ==}
dependencies:
adm-zip: 0.5.17
original-fs: 1.2.0
diff --git a/packages/fx-core/resource/package.nls.json b/packages/fx-core/resource/package.nls.json
index 28eb9079584..45021df7916 100644
--- a/packages/fx-core/resource/package.nls.json
+++ b/packages/fx-core/resource/package.nls.json
@@ -1064,6 +1064,7 @@
"driver.typeSpec.compile.description": "Compile TypeSpec project",
"driver.typespec.error.noSpecError": "No OpenApi spec found. Please make sure your TypeSpec files are valid and try again.",
"driver.typespec.error.multipleActionError": "More than one action found in declarativeAgent.json. Please make sure your TypeSpec files are valid and try again.",
+ "driver.typespec.error.compileError": "TypeSpec compilation failed. Please fix the errors reported by the compiler and try again. Compiler output:\n%s",
"driver.typeSpec.progressBar": "Compiling and generating files...",
"core.addKnowledge.doubleConfirm": "Performing this action will overwrite your existing manifest file and can't be undone. To keep your existing data, please back it up before proceeding. Would you like to add new content?",
"error.dep.InstallNodeJSError": "Unable to install Node.js for reason: %s. Please install it manually from https://nodejs.org and restart Visual Studio Code.",
diff --git a/packages/fx-core/resource/yaml-schema/v1.11/yaml.schema.json b/packages/fx-core/resource/yaml-schema/v1.11/yaml.schema.json
index e02e71ad1af..985668e604c 100644
--- a/packages/fx-core/resource/yaml-schema/v1.11/yaml.schema.json
+++ b/packages/fx-core/resource/yaml-schema/v1.11/yaml.schema.json
@@ -747,6 +747,9 @@
"properties": {
"teamsAppId": {
"$ref": "#/definitions/envVarName"
+ },
+ "teamsAppTenantId": {
+ "$ref": "#/definitions/envVarName"
}
}
}
diff --git a/packages/fx-core/resource/yaml-schema/yaml.schema.json b/packages/fx-core/resource/yaml-schema/yaml.schema.json
index e02e71ad1af..985668e604c 100644
--- a/packages/fx-core/resource/yaml-schema/yaml.schema.json
+++ b/packages/fx-core/resource/yaml-schema/yaml.schema.json
@@ -747,6 +747,9 @@
"properties": {
"teamsAppId": {
"$ref": "#/definitions/envVarName"
+ },
+ "teamsAppTenantId": {
+ "$ref": "#/definitions/envVarName"
}
}
}
diff --git a/packages/fx-core/src/common/daSpecParser.ts b/packages/fx-core/src/common/daSpecParser.ts
index 652a6d0a5a4..2f26455b889 100644
--- a/packages/fx-core/src/common/daSpecParser.ts
+++ b/packages/fx-core/src/common/daSpecParser.ts
@@ -39,6 +39,7 @@ import * as fs from "fs-extra";
import tmp from "tmp";
import { createHash } from "crypto";
import path from "path";
+import { parse as parseYaml } from "yaml";
import { getLocalizedString } from "./localizeUtils";
const daProjectConfig: ParseOptions = {
@@ -236,6 +237,200 @@ export async function generatePlugin(
return result;
}
+// Workaround for https://github.com/OfficeDev/microsoft-365-agents-toolkit/issues/15731.
+// Kiota >= 1.30.0 emits plugin manifest schema v2.4 but does NOT propagate the
+// `x-ai-adaptive-card`, `x-openai-isConsequential` and `x-ai-capabilities`
+// OpenAPI extensions into the generated `*-apiplugin.json` (only the schema
+// version was bumped by microsoft/kiota#7166; the extension propagation
+// promised by issue microsoft/kiota#7165 is not actually implemented as of
+// 1.31.1). This helper reads the source OpenAPI spec, finds those extensions
+// per operation, and patches the corresponding
+// `function.capabilities.{response_semantics,confirmation}` blocks in the
+// generated plugin manifest. Remove this workaround once Kiota propagates
+// these extensions natively.
+//
+// It is a no-op for operations whose extensions are absent or whose
+// capability blocks are already populated by Kiota.
+export async function patchOpenApiExtensionsIntoPluginManifest(
+ specPath: string,
+ pluginManifestPath: string
+): Promise {
+ if (!(await fs.pathExists(specPath)) || !(await fs.pathExists(pluginManifestPath))) {
+ return;
+ }
+
+ const specRaw = await fs.readFile(specPath, "utf8");
+ let spec: any;
+ try {
+ spec = parseYaml(specRaw);
+ } catch {
+ return;
+ }
+ if (!spec || typeof spec !== "object" || !spec.paths) {
+ return;
+ }
+
+ const specDir = path.dirname(specPath);
+ type OpExt = {
+ adaptiveCard?: { data_path?: string; file?: string };
+ isConsequential?: boolean;
+ confirmation?: any;
+ };
+ const opExtensions = new Map();
+
+ const httpMethods = [
+ "get",
+ "post",
+ "put",
+ "delete",
+ "patch",
+ "head",
+ "options",
+ "trace",
+ "connect",
+ ];
+ for (const pathKey of Object.keys(spec.paths)) {
+ const pathItem = spec.paths[pathKey];
+ if (!pathItem || typeof pathItem !== "object") continue;
+ for (const method of httpMethods) {
+ const op = pathItem[method];
+ if (!op || typeof op !== "object" || !op.operationId) continue;
+ const adaptiveCard = op["x-ai-adaptive-card"];
+ const isConsequential = op["x-openai-isConsequential"];
+ const aiCapabilities = op["x-ai-capabilities"];
+ if (
+ adaptiveCard === undefined &&
+ isConsequential === undefined &&
+ (!aiCapabilities || aiCapabilities.confirmation === undefined)
+ ) {
+ continue;
+ }
+ opExtensions.set(op.operationId as string, {
+ adaptiveCard: adaptiveCard && typeof adaptiveCard === "object" ? adaptiveCard : undefined,
+ isConsequential: typeof isConsequential === "boolean" ? isConsequential : undefined,
+ confirmation:
+ aiCapabilities && typeof aiCapabilities === "object"
+ ? aiCapabilities.confirmation
+ : undefined,
+ });
+ }
+ }
+
+ if (opExtensions.size === 0) {
+ return;
+ }
+
+ const manifest = (await fs.readJSON(pluginManifestPath)) as PluginManifestSchema;
+ const pluginManifestDir = path.dirname(pluginManifestPath);
+ const functions = manifest.functions ?? [];
+ let modified = false;
+
+ // Try several base directories when resolving an Adaptive Card file
+ // reference. The path in `x-ai-adaptive-card.file` (and the placeholder
+ // emitted by Kiota) is authored relative to the appPackage directory, but
+ // the plugin manifest lives in `appPackage/.generated/` and the spec lives
+ // in `appPackage/.generated/specs/`. Walk a few candidate base dirs so
+ // either layout works.
+ const candidateBaseDirs = [
+ pluginManifestDir,
+ path.dirname(pluginManifestDir),
+ path.dirname(path.dirname(pluginManifestDir)),
+ specDir,
+ path.dirname(specDir),
+ ];
+ const resolveCardJson = async (relOrAbs: string): Promise => {
+ const candidates = path.isAbsolute(relOrAbs)
+ ? [relOrAbs]
+ : candidateBaseDirs.map((dir) => path.join(dir, relOrAbs));
+ for (const candidate of candidates) {
+ try {
+ if (await fs.pathExists(candidate)) {
+ return await fs.readJSON(candidate);
+ }
+ } catch {
+ // try next candidate
+ }
+ }
+ return undefined;
+ };
+
+ // Detect Kiota's placeholder shape: `static_template: { file: "..." }`.
+ // Real Adaptive Cards always have `type` and `$schema` (or `body`), so a
+ // bare `{ file }` object means Kiota left the card unresolved.
+ const isFilePlaceholder = (template: any): template is { file: string } => {
+ return (
+ template &&
+ typeof template === "object" &&
+ typeof template.file === "string" &&
+ template.type === undefined &&
+ template.$schema === undefined &&
+ template.body === undefined
+ );
+ };
+
+ for (const fn of functions as any[]) {
+ const ext = opExtensions.get(fn.name);
+ if (!ext) continue;
+ fn.capabilities = fn.capabilities || {};
+
+ // 1. response_semantics from x-ai-adaptive-card.
+ if (ext.adaptiveCard) {
+ if (!fn.capabilities.response_semantics) {
+ const responseSemantics: any = {};
+ if (ext.adaptiveCard.data_path) {
+ responseSemantics.data_path = ext.adaptiveCard.data_path;
+ }
+ if (ext.adaptiveCard.file) {
+ const cardJson = await resolveCardJson(ext.adaptiveCard.file);
+ if (cardJson !== undefined) {
+ responseSemantics.static_template = cardJson;
+ }
+ }
+ if (Object.keys(responseSemantics).length > 0) {
+ fn.capabilities.response_semantics = responseSemantics;
+ modified = true;
+ }
+ } else {
+ // Kiota 1.31.1 emits a placeholder
+ // `static_template: { file: "adaptiveCards/.json" }` instead of
+ // inlining the card contents. Replace it with the actual card JSON.
+ const rs = fn.capabilities.response_semantics;
+ if (isFilePlaceholder(rs.static_template)) {
+ const cardJson = await resolveCardJson(rs.static_template.file);
+ if (cardJson !== undefined) {
+ rs.static_template = cardJson;
+ modified = true;
+ }
+ }
+ // Also fill in data_path if Kiota left it empty.
+ if (!rs.data_path && ext.adaptiveCard.data_path) {
+ rs.data_path = ext.adaptiveCard.data_path;
+ modified = true;
+ }
+ }
+ }
+
+ // 2. confirmation from x-ai-capabilities.confirmation +
+ // x-openai-isConsequential.
+ if (ext.confirmation && !fn.capabilities.confirmation) {
+ fn.capabilities.confirmation = { ...ext.confirmation };
+ modified = true;
+ }
+ if (
+ ext.isConsequential !== undefined &&
+ fn.capabilities.confirmation &&
+ fn.capabilities.confirmation.isNonConsequential === undefined
+ ) {
+ fn.capabilities.confirmation.isNonConsequential = !ext.isConsequential;
+ modified = true;
+ }
+ }
+
+ if (modified) {
+ await fs.writeJson(pluginManifestPath, manifest, { spaces: 4 });
+ }
+}
+
export async function parseAndUpdatePluginManifestForKiota(
pluginManifestPath: string,
updatePlaceholder: boolean
diff --git a/packages/fx-core/src/common/wrappedAxiosClient.ts b/packages/fx-core/src/common/wrappedAxiosClient.ts
index 64826a65373..c251242eaaf 100644
--- a/packages/fx-core/src/common/wrappedAxiosClient.ts
+++ b/packages/fx-core/src/common/wrappedAxiosClient.ts
@@ -90,69 +90,84 @@ export class WrappedAxiosClient {
* @returns
*/
public static onRejected(error: AxiosError) {
- const method = error.request.method as string;
- const fullPath = `${(error.request.host as string) ?? ""}${
- (error.request.path as string) ?? ""
- }`;
- const apiName = this.convertUrlToApiName(fullPath, method);
+ // Telemetry must never throw, otherwise the synthetic error will mask the
+ // real transport-level failure (TLS handshake, ECONNRESET on a kept-alive
+ // socket, etc.) returned to the caller. See AB#37640864.
+ try {
+ const method = ((error.request?.method as string) ?? "").toString();
+ const fullPath = `${(error.request?.host as string) ?? ""}${
+ (error.request?.path as string) ?? ""
+ }`;
+ const apiName = this.convertUrlToApiName(fullPath, method);
- let requestData: any;
- if (error.config?.data && typeof error.config.data === "string") {
- try {
- requestData = JSON.parse(error.config.data);
- } catch (error) {
- requestData = undefined;
+ let requestData: any;
+ if (error.config?.data && typeof error.config.data === "string") {
+ try {
+ requestData = JSON.parse(error.config.data);
+ } catch (error) {
+ requestData = undefined;
+ }
}
- }
- const properties: { [key: string]: string } = {
- url: `<${apiName}-url>`,
- method: method,
- params: this.generateParameters(error.config!.params),
- [TelemetryProperty.Success]: TelemetrySuccess.No,
- [TelemetryProperty.ErrorMessage]: error.response
- ? JSON.stringify(error.response.data)
- : error.message ?? "undefined",
- "status-code": error.response?.status.toString() ?? "undefined",
- ...this.generateExtraProperties(fullPath, requestData),
- };
+ const properties: { [key: string]: string } = {
+ url: `<${apiName}-url>`,
+ method: method,
+ params: this.generateParameters(error.config?.params),
+ [TelemetryProperty.Success]: TelemetrySuccess.No,
+ [TelemetryProperty.ErrorMessage]: error.response
+ ? JSON.stringify(error.response.data)
+ : error.message ?? "undefined",
+ "status-code": error.response?.status.toString() ?? "undefined",
+ ...this.generateExtraProperties(fullPath, requestData),
+ };
- const eventName = this.getEventName(fullPath);
- if (eventName === TelemetryEvent.AppStudioApi) {
- const correlationId = error.response?.headers[Constants.CORRELATION_ID] ?? "undefined";
+ const eventName = this.getEventName(fullPath);
+ if (eventName === TelemetryEvent.AppStudioApi) {
+ const correlationId =
+ (error.response?.headers
+ ? error.response.headers[Constants.CORRELATION_ID]
+ : undefined) ?? "undefined";
- const extraData = getDefaultString(
- "error.appstudio.apiFailed.reason.common",
- error.response?.data ? `data: ${JSON.stringify(error.response.data)}` : ""
- );
- const TDPApiFailedError = new DeveloperPortalAPIFailedSystemError(
- error,
- correlationId,
- apiName,
- extraData
- );
- properties[TelemetryProperty.ErrorCode] =
- `${TDPApiFailedError.source}.${TDPApiFailedError.name}`;
- properties[TelemetryProperty.ErrorMessage] = TDPApiFailedError.message;
- properties[TelemetryProperty.TDPTraceId] = correlationId;
- } else if (eventName === TelemetryEvent.MOSApi) {
- const tracingId = (error.response?.headers?.traceresponse ?? "undefined") as string;
- const originalMessage = error.message;
- const innerError = (error.response?.data as any).error || { code: "", message: "" };
- const finalMessage = `${originalMessage} (tracingId: ${tracingId}) ${
- innerError.code as string
- }: ${innerError.message as string} `;
- properties[TelemetryProperty.ErrorMessage] = finalMessage;
- properties[TelemetryProperty.MOSTraceId] = tracingId;
- }
+ const extraData = getDefaultString(
+ "error.appstudio.apiFailed.reason.common",
+ error.response?.data ? `data: ${JSON.stringify(error.response.data)}` : ""
+ );
+ const TDPApiFailedError = new DeveloperPortalAPIFailedSystemError(
+ error,
+ correlationId as string,
+ apiName,
+ extraData
+ );
+ properties[TelemetryProperty.ErrorCode] =
+ `${TDPApiFailedError.source}.${TDPApiFailedError.name}`;
+ properties[TelemetryProperty.ErrorMessage] = TDPApiFailedError.message;
+ properties[TelemetryProperty.TDPTraceId] = correlationId as string;
+ } else if (eventName === TelemetryEvent.MOSApi) {
+ const tracingId = (error.response?.headers?.traceresponse ?? "undefined") as string;
+ const originalMessage = error.message;
+ const responseData = error.response?.data;
+ const innerError =
+ responseData && typeof responseData === "object"
+ ? (responseData as any).error ?? { code: "", message: "" }
+ : { code: "", message: "" };
+ const finalMessage = `${originalMessage} (tracingId: ${tracingId}) ${
+ (innerError.code as string) ?? ""
+ }: ${(innerError.message as string) ?? ""} `;
+ properties[TelemetryProperty.ErrorMessage] = finalMessage;
+ properties[TelemetryProperty.MOSTraceId] = tracingId;
+ }
- TOOLS?.telemetryReporter?.sendTelemetryErrorEvent(eventName, properties);
+ TOOLS?.telemetryReporter?.sendTelemetryErrorEvent(eventName, properties);
+ } catch {
+ // Swallow telemetry errors so we always reject with the original error.
+ }
return Promise.reject(error);
}
static convertMethodUrlToApiDefForMOS(method: string, url: string): MOS3Api | undefined {
+ const upperMethod = (method ?? "").toUpperCase();
for (const key of Object.keys(MOS3ApiDefinitions)) {
const api = MOS3ApiDefinitions[key];
- if (api.method === method.toUpperCase() && url.match(api.path)) {
+ if (api.method === upperMethod && url.match(api.path)) {
return api;
}
}
@@ -168,7 +183,7 @@ export class WrappedAxiosClient {
* @returns
*/
public static convertUrlToApiName(fullPath: string, method: string): string {
- const upperMethod = method.toUpperCase();
+ const upperMethod = (method ?? "").toUpperCase();
if (this.isTDPApi(fullPath)) {
if (fullPath.match(new RegExp("/api/aadapp/v2"))) {
diff --git a/packages/fx-core/src/component/configManager/lifecycle.ts b/packages/fx-core/src/component/configManager/lifecycle.ts
index 61a52cc9890..3fcd00d2e88 100644
--- a/packages/fx-core/src/component/configManager/lifecycle.ts
+++ b/packages/fx-core/src/component/configManager/lifecycle.ts
@@ -25,6 +25,7 @@ import {
import { MissingEnvironmentVariablesError } from "../../error";
import { setErrorContext } from "../../common/globalVars";
import { AzureEnvironmentVariables, OpenAIEnvironmentVariables } from "../constants";
+import { envUtil } from "../utils/envUtil";
function resolveDriverDef(
def: DriverDefinition,
@@ -307,6 +308,20 @@ export class Lifecycle implements ILifecycle {
envOutput.set(envVar, value);
process.env[envVar] = value;
}
+ // Flush accumulated env output to disk after each driver so that subsequent actions
+ // (e.g. cli/runNpmCommand) that read the .env file directly can see up-to-date values.
+ if (result.value.size > 0 && ctx.projectPath && process.env.TEAMSFX_ENV) {
+ const writeRes = await envUtil.writeEnv(
+ ctx.projectPath,
+ process.env.TEAMSFX_ENV,
+ envUtil.map2object(envOutput)
+ );
+ if (writeRes.isErr()) {
+ ctx.logProvider.warning(
+ `Failed to flush env output to disk after action ${this.stringifyDriverDef(driver)}: ${writeRes.error?.message ?? String(writeRes.error)}`
+ );
+ }
+ }
ctx.logProvider.verbose(
`Action ${this.stringifyDriverDef(driver)} in lifecycle ${
this.name
diff --git a/packages/fx-core/src/component/driver/teamsApp/create.ts b/packages/fx-core/src/component/driver/teamsApp/create.ts
index 40dfbf4e118..603bdbc419e 100644
--- a/packages/fx-core/src/component/driver/teamsApp/create.ts
+++ b/packages/fx-core/src/component/driver/teamsApp/create.ts
@@ -94,7 +94,10 @@ export class CreateTeamsAppDriver implements StepDriver {
if (!outputEnvVarNames) {
outputEnvVarNames = new Map(Object.entries(defaultOutputNames));
}
- outputEnvVarNames = new Map([...outputEnvVarNames, ...Object.entries(internalOutputNames)]);
+ // Merge internal defaults as a fallback: any env var name the author
+ // configured in writeToEnvironmentFile (e.g. teamsAppTenantId) must take
+ // precedence over the internal default.
+ outputEnvVarNames = new Map([...Object.entries(internalOutputNames), ...outputEnvVarNames]);
const state = loadStateFromEnv(outputEnvVarNames);
let create = true;
diff --git a/packages/fx-core/src/component/driver/typeSpec/compile.ts b/packages/fx-core/src/component/driver/typeSpec/compile.ts
index 299b1abaa30..7f5496b0aa2 100644
--- a/packages/fx-core/src/component/driver/typeSpec/compile.ts
+++ b/packages/fx-core/src/component/driver/typeSpec/compile.ts
@@ -14,7 +14,10 @@ import {
import fs from "fs-extra";
import path from "path";
import { Service } from "typedi";
-import { parseAndUpdatePluginManifestForKiota } from "../../../common/daSpecParser";
+import {
+ parseAndUpdatePluginManifestForKiota,
+ patchOpenApiExtensionsIntoPluginManifest,
+} from "../../../common/daSpecParser";
import { kiotageneratePlugin } from "../../../common/kiotaClient";
import { getLocalizedString } from "../../../common/localizeUtils";
import { MetadataV4 } from "../../../common/versionMetadata";
@@ -31,6 +34,7 @@ import { addStartAndEndTelemetry } from "../middleware/addStartAndEndTelemetry";
import { defaultDAManifestFileName, defaultOpenApiOutputDir, helpLink } from "./constants";
import { MultipleActionError } from "./error/multipleActionError";
import { NoSpecError } from "./error/noSpecError";
+import { TypeSpecCompileError } from "./error/typeSpecCompileError";
import { TypeSpecCompileArgs } from "./interface/typeSpecCompileArgs";
const actionName = "typeSpec/compile"; // DO NOT MODIFY the name
@@ -81,6 +85,20 @@ export class TypeSpecCompileDriver implements StepDriver {
throw tspRes.error;
}
+ // Guard against the case where the TypeSpec compiler failed but
+ // runCommand still returned ok() (e.g., when the exit code is masked
+ // by a pipe in the VS Code task shell). If the expected output directory
+ // was not created, the compile clearly failed — surface the captured
+ // compiler output instead of the misleading ENOENT that would otherwise
+ // come from the readdirSync call below.
+ if (!fs.existsSync(openApiSpecsFolderPath)) {
+ const tspOutput = tspRes.value;
+ if (tspOutput) {
+ ctx.logProvider?.error(tspOutput);
+ }
+ throw new TypeSpecCompileError(actionName, tspOutput);
+ }
+
// 2. Call Kiota to generate plugin manifest
const openapiSpecs = fs.readdirSync(openApiSpecsFolderPath);
if (openapiSpecs.length === 0) {
@@ -111,6 +129,10 @@ export class TypeSpecCompileDriver implements StepDriver {
undefined,
true
);
+ await patchOpenApiExtensionsIntoPluginManifest(
+ `${openApiSpecsFolderPath}/${spec}`,
+ path.join(outputFolderPath, `${pluginManifestName.toLowerCase()}-apiplugin.json`)
+ );
} else {
for (const spec of openapiSpecs) {
const action = actions.find(
@@ -135,6 +157,10 @@ export class TypeSpecCompileDriver implements StepDriver {
undefined,
true
);
+ await patchOpenApiExtensionsIntoPluginManifest(
+ `${openApiSpecsFolderPath}/${spec}`,
+ path.join(outputFolderPath, `${pluginManifestName.toLowerCase()}-apiplugin.json`)
+ );
}
}
}
diff --git a/packages/fx-core/src/component/driver/typeSpec/error/typeSpecCompileError.ts b/packages/fx-core/src/component/driver/typeSpec/error/typeSpecCompileError.ts
new file mode 100644
index 00000000000..076ef6206a4
--- /dev/null
+++ b/packages/fx-core/src/component/driver/typeSpec/error/typeSpecCompileError.ts
@@ -0,0 +1,19 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { UserError } from "@microsoft/teamsfx-api";
+import { getDefaultString, getLocalizedString } from "../../../../common/localizeUtils";
+
+const errorCode = "TypeSpecCompileError";
+const messageKey = "driver.typespec.error.compileError";
+
+export class TypeSpecCompileError extends UserError {
+ constructor(actionName: string, output: string) {
+ super({
+ source: actionName,
+ name: errorCode,
+ message: getDefaultString(messageKey, output),
+ displayMessage: getLocalizedString(messageKey, output),
+ });
+ }
+}
diff --git a/packages/fx-core/tests/common/daSpecParser.test.ts b/packages/fx-core/tests/common/daSpecParser.test.ts
index a33eaea09fb..54688540f96 100644
--- a/packages/fx-core/tests/common/daSpecParser.test.ts
+++ b/packages/fx-core/tests/common/daSpecParser.test.ts
@@ -4,6 +4,9 @@
import { assert } from "chai";
import "mocha";
import sinon from "sinon";
+import * as fs from "fs-extra";
+import * as os from "os";
+import * as path from "path";
import * as kiotaClient from "../../src/common/kiotaClient";
import * as daSpecParser from "../../src/common/daSpecParser";
import * as utils from "../../src/common/utils";
@@ -1534,4 +1537,562 @@ describe("daSpecParser", () => {
);
});
});
+
+ describe("patchOpenApiExtensionsIntoPluginManifest (issue #15731)", () => {
+ let tmpDir: string;
+
+ beforeEach(async () => {
+ // The outer describe sets up sinon stubs we don't need here; restore so
+ // real fs / yaml are exercised.
+ sinon.restore();
+ tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), "kiota-15731-test-"));
+ });
+
+ afterEach(async () => {
+ try {
+ await fs.remove(tmpDir);
+ } catch {
+ // Ignore cleanup errors on Windows when files are still locked.
+ }
+ });
+
+ async function writeSpec(yaml: string): Promise {
+ const specPath = path.join(tmpDir, "openapi.yaml");
+ await fs.writeFile(specPath, yaml, "utf8");
+ return specPath;
+ }
+
+ async function writeManifest(manifest: any): Promise {
+ const p = path.join(tmpDir, "test-apiplugin.json");
+ await fs.writeJson(p, manifest, { spaces: 2 });
+ return p;
+ }
+
+ it("propagates x-ai-adaptive-card and inlines the static_template", async () => {
+ const cardsDir = path.join(tmpDir, "adaptiveCards");
+ await fs.ensureDir(cardsDir);
+ const card = { type: "AdaptiveCard", version: "1.5", body: [] };
+ await fs.writeJson(path.join(cardsDir, "get.json"), card);
+
+ const specPath = await writeSpec(
+ [
+ "openapi: 3.0.0",
+ "info: { title: t, version: '1' }",
+ "paths:",
+ " /items:",
+ " get:",
+ " operationId: getItems",
+ " x-ai-adaptive-card:",
+ " data_path: $.value[0]",
+ " file: adaptiveCards/get.json",
+ " responses: { '200': { description: ok } }",
+ "",
+ ].join("\n")
+ );
+ const manifestPath = await writeManifest({
+ schema_version: "v2.4",
+ functions: [{ name: "getItems", description: "" }],
+ });
+
+ await daSpecParser.patchOpenApiExtensionsIntoPluginManifest(specPath, manifestPath);
+
+ const result = await fs.readJson(manifestPath);
+ const fn = result.functions[0];
+ assert.deepEqual(fn.capabilities.response_semantics.data_path, "$.value[0]");
+ assert.deepEqual(fn.capabilities.response_semantics.static_template, card);
+ });
+
+ it("propagates x-openai-isConsequential into confirmation.isNonConsequential", async () => {
+ const specPath = await writeSpec(
+ [
+ "openapi: 3.0.0",
+ "info: { title: t, version: '1' }",
+ "paths:",
+ " /items:",
+ " patch:",
+ " operationId: updateItems",
+ " x-openai-isConsequential: true",
+ " x-ai-capabilities:",
+ " confirmation:",
+ " type: AdaptiveCard",
+ " title: Update?",
+ " body: Confirm.",
+ " responses: { '200': { description: ok } }",
+ "",
+ ].join("\n")
+ );
+ const manifestPath = await writeManifest({
+ schema_version: "v2.4",
+ functions: [{ name: "updateItems", description: "" }],
+ });
+
+ await daSpecParser.patchOpenApiExtensionsIntoPluginManifest(specPath, manifestPath);
+
+ const fn = (await fs.readJson(manifestPath)).functions[0];
+ assert.equal(fn.capabilities.confirmation.type, "AdaptiveCard");
+ assert.equal(fn.capabilities.confirmation.title, "Update?");
+ // x-openai-isConsequential: true => isNonConsequential: false
+ assert.strictEqual(fn.capabilities.confirmation.isNonConsequential, false);
+ });
+
+ it("maps x-openai-isConsequential: false to isNonConsequential: true", async () => {
+ const specPath = await writeSpec(
+ [
+ "openapi: 3.0.0",
+ "info: { title: t, version: '1' }",
+ "paths:",
+ " /items:",
+ " post:",
+ " operationId: readItems",
+ " x-openai-isConsequential: false",
+ " x-ai-capabilities:",
+ " confirmation:",
+ " type: AdaptiveCard",
+ " title: Read",
+ " body: ok",
+ " responses: { '200': { description: ok } }",
+ "",
+ ].join("\n")
+ );
+ const manifestPath = await writeManifest({
+ schema_version: "v2.4",
+ functions: [{ name: "readItems", description: "" }],
+ });
+
+ await daSpecParser.patchOpenApiExtensionsIntoPluginManifest(specPath, manifestPath);
+
+ const fn = (await fs.readJson(manifestPath)).functions[0];
+ assert.strictEqual(fn.capabilities.confirmation.isNonConsequential, true);
+ });
+
+ it("does not overwrite capabilities Kiota already populated", async () => {
+ const specPath = await writeSpec(
+ [
+ "openapi: 3.0.0",
+ "info: { title: t, version: '1' }",
+ "paths:",
+ " /items:",
+ " get:",
+ " operationId: getItems",
+ " x-ai-adaptive-card:",
+ " data_path: $.value[0]",
+ " file: adaptiveCards/get.json",
+ " responses: { '200': { description: ok } }",
+ "",
+ ].join("\n")
+ );
+ const existing = {
+ schema_version: "v2.4",
+ functions: [
+ {
+ name: "getItems",
+ description: "",
+ capabilities: {
+ response_semantics: { data_path: "$.preserved" },
+ },
+ },
+ ],
+ };
+ const manifestPath = await writeManifest(existing);
+
+ await daSpecParser.patchOpenApiExtensionsIntoPluginManifest(specPath, manifestPath);
+
+ const fn = (await fs.readJson(manifestPath)).functions[0];
+ assert.equal(fn.capabilities.response_semantics.data_path, "$.preserved");
+ });
+
+ it("is a no-op when the spec has no relevant extensions", async () => {
+ const specPath = await writeSpec(
+ [
+ "openapi: 3.0.0",
+ "info: { title: t, version: '1' }",
+ "paths:",
+ " /items:",
+ " get:",
+ " operationId: getItems",
+ " responses: { '200': { description: ok } }",
+ "",
+ ].join("\n")
+ );
+ const before = {
+ schema_version: "v2.4",
+ functions: [{ name: "getItems", description: "" }],
+ };
+ const manifestPath = await writeManifest(before);
+
+ await daSpecParser.patchOpenApiExtensionsIntoPluginManifest(specPath, manifestPath);
+
+ assert.deepEqual(await fs.readJson(manifestPath), before);
+ });
+
+ it("returns silently when spec or manifest path does not exist", async () => {
+ // Should not throw.
+ await daSpecParser.patchOpenApiExtensionsIntoPluginManifest(
+ path.join(tmpDir, "missing.yaml"),
+ path.join(tmpDir, "missing.json")
+ );
+ });
+
+ it("returns silently when the spec is not valid YAML", async () => {
+ const specPath = path.join(tmpDir, "openapi.yaml");
+ // `: : :` is a YAML parse error.
+ await fs.writeFile(specPath, ":\n: :\n : :", "utf8");
+ const before = {
+ schema_version: "v2.4",
+ functions: [{ name: "x", description: "" }],
+ };
+ const manifestPath = await writeManifest(before);
+
+ await daSpecParser.patchOpenApiExtensionsIntoPluginManifest(specPath, manifestPath);
+
+ assert.deepEqual(await fs.readJson(manifestPath), before);
+ });
+
+ it("returns silently when the parsed spec has no paths object", async () => {
+ // YAML parses to a plain string, which exercises the
+ // `!spec || typeof spec !== "object" || !spec.paths` guard.
+ const specPath = await writeSpec("just-a-string\n");
+ const before = {
+ schema_version: "v2.4",
+ functions: [{ name: "x", description: "" }],
+ };
+ const manifestPath = await writeManifest(before);
+
+ await daSpecParser.patchOpenApiExtensionsIntoPluginManifest(specPath, manifestPath);
+
+ assert.deepEqual(await fs.readJson(manifestPath), before);
+ });
+
+ it("leaves static_template unset when the referenced card file is unreadable", async () => {
+ // Create a directory where a card file is expected; readJson will fail.
+ const cardsDir = path.join(tmpDir, "adaptiveCards");
+ await fs.ensureDir(cardsDir);
+ await fs.ensureDir(path.join(cardsDir, "broken.json"));
+
+ const specPath = await writeSpec(
+ [
+ "openapi: 3.0.0",
+ "info: { title: t, version: '1' }",
+ "paths:",
+ " /items:",
+ " get:",
+ " operationId: getItems",
+ " x-ai-adaptive-card:",
+ " data_path: $.items[0]",
+ " file: adaptiveCards/broken.json",
+ " responses: { '200': { description: ok } }",
+ "",
+ ].join("\n")
+ );
+ const manifestPath = await writeManifest({
+ schema_version: "v2.4",
+ functions: [{ name: "getItems", description: "" }],
+ });
+
+ await daSpecParser.patchOpenApiExtensionsIntoPluginManifest(specPath, manifestPath);
+
+ const fn = (await fs.readJson(manifestPath)).functions[0];
+ // data_path is still propagated; static_template silently omitted.
+ assert.equal(fn.capabilities.response_semantics.data_path, "$.items[0]");
+ assert.notProperty(fn.capabilities.response_semantics, "static_template");
+ });
+
+ it("inlines Kiota's `{ file }` placeholder for static_template", async () => {
+ // Kiota 1.31.1 emits `static_template: { file: "adaptiveCards/.json" }`
+ // instead of inlining the card. The patch must replace it with the
+ // actual card JSON.
+ const cardsDir = path.join(tmpDir, "adaptiveCards");
+ await fs.ensureDir(cardsDir);
+ const cardJson = {
+ type: "AdaptiveCard",
+ $schema: "http://adaptivecards.io/schemas/adaptive-card.json",
+ version: "1.5",
+ body: [{ type: "TextBlock", text: "${title}" }],
+ };
+ await fs.writeJson(path.join(cardsDir, "search.json"), cardJson);
+
+ const specPath = await writeSpec(
+ [
+ "openapi: 3.0.0",
+ "info: { title: t, version: '1' }",
+ "paths:",
+ " /search:",
+ " get:",
+ " operationId: searchIssues",
+ " x-ai-adaptive-card:",
+ " data_path: $.items",
+ " file: adaptiveCards/search.json",
+ " responses: { '200': { description: ok } }",
+ "",
+ ].join("\n")
+ );
+ const manifestPath = await writeManifest({
+ schema_version: "v2.4",
+ functions: [
+ {
+ name: "searchIssues",
+ description: "",
+ capabilities: {
+ response_semantics: {
+ data_path: "$.items",
+ static_template: { file: "adaptiveCards/search.json" },
+ },
+ },
+ },
+ ],
+ });
+
+ await daSpecParser.patchOpenApiExtensionsIntoPluginManifest(specPath, manifestPath);
+
+ const fn = (await fs.readJson(manifestPath)).functions[0];
+ assert.deepEqual(fn.capabilities.response_semantics.static_template, cardJson);
+ assert.equal(fn.capabilities.response_semantics.data_path, "$.items");
+ });
+
+ it("does not replace a real static_template that already has card fields", async () => {
+ // If `static_template` already looks like a real Adaptive Card (has
+ // `type`/`$schema`/`body`), we must leave it alone even if a `file`
+ // property happens to be present.
+ const cardsDir = path.join(tmpDir, "adaptiveCards");
+ await fs.ensureDir(cardsDir);
+ await fs.writeJson(path.join(cardsDir, "search.json"), {
+ type: "AdaptiveCard",
+ body: [{ type: "TextBlock", text: "from disk" }],
+ });
+
+ const specPath = await writeSpec(
+ [
+ "openapi: 3.0.0",
+ "info: { title: t, version: '1' }",
+ "paths:",
+ " /search:",
+ " get:",
+ " operationId: searchIssues",
+ " x-ai-adaptive-card:",
+ " data_path: $.items",
+ " file: adaptiveCards/search.json",
+ " responses: { '200': { description: ok } }",
+ "",
+ ].join("\n")
+ );
+ const realCard = {
+ type: "AdaptiveCard",
+ $schema: "http://adaptivecards.io/schemas/adaptive-card.json",
+ body: [{ type: "TextBlock", text: "preserved" }],
+ };
+ const manifestPath = await writeManifest({
+ schema_version: "v2.4",
+ functions: [
+ {
+ name: "searchIssues",
+ description: "",
+ capabilities: {
+ response_semantics: {
+ data_path: "$.items",
+ static_template: realCard,
+ },
+ },
+ },
+ ],
+ });
+
+ await daSpecParser.patchOpenApiExtensionsIntoPluginManifest(specPath, manifestPath);
+
+ const fn = (await fs.readJson(manifestPath)).functions[0];
+ assert.deepEqual(fn.capabilities.response_semantics.static_template, realCard);
+ });
+
+ it("resolves card files from the parent of the plugin manifest directory", async () => {
+ // Mirrors the real layout: spec lives in `/.generated/specs/`,
+ // plugin manifest lives in `/.generated/`, and the card lives in
+ // `/adaptiveCards/`.
+ const generated = path.join(tmpDir, ".generated");
+ const specsDir = path.join(generated, "specs");
+ await fs.ensureDir(specsDir);
+ await fs.ensureDir(path.join(tmpDir, "adaptiveCards"));
+ const cardJson = { type: "AdaptiveCard", body: [] };
+ await fs.writeJson(path.join(tmpDir, "adaptiveCards", "card.json"), cardJson);
+
+ const specPath = path.join(specsDir, "openapi.yaml");
+ await fs.writeFile(
+ specPath,
+ [
+ "openapi: 3.0.0",
+ "info: { title: t, version: '1' }",
+ "paths:",
+ " /x:",
+ " get:",
+ " operationId: getX",
+ " x-ai-adaptive-card:",
+ " data_path: $.items",
+ " file: adaptiveCards/card.json",
+ " responses: { '200': { description: ok } }",
+ "",
+ ].join("\n"),
+ "utf8"
+ );
+ const manifestPath = path.join(generated, "x-apiplugin.json");
+ await fs.writeJson(manifestPath, {
+ schema_version: "v2.4",
+ functions: [
+ {
+ name: "getX",
+ description: "",
+ capabilities: {
+ response_semantics: {
+ data_path: "$.items",
+ static_template: { file: "adaptiveCards/card.json" },
+ },
+ },
+ },
+ ],
+ });
+
+ await daSpecParser.patchOpenApiExtensionsIntoPluginManifest(specPath, manifestPath);
+
+ const fn = (await fs.readJson(manifestPath)).functions[0];
+ assert.deepEqual(fn.capabilities.response_semantics.static_template, cardJson);
+ });
+
+ it("swallows readJSON errors when the card file exists but is invalid JSON", async () => {
+ // Exercises the `catch` branch inside resolveCardJson: pathExists
+ // succeeds but readJSON throws on a corrupt file.
+ const cardsDir = path.join(tmpDir, "adaptiveCards");
+ await fs.ensureDir(cardsDir);
+ await fs.writeFile(path.join(cardsDir, "broken.json"), "{ not valid json", "utf8");
+
+ const specPath = await writeSpec(
+ [
+ "openapi: 3.0.0",
+ "info: { title: t, version: '1' }",
+ "paths:",
+ " /items:",
+ " get:",
+ " operationId: getItems",
+ " x-ai-adaptive-card:",
+ " data_path: $.items",
+ " file: adaptiveCards/broken.json",
+ " responses: { '200': { description: ok } }",
+ "",
+ ].join("\n")
+ );
+ const manifestPath = await writeManifest({
+ schema_version: "v2.4",
+ functions: [
+ {
+ name: "getItems",
+ description: "",
+ capabilities: {
+ response_semantics: {
+ static_template: { file: "adaptiveCards/broken.json" },
+ },
+ },
+ },
+ ],
+ });
+
+ await daSpecParser.patchOpenApiExtensionsIntoPluginManifest(specPath, manifestPath);
+
+ // The placeholder should be left intact since the card could not be
+ // read; data_path should still get filled from the spec.
+ const fn = (await fs.readJson(manifestPath)).functions[0];
+ assert.deepEqual(fn.capabilities.response_semantics.static_template, {
+ file: "adaptiveCards/broken.json",
+ });
+ assert.equal(fn.capabilities.response_semantics.data_path, "$.items");
+ });
+
+ it("fills missing data_path on an existing response_semantics with a placeholder", async () => {
+ // response_semantics exists with the Kiota `{ file }` placeholder but
+ // without a data_path; the patcher should backfill data_path from the
+ // spec while also inlining the card.
+ const cardsDir = path.join(tmpDir, "adaptiveCards");
+ await fs.ensureDir(cardsDir);
+ const card = { type: "AdaptiveCard", version: "1.5", body: [] };
+ await fs.writeJson(path.join(cardsDir, "get.json"), card);
+
+ const specPath = await writeSpec(
+ [
+ "openapi: 3.0.0",
+ "info: { title: t, version: '1' }",
+ "paths:",
+ " /items:",
+ " get:",
+ " operationId: getItems",
+ " x-ai-adaptive-card:",
+ " data_path: $.value",
+ " file: adaptiveCards/get.json",
+ " responses: { '200': { description: ok } }",
+ "",
+ ].join("\n")
+ );
+ const manifestPath = await writeManifest({
+ schema_version: "v2.4",
+ functions: [
+ {
+ name: "getItems",
+ description: "",
+ capabilities: {
+ response_semantics: {
+ // No data_path; placeholder static_template.
+ static_template: { file: "adaptiveCards/get.json" },
+ },
+ },
+ },
+ ],
+ });
+
+ await daSpecParser.patchOpenApiExtensionsIntoPluginManifest(specPath, manifestPath);
+
+ const fn = (await fs.readJson(manifestPath)).functions[0];
+ assert.equal(fn.capabilities.response_semantics.data_path, "$.value");
+ assert.deepEqual(fn.capabilities.response_semantics.static_template, card);
+ });
+
+ it("fills missing data_path on an existing response_semantics with a real card", async () => {
+ // response_semantics exists with a real (non-placeholder) static_template
+ // but no data_path. The patcher should leave the card alone and only
+ // backfill data_path.
+ const realCard = {
+ type: "AdaptiveCard",
+ $schema: "http://adaptivecards.io/schemas/adaptive-card.json",
+ body: [{ type: "TextBlock", text: "real" }],
+ };
+ const specPath = await writeSpec(
+ [
+ "openapi: 3.0.0",
+ "info: { title: t, version: '1' }",
+ "paths:",
+ " /items:",
+ " get:",
+ " operationId: getItems",
+ " x-ai-adaptive-card:",
+ " data_path: $.value",
+ " file: adaptiveCards/get.json",
+ " responses: { '200': { description: ok } }",
+ "",
+ ].join("\n")
+ );
+ const manifestPath = await writeManifest({
+ schema_version: "v2.4",
+ functions: [
+ {
+ name: "getItems",
+ description: "",
+ capabilities: {
+ response_semantics: {
+ static_template: realCard,
+ },
+ },
+ },
+ ],
+ });
+
+ await daSpecParser.patchOpenApiExtensionsIntoPluginManifest(specPath, manifestPath);
+
+ const fn = (await fs.readJson(manifestPath)).functions[0];
+ assert.equal(fn.capabilities.response_semantics.data_path, "$.value");
+ assert.deepEqual(fn.capabilities.response_semantics.static_template, realCard);
+ });
+ });
});
diff --git a/packages/fx-core/tests/common/wrappedAxiosClient.test.ts b/packages/fx-core/tests/common/wrappedAxiosClient.test.ts
index a943e88f39c..83935ad6d7d 100644
--- a/packages/fx-core/tests/common/wrappedAxiosClient.test.ts
+++ b/packages/fx-core/tests/common/wrappedAxiosClient.test.ts
@@ -288,6 +288,201 @@ describe("Wrapped Axios Client Test", () => {
chai.expect(telemetryChecker.calledOnce).to.be.true;
});
+ // Regression tests for AB#37640864: telemetry must never throw / mask the
+ // real transport-level error. Triggered by retry + keepAlive in PR #15676.
+ it("transport-level error with undefined request.method does not throw", async () => {
+ const transportError = {
+ message: "socket hang up",
+ code: "ECONNRESET",
+ request: {
+ // method, host, path can all be undefined for low-level socket errors
+ host: "https://titles.prod.mos.microsoft.com",
+ path: "/dev/v1/users/packages",
+ },
+ config: {},
+ // no `response` property -> transport failure
+ } as any;
+ const telemetryChecker = sinon.spy(mockTools.telemetryReporter, "sendTelemetryErrorEvent");
+
+ let rejected: any;
+ await WrappedAxiosClient.onRejected(transportError).catch((e) => (rejected = e));
+
+ chai.expect(rejected).to.equal(transportError);
+ chai.expect(telemetryChecker.calledOnce).to.be.true;
+ });
+
+ it("error with no request object does not throw", async () => {
+ const transportError = {
+ message: "TLS handshake failed",
+ code: "EPROTO",
+ config: {},
+ } as any;
+
+ let rejected: any;
+ await WrappedAxiosClient.onRejected(transportError).catch((e) => (rejected = e));
+
+ chai.expect(rejected).to.equal(transportError);
+ });
+
+ it("MOS API error with non-object response.data does not throw", async () => {
+ const mockedError = {
+ message: "Bad Gateway",
+ request: {
+ method: "POST",
+ host: "https://titles.prod.mos.microsoft.com",
+ path: "/dev/v1/users/packages",
+ },
+ config: {},
+ response: {
+ status: 502,
+ // data is a string (e.g. HTML body from a gateway), not an object
+ data: "502 Bad Gateway",
+ headers: { traceresponse: "trace-123" },
+ },
+ } as any;
+ const telemetryChecker = sinon.spy(mockTools.telemetryReporter, "sendTelemetryErrorEvent");
+
+ let rejected: any;
+ await WrappedAxiosClient.onRejected(mockedError).catch((e) => (rejected = e));
+
+ chai.expect(rejected).to.equal(mockedError);
+ chai.expect(telemetryChecker.calledOnce).to.be.true;
+ });
+
+ it("convertUrlToApiName handles undefined method", () => {
+ const apiName = WrappedAxiosClient.convertUrlToApiName(
+ "https://example.com/foo",
+ undefined as any
+ );
+ chai.expect(apiName).to.be.a("string");
+ });
+
+ it("convertMethodUrlToApiDefForMOS handles undefined method", () => {
+ const result = WrappedAxiosClient.convertMethodUrlToApiDefForMOS(
+ undefined as any,
+ "https://example.com/foo"
+ );
+ chai.expect(result).to.be.undefined;
+ });
+
+ it("TDP API error response without headers does not throw", async () => {
+ const mockedError = {
+ message: "Bad Request",
+ request: {
+ method: "GET",
+ host: getResourceServiceEndpoint(ResourceServiceType.TDP),
+ path: "/api/appdefinitions/fakeId",
+ },
+ config: {},
+ response: {
+ status: 400,
+ // headers intentionally omitted
+ },
+ } as any;
+ const telemetryChecker = sinon.spy(mockTools.telemetryReporter, "sendTelemetryErrorEvent");
+
+ let rejected: any;
+ await WrappedAxiosClient.onRejected(mockedError).catch((e) => (rejected = e));
+
+ chai.expect(rejected).to.equal(mockedError);
+ chai.expect(telemetryChecker.calledOnce).to.be.true;
+ });
+
+ it("MOS API error with nested response.data.error is surfaced", async () => {
+ const mockedError = {
+ message: "Conflict",
+ request: {
+ method: "POST",
+ host: "https://titles.prod.mos.microsoft.com",
+ path: "/dev/v1/users/packages",
+ },
+ config: {},
+ response: {
+ status: 409,
+ data: {
+ error: { code: "Conflict", message: "Already exists" },
+ },
+ headers: { traceresponse: "trace-xyz" },
+ },
+ } as any;
+ const telemetryChecker = sinon.spy(mockTools.telemetryReporter, "sendTelemetryErrorEvent");
+
+ let rejected: any;
+ await WrappedAxiosClient.onRejected(mockedError).catch((e) => (rejected = e));
+
+ chai.expect(rejected).to.equal(mockedError);
+ chai.expect(telemetryChecker.calledOnce).to.be.true;
+ const props = telemetryChecker.firstCall.args[1] as any;
+ chai.expect(props["err-message"]).to.contain("Conflict");
+ chai.expect(props["err-message"]).to.contain("Already exists");
+ chai.expect(props["err-message"]).to.contain("trace-xyz");
+ });
+
+ it("onRejected swallows internal telemetry errors and still rejects", async () => {
+ const mockedError = {
+ message: "boom",
+ request: { method: "GET", host: "https://example.com", path: "/x" },
+ config: {},
+ } as any;
+ // Force the telemetry reporter itself to throw, exercising the outer catch.
+ sinon
+ .stub(mockTools.telemetryReporter, "sendTelemetryErrorEvent")
+ .throws(new Error("telemetry exploded"));
+
+ let rejected: any;
+ await WrappedAxiosClient.onRejected(mockedError).catch((e) => (rejected = e));
+
+ chai.expect(rejected).to.equal(mockedError);
+ });
+
+ it("onRejected handles minimal error shape with no config / no message", async () => {
+ // Bare-minimum error object: no config, no message, no response.
+ // Exercises the "?? undefined" / "?? '...'" nullish fallback branches.
+ const mockedError = {
+ request: {
+ host: "https://titles.prod.mos.microsoft.com",
+ path: "/dev/v1/users/packages",
+ },
+ } as any;
+ const telemetryChecker = sinon.spy(mockTools.telemetryReporter, "sendTelemetryErrorEvent");
+
+ let rejected: any;
+ await WrappedAxiosClient.onRejected(mockedError).catch((e) => (rejected = e));
+
+ chai.expect(rejected).to.equal(mockedError);
+ chai.expect(telemetryChecker.calledOnce).to.be.true;
+ });
+
+ it("MOS API error with response.data.error missing fields uses fallback", async () => {
+ const mockedError = {
+ message: "Server Error",
+ request: {
+ method: "POST",
+ host: "https://titles.prod.mos.microsoft.com",
+ path: "/dev/v1/users/packages",
+ },
+ config: {},
+ response: {
+ status: 500,
+ // .error exists but has neither .code nor .message → exercises the
+ // `(innerError.code as string) ?? ""` and `... ?? ""` fallbacks.
+ data: { error: {} },
+ // no `headers.traceresponse` → exercises tracingId "undefined" fallback
+ headers: {},
+ },
+ } as any;
+ const telemetryChecker = sinon.spy(mockTools.telemetryReporter, "sendTelemetryErrorEvent");
+
+ let rejected: any;
+ await WrappedAxiosClient.onRejected(mockedError).catch((e) => (rejected = e));
+
+ chai.expect(rejected).to.equal(mockedError);
+ chai.expect(telemetryChecker.calledOnce).to.be.true;
+ const props = telemetryChecker.firstCall.args[1] as any;
+ chai.expect(props["err-message"]).to.contain("Server Error");
+ chai.expect(props["err-message"]).to.contain("undefined"); // tracingId fallback
+ });
+
it("Create bot API start telemetry", async () => {
const mockedRequest = {
method: "POST",
diff --git a/packages/fx-core/tests/component/configManager/lifecycle.test.ts b/packages/fx-core/tests/component/configManager/lifecycle.test.ts
index 575246ffcf5..93478c74f90 100644
--- a/packages/fx-core/tests/component/configManager/lifecycle.test.ts
+++ b/packages/fx-core/tests/component/configManager/lifecycle.test.ts
@@ -30,6 +30,7 @@ import {
import { ExecutionResult, StepDriver } from "../../../src/component/driver/interface/stepDriver";
import { SummaryConstant } from "../../../src/component/configManager/constant";
import { MockedAzureAccountProvider, MockedM365Provider } from "../../core/utils";
+import { envUtil } from "../../../src/component/utils/envUtil";
const mockedDriverContext: DriverContext = {
m365TokenProvider: new MockedM365Provider(),
@@ -826,3 +827,251 @@ describe("writeToEnvironmentFile", () => {
);
});
});
+
+describe("env flush to disk between actions", () => {
+ const sandbox = sinon.createSandbox();
+ let restoreFn: RestoreFn | undefined = undefined;
+ const driverAInstance = new DriverA();
+ const driverBInstance = new DriverB();
+
+ before(() => {
+ restoreFn = mockedEnv({ TEAMSFX_ENV: "local" });
+ sandbox
+ .stub(Container, "has")
+ .withArgs(sandbox.match("DriverA"))
+ .returns(true)
+ .withArgs(sandbox.match("DriverB"))
+ .returns(true);
+ sandbox
+ .stub(Container, "get")
+ .withArgs(sandbox.match("DriverA"))
+ .returns(driverAInstance)
+ .withArgs(sandbox.match("DriverB"))
+ .returns(driverBInstance);
+ });
+
+ after(() => {
+ sandbox.restore();
+ if (restoreFn) {
+ restoreFn();
+ }
+ });
+
+ it("should flush env to disk after each driver execution", async () => {
+ const writeEnvCalls: Array<{ env: string; envs: Record }> = [];
+ sandbox.stub(envUtil, "writeEnv").callsFake(async (_projectPath, env, envs) => {
+ writeEnvCalls.push({ env, envs: { ...envs } });
+ return ok(undefined);
+ });
+
+ const driverDefs: DriverDefinition[] = [];
+ driverDefs.push({ uses: "DriverA", with: {} });
+ driverDefs.push({ uses: "DriverB", with: {} });
+
+ const ctx: DriverContext = {
+ ...mockedDriverContext,
+ projectPath: "/fake/project",
+ };
+
+ const lifecycle = new Lifecycle("provision", driverDefs, "1.0.0");
+ const { result } = await lifecycle.execute(ctx);
+
+ assert(result.isOk(), "lifecycle should succeed");
+ // writeEnv should be called once per driver that produced output
+ assert.equal(writeEnvCalls.length, 2, "writeEnv should be called after each driver");
+ // After DriverA runs, its output should be flushed
+ assert.equal(writeEnvCalls[0].env, "local");
+ assert.equal(writeEnvCalls[0].envs["OUTPUT_A"], "VALUE_A");
+ // After DriverB runs, both outputs should be present
+ assert.equal(writeEnvCalls[1].env, "local");
+ assert.equal(writeEnvCalls[1].envs["OUTPUT_A"], "VALUE_A");
+ assert.equal(writeEnvCalls[1].envs["OUTPUT_B"], "VALUE_B");
+ });
+});
+
+// Additional coverage for the per-step env flush guard branches:
+// if (result.value.size > 0 && ctx.projectPath && process.env.TEAMSFX_ENV) { ... }
+// and for the writeEnv error path / warning logging.
+describe("env flush to disk between actions - edge cases", () => {
+ const sandbox = sinon.createSandbox();
+ let restoreFn: RestoreFn | undefined = undefined;
+
+ // Driver that returns success with an empty env map; flush must NOT happen.
+ class DriverEmptyOk implements StepDriver {
+ progressTitle = "mocked progress title";
+ async execute(): Promise {
+ return { result: ok(new Map()), summaries: [] };
+ }
+ }
+
+ // Driver that returns an error; flush must NOT happen for this driver.
+ class DriverErr implements StepDriver {
+ progressTitle = "mocked progress title";
+ async execute(): Promise {
+ return { result: err(mockedError), summaries: [] };
+ }
+ }
+
+ const driverAInstance = new DriverA();
+ const driverEmptyInstance = new DriverEmptyOk();
+ const driverErrInstance = new DriverErr();
+
+ beforeEach(() => {
+ sandbox
+ .stub(Container, "has")
+ .withArgs(sandbox.match("DriverA"))
+ .returns(true)
+ .withArgs(sandbox.match("DriverEmptyOk"))
+ .returns(true)
+ .withArgs(sandbox.match("DriverErr"))
+ .returns(true);
+ sandbox
+ .stub(Container, "get")
+ .withArgs(sandbox.match("DriverA"))
+ .returns(driverAInstance)
+ .withArgs(sandbox.match("DriverEmptyOk"))
+ .returns(driverEmptyInstance)
+ .withArgs(sandbox.match("DriverErr"))
+ .returns(driverErrInstance);
+ });
+
+ afterEach(() => {
+ sandbox.restore();
+ if (restoreFn) {
+ restoreFn();
+ restoreFn = undefined;
+ }
+ });
+
+ it("should not flush when driver returns empty env map", async () => {
+ restoreFn = mockedEnv({ TEAMSFX_ENV: "local" });
+ const writeEnvSpy = sandbox.stub(envUtil, "writeEnv").resolves(ok(undefined));
+
+ const lifecycle = new Lifecycle("provision", [{ uses: "DriverEmptyOk", with: {} }], "1.0.0");
+ const { result } = await lifecycle.execute({
+ ...mockedDriverContext,
+ projectPath: "/fake/project",
+ });
+
+ assert(result.isOk(), "lifecycle should succeed");
+ assert.equal(writeEnvSpy.callCount, 0, "writeEnv should not be called for empty output");
+ });
+
+ it("should not flush when ctx.projectPath is empty", async () => {
+ restoreFn = mockedEnv({ TEAMSFX_ENV: "local" });
+ const writeEnvSpy = sandbox.stub(envUtil, "writeEnv").resolves(ok(undefined));
+
+ const lifecycle = new Lifecycle("provision", [{ uses: "DriverA", with: {} }], "1.0.0");
+ const { result } = await lifecycle.execute({
+ ...mockedDriverContext,
+ projectPath: "",
+ });
+
+ assert(result.isOk(), "lifecycle should succeed");
+ assert.equal(
+ writeEnvSpy.callCount,
+ 0,
+ "writeEnv should not be called when projectPath is empty"
+ );
+ });
+
+ it("should not flush when TEAMSFX_ENV is not set", async () => {
+ restoreFn = mockedEnv({ TEAMSFX_ENV: undefined });
+ const writeEnvSpy = sandbox.stub(envUtil, "writeEnv").resolves(ok(undefined));
+
+ const lifecycle = new Lifecycle("provision", [{ uses: "DriverA", with: {} }], "1.0.0");
+ const { result } = await lifecycle.execute({
+ ...mockedDriverContext,
+ projectPath: "/fake/project",
+ });
+
+ assert(result.isOk(), "lifecycle should succeed");
+ assert.equal(
+ writeEnvSpy.callCount,
+ 0,
+ "writeEnv should not be called when TEAMSFX_ENV is not set"
+ );
+ });
+
+ it("should log a warning but continue when writeEnv returns an error", async () => {
+ restoreFn = mockedEnv({ TEAMSFX_ENV: "local" });
+ const writeEnvSpy = sandbox.stub(envUtil, "writeEnv").resolves(err(mockedError));
+ const logProvider = new MockedLogProvider();
+ const warningSpy = sandbox.spy(logProvider, "warning");
+
+ const lifecycle = new Lifecycle("provision", [{ uses: "DriverA", with: {} }], "1.0.0");
+ const { result } = await lifecycle.execute({
+ ...mockedDriverContext,
+ projectPath: "/fake/project",
+ logProvider,
+ });
+
+ assert(result.isOk(), "lifecycle should still succeed when flush fails");
+ assert.equal(writeEnvSpy.callCount, 1, "writeEnv should be attempted once");
+ assert.equal(warningSpy.callCount, 1, "warning should be logged exactly once");
+ const warningMsg = String(warningSpy.firstCall.args[0]);
+ assert(
+ warningMsg.includes("Failed to flush env output to disk"),
+ `warning message should describe the flush failure, got: ${warningMsg}`
+ );
+ assert(
+ warningMsg.includes("mockedMessage"),
+ `warning message should include underlying error message, got: ${warningMsg}`
+ );
+ });
+
+ it("should log a fallback warning when writeEnv returns an error without message", async () => {
+ restoreFn = mockedEnv({ TEAMSFX_ENV: "local" });
+ // Simulate the defensive `error?.message ?? String(error)` branch by returning a
+ // non-Error-shaped value as the error.
+ const oddError = "string-error" as unknown as FxError;
+ const writeEnvSpy = sandbox.stub(envUtil, "writeEnv").resolves(err(oddError));
+ const logProvider = new MockedLogProvider();
+ const warningSpy = sandbox.spy(logProvider, "warning");
+
+ const lifecycle = new Lifecycle("provision", [{ uses: "DriverA", with: {} }], "1.0.0");
+ const { result } = await lifecycle.execute({
+ ...mockedDriverContext,
+ projectPath: "/fake/project",
+ logProvider,
+ });
+
+ assert(result.isOk());
+ assert.equal(writeEnvSpy.callCount, 1);
+ assert.equal(warningSpy.callCount, 1);
+ const warningMsg = String(warningSpy.firstCall.args[0]);
+ assert(
+ warningMsg.includes("string-error"),
+ `warning message should fall back to String(error), got: ${warningMsg}`
+ );
+ });
+
+ it("should not flush after a driver that returns an error", async () => {
+ restoreFn = mockedEnv({ TEAMSFX_ENV: "local" });
+ const writeEnvSpy = sandbox.stub(envUtil, "writeEnv").resolves(ok(undefined));
+
+ // DriverA succeeds (and flushes once), then DriverErr fails (no flush for it).
+ const lifecycle = new Lifecycle(
+ "provision",
+ [
+ { uses: "DriverA", with: {} },
+ { uses: "DriverErr", with: {} },
+ ],
+ "1.0.0"
+ );
+ const { result } = await lifecycle.execute({
+ ...mockedDriverContext,
+ projectPath: "/fake/project",
+ });
+
+ assert(result.isErr(), "lifecycle should fail because of DriverErr");
+ assert.equal(
+ writeEnvSpy.callCount,
+ 1,
+ "writeEnv should only be called once (for the successful DriverA)"
+ );
+ assert.equal(writeEnvSpy.firstCall.args[1], "local");
+ const flushedEnvs = writeEnvSpy.firstCall.args[2] as Record;
+ assert.equal(flushedEnvs["OUTPUT_A"], "VALUE_A");
+ });
+});
diff --git a/packages/fx-core/tests/component/driver/teamsApp/create.test.ts b/packages/fx-core/tests/component/driver/teamsApp/create.test.ts
index 67db951bc0e..363424913ed 100644
--- a/packages/fx-core/tests/component/driver/teamsApp/create.test.ts
+++ b/packages/fx-core/tests/component/driver/teamsApp/create.test.ts
@@ -157,4 +157,62 @@ describe("teamsApp/create", async () => {
const result = (await teamsAppDriver.execute(args, mockedDriverContext)).result;
chai.assert.isTrue(result.isErr());
});
+
+ it("respects user-configured teamsAppTenantId env var name", async () => {
+ const args: CreateTeamsAppArgs = {
+ name: appDef.appName!,
+ };
+
+ sinon.stub(teamsDevPortalClient, "getApp").throws(new Error("404"));
+ sinon.stub(teamsDevPortalClient, "importApp").resolves(appDef);
+ sinon.stub(fs, "readFile").callsFake(async () => {
+ const zip = new AdmZip();
+ zip.addFile(Constants.MANIFEST_FILE, Buffer.from(JSON.stringify(new TeamsAppManifest())));
+ zip.addFile("color.png", new Buffer(""));
+ zip.addFile("outline.png", new Buffer(""));
+ return zip.toBuffer();
+ });
+
+ const outputEnvVarNames = new Map([
+ ["teamsAppId", "MY_TEAMS_APP_ID"],
+ ["teamsAppTenantId", "MY_TEAMS_APP_TENANT_ID"],
+ ]);
+
+ const result = (await teamsAppDriver.execute(args, mockedDriverContext, outputEnvVarNames))
+ .result;
+ chai.assert.isTrue(result.isOk());
+ if (result.isOk()) {
+ chai.assert.equal(result.value.get("MY_TEAMS_APP_ID"), appDef.teamsAppId);
+ chai.assert.equal(result.value.get("MY_TEAMS_APP_TENANT_ID"), appDef.tenantId);
+ // The internal default name must not leak through when the author
+ // configured a custom env var name.
+ chai.assert.isFalse(result.value.has("TEAMS_APP_TENANT_ID"));
+ }
+ });
+
+ it("falls back to TEAMS_APP_TENANT_ID when teamsAppTenantId is not configured", async () => {
+ const args: CreateTeamsAppArgs = {
+ name: appDef.appName!,
+ };
+
+ sinon.stub(teamsDevPortalClient, "getApp").throws(new Error("404"));
+ sinon.stub(teamsDevPortalClient, "importApp").resolves(appDef);
+ sinon.stub(fs, "readFile").callsFake(async () => {
+ const zip = new AdmZip();
+ zip.addFile(Constants.MANIFEST_FILE, Buffer.from(JSON.stringify(new TeamsAppManifest())));
+ zip.addFile("color.png", new Buffer(""));
+ zip.addFile("outline.png", new Buffer(""));
+ return zip.toBuffer();
+ });
+
+ const outputEnvVarNames = new Map