@microsoft/teamsfx-core 1.16.2 → 1.16.3-alpha.39751981b.0

package/build/plugins/solution/fx-solution/debug/util/tasksTransparency.js

@@ -0,0 +1,675 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateSpfxTasks = exports.mergeTasksJson = exports.generateM365Tasks = exports.generateTasks = exports.generateM365TasksJson = exports.generateTasksJson = void 0;
+const tslib_1 = require("tslib");
+const constants_1 = require("../../../../../common/local/constants");
+const comment_json_1 = require("comment-json");
+const commentJson = tslib_1.__importStar(require("comment-json"));
+function generateTasksJson(includeFrontend, includeBackend, includeBot, includeFuncHostedBot, includeSSO, programmingLanguage) {
+    const comment = `
+  // This file is automatically generated by Teams Toolkit.
+  // See https://aka.ms/teamsfx-debug-tasks to know the details and how to customize each task.
+  {}
+  `;
+    return commentJson.assign(commentJson.parse(comment), {
+        version: "2.0.0",
+        tasks: generateTasks(includeFrontend, includeBackend, includeBot, includeFuncHostedBot, includeSSO, programmingLanguage),
+    });
+}
+exports.generateTasksJson = generateTasksJson;
+function generateM365TasksJson(includeFrontend, includeBackend, includeBot, includeFuncHostedBot, includeSSO, programmingLanguage) {
+    const comment = `
+  // This file is automatically generated by Teams Toolkit.
+  // See https://aka.ms/teamsfx-debug-tasks to know the details and how to customize each task.
+  {}
+  `;
+    return commentJson.assign(commentJson.parse(comment), {
+        version: "2.0.0",
+        tasks: generateM365Tasks(includeFrontend, includeBackend, includeBot, includeFuncHostedBot, includeSSO, programmingLanguage),
+    });
+}
+exports.generateM365TasksJson = generateM365TasksJson;
+function generateTasks(includeFrontend, includeBackend, includeBot, includeFuncHostedBot, includeSSO, programmingLanguage) {
+    /**
+     * Referenced by launch.json
+     *   - Start Teams App Locally
+     *
+     * Referenced inside tasks.json
+     *   - Validate & install prerequisites
+     *   - Install npm packages
+     *   - Start local tunnel
+     *   - Set up tab
+     *   - Set up bot
+     *   - Set up SSO
+     *   - Build & upload Teams manifest
+     *   - Start services
+     *   - Start frontend
+     *   - Start backend
+     *   - Install Azure Functions binding extensions
+     *   - Watch backend
+     *   - Start bot
+     *   - Start Azurite emulator
+     */
+    const tasks = [
+        startTeamsAppLocally(includeFrontend, includeBackend, includeBot, includeSSO),
+        validateAndInstallPrerequisites(includeFrontend, includeBackend, includeBot, includeFuncHostedBot),
+        installNPMpackages(includeFrontend, includeBackend, includeBot),
+    ];
+    if (includeBot) {
+        tasks.push(startLocalTunnel());
+    }
+    if (includeFrontend) {
+        tasks.push(setUpTab());
+    }
+    if (includeBot) {
+        tasks.push(setUpBot());
+    }
+    if (includeSSO) {
+        tasks.push(setUpSSO());
+    }
+    tasks.push(buildAndUploadTeamsManifest());
+    tasks.push(startServices(includeFrontend, includeBackend, includeBot));
+    if (includeFrontend) {
+        tasks.push(startFrontend());
+    }
+    if (includeBackend) {
+        tasks.push(startBackend(programmingLanguage));
+        tasks.push(installAzureFunctionsBindingExtensions());
+        if (programmingLanguage === constants_1.ProgrammingLanguage.typescript) {
+            tasks.push(watchBackend());
+        }
+    }
+    if (includeBot) {
+        if (includeFuncHostedBot) {
+            tasks.push(startFuncHostedBot(includeFrontend, programmingLanguage));
+            tasks.push(startAzuriteEmulator());
+            if (programmingLanguage === constants_1.ProgrammingLanguage.typescript) {
+                tasks.push(watchFuncHostedBot());
+            }
+        }
+        else {
+            tasks.push(startBot(includeFrontend));
+        }
+    }
+    return tasks;
+}
+exports.generateTasks = generateTasks;
+function generateM365Tasks(includeFrontend, includeBackend, includeBot, includeFuncHostedBot, includeSSO, programmingLanguage) {
+    /**
+     * Referenced by launch.json
+     *   - Start Teams App Locally
+     *   - Start Teams App Locally & Install App
+     *
+     * Referenced inside tasks.json
+     *   - Validate & install prerequisites
+     *   - Install npm packages
+     *   - Start local tunnel
+     *   - Set up tab
+     *   - Set up bot
+     *   - Set up SSO
+     *   - Build & upload Teams manifest
+     *   - Start services
+     *   - Start frontend
+     *   - Start backend
+     *   - Install Azure Functions binding extensions
+     *   - Watch backend
+     *   - Start bot
+     *   - Start Azurite emulator
+     *   - install app in Teams
+     */
+    const tasks = generateTasks(includeFrontend, includeBackend, includeBot, includeFuncHostedBot, includeSSO, programmingLanguage);
+    tasks.splice(1, 0, startTeamsAppLocallyAndInstallApp(includeFrontend, includeBackend, includeBot, includeSSO));
+    tasks.push(installAppInTeams());
+    return tasks;
+}
+exports.generateM365Tasks = generateM365Tasks;
+function mergeTasksJson(existingData, newData) {
+    const mergedData = commentJson.assign(commentJson.parse(`{}`), existingData);
+    if (mergedData.version === undefined) {
+        mergedData.version = newData.version;
+    }
+    if (mergedData.tasks === undefined) {
+        mergedData.tasks = newData.tasks;
+    }
+    else {
+        const existingTasks = mergedData.tasks;
+        const newTasks = newData.tasks;
+        const keptTasks = new comment_json_1.CommentArray();
+        for (const existingTask of existingTasks) {
+            if (!newTasks.some((newTask) => existingTask.label === newTask.label && existingTask.type === newTask.type)) {
+                keptTasks.push(existingTask);
+            }
+        }
+        mergedData.tasks = new comment_json_1.CommentArray(...keptTasks, ...newTasks);
+    }
+    if (mergedData.inputs === undefined) {
+        mergedData.inputs = newData.inputs;
+    }
+    else if (newData.inputs !== undefined) {
+        const existingInputs = mergedData.inputs;
+        const newInputs = newData.inputs;
+        const keptInputs = new comment_json_1.CommentArray();
+        for (const existingInput of existingInputs) {
+            if (!newInputs.some((newInput) => existingInput.id === newInput.id && existingInput.type === newInput.type)) {
+                keptInputs.push(existingInput);
+            }
+        }
+        mergedData.inputs = new comment_json_1.CommentArray(...keptInputs, ...newInputs);
+    }
+    return mergedData;
+}
+exports.mergeTasksJson = mergeTasksJson;
+function startTeamsAppLocally(includeFrontend, includeBackend, includeBot, includeSSO) {
+    const result = {
+        label: "Start Teams App Locally",
+        dependsOn: ["Validate & install prerequisites", "Install npm packages"],
+        dependsOrder: "sequence",
+    };
+    if (includeBot) {
+        result.dependsOn.push("Start local tunnel");
+    }
+    if (includeFrontend) {
+        result.dependsOn.push("Set up tab");
+    }
+    if (includeBot) {
+        result.dependsOn.push("Set up bot");
+    }
+    if (includeSSO) {
+        result.dependsOn.push("Set up SSO");
+    }
+    result.dependsOn.push("Build & upload Teams manifest", "Start services");
+    return result;
+}
+function startTeamsAppLocallyAndInstallApp(includeFrontend, includeBackend, includeBot, includeSSO) {
+    const result = startTeamsAppLocally(includeFrontend, includeBackend, includeBot, includeSSO);
+    result.label = "Start Teams App Locally & Install App";
+    result.dependsOn.push("install app in Teams");
+    return result;
+}
+function validateAndInstallPrerequisites(includeFrontend, includeBackend, includeBot, includeFuncHostedBot) {
+    const prerequisites = [
+        `"nodejs", // Validate if Node.js is installed.`,
+        `"m365Account", // Sign-in prompt for Microsoft 365 account, then validate if the account enables the sideloading permission.`,
+    ];
+    const ports = [];
+    if (includeFrontend) {
+        prerequisites.push(`"devCert", // Install localhost SSL certificate. It's used to serve the development sites over HTTPS to debug the Tab app in Teams.`);
+        ports.push("53000, // tab service port");
+    }
+    if (includeBackend) {
+        prerequisites.push(`"func", // Install Azure Functions Core Tools. It's used to serve Azure Functions hosted project locally.`, `"dotnet", // Ensure .NET Core SDK is installed. TeamsFx Azure Functions project depends on extra .NET binding extensions for HTTP trigger authorization.`);
+        ports.push("7071, // backend service port", "9229, // backend debug port");
+    }
+    if (includeFuncHostedBot && !includeBackend) {
+        prerequisites.push(`"func", // Install Azure Functions Core Tools. It's used to serve Azure Functions hosted project locally.`);
+    }
+    if (includeBot) {
+        prerequisites.push(`"ngrok", // Install Ngrok. Bot project requires a public message endpoint, and ngrok can help create public tunnel for your local service.`);
+        ports.push("3978, // bot service port", "9239, // bot debug port");
+    }
+    prerequisites.push(`"portOccupancy", // Validate available ports to ensure those local debug ones are not occupied.`);
+    const prerequisitesComment = `
+  [
+    ${prerequisites.join("\n  ")}
+  ]`;
+    const portsComment = `
+  [
+    ${ports.join("\n  ")}
+  ]
+  `;
+    const comment = `{
+    // Check if all required prerequisites are installed and will install them if not.
+    // See https://aka.ms/teamsfx-check-prerequisites-task to know the details and how to customize the args.
+  }`;
+    const task = {
+        label: "Validate & install prerequisites",
+        type: "teamsfx",
+        command: "debug-check-prerequisites",
+        args: {
+            prerequisites: commentJson.parse(prerequisitesComment),
+            portOccupancy: commentJson.parse(portsComment),
+        },
+    };
+    return commentJson.assign(commentJson.parse(comment), task);
+}
+function installNPMpackages(includeFrontend, includeBackend, includeBot) {
+    const comment = `{
+    // Check if all the npm packages are installed and will install them if not.
+    // See https://aka.ms/teamsfx-npm-package-task to know the details and how to customize the args.
+  }`;
+    const result = {
+        label: "Install npm packages",
+        type: "teamsfx",
+        command: "debug-npm-install",
+        args: {
+            projects: [],
+        },
+    };
+    if (includeFrontend) {
+        result.args.projects.push({
+            cwd: "${workspaceFolder}/tabs",
+            npmInstallArgs: ["--no-audit"],
+        });
+    }
+    if (includeBackend) {
+        result.args.projects.push({
+            cwd: "${workspaceFolder}/api",
+            npmInstallArgs: ["--no-audit"],
+        });
+    }
+    if (includeBot) {
+        result.args.projects.push({
+            cwd: "${workspaceFolder}/bot",
+            npmInstallArgs: ["--no-audit"],
+        });
+    }
+    return commentJson.assign(commentJson.parse(comment), result);
+}
+function installAzureFunctionsBindingExtensions() {
+    const comment = `{
+    // TeamsFx Azure Functions project depends on extra Azure Functions binding extensions for HTTP trigger authorization.
+  }`;
+    const task = {
+        label: "Install Azure Functions binding extensions",
+        type: "shell",
+        command: "dotnet build extensions.csproj -o ./bin --ignore-failed-sources",
+        options: {
+            cwd: "${workspaceFolder}/api",
+            env: {
+                PATH: "${command:fx-extension.get-dotnet-path}${env:PATH}",
+            },
+        },
+        presentation: {
+            reveal: "silent",
+        },
+    };
+    return commentJson.assign(commentJson.parse(comment), task);
+}
+function startLocalTunnel() {
+    const comment = `{
+    // Start the local tunnel service to forward public ngrok URL to local port and inspect traffic.
+    // See https://aka.ms/teamsfx-local-tunnel-task to know the details and how to customize the args.
+  }`;
+    const task = {
+        label: "Start local tunnel",
+        type: "teamsfx",
+        command: "debug-start-local-tunnel",
+        args: {
+            ngrokArgs: "http 3978 --log=stdout --log-format=logfmt",
+        },
+        isBackground: true,
+        problemMatcher: "$teamsfx-local-tunnel-watch",
+    };
+    return commentJson.assign(commentJson.parse(comment), task);
+}
+function setUpTab() {
+    const comment = `{
+    // Prepare local launch information for Tab.
+    // See https://aka.ms/teamsfx-debug-set-up-tab-task to know the details and how to customize the args.
+  }`;
+    const task = {
+        label: "Set up tab",
+        type: "teamsfx",
+        command: "debug-set-up-tab",
+        args: {
+            baseUrl: "https://localhost:53000",
+        },
+    };
+    return commentJson.assign(commentJson.parse(comment), task);
+}
+function setUpBot() {
+    const comment = `{
+    // Register resources and prepare local launch information for Bot.
+    // See https://aka.ms/teamsfx-debug-set-up-bot-task to know the details and how to customize the args.
+  }`;
+    const existingBot = `
+  {
+    //// Enter you own bot information if using the existing bot. ////
+    // "botId": "",
+    // "botPassword": "", // use plain text or environment variable reference like \${env:BOT_PASSWORD}
+  }
+  `;
+    const task = {
+        label: "Set up bot",
+        type: "teamsfx",
+        command: "debug-set-up-bot",
+        args: commentJson.assign(commentJson.parse(existingBot), {
+            botMessagingEndpoint: "/api/messages",
+        }),
+    };
+    return commentJson.assign(commentJson.parse(comment), task);
+}
+function setUpSSO() {
+    const comment = `{
+    // Register resources and prepare local launch information for SSO functionality.
+    // See https://aka.ms/teamsfx-debug-set-up-sso-task to know the details and how to customize the args.
+  }`;
+    const existingAAD = `
+  {
+    //// Enter you own AAD app information if using the existing AAD app. ////
+    // "objectId": "",
+    // "clientId": "",
+    // "clientSecret": "", // use plain text or environment variable reference like \${env:CLIENT_SECRET}
+    // "accessAsUserScopeId": "
+  }
+  `;
+    const task = {
+        label: "Set up SSO",
+        type: "teamsfx",
+        command: "debug-set-up-sso",
+        args: commentJson.parse(existingAAD),
+    };
+    return commentJson.assign(commentJson.parse(comment), task);
+}
+function buildAndUploadTeamsManifest() {
+    const comment = `
+  {
+    // Build and upload Teams manifest.
+    // See https://aka.ms/teamsfx-debug-prepare-manifest-task to know the details and how to customize the args.
+  }`;
+    const existingApp = `
+  {
+    //// Enter your own Teams app package path if using the existing Teams manifest. ////
+    // "appPackagePath": ""
+  }
+  `;
+    const task = {
+        label: "Build & upload Teams manifest",
+        type: "teamsfx",
+        command: "debug-prepare-manifest",
+        args: commentJson.parse(existingApp),
+    };
+    return commentJson.assign(commentJson.parse(comment), task);
+}
+function startFrontend() {
+    return {
+        label: "Start frontend",
+        type: "shell",
+        command: "npm run dev:teamsfx",
+        isBackground: true,
+        options: {
+            cwd: "${workspaceFolder}/tabs",
+        },
+        problemMatcher: {
+            pattern: {
+                regexp: "^.*$",
+                file: 0,
+                location: 1,
+                message: 2,
+            },
+            background: {
+                activeOnStart: true,
+                beginsPattern: ".*",
+                endsPattern: "Compiled|Failed|compiled|failed",
+            },
+        },
+    };
+}
+function startBackend(programmingLanguage) {
+    const result = {
+        label: "Start backend",
+        type: "shell",
+        command: "npm run dev:teamsfx",
+        isBackground: true,
+        options: {
+            cwd: "${workspaceFolder}/api",
+            env: {
+                PATH: "${command:fx-extension.get-func-path}${env:PATH}",
+            },
+        },
+        problemMatcher: {
+            pattern: {
+                regexp: "^.*$",
+                file: 0,
+                location: 1,
+                message: 2,
+            },
+            background: {
+                activeOnStart: true,
+                beginsPattern: "^.*(Job host stopped|signaling restart).*$",
+                endsPattern: "^.*(Worker process started and initialized|Host lock lease acquired by instance ID).*$",
+            },
+        },
+        presentation: {
+            reveal: "silent",
+        },
+        dependsOn: ["Install Azure Functions binding extensions"],
+    };
+    if (programmingLanguage === constants_1.ProgrammingLanguage.typescript) {
+        result.dependsOn.push("Watch backend");
+    }
+    return result;
+}
+function watchBackend() {
+    return {
+        label: "Watch backend",
+        type: "shell",
+        command: "npm run watch:teamsfx",
+        isBackground: true,
+        options: {
+            cwd: "${workspaceFolder}/api",
+        },
+        problemMatcher: "$tsc-watch",
+        presentation: {
+            reveal: "silent",
+        },
+    };
+}
+function watchFuncHostedBot() {
+    return {
+        label: "Watch bot",
+        type: "shell",
+        command: "npm run watch:teamsfx",
+        isBackground: true,
+        options: {
+            cwd: "${workspaceFolder}/bot",
+        },
+        problemMatcher: "$tsc-watch",
+        presentation: {
+            reveal: "silent",
+        },
+    };
+}
+function startBot(includeFrontend) {
+    const result = {
+        label: "Start bot",
+        type: "shell",
+        command: "npm run dev:teamsfx",
+        isBackground: true,
+        options: {
+            cwd: "${workspaceFolder}/bot",
+        },
+        problemMatcher: {
+            pattern: [
+                {
+                    regexp: "^.*$",
+                    file: 0,
+                    location: 1,
+                    message: 2,
+                },
+            ],
+            background: {
+                activeOnStart: true,
+                beginsPattern: "[nodemon] starting",
+                endsPattern: "restify listening to|Bot/ME service listening at|[nodemon] app crashed",
+            },
+        },
+    };
+    if (includeFrontend) {
+        result.presentation = { reveal: "silent" };
+    }
+    return result;
+}
+function startFuncHostedBot(includeFrontend, programmingLanguage) {
+    const result = {
+        label: "Start bot",
+        type: "shell",
+        command: "npm run dev:teamsfx",
+        isBackground: true,
+        options: {
+            cwd: "${workspaceFolder}/bot",
+            env: {
+                PATH: "${command:fx-extension.get-func-path}${env:PATH}",
+            },
+        },
+        problemMatcher: {
+            pattern: {
+                regexp: "^.*$",
+                file: 0,
+                location: 1,
+                message: 2,
+            },
+            background: {
+                activeOnStart: true,
+                beginsPattern: "^.*(Job host stopped|signaling restart).*$",
+                endsPattern: "^.*(Worker process started and initialized|Host lock lease acquired by instance ID).*$",
+            },
+        },
+    };
+    if (includeFrontend) {
+        result.presentation = { reveal: "silent" };
+    }
+    const dependsOn = ["Start Azurite emulator"];
+    if (programmingLanguage === constants_1.ProgrammingLanguage.typescript) {
+        dependsOn.push("Watch bot");
+    }
+    result.dependsOn = dependsOn;
+    return result;
+}
+function startServices(includeFrontend, includeBackend, includeBot) {
+    const dependsOn = [];
+    if (includeFrontend) {
+        dependsOn.push("Start frontend");
+    }
+    if (includeBackend) {
+        dependsOn.push("Start backend");
+    }
+    if (includeBot) {
+        dependsOn.push("Start bot");
+    }
+    return {
+        label: "Start services",
+        dependsOn,
+    };
+}
+function startAzuriteEmulator() {
+    return {
+        label: "Start Azurite emulator",
+        type: "shell",
+        command: "npm run prepare-storage:teamsfx",
+        isBackground: true,
+        problemMatcher: {
+            pattern: [
+                {
+                    regexp: "^.*$",
+                    file: 0,
+                    location: 1,
+                    message: 2,
+                },
+            ],
+            background: {
+                activeOnStart: true,
+                beginsPattern: "Azurite",
+                endsPattern: "successfully listening",
+            },
+        },
+        options: {
+            cwd: "${workspaceFolder}/bot",
+        },
+        presentation: { reveal: "silent" },
+    };
+}
+function installAppInTeams() {
+    return {
+        label: "install app in Teams",
+        type: "shell",
+        command: "exit ${command:fx-extension.install-app-in-teams}",
+        presentation: {
+            reveal: "never",
+        },
+    };
+}
+function generateSpfxTasks() {
+    return [
+        {
+            label: "Validate & install prerequisites",
+            type: "teamsfx",
+            command: "debug-check-prerequisites",
+            args: {
+                prerequisites: ["nodejs"],
+            },
+        },
+        {
+            label: "Install npm packages",
+            type: "teamsfx",
+            command: "debug-npm-install",
+            args: {
+                projects: [
+                    {
+                        cwd: "${workspaceFolder}/SPFx",
+                        npmInstallArgs: ["--no-audit"],
+                    },
+                ],
+                forceUpdate: false,
+            },
+        },
+        {
+            label: "gulp trust-dev-cert",
+            type: "process",
+            command: "node",
+            args: ["${workspaceFolder}/SPFx/node_modules/gulp/bin/gulp.js", "trust-dev-cert"],
+            options: {
+                cwd: "${workspaceFolder}/SPFx",
+            },
+            dependsOn: "Install npm packages",
+        },
+        {
+            label: "gulp serve",
+            type: "process",
+            command: "node",
+            args: ["${workspaceFolder}/SPFx/node_modules/gulp/bin/gulp.js", "serve", "--nobrowser"],
+            problemMatcher: [
+                {
+                    pattern: [
+                        {
+                            regexp: ".",
+                            file: 1,
+                            location: 2,
+                            message: 3,
+                        },
+                    ],
+                    background: {
+                        activeOnStart: true,
+                        beginsPattern: "^.*Starting gulp.*",
+                        endsPattern: "^.*Finished subtask 'reload'.*",
+                    },
+                },
+            ],
+            isBackground: true,
+            options: {
+                cwd: "${workspaceFolder}/SPFx",
+            },
+            dependsOn: "gulp trust-dev-cert",
+        },
+        {
+            label: "prepare local environment",
+            type: "shell",
+            command: "exit ${command:fx-extension.pre-debug-check}",
+        },
+        {
+            label: "prepare dev env",
+            dependsOn: ["Validate & install prerequisites", "prepare local environment", "gulp serve"],
+            dependsOrder: "sequence",
+        },
+        {
+            label: "Terminate All Tasks",
+            command: "echo ${input:terminate}",
+            type: "shell",
+            problemMatcher: [],
+        },
+    ];
+}
+exports.generateSpfxTasks = generateSpfxTasks;
+//# sourceMappingURL=tasksTransparency.js.map