feat: refactor cache handling, move storage out of generated #238

fiam · 2022-10-05T14:41:25Z

feat: move introspection cache to .wundergraph/introspection/cache
feat: prioritize cache during introspection

Checklist

run make test
PR title must follow conventional-commit-standard
tests and/or benchmarks are included
documentation is changed or added
commit message and code follows the Code of conduct

vercel · 2022-10-05T14:46:45Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Updated
wundergraph-docs	⬜️ Ignored (Inspect)		Oct 11, 2022 at 3:50PM (UTC)

docs-website/src/pages/docs/wundergraph-config-ts-reference/configure-introspection.md

packages/sdk/src/definition/introspection-cache.ts

cli/commands/up.go

fiam · 2022-10-06T10:27:53Z

Made the requested changed and rebased

cli/commands/root.go

cli/commands/generate.go

cli/commands/up.go

cli/commands/root.go

cli/commands/up.go

jensneuse · 2022-10-07T14:48:54Z

One thing I'd add is to set all "introspection" configs to automatically refresh each cache item every 5 seconds if not otherwise configured. So, by default, all introspections should be cached and refreshed after 5 seconds of waiting. This will give the most pleasent DX as it will be fast and (almost) always up to date if a datasource changes. @StarpTech opinion?

fiam · 2022-10-07T14:53:44Z

One thing I'd add is to set all "introspection" configs to automatically refresh each cache item every 5 seconds if not otherwise configured. So, by default, all introspections should be cached and refreshed after 5 seconds of waiting. This will give the most pleasent DX as it will be fast and (almost) always up to date if a datasource changes. @StarpTech opinion?

So basically making pollingIntervalSeconds default to 5 while running from wunderctl up?

jensneuse · 2022-10-07T14:55:20Z

One thing I'd add is to set all "introspection" configs to automatically refresh each cache item every 5 seconds if not otherwise configured. So, by default, all introspections should be cached and refreshed after 5 seconds of waiting. This will give the most pleasent DX as it will be fast and (almost) always up to date if a datasource changes. @StarpTech opinion?

So basically making pollingIntervalSeconds default to 5 while running from wunderctl up?

It can always default to 5s, not just for "up", because when using "start", we don't introspect.

StarpTech · 2022-10-07T14:58:57Z

Assumption: Most people integrate a ready API. They don't need to refresh it so often. If so, they can configure it. For me, it makes more sense to opt in. It produces fewer errors and logs.

jensneuse · 2022-10-07T15:00:22Z

Assumption: Most people integrate an ready API into the service. They don't need to refresh it so often. If so, they can configure it. For me, it makes more sense to opt in.

ok, makes sense

fiam · 2022-10-07T15:21:21Z

@StarpTech GH says there's one remaining change requested from you, but then it links to a resolved one. Can we dismiss it?

jensneuse · 2022-10-07T18:12:13Z

@StarpTech GH says there's one remaining change requested from you, but then it links to a resolved one. Can we dismiss it?

@StarpTech if you're ok, please approve

cli/commands/generate.go

StarpTech · 2022-10-07T18:18:15Z

I'd like to test it once locally.

jensneuse · 2022-10-07T21:24:48Z

Once the implementation is done, the docs need updates as well:
https://docs.wundergraph.com/docs/wundergraph-config-ts-reference/configure-introspection

Always try to hit the cache first. Once a result is retrieved, populate the cache as long as it's not disabled. Make the cache enabled by default, but toggleable via WG_DISABLE_INTROSPECTION_CACHE.

This way we can eventually place more items into a cache using the hierarchy below $WGD/cache

wunderctl generate was not propertly initializing it. Instead of making commands that might end up using the cache initialize the directory, make the TS side initialize it lazily when needed.

Instead of testing for file existence, try to read it and handle the potential errors.

- New --cache flag enables caching, which otherwise is always disabled by default - --cache is implemented globally for all commands, although it doesn't have any effect for some of them - TS side honors this via WG_ENABLE_INTROSPECTION_CACHE environment variable

- Enable cache by default - During wunderctl generate, fail if there's a cache miss - Add --cache-fallback flag to wunderctl generate, which allows falling back onto introspection - Pass WG_ENABLE_INTROSPECTION_CACHE explicitely instead of setting it globally - Clear the cache by default during wunderctl up startup - Add a configurable time interval to clear the cache during wunderctl up, with a 5 seconds default

Let the TS side do the refreshes when polling is enabled

Always clear it up during startup

The UI ends up much more intuitive this way

Make it clear that the error is because offline mode is enabled, include details of the introspection that failed

As discussed with Dustin, this is useful for generating a cache from a known and cold state, to reuse it later (e.g. for CI runs)

Added to both .gitignore and .prettierignore, as well as testsapps and examples

StarpTech

LGTM

5 minutes is too slow for testapps/default in CI, it ends up being cancelled. Investigate this a bit further, because it shouldn't take this long.

fiam requested review from StarpTech and jensneuse as code owners October 5, 2022 14:41

github-actions bot added engine npm sdk labels Oct 5, 2022