@codecademy/codebytes 0.4.1-alpha.354338.0 → 0.4.1-alpha.4ac9d1.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.4.1-alpha.354338.0](https://github.com/Codecademy/client-modules/compare/@codecademy/codebytes@0.4.0...@codecademy/codebytes@0.4.1-alpha.354338.0) (2022-01-23)
+### [0.4.1-alpha.4ac9d1.0](https://github.com/Codecademy/client-modules/compare/@codecademy/codebytes@0.4.0...@codecademy/codebytes@0.4.1-alpha.4ac9d1.0) (2022-01-26)
 
 **Note:** Version bump only for package @codecademy/codebytes
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codecademy/codebytes",
   "description": "Codebytes Code Editor",
-  "version": "0.4.1-alpha.354338.0",
+  "version": "0.4.1-alpha.4ac9d1.0",
   "author": "Codecademy Engineering <dev@codecademy.com>",
   "sideEffects": [
     "**/*.css",
@@ -43,18 +43,14 @@
   },
   "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/jsuri": "^1.3.30",
-    "@types/loadable__component": "^5.13.2",
-    "monaco-editor-webpack-plugin": "1.9.1"
+    "@types/loadable__component": "^5.13.2"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "41eb8781f582f67b5fcc8d5e36109342876d3170"
+  "gitHead": "8fd3371c13836350c50da4dfd161117b840e0227"
 }

package/src/consts.ts

@@ -16,7 +16,7 @@ export type LanguageOption = keyof typeof LanguageOptions;
 
 export const validLanguages = Object.keys(LanguageOptions).filter(
   (option) => !!option
-) as Exclude<LanguageOption, ''>[];
+) as LanguageOption[];
 
 const cpp = `#include <iostream>
 int main() {

package/src/editor.tsx

@@ -14,7 +14,6 @@ import type { LanguageOption } from './consts';
 import { Drawers } from './drawers';
 import { trackClick } from './helpers';
 import { SimpleMonacoEditor } from './MonacoEditor';
-import { CodebytesChangeHandler } from './types';
 
 const Output = styled.pre<{ hasError: boolean }>`
   width: 100%;
