Milestone - August (八月) - 2022

[Bistard]

OverView

mark	Description
bullet	not started
checkmark	completed
⭐	important
🐄	on-going (Chris)
🐳	on-going (Jerry)
🚳	not for now
...	lots of unfinished

Folder Structure (2022.10.30)

├─base     # 基础代码
│  ├─browser       # 通用UI元件
│  │  ├─basic          # 基础UI元件
│  │  └─secondary      # 复合UI元件
│  ├─common        # 公用接口
│  ├─electron      # 主进程相关接口
│  └─node          # nodeJS相关接口
├─code     # 主入口
│  ├─browser       # 渲染进程主入口
│  ├─electron      # 主进程主入口
│  ├─platform      # 基于平台相关的微服务
│  └─styles        # css文件
├─editor   # 编辑器代码
│  ├─common
│  ├─styles        # css文件
│  ├─model
│  ├─view
│  └─viewModel
└─styles   # css文件

Iteration Plan

Generals

• CSP and prevent eval() when using webpack.
• build.js - A smarter building script that invokes webpack command and integrates with other jobs.
• createService() - renamed from createDecorator().

Common Codes

• 🐄AsyncRunner - Guarantees no more than N promises are running at the same time.
• UUID - Universally Unique Identifier.
• 🐄ErrorRegistrant - Brand new error caught system.
• performance - Functionality that able to test performance on given code section.
• Blocker - simple but very helpful async tools that user can mually resolve a promise at any time (remove old AsyncTask).
• instantiationService - Now supports parent relationship.
• object.ts - Provides object related helper functions.
• NodeEventEmitter - A wrapper of NodeJS.EventEmitter that listens to the provided channel and wraps the receiving data with the provided data wrapper.
• hash - String hashable and object hashable.
• event - New type of emitter: PriorityEmitter that only fires event to the listeners who has the highest priority.
• 🚳event - Emitter memory leak optimization.
• uri - refactor - Simplifies the existed uri.ts.

User interface (UI)

• ContextMenu - Refactors all the existed codes relates to ContextMenu.
• milkdown - Trys out how milkdown lib works.
• 🐳SplitView - Supports nested and vertical SplitView.
• 🐳SplitView - Remove / move / swap APIs.
• 🐄Sash - Refactor Sash which has smoother movements.
• 🐄SashController - Refactoring to a wrapper class that determines the behaviors of the sash under the user's operations.
• 🐄ListView - Adaptive resizing when window is resizing.

Services (common)

• 🐄ILogService - Remove the old logService code.
• 🐄Logger - Provides the actual logging functionalities.
• 🐄 pipelineLogger - Provide integrations on mutiple loggers.
• 🐄pipelineLogger - Intergrated with a buffer to stores loggings inside the logger.
• 🐄fileLoggerService && fileLogger - Able to create a file logger that does the actual reading / writing logic.
• 🐄consoleLogService && consoleLogger - A simple log service that only logging to the console (could be either Chrome or Node.js console depends on which env the program is running on).
• 🐄fileService - enum type for representing the error type during different operations.
• 🐳CommandRegistrant && commandService - A registrant that can register commands universally. A service that can access the registrant in the program.
• 🐄IEnviromentService - A shared environment interface that can be used in either the main process or renderer process (unlike configurations, environment remain constants during runtime).
• IDiskEnviromentService && IMainEnviromentService && IBrowserEnviromentService - Diff environments interfaces for Electron.
• ILifecycleService && AbstractLifecycleService - Controls and tracks the lifecycle of the program.
• DiskStorage - A simple storage class that wraps an object that provides sync functionality.
• ConfigStorage && DefaultConfigStorage - A base storage class for configuration usage purpose.
• ConfigModel - A brand new class (refactored) that integrates with reading / saving.
• ConfigCollection - A class that contains a collection of config models.
• AbstractConfigService - Extended by MainConfigService and BrowserConfigService.
• ConfigEmtter - Smarter and cleaver way to listen to the change of configurations.

Services (main process)

• mainEnvironmentService - A concrete class that stores the environment that is used in the main process of Electron.
• mainLifecycleService - A concrete class that controls and tracks the lifecycle of the main process of Electron.
• mainWindowService - Window service has ability to create windows based on different configurations and also tracks the lifecycle of each WindowInstance.
• mainStatusService - A simple class that stores the user-specific and window-status related data into the disk synchrously.
• MainLoggerChannel - A customized wrapper channel class used in the main process so that a logger service can be correctly registered into a server (cannot use ProxyChannel directly).
• MainFileChannel - A customized file service channel class used in the main process.
• MainDialogService - A microservice that can open dialog windows under Electron APIs.
• LookupPaletteService - startup and other few empty html files.
• MainConfigService - A brand new configuration service (refactored using ConfigCollection).
• MainHostService - Integrations of a series of functionalities that relates to window as a microservice.

Services (renderer process)

• browserEnvironmentService - A concrete class that stores the environment that is used in the renderer process of Electron.
• browserLifecycleService - A concrete class that controls and tracks the lifecycle of the renderer process of Electron.
• IpcService - Wraps an IpcClient.
• BrowserLoggerChannel - A customized wrapper channel class used in the renderer process so that a logger service can be correctly registered as a client (cannot use ProxyChannel directly).
• BrowserFileChannel - A customized file service channel class used in the renderer process.
• BrowserDialogService - Wrapper over ProxyChannel.
• BrowserConfigService - A brand new configuration service (refactored using ConfigCollection).

Main Process

• 🐄Electron - update to v17.4.1.
• JQuery - remove jq completely from the project.
• 🐄platform - base universal APIs for different platform environments (os.ts and app.ts deleted).
• 🐄process - A safer process variable that cross in different environments.
• 🐄remote - Remove remote module from the applications.
• 🐄main.js - The earliest entry of the program. Not responsible for any business logic handling. Only existed for processing some preparation.
• env - using minilist for CLI parsing.
• 🐄MainProcess - A new class replacing the old mainclass. The first entry (except main.js) of the program that only handles core services initialization and make sure there is only one process that is running in the current environment. Does NOT handle the business logic.
• 🐄NotaInstance - A new class that controls the actual business logic of the nota program.
• 🐄WindowInstance - A wrapper class over BrowserWindow that represents a renderer process of Electron.
• 🐄preload - Use and rewrite preload.js (eg. manually wraps and expose desired global variables to renderer process).
• 🐄safeIpcMain - A wrapper of original IpcMain that integerates with channel checking.
• 🐄IProtocol - A protocol is a set of rules for formatting and processing data.
• 🐄DataSerializer - Serializes the incoming data into DataBuffer under the pre-defined protocol.
• 🐄BufferDeserializer - Deserializes the incoming DataBuffer into corresponding data type under the pre-defined protocol.
• 🐄ProxyChannel - A namespace that provide functionalities to proxy micro-services into different IServerChannel which can be directly registered into IServerBase (You may also to unproxy channel to microservice (notice that the returned object is not the actual microservice, it is a Proxy).
• 🐄ChannelClient - Invokes a command or listens to an event from the server channel. Client side can get a promise that resolves with the corresponding response.
• 🐄ChannelServer - Able to register different channels then start to listen to the corresponding possible clients. It will send response back to the client once the work is done by the corresponding channel.
• 🐄ServerBase - Caller can register different server channels into the server. Everytime a client connects to the server. A ChannelServer is created and automatically registered all the existed channels into the new server channel.
• 🐄ClientBase - A simple wrapper over ChannelClient except that it will send a one-time request that including the client ID.
• 🐄IpcServer && IpcClient - Two implementations over ServerBase and ClientBase that defines the protocol is IPC related.
• 🐄src/code/platform - A brand new directory that contains all the micro-services that may varies in different platforms.
• 🐄registrants - A universal REGISTRANT that can access all the other registered registrants.
• 🐄Node.JS - Remove all the Node.JS code from the renderer process.
• 🐄DevEnviro - Move all the testing code from electron-quick-playground in a brand new branch named test.

Renderer Process

• rendererInstance - Brand rederer.ts repacing old browser.ts. The entry of the renderer process.
• browserInstance - Brand new browser.ts. Handles the business logic of each browser in the renderer process.
• theme - Themable and ThemeService startup.
• Component - refactor Component UI class with new API layout. Furthermore using FastElement intsead of HTMLElement.
• shortcutRegistrant - A type of registrant that used in the renderer process typically for shortcut registration.
• workbench - implement SplitView in workbench now.

Editor

• pieceTable - new method getCharCodeByLine.
• PieceTableModel - wrapper class.
• EditorModel - tokenization process.
• EditorViewEventHandler -
• EditorViewModelEventEmitter -

Issues

• Sash - Fix When draging the scrollbar of the explorer view, the hover effect on the sash will be activated, which is not what we expected. #100

Unit Tests

• utility.ts - A series of helper functions / classes only used during unit testing.
• fileService - exist / createFile / createDir / move / copy / delete / warn.
• 🚳shortcutService - shortcutService.test.ts. (currently disabled)
• async.test.ts - unit tests.
• diskStorage.test.ts - unit tests.
• object.test.ts - unit tests.
• piecetable.test.ts - getCharCodeByline unit tests.
• configStorage.test.ts - unit tests.
• registrant.test.ts - unit tests.
• commandRegistrant.test.ts - unit tests.
• configRegistrant.test.ts - unit tests.
• PieceTableModel - unit tests.

Benchmark & Optimization

• 🐄markdown-tokenizer - marked, markdown-it, and our own tokenizer.
• PieceTable - Reading chunks in 128KB or 64KB instead of 256KB. We need a fully test here.
• range - perf optimization.
• ListView - perf optimization.
• event - perf optimization.
• general - avoid using forEach / map / reduce etc functions. Use vanilla coding style.

Code Review

• vscode - Read codes about CompressedObjectTreeModel.
• vscode - Read codes about FuzzyScore.
• vscode - Read codes about CompressibleAsyncDataTree.
• vscode - Learn how ThemeService works.
• vscode - Learn how StorageService works.
• marked - Source code reading (tokenizer & lexer).
• vscode - TokenizationTextModelPart
• vscode - TextModelTokenization
• vscode - TokenizationStateStore - Stores the states at the start of each line and keeps track of which lines must be retokenized.
• vscode - ContiguousTokensStore - Represents contiguous tokens in a text model.
• vscode - SparseTokensStore - Represents sparse tokens in a text model.
• 🐄vscode - How vscode renders lines (How vscode get LineTokens given a line number) (low-level)
• 🐳vscode - CommandService
• 🐳vscode - CommandRegistry
• 🐳vscode - Action and Action2
• 🐄vscode - preload.js
• 🐄vscode - lifeCycleService.
• 🐄vscode - enviromentService.
• 🐄vscode - stateService.
• 🐄vscode - CodeMain class.
• 🐄vscode - CodeApplication class.
• 🐄vscode - WindowsMainService class.
• 🐄vscode - CodeWindow class.
• 🐄vscode - preload.js
• 🐄vscode - desktop.main.ts
• 🐄vscode - ipc.ts⭐
• 🐄vscode - ConfigurationModel
• 🐄vscode - Configuration && DefaultConfigurationModel && DefaultConfiguration && UserSettings
• 🐄vscode - Registry.
• vscode - 不想列了, 看了太多.
• 🐄vscode - Create a pr on PieceTable optimization.

Documentation

• Nota_Manual - detailed documentation of Nota.

Others

• try out TiddlyWiki
• MVVM
• Gap Buffer
• Context Pattern

[Bistard]

VSCode startup

CodeMain -> CodeApplication -> WindowsMainService -> CodeWindow -> new BrowserWindow()...