Viera/fix app update (#90)

* fix: address app update bugs

Author: rvwatch

command-snapshot.json

@@ -47,21 +47,8 @@
     "alias": [],
     "command": "orchestrator:app:update",
     "flagAliases": [],
-    "flagChars": ["d", "g", "i", "l", "m", "n", "o", "r", "t"],
-    "flags": [
-      "api-version",
-      "app-id",
-      "app-name",
-      "description",
-      "flags-dir",
-      "json",
-      "label",
-      "log-level",
-      "runtime-method",
-      "target-org",
-      "template-id",
-      "template-name"
-    ],
+    "flagChars": ["d", "i", "l", "n", "o"],
+    "flags": ["api-version", "app-id", "app-name", "description", "flags-dir", "json", "label", "target-org"],
     "plugin": "@salesforce/plugin-orchestrator"
   },
   {

messages/appframework.update.app.md

@@ -1,16 +1,16 @@
 # summary
 
-Update an app with a new template.
+Update an app's label and description.
 
 # description
 
-Update an existing orchestrated app by associating it with a new template or modifying its properties. This command allows you to change the template that an app is based on, update its metadata (label, description), or modify runtime configuration settings.
+Update an existing orchestrated app's label and description. This command allows you to modify the display properties of an app without changing its underlying template or functionality.
 
-You can identify the app by either its unique ID or its name, and specify the new template by either its unique ID or its name. App and template IDs are guaranteed to be unique, while names should be unique within an org.
+You can identify the app by either its unique ID or its name. App IDs are guaranteed to be unique, while names should be unique within an org.
 
-Updating an app with a new template changes the app's underlying structure and configuration to match the new template. This is useful for migrating apps to updated templates or changing an app's functionality. You can also update just the app's metadata without changing the template.
+Use this command to update the human-readable display name (label) and description that users see when viewing the app. This is useful for improving app discoverability and providing clearer information about the app's purpose.
 
-You must have Data Cloud and Tableau Next enabled in your org and the AppFrameworkManageApp user permission to modify apps. Both the app and template must exist in the same org.
+You must have the AppFrameworkManageApp user permission to modify apps.
 
 # flags.target-org.summary
 
@@ -100,6 +100,10 @@ No app specified for update. You must specify either an app ID with --app-id or
 
 No template specified for update. You must specify either a template ID with --template-id or a template name with --template-name.
 
+# noUpdateFieldsSpecified
+
+No update fields specified. You must specify at least one field to update such as --label or --description.
+
 # fetchingApp
 
 Fetching app details...
@@ -193,22 +197,18 @@ You don't have permission to update apps in this org.
 
 # examples
 
-- Update an app to use a new template by ID:
-
-  <%= config.bin %> <%= command.id %> --target-org myOrg --app-id 01t000000000123 --template-id 01t000000000456
-
-- Update an app to use a new template by name:
+- Update an app's label:
 
-  <%= config.bin %> <%= command.id %> --target-org myOrg --app-name "My App" --template-name "New Template"
+  <%= config.bin %> <%= command.id %> --target-org myOrg --app-id 1zAxx000000000123 --label "Updated App Label"
 
-- Update an app with a new label and description:
+- Update an app's description:
 
-  <%= config.bin %> <%= command.id %> --target-org myOrg --app-id 01t000000000123 --label "Updated App" --description "Updated description for the app"
+  <%= config.bin %> <%= command.id %> --target-org myOrg --app-name "My App" --description "Updated description for the app"
 
-- Update an app with new template and runtime configuration:
+- Update both label and description:
 
-  <%= config.bin %> <%= command.id %> --target-org myOrg --app-name "analytics_app" --template-name "Analytics Template" --runtime-method async --log-level debug
+  <%= config.bin %> <%= command.id %> --target-org myOrg --app-id 1zAxx000000000123 --label "Updated App" --description "Updated description for the app"
 
 - Update an app using a specific API version:
 
-  <%= config.bin %> <%= command.id %> --target-org mySandbox --app-id 01t000000000123 --template-id 01t000000000789 --api-version 60.0
+  <%= config.bin %> <%= command.id %> --target-org mySandbox --app-id 1zAxx000000000123 --label "New Label" --api-version 65.0

src/commands/orchestrator/app/update.ts

@@ -50,18 +50,6 @@ export default class UpdateApp extends SfCommand<string> {
       description: messages.getMessage('flags.app-name.description'),
       exclusive: ['app-id'],
     }),
