[tsp-client] Fix writing additional directory (#8662)

* account for non-list additional dir

* unify tsp-location.yaml creation

* docs

* add test

* add read test

* release prep

* update release date

---------

Co-authored-by: Catalina Peralta <caperal@microsoft.com>

Author: catalinaperalta

tools/tsp-client/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release
 
+## 2024-07-23 - 0.9.4
+
+- Fixed issue where one additional directory entry is treated as a string instead of an array. (#8551)
+
 ## 2024-07-15 - 0.9.3
 
 - Add autorest and plugins as dependencies, and run the packages from their install folders, to guarantee the versions don't change after install.

tools/tsp-client/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-client-generator-cli",
-  "version": "0.9.3",
+  "version": "0.9.4",
   "description": "A tool to generate Azure SDKs from TypeSpec",
   "main": "dist/index.js",
   "homepage": "https://github.com/Azure/azure-sdk-tools/tree/main/tools/tsp-client#readme",

tools/tsp-client/package.json

@@ -35,7 +35,13 @@ export async function readTspLocation(rootDir: string): Promise<TspLocation> {
 
       // Normalize the directory path and remove trailing slash
       tspLocation.directory = normalizeDirectory(tspLocation.directory);
-      tspLocation.additionalDirectories = tspLocation.additionalDirectories.map(normalizeDirectory);
+      if (typeof tspLocation.additionalDirectories === "string") {
+        tspLocation.additionalDirectories = [normalizeDirectory(tspLocation.additionalDirectories)];
+      } else {
+        // List of additional directories
+        tspLocation.additionalDirectories =
+          tspLocation.additionalDirectories.map(normalizeDirectory);
+      }
 
       return tspLocation;
     }
@@ -46,10 +52,9 @@ export async function readTspLocation(rootDir: string): Promise<TspLocation> {
   }
 }
 
-
 export async function getEmitterFromRepoConfig(emitterPath: string): Promise<string> {
   await access(emitterPath);
-  const data = await readFile(emitterPath, 'utf8');
+  const data = await readFile(emitterPath, "utf8");
   const obj = JSON.parse(data);
   if (!obj || !obj.dependencies) {
     throw new Error("Invalid emitter-package.json");
@@ -66,6 +71,6 @@ export async function getEmitterFromRepoConfig(emitterPath: string): Promise<str
 }
 
 export function normalizeDirectory(directory: string): string {
-    const normalizedDir = normalizePath(directory);
-    return normalizedDir.endsWith("/") ? normalizedDir.slice(0, -1) : normalizedDir;
+  const normalizedDir = normalizePath(directory);
+  return normalizedDir.endsWith("/") ? normalizedDir.slice(0, -1) : normalizedDir;
 }

tools/tsp-client/src/fs.ts

@@ -3,12 +3,12 @@ import { createTempDirectory, removeDirectory, readTspLocation, getEmitterFromRe
 import { Logger, printBanner, enableDebug, printVersion } from "./log.js";
 import { TspLocation, compileTsp, discoverMainFile, resolveTspConfigUrl } from "./typespec.js";
 import { getOptions } from "./options.js";
-import { mkdir, writeFile, cp, readFile, stat, rename, unlink } from "node:fs/promises";
+import { mkdir, cp, readFile, stat, rename, unlink } from "node:fs/promises";
 import { addSpecFiles, checkoutCommit, cloneRepo, getRepoRoot, sparseCheckout } from "./git.js";
 import { doesFileExist } from "./network.js";
 import { parse as parseYaml } from "yaml";
 import { joinPaths, normalizePath, resolvePath } from "@typespec/compiler";
-import { formatAdditionalDirectories, getAdditionalDirectoryName, getPathToDependency, getServiceDir, makeSparseSpecDir } from "./utils.js";
+import { getAdditionalDirectoryName, getPathToDependency, getServiceDir, makeSparseSpecDir, writeTspLocationYaml } from "./utils.js";
 import { resolve } from "node:path";
 import { config as dotenvConfig } from "dotenv";
 
@@ -58,10 +58,13 @@ async function sdkInit(
     }
     const newPackageDir = joinPaths(outputDir, serviceDir, packageDir!)
     await mkdir(newPackageDir, { recursive: true });
-    const additionalDirOutput = formatAdditionalDirectories(configYaml?.parameters?.dependencies?.additionalDirectories);
-    await writeFile(
-      joinPaths(newPackageDir, "tsp-location.yaml"),
-    `directory: ${resolvedConfigUrl.path}\ncommit: ${resolvedConfigUrl.commit}\nrepo: ${resolvedConfigUrl.repo}\nadditionalDirectories:${additionalDirOutput}\n`);
+    const tspLocationData: TspLocation = {
+        directory: resolvedConfigUrl.path,
+        commit: resolvedConfigUrl.commit,
+        repo: resolvedConfigUrl.repo,
+        additionalDirectories: configYaml?.parameters?.dependencies?.additionalDirectories,
+        };
+    await writeTspLocationYaml(tspLocationData, newPackageDir);
     Logger.debug(`Removing sparse-checkout directory ${cloneDir}`);
     await removeDirectory(cloneDir);
     return newPackageDir;
@@ -81,7 +84,6 @@ async function sdkInit(
     }
     const configYaml = parseYaml(data);
     const serviceDir = getServiceDir(configYaml, emitter);
-    const additionalDirOutput = formatAdditionalDirectories(configYaml?.parameters?.dependencies?.additionalDirectories);
     const packageDir = configYaml?.options?.[emitter]?.["package-dir"];
     if (!packageDir) {
       throw new Error(`Missing package-dir in ${emitter} options of tspconfig.yaml. Please refer to https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml for the right schema.`);
@@ -96,8 +98,13 @@ async function sdkInit(
         directory = matchRes.groups!["path"]!;
       }
     }
-    writeFile(joinPaths(newPackageDir, "tsp-location.yaml"),
-          `directory: ${directory}\ncommit: ${commit}\nrepo: ${repo}\nadditionalDirectories:${additionalDirOutput}\n`);
+    const tspLocationData: TspLocation = {
+        directory: directory,
+        commit: commit ?? "",
+        repo: repo ?? "",
+        additionalDirectories: configYaml?.parameters?.dependencies?.additionalDirectories,
+        };
+    await writeTspLocationYaml(tspLocationData, newPackageDir);
     return newPackageDir;
   }
 }
@@ -321,13 +328,13 @@ async function main() {
           const tspLocation: TspLocation = await readTspLocation(rootUrl);
           tspLocation.commit = options.commit ?? tspLocation.commit;
           tspLocation.repo = options.repo ?? tspLocation.repo;
-          await writeFile(joinPaths(rootUrl, "tsp-location.yaml"), `directory: ${tspLocation.directory}\ncommit: ${tspLocation.commit}\nrepo: ${tspLocation.repo}\nadditionalDirectories: ${tspLocation.additionalDirectories}`);
+          await writeTspLocationYaml(tspLocation, rootUrl);
         } else if (options.tspConfig) {
           const tspLocation: TspLocation = await readTspLocation(rootUrl);
           const tspConfig = resolveTspConfigUrl(options.tspConfig);
           tspLocation.commit = tspConfig.commit ?? tspLocation.commit;
           tspLocation.repo = tspConfig.repo ?? tspLocation.repo;
-          await writeFile(joinPaths(rootUrl, "tsp-location.yaml"), `directory: ${tspLocation.directory}\ncommit: ${tspLocation.commit}\nrepo: ${tspLocation.repo}\nadditionalDirectories: ${tspLocation.additionalDirectories}`);
+          await writeTspLocationYaml(tspLocation, rootUrl);
         }
         await syncTspFiles(rootUrl, options.localSpecRepo);
         await generate({ rootUrl, noCleanup: options.noCleanup, additionalEmitterOptions: options.emitterOptions});

tools/tsp-client/src/index.ts

@@ -1,9 +1,10 @@
 import { joinPaths, normalizeSlashes } from "@typespec/compiler";
 import { randomUUID } from "node:crypto";
-import { access, constants, mkdir } from "node:fs/promises";
+import { access, constants, mkdir, writeFile } from "node:fs/promises";
 import { dirname, join } from "node:path";
 import { fileURLToPath } from "node:url";
 import { Logger } from "./log.js";
+import { TspLocation } from "./typespec.js";
 
 export function formatAdditionalDirectories(additionalDirectories?: string[]): string {
     let additionalDirOutput = "";
@@ -77,3 +78,19 @@ export async function getPathToDependency(dependency: string): Promise<string> {
         }
     }
 }
