Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions e2e/storage/details.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -226,4 +226,58 @@ test.describe('Storage S3 — Details Modal', () => {
await expect(modal.getByText('Disabled')).toHaveCount(0);
await expect(modal.getByText('No lifecycle rules')).toBeVisible();
});

test('shows lifecycle rule filter conditions', async ({ page }) => {
const credentials = requireGarageCredentials();
const bucket = credentials.bucket;
const rule = (id: string, filter: object) => ({
id,
status: 'Enabled',
filter: { tags: [], ...filter },
transitions: [],
expirations: [{ days: 30 }],
noncurrentVersionTransitions: [],
noncurrentVersionExpirations: [],
abortIncompleteMultipartUploads: []
});

await page.route(
(url) =>
url.pathname === '/api/storage/buckets' && url.searchParams.get('details') === 'true',
(route) =>
route.fulfill({
json: {
name: bucket,
versioning: 'Enabled',
lifecycleRules: [
rule('prefix-only', { prefix: 'logs/' }),
rule('combined', {
prefix: 'tmp/',
tags: [{ key: 'team', value: 'data' }],
objectSizeGreaterThan: 1_000_000
}),
rule('everything', {})
],
tags: {},
acl: null
}
})
);

await connectToStorage(page, credentials);
await expect(page).toHaveURL('/storage');

const sidebar = page.getByRole('navigation', { name: 'Buckets' });
await sidebar.getByText(bucket).click({ button: 'right' });
await page.getByRole('menuitem', { name: 'Details' }).click();

const modal = page.getByRole('dialog');
await expect(modal.getByText('Prefix: logs/')).toBeVisible();
await expect(modal.getByText('Prefix: tmp/')).toBeVisible();
await expect(modal.getByText('Tag: team = data')).toBeVisible();
await expect(modal.getByText('Size > 1 MB')).toBeVisible();
await expect(modal).toContainText('Prefix: tmp/ and Tag: team = data and Size > 1 MB');
await expect(modal.getByText('All objects')).toHaveCount(1);
await expect(modal.getByText(/[{}]/)).toHaveCount(0);
});
});
4 changes: 4 additions & 0 deletions messages/de.json
Original file line number Diff line number Diff line change
Expand Up @@ -657,6 +657,10 @@
"storage_details_lifecycle_noncurrent_transition": "Übergang inakt. Versionen",
"storage_details_lifecycle_transition_to": "→ {storageClass}",
"storage_details_lifecycle_prefix_filter": "Präfix: {prefix}",
"storage_details_lifecycle_filter_and": "und",
"storage_details_lifecycle_tag_filter": "Tag: {key} = {value}",
"storage_details_lifecycle_size_greater_filter": "Größe > {size}",
"storage_details_lifecycle_size_less_filter": "Größe < {size}",
"storage_details_lifecycle_all_objects": "Alle Objekte",
"storage_details_lifecycle_no_rules": "Keine Lebenszyklus-Regeln konfiguriert",
"storage_details_tags": "Tags",
Expand Down
4 changes: 4 additions & 0 deletions messages/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -657,6 +657,10 @@
"storage_details_lifecycle_noncurrent_transition": "Noncurrent transition",
"storage_details_lifecycle_transition_to": "→ {storageClass}",
"storage_details_lifecycle_prefix_filter": "Prefix: {prefix}",
"storage_details_lifecycle_filter_and": "and",
"storage_details_lifecycle_tag_filter": "Tag: {key} = {value}",
"storage_details_lifecycle_size_greater_filter": "Size > {size}",
"storage_details_lifecycle_size_less_filter": "Size < {size}",
"storage_details_lifecycle_all_objects": "All objects",
"storage_details_lifecycle_no_rules": "No lifecycle rules configured",
"storage_details_tags": "Tags",
Expand Down
49 changes: 33 additions & 16 deletions src/lib/components/storage/modals/details/BucketDetails.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@
import IconKey from 'virtual:icons/material-symbols/key';
import { getStorageState } from '$lib/storage/context.js';
import { getDetailsErrorMessage } from '$lib/storage/errors.js';
import type { BucketDetails as BucketDetailsType } from '$lib/storage/details-types.js';
import type {
BucketDetails as BucketDetailsType,
LifecycleFilter
} from '$lib/storage/details-types.js';
import { formatFileSize } from '$lib/storage/utils.js';

interface Props {
bucket: string;
Expand All @@ -16,6 +20,29 @@

const storage = getStorageState();

/** One label per filter condition; S3 requires all of them to match. */
function lifecycleFilterConditions(filter: LifecycleFilter): string[] {
const size = (bytes: number) => formatFileSize(bytes, undefined, {});
return [
...(filter.prefix
? [m.storage_details_lifecycle_prefix_filter({ prefix: filter.prefix })]
: []),
...filter.tags.map((t) =>
m.storage_details_lifecycle_tag_filter({ key: t.key, value: t.value })
),
...(filter.objectSizeGreaterThan !== undefined
? [
m.storage_details_lifecycle_size_greater_filter({
size: size(filter.objectSizeGreaterThan)
})
]
: []),
...(filter.objectSizeLessThan !== undefined
? [m.storage_details_lifecycle_size_less_filter({ size: size(filter.objectSizeLessThan) })]
: [])
];
}

let loading = $state(true);
let error = $state<string | null>(null);
let details = $state<BucketDetailsType | null>(null);
Expand Down Expand Up @@ -163,25 +190,15 @@

<div class="text-muted mb-2 text-xs">
<span>{m.storage_details_lifecycle_filter()}:</span>
{#if rule.filter && typeof rule.filter === 'object' && 'prefix' in (rule.filter as Record<string, unknown>) && (rule.filter as Record<string, unknown>).prefix}
<span class="text-base-content font-mono leading-none">
{m.storage_details_lifecycle_prefix_filter({
prefix: String((rule.filter as Record<string, unknown>).prefix)
})}
</span>
{:else if rule.filter && typeof rule.filter === 'object' && 'and' in (rule.filter as Record<string, unknown>)}
<span class="text-base-content font-mono leading-none">
AND ({(rule.filter as Record<string, unknown>).and as string})
</span>
{:else if rule.filter && typeof rule.filter === 'object' && Object.keys(rule.filter).length > 0}
<span class="text-base-content font-mono leading-none">
{JSON.stringify(rule.filter)}
</span>
{#each lifecycleFilterConditions(rule.filter) as condition, i (i)}
<!-- Svelte trims whitespace at iteration edges, so the separator carries its own leading space. -->
{#if i > 0}<span>&nbsp;{m.storage_details_lifecycle_filter_and()}</span>{/if}
<span class="text-base-content font-mono leading-none">{condition}</span>
{:else}
<span class="text-muted leading-none italic"
>{m.storage_details_lifecycle_all_objects()}</span
>
{/if}
{/each}
</div>

{#if rule.transitions.length > 0}
Expand Down
48 changes: 48 additions & 0 deletions src/lib/server/storage/s3-provider-bucket-info.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,54 @@ describe('S3StorageProvider.getBucketLifecycleRules', () => {
]);
});

it.each([
['no filter', {}, { prefix: undefined, tags: [] }],
['an empty filter', { Filter: {} }, { prefix: undefined, tags: [] }],
['an empty prefix', { Filter: { Prefix: '' } }, { prefix: undefined, tags: [] }],
['a prefix', { Filter: { Prefix: 'logs/' } }, { prefix: 'logs/', tags: [] }],
['a legacy rule prefix', { Prefix: 'old/' }, { prefix: 'old/', tags: [] }],
[
'a single tag',
{ Filter: { Tag: { Key: 'team', Value: 'data' } } },
{ prefix: undefined, tags: [{ key: 'team', value: 'data' }] }
],
[
'a size bound',
{ Filter: { ObjectSizeGreaterThan: 1024 } },
{ prefix: undefined, tags: [], objectSizeGreaterThan: 1024 }
],
[
'an And filter',
{
Filter: {
And: {
Prefix: 'tmp/',
Tags: [
{ Key: 'a', Value: '1' },
{ Key: 'b', Value: '2' }
],
ObjectSizeGreaterThan: 10,
ObjectSizeLessThan: 100
}
}
},
{
prefix: 'tmp/',
tags: [
{ key: 'a', value: '1' },
{ key: 'b', value: '2' }
],
objectSizeGreaterThan: 10,
objectSizeLessThan: 100
}
]
])('maps a rule with %s', async (_name, rule, filter) => {
const { provider, send } = makeProvider();
send.mockResolvedValue({ Rules: [{ ID: 'r', Status: 'Enabled', ...rule }] });
const rules = await provider.getBucketLifecycleRules();
expect(rules?.[0].filter).toEqual(filter);
});

it('returns an empty list when no lifecycle configuration exists', async () => {
const { provider, send } = makeProvider();
send.mockRejectedValue(makeS3Error('NoSuchLifecycleConfiguration', 404));
Expand Down
32 changes: 29 additions & 3 deletions src/lib/server/storage/s3-provider.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ import {
UploadPartCopyCommand,
CompleteMultipartUploadCommand,
AbortMultipartUploadCommand,
type ListObjectsV2CommandOutput
type ListObjectsV2CommandOutput,
type LifecycleRule as S3LifecycleRule
} from '@aws-sdk/client-s3';
import { Upload } from '@aws-sdk/lib-storage';
import { error } from '@sveltejs/kit';
Expand All @@ -37,7 +38,12 @@ import type {
StorageMetadata,
SearchResultItem
} from '$lib/storage/types.js';
import type { LifecycleRule, BucketAcl, BucketVersioning } from '$lib/storage/details-types.js';
import type {
LifecycleFilter,
LifecycleRule,
BucketAcl,
BucketVersioning
} from '$lib/storage/details-types.js';
import { logger } from '$lib/server/logging';
import { createS3Client } from './s3-client.js';
import { mapS3ErrorToHttp } from './s3-errors.js';
Expand Down Expand Up @@ -114,6 +120,26 @@ async function withS3Errors<T>(
}
}

/**
* Flatten an S3 lifecycle filter into its conditions. S3 allows a single condition or an `And`
* of several; both mean all conditions must match, so they are merged. Rules from the deprecated
* schema carry their prefix on the rule itself instead of in `Filter`.
*/
function mapLifecycleFilter(rule: S3LifecycleRule): LifecycleFilter {
const filter = rule.Filter ?? {};
const and = filter.And ?? {};
const tags = [...(filter.Tag ? [filter.Tag] : []), ...(and.Tags ?? [])].map((t) => ({
key: t.Key ?? '',
value: t.Value ?? ''
}));
return {
prefix: filter.Prefix || and.Prefix || rule.Prefix || undefined,
tags,
objectSizeGreaterThan: filter.ObjectSizeGreaterThan ?? and.ObjectSizeGreaterThan,
objectSizeLessThan: filter.ObjectSizeLessThan ?? and.ObjectSizeLessThan
};
}

export class S3StorageProvider implements StorageProvider {
private readonly client: S3Client;
private readonly bucket: string;
Expand Down Expand Up @@ -515,7 +541,7 @@ export class S3StorageProvider implements StorageProvider {
return {
id: rule.ID ?? '',
status: rule.Status === 'Enabled' ? 'Enabled' : 'Disabled',
filter: (rule.Filter as Record<string, unknown>) ?? {},
filter: mapLifecycleFilter(rule),
transitions: (rule.Transitions ?? []).map((t) => ({
days: t.Days ?? 0,
storageClass: t.StorageClass ?? ''
Expand Down
11 changes: 10 additions & 1 deletion src/lib/storage/details-types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,20 @@ interface DirectorySizeError {

export type DirectorySizeEvent = DirectorySizeProgress | DirectorySizeResult | DirectorySizeError;

/** Objects a lifecycle rule applies to. All set conditions must match; an
* empty filter applies to all objects in the bucket. */
export interface LifecycleFilter {
prefix?: string;
tags: Array<{ key: string; value: string }>;
objectSizeGreaterThan?: number;
objectSizeLessThan?: number;
}

/** Lifecycle rule from S3 bucket lifecycle configuration. */
export interface LifecycleRule {
id: string;
status: 'Enabled' | 'Disabled';
filter: Record<string, unknown>;
filter: LifecycleFilter;
transitions: Array<{ days: number; storageClass: string }>;
expirations: Array<{ days?: number; date?: string; expiredObjectDeleteMarker?: boolean }>;
noncurrentVersionTransitions: Array<{ noncurrentDays: number; storageClass: string }>;
Expand Down
2 changes: 1 addition & 1 deletion src/routes/(app)/api/storage/buckets/server.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ describe('GET /api/storage/buckets', () => {
{
id: 'rule-1',
status: 'Enabled',
filter: { prefix: 'logs/' },
filter: { prefix: 'logs/', tags: [] },
transitions: [],
expirations: [{ days: 30 }],
noncurrentVersionTransitions: [],
Expand Down
Loading