Add API to enable/disable debug logging (in development)

[bvaughn]

Debug logging can be useful to correlate Suspense data fetching with other things going on in an application. For a while, I've had debugging built into this library locally but not exported for applications that use the library.

This PR adds the ability to turn debug logging on for an individual cache or for all caches.

For all caches:

import { disableDebugLogging, enableDebugLogging } from "suspense";

enableDebugLogging(); // Turns global debug logging on

disableDebugLogging(); // Turns global debug logging back off

For an individual cache:

import { createCache } from "suspense";

// Cache can be configured during initialization
const cache = createCache({
  debugLogging: true,
  // ...
});

// They can also be turned on/off later
cache.disableDebugLogging();
cache.enableDebugLogging();

Note that this logging is only in development builds of this package (see c21c562). The above code will have no observable impact on production builds.

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
suspense	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 24, 2023 8:08pm

[bvaughn]

For some reason, it looks like the isDevelopment flag isn't correctly set when running the website locally with Parcel. Need to investigate.

Adding the following to createCache.ts:

import { isDevelopment } from "#is-development";

console.log("[createCache] isDevelopment:", isDevelopment);
console.log("[createCache] NODE_ENV:", process.env.NODE_ENV);

Prints:

[createCache] isDevelopment: false
[createCache] NODE_ENV: development

Not sure what needs to change to connect these two. I've updated parcel deps to the latest release (2.9.2). Based on the Parcel documentation, I would expect the import/export to work. Parcel says it supports "development" (and I've added the packageExports attribute to the root package.json as the docs require):

Out of curiosity, I split the "suspense" package exports into development, production, and default– and Parcel seems to be importing the default path.

Edit Fix inbound! parcel-bundler/parcel#9108

[Andarist]

Were you able to figure out everything here? I wonder if there is still anything that is unclear when it comes to those exports and stuff that I could help you out with.

[bvaughn]

Only that it was a Parcel bug. In the meanwhile, I just hard-coded the condition to true so I could test what I was working on.