CLI: Implement `auth login` command #2017

fredrikekelund · 2025-11-05T15:16:38Z

Related issues

Fixes STU-946

Proposed Changes

This PR is based on @youknowriad's work in #1958. It implements a studio auth login command that:

Opens a WordPress.com OAuth2 authorization URL in the browser
The OAuth2 authorization page redirects to a developer.wordpress.com page that renders a convenient button for copying the generated access token
Once copied, the access token can be pasted back to the terminal

Testing Instructions

Check out 156890-ghe-Automattic/wpcom-a8c-themes on your sandbox
Sandbox developer.wordpress.com
Open Studio and log out from WordPress.com
Close Studio
Run npm run cli:build
Run node dist/cli/main.js auth login
Finish the authorization process and paste the token back to the terminal
Open Studio again
Ensure you are logged in to WordPress.com

Pre-merge Checklist

Have you checked for TypeScript, React or other console errors?

fredrikekelund · 2025-11-05T15:17:23Z

cli/lib/browser.ts

+			cmd = 'PowerShell';
+			args = [
+				'-NoProfile',
+				'-NonInteractive',
+				'-ExecutionPolicy',
+				'Bypass',
+				'-Command',
+				'Start',
+				`"${ url }"`,
+			];


I have yet to test this. This was taken from Sindre Sorhus's open module.

github-actions · 2025-11-05T15:37:52Z

📊 Performance Test Results

Comparing 0f75d13 vs trunk

site-editor

Metric	trunk	`0f75d13`	Diff	Change
load	10107.00 ms	8716.00 ms	-1391.00 ms	🟢 -13.8%

site-startup

Metric	trunk	`0f75d13`	Diff	Change
siteCreation	13017.00 ms	13009.00 ms	-8.00 ms	🟢 -0.1%
siteStartup	4200.00 ms	4936.00 ms	+736.00 ms	🔴 17.5%

Results are median values from multiple test runs.

Legend: 🟢 Improvement (faster) | 🔴 Regression (slower) | ⚪ No change

fredrikekelund · 2025-11-06T07:45:41Z

Working on a test right now.

fredrikekelund · 2025-11-06T09:42:22Z

Looking at how many changes I had to make today, I see that I opened this PR a little early. In any case, it's good for a full review now 👍

Copilot

Pull Request Overview

This PR adds a CLI authentication command (studio auth login) to allow users to authenticate with WordPress.com directly from the command line. The implementation opens a browser for OAuth authentication and stores the resulting token with user information.

Key changes:

Adds @inquirer/prompts dependency for interactive token input
Implements OAuth-based login flow with browser integration
Enhances auth token storage to include expiration time and user details

Reviewed Changes

Copilot reviewed 12 out of 13 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
package.json, package-lock.json	Added @inquirer/prompts dependency for interactive CLI prompts
common/logger-actions.ts	Added AuthCommandLoggerAction enum for login/logout tracking
common/lib/oauth.ts	Made redirect URI configurable for CLI authentication flow
cli/lib/i18n.ts	Extracted getAppLocale() function for reusability
cli/lib/browser.ts	New utility to open default browser across platforms
cli/lib/appdata.ts	Enhanced auth token schema with expiration, email, and display name
cli/lib/api.ts	Added getUserInfo() function to fetch user details from WordPress.com
cli/index.ts	Registered auth command group with login subcommand
cli/commands/auth/login.ts	Main login command implementation
cli/commands/auth/tests/login.test.ts	Comprehensive test coverage for login command
cli/lib/tests/snapshots.test.ts, appdata.test.ts	Updated test mocks to include new auth token fields

Comments suppressed due to low confidence (1)

cli/lib/browser.ts:2

Unused import sprintf.

import { __, sprintf } from '@wordpress/i18n';

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-06T12:41:24Z

cli/commands/auth/login.ts

+				email: user.email,
+				displayName: user.display_name,
+				expiresIn: twoWeeksInSeconds,
+				expirationTime: now.getTime() + twoWeeksInSeconds,


The expirationTime calculation is incorrect. twoWeeksInSeconds is in seconds (1209600), but getTime() returns milliseconds. This should be now.getTime() + twoWeeksInSeconds * 1000 to convert seconds to milliseconds, or the calculation should use twoWeeksInSeconds * 1000 directly.

Suggested change

expirationTime: now.getTime() + twoWeeksInSeconds,

expirationTime: now.getTime() + twoWeeksInSeconds * 1000,

Copilot · 2025-11-06T12:41:25Z

