Add deploy plugin

ije · ije · commit c1b0fc3ec865 · 2023-03-08T21:41:09.000+08:00
diff --git a/examples/api-app/server.ts b/examples/api-app/server.ts
@@ -1,10 +1,13 @@
 import { serve } from "aleph/server";
-import routes from "./routes/_export.ts";
+import denoDeploy from "aleph/plugins/deploy";
+import modules from "./routes/_export.ts";
 
 serve({
   baseUrl: import.meta.url,
+  plugins: [
+    denoDeploy({ modules }),
+  ],
   middlewares: [
     // add your middlewares here
   ],
-  router: { routes },
 });
diff --git a/examples/github-oauth-middleware/server.ts b/examples/github-oauth-middleware/server.ts
@@ -1,14 +1,15 @@
 import { serve } from "aleph/server";
+import denoDeploy from "aleph/plugins/deploy";
 import react from "aleph/plugins/react";
 import unocss from "aleph/plugins/unocss";
 import presetUno from "@unocss/preset-uno";
 import { GithubOauth } from "./middlewares/oauth.ts";
-import routes from "./routes/_export.ts";
+import modules from "./routes/_export.ts";
 
 serve({
   baseUrl: import.meta.url,
-  router: { routes },
   plugins: [
+    denoDeploy({ modules }),
     react({ ssr: true }),
     unocss({
       presets: [presetUno()],
diff --git a/examples/react-app/server.ts b/examples/react-app/server.ts
@@ -1,11 +1,12 @@
 import { serve } from "aleph/server";
 import react from "aleph/plugins/react";
-import routes from "./routes/_export.ts";
+import denoDeploy from "aleph/plugins/deploy";
+import modules from "./routes/_export.ts";
 
 serve({
   baseUrl: import.meta.url,
-  router: { routes },
   plugins: [
+    denoDeploy({ modules }),
     react({ ssr: true }),
   ],
 });
diff --git a/examples/react-mdx-app/server.ts b/examples/react-mdx-app/server.ts
@@ -1,7 +1,8 @@
 import { serve } from "aleph/server";
+import denoDeploy from "aleph/plugins/deploy";
 import react from "aleph/plugins/react";
 import mdx from "aleph/plugins/mdx";
-import routes from "./routes/_export.ts";
+import modules from "./routes/_export.ts";
 
 // check https://mdxjs.com/docs/extending-mdx
 import remarkFrontmatter from "https://esm.sh/v110/remark-frontmatter@4.0.1";
@@ -12,12 +13,12 @@ import rehypeSlug from "https://esm.sh/v110/rehype-slug@5.0.1";
 serve({
   baseUrl: import.meta.url,
   plugins: [
+    denoDeploy({ modules }),
     mdx({
       remarkPlugins: [remarkFrontmatter, remarkGFM],
       rehypePlugins: [rehypeHighlight, rehypeSlug],
       providerImportSource: "@mdx-js/react",
     }),
     react({ ssr: true }),
   ],
-  router: { routes },
 });
diff --git a/examples/react-suspense-ssr/server.ts b/examples/react-suspense-ssr/server.ts
@@ -1,9 +1,12 @@
 import { serve } from "aleph/server";
+import denoDeploy from "aleph/plugins/deploy";
 import react from "aleph/plugins/react";
-import routes from "./routes/_export.ts";
+import modules from "./routes/_export.ts";
 
 serve({
   baseUrl: import.meta.url,
-  router: { routes },
-  plugins: [react({ ssr: true })],
+  plugins: [
+    denoDeploy({ modules }),
+    react({ ssr: true }),
+  ],
 });
diff --git a/examples/solid-app/server.ts b/examples/solid-app/server.ts
@@ -1,11 +1,12 @@
 import { serve } from "aleph/server";
+import denoDeploy from "aleph/plugins/deploy";
 import solid from "aleph/plugins/solid";
-import routes from "./routes/_export.ts";
+import modules from "./routes/_export.ts";
 
 serve({
   baseUrl: import.meta.url,
-  router: { routes },
   plugins: [
+    denoDeploy({ modules }),
     solid({ ssr: true }),
   ],
 });
diff --git a/examples/vue-app/server.ts b/examples/vue-app/server.ts
@@ -1,11 +1,12 @@
 import { serve } from "aleph/server";
+import denoDeploy from "aleph/plugins/deploy";
 import vue from "aleph/plugins/vue";
-import routes from "./routes/_export.ts";
+import modules from "./routes/_export.ts";
 
 serve({
   baseUrl: import.meta.url,
-  router: { routes },
   plugins: [
+    denoDeploy({ modules }),
     vue({ ssr: true }),
   ],
 });
diff --git a/examples/with-unocss/react-app/server.ts b/examples/with-unocss/react-app/server.ts
@@ -1,14 +1,15 @@
 import { serve } from "aleph/server";
+import denoDeploy from "aleph/plugins/deploy";
 import react from "aleph/plugins/react";
 import unocss from "aleph/plugins/unocss";
 import config from "./unocss.config.ts";
-import routes from "./routes/_export.ts";
+import modules from "./routes/_export.ts";
 
 serve({
   baseUrl: import.meta.url,
   plugins: [
+    denoDeploy({ modules }),
     react({ ssr: true }),
     unocss(config),
   ],
-  router: { routes },
 });
diff --git a/examples/with-unocss/solid-app/server.ts b/examples/with-unocss/solid-app/server.ts
@@ -1,13 +1,14 @@
 import { serve } from "aleph/server";
+import denoDeploy from "aleph/plugins/deploy";
 import solid from "aleph/plugins/solid";
 import unocss from "aleph/plugins/unocss";
 import config from "./unocss.config.ts";
-import routes from "./routes/_export.ts";
+import modules from "./routes/_export.ts";
 
 serve({
   baseUrl: import.meta.url,
-  router: { routes },
   plugins: [
+    denoDeploy({ modules }),
     solid({ ssr: true }),
     unocss(config),
   ],
diff --git a/import_map.json b/import_map.json
@@ -4,6 +4,7 @@
     "aleph/": "./",
     "aleph/server": "./server/mod.ts",
     "aleph/dev": "./server/dev.ts",
+    "aleph/plugins/deploy": "./plugins/deploy.ts",
     "aleph/plugins/unocss": "./plugins/unocss.ts",
     "aleph/plugins/mdx": "./plugins/mdx.ts",
     "aleph/react": "./framework/react/mod.ts",
diff --git a/init.ts b/init.ts
@@ -17,12 +17,16 @@ const templates = [
   "api",
 ];
 
-const routerApps = [
+const rsApps = [
+  "yew",
+  "leptos",
+];
+
+const unocssApps = [
   "react",
-  "react-mdx",
-  "vue",
+  "yew",
+  "leptos",
   "solid",
-  "api",
 ];
 
 const versions = {
@@ -76,14 +80,9 @@ export default async function init(nameArg?: string, options?: Options) {
   }
 
   const appDir = join(Deno.cwd(), name);
-  const generateExportTs = routerApps.includes(template)
-    ? await confirm(
-      "Generate `_export.ts` file for runtime that doesn't support dynamic import (deploy to Deno Deploy)?",
-    )
-    : false;
-  const withUnocss = ["react", "yew", "leptos", "solid"].includes(template!) &&
-    await confirm("Using Unocss(TailwindCSS)?");
+  const withUnocss = unocssApps.includes(template!) && await confirm("Use Atomic CSS (powered by Unocss)?");
   const withVscode = await confirm("Initialize VS Code workspace configuration?");
+  const deploy = !rsApps.includes(template) ? await confirm("Deploy to Deno Deploy ?") : false;
 
   // download template
   console.log(`${dim("↓")} Downloading template(${blue(template!)}), this might take a moment...`);
@@ -136,17 +135,13 @@ export default async function init(nameArg?: string, options?: Options) {
   const { version: ESM_VERSION } = await res.json();
 
   let serverCode = await Deno.readTextFile(join(appDir, "server.ts"));
-  if (routerApps.includes(template) && !generateExportTs) {
-    const importExpr = `import routes from "./routes/_export.ts";\n`;
+  if (!rsApps.includes(template) && !deploy) {
+    const importExpr = `import modules from "./routes/_export.ts";\n`;
     if (serverCode.includes(importExpr)) {
       serverCode = serverCode
         .replace(importExpr, "")
-        .replace("  router: { routes },\n", "")
-        .replace("    routes,\n  },", "  },");
-      await Deno.writeTextFile(
-        join(appDir, "dev.ts"),
-        [`import dev from "aleph/dev";`, "dev();\n"].join("\n\n"),
-      );
+        .replace('import denoDeploy from "aleph/plugins/deploy";\n', "")
+        .replace("    denoDeploy({ modules }),\n", "");
       await Deno.remove(join(appDir, "routes/_export.ts"));
     }
   }
@@ -169,7 +164,7 @@ export default async function init(nameArg?: string, options?: Options) {
     },
     "importMap": "import_map.json",
     "tasks": {
-      "dev": "deno run -A dev.ts",
+      "dev": rsApps.includes(template) ? "deno run -A dev.ts" : `${alephPkgUri}/dev.ts${deploy ? " --generate" : ""}`,
       "start": "deno run -A server.ts",
       "build": "deno run -A server.ts --build",
       "esm:add": `deno run -A https://esm.sh/v${ESM_VERSION} add`,
@@ -187,6 +182,11 @@ export default async function init(nameArg?: string, options?: Options) {
     } as Record<string, string>,
     scopes: {},
   };
+  if (deploy) {
+    Object.assign(importMap.imports, {
+      "aleph/plugins/deploy": `${alephPkgUri}/plugins/deploy.ts`,
+    });
+  }
   if (withUnocss) {
     Object.assign(importMap.imports, {
       "aleph/plugins/unocss": `${alephPkgUri}/plugins/unocss.ts`,
diff --git a/plugins/deploy.ts b/plugins/deploy.ts
@@ -0,0 +1,20 @@
+import depGraph from "../server/graph.ts";
+import type { Plugin } from "../server/types.ts";
+import { isFilledArray } from "../shared/util.ts";
+
+/** A plugin for Deno Deploy which doesn't support the dynamic import. */
+export default function DenoDeployPlugin({ modules }: { modules: Record<string, Record<string, unknown>> }): Plugin {
+  return {
+    name: "deploy",
+    setup(aleph, env) {
+      if (!env.isDev) {
+        if (isFilledArray(modules.depGraph?.modules)) {
+          modules.depGraph.modules.forEach((module) => {
+            depGraph.mark(module.specifier, module);
+          });
+        }
+        aleph.router = { ...aleph.router, modules };
+      }
+    },
+  };
+}
diff --git a/server/mod.ts b/server/mod.ts
@@ -1,26 +1,24 @@
-import { isFilledArray } from "../shared/util.ts";
 import { path, serve as stdServe, serveTls } from "./deps.ts";
-import depGraph from "./graph.ts";
 import { createHandler } from "./handler.ts";
 import log, { type LevelName } from "./log.ts";
 import { build } from "./build.ts";
 import type { AlephConfig, ServeInit } from "./types.ts";
 import { watch } from "./dev.ts";
 
-/** The options for the Aleph.js server.  */
+/** The options for Aleph.js server.  */
 export type ServeOptions = AlephConfig & Omit<ServeInit, "onError">;
 
 /** Start the Aleph.js server. */
 export async function serve(options?: ServeOptions): Promise<void> {
   const isDev = Deno.args.includes("--dev");
-  const { hostname, port, signal, onListen: _onListen, tls, plugins, ...config } = options ?? {};
-  const { baseUrl, router } = config;
+  const { hostname, port, signal, onListen: _onListen, plugins, ...config } = options ?? {};
+  const { baseUrl } = config;
 
-  // setup plugins
+  // use plugins
   if (plugins) {
     for (const plugin of plugins) {
       try {
-        await plugin.setup(config);
+        await plugin.setup(config, { isDev });
         log.debug(`plugin ${plugin.name ?? "Unnamed"} setup`);
       } catch (err) {
         log.fatal(`[plugin:${plugin.name}] ${err.message}`);
@@ -31,18 +29,6 @@ export async function serve(options?: ServeOptions): Promise<void> {
   // inject the config to global
   Reflect.set(globalThis, "__ALEPH_CONFIG", config);
 
-  // use `_export.ts` imports
-  if (router && router.routes) {
-    if (isDev) {
-      router.routes = undefined;
-    } else if (isFilledArray(router.routes.depGraph?.modules)) {
-      // restore the dependency graph from the re-import route modules
-      router.routes.depGraph.modules.forEach((module) => {
-        depGraph.mark(module.specifier, module);
-      });
-    }
-  }
-
   const appDir = baseUrl ? path.fromFileUrl(new URL(".", baseUrl)) : Deno.cwd();
   const handler = createHandler(appDir, config);
 
@@ -56,6 +42,7 @@ export async function serve(options?: ServeOptions): Promise<void> {
     watch(appDir, Deno.args.includes("--generate"));
   }
 
+  const { tls } = config;
   const onListen = (arg: { port: number; hostname: string }) => {
     const origin = `${tls ? "https" : "http"}://${hostname ?? "localhost"}:${arg.port}`;
     Reflect.set(globalThis, "__ALEPH_SERVER_ORIGIN", origin);
diff --git a/server/routing.ts b/server/routing.ts
@@ -19,9 +19,9 @@ import type { Context, RouterInit } from "./types.ts";
 /** import the route module. */
 export async function importRouteModule({ filename, pattern }: RouteMeta, appDir?: string) {
   const config = getAlephConfig();
-  const routes = config?.router?.routes;
-  if (routes && pattern.pathname in routes) {
-    return routes[pattern.pathname];
+  const modules = config?.router?.modules;
+  if (modules && pattern.pathname in modules) {
+    return modules[pattern.pathname];
   }
 
   const version = depGraph.get(filename)?.version;
diff --git a/server/types.ts b/server/types.ts
@@ -29,9 +29,13 @@ export type AlephConfig = {
 
 export interface Plugin {
   name?: string;
-  setup(config: AlephConfig): void | Promise<void>;
+  setup(config: AlephConfig, env: PluginENV): void | Promise<void>;
 }
 
+export type PluginENV = {
+  isDev: boolean;
+};
+
 export interface AtomicCSSGenerateOptions {
   /**
    * Filepath of the file being processed.
@@ -74,7 +78,7 @@ export interface RouterInit {
   /** The extnames to match routes. */
   exts?: string[];
   /** The pre-built routes.  */
-  routes?: Record<string, Record<string, unknown>>;
+  modules?: Record<string, Record<string, unknown>>;
 }
 
 export type CookieOptions = {
