Add a TS Hook for Fetching Multiple TimeSeries at Once by krowvin · Pull Request #138 · USACE-WaterManagement/groundwork-water

krowvin · 2025-07-22T20:31:09Z

In preparation for the CWMSTable and CWMSPlot hook updates I wanted to create a multi-ts hook.

Instead of merging this into the existing useCdaTimeSeries I thought I would go the route of cwms-python and create a separate call for doing multi-ts.

Some talking points:

When do we want to get clever with the cache? I.e. better with caching dates of a timeseries
I'm running a promise.all inside 1 useQuery. I was not sure how to make multiple useQuery. This might be better in terms of each timeseries would have it's own state? Memory issues?
Does it make sense to use , for the timeseries delimiter? V1 of the API used | or perhaps we use an Array of strings?

MikeNeilson · 2025-07-22T20:33:46Z

FYI the v1 multi time series by | separate string will be going away at some point. You should favor doing parallel queries and doing some form of join or yield operation.

krowvin · 2025-07-22T22:16:42Z

You should favor doing parallel queries

This is a parallel query and does not use v1. It splits on , and loops that array triggering cwmsjs to build the query urls and stores them into one state for re-use. (Larger state convo here)

My mention of the v1 was more about it's choice of | instead of , as a delimiter

Sorry for the confusion.

https://github.com/USACE-WaterManagement/groundwork-water/pull/138/files#diff-44134e2578417fcea9bc82b6bf059595dd3ec5984ba7afae9ebfa6805354cf34R22

jbkolze

As discussed externally, I think it might be a little smoother to use useQueries here instead of useQuery. That would replace the Promise.all and return more granular results to the user.

- Make sure users know about CWMSTable before they try to make their own table

…doc page

jbkolze

Looks good in general. Recommended removing type assertions and checking example TSIDs. Other stuff is at your discretion.

jbkolze · 2025-08-20T12:33:11Z

docs/src/pages/docs/hooks/use-cda-multi-time-series.jsx

+        "KEYS.Elev.Inst.1Hour.0.Ccp-Rev",
+        "KEYS.Stor.Inst.1Hour.0.Ccp-Rev",


These TSIDs are throwing errors for me. Works as expected when I change to working ones, though.

I was getting issues with this as well. They would work off and on against the national CDA.
Do you see data via this URL?
https://cwms-data.usace.army.mil/cwms-data/timeseries?name=KEYS.Elev.Inst.1Hour.0.Ccp-Rev&office=SWT

No, that throws a system error for me -- same thing i was seeing in the docs:

{ "message": "System Error", "incidentIdentifier": "1109935419268345744", "details": {} }

Well, while further testing the docs they suddenly started populating? Not sure -- seems like might be something odd going on with these records.

lib/components/data/hooks/useCdaMultiTimeSeries.ts

docs/src/pages/docs/hooks/use-cda-multi-time-series.jsx

jbkolze · 2025-08-20T13:33:10Z

docs/src/pages/docs/hooks/use-cda-multi-time-series.jsx

+        cwmsJsType="GetTimeSeriesRequest"
+      />
+      <div className="font-bold text-lg pt-6">cdaParams</div>
+      <ParamsTable paramsList={cdaTSHookParams} />


The default ParamsTable doesn't indicate that "name" should be passed as an array (or comma-separated string).

This actually somewhat raises the question of whether the data should be mapped in this manner, or whether each time series should have its own set of parameters? With the current setup a provided "unit" value would get applied to every provided TSID, which might cause issues if you're pulling both flow and elevation, for example.

Might be a "future enhancement" thing.

Might be a "future enhancement" thing.

I had the same thought, but wondered if it was a goose chase to pursue it now. But since you said something and i didn't realize it would break unit I'd lean towards all in and go ahead and just make it an array of the CDATSParam object.

Edit: i was thinking of begin/end times when I thought of it. I.e. all the TS would have to have the same start/stop dates. Which can make caching weird too.

I think it's good as-is, but if someone gets antsy in the future we could potentially allow for setting "default" params and allowing custom overrides for individual TSIDs as required. Because I do think typically the begin/end dates will be consistent, like you mentioned.

krowvin · 2025-08-20T22:01:00Z

Alright, check those out. See what you think. For some reason the GW table overflow as not working for me despite me updating GW to the latest. I'm wondering if it was a cache issue? Tried nuking my node_modules too.

I also debated if the TSMulti hook should return an object/map of these TS Param objects keyed to the TSID. But that could go wrong considering multiple offices can have the same tsid name! So sticking with an array that contains all the responses from CDA for now.

krowvin · 2025-08-20T22:07:28Z

