Merge remote-tracking branch 'origin/main' into copilot/implement-search-functionality

Author: vobu

EXAMPLES.md

@@ -41,6 +41,9 @@ c8 list pi --state=ACTIVE
 ```bash
 c8 get pi 2251799813685249
 c8 get process-instance 2251799813685249
+
+# Get process instance with variables
+c8 get pi 2251799813685249 --variables
 ```
 
 ### Create Process Instance
@@ -139,6 +142,13 @@ c8 list inc --state=ACTIVE
 c8 list inc --processInstanceKey=2251799813685249
 ```
 
+### Get Incident by Key
+
+```bash
+c8 get inc 2251799813685251
+c8 get incident 2251799813685251
+```
+
 ### Resolve Incident
 
 ```bash

README.md

@@ -87,6 +87,7 @@ c8ctl --version
 c8ctl list pi                          # List process instances
 c8ctl list pd                          # List process definitions
 c8ctl get pi 123456                    # Get process instance by key
+c8ctl get pi 123456 --variables        # Get process instance with variables
 c8ctl get pd 123456 --xml              # Get process definition as XML
 
 # Create process instance

package-lock.json

@@ -25,7 +25,7 @@ _c8ctl_completions() {
   # Resources by verb
   local list_resources="process-instances process-instance pi user-tasks user-task ut incidents incident inc jobs profiles profile plugins plugin"
   local search_resources="process-instances process-instance pi process-definitions process-definition pd user-tasks user-task ut incidents incident inc jobs variables variable"
-  local get_resources="process-instance pi process-definition pd topology"
+  local get_resources="process-instance pi process-definition pd incident inc topology"
   local create_resources="process-instance pi"
   local cancel_resources="process-instance pi"
   local await_resources="process-instance pi"
@@ -272,6 +272,8 @@ _c8ctl() {
             'pi:Get process instance'
             'process-definition:Get process definition'
             'pd:Get process definition'
+            'incident:Get incident'
+            'inc:Get incident'
             'topology:Get cluster topology'
           )
           _describe 'resource' resources
@@ -624,6 +626,10 @@ complete -c c8ctl -n '__fish_seen_subcommand_from get' -a 'process-definition' -
 complete -c c8 -n '__fish_seen_subcommand_from get' -a 'process-definition' -d 'Get process definition'
 complete -c c8ctl -n '__fish_seen_subcommand_from get' -a 'pd' -d 'Get process definition'
 complete -c c8 -n '__fish_seen_subcommand_from get' -a 'pd' -d 'Get process definition'
+complete -c c8ctl -n '__fish_seen_subcommand_from get' -a 'incident' -d 'Get incident'
+complete -c c8 -n '__fish_seen_subcommand_from get' -a 'incident' -d 'Get incident'
+complete -c c8ctl -n '__fish_seen_subcommand_from get' -a 'inc' -d 'Get incident'
+complete -c c8 -n '__fish_seen_subcommand_from get' -a 'inc' -d 'Get incident'
 complete -c c8ctl -n '__fish_seen_subcommand_from get' -a 'topology' -d 'Get cluster topology'
 complete -c c8 -n '__fish_seen_subcommand_from get' -a 'topology' -d 'Get cluster topology'
 

src/commands/completion.ts

@@ -52,7 +52,7 @@ Usage: c8ctl <command> [resource] [options]
 Commands:
   list      <resource>       List resources (pi, pd, ut, inc, jobs, profiles)
   search    <resource>       Search resources with filters (pi, pd, ut, inc, jobs, variables)
-  get       <resource> <key> Get resource by key (pi, pd, topology)
+  get       <resource> <key> Get resource by key (pi, pd, inc, topology)
   create    <resource>       Create resource (pi)
   cancel    <resource> <key> Cancel resource (pi)
   await     <resource>       Create and await completion (pi, alias for create --awaitCompletion)
@@ -80,6 +80,7 @@ Flags:
   --profile <name>      Use specific profile for this command
   --from <url>          Load plugin from URL (use with 'load plugin')
   --xml                 Get process definition as XML (use with 'get pd')
+  --variables           Get process instance with variables (use with 'get pi')
   --id <process-id>     Process definition ID (alias for --bpmnProcessId)
   --awaitCompletion     Wait for process instance to complete (use with 'create pi')
   --fetchVariables <v>  Reserved for future use (all variables returned by default)
@@ -121,6 +122,7 @@ Examples:
   c8ctl search variables --value=foo Search for variables by value
   c8ctl search variables --processInstanceKey=123 --fullValue  Search variables with full values
   c8ctl get pi 123456                Get process instance by key
+  c8ctl get pi 123456 --variables    Get process instance with variables
   c8ctl get pd 123456                Get process definition by key
   c8ctl get pd 123456 --xml          Get process definition XML
   c8ctl create pi --id=myProcess
@@ -152,7 +154,7 @@ export function showVerbResources(verb: string): void {
   const resources: Record<string, string> = {
     list: 'process-instances (pi), process-definitions (pd), user-tasks (ut), incidents (inc), jobs, profiles, plugins',
     search: 'process-instances (pi), process-definitions (pd), user-tasks (ut), incidents (inc), jobs, variables',
-    get: 'process-instance (pi), process-definition (pd), topology',
+    get: 'process-instance (pi), process-definition (pd), incident (inc), topology',
     create: 'process-instance (pi)',
     complete: 'user-task (ut), job',
     cancel: 'process-instance (pi)',
@@ -248,19 +250,25 @@ Usage: c8ctl get <resource> <key> [flags]
 Resources and their available flags:
 
   process-instance (pi) <key>
+    --variables              Include variables for the process instance
     --profile <name>         Use specific profile
 
   process-definition (pd) <key>
     --xml                    Return process definition as XML
     --profile <name>         Use specific profile
 
+  incident (inc) <key>
+    --profile <name>         Use specific profile
+
   topology
     --profile <name>         Use specific profile
 
 Examples:
   c8ctl get pi 2251799813685249
+  c8ctl get pi 2251799813685249 --variables
   c8ctl get pd 2251799813685250
   c8ctl get pd 2251799813685250 --xml
+  c8ctl get inc 2251799813685251
   c8ctl get topology
 `.trim());
 }

src/commands/help.ts

@@ -54,6 +54,24 @@ export async function listIncidents(options: {
   }
 }
 
+/**
+ * Get incident by key
+ */
+export async function getIncident(key: string, options: {
+  profile?: string;
+}): Promise<void> {
+  const logger = getLogger();
+  const client = createClient(options.profile);
+
+  try {
+    const result = await client.getIncident({ incidentKey: key as any }, { consistency: { waitUpToMs: 0 } });
+    logger.json(result);
+  } catch (error) {
+    logger.error(`Failed to get incident ${key}`, error as Error);
+    process.exit(1);
+  }
+}
+
 /**
  * Resolve incident
  */

src/commands/incidents.ts

@@ -65,13 +65,41 @@ export async function listProcessInstances(options: {
  */
 export async function getProcessInstance(key: string, options: {
   profile?: string;
+  variables?: boolean;
 }): Promise<void> {
   const logger = getLogger();
   const client = createClient(options.profile);
+  const consistencyOptions = { consistency: { waitUpToMs: 0 } };
 
   try {
-    const result = await client.getProcessInstance({ processInstanceKey: key as any }, { consistency: { waitUpToMs: 0 } });
-    logger.json(result);
+    const result = await client.getProcessInstance({ processInstanceKey: key as any }, consistencyOptions);
+    
+    // Fetch variables if requested
+    if (options.variables) {
+      try {
+        const variablesResult = await client.searchVariables(
+          {
+            filter: {
+              processInstanceKey: key as any,
+            },
+            truncateValues: false,  // Get full variable values
+          },
+          consistencyOptions
+        );
+        
+        // Add variables to the result
+        const resultWithVariables = {
+          ...result,
+          variables: variablesResult.items || [],
+        };
+        logger.json(resultWithVariables);
+      } catch (varError) {
+        logger.error(`Failed to fetch variables for process instance ${key}. The process instance was found, but variables could not be retrieved.`, varError as Error);
+        process.exit(1);
+      }
+    } else {
+      logger.json(result);
+    }
   } catch (error) {
     logger.error(`Failed to get process instance ${key}`, error as Error);
     process.exit(1);

src/commands/process-instances.ts

@@ -30,7 +30,7 @@ import {
   searchVariables,
 } from './commands/search.ts';
 import { listUserTasks, completeUserTask } from './commands/user-tasks.ts';
-import { listIncidents, resolveIncident } from './commands/incidents.ts';
+import { listIncidents, getIncident, resolveIncident } from './commands/incidents.ts';
 import { listJobs, activateJobs, completeJob, failJob } from './commands/jobs.ts';
 import { publishMessage, correlateMessage } from './commands/messages.ts';
 import { getTopology } from './commands/topology.ts';
@@ -298,8 +298,11 @@ async function main() {
       logger.error('Process instance key required. Usage: c8 get pi <key>');
       process.exit(1);
     }
+    // Check if --variables flag is present (for get command, it's a boolean flag)
+    const includeVariables = process.argv.includes('--variables');
     await getProcessInstance(args[0], {
       profile: values.profile as string | undefined,
+      variables: includeVariables,
     });
     return;
   }
@@ -395,6 +398,17 @@ async function main() {
     return;
   }
 
+  if (verb === 'get' && normalizedResource === 'incident') {
+    if (!args[0]) {
+      logger.error('Incident key required. Usage: c8 get inc <key>');
+      process.exit(1);
+    }
+    await getIncident(args[0], {
+      profile: values.profile as string | undefined,
+    });
+    return;
+  }
+
   if (verb === 'resolve' && normalizedResource === 'incident') {
     if (!args[0]) {
       logger.error('Incident key required. Usage: c8 resolve inc <key>');

src/index.ts

@@ -66,6 +66,7 @@ describe('Help Module', () => {
 
     // Check for flags
     assert.ok(output.includes('--profile'));
+    assert.ok(output.includes('--variables'));
     assert.ok(output.includes('--awaitCompletion'));
     assert.ok(output.includes('--fetchVariables'));
     assert.ok(output.includes('--version'));
@@ -91,6 +92,7 @@ describe('Help Module', () => {
     const output = consoleLogSpy.join('\n');
     assert.ok(output.includes('c8ctl get'));
     assert.ok(output.includes('process-instance'));
+    assert.ok(output.includes('incident'));
     assert.ok(output.includes('topology'));
   });
 
@@ -201,8 +203,10 @@ describe('Help Module', () => {
     const output = consoleLogSpy.join('\n');
     assert.ok(output.includes('c8ctl get'));
     assert.ok(output.includes('process-instance (pi)'));
+    assert.ok(output.includes('--variables'));
     assert.ok(output.includes('process-definition (pd)'));
     assert.ok(output.includes('--xml'));
+    assert.ok(output.includes('incident (inc)'));
     assert.ok(output.includes('topology'));
   });