feat: render external profiles (NASA-AMMOS#69)

- Add external profile subscribable
- Create two resource stores for external and simulation
- Create reusable sampleProfiles function

Author: camargo

src/routes/plans/[id].svelte

@@ -30,7 +30,7 @@
     resetPlanStores,
     viewTimeRange,
   } from '../../stores/plan';
-  import { resetResourceStores } from '../../stores/resources';
+  import { externalResources, resetResourceStores } from '../../stores/resources';
   import { resetSchedulingStores, schedulingStatus } from '../../stores/scheduling';
   import {
     modelParametersMap,
@@ -108,6 +108,7 @@
     $maxTimeRange = { end: $planEndTimeMs, start: $planStartTimeMs };
     $viewTimeRange = $maxTimeRange;
 
+    externalResources.setVariables({ planId: initialPlan.id });
     simulation.setVariables({ planId: initialPlan.id });
     simulationTemplates.setVariables({ modelId: initialPlan.model.id });
   }

src/stores/resources.ts

@@ -1,11 +1,46 @@
-import { writable, type Writable } from 'svelte/store';
+import { derived, writable, type Writable } from 'svelte/store';
+import gql from '../utilities/gql';
+import { sampleProfiles } from '../utilities/resources';
+import { gqlSubscribable } from './subscribable';
+
+/* Subscriptions. */
+
+export const externalResources = gqlSubscribable<Resource[]>(
+  gql.SUB_PROFILES_EXTERNAL,
+  { planId: -1 },
+  [],
+  (data: ProfilesExternalResponse) => {
+    const { datasets, duration, start_time } = data;
+    let resources: Resource[] = [];
+
+    for (const dataset of datasets) {
+      const {
+        dataset: { profiles },
+        offset_from_plan_start,
+      } = dataset;
+      const sampledResources: Resource[] = sampleProfiles(profiles, start_time, duration, offset_from_plan_start);
+      resources = [...resources, ...sampledResources];
+    }
+
+    return resources;
+  },
+);
 
 /* Writeable. */
 
-export const resources: Writable<Resource[]> = writable([]);
+export const simulationResources: Writable<Resource[]> = writable([]);
+
+/* Derived. */
+
+export const resources = derived(
+  [externalResources, simulationResources],
+  ([$externalResources, $simulationResources]) => {
+    return [...$externalResources, ...$simulationResources];
+  },
+);
 
 /* Helper Functions. */
 
 export function resetResourceStores() {
-  resources.set([]);
+  simulationResources.set([]);
 }

src/types/simulation.d.ts

