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: support analytics engine in local/remote dev #6666

Merged
merged 1 commit into from
Sep 10, 2024

Conversation

threepointone
Copy link
Contributor

@threepointone threepointone commented Sep 10, 2024

This adds "support" for analytics engine datasets for wrangler dev. Specifically, it simply mocks the AE bindings so that they exist while developing (and don't throw when accessed).

This does NOT add support in Pages, though we very well could do so in a similar way in a followup.

What this PR solves / how to test

Fixes #5532
Fixes #4383 (maybe?)

Author has addressed the following

  • Tests
    • TODO (before merge)
    • Included
    • Not necessary because:
  • E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
    • I don't know
    • Required / Maybe required
    • Not required because:
  • Changeset (Changeset guidelines)
    • TODO (before merge)
    • Included
    • Not necessary because:
  • Public documentation
    • TODO (before merge)
    • Cloudflare docs PR(s):
    • Not necessary because: We don't document the previous limitation that AE doesn't work in dev

@threepointone threepointone requested review from a team as code owners September 10, 2024 14:10
Copy link

changeset-bot bot commented Sep 10, 2024

🦋 Changeset detected

Latest commit: 7a14484

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

This PR includes changesets to release 2 packages
Name Type
wrangler Minor
@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

@workers-devprod workers-devprod added the e2e Run e2e tests on a PR label Sep 10, 2024
Copy link
Contributor

github-actions bot commented Sep 10, 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/10795874947/npm-package-wrangler-6666

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

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

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10795874947/npm-package-wrangler-6666 dev path/to/script.js
Additional artifacts:
npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10795874947/npm-package-create-cloudflare-6666 --no-auto-update
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10795874947/npm-package-cloudflare-kv-asset-handler-6666
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10795874947/npm-package-miniflare-6666
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10795874947/npm-package-cloudflare-pages-shared-6666
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10795874947/npm-package-cloudflare-vitest-pool-workers-6666
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10795874947/npm-package-cloudflare-workers-editor-shared-6666
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10795874947/npm-package-cloudflare-workers-shared-6666

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


wrangler@3.75.0 includes the following runtime dependencies:

Package Constraint Resolved
miniflare workspace:* 3.20240821.1
workerd 1.20240821.1 1.20240821.1
workerd --version 1.20240821.1 2024-08-21

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

) => {
// we're going to directly modify env so it maintains referential equality
for (const binding of bindings) {
env[binding] ??= bindingsEnv[binding];
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This makes it so the binding doesn't get overridden if it's previously set. Now, AE actually does work in remote mode, which means it'll track events. There's an argument to be made here that we should mock it even then.

This adds "support" for analytics engine datasets for `wrangler dev`. Specifically, it simply mocks the AE bindings so that they exist while developing (and don't throw when accessed).

This does NOT add support in Pages, though we very well could do so in a similar way in a followup.
@lrapoport-cf lrapoport-cf added the caretaking Priority for caretaking label Sep 10, 2024
Copy link

@rohinlohe rohinlohe left a comment

Choose a reason for hiding this comment

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

thank you, Sunil!

@threepointone threepointone merged commit 4107f57 into main Sep 10, 2024
27 of 30 checks passed
@threepointone threepointone deleted the mock-analytics-engine branch September 10, 2024 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
caretaking Priority for caretaking e2e Run e2e tests on a PR
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

🚀 Feature Request: Analytics Engine Local Stub [Miniflare] Support analytics engine
5 participants