Skip to content

fix(twilio-run): passing a dir doesn't get overriden by cwd #381

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

Merged
merged 1 commit into from
Aug 30, 2022
Merged

fix(twilio-run): passing a dir doesn't get overriden by cwd #381

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
116 changes: 76 additions & 40 deletions packages/twilio-run/__tests__/config/start.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
jest.mock('../../src/config/utils/package-json');

import {
getBaseDirectory,
getConfigFromCli,
getInspectInfo,
getPort,
getUrl,
Expand All @@ -23,27 +26,27 @@ jest.mock('ngrok', () => {

describe('getUrl', () => {
test('returns localhost if ngrok is not passed', async () => {
const config = ({
const config = {
ngrok: undefined,
} as unknown) as StartCliFlags;
} as unknown as StartCliFlags;

const url = await getUrl(config, 3000);
expect(url).toBe('http://localhost:3000');
});

test('calls ngrok if ngrok is defined', async () => {
const config = ({
const config = {
ngrok: '',
} as unknown) as StartCliFlags;
} as unknown as StartCliFlags;

const url = await getUrl(config, 3000);
expect(url).toBe('https://random.ngrok.io');
});

test('calls ngrok with custom subdomain if passed', async () => {
const config = ({
const config = {
ngrok: 'dom',
} as unknown) as StartCliFlags;
} as unknown as StartCliFlags;

const url = await getUrl(config, 3000);
expect(url).toBe('https://dom.ngrok.io');
Expand All @@ -66,19 +69,19 @@ describe('getPort', () => {
});

test('returns default 3000 if nothing is passed', () => {
const config = ({
const config = {
port: undefined,
} as unknown) as StartCliFlags;
} as unknown as StartCliFlags;

delete process.env.PORT;
const port = getPort(config);
expect(port).toBe(3000);
});

test('checks for process.env.PORT and returns number', () => {
const config = ({
const config = {
port: undefined,
} as unknown) as StartCliFlags;
} as unknown as StartCliFlags;

process.env.PORT = '9999';
const port = getPort(config);
Expand All @@ -87,9 +90,9 @@ describe('getPort', () => {
});

test('port passed via flag takes preference', () => {
const config = ({
const config = {
port: 1234,
} as unknown) as StartCliFlags;
} as unknown as StartCliFlags;

process.env.PORT = '9999';
const port = getPort(config);
Expand All @@ -98,9 +101,9 @@ describe('getPort', () => {
});

test('handles strings and returns number', () => {
const config = ({
const config = {
port: '8080',
} as unknown) as StartCliFlags;
} as unknown as StartCliFlags;

process.env.PORT = '9999';
const port = getPort(config);
Expand All @@ -127,66 +130,66 @@ describe('getBaseDirectory', () => {
});

test('handles current working directory if none is passed', () => {
const config = ({
const config = {
dir: undefined,
cwd: undefined,
} as unknown) as StartCliFlags;
} as unknown as StartCliFlags;

const result = getBaseDirectory(config);
expect(result).toBe(os.homedir());
});

test('supports dir argument', () => {
const config = ({
const config = {
dir: '/usr/local',
cwd: undefined,
} as unknown) as StartCliFlags;
} as unknown as StartCliFlags;

const result = getBaseDirectory(config);
expect(result).toBe(path.resolve('/usr/local'));
});

test('prefers cwd over dir argument', () => {
const config = ({
const config = {
dir: '/usr/local',
cwd: '/usr/bin',
} as unknown) as StartCliFlags;
} as unknown as StartCliFlags;

const result = getBaseDirectory(config);
expect(result).toBe(path.resolve('/usr/bin'));
});

test('handles relative path for dir', () => {
let config = ({
let config = {
dir: 'demo',
cwd: undefined,
} as unknown) as StartCliFlags;
} as unknown as StartCliFlags;

let result = getBaseDirectory(config);
expect(result).toBe(path.resolve('demo'));

config = ({
config = {
dir: '../demo',
cwd: undefined,
} as unknown) as StartCliFlags;
} as unknown as StartCliFlags;

result = getBaseDirectory(config);
expect(result).toBe(path.resolve('../demo'));
});

test('handles relative path for cwd', () => {
let config = ({
let config = {
dir: undefined,
cwd: 'demo',
} as unknown) as StartCliFlags;
} as unknown as StartCliFlags;

let result = getBaseDirectory(config);
expect(result).toBe(path.resolve('demo'));

config = ({
config = {
dir: undefined,
cwd: '../demo',
} as unknown) as StartCliFlags;
} as unknown as StartCliFlags;

result = getBaseDirectory(config);
expect(result).toBe(path.resolve('../demo'));
Expand All @@ -195,58 +198,91 @@ describe('getBaseDirectory', () => {

describe('getInspectInfo', () => {
test('returns undefined if nothing is passed', () => {
const config = ({
const config = {
inspect: undefined,
inspectBrk: undefined,
} as unknown) as StartCliFlags;
} as unknown as StartCliFlags;

const result = getInspectInfo(config);
expect(result).toBeUndefined();
});

test('handles present but empty inspect flag', () => {
const config = ({
const config = {
inspect: '',
inspectBrk: undefined,
} as unknown) as StartCliFlags;
} as unknown as StartCliFlags;

const result = getInspectInfo(config);
expect(result).toEqual({ hostPort: '', break: false });
});

test('handles present but empty inspectBrk flag', () => {
const config = ({
const config = {
inspect: undefined,
inspectBrk: '',
} as unknown) as StartCliFlags;
} as unknown as StartCliFlags;

const result = getInspectInfo(config);
expect(result).toEqual({ hostPort: '', break: true });
});

test('handles passed port in inspect flag', () => {
const config = ({
const config = {
inspect: '9999',
inspectBrk: undefined,
} as unknown) as StartCliFlags;
} as unknown as StartCliFlags;

const result = getInspectInfo(config);
expect(result).toEqual({ hostPort: '9999', break: false });
});

test('handles passed port in inspect flag', () => {
const config = ({
const config = {
inspect: undefined,
inspectBrk: '1234',
} as unknown) as StartCliFlags;
} as unknown as StartCliFlags;

const result = getInspectInfo(config);
expect(result).toEqual({ hostPort: '1234', break: true });
});
});

describe('getConfigFromCli', () => {
test('TODO', () => {
expect(true).toBeTruthy();
const initialWorkingDirectory = process.cwd();

beforeAll(() => {
process.chdir(os.homedir());
});

afterAll(() => {
process.chdir(initialWorkingDirectory);
});

beforeEach(() => {
require('../../src/config/utils/package-json').__setPackageJson({});
});

test('uses passed in directory as base directory', async () => {
require('../../src/config/utils/package-json').__setPackageJson({});
const config = {
dir: './other_dir',
} as unknown as StartCliFlags;
if (config.dir) {
const startConfig = await getConfigFromCli(config);
expect(startConfig.baseDir).toEqual(path.resolve(config.dir));
}
});

test('uses passed in cwd as base directory', async () => {
require('../../src/config/utils/package-json').__setPackageJson({});
const config = {
dir: './other_dir',
cwd: './new_cwd',
} as unknown as StartCliFlags;
if (config.cwd) {
const startConfig = await getConfigFromCli(config);
expect(startConfig.baseDir).toEqual(path.resolve(config.cwd));
}
});
});
6 changes: 3 additions & 3 deletions packages/twilio-run/src/config/start.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,18 +164,18 @@ export async function getConfigFromCli(
externalCliOptions?: ExternalCliOptions
): Promise<StartCliConfig> {
let cwd = flags.cwd ? path.resolve(flags.cwd) : process.cwd();
flags.cwd = cwd;
const configFlags = readSpecializedConfig(cwd, flags.config, 'start', {
username:
(externalCliOptions && externalCliOptions.accountSid) || undefined,
}) as StartCliFlags;
const cli = mergeFlagsAndConfig<StartCliFlags>(configFlags, flags, cliInfo);
const config = {} as StartCliConfig;

const baseDir = getBaseDirectory(cli);
cli.cwd = baseDir;
const pkgJson = await readPackageJsonContent(cli);

config.inspect = getInspectInfo(cli);
config.baseDir = getBaseDirectory(cli);
config.baseDir = baseDir;
config.env = await getEnvironment(cli, config.baseDir);
config.port = getPort(cli);
config.detailedLogs = cli.detailedLogs;
Expand Down