Clarify and reduce Cloudflare adapter integration logs noise #13817

yanthomasdev · 2025-05-17T19:52:24Z

Changes

This PR makes a few changes for logs in the Cloudflare adapter's dev server based on feedback from withastro/adapters#191 and my experience using it.

Here's the log you would get when starting the dev server with the Cloudflare adapter:

12:50:48 [@astrojs/cloudflare] Enabling sessions with filesystem storage. Be sure to define a KV binding named "SESSION".
12:50:48 [@astrojs/cloudflare] If you see the error "Invalid binding `SESSION`" in your build output, you need to add the binding to your wrangler config file.
12:50:48 [WARN] [config] The adapter @astrojs/cloudflare has limited support for "sharp". Certain features may not work as expected.
12:50:48 [WARN] [adapter] Cloudflare does not support sharp. You can use the `compile` image service to compile images at build time. It will not work for any on-demand rendered images.

Respectively, here are my thoughts and solutions:

The first log says it's enabling sessions with filesystem storage, but asks you to define a KV binding name, which sounds confusing.
— Changed it so it clarifies it will enable it for production usage, and the follow-up docs PR will add information about the Sessions behavior during dev.
Again, if I am using the filesystem storage, why would that matter?
— Made so this log is only shown during build. That's when you'd get the mentioned error and the information would be most relevant to be shown to you, plus making the dev startup logs one line shorter.
Limited support, ok! How exactly limited, though?
— Clarified that you can still use sharp during build time, but not runtime, meaning only pre-rendered pages will get optimized.
Now its no support at all? Also, this says you can use the compile image service, but using it doesn't make the warning go away, and in a kind of funny way, I was totally unaware it actually uses sharp, which I was just told was not compatible at all, so...? 😆
— Clarified the compile option means using sharp.

NOTE: Not really sure if this is a patch or a minor change? 😅

Testing

I am not sure how/if I am supposed to test CLI logs automatically, but for manual testing:

Build packages/integrations/cloudflare with this branch's changes.
Run the dev server with and without an imageService option set.
Then, run the build command to see the warning about session storage on build.

The expected behavior is to get the two warnings about sharp with @astrojs/cloudflare while no imageService is set, but when set, it is suppressed. And the tip about the "invalid session storage" to only be shown during the build process.

Docs

Sibling docs PR: withastro/docs#11708

/cc @withastro/maintainers-docs for feedback!

changeset-bot · 2025-05-17T19:52:31Z

🦋 Changeset detected

Latest commit: 3191a96

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

packages/integrations/cloudflare/src/index.ts

yanthomasdev · 2025-05-17T20:04:16Z

