fix(core): Fix state initialization, hash detection, and validation - v2.0.25
Some checks failed
Default (tags) / security (push) Successful in 42s
Default (tags) / test (push) Successful in 1m8s
Default (tags) / release (push) Failing after 59s
Default (tags) / metadata (push) Successful in 1m8s

This commit is contained in:
2025-07-29 19:26:03 +00:00
parent 09fc53aaff
commit 02575e8baf
8 changed files with 370 additions and 61 deletions

View File

@@ -13,9 +13,10 @@ export class Smartstate<StatePartNameType extends string> {
/**
* Allows getting and initializing a new statepart
* initMode === 'soft' it will allow existing stateparts
* initMode === 'mandatory' will fail if there is an existing statepart
* initMode === 'force' will overwrite any existing statepart
* initMode === 'soft' (default) - returns existing statepart if exists, creates new if not
* initMode === 'mandatory' - requires statepart to not exist, fails if it does
* initMode === 'force' - always creates new statepart, overwriting any existing
* initMode === 'persistent' - like 'soft' but with webstore persistence
* @param statePartNameArg
* @param initialArg
* @param initMode
@@ -23,19 +24,30 @@ export class Smartstate<StatePartNameType extends string> {
public async getStatePart<PayloadType>(
statePartNameArg: StatePartNameType,
initialArg?: PayloadType,
initMode?: TInitMode
initMode: TInitMode = 'soft'
): Promise<StatePart<StatePartNameType, PayloadType>> {
if (this.statePartMap[statePartNameArg]) {
if (initialArg && (!initMode || initMode !== 'soft')) {
throw new Error(
`${statePartNameArg} already exists, yet you try to set an initial state again`
);
const existingStatePart = this.statePartMap[statePartNameArg];
if (existingStatePart) {
switch (initMode) {
case 'mandatory':
throw new Error(
`State part '${statePartNameArg}' already exists, but initMode is 'mandatory'`
);
case 'force':
// Force mode: create new state part
return this.createStatePart<PayloadType>(statePartNameArg, initialArg, initMode);
case 'soft':
case 'persistent':
default:
// Return existing state part
return existingStatePart as StatePart<StatePartNameType, PayloadType>;
}
return this.statePartMap[statePartNameArg] as StatePart<StatePartNameType, PayloadType>;
} else {
// State part doesn't exist
if (!initialArg) {
throw new Error(
`${statePartNameArg} does not yet exist, yet you don't provide an initial state`
`State part '${statePartNameArg}' does not exist and no initial state provided`
);
}
return this.createStatePart<PayloadType>(statePartNameArg, initialArg, initMode);
@@ -46,11 +58,12 @@ export class Smartstate<StatePartNameType extends string> {
* Creates a statepart
* @param statePartName
* @param initialPayloadArg
* @param initMode
*/
private async createStatePart<PayloadType>(
statePartName: StatePartNameType,
initialPayloadArg: PayloadType,
initMode?: TInitMode
initMode: TInitMode = 'soft'
): Promise<StatePart<StatePartNameType, PayloadType>> {
const newState = new StatePart<StatePartNameType, PayloadType>(
statePartName,
@@ -64,8 +77,8 @@ export class Smartstate<StatePartNameType extends string> {
await newState.init();
const currentState = newState.getState();
await newState.setState({
...initialPayloadArg,
...currentState,
...initialPayloadArg,
});
this.statePartMap[statePartName] = newState;
return newState;

View File

@@ -4,7 +4,7 @@ import { StateAction, type IActionDef } from './smartstate.classes.stateaction.j
export class StatePart<TStatePartName, TStatePayload> {
public name: TStatePartName;
public state = new plugins.smartrx.rxjs.Subject<TStatePayload>();
public stateStore: TStatePayload;
public stateStore: TStatePayload | undefined;
private cumulativeDeferred = plugins.smartpromise.cumulativeDefer();
private webStoreOptions: plugins.webstore.IWebStoreOptions;
@@ -27,9 +27,9 @@ export class StatePart<TStatePartName, TStatePayload> {
this.webStore = new plugins.webstore.WebStore<TStatePayload>(this.webStoreOptions);
await this.webStore.init();
const storedState = await this.webStore.get(String(this.name));
if (storedState) {
if (storedState && this.validateState(storedState)) {
this.stateStore = storedState;
this.notifyChange();
await this.notifyChange();
}
}
}
@@ -37,7 +37,7 @@ export class StatePart<TStatePartName, TStatePayload> {
/**
* gets the state from the state store
*/
public getState(): TStatePayload {
public getState(): TStatePayload | undefined {
return this.stateStore;
}
@@ -46,8 +46,13 @@ export class StatePart<TStatePartName, TStatePayload> {
* @param newStateArg
*/
public async setState(newStateArg: TStatePayload) {
// Validate state structure
if (!this.validateState(newStateArg)) {
throw new Error(`Invalid state structure for state part '${this.name}'`);
}
this.stateStore = newStateArg;
this.notifyChange();
await this.notifyChange();
// Save state to WebStore if initialized
if (this.webStore) {
@@ -56,21 +61,34 @@ export class StatePart<TStatePartName, TStatePayload> {
return this.stateStore;
}
/**
* Validates state structure - can be overridden for custom validation
* @param stateArg
*/
protected validateState(stateArg: any): stateArg is TStatePayload {
// Basic validation - ensure state is not null/undefined
// Subclasses can override for more specific validation
return stateArg !== null && stateArg !== undefined;
}
/**
* notifies of a change on the state
*/
public notifyChange() {
const createStateHash = (stateArg: any) => {
return plugins.smarthashWeb.sha256FromString(plugins.smartjson.stringify(stateArg));
public async notifyChange() {
if (!this.stateStore) {
return;
}
const createStateHash = async (stateArg: any) => {
return await plugins.smarthashWeb.sha256FromString(plugins.smartjson.stringify(stateArg));
};
const currentHash = await createStateHash(this.stateStore);
if (
this.stateStore &&
this.lastStateNotificationPayloadHash &&
createStateHash(this.stateStore) === this.lastStateNotificationPayloadHash
currentHash === this.lastStateNotificationPayloadHash
) {
return;
} else {
this.lastStateNotificationPayloadHash = this.stateStore;
this.lastStateNotificationPayloadHash = currentHash;
}
this.state.next(this.stateStore);
}
@@ -81,7 +99,11 @@ export class StatePart<TStatePartName, TStatePayload> {
*/
public notifyChangeCumulative() {
// TODO: check viability
setTimeout(() => this.state.next(this.stateStore), 0);
setTimeout(async () => {
if (this.stateStore) {
await this.notifyChange();
}
}, 0);
}
/**
@@ -95,6 +117,7 @@ export class StatePart<TStatePartName, TStatePayload> {
}
const mapped = this.state.pipe(
plugins.smartrx.rxjs.ops.startWith(this.getState()),
plugins.smartrx.rxjs.ops.filter((stateArg): stateArg is TStatePayload => stateArg !== undefined),
plugins.smartrx.rxjs.ops.map((stateArg) => {
try {
return selectorFn(stateArg);