insights(feat): qwikInsights Vite Plugin + save symbol details #5011

gioboa · 2023-08-24T20:48:15Z

What is it?

Feature / enhancement

Description

This PR creates the plugin for Qwik Insights, this plugin runs only in production build.
The remote baseUrl by default is https://qwik-insights.builder.io

This is the new proposed process flow:

qwikInsights plugin runs before all Vite plugins and downloads the recorded real user data.
qwikVite reads this data to optimise the bundle.
qwikInsights send the q-manifest.json file to the remote Insights baseUrl.

Checklist:

My code follows the developer guidelines of this project
I have performed a self-review of my own code
I have made corresponding changes to the documentation

stackblitz · 2023-08-24T20:48:17Z

Run & review this pull request in StackBlitz Codeflow.

netlify · 2023-08-24T20:48:17Z

👷 Deploy request for qwik-insights pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	`2faa529`

packages/qwik/src/optimizer/src/plugins/vite.ts

packages/qwik-labs/src-vite/insights/index.ts

mhevery

Minor questions/comments. LGTM othewise

packages/qwik-labs/src-vite/insights/index.ts

packages/qwik/src/optimizer/src/plugins/vite.ts

mhevery · 2023-08-24T23:54:06Z

packages/qwik/src/optimizer/src/plugins/vite.ts

