repluggable-core 0.0.0-pr343.49 → 0.0.0-pr345.55

package/src/API.ts

@@ -50,11 +50,17 @@ export type ContributionPredicate = () => boolean
 export interface EntryPointTags {
     [name: string]: string
 }
+export type LazyEntryPointFactory = () => Promise<EntryPoint> //TODO: get rid of these
 export type ShellsChangedCallback = (shellNames: string[]) => void
 export type DeclarationsChangedCallback = () => void
 export type UnsubscribeFromDeclarationsChanged = () => void
 export type ShellBoundaryAspect = React.FunctionComponent<React.PropsWithChildren<unknown>>
 
+export interface LazyEntryPointDescriptor {
+    readonly name: string
+    readonly factory: LazyEntryPointFactory
+}
+
 /**
  * Application part that will receive a {Shell} when loaded into the {AppHost}
  * @export
@@ -100,7 +106,7 @@ export interface EntryPoint {
     detach?(shell: Shell): void
 }
 
-export type AnyEntryPoint = EntryPoint
+export type AnyEntryPoint = EntryPoint | LazyEntryPointDescriptor
 export type EntryPointOrPackage = AnyEntryPoint | AnyEntryPoint[]
 export interface EntryPointOrPackagesMap {
     [name: string]: EntryPointOrPackage
@@ -264,6 +270,8 @@ export interface AppHost {
      * @return {boolean}
      */
     hasShell(name: string): boolean
