chore: more comprehensive codeSplitting option

Author: magne4000

example/awesome-framework/src/vite/photonPlugin.ts

@@ -7,7 +7,9 @@ export function photonPlugin(): Plugin[] {
     fullInstall: true,
 
     // Disables code-splitting functionality for testing purposes
-    codeSplitting: false,
+    codeSplitting: {
+      framework: false,
+    },
 
     // Always use those middlewares for all entries defined by Photon
     resolveMiddlewares() {

packages/adapter-cloudflare/src/plugin.ts

@@ -15,7 +15,9 @@ export function cloudflare(config?: Omit<PluginConfig, 'viteEnvironment'>): Plug
             photon: {
               // @cloudflare/vite-plugin has its own dev server
               devServer: false,
-              codeSplitting: false,
+              codeSplitting: {
+                target: false,
+              },
               // Should be set to the value of cloudflareVitePlugins -> viteEnvironment.name
               // defaultBuildEnv: 'cloudflare',
             },

packages/photonjs/src/api/api.ts

@@ -22,7 +22,7 @@ export function addPhotonEntry(pluginContext: PluginContext, name: string, entry
     .union([PhotonEntryUniversalHandler, PhotonEntryServerConfig])
     .parse(entryToPhoton('handler-entry', entry, name))
 
-  if (pluginContext.environment.config.photon.codeSplitting && parsed.type === 'server-config') {
+  if (pluginContext.environment.config.photon.codeSplitting.framework && parsed.type === 'server-config') {
     throw new PhotonConfigError(
       `Photon entry with name "${entry.name}" is of type "server-config" but code splitting is enabled. Please disable code splitting or use "universal-handler" instead.`,
     )
@@ -45,7 +45,7 @@ export function updatePhotonEntry(pluginContext: PluginContext, name: string, en
     .union([PhotonEntryUniversalHandler, PhotonEntryServerConfig])
     .parse(entryToPhoton('handler-entry', entry, name))
 
-  if (pluginContext.environment.config.photon.codeSplitting && parsed.type === 'server-config') {
+  if (pluginContext.environment.config.photon.codeSplitting.framework && parsed.type === 'server-config') {
     throw new PhotonConfigError(
       `Photon entry with name "${entry.name}" is of type "server-config" but code splitting is enabled. Please disable code splitting or use "universal-handler" instead.`,
     )

packages/photonjs/src/plugin/plugins/getMiddlewaresPlugin.ts

@@ -31,6 +31,10 @@ async function getAllPhotonMiddlewares(
   if (!isDev) {
     // Only inject entries for the current environment
     universalEntries = universalEntries.filter((h) => (h.env || defaultBuildEnv) === currentEnv)
+    if (pluginContext.environment.config.photon.codeSplitting.target) {
+      // Do not inject isolated entries when target supports code splitting
+      universalEntries = universalEntries.filter((h) => h.compositionMode !== 'isolated')
+    }
   }
   const universalEntriesIds = metaHandler ? [metaHandler.id] : universalEntries.map((e) => e.id)
 

packages/photonjs/src/plugin/plugins/resolvePhotonConfigPlugin.ts

@@ -28,11 +28,11 @@ export function resolvePhotonConfigPlugin(pluginConfig?: Photon.Config): Plugin[
             // biome-ignore lint/suspicious/noExplicitAny: <explanation>
             resolvedPhotonConfig = resolvePhotonConfig(config.photon as any)
           }
-          if (resolvedPhotonConfig.codeSplitting) {
+          if (resolvedPhotonConfig.codeSplitting.framework) {
             const serverConfigEntries = resolvedPhotonConfig.entries.filter((e) => e.type === 'server-config')
             if (serverConfigEntries.length > 0) {
               throw new PhotonConfigError(
-                'server-config entries are not supported when code splitting is enabled. Please disable code splitting or remove server-config entries.',
+                'server-config entries are not supported when codeSplitting.framework is true. Please disable code splitting or remove server-config entries.',
               )
             }
           }

packages/photonjs/src/plugin/plugins/targetLoader.ts

@@ -49,8 +49,8 @@ export function targetLoader(
           for (const entry of photon.entries) {
             if (
               (entry.env || 'ssr') === envName &&
-              // if codeSplitting is enabled or if a target has explicitely been set, emit a new entry
-              (photon.codeSplitting || entry.target)
+              // if framework codeSplitting is enabled or if a target has explicitely been set, emit a new entry
+              (photon.codeSplitting.framework || entry.target)
             ) {
               this.emitFile({
                 type: 'chunk',

packages/photonjs/src/validators/coerce.ts

@@ -80,8 +80,10 @@ const resolver = Validators.PhotonConfig.transform((c) => {
             autoServe: excludeTrue(c.devServer)?.autoServe ?? true,
           },
     middlewares: c.middlewares ?? [],
-    // codeSplitting must explicitely be set to true by targets
-    codeSplitting: c.codeSplitting ?? false,
+    codeSplitting: {
+      framework: c.codeSplitting?.framework ?? true,
+      target: c.codeSplitting?.target ?? false,
+    },
     defaultBuildEnv: c.defaultBuildEnv ?? 'ssr',
     hmr: c.hmr ?? (isBun || isDeno ? 'prefer-restart' : true),
   })
@@ -91,6 +93,7 @@ export function mergePhotonConfig(configs: Photon.Config[]): Photon.Config {
   const resolving: Photon.Config = {}
   resolving.entries = {}
   resolving.middlewares = []
+  resolving.codeSplitting = {}
   for (const config of configs) {
     // server
     if (config.server) {
@@ -132,9 +135,14 @@ export function mergePhotonConfig(configs: Photon.Config[]): Photon.Config {
 
     // codeSplitting
     // if codeSplitting has already been set to false, keep it that way
-    if (resolving.codeSplitting !== false) {
-      if (typeof config.codeSplitting !== 'undefined') {
-        resolving.codeSplitting = config.codeSplitting
+    if (resolving.codeSplitting.framework !== false) {
+      if (typeof config.codeSplitting?.framework !== 'undefined') {
+        resolving.codeSplitting.framework = config.codeSplitting.framework
+      }
+    }
+    if (resolving.codeSplitting.target !== false) {
+      if (typeof config.codeSplitting?.target !== 'undefined') {
+        resolving.codeSplitting.target = config.codeSplitting.target
       }
     }
 

packages/photonjs/src/validators/validators.ts

@@ -57,7 +57,6 @@ export const PhotonEntryPartial = PhotonEntryUniversalHandler.extend({
 
 export const PhotonConfig = z.looseObject({
   server: z.union([z.string(), PhotonEntryServerPartial]).optional(),
-  // TODO if codeSplitting is false and one entry does not have .id -> throw error
   // This means that only a framework setting codeSplitting: false can also add entries without .id
   entries: z.record(z.string(), z.union([z.string(), PhotonEntryPartial])).optional(),
   hmr: z.union([z.boolean(), z.literal('prefer-restart')]).optional(),
@@ -72,7 +71,12 @@ export const PhotonConfig = z.looseObject({
   /**
    * Can be set to false by frameworks or deployment targets if code splitting is not supported
    */
-  codeSplitting: z.boolean().optional(),
+  codeSplitting: z
+    .object({
+      framework: z.boolean().optional(),
+      target: z.boolean().optional(),
+    })
+    .optional(),
   devServer: z
     .union([
       z.boolean(),
@@ -94,7 +98,10 @@ export const PhotonConfigResolved = z.looseObject({
     }),
   ),
   defaultBuildEnv: z.string(),
-  codeSplitting: z.boolean(),
+  codeSplitting: z.object({
+    framework: z.boolean(),
+    target: z.boolean(),
+  }),
   devServer: z.union([
     z.literal(false),
     z.object({