Conditional display of API key

Show the API key, and API key secret name, when "secure" registrations are configured in the service
microsoft · Oct 21, 2024 · d9bc378 · d9bc378
1 parent 9a07df5
commit d9bc378
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 23 deletions.
diff --git a/workbench-app/src/routes/AssistantServiceRegistrationEditor.tsx b/workbench-app/src/routes/AssistantServiceRegistrationEditor.tsx
@@ -104,21 +104,27 @@ export const AssistantServiceRegistrationEditor: React.FC = () => {
                 <Field label="Name">
                     <Input className={classes.input} value={name} onChange={(_event, data) => setName(data.value)} />
                 </Field>
-                <Field label="API Key (read-only)">
-                    <div className={classes.row}>
-                        <Input className={classes.input} value={assistantServiceRegistration.apiKey} readOnly />
-                        <AssistantServiceRegistrationApiKeyReset
-                            assistantServiceRegistration={assistantServiceRegistration}
-                        />
-                    </div>
-                </Field>
                 {assistantServiceRegistration.apiKeyName && (
-                    <Field label="API Key secret name (read-only)">
-                        <div className={classes.row}>
-                            <Input className={classes.input} value={assistantServiceRegistration.apiKeyName} readOnly />
-                            <CopyButton data={assistantServiceRegistration.apiKeyName ?? ''} />
-                        </div>
-                    </Field>
+                    <>
+                        <Field label="API Key (read-only)">
+                            <div className={classes.row}>
+                                <Input className={classes.input} value={assistantServiceRegistration.apiKey} readOnly />
+                                <AssistantServiceRegistrationApiKeyReset
+                                    assistantServiceRegistration={assistantServiceRegistration}
+                                />
+                            </div>
+                        </Field>
+                        <Field label="API Key secret name (read-only)">
+                            <div className={classes.row}>
+                                <Input
+                                    className={classes.input}
+                                    value={assistantServiceRegistration.apiKeyName}
+                                    readOnly
+                                />
+                                <CopyButton data={assistantServiceRegistration.apiKeyName} />
+                            </div>
+                        </Field>
+                    </>
                 )}
                 <Checkbox
                     label="Include this assistant service in everyone's create assistant list"

diff --git a/workbench-service/semantic_workbench_service/controller/assistant_service_registration.py b/workbench-service/semantic_workbench_service/controller/assistant_service_registration.py
@@ -93,7 +93,9 @@ async def create_registration(
 
             await session.commit()
 
-        return convert.assistant_service_registration_from_db(registration, api_key=api_key)
+        return convert.assistant_service_registration_from_db(
+            registration, api_key=api_key, include_api_key_name=self._registration_is_secured
+        )
 
     async def get_registrations(
         self, user_ids: set[str], assistant_service_online: bool | None = None
@@ -117,7 +119,9 @@ async def get_registrations(
 
             assistant_services = await session.exec(query_registrations)
 
-            return convert.assistant_service_registration_list_from_db(assistant_services)
+            return convert.assistant_service_registration_list_from_db(
+                assistant_services, include_api_key_name=self._registration_is_secured
+            )
 
     async def get_registration(self, assistant_service_id: str) -> AssistantServiceRegistration:
         async with self._get_session() as session:
@@ -134,7 +138,9 @@ async def get_registration(self, assistant_service_id: str) -> AssistantServiceR
             api_key = await self._api_key_store.get(registration.api_key_name)
             masked_api_key = self.mask_api_key(api_key)
 
-            return convert.assistant_service_registration_from_db(registration, api_key=masked_api_key)
+            return convert.assistant_service_registration_from_db(
+                registration, api_key=masked_api_key, include_api_key_name=self._registration_is_secured
+            )
 
     @staticmethod
     def mask_api_key(api_key: str | None) -> str | None:
@@ -187,7 +193,9 @@ async def update_registration(
             await session.commit()
             await session.refresh(registration)
 
-        return convert.assistant_service_registration_from_db(registration)
+        return convert.assistant_service_registration_from_db(
+            registration, include_api_key_name=self._registration_is_secured
+        )
 
     async def update_assistant_service_url(
         self,
@@ -238,7 +246,9 @@ async def update_assistant_service_url(
             await session.commit()
             await session.refresh(registration)
 
-        return convert.assistant_service_registration_from_db(registration), background_task_args
+        return convert.assistant_service_registration_from_db(
+            registration, include_api_key_name=self._registration_is_secured
+        ), background_task_args
 
     async def _update_participants(
         self,
@@ -290,7 +300,9 @@ async def reset_api_key(
 
             api_key = await self._api_key_store.reset(registration.api_key_name)
 
-        return convert.assistant_service_registration_from_db(registration, api_key=api_key)
+        return convert.assistant_service_registration_from_db(
+            registration, api_key=api_key, include_api_key_name=self._registration_is_secured
+        )
 
     async def check_assistant_service_online_expired(self) -> None:
         async with self._get_session() as session:

diff --git a/workbench-service/semantic_workbench_service/controller/convert.py b/workbench-service/semantic_workbench_service/controller/convert.py
@@ -52,6 +52,7 @@ def user_list_from_db(models: Iterable[db.User]) -> UserList:
 
 def assistant_service_registration_from_db(
     model: db.AssistantServiceRegistration,
+    include_api_key_name: bool,
     api_key: str | None = None,
 ) -> AssistantServiceRegistration:
     return AssistantServiceRegistration(
@@ -62,7 +63,7 @@ def assistant_service_registration_from_db(
         name=model.name,
         description=model.description,
         include_in_listing=model.include_in_listing,
-        api_key_name=model.api_key_name,
+        api_key_name=model.api_key_name if include_api_key_name else "",
         api_key=api_key,
         assistant_service_url=model.assistant_service_url,
         assistant_service_online=model.assistant_service_online,
@@ -71,10 +72,12 @@ def assistant_service_registration_from_db(
 
 
 def assistant_service_registration_list_from_db(
-    models: Iterable[db.AssistantServiceRegistration],
+    models: Iterable[db.AssistantServiceRegistration], include_api_key_name: bool
 ) -> AssistantServiceRegistrationList:
     return AssistantServiceRegistrationList(
-        assistant_service_registrations=[assistant_service_registration_from_db(model=a) for a in models]
+        assistant_service_registrations=[
+            assistant_service_registration_from_db(model=a, include_api_key_name=include_api_key_name) for a in models
+        ]
     )