Merge pull request #2271 from appwrite/fix-keys

This commit is contained in:
Darshan authored and GitHub committed 2025-08-28 15:23:36 +05:30
commit 24b197c2f5
3 files changed
+101 -68

No files matched your search

@@ -16,6 +16,7 @@
import { symmetricDifference } from '$lib/helpers/array';
import Scopes from '../api-keys/scopes.svelte';
import { InteractiveText, Layout, Typography } from '@appwrite.io/pink-svelte';
import { getEffectiveScopes } from '../api-keys/scopes.svelte';
export let key: Models.DevKey | Models.Key;
export let keyType: 'api' | 'dev' = 'api';
@@ -162,6 +163,8 @@
{#if isApiKey}
<Form onSubmit={updateScopes}>
{@const apiKey = asApiKey(key)}
{@const apiKeyCorrectScopes = getEffectiveScopes(apiKey.scopes)}
{@const currentEffective = scopes ? getEffectiveScopes(scopes) : null}
<CardGrid>
<svelte:fragment slot="title">Scopes</svelte:fragment>
You can choose which permission scope to grant your application. It is a best practice
@@ -176,8 +179,8 @@
<Button
submit
disabled={scopes &&
apiKey?.scopes &&
!symmetricDifference(scopes, apiKey.scopes).length}>Update</Button>
!symmetricDifference(currentEffective, apiKeyCorrectScopes).length}
>Update</Button>
</svelte:fragment>
</CardGrid>
</Form>
@@ -11,6 +11,7 @@
import { Badge, FloatingActionBar, Layout, Table } from '@appwrite.io/pink-svelte';
import DeleteBatch from './deleteBatch.svelte';
import { capitalize } from '$lib/helpers/string';
import { getEffectiveScopes } from '../api-keys/scopes.svelte';
export let keyType: 'api' | 'dev' = 'api';
export let keys: Models.KeyList | Models.DevKeyList;
@@ -22,8 +23,9 @@
const label = isApiKey ? 'API' : 'dev';
const slug = isApiKey ? 'api-keys' : 'dev-keys';
function asApiKey(key: Models.Key | Models.DevKey) {
return key as Models.Key;
function getApiKeyScopeCount(key: Models.Key | Models.DevKey) {
const apiKey = key as Models.Key;
return getEffectiveScopes(apiKey.scopes).length;
}
function getExpiryDetails(key: Models.Key | Models.DevKey): {
@@ -85,7 +87,7 @@
</Table.Cell>
{#if isApiKey}
<Table.Cell {root}>
{asApiKey(key).scopes.length} Scopes
{getApiKeyScopeCount(key)} Scopes
</Table.Cell>
{/if}
</Table.Row.Link>
@@ -1,3 +1,30 @@
<script lang="ts" context="module">
const compatPairs = [
{ newer: 'tables.', legacy: 'collections.' },
{ newer: 'columns.', legacy: 'attributes.' },
{ newer: 'rows.', legacy: 'documents.' }
] as const;
export function getEffectiveScopes(scopes: string[]): string[] {
const effectiveScopes = new Set<string>();
for (const scope of scopes) {
let effectiveScope = scope;
for (const pair of compatPairs) {
if (scope.startsWith(pair.legacy)) {
effectiveScope = scope.replace(pair.legacy, pair.newer);
break;
}
}
effectiveScopes.add(effectiveScope);
}
return Array.from(effectiveScopes);
}
</script>
<script lang="ts">
import { Button } from '$lib/elements/forms';
import { scopes as allScopes } from '$lib/constants';
@@ -7,37 +34,14 @@
export let scopes: string[];
const newScopes = ['tables.', 'columns.', 'rows.'];
const legacyScopes = ['attributes.', 'collections.', 'documents.'];
const compatPairs = [
{ newer: 'tables.', legacy: 'collections.' },
{ newer: 'columns.', legacy: 'attributes.' },
{ newer: 'rows.', legacy: 'documents.' }
] as const;
const isCreateMode = scopes.length === 0;
const scopeCatalog = new Set(allScopes.map((s) => s.scope));
const hasLegacyScopes = !isCreateMode
? scopes.some((scope) => legacyScopes.some((prefix) => scope?.startsWith(prefix)))
: false;
const filteredScopes = allScopes.filter((scope) => {
const val = scope.scope;
if (!val) return false;
if (isCreateMode) {
return !legacyScopes.some((prefix) => val.startsWith(prefix));
}
if (hasLegacyScopes) {
// In edit mode, if legacy scopes exist, exclude new ones
return !newScopes.some((prefix) => val.startsWith(prefix));
} else {
// In edit mode, if new scopes exist, exclude new ones
return !legacyScopes.some((prefix) => val.startsWith(prefix));
}
const legacyPrefixes = ['collections.', 'attributes.', 'documents.'];
return !legacyPrefixes.some((prefix) => val.startsWith(prefix));
});
enum Category {
@@ -62,13 +66,18 @@
let mounted = false;
onMount(() => {
const computedScopes = syncScopes(scopes);
if (symmetricDifference(scopes, computedScopes).length) {
scopes = computedScopes;
}
const activeScopes = filteredScopes.reduce((prev, next) => {
prev[next.scope] = false;
return prev;
}, {});
scopes.forEach((scope) => (activeScopes[scope] = true));
onMount(() => {
scopes.forEach((scope) => {
const newerScope = toNewerScope(scope);
if (newerScope in activeScopes) {
activeScopes[newerScope] = true;
}
});
mounted = true;
});
@@ -85,14 +94,43 @@
}
}
function toNewerScope(scope: string): string {
for (const pair of compatPairs) {
if (scope.startsWith(pair.legacy)) {
return scope.replace(pair.legacy, pair.newer);
}
}
return scope;
}
function getAllScopeVariants(scope: string): string[] {
const variants = new Set([scope]);
for (const pair of compatPairs) {
if (scope.startsWith(pair.newer)) {
variants.add(scope.replace(pair.newer, pair.legacy));
} else if (scope.startsWith(pair.legacy)) {
variants.add(scope.replace(pair.legacy, pair.newer));
}
}
return Array.from(variants);
}
function categoryState(category: string, s: string[]): boolean | 'indeterminate' {
const scopesByCategory = filteredScopes.filter((n) => n.category === category);
const filtered = scopesByCategory.filter((n) => s.includes(n.scope));
if (filtered.length === 0) {
const activeInCategory = scopesByCategory.filter((scopeItem) => {
const newerScope = scopeItem.scope;
return s.some((scope) => toNewerScope(scope) === newerScope);
});
if (activeInCategory.length === 0) {
return false;
} else if (filtered.length === scopesByCategory.length) {
} else if (activeInCategory.length === scopesByCategory.length) {
return true;
}
return 'indeterminate';
}
@@ -105,41 +143,29 @@
});
}
function syncScopes(list: string[]): string[] {
const out = new Set(list);
const pairs = compatPairs.map((pair) =>
hasLegacyScopes
? ([pair.legacy, pair.newer] as const)
: ([pair.newer, pair.legacy] as const)
);
function generateSyncedScopes(activeScopesObj: Record<string, boolean>): string[] {
const result = new Set<string>();
for (const scope of list) {
for (const [from, to] of pairs) {
if (scope.startsWith(from)) {
const counterpart = scope.replace(from, to);
if (scopeCatalog.has(counterpart)) out.add(counterpart);
}
Object.entries(activeScopesObj).forEach(([scope, isActive]) => {
if (isActive) {
const variants = getAllScopeVariants(scope);
variants.forEach((variant) => {
if (scopeCatalog.has(variant)) {
result.add(variant);
}
});
}
}
return Array.from(out);
});
return Array.from(result);
}
const activeScopes = filteredScopes.reduce((prev, next) => {
prev[next.scope] = false;
return prev;
}, {});
$: {
if (mounted) {
const newScopeSet = filteredScopes
.filter((scope) => activeScopes[scope.scope])
.map(({ scope }) => scope);
const newScopes = generateSyncedScopes(activeScopes);
const updatedScopes = hasLegacyScopes ? newScopeSet : syncScopes(newScopeSet);
if (symmetricDifference(scopes, updatedScopes).length) {
scopes = updatedScopes;
if (symmetricDifference(scopes, newScopes).length) {
scopes = newScopes;
}
}
}
@@ -160,7 +186,9 @@
{@const checked = categoryState(category, scopes)}
{@const isLastItem = index === categories.length - 1}
{@const scopesLength = filteredScopes.filter(
(n) => n.category === category && scopes.includes(n.scope)
(n) =>
n.category === category &&
scopes.some((scope) => toNewerScope(scope) === n.scope)
).length}
<Accordion
selectable