@@ -41,8 +40,8 @@ type EditorProps = {
   language: LanguageOption;
   text: string;
   onChange: (text: string) => void;
+  onCopy?: (text: string, language: string) => void;
   snippetsBaseUrl?: string;
-  onCopy?: CodebytesChangeHandler;
 };
 
 export const Editor: React.FC<EditorProps> = ({
@@ -50,19 +49,21 @@ export const Editor: React.FC<EditorProps> = ({
   text,
   hideCopyButton,
   onChange,
-  snippetsBaseUrl,
   onCopy,
+  snippetsBaseUrl,
 }) => {
   const [output, setOutput] = useState('');
   const [status, setStatus] = useState<'ready' | 'waiting' | 'error'>('ready');
   const [isCodeByteCopied, setIsCodeByteCopied] = useState(false);
   const onCopyClick = () => {
     if (!isCodeByteCopied) {
-      // eslint-disable-next-line @typescript-eslint/no-floating-promises
-      navigator.clipboard.writeText(text);
+      navigator.clipboard
+        .writeText(text)
+        // eslint-disable-next-line no-console
+        .catch(() => console.error('Failed to copy'));
+      onCopy?.(text, language);
       setIsCodeByteCopied(true);
       trackClick('copy');
-      onCopy?.(text, language);
     }
   };
 
@@ -132,20 +133,15 @@ export const Editor: React.FC<EditorProps> = ({
                 variant="secondary"
                 onClick={onCopyClick}
                 onBlur={() => setIsCodeByteCopied(false)}
-                data-testid="copy-codebyte-btn"
               >
                 <CopyIconStyled aria-hidden="true" /> Copy Codebyte
               </TextButton>
             }
           >
             {isCodeByteCopied ? (
-              <span data-testid="copy-confirmation-tooltip" role="alert">
-                Copied!
-              </span>
+              <span role="alert">Copied!</span>
             ) : (
-              <span data-testid="copy-prompt-tooltip">
-                Copy to your clipboard
-              </span>
+              <span>Copy to your clipboard</span>
             )}
           </ToolTip>
         ) : null}

package/src/index.tsx

@@ -13,7 +13,7 @@ import { trackUserImpression } from './libs/eventTracking';
 import { CodeByteEditorProps } from './types';
 
 const editorStates = states({
-  isIFrame: { height: '100vh' },
+  isForums: { height: '100vh' },
 });
 
 const editorBaseStyles = system.css({
@@ -37,40 +37,33 @@ const EditorContainer = styled(Background)<EditorStyleProps>(
 export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
   text: initialText,
   language: initialLanguage,
-  hideCopyButton = false,
-  isIFrame = false,
+  hideCopyButton,
+  isForums = false,
   snippetsBaseUrl = process.env.CONTAINER_API_BASE,
   onEdit,
   onLanguageChange,
-  onCopy,
 }) => {
-  const [text, setText] = useState<string>(initialText ?? '');
-  const [language, setLanguage] = useState<LanguageOption>(
-    initialLanguage ?? ''
-  );
+  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',
-    });
-  }, []);
+    if (isForums) {
+      const options = getOptions();
+      const page_name = options.renderMode
+        ? `${options.clientName}_${options.renderMode}`
+        : options.clientName;
 
-  useEffect(() => {
-    if (language) {
-      setText(initialText ?? (helloWorld[language] || ''));
+      trackUserImpression({
+        page_name,
+        context: options.parentPage,
+        target: 'codebyte',
+      });
     }
-  }, [language, initialText]);
+  }, [isForums]);
 
   return (
-    <EditorContainer bg="black" as="main" isIFrame={isIFrame}>
+    <EditorContainer bg="black" as="main" isForums={isForums}>
       <Box borderBottom={1} borderColor="gray-900" py={4} pl={8}>
         <IconButton
           icon={FaviconIcon}
@@ -90,6 +83,7 @@ export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
           onChange={(newText: string) => {
             setText(newText);
             onEdit?.(newText, language);
+
             const { renderMode } = getOptions();
             if (!renderMode && hasBeenEdited === false) {
               setHasBeenEdited(true);
@@ -97,7 +91,6 @@ export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
             }
           }}
           snippetsBaseUrl={snippetsBaseUrl}
-          onCopy={onCopy}
         />
       ) : (
         <LanguageSelection
@@ -106,7 +99,6 @@ export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
               text || (newLanguage ? helloWorld[newLanguage] : '');
             setLanguage(newLanguage);
             setText(newText);
-            onLanguageChange?.(newText, newLanguage);
             trackClick('lang_select');
             onLanguageChange?.(newText, newLanguage);
           }}

package/src/libs/eventTracking.ts

@@ -1,8 +1,11 @@
 import { createTracker } from '@codecademy/tracking';
 
 const IS_DEV = process.env.NODE_ENV === 'development';
+// TODO: confirm tracking details and implementation DISC-447
 const API_BASE_URL =
-  process.env.GATSBY_MONOLITH_API_BASE || 'https://www.codecademy.com';
+  process.env.NODE_ENV === 'production'
+    ? 'https://www.codecademy.com'
+    : 'https://staging.codecademy.com/';
 
 const tracker = createTracker({
   apiBaseUrl: API_BASE_URL,

package/src/types.ts

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

package/jest.config.js

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

package/src/__tests__/codebyte-test.tsx

@@ -1,197 +0,0 @@
-import './mocks';
-
-import { setupRtl } from '@codecademy/gamut-tests';
-import userEvent from '@testing-library/user-event';
-import { encode } from 'js-base64';
-import React from 'react';
-
-import { CodeByteEditor } from '..';
-import { helloWorld, validLanguages } from '../consts';
-import { trackClick } from '../helpers';
-import { trackUserImpression } from '../libs/eventTracking';
-import { CodeByteEditorProps } from '../types';
-
-const mockEditorTestId = 'mock-editor-test-id';
-
-// 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, {});
-
-type RenderWrapperWithProps = CodeByteEditorProps & { mode?: string };
-
-const renderWrapperWith = ({ mode, ...rest }: RenderWrapperWithProps) => {
-  const url = new URL(window.location.href);
-
-  const { text, language } = rest;
-  if (text) {
-    url.searchParams.set('text', encode(text));
-  }
-  if (language) {
-    url.searchParams.set('lang', language);
-  }
-  url.searchParams.set('client-name', 'forum');
-  url.searchParams.set(
-    'page',
-    'https://discuss.codecademy.com/some-interesting/post'
-  );
-  if (mode) {
-    url.searchParams.set('mode', mode);
-  }
-  window.history.replaceState({}, '', url.toString());
-
-  return renderWrapper(rest);
-};
-
-describe('CodeBytes', () => {
-  const initialUrl = window.location.href;
-
-  afterEach(() => {
-    window.history.replaceState(null, '', initialUrl);
-    (trackClick as any).mockReset();
-    (trackUserImpression as any).mockReset();
-  });
-
-  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);
-  });
-
-  describe('Change Handlers', () => {
-    it('triggers onEdit on text edit', () => {
-      const onEdit = jest.fn();
-      const { view } = renderWrapper({
-        text: '',
-        language: 'javascript',
-        onEdit,
-      });
-
-      const editor = view.getByTestId(mockEditorTestId);
-      userEvent.type(editor, 'dog');
-
-      expect(onEdit).toHaveBeenCalledTimes(3);
-      expect(onEdit).toHaveBeenLastCalledWith('dog', 'javascript');
-    });
-
-    it('triggers onLanguageChange on language selection', () => {
-      const onLanguageChange = jest.fn();
-      const { view } = renderWrapper({
-        onLanguageChange,
-      });
-
-      const selectedLanguage = view.getByRole('combobox') as Element;
-      userEvent.selectOptions(selectedLanguage, ['javascript']);
-
-      expect(onLanguageChange).toHaveBeenCalledWith(
-        "console.log('Hello world!');",
-        'javascript'
-      );
-    });
-  });
-
-  describe('Tracking', () => {
-    it('triggers trackClick on clicking the logo', () => {
-      const { view } = renderWrapper({});
-      const logo = view.getByLabelText('visit codecademy.com');
-      userEvent.click(logo);
-      expect(trackClick).toHaveBeenCalledWith('logo');
-    });
-
-    it('triggers trackClick on language selection', () => {
-      const { view } = renderWrapper();
-      const selectedLanguage = view.getByRole('combobox') as Element;
-      userEvent.selectOptions(selectedLanguage, ['javascript']);
-      expect(trackClick).toHaveBeenCalledWith('lang_select');
-    });
-
-    it('triggers trackClick for the first edit in view mode', () => {
-      const testString = 'original-value';
-      const { view } = renderWrapper({
-        text: testString,
-        language: 'javascript',
-      });
-
-      const editor = view.getByTestId(mockEditorTestId);
-      userEvent.type(editor, 'd');
-
-      expect(trackClick).toHaveBeenCalledWith('edit');
-    });
-
-    it('triggers trackUserImpression for view mode', () => {
-      renderWrapperWith({
-        text: 'some-value',
-        language: 'javascript',
-      });
-
-      expect(trackUserImpression).toHaveBeenCalledWith({
-        page_name: 'forum',
-        context: 'https://discuss.codecademy.com/some-interesting/post',
-        target: 'codebyte',
-      });
-    });
-
-    it('triggers trackUserImpression for compose mode', () => {
-      renderWrapperWith({
-        text: 'some-value',
-        language: 'javascript',
-        mode: 'compose',
-      });
-
-      expect(trackUserImpression).toHaveBeenCalledWith({
-        page_name: 'forum_compose',
-        context: 'https://discuss.codecademy.com/some-interesting/post',
-        target: 'codebyte',
-      });
-    });
-  });
-});

package/src/__tests__/editor-test.tsx

@@ -1,113 +0,0 @@
-import './mocks';
-
-import { setupRtl } from '@codecademy/gamut-tests';
-import { act } from '@testing-library/react';
-import userEvent from '@testing-library/user-event';
-import React from 'react';
-
-import { Editor } from '../editor';
-import { trackClick } from '../helpers';
-
-jest.mock('../MonacoEditor', () => ({
-  SimpleMonacoEditor: ({ value }: { value: string }) => <>{value}</>,
-}));
-
-const renderWrapper = setupRtl(Editor, {
-  hideCopyButton: false,
-  language: 'javascript',
-  text: 'hello world',
-  onChange: jest.fn(),
-  snippetsBaseUrl: '',
-});
-
-Object.defineProperty(navigator, 'clipboard', {
-  value: {
-    writeText: jest.fn(),
-  },
-});
-
-describe('Editor', () => {
-  (global as any).fetch = jest.fn();
-  afterEach(() => {
-    (global as any).fetch.mockClear();
-  });
-
-  it('shows a prompt tooltip when the CodeByte has __not__ been copied via the button', () => {
-    const { view } = renderWrapper();
-    expect(view.queryByTestId('copy-confirmation-tooltip')).toBeFalsy();
-    view.getByTestId('copy-prompt-tooltip');
-  });
-
-  it('shows a confirmation tooltip when the CodeByte has been copied via the button', () => {
-    const { view } = renderWrapper();
-    const copyBtn = view.getByTestId('copy-codebyte-btn');
-    userEvent.click(copyBtn as HTMLButtonElement);
-    expect(view.queryByTestId('copy-prompt-tooltip')).toBeFalsy();
-    view.getByTestId('copy-confirmation-tooltip');
-  });
-
-  it('hides the copy codebyte button if hideCopyButton prop is true"', () => {
-    const { view } = renderWrapper({
-      hideCopyButton: true,
-    });
-    expect(view.queryByTestId('copy-codebyte-btn')).toBeNull();
-  });
-
-  it('shows the copy codebyte button if hideCopyButton prop is not set', () => {
-    const { view } = renderWrapper();
-
-    view.getByTestId('copy-codebyte-btn');
-  });
-
-  describe('Change Handlers', () => {
-    it('triggers onCopy upon clicking the copy button', () => {
-      const onCopy = jest.fn();
-      const { view } = renderWrapper({
-        onCopy,
-      });
-
-      const copyButton = view.getByTestId('copy-codebyte-btn');
-      userEvent.click(copyButton);
-
-      expect(onCopy).toHaveBeenCalled();
-    });
-  });
-
-  describe('Tracking', () => {
-    it('tracks clicks on the run button', async () => {
-      (global as any).fetch.mockResolvedValue({
-        json: () =>
-          Promise.resolve({
-            stderr: [],
-            exit_code: 0,
-            stdout: '',
-          }),
-      });
-      const { view } = renderWrapper({
-        onChange: jest.fn(),
-        text: 'test',
-        language: 'javascript',
-      });
-
-      const runButton = view.getByText('Run');
-      await act(async () => {
-        userEvent.click(runButton);
-      });
-
-      expect(trackClick).toHaveBeenCalledWith('run');
-    });
-
-    it('tracks clicks on the copy codebyte button', () => {
-      const { view } = renderWrapper({
-        onChange: jest.fn(),
-        text: 'test',
-        language: 'javascript',
-      });
-
-      const copyButton = view.getByTestId('copy-codebyte-btn');
-      userEvent.click(copyButton);
-
-      expect(trackClick).toHaveBeenCalledWith('copy');
-    });
-  });
-});

package/src/__tests__/helpers-test.tsx

@@ -1,121 +0,0 @@
-import { encode } from 'js-base64';
-
-import { CodebytesParams, getOptions, trackClick } from '../helpers';
-import { trackUserClick } from '../libs/eventTracking';
-
-jest.mock('../libs/eventTracking');
-
-const initialUrl = window.location.href;
-const resetCodebytesParams = () =>
-  window.history.replaceState(null, '', initialUrl);
-type SetCodebytesParamsProps = Record<CodebytesParams, string>;
-const setCodebytesParams = (params: SetCodebytesParamsProps) => {
-  if (params.text) {
-    params.text = encode(params.text);
-  }
-
-  const url = new URL(window.location.href);
-  Object.entries(params).forEach(([key, value]) => {
-    url.searchParams.set(key, value);
-  });
-
-  window.history.replaceState({}, '', url.toString());
-};
-
-describe('getOptions', () => {
-  afterEach(() => {
-    resetCodebytesParams();
-  });
-
-  it('parses props out of the window locations', () => {
-    const text = `
-    const msg = 'Sup?';
-    console.log(msg);
-    `.trim();
-    setCodebytesParams({
-      lang: 'javascript',
-      text,
-      'copy-mode': '',
-      'client-name': 'forum',
-      page: 'https://discuss.codecademy.com/some-interesting/post',
-      mode: 'compose',
-    });
-
-    expect(getOptions()).toEqual({
-      clientName: 'forum',
-      parentPage: 'https://discuss.codecademy.com/some-interesting/post',
-      renderMode: 'compose',
-    });
-  });
-});
-
-describe('trackClick', () => {
-  afterEach(() => {
-    resetCodebytesParams();
-    (trackUserClick as any).mockReset();
-  });
-
-  it('proxies to trackUserClick setting the page_name, context, and target', () => {
-    const target = 'foobar';
-    setCodebytesParams({
-      lang: 'javascript',
-      text: `
-      const msg = 'Sup?';
-      console.log(msg);
-      `.trim(),
-      'copy-mode': '',
-      'client-name': 'forum',
-      page: 'https://discuss.codecademy.com/some-interesting/post',
-      mode: '',
-    });
-    trackClick(target);
-    expect(trackUserClick).toHaveBeenCalledWith({
-      page_name: 'forum',
-      context: 'https://discuss.codecademy.com/some-interesting/post',
-      target,
-    });
-  });
-
-  it('defaults the client name to "Unknown"', () => {
-    const target = 'foobar';
-    setCodebytesParams({
-      lang: 'javascript',
-      text: `
-      const msg = 'Sup?';
-      console.log(msg);
-      `.trim(),
-      'copy-mode': '',
-      'client-name': '',
-      page: 'https://discuss.codecademy.com/some-interesting/post',
-      mode: '',
-    });
-    trackClick(target);
-    expect(trackUserClick).toHaveBeenCalledWith({
-      page_name: 'Unknown',
-      context: 'https://discuss.codecademy.com/some-interesting/post',
-      target,
-    });
-  });
-
-  it('embeds the render mode into the page_name', () => {
-    const mode = 'compose';
-    const target = 'foobar';
-    setCodebytesParams({
-      lang: 'javascript',
-      text: `
-      const msg = 'Sup?';
-      console.log(msg);
-      `.trim(),
-      'copy-mode': '',
-      'client-name': 'forum',
-      page: 'https://discuss.codecademy.com/some-interesting/post',
-      mode,
-    });
-    trackClick(target);
-    expect(trackUserClick).toHaveBeenCalledWith({
-      page_name: `forum_${mode}`,
-      context: 'https://discuss.codecademy.com/some-interesting/post',
-      target,
-    });
-  });
-});

package/src/__tests__/language-selection-test.tsx

@@ -1,14 +0,0 @@
-import { setupRtl } from '@codecademy/gamut-tests';
-
-import { LanguageSelection } from '../languageSelection';
-
-const renderWrapper = setupRtl(LanguageSelection, {
-  onChange: () => null,
-});
-
-describe('LanguageSelection', () => {
-  it('has placeholder text', () => {
-    const { view } = renderWrapper();
-    view.getByText('Which language do you want to code in?');
-  });
-});

package/src/__tests__/mocks.ts

@@ -1,8 +0,0 @@
-jest.mock('react-resize-observer');
-jest.mock('../libs/eventTracking');
-jest.mock('../helpers', () => ({
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-  // @ts-ignore
-  ...jest.requireActual('../helpers'),
-  trackClick: jest.fn(),
-}));