[tsp-client] Fix tsp compile diagnostics logging (#8529)

* fix tsp compile diagnostics logging

* update changelog and package version

* use typespec/compiler format method

* add test

* update changelog date

* changelog

* nit fix changelog wording

---------

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

Author: catalinaperalta

tools/tsp-client/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release
 
+## 2024-07-02 - 0.9.1
+
+- Fix error logging after the `compile()` call and exit if diagnostics are encountered.
+- Use `formatDiagnostic()` from "@typespec/compiler" to report diagnostics after compiling.
+
 ## 2024-06-21 - 0.9.0
 
 - Prefer the `service-dir` parameter in the emitter configurations in tspconfig.yaml if specified.

tools/tsp-client/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-client-generator-cli",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "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",
@@ -17,7 +17,7 @@
     "clean": "rimraf ./dist ./types",
     "example": "npx ts-node src/index.ts update",
     "prepack": "npm run build",
-    "test": "mocha"
+    "test": "mocha --exclude **/examples/**"
   },
   "author": "Microsoft Corporation",
   "license": "MIT",
@@ -39,7 +39,7 @@
     "@types/prompt-sync": "^4.2.1",
     "@typespec/compiler": "0.50.0",
     "chai": "^4.3.7",
-    "mocha": "^10.2.0",
+    "mocha": "^10.5.2",
     "prettier": "^3.0.1",
     "rimraf": "^5.0.1",
     "ts-node": "^10.9.1",

tools/tsp-client/package.json

@@ -1,4 +1,4 @@
-import { resolvePath, getDirectoryPath, ResolveCompilerOptionsOptions } from "@typespec/compiler";
+import { resolvePath, getDirectoryPath, ResolveCompilerOptionsOptions, formatDiagnostic } from "@typespec/compiler";
 import { ModuleResolutionResult, resolveModule, ResolveModuleHost } from "@typespec/compiler/module-resolver";
 import { Logger } from "./log.js";
 import { readFile, readdir, realpath, stat } from "fs/promises";