@@ -1,4 +1,10 @@
-type ProfilesForPlanResponse = {
+type ProfilesExternalResponse = {
+  datasets: [{ dataset: { profiles: Profile[] }; offset_from_plan_start: string }];
+  duration: string;
+  start_time: string;
+};
+
+type ProfilesSimulationResponse = {
   duration: string;
   simulations: [{ datasets: [{ dataset: { profiles: Profile[] } }] }];
   start_time: string;

src/utilities/effects.ts

@@ -12,7 +12,7 @@ import {
   savingExpansionSet,
 } from '../stores/expansion';
 import { createModelError, createPlanError, creatingModel, creatingPlan, models, plan } from '../stores/plan';
-import { resources } from '../stores/resources';
+import { simulationResources } from '../stores/resources';
 import { schedulingStatus, selectedSpecId } from '../stores/scheduling';
 import { simulation, simulationStatus } from '../stores/simulation';
 import { view } from '../stores/views';
@@ -21,8 +21,9 @@ import { parseFloatOrNull, setQueryParam, sleep } from './generic';
 import gql from './gql';
 import { showConfirmModal } from './modal';
 import { reqGateway, reqHasura } from './requests';
+import { sampleProfiles } from './resources';
 import { Status } from './status';
-import { getDoyTime, getDoyTimeFromDuration, getDurationInMs, getIntervalFromDoyRange, getUnixEpochTime } from './time';
+import { getDoyTime, getDoyTimeFromDuration, getIntervalFromDoyRange } from './time';
 import { showFailureToast, showSuccessToast } from './toast';
 
 /**
@@ -750,65 +751,6 @@ const effects = {
     }
   },
 
-  async getSampledResourcesForPlan(planId: number): Promise<Resource[]> {
-    try {
-      const data = await reqHasura<ProfilesForPlanResponse>(gql.GET_PROFILES_FOR_PLAN, { planId });
-      const { plan } = data;
-      const { duration, simulations, start_time } = plan;
-      const [{ datasets }] = simulations;
-      const [{ dataset }] = datasets;
-      const { profiles } = dataset;
-
-      const planStart = getUnixEpochTime(getDoyTime(new Date(start_time)));
-      const planDuration = getDurationInMs(duration);
-      const sampledResources: Resource[] = [];
-
-      for (const profile of profiles) {
-        const { name, profile_segments, type: profileType } = profile;
-        const { type } = profileType;
-        const values: ResourceValue[] = [];
-        const schema = profileType?.schema ?? (profileType as ValueSchema);
-
-        for (let i = 0; i < profile_segments.length; ++i) {
-          const segment = profile_segments[i];
-          const nextSegment = profile_segments[i + 1];
-
-          const segmentOffset = getDurationInMs(segment.start_offset);
-          const nextSegmentOffset = nextSegment ? getDurationInMs(nextSegment.start_offset) : planDuration;
-
-          const { dynamics } = segment;
-
-          if (type === 'discrete') {
-            values.push({
-              x: planStart + segmentOffset,
-              y: dynamics,
-            });
-            values.push({
-              x: planStart + nextSegmentOffset,
-              y: dynamics,
-            });
-          } else if (type === 'real') {
-            values.push({
-              x: planStart + segmentOffset,
-              y: dynamics.initial,
-            });
-            values.push({
-              x: planStart + nextSegmentOffset,
-              y: dynamics.initial + dynamics.rate * (nextSegmentOffset / 1000),
-            });
-          }
-        }
-
-        sampledResources.push({ name, schema, values });
-      }
-
-      return sampledResources;
-    } catch (e) {
-      console.log(e);
-      return [];
-    }
-  },
-
   async getSchedulingGoal(id: number | null | undefined): Promise<SchedulingGoal | null> {
     if (id !== null && id !== undefined) {
       try {
@@ -852,6 +794,22 @@ const effects = {
     }
   },
 
+  async getSimulationResources(planId: number): Promise<Resource[]> {
+    try {
+      const data = await reqHasura<ProfilesSimulationResponse>(gql.GET_PROFILES_SIMULATION, { planId });
+      const { plan } = data;
+      const { duration, simulations, start_time } = plan;
+      const [{ datasets }] = simulations;
+      const [{ dataset }] = datasets;
+      const { profiles } = dataset;
+      const resources: Resource[] = sampleProfiles(profiles, start_time, duration);
+      return resources;
+    } catch (e) {
+      console.log(e);
+      return [];
+    }
+  },
+
   async getTsFilesActivityType(
     activityTypeName: string | null | undefined,
     modelId: number | null | undefined,
@@ -1114,8 +1072,8 @@ const effects = {
           activitiesMap.set(keyBy(newActivities, 'id'));
 
           // Resources.
-          const sampledResources: Resource[] = await effects.getSampledResourcesForPlan(planId);
-          resources.set(sampledResources);
+          const resources: Resource[] = await effects.getSimulationResources(planId);
+          simulationResources.set(resources);
 
           checkConstraintsStatus.set(Status.Dirty);
           simulationStatus.update(Status.Complete);

src/utilities/gql.ts

@@ -440,8 +440,8 @@ const gql = {
     }
   `,
 
-  GET_PROFILES_FOR_PLAN: `#graphql
-    query GetProfilesForPlan($planId: Int!) {
+  GET_PROFILES_SIMULATION: `#graphql
+    query GetProfilesSimulation($planId: Int!) {
       plan: plan_by_pk(id: $planId) {
         duration
         simulations(limit: 1) {
@@ -734,6 +734,28 @@ const gql = {
     }
   `,
 
+  SUB_PROFILES_EXTERNAL: `#graphql
+    subscription SubProfilesExternal($planId: Int!) {
+      plan: plan_by_pk(id: $planId) {
+        datasets {
+          dataset {
+            profiles {
+              name
+              profile_segments {
+                dynamics
+                start_offset
+              }
+              type
+            }
+          }
+          offset_from_plan_start
+        }
+        duration
+        start_time
+      }
+    }
+  `,
+
   SUB_SCHEDULING_GOALS: `#graphql
     subscription SubSchedulingGoals {
       goals: scheduling_goal {

src/utilities/resources.ts

@@ -0,0 +1,52 @@
+import { getDoyTime, getDurationInMs, getUnixEpochTime } from './time';
+
+/**
+ * Samples a list of profiles at their change points. Converts the sampled profiles to Resources.
+ */
+export function sampleProfiles(profiles: Profile[], startTime: string, duration: string, offset?: string): Resource[] {
+  const planOffset = getDurationInMs(offset);
+  const planStart = getUnixEpochTime(getDoyTime(new Date(startTime))) + planOffset;
+  const planDuration = getDurationInMs(duration);
+  const resources: Resource[] = [];
+
+  for (const profile of profiles) {
+    const { name, profile_segments, type: profileType } = profile;
+    const { type } = profileType;
+    const values: ResourceValue[] = [];
+    const schema = profileType?.schema ?? (profileType as ValueSchema);
+
+    for (let i = 0; i < profile_segments.length; ++i) {
+      const segment = profile_segments[i];
+      const nextSegment = profile_segments[i + 1];
+
+      const segmentOffset = getDurationInMs(segment.start_offset);
+      const nextSegmentOffset = nextSegment ? getDurationInMs(nextSegment.start_offset) : planDuration;
+
+      const { dynamics } = segment;
+
+      if (type === 'discrete') {
+        values.push({
+          x: planStart + segmentOffset,
+          y: dynamics,
+        });
+        values.push({
+          x: planStart + nextSegmentOffset,
+          y: dynamics,
+        });
+      } else if (type === 'real') {
+        values.push({
+          x: planStart + segmentOffset,
+          y: dynamics.initial,
+        });
+        values.push({
+          x: planStart + nextSegmentOffset,
+          y: dynamics.initial + dynamics.rate * (nextSegmentOffset / 1000),
+        });
+      }
+    }
+
+    resources.push({ name, schema, values });
+  }
+
+  return resources;
+}