tsp, support flavor flag from typespec config (#2609)

* add flavor option and make nonbranding as default * remove branded flag related logic * update according to comments * update version * update version and format * update according to comments * format * add package-dir option and add the related check logics * format * update according to comments * update according to comments
Azure · Mar 8, 2024 · 47cac99 · 47cac99
1 parent 74f51a7
commit 47cac99
Show file tree

Hide file tree

Showing 10 changed files with 53 additions and 23 deletions.
diff --git a/extension-base/src/main/java/com/azure/autorest/extension/base/plugin/JavaSettings.java b/extension-base/src/main/java/com/azure/autorest/extension/base/plugin/JavaSettings.java
@@ -31,7 +31,7 @@ public class JavaSettings {
     private static final Map<String, Object> SIMPLE_JAVA_SETTINGS = new HashMap<>();
     private static Logger logger;
     private final boolean useKeyCredential;
-    private final boolean branded;
+    private final String flavor;
     private final boolean noCustomHeaders;
 
     static void setHeader(String value) {
@@ -175,7 +175,7 @@ public static JavaSettings getInstance() {
                 getBooleanValue(host, "use-key-credential", false),
                 getBooleanValue(host, "null-byte-array-maps-to-empty-array", false),
                 getBooleanValue(host, "graal-vm-config", false),
-                getBooleanValue(host, "branded", true)
+                getStringValue(host, "flavor", "Azure")
             );
         }
         return instance;
@@ -264,7 +264,7 @@ public static JavaSettings getInstance() {
      * @param nullByteArrayMapsToEmptyArray If set to true, {@code ArrayType.BYTE_ARRAY} will return an empty array
      * instead of null when the default value expression is null.
      * @param generateGraalVmConfig If set to true, the generated client will have support for GraalVM.
-     * @param branded Whether to generate with Azure branding.
+     * @param flavor The brand name we use to geneate SDK.
      */
     private JavaSettings(AutorestSettings autorestSettings,
         Map<String, Object> modelerSettings,
@@ -327,7 +327,7 @@ private JavaSettings(AutorestSettings autorestSettings,
         boolean useKeyCredential,
         boolean nullByteArrayMapsToEmptyArray,
         boolean generateGraalVmConfig,
-        boolean branded) {
+        String flavor) {
 
         this.autorestSettings = autorestSettings;
         this.modelerSettings = new ModelerSettings(modelerSettings);
@@ -425,7 +425,7 @@ private JavaSettings(AutorestSettings autorestSettings,
         this.useKeyCredential = useKeyCredential;
         this.nullByteArrayMapsToEmptyArray = nullByteArrayMapsToEmptyArray;
         this.generateGraalVmConfig = generateGraalVmConfig;
-        this.branded = branded;
+        this.flavor = flavor;
     }
 
     /**
@@ -434,7 +434,7 @@ private JavaSettings(AutorestSettings autorestSettings,
      * @return Whether to generate with Azure branding.
      */
     public boolean isBranded() {
-        return branded;
+        return "azure".equalsIgnoreCase(this.flavor);
     }
 
     private final String keyCredentialHeaderName;
@@ -519,6 +519,12 @@ public boolean urlAsString() {
     }
 
     private final boolean uuidAsString;
+
+    /**
+     * Whether to use string for uuid.
+     *
+     * @return Whether to use string for uuid.
+     */
     public boolean uuidAsString() {
         return uuidAsString;
     }

diff --git a/typespec-extension/changelog.md b/typespec-extension/changelog.md
@@ -1,5 +1,11 @@
 # Release History
 
+## 0.15.0 (2024-03-08)
+
+Compatible with compiler 0.54.
+
+- Supported "flavor" from typespec config.
+
 ## 0.14.1 (2024-03-07)
 
 Compatible with compiler 0.54.

diff --git a/typespec-extension/package-lock.json b/typespec-extension/package-lock.json
diff --git a/typespec-extension/package.json b/typespec-extension/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-java",
-  "version": "0.14.1",
+  "version": "0.15.0",
   "description": "TypeSpec library for emitting Java client from the TypeSpec REST protocol binding",
   "keywords": [
     "TypeSpec"

diff --git a/typespec-extension/src/code-model-builder.ts b/typespec-extension/src/code-model-builder.ts
@@ -365,7 +365,7 @@ export class CodeModelBuilder {
                 // HTTP Authentication should use "Basic token" or "Bearer token"
                 schemeOrApiKeyPrefix = pascalCase(schemeOrApiKeyPrefix);
 
-                if (!(this.options.branded === false)) {
+                if (this.isBranded()) {
                   // Azure would not allow BasicAuth or BearerAuth
                   this.logWarning(`{scheme.scheme} auth method is currently not supported.`);
                   continue;
@@ -389,6 +389,10 @@ export class CodeModelBuilder {
     }
   }
 
+  private isBranded(): boolean {
+    return !this.options["flavor"] || this.options["flavor"].toLocaleLowerCase() === "azure";
+  }
+
   private isInternal(context: SdkContext, operation: Operation): boolean {
     const access = getAccess(operation);
     if (access) {

diff --git a/typespec-extension/src/emitter.ts b/typespec-extension/src/emitter.ts
@@ -16,8 +16,9 @@ import { fileURLToPath } from "url";
 export interface EmitterOptions {
   "namespace"?: string;
   "output-dir"?: string;
+  "package-dir"?: string;
 
-  "branded"?: boolean;
+  "flavor"?: string;
 
   "service-name"?: string;
   "service-versions"?: string[];
@@ -59,8 +60,9 @@ const EmitterOptionsSchema: JSONSchemaType<EmitterOptions> = {
   properties: {
     "namespace": { type: "string", nullable: true },
     "output-dir": { type: "string", nullable: true },
+    "package-dir": { type: "string", nullable: true },
 
-    "branded": { type: "boolean", nullable: true, default: true },
+    "flavor": { type: "string", nullable: true, default: "Azure" },
 
     // service
     "service-name": { type: "string", nullable: true },
@@ -106,6 +108,15 @@ export const $lib = createTypeSpecLibrary({
 export async function $onEmit(context: EmitContext<EmitterOptions>) {
   const program = context.program;
   const options = context.options;
+  if (!options["flavor"]) {
+    if (options["package-dir"]?.toLocaleLowerCase().startsWith("azure")) {
+      // Azure package
+      options["flavor"] = "Azure";
+    } else {
+      // default
+      options["flavor"] = "Azure";
+    }
+  }
   const builder = new CodeModelBuilder(program, context);
   const codeModel = await builder.build();
 

diff --git a/typespec-extension/src/main/java/com/azure/autorest/TypeSpecPlugin.java b/typespec-extension/src/main/java/com/azure/autorest/TypeSpecPlugin.java
@@ -291,9 +291,11 @@ public TypeSpecPlugin(EmitterOptions options, boolean sdkIntegration) {
             SETTINGS_MAP.put("polling", options.getPolling());
         }
 
-        if (options.getBranded() == Boolean.FALSE) {
-            SETTINGS_MAP.put("branded", options.getBranded());
+        if (options.getFlavor() != null) {
+            SETTINGS_MAP.put("flavor", options.getFlavor());
+        }
 
+        if (options.getFlavor() != null && !"azure".equalsIgnoreCase(options.getFlavor())) {
             SETTINGS_MAP.put("sdk-integration", false);
             SETTINGS_MAP.put("license-header", "SMALL_TYPESPEC");
 

diff --git a/typespec-extension/src/main/java/com/azure/typespec/model/EmitterOptions.java b/typespec-extension/src/main/java/com/azure/typespec/model/EmitterOptions.java
@@ -24,8 +24,8 @@ public class EmitterOptions {
     @JsonProperty(value="output-dir")
     private String outputDir;
 
-    @JsonProperty(value = "branded")
-    private Boolean branded = true;
+    @JsonProperty(value = "flavor")
+    private String flavor = "Azure";
 
     @JsonDeserialize(using = EmptyStringToNullDeserializer.class)
     @JsonProperty(value="service-name")
@@ -146,10 +146,6 @@ public void setPolling(Map<String, JavaSettings.PollingDetails> polling) {
         this.polling = polling;
     }
 
-    public Boolean getBranded() {
-        return branded;
-    }
-
     public Boolean getArm() {
         return arm;
     }
@@ -158,6 +154,10 @@ public String getModelsSubpackage() {
         return modelsSubpackage;
     }
 
+    public String getFlavor() {
+        return flavor;
+    }
+
     public static class EmptyStringToNullDeserializer extends JsonDeserializer<String> {
 
         @Override

diff --git a/typespec-tests/package.json b/typespec-tests/package.json
@@ -10,7 +10,7 @@
   },
   "dependencies": {
     "@azure-tools/cadl-ranch-specs": "0.31.2",
-    "@azure-tools/typespec-java": "file:/../typespec-extension/azure-tools-typespec-java-0.14.1.tgz"
+    "@azure-tools/typespec-java": "file:/../typespec-extension/azure-tools-typespec-java-0.15.0.tgz"
   },
   "devDependencies": {
     "@typespec/prettier-plugin-typespec": "~0.54.0",

diff --git a/typespec-tests/tspconfig.yaml b/typespec-tests/tspconfig.yaml
@@ -7,6 +7,7 @@ options:
     generate-samples: true
     generate-tests: true
     examples-directory: "{project-root}/tsp/examples"
+    flavor: "Azure"
     dev-options:
       generate-code-model: true
       support-versioning: true