cli/lib/browser.ts

+	let cmd: string;
+	let args: string[];


Variables cmd and args are not initialized and will be undefined if process.platform doesn't match 'darwin', 'win32', or 'linux'. This will cause the spawn() call on line 37 to fail. Add a default case to the switch statement that throws an error for unsupported platforms.

Copilot · 2025-11-06T12:41:25Z

cli/lib/browser.ts

@@ -0,0 +1,49 @@
+import { spawn } from 'child_process';
+import { __, sprintf } from '@wordpress/i18n';


The sprintf function is imported but never used in this file. Remove the unused import.

Suggested change

import { __, sprintf } from '@wordpress/i18n';

import { __ } from '@wordpress/i18n';

Copilot · 2025-11-06T12:41:25Z

cli/lib/browser.ts

+import { LoggerError } from 'cli/logger';
+


Unused import LoggerError.

Suggested change

import { LoggerError } from 'cli/logger';

sejas

I confirm that the login works as expected, and I was able to authenticate by copying and pasting the token. Here are a couple of suggestions to improve the experience:

We could avoid hiding the token so the user can see they pasted the correct value.
We could automatically try three times when the user enters an invalid token, similarly to SSH connections. Currently the feedback is very rough ✖ Failed to fetch user info: The OAuth2 token is invalid., we could at least invite the user to try again.

sejas · 2025-11-06T21:45:53Z

common/logger-actions.ts


+export enum AuthCommandLoggerAction {
+	LOGIN = 'login',
+	LOGOUT = 'logout',


Nit: We don't really need the logout at this point.

I'll move this to #2027

sejas · 2025-11-06T21:49:04Z

cli/commands/auth/login.ts

+			const userData = await readAppdata();
+
+			const now = new Date();
+			const twoWeeksInSeconds = 2 * 7 * 24 * 60 * 60;


I just saw that the expiresIn in appData is 1209600 seconds or two weeks, but I always thought the token was valid for months. 🤔

This is governed by the back-end. We could look into this further if we think two weeks is too short

youknowriad · 2025-11-06T22:53:32Z

I like how simple this is. Good work :)

CLI: Implement auth login command

999b2a8

fredrikekelund requested review from a team and bcotrim November 5, 2025 15:16

fredrikekelund self-assigned this Nov 5, 2025

fredrikekelund commented Nov 5, 2025

View reviewed changes

Fix lint and tests

8650b02

fredrikekelund added 3 commits November 6, 2025 10:07

Add tests, tweak command

fc661e0

Consider expiration time

c8b228c

Move logic around

9fcc45f

fredrikekelund added 2 commits November 6, 2025 10:54

Unwrap

36e6059

Fix type error

a228ae9

sejas requested a review from Copilot November 6, 2025 12:39

Copilot AI reviewed Nov 6, 2025

View reviewed changes

fredrikekelund added 2 commits November 6, 2025 13:46

Address review comments

c1799fe

Reject unsupported platforms

23aa26c

sejas approved these changes Nov 6, 2025

View reviewed changes

fredrikekelund added 3 commits November 7, 2025 10:33

Merge branch 'trunk' into f26d/cli-auth-login-command

49966e3

Address review feedback

e13fd34

Fix test

c72a70d

	expirationTime: now.getTime() + twoWeeksInSeconds,
	expirationTime: now.getTime() + twoWeeksInSeconds * 1000,

		@@ -0,0 +1,49 @@
		import { spawn } from 'child_process';
		import { __, sprintf } from '@wordpress/i18n';

	import { __, sprintf } from '@wordpress/i18n';
	import { __ } from '@wordpress/i18n';

CLI: Implement auth login command #2017

Are you sure you want to change the base?

CLI: Implement auth login command #2017

Uh oh!

Conversation

fredrikekelund commented Nov 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related issues

Proposed Changes

Testing Instructions

Pre-merge Checklist

Uh oh!

fredrikekelund Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Nov 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📊 Performance Test Results

site-editor

site-startup

Uh oh!

fredrikekelund commented Nov 6, 2025

Uh oh!

fredrikekelund commented Nov 6, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

sejas left a comment

Choose a reason for hiding this comment

Uh oh!

sejas Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

fredrikekelund Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

sejas Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

fredrikekelund Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

youknowriad commented Nov 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

CLI: Implement `auth login` command #2017

CLI: Implement `auth login` command #2017

fredrikekelund commented Nov 5, 2025 •

edited

Loading

github-actions bot commented Nov 5, 2025 •

edited

Loading