+    // TODO: Deprecate
+    isLazyEntryPoint(name: string): boolean
     /**
      * Dynamically add {Shell}s after the host is created
      *

package/src/appHost.ts

@@ -18,6 +18,8 @@ import {
     ExtensionSlot,
     FunctionWithSameArgs,
     Lazy,
+    LazyEntryPointDescriptor,
+    LazyEntryPointFactory,
     MemoizeMissHit,
     ObservableState,
     PrivateAppHost,
@@ -60,6 +62,13 @@ function castMultiArray<T>(v: T[] | T[][]): T[][] {
     return isMultiArray(v) ? v : [v]
 }
 
+export const makeLazyEntryPoint = (name: string, factory: LazyEntryPointFactory): LazyEntryPointDescriptor => {
+    return {
+        name,
+        factory
+    }
+}
+
 export const mainViewSlotKey: SlotKey<ReactComponentContributor> = {
     name: 'mainView'
 }
@@ -173,6 +182,7 @@ export function createAppHost(initialEntryPointsOrPackages: EntryPointOrPackage[
     const slotKeysByName = new Map<string, AnySlotKey>()
     const addedShells = new Map<string, PrivateShell>()
     const shellInstallers = new WeakMap<PrivateShell, string[]>()
+    const lazyShells = new Map<string, LazyEntryPointFactory>()
     const shellsChangedCallbacks = new Map<string, ShellsChangedCallback>()
     const declarationsChangedCallbacks = new Map<string, DeclarationsChangedCallback>()
     const APILayers = new WeakMap<AnySlotKey, APILayer[] | undefined>()
@@ -194,6 +204,7 @@ export function createAppHost(initialEntryPointsOrPackages: EntryPointOrPackage[
         getAllSlotKeys,
         getAllEntryPoints,
         hasShell,
+        isLazyEntryPoint,
         addShells,
         removeShells,
         onShellsChanged,
@@ -213,6 +224,7 @@ export function createAppHost(initialEntryPointsOrPackages: EntryPointOrPackage[
         extensionSlots,
         addedShells,
         shellInstallers,
+        lazyShells,
 
         performance: {
             options,
@@ -288,6 +300,11 @@ export function createAppHost(initialEntryPointsOrPackages: EntryPointOrPackage[
 
     return host
 
+    //TODO: get rid of LazyEntryPointDescriptor
+    function isLazyEntryPointDescriptor(value: AnyEntryPoint): value is LazyEntryPointDescriptor {
+        return typeof (value as LazyEntryPointDescriptor).factory === 'function'
+    }
+
     function enrichMemoization<T extends _.MemoizedFunction & Partial<MemoizeMissHit>>(memoized: T): T & MemoizeMissHit {
         const memoizedWithMissHit = _.assign(memoized, {
             miss: 0,
@@ -387,9 +404,15 @@ miss: ${memoizedWithMissHit.miss}
         validateUniqueShellNames(entryPoints)
         !options.disableCheckCircularDependencies && !options.experimentalCyclicMode && validateCircularDependency(allEntryPoints)
 
-        executeInstallShell(entryPoints)
+        const [lazyEntryPointsList, readyEntryPointsList] = _.partition(entryPoints, isLazyEntryPointDescriptor) as [
+            LazyEntryPointDescriptor[],
+            EntryPoint[]
+        ]
 
-        setInstalledShellNames(getInstalledShellNames())
+        executeInstallShell(readyEntryPointsList)
+        lazyEntryPointsList.forEach(registerLazyEntryPoint)
+
+        setInstalledShellNames(getInstalledShellNames().concat(_.map(lazyEntryPointsList, 'name')))
         return Promise.resolve()
     }
 
@@ -639,6 +662,14 @@ miss: ${memoizedWithMissHit.miss}
         return installedShellsSet[name] === true
     }
 
+    function isLazyEntryPoint(name: string): boolean {
+        return lazyShells.has(name)
+    }
+
+    function registerLazyEntryPoint(descriptor: LazyEntryPointDescriptor): void {
+        lazyShells.set(descriptor.name, descriptor.factory)
+    }
+
     function getOwnSlotKey<T>(key: SlotKey<T>): SlotKey<T> {
         if (key.public === true) {
             const ownKey = slotKeysByName.get(slotKeyToName(key))
@@ -968,6 +999,7 @@ miss: ${memoizedWithMissHit.miss}
             getAllSlotKeys: host.getAllSlotKeys,
             getAllEntryPoints: host.getAllEntryPoints,
             hasShell: host.hasShell,
+            isLazyEntryPoint: host.isLazyEntryPoint,
             onShellsChanged: host.onShellsChanged,
             onDeclarationsChanged: host.onDeclarationsChanged,
             removeShellsChangedCallback: host.removeShellsChangedCallback,

package/src/index.ts

@@ -29,7 +29,7 @@ export {
 
 export { ConsoleHostLogger } from './loggers'
 
-export { createAppHost, mainViewSlotKey, stateSlotKey } from './appHost'
+export { createAppHost, makeLazyEntryPoint, mainViewSlotKey, stateSlotKey } from './appHost'
 
 export { AppHostServicesProvider } from './appHostServices'
 

package/src/repluggableAppDebug/debug.d.ts

@@ -1,4 +1,4 @@
-import { EntryPoint, AppHost, AnySlotKey, PrivateShell, SlotKey } from '../API'
+import { EntryPoint, AppHost, AnySlotKey, LazyEntryPointFactory, PrivateShell, SlotKey } from '../API'
 import { AnyExtensionSlot } from '../extensionSlot'
 import { Hot } from '../hot'
 
@@ -12,6 +12,7 @@ export interface RepluggableAppDebugInfo {
     uniqueShellNames: Set<string>
     extensionSlots: Map<AnySlotKey, AnyExtensionSlot>
     addedShells: Map<string, PrivateShell>
+    lazyShells: Map<string, LazyEntryPointFactory>
     readyAPIs: Set<AnySlotKey>
     shellInstallers: WeakMap<PrivateShell, string[]>
     utils: RepluggableDebugUtils

package/src/repluggableAppDebug/repluggableAppDebug.ts

@@ -1,5 +1,5 @@
 import { getPerformanceDebug } from './performanceDebugInfo'
-import { AnySlotKey, AppHost, EntryPoint, PrivateShell, SlotKey, StatisticsMemoization, Trace } from '../API'
+import { AnySlotKey, AppHost, EntryPoint, LazyEntryPointFactory, PrivateShell, SlotKey, StatisticsMemoization, Trace } from '../API'
 import _ from 'lodash'
 import { hot } from '../hot'
 import { AppHostServicesProvider } from '../appHostServices'
@@ -18,6 +18,7 @@ interface SetupDebugInfoParams {
     extensionSlots: Map<AnySlotKey, AnyExtensionSlot>
     addedShells: Map<string, PrivateShell>
     shellInstallers: WeakMap<PrivateShell, string[]>
+    lazyShells: Map<string, LazyEntryPointFactory>
 
     performance: PerformanceDebugParams
 
@@ -132,6 +133,7 @@ export function setupDebugInfo({
     getUnreadyEntryPoints,
     extensionSlots,
     addedShells,
+    lazyShells,
     shellInstallers,
     performance: { options, trace, memoizedArr }
 }: SetupDebugInfoParams) {
@@ -179,6 +181,7 @@ export function setupDebugInfo({
         uniqueShellNames,
         extensionSlots,
         addedShells,
+        lazyShells,
         readyAPIs,
         shellInstallers,
         utils,

package/test/appHost.spec.ts

@@ -1,6 +1,6 @@
 import _ from 'lodash'
 
-import { createAppHost, mainViewSlotKey, stateSlotKey } from '../src/appHost'
+import { createAppHost, mainViewSlotKey, makeLazyEntryPoint, stateSlotKey } from '../src/appHost'
 
 import {
     AnySlotKey,
@@ -207,6 +207,12 @@ describe('App Host', () => {
         it('should not install multiple shells with the same name', () => {
             expect(() => createAppHost([mockPackage, _.pick(mockPackage, 'name')], testHostOptions)).toThrow()
         })
+
+        it('should install lazy shells', () => {
+            const lazyEntryPoint = makeLazyEntryPoint(mockPackage.name, async () => mockPackage)
+            const host = createAppHost([lazyEntryPoint], testHostOptions)
+            expect(host.hasShell(lazyEntryPoint.name)).toBe(true)
+        })
     })
 
     describe('EntryPoint lifecycle state', () => {