Do not require project name on logfire projects use command (#177)

Author: Kludex

logfire/_internal/cli.py

@@ -270,7 +270,6 @@ def parse_auth(args: argparse.Namespace) -> None:
 
     console.print()
     console.print(f'Your Logfire credentials are stored in [bold]{DEFAULT_FILE}[/]')
-    # TODO(Marcelo): Add a message to inform which commands can be used.
 
 
 def parse_list_projects(args: argparse.Namespace) -> None:
@@ -326,6 +325,7 @@ def parse_use_project(args: argparse.Namespace) -> None:
     project_name = args.project_name
     organization = args.org
     console = Console(file=sys.stderr)
+
     projects = LogfireCredentials.get_user_projects(session=args._session, logfire_api_url=logfire_url)
     project_info = LogfireCredentials.use_existing_project(
         session=args._session,
@@ -438,7 +438,7 @@ def _main(args: list[str] | None = None) -> None:
     cmd_projects_new.set_defaults(func=parse_create_new_project)
 
     cmd_projects_use = projects_subparsers.add_parser('use', help='use a project')
-    cmd_projects_use.add_argument('project_name', help='project name')
+    cmd_projects_use.add_argument('project_name', nargs='?', help='project name')
     cmd_projects_use.add_argument('--org', help='project organization')
     cmd_projects_use.add_argument('--data-dir', default='.logfire')
     cmd_projects_use.set_defaults(func=parse_use_project)

logfire/_internal/config.py

@@ -913,7 +913,7 @@ def use_existing_project(
             project_name: Name of project that has to be used.
 
         Returns:
-            The configured project informations.
+            The configured project information.
 
         Raises:
             LogfireConfigError: If there was an error configuring the project.
@@ -1142,10 +1142,7 @@ def initialize_project(
 
         projects = cls.get_user_projects(session=session, logfire_api_url=logfire_api_url)
         if projects:
-            use_existing_projects = Confirm.ask(
-                'Do you want to use one of your existing projects? ',
-                default=True,
-            )
+            use_existing_projects = Confirm.ask('Do you want to use one of your existing projects? ', default=True)
             if use_existing_projects:  # pragma: no branch
                 credentials = cls.use_existing_project(
                     session=session, logfire_api_url=logfire_api_url, projects=projects

tests/test_cli.py

@@ -823,6 +823,59 @@ def test_projects_use(tmp_dir_cwd: Path, default_credentials: Path) -> None:
         }
 
 
+def test_projects_use_without_project_name(tmp_dir_cwd: Path, default_credentials: Path) -> None:
+    with ExitStack() as stack:
+        stack.enter_context(patch('logfire._internal.config.LogfireCredentials._get_user_token', return_value=''))
+        console = stack.enter_context(patch('logfire._internal.cli.Console'))
+        prompt_mock = stack.enter_context(patch('rich.prompt.Prompt.ask', side_effect=['1']))
+
+        m = requests_mock.Mocker()
+        stack.enter_context(m)
+        m.get(
+            'https://logfire-api.pydantic.dev/v1/projects/',
+            json=[
+                {'organization_name': 'fake_org', 'project_name': 'myproject'},
+                {'organization_name': 'fake_org', 'project_name': 'otherproject'},
+            ],
+        )
+        create_project_response = {
+            'json': {
+                'project_name': 'myproject',
+                'token': 'fake_token',
+                'project_url': 'fake_project_url',
+            }
+        }
+        m.post(
+            'https://logfire-api.pydantic.dev/v1/organizations/fake_org/projects/myproject/write-tokens/',
+            [create_project_response],
+        )
+
+        main(['projects', 'use'])
+
+        assert prompt_mock.mock_calls == [
+            call(
+                (
+                    'Please select one of the following projects by number:\n'
+                    '1. fake_org/myproject\n'
+                    '2. fake_org/otherproject\n'
+                ),
+                choices=['1', '2'],
+                default='1',
+            )
+        ]
+
+        console_calls = [re.sub(r'^call(\(\).)?', '', str(call)) for call in console.mock_calls]
+        assert console_calls == [
+            IsStr(regex=r'^\(file=.*'),
+            "print('Project configured successfully. You will be able to view it at: fake_project_url')",
+        ]
+
+        assert json.loads((tmp_dir_cwd / '.logfire/logfire_credentials.json').read_text()) == {
+            **create_project_response['json'],
+            'logfire_api_url': 'https://logfire-api.pydantic.dev',
+        }
+
+
 def test_projects_use_multiple(tmp_dir_cwd: Path, default_credentials: Path) -> None:
     with ExitStack() as stack:
         stack.enter_context(patch('logfire._internal.config.LogfireCredentials._get_user_token', return_value=''))