@codecademy/codebytes 0.2.1-alpha.f45f38.0 → 0.3.1-alpha.16a37d.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.f45f38.0](https://github.com/Codecademy/client-modules/compare/@codecademy/codebytes@0.2.0...@codecademy/codebytes@0.2.1-alpha.f45f38.0) (2022-01-11)
+### [0.3.1-alpha.16a37d.0](https://github.com/Codecademy/client-modules/compare/@codecademy/codebytes@0.3.0...@codecademy/codebytes@0.3.1-alpha.16a37d.0) (2022-01-21)
 
 **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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codecademy/codebytes",
   "description": "Codebytes Code Editor",
-  "version": "0.2.1-alpha.f45f38.0",
+  "version": "0.3.1-alpha.16a37d.0",
   "author": "Codecademy Engineering <dev@codecademy.com>",
   "sideEffects": [
     "**/*.css",
@@ -23,11 +23,13 @@
     "@codecademy/gamut": "*",
     "@codecademy/gamut-icons": "*",
     "@codecademy/gamut-styles": "*",
+    "@codecademy/tracking": "0.18.0",
     "@codecademy/variance": "*",
     "@emotion/react": "^11.4.0",
     "@emotion/styled": "^11.3.0",
-    "@loadable/component": "^5.13.1",
     "@monaco-editor/react": "4.3.1",
+    "js-base64": "^3.6.0",
+    "jsuri": "^1.3.1",
     "monaco-editor": ">= 0.25.0 < 1",
     "react-resize-observer": "1.1.1"
   },
@@ -44,11 +46,11 @@
     "@emotion/jest": "^11.3.0",
     "@testing-library/dom": "^7.31.2",
     "@testing-library/react": "^11.0.4",
-    "@types/loadable__component": "^5.13.2",
-    "monaco-editor-webpack-plugin": "1.9.1"
+    "@types/jsuri": "^1.3.30",
+    "@types/loadable__component": "^5.13.2"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "783fed789d9754d46535c05f38b2a8a8185aa298"
+  "gitHead": "f6569c17f562407f3f6873b2e3f8949794028656"
 }

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/api.ts

@@ -1,4 +1,4 @@
-import type { languageOption } from './consts';
+import type { LanguageOption } from './consts';
 
 interface Response {
   stderr: string;
@@ -7,7 +7,7 @@ interface Response {
 }
 
 interface PostSnippetData {
-  language: languageOption;
+  language: LanguageOption;
   code: string;
 }
 

package/src/consts.ts

@@ -1,7 +1,7 @@
 // key = language param to send to snippets service
 // val = label in language selection drop down
-export const languageOptions = {
-  '': 'Select your language',
+export const LanguageOptions = {
+  '': 'Select a language',
   cpp: 'C++',
   csharp: 'C#',
   golang: 'Go',
@@ -12,4 +12,53 @@ export const languageOptions = {
   scheme: 'Scheme',
 };
 
-export type languageOption = keyof typeof languageOptions;
+export type LanguageOption = keyof typeof LanguageOptions;
+
+export const validLanguages = Object.keys(LanguageOptions).filter(
+  (option) => !!option
+) as LanguageOption[];
+
+const cpp = `#include <iostream>
+int main() {
+  std::cout << "Hello world!";
+  return 0;
+}`;
+
+const csharp = `namespace HelloWorld {
+  class Hello {
+    static void Main(string[] args) {
+      System.Console.WriteLine("Hello world!");
+    }
+  }
+}`;
+
+const golang = `package main
+import "fmt"
+func main() {
+  fmt.Println("Hello world!")
+}`;
+
+const javascript = "console.log('Hello world!');";
+
+const php = `<?php
+  echo "Hello world!";
+?>`;
+
+const python = "print('Hello world!')";
+
+const ruby = 'puts "Hello world!"';
+
+const scheme = `(begin
+  (display "Hello world!")
+  (newline))`;
+
+export const helloWorld = {
+  cpp,
+  csharp,
+  golang,
+  javascript,
+  php,
+  python,
+  ruby,
+  scheme,
+} as const;

package/src/editor.tsx

@@ -6,13 +6,13 @@ 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 { postSnippet } from './api';
-import type { languageOption } from './consts';
+import type { LanguageOption } from './consts';
 import { Drawers } from './drawers';
+import { trackClick } from './helpers';
 import { SimpleMonacoEditor } from './MonacoEditor';
 
 const Output = styled.pre<{ hasError: boolean }>`
@@ -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']};
 `}
 `;
 
@@ -37,10 +37,9 @@ const DOCKER_SIGTERM = 143;
 
 type EditorProps = {
   hideCopyButton: boolean;
-  language: languageOption;
+  language: LanguageOption;
   text: string;
   onChange: (text: string) => void;
-  onCopy?: (text: string, language: string) => void;
   snippetsBaseUrl?: string;
 };
 
@@ -48,7 +47,6 @@ export const Editor: React.FC<EditorProps> = ({
   language,
   text,
   hideCopyButton,
-  onCopy,
   onChange,
   snippetsBaseUrl,
 }) => {
@@ -61,8 +59,8 @@ export const Editor: React.FC<EditorProps> = ({
         .writeText(text)
         // eslint-disable-next-line no-console
         .catch(() => console.error('Failed to copy'));
-      onCopy?.(text, language);
       setIsCodeByteCopied(true);
+      trackClick('copy');
     }
   };
 
@@ -81,6 +79,7 @@ export const Editor: React.FC<EditorProps> = ({
     };
     setStatus('waiting');
     setOutput('');
+    trackClick('run');
 
     try {
       const response = await postSnippet(data, snippetsBaseUrl);

package/src/helpers/index.ts

@@ -0,0 +1,43 @@
+import Uri from 'jsuri';
+
+import { trackUserClick } from '../libs/eventTracking';
+
+export type CodebyteOptions = {
+  clientName: string;
+  parentPage: string;
+  renderMode: string;
+};
+
+export enum CodebytesParams {
+  Language = 'lang',
+  Text = 'text',
+  CopyMode = 'copy-mode',
+  ClientName = 'client-name',
+  Page = 'page',
+  Mode = 'mode',
+}
+
+export const getOptions = (): CodebyteOptions => {
+  const currentUri = new Uri(window.location.href);
+
+  return {
+    clientName:
+      currentUri.getQueryParamValue(CodebytesParams.ClientName) || 'Unknown',
+    parentPage:
+      currentUri.getQueryParamValue(CodebytesParams.Page) || document.referrer,
+    renderMode: currentUri.getQueryParamValue(CodebytesParams.Mode) || '',
+  };
+};
+
+export const trackClick = (target: string) => {
+  const options = getOptions();
+  const page_name = options.renderMode
+    ? `${options.clientName}_${options.renderMode}`
+    : options.clientName;
+
+  trackUserClick({
+    page_name,
+    context: options.parentPage,
+    target,
+  });
+};

package/src/index.tsx

@@ -3,20 +3,14 @@ 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 { languageOption } from './consts';
+import { helloWorld, LanguageOption } from './consts';
 import { Editor } from './editor';
-
-export interface CodeByteEditorProps {
-  text: string;
-  language: languageOption;
-  hideCopyButton: boolean;
-  onCopy?: (text: string, language: string) => void;
-  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. */;
-  onTextChange?: (text: string) => void;
-}
+import { getOptions, trackClick } from './helpers';
+import { LanguageSelection } from './languageSelection';
+import { trackUserImpression } from './libs/eventTracking';
+import { CodeByteEditorProps } from './types';
 
 const editorStates = states({
   isIFrame: { height: '100vh' },
@@ -42,14 +36,28 @@ const EditorContainer = styled(Background)<EditorStyleProps>(
 
 export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
   text: initialText,
-  language,
+  language: initialLanguage,
   hideCopyButton,
-  onCopy,
   isIFrame = false,
-  snippetsBaseUrl = '',
-  onTextChange,
+  snippetsBaseUrl = process.env.CONTAINER_API_BASE,
 }) => {
   const [text, setText] = useState<string>(initialText);
+  const [language, setLanguage] = useState<LanguageOption>(initialLanguage);
+  const [hasBeenEdited, setHasBeenEdited] = useState(false);
+
+  useEffect(() => {
+    const options = getOptions();
+    const page_name = options.renderMode
+      ? `${options.clientName}_${options.renderMode}`
+      : options.clientName;
+
+    trackUserImpression({
+      page_name,
+      context: options.parentPage,
+      target: 'codebyte',
+    });
+  }, []);
+
   return (
     <EditorContainer bg="black" as="main" isIFrame={isIFrame}>
       <Box borderBottom={1} borderColor="gray-900" py={4} pl={8}>
@@ -60,19 +68,36 @@ export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
           target="_blank"
           rel="noreferrer"
           aria-label="visit codecademy.com"
+          onClick={() => trackClick('logo')}
         />
       </Box>
-      <Editor
-        language={language}
-        text={text}
-        hideCopyButton={hideCopyButton}
-        onChange={(newText: string) => {
-          setText(newText);
-          onTextChange?.(newText);
-        }}
-        onCopy={onCopy}
-        snippetsBaseUrl={snippetsBaseUrl}
-      />
+      {language ? (
+        <Editor
+          language={language}
+          text={text}
+          hideCopyButton={hideCopyButton}
+          onChange={(newText: string) => {
+            setText(newText);
+
+            const { renderMode } = getOptions();
+            if (!renderMode && hasBeenEdited === false) {
+              setHasBeenEdited(true);
+              trackClick('edit');
+            }
+          }}
+          snippetsBaseUrl={snippetsBaseUrl}
+        />
+      ) : (
+        <LanguageSelection
+          onChange={(newLanguage) => {
+            const newText: string =
+              text || (newLanguage ? helloWorld[newLanguage] : '');
+            setLanguage(newLanguage);
+            setText(newText);
+            trackClick('lang_select');
+          }}
+        />
+      )}
     </EditorContainer>
   );
 };

package/src/languageSelection.tsx

@@ -0,0 +1,26 @@
+import { Select, Text } from '@codecademy/gamut';
+import { ColorMode } from '@codecademy/gamut-styles';
+import React from 'react';
+
+import type { LanguageOption } from './consts';
+import { LanguageOptions } from './consts';
+
+export type LanguageSelectionProps = {
+  onChange: (newLanguage: LanguageOption) => void;
+};
+
+export const LanguageSelection: React.FC<LanguageSelectionProps> = ({
+  onChange,
+}) => {
+  return (
+    <ColorMode mode="dark" flex={1} px={16} pt={48}>
+      <Text mb={16}>Which language do you want to code in?</Text>
+      <Select
+        id="language-select"
+        aria-label="Select a language"
+        options={LanguageOptions}
+        onChange={(e) => onChange(e.target.value as LanguageOption)}
+      />
+    </ColorMode>
+  );
+};

package/src/libs/eventTracking.ts

@@ -0,0 +1,16 @@
+import { createTracker } from '@codecademy/tracking';
+
+const IS_DEV = process.env.NODE_ENV === 'development';
+const API_BASE_URL =
+  process.env.GATSBY_MONOLITH_API_BASE || 'https://www.codecademy.com';
+
+const tracker = createTracker({
+  apiBaseUrl: API_BASE_URL,
+  verbose: IS_DEV,
+});
+
+export const {
+  click: trackUserClick,
+  visit: trackUserVisit,
+  impression: trackUserImpression,
+} = tracker;

package/src/types.ts

@@ -0,0 +1,13 @@
+import { LanguageOption } from './consts';
+
+type CodebytesChangeHandler = (text: string, language: LanguageOption) => void;
+export interface CodeByteEditorProps {
+  text: string;
+  language: LanguageOption;
+  hideCopyButton: boolean;
+  onCopy?: CodebytesChangeHandler;
+  isIFrame?: boolean;
+  snippetsBaseUrl?: string;
+  onEdit?: CodebytesChangeHandler;
+  onLanguageChange?: CodebytesChangeHandler;
+}