Skip to content
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.

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

Add validation for invalid memory references #131

Merged
merged 2 commits into from
May 8, 2024
Merged
Changes from all commits
Commits
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
21 changes: 13 additions & 8 deletions src/webview/components/options-widget.tsx
Original file line number Diff line number Diff line change
@@ -28,7 +28,7 @@ import { MemoryOptions, ReadMemoryArguments, SessionContext } from '../../common
import { tryToNumber } from '../../common/typescript';
import { CONFIG_BYTES_PER_MAU_CHOICES, CONFIG_GROUPS_PER_ROW_CHOICES, CONFIG_MAUS_PER_GROUP_CHOICES } from '../../plugin/manifest';
import { TableRenderOptions } from '../columns/column-contribution-service';
import { AddressPaddingOptions, MemoryState, SerializedTableRenderOptions } from '../utils/view-types';
import { AddressPaddingOptions, DEFAULT_READ_ARGUMENTS, MemoryState, SerializedTableRenderOptions } from '../utils/view-types';
import { createSectionVscodeContext } from '../utils/vscode-contexts';
import { MultiSelectWithLabel } from './multi-select';

@@ -105,7 +105,7 @@ export class OptionsWidget extends React.Component<OptionsWidgetProps, OptionsWi

protected validate = (values: OptionsForm) => {
const errors: FormikErrors<OptionsForm> = {};
const addressError = values.address.trim().length === 0 ? 'Required' : validateMemoryReference(values.address);
const addressError = values.address.trim().length === 0 ? 'Required' : validateMemoryReference(values.address.trim());
if (addressError) {
errors.address = addressError;
}
@@ -120,11 +120,14 @@ export class OptionsWidget extends React.Component<OptionsWidgetProps, OptionsWi
return errors;
};

componentDidUpdate(_: Readonly<OptionsWidgetProps>, prevState: Readonly<OptionsWidgetState>): void {
componentDidUpdate(prevProps: Readonly<OptionsWidgetProps>, prevState: Readonly<OptionsWidgetState>): void {
if (!prevState.isTitleEditing && this.state.isTitleEditing) {
this.labelEditInput.current?.focus();
this.labelEditInput.current?.select();
}
if (prevProps.activeReadArguments === DEFAULT_READ_ARGUMENTS) {
this.formConfig.initialErrors = this.validate(this.optionsFormValues);
}
}

override render(): React.ReactNode {
@@ -134,9 +137,11 @@ export class OptionsWidget extends React.Component<OptionsWidgetProps, OptionsWi
const readDisabled = isFrozen || !this.props.sessionContext.canRead;
const freezeContentToggleTitle = isFrozen ? 'Unfreeze Memory View' : 'Freeze Memory View';
const activeMemoryReadArgumentHint = (userValue: string | number, memoryValue: string | number): ReactNode | undefined => {
if (userValue !== memoryValue) {
return <small className="form-options-memory-read-argument-hint">Actual: {memoryValue}</small>;
if (userValue === memoryValue || this.props.activeReadArguments === DEFAULT_READ_ARGUMENTS) {
return undefined;
}
return <small className="form-options-memory-read-argument-hint">Actual: {memoryValue}</small>;

};

return (
@@ -438,12 +443,12 @@ export class OptionsWidget extends React.Component<OptionsWidgetProps, OptionsWi
this.props.updateMemoryState({
configuredReadArguments: {
...this.props.configuredReadArguments,
memoryReference: value,
memoryReference: value.trim(),
}
});
break;
case InputId.Offset:
if (!Number.isNaN(value)) {
if (!!value && !Number.isNaN(value)) {
this.props.updateMemoryState({
configuredReadArguments: {
...this.props.configuredReadArguments,
@@ -453,7 +458,7 @@ export class OptionsWidget extends React.Component<OptionsWidgetProps, OptionsWi
}
break;
case InputId.Length:
if (!Number.isNaN(value)) {
if (!!value && !Number.isNaN(value)) {
this.props.updateMemoryState({
configuredReadArguments: {
...this.props.configuredReadArguments,
17 changes: 8 additions & 9 deletions src/webview/memory-webview-view.tsx
Original file line number Diff line number Diff line change
@@ -28,7 +28,6 @@ import {
logMessageType,
MemoryOptions,
memoryWrittenType,
ReadMemoryArguments,
readMemoryType,
readyType,
resetMemoryViewSettingsType,
@@ -51,7 +50,7 @@ import { AddressHover } from './hovers/address-hover';
import { DataHover } from './hovers/data-hover';
import { hoverService, HoverService } from './hovers/hover-service';
import { VariableHover } from './hovers/variable-hover';
import { Decoration, MemoryDisplayConfiguration, MemoryState } from './utils/view-types';
import { Decoration, DEFAULT_READ_ARGUMENTS, MemoryDisplayConfiguration, MemoryState } from './utils/view-types';
import { variableDecorator } from './variables/variable-decorations';
import { messenger } from './view-messenger';

@@ -82,12 +81,6 @@ const MEMORY_DISPLAY_CONFIGURATION_DEFAULTS: MemoryDisplayConfiguration = {
showRadixPrefix: true,
};

const DEFAULT_READ_ARGUMENTS: Required<ReadMemoryArguments> = {
memoryReference: '',
offset: 0,
count: 256,
};

class App extends React.Component<{}, MemoryAppState> {
protected memoryWidget = React.createRef<MemoryWidget>();

@@ -249,13 +242,19 @@ class App extends React.Component<{}, MemoryAppState> {
if (this.state.isFrozen) {
return;
}
this.setState(prev => ({ ...prev, isMemoryFetching: true }));
const completeOptions = {
memoryReference: partialOptions?.memoryReference || this.state.activeReadArguments.memoryReference,
offset: partialOptions?.offset ?? this.state.activeReadArguments.offset,
count: partialOptions?.count ?? this.state.activeReadArguments.count
};

// Don't fetch memory if we have an incomplete memory reference
if (completeOptions.memoryReference === '') {
return;
}

this.setState(prev => ({ ...prev, isMemoryFetching: true }));

try {
const response = await messenger.sendRequest(readMemoryType, HOST_EXTENSION, completeOptions);
await Promise.all(Array.from(
6 changes: 6 additions & 0 deletions src/webview/utils/view-types.ts
Original file line number Diff line number Diff line change
@@ -59,6 +59,12 @@ export interface MemoryState {
isMemoryFetching: boolean;
}

export const DEFAULT_READ_ARGUMENTS: Required<ReadMemoryArguments> = {
memoryReference: '',
offset: 0,
count: 256,
};

export interface UpdateExecutor {
fetchData(currentViewParameters: ReadMemoryArguments): Promise<void>;
}