Merge pull request #1880 from Automattic/fix/lando-domain

fix(dev-env): use correct domain for environments

__tests__/commands/dev-env-sync-sql.js

@@ -1,5 +1,6 @@
 import { replace } from '@automattic/vip-search-replace';
 import fs from 'fs';
+import Lando from 'lando';
 import { PassThrough } from 'stream';
 
 import { DevEnvImportSQLCommand } from '../../src/commands/dev-env-import-sql';
@@ -77,12 +78,14 @@ describe( 'commands/DevEnvSyncSQLCommand', () => {
 		},
 	};
 
+	const lando = new Lando( { domain: 'vipdev.lndo.site' } );
+
 	describe( '.generateExport', () => {
 		it( 'should create an instance of ExportSQLCommand and run', async () => {
 			const mockExport = jest.spyOn( ExportSQLCommand.prototype, 'run' );
 			mockExport.mockResolvedValue();
 
-			const cmd = new DevEnvSyncSQLCommand( app, env, 'test-slug' );
+			const cmd = new DevEnvSyncSQLCommand( app, env, 'test-slug', lando );
 			await cmd.generateExport();
 
 			expect( mockExport ).toHaveBeenCalled();
@@ -91,7 +94,7 @@ describe( 'commands/DevEnvSyncSQLCommand', () => {
 
 	describe( 'generateSearchReplaceMap', () => {
 		it( 'should return a map of search-replace values', () => {
-			const cmd = new DevEnvSyncSQLCommand( app, env, 'test-slug' );
+			const cmd = new DevEnvSyncSQLCommand( app, env, 'test-slug', lando );
 			cmd.slug = 'test-slug';
 			cmd.siteUrls = [ 'test.go-vip.com' ];
 			cmd.generateSearchReplaceMap();
@@ -100,7 +103,7 @@ describe( 'commands/DevEnvSyncSQLCommand', () => {
 		} );
 
 		it( 'should return a map of search-replace values for multisite', () => {
-			const cmd = new DevEnvSyncSQLCommand( app, msEnv, 'test-slug' );
+			const cmd = new DevEnvSyncSQLCommand( app, msEnv, 'test-slug', lando );
 			cmd.slug = 'test-slug';
 			cmd.siteUrls = [ 'test.go-vip.com', 'subsite.com' ];
 			cmd.generateSearchReplaceMap();
@@ -114,7 +117,7 @@ describe( 'commands/DevEnvSyncSQLCommand', () => {
 
 	describe( '.runSearchReplace', () => {
 		it( 'should run search-replace operation on the SQL file', async () => {
-			const cmd = new DevEnvSyncSQLCommand( app, env, 'test-slug' );
+			const cmd = new DevEnvSyncSQLCommand( app, env, 'test-slug', lando );
 			cmd.searchReplaceMap = { 'test.go-vip.com': 'test-slug.vipdev.lndo.site' };
 			cmd.slug = 'test-slug';
 
@@ -131,15 +134,15 @@ describe( 'commands/DevEnvSyncSQLCommand', () => {
 			const mockImport = jest.spyOn( DevEnvImportSQLCommand.prototype, 'run' );
 			mockImport.mockResolvedValue();
 
-			const cmd = new DevEnvSyncSQLCommand( app, env, 'test-slug' );
+			const cmd = new DevEnvSyncSQLCommand( app, env, 'test-slug', lando );
 			await cmd.runImport();
 
 			expect( mockImport ).toHaveBeenCalled();
 		} );
 	} );
 
 	describe( '.run', () => {
-		const syncCommand = new DevEnvSyncSQLCommand( app, env, 'test-slug' );
+		const syncCommand = new DevEnvSyncSQLCommand( app, env, 'test-slug', lando );
 		const exportSpy = jest.spyOn( syncCommand, 'generateExport' );
 		const generateSearchReplaceMapSpy = jest.spyOn( syncCommand, 'generateSearchReplaceMap' );
 		const searchReplaceSpy = jest.spyOn( syncCommand, 'runSearchReplace' );

src/bin/vip-dev-env-sync-sql.js

@@ -80,7 +80,7 @@ command( {
 			throw new UserError( 'Environment needs to be started first' );
 		}
 
-		const cmd = new DevEnvSyncSQLCommand( app, env, slug, trackerFn );
+		const cmd = new DevEnvSyncSQLCommand( app, env, slug, lando, trackerFn );
 		// TODO: There's a function called handleCLIException for dev-env that handles exceptions but DevEnvSyncSQLCommand has its own implementation.
 		// We should probably use handleCLIException instead?
 		const didCommandRun = await cmd.run();

src/commands/dev-env-import-sql.js

@@ -70,7 +70,7 @@ export class DevEnvImportSQLCommand {
 				throw new UserError( 'Environment needs to be started first' );
 			}
 
-			const expectedDomain = `${ this.slug }.vipdev.lndo.site`;
+			const expectedDomain = `${ this.slug }.${ lando.config.domain }`;
 			await validateSQL( resolvedPath, {
 				isImport: false,
 				skipChecks: [],

src/commands/dev-env-sync-sql.js

@@ -58,6 +58,7 @@ export class DevEnvSyncSQLCommand {
 	app;
 	env;
 	slug;
+	lando;
 	tmpDir;
 	siteUrls;
 	searchReplaceMap;
@@ -69,18 +70,20 @@ export class DevEnvSyncSQLCommand {
 	 * @param {string}   app       The app object
 	 * @param {string}   env       The environment object
 	 * @param {string}   slug      The site slug
+	 * @param {Object}   lando     The lando object
 	 * @param {Function} trackerFn Function to call for tracking
 	 */
-	constructor( app, env, slug, trackerFn = () => {} ) {
+	constructor( app, env, slug, lando, trackerFn = () => {} ) {
 		this.app = app;
 		this.env = env;
 		this.slug = slug;
+		this.lando = lando;
 		this.track = trackerFn;
 		this.tmpDir = makeTempDir();
 	}
 
 	get landoDomain() {
-		return `${ this.slug }.vipdev.lndo.site`;
+		return `${ this.slug }.${ this.lando.config.domain }`;
 	}
 
 	get sqlFile() {

src/lib/dev-environment/dev-environment-cli.ts

@@ -115,9 +115,9 @@ export async function handleCLIException(
 	}
 }
 
-const verifyDNSResolution = async ( slug: string ): Promise< void > => {
+const verifyDNSResolution = async ( slug: string, domain: string ): Promise< void > => {
 	const expectedIP = '127.0.0.1';
-	const testDomain = `${ slug }.vipdev.lndo.site`;
+	const testDomain = `${ slug }.${ domain }`;
 	const advice = `Please add following line to hosts file on your system:\n\n${ expectedIP } ${ testDomain }\n\nLearn more: https://docs.wpvip.com/vip-local-development-environment/troubleshooting-dev-env/#h-resolve-networking-configuration-issues\n`;
 
 	debug( `Verifying DNS resolution for ${ testDomain }` );
@@ -151,7 +151,7 @@ export const validateDependencies = async ( lando: Lando, slug: string ) => {
 
 	validateDockerInstalled( lando );
 	if ( slug ) {
-		await verifyDNSResolution( slug );
+		await verifyDNSResolution( slug, lando.config.domain ?? 'vipdev.lndo.site' );
 	}
 
 	const duration = new Date().getTime() - now.getTime();