add-custom-data-strucutre-extension-slot (#332)

Author: ma-cohen

packages/repluggable-core/package.json

@@ -20,7 +20,8 @@
     "build-es": "tsc --outDir dist/es --module esNext",
     "build-debug": "tsc --project tsconfig.debug.json",
     "test": "jest --coverage",
-    "posttest": "tslint --project ."
+    "posttest": "tslint --project .",
+    "lintfix": "tslint --fix --project ."
   },
   "dependencies": {
     "lodash": "^4.17.20",

packages/repluggable-core/src/API.ts

@@ -1,7 +1,7 @@
 import * as Redux from 'redux'
 import { ThrottledStore } from './throttledStore'
 import { INTERNAL_DONT_USE_SHELL_GET_APP_HOST } from './__internal'
-
+import { CustomCreateExtensionSlot } from './extensionSlot'
 
 export interface AnySlotKey {
     readonly name: string
@@ -333,6 +333,12 @@ export interface APILayer {
     name: string
 }
 
+interface AppHostPlugins {
+    extensionSlot?: {
+        customCreateExtensionSlot: CustomCreateExtensionSlot
+    }
+}
+
 export interface AppHostOptions {
     readonly logger?: HostLogger
     readonly monitoring: MonitoringOptions
@@ -343,6 +349,7 @@ export interface AppHostOptions {
     readonly enableReduxDevtoolsExtension?: boolean
     readonly experimentalCyclicMode?: boolean
     readonly shouldScopeReducers?: boolean
+    readonly plugins?: AppHostPlugins
 }
 
 export interface MemoizeMissHit {
@@ -526,9 +533,8 @@ export interface PrivateShell extends Shell {
     setDependencyAPIs(APIs: AnySlotKey[]): void
     setLifecycleState(enableStore: boolean, enableAPIs: boolean, initCompleted: boolean): void
     getBoundaryAspects(): ShellBoundaryAspect[]
-    getHostOptions(): AppHostOptions,
-    readonly [INTERNAL_DONT_USE_SHELL_GET_APP_HOST]: () => AppHost
-  
+    getHostOptions(): AppHostOptions
+    [INTERNAL_DONT_USE_SHELL_GET_APP_HOST](): AppHost
 }
 
 export interface EntryPointsInfo {

packages/repluggable-core/src/IterableWeakMap.ts

@@ -81,7 +81,7 @@ export class IterableWeakMap<K extends object = object, V = any> implements Map<
 
     forEach(callbackfn: (value: V, key: K, map: this) => void, thisArg?: any): void {
         for (const [key, value] of this) {
-            callbackfn(value, key, this )
+            callbackfn(value, key, this)
         }
     }
 
@@ -107,17 +107,15 @@ export class IterableWeakMap<K extends object = object, V = any> implements Map<
         return this[Symbol.iterator]() as unknown as ReturnType<Map<K, V>['entries']>
     }
 
-    *keys(): ReturnType<Map<K, V>['keys']>  {
+    *keys(): ReturnType<Map<K, V>['keys']> {
         for (const [key] of this) {
             yield key
         }
     }
 
-    *values():  ReturnType<Map<K, V>['values']> {
+    *values(): ReturnType<Map<K, V>['values']> {
         for (const [_, value] of this) {
             yield value
         }
     }
 }
-
-

packages/repluggable-core/src/__internal.ts

@@ -1,4 +1,4 @@
 /**
  * This symbol is only for internal use of repluggable mono-repo.
  */
-export const INTERNAL_DONT_USE_SHELL_GET_APP_HOST: unique symbol = Symbol.for('SHELL_GET_APP_HOST')
+export const INTERNAL_DONT_USE_SHELL_GET_APP_HOST: unique symbol = Symbol.for('SHELL_GET_APP_HOST')

packages/repluggable-core/src/appHost.ts

@@ -251,7 +251,10 @@ export function createAppHost(initialEntryPointsOrPackages: EntryPointOrPackage[
         const memoized = _.memoize(func, resolver)
 
         if (options.monitoring.debugMemoization) {
-            Object.defineProperty(memoized, 'name', { value: `${func.name}_memoized`, writable: false })
+            Object.defineProperty(memoized, 'name', {
+                value: `${func.name}_memoized`,
+                writable: false
+            })
         }
 
         if (options.monitoring.disableMonitoring) {
@@ -560,7 +563,12 @@ miss: ${memoizedWithMissHit.miss}
     }
 
     function declareSlot<TItem>(key: SlotKey<TItem>, declaringShell?: Shell): ExtensionSlot<TItem> {
-        const newSlot = registerSlotOrThrow(key, () => createExtensionSlot(key, host, declaringShell))
+        const newSlot = registerSlotOrThrow(key, () =>
+            createExtensionSlot(key, host, {
+                declaringShell,
+                customCreateExtensionSlot: options.plugins?.extensionSlot?.customCreateExtensionSlot
+            })
+        )
         return newSlot
     }
 

packages/repluggable-core/src/extensionSlot.ts

@@ -21,18 +21,44 @@ const alwaysTrue = () => true
 
 type Unsubscribe = () => void
 
+interface ItemsDataStructure<T> {
+    get(): ExtensionItem<T>[]
+    add(item: ExtensionItem<T>): void
+    discardBy(predicate: (item: ExtensionItem<T>) => boolean): void
+}
+
+const itemsDataStructure = <T>(): ItemsDataStructure<T> => {
+    let items: ExtensionItem<T>[] = []
+    return {
+        get: () => items,
+        add: (item: ExtensionItem<T>) => {
+            items.push(item)
+        },
+        discardBy: (predicate: (item: ExtensionItem<T>) => boolean) => {
+            items = items.filter(predicate)
+        }
+    }
+}
+
+export type CustomCreateExtensionSlot = <T>() => ItemsDataStructure<T>
+
+export interface CreateExtensionSlotOptions {
+    declaringShell?: Shell
+    customCreateExtensionSlot?: CustomCreateExtensionSlot
+}
+
 export function createExtensionSlot<T>(
     key: SlotKey<T>,
     host: PrivateAppHost,
-    declaringShell?: Shell
+    options?: CreateExtensionSlotOptions
 ): PrivateExtensionSlot<T> & AnyExtensionSlot {
-    let items: ExtensionItem<T>[] = []
+    const items = options?.customCreateExtensionSlot ? options.customCreateExtensionSlot<T>() : itemsDataStructure<T>()
     let subscribers: (() => void)[] = []
     const slotUniqueId = _.uniqueId()
 
     return {
         host,
-        declaringShell,
+        declaringShell: options?.declaringShell,
         name: key.name,
         contribute,
         getItems,
@@ -43,7 +69,7 @@ export function createExtensionSlot<T>(
     }
 
     function contribute(fromShell: Shell, item: T, condition?: ContributionPredicate): void {
-        items.push({
+        items.add({
             shell: fromShell,
             contribution: item,
             condition: condition || alwaysTrue,
@@ -53,21 +79,21 @@ export function createExtensionSlot<T>(
     }
 
     function getItems(forceAll: boolean = false): ExtensionItem<T>[] {
-        return forceAll ? items : items.filter(item => item.condition())
+        return forceAll ? items.get() : items.get().filter(item => item.condition())
     }
 
     function getSingleItem(): ExtensionItem<T> | undefined {
-        return items.find(item => item.condition())
+        return items.get().find(item => item.condition())
     }
 
     function getItemByName(name: string): ExtensionItem<T> | undefined {
-        return items.find(item => item.name === name && item.condition())
+        return items.get().find(item => item.name === name && item.condition())
     }
 
     function discardBy(predicate: ExtensionItemFilter<T>) {
-        const originalContributionCount = items.length
-        items = items.filter(v => !predicate(v))
-        if (items.length !== originalContributionCount) {
+        const originalContributionCount = items.get().length
+        items.discardBy(v => !predicate(v))
+        if (items.get().length !== originalContributionCount) {
             subscribers.forEach(func => func())
         }
     }

packages/repluggable-core/src/index.ts

@@ -26,13 +26,11 @@ export {
     ScopedStore
 } from './API'
 
-
-
 export { ConsoleHostLogger } from './loggers'
 
 export { createAppHost, makeLazyEntryPoint, mainViewSlotKey, stateSlotKey } from './appHost'
 
-export {AppHostServicesProvider} from './appHostServices'
+export { AppHostServicesProvider } from './appHostServices'
 
 export { InstalledShellsSelectors, ShellToggleSet } from './installedShellsState'
 
@@ -42,5 +40,4 @@ export { interceptAnyObject } from './interceptAnyObject'
 export { monitorAPI } from './monitorAPI'
 export { hot } from './hot'
 
-
-export {INTERNAL_DONT_USE_SHELL_GET_APP_HOST} from './__internal'
+export { INTERNAL_DONT_USE_SHELL_GET_APP_HOST } from './__internal'

packages/repluggable-core/src/throttledStore.ts

@@ -16,18 +16,17 @@ interface AnyShellAction extends AnyAction {
     __shellName?: string
 }
 
-
-function createTimeOutPublisher ( notify: () => void)  {
-    let id : undefined | NodeJS.Timeout =  undefined 
+function createTimeOutPublisher(notify: () => void) {
+    let id: undefined | NodeJS.Timeout = undefined
     return () => {
         if (id === undefined) {
             id = setTimeout(() => {
                 id = undefined
                 notify()
-            },0)
+            }, 0)
         }
         return () => {
-            if(id === undefined) {
+            if (id === undefined) {
                 return
             }
             clearTimeout(id)
@@ -36,8 +35,8 @@ function createTimeOutPublisher ( notify: () => void)  {
     }
 }
 
-function createAnimationFramePublisher ( notify: () => void)  {
-    let id : undefined | number =  undefined 
+function createAnimationFramePublisher(notify: () => void) {
+    let id: undefined | number = undefined
     return () => {
         if (id === undefined) {
             id = requestAnimationFrame(() => {
@@ -46,7 +45,7 @@ function createAnimationFramePublisher ( notify: () => void)  {
             })
         }
         return () => {
-            if(id === undefined) {
+            if (id === undefined) {
                 return
             }
             cancelAnimationFrame(id)
@@ -55,9 +54,6 @@ function createAnimationFramePublisher ( notify: () => void)  {
     }
 }
 
-
-
-
 type Subscriber = () => void
 
 export interface StateContribution<TState = {}, TAction extends AnyAction = AnyAction> {
@@ -252,10 +248,8 @@ export const createThrottledStore = (
         notifyAll()
     }
 
-
-   
-
-    const notifyAllOnPublish = typeof window === 'undefined' ? createTimeOutPublisher(scheduledNotifyAll) : createAnimationFramePublisher(scheduledNotifyAll)
+    const notifyAllOnPublish =
+        typeof window === 'undefined' ? createTimeOutPublisher(scheduledNotifyAll) : createAnimationFramePublisher(scheduledNotifyAll)
 
     let cancelRender = _.noop
 

packages/repluggable-core/test/appHost.spec.ts

@@ -32,6 +32,7 @@ import {
 import { AppHostAPI, AppHostServicesEntryPointName, AppHostServicesProvider } from '../src/appHostServices'
 import { ConsoleHostLogger } from '../src/loggers'
 import { createCircularEntryPoints, createDirectCircularEntryPoints } from './appHost.mock'
+import { createSignalItemsDataStructure } from './createSignalItemsDataStructure'
 
 const testHostOptions: AppHostOptions = {
     monitoring: { disableMonitoring: true }
@@ -1792,4 +1793,92 @@ If the API is intended to be public, it should be declared as "public: true" in
             )
         })
     })
+
+    describe('Custom Items Data Structure via AppHost Options (plugins)', () => {
+        it('should use customCreateExtensionSlot from appHostOptions when contributing and removing items', async () => {
+            interface SlotItem {
+                value: string
+            }
+            const slotKey: SlotKey<SlotItem> = { name: 'host_options_signal_slot' }
+
+            interface SlotContributionAPI {
+                contributeItem(fromShell: Shell, item: SlotItem): void
+                getItems(): SlotItem[]
+            }
+            const SlotContributionAPIKey: SlotKey<SlotContributionAPI> = {
+                name: 'SLOT_CONTRIBUTION_API'
+            }
+
+            const itemsSpy = jest.fn()
+
+            const { createDataStructure, effect } = createSignalItemsDataStructure()
+
+            const slotOwnerEntryPoint: EntryPoint = {
+                name: 'SLOT_OWNER_ENTRY_POINT',
+                declareAPIs() {
+                    return [SlotContributionAPIKey]
+                },
+                attach(shell: Shell) {
+                    const slot = shell.declareSlot(slotKey)
+                    shell.contributeAPI(SlotContributionAPIKey, () => ({
+                        contributeItem(fromShell: Shell, item: SlotItem) {
+                            slot.contribute(fromShell, item)
+                        },
+                        getItems() {
+                            return slot.getItems().map(item => item.contribution)
+                        }
+                    }))
+                }
+            }
+
+            const ContributorEntryPoint: EntryPoint = {
+                name: 'CONTRIBUTOR_ENTRY_POINT',
+                getDependencyAPIs() {
+                    return [SlotContributionAPIKey, ListenerAPI]
+                },
+                extend(shell: Shell) {
+                    const api = shell.getAPI(SlotContributionAPIKey)
+                    api.contributeItem(shell, { value: 'item1' })
+                    api.contributeItem(shell, { value: 'item2' })
+                }
+            }
+
+            const ListenerAPI: SlotKey<{}> = { name: 'LISTENER_API' }
+
+            const ListenerEntryPoint: EntryPoint = {
+                name: 'LISTENER_ENTRY_POINT',
+                declareAPIs() {
+                    return [ListenerAPI]
+                },
+                getDependencyAPIs() {
+                    return [SlotContributionAPIKey]
+                },
+                // move to attach to make sure
+                attach(shell: Shell) {
+                    const slotContributionAPI = shell.getAPI(SlotContributionAPIKey)
+                    effect(() => {
+                        slotContributionAPI.getItems()
+                        itemsSpy()
+                    })
+                    // contribute an api to make sure that the contribution depends on it and happens after.
+                    shell.contributeAPI(ListenerAPI, () => ({}))
+                }
+            }
+
+            const host = createAppHost([slotOwnerEntryPoint, ContributorEntryPoint, ListenerEntryPoint], {
+                monitoring: {},
+                plugins: {
+                    extensionSlot: {
+                        customCreateExtensionSlot: createDataStructure
+                    }
+                }
+            })
+
+            // first was created and then two time
+            expect(itemsSpy).toBeCalledTimes(3)
+
+            await host.removeShells([ContributorEntryPoint.name])
+            expect(itemsSpy).toBeCalledTimes(4)
+        })
+    })
 })