feat(models): add generic artifact generation to enable caching

[AndriiSiuta]

Closes #1021

[BioPhoton]

I found couple of improvements and many unrelated changes. Please review your PRs changes with focus.

[github-actions]

Code PushUp

🤨 Code PushUp report has both improvements and regressions – compared current commit c27a5c4 with previous commit 562c83b.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Categories

🏷️ Category	⭐ Previous score	⭐ Current score	🔄 Score change
Performance	🔴 46	🟡 53
Documentation	🔴 23	🔴 23
Code coverage	🟢 90	🟢 90
Security	🟡 61	🟡 61	–
Updates	🟡 77	🟡 77	–
Accessibility	🟢 92	🟢 92	–
Best Practices	🟢 100	🟢 100	–
SEO	🟡 61	🟡 61	–
Type Safety	🟢 100	🟢 100	–
Bug prevention	🟢 100	🟢 100	–
Miscellaneous	🟢 100	🟢 100	–
Code style	🟢 100	🟢 100	–

👍 2 groups improved, 👎 1 group regressed, 👍 7 audits improved, 👎 2 audits regressed, 11 audits changed without impacting score

🗃️ Groups

🔌 Plugin	🗃️ Group	⭐ Previous score	⭐ Current score	🔄 Score change
Lighthouse	Performance	🔴 46	🟡 53
JSDoc coverage	Documentation coverage	🔴 23	🔴 23
Code coverage	Code coverage metrics	🟢 90	🟢 90

18 other groups are unchanged.

🛡️ Audits

🔌 Plugin	🛡️ Audit	📏 Previous value	📏 Current value	🔄 Value change
Lighthouse	Speed Index	🟥 6.5 s	🟨 5.3 s
Lighthouse	Largest Contentful Paint	🟨 4.0 s	🟨 3.5 s
Lighthouse	Total Blocking Time	🟥 3,840 ms	🟥 2,110 ms
Lighthouse	Time to Interactive	🟥 12.7 s	🟥 12.3 s
Lighthouse	First Contentful Paint	🟥 3.2 s	🟥 3.2 s
JSDoc coverage	Variables coverage	🟥 218 undocumented variables	🟥 219 undocumented variables
JSDoc coverage	Types coverage	🟥 223 undocumented types	🟥 225 undocumented types
Code coverage	Branch coverage	🟨 85.7 %	🟨 85.7 %
Code coverage	Line coverage	🟨 86.5 %	🟨 86.6 %
Lighthouse	Avoids enormous network payloads	🟩 Total size was 1,900 KiB	🟩 Total size was 1,918 KiB
Lighthouse	Minimizes main-thread work	🟥 16.4 s	🟥 11.5 s
Lighthouse	JavaScript execution time	🟥 6.5 s	🟥 5.1 s
Lighthouse	Max Potential First Input Delay	🟥 2,140 ms	🟥 1,350 ms
Lighthouse	Metrics	🟩 100%	🟩 100%
Lighthouse	Uses efficient cache policy on static assets	🟨 30 resources found	🟨 30 resources found
Lighthouse	Reduce unused CSS	🟥 Potential savings of 68 KiB	🟥 Potential savings of 69 KiB
Lighthouse	Server Backend Latencies	🟩 160 ms	🟩 240 ms
Lighthouse	Network Round Trip Times	🟩 10 ms	🟩 60 ms
Lighthouse	Initial server response time was short	🟩 Root document took 450 ms	🟩 Root document took 450 ms
Lighthouse	Avoids an excessive DOM size	🟥 2,248 elements	🟥 2,240 elements

585 other audits are unchanged.

[matejchalk]

Since we're standardizing the configuration, maybe a good time to agree on what's a more user-friendly way to configure commands.

Currently, the user has to do something like { command: 'yarn', args: ['test', '--coverage'] }. But why not let them simply provide 'yarn test --coverage'? It's both less verbose and more intuitive, I think 🤔

We could also theoretically support a union of both object and string, but I think that would be unnecessarily complicated.

@BioPhoton @vmasek What do you think?

[vmasek]

I remember thinking the same some time ago and I was up for supporting both especially so we don't introduce a breaking change (and maybe deprecating the object with args), but really I see no issue to having both

[BioPhoton]

Fully agree

[matejchalk]

@AndriiSiuta Could you please add support for string commands? As I understand it, the consensus is both of these should be valid:

• {
    generateArtifactsCommand: 'yarn test --coverage',
    artifactsPath: 'coverage/lcov.info',
  }

• {
    generateArtifactsCommand: {
      command: 'yarn',
      args: ['test', '--coverage'],
    },
    artifactsPath: 'coverage/lcov.info',
  }

The schema validation can be implemented with a z.union([...]).