-
Notifications
You must be signed in to change notification settings - Fork 13
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
Proposal: Use React context instead of prop drilling #85
Draft
tortmayr
wants to merge
1
commit into
eclipse-cdt-cloud:main
Choose a base branch
from
eclipsesource:issues/84_context
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+294
−291
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,199 @@ | ||
| /******************************************************************************** | ||
| * Copyright (C) 2022 Ericsson, Arm and others. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License v. 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0. | ||
| * | ||
| * This Source Code may also be made available under the following Secondary | ||
| * Licenses when the conditions for such availability set forth in the Eclipse | ||
| * Public License v. 2.0 are satisfied: GNU General Public License, version 2 | ||
| * with the GNU Classpath Exception which is available at | ||
| * https://www.gnu.org/software/classpath/license.html. | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 | ||
| ********************************************************************************/ | ||
|
|
||
| import { DebugProtocol } from '@vscode/debugprotocol'; | ||
| import React from 'react'; | ||
| import { HOST_EXTENSION } from 'vscode-messenger-common'; | ||
| import { logMessageType, readMemoryType, readyType, resetMemoryViewSettingsType, setMemoryViewSettingsType, setOptionsType, setTitleType } from '../../common/messaging'; | ||
| import { AddressColumn } from '../columns/address-column'; | ||
| import { AsciiColumn } from '../columns/ascii-column'; | ||
| import { ColumnStatus, columnContributionService } from '../columns/column-contribution-service'; | ||
| import { DataColumn } from '../columns/data-column'; | ||
| import { decorationService } from '../decorations/decoration-service'; | ||
| import { Decoration, Memory, MemoryDisplayConfiguration, MemoryState } from '../utils/view-types'; | ||
| import { variableDecorator } from '../variables/variable-decorations'; | ||
| import { messenger } from '../view-messenger'; | ||
|
|
||
| export interface MemoryAppState extends MemoryState, MemoryDisplayConfiguration { | ||
| title: string; | ||
| decorations: Decoration[]; | ||
| columns: ColumnStatus[]; | ||
| offset: number; | ||
| } | ||
|
|
||
| const MEMORY_DISPLAY_CONFIGURATION_DEFAULTS: MemoryDisplayConfiguration = { | ||
| bytesPerWord: 1, | ||
| wordsPerGroup: 1, | ||
| groupsPerRow: 4, | ||
| scrollingBehavior: 'Paginate', | ||
| addressRadix: 16, | ||
| showRadixPrefix: true, | ||
| }; | ||
|
|
||
| const MEMORY_APP_STATE_DEFAULTS: MemoryAppState = { | ||
| title: 'Memory', | ||
| memory: undefined, | ||
| memoryReference: '', | ||
| offset: 0, | ||
| count: 256, | ||
| decorations: [], | ||
| columns: columnContributionService.getColumns(), | ||
| isMemoryFetching: false, | ||
| ...MEMORY_DISPLAY_CONFIGURATION_DEFAULTS | ||
| }; | ||
|
|
||
| const MEMORY_APP_CONTEXT_DEFAULTS: MemoryAppContext = { | ||
| ...MEMORY_APP_STATE_DEFAULTS, | ||
| updateMemoryState: () => { }, | ||
| updateMemoryDisplayConfiguration: () => { }, | ||
| resetMemoryDisplayConfiguration: () => { }, | ||
| updateTitle: () => { }, | ||
| refreshMemory: () => { }, | ||
| fetchMemory: async () => { }, | ||
| toggleColumn: () => { } | ||
| }; | ||
|
|
||
| export const MemoryAppContext = React.createContext<MemoryAppContext>(MEMORY_APP_CONTEXT_DEFAULTS); | ||
|
|
||
| export interface MemoryAppContext extends MemoryAppState { | ||
| updateMemoryState: (newState: Partial<MemoryAppState>) => void; | ||
| updateMemoryDisplayConfiguration: (newState: Partial<MemoryDisplayConfiguration>) => void; | ||
| resetMemoryDisplayConfiguration: () => void; | ||
| updateTitle: (title: string) => void; | ||
| refreshMemory: () => void; | ||
| fetchMemory: (partialOptions?: Partial<DebugProtocol.ReadMemoryArguments>) => Promise<void>; | ||
| toggleColumn: (id: string, active: boolean) => void; | ||
| } | ||
|
|
||
| interface MemoryAppProviderProps { | ||
| children: React.ReactNode; | ||
| } | ||
|
|
||
| export class MemoryAppProvider extends React.Component<MemoryAppProviderProps, MemoryAppState> { | ||
|
|
||
| public constructor(props: MemoryAppProviderProps) { | ||
| super(props); | ||
| columnContributionService.register(new AddressColumn(), false); | ||
| columnContributionService.register(new DataColumn(), false); | ||
| columnContributionService.register(variableDecorator); | ||
| columnContributionService.register(new AsciiColumn()); | ||
| decorationService.register(variableDecorator); | ||
| this.state = { | ||
| title: 'Memory', | ||
| memory: undefined, | ||
| memoryReference: '', | ||
| offset: 0, | ||
| count: 256, | ||
| decorations: [], | ||
| columns: columnContributionService.getColumns(), | ||
| isMemoryFetching: false, | ||
| ...MEMORY_DISPLAY_CONFIGURATION_DEFAULTS | ||
| }; | ||
| } | ||
|
|
||
| public componentDidMount(): void { | ||
| messenger.onRequest(setOptionsType, options => this.setOptions(options)); | ||
| messenger.onNotification(setMemoryViewSettingsType, config => { | ||
| for (const column of columnContributionService.getColumns()) { | ||
| const id = column.contribution.id; | ||
| const configurable = column.configurable; | ||
| this.toggleColumn(id, !configurable || !!config.visibleColumns?.includes(id)); | ||
| } | ||
| this.setState(prevState => ({ ...prevState, ...config, title: config.title ?? prevState.title, })); | ||
| }); | ||
| messenger.sendNotification(readyType, HOST_EXTENSION, undefined); | ||
| } | ||
|
|
||
| public render(): React.ReactNode { | ||
| const contextValue: MemoryAppContext = { | ||
| ...this.state, | ||
| updateMemoryState: this.updateMemoryState, | ||
| fetchMemory: this.fetchMemory, | ||
| refreshMemory: this.refreshMemory, | ||
| resetMemoryDisplayConfiguration: this.resetMemoryDisplayConfiguration, | ||
| toggleColumn: this.toggleColumn, | ||
| updateMemoryDisplayConfiguration: this.updateMemoryDisplayConfiguration, | ||
| updateTitle: this.updateTitle | ||
| }; | ||
|
|
||
| return ( | ||
| <MemoryAppContext.Provider value={contextValue}> | ||
| {this.props.children} | ||
| </MemoryAppContext.Provider> | ||
| ); | ||
| } | ||
|
|
||
| protected updateMemoryState = (newState: Partial<MemoryState>) => this.setState(prevState => ({ ...prevState, ...newState })); | ||
| protected updateMemoryDisplayConfiguration = (newState: Partial<MemoryDisplayConfiguration>) => this.setState(prevState => ({ ...prevState, ...newState })); | ||
| protected resetMemoryDisplayConfiguration = () => messenger.sendNotification(resetMemoryViewSettingsType, HOST_EXTENSION, undefined); | ||
| protected updateTitle = (title: string) => { | ||
| this.setState({ title }); | ||
| messenger.sendNotification(setTitleType, HOST_EXTENSION, title); | ||
| }; | ||
|
|
||
| protected async setOptions(options?: Partial<DebugProtocol.ReadMemoryArguments>): Promise<void> { | ||
| messenger.sendRequest(logMessageType, HOST_EXTENSION, `Setting options: ${JSON.stringify(options)}`); | ||
| this.setState(prevState => ({ ...prevState, ...options })); | ||
| return this.fetchMemory(options); | ||
| } | ||
|
|
||
| protected refreshMemory = () => { this.fetchMemory(); }; | ||
|
|
||
| protected fetchMemory = async (partialOptions?: Partial<DebugProtocol.ReadMemoryArguments>): Promise<void> => this.doFetchMemory(partialOptions); | ||
| protected async doFetchMemory(partialOptions?: Partial<DebugProtocol.ReadMemoryArguments>): Promise<void> { | ||
| this.setState(prev => ({ ...prev, isMemoryFetching: true })); | ||
| const completeOptions = { | ||
| memoryReference: partialOptions?.memoryReference || this.state.memoryReference, | ||
| offset: partialOptions?.offset ?? this.state.offset, | ||
| count: partialOptions?.count ?? this.state.count | ||
| }; | ||
|
|
||
| try { | ||
| const response = await messenger.sendRequest(readMemoryType, HOST_EXTENSION, completeOptions); | ||
| await Promise.all(Array.from( | ||
| new Set(columnContributionService.getUpdateExecutors().concat(decorationService.getUpdateExecutors())), | ||
| executor => executor.fetchData(completeOptions) | ||
| )); | ||
|
|
||
| this.setState({ | ||
| decorations: decorationService.decorations, | ||
| memory: this.convertMemory(response), | ||
| memoryReference: completeOptions.memoryReference, | ||
| offset: completeOptions.offset, | ||
| count: completeOptions.count, | ||
| isMemoryFetching: false | ||
| }); | ||
|
|
||
| messenger.sendRequest(setOptionsType, HOST_EXTENSION, completeOptions); | ||
| } finally { | ||
| this.setState(prev => ({ ...prev, isMemoryFetching: false })); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| protected convertMemory(result: DebugProtocol.ReadMemoryResponse['body']): Memory { | ||
| if (!result?.data) { throw new Error('No memory provided!'); } | ||
| const address = BigInt(result.address); | ||
| const bytes = Uint8Array.from(Buffer.from(result.data, 'base64')); | ||
| return { bytes, address }; | ||
| } | ||
|
|
||
| protected toggleColumn = (id: string, active: boolean): void => { this.doToggleColumn(id, active); }; | ||
| protected async doToggleColumn(id: string, isVisible: boolean): Promise<void> { | ||
| const columns = isVisible ? await columnContributionService.show(id, this.state) : columnContributionService.hide(id); | ||
| this.setState(prevState => ({ ...prevState, columns })); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unrelated to your changes, but it seems we don't really ever use the
endiannessvalues we pass around.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just noticed the same. We have "Selectable word endianess" in #48 . But I was falsely assuming before that the word display was little endian already which seems to be the internal default. I've raised #88