mirror of
https://github.com/outline/outline.git
synced 2026-11-21 05:24:03 +03:00
track access requests
This commit is contained in:
1 parent
9f96245055
commit
2c2efe57db
21 files changed
+829
-22
No files matched your search
@@ -18,6 +18,7 @@ import Time from "../Time";
|
||||
import { UnreadBadge } from "../UnreadBadge";
|
||||
import { Permission } from "~/types";
|
||||
import lazyWithRetry from "~/utils/lazyWithRetry";
|
||||
import { client } from "~/utils/ApiClient";
|
||||
|
||||
const CommentEditor = lazyWithRetry(
|
||||
() => import("~/scenes/Document/components/CommentEditor")
|
||||
@@ -30,7 +31,7 @@ type Props = {
|
||||
|
||||
function NotificationListItem({ notification, onNavigate }: Props) {
|
||||
const { t } = useTranslation();
|
||||
const { collections, userMemberships } = useStores();
|
||||
const { collections } = useStores();
|
||||
const collectionId = notification.document?.collectionId;
|
||||
const collection = collectionId ? collections.get(collectionId) : undefined;
|
||||
const [processing, setProcessing] = React.useState(false);
|
||||
@@ -76,13 +77,19 @@ function NotificationListItem({ notification, onNavigate }: Props) {
|
||||
event.preventDefault();
|
||||
event.stopPropagation();
|
||||
|
||||
if (!collection || !notification.actor || processing) {return;}
|
||||
if (
|
||||
!collection ||
|
||||
!notification.actor ||
|
||||
processing ||
|
||||
!notification.accessRequestId
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
setProcessing(true);
|
||||
try {
|
||||
await userMemberships.create({
|
||||
documentId: notification.documentId,
|
||||
userId: notification.actor?.id,
|
||||
await client.post("/access_requests.approve", {
|
||||
id: notification.accessRequestId,
|
||||
permission: selectedPermission,
|
||||
});
|
||||
toast.success(
|
||||
@@ -97,14 +104,32 @@ function NotificationListItem({ notification, onNavigate }: Props) {
|
||||
setProcessing(false);
|
||||
}
|
||||
},
|
||||
[
|
||||
notification,
|
||||
processing,
|
||||
selectedPermission,
|
||||
t,
|
||||
userMemberships,
|
||||
collection,
|
||||
]
|
||||
[notification, processing, selectedPermission, t, collection]
|
||||
);
|
||||
|
||||
const handleDismiss = React.useCallback(
|
||||
async (event: React.MouseEvent) => {
|
||||
event.preventDefault();
|
||||
event.stopPropagation();
|
||||
|
||||
if (!notification.accessRequestId || processing) {
|
||||
return;
|
||||
}
|
||||
|
||||
setProcessing(true);
|
||||
try {
|
||||
await client.post("/access_requests.dismiss", {
|
||||
id: notification.accessRequestId,
|
||||
});
|
||||
toast.success(t("Access request dismissed"));
|
||||
void notification.markAsRead();
|
||||
} catch {
|
||||
toast.error(t("Failed to dismiss access request"));
|
||||
} finally {
|
||||
setProcessing(false);
|
||||
}
|
||||
},
|
||||
[notification, processing, t]
|
||||
);
|
||||
|
||||
return (
|
||||
@@ -148,7 +173,7 @@ function NotificationListItem({ notification, onNavigate }: Props) {
|
||||
{t("Approve")}
|
||||
</Button>
|
||||
<Button
|
||||
onClick={() => void notification.markAsRead()}
|
||||
onClick={handleDismiss}
|
||||
disabled={processing}
|
||||
neutral
|
||||
size="small"
|
||||
|
||||
@@ -32,6 +32,13 @@ class Notification extends Model {
|
||||
@observable
|
||||
archivedAt: Date | null;
|
||||
|
||||
/**
|
||||
* Request ID on notifications for access requests.
|
||||
*/
|
||||
@Field
|
||||
@observable
|
||||
accessRequestId?: string;
|
||||
|
||||
/**
|
||||
* The user that triggered the notification.
|
||||
*/
|
||||
|
||||
@@ -21,12 +21,25 @@ const Error403 = ({ documentId }: Props) => {
|
||||
const [requesting, setRequesting] = React.useState(false);
|
||||
const [requested, setRequested] = React.useState(false);
|
||||
|
||||
React.useEffect(() => {
|
||||
const getAccessRequest = async () => {
|
||||
const request = await client.post("/access_requests.info", {
|
||||
documentSlug: documentId,
|
||||
});
|
||||
|
||||
if (request.data.status === "pending") {
|
||||
setRequested(true);
|
||||
}
|
||||
};
|
||||
|
||||
getAccessRequest();
|
||||
}, [documentId]);
|
||||
|
||||
const handleRequestAccess = React.useCallback(async () => {
|
||||
if (!documentId || requesting || requested) {
|
||||
return;
|
||||
}
|
||||
|
||||
setRequesting(true);
|
||||
try {
|
||||
await client.post("/documents.request_access", { id: documentId });
|
||||
setRequested(true);
|
||||
@@ -42,12 +55,20 @@ const Error403 = ({ documentId }: Props) => {
|
||||
<Scene title={t("No access to this doc")}>
|
||||
<Heading>{t("No access to this doc")}</Heading>
|
||||
<Flex gap={20} style={{ maxWidth: 500 }} column>
|
||||
<Empty size="large">
|
||||
{t(
|
||||
"It doesn't look like you have permission to access this document."
|
||||
)}{" "}
|
||||
{t("You can request access from a document manager.")}
|
||||
</Empty>
|
||||
{requested ? (
|
||||
<Empty size="large">
|
||||
{t(
|
||||
"You have sucessfully sent a request to access this document. You will be notified once access is granted."
|
||||
)}{" "}
|
||||
</Empty>
|
||||
) : (
|
||||
<Empty size="large">
|
||||
{t(
|
||||
"It doesn't look like you have permission to access this document."
|
||||
)}{" "}
|
||||
{t("You can request access from a document manager.")}
|
||||
</Empty>
|
||||
)}
|
||||
<Flex gap={8}>
|
||||
{documentId && (
|
||||
<Button
|
||||
|
||||
@@ -0,0 +1,83 @@
|
||||
"use strict";
|
||||
|
||||
/** @type {import('sequelize-cli').Migration} */
|
||||
module.exports = {
|
||||
async up(queryInterface, Sequelize) {
|
||||
await queryInterface.createTable("access_requests", {
|
||||
id: {
|
||||
type: Sequelize.UUID,
|
||||
primaryKey: true,
|
||||
defaultValue: Sequelize.UUIDV4,
|
||||
allowNull: false,
|
||||
},
|
||||
status: {
|
||||
type: Sequelize.STRING,
|
||||
allowNull: false,
|
||||
defaultValue: "pending",
|
||||
},
|
||||
respondedAt: {
|
||||
type: Sequelize.DATE,
|
||||
allowNull: true,
|
||||
},
|
||||
createdAt: {
|
||||
type: Sequelize.DATE,
|
||||
allowNull: false,
|
||||
defaultValue: Sequelize.NOW,
|
||||
},
|
||||
updatedAt: {
|
||||
type: Sequelize.DATE,
|
||||
allowNull: false,
|
||||
defaultValue: Sequelize.NOW,
|
||||
},
|
||||
documentId: {
|
||||
type: Sequelize.UUID,
|
||||
allowNull: false,
|
||||
references: {
|
||||
model: "documents",
|
||||
key: "id",
|
||||
},
|
||||
onDelete: "CASCADE",
|
||||
onUpdate: "CASCADE",
|
||||
},
|
||||
userId: {
|
||||
type: Sequelize.UUID,
|
||||
allowNull: false,
|
||||
references: {
|
||||
model: "users",
|
||||
key: "id",
|
||||
},
|
||||
onDelete: "CASCADE",
|
||||
onUpdate: "CASCADE",
|
||||
},
|
||||
teamId: {
|
||||
type: Sequelize.UUID,
|
||||
allowNull: false,
|
||||
references: {
|
||||
model: "teams",
|
||||
key: "id",
|
||||
},
|
||||
onDelete: "CASCADE",
|
||||
onUpdate: "CASCADE",
|
||||
},
|
||||
responderId: {
|
||||
type: Sequelize.UUID,
|
||||
allowNull: true,
|
||||
references: {
|
||||
model: "users",
|
||||
key: "id",
|
||||
},
|
||||
onDelete: "SET NULL",
|
||||
onUpdate: "CASCADE",
|
||||
},
|
||||
});
|
||||
|
||||
await queryInterface.addIndex("access_requests", ["documentId"]);
|
||||
await queryInterface.addIndex("access_requests", ["userId"]);
|
||||
await queryInterface.addIndex("access_requests", ["teamId"]);
|
||||
await queryInterface.addIndex("access_requests", ["status"]);
|
||||
},
|
||||
|
||||
async down(queryInterface) {
|
||||
await queryInterface.dropTable("access_requests");
|
||||
},
|
||||
};
|
||||
@@ -0,0 +1,24 @@
|
||||
"use strict";
|
||||
|
||||
/** @type {import('sequelize-cli').Migration} */
|
||||
module.exports = {
|
||||
async up(queryInterface, Sequelize) {
|
||||
await queryInterface.addColumn("notifications", "accessRequestId", {
|
||||
type: Sequelize.UUID,
|
||||
allowNull: true,
|
||||
references: {
|
||||
model: "access_requests",
|
||||
key: "id",
|
||||
},
|
||||
onDelete: "SET NULL",
|
||||
onUpdate: "CASCADE",
|
||||
});
|
||||
|
||||
await queryInterface.addIndex("notifications", ["accessRequestId"]);
|
||||
},
|
||||
|
||||
async down(queryInterface) {
|
||||
await queryInterface.removeIndex("notifications", ["accessRequestId"]);
|
||||
await queryInterface.removeColumn("notifications", "accessRequestId");
|
||||
},
|
||||
};
|
||||
@@ -0,0 +1,129 @@
|
||||
import type { InferAttributes, InferCreationAttributes } from "sequelize";
|
||||
import {
|
||||
Table,
|
||||
ForeignKey,
|
||||
Column,
|
||||
PrimaryKey,
|
||||
IsUUID,
|
||||
CreatedAt,
|
||||
UpdatedAt,
|
||||
BelongsTo,
|
||||
DataType,
|
||||
Default,
|
||||
AllowNull,
|
||||
DefaultScope,
|
||||
} from "sequelize-typescript";
|
||||
import Model from "@server/models/base/Model";
|
||||
import Document from "./Document";
|
||||
import Team from "./Team";
|
||||
import User from "./User";
|
||||
import Fix from "./decorators/Fix";
|
||||
|
||||
export enum AccessRequestStatus {
|
||||
Pending = "pending",
|
||||
Approved = "approved",
|
||||
Dismissed = "dismissed",
|
||||
}
|
||||
|
||||
@DefaultScope(() => ({
|
||||
include: [
|
||||
{
|
||||
association: "user",
|
||||
required: true,
|
||||
},
|
||||
{
|
||||
association: "document",
|
||||
required: true,
|
||||
},
|
||||
{
|
||||
association: "responder",
|
||||
required: false,
|
||||
},
|
||||
],
|
||||
}))
|
||||
@Table({
|
||||
tableName: "access_requests",
|
||||
modelName: "access_request",
|
||||
})
|
||||
@Fix
|
||||
class AccessRequest extends Model<
|
||||
InferAttributes<AccessRequest>,
|
||||
Partial<InferCreationAttributes<AccessRequest>>
|
||||
> {
|
||||
@IsUUID(4)
|
||||
@PrimaryKey
|
||||
@Default(DataType.UUIDV4)
|
||||
@Column(DataType.UUID)
|
||||
id: string;
|
||||
|
||||
@Default(AccessRequestStatus.Pending)
|
||||
@Column(DataType.STRING)
|
||||
status: AccessRequestStatus;
|
||||
|
||||
@AllowNull
|
||||
@Column
|
||||
respondedAt: Date | null;
|
||||
|
||||
@CreatedAt
|
||||
createdAt: Date;
|
||||
|
||||
@UpdatedAt
|
||||
updatedAt: Date;
|
||||
|
||||
// associations
|
||||
@BelongsTo(() => Document, "documentId")
|
||||
document: Document;
|
||||
|
||||
@ForeignKey(() => Document)
|
||||
@Column(DataType.UUID)
|
||||
documentId: string;
|
||||
|
||||
@BelongsTo(() => User, "userId")
|
||||
user: User;
|
||||
|
||||
@ForeignKey(() => User)
|
||||
@Column(DataType.UUID)
|
||||
userId: string;
|
||||
|
||||
@BelongsTo(() => Team, "teamId")
|
||||
team: Team;
|
||||
|
||||
@ForeignKey(() => Team)
|
||||
@Column(DataType.UUID)
|
||||
teamId: string;
|
||||
|
||||
@BelongsTo(() => User, "responderId")
|
||||
responder: User | null;
|
||||
|
||||
@AllowNull
|
||||
@ForeignKey(() => User)
|
||||
@Column(DataType.UUID)
|
||||
responderId: string | null;
|
||||
|
||||
/**
|
||||
* Check if the user has a pending request on this document.
|
||||
*
|
||||
* @param documentId The document ID.
|
||||
* @param userId The user ID.
|
||||
* @returns True if there's a pending request.
|
||||
*/
|
||||
public static async hasPendingRequest(
|
||||
documentId: string,
|
||||
userId: string
|
||||
): Promise<boolean> {
|
||||
if (!documentId || !userId) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const count = await this.count({
|
||||
where: {
|
||||
documentId,
|
||||
userId,
|
||||
status: AccessRequestStatus.Pending,
|
||||
},
|
||||
});
|
||||
return count > 0;
|
||||
}
|
||||
}
|
||||
|
||||
export default AccessRequest;
|
||||
@@ -32,6 +32,7 @@ import Team from "./Team";
|
||||
import User from "./User";
|
||||
import Group from "./Group";
|
||||
import Fix from "./decorators/Fix";
|
||||
import AccessRequest from "./AccessRequest";
|
||||
|
||||
let baseDomain;
|
||||
|
||||
@@ -195,6 +196,14 @@ class Notification extends Model<
|
||||
@Column(DataType.UUID)
|
||||
membershipId: string;
|
||||
|
||||
@BelongsTo(() => AccessRequest, "accessRequestId")
|
||||
accessRequest: AccessRequest;
|
||||
|
||||
@AllowNull
|
||||
@ForeignKey(() => AccessRequest)
|
||||
@Column(DataType.UUID)
|
||||
accessRequestId: string;
|
||||
|
||||
@AfterCreate
|
||||
static async createEvent(
|
||||
model: Notification,
|
||||
|
||||
@@ -69,3 +69,5 @@ export { default as WebhookDelivery } from "./WebhookDelivery";
|
||||
export { default as Subscription } from "./Subscription";
|
||||
|
||||
export { default as Emoji } from "./Emoji";
|
||||
|
||||
export { default as AccessRequest } from "./AccessRequest";
|
||||
@@ -0,0 +1,7 @@
|
||||
import { AccessRequest, User } from "@server/models";
|
||||
import { allow } from "./cancan";
|
||||
import { isTeamModel } from "./utils";
|
||||
|
||||
allow(User, "read", AccessRequest, (actor, accessRequest) =>
|
||||
isTeamModel(actor, accessRequest?.user)
|
||||
);
|
||||
@@ -27,3 +27,4 @@ import "./group";
|
||||
import "./webhookSubscription";
|
||||
import "./userMembership";
|
||||
import "./emoji";
|
||||
import "./accessRequest";
|
||||
@@ -0,0 +1,20 @@
|
||||
import { AccessRequest } from "@server/models";
|
||||
import presentUser from "./user";
|
||||
|
||||
export default function present(accessRequest: AccessRequest) {
|
||||
return {
|
||||
id: accessRequest.id,
|
||||
documentId: accessRequest.documentId,
|
||||
userId: accessRequest.userId,
|
||||
user: accessRequest.user ? presentUser(accessRequest.user) : undefined,
|
||||
teamId: accessRequest.teamId,
|
||||
status: accessRequest.status,
|
||||
responderId: accessRequest.responderId,
|
||||
responder: accessRequest.responder
|
||||
? presentUser(accessRequest.responder)
|
||||
: undefined,
|
||||
respondedAt: accessRequest.respondedAt,
|
||||
createdAt: accessRequest.createdAt,
|
||||
updatedAt: accessRequest.updatedAt,
|
||||
};
|
||||
}
|
||||
@@ -29,6 +29,7 @@ import presentTeam from "./team";
|
||||
import presentUser from "./user";
|
||||
import presentView from "./view";
|
||||
import presentEmoji from "./emoji";
|
||||
import presentAccessRequest from "./accessRequests";
|
||||
|
||||
export {
|
||||
presentApiKey,
|
||||
@@ -63,4 +64,5 @@ export {
|
||||
presentUser,
|
||||
presentView,
|
||||
presentEmoji,
|
||||
presentAccessRequest,
|
||||
};
|
||||
@@ -10,6 +10,7 @@ export default async function presentNotification(
|
||||
return {
|
||||
id: notification.id,
|
||||
viewedAt: notification.viewedAt,
|
||||
accessRequestId: notification.accessRequestId,
|
||||
archivedAt: notification.archivedAt,
|
||||
createdAt: notification.createdAt,
|
||||
event: notification.event,
|
||||
|
||||
@@ -5,7 +5,13 @@ import {
|
||||
CollectionPermission,
|
||||
} from "@shared/types";
|
||||
import Logger from "@server/logging/Logger";
|
||||
import { Document, Notification, User, Collection } from "@server/models";
|
||||
import {
|
||||
Document,
|
||||
Notification,
|
||||
User,
|
||||
Collection,
|
||||
AccessRequest,
|
||||
} from "@server/models";
|
||||
import { DocumentAccessRequestEvent } from "@server/types";
|
||||
import { BaseTask, TaskPriority } from "./base/BaseTask";
|
||||
import { uniq } from "lodash";
|
||||
@@ -40,12 +46,19 @@ export default class DocumentAccessRequestNotificationsTask extends BaseTask<Doc
|
||||
continue;
|
||||
}
|
||||
|
||||
const accessReq = await AccessRequest.create({
|
||||
documentId: document.id,
|
||||
teamId: document.teamId,
|
||||
userId: event.actorId,
|
||||
});
|
||||
|
||||
await Notification.create({
|
||||
event: NotificationEventType.RequestDocumentAccess,
|
||||
userId: recipient.id,
|
||||
actorId: event.actorId,
|
||||
teamId: event.teamId,
|
||||
documentId: event.documentId,
|
||||
accessRequestId: accessReq.id,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,233 @@
|
||||
import { DocumentPermission } from "@shared/types";
|
||||
import { AccessRequest, UserMembership } from "@server/models";
|
||||
import { AccessRequestStatus } from "@server/models/AccessRequest";
|
||||
import {
|
||||
buildAdmin,
|
||||
buildDocument,
|
||||
buildTeam,
|
||||
buildUser,
|
||||
} from "@server/test/factories";
|
||||
import { getTestServer } from "@server/test/support";
|
||||
|
||||
const server = getTestServer();
|
||||
|
||||
describe("#access_requests.approve", () => {
|
||||
it("should require authentication", async () => {
|
||||
const res = await server.post("/api/access_requests.approve");
|
||||
expect(res.status).toEqual(401);
|
||||
});
|
||||
|
||||
it("should approve an access request and grant access", async () => {
|
||||
const team = await buildTeam();
|
||||
const requester = await buildUser({ teamId: team.id });
|
||||
const admin = await buildAdmin({ teamId: team.id });
|
||||
const document = await buildDocument({
|
||||
userId: admin.id,
|
||||
teamId: team.id,
|
||||
});
|
||||
|
||||
// Create document admin membership
|
||||
await UserMembership.create({
|
||||
userId: admin.id,
|
||||
documentId: document.id,
|
||||
createdById: admin.id,
|
||||
permission: DocumentPermission.Admin,
|
||||
});
|
||||
|
||||
// Create access request
|
||||
const accessRequest = await AccessRequest.create({
|
||||
documentId: document.id,
|
||||
userId: requester.id,
|
||||
teamId: team.id,
|
||||
status: AccessRequestStatus.Pending,
|
||||
});
|
||||
|
||||
const res = await server.post("/api/access_requests.approve", {
|
||||
body: {
|
||||
token: admin.getJwtToken(),
|
||||
id: accessRequest.id,
|
||||
permission: DocumentPermission.ReadWrite,
|
||||
},
|
||||
});
|
||||
const body = await res.json();
|
||||
|
||||
expect(res.status).toEqual(200);
|
||||
expect(body.data.status).toEqual(AccessRequestStatus.Approved);
|
||||
expect(body.data.responderId).toEqual(admin.id);
|
||||
|
||||
// Verify that the user now has access
|
||||
const membership = await UserMembership.findOne({
|
||||
where: {
|
||||
userId: requester.id,
|
||||
documentId: document.id,
|
||||
},
|
||||
});
|
||||
expect(membership).toBeTruthy();
|
||||
expect(membership?.permission).toEqual(DocumentPermission.ReadWrite);
|
||||
});
|
||||
|
||||
it("should not allow non-admins to approve requests", async () => {
|
||||
const team = await buildTeam();
|
||||
const requester = await buildUser({ teamId: team.id });
|
||||
const admin = await buildAdmin({ teamId: team.id });
|
||||
const nonAdmin = await buildUser({ teamId: team.id });
|
||||
const document = await buildDocument({
|
||||
userId: admin.id,
|
||||
teamId: team.id,
|
||||
});
|
||||
|
||||
// Create document admin membership
|
||||
await UserMembership.create({
|
||||
userId: admin.id,
|
||||
documentId: document.id,
|
||||
createdById: admin.id,
|
||||
permission: DocumentPermission.Admin,
|
||||
});
|
||||
|
||||
// Create access request
|
||||
const accessRequest = await AccessRequest.create({
|
||||
documentId: document.id,
|
||||
userId: requester.id,
|
||||
teamId: team.id,
|
||||
status: AccessRequestStatus.Pending,
|
||||
});
|
||||
|
||||
const res = await server.post("/api/access_requests.approve", {
|
||||
body: {
|
||||
token: nonAdmin.getJwtToken(),
|
||||
id: accessRequest.id,
|
||||
permission: DocumentPermission.ReadWrite,
|
||||
},
|
||||
});
|
||||
|
||||
expect(res.status).toEqual(403);
|
||||
});
|
||||
|
||||
it("should not allow approving already responded requests", async () => {
|
||||
const team = await buildTeam();
|
||||
const requester = await buildUser({ teamId: team.id });
|
||||
const admin = await buildAdmin({ teamId: team.id });
|
||||
const document = await buildDocument({
|
||||
userId: admin.id,
|
||||
teamId: team.id,
|
||||
});
|
||||
|
||||
// Create document admin membership
|
||||
await UserMembership.create({
|
||||
userId: admin.id,
|
||||
documentId: document.id,
|
||||
createdById: admin.id,
|
||||
permission: DocumentPermission.Admin,
|
||||
});
|
||||
|
||||
// Create access request that's already approved
|
||||
const accessRequest = await AccessRequest.create({
|
||||
documentId: document.id,
|
||||
userId: requester.id,
|
||||
teamId: team.id,
|
||||
status: AccessRequestStatus.Approved,
|
||||
responderId: admin.id,
|
||||
respondedAt: new Date(),
|
||||
});
|
||||
|
||||
const res = await server.post("/api/access_requests.approve", {
|
||||
body: {
|
||||
token: admin.getJwtToken(),
|
||||
id: accessRequest.id,
|
||||
permission: DocumentPermission.ReadWrite,
|
||||
},
|
||||
});
|
||||
|
||||
expect(res.status).toEqual(400);
|
||||
});
|
||||
});
|
||||
|
||||
describe("#access_requests.dismiss", () => {
|
||||
it("should require authentication", async () => {
|
||||
const res = await server.post("/api/access_requests.dismiss");
|
||||
expect(res.status).toEqual(401);
|
||||
});
|
||||
|
||||
it("should dismiss an access request", async () => {
|
||||
const team = await buildTeam();
|
||||
const requester = await buildUser({ teamId: team.id });
|
||||
const admin = await buildAdmin({ teamId: team.id });
|
||||
const document = await buildDocument({
|
||||
userId: admin.id,
|
||||
teamId: team.id,
|
||||
});
|
||||
|
||||
// Create document admin membership
|
||||
await UserMembership.create({
|
||||
userId: admin.id,
|
||||
documentId: document.id,
|
||||
createdById: admin.id,
|
||||
permission: DocumentPermission.Admin,
|
||||
});
|
||||
|
||||
// Create access request
|
||||
const accessRequest = await AccessRequest.create({
|
||||
documentId: document.id,
|
||||
userId: requester.id,
|
||||
teamId: team.id,
|
||||
status: AccessRequestStatus.Pending,
|
||||
});
|
||||
|
||||
const res = await server.post("/api/access_requests.dismiss", {
|
||||
body: {
|
||||
token: admin.getJwtToken(),
|
||||
id: accessRequest.id,
|
||||
},
|
||||
});
|
||||
const body = await res.json();
|
||||
|
||||
expect(res.status).toEqual(200);
|
||||
expect(body.data.status).toEqual(AccessRequestStatus.Dismissed);
|
||||
expect(body.data.responderId).toEqual(admin.id);
|
||||
|
||||
// Verify that the user does not have access
|
||||
const membership = await UserMembership.findOne({
|
||||
where: {
|
||||
userId: requester.id,
|
||||
documentId: document.id,
|
||||
},
|
||||
});
|
||||
expect(membership).toBeNull();
|
||||
});
|
||||
|
||||
it("should not allow non-admins to dismiss requests", async () => {
|
||||
const team = await buildTeam();
|
||||
const requester = await buildUser({ teamId: team.id });
|
||||
const admin = await buildAdmin({ teamId: team.id });
|
||||
const nonAdmin = await buildUser({ teamId: team.id });
|
||||
const document = await buildDocument({
|
||||
userId: admin.id,
|
||||
teamId: team.id,
|
||||
});
|
||||
|
||||
// Create document admin membership
|
||||
await UserMembership.create({
|
||||
userId: admin.id,
|
||||
documentId: document.id,
|
||||
createdById: admin.id,
|
||||
permission: DocumentPermission.Admin,
|
||||
});
|
||||
|
||||
// Create access request
|
||||
const accessRequest = await AccessRequest.create({
|
||||
documentId: document.id,
|
||||
userId: requester.id,
|
||||
teamId: team.id,
|
||||
status: AccessRequestStatus.Pending,
|
||||
});
|
||||
|
||||
const res = await server.post("/api/access_requests.dismiss", {
|
||||
body: {
|
||||
token: nonAdmin.getJwtToken(),
|
||||
id: accessRequest.id,
|
||||
},
|
||||
});
|
||||
|
||||
expect(res.status).toEqual(403);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,172 @@
|
||||
import Router from "koa-router";
|
||||
import { DocumentPermission } from "@shared/types";
|
||||
import auth from "@server/middlewares/authentication";
|
||||
import { rateLimiter } from "@server/middlewares/rateLimiter";
|
||||
import { transaction } from "@server/middlewares/transaction";
|
||||
import validate from "@server/middlewares/validate";
|
||||
import {
|
||||
Document,
|
||||
AccessRequest,
|
||||
UserMembership,
|
||||
Notification,
|
||||
} from "@server/models";
|
||||
import { AccessRequestStatus } from "@server/models/AccessRequest";
|
||||
import { authorize } from "@server/policies";
|
||||
import { presentAccessRequest, presentPolicies } from "@server/presenters";
|
||||
import { APIContext } from "@server/types";
|
||||
import { RateLimiterStrategy } from "@server/utils/RateLimiter";
|
||||
import * as T from "./schema";
|
||||
|
||||
const router = new Router();
|
||||
|
||||
/**
|
||||
* Default permission level to grant when approving an access request
|
||||
* if no specific permission is provided.
|
||||
*/
|
||||
const DEFAULT_APPROVED_PERMISSION = DocumentPermission.ReadWrite;
|
||||
|
||||
router.post(
|
||||
"access_requests.info",
|
||||
auth(),
|
||||
validate(T.AccessRequestInfoSchema),
|
||||
async (ctx: APIContext<T.AccessRequestInfoReq>) => {
|
||||
const { user } = ctx.state.auth;
|
||||
const { id, documentSlug } = ctx.input.body;
|
||||
|
||||
let accessReq: AccessRequest | null = null;
|
||||
if (id) {
|
||||
accessReq = await AccessRequest.findByPk(id);
|
||||
} else if (documentSlug) {
|
||||
const document = await Document.findByPk(documentSlug);
|
||||
accessReq = await AccessRequest.findOne({
|
||||
where: {
|
||||
documentId: document.id,
|
||||
userId: user.id,
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
authorize(user, "read", accessReq);
|
||||
ctx.body = {
|
||||
data: presentAccessRequest(accessReq),
|
||||
policies: presentPolicies(user, [accessReq]),
|
||||
};
|
||||
}
|
||||
);
|
||||
|
||||
router.post(
|
||||
"access_requests.approve",
|
||||
rateLimiter(RateLimiterStrategy.TenPerMinute),
|
||||
auth(),
|
||||
validate(T.AccessRequestsApproveSchema),
|
||||
transaction(),
|
||||
async (ctx: APIContext<T.AccessRequestsApproveReq>) => {
|
||||
const { id, permission } = ctx.input.body;
|
||||
const { user } = ctx.state.auth;
|
||||
const { transaction } = ctx.state;
|
||||
|
||||
const accessRequest = await AccessRequest.findByPk(id, {
|
||||
transaction,
|
||||
rejectOnEmpty: true,
|
||||
});
|
||||
|
||||
const document = await Document.findByPk(accessRequest.documentId, {
|
||||
userId: user.id,
|
||||
transaction,
|
||||
});
|
||||
authorize(user, "share", document);
|
||||
|
||||
// Check that the request is still pending
|
||||
if (accessRequest.status !== AccessRequestStatus.Pending) {
|
||||
ctx.throw(400, "Access request has already been responded to");
|
||||
}
|
||||
|
||||
// Update the access request
|
||||
accessRequest.status = AccessRequestStatus.Approved;
|
||||
accessRequest.responderId = user.id;
|
||||
accessRequest.respondedAt = new Date();
|
||||
await accessRequest.save({ transaction });
|
||||
|
||||
// Grant the user access to the document
|
||||
await UserMembership.create(
|
||||
{
|
||||
userId: accessRequest.userId,
|
||||
documentId: accessRequest.documentId,
|
||||
permission: permission || DEFAULT_APPROVED_PERMISSION,
|
||||
createdById: user.id,
|
||||
},
|
||||
{ transaction }
|
||||
);
|
||||
|
||||
// Mark all related notifications as read
|
||||
await Notification.update(
|
||||
{ viewedAt: new Date() },
|
||||
{
|
||||
where: {
|
||||
accessRequestId: accessRequest.id,
|
||||
viewedAt: null,
|
||||
},
|
||||
transaction,
|
||||
}
|
||||
);
|
||||
|
||||
ctx.body = {
|
||||
data: presentAccessRequest(accessRequest),
|
||||
policies: presentPolicies(user, [accessRequest]),
|
||||
};
|
||||
}
|
||||
);
|
||||
|
||||
router.post(
|
||||
"access_requests.dismiss",
|
||||
rateLimiter(RateLimiterStrategy.TenPerMinute),
|
||||
auth(),
|
||||
validate(T.AccessRequestsDismissSchema),
|
||||
transaction(),
|
||||
async (ctx: APIContext<T.AccessRequestsDismissReq>) => {
|
||||
const { id } = ctx.input.body;
|
||||
const { user } = ctx.state.auth;
|
||||
const { transaction } = ctx.state;
|
||||
|
||||
const accessRequest = await AccessRequest.findByPk(id, {
|
||||
transaction,
|
||||
rejectOnEmpty: true,
|
||||
});
|
||||
|
||||
const document = await Document.findByPk(accessRequest.documentId, {
|
||||
userId: user.id,
|
||||
transaction,
|
||||
});
|
||||
authorize(user, "share", document);
|
||||
|
||||
// Check that the request is still pending
|
||||
if (accessRequest.status !== AccessRequestStatus.Pending) {
|
||||
ctx.throw(400, "Access request has already been responded to");
|
||||
}
|
||||
|
||||
// Update the access request
|
||||
accessRequest.status = AccessRequestStatus.Dismissed;
|
||||
accessRequest.responderId = user.id;
|
||||
accessRequest.respondedAt = new Date();
|
||||
await accessRequest.save({ transaction });
|
||||
|
||||
// Mark all related notifications as read
|
||||
await Notification.update(
|
||||
{ viewedAt: new Date() },
|
||||
{
|
||||
where: {
|
||||
accessRequestId: accessRequest.id,
|
||||
viewedAt: null,
|
||||
},
|
||||
transaction,
|
||||
}
|
||||
);
|
||||
|
||||
ctx.body = {
|
||||
data: presentAccessRequest(accessRequest),
|
||||
policies: presentPolicies(user, [accessRequest]),
|
||||
};
|
||||
}
|
||||
);
|
||||
|
||||
export default router;
|
||||
@@ -0,0 +1 @@
|
||||
export { default } from "./accessRequests";
|
||||
@@ -0,0 +1,34 @@
|
||||
import { z } from "zod";
|
||||
import { DocumentPermission } from "@shared/types";
|
||||
import { BaseSchema } from "@server/routes/api/schema";
|
||||
|
||||
const BaseIdSchema = z.object({
|
||||
id: z.string().uuid(),
|
||||
});
|
||||
|
||||
export const AccessRequestInfoSchema = z.object({
|
||||
body: z.object({
|
||||
id: z.string().uuid().optional(),
|
||||
documentSlug: z.string().optional(),
|
||||
}),
|
||||
});
|
||||
|
||||
export type AccessRequestInfoReq = z.infer<typeof AccessRequestInfoSchema>;
|
||||
|
||||
export const AccessRequestsApproveSchema = BaseSchema.extend({
|
||||
body: BaseIdSchema.extend({
|
||||
permission: z.nativeEnum(DocumentPermission),
|
||||
}),
|
||||
});
|
||||
|
||||
export type AccessRequestsApproveReq = z.infer<
|
||||
typeof AccessRequestsApproveSchema
|
||||
>;
|
||||
|
||||
export const AccessRequestsDismissSchema = BaseSchema.extend({
|
||||
body: BaseIdSchema,
|
||||
});
|
||||
|
||||
export type AccessRequestsDismissReq = z.infer<
|
||||
typeof AccessRequestsDismissSchema
|
||||
>;
|
||||
@@ -479,3 +479,21 @@ export const DocumentsSitemapSchema = BaseSchema.extend({
|
||||
});
|
||||
|
||||
export type DocumentsSitemapReq = z.infer<typeof DocumentsSitemapSchema>;
|
||||
|
||||
export const AccessRequestsApproveSchema = BaseSchema.extend({
|
||||
body: BaseIdSchema.extend({
|
||||
permission: z.nativeEnum(DocumentPermission),
|
||||
}),
|
||||
});
|
||||
|
||||
export type AccessRequestsApproveReq = z.infer<
|
||||
typeof AccessRequestsApproveSchema
|
||||
>;
|
||||
|
||||
export const AccessRequestsDismissSchema = BaseSchema.extend({
|
||||
body: BaseIdSchema,
|
||||
});
|
||||
|
||||
export type AccessRequestsDismissReq = z.infer<
|
||||
typeof AccessRequestsDismissSchema
|
||||
>;
|
||||
@@ -46,6 +46,7 @@ import urls from "./urls";
|
||||
import userMemberships from "./userMemberships";
|
||||
import users from "./users";
|
||||
import views from "./views";
|
||||
import accessRequests from "./accessRequests";
|
||||
|
||||
const api = new Koa<AppState, AppContext>();
|
||||
const router = new Router();
|
||||
@@ -85,6 +86,7 @@ router.use("/", users.routes());
|
||||
router.use("/", collections.routes());
|
||||
router.use("/", comments.routes());
|
||||
router.use("/", documents.routes());
|
||||
router.use("/", accessRequests.routes());
|
||||
router.use("/", emojis.routes());
|
||||
router.use("/", pins.routes());
|
||||
router.use("/", revisions.routes());
|
||||
|
||||
@@ -352,6 +352,8 @@
|
||||
"Manage": "Manage",
|
||||
"Permissions for {{ userName }} updated": "Permissions for {{ userName }} updated",
|
||||
"Failed to approve access request": "Failed to approve access request",
|
||||
"Access request dismissed": "Access request dismissed",
|
||||
"Failed to dismiss access request": "Failed to dismiss access request",
|
||||
"Unknown": "Unknown",
|
||||
"Approve": "Approve",
|
||||
"Mark all as read": "Mark all as read",
|
||||
@@ -802,6 +804,7 @@
|
||||
"Access request sent": "Access request sent",
|
||||
"Failed to send access request": "Failed to send access request",
|
||||
"No access to this doc": "No access to this doc",
|
||||
"You have sucessfully sent a request to access this document. You will be notified once access is granted.": "You have sucessfully sent a request to access this document. You will be notified once access is granted.",
|
||||
"It doesn't look like you have permission to access this document.": "It doesn't look like you have permission to access this document.",
|
||||
"You can request access from a document manager.": "You can request access from a document manager.",
|
||||
"Request sent": "Request sent",
|
||||
|
||||
Reference in new issue
Block a user