@@ -66,7 +66,7 @@ export async function compileTsp({
   saveInputs?: boolean;
 }) {
   const parsedEntrypoint = getDirectoryPath(resolvedMainFilePath);
-  const { compile, NodeHost, getSourceLocation, resolveCompilerOptions } = await importTsp(parsedEntrypoint);
+  const { compile, NodeHost, resolveCompilerOptions } = await importTsp(parsedEntrypoint);
 
   const outputDir = resolvePath(outputPath);
   const overrideOptions: Record<string, Record<string, string>> = {
@@ -107,12 +107,9 @@ export async function compileTsp({
 
   if (program.diagnostics.length > 0) {
     for (const diagnostic of program.diagnostics) {
-      const location = getSourceLocation(diagnostic.target);
-      const source = location ? location.file.path : "unknown";
-      console.error(
-        `${diagnostic.severity}: ${diagnostic.code} - ${diagnostic.message} @ ${source}`,
-      );
+      Logger.error(formatDiagnostic(diagnostic));
     }
+    process.exit(1);
   } else {
     Logger.success("generation complete");
   }

tools/tsp-client/src/typespec.ts

@@ -0,0 +1,70 @@
+// DONT specify @useDependency to get a diagnostic reported
+
+import "@typespec/http";
+import "@typespec/rest";
+import "@typespec/versioning";
+import "@azure-tools/typespec-azure-core";
+
+using TypeSpec.Http;
+using TypeSpec.Rest;
+using TypeSpec.Versioning;
+using Azure.Core;
+using Azure.Core.Traits;
+
+@useAuth(
+  ApiKeyAuth<ApiKeyLocation.header, "api-key"> | OAuth2Auth<[
+    {
+      type: OAuth2FlowType.implicit,
+      authorizationUrl: "https://login.contoso.com/common/oauth2/v2.0/authorize",
+      scopes: ["https://widget.contoso.com/.default"],
+    }
+  ]>
+)
+@service({
+  title: "Contoso Widget Manager",
+})
+@server(
+  "{endpoint}/widget",
+  "Contoso Widget APIs",
+  {
+    /** 
+Supported Widget Services endpoints (protocol and hostname, for example:
+https://westus.api.widget.contoso.com).
+ */
+    endpoint: string,
+  }
+)
+@versioned(Contoso.WidgetManager.Versions)
+namespace Contoso.WidgetManager;
+
+/** The Contoso Widget Manager service version. */
+enum Versions {
+  /** Version 2022-08-31 */
+  // @useDependency(Azure.Core.Versions.v1_0_Preview_2)
+  `2022-08-30`,
+}
+
+/** A widget. */
+@resource("widgets")
+model Widget {
+  /** The widget name. */
+  @key("widgetName")
+  @visibility("read")
+  name: string;
+
+  /** The widget color. */
+  color: string;
+
+  /** The ID of the widget's manufacturer. */
+  manufacturerId: string;
+}
+
+alias ServiceTraits = SupportsRepeatableRequests &
+  SupportsConditionalRequests &
+  SupportsClientRequestId;
+
+alias Operations = Azure.Core.ResourceOperations<ServiceTraits>;
+
+interface Widgets {
+    getWidget is Operations.ResourceRead<Widget>;
+}

tools/tsp-client/test/examples/specification/diagnostics/main.tsp

@@ -0,0 +1,34 @@
+parameters:
+  "service-dir":
+    default: "sdk/contosowidgetmanager"
+emit:
+  - "@azure-tools/typespec-autorest"
+linter:
+  extends:
+    - "@azure-tools/typespec-azure-rulesets/data-plane"
+options:
+  "@azure-tools/typespec-autorest":
+    azure-resource-provider-folder: "data-plane"
+    emit-lro-options: "none"
+    emitter-output-dir: "{project-root}/.."
+    examples-directory: "examples"
+    output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/widgets.json"
+  "@azure-tools/typespec-python":
+    package-dir: "azure-contoso-widgetmanager"
+    package-name: "{package-dir}"
+    flavor: azure
+  "@azure-tools/typespec-csharp":
+    package-dir: "Azure.Template.Contoso"
+    clear-output-folder: true
+    model-namespace: false
+    namespace: "{package-dir}"
+    flavor: azure
+  "@azure-tools/typespec-ts":
+    package-dir: "contosowidgetmanager-rest"
+    packageDetails:
+      name: "@azure-rest/contoso-widgetmanager-rest"
+    flavor: azure
+  "@azure-tools/typespec-java":
+    package-dir: "azure-contoso-widgetmanager"
+    namespace: com.azure.contoso.widgetmanager
+    flavor: azure

tools/tsp-client/test/examples/specification/diagnostics/tspconfig.yaml

@@ -0,0 +1,23 @@
+import { assert } from "chai";
+import { compileTsp } from "../src/typespec.js";
+import { describe, it } from "node:test";
+import { joinPaths } from "@typespec/compiler";
+
+describe("Check diagnostic reporting", function () {
+  it("Check diagnostic format", async function () {
+        compileTsp({
+            emitterPackage: "@azure-tools/typespec-ts",
+            outputPath: joinPaths(process.cwd(), "examples"),
+            resolvedMainFilePath: joinPaths(process.cwd(), "examples", "specification", "diagnostics", "main.tsp"),
+            additionalEmitterOptions: "",
+            saveInputs: false
+        }).then(
+            () => {
+                assert.fail("Expected error but got none");
+            },
+            (e) => {
+                assert.ok(e.message.includes("test/examples/specification/diagnostics/main.tsp:38:19 - error @typespec/versioning/using-versioned-library: Namespace 'Contoso.WidgetManager' is referencing types from versioned namespace 'Azure.Core' but didn't specify which versions with @useDependency."));
+            }
+        );
+  });
+});