+
+/**
+ * Writes tsp-location.yaml file at the given projectPath. Ensures additional directories are formatted correctly.
+ *
+ * @param tspLocation TspLocation object containing tsp location information.
+ * @param projectPath Path to the project.
+ */
+export async function writeTspLocationYaml(
+    tspLocation: TspLocation,
+    projectPath: string,
+  ): Promise<void> {
+    await writeFile(
+      joinPaths(projectPath, "tsp-location.yaml"),
+      `directory: ${tspLocation.directory}\ncommit: ${tspLocation.commit}\nrepo: ${tspLocation.repo}\nadditionalDirectories: ${formatAdditionalDirectories(tspLocation.additionalDirectories)}`,
+    );
+  }

tools/tsp-client/src/utils.ts

@@ -0,0 +1,5 @@
+directory: specification/contosowidgetmanager/Contoso.WidgetManager
+commit: 1234567
+repo: foo
+additionalDirectories: 
+- specification/contosowidgetmanager/Contoso.WidgetManager.Shared

tools/tsp-client/test/examples/tsp-location.yaml

@@ -1,8 +1,10 @@
 import { assert } from "chai";
 import { normalizeDirectory, readTspLocation } from "../src/fs.js";
 import { describe, it } from "node:test";
+import { writeTspLocationYaml } from "../src/utils.js";
+import { stat } from "node:fs/promises";
 
