Add autocompletion and documentation display (#2)

tuesmiddt · web-flow · commit 3c8c9c277fc5 · 2020-03-30T15:47:31.000+08:00
Add autocompletion and documentation display for builtins
diff --git a/src/actions/actionTypes.ts b/src/actions/actionTypes.ts
@@ -40,6 +40,7 @@ export const END_CLEAR_CONTEXT = 'END_CLEAR_CONTEXT';
 export const ENSURE_LIBRARIES_LOADED = 'ENSURE_LIBRARIES_LOADED';
 export const EVAL_EDITOR = 'EVAL_EDITOR';
 export const EVAL_REPL = 'EVAL_REPL';
+export const PROMPT_AUTOCOMPLETE = 'PROMPT_AUTOCOMPLETE';
 // For interpreting code blocks silently (e.g. prepend) BEFORE the test case is run
 export const EVAL_SILENT = 'EVAL_SILENT';
 export const EVAL_TESTCASE = 'EVAL_TESTCASE';
diff --git a/src/actions/workspaces.ts b/src/actions/workspaces.ts
@@ -209,3 +209,16 @@ export const updateHasUnsavedChanges = (
     workspaceLocation,
     hasUnsavedChanges
   });
+
+export const promptAutocomplete = (
+  workspaceLocation: WorkspaceLocation,
+  row: number,
+  column: number,
+  callback: any // TODO: define a type for this
+) =>
+  action(actionTypes.PROMPT_AUTOCOMPLETE, {
+    workspaceLocation,
+    row,
+    column,
+    callback
+  });
diff --git a/src/components/Playground.tsx b/src/components/Playground.tsx
@@ -104,6 +104,7 @@ export interface IDispatchProps {
   handleDebuggerResume: () => void;
   handleDebuggerReset: () => void;
   handleToggleEditorAutorun: () => void;
+  handlePromptAutocomplete: (row: number, col: number, callback: any) => void;
 }
 
 type PlaygroundState = {
@@ -272,6 +273,7 @@ class Playground extends React.Component<IPlaygroundProps, PlaygroundState> {
         handleDeclarationNavigate: this.props.handleDeclarationNavigate,
         handleEditorEval: this.props.handleEditorEval,
         handleEditorValueChange: this.props.handleEditorValueChange,
+        handlePromptAutocomplete: this.props.handlePromptAutocomplete,
         handleFinishInvite: this.props.handleFinishInvite,
         sharedbAceInitValue: this.props.sharedbAceInitValue,
         sharedbAceIsInviting: this.props.sharedbAceIsInviting,
diff --git a/src/components/__tests__/Playground.tsx b/src/components/__tests__/Playground.tsx
@@ -54,7 +54,8 @@ const baseProps = {
   handleUsingSubst: (usingSubst: boolean) => {},
   handleDebuggerPause: () => {},
   handleDebuggerResume: () => {},
-  handleDebuggerReset: () => {}
+  handleDebuggerReset: () => {},
+  handlePromptAutocomplete: (row: number, col: number, callback: any) => {}
 };
 
 const testValueProps: IPlaygroundProps = {
diff --git a/src/components/academy/grading/GradingWorkspace.tsx b/src/components/academy/grading/GradingWorkspace.tsx
@@ -88,6 +88,7 @@ export type DispatchProps = {
   handleDebuggerReset: () => void;
   handleUpdateCurrentSubmissionId: (submissionId: number, questionId: number) => void;
   handleUpdateHasUnsavedChanges: (hasUnsavedChanges: boolean) => void;
+  handlePromptAutocomplete: (row: number, col: number, callback: any) => void;
 };
 
 class GradingWorkspace extends React.Component<GradingWorkspaceProps> {
@@ -179,6 +180,7 @@ class GradingWorkspace extends React.Component<GradingWorkspaceProps> {
               highlightedLines: this.props.highlightedLines,
               newCursorPosition: this.props.newCursorPosition,
               handleEditorUpdateBreakpoints: this.props.handleEditorUpdateBreakpoints,
+              handlePromptAutocomplete: this.props.handlePromptAutocomplete,
               isEditorAutorun: false
             }
           : undefined,
diff --git a/src/components/assessment/AssessmentWorkspace.tsx b/src/components/assessment/AssessmentWorkspace.tsx
@@ -108,6 +108,7 @@ export type DispatchProps = {
   handleDebuggerPause: () => void;
   handleDebuggerResume: () => void;
   handleDebuggerReset: () => void;
+  handlePromptAutocomplete: (row: number, col: number, callback: any) => void;
 };
 
 class AssessmentWorkspace extends React.Component<
@@ -248,6 +249,7 @@ class AssessmentWorkspace extends React.Component<
               highlightedLines: this.props.highlightedLines,
               newCursorPosition: this.props.newCursorPosition,
               handleEditorUpdateBreakpoints: this.props.handleEditorUpdateBreakpoints,
+              handlePromptAutocomplete: this.props.handlePromptAutocomplete,
               isEditorAutorun: false
             }
           : undefined,
diff --git a/src/components/assessment/__tests__/AssessmentWorkspace.tsx b/src/components/assessment/__tests__/AssessmentWorkspace.tsx
@@ -45,6 +45,7 @@ const defaultProps: AssessmentWorkspaceProps = {
   handleDebuggerPause: () => {},
   handleDebuggerResume: () => {},
   handleDebuggerReset: () => {},
+  handlePromptAutocomplete: (row: number, col: number, callback: any) => {},
   isRunning: false,
   isDebugging: false,
   enableDebugging: false,
diff --git a/src/components/missionControl/EditingWorkspace.tsx b/src/components/missionControl/EditingWorkspace.tsx
@@ -102,6 +102,7 @@ export type DispatchProps = {
   handleDebuggerReset: () => void;
   handleUpdateCurrentAssessmentId: (assessmentId: number, questionId: number) => void;
   handleUpdateHasUnsavedChanges: (hasUnsavedChanges: boolean) => void;
+  handlePromptAutocomplete: (row: number, col: number, callback: any) => void;
 };
 
 interface IState {
@@ -182,6 +183,7 @@ class AssessmentWorkspace extends React.Component<AssessmentWorkspaceProps, ISta
               newCursorPosition: this.props.newCursorPosition,
               handleEditorUpdateBreakpoints: this.props.handleEditorUpdateBreakpoints,
               handleUpdateHasUnsavedChanges: this.props.handleUpdateHasUnsavedChanges,
+              handlePromptAutocomplete: this.props.handlePromptAutocomplete,
               isEditorAutorun: false
             }
           : undefined,
diff --git a/src/components/sourcecast/Sourcecast.tsx b/src/components/sourcecast/Sourcecast.tsx
@@ -71,6 +71,7 @@ export interface IDispatchProps {
   handleEditorEval: () => void;
   handleEditorHeightChange: (height: number) => void;
   handleEditorValueChange: (val: string) => void;
+  handlePromptAutocomplete: (row: number, col: number, callback: any) => void;
   handleEditorWidthChange: (widthChange: number) => void;
   handleEditorUpdateBreakpoints: (breakpoints: string[]) => void;
   handleExternalSelect: (externalLibraryName: ExternalLibraryName) => void;
@@ -234,6 +235,7 @@ class Sourcecast extends React.Component<ISourcecastProps> {
     };
     const sourcecastControlbarProps: ISourcecastControlbarProps = {
       handleEditorValueChange: this.props.handleEditorValueChange,
+      handlePromptAutocomplete: this.props.handlePromptAutocomplete,
       handleSetCodeDeltasToApply: this.props.handleSetCodeDeltasToApply,
       handleSetEditorReadonly: this.props.handleSetEditorReadonly,
       handleSetInputToApply: this.props.handleSetInputToApply,
diff --git a/src/components/sourcecast/SourcecastControlbar.tsx b/src/components/sourcecast/SourcecastControlbar.tsx
@@ -204,6 +204,7 @@ export interface ISourcecastControlbarProps {
   playbackStatus: PlaybackStatus;
   handleChapterSelect: (chapter: number) => void;
   handleExternalSelect: (name: ExternalLibraryName) => void;
+  handlePromptAutocomplete: (row: number, col: number, callback: any) => void;
 }
 
 export interface ISourcecastControlbarState {
diff --git a/src/components/workspace/Editor.tsx b/src/components/workspace/Editor.tsx
@@ -3,6 +3,7 @@ import AceEditor, { IAnnotation } from 'react-ace';
 import { HotKeys } from 'react-hotkeys';
 import sharedbAce from 'sharedb-ace';
 
+import { require as acequire } from 'ace-builds';
 import 'ace-builds/src-noconflict/ext-language_tools';
 import 'ace-builds/src-noconflict/ext-searchbox';
 import { createContext, getAllOccurrencesInScope } from 'js-slang';
@@ -35,6 +36,7 @@ export interface IEditorProps {
   handleEditorValueChange: (newCode: string) => void;
   handleEditorUpdateBreakpoints: (breakpoints: string[]) => void;
   handleFinishInvite?: () => void;
+  handlePromptAutocomplete: (row: number, col: number, callback: any) => void;
   handleSetWebsocketStatus?: (websocketStatus: number) => void;
   handleUpdateHasUnsavedChanges?: (hasUnsavedChanges: boolean) => void;
 }
@@ -43,13 +45,21 @@ export interface IPosition {
   row: number;
   column: number;
 }
+export interface IAutocompletionResult {
+  caption: string;
+  value: string;
+  meta?: string;
+  docHTML?: string;
+  score?: number;
+}
 
 class Editor extends React.PureComponent<IEditorProps, {}> {
   public ShareAce: any;
   public AceEditor: React.RefObject<AceEditor>;
   private markerIds: number[];
   private onChangeMethod: (newCode: string) => void;
   private onValidateMethod: (annotations: IAnnotation[]) => void;
+  private completer: {};
 
   constructor(props: IEditorProps) {
     super(props);
@@ -68,6 +78,13 @@ class Editor extends React.PureComponent<IEditorProps, {}> {
         this.props.handleEditorEval();
       }
     };
+
+    this.completer = {
+      getCompletions: (editor: any, session: any, pos: any, prefix: any, callback: any) => {
+        // console.log(pos); // Cursor col is insertion location i.e. last char col + 1
+        this.props.handlePromptAutocomplete(pos.row, pos.column, callback);
+      }
+    };
   }
 
   public getBreakpoints() {
@@ -117,6 +134,9 @@ class Editor extends React.PureComponent<IEditorProps, {}> {
     // Change all info annotations to error annotations
     session.on('changeAnnotation', this.handleAnnotationChange(session));
 
+    // Start autocompletion
+    acequire('ace/ext/language_tools').setCompleters([this.completer]);
+
     // Has session ID
     if (this.props.editorSessionId !== '') {
       this.handleStartCollabEditing(editor);
@@ -214,6 +234,8 @@ class Editor extends React.PureComponent<IEditorProps, {}> {
             value={this.props.editorValue}
             width="100%"
             setOptions={{
+              enableBasicAutocompletion: true,
+              enableLiveAutocompletion: true,
               fontFamily: "'Inconsolata', 'Consolas', monospace"
             }}
           />
diff --git a/src/components/workspace/__tests__/Editor.tsx b/src/components/workspace/__tests__/Editor.tsx
@@ -23,7 +23,8 @@ test('Editor renders correctly', () => {
     handleEditorUpdateBreakpoints: breakpoints => {},
     handleFinishInvite: () => {},
     handleSetWebsocketStatus: websocketStatus => {},
-    handleUpdateHasUnsavedChanges: hasUnsavedChanges => {}
+    handleUpdateHasUnsavedChanges: hasUnsavedChanges => {},
+    handlePromptAutocomplete: (row: number, col: number, callback: any) => {}
   };
   const app = <Editor {...props} />;
   const tree = shallow(app);
diff --git a/src/containers/ApplicationContainer.ts b/src/containers/ApplicationContainer.ts
@@ -6,6 +6,7 @@ import {
   changeExecTime,
   ensureLibrariesLoaded,
   externalLibrarySelect,
+  promptAutocomplete,
   WorkspaceLocations
 } from '../actions/workspaces';
 import Application, { IDispatchProps, IStateProps } from '../components/Application';
@@ -47,6 +48,8 @@ const mapDispatchToProps: MapDispatchToProps<IDispatchProps, {}> = (dispatch: Di
           workspaceLocation
         ),
       handleEditorValueChange: (val: string) => updateEditorValue(val, workspaceLocation),
+      handlePromptAutocomplete: (row: number, col: number, callback: any) =>
+        promptAutocomplete(workspaceLocation, row, col, callback),
       handleEditorUpdateBreakpoints: (breakpoints: string[]) =>
         setEditorBreakpoint(breakpoints, workspaceLocation),
       handleEnsureLibrariesLoaded: ensureLibrariesLoaded,
diff --git a/src/containers/PlaygroundContainer.ts b/src/containers/PlaygroundContainer.ts
@@ -23,6 +23,7 @@ import {
   initInvite,
   invalidEditorSessionId,
   navigateToDeclaration,
+  promptAutocomplete,
   setEditorBreakpoint,
   setEditorSessionId,
   setWebsocketStatus,
@@ -104,7 +105,9 @@ const mapDispatchToProps: MapDispatchToProps<IDispatchProps, {}> = (dispatch: Di
       handleUsingSubst: (usingSubst: boolean) => toggleUsingSubst(usingSubst),
       handleDebuggerPause: () => beginDebuggerPause(workspaceLocation),
       handleDebuggerResume: () => debuggerResume(workspaceLocation),
-      handleDebuggerReset: () => debuggerReset(workspaceLocation)
+      handleDebuggerReset: () => debuggerReset(workspaceLocation),
+      handlePromptAutocomplete: (row: number, col: number, callback: any) =>
+        promptAutocomplete(workspaceLocation, row, col, callback)
     },
     dispatch
   );
diff --git a/src/containers/academy/grading/GradingWorkspaceContainer.ts b/src/containers/academy/grading/GradingWorkspaceContainer.ts
@@ -18,6 +18,7 @@ import {
   evalTestcase,
   fetchGrading,
   navigateToDeclaration,
+  promptAutocomplete,
   setEditorBreakpoint,
   updateActiveTab,
   updateEditorValue,
@@ -101,7 +102,9 @@ const mapDispatchToProps: MapDispatchToProps<DispatchProps, {}> = (dispatch: Dis
         updateHasUnsavedChanges(workspaceLocation, unsavedChanges),
       handleDebuggerPause: () => beginDebuggerPause(workspaceLocation),
       handleDebuggerResume: () => debuggerResume(workspaceLocation),
-      handleDebuggerReset: () => debuggerReset(workspaceLocation)
+      handleDebuggerReset: () => debuggerReset(workspaceLocation),
+      handlePromptAutocomplete: (row: number, col: number, callback: any) =>
+        promptAutocomplete(workspaceLocation, row, col, callback)
     },
     dispatch
   );
diff --git a/src/containers/assessment/AssessmentWorkspaceContainer.ts b/src/containers/assessment/AssessmentWorkspaceContainer.ts
@@ -19,6 +19,7 @@ import {
   evalTestcase,
   fetchAssessment,
   navigateToDeclaration,
+  promptAutocomplete,
   setEditorBreakpoint,
   submitAnswer,
   updateActiveTab,
@@ -102,7 +103,9 @@ const mapDispatchToProps: MapDispatchToProps<DispatchProps, {}> = (dispatch: Dis
       handleUpdateCurrentAssessmentId: updateCurrentAssessmentId,
       handleDebuggerPause: () => beginDebuggerPause(workspaceLocation),
       handleDebuggerResume: () => debuggerResume(workspaceLocation),
-      handleDebuggerReset: () => debuggerReset(workspaceLocation)
+      handleDebuggerReset: () => debuggerReset(workspaceLocation),
+      handlePromptAutocomplete: (row: number, col: number, callback: any) =>
+        promptAutocomplete(workspaceLocation, row, col, callback)
     },
     dispatch
   );
diff --git a/src/containers/missionControl/EditingWorkspaceContainer.ts b/src/containers/missionControl/EditingWorkspaceContainer.ts
@@ -18,6 +18,7 @@ import {
   evalRepl,
   evalTestcase,
   navigateToDeclaration,
+  promptAutocomplete,
   setEditorBreakpoint,
   submitAnswer,
   updateEditorValue,
@@ -95,7 +96,9 @@ const mapDispatchToProps: MapDispatchToProps<DispatchProps, {}> = (dispatch: Dis
       handleUpdateCurrentAssessmentId: updateCurrentAssessmentId,
       handleDebuggerPause: () => beginDebuggerPause(workspaceLocation),
       handleDebuggerResume: () => debuggerResume(workspaceLocation),
-      handleDebuggerReset: () => debuggerReset(workspaceLocation)
+      handleDebuggerReset: () => debuggerReset(workspaceLocation),
+      handlePromptAutocomplete: (row: number, col: number, callback: any) =>
+        promptAutocomplete(workspaceLocation, row, col, callback)
     },
     dispatch
   );
diff --git a/src/containers/sourcecast/SourcecastContainer.ts b/src/containers/sourcecast/SourcecastContainer.ts
@@ -18,6 +18,7 @@ import {
   externalLibrarySelect,
   fetchSourcecastIndex,
   navigateToDeclaration,
+  promptAutocomplete,
   setCodeDeltasToApply,
   setEditorBreakpoint,
   setEditorReadonly,
@@ -112,7 +113,9 @@ const mapDispatchToProps: MapDispatchToProps<IDispatchProps, {}> = (dispatch: Di
       handleToggleEditorAutorun: () => toggleEditorAutorun(location),
       handleDebuggerPause: () => beginDebuggerPause(location),
       handleDebuggerResume: () => debuggerResume(location),
-      handleDebuggerReset: () => debuggerReset(location)
+      handleDebuggerReset: () => debuggerReset(location),
+      handlePromptAutocomplete: (row: number, col: number, callback: any) =>
+        promptAutocomplete(location, row, col, callback)
     },
     dispatch
   );
diff --git a/src/containers/sourcecast/SourcereelContainer.ts b/src/containers/sourcecast/SourcereelContainer.ts
@@ -19,6 +19,7 @@ import {
   externalLibrarySelect,
   fetchSourcecastIndex,
   navigateToDeclaration,
+  promptAutocomplete,
   recordInit,
   recordInput,
   saveSourcecastData,
@@ -108,7 +109,9 @@ const mapDispatchToProps: MapDispatchToProps<IDispatchProps, {}> = (dispatch: Di
       handleToggleEditorAutorun: () => toggleEditorAutorun(location),
       handleDebuggerPause: () => beginDebuggerPause(location),
       handleDebuggerResume: () => debuggerResume(location),
-      handleDebuggerReset: () => debuggerReset(location)
+      handleDebuggerReset: () => debuggerReset(location),
+      handlePromptAutocomplete: (row: number, col: number, callback: any) =>
+        promptAutocomplete(location, row, col, callback)
     },
     dispatch
   );
diff --git a/src/reducers/documentation.ts b/src/reducers/documentation.ts
@@ -0,0 +1,55 @@
+import { SourceDocumentation } from 'js-slang';
+import { externalLibraries } from './externalLibraries';
+
+const externalLibrariesDocumentation = {};
+
+const MAX_CAPTION_LENGTH = 25;
+
+function shortenCaption(name: string): string {
+  if (name.length <= MAX_CAPTION_LENGTH) {
+    return name;
+  }
+
+  return (name = name.substring(0, MAX_CAPTION_LENGTH - 3) + '...');
+}
+
+for (const [lib, names] of externalLibraries) {
+  const libDocs = names.map((name: string) => {
+    if (name in SourceDocumentation.ext_lib) {
+      return {
+        caption: shortenCaption(name),
+        value: name,
+        meta: SourceDocumentation.ext_lib[name].meta,
+        docHTML: SourceDocumentation.ext_lib[name].description
+      };
+    } else {
+      return {
+        caption: shortenCaption(name),
+        value: name,
+        meta: 'const'
+      };
+    }
+  });
+
+  externalLibrariesDocumentation[lib] = libDocs;
+}
+
+const builtinDocumentation = {};
+
+Object.entries(SourceDocumentation.builtins).forEach((chapterDoc: any) => {
+  const [chapter, docs] = chapterDoc;
+  builtinDocumentation[chapter] = Object.entries(docs).map((entry: any) => {
+    const [name, info] = entry;
+    return {
+      caption: shortenCaption(name),
+      value: name,
+      meta: info.meta,
+      docHTML: info.description
+    };
+  });
+});
+
+export const Documentation = {
+  builtins: builtinDocumentation,
+  externalLibraries: externalLibrariesDocumentation
+};
diff --git a/src/sagas/workspaces.ts b/src/sagas/workspaces.ts

Original file line number	Diff line number	Diff line change
`@@ -204,6 +204,7 @@ export interface ISourcecastControlbarProps {`
`204`	`204`	`playbackStatus: PlaybackStatus;`
`205`	`205`	`handleChapterSelect: (chapter: number) => void;`
`206`	`206`	`handleExternalSelect: (name: ExternalLibraryName) => void;`
	`207`	`+ handlePromptAutocomplete: (row: number, col: number, callback: any) => void;`
`207`	`208`	`}`
`208`	`209`
`209`	`210`	`export interface ISourcecastControlbarState {`