Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

fix(dashboard): keep the next API key editor open after a delayed save

Yudhi Armyndharise6f8a7d61da2
diff --git a/dashboard/src/pages/ApiKeys.test.ts b/dashboard/src/pages/ApiKeys.test.ts
index cd0df32de..6080a8f07 100644
--- a/dashboard/src/pages/ApiKeys.test.ts
+++ b/dashboard/src/pages/ApiKeys.test.ts
@@ -31,6 +31,8 @@ let createBody: Record<string, unknown> | undefined;
let createGate: Promise<void> | undefined;
let updateBodies: Record<string, unknown>[] = [];
let updateStatus = 200;
+let updateGate: Promise<void> | undefined;
+const updatePaths: string[] = [];
function installFetchStub(): void {
globalThis.fetch = ((input: RequestInfo | URL, init?: RequestInit): Promise<Response> => {
@@ -44,10 +46,12 @@ function installFetchStub(): void {
}
if (init?.method === 'PUT' && path.startsWith('/api/auth/api-keys/')) {
updateBodies.push(JSON.parse(String(init.body)));
- if (updateStatus === 409) {
- return Promise.resolve(jsonResponse({ message: 'Cannot remove the last active admin key' }, 409));
- }
- return Promise.resolve(jsonResponse(billingBot));
+ updatePaths.push(path);
+ const status = updateStatus;
+ return (updateGate ?? Promise.resolve()).then(() => {
+ if (status === 409) return jsonResponse({ message: 'Cannot remove the last active admin key' }, 409);
+ return jsonResponse(billingBot);
+ });
}
if (path === '/api/auth/api-keys') {
if (listStatus !== 200) {
@@ -85,6 +89,8 @@ afterEach(() => {
createGate = undefined;
updateBodies = [];
updateStatus = 200;
+ updateGate = undefined;
+ updatePaths.length = 0;
window.sessionStorage.removeItem('openwa_api_key');
});
@@ -697,3 +703,93 @@ test('a chat list past the gateway limit blocks Create and says how many it hold
fireEvent.change(screen.getByLabelText('Chat access (optional)'), { target: { value: '6281234' } });
await rtl.waitFor(() => assert.equal(create.disabled, false));
});
+
+for (const dismissal of ['Cancel', 'Close'] as const) {
+ test(`a completed key update keeps the editor opened after ${dismissal}`, async () => {
+ const { screen, fireEvent, within, waitFor, act } = rtl;
+ keyList = [billingBot, { ...billingBot, id: 'key-2', name: 'support-bot', keyPrefix: 'owa_k1cd' }];
+ let release!: () => void;
+ updateGate = new Promise<void>(resolve => (release = resolve));
+ renderApiKeys();
+ await screen.findByText('owa_k1ab****');
+ const firstRow = screen.getByText('billing-bot').closest('tr') as HTMLElement;
+ fireEvent.click(within(firstRow).getByTitle('Edit access'));
+ const firstDialog = await screen.findByRole('dialog');
+ fireEvent.change(within(firstDialog).getByLabelText('Role'), { target: { value: 'viewer' } });
+ fireEvent.click(within(firstDialog).getByRole('button', { name: 'Save' }));
+ await waitFor(() => assert.equal(updateBodies.length, 1));
+ fireEvent.click(within(firstDialog).getByRole('button', { name: dismissal }));
+ assert.equal(screen.queryByRole('dialog') === null, true);
+
+ const secondRow = screen.getByText('support-bot').closest('tr') as HTMLElement;
+ fireEvent.click(within(secondRow).getByTitle('Edit access'));
+ const secondDialog = await screen.findByRole('dialog');
+ within(secondDialog).getByText('support-bot');
+ assert.equal(within(secondDialog).getByLabelText<HTMLSelectElement>('Role').disabled, true);
+ await act(async () => {
+ release();
+ await updateGate;
+ });
+ await waitFor(() => assert.equal(queryClient!.isMutating(), 0));
+ assert.equal(
+ screen.queryByRole('dialog') === secondDialog,
+ true,
+ 'the completed key update closed the replacement editor',
+ );
+ within(secondDialog).getByText('support-bot');
+ assert.equal(within(secondDialog).getByLabelText<HTMLSelectElement>('Role').value, 'operator');
+ assert.deepEqual(updatePaths, ['/api/auth/api-keys/key-1']);
+ assert.deepEqual(updateBodies, [{ role: 'viewer' }]);
+ });
+}
+
+test('a successful key update closes its own editor after the response settles', async () => {
+ const { screen, fireEvent, waitFor } = rtl;
+ let release!: () => void;
+ updateGate = new Promise<void>(resolve => (release = resolve));
+ const save = await openEdit(billingBot);
+ fireEvent.change(screen.getByLabelText('Role'), { target: { value: 'viewer' } });
+ fireEvent.click(save);
+ await waitFor(() => assert.equal(updateBodies.length, 1));
+ assert.equal(screen.getByLabelText<HTMLSelectElement>('Role').disabled, true);
+ assert.equal(save.disabled, true);
+ fireEvent.click(save);
+ assert.equal(updateBodies.length, 1, 'a pending save sent another update');
+ release();
+ await waitFor(() => assert.equal(screen.queryByRole('dialog') === null, true));
+ assert.deepEqual(updatePaths, ['/api/auth/api-keys/key-1']);
+ assert.deepEqual(updateBodies, [{ role: 'viewer' }]);
+});
+
+test('cancelling an unsaved key edit closes it without an update', async () => {
+ const { screen, fireEvent, within } = rtl;
+ await openEdit(billingBot);
+ fireEvent.change(screen.getByLabelText('Role'), { target: { value: 'viewer' } });
+ fireEvent.click(within(screen.getByRole('dialog')).getByRole('button', { name: 'Cancel' }));
+ assert.equal(screen.queryByRole('dialog') === null, true);
+ assert.deepEqual(updateBodies, []);
+});
+
+test('a refused delayed key update keeps the draft available for retry and cancellation', async () => {
+ const { screen, fireEvent, within, waitFor } = rtl;
+ updateStatus = 409;
+ let release!: () => void;
+ updateGate = new Promise<void>(resolve => (release = resolve));
+ const save = await openEdit({ ...billingBot, role: 'admin' });
+ const dialog = screen.getByRole('dialog');
+ fireEvent.change(within(dialog).getByLabelText('Role'), { target: { value: 'viewer' } });
+ fireEvent.click(save);
+ await waitFor(() => assert.equal(updateBodies.length, 1));
+ assert.equal(within(dialog).getByLabelText<HTMLSelectElement>('Role').disabled, true);
+ assert.equal(save.disabled, true);
+ release();
+ await screen.findByText('Cannot remove the last active admin key');
+ await waitFor(() => assert.equal(save.disabled, false));
+ assert.equal(screen.getByRole('dialog') === dialog, true);
+ assert.equal(within(dialog).getByLabelText<HTMLSelectElement>('Role').value, 'viewer');
+ assert.equal(within(dialog).getByLabelText<HTMLSelectElement>('Role').disabled, false);
+ assert.deepEqual(updatePaths, ['/api/auth/api-keys/key-1']);
+ assert.deepEqual(updateBodies, [{ role: 'viewer' }]);
+ fireEvent.click(within(dialog).getByRole('button', { name: 'Cancel' }));
+ assert.equal(screen.queryByRole('dialog') === null, true);
+});
diff --git a/dashboard/src/pages/ApiKeys.tsx b/dashboard/src/pages/ApiKeys.tsx
index 042372c15..d41b7ab13 100644
--- a/dashboard/src/pages/ApiKeys.tsx
+++ b/dashboard/src/pages/ApiKeys.tsx
@@ -291,18 +291,23 @@ export function ApiKeys() {
}
};
+ const editVisit = useRef<object | null>(null);
+
const openEdit = (apiKey: ApiKey) => {
+ editVisit.current = {};
setEditingKey(apiKey);
setEditDraft(apiKeyDraft(apiKey));
};
const closeEdit = () => {
+ editVisit.current = null;
setEditingKey(null);
setEditDraft(null);
};
const handleSave = async () => {
if (!editingKey || !editDraft || !canSave) return;
+ const visit = editVisit.current;
// A stored expiry left as it is is not sent (see apiKeyPatch), so one past this browser's max (set
// from another time zone or through the API) does not block an unrelated change.
const expiryUntouched = editDraft.expires !== '' && editDraft.expires === toDateTimeLocal(editingKey.expiresAt);
@@ -318,7 +323,7 @@ export function ApiKeys() {
return;
}
await updateMutation.mutateAsync({ id: editingKey.id, data });
- closeEdit();
+ if (editVisit.current === visit) closeEdit();
} catch (err) {
console.error('Failed to update key:', err);
toast.error(t('apiKeys.edit.title'), err instanceof Error ? err.message : t('common.unknownError'));