refactor(msar): Consistent terminology (session vs. api)

battis · Jan 2, 2025 · e12e273 · e12e273
1 parent baaf6cd
commit e12e273
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 23 deletions.
diff --git a/packages/msar/src/workflows/Snapshot/Area/Base.ts b/packages/msar/src/workflows/Snapshot/Area/Base.ts
@@ -4,7 +4,12 @@ export class StudentDataError extends Error {
   public message = 'Student data is not included in this snapshot';
 }
 
+/*
+ * FIXME add session to Area.Base.Options
+ *   Should be able to invoke endpoints on specific session
+ */
 export type Options = {
+  groupId: number;
   payload?: types.datadirect.ContentItem.Payload;
   ignoreErrors?: boolean;
   studentData?: boolean;

diff --git a/packages/msar/src/workflows/Snapshot/Area/Topics.ts b/packages/msar/src/workflows/Snapshot/Area/Topics.ts
@@ -28,7 +28,7 @@ async function getPossibleContent() {
 
 export const snapshot: Base.Snapshot<Data> = async ({
   groupId: Id,
-  payload = { format: 'json' },
+  payload,
   ignoreErrors = true,
   studentData
 }): Promise<Data | undefined> => {
@@ -38,11 +38,13 @@ export const snapshot: Base.Snapshot<Data> = async ({
     await getPossibleContent();
     const topics = await api.datadirect.sectiontopicsget({
       payload: {
-        format: 'json',
-        sharedTopics: true,
-        future: !!payload.future,
-        expired: !!payload.expired,
-        active: !!payload.active
+        // TODO Fix typing to avoid parameter redundancy
+        active: true,
+        future: true,
+        expired: true,
+        ...payload,
+        format: 'json', // TODO Empirically, `format` is often optional
+        sharedTopics: true // TODO sharedTopics should be configurable
       },
       pathParams: { Id }
     });
@@ -83,22 +85,25 @@ export const snapshot: Base.Snapshot<Data> = async ({
           const entry: Item = {
             ...item,
             ObjectType,
-            Content: await (
-              await api.datadirect.TopicContent_detail(item, possibleContent!)
-            )({
-              payload: {
-                ...payload,
-                id: TopicID,
-                leadSectionId: Id,
-                contextValue: Id,
-                topicIndexId: TopicID,
-                contentIndexId: topic.TopicIndexID,
-                row: item.RowIndex,
-                column: item.ColumnIndex,
-                cell: item.CellIndex
-              },
-              pathParams: { Id }
-            })
+            Content: await api.datadirect.TopicContent_detail(
+              item,
+              possibleContent!,
+              {
+                payload: {
+                  format: 'json',
+                  ...payload,
+                  id: TopicID,
+                  leadSectionId: Id,
+                  contextValue: Id,
+                  topicIndexId: TopicID,
+                  contentIndexId: topic.TopicIndexID,
+                  row: item.RowIndex,
+                  column: item.ColumnIndex,
+                  cell: item.CellIndex
+                },
+                pathParams: { Id }
+              }
+            )
           };
           if (
             !studentData &&

diff --git a/packages/msar/src/workflows/Snapshot/Manager/Single.ts b/packages/msar/src/workflows/Snapshot/Manager/Single.ts
@@ -96,7 +96,7 @@ export async function snapshot({
 
   const Start = new Date();
 
-  const endpointParams = { api, groupId, options };
+  const endpointParams = { session, groupId, ...options };
   const [SectionInfo, BulletinBoard, Topics, Assignments, Gradebook] =
     await Promise.all([
       Area.SectionInfo.snapshot(endpointParams),