-    'template-id': Flags.string({
-      char: 't',
-      summary: messages.getMessage('flags.template-id.summary'),
-      description: messages.getMessage('flags.template-id.description'),
-      exclusive: ['template-name'],
-    }),
-    'template-name': Flags.string({
-      char: 'm',
-      summary: messages.getMessage('flags.template-name.summary'),
-      description: messages.getMessage('flags.template-name.description'),
-      exclusive: ['template-id'],
-    }),
     label: Flags.string({
       char: 'l',
       summary: messages.getMessage('flags.label.summary'),
@@ -72,18 +60,6 @@ export default class UpdateApp extends SfCommand<string> {
       summary: messages.getMessage('flags.description.summary'),
       description: messages.getMessage('flags.description.description'),
     }),
-    'runtime-method': Flags.string({
-      char: 'r',
-      summary: messages.getMessage('flags.runtime-method.summary'),
-      description: messages.getMessage('flags.runtime-method.description'),
-      options: ['sync', 'async'],
-    }),
-    'log-level': Flags.string({
-      char: 'g',
-      summary: messages.getMessage('flags.log-level.summary'),
-      description: messages.getMessage('flags.log-level.description'),
-      options: ['debug', 'info', 'warn', 'error'],
-    }),
   };
 
   public async run(): Promise<string> {
@@ -98,10 +74,10 @@ export default class UpdateApp extends SfCommand<string> {
       );
     }
 
-    // Check that at least one of template-id or template-name is provided
-    if (!flags['template-id'] && !flags['template-name']) {
+    // Check that at least one update field is provided
+    if (!flags.label && !flags.description) {
       throw new SfError(
-        messages.getMessage('noTemplateSpecified'),
+        messages.getMessage('noUpdateFieldsSpecified'),
         'AppUpdateError',
         messages.getMessages('error.UpdateError.Actions')
       );
@@ -136,34 +112,12 @@ export default class UpdateApp extends SfCommand<string> {
         appId = flags['app-id'] ?? '';
       }
 
-      let templateId = '';
-
-      // Get template ID if template name was provided
-      if (flags['template-name']) {
-        this.spinner.start(messages.getMessage('fetchingTemplate'));
-
-        // Since we don't have a direct way to list templates,
-        // we need to get the template by name from a different utility class
-        // For now, we'll throw an error and suggest using template-id instead
-        this.spinner.stop();
-        throw new SfError(
-          messages.getMessage('noTemplateFound'),
-          'AppUpdateError',
-          messages.getMessages('error.UpdateError.Actions')
-        );
-      } else {
-        templateId = flags['template-id'] ?? '';
-      }
-
       // Update the app
       this.spinner.start(messages.getMessage('updatingApp'));
 
-      const updatedAppId = await appFrameworkApp.updateApp(appId, {
-        templateSourceId: templateId,
+      const updatedAppId = await appFrameworkApp.patchApp(appId, {
         label: flags.label,
         description: flags.description,
-        runtimeMethod: flags['runtime-method'],
-        logLevel: flags['log-level'],
       });
 
       this.spinner.stop();

src/utils/app/appframeworkapp.ts

@@ -204,11 +204,10 @@ export default class AppFrameworkApp {
     appId: string,
     options: {
       templateSourceId: string;
-      label?: string;
-      description?: string;
       templateValues?: Record<string, unknown>;
       runtimeMethod?: string;
       logLevel?: string;
+      chainName?: string;
     }
   ): Promise<string> {
     if (!appId) {
@@ -224,11 +223,10 @@ export default class AppFrameworkApp {
     const body = Object.fromEntries(
       Object.entries({
         templateSourceId: options.templateSourceId,
-        label: options.label,
-        description: options.description,
         templateValues: options.templateValues ?? {},
         runtimeMethod: options.runtimeMethod,
         logLevel: options.logLevel,
+        chainName: options.chainName,
       }).filter((entries) => entries[1] !== undefined)
     );
 
@@ -239,7 +237,61 @@ export default class AppFrameworkApp {
     };
 
     const response = await request<AppResponse>(this.connection, {
-      method: 'POST',
+      method: 'PUT',
+      url,
+      body,
+    });
+
+    if (response && typeof response === 'object') {
+      if ('id' in response && typeof response.id === 'string') {
+        return response.id;
+      } else if ('app' in response && response.app && typeof response.app === 'object' && 'id' in response.app) {
+        return response.app.id;
+      }
+    }
+
+    return appId; // Return the original app ID if no specific ID was found in the response
+  }
+
+  /**
+   * Patch an existing app's metadata (label, description)
+   *
+   * @param appId - ID of the app to patch
+   * @param options - Patch options
+   * @returns The ID of the patched app
+   */
+  public async patchApp(
+    appId: string,
+    options: {
+      label?: string;
+      description?: string;
+    }
+  ): Promise<string> {
+    if (!appId) {
+      throw new Error('App ID must be provided');
+    }
+
+    if (!options.label && !options.description) {
+      throw new Error('At least one field (label or description) must be provided for patch');
+    }
+
+    const url = `/apps/${appId}`;
+
+    const body = Object.fromEntries(
+      Object.entries({
+        label: options.label,
+        description: options.description,
+      }).filter((entries) => entries[1] !== undefined)
+    );
+
+    // Define response types
+    type AppResponse = {
+      id?: string;
+      app?: { id: string };
+    };
+
+    const response = await request<AppResponse>(this.connection, {
+      method: 'PATCH',
       url,
       body,
     });