runtime-compiler 4.0.0 → 4.0.1

package/README.md

@@ -1,131 +1,33 @@
 A code generation system.
 
 # Usage
-See [examples](https://github.com/re-utils/runtime-compiler/tree/main/examples).
-
-# Code generation
-Code generation is a trick used in a lot of high performance libraries, especially schema validators (TypeBox, Ajv, Sury, ...).
-```ts
-const schema = {
-  id: t.string,
-  pwd: t.string
-};
-
-// Can be compiled to a fast check function
-const check = (0, eval)(`
-  (d) => typeof d === 'object'
-    && d !== null
-    && typeof d.id === 'string'
-    && typeof d.pwd === 'string'
-`);
-```
-
-Backend frameworks like Elysia also use it to optimize their request handling:
-```ts
-// Not exactly what Elysia generates but u get the idea
-switch (path) {
-  case '/': return handleHome();
-  case '/user': {
-    // Calls can be analyzed to remove
-    // unused fields in the context object
-    const c = { ... };
-
-    // Inline hook calls
-    onRequestHook(c);
-    handleRequest(c);
-    afterRequestHook(c);
-
-    return sendResponse(c);
-  }
-}
-```
-
-For cases that code generation works, it is usually much easier to write and setup than AST transformations, compiles faster, and also has more flexibility.
-
-The output startup cost is higher than AST transformations though, but this library has primitives to minimize that additional cost.
-
-## Writing codegen
-The first example was pretty simple, but what if we want to use an user-defined value?
-```ts
-const check = (0, eval)(`
-  (d) => typeof d === 'string' && checkEmail(d)
-`);
-```
-
-This works but it breaks with closures (similarly for other types of unserializable data):
 ```ts
-import { checkEmail } from './utils.ts';
-
-// eval returns the value of the last statement
-const check = (0, eval)(`
-  const checkEmail = ${checkEmail.toString()};
-  (d) => typeof d === 'string' && checkEmail(d)
-`);
+import { IS_AOT, IS_BUILD } from 'runtime-compiler/env';
+import { emit, evaluate } from 'runtime-compiler/globals';
 
-// For a checkEmail function like this it would
-// break as emailRegex is not available in eval scope
-const emailRegex = /.../;
-const checkEmail = (str: string) => emailRegex.test(str);
-```
+// Only emit code if not in AOT mode
+IS_AOT || emit(`return()=>console.log("Hi")`);
 
-We gonna need a dependency array to inject user-defined values into the eval scope:
-```ts
-import { checkEmail } from './utils.ts';
+// Only log when building
+IS_BUILD && console.log('Building...');
 
-const buildCheck = (0, eval)(`(deps) => {
-  const checkEmail = deps[0];
-  return (d) => typeof d === 'string' && checkEmail(d)
-}`);
-
-const check = buildCheck([checkEmail]);
+// Run emitted code
+const fn = evaluate<() => void>();
+fn();
 ```
 
-## Problems
-Code generation has 2 main problems:
-- It has a startup time, memory usage and bundle size cost.
-- It does not work on certain runtimes.
-
-This library merges all `eval()` calls into 1 (which makes it able to do ahead of time compilation) and make compiled values easier to work with.
+Build with `rolldown` or `vite`:
 ```ts
-const check1 = compile(schema1);
-const check2 = compile(schema2);
-
-// Can be rewritten as
-const check1Id = compile(schema1);
-const check2Id = compile(schema2);
+...
+import rtc from 'runtime-compiler/build/rolldown';
 
-// For ahead-of-time compilation to work
-// this evaluate() call can just be replaced with
-// whatever code is generated at the moment
-evaluate();
-
-const check1 = artifact(check1Id);
-const check2 = artifact(check2Id);
+export default defineConfig({
+  ...,
+  plugins: [
+    ...,
+    rtc()
+  ]
+});
 ```
 
-The ahead of time output can be:
-```js
-// Store dependencies and build outputs
-const check1Id = compile(schema1);
-const check2Id = compile(schema2);
-
-$[0] = (d) => typeof d === 'string';
-$[1] = (d) => Number.isInteger(d) && d > -1 && d < 256;
-
-const check1 = artifact(check1Id);
-const check2 = artifact(check2Id);
-```
-
-We can remove the codegen cost with flags:
-```ts
-const compile = IS_AOT
-  // This is the compile() function after build, since
-  // we don't need to codegen anymore
-  ? () => reserveArtifact()
-  : (schema1) => {
-    ...;
-    const schemaId = reserveArtifact();
-    emit(`$[${schemaId}]=${builtFnCode}`);
-    return schemaId;
-  }
-```
+You only need to build when the target runtime doesn't allow `eval()`.

package/build/rolldown.d.ts

@@ -1,16 +1,3 @@
 import type { Plugin } from "rolldown";
-interface ImportBinding {
-	name: string;
-	alias: string;
-}
-interface ImportStatement {
-	start: number;
-	end: number;
-	bindings: ImportBinding[];
-}
-export declare const parseImports: (code: string) => {
-	envImports: ImportStatement;
-	globalsImports: ImportStatement;
-};
 declare const _default: () => Plugin;
 export default _default;

package/build/rolldown.js

@@ -1 +1 @@
-import{runInWorker}from"./index.js";let parseImportBindings=(code,start,end)=>{let startSpecs=code.indexOf("{",start),endSpecs=code.lastIndexOf("}",end);if(-1===start&&-1===end)throw new Error("Only named imports replacement is supported!");let bindings=[];for(let i=0,specifiers=code.slice(startSpecs+1,endSpecs-1).split(",");i<specifiers.length;i++){let specifier=specifiers[i].trim();if(""===specifier)continue;let parts=specifier.split(" as ",2);if(1===parts.length){let name=parts[0].trim();bindings.push({name,alias:name})}else bindings.push({name:parts[0].trim(),alias:parts[1].trim()})}return{bindings,start,end}};export const parseImports=code=>{let envImports,globalsImports;for(let start=0,eol=code.indexOf("\n");eol>-1&&(null==envImports||null==globalsImports);eol=code.indexOf("\n",start=eol+1))code.startsWith("import",start)&&(code.endsWith('"runtime-compiler/env";',eol)?envImports=parseImportBindings(code,start,eol):code.endsWith('"runtime-compiler/globals";',eol)&&(globalsImports=parseImportBindings(code,start,eol)));return{envImports,globalsImports}};export default(()=>({name:"rolldown-plugin-runtime-compiler",resolveId:{filter:{id:/^runtime-compiler\/(?:env|globals)$/},handler:()=>!1},renderChunk:async(code,chunk)=>{if(!chunk.imports.includes("runtime-compiler/globals")||!chunk.imports.includes("runtime-compiler/env"))return null;let{envImports,globalsImports}=parseImports(code),aotCode="const __rtcpl_atf__=[],__rtcpl_aot_fns__=[],__rtcpl_setup_aot__=f=>{__rtcpl_aot_fns__.push(f)};let __rtcpl_aot_fn_idx__=0;";for(let i=0,{bindings}=envImports;i<bindings.length;i++){let{name,alias}=bindings[i];aotCode+="IS_AOT"===name?`const ${alias}=true;`:"IS_BUILD"===name||"IS_JIT"===name?`const ${alias}=false;`:""}for(let i=0,{bindings}=globalsImports;i<bindings.length;i++){let{name,alias}=bindings[i];aotCode+="artifact"===name?`const ${alias}=i=>__rtcpl_atf__[i];`:"emit"===name?`const ${alias}=()=>{};`:"evaluate"===name?`const ${alias}=()=>__rtcpl_aot_fns__[__rtcpl_aot_fn_idx__++](__rtcpl_atf__);`:"reserveArtifact"===name?`const ${alias}=()=>__rtcpl_atf__.push(undefined)-1;`:"importArtifact"===name?`const ${alias}=v=>__rtcpl_atf__.push(v)-1;`:""}for(let i=0,codes=await runInWorker(code);i<codes.length;i++)aotCode+=`__rtcpl_setup_aot__($=>{${codes[i]}});`;aotCode+=envImports.start<globalsImports.start?code.slice(0,envImports.start)+code.slice(envImports.end,globalsImports.start)+code.slice(globalsImports.end):code.slice(0,globalsImports.start)+code.slice(globalsImports.end,envImports.start)+code.slice(envImports.end);return{code:aotCode}}}));
+import{runInWorker}from"./index.js";let parseImportBindings=(code,start,end)=>{let startSpecs=code.indexOf("{",start),endSpecs=code.lastIndexOf("}",end);if(-1===start&&-1===end)throw new Error("Only named imports replacement is supported!");let bindings=[];for(let i=0,specifiers=code.slice(startSpecs+1,endSpecs-1).split(",");i<specifiers.length;i++){let specifier=specifiers[i].trim();if(""===specifier)continue;let parts=specifier.split(" as ",2);if(1===parts.length){let name=parts[0].trim();bindings.push({name,alias:name})}else bindings.push({name:parts[0].trim(),alias:parts[1].trim()})}return{bindings,start,end}};export default(()=>({name:"rolldown-plugin-runtime-compiler",resolveId:{filter:{id:/^runtime-compiler\/(?:env|globals)$/},handler:()=>!1},renderChunk:async(code,{imports})=>{let globalsImportIdx=imports.indexOf("runtime-compiler/globals");if(-1===globalsImportIdx)return null;imports.splice(globalsImportIdx);let envImportIdx=imports.indexOf("runtime-compiler/env"),envImport=null,globalsImport=null;-1===envImportIdx?envImport={bindings:[],start:0,end:0}:imports.splice(envImportIdx,1);for(let start=0,eol=code.indexOf("\n");eol>-1&&(null==envImport||null==globalsImport);eol=code.indexOf("\n",start=eol+1))code.startsWith("import",start)&&(code.endsWith('"runtime-compiler/env";',eol)?envImport=parseImportBindings(code,start,eol):code.endsWith('"runtime-compiler/globals";',eol)&&(globalsImport=parseImportBindings(code,start,eol)));let aotCode="const __rtcpl_atf__=[],__rtcpl_aot_fns__=[],__rtcpl_setup_aot__=f=>{__rtcpl_aot_fns__.push(f)};let __rtcpl_aot_fn_idx__=0;";for(let i=0,{bindings}=envImport;i<bindings.length;i++){let{name,alias}=bindings[i];aotCode+="IS_AOT"===name?`const ${alias}=true;`:"IS_BUILD"===name||"IS_JIT"===name?`const ${alias}=false;`:""}for(let i=0,{bindings}=globalsImport;i<bindings.length;i++){let{name,alias}=bindings[i];aotCode+="deref"===name?`const ${alias}=i=>__rtcpl_atf__[i];`:"emit"===name?`const ${alias}=()=>{};`:"evaluate"===name?`const ${alias}=()=>__rtcpl_aot_fns__[__rtcpl_aot_fn_idx__++](__rtcpl_atf__);`:"createRef"===name?`const ${alias}=()=>__rtcpl_atf__.push(undefined)-1;`:"importRef"===name?`const ${alias}=v=>__rtcpl_atf__.push(v)-1;`:""}for(let i=0,codes=await runInWorker(code);i<codes.length;i++)aotCode+=`__rtcpl_setup_aot__($=>{${codes[i]}});`;aotCode+=envImport.start<globalsImport.start?code.slice(0,envImport.start)+code.slice(envImport.end,globalsImport.start)+code.slice(globalsImport.end):code.slice(0,globalsImport.start)+code.slice(globalsImport.end,envImport.start)+code.slice(envImport.end);return{code:aotCode}}}));

package/globals.d.ts

@@ -1,10 +1,8 @@
-export type Artifact<T> = number & {
+export type Ref<T> = number & {
 	"~": T;
 };
-export declare const importArtifact: <T>(value: T) => Artifact<T>;
-export declare const reserveArtifact: <T>() => Artifact<T>;
+export declare const importRef: <T>(value: T) => Ref<T>;
+export declare const createRef: <T>() => Ref<T>;
 export declare let evaluate: <T>() => T;
 export declare const emit: (code: string) => void;
-export type ArtifactsRecord = Record<any, Artifact<any>>;
-export type ArtifactGroup<T extends ArtifactsRecord> = <K extends keyof T>(k: K) => T[K]["~"];
-export declare const artifact: <T>(id: Artifact<T>) => T;
+export declare const deref: <T>(id: Ref<T>) => T;

package/globals.js

@@ -1 +1 @@
-import{IS_AOT,IS_BUILD}from"./env/index.js";import{emptyFn}from"./utils.js";let __rtcpl_atf__=[];export const importArtifact=value=>__rtcpl_atf__.push(value)-1;export const reserveArtifact=()=>__rtcpl_atf__.push(void 0)-1;let content="";export let __rtcpl_ct__=[];export let evaluate=IS_AOT?()=>__rtcpl_aot_fns__[__rtcpl_aot_fn_idx__++](__rtcpl_atf__):IS_BUILD?()=>{__rtcpl_ct__.push(content);let currentContent=content;content="";if(currentContent.length>0)return(0,eval)(`$=>{${currentContent}}`)(__rtcpl_atf__)}:()=>{let currentContent=content;content="";if(currentContent.length>0)return(0,eval)(`$=>{${currentContent}}`)(__rtcpl_atf__)};export const emit=IS_AOT?emptyFn:code=>{content+=code};let __rtcpl_aot_fns__=[],__rtcpl_aot_fn_idx__=0;export const __rtcpl_setup_aot__=fn=>{__rtcpl_aot_fns__.push(fn)};export const artifact=id=>__rtcpl_atf__[id];
+import{IS_AOT,IS_BUILD}from"./env/index.js";import{emptyFn}from"./utils.js";let refs=[];export const importRef=value=>refs.push(value)-1;export const createRef=()=>refs.push(void 0)-1;let content="";export let __rtcpl_ct__=[];export let evaluate=IS_AOT?()=>__rtcpl_aot_fns__[__rtcpl_aot_fn_idx__++](refs):IS_BUILD?()=>{__rtcpl_ct__.push(content);let currentContent=content;content="";if(currentContent.length>0)return(0,eval)(`$=>{${currentContent}}`)(refs)}:()=>{let currentContent=content;content="";if(currentContent.length>0)return(0,eval)(`$=>{${currentContent}}`)(refs)};export const emit=IS_AOT?emptyFn:code=>{content+=code};let __rtcpl_aot_fns__=[],__rtcpl_aot_fn_idx__=0;export const __rtcpl_setup_aot__=fn=>{__rtcpl_aot_fns__.push(fn)};export const deref=id=>refs[id];

package/package.json

@@ -1 +1 @@
-{"name":"runtime-compiler","version":"4.0.0","description":"A compiler system.","keywords":[],"homepage":"","license":"MIT","repository":"","type":"module","exports":{"./*":"./*.js","./build":"./build/index.js","./env":"./env/index.js"}}
+{"name":"runtime-compiler","version":"4.0.1","description":"A compiler system.","keywords":[],"homepage":"","license":"MIT","repository":"","type":"module","exports":{"./*":"./*.js","./build":"./build/index.js","./env":"./env/index.js"}}