Fix slowlogs format option

Automattic · Apr 19, 2024 · c3113a9 · c3113a9
1 parent 737d4ad
commit c3113a9
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 11 deletions.
diff --git a/src/bin/vip-slowlogs.ts b/src/bin/vip-slowlogs.ts
@@ -14,12 +14,12 @@ import {
 } from '../lib/app-slowlogs/types';
 import command from '../lib/cli/command';
 import * as exit from '../lib/cli/exit';
-import { formatData } from '../lib/cli/format';
+import { OutputFormat, formatData } from '../lib/cli/format';
 import { trackEvent } from '../lib/tracker';
 
 const LIMIT_MIN = 1;
 const LIMIT_MAX = 500;
-const ALLOWED_FORMATS = [ 'csv', 'json', 'text' ];
+const ALLOWED_FORMATS: OutputFormat[] = [ 'csv', 'json', 'table' ];
 const DEFAULT_POLLING_DELAY_IN_SECONDS = 30;
 const MIN_POLLING_DELAY_IN_SECONDS = 5;
 const MAX_POLLING_DELAY_IN_SECONDS = 300;
@@ -150,7 +150,7 @@ function printSlowlogs( slowlogs: Slowlog[], format: SlowlogFormats ): void {
 		return { timestamp, rowsSent, rowsExamined, queryTime, requestUri, query };
 	} );
 
-	console.log( formatData( slowlogs, format ) );
+	console.log( formatData( slowlogs, format as OutputFormat ) );
 }
 
 export function validateInputs( limit: number, format: SlowlogFormats ): void {
@@ -186,11 +186,11 @@ void command( {
 	appContext: true,
 	appQuery,
 	envContext: true,
-	format: true,
+	format: false,
 	module: 'slowlogs',
 } )
 	.option( 'limit', 'The maximum number of log lines', 500 )
-	.option( 'format', 'Output the log lines in CSV or JSON format', 'text' )
+	.option( 'format', 'Output the log lines in CSV or JSON format', 'table' )
 	.examples( [
 		{
 			description: 'Get the most recent app slowlogs',

diff --git a/src/lib/app-slowlogs/types.ts b/src/lib/app-slowlogs/types.ts
@@ -11,13 +11,11 @@ export interface DefaultOptions {
 	};
 }
 
-export type SlowlogFormats = 'ids' | 'json' | 'csv';
+export type SlowlogFormats =  'json' | 'csv' | 'table';
 
 type Stringable =
 	| string
-	| {
-			toString: () => string;
-	  };
+	| { toString: () => string; };
 
 export interface GetSlowLogsOptions extends DefaultOptions {
 	limit: number;

diff --git a/src/lib/cli/format.ts b/src/lib/cli/format.ts
@@ -15,15 +15,20 @@ type Stringable =
 			toString: () => string;
 	  };
 
+export type OutputFormat = 'keyValue' | 'ids' | 'json' | 'csv' | 'table';
+
 export function formatData( data: Tuple[], format: 'keyValue' ): string;
-export function formatData( data: Record< string, Stringable >[], format: 'table' ): string;
 export function formatData(
 	data: Record< string, unknown >[],
 	format: 'ids' | 'json' | 'csv'
 ): string;
+export function formatData(
+	data: Record< string, Stringable >[],
+	format: OutputFormat
+): string;
 export function formatData(
 	data: Record< string, unknown >[] | Tuple[],
-	format: 'keyValue' | 'ids' | 'json' | 'csv' | 'table'
+	format: OutputFormat
 ): string {
 	if ( ! data.length ) {
 		return '';