Skip to content

fix(vercel): keep deployment token out of argv #984

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
WNZhao wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(vercel): keep deployment token out of argv #984

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
34 changes: 33 additions & 1 deletion packages/targets/deploy-vercel/src/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,27 @@ import { fakeBuildContext, fakeShipContext, smokeTest } from '@profullstack/sh1p
import { mkdtemp, readFile, rm } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import { join } from 'node:path';
import { afterEach, describe, expect, it } from 'vitest';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

const { execMock } = vi.hoisted(() => ({
execMock: vi.fn(),
}));

vi.mock('@profullstack/sh1pt-core', async () => ({
...(await vi.importActual<typeof import('@profullstack/sh1pt-core')>('@profullstack/sh1pt-core')),
exec: execMock,
}));

import adapter from './index.js';

smokeTest(adapter, { idPrefix: 'deploy', requireKind: true });

const tempDirs: string[] = [];

beforeEach(() => {
execMock.mockReset();
});

afterEach(async () => {
await Promise.all(tempDirs.splice(0).map((dir) => rm(dir, { recursive: true, force: true })));
});
Expand Down Expand Up @@ -90,4 +104,22 @@ describe('Vercel deployment target', () => {
project: 'myapp',
})).rejects.toThrow('VERCEL_TOKEN not in vault');
});

it('passes the Vercel token through the child environment, not argv', async () => {
execMock.mockResolvedValue({ exitCode: 0, stdout: 'https://myapp.vercel.app\n', stderr: '' });

await adapter.ship(fakeShipContext({
channel: 'stable',
dryRun: false,
secret: (key: string) => key === 'VERCEL_TOKEN' ? 'vercel-secret-token' : undefined,
}) as any, {
project: 'myapp',
});

const [bin, args, options] = execMock.mock.calls[0] ?? [];
expect(bin).toBe('npx');
expect(args).not.toContain('vercel-secret-token');
expect(args).not.toContain('--token');
expect(options.env.VERCEL_TOKEN).toBe('vercel-secret-token');
});
});
5 changes: 2 additions & 3 deletions packages/targets/deploy-vercel/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,12 @@ function deployDir(ctx: { projectDir: string }, config: Config): string {
return isAbsolute(config.dir) ? config.dir : join(ctx.projectDir, config.dir);
}

function deployArgs(ctx: { channel: string; projectDir: string }, config: Config, token?: string): string[] {
function deployArgs(ctx: { channel: string; projectDir: string }, config: Config): string[] {
config = normalizedConfig(config);
const prod = config.prod ?? ctx.channel === 'stable';
const args = ['--yes', 'vercel', 'deploy', deployDir(ctx, config), '--yes'];
if (prod) args.push('--prod');
if (config.org) args.push('--scope', config.org);
if (token) args.push('--token', token);
return args;
}

Expand Down Expand Up @@ -91,7 +90,7 @@ export default defineTarget<Config>({
throw new Error('VERCEL_TOKEN not in vault — run: sh1pt secret set VERCEL_TOKEN <token>');
}

const result = await exec('npx', deployArgs(ctx, config, token), {
const result = await exec('npx', deployArgs(ctx, config), {
cwd: ctx.projectDir,
env: { ...ctx.env, VERCEL_TOKEN: token },
log: ctx.log,
Expand Down
Loading