refactor: cleanup (#348)

* some wip code

Co-authored-by: Jacob Nguyen <jacoobes@users.noreply.github.com>

* general idea

* style

* making shrimple truly optional

* got optional localizer working

* proposing api notation?

* prepare for localization map

* add localsFor

* merge some internals

* boss call

* add test for init functionality

* add documentation

* inline and cleanup

* feat: logging for experimental json loading

* loosen typings

* dev workflow and cleaning up comments

* cleaning up a bit more

* rename Localizer -> Localization

* more documentation, change dir for default localizer

* some tests

* "

* move stuff, refactor, deprecate

* yarnb

* Update index.ts

---------

Co-authored-by: Jacob Nguyen <jacoobes@users.noreply.github.com>
Co-authored-by: Jacob Nguyen <76754747+jacoobes@users.noreply.github.com>
Co-authored-by: jacob <jacoobes@sern.dev>
This commit is contained in:
2024-02-10 00:46:16 +01:00
committed by GitHub
parent 5cad432589
commit 45cbda7b42
36 changed files with 311 additions and 272 deletions

34
.github/workflows/npm-publish-dev.yml vendored Normal file
View File

@@ -0,0 +1,34 @@
name: Continuous Delivery
on:
push:
branches:
- main
paths:
- 'src/**'
- 'package.json'
jobs:
Publish:
name: Publishing Dev
runs-on: ubuntu-latest
steps:
- name: Check out Git repository
uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3
- name: Set up Node.js
uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3
with:
node-version: 18
registry-url: 'https://registry.npmjs.org'
- name: Install Node.js dependencies
run: npm i && npm run build:dev
- name: Publish to npm
run: |
npm version premajor --preid "dev.$(git rev-parse --verify --short HEAD)" --git-tag-version=false
npm publish --tag dev
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

View File

@@ -48,7 +48,6 @@
"@typescript-eslint/eslint-plugin": "5.58.0", "@typescript-eslint/eslint-plugin": "5.58.0",
"@typescript-eslint/parser": "5.59.1", "@typescript-eslint/parser": "5.59.1",
"discord.js": "^14.11.0", "discord.js": "^14.11.0",
"esbuild": "^0.17.0",
"eslint": "8.39.0", "eslint": "8.39.0",
"prettier": "2.8.8", "prettier": "2.8.8",
"tsup": "^6.7.0", "tsup": "^6.7.0",
@@ -95,5 +94,8 @@
"type": "git", "type": "git",
"url": "git+https://github.com/sern-handler/handler.git" "url": "git+https://github.com/sern-handler/handler.git"
}, },
"engines": {
"node": ">= 18.16.x"
},
"homepage": "https://sern.dev" "homepage": "https://sern.dev"
} }

View File

@@ -1,6 +1,5 @@
export * as Id from './id'; export * as Id from './id';
export * from './operators'; export * from './operators';
export * from './predicates';
export * as Files from './module-loading'; export * as Files from './module-loading';
export * from './functions'; export * from './functions';
export type { VoidResult } from '../types/core-plugin'; export type { VoidResult } from '../types/core-plugin';
@@ -8,3 +7,4 @@ export { SernError } from './structures/enums';
export { ModuleStore } from './structures/module-store'; export { ModuleStore } from './structures/module-store';
export * as DefaultServices from './structures/services'; export * as DefaultServices from './structures/services';
export { useContainerRaw } from './ioc/base' export { useContainerRaw } from './ioc/base'

View File

@@ -1,9 +0,0 @@
import type { Awaitable } from '../../types/utility';
/**
* Represents a Disposable contract.
* Let dependencies implement this to dispose and cleanup.
*/
export interface Disposable {
dispose(): Awaitable<unknown>;
}

View File

@@ -1,3 +1,5 @@
//i deleted it, hmm so how should we allow users to enable localization?
// a
import type { AnyFunction } from '../../types/utility'; import type { AnyFunction } from '../../types/utility';
export interface Emitter { export interface Emitter {

View File

@@ -1,5 +1,3 @@
import type { CommandModule,Processed, EventModule } from "../../types/core-modules";
/** /**
* @since 2.0.0 * @since 2.0.0
*/ */

View File

@@ -0,0 +1,16 @@
/**
* Represents an initialization contract.
* Let dependencies implement this to initiate some logic.
*/
export interface Init {
init(): unknown;
}
/**
* Represents a Disposable contract.
* Let dependencies implement this to dispose and cleanup.
*/
export interface Disposable {
dispose(): unknown;
}

View File

@@ -2,6 +2,5 @@ export * from './error-handling';
export * from './logging'; export * from './logging';
export * from './module-manager'; export * from './module-manager';
export * from './module-store'; export * from './module-store';
export * from './init'; export * from './hooks';
export * from './emitter'; export * from './emitter';
export * from './disposable'

View File

@@ -1,9 +0,0 @@
import type { Awaitable } from '../../types/utility';
/**
* Represents an initialization contract.
* Let dependencies implement this to initiate some logic.
*/
export interface Init {
init(): Awaitable<unknown>;
}

View File

@@ -1,9 +1,19 @@
import { Err, Ok } from 'ts-results-es'; import { Err, Ok } from 'ts-results-es';
import { ApplicationCommandOptionType, AutocompleteInteraction } from 'discord.js'; import type { Module, SernAutocompleteData, SernOptionsData } from '../types/core-modules';
import type { SernAutocompleteData, SernOptionsData } from '../types/core-modules';
import type { AnyCommandPlugin, AnyEventPlugin, Plugin } from '../types/core-plugin'; import type { AnyCommandPlugin, AnyEventPlugin, Plugin } from '../types/core-plugin';
import { PluginType } from './structures'; import type {
AnySelectMenuInteraction,
ButtonInteraction,
ChatInputCommandInteraction,
MessageContextMenuCommandInteraction,
ModalSubmitInteraction,
UserContextMenuCommandInteraction,
AutocompleteInteraction
} from 'discord.js';
import { ApplicationCommandOptionType, InteractionType } from 'discord.js'
import { PayloadType, PluginType } from './structures';
import assert from 'assert'; import assert from 'assert';
import { Payload } from '../types/utility';
//function wrappers for empty ok / err //function wrappers for empty ok / err
export const ok = /* @__PURE__*/ () => Ok.EMPTY; export const ok = /* @__PURE__*/ () => Ok.EMPTY;
@@ -81,3 +91,33 @@ export function treeSearch(
} }
} }
} }
interface InteractionTypable {
type: InteractionType;
}
//discord.js pls fix ur typings or i will >:(
type AnyMessageComponentInteraction = AnySelectMenuInteraction | ButtonInteraction;
type AnyCommandInteraction =
| ChatInputCommandInteraction
| MessageContextMenuCommandInteraction
| UserContextMenuCommandInteraction;
export function isMessageComponent(i: InteractionTypable): i is AnyMessageComponentInteraction {
return i.type === InteractionType.MessageComponent;
}
export function isCommand(i: InteractionTypable): i is AnyCommandInteraction {
return i.type === InteractionType.ApplicationCommand;
}
export function isAutocomplete(i: InteractionTypable): i is AutocompleteInteraction {
return i.type === InteractionType.ApplicationCommandAutocomplete;
}
export function isModal(i: InteractionTypable): i is ModalSubmitInteraction {
return i.type === InteractionType.ModalSubmit;
}
export function resultPayload<T extends PayloadType>
(type: T, module?: Module, reason?: unknown) {
return { type, module, reason } as Payload & { type : T };
}

