Skip to content

WIP: Introduce defineModule function to declare a module before registering #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

WIP: Introduce defineModule function to declare a module before registering #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions apps/springboard-test/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import {Springboard} from 'springboard/engine/engine';
import {springboard} from 'springboard/engine/register';

const mod = springboard.defineModule('Main', {
Copy link
Member Author

@mickmister mickmister Jan 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should then be able to do the following, even though it wouldn't make sense for a Main module:

declare module 'springboard' {
    interface DefinedModules {
        Main: typeof mod;
    }
}

externalDependencies: {
mything: async () => {
return {
getTheThing: async () => 'thanks',
};
},
},
}, async (m, deps) => {
const myThing = await deps.externalDependencies.mything();

// const macroModule = m.getModule('macro');
});

const engine = new Springboard({} as any, {});

engine.registerModule2(mod);
engine.registerModule2(mod, {
externalDependencies: {
mything: async () => {
return {
getTheThing: async () => {
return 'fegfeg';
},
}
}
}
});
46 changes: 23 additions & 23 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

54 changes: 27 additions & 27 deletions packages/jamtools/core/modules/io/io_module.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,33 +24,33 @@ let createIoDependencies = (): IoDeps => {
};
};

// @platform "browser"
import {BrowserQwertyService} from '@jamtools/core/services/browser/browser_qwerty_service';
import {BrowserMidiService} from '@jamtools/core/services/browser/browser_midi_service';

createIoDependencies = () => {
const qwerty = new BrowserQwertyService(document);
const midi = new BrowserMidiService();
return {
qwerty,
midi,
};
};
// @platform end

// @platform "node"
import {NodeQwertyService} from '@jamtools/core/services/node/node_qwerty_service';
import {NodeMidiService} from '@jamtools/core/services/node/node_midi_service';

createIoDependencies = () => {
const qwerty = new NodeQwertyService();
const midi = new NodeMidiService();
return {
qwerty,
midi,
};
};
// @platform end
// // @platform "browser"
// import {BrowserQwertyService} from '@jamtools/core/services/browser/browser_qwerty_service';
// import {BrowserMidiService} from '@jamtools/core/services/browser/browser_midi_service';

// createIoDependencies = () => {
// const qwerty = new BrowserQwertyService(document);
// const midi = new BrowserMidiService();
// return {
// qwerty,
// midi,
// };
// };
// // @platform end

// // @platform "node"
// import {NodeQwertyService} from '@jamtools/core/services/node/node_qwerty_service';
// import {NodeMidiService} from '@jamtools/core/services/node/node_midi_service';

// createIoDependencies = () => {
// const qwerty = new NodeQwertyService();
// const midi = new NodeMidiService();
// return {
// qwerty,
// midi,
// };
// };
// // @platform end

export const setIoDependencyCreator = (func: typeof createIoDependencies) => {
createIoDependencies = func;
Expand Down
83 changes: 82 additions & 1 deletion packages/springboard/core/engine/engine.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import {CoreDependencies, ModuleDependencies} from 'springboard/types/module_types';

import {ClassModuleCallback, ModuleCallback, RegisterModuleOptions, springboard} from './register';
import {ClassModuleCallback, DefineModuleFuncReturnValue, ModuleCallback, RegisterModuleOptions, springboard} from './register';

import React, {createContext, useContext, useState} from 'react';

Expand Down Expand Up @@ -56,6 +56,87 @@ export class Springboard {
}
};

initialize2 = async () => {
const websocketConnected = await this.coreDeps.rpc.initialize();
if (!websocketConnected) {
if ('confirm' in globalThis) {
if (confirm('failed to connect to websocket server. run in local browser mode?')) {
this.coreDeps.isMaestro = () => true;
}
}
}

this.sharedStateService = new SharedStateService(this.coreDeps);
await this.sharedStateService.initialize();

this.moduleRegistry = new ModuleRegistry();

const registeredModules = this.preRegisteredModules;
for (const mod of registeredModules) {
await this.initializeModule(mod.definedModule, mod.options);
}


// const registeredClassModuleCallbacks = (springboard.registerClassModule as unknown as {calls: CapturedRegisterClassModuleCalls[]}).calls || [];
// springboard.registerClassModule = this.registerClassModule;

// const registeredModuleCallbacks = (springboard.registerModule as unknown as {calls: CapturedRegisterModuleCalls[]}).calls || [];
// springboard.registerModule = this.registerModule;

// for (const modClassCallback of registeredClassModuleCallbacks) {
// await this.registerClassModule(modClassCallback);
// }

// for (const modFuncCallback of registeredModuleCallbacks) {
// await this.registerModule(modFuncCallback[0], modFuncCallback[1], modFuncCallback[2]);
// }

for (const cb of this.initializeCallbacks) {
cb();
}
};

preRegisteredModules: {
definedModule: DefineModuleFuncReturnValue<any, any>;
options?: {
externalDependencies?: Partial<any>,
}
}[] = [];

private initializeModule = async <ModuleId extends string, ExternalDependencies extends object | undefined>(
definedModule: DefineModuleFuncReturnValue<ModuleId, ExternalDependencies>,
options?: {
externalDependencies?: Partial<ExternalDependencies>,
},
) => {
const mod: Module = {moduleId: definedModule.moduleId};
const moduleAPI = new ModuleAPI(mod, 'engine', this.coreDeps, this.makeDerivedDependencies(), this.extraModuleDependencies);

const moduleReturnValue = await definedModule.initialize(moduleAPI, definedModule.options?.externalDependencies ? {
externalDependencies: {
...definedModule.options!.externalDependencies!,
...options?.externalDependencies,
},
}: {externalDependencies: {} as any});

Object.assign(mod, moduleReturnValue);

this.moduleRegistry.registerModule(mod);
return {module: mod, api: moduleReturnValue};
}

public registerModule2 = <ModuleId extends string, ExternalDependencies extends object>(
definedModule: DefineModuleFuncReturnValue<ModuleId, ExternalDependencies>,
options?: {
externalDependencies?: Partial<ExternalDependencies>,
},
) => {
this.preRegisteredModules.push({
definedModule,
options,
});
};

public registerModule = async <ModuleOptions extends RegisterModuleOptions, ModuleReturnValue extends object>(
moduleId: string,
options: ModuleOptions,
Expand Down
Loading
Loading