Show project details when running the whoami command #2231

nicktrn · 2025-07-04T10:51:03Z

Does what it says. Check the trigger.config in the cwd only. Ignores missing config file. Optional -p project override.

changeset-bot · 2025-07-04T10:51:07Z

🦋 Changeset detected

Latest commit: a5716b6

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

coderabbitai · 2025-07-04T10:51:09Z

Walkthrough

This change enhances the "whoami" command and its supporting API to include project context details in its output. The API endpoint now optionally accepts a projectRef parameter and, if provided, returns additional project information such as the project's name, URL, and organization title. The CLI client and command were updated to support specifying a project reference, configuration file, and environment file, and to display project details when available. The response schema was extended with an optional project field to accommodate this new data. No breaking changes were made to existing exported function signatures, except for the addition of optional parameters and properties.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between afc9a6a and a5716b6.

📒 Files selected for processing (5)

.changeset/healthy-apricots-drop.md (1 hunks)
apps/webapp/app/routes/api.v2.whoami.ts (2 hunks)
packages/cli-v3/src/apiClient.ts (1 hunks)
packages/cli-v3/src/commands/whoami.ts (5 hunks)
packages/core/src/v3/schemas/api.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (4)

`**/*.{ts,tsx}`: Always prefer using isomorphic code like fetch, ReadableStream,...

**/*.{ts,tsx}: Always prefer using isomorphic code like fetch, ReadableStream, etc. instead of Node.js specific code
For TypeScript, we usually use types over interfaces
Avoid enums
Use strict mode
No default exports, use function declarations

📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)

List of files the instruction was applied to:

packages/core/src/v3/schemas/api.ts
packages/cli-v3/src/apiClient.ts
apps/webapp/app/routes/api.v2.whoami.ts
packages/cli-v3/src/commands/whoami.ts

`{packages/core,apps/webapp}/**/*.{ts,tsx}`: We use zod a lot in packages/core and in the webapp

{packages/core,apps/webapp}/**/*.{ts,tsx}: We use zod a lot in packages/core and in the webapp

📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)

List of files the instruction was applied to:

packages/core/src/v3/schemas/api.ts
apps/webapp/app/routes/api.v2.whoami.ts

`apps/webapp/**/*.ts`: In the webapp, all environment variables must be accessed through the `env` export of `env.server.ts`, instead of directly accessing `process.env`.

apps/webapp/**/*.ts: In the webapp, all environment variables must be accessed through the env export of env.server.ts, instead of directly accessing process.env.

📄 Source: CodeRabbit Inference Engine (.cursor/rules/webapp.mdc)

List of files the instruction was applied to:

apps/webapp/app/routes/api.v2.whoami.ts

`apps/webapp/**/*.{ts,tsx}`: When importing from `@trigger.dev/core` in the weba...

apps/webapp/**/*.{ts,tsx}: When importing from @trigger.dev/core in the webapp, never import from the root @trigger.dev/core path; always use one of the subpath exports as defined in the package's package.json.

📄 Source: CodeRabbit Inference Engine (.cursor/rules/webapp.mdc)

List of files the instruction was applied to:

apps/webapp/app/routes/api.v2.whoami.ts

🧠 Learnings (2)

.changeset/healthy-apricots-drop.md (7)

Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-06-30T13:22:21.528Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Each Trigger.dev task must have a unique `id` within your project.

Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-06-30T13:22:21.528Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use the `metadata` API from `@trigger.dev/sdk/v3` to attach, update, and access structured metadata within task runs.

Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-06-30T13:22:21.528Z
Learning: Applies to trigger.config.ts : Build extensions for Trigger.dev must be configured in the `build` property of `trigger.config.ts` using provided or custom extensions.

Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-06-30T13:22:21.528Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : You MUST use `@trigger.dev/sdk/v3` when writing Trigger.dev tasks.

Learnt from: nicktrn
PR: triggerdotdev/trigger.dev#2155
File: hosting/docker/.env.example:4-7
Timestamp: 2025-06-06T23:55:01.933Z
Learning: In the trigger.dev project, .env.example files should contain actual example secret values rather than placeholders, as these help users understand the expected format. The files include clear warnings about not using these defaults in production and instructions for generating proper secrets.

Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-06-30T13:22:21.528Z
Learning: Applies to trigger.config.ts : The `trigger.config.ts` file must use `defineConfig` from `@trigger.dev/sdk/v3` to configure project settings, directories, retries, telemetry, runtime, machine settings, log level, max duration, and build options.

Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-06-30T13:22:21.528Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : ALWAYS generate Trigger.dev tasks using the `task` function from `@trigger.dev/sdk/v3` and NEVER use the deprecated `client.defineJob` pattern.

packages/cli-v3/src/commands/whoami.ts (3)

Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-30T13:21:33.994Z
Learning: Applies to {packages/core,apps/webapp}/**/*.{ts,tsx} : We use zod a lot in packages/core and in the webapp

Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-06-30T13:22:21.528Z
Learning: Applies to trigger.config.ts : The `trigger.config.ts` file must use `defineConfig` from `@trigger.dev/sdk/v3` to configure project settings, directories, retries, telemetry, runtime, machine settings, log level, max duration, and build options.

Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-06-30T13:22:21.528Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : When using retry, queue, machine, or maxDuration options, configure them within the `task` function in Trigger.dev task files.

⏰ Context from checks skipped due to timeout of 90000ms (25)

GitHub Check: units / internal / 🧪 Unit Tests: Internal (6, 8)
GitHub Check: units / internal / 🧪 Unit Tests: Internal (5, 8)
GitHub Check: units / internal / 🧪 Unit Tests: Internal (7, 8)
GitHub Check: units / internal / 🧪 Unit Tests: Internal (3, 8)
GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (9, 10)
GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (7, 10)
GitHub Check: units / internal / 🧪 Unit Tests: Internal (8, 8)
GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
GitHub Check: units / internal / 🧪 Unit Tests: Internal (4, 8)
GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 10)
GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 10)
GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (5, 10)
GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (10, 10)
GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (3, 10)
GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (6, 10)
GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (2, 10)
GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 10)
GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
GitHub Check: typecheck / typecheck
GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (10)

.changeset/healthy-apricots-drop.md (1)

1-7: LGTM!

The changeset correctly documents the enhancement and specifies appropriate patch versions for both affected packages.

packages/core/src/v3/schemas/api.ts (1)

19-25: LGTM!

The schema extension correctly adds an optional project field with appropriate validation. The structure follows the established zod patterns in the codebase.

packages/cli-v3/src/apiClient.ts (1)

82-99: LGTM!

The URL construction approach is clean and properly handles the optional projectRef parameter. The implementation maintains existing authentication patterns while extending functionality.

apps/webapp/app/routes/api.v2.whoami.ts (2)

31-83: LGTM!

The implementation correctly handles project lookup with proper access control. Users can only retrieve project details for projects in organizations where they are members, ensuring security.

85-90: LGTM!

The response construction properly includes the optional project details while maintaining the existing response structure.

packages/cli-v3/src/commands/whoami.ts (5)

35-39: LGTM!

The command options schema properly extends the common options with the new functionality for config file, project reference, and environment file specification.

45-56: LGTM!

The command options are well-documented and follow CLI best practices with clear descriptions and proper option flags.

80-95: LGTM!

The environment variable and configuration loading is implemented with appropriate error handling. Logging config errors without aborting execution is the right approach for this command.

133-133: LGTM!

Correctly passes the resolved project reference to the API client, enabling project-scoped user information retrieval.

153-162: LGTM!

The project details display is well-formatted and provides valuable information including project name, organization, and URL. The conditional display ensures it only shows when project details are available.

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

nicktrn added 4 commits July 4, 2025 11:36

add project details to whoami

4cd9744

findFirst

729c68a

skip project check if no orgs found

c945ed9

add changeset

a5716b6

coderabbitai bot changed the title ~~Show project details when running the whoami command @coderabbitai~~ Show project details when running the whoami command Add project context support to whoami command and API endpoint Jul 4, 2025

nicktrn changed the title ~~Show project details when running the whoami command Add project context support to whoami command and API endpoint~~ Show project details when running the whoami command Jul 4, 2025

myftija approved these changes Jul 4, 2025

View reviewed changes

nicktrn merged commit 74fdfa9 into main Jul 4, 2025
33 checks passed

nicktrn deleted the dude-wheres-my-project branch July 4, 2025 12:40

github-actions bot mentioned this pull request Jul 4, 2025

chore: Update version for release (v4-beta) #2159

Merged

github-actions bot mentioned this pull request Aug 18, 2025

chore: Update version for release #2407

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Show project details when running the whoami command #2231

Show project details when running the whoami command #2231

Uh oh!

nicktrn commented Jul 4, 2025 •

edited

Loading

Uh oh!

changeset-bot bot commented Jul 4, 2025

Uh oh!

coderabbitai bot commented Jul 4, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Show project details when running the whoami command #2231

Show project details when running the whoami command #2231

Uh oh!

Conversation

nicktrn commented Jul 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Jul 4, 2025

🦋 Changeset detected

Uh oh!

coderabbitai bot commented Jul 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

nicktrn commented Jul 4, 2025 •

edited

Loading

coderabbitai bot commented Jul 4, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)