-describe("Parse tsp-location.yaml", function () {
+describe("Verify tsp-location.yaml", function () {
   it("Normalize tsp-location.yaml directories", async function () {
     const tspLocation = await readTspLocation("./test/examples/sdk/badtsplocation");
     const directory = normalizeDirectory(tspLocation.directory);
@@ -20,4 +22,32 @@ describe("Parse tsp-location.yaml", function () {
       );
     }
   });
+
+  it("Write tsp-location.yaml", async function () {
+    const tspLocation = {
+      directory: "specification/contosowidgetmanager/Contoso.WidgetManager",
+      commit: "1234567",
+      repo: "foo",
+      additionalDirectories: [
+        "specification/contosowidgetmanager/Contoso.WidgetManager.Shared",
+      ],
+    };
+    await writeTspLocationYaml(tspLocation, "./test/examples/");
+
+    const tspLocationFile = await stat("./test/examples/tsp-location.yaml");
+    assert.isTrue(tspLocationFile.isFile());
+  });
+
+  it("Verify read tsp-location.yaml", async function () {
+    const tspLocation = await readTspLocation("./test/examples/");
+    assert.equal(tspLocation.directory, "specification/contosowidgetmanager/Contoso.WidgetManager");
+    assert.equal(tspLocation.commit, "1234567");
+    assert.equal(tspLocation.repo, "foo");
+    assert.typeOf(tspLocation.additionalDirectories, "array");
+    assert.equal(tspLocation.additionalDirectories?.length, 1);
+    assert.equal(
+      tspLocation.additionalDirectories?.[0],
+      "specification/contosowidgetmanager/Contoso.WidgetManager.Shared",
+    );
+  });
 });