Workflows open beta warning on deploy #7068

RamIdeas · 2024-10-23T11:42:41Z

Supersedes #7047

Adds a warning reminding the user that Workflows is in open beta – if their config file contains any workflows – in wrangler deploy, wrangler versions upload, wrangler versions deploy and wrangler trigger deploy.

Tests
- TODO (before merge)
- Tests included
- Tests not necessary because:
E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
- I don't know
- Required
- Not required because: covered by other tests
Public documentation
- TODO (before merge)
- Cloudflare docs PR(s):
- Documentation not necessary because: already documented

changeset-bot · 2024-10-23T11:42:45Z

🦋 Changeset detected

Latest commit: b0e01e4

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

This PR includes changesets to release 2 packages

Name	Type
wrangler	Patch
@cloudflare/vitest-pool-workers	Patch

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

RamIdeas · 2024-10-23T11:44:58Z

packages/wrangler/src/logger.ts

-
-	return (...args: Parameters<typeof console.warn>) => {
-		if (!logged) {
-			console.warn(...args);


This previously used console.warn instead of logger.warn

This helper has been replaced by logger.warnOnce which will use logger.warn

github-actions · 2024-10-23T11:45:16Z

A wrangler prerelease is available for testing. You can install this latest build in your project with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11479645360/npm-package-wrangler-7068

You can reference the automatically updated head of this PR with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/7068/npm-package-wrangler-7068

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11479645360/npm-package-wrangler-7068 dev path/to/script.js

Additional artifacts:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11479645360/npm-package-create-cloudflare-7068 --no-auto-update

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11479645360/npm-package-cloudflare-kv-asset-handler-7068

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11479645360/npm-package-miniflare-7068

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11479645360/npm-package-cloudflare-pages-shared-7068

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11479645360/npm-package-cloudflare-vitest-pool-workers-7068

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11479645360/npm-package-cloudflare-workers-editor-shared-7068

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11479645360/npm-package-cloudflare-workers-shared-7068

Note that these links will no longer work once the GitHub Actions artifact expires.

wrangler@3.82.0 includes the following runtime dependencies:

Package	Constraint	Resolved
`miniflare`	workspace:*	3.20241018.0
`workerd`	1.20241022.0	1.20241022.0
`workerd --version`	1.20241022.0	2024-10-22

Please ensure constraints are pinned, and miniflare/workerd minor versions match.

RamIdeas · 2024-10-23T11:47:43Z

packages/wrangler/src/__tests__/logger.test.ts

-        "Unrecognised WRANGLER_LOG value \\"everything\\", expected \\"none\\" | \\"error\\" | \\"warn\\" | \\"info\\" | \\"log\\" | \\"debug\\", defaulting to \\"log\\"...
-        [33m▲ [43;33m[[43;30mWARNING[43;33m][0m [1mThis is a warn message[0m
+				"[33m▲ [43;33m[[43;30mWARNING[43;33m][0m [1mUnrecognised WRANGLER_LOG value \\"everything\\", expected \\"none\\" | \\"error\\" | \\"warn\\" | \\"info\\" | \\"log\\" | \\"debug\\", defaulting to \\"log\\"...[0m

-        "
-      `);
+
+				[33m▲ [43;33m[[43;30mWARNING[43;33m][0m [1mThis is a warn message[0m
+
+				"
+			`);


This was previously using console.warn. Now using logger.warn prepends the ansi colourised "[WARNING]"

penalosa · 2024-10-23T12:04:13Z

packages/wrangler/src/logger.ts

@@ -51,7 +40,7 @@ function getLoggerLevel(): LoggerLevel {
 		const expected = Object.keys(LOGGER_LEVELS)
 			.map((level) => `"${level}"`)
 			.join(" | ");
-		warnOnce(
+		logger.warnOnce(


I'm not sure we should be using logger methods inside getLoggerLevel() like this—it feels like a bit of a circular dependency

I thought that may have been the reason. But this function is about to override the default log level – since the default log level will not swallow warnings, I think it's okay to use logger.warn

Is it not going to be slightly circular though? logger.warnOnce() will eventually call getLoggerLevel() which will then call logger.warnOnce() again and so on. I might be misunderstanding, but that would be my expectation

Yeah I guess. But luckily logger.warnOnce only calls logger.warn... once 😉

penalosa · 2024-10-23T12:05:20Z

packages/wrangler/src/logger.ts

@@ -118,6 +107,17 @@ export class Logger {
 		Logger.#afterLogHook?.();
 	}

+	static warnOnceHistory = new Set();


Why is this static? It feels like each logger instance should have it's own warnOnce set

If a subclass wants a new set, it can override its own static property i.e. static warnOnceHistory = new Set() on the class

I guess if it was an instance property, the inverse could also be said: If a subclass wants to share the set, it can override its own instance property i.e. this.warnOnceHistory = logger.warnOnceHistory in the constructor

The former seems simpler but not tied to either tbh

A subclass can, but multiple instances of the Logger class can't, AFAIK? That seems like the problem to me here

Ah sorry you said instance not subclass

The logger is currently a singleton so I'm more concerned with subclasses (we do this with Miniflare's Log class to intercept method calls, where we would expect this kind of property to be shared).

From this feature's perspective, I'd want these warnings to be logged once per invocation of wrangler not per instance of the logger

The logger is used as a singleton in Wrangler, but there's no inherit reason it has to be, and in various tests we construct multiple instances. It seems to me that it would be kinda strange for those instances to share this warnOnce set.

In terms of subclasses, maybe we're coming at this from different angles, but I would be really surprised if a method call on an instance of the parent class affected method calls on an instance of a subclass.

.changeset/rare-planes-warn.md

penalosa

Not going to block on the logger changes—we can land as-is and followup. In general:

I don't think we should be using a mutable static property for this—this feels to me like it should be an instance property that is not shared to subclasses unless specifically set up in the constructor
I think we should be using console.warn() in getLoggerLevel() to avoid the circular dependency (I realise it's avoided by the "once" nature of warnOnce() when it's called the second time, but it still feels unnecessarily circular)

RamIdeas added 3 commits October 23, 2024 12:39

implement logger.warnOnce

7f6b4b8

workflow open-beta warning on deploy

1a1b0b9

add changeset

59ee47b

RamIdeas requested a review from a team as a code owner October 23, 2024 11:42

RamIdeas commented Oct 23, 2024

View reviewed changes

penalosa reviewed Oct 23, 2024

View reviewed changes

emily-shen reviewed Oct 23, 2024

View reviewed changes

.changeset/rare-planes-warn.md Outdated Show resolved Hide resolved

fix changeset

b0e01e4

penalosa approved these changes Oct 23, 2024

View reviewed changes

RamIdeas merged commit a2afcf1 into main Oct 23, 2024
20 checks passed

RamIdeas deleted the workflows-deploy-warning branch October 23, 2024 12:56

workers-devprod mentioned this pull request Oct 23, 2024

Version Packages #7062

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Workflows open beta warning on deploy #7068

Workflows open beta warning on deploy #7068

RamIdeas commented Oct 23, 2024

changeset-bot bot commented Oct 23, 2024 •

edited

Loading

RamIdeas Oct 23, 2024

github-actions bot commented Oct 23, 2024 •

edited

Loading

RamIdeas Oct 23, 2024

penalosa Oct 23, 2024

RamIdeas Oct 23, 2024

penalosa Oct 23, 2024

RamIdeas Oct 23, 2024

penalosa Oct 23, 2024 •

edited

Loading

RamIdeas Oct 23, 2024

penalosa Oct 23, 2024

RamIdeas Oct 23, 2024

penalosa Oct 23, 2024

penalosa left a comment

Workflows open beta warning on deploy #7068

Workflows open beta warning on deploy #7068

Conversation

RamIdeas commented Oct 23, 2024

changeset-bot bot commented Oct 23, 2024 • edited Loading

🦋 Changeset detected

Choose a reason for hiding this comment

github-actions bot commented Oct 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

penalosa Oct 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

penalosa left a comment

Choose a reason for hiding this comment

changeset-bot bot commented Oct 23, 2024 •

edited

Loading

github-actions bot commented Oct 23, 2024 •

edited

Loading

penalosa Oct 23, 2024 •

edited

Loading