Had a few conflicts there. Mainly with the package lock. Probably should have pulled main in first before trying to bump the version. For now I tried to revert back to the last package.json/package lock.

Will bump groundwork in a sep PR I think! (Was mostly for table overflow)

jbkolze

I think we're playing formatter ping-pong again. Looks like the husky commit hooks aren't working on your end for some reason? We will have to get together to figure that out. And maybe an indication that it would be helpful to add a prettier -check to the merge GH Action.

In the meantime, can you just do an npx prettier -w . from the root when you're done with any other changes? That should take care of it.

jbkolze · 2025-08-22T12:24:19Z

lib/components/data/hooks/useCdaMultiTimeSeries.ts

+  }
  // Stable API client across renders unless config changes
-  const timeseriesApi = useMemo(() => new TimeSeriesApi(config), [config]);
+  const TIME_SERIES_API = useMemo(() => new TimeSeriesApi(config), [config]);


I feel like using FULL_UPPERCASE naming is a little misleading here since this isn't really a run-time constant?

jbkolze · 2025-08-22T12:27:22Z

lib/components/data/hooks/useCdaMultiTimeSeries.ts

-  const baseKey = useMemo(() => {
-    const { name, ...rest } = cdaParams || {};
-    return ["cda", "timeseries", JSON.stringify(rest)];
+  const TIME_SERIES_IDS = useMemo(() => {


Same as above with the FULL_UPPERCASE naming. Would probably just stick to camelCase here.

jbkolze · 2025-08-22T12:36:18Z

docs/src/pages/docs/hooks/use-cda-multi-time-series.jsx

+        "KEYS.Elev.Inst.1Hour.0.Ccp-Rev",
+        "KEYS.Stor.Inst.1Hour.0.Ccp-Rev",


Well, while further testing the docs they suddenly started populating? Not sure -- seems like might be something odd going on with these records.

jbkolze · 2025-08-22T12:43:18Z

docs/src/pages/docs/hooks/use-cda-multi-time-series.jsx

+        cwmsJsType="GetTimeSeriesRequest"
+      />
+      <div className="font-bold text-lg pt-6">cdaParams</div>
+      <ParamsTable paramsList={cdaTSHookParams} />


I think it's good as-is, but if someone gets antsy in the future we could potentially allow for setting "default" params and allowing custom overrides for individual TSIDs as required. Because I do think typically the begin/end dates will be consistent, like you mentioned.

krowvin added 6 commits July 18, 2025 17:14

Add multi TS hook

739cbe0

Add multi-ts hook docs

bd4b43e

Update component name

b7072c5

Format nav-links

5b8e8e3

Add multi-ts route

45ea065

Update Card to use a Groundwork Table component

48ca6e7

krowvin requested a review from jbkolze July 22, 2025 20:31

krowvin added the enhancement New feature or request label Jul 22, 2025

jbkolze reviewed Jul 31, 2025

View reviewed changes

krowvin added 4 commits August 19, 2025 22:50

Convert useCdaMultiTimeSeries to a useQueries call

5eb0065

Update the doc page to use this new useQueries call

83abd44

- Make the timestamps legible

c809c3d

- Make sure users know about CWMSTable before they try to make their own table

Update the docs codeblock example to match the actual example on the …

33c32e3

…doc page

krowvin requested a review from jbkolze August 20, 2025 04:14

Add better load and error states to the docs

6330733

jbkolze requested changes Aug 20, 2025

View reviewed changes

krowvin added 4 commits August 20, 2025 16:55

Bump groundwork to the latest for docs

359b99a

Make it so multTS takes an array of TS Request objects

5fc438b

Update the doc example to use this array of objects

eb04ac6

Update the doc param table to account for an array of TS objects

361d624

Merge branch 'main' into multi-ts-hook

12d027e

krowvin requested a review from jbkolze August 20, 2025 22:08

jbkolze requested changes Aug 22, 2025

View reviewed changes

Install husky and fix formatting

9b25110

		"KEYS.Elev.Inst.1Hour.0.Ccp-Rev",
		"KEYS.Stor.Inst.1Hour.0.Ccp-Rev",

Conversation

krowvin commented Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MikeNeilson commented Jul 22, 2025

Uh oh!

krowvin commented Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jbkolze left a comment

Choose a reason for hiding this comment

Uh oh!

jbkolze left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

krowvin Aug 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

krowvin commented Aug 20, 2025

Uh oh!

krowvin commented Aug 20, 2025

Uh oh!

jbkolze left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

krowvin commented Jul 22, 2025 •

edited

Loading

krowvin commented Jul 22, 2025 •

edited

Loading

krowvin Aug 20, 2025 •

edited

Loading

jbkolze left a comment •

edited

Loading