Create a transformer to enforce current terminology in reportEvent without breaking Mixpanel events

[grahamlangford]

What does this PR do?

• Adds a type check to event payloads in reportEvent banning certain deprecated terms
• Uses a transformer to send the new terms and the deprecated terms to Mixpanel

Discussion

• We've been unable to remove outdated terms like blueprintId from reportEvent payloads because it breaks Mixpanel reports
• By adding a transformer, we can force sending blueprintId && recipeId && modId for backwards compatibility
• Once we've been doing this for long enough, we can remove the transformer and convert reports to rely on the new terms

For more information on our expectations for the PR process, see the
code review principles doc

[grahamlangford]

Not sure of the safety of changing the indexes for the database.

Since this is for debug and trace only it may be safe? Otherwise I can revert this change

[twschiller]

Since this is for debug and trace only it may be safe?

I suspect we'd need to write some sort of migration. But I don't have enough experience with IDB to know

[grahamlangford]

That's what I was wondering. I can look into it if we want to move forward with this concept

[mnholtz]

There's this comment here suggesting we don't really need the logs anyways?

pixiebrix-extension/src/telemetry/logging.ts

Lines 133 to 139 in 9ccb875

	// For now, just clear local logs whenever we need to upgrade the log database structure. There's no real use
	// cases for looking at historic local logs
	db.deleteObjectStore(ENTRY_OBJECT_STORE);
	console.warn(
	"Deleting object store %s for upgrade",
	ENTRY_OBJECT_STORE,
	);

But if we were to do it properly we'd bump the database version number and properly implement that upgrade function

[grahamlangford]

Per the comment, I'm just going to bump the version number

[grahamlangford]

This type is a bit of a hack to prevent us from passing outdated terminology to reportEvent. The resulting ts error looks like:

[grahamlangford]

There might be a better type that explicitly states which key(s) is the problem, but this works as a POC

[mnholtz]

What about never on the types of the individual offending properties? I'm sure we could get fancy with that somehow but it would obviously be nice to have a more specific type error

[grahamlangford]

Actually there's a much simpler solution that I didn't catch my first time around

[mnholtz]

Did you make that change? I noticed you marked this ready for review

[grahamlangford]

i did

[github-actions]

Playwright test results

 84 passed
 2 flaky
 2 skipped

Details

 Open report ↗︎
 88 tests across 31 suites
 14 minutes, 36 seconds
 545e1c7

Flaky tests

edge › tests/extensionConsole/modsPage.spec.ts › can open mod in the workshop
chrome › tests/regressions/welcomeStarterBricks.spec.ts › #8740: can view the starter mods on the pixiebrix.com/welcome page

Skipped tests

chrome › tests/runtime/googleSheetsIntegration.spec.ts › can activate a google spreadsheet mod with config options
edge › tests/runtime/googleSheetsIntegration.spec.ts › can activate a google spreadsheet mod with config options

[codecov]

Codecov Report

Attention: Patch coverage is 36.23188% with 44 lines in your changes missing coverage. Please review.

Project coverage is 74.19%. Comparing base (8318d74) to head (bddeca3).
Report is 35 commits behind head on main.

Files	Patch %	Lines
src/telemetry/telemetryHelpers.ts	0.00%	26 Missing ⚠️
src/data/service/errorService.ts	0.00%	4 Missing ⚠️
...ensionConsole/pages/packageEditor/useLogContext.ts	0.00%	4 Missing ⚠️
src/telemetry/logging.ts	20.00%	4 Missing ⚠️
...ionConsole/pages/mods/hooks/useReactivateAction.ts	0.00%	2 Missing ⚠️
src/telemetry/reportEvent.ts	0.00%	2 Missing ⚠️
src/bricks/renderers/customForm.tsx	66.66%	1 Missing ⚠️
src/telemetry/telemetryTypes.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8774      +/-   ##
==========================================
- Coverage   74.24%   74.19%   -0.06%     
==========================================
  Files        1332     1333       +1     
  Lines       40817    40892      +75     
  Branches     7634     7651      +17     
==========================================
+ Hits        30306    30340      +34     
- Misses      10511    10552      +41     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

No loom links were found in the first post. Please add one there if you'd like to it to appear on Slack.

Do not edit this comment manually.