[server] 4.4.1: impl APIs

Author: geropl

components/server/src/api/organization-service-api.ts

@@ -22,6 +22,8 @@ import {
     GetOrganizationResponse,
     GetOrganizationSettingsRequest,
     GetOrganizationSettingsResponse,
+    GetScheduledMaintenanceNotificationRequest,
+    GetScheduledMaintenanceNotificationResponse,
     JoinOrganizationRequest,
     JoinOrganizationResponse,
     ListOrganizationMembersRequest,
@@ -35,6 +37,8 @@ import {
     ResetOrganizationInvitationResponse,
     SetOrganizationMaintenanceModeRequest,
     SetOrganizationMaintenanceModeResponse,
+    SetScheduledMaintenanceNotificationRequest,
+    SetScheduledMaintenanceNotificationResponse,
     UpdateOrganizationMemberRequest,
     UpdateOrganizationMemberResponse,
     UpdateOrganizationRequest,
@@ -345,4 +349,43 @@ export class OrganizationServiceAPI implements ServiceImpl<typeof OrganizationSe
             enabled,
         });
     }
+
+    async getScheduledMaintenanceNotification(
+        req: GetScheduledMaintenanceNotificationRequest,
+        _: HandlerContext,
+    ): Promise<GetScheduledMaintenanceNotificationResponse> {
+        if (!uuidValidate(req.organizationId)) {
+            throw new ApplicationError(ErrorCodes.BAD_REQUEST, "organizationId is required");
+        }
+
+        const settings = await this.orgService.getScheduledMaintenanceNotificationSettings(
+            ctxUserId(),
+            req.organizationId,
+        );
+        return new GetScheduledMaintenanceNotificationResponse({
+            isEnabled: settings.enabled,
+            message: settings.message,
+        });
+    }
+
+    async setScheduledMaintenanceNotification(
+        req: SetScheduledMaintenanceNotificationRequest,
+        _: HandlerContext,
+    ): Promise<SetScheduledMaintenanceNotificationResponse> {
+        if (!uuidValidate(req.organizationId)) {
+            throw new ApplicationError(ErrorCodes.BAD_REQUEST, "organizationId is required");
+        }
+
+        const settings = await this.orgService.setScheduledMaintenanceNotificationSettings(
+            ctxUserId(),
+            req.organizationId,
+            req.isEnabled,
+            req.customMessage,
+        );
+
+        return new SetScheduledMaintenanceNotificationResponse({
+            isEnabled: settings.enabled,
+            message: settings.message,
+        });
+    }
 }

components/server/src/orgs/organization-service.ts

@@ -14,6 +14,7 @@ import {
     WorkspaceTimeoutDuration,
     OrgMemberRole,
     User,
+    MaintenanceNotification,
 } from "@gitpod/gitpod-protocol";
 import { IAnalyticsWriter } from "@gitpod/gitpod-protocol/lib/analytics";
 import { ApplicationError, ErrorCodes } from "@gitpod/gitpod-protocol/lib/messaging/error";
@@ -145,7 +146,7 @@ export class OrganizationService {
     async updateOrganization(
         userId: string,
         orgId: string,
-        changes: Partial<Pick<Organization, "name" | "maintenanceMode">>,
+        changes: Partial<Pick<Organization, "name" | "maintenanceMode" | "maintenanceNotification">>,
     ): Promise<Organization> {
         await this.auth.checkPermissionOnOrganization(userId, "write_info", orgId);
         return this.teamDB.updateTeam(orgId, changes);
@@ -816,4 +817,69 @@ export class OrganizationService {
 
         return enabled;
     }
+
+    /**
+     * Gets the scheduled maintenance notification settings for an organization.
+     *
+     * @param userId The ID of the user making the request
+     * @param orgId The ID of the organization
+     * @returns The notification settings (enabled status and custom message)
+     */
+    public async getScheduledMaintenanceNotificationSettings(
+        userId: string,
+        orgId: string,
+    ): Promise<MaintenanceNotification> {
+        // Using maintenance permission as it's available to owners and installation admins
+        await this.auth.checkPermissionOnOrganization(userId, "maintenance", orgId);
+
+        const team = await this.teamDB.findTeamById(orgId);
+        if (!team) {
+            throw new ApplicationError(ErrorCodes.NOT_FOUND, `Organization ${orgId} not found`);
+        }
+
+        // If the maintenanceNotification field doesn't exist or is invalid, return default values
+        if (!team.maintenanceNotification) {
+            return { enabled: false, message: undefined };
+        }
+
+        return {
+            enabled: team.maintenanceNotification.enabled,
+            message: team.maintenanceNotification.message,
+        };
+    }
+
+    /**
+     * Sets the scheduled maintenance notification settings for an organization.
+     *
+     * @param userId The ID of the user making the request
+     * @param orgId The ID of the organization
+     * @param isEnabled Whether the notification should be enabled
+     * @param customMessage Optional custom message for the notification
+     * @returns The updated notification settings
+     */
+    public async setScheduledMaintenanceNotificationSettings(
+        userId: string,
+        orgId: string,
+        isEnabled: boolean,
+        customMessage?: string,
+    ): Promise<MaintenanceNotification> {
+        // Using maintenance permission as it's available to owners and installation admins
+        await this.auth.checkPermissionOnOrganization(userId, "maintenance", orgId);
+
+        const team = await this.teamDB.findTeamById(orgId);
+        if (!team) {
+            throw new ApplicationError(ErrorCodes.NOT_FOUND, `Organization ${orgId} not found`);
+        }
+
+        // Prepare the new notification config
+        const newNotificationConfig = {
+            enabled: isEnabled,
+            message: customMessage?.trim() || undefined,
+        };
+
+        // Update the team with the new notification config
+        await this.teamDB.updateTeam(orgId, { maintenanceNotification: newNotificationConfig });
+
+        return newNotificationConfig;
+    }
 }