@@ -105,6 +105,22 @@ export function qwikVite(qwikViteOpts: QwikVitePluginOptions = {}): any {

      qwikPlugin.log(`vite config(), command: ${viteCommand}, env.mode: ${viteEnv.mode}`);

+      if (sys.env === 'node' && !qwikViteOpts.entryStrategy) {
+        const fs: typeof import('fs') = await sys.dynamicImport('node:fs');


Why not do a regular import? Why dynamic?

I handled the import the same way as the rest of the code.
eg. few lines after my code

mhevery · 2023-08-24T23:54:34Z

Nice work sir!

Co-authored-by: Miško Hevery <misko@hevery.com>

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [@builder.io/qwik](https://qwik.builder.io/) ([source](https://togithub.com/BuilderIO/qwik)) | [`1.2.7` -> `1.2.10`](https://renovatebot.com/diffs/npm/@builder.io%2fqwik/1.2.7/1.2.10) | [![age](https://developer.mend.io/api/mc/badges/age/npm/@builder.io%2fqwik/1.2.10?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/@builder.io%2fqwik/1.2.10?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/@builder.io%2fqwik/1.2.7/1.2.10?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@builder.io%2fqwik/1.2.7/1.2.10?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>BuilderIO/qwik (@builder.io/qwik)</summary> ### [`v1.2.10`](https://togithub.com/BuilderIO/qwik/releases/tag/v1.2.10) [Compare Source](https://togithub.com/BuilderIO/qwik/compare/v1.2.9...v1.2.10) ##### What's Changed - fix: docs/cookbook/index.mdx link to portal page by [@Craiqser](https://togithub.com/Craiqser) in [QwikDev/qwik#5022 - qwik-labs: fix prettier estree error by [@gioboa](https://togithub.com/gioboa) in [QwikDev/qwik#5027 - insights: add existsSync check by [@gioboa](https://togithub.com/gioboa) in [QwikDev/qwik#5026 - chore(insights): correct DB migration script by [@mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5024 - fix(core): Report errors to browser global error handler by [@mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5029 - style(pnpm-lock.yaml): synchronize lockfile version with version of pnpm in use by [@jensmeindertsma](https://togithub.com/jensmeindertsma) in [QwikDev/qwik#4905 - fix(starter): missing key attrib on `routerHead` component on `1.2.9` by [@zanettin](https://togithub.com/zanettin) in [QwikDev/qwik#5025 - 1.2.10 by [@mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5035 **Full Changelog**: QwikDev/qwik@v1.2.9...v1.2.10 ### [`v1.2.9`](https://togithub.com/BuilderIO/qwik/releases/tag/v1.2.9) [Compare Source](https://togithub.com/BuilderIO/qwik/compare/v1.2.8...v1.2.9) #### What's Changed - docs: Vercel environment variables by [@gioboa](https://togithub.com/gioboa) in [QwikDev/qwik#4993 - refactor(create-qwik): add yargs in create-qwik for better DX by [@MrWaip](https://togithub.com/MrWaip) in [QwikDev/qwik#4932 - feat(adapter): firebase adapter by [@leifermendez](https://togithub.com/leifermendez) in [QwikDev/qwik#4778 - Pr chore by [@mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#4994 - fix: Link component `reload` functionality by [@zanettin](https://togithub.com/zanettin) in [QwikDev/qwik#4917 - docs(qwikcity): html attributes docs page by [@bab2683](https://togithub.com/bab2683) in [QwikDev/qwik#4961 - feat(qwik-city): add a way to get server-side env vars from `onStaticGenerate` by [@Kocal](https://togithub.com/Kocal) in [QwikDev/qwik#4912 - fix(eslint): allow eslint to accept FunctionComponent inside lexical scopes by [@nynevi](https://togithub.com/nynevi) in [QwikDev/qwik#4900 - refactor(cloudflare-pages): allow PlatformCloudflarePages.env to be undefined by [@bangonkali](https://togithub.com/bangonkali) in [QwikDev/qwik#4941 - docs: dynamic alt image by [@the-r3aper7](https://togithub.com/the-r3aper7) in [QwikDev/qwik#4999 - docs: add responsive image recipe by [@fabiobiondi](https://togithub.com/fabiobiondi) in [QwikDev/qwik#5002 - docs: community project update image url by [@the-r3aper7](https://togithub.com/the-r3aper7) in [QwikDev/qwik#5000 - docs: enhance image documentation by [@fabiobiondi](https://togithub.com/fabiobiondi) in [QwikDev/qwik#5005 - added qwik-meet in showcase by [@harshmangalam](https://togithub.com/harshmangalam) in [QwikDev/qwik#5007 - docs: Update index.mdx by [@the-r3aper7](https://togithub.com/the-r3aper7) in [QwikDev/qwik#5010 - docs: update side bar by [@the-r3aper7](https://togithub.com/the-r3aper7) in [QwikDev/qwik#5009 - fix(qwik-city): enable matching route and pathname with an optional t… by [@pleclech](https://togithub.com/pleclech) in [QwikDev/qwik#5004 - docs(image): add details by [@fabiobiondi](https://togithub.com/fabiobiondi) in [QwikDev/qwik#5014 - insights(feat): qwikInsights Vite Plugin + save symbol details by [@gioboa](https://togithub.com/gioboa) in [QwikDev/qwik#5011 - chore(insights): Remove deprecated InferModel by [@mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5018 - fix: add options to qwik vite plugin by [@jessezhang91](https://togithub.com/jessezhang91) in [QwikDev/qwik#4983 - 1.2.9 by [@mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5021 #### New Contributors - [@MrWaip](https://togithub.com/MrWaip) made their first contribution in [QwikDev/qwik#4932 - [@bab2683](https://togithub.com/bab2683) made their first contribution in [QwikDev/qwik#4961 - [@Kocal](https://togithub.com/Kocal) made their first contribution in [QwikDev/qwik#4912 - [@nynevi](https://togithub.com/nynevi) made their first contribution in [QwikDev/qwik#4900 - [@bangonkali](https://togithub.com/bangonkali) made their first contribution in [QwikDev/qwik#4941 - [@pleclech](https://togithub.com/pleclech) made their first contribution in [QwikDev/qwik#5004 **Full Changelog**: QwikDev/qwik@v1.2.8...v1.2.9 ### [`v1.2.8`](https://togithub.com/BuilderIO/qwik/releases/tag/v1.2.8) [Compare Source](https://togithub.com/BuilderIO/qwik/compare/v1.2.7...v1.2.8) ##### What's Changed - docs: cleanup by [@mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#4945 - chore: update issue templates by [@shairez](https://togithub.com/shairez) in [QwikDev/qwik#4962 - docs: correctly generate edit URLs for github by [@mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#4963 - Typo in FAQ by [@ThatJSGuy](https://togithub.com/ThatJSGuy) in [QwikDev/qwik#4953 - feat(qwik-city): Show current route in container by [@mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#4954 - fix(docs): add overview link by [@fabiobiondi](https://togithub.com/fabiobiondi) in [QwikDev/qwik#4958 - Towards personalized SSG by [@eric-burel](https://togithub.com/eric-burel) in [QwikDev/qwik#4951 - fix(qwik-auth): remove qaction param from defaultCallbackUrl by [@ulic75](https://togithub.com/ulic75) in [QwikDev/qwik#4936 - fix(qwik-city): cleanup matchRouteRequest by [@gioboa](https://togithub.com/gioboa) in [QwikDev/qwik#4967 - fix(auth): Cookies get updated if session returns Updated Cookies by [@aliyss](https://togithub.com/aliyss) in [QwikDev/qwik#4960 - cli(library): fix release script by [@fabiobiondi](https://togithub.com/fabiobiondi) in [QwikDev/qwik#4957 - docs: Improved media, fixed height thumbnails by [@the-r3aper7](https://togithub.com/the-r3aper7) in [QwikDev/qwik#4970 - feat(qwik-city): Adding Script Tag to Head Tag via DocumentHead by [@Harkunwar](https://togithub.com/Harkunwar) in [QwikDev/qwik#3230 - fix: fix cookie parsing to allow invalid uri encoding by [@jessezhang91](https://togithub.com/jessezhang91) in [QwikDev/qwik#4915 - fix(qwikcity): respect X-Forwarded-Host header by [@mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#4982 - chore(docs): fix broken cloudflare build by [@mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#4984 - feat(insights): manage routes and timeline metrics by [@gioboa](https://togithub.com/gioboa) in [QwikDev/qwik#4971 - feat: complex form data by [@ulic75](https://togithub.com/ulic75) in [QwikDev/qwik#4634 - docs(portals): update the portal cookbook example by [@mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#4968 - chore(insights): fix build by [@mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#4986 - fix: only show qwik eslint errors in dev mode by [@jessezhang91](https://togithub.com/jessezhang91) in [QwikDev/qwik#4985 - docs: some progress on the update of the react-cheat-sheet section re… by [@nsdonato](https://togithub.com/nsdonato) in [QwikDev/qwik#4976 - chore(docs): Remove home-page from SSR to improve TTFB metric by [@mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#4988 - Pr no ssr by [@mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#4989 - cli: Add new Markdown route command by [@brandonpittman](https://togithub.com/brandonpittman) in [QwikDev/qwik#4955 - docs: update Prisma limitations by [@ruheni](https://togithub.com/ruheni) in [QwikDev/qwik#4241 - 1.2.8 by [@mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#4992 ##### New Contributors - [@ThatJSGuy](https://togithub.com/ThatJSGuy) made their first contribution in [QwikDev/qwik#4953 - [@fabiobiondi](https://togithub.com/fabiobiondi) made their first contribution in [QwikDev/qwik#4958 - [@eric-burel](https://togithub.com/eric-burel) made their first contribution in [QwikDev/qwik#4951 - [@aliyss](https://togithub.com/aliyss) made their first contribution in [QwikDev/qwik#4960 - [@brandonpittman](https://togithub.com/brandonpittman) made their first contribution in [QwikDev/qwik#4955 - [@ruheni](https://togithub.com/ruheni) made their first contribution in [QwikDev/qwik#4241 **Full Changelog**: QwikDev/qwik@v1.2.7...v1.2.8 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 9pm on sunday" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/ascorbic/unpic-img).

gioboa added 9 commits August 23, 2023 20:16

create qwikInsights vite plugin

623df35

read entryStrategy from insights

a4b12a5

linter 🧽

9439b89

fix qwikInsights plugin

8231ad3

change INSIGHTS_Q_MANIFEST_FILENAME

de232ba

add symbolDetail migration

5740b4e

fix insights vite.config

78b0ab3

remove unused insightsEntryStrategy

f485349

modify Insights docs

a4b0ca9

gioboa commented Aug 24, 2023

View reviewed changes

packages/qwik/src/optimizer/src/plugins/vite.ts Show resolved Hide resolved

gioboa commented Aug 24, 2023

View reviewed changes

packages/qwik-labs/src-vite/insights/index.ts Show resolved Hide resolved

zanettin added the COMP: insights label Aug 24, 2023

mhevery approved these changes Aug 24, 2023

View reviewed changes

gioboa and others added 2 commits August 25, 2023 05:11

change INSIGHTS_Q_MANIFEST_FILENAME

2a5e25e

Co-authored-by: Miško Hevery <misko@hevery.com>

change INSIGHTS_Q_MANIFEST_FILENAME

2faa529

gioboa added the STATUS-2: PR waiting for review This PR is waiting for review and approval before merge label Aug 25, 2023

mhevery approved these changes Aug 25, 2023

View reviewed changes

mhevery merged commit 2c560f9 into QwikDev:main Aug 25, 2023
19 checks passed

gioboa deleted the feat/insights_symbolDetail branch August 29, 2023 21:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

insights(feat): qwikInsights Vite Plugin + save symbol details #5011

insights(feat): qwikInsights Vite Plugin + save symbol details #5011

gioboa commented Aug 24, 2023

stackblitz bot commented Aug 24, 2023

netlify bot commented Aug 24, 2023 •

edited

mhevery left a comment

mhevery Aug 24, 2023

gioboa Aug 25, 2023

mhevery commented Aug 24, 2023

insights(feat): qwikInsights Vite Plugin + save symbol details #5011

insights(feat): qwikInsights Vite Plugin + save symbol details #5011

Conversation

gioboa commented Aug 24, 2023

What is it?

Description

Checklist:

stackblitz bot commented Aug 24, 2023

netlify bot commented Aug 24, 2023 • edited

👷 Deploy request for qwik-insights pending review.

mhevery left a comment

Choose a reason for hiding this comment

mhevery Aug 24, 2023

Choose a reason for hiding this comment

gioboa Aug 25, 2023

Choose a reason for hiding this comment

mhevery commented Aug 24, 2023

netlify bot commented Aug 24, 2023 •

edited