View File

@@ -1,11 +1,12 @@
import * as assert from 'assert'; import * as assert from 'assert';
import { composeRoot, useContainer } from './dependency-injection'; import { useContainer } from './dependency-injection';
import type { DependencyConfiguration } from '../../types/ioc'; import type { CoreDependencies, DependencyConfiguration } from '../../types/ioc';
import { CoreContainer } from './container'; import { CoreContainer } from './container';
import { Result } from 'ts-results-es' import { Result } from 'ts-results-es';
import { DefaultServices } from '../_internal'; import { DefaultServices } from '../_internal';
import { AnyFunction } from '../../types/utility'; import { AnyFunction } from '../../types/utility';
import type { Logging } from '../contracts/logging'; import type { Logging } from '../contracts/logging';
//SIDE EFFECT: GLOBAL DI //SIDE EFFECT: GLOBAL DI
let containerSubject: CoreContainer<Partial<Dependencies>>; let containerSubject: CoreContainer<Partial<Dependencies>>;
@@ -29,19 +30,18 @@ export function disposeAll(logger: Logging|undefined) {
.then(() => logger?.info({ message: 'Cleaning container and crashing' })); .then(() => logger?.info({ message: 'Cleaning container and crashing' }));
} }
const dependencyBuilder = (container: any, excluded: string[]) => { const dependencyBuilder = (container: any, excluded: string[] ) => {
type Insertable = type Insertable =
| ((container: CoreContainer<Dependencies>) => unknown ) | ((container: CoreContainer<Dependencies>) => unknown )
| Record<PropertyKey, unknown> | object
return { return {
/** /**
* Insert a dependency into your container. * Insert a dependency into your container.
* Supply the correct key and dependency * Supply the correct key and dependency
*/ */
add(key: keyof Dependencies, v: Insertable) { add(key: keyof Dependencies, v: Insertable) {
Result Result.wrap(() => container.add({ [key]: v}))
.wrap(() => container.add({ [key]: v})) .expect("Failed to add " + key);
.expect("Failed to add " + key);
}, },
/** /**
* Exclude any dependencies from being added. * Exclude any dependencies from being added.
@@ -50,15 +50,15 @@ const dependencyBuilder = (container: any, excluded: string[]) => {
exclude(...keys: (keyof Dependencies)[]) { exclude(...keys: (keyof Dependencies)[]) {
keys.forEach(key => excluded.push(key)); keys.forEach(key => excluded.push(key));
}, },
/** /**
* @param key the key of the dependency * @param key the key of the dependency
* @param v The dependency to swap out. * @param v The dependency to swap out.
* Swap out a preexisting dependency. * Swap out a preexisting dependency.
*/ */
swap(key: keyof Dependencies, v: Insertable) { swap(key: keyof Dependencies, v: Insertable) {
Result Result.wrap(() => container.upsert({ [key]: v }))
.wrap(() => container.upsert({ [key]: v })) .expect("Failed to update " + key);
.expect("Failed to update " + key);
}, },
/** /**
* @param key the key of the dependency * @param key the key of the dependency
@@ -70,9 +70,8 @@ const dependencyBuilder = (container: any, excluded: string[]) => {
* Swap out a preexisting dependency. * Swap out a preexisting dependency.
*/ */
addDisposer(key: keyof Dependencies, cleanup: AnyFunction) { addDisposer(key: keyof Dependencies, cleanup: AnyFunction) {
Result Result.wrap(() => container.addDisposer({ [key] : cleanup }))
.wrap(() => container.addDisposer({ [key] : cleanup })) .expect("Failed to addDisposer for" + key);
.expect("Failed to addDisposer for" + key);
} }
}; };
}; };
@@ -87,15 +86,45 @@ export const insertLogger = (containerSubject: CoreContainer<any>) => {
containerSubject containerSubject
.upsert({'@sern/logger': () => new DefaultServices.DefaultLogging}); .upsert({'@sern/logger': () => new DefaultServices.DefaultLogging});
} }
/**
* Given the user's conf, check for any excluded/included dependency keys.
* Then, call conf.build to get the rest of the users' dependencies.
* Finally, update the containerSubject with the new container state
* @param conf
*/
function composeRoot(
container: CoreContainer<Partial<Dependencies>>,
conf: DependencyConfiguration,
) {
//container should have no client or logger yet.
const hasLogger = conf.exclude?.has('@sern/logger');
if (!hasLogger) {
insertLogger(container);
}
//Build the container based on the callback provided by the user
conf.build(container as CoreContainer<Omit<CoreDependencies, '@sern/client'>>);
if (!hasLogger) {
container.get('@sern/logger')?.info({ message: 'All dependencies loaded successfully.' });
}
container.ready();
}
export async function makeDependencies<const T extends Dependencies> export async function makeDependencies<const T extends Dependencies>
(conf: ValidDependencyConfig) { (conf: ValidDependencyConfig) {
containerSubject = new CoreContainer(); containerSubject = new CoreContainer();
if(typeof conf === 'function') { if(typeof conf === 'function') {
const excluded: string[] = []; const excluded: string[] = [];
conf(dependencyBuilder(containerSubject, excluded)); conf(dependencyBuilder(containerSubject, excluded));
const includeLogger =
!excluded.includes('@sern/logger')
&& !containerSubject.getTokens()['@sern/logger'];
if(!excluded.includes('@sern/logger') if(includeLogger) {
&& !containerSubject.getTokens()['@sern/logger']) {
insertLogger(containerSubject); insertLogger(containerSubject);
} }
@@ -107,5 +136,3 @@ export async function makeDependencies<const T extends Dependencies>
return useContainer<T>(); return useContainer<T>();
} }

View File

@@ -1,9 +1,10 @@
import { Container } from 'iti'; import { Container } from 'iti';
import { Disposable, SernEmitter } from '../'; import { Disposable } from '../';
import * as assert from 'node:assert'; import * as assert from 'node:assert';
import { Subject } from 'rxjs'; import { Subject } from 'rxjs';
import { DefaultServices, ModuleStore } from '../_internal'; import { DefaultServices, ModuleStore } from '../_internal';
import * as Hooks from './hooks' import * as Hooks from './hooks';
import { EventEmitter } from 'node:events';
/** /**
@@ -17,12 +18,13 @@ export class CoreContainer<T extends Partial<Dependencies>> extends Container<T,
assert.ok(!this.isReady(), 'Listening for dispose & init should occur prior to sern being ready.'); assert.ok(!this.isReady(), 'Listening for dispose & init should occur prior to sern being ready.');
const { unsubscribe } = Hooks.createInitListener(this); const { unsubscribe } = Hooks.createInitListener(this);
this.ready$ this.ready$
.subscribe({ complete: unsubscribe }); .subscribe({ complete: unsubscribe });
(this as Container<{}, {}>) (this as Container<{}, {}>)
.add({ '@sern/errors': () => new DefaultServices.DefaultErrorHandling(), .add({ '@sern/errors': () => new DefaultServices.DefaultErrorHandling,
'@sern/emitter': () => new SernEmitter, '@sern/emitter': () => new EventEmitter({ captureRejections: true }),
'@sern/store': () => new ModuleStore }) '@sern/store': () => new ModuleStore })
.add(ctx => { .add(ctx => {
return { '@sern/modules': () => return { '@sern/modules': () =>
@@ -33,19 +35,25 @@ export class CoreContainer<T extends Partial<Dependencies>> extends Container<T,
isReady() { isReady() {
return this.ready$.closed; return this.ready$.closed;
} }
hasKey(key: string): boolean {
return Boolean((this as Container<any,any>)._context[key]);
}
override async disposeAll() { override async disposeAll() {
const otherDisposables = Object const otherDisposables = Object
.entries(this._context) .entries(this._context)
.flatMap(([key, value]) => .flatMap(([key, value]) =>
'dispose' in value ? [key] : []); 'dispose' in value ? [key] : []);
otherDisposables.forEach(key => {
for(const key of otherDisposables) { //possible source of bug: dispose is a property.
this.addDisposer({ [key]: (dep: Disposable) => dep.dispose() } as never); this.addDisposer({ [key]: (dep: Disposable) => dep.dispose() } as never);
} })
await super.disposeAll() await super.disposeAll();
} }
ready() { ready() {
this.ready$.complete(); this.ready$.complete();
this.ready$.unsubscribe(); this.ready$.unsubscribe();

View File

@@ -1,6 +1,6 @@
import type { CoreDependencies, DependencyConfiguration, IntoDependencies } from '../../types/ioc'; import assert from 'node:assert';
import { insertLogger, useContainerRaw } from './base'; import type { IntoDependencies } from '../../types/ioc';
import { CoreContainer } from './container'; import { useContainerRaw } from './base';
/** /**
* @__PURE__ * @__PURE__
@@ -25,6 +25,7 @@ export function transient<T>(cb: () => () => T) {
* The new Service api, a cleaner alternative to useContainer * The new Service api, a cleaner alternative to useContainer
* To obtain intellisense, ensure a .d.ts file exists in the root of compilation. * To obtain intellisense, ensure a .d.ts file exists in the root of compilation.
* Usually our scaffolding tool takes care of this. * Usually our scaffolding tool takes care of this.
* Note: this method only works AFTER your container has been initiated
* @since 3.0.0 * @since 3.0.0
* @example * @example
* ```ts * ```ts
@@ -34,7 +35,9 @@ export function transient<T>(cb: () => () => T) {
* *
*/ */
export function Service<const T extends keyof Dependencies>(key: T) { export function Service<const T extends keyof Dependencies>(key: T) {
return useContainerRaw().get(key)!; const dep = useContainerRaw().get(key)!;
assert(dep, "Requested key " + key + " returned undefined");
return dep;
} }
/** /**
* @since 3.0.0 * @since 3.0.0
@@ -46,32 +49,9 @@ export function Services<const T extends (keyof Dependencies)[]>(...keys: [...T]
return keys.map(k => container.get(k)!) as IntoDependencies<T>; return keys.map(k => container.get(k)!) as IntoDependencies<T>;
} }
/**
* Given the user's conf, check for any excluded dependency keys.
* Then, call conf.build to get the rest of the users' dependencies.
* Finally, update the containerSubject with the new container state
* @param conf
*/
export function composeRoot(
container: CoreContainer<Partial<Dependencies>>,
conf: DependencyConfiguration,
) {
//container should have no client or logger yet.
const hasLogger = conf.exclude?.has('@sern/logger');
if (!hasLogger) {
insertLogger(container);
}
//Build the container based on the callback provided by the user
conf.build(container as CoreContainer<Omit<CoreDependencies, '@sern/client'>>);
if (!hasLogger) {
container.get('@sern/logger')?.info({ message: 'All dependencies loaded successfully.' });
}
container.ready();
}
export function useContainer<const T extends Dependencies>() { export function useContainer<const T extends Dependencies>() {
return <V extends (keyof T)[]>(...keys: [...V]) => return <V extends (keyof T)[]>(...keys: [...V]) =>
keys.map(key => useContainerRaw().get(key as keyof Dependencies)) as IntoDependencies<V>; keys.map(key => useContainerRaw().get(key as keyof Dependencies)) as IntoDependencies<V>;
} }

View File

@@ -9,7 +9,7 @@ type HookName = 'init';
export const createInitListener = (coreContainer : CoreContainer<any>) => { export const createInitListener = (coreContainer : CoreContainer<any>) => {
const initCalled = new Set<PropertyKey>(); const initCalled = new Set<PropertyKey>();
const hasCallableMethod = createPredicate(initCalled); const hasCallableMethod = createPredicate(initCalled);
const unsubscribe = coreContainer.on('containerUpserted', async (event) => { const unsubscribe = coreContainer.on('containerUpserted', async event => {
if(isNotHookable(event)) { if(isNotHookable(event)) {
return; return;
@@ -21,6 +21,7 @@ export const createInitListener = (coreContainer : CoreContainer<any>) => {
} }
}); });
return { unsubscribe }; return { unsubscribe };
} }

View File

@@ -7,6 +7,7 @@ import { createRequire } from 'node:module';
import type { ImportPayload, Wrapper } from '../types/core'; import type { ImportPayload, Wrapper } from '../types/core';
import type { Module } from '../types/core-modules'; import type { Module } from '../types/core-modules';
import { existsSync } from 'fs'; import { existsSync } from 'fs';
import type { Logging } from './contracts/logging';
export const shouldHandle = (path: string, fpath: string) => { export const shouldHandle = (path: string, fpath: string) => {
const file_name = fpath+extname(path); const file_name = fpath+extname(path);
@@ -18,6 +19,7 @@ export const shouldHandle = (path: string, fpath: string) => {
export type ModuleResult<T> = Promise<ImportPayload<T>>; export type ModuleResult<T> = Promise<ImportPayload<T>>;
/** /**
* Import any module based on the absolute path. * Import any module based on the absolute path.
* This can accept four types of exported modules * This can accept four types of exported modules
@@ -104,13 +106,13 @@ async function* readPaths(dir: string): AsyncGenerator<string> {
} }
} }
const requir = createRequire(import.meta.url); export const requir = createRequire(import.meta.url);
export function loadConfig(wrapper: Wrapper | 'file'): Wrapper { export function loadConfig(wrapper: Wrapper | 'file', log: Logging | undefined): Wrapper {
if (wrapper !== 'file') { if (wrapper !== 'file') {
return wrapper; return wrapper;
} }
console.log('Experimental loading of sern.config.json'); log?.info({ message: 'Experimental loading of sern.config.json'});
const config = requir(resolve('sern.config.json')); const config = requir(resolve('sern.config.json'));
const makePath = (dir: PropertyKey) => const makePath = (dir: PropertyKey) =>
@@ -118,14 +120,14 @@ export function loadConfig(wrapper: Wrapper | 'file'): Wrapper {
? join('dist', config.paths[dir]!) ? join('dist', config.paths[dir]!)
: join(config.paths[dir]!); : join(config.paths[dir]!);
console.log('Loading config: ', config); log?.info({ message: 'Loading config: ' + JSON.stringify(config, null, 4) });
const commandsPath = makePath('commands'); const commandsPath = makePath('commands');
console.log('Commands path is set to', commandsPath); log?.info({ message: `Commands path is set to ${commandsPath}` });
let eventsPath: string | undefined; let eventsPath: string | undefined;
if (config.paths.events) { if (config.paths.events) {
eventsPath = makePath('events'); eventsPath = makePath('events');
console.log('Events path is set to', eventsPath); log?.info({ message: `Events path is set to ${eventsPath} `});
} }
return { defaultPrefix: config.defaultPrefix, return { defaultPrefix: config.defaultPrefix,

View File

@@ -71,8 +71,7 @@ export function handleError<C>(crashHandler: ErrorHandling, logging?: Logging) {
} }
// Temporary until i get rxjs operators working on ts-results-es // Temporary until i get rxjs operators working on ts-results-es
export const filterTap = <K, R>(onErr: (e: R) => void): OperatorFunction<Result<K, R>, K> => export const filterTap = <K, R>(onErr: (e: R) => void): OperatorFunction<Result<K, R>, K> =>
pipe( pipe(concatMap(result => {
concatMap(result => {
if(result.isOk()) { if(result.isOk()) {
return of(result.value) return of(result.value)
} }

View File

@@ -1,34 +0,0 @@
import type {
AnySelectMenuInteraction,
AutocompleteInteraction,
ButtonInteraction,
ChatInputCommandInteraction,
MessageContextMenuCommandInteraction,
ModalSubmitInteraction,
UserContextMenuCommandInteraction,
} from 'discord.js';
import { InteractionType } from 'discord.js';
interface InteractionTypable {
type: InteractionType;
}
//discord.js pls fix ur typings or i will >:(
type AnyMessageComponentInteraction = AnySelectMenuInteraction | ButtonInteraction;
type AnyCommandInteraction =
| ChatInputCommandInteraction
| MessageContextMenuCommandInteraction
| UserContextMenuCommandInteraction;
export function isMessageComponent(i: InteractionTypable): i is AnyMessageComponentInteraction {
return i.type === InteractionType.MessageComponent;
}
export function isCommand(i: InteractionTypable): i is AnyCommandInteraction {
return i.type === InteractionType.ApplicationCommand;
}
export function isAutocomplete(i: InteractionTypable): i is AutocompleteInteraction {
return i.type === InteractionType.ApplicationCommandAutocomplete;
}
export function isModal(i: InteractionTypable): i is ModalSubmitInteraction {
return i.type === InteractionType.ModalSubmit;
}

View File

@@ -1,4 +1,4 @@
import { import type {
BaseInteraction, BaseInteraction,
ChatInputCommandInteraction, ChatInputCommandInteraction,
Client, Client,

View File

@@ -1,5 +1,5 @@
export { CommandType, PluginType, PayloadType, EventType } from './enums'; export { CommandType, PluginType, PayloadType, EventType } from './enums';
export * from './context'; export * from './context';
export * from './sern-emitter';
export * from './services'; export * from './services';
export * from './module-store'; export * from './module-store';

View File

@@ -1,12 +1,11 @@
import { CommandMeta, Module } from '../../types/core-modules'; import { CommandMeta, Module } from '../../types/core-modules';
import { CoreModuleStore } from '../contracts';
/* /*
* @internal * @deprecated
* Version 4.0.0 will internalize this api. Please refrain from using ModuleStore! * Version 4.0.0 will internalize this api. Please refrain from using ModuleStore!
* For interacting with modules, use the ModuleManager instead. * For interacting with modules, use the ModuleManager instead.
*/ */
export class ModuleStore implements CoreModuleStore { export class ModuleStore {
metadata = new WeakMap<Module, CommandMeta>(); metadata = new WeakMap<Module, CommandMeta>();
commands = new Map<string, string>(); commands = new Map<string, string>();
} }

View File

@@ -1,89 +0,0 @@
import { EventEmitter } from 'node:events';
import { PayloadType } from '../../core/structures';
import { Module } from '../../types/core-modules';
import { SernEventsMapping, Payload } from '../../types/utility';
/**
* @since 1.0.0
*/
export class SernEmitter extends EventEmitter {
constructor() {
super({ captureRejections: true });
}
/**
* Listening to sern events with on. This event stays on until a crash or a normal exit
* @param eventName
* @param listener what to do with the data
*/
public override on<T extends keyof SernEventsMapping>(
eventName: T,
listener: (...args: SernEventsMapping[T][]) => void,
): this {
return super.on(eventName, listener);
}
/**
* Listening to sern events with on. This event stays on until a crash or a normal exit
* @param eventName
* @param listener what to do with the data
*/
public override once<T extends keyof SernEventsMapping>(
eventName: T,
listener: (...args: SernEventsMapping[T][]) => void,
): this {
return super.once(eventName, listener);
}
/**
* Listening to sern events with on. This event stays on until a crash or a normal exit
* @param eventName
* @param args the arguments for emitting the eventName
*/
public override emit<T extends keyof SernEventsMapping>(
eventName: T,
...args: SernEventsMapping[T]
): boolean {
return super.emit(eventName, ...args);
}
private static payload<T extends Payload>(
type: PayloadType,
module?: Module,
reason?: unknown,
) {
return { type, module, reason } as T;
}
/**
* Creates a compliant SernEmitter failure payload
* @param module
* @param reason
*/
static failure(module?: Module, reason?: unknown) {
//The generic cast Payload & { type : PayloadType.* } coerces the type to be a failure payload
// same goes to the other methods below
return SernEmitter.payload<Payload & { type: PayloadType.Failure }>(
PayloadType.Failure,
module,
reason,
);
}
/**
* Creates a compliant SernEmitter module success payload
* @param module
*/
static success(module: Module) {
return SernEmitter.payload<Payload & { type: PayloadType.Success }>(
PayloadType.Success,
module,
);
}
/**
* Creates a compliant SernEmitter module warning payload
* @param reason
*/
static warning(reason: unknown) {
return SernEmitter.payload<Payload & { type: PayloadType.Warning }>(
PayloadType.Warning,
undefined,
reason,
);
}
}

View File

@@ -85,10 +85,7 @@ export function createDispatcher(payload: {
args: [payload.event], args: [payload.event],
}; };
} }
return { return { module: payload.module, args: contextArgs(payload.event) };
module: payload.module,
args: contextArgs(payload.event),
};
} }
default: return { default: return {
module: payload.module, module: payload.module,

View File

@@ -21,11 +21,11 @@ import {
handleError, handleError,
SernError, SernError,
VoidResult, VoidResult,
resultPayload,
} from '../core/_internal'; } from '../core/_internal';
import { Emitter, ErrorHandling, Logging, ModuleManager } from '../core'; import { Emitter, ErrorHandling, Logging, ModuleManager, PayloadType } from '../core';
import { contextArgs, createDispatcher } from './dispatchers'; import { contextArgs, createDispatcher } from './dispatchers';
import { ObservableInput, pipe } from 'rxjs'; import { ObservableInput, pipe } from 'rxjs';
import { SernEmitter } from '../core';
import { Err, Ok, Result } from 'ts-results-es'; import { Err, Ok, Result } from 'ts-results-es';
import type { Awaitable } from '../types/utility'; import type { Awaitable } from '../types/utility';
import type { ControlPlugin } from '../types/core-plugin'; import type { ControlPlugin } from '../types/core-plugin';
@@ -86,8 +86,7 @@ export function createInteractionHandler<T extends Interaction>(
module: payload.module, module: payload.module,
event, event,
}))); })));
}, });
);
} }
export function createMessageHandler( export function createMessageHandler(
@@ -168,10 +167,10 @@ export function executeModule(
concatMap(() => Result.wrapAsync(async () => task())), concatMap(() => Result.wrapAsync(async () => task())),
concatMap(result => { concatMap(result => {
if (result.isOk()) { if (result.isOk()) {
emitter.emit('module.activate', SernEmitter.success(module)); emitter.emit('module.activate', resultPayload(PayloadType.Success, module));
return EMPTY; return EMPTY;
} }
return throwError(() => SernEmitter.failure(module, result.error)); return throwError(() => resultPayload(PayloadType.Failure, module, result.error));
}), }),
); );
@@ -218,13 +217,10 @@ export function callInitPlugins<T extends Processed<AnyModule>>(sernEmitter: Emi
createResultResolver({ createResultResolver({
createStream: args => from(args.module.plugins).pipe(callPlugin(args)), createStream: args => from(args.module.plugins).pipe(callPlugin(args)),
onStop: (module: T) => { onStop: (module: T) => {
sernEmitter.emit( sernEmitter.emit('module.register', resultPayload(PayloadType.Failure, module, SernError.PluginFailure));
'module.register',
SernEmitter.failure(module, SernError.PluginFailure),
);
}, },
onNext: ({ module }) => { onNext: ({ module }) => {
sernEmitter.emit('module.register', SernEmitter.success(module)); sernEmitter.emit('module.register', resultPayload(PayloadType.Success, module));
return { module }; return { module };
}, },
}), }),

View File

@@ -1,6 +1,6 @@
import { Interaction } from 'discord.js'; import { Interaction } from 'discord.js';
import { mergeMap, merge } from 'rxjs'; import { mergeMap, merge } from 'rxjs';
import { SernEmitter } from '../core'; import { PayloadType } from '../core';
import { import {
isAutocomplete, isAutocomplete,
isCommand, isCommand,
@@ -9,6 +9,7 @@ import {
sharedEventStream, sharedEventStream,
SernError, SernError,
filterTap, filterTap,
resultPayload,
} from '../core/_internal'; } from '../core/_internal';
import { createInteractionHandler, executeModule, makeModuleExecutor } from './_internal'; import { createInteractionHandler, executeModule, makeModuleExecutor } from './_internal';
import type { DependencyList } from '../types/ioc'; import type { DependencyList } from '../types/ioc';
@@ -25,8 +26,8 @@ export function interactionHandler([emitter, err, log, modules, client]: Depende
); );
return interactionHandler$ return interactionHandler$
.pipe( .pipe(
filterTap(e => emitter.emit('warning', SernEmitter.warning(e))), filterTap(e => emitter.emit('warning', resultPayload(PayloadType.Warning, undefined, e))),
makeModuleExecutor(module => makeModuleExecutor(module =>
emitter.emit('module.activate', SernEmitter.failure(module, SernError.PluginFailure))), emitter.emit('module.activate', resultPayload(PayloadType.Failure, module, SernError.PluginFailure))),
mergeMap(payload => executeModule(emitter, log, err, payload))); mergeMap(payload => executeModule(emitter, log, err, payload)));
} }

View File

@@ -1,7 +1,7 @@
import { mergeMap, EMPTY } from 'rxjs'; import { mergeMap, EMPTY } from 'rxjs';
import type { Message } from 'discord.js'; import type { Message } from 'discord.js';
import { SernEmitter } from '../core'; import { PayloadType } from '../core';
import { sharedEventStream, SernError, filterTap } from '../core/_internal'; import { sharedEventStream, SernError, filterTap, resultPayload } from '../core/_internal';
import { createMessageHandler, executeModule, makeModuleExecutor } from './_internal'; import { createMessageHandler, executeModule, makeModuleExecutor } from './_internal';
import type { DependencyList } from '../types/ioc'; import type { DependencyList } from '../types/ioc';
@@ -38,9 +38,10 @@ export function messageHandler(
const msgCommands$ = handle(isNonBot(defaultPrefix)); const msgCommands$ = handle(isNonBot(defaultPrefix));
return msgCommands$.pipe( return msgCommands$.pipe(
filterTap((e) => emitter.emit('warning', SernEmitter.warning(e))), filterTap((e) => emitter.emit('warning', resultPayload(PayloadType.Warning, undefined, e))),
makeModuleExecutor(module => { makeModuleExecutor(module => {
emitter.emit('module.activate', SernEmitter.failure(module, SernError.PluginFailure)); const result = resultPayload(PayloadType.Failure, module, SernError.PluginFailure);
emitter.emit('module.activate', result);
}), }),
mergeMap(payload => executeModule(emitter, log, err, payload))); mergeMap(payload => executeModule(emitter, log, err, payload)));
} }

View File

@@ -19,7 +19,6 @@ const parseConfig = async (conf: Promise<Presence.Result>) => {
.pipe(scan(onRepeat, s), .pipe(scan(onRepeat, s),
startWith(s)); startWith(s));
} }
//take 1?
return of(s).pipe(take(1)); return of(s).pipe(take(1));
}) })
}; };
@@ -37,7 +36,7 @@ export const presenceHandler = (path: string, setPresence: SetPresence) => {
}) })
const module$ = from(presence); const module$ = from(presence);
return module$.pipe( return module$.pipe(
//compose:. //compose:
//call the execute function, passing that result into parseConfig. //call the execute function, passing that result into parseConfig.
//concatMap resolves the promise, and passes it to the next concatMap. //concatMap resolves the promise, and passes it to the next concatMap.
concatMap(fn => parseConfig(fn())), concatMap(fn => parseConfig(fn())),

View File

@@ -9,7 +9,7 @@ import * as util from 'node:util';
import type { DependencyList } from '../types/ioc'; import type { DependencyList } from '../types/ioc';
import type { AnyModule, Processed } from '../types/core-modules'; import type { AnyModule, Processed } from '../types/core-modules';
export function startReadyEvent( export function readyHandler(
[sEmitter, , , moduleManager, client]: DependencyList, [sEmitter, , , moduleManager, client]: DependencyList,
allPaths: ObservableInput<string>, allPaths: ObservableInput<string>,
) { ) {

View File

@@ -1,11 +1,11 @@
import { handleCrash } from './handlers/_internal'; import { handleCrash } from './handlers/_internal';
import callsites from 'callsites'; import callsites from 'callsites';
import { err, ok, Files } from './core/_internal'; import { Files } from './core/_internal';
import { merge } from 'rxjs'; import { merge } from 'rxjs';
import { Services } from './core/ioc'; import { Services } from './core/ioc';
import { Wrapper } from './types/core'; import { Wrapper } from './types/core';
import { eventsHandler } from './handlers/user-defined-events'; import { eventsHandler } from './handlers/user-defined-events';
import { startReadyEvent } from './handlers/ready-event'; import { readyHandler } from './handlers/ready-event';
import { messageHandler } from './handlers/message-event'; import { messageHandler } from './handlers/message-event';
import { interactionHandler } from './handlers/interaction-event'; import { interactionHandler } from './handlers/interaction-event';
import { presenceHandler } from './handlers/presence'; import { presenceHandler } from './handlers/presence';
@@ -23,14 +23,17 @@ import { Client } from 'discord.js';
* }) * })
* ``` * ```
*/ */
export function init(maybeWrapper: Wrapper | 'file') { export function init(maybeWrapper: Wrapper | 'file') {
const startTime = performance.now(); const startTime = performance.now();
const wrapper = Files.loadConfig(maybeWrapper); const dependencies = Services('@sern/emitter',
const dependencies = useDependencies(); '@sern/errors',
'@sern/logger',
'@sern/modules',
'@sern/client');
const logger = dependencies[2], const logger = dependencies[2],
errorHandler = dependencies[1]; errorHandler = dependencies[1];
const wrapper = Files.loadConfig(maybeWrapper, logger);
if (wrapper.events !== undefined) { if (wrapper.events !== undefined) {
eventsHandler(dependencies, Files.getFullPathTree(wrapper.events)); eventsHandler(dependencies, Files.getFullPathTree(wrapper.events));
} }
@@ -38,7 +41,7 @@ export function init(maybeWrapper: Wrapper | 'file') {
const initCallsite = callsites()[1].getFileName(); const initCallsite = callsites()[1].getFileName();
const presencePath = Files.shouldHandle(initCallsite!, "presence"); const presencePath = Files.shouldHandle(initCallsite!, "presence");
//Ready event: load all modules and when finished, time should be taken and logged //Ready event: load all modules and when finished, time should be taken and logged
startReadyEvent(dependencies, Files.getFullPathTree(wrapper.commands)) readyHandler(dependencies, Files.getFullPathTree(wrapper.commands))
.add(() => { .add(() => {
const time = ((performance.now() - startTime) / 1000).toFixed(2); const time = ((performance.now() - startTime) / 1000).toFixed(2);
dependencies[0].emit('modulesLoaded'); dependencies[0].emit('modulesLoaded');
@@ -56,15 +59,3 @@ export function init(maybeWrapper: Wrapper | 'file') {
// listening to the message stream and interaction stream // listening to the message stream and interaction stream
merge(messages$, interactions$).pipe(handleCrash(errorHandler, logger)).subscribe(); merge(messages$, interactions$).pipe(handleCrash(errorHandler, logger)).subscribe();
} }
function useDependencies() {
return Services(
'@sern/emitter',
'@sern/errors',
'@sern/logger',
'@sern/modules',
'@sern/client',
);
}

View File

@@ -20,7 +20,6 @@ import { AnyCommandPlugin, AnyEventPlugin, ControlPlugin, InitPlugin } from './c
import { Awaitable, Args, SlashOptions, SernEventsMapping } from './utility'; import { Awaitable, Args, SlashOptions, SernEventsMapping } from './utility';
export interface CommandMeta { export interface CommandMeta {
fullPath: string; fullPath: string;
id: string; id: string;

View File

@@ -33,9 +33,9 @@ import type {
TextCommand, TextCommand,
UserSelectCommand, UserSelectCommand,
} from './core-modules'; } from './core-modules';
import { Args, Awaitable, Payload, SlashOptions } from './utility'; import type { Args, Awaitable, Payload, SlashOptions } from './utility';
import { CommandType, Context, EventType, PluginType } from '../core'; import type { CommandType, Context, EventType, PluginType } from '../core';
import { import type {
ButtonInteraction, ButtonInteraction,
ChannelSelectMenuInteraction, ChannelSelectMenuInteraction,
ClientEvents, ClientEvents,

View File

@@ -26,11 +26,15 @@ export type DependencyList = [
export interface CoreDependencies { export interface CoreDependencies {
'@sern/client': () => Contracts.Emitter; '@sern/client': () => Contracts.Emitter;
'@sern/logger'?: () => Contracts.Logging;
'@sern/emitter': () => Contracts.Emitter; '@sern/emitter': () => Contracts.Emitter;
/**
* @deprecated
* Will be removed and turned internal
*/
'@sern/store': () => Contracts.CoreModuleStore; '@sern/store': () => Contracts.CoreModuleStore;
'@sern/modules': () => Contracts.ModuleManager; '@sern/modules': () => Contracts.ModuleManager;
'@sern/errors': () => Contracts.ErrorHandling; '@sern/errors': () => Contracts.ErrorHandling;
'@sern/logger'?: () => Contracts.Logging;
} }
export type DependencyFromKey<T extends keyof Dependencies> = Dependencies[T]; export type DependencyFromKey<T extends keyof Dependencies> = Dependencies[T];
@@ -39,8 +43,13 @@ export type IntoDependencies<Tuple extends [...any[]]> = {
[Index in keyof Tuple]: UnpackFunction<NonNullable<DependencyFromKey<Tuple[Index]>>>; //Unpack and make NonNullable [Index in keyof Tuple]: UnpackFunction<NonNullable<DependencyFromKey<Tuple[Index]>>>; //Unpack and make NonNullable
} & { length: Tuple['length'] }; } & { length: Tuple['length'] };
/**
* @deprecated This old signature will be incompatible with future versions of sern.
*/
export interface DependencyConfiguration { export interface DependencyConfiguration {
//@deprecated. Loggers will always be included in the future /*
* @deprecated. Loggers will be opt-in the future
*/
exclude?: Set<'@sern/logger'>; exclude?: Set<'@sern/logger'>;
build: ( build: (
root: Container<Omit<CoreDependencies, '@sern/client'>, {}>, root: Container<Omit<CoreDependencies, '@sern/client'>, {}>,

View File

@@ -29,5 +29,4 @@ export type Payload =
| { type: PayloadType.Warning; reason: string }; | { type: PayloadType.Warning; reason: string };
export type ReplyOptions = string | Omit<InteractionReplyOptions, 'fetchReply'> | MessageReplyOptions; export type ReplyOptions = string | Omit<InteractionReplyOptions, 'fetchReply'> | MessageReplyOptions;

64
test/core/id.test.ts Normal file
View File

@@ -0,0 +1,64 @@
import { CommandType } from '../../src/core';
import * as Id from '../../src/core/id'
import { expect, test } from 'vitest'
test('id -> Text', () => {
const bothCmdId = Id.create("ping", CommandType.Text)
expect(bothCmdId).toBe("ping_T")
})
test('id -> Both', () => {
const bothCmdId = Id.create("ping", CommandType.Both)
expect(bothCmdId).toBe("ping_B")
})
test('id -> CtxMsg', () => {
const bothCmdId = Id.create("ping", CommandType.CtxMsg)
expect(bothCmdId).toBe("ping_A3")
})
test('id -> CtxUsr', () => {
const bothCmdId = Id.create("ping", CommandType.CtxUser)
expect(bothCmdId).toBe("ping_A2")
})
test('id -> Modal', () => {
const modal = Id.create("my-modal", CommandType.Modal)
expect(modal).toBe("my-modal_M");
})
test('id -> Button', () => {
const modal = Id.create("my-button", CommandType.Button)
expect(modal).toBe("my-button_C2");
})
test('id -> Slash', () => {
const modal = Id.create("myslash", CommandType.Slash)
expect(modal).toBe("myslash_A1");
})
test('id -> StringSelect', () => {
const modal = Id.create("mystringselect", CommandType.StringSelect)
expect(modal).toBe("mystringselect_C3");
})
test('id -> UserSelect', () => {
const modal = Id.create("myuserselect", CommandType.UserSelect)
expect(modal).toBe("myuserselect_C5");
})
test('id -> RoleSelect', () => {
const modal = Id.create("myroleselect", CommandType.RoleSelect)
expect(modal).toBe("myroleselect_C6");
})
test('id -> MentionSelect', () => {
const modal = Id.create("mymentionselect", CommandType.MentionableSelect)
expect(modal).toBe("mymentionselect_C7");
})
test('id -> ChannelSelect', () => {
const modal = Id.create("mychannelselect", CommandType.ChannelSelect)
expect(modal).toBe("mychannelselect_C8");
})

View File

@@ -1,12 +1,13 @@
import { beforeEach, describe, expect, it, vi } from 'vitest'; import { beforeEach, describe, expect, it, vi } from 'vitest';
import { CoreContainer } from '../../src/core/ioc/container'; import { CoreContainer } from '../../src/core/ioc/container';
import { EventEmitter } from 'events'; import { EventEmitter } from 'events';
import { DefaultLogging, Disposable, Init, Logging } from '../../src/core'; import { DefaultLogging, Disposable, Emitter, Init, Logging } from '../../src/core';
import { CoreDependencies } from '../../src/types/ioc'; import { CoreDependencies } from '../../src/types/ioc';
describe('ioc container', () => { describe('ioc container', () => {
let container: CoreContainer<{}> = new CoreContainer(); let container: CoreContainer<{}> = new CoreContainer();
let dependency: Logging & Init & Disposable; let dependency: Logging & Init & Disposable;
let dependency2: Emitter
beforeEach(() => { beforeEach(() => {
dependency = { dependency = {
init: vi.fn(), init: vi.fn(),
@@ -16,6 +17,11 @@ describe('ioc container', () => {
debug(): void {}, debug(): void {},
dispose: vi.fn() dispose: vi.fn()
}; };
dependency2 = {
addListener: vi.fn(),
removeListener: vi.fn(),
emit: vi.fn()
};
container = new CoreContainer(); container = new CoreContainer();
}); });
const wait = (seconds: number) => new Promise((resolve) => setTimeout(resolve, seconds)); const wait = (seconds: number) => new Promise((resolve) => setTimeout(resolve, seconds));
@@ -83,4 +89,13 @@ describe('ioc container', () => {
container.ready(); container.ready();
expect(dependency.init).toHaveBeenCalledTimes(0); expect(dependency.init).toHaveBeenCalledTimes(0);
}); });
it('should init dependency depending on something else', () => {
container.add({ '@sern/client': dependency2 });
container.upsert((cntr) => ({
'@sern/logger': dependency
}));
container.ready();
expect(dependency.init).toHaveBeenCalledTimes(1);
})
}); });

View File

@@ -74,4 +74,7 @@ describe('services', () => {
expect(consoleMock).toHaveBeenCalledOnce(); expect(consoleMock).toHaveBeenCalledOnce();
expect(consoleMock).toHaveBeenLastCalledWith({ message: 'error' }); expect(consoleMock).toHaveBeenLastCalledWith({ message: 'error' });
}); });
}); });

View File

@@ -629,7 +629,6 @@ __metadata:
"@typescript-eslint/parser": 5.59.1 "@typescript-eslint/parser": 5.59.1
callsites: ^3.1.0 callsites: ^3.1.0
discord.js: ^14.11.0 discord.js: ^14.11.0
esbuild: ^0.17.0
eslint: 8.39.0 eslint: 8.39.0
iti: ^0.6.0 iti: ^0.6.0
prettier: 2.8.8 prettier: 2.8.8
@@ -1449,7 +1448,7 @@ __metadata:
languageName: node languageName: node
linkType: hard linkType: hard
"esbuild@npm:^0.17.0, esbuild@npm:^0.17.6": "esbuild@npm:^0.17.6":
version: 0.17.19 version: 0.17.19
resolution: "esbuild@npm:0.17.19" resolution: "esbuild@npm:0.17.19"
dependencies: dependencies: