@codecademy/codebytes 0.2.1-alpha.524b82.0 → 0.2.1-alpha.547196.0

package/CHANGELOG.md

@@ -3,7 +3,7 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-### [0.2.1-alpha.524b82.0](https://github.com/Codecademy/client-modules/compare/@codecademy/codebytes@0.2.0...@codecademy/codebytes@0.2.1-alpha.524b82.0) (2022-01-11)
+### [0.2.1-alpha.547196.0](https://github.com/Codecademy/client-modules/compare/@codecademy/codebytes@0.3.0...@codecademy/codebytes@0.2.1-alpha.547196.0) (2022-01-13)
 
 **Note:** Version bump only for package @codecademy/codebytes
 
@@ -11,6 +11,15 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 
 
+## [0.3.0](https://github.com/Codecademy/client-modules/compare/@codecademy/codebytes@0.2.0...@codecademy/codebytes@0.3.0) (2022-01-12)
+
+
+### Features
+
+* **Codebytes:** add simple monaco editor disc 353 ([#16](https://github.com/Codecademy/client-modules/issues/16)) ([eec98ba](https://github.com/Codecademy/client-modules/commit/eec98ba9aad45f07fb5f3417e3da1e1935985deb))
+
+
+
 ## [0.2.0](https://github.com/Codecademy/client-modules/compare/@codecademy/codebytes@0.1.0...@codecademy/codebytes@0.2.0) (2022-01-04)
 
 

package/jest.config.js

@@ -0,0 +1 @@
+module.exports = require('../../jest.config.base')('codebytes');

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codecademy/codebytes",
   "description": "Codebytes Code Editor",
-  "version": "0.2.1-alpha.524b82.0",
+  "version": "0.2.1-alpha.547196.0",
   "author": "Codecademy Engineering <dev@codecademy.com>",
   "sideEffects": [
     "**/*.css",
@@ -27,8 +27,8 @@
     "@emotion/react": "^11.4.0",
     "@emotion/styled": "^11.3.0",
     "@loadable/component": "^5.13.1",
-    "@monaco-editor/react": "4.3.1",
-    "monaco-editor": ">= 0.25.0 < 1",
+    "monaco-editor": "0.20.0",
+    "react-monaco-editor": "0.34.0",
     "react-resize-observer": "1.1.1"
   },
   "scripts": {
@@ -41,14 +41,17 @@
   },
   "license": "MIT",
   "devDependencies": {
+    "@codecademy/gamut-tests": "*",
     "@emotion/jest": "^11.3.0",
     "@testing-library/dom": "^7.31.2",
     "@testing-library/react": "^11.0.4",
+    "@testing-library/react-hooks": "3.2.1",
+    "@testing-library/user-event": "13.1.1",
     "@types/loadable__component": "^5.13.2",
     "monaco-editor-webpack-plugin": "1.9.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d70500edcc3765e46127f9b32bb89e2626c55ba3"
+  "gitHead": "bb68468f760bc1b81d2f0c179a2974196993cf39"
 }

package/src/MonacoEditor/index.tsx

@@ -3,16 +3,14 @@
 // We are working on a monaco package in client-modules that has more configuration around themes and languages
 // Monaco as a shared package RFC https://www.notion.so/codecademy/Monaco-editor-as-a-shared-package-1f4484db165b4abc8394c3556451ef6a
 
-import loadable from '@loadable/component';
-import { OnMount } from '@monaco-editor/react';
+import ReactMonacoEditor, { OnMount } from '@monaco-editor/react';
+import { editor } from 'monaco-editor/esm/vs/editor/editor.api';
 import React, { useCallback, useRef } from 'react';
 import ResizeObserver from 'react-resize-observer';
 
 import { dark } from './theme';
 import { Monaco } from './types';
 
-const ReactMonacoEditor = loadable(() => import('@monaco-editor/react'));
-
 export type SimpleMonacoEditorProps = {
   value: string;
   language: string;
@@ -26,7 +24,7 @@ export const SimpleMonacoEditor: React.FC<SimpleMonacoEditorProps> = ({
   language,
   onChange,
 }) => {
-  const editorRef = useRef<any>(null);
+  const editorRef = useRef<editor.IStandaloneCodeEditor | null>(null);
   const editorWillMount = useCallback(
     (editor: ThemedEditor, monaco: Monaco) => {
       editorRef.current = editor;
@@ -39,7 +37,7 @@ export const SimpleMonacoEditor: React.FC<SimpleMonacoEditorProps> = ({
     <>
       <ResizeObserver
         onResize={({ height, width }) => {
-          editorRef.current?.editor?.layout({
+          editorRef.current?.layout({
             height,
             width,
           });
@@ -49,7 +47,7 @@ export const SimpleMonacoEditor: React.FC<SimpleMonacoEditorProps> = ({
         onMount={editorWillMount}
         onChange={onChange}
         options={{ minimap: { enabled: false } }}
-        theme="dark"
+        theme="vs-dark"
         value={value}
         language={language}
       />

package/src/__tests__/codebyte-test.tsx

@@ -0,0 +1,71 @@
+import { setupRtl } from '@codecademy/gamut-tests';
+import userEvent from '@testing-library/user-event';
+import React from 'react';
+
+import { CodeByteEditor } from '..';
+import { helloWorld, validLanguages } from '../consts';
+
+const mockEditorTestId = 'mock-editor-test-id';
+
+jest.mock('react-resize-observer');
+// This is a super simplified mock capable of render value and trigger onChange.
+jest.mock('../MonacoEditor', () => ({
+  SimpleMonacoEditor: ({
+    value,
+    onChange,
+  }: {
+    value: string;
+    onChange?: (value: string) => void;
+  }) => (
+    <>
+      {value}
+      <input
+        data-testid={mockEditorTestId}
+        type="text"
+        onChange={(e) => {
+          onChange?.(e.target.value);
+        }}
+        value={value}
+      />
+    </>
+  ),
+}));
+
+const renderWrapper = setupRtl(CodeByteEditor, {});
+
+describe('CodeBytes', () => {
+  it('has a language-specific "hello world" program defined for each language', () => {
+    validLanguages.forEach((language) => {
+      expect(helloWorld[language]).toBeDefined();
+    });
+  });
+
+  it('initializes with a language-specific "hello world" program when there is no language prop', () => {
+    const { view } = renderWrapper();
+    const selectedLanguage = view.getByRole('combobox') as Element;
+    userEvent.selectOptions(selectedLanguage, ['javascript']);
+    view.getByText(helloWorld.javascript!);
+  });
+
+  it('initializes with a language-specific "hello world" program when there is a language prop but no text prop', () => {
+    const { view } = renderWrapper({ language: 'javascript' });
+    view.getByText(helloWorld.javascript!);
+  });
+
+  it('initializes with deserialized text when there is a text prop but no language prop', () => {
+    const testString = 'yes hello';
+    const { view } = renderWrapper({ text: testString });
+    const selectedLanguage = view.getByRole('combobox') as Element;
+    userEvent.selectOptions(selectedLanguage, ['javascript']);
+    view.getByText(testString);
+  });
+
+  it('initializes with deserialized text when there is both a language and text prop', () => {
+    const testString = 'yes hello';
+    const { view } = renderWrapper({
+      text: testString,
+      language: 'javascript',
+    });
+    view.getByText(testString);
+  });
+});

package/src/consts.ts

@@ -61,4 +61,4 @@ export const helloWorld: { [key in languageOption]?: string } = {
   python,
   ruby,
   scheme,
-};
+};

package/src/editor.tsx

@@ -6,10 +6,10 @@ import {
   ToolTip,
 } from '@codecademy/gamut';
 import { CopyIcon } from '@codecademy/gamut-icons';
-import { colors } from '@codecademy/gamut-styles';
 import styled from '@emotion/styled';
 import React, { useState } from 'react';
 
+import { CodebytesChangeHandlerMap } from '.';
 import { postSnippet } from './api';
 import type { languageOption } from './consts';
 import { Drawers } from './drawers';
@@ -25,7 +25,7 @@ const Output = styled.pre<{ hasError: boolean }>`
   overflow: auto;
   ${({ hasError, theme }) => `
   color: ${hasError ? theme.colors.orange : theme.colors.white};
-  background-color: ${colors['gray-900']};
+  background-color: ${theme.colors['navy-900']};
 `}
 `;
 
@@ -39,8 +39,9 @@ type EditorProps = {
   hideCopyButton: boolean;
   language: languageOption;
   text: string;
+
   onChange: (text: string) => void;
-  onCopy?: (text: string, language: string) => void;
+  on?: Pick<CodebytesChangeHandlerMap, 'copy' | 'run'>;
   snippetsBaseUrl?: string;
 };
 
@@ -48,7 +49,7 @@ export const Editor: React.FC<EditorProps> = ({
   language,
   text,
   hideCopyButton,
-  onCopy,
+  on,
   onChange,
   snippetsBaseUrl,
 }) => {
@@ -61,7 +62,7 @@ export const Editor: React.FC<EditorProps> = ({
         .writeText(text)
         // eslint-disable-next-line no-console
         .catch(() => console.error('Failed to copy'));
-      onCopy?.(text, language);
+      on?.copy?.(text, language);
       setIsCodeByteCopied(true);
     }
   };
@@ -81,6 +82,7 @@ export const Editor: React.FC<EditorProps> = ({
     };
     setStatus('waiting');
     setOutput('');
+    on?.run?.();
 
     try {
       const response = await postSnippet(data, snippetsBaseUrl);

package/src/index.tsx

@@ -3,22 +3,28 @@ import { FaviconIcon } from '@codecademy/gamut-icons';
 import { Background, states, system } from '@codecademy/gamut-styles';
 import { StyleProps } from '@codecademy/variance';
 import styled from '@emotion/styled';
-import React, { useState } from 'react';
+import React, { useEffect, useState } from 'react';
 
 import { helloWorld, languageOption } from './consts';
 import { Editor } from './editor';
 import { LanguageSelection } from './languageSelection';
 
-type ChangeHandler = (text: string, language: languageOption) => void;
+type CodebytesChangeHandler = (text: string, language: languageOption) => void;
+export type CodebytesChangeHandlerMap = {
+  logoClick?: () => void;
+  edit?: CodebytesChangeHandler;
+  languageChange?: CodebytesChangeHandler;
+  copy?: CodebytesChangeHandler;
+  run?: () => void;
+};
+
 export interface CodeByteEditorProps {
-  text: string;
-  language: languageOption;
-  hideCopyButton: boolean;
-  onCopy?: (text: string, language: string) => void;
+  text?: string;
+  language?: languageOption;
+  hideCopyButton?: boolean;
   isIFrame?: boolean;
-  snippetsBaseUrl?: string /* TODO in DISC-353: Determine best way to host and include snippets endpoint for both staging and production in both the monolith and next.js repo. */;
-  onEdit?: ChangeHandler;
-  onLanguageChange?: ChangeHandler;
+  snippetsBaseUrl?: string;
+  on?: CodebytesChangeHandlerMap;
 }
 
 const editorStates = states({
@@ -46,15 +52,23 @@ const EditorContainer = styled(Background)<EditorStyleProps>(
 export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
   text: initialText,
   language: initialLanguage,
-  hideCopyButton,
-  onCopy,
+  hideCopyButton = false,
   isIFrame = false,
-  snippetsBaseUrl = '',
-  onEdit,
-  onLanguageChange,
+  on,
+  snippetsBaseUrl = process.env.CONTAINER_API_BASE,
 }) => {
-  const [text, setText] = useState<string>(initialText);
-  const [language, setLanguage] = useState<languageOption>(initialLanguage);
+  const [text, setText] = useState<string>(initialText ?? '');
+  const [language, setLanguage] = useState<languageOption>(
+    initialLanguage ?? ''
+  );
+
+  /* Resetting the state when the props change. If the language changes and the text is not provided output helloworld  */
+  useEffect(() => {
+    if (language) {
+      setText(initialText ?? (helloWorld[language] || ''));
+    }
+  }, [language, initialText]);
+
   return (
     <EditorContainer bg="black" as="main" isIFrame={isIFrame}>
       <Box borderBottom={1} borderColor="gray-900" py={4} pl={8}>
@@ -65,6 +79,7 @@ export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
           target="_blank"
           rel="noreferrer"
           aria-label="visit codecademy.com"
+          onClick={() => on?.logoClick?.()}
         />
       </Box>
       {language ? (
@@ -74,12 +89,9 @@ export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
           hideCopyButton={hideCopyButton}
           onChange={(newText: string) => {
             setText(newText);
-            onEdit?.(
-              newText,
-              language
-            ); /* TODO: in DISC-355 update component to use an object that contains all change handlers */
+            on?.edit?.(newText, language);
           }}
-          onCopy={onCopy}
+          on={on}
           snippetsBaseUrl={snippetsBaseUrl}
         />
       ) : (
@@ -88,10 +100,7 @@ export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
             const newText: string = text || helloWorld[newLanguage] || '';
             setLanguage(newLanguage);
             setText(newText);
-            onLanguageChange?.(
-              newText,
-              newLanguage
-            ); /* TODO: in DISC-355 update component to use an object that contains all change handlers */
+            on?.languageChange?.(newText, newLanguage);
           }}
         />
       )}

package/src/languageSelection.tsx

@@ -1,5 +1,5 @@
 import { Select } from '@codecademy/gamut';
-import { Background, themed } from '@codecademy/gamut-styles';
+import { Background } from '@codecademy/gamut-styles';
 import styled from '@emotion/styled';
 import React from 'react';
 
@@ -8,19 +8,18 @@ import { languageOptions } from './consts';
 
 const StyledSelect = styled(Select)`
   margin-top: 1rem;
-  color: ${themed('colors.text')};
-
+  color: ${({ theme }) => theme.colors.text};
   select {
-    color: ${themed('colors.text')};
-    background-color: ${themed('colors.black')};
+    color: ${({ theme }) => theme.colors.text};
+    background-color: ${({ theme }) => theme.colors.black};
 
     &:hover,
     &:active,
     &:focus {
-      border-color: ${themed('colors.primary')};
+      border-color: ${({ theme }) => theme.colors.primary};
     }
     &:focus {
-      box-shadow: inset 0 0 0 1px ${themed('colors.primary')};
+      box-shadow: inset 0 0 0 1px ${({ theme }) => theme.colors.primary};
     }
   }
 `;
@@ -34,10 +33,10 @@ export const LanguageSelection: React.FC<LanguageSelectionProps> = ({
 }) => {
   return (
     <Background bg="black" flex={1} px={16} pt={48}>
-      What language do you want to write?
+      Which language do you want to code in?
       <StyledSelect
         id="language-select"
-        aria-label="Select your language"
+        aria-label="Select a language"
         options={languageOptions}
         onChange={(e) => onChange(e.target.value as languageOption)}
       />