Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add experimental_readRawConfig() #7573

Merged
merged 5 commits into from
Dec 18, 2024
Merged

feat: add experimental_readRawConfig() #7573

merged 5 commits into from
Dec 18, 2024

Conversation

emily-shen
Copy link
Contributor

@emily-shen emily-shen commented Dec 17, 2024

Fixes DEVX 1423


  • 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 unit tests
  • Public documentation
    • TODO (before merge)
    • Cloudflare docs PR(s):
    • Documentation not necessary because: not user facing change

@emily-shen emily-shen requested a review from a team as a code owner December 17, 2024 16:22
Copy link

changeset-bot bot commented Dec 17, 2024

🦋 Changeset detected

Latest commit: 8aecc4e

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

@@ -158,498 +152,20 @@ export function readPagesConfig(
};
}

export const readRawConfig = (configPath: string | undefined): RawConfig => {
export const experimental_readRawConfig = (
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to re-export this on the entry file (src/cli.ts) to expose the API

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤦 8aecc4e

Copy link
Contributor

github-actions bot commented Dec 17, 2024

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/12377905261/npm-package-wrangler-7573

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

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

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12377905261/npm-package-wrangler-7573 dev path/to/script.js
Additional artifacts:
wget https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12377905261/npm-package-cloudflare-workers-bindings-extension-7573 -O ./cloudflare-workers-bindings-extension.0.0.0-v33cb3799a.vsix && code --install-extension ./cloudflare-workers-bindings-extension.0.0.0-v33cb3799a.vsix
npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12377905261/npm-package-create-cloudflare-7573 --no-auto-update
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12377905261/npm-package-cloudflare-kv-asset-handler-7573
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12377905261/npm-package-miniflare-7573
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12377905261/npm-package-cloudflare-pages-shared-7573
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12377905261/npm-package-cloudflare-unenv-preset-7573
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12377905261/npm-package-cloudflare-vitest-pool-workers-7573
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12377905261/npm-package-cloudflare-workers-editor-shared-7573
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12377905261/npm-package-cloudflare-workers-shared-7573
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12377905261/npm-package-cloudflare-workflows-shared-7573

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


[email protected] includes the following runtime dependencies:

Package Constraint Resolved
miniflare workspace:* 3.20241205.0
workerd 1.20241205.0 1.20241205.0
workerd --version 1.20241205.0 2024-12-05

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

let result = experimental_readRawConfig({
script: "./path/to/index.js",
});
expect(result.rawConfig).toEqual({
Copy link
Contributor

@vicb vicb Dec 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: should this test result.rawConfig.name only? (the date is not specified in the config, same on l 6083 and l 6054

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the writeWranglerConfig helper provides the default name (test-name) and compat date so I think this is okay :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, that's only a nit (= minor comment).

FYI my thinking is that writeWranglerConfig is already tested here and this test would break if it changes behavior while this test is for experimental_readRawConfig() (l6041).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fair enough :) will fix it in a followup PR!

@emily-shen emily-shen merged commit fb819f9 into main Dec 18, 2024
27 of 29 checks passed
@emily-shen emily-shen deleted the emily/read-only branch December 18, 2024 11:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants