Skip to content

chore: save compiled output for test suites #4251

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

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 0 additions & 28 deletions test/helpers.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import * as assert$1 from 'assert';
import * as jsdom from 'jsdom';
import glob from 'tiny-glob/sync';
import * as path from 'path';
import * as fs from 'fs';
import * as colors from 'kleur';
Expand Down Expand Up @@ -46,12 +45,6 @@ export function tryToReadFile(file) {
}
}

export function cleanRequireCache() {
Object.keys(require.cache)
.filter(x => x.endsWith('.svelte'))
.forEach(file => delete require.cache[file]);
}

const virtualConsole = new jsdom.VirtualConsole();
virtualConsole.sendTo(console);

Expand Down Expand Up @@ -206,27 +199,6 @@ export function addLineNumbers(code) {
.join('\n');
}

export function showOutput(cwd, options = {}, compile = svelte.compile) {
glob('**/*.svelte', { cwd }).forEach(file => {
if (file[0] === '_') return;

try {
const { js } = compile(
fs.readFileSync(`${cwd}/${file}`, 'utf-8'),
Object.assign(options, {
filename: file
})
);

console.log( // eslint-disable-line no-console
`\n>> ${colors.cyan().bold(file)}\n${addLineNumbers(js.code)}\n<< ${colors.cyan().bold(file)}`
);
} catch (err) {
console.log(`failed to generate output: ${err.message}`);
}
});
}

export function shouldUpdateExpected() {
return process.argv.includes('--update');
}
Expand Down
50 changes: 16 additions & 34 deletions test/hydration/index.ts
Original file line number Diff line number Diff line change
@@ -1,44 +1,26 @@
import * as path from 'path';
import * as fs from 'fs';
import * as register from '../register';

import {
assert,
showOutput,
loadConfig,
loadSvelte,
env,
setupHtmlEqual,
shouldUpdateExpected
} from '../helpers';

let compileOptions = null;

const sveltePath = process.cwd();
let svelte;

describe('hydration', () => {
before(() => {
const svelte = loadSvelte();

require.extensions['.svelte'] = function(module, filename) {
const options = Object.assign(
{
filename,
hydratable: true,
format: 'cjs',
sveltePath
},
compileOptions
);

const { js } = svelte.compile(fs.readFileSync(filename, 'utf-8'), options);

return module._compile(js.code, filename);
};
svelte = loadSvelte();

return setupHtmlEqual();
});

function runTest(dir) {
function runTest(dir: string) {
if (dir[0] === '.') return;

const config = loadConfig(`./hydration/samples/${dir}/_config.js`);
Expand All @@ -51,8 +33,15 @@ describe('hydration', () => {
(config.skip ? it.skip : solo ? it.only : it)(dir, () => {
const cwd = path.resolve(`${__dirname}/samples/${dir}`);

compileOptions = config.compileOptions || {};
compileOptions.accessors = 'accessors' in config ? config.accessors : true;
register.setCompileOptions({
...config.compileOptions,
accessors: 'accessors' in config ? config.accessors : true,
hydratable: true
});
register.setCompile(svelte.compile);
register.setOutputFolderName('hydratable');
register.clearRequireCache();
register.clearCompileOutputCache();

const window = env();

Expand Down Expand Up @@ -113,21 +102,14 @@ describe('hydration', () => {
assert.equal(target.innerHTML, '');
}
} catch (err) {
showOutput(cwd, {
hydratable: true
});
// saves the compiled output into file system
register.writeCompileOutputCacheToFile();
throw err;
}

if (config.show) {
showOutput(cwd, {
hydratable: true
});
}
});
}

fs.readdirSync(`${__dirname}/samples`).forEach(dir => {
runTest(dir, null);
runTest(dir);
});
});
88 changes: 88 additions & 0 deletions test/register.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
import * as fs from 'fs';
import * as path from 'path';
import { mkdirp } from './helpers';
import * as svelte from 'svelte/compiler';

type Compile = typeof svelte.compile;
type CompileOptions = Parameters<Compile>[1];

const extensions = ['.svelte', '.html'];
let compileOptions = {};
let compile;
let folderName = 'normal';

const sveltePath = process.cwd().split('\\').join('/');

function capitalise(name: string) {
return name[0].toUpperCase() + name.slice(1);
}

export function setCompileOptions(_compileOptions: CompileOptions) {
Copy link
Member

Choose a reason for hiding this comment

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

should these methods be named with the underscore convention like set_compile_options?

compileOptions = _compileOptions;
}

export function setCompile(_compile: Compile) {
compile = _compile;
}

export function setOutputFolderName(_folderName: string) {
folderName = _folderName;
}

export function clearRequireCache() {
Object.keys(require.cache)
.filter(x => x.endsWith('.svelte'))
.forEach(file => {
delete require.cache[file];
});
}

function registerExtension(extension: string) {
require.extensions[extension] = function (module, filename) {
const name = path
.parse(filename)
.name.replace(/^\d/, '_$&')
.replace(/[^a-zA-Z0-9_$]/g, '');

const options = Object.assign({}, compileOptions, {
filename,
sveltePath,
name: capitalise(name),
format: 'cjs'
});

const {
js: { code }
} = compile(fs.readFileSync(filename, 'utf-8').replace(/\r/g, ''), options);

if (!process.env.CI) {
saveGeneratedOutputToCache(code, filename);
}

return module._compile(code, filename);
};
}

const outputCache = new Map();
function saveGeneratedOutputToCache(code: string, filename: string) {
filename = filename.split('\\').join('/');
filename = filename.replace(
/samples\/([^/]+)\/(.*)\.svelte$/,
`samples/$1/_output/${folderName}/$2.js`
);
outputCache.set(filename, code);
}

export function clearCompileOutputCache() {
outputCache.clear();
}

export function writeCompileOutputCacheToFile() {
for (const [filename, code] of outputCache) {
mkdirp(path.dirname(filename));
fs.writeFileSync(filename, code, 'utf8');
}
clearCompileOutputCache();
}

extensions.forEach(registerExtension);
Loading