Skip to content

Commit

Permalink
feat: add name property to share (#462)
Browse files Browse the repository at this point in the history 
* add name property to share

* refactor: run formatter

* tests: adapt system tests

* tests: adapt second system test
  • Loading branch information
@stonith404
stonith404 committed May 3, 2024
1 parent 0e12ba8 commit b717663
Show file tree
Hide file tree
Showing 13 changed files with 59 additions and 39 deletions.
2 changes: 2 additions & 0 deletions backend/prisma/migrations/20240501154254_share_name_property/migration.sql
View file
@@ -0,0 +1,2 @@
-- AlterTable
ALTER TABLE "Share" ADD COLUMN "name" TEXT;
1 change: 1 addition & 0 deletions backend/prisma/schema.prisma
View file
Expand Up @@ -75,6 +75,7 @@ model Share {
id String @id @default(uuid())
createdAt DateTime @default(now())
name String?
uploadLocked Boolean @default(false)
isZipReady Boolean @default(false)
views Int @default(0)
Expand Down
2 changes: 1 addition & 1 deletion backend/src/reverseShare/dto/reverseShareTokenWithShares.ts
View file
Expand Up @@ -13,7 +13,7 @@ export class ReverseShareTokenWithShares extends OmitType(ReverseShareDTO, [
@Type(() => OmitType(MyShareDTO, ["recipients", "hasPassword"] as const))
shares: Omit<
MyShareDTO,
"recipients" | "files" | "from" | "fromList" | "hasPassword"
"recipients" | "files" | "from" | "fromList" | "hasPassword" | "size"
>[];

@Expose()
Expand Down
4 changes: 4 additions & 0 deletions backend/src/share/dto/createShare.dto.ts
View file
Expand Up @@ -18,6 +18,10 @@ export class CreateShareDTO {
@Length(3, 50)
id: string;

@Length(3, 30)
@IsOptional()
name: string;

@IsString()
expiration: string;

Expand Down
6 changes: 6 additions & 0 deletions backend/src/share/dto/share.dto.ts
View file
Expand Up @@ -6,6 +6,9 @@ export class ShareDTO {
@Expose()
id: string;

@Expose()
name?: string;

@Expose()
expiration: Date;

Expand All @@ -23,6 +26,9 @@ export class ShareDTO {
@Expose()
hasPassword: boolean;

@Expose()
size: number;

from(partial: Partial<ShareDTO>) {
return plainToClass(ShareDTO, partial, { excludeExtraneousValues: true });
}
Expand Down
1 change: 1 addition & 0 deletions backend/src/share/share.service.ts
View file
Expand Up @@ -214,6 +214,7 @@ export class ShareService {
return shares.map((share) => {
return {
...share,
size: share.files.reduce((acc, file) => acc + parseInt(file.size), 0),
recipients: share.recipients.map((recipients) => recipients.email),
};
});
Expand Down
4 changes: 2 additions & 2 deletions backend/test/newman-system-tests.json
View file
Expand Up @@ -432,7 +432,7 @@
" const responseBody = pm.response.json();",
" pm.expect(responseBody).to.have.property(\"id\")",
" pm.expect(responseBody).to.have.property(\"expiration\")",
" pm.expect(Object.keys(responseBody).length).be.equal(3)",
" pm.expect(Object.keys(responseBody).length).be.equal(4)",
"});",
""
],
Expand Down Expand Up @@ -626,7 +626,7 @@
" const responseBody = pm.response.json();",
" pm.expect(responseBody).to.have.property(\"id\")",
" pm.expect(responseBody).to.have.property(\"expiration\")",
" pm.expect(Object.keys(responseBody).length).be.equal(3)",
" pm.expect(Object.keys(responseBody).length).be.equal(4)",
"});",
""
],
Expand Down
22 changes: 12 additions & 10 deletions frontend/src/components/account/showShareInformationsModal.tsx
View file
Expand Up @@ -17,13 +17,9 @@ const showShareInformationsModal = (
const t = translateOutsideContext();
const link = `${appUrl}/s/${share.id}`;

let shareSize: number = 0;
for (let file of share.files as FileMetaData[])
shareSize += parseInt(file.size);

const formattedShareSize = byteToHumanSizeString(shareSize);
const formattedShareSize = byteToHumanSizeString(share.size);
const formattedMaxShareSize = byteToHumanSizeString(maxShareSize);
const shareSizeProgress = (shareSize / maxShareSize) * 100;
const shareSizeProgress = (share.size / maxShareSize) * 100;

const formattedCreatedAt = moment(share.createdAt).format("LLL");
const formattedExpiration =
Expand All @@ -42,12 +38,18 @@ const showShareInformationsModal = (
</b>
{share.id}
</Text>
<Text size="sm">
<b>
<FormattedMessage id="account.shares.table.name" />:{" "}
</b>
{share.name || "-"}
</Text>

<Text size="sm">
<b>
<FormattedMessage id="account.shares.table.description" />:{" "}
</b>
{share.description || "No description"}
{share.description || "-"}
</Text>

<Text size="sm">
Expand Down Expand Up @@ -75,15 +77,15 @@ const showShareInformationsModal = (
</Text>

<Flex align="center" justify="center">
{shareSize / maxShareSize < 0.1 && (
{share.size / maxShareSize < 0.1 && (
<Text size="xs" style={{ marginRight: "4px" }}>
{formattedShareSize}
</Text>
)}
<Progress
value={shareSizeProgress}
label={shareSize / maxShareSize >= 0.1 ? formattedShareSize : ""}
style={{ width: shareSize / maxShareSize < 0.1 ? "70%" : "80%" }}
label={share.size / maxShareSize >= 0.1 ? formattedShareSize : ""}
style={{ width: share.size / maxShareSize < 0.1 ? "70%" : "80%" }}
size="xl"
radius="xl"
/>
Expand Down
22 changes: 18 additions & 4 deletions frontend/src/components/upload/modals/showCreateUploadModal.tsx
View file
Expand Up @@ -92,11 +92,16 @@ const CreateUploadModalBody = ({
.matches(new RegExp("^[a-zA-Z0-9_-]*$"), {
message: t("upload.modal.link.error.invalid"),
}),
name: yup
.string()
.transform((value) => value || undefined)
.min(3, t("common.error.too-short", { length: 3 }))
.max(30, t("common.error.too-long", { length: 30 })),
password: yup
.string()
.transform((value) => value || undefined)
.min(3)
.max(30),
.min(3, t("common.error.too-short", { length: 3 }))
.max(30, t("common.error.too-long", { length: 30 })),
maxViews: yup
.number()
.transform((value) => value || undefined)
Expand All @@ -105,6 +110,7 @@ const CreateUploadModalBody = ({

const form = useForm({
initialValues: {
name: undefined,
link: generatedLink,
recipients: [] as string[],
password: undefined,
Expand Down Expand Up @@ -154,6 +160,7 @@ const CreateUploadModalBody = ({
uploadCallback(
{
id: values.link,
name: values.name,
expiration: expirationString,
recipients: values.recipients,
description: values.description,
Expand Down Expand Up @@ -308,14 +315,21 @@ const CreateUploadModalBody = ({
<Accordion>
<Accordion.Item value="description" sx={{ borderBottom: "none" }}>
<Accordion.Control>
<FormattedMessage id="upload.modal.accordion.description.title" />
<FormattedMessage id="upload.modal.accordion.name-and-description.title" />
</Accordion.Control>
<Accordion.Panel>
<Stack align="stretch">
<TextInput
variant="filled"
placeholder={t(
"upload.modal.accordion.name-and-description.name.placeholder",
)}
{...form.getInputProps("name")}
/>
<Textarea
variant="filled"
placeholder={t(
"upload.modal.accordion.description.placeholder",
"upload.modal.accordion.name-and-description.description.placeholder",
)}
{...form.getInputProps("description")}
/>
Expand Down
5 changes: 3 additions & 2 deletions frontend/src/i18n/translations/en-US.ts
View file
Expand Up @@ -307,8 +307,9 @@ export default {
"upload.modal.expires.year-singular": "Year",
"upload.modal.expires.year-plural": "Years",

"upload.modal.accordion.description.title": "Description",
"upload.modal.accordion.description.placeholder":
"upload.modal.accordion.name-and-description.title": "Name and description",
"upload.modal.accordion.name-and-description.name.placeholder": "Name",
"upload.modal.accordion.name-and-description.description.placeholder":
"Note for the recipients of this share",

"upload.modal.accordion.email.title": "Email recipients",
Expand Down
22 changes: 4 additions & 18 deletions frontend/src/pages/account/shares.tsx
View file
Expand Up @@ -68,15 +68,12 @@ const MyShares = () => {
<Table>
<thead>
<tr>
<th>
<FormattedMessage id="account.shares.table.id" />
</th>
<th>
<FormattedMessage id="account.shares.table.name" />
</th>
<MediaQuery smallerThan="md" styles={{ display: "none" }}>
<th>
<FormattedMessage id="account.shares.table.description" />
</th>
</MediaQuery>

<th>
<FormattedMessage id="account.shares.table.visitors" />
</th>
Expand All @@ -90,18 +87,7 @@ const MyShares = () => {
{shares.map((share) => (
<tr key={share.id}>
<td>{share.id}</td>
<MediaQuery smallerThan="sm" styles={{ display: "none" }}>
<td
style={{
overflow: "hidden",
textOverflow: "ellipsis",
whiteSpace: "nowrap",
maxWidth: "300px",
}}
>
{share.description || ""}
</td>
</MediaQuery>
<td>{share.name}</td>
<td>{share.views}</td>
<td>
{moment(share.expiration).unix() === 0
Expand Down
4 changes: 2 additions & 2 deletions frontend/src/pages/share/[shareId]/index.tsx
View file
Expand Up @@ -91,13 +91,13 @@ const Share = ({ shareId }: { shareId: string }) => {
return (
<>
<Meta
title={t("share.title", { shareId })}
title={t("share.title", { shareId: share?.name || shareId })}
description={t("share.description")}
/>

<Group position="apart" mb="lg">
<Box style={{ maxWidth: "70%" }}>
<Title order={3}>{share?.id}</Title>
<Title order={3}>{share?.name || share?.id}</Title>
<Text size="sm">{share?.description}</Text>
</Box>
{share?.files.length > 1 && <DownloadAllButton shareId={shareId} />}
Expand Down
3 changes: 3 additions & 0 deletions frontend/src/types/share.type.ts
View file
Expand Up @@ -2,15 +2,18 @@ import User from "./user.type";

export type Share = {
id: string;
name?: string;
files: any;
creator: User;
description?: string;
expiration: Date;
size: number;
hasPassword: boolean;
};

export type CreateShare = {
id: string;
name?: string;
description?: string;
recipients: string[];
expiration: string;
Expand Down

0 comments on commit b717663

Please sign in to comment.