9c8a7c0b09
* fix: filter out falsy integration from telemetry
Falsy integrations are now ignored in `@astrojs/telemetry`
This error should no longer occur,
```ts
error Cannot read properties of null (reading 'name')
at file:///workspaces/bundle/node_modules/.pnpm/@astrojs+telemetry@0.1.2/node_modules/@astrojs/telemetry/dist/events/session.js:53:117
...
```
* ci: add tests for optional integrations
* ci: add changeset
* fix(@astrojs/telemetry): count number of optional integrations in use
* ci: add test for counting the total number of optional integrations in use
* ci: update changeset
* chore: make the changes @tony-sull sugested
* revert(@astrojs/webapi): mod.d.ts -> a4c78b5: [ci] format
* ci: remove `@astrojs/webapi` patch change
* chore(@astrojs/telemetry): remove totalIntegrations payload field
* fix(@astrojs/telemetry): add optional integrations field
* ci: add changeset
489 lines
9.1 KiB
JavaScript
489 lines
9.1 KiB
JavaScript
import { expect } from 'chai';
|
|
import * as events from '../dist/events/index.js';
|
|
|
|
describe('Session event', () => {
|
|
describe('top-level', () => {
|
|
it('All top-level keys added', () => {
|
|
const config = {
|
|
root: 1,
|
|
srcDir: 2,
|
|
publicDir: 3,
|
|
outDir: 4,
|
|
site: 5,
|
|
base: 6,
|
|
trailingSlash: 7,
|
|
experimental: 8,
|
|
};
|
|
const expected = Object.keys(config);
|
|
const [{ payload }] = events.eventCliSession(
|
|
{
|
|
cliCommand: 'dev',
|
|
astroVersion: '0.0.0',
|
|
},
|
|
config
|
|
);
|
|
expect(payload.configKeys).to.deep.equal(expected);
|
|
});
|
|
});
|
|
|
|
describe('config.build', () => {
|
|
it('configKeys includes format', () => {
|
|
const config = {
|
|
srcDir: 1,
|
|
build: {
|
|
format: 'file',
|
|
},
|
|
};
|
|
const [{ payload }] = events.eventCliSession(
|
|
{
|
|
cliCommand: 'dev',
|
|
astroVersion: '0.0.0',
|
|
},
|
|
config
|
|
);
|
|
expect(payload.configKeys).to.deep.equal(['srcDir', 'build', 'build.format']);
|
|
});
|
|
|
|
it('config.build.format', () => {
|
|
const config = {
|
|
srcDir: 1,
|
|
build: {
|
|
format: 'file',
|
|
},
|
|
};
|
|
const [{ payload }] = events.eventCliSession(
|
|
{
|
|
cliCommand: 'dev',
|
|
astroVersion: '0.0.0',
|
|
},
|
|
config
|
|
);
|
|
expect(payload.config.build.format).to.equal('file');
|
|
});
|
|
});
|
|
|
|
describe('config.server', () => {
|
|
it('configKeys includes server props', () => {
|
|
const config = {
|
|
srcDir: 1,
|
|
server: {
|
|
host: 'example.com',
|
|
port: 8033,
|
|
},
|
|
};
|
|
const [{ payload }] = events.eventCliSession(
|
|
{
|
|
cliCommand: 'dev',
|
|
astroVersion: '0.0.0',
|
|
},
|
|
config
|
|
);
|
|
expect(payload.configKeys).to.deep.equal(['srcDir', 'server', 'server.host', 'server.port']);
|
|
});
|
|
});
|
|
|
|
describe('config.markdown', () => {
|
|
it('configKeys is deep', () => {
|
|
const config = {
|
|
publicDir: 1,
|
|
markdown: {
|
|
drafts: true,
|
|
mode: 'mdx',
|
|
shikiConfig: {
|
|
lang: 1,
|
|
theme: 2,
|
|
wrap: 3,
|
|
},
|
|
syntaxHighlight: 'shiki',
|
|
remarkPlugins: [],
|
|
rehypePlugins: [],
|
|
},
|
|
};
|
|
const [{ payload }] = events.eventCliSession(
|
|
{
|
|
cliCommand: 'dev',
|
|
astroVersion: '0.0.0',
|
|
},
|
|
config
|
|
);
|
|
expect(payload.configKeys).to.deep.equal([
|
|
'publicDir',
|
|
'markdown',
|
|
'markdown.drafts',
|
|
'markdown.mode',
|
|
'markdown.shikiConfig',
|
|
'markdown.shikiConfig.lang',
|
|
'markdown.shikiConfig.theme',
|
|
'markdown.shikiConfig.wrap',
|
|
'markdown.syntaxHighlight',
|
|
'markdown.remarkPlugins',
|
|
'markdown.rehypePlugins',
|
|
]);
|
|
});
|
|
|
|
it('mode', () => {
|
|
const config = {
|
|
markdown: {
|
|
mode: 'mdx',
|
|
},
|
|
};
|
|
const [{ payload }] = events.eventCliSession(
|
|
{
|
|
cliCommand: 'dev',
|
|
astroVersion: '0.0.0',
|
|
},
|
|
config
|
|
);
|
|
expect(payload.config.markdown.mode).to.equal('mdx');
|
|
});
|
|
|
|
it('syntaxHighlight', () => {
|
|
const config = {
|
|
markdown: {
|
|
syntaxHighlight: 'shiki',
|
|
},
|
|
};
|
|
const [{ payload }] = events.eventCliSession(
|
|
{
|
|
cliCommand: 'dev',
|
|
astroVersion: '0.0.0',
|
|
},
|
|
config
|
|
);
|
|
expect(payload.config.markdown.syntaxHighlight).to.equal('shiki');
|
|
});
|
|
});
|
|
|
|
describe('config.vite', () => {
|
|
it('top-level keys are captured', async () => {
|
|
const config = {
|
|
root: 'some/thing',
|
|
vite: {
|
|
css: { modules: [] },
|
|
base: 'a',
|
|
mode: 'b',
|
|
define: {
|
|
a: 'b',
|
|
},
|
|
publicDir: 'some/dir',
|
|
},
|
|
};
|
|
|
|
const [{ payload }] = events.eventCliSession(
|
|
{
|
|
cliCommand: 'dev',
|
|
astroVersion: '0.0.0',
|
|
},
|
|
config
|
|
);
|
|
expect(payload.configKeys).is.deep.equal([
|
|
'root',
|
|
'vite',
|
|
'vite.css',
|
|
'vite.css.modules',
|
|
'vite.base',
|
|
'vite.mode',
|
|
'vite.define',
|
|
'vite.publicDir',
|
|
]);
|
|
});
|
|
|
|
it('vite.resolve keys are captured', async () => {
|
|
const config = {
|
|
vite: {
|
|
resolve: {
|
|
alias: {
|
|
a: 'b',
|
|
},
|
|
dedupe: ['one', 'two'],
|
|
},
|
|
},
|
|
};
|
|
|
|
const [{ payload }] = events.eventCliSession(
|
|
{
|
|
cliCommand: 'dev',
|
|
astroVersion: '0.0.0',
|
|
},
|
|
config
|
|
);
|
|
expect(payload.configKeys).is.deep.equal([
|
|
'vite',
|
|
'vite.resolve',
|
|
'vite.resolve.alias',
|
|
'vite.resolve.dedupe',
|
|
]);
|
|
});
|
|
|
|
it('vite.css keys are captured', async () => {
|
|
const config = {
|
|
vite: {
|
|
resolve: {
|
|
dedupe: ['one', 'two'],
|
|
},
|
|
css: {
|
|
modules: [],
|
|
postcss: {},
|
|
},
|
|
},
|
|
};
|
|
|
|
const [{ payload }] = events.eventCliSession(
|
|
{
|
|
cliCommand: 'dev',
|
|
astroVersion: '0.0.0',
|
|
},
|
|
config
|
|
);
|
|
expect(payload.configKeys).is.deep.equal([
|
|
'vite',
|
|
'vite.resolve',
|
|
'vite.resolve.dedupe',
|
|
'vite.css',
|
|
'vite.css.modules',
|
|
'vite.css.postcss',
|
|
]);
|
|
});
|
|
|
|
it('vite.server keys are captured', async () => {
|
|
const config = {
|
|
vite: {
|
|
server: {
|
|
host: 'example.com',
|
|
open: true,
|
|
fs: {
|
|
strict: true,
|
|
allow: ['a', 'b'],
|
|
},
|
|
},
|
|
},
|
|
};
|
|
|
|
const [{ payload }] = events.eventCliSession(
|
|
{
|
|
cliCommand: 'dev',
|
|
astroVersion: '0.0.0',
|
|
},
|
|
config
|
|
);
|
|
expect(payload.configKeys).is.deep.equal([
|
|
'vite',
|
|
'vite.server',
|
|
'vite.server.host',
|
|
'vite.server.open',
|
|
'vite.server.fs',
|
|
'vite.server.fs.strict',
|
|
'vite.server.fs.allow',
|
|
]);
|
|
});
|
|
|
|
it('vite.build keys are captured', async () => {
|
|
const config = {
|
|
vite: {
|
|
build: {
|
|
target: 'one',
|
|
outDir: 'some/dir',
|
|
cssTarget: {
|
|
one: 'two',
|
|
},
|
|
},
|
|
},
|
|
};
|
|
|
|
const [{ payload }] = events.eventCliSession(
|
|
{
|
|
cliCommand: 'dev',
|
|
astroVersion: '0.0.0',
|
|
},
|
|
config
|
|
);
|
|
expect(payload.configKeys).is.deep.equal([
|
|
'vite',
|
|
'vite.build',
|
|
'vite.build.target',
|
|
'vite.build.outDir',
|
|
'vite.build.cssTarget',
|
|
]);
|
|
});
|
|
|
|
it('vite.preview keys are captured', async () => {
|
|
const config = {
|
|
vite: {
|
|
preview: {
|
|
host: 'example.com',
|
|
port: 8080,
|
|
another: {
|
|
a: 'b',
|
|
},
|
|
},
|
|
},
|
|
};
|
|
|
|
const [{ payload }] = events.eventCliSession(
|
|
{
|
|
cliCommand: 'dev',
|
|
astroVersion: '0.0.0',
|
|
},
|
|
config
|
|
);
|
|
expect(payload.configKeys).is.deep.equal([
|
|
'vite',
|
|
'vite.preview',
|
|
'vite.preview.host',
|
|
'vite.preview.port',
|
|
'vite.preview.another',
|
|
]);
|
|
});
|
|
|
|
it('vite.optimizeDeps keys are captured', async () => {
|
|
const config = {
|
|
vite: {
|
|
optimizeDeps: {
|
|
entries: ['one', 'two'],
|
|
exclude: ['secret', 'name'],
|
|
},
|
|
},
|
|
};
|
|
|
|
const [{ payload }] = events.eventCliSession(
|
|
{
|
|
cliCommand: 'dev',
|
|
astroVersion: '0.0.0',
|
|
},
|
|
config
|
|
);
|
|
expect(payload.configKeys).is.deep.equal([
|
|
'vite',
|
|
'vite.optimizeDeps',
|
|
'vite.optimizeDeps.entries',
|
|
'vite.optimizeDeps.exclude',
|
|
]);
|
|
});
|
|
|
|
it('vite.ssr keys are captured', async () => {
|
|
const config = {
|
|
vite: {
|
|
ssr: {
|
|
external: ['a'],
|
|
target: { one: 'two' },
|
|
},
|
|
},
|
|
};
|
|
|
|
const [{ payload }] = events.eventCliSession(
|
|
{
|
|
cliCommand: 'dev',
|
|
astroVersion: '0.0.0',
|
|
},
|
|
config
|
|
);
|
|
expect(payload.configKeys).is.deep.equal([
|
|
'vite',
|
|
'vite.ssr',
|
|
'vite.ssr.external',
|
|
'vite.ssr.target',
|
|
]);
|
|
});
|
|
|
|
it('vite.worker keys are captured', async () => {
|
|
const config = {
|
|
vite: {
|
|
worker: {
|
|
format: { a: 'b' },
|
|
plugins: ['a', 'b'],
|
|
},
|
|
},
|
|
};
|
|
|
|
const [{ payload }] = events.eventCliSession(
|
|
{
|
|
cliCommand: 'dev',
|
|
astroVersion: '0.0.0',
|
|
},
|
|
config
|
|
);
|
|
expect(payload.configKeys).is.deep.equal([
|
|
'vite',
|
|
'vite.worker',
|
|
'vite.worker.format',
|
|
'vite.worker.plugins',
|
|
]);
|
|
});
|
|
});
|
|
|
|
describe('config.integrations + optionalIntegrations', () => {
|
|
it('optional/conditional integrations', () => {
|
|
const config = {
|
|
srcDir: 1,
|
|
integrations: [
|
|
null,
|
|
undefined,
|
|
{ name: "example-integration" }
|
|
]
|
|
};
|
|
const [{ payload }] = events.eventCliSession(
|
|
{
|
|
cliCommand: 'dev',
|
|
astroVersion: '0.0.0',
|
|
},
|
|
config
|
|
);
|
|
expect(payload.config.integrations).deep.equal(["example-integration"]);
|
|
expect(payload.optionalIntegrations).to.equal(2);
|
|
});
|
|
|
|
it('falsy integrations', () => {
|
|
const config = {
|
|
srcDir: 1,
|
|
integrations: [
|
|
null,
|
|
undefined,
|
|
false
|
|
]
|
|
};
|
|
const [{ payload }] = events.eventCliSession(
|
|
{
|
|
cliCommand: 'dev',
|
|
astroVersion: '0.0.0',
|
|
},
|
|
config
|
|
);
|
|
expect(payload.config.integrations.length).to.equal(0);
|
|
expect(payload.optionalIntegrations).to.equal(3);
|
|
});
|
|
});
|
|
|
|
describe('flags', () => {
|
|
it('includes cli flags in payload', () => {
|
|
const config = {};
|
|
const flags = {
|
|
root: 'root',
|
|
site: 'http://example.com',
|
|
host: true,
|
|
port: 8080,
|
|
config: 'path/to/config.mjs',
|
|
experimentalSsr: true,
|
|
experimentalIntegrations: true,
|
|
drafts: true,
|
|
};
|
|
const [{ payload }] = events.eventCliSession(
|
|
{
|
|
cliCommand: 'dev',
|
|
astroVersion: '0.0.0',
|
|
},
|
|
config,
|
|
flags
|
|
);
|
|
expect(payload.flags).to.deep.equal([
|
|
'root',
|
|
'site',
|
|
'host',
|
|
'port',
|
|
'config',
|
|
'experimentalSsr',
|
|
'experimentalIntegrations',
|
|
'drafts',
|
|
]);
|
|
});
|
|
});
|
|
});
|