Merge pull request #2428 from zetkin/undocumented/canvass-intructions

Canvass instructions
zetkin · Dec 20, 2024 · 957c0fb · 957c0fb
2 parents 9511c8d + 6041655
commit 957c0fb
Show file tree

Hide file tree

Showing 17 changed files with 563 additions and 3 deletions.
diff --git a/src/app/beta/orgs/[orgId]/canvassassignments/[canvassAssId]/areasgraph/route.ts b/src/app/beta/orgs/[orgId]/canvassassignments/[canvassAssId]/areasgraph/route.ts
@@ -70,6 +70,7 @@ export async function GET(request: NextRequest, { params }: RouteMeta) {
               campaign: { id: assignmentModel.campId },
               end_date: assignmentModel.end_date,
               id: assignmentModel._id.toString(),
+              instructions: assignmentModel.instructions,
               metrics: assignmentModel.metrics.map((m) => ({
                 definesDone: m.definesDone,
                 description: m.description,

diff --git a/src/app/beta/orgs/[orgId]/canvassassignments/[canvassAssId]/areastats/route.ts b/src/app/beta/orgs/[orgId]/canvassassignments/[canvassAssId]/areastats/route.ts
@@ -80,6 +80,7 @@ export async function GET(request: NextRequest, { params }: RouteMeta) {
               },
               end_date: assignmentModel.end_date,
               id: assignmentModel._id.toString(),
+              instructions: assignmentModel.instructions,
               metrics: assignmentModel.metrics.map((m) => ({
                 definesDone: m.definesDone,
                 description: m.description,

diff --git a/src/app/beta/orgs/[orgId]/canvassassignments/[canvassAssId]/route.ts b/src/app/beta/orgs/[orgId]/canvassassignments/[canvassAssId]/route.ts
@@ -38,6 +38,7 @@ export async function GET(request: NextRequest, { params }: RouteMeta) {
         campaign: { id: canvassAssignmentModel.campId },
         end_date: canvassAssignmentModel.end_date,
         id: canvassAssignmentModel._id.toString(),
+        instructions: canvassAssignmentModel.instructions,
         metrics: (canvassAssignmentModel.metrics || []).map((metric) => ({
           definesDone: metric.definesDone || false,
           description: metric.description || '',
@@ -68,6 +69,7 @@ export async function PATCH(request: NextRequest, { params }: RouteMeta) {
 
       const payload = await request.json();
       const {
+        instructions,
         metrics: newMetrics,
         title,
         start_date,
@@ -130,7 +132,11 @@ export async function PATCH(request: NextRequest, { params }: RouteMeta) {
       type UpdateFieldsType = Partial<
         Pick<
           ZetkinCanvassAssignment,
-          'title' | 'start_date' | 'end_date' | 'reporting_level'
+          | 'title'
+          | 'start_date'
+          | 'end_date'
+          | 'reporting_level'
+          | 'instructions'
         >
       >;
 
@@ -152,6 +158,10 @@ export async function PATCH(request: NextRequest, { params }: RouteMeta) {
         updateFields.end_date = end_date;
       }
 
+      if (instructions) {
+        updateFields.instructions = instructions;
+      }
+
       if (Object.keys(updateFields).length > 0) {
         await CanvassAssignmentModel.updateOne(
           { _id: params.canvassAssId },
@@ -171,6 +181,7 @@ export async function PATCH(request: NextRequest, { params }: RouteMeta) {
           campaign: { id: model.campId },
           end_date: model.end_date,
           id: model._id.toString(),
+          instructions: model.instructions,
           metrics: (model.metrics || []).map((metric) => ({
             definesDone: metric.definesDone || false,
             description: metric.description || '',

diff --git a/src/app/beta/orgs/[orgId]/canvassassignments/[canvassAssId]/sessions/route.ts b/src/app/beta/orgs/[orgId]/canvassassignments/[canvassAssId]/sessions/route.ts
@@ -66,6 +66,7 @@ export async function GET(request: NextRequest, { params }: RouteMeta) {
               },
               end_date: model.end_date,
               id: model._id.toString(),
+              instructions: model.instructions,
               metrics: model.metrics.map((m) => ({
                 definesDone: m.definesDone,
                 description: m.description,

diff --git a/src/app/beta/orgs/[orgId]/canvassassignments/[canvassAssId]/stats/route.ts b/src/app/beta/orgs/[orgId]/canvassassignments/[canvassAssId]/stats/route.ts
@@ -73,6 +73,7 @@ export async function GET(request: NextRequest, { params }: RouteMeta) {
               },
               end_date: assignmentModel.end_date,
               id: assignmentModel._id.toString(),
+              instructions: assignmentModel.instructions,
               metrics: assignmentModel.metrics.map((m) => ({
                 definesDone: m.definesDone,
                 description: m.description,

diff --git a/src/app/beta/orgs/[orgId]/canvassassignments/route.ts b/src/app/beta/orgs/[orgId]/canvassassignments/route.ts
@@ -29,6 +29,7 @@ export async function GET(request: NextRequest, { params }: RouteMeta) {
           },
           end_date: assignment.end_date,
           id: assignment._id.toString(),
+          instructions: assignment.instructions,
           metrics: (assignment.metrics || []).map((metric) => ({
             definesDone: metric.definesDone || false,
             description: metric.description || '',
@@ -61,6 +62,7 @@ export async function POST(request: NextRequest, { params }: RouteMeta) {
 
       const model = new CanvassAssignmentModel({
         campId: payload.campaign_id,
+        instructions: payload.instructions,
         metrics: payload.metrics || [],
         orgId: orgId,
         reporting_level: payload.reporting_level || 'household',
@@ -74,6 +76,7 @@ export async function POST(request: NextRequest, { params }: RouteMeta) {
           campaign: { id: model.campId },
           end_date: model.end_date,
           id: model._id.toString(),
+          instructions: model.instructions,
           metrics: model.metrics.map((metric) => ({
             definesDone: metric.definesDone || false,
             description: metric.description || '',

diff --git a/src/app/beta/users/me/canvassassignments/route.ts b/src/app/beta/users/me/canvassassignments/route.ts
@@ -66,6 +66,7 @@ export async function GET(request: NextRequest) {
         },
         end_date: assignment.end_date,
         id: assignment._id.toString(),
+        instructions: assignment.instructions,
         metrics: assignment.metrics.map((m) => ({
           definesDone: m.definesDone,
           description: m.description,

diff --git a/src/app/canvass/[canvassAssId]/map/page.tsx b/src/app/canvass/[canvassAssId]/map/page.tsx
@@ -0,0 +1,29 @@
+import 'leaflet/dist/leaflet.css';
+import { headers } from 'next/headers';
+import { redirect } from 'next/navigation';
+
+import BackendApiClient from 'core/api/client/BackendApiClient';
+import { ZetkinOrganization } from 'utils/types/zetkin';
+import MyCanvassAssignmentPage from 'features/canvassAssignments/components/MyCanvassAssignmentPage';
+
+interface PageProps {
+  params: {
+    canvassAssId: string;
+  };
+}
+
+export default async function Page({ params }: PageProps) {
+  const { canvassAssId } = params;
+  const headersList = headers();
+  const headersEntries = headersList.entries();
+  const headersObject = Object.fromEntries(headersEntries);
+  const apiClient = new BackendApiClient(headersObject);
+
+  try {
+    await apiClient.get<ZetkinOrganization>(`/api/users/me`);
+
+    return <MyCanvassAssignmentPage canvassAssId={canvassAssId} />;
+  } catch (err) {
+    return redirect(`/login?redirect=/canvass/${canvassAssId}/map`);
+  }
+}
diff --git a/src/app/canvass/[canvassAssId]/page.tsx b/src/app/canvass/[canvassAssId]/page.tsx
@@ -2,8 +2,8 @@ import 'leaflet/dist/leaflet.css';
 import { headers } from 'next/headers';
 import { redirect } from 'next/navigation';
 
-import MyCanvassAssignmentPage from 'features/canvassAssignments/components/MyCanvassAssignmentPage';
 import BackendApiClient from 'core/api/client/BackendApiClient';
+import MyCanvassInstructionsPage from 'features/canvassAssignments/components/MyCanvassInstructionsPage';
 import { ZetkinOrganization } from 'utils/types/zetkin';
 
 interface PageProps {
@@ -22,7 +22,7 @@ export default async function Page({ params }: PageProps) {
   try {
     await apiClient.get<ZetkinOrganization>(`/api/users/me`);
 
-    return <MyCanvassAssignmentPage canvassAssId={canvassAssId} />;
+    return <MyCanvassInstructionsPage canvassAssId={canvassAssId} />;
   } catch (err) {
     return redirect(`/login?redirect=/canvass/${canvassAssId}`);
   }

diff --git a/src/features/campaigns/components/CampaignActionButtons.tsx b/src/features/campaigns/components/CampaignActionButtons.tsx
@@ -126,6 +126,7 @@ const CampaignActionButtons: React.FunctionComponent<
       onClick: () =>
         createCanvassAssignment({
           campaign_id: campaign.id,
+          instructions: '',
           metrics: [
             {
               definesDone: true,

diff --git a/src/features/canvassAssignments/components/CanvasserSidebar/index.tsx b/src/features/canvassAssignments/components/CanvasserSidebar/index.tsx
@@ -5,13 +5,15 @@ import {
   CircularProgress,
   Divider,
   List,
+  ListItem,
   ListItemButton,
   ListItemText,
   Typography,
 } from '@mui/material';
 
 import { ZetkinCanvassAssignment } from '../../types';
 import useSidebarStats from 'features/canvassAssignments/hooks/useSidebarStats';
+import ZUIMarkdown from 'zui/ZUIMarkdown';
 import ZUIRelativeTime from 'zui/ZUIRelativeTime';
 
 type Props = {
@@ -108,6 +110,16 @@ const CanvasserSidebar: FC<Props> = ({ assignment }) => {
         </Box>
       </Box>
       <List>
+        {assignment.instructions && (
+          <ListItem sx={{ display: 'block', px: 1 }}>
+            <ListItemText primary="Instructions" sx={{ pb: 2 }} />
+            <Divider sx={(theme) => ({ bgcolor: theme.palette.grey[100] })} />
+            <Typography sx={{ pb: 2, pt: 2 }} variant="body2">
+              <ZUIMarkdown markdown={assignment.instructions} />
+            </Typography>
+            <Divider sx={(theme) => ({ bgcolor: theme.palette.grey[100] })} />
+          </ListItem>
+        )}
         <ListItemButton href="/my/home" sx={{ px: 1 }}>
           <ListItemText primary="My assignments" />
         </ListItemButton>