@codecademy/codebytes 0.6.1 → 0.6.3-alpha.e74dd5.0

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().mockImplementation(() => Promise.resolve()),
-  },
-});
-
-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(),
-}));

package/src/api.ts

@@ -1,28 +0,0 @@
-import type { LanguageOption } from './consts';
-
-interface Response {
-  stderr: string;
-  stdout: string;
-  exit_code: number;
-}
-
-interface PostSnippetData {
-  language: LanguageOption;
-  code: string;
-}
-
-export const postSnippet = async (
-  data: PostSnippetData,
-  snippetsBaseUrl?: string
-): Promise<Response> => {
-  const snippetsEndpoint = `https://${snippetsBaseUrl}/snippets`;
-
-  const response = await fetch(snippetsEndpoint, {
-    method: 'POST',
-    body: JSON.stringify(data),
-    headers: {
-      'x-codecademy-user-id': 'codebytes-anon-user',
-    },
-  });
-  return response.json();
-};

package/src/codeByteEditor.tsx

@@ -1,118 +0,0 @@
-import { Box, IconButton } from '@codecademy/gamut';
-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, { useEffect, useState } from 'react';
-
-import { helloWorld, LanguageOption } from './consts';
-import { Editor } from './editor';
-import { getOptions, trackClick } from './helpers';
-import { LanguageSelection } from './languageSelection';
-import { trackUserImpression } from './libs/eventTracking';
-import { CodeByteEditorProps } from './types';
-
-const editorStates = states({
-  isIFrame: { height: '100vh' },
-});
-
-const editorBaseStyles = system.css({
-  border: 1,
-  borderColor: 'gray-900',
-  display: 'flex',
-  flexDirection: 'column',
-  height: '25rem',
-  width: '43rem',
-  overflow: 'hidden',
-});
-export interface EditorStyleProps
-  extends StyleProps<typeof editorBaseStyles>,
-    StyleProps<typeof editorStates> {}
-
-const EditorContainer = styled(Background)<EditorStyleProps>(
-  editorBaseStyles,
-  editorStates
-);
-
-export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
-  text: initialText,
-  language: initialLanguage,
-  hideCopyButton = false,
-  isIFrame = false,
-  snippetsBaseUrl,
-  onEdit,
-  onLanguageChange,
-  onCopy,
-}) => {
-  const getInitialText = () => {
-    if (initialText !== undefined) return initialText;
-    return initialLanguage ? helloWorld[initialLanguage] : '';
-  };
-
-  const [text, setText] = useState<string>(getInitialText());
-  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}>
-        <IconButton
-          icon={FaviconIcon}
-          variant="secondary"
-          href="https://www.codecademy.com/"
-          target="_blank"
-          rel="noreferrer"
-          aria-label="visit codecademy.com"
-          onClick={() => trackClick('logo')}
-        />
-      </Box>
-      {language ? (
-        <Editor
-          language={language}
-          text={text}
-          hideCopyButton={hideCopyButton}
-          onChange={(newText: string) => {
-            setText(newText);
-            onEdit?.(newText, language);
-            const { renderMode } = getOptions();
-            if (!renderMode && hasBeenEdited === false) {
-              setHasBeenEdited(true);
-              trackClick('edit');
-            }
-          }}
-          snippetsBaseUrl={snippetsBaseUrl}
-          onCopy={onCopy}
-        />
-      ) : (
-        <LanguageSelection
-          onChange={(newLanguage) => {
-            const newText: string =
-              text || (newLanguage ? helloWorld[newLanguage] : '');
-            setLanguage(newLanguage);
-            setText(newText);
-            trackClick('lang_select');
-            onLanguageChange?.(newText, newLanguage);
-            trackClick('lang_select');
-          }}
-        />
-      )}
-    </EditorContainer>
-  );
-};
-
-export default CodeByteEditor;

package/src/consts.ts

@@ -1,64 +0,0 @@
-// key = language param to send to snippets service
-// val = label in language selection drop down
-export const LanguageOptions = {
-  '': 'Select a language',
-  cpp: 'C++',
-  csharp: 'C#',
-  golang: 'Go',
-  javascript: 'JavaScript',
-  php: 'PHP',
-  python: 'Python 3',
-  ruby: 'Ruby',
-  scheme: 'Scheme',
-};
-
-export type LanguageOption = keyof typeof LanguageOptions;
-
-export const validLanguages = Object.keys(LanguageOptions).filter(
-  (option) => !!option
-) as Exclude<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;