packages/integrations/cloudflare/src/utils/image-config.ts

 			if (config.service.entrypoint === 'astro/assets/services/sharp') {
 				logger.warn(
-					`The current configuration does not support image optimization. To allow your project to build with the original, unoptimized images, the image service has been automatically switched to the 'noop' option. See https://docs.astro.build/en/reference/configuration-reference/#imageservice`,
+					`The current configuration does not support image optimization. To allow your project to build with the original, unoptimized images, the image service has been automatically switched to the 'passthrough' option. See https://docs.astro.build/en/reference/configuration-reference/#imageservice`,


A bit of an extra, the option name itself is not noop (although yes, it's a non-operational service). Mostly to make things consistent.

packages/integrations/cloudflare/src/utils/image-config.ts

sarah11918

The logged messages look good to me, Yan! One small suggestion below to see if we can make one a little easier to read. Approving for docs/messages!

packages/integrations/cloudflare/src/index.ts

ascorbic · 2025-05-20T09:18:16Z

packages/integrations/cloudflare/src/index.ts

-					);
-					logger.info(
-						`If you see the error "Invalid binding \`${bindingName}\`" in your build output, you need to add the binding to your wrangler config file.`,
+						`Enabling sessions with Cloudflare KV for production with the "${bindingName}" KV binding.`,


I think this is misleading because in dev it's not using CLoudflare KV. I'd move this inside the conditional block

It does say it's Cloudflare KV for production, so I wouldn't think that would apply in dev if I were reading that.

I am not against moving this into the conditional, though! I was thinking, and I guess most people wanting to use Sessions will either look into the docs and configure manually or see the Cloudflare adapter docs and just use the default config, so being reminded of this in dev might not be necessary.

Co-authored-by: Sarah Rainsberger <[email protected]>

alexanderniebuhr

I would prefer if core actually allows the adapter to control when messages will be logged instead of using a "hacky" workaround, but it works for me.

ematipico · 2025-05-21T05:54:45Z

From this PR it's clear that the supporting feature needs to be more flexible and intelligent, so I wonder:

why aren't we making PRs against it?
do we plan to track those suggestions somewhere?

alexanderniebuhr · 2025-05-21T07:59:57Z

@ematipico IIRC in the past I was told we don't want to change the logic in core, and the adapter should find a way to work-around it, but it that changed, we can track the idea and try to open PRs.

ascorbic · 2025-05-21T08:47:07Z

I agree with @ematipico. Let's fix this in core rather than hacking around it.

yanthomasdev · 2025-05-22T19:50:29Z

I made a PR to track and propose a way to fix this in core: #13842

…-log-option

Co-authored-by: Sarah Rainsberger <[email protected]> Co-authored-by: Matt Kane <[email protected]>

github-actions

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.

codspeed-hq · 2025-06-03T13:11:56Z

CodSpeed Performance Report

Merging #13817 will not alter performance

_{Comparing cloudflare-log-improv (2137869) with main (442b841)}

Summary

✅ 6 untouched benchmarks

yanthomasdev · 2025-06-03T13:13:24Z

Added a changeset for the changes in @astrojs/cloudflare. I assume it's a minor since we are using a new option in Astro core, let me know if it should be a patch instead.

ascorbic · 2025-06-03T13:36:39Z

Merge after #13887

.changeset/fast-planets-shout.md

Co-authored-by: Matt Kane <[email protected]>

ascorbic

Much better! No more gambiarra fixes!

tryna strike a chord

…ro#13817) * Clarify and reduce Cloudflare integration logs * Simplify log Co-authored-by: Sarah Rainsberger <[email protected]> * Move enabling sessions log to only show in build * Use double quotes instead * Add option to suppress adapter feature support log * Add fixture to test option * Add changeset * Apply suggestions from code review Co-authored-by: Sarah Rainsberger <[email protected]> Co-authored-by: Matt Kane <[email protected]> * Use `suppress` option instead of hack * Create fast-planets-shout.md * Update .changeset/fast-planets-shout.md Co-authored-by: Matt Kane <[email protected]> --------- Co-authored-by: Sarah Rainsberger <[email protected]> Co-authored-by: Matt Kane <[email protected]>

Clarify and reduce Cloudflare integration logs

8288710

github-actions bot added the pkg: integration Related to any renderer integration (scope) label May 17, 2025

yanthomasdev commented May 17, 2025

View reviewed changes

packages/integrations/cloudflare/src/index.ts Outdated Show resolved Hide resolved

yanthomasdev commented May 17, 2025

View reviewed changes

packages/integrations/cloudflare/src/utils/image-config.ts Show resolved Hide resolved

yanthomasdev mentioned this pull request May 17, 2025

Clarify usage of fs storage in Sessions with Cloudflare adapter withastro/docs#11708

Closed

ematipico requested a review from ascorbic May 19, 2025 16:05

sarah11918 approved these changes May 19, 2025

View reviewed changes

packages/integrations/cloudflare/src/index.ts Outdated Show resolved Hide resolved

ascorbic reviewed May 20, 2025

View reviewed changes

yanthomasdev and others added 3 commits May 20, 2025 07:58

Simplify log

f592fa3

Co-authored-by: Sarah Rainsberger <[email protected]>

Move enabling sessions log to only show in build

6b36145

Use double quotes instead

6247780

alexanderniebuhr approved these changes May 21, 2025

View reviewed changes

yanthomasdev added 2 commits May 22, 2025 16:34

Add option to suppress adapter feature support log

ce490e2

Add fixture to test option

ec46803

yanthomasdev mentioned this pull request May 22, 2025

Add option to suppress adapter feature support log #13842

Merged

yanthomasdev and others added 4 commits May 23, 2025 20:43

Add changeset

908afe9

Merge branch 'main' into cloudflare-log-improv

e5f74a0

Merge branch 'cloudflare-log-improv' into suppress-supported-features…

628a0ce

…-log-option

Apply suggestions from code review

7fbd8a6

Co-authored-by: Sarah Rainsberger <[email protected]> Co-authored-by: Matt Kane <[email protected]>

github-actions bot added pkg: astro Related to the core `astro` package (scope) docs pr semver: minor Change triggers a `minor` release labels Jun 3, 2025

github-actions bot previously requested changes Jun 3, 2025

View reviewed changes

yanthomasdev mentioned this pull request Jun 3, 2025

Document suppress in supportedAstroFeatures withastro/docs#11825

Merged

ascorbic changed the base branch from main to suppress-supported-features-log-option June 3, 2025 13:31

ascorbic and others added 3 commits June 3, 2025 14:32

Merge branch 'main' into suppress-supported-features-log-option

d30ad27

Use suppress option instead of hack

7c8d997

Create fast-planets-shout.md

ba9360a

ascorbic force-pushed the cloudflare-log-improv branch from 2137869 to ba9360a Compare June 3, 2025 13:35

github-actions bot removed pkg: astro Related to the core `astro` package (scope) docs pr labels Jun 3, 2025

ascorbic reviewed Jun 3, 2025

View reviewed changes

.changeset/fast-planets-shout.md Outdated Show resolved Hide resolved

Update .changeset/fast-planets-shout.md

ca703e1

Co-authored-by: Matt Kane <[email protected]>

ascorbic approved these changes Jun 3, 2025

View reviewed changes

Base automatically changed from suppress-supported-features-log-option to main June 4, 2025 10:01

Merge branch 'main' into cloudflare-log-improv

3191a96

ascorbic merged commit b7258f1 into main Jun 4, 2025
2 of 5 checks passed

ascorbic deleted the cloudflare-log-improv branch June 4, 2025 10:04

astrobot-houston mentioned this pull request Jun 4, 2025

[ci] release #13889

Merged

Uh oh!

Clarify and reduce Cloudflare adapter integration logs noise #13817

Clarify and reduce Cloudflare adapter integration logs noise #13817

Uh oh!

Conversation

yanthomasdev commented May 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Testing

Docs

Uh oh!

changeset-bot bot commented May 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Uh oh!

yanthomasdev May 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sarah11918 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ascorbic May 20, 2025

Choose a reason for hiding this comment

Uh oh!

yanthomasdev May 20, 2025

Choose a reason for hiding this comment

Uh oh!

alexanderniebuhr left a comment

Choose a reason for hiding this comment

Uh oh!

ematipico commented May 21, 2025

Uh oh!

alexanderniebuhr commented May 21, 2025

Uh oh!

ascorbic commented May 21, 2025

Uh oh!

yanthomasdev commented May 22, 2025

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

codspeed-hq bot commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #13817 will not alter performance

Summary

Uh oh!

yanthomasdev commented Jun 3, 2025

Uh oh!

ascorbic commented Jun 3, 2025

Uh oh!

Uh oh!

ascorbic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

yanthomasdev commented May 17, 2025 •

edited

Loading

changeset-bot bot commented May 17, 2025 •

edited

Loading

codspeed-hq bot commented Jun 3, 2025 •

edited

Loading