Skip to content

Unified logger pass 3 #2701

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rinatkhaziev wants to merge 10 commits into
base: trunk
Choose a base branch
from
Open

Unified logger pass 3 #2701

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
d155120
WIP
rinatkhaziev Jan 20, 2026
cbd910e
Unify Lando logging via shared logger/child loggers so dev‑env logs l…
rinatkhaziev Jan 20, 2026
fd1132d
Implement banner
rinatkhaziev Jan 20, 2026
a233a76
Banner improvements + log the log file path at the end
rinatkhaziev Jan 20, 2026
35bc1c6
Fix E2E
rinatkhaziev Jan 20, 2026
82cbe0a
Revert shrinkwrap changes
rinatkhaziev Jan 20, 2026
0b42b01
Fix type error
rinatkhaziev Jan 20, 2026
81af5b6
regenerate shrinkwrap
rinatkhaziev Jan 20, 2026
ae18c96
Lint fix
rinatkhaziev Jan 20, 2026
6fc3de3
more lint
rinatkhaziev Jan 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
241 changes: 158 additions & 83 deletions npm-shrinkwrap.json
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@
"https-proxy-agent": "^7.0.6",
"js-yaml": "^4.1.0",
"jwt-decode": "4.0.0",
"lando": "github:automattic/lando-cli#bff037ea318948a1bac623c12ede017928cb99db",
"lando": "github:automattic/lando-cli#8f198e0f17dec1144efa216bec5a227dfc851900",
"node-fetch": "^3.3.2",
"node-stream-zip": "1.15.0",
"open": "^11.0.0",
Expand Down
3 changes: 2 additions & 1 deletion src/bin/vip-dev-env-create.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import {
processStringOrBooleanOption,
processSlug,
ensureValidPathsInOptions,
getDevEnvLogFile,
} from '../lib/dev-environment/dev-environment-cli';
import {
getConfigurationFileOptions,
Expand Down Expand Up @@ -102,7 +103,7 @@ cmd.argv( process.argv, async ( arg, opt ) => {
slug = await getEnvironmentName( environmentNameOptions );
}

const lando = await bootstrapLando();
const lando = await bootstrapLando( { logFile: getDevEnvLogFile( slug ) } );
validateDependencies( lando );

debug( 'Args: ', arg, 'Options: ', opt );
Expand Down
3 changes: 2 additions & 1 deletion src/bin/vip-dev-env-destroy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import {
handleCLIException,
processSlug,
validateDependencies,
getDevEnvLogFile,
} from '../lib/dev-environment/dev-environment-cli';
import { destroyEnvironment } from '../lib/dev-environment/dev-environment-core';
import { bootstrapLando } from '../lib/dev-environment/dev-environment-lando';
Expand Down Expand Up @@ -50,7 +51,7 @@ command( {
.argv( process.argv, async ( arg, opt ) => {
const slug = await getEnvironmentName( opt );

const lando = await bootstrapLando();
const lando = await bootstrapLando( { logFile: getDevEnvLogFile( slug ) } );
validateDependencies( lando );

const trackingInfo = getEnvTrackingInfo( slug );
Expand Down
3 changes: 2 additions & 1 deletion src/bin/vip-dev-env-exec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
processBooleanOption,
processSlug,
validateDependencies,
getDevEnvLogFile,
} from '../lib/dev-environment/dev-environment-cli';
import { exec, getEnvironmentPath } from '../lib/dev-environment/dev-environment-core';
import { bootstrapLando, isEnvUp } from '../lib/dev-environment/dev-environment-lando';
Expand Down Expand Up @@ -56,7 +57,7 @@ command( {
.examples( examples )
.argv( process.argv, async ( unmatchedArgs, opt ) => {
const slug = await getEnvironmentName( opt );
const lando = await bootstrapLando();
const lando = await bootstrapLando( { logFile: getDevEnvLogFile( slug ) } );
validateDependencies( lando );

const trackingInfo = getEnvTrackingInfo( slug );
Expand Down
5 changes: 3 additions & 2 deletions src/bin/vip-dev-env-info.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
handleCLIException,
processSlug,
validateDependencies,
getDevEnvLogFile,
} from '../lib/dev-environment/dev-environment-cli';
import {
printEnvironmentInfo,
Expand Down Expand Up @@ -47,16 +48,16 @@ command( {
.argv( process.argv, async ( arg, opt ) => {
let trackingInfo;
let slug;
const lando = await bootstrapLando();

if ( opt.all ) {
trackingInfo = { all: true };
slug = '';
slug = undefined;
} else {
slug = await getEnvironmentName( opt );
trackingInfo = getEnvTrackingInfo( slug );
}

const lando = await bootstrapLando( { logFile: getDevEnvLogFile( slug ) } );
validateDependencies( lando );
await trackEvent( 'dev_env_info_command_execute', trackingInfo );

Expand Down
3 changes: 2 additions & 1 deletion src/bin/vip-dev-env-list.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import command from '../lib/cli/command';
import {
handleCLIException,
validateDependencies,
getDevEnvLogFile,
} from '../lib/dev-environment/dev-environment-cli';
import { printAllEnvironmentsInfo } from '../lib/dev-environment/dev-environment-core';
import { bootstrapLando } from '../lib/dev-environment/dev-environment-lando';
Expand All @@ -24,7 +25,7 @@ command( {
} )
.examples( examples )
.argv( process.argv, async () => {
const lando = await bootstrapLando();
const lando = await bootstrapLando( { logFile: getDevEnvLogFile() } );
lando.events.constructor.prototype.setMaxListeners( 1024 );
validateDependencies( lando );

Expand Down
3 changes: 2 additions & 1 deletion src/bin/vip-dev-env-logs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
handleCLIException,
processSlug,
validateDependencies,
getDevEnvLogFile,
} from '../lib/dev-environment/dev-environment-cli';
import { showLogs } from '../lib/dev-environment/dev-environment-core';
import { bootstrapLando } from '../lib/dev-environment/dev-environment-lando';
Expand Down Expand Up @@ -51,7 +52,7 @@ command( {
.argv( process.argv, async ( arg, opt ) => {
const slug = await getEnvironmentName( opt );

const lando = await bootstrapLando();
const lando = await bootstrapLando( { logFile: getDevEnvLogFile( slug ) } );
validateDependencies( lando );

const trackingInfo = getEnvTrackingInfo( slug );
Expand Down
3 changes: 2 additions & 1 deletion src/bin/vip-dev-env-purge.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import {
handleCLIException,
validateDependencies,
promptForBoolean,
getDevEnvLogFile,
} from '../lib/dev-environment/dev-environment-cli';
import {
destroyEnvironment,
Expand Down Expand Up @@ -57,7 +58,7 @@ command( {
debug( 'Args: ', arg, 'Options: ', opt );

const allEnvNames = getAllEnvironmentNames();
const lando = await bootstrapLando();
const lando = await bootstrapLando( { logFile: getDevEnvLogFile() } );

if ( allEnvNames.length === 0 ) {
console.log( 'No environments to purge!' );
Expand Down
3 changes: 2 additions & 1 deletion src/bin/vip-dev-env-shell.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
getEnvironmentName,
handleCLIException,
processSlug,
getDevEnvLogFile,
} from '../lib/dev-environment/dev-environment-cli';
import { getEnvironmentPath } from '../lib/dev-environment/dev-environment-core';
import { bootstrapLando, landoShell } from '../lib/dev-environment/dev-environment-lando';
Expand Down Expand Up @@ -90,7 +91,7 @@ command( {
.argv( process.argv, async ( args, opt ) => {
const slug = await getEnvironmentName( opt );

const lando = await bootstrapLando();
const lando = await bootstrapLando( { logFile: getDevEnvLogFile( slug ) } );
validateDependencies( lando );

const trackingInfo = getEnvTrackingInfo( slug );
Expand Down
3 changes: 2 additions & 1 deletion src/bin/vip-dev-env-start.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import {
handleCLIException,
postStart,
processSlug,
getDevEnvLogFile,
} from '../lib/dev-environment/dev-environment-cli';
import { startEnvironment } from '../lib/dev-environment/dev-environment-core';
import { bootstrapLando } from '../lib/dev-environment/dev-environment-lando';
Expand Down Expand Up @@ -76,7 +77,7 @@ command( {
.examples( examples )
.argv( process.argv, async ( arg, opt ) => {
const slug = await getEnvironmentName( opt );
const lando = await bootstrapLando();
const lando = await bootstrapLando( { logFile: getDevEnvLogFile( slug ) } );
validateDependencies( lando );

const startProcessing = new Date();
Expand Down
11 changes: 8 additions & 3 deletions src/bin/vip-dev-env-stop.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
getEnvironmentName,
processSlug,
validateDependencies,
getDevEnvLogFile,
} from '../lib/dev-environment/dev-environment-cli';
import {
getAllEnvironmentNames,
Expand Down Expand Up @@ -44,24 +45,28 @@ command( {
.option( 'all', 'Stop all local environments.' )
.examples( examples )
.argv( process.argv, async ( arg, opt ) => {
const lando = await bootstrapLando();
validateDependencies( lando );

debug( 'Args: ', arg, 'Options: ', opt );

/** @type {Record< string, unknown >} */
let trackingInfo;
/** @type {string[]} */
let environments;
/** @type {string|undefined} */
let logSlug;
if ( opt.all ) {
trackingInfo = { all: true };
environments = getAllEnvironmentNames();
logSlug = undefined;
} else {
const slug = await getEnvironmentName( opt );
trackingInfo = getEnvTrackingInfo( slug );
environments = [ slug ];
logSlug = slug;
}

const lando = await bootstrapLando( { logFile: getDevEnvLogFile( logSlug ) } );
validateDependencies( lando );

await trackEvent( 'dev_env_stop_command_execute', trackingInfo );

for ( const slug of environments ) {
Expand Down
3 changes: 2 additions & 1 deletion src/bin/vip-dev-env-sync-sql.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
getEnvironmentName,
processBooleanOption,
processSlug,
getDevEnvLogFile,
} from '../lib/dev-environment/dev-environment-cli';
import { bootstrapLando, isContainerRunning } from '../lib/dev-environment/dev-environment-lando';
import { parseLiveBackupCopyCLIOptions } from '../lib/live-backup-copy';
Expand Down Expand Up @@ -114,7 +115,7 @@ command( {
} );
await trackerFn( 'execute' );

const lando = await bootstrapLando();
const lando = await bootstrapLando( { logFile: getDevEnvLogFile( slug ) } );

const isUp = (
await Promise.all( [
Expand Down
3 changes: 2 additions & 1 deletion src/bin/vip-dev-env-update.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import {
promptForArguments,
validateDependencies,
ensureValidPathsInOptions,
getDevEnvLogFile,
} from '../lib/dev-environment/dev-environment-cli';
import {
getConfigurationFileOptions,
Expand Down Expand Up @@ -68,7 +69,7 @@ cmd.examples( examples );
cmd.argv( process.argv, async ( arg, opt ) => {
const slug = await getEnvironmentName( opt );

const lando = await bootstrapLando();
const lando = await bootstrapLando( { logFile: getDevEnvLogFile( slug ) } );
validateDependencies( lando );

const trackingInfo = getEnvTrackingInfo( slug );
Expand Down
3 changes: 2 additions & 1 deletion src/commands/dev-env-import-sql.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import * as exit from '../lib/cli/exit';
import { getFileMeta, unzipFile } from '../lib/client-file-uploader';
import { getSqlDumpDetails, SqlDumpDetails, SqlDumpType } from '../lib/database';
import {
getDevEnvLogFile,
processBooleanOption,
validateDependencies,
} from '../lib/dev-environment/dev-environment-cli';
Expand Down Expand Up @@ -39,7 +40,7 @@ export class DevEnvImportSQLCommand {
) {}

public async run(): Promise< void > {
const lando = await bootstrapLando();
const lando = await bootstrapLando( { logFile: getDevEnvLogFile( this.slug ) } );
validateDependencies( lando );

validateImportFileExtension( this.fileName );
Expand Down
13 changes: 13 additions & 0 deletions src/lib/dev-environment/dev-environment-cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -954,6 +954,19 @@ export function processSlug( value: unknown ): string {
return ( value ?? '' ).toString().toLowerCase();
}

export function formatDevEnvLogTimestamp( date: Date ): string {
return date.toISOString().replace( /\..*$/, '' ).replace( /[-:]/g, '' ).replace( 'T', '-' );
}

export function formatDevEnvLogSlug( slug: string ): string {
return slug.replace( /[^a-z0-9_-]+/gi, '-' ).toLowerCase();
}

export function getDevEnvLogFile( slug?: string ): string {
const slugPart = slug ? formatDevEnvLogSlug( slug ) : 'all';
return `vip-dev-env-${ slugPart }-${ formatDevEnvLogTimestamp( new Date() ) }.log`;
}
Comment on lines +957 to +968
Copy link

Copilot AI Jan 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The three new exported functions formatDevEnvLogTimestamp, formatDevEnvLogSlug, and getDevEnvLogFile lack test coverage. These functions handle string formatting and timestamp generation, which are important for log file naming. Consider adding unit tests to verify the expected output format, especially for formatDevEnvLogTimestamp which manipulates dates, and formatDevEnvLogSlug which sanitizes slug strings.

Copilot uses AI. Check for mistakes.

declare function isNaN( value: unknown ): boolean;
declare function parseFloat( value: unknown ): number;

Expand Down
Loading
Loading