@codecademy/codebytes 0.3.1-alpha.cef935.0 → 0.4.1-alpha.10e614.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -3,7 +3,7 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
- ### [0.3.1-alpha.cef935.0](https://github.com/Codecademy/client-modules/compare/@codecademy/codebytes@0.3.0...@codecademy/codebytes@0.3.1-alpha.cef935.0) (2022-01-13)
6
+ ### [0.4.1-alpha.10e614.0](https://github.com/Codecademy/client-modules/compare/@codecademy/codebytes@0.4.0...@codecademy/codebytes@0.4.1-alpha.10e614.0) (2022-01-25)
7
7
 
8
8
  **Note:** Version bump only for package @codecademy/codebytes
9
9
 
@@ -11,6 +11,15 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
11
11
 
12
12
 
13
13
 
14
+ ## [0.4.0](https://github.com/Codecademy/client-modules/compare/@codecademy/codebytes@0.3.0...@codecademy/codebytes@0.4.0) (2022-01-21)
15
+
16
+
17
+ ### Features
18
+
19
+ * **Codebytes:** move language selection component disc 354 ([#17](https://github.com/Codecademy/client-modules/issues/17)) ([040553d](https://github.com/Codecademy/client-modules/commit/040553dcc7867b6e331712365bcc19ea2df306d5))
20
+
21
+
22
+
14
23
  ## [0.3.0](https://github.com/Codecademy/client-modules/compare/@codecademy/codebytes@0.2.0...@codecademy/codebytes@0.3.0) (2022-01-12)
15
24
 
16
25
 
package/jest.config.js ADDED
@@ -0,0 +1 @@
1
+ module.exports = require('../../jest.config.base')('codebytes');
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@codecademy/codebytes",
3
3
  "description": "Codebytes Code Editor",
4
- "version": "0.3.1-alpha.cef935.0",
4
+ "version": "0.4.1-alpha.10e614.0",
5
5
  "author": "Codecademy Engineering <dev@codecademy.com>",
6
6
  "sideEffects": [
7
7
  "**/*.css",
@@ -23,10 +23,13 @@
23
23
  "@codecademy/gamut": "*",
24
24
  "@codecademy/gamut-icons": "*",
25
25
  "@codecademy/gamut-styles": "*",
26
+ "@codecademy/tracking": "0.18.0",
26
27
  "@codecademy/variance": "*",
27
28
  "@emotion/react": "^11.4.0",
28
29
  "@emotion/styled": "^11.3.0",
29
30
  "@monaco-editor/react": "4.3.1",
31
+ "js-base64": "^3.6.0",
32
+ "jsuri": "^1.3.1",
30
33
  "monaco-editor": ">= 0.25.0 < 1",
31
34
  "react-resize-observer": "1.1.1"
32
35
  },
@@ -40,13 +43,18 @@
40
43
  },
41
44
  "license": "MIT",
42
45
  "devDependencies": {
46
+ "@codecademy/gamut-tests": "*",
43
47
  "@emotion/jest": "^11.3.0",
44
48
  "@testing-library/dom": "^7.31.2",
45
49
  "@testing-library/react": "^11.0.4",
46
- "@types/loadable__component": "^5.13.2"
50
+ "@testing-library/react-hooks": "3.2.1",
51
+ "@testing-library/user-event": "13.1.1",
52
+ "@types/jsuri": "^1.3.30",
53
+ "@types/loadable__component": "^5.13.2",
54
+ "monaco-editor-webpack-plugin": "1.9.1"
47
55
  },
48
56
  "publishConfig": {
49
57
  "access": "public"
50
58
  },
51
- "gitHead": "0f05e194904faae9337cdbd57e84382acc355a92"
59
+ "gitHead": "02a804d14e940229bbd875ebadefaffa798d77c7"
52
60
  }
@@ -0,0 +1,210 @@
1
+ import './mocks';
2
+
3
+ import { setupRtl } from '@codecademy/gamut-tests';
4
+ import userEvent from '@testing-library/user-event';
5
+ import { encode } from 'js-base64';
6
+ import React from 'react';
7
+
8
+ import { CodeByteEditor } from '..';
9
+ import { helloWorld, validLanguages } from '../consts';
10
+ import { trackClick } from '../helpers';
11
+ import { trackUserImpression } from '../libs/eventTracking';
12
+ import { CodeByteEditorProps } from '../types';
13
+
14
+ const mockEditorTestId = 'mock-editor-test-id';
15
+
16
+ // This is a super simplified mock capable of render value and trigger onChange.
17
+ jest.mock('../MonacoEditor', () => ({
18
+ SimpleMonacoEditor: ({
19
+ value,
20
+ onChange,
21
+ }: {
22
+ value: string;
23
+ onChange?: (value: string) => void;
24
+ }) => (
25
+ <>
26
+ {value}
27
+ <input
28
+ data-testid={mockEditorTestId}
29
+ type="text"
30
+ onChange={(e) => {
31
+ onChange?.(e.target.value);
32
+ }}
33
+ value={value}
34
+ />
35
+ </>
36
+ ),
37
+ }));
38
+
39
+ const renderWrapper = setupRtl(CodeByteEditor, {});
40
+
41
+ type RenderWrapperWithProps = CodeByteEditorProps & { mode?: string };
42
+
43
+ const renderWrapperWith = ({ mode, ...rest }: RenderWrapperWithProps) => {
44
+ const url = new URL(window.location.href);
45
+
46
+ const { text, language } = rest;
47
+ if (text) {
48
+ url.searchParams.set('text', encode(text));
49
+ }
50
+ if (language) {
51
+ url.searchParams.set('lang', language);
52
+ }
53
+ url.searchParams.set('client-name', 'forum');
54
+ url.searchParams.set(
55
+ 'page',
56
+ 'https://discuss.codecademy.com/some-interesting/post'
57
+ );
58
+ if (mode) {
59
+ url.searchParams.set('mode', mode);
60
+ }
61
+ window.history.replaceState({}, '', url.toString());
62
+
63
+ return renderWrapper(rest);
64
+ };
65
+
66
+ describe('CodeBytes', () => {
67
+ const initialUrl = window.location.href;
68
+
69
+ afterEach(() => {
70
+ window.history.replaceState(null, '', initialUrl);
71
+ (trackClick as any).mockReset();
72
+ (trackUserImpression as any).mockReset();
73
+ });
74
+
75
+ it('has a language-specific "hello world" program defined for each language', () => {
76
+ validLanguages.forEach((language) => {
77
+ expect(helloWorld[language]).toBeDefined();
78
+ });
79
+ });
80
+
81
+ it('initializes with a language-specific "hello world" program when there is no language prop', () => {
82
+ const { view } = renderWrapper();
83
+ const selectedLanguage = view.getByRole('combobox') as Element;
84
+ userEvent.selectOptions(selectedLanguage, ['javascript']);
85
+ view.getByText(helloWorld.javascript);
86
+ });
87
+
88
+ it('initializes with a language-specific "hello world" program when there is a language prop but no text prop', () => {
89
+ const { view } = renderWrapper({ language: 'javascript' });
90
+ view.getByText(helloWorld.javascript);
91
+ });
92
+
93
+ it('initializes with deserialized text when there is a text prop but no language prop', () => {
94
+ const testString = 'yes hello';
95
+ const { view } = renderWrapper({ text: testString });
96
+ const selectedLanguage = view.getByRole('combobox') as Element;
97
+ userEvent.selectOptions(selectedLanguage, ['javascript']);
98
+ view.getByText(testString);
99
+ });
100
+
101
+ it('initializes with deserialized text when there is both a language and text prop', () => {
102
+ const testString = 'yes hello';
103
+ const { view } = renderWrapper({
104
+ text: testString,
105
+ language: 'javascript',
106
+ });
107
+ view.getByText(testString);
108
+ });
109
+
110
+ describe('Change Handlers', () => {
111
+ it('triggers onEdit on text edit', () => {
112
+ const onEdit = jest.fn();
113
+ const { view } = renderWrapper({
114
+ text: '',
115
+ language: 'javascript',
116
+ onEdit,
117
+ });
118
+
119
+ const editor = view.getByTestId(mockEditorTestId);
120
+ userEvent.type(editor, 'dog');
121
+
122
+ expect(onEdit).toHaveBeenCalledTimes(3);
123
+ expect(onEdit).toHaveBeenLastCalledWith('dog', 'javascript');
124
+ });
125
+
126
+ it('triggers onLanguageChange on language selection', () => {
127
+ const onLanguageChange = jest.fn();
128
+ const { view } = renderWrapper({
129
+ onLanguageChange,
130
+ });
131
+
132
+ const selectedLanguage = view.getByRole('combobox') as Element;
133
+ userEvent.selectOptions(selectedLanguage, ['javascript']);
134
+
135
+ expect(onLanguageChange).toHaveBeenCalledWith(
136
+ "console.log('Hello world!');",
137
+ 'javascript'
138
+ );
139
+ });
140
+ });
141
+
142
+ describe('Tracking', () => {
143
+ it('triggers trackClick on clicking the logo', () => {
144
+ const { view } = renderWrapper({});
145
+ const logo = view.getByLabelText('visit codecademy.com');
146
+ userEvent.click(logo);
147
+ expect(trackClick).toHaveBeenCalledWith('logo');
148
+ });
149
+
150
+ it('triggers trackClick on language selection', () => {
151
+ const { view } = renderWrapper();
152
+ const selectedLanguage = view.getByRole('combobox') as Element;
153
+ userEvent.selectOptions(selectedLanguage, ['javascript']);
154
+ expect(trackClick).toHaveBeenCalledWith('lang_select');
155
+ });
156
+
157
+ it('triggers trackClick for the first edit in view mode', () => {
158
+ const testString = 'original-value';
159
+ const { view } = renderWrapper({
160
+ text: testString,
161
+ language: 'javascript',
162
+ });
163
+
164
+ const editor = view.getByTestId(mockEditorTestId);
165
+ userEvent.type(editor, 'd');
166
+
167
+ expect(trackClick).toHaveBeenCalledWith('edit');
168
+ });
169
+
170
+ it('triggers trackUserImpression for view mode', () => {
171
+ renderWrapperWith({
172
+ text: 'some-value',
173
+ language: 'javascript',
174
+ isForums: true,
175
+ });
176
+
177
+ expect(trackUserImpression).toHaveBeenCalledWith({
178
+ page_name: 'forum',
179
+ context: 'https://discuss.codecademy.com/some-interesting/post',
180
+ target: 'codebyte',
181
+ });
182
+ });
183
+
184
+ it('triggers trackUserImpression for compose mode', () => {
185
+ renderWrapperWith({
186
+ text: 'some-value',
187
+ language: 'javascript',
188
+ mode: 'compose',
189
+ isForums: true,
190
+ });
191
+
192
+ expect(trackUserImpression).toHaveBeenCalledWith({
193
+ page_name: 'forum_compose',
194
+ context: 'https://discuss.codecademy.com/some-interesting/post',
195
+ target: 'codebyte',
196
+ });
197
+ });
198
+
199
+ it('does not trigger a trackUserImpression when not isForum is false', () => {
200
+ renderWrapperWith({
201
+ text: 'some-value',
202
+ language: 'javascript',
203
+ mode: 'compose',
204
+ isForums: false,
205
+ });
206
+
207
+ expect(trackUserImpression).not.toHaveBeenCalled();
208
+ });
209
+ });
210
+ });
@@ -0,0 +1,113 @@
1
+ import './mocks';
2
+
3
+ import { setupRtl } from '@codecademy/gamut-tests';
4
+ import { act } from '@testing-library/react';
5
+ import userEvent from '@testing-library/user-event';
6
+ import React from 'react';
7
+
8
+ import { Editor } from '../editor';
9
+ import { trackClick } from '../helpers';
10
+
11
+ jest.mock('../MonacoEditor', () => ({
12
+ SimpleMonacoEditor: ({ value }: { value: string }) => <>{value}</>,
13
+ }));
14
+
15
+ const renderWrapper = setupRtl(Editor, {
16
+ hideCopyButton: false,
17
+ language: 'javascript',
18
+ text: 'hello world',
19
+ onChange: jest.fn(),
20
+ snippetsBaseUrl: '',
21
+ });
22
+
23
+ Object.defineProperty(navigator, 'clipboard', {
24
+ value: {
25
+ writeText: jest.fn(),
26
+ },
27
+ });
28
+
29
+ describe('Editor', () => {
30
+ (global as any).fetch = jest.fn();
31
+ afterEach(() => {
32
+ (global as any).fetch.mockClear();
33
+ });
34
+
35
+ it('shows a prompt tooltip when the CodeByte has __not__ been copied via the button', () => {
36
+ const { view } = renderWrapper();
37
+ expect(view.queryByTestId('copy-confirmation-tooltip')).toBeFalsy();
38
+ view.getByTestId('copy-prompt-tooltip');
39
+ });
40
+
41
+ it('shows a confirmation tooltip when the CodeByte has been copied via the button', () => {
42
+ const { view } = renderWrapper();
43
+ const copyBtn = view.getByTestId('copy-codebyte-btn');
44
+ userEvent.click(copyBtn as HTMLButtonElement);
45
+ expect(view.queryByTestId('copy-prompt-tooltip')).toBeFalsy();
46
+ view.getByTestId('copy-confirmation-tooltip');
47
+ });
48
+
49
+ it('hides the copy codebyte button if hideCopyButton prop is true"', () => {
50
+ const { view } = renderWrapper({
51
+ hideCopyButton: true,
52
+ });
53
+ expect(view.queryByTestId('copy-codebyte-btn')).toBeNull();
54
+ });
55
+
56
+ it('shows the copy codebyte button if hideCopyButton prop is not set', () => {
57
+ const { view } = renderWrapper();
58
+
59
+ view.getByTestId('copy-codebyte-btn');
60
+ });
61
+
62
+ describe('Change Handlers', () => {
63
+ it('triggers onCopy upon clicking the copy button', () => {
64
+ const onCopy = jest.fn();
65
+ const { view } = renderWrapper({
66
+ onCopy,
67
+ });
68
+
69
+ const copyButton = view.getByTestId('copy-codebyte-btn');
70
+ userEvent.click(copyButton);
71
+
72
+ expect(onCopy).toHaveBeenCalled();
73
+ });
74
+ });
75
+
76
+ describe('Tracking', () => {
77
+ it('tracks clicks on the run button', async () => {
78
+ (global as any).fetch.mockResolvedValue({
79
+ json: () =>
80
+ Promise.resolve({
81
+ stderr: [],
82
+ exit_code: 0,
83
+ stdout: '',
84
+ }),
85
+ });
86
+ const { view } = renderWrapper({
87
+ onChange: jest.fn(),
88
+ text: 'test',
89
+ language: 'javascript',
90
+ });
91
+
92
+ const runButton = view.getByText('Run');
93
+ await act(async () => {
94
+ userEvent.click(runButton);
95
+ });
96
+
97
+ expect(trackClick).toHaveBeenCalledWith('run');
98
+ });
99
+
100
+ it('tracks clicks on the copy codebyte button', () => {
101
+ const { view } = renderWrapper({
102
+ onChange: jest.fn(),
103
+ text: 'test',
104
+ language: 'javascript',
105
+ });
106
+
107
+ const copyButton = view.getByTestId('copy-codebyte-btn');
108
+ userEvent.click(copyButton);
109
+
110
+ expect(trackClick).toHaveBeenCalledWith('copy');
111
+ });
112
+ });
113
+ });
@@ -0,0 +1,121 @@
1
+ import { encode } from 'js-base64';
2
+
3
+ import { CodebytesParams, getOptions, trackClick } from '../helpers';
4
+ import { trackUserClick } from '../libs/eventTracking';
5
+
6
+ jest.mock('../libs/eventTracking');
7
+
8
+ const initialUrl = window.location.href;
9
+ const resetCodebytesParams = () =>
10
+ window.history.replaceState(null, '', initialUrl);
11
+ type SetCodebytesParamsProps = Record<CodebytesParams, string>;
12
+ const setCodebytesParams = (params: SetCodebytesParamsProps) => {
13
+ if (params.text) {
14
+ params.text = encode(params.text);
15
+ }
16
+
17
+ const url = new URL(window.location.href);
18
+ Object.entries(params).forEach(([key, value]) => {
19
+ url.searchParams.set(key, value);
20
+ });
21
+
22
+ window.history.replaceState({}, '', url.toString());
23
+ };
24
+
25
+ describe('getOptions', () => {
26
+ afterEach(() => {
27
+ resetCodebytesParams();
28
+ });
29
+
30
+ it('parses props out of the window locations', () => {
31
+ const text = `
32
+ const msg = 'Sup?';
33
+ console.log(msg);
34
+ `.trim();
35
+ setCodebytesParams({
36
+ lang: 'javascript',
37
+ text,
38
+ 'copy-mode': '',
39
+ 'client-name': 'forum',
40
+ page: 'https://discuss.codecademy.com/some-interesting/post',
41
+ mode: 'compose',
42
+ });
43
+
44
+ expect(getOptions()).toEqual({
45
+ clientName: 'forum',
46
+ parentPage: 'https://discuss.codecademy.com/some-interesting/post',
47
+ renderMode: 'compose',
48
+ });
49
+ });
50
+ });
51
+
52
+ describe('trackClick', () => {
53
+ afterEach(() => {
54
+ resetCodebytesParams();
55
+ (trackUserClick as any).mockReset();
56
+ });
57
+
58
+ it('proxies to trackUserClick setting the page_name, context, and target', () => {
59
+ const target = 'foobar';
60
+ setCodebytesParams({
61
+ lang: 'javascript',
62
+ text: `
63
+ const msg = 'Sup?';
64
+ console.log(msg);
65
+ `.trim(),
66
+ 'copy-mode': '',
67
+ 'client-name': 'forum',
68
+ page: 'https://discuss.codecademy.com/some-interesting/post',
69
+ mode: '',
70
+ });
71
+ trackClick(target);
72
+ expect(trackUserClick).toHaveBeenCalledWith({
73
+ page_name: 'forum',
74
+ context: 'https://discuss.codecademy.com/some-interesting/post',
75
+ target,
76
+ });
77
+ });
78
+
79
+ it('defaults the client name to "Unknown"', () => {
80
+ const target = 'foobar';
81
+ setCodebytesParams({
82
+ lang: 'javascript',
83
+ text: `
84
+ const msg = 'Sup?';
85
+ console.log(msg);
86
+ `.trim(),
87
+ 'copy-mode': '',
88
+ 'client-name': '',
89
+ page: 'https://discuss.codecademy.com/some-interesting/post',
90
+ mode: '',
91
+ });
92
+ trackClick(target);
93
+ expect(trackUserClick).toHaveBeenCalledWith({
94
+ page_name: 'Unknown',
95
+ context: 'https://discuss.codecademy.com/some-interesting/post',
96
+ target,
97
+ });
98
+ });
99
+
100
+ it('embeds the render mode into the page_name', () => {
101
+ const mode = 'compose';
102
+ const target = 'foobar';
103
+ setCodebytesParams({
104
+ lang: 'javascript',
105
+ text: `
106
+ const msg = 'Sup?';
107
+ console.log(msg);
108
+ `.trim(),
109
+ 'copy-mode': '',
110
+ 'client-name': 'forum',
111
+ page: 'https://discuss.codecademy.com/some-interesting/post',
112
+ mode,
113
+ });
114
+ trackClick(target);
115
+ expect(trackUserClick).toHaveBeenCalledWith({
116
+ page_name: `forum_${mode}`,
117
+ context: 'https://discuss.codecademy.com/some-interesting/post',
118
+ target,
119
+ });
120
+ });
121
+ });
@@ -0,0 +1,14 @@
1
+ import { setupRtl } from '@codecademy/gamut-tests';
2
+
3
+ import { LanguageSelection } from '../languageSelection';
4
+
5
+ const renderWrapper = setupRtl(LanguageSelection, {
6
+ onChange: () => null,
7
+ });
8
+
9
+ describe('LanguageSelection', () => {
10
+ it('has placeholder text', () => {
11
+ const { view } = renderWrapper();
12
+ view.getByText('Which language do you want to code in?');
13
+ });
14
+ });
@@ -0,0 +1,8 @@
1
+ jest.mock('react-resize-observer');
2
+ jest.mock('../libs/eventTracking');
3
+ jest.mock('../helpers', () => ({
4
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
5
+ // @ts-ignore
6
+ ...jest.requireActual('../helpers'),
7
+ trackClick: jest.fn(),
8
+ }));
package/src/api.ts CHANGED
@@ -1,4 +1,4 @@
1
- import type { languageOption } from './consts';
1
+ import type { LanguageOption } from './consts';
2
2
 
3
3
  interface Response {
4
4
  stderr: string;
@@ -7,7 +7,7 @@ interface Response {
7
7
  }
8
8
 
9
9
  interface PostSnippetData {
10
- language: languageOption;
10
+ language: LanguageOption;
11
11
  code: string;
12
12
  }
13
13
 
package/src/consts.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  // key = language param to send to snippets service
2
2
  // val = label in language selection drop down
3
- export const languageOptions = {
3
+ export const LanguageOptions = {
4
4
  '': 'Select a language',
5
5
  cpp: 'C++',
6
6
  csharp: 'C#',
@@ -12,11 +12,11 @@ export const languageOptions = {
12
12
  scheme: 'Scheme',
13
13
  };
14
14
 
15
- export type languageOption = keyof typeof languageOptions;
15
+ export type LanguageOption = keyof typeof LanguageOptions;
16
16
 
17
- export const validLanguages = Object.keys(languageOptions).filter(
17
+ export const validLanguages = Object.keys(LanguageOptions).filter(
18
18
  (option) => !!option
19
- ) as languageOption[];
19
+ ) as Exclude<LanguageOption, ''>[];
20
20
 
21
21
  const cpp = `#include <iostream>
22
22
  int main() {
@@ -52,7 +52,7 @@ const scheme = `(begin
52
52
  (display "Hello world!")
53
53
  (newline))`;
54
54
 
55
- export const helloWorld: { [key in languageOption]?: string } = {
55
+ export const helloWorld = {
56
56
  cpp,
57
57
  csharp,
58
58
  golang,
@@ -61,4 +61,4 @@ export const helloWorld: { [key in languageOption]?: string } = {
61
61
  python,
62
62
  ruby,
63
63
  scheme,
64
- };
64
+ } as const;
package/src/editor.tsx CHANGED
@@ -10,10 +10,11 @@ import styled from '@emotion/styled';
10
10
  import React, { useState } from 'react';
11
11
 
12
12
  import { postSnippet } from './api';
13
- import type { languageOption } from './consts';
13
+ import type { LanguageOption } from './consts';
14
14
  import { Drawers } from './drawers';
15
+ import { trackClick } from './helpers';
15
16
  import { SimpleMonacoEditor } from './MonacoEditor';
16
- import { CodebytesChangeHandlerMap } from './types';
17
+ import { CodebytesChangeHandler } from './types';
17
18
 
18
19
  const Output = styled.pre<{ hasError: boolean }>`
19
20
  width: 100%;
@@ -37,32 +38,33 @@ const DOCKER_SIGTERM = 143;
37
38
 
38
39
  type EditorProps = {
39
40
  hideCopyButton: boolean;
40
- language: languageOption;
41
+ language: LanguageOption;
41
42
  text: string;
42
43
  onChange: (text: string) => void;
43
- on?: CodebytesChangeHandlerMap;
44
+ onCopy?: (text: string, language: string) => void;
44
45
  snippetsBaseUrl?: string;
46
+ onCopy?: CodebytesChangeHandler;
45
47
  };
46
48
 
47
49
  export const Editor: React.FC<EditorProps> = ({
48
50
  language,
49
51
  text,
50
52
  hideCopyButton,
51
- on = {},
52
53
  onChange,
54
+ onCopy,
53
55
  snippetsBaseUrl,
56
+ onCopy,
54
57
  }) => {
55
58
  const [output, setOutput] = useState('');
56
59
  const [status, setStatus] = useState<'ready' | 'waiting' | 'error'>('ready');
57
60
  const [isCodeByteCopied, setIsCodeByteCopied] = useState(false);
58
61
  const onCopyClick = () => {
59
62
  if (!isCodeByteCopied) {
60
- navigator.clipboard
61
- .writeText(text)
62
- // eslint-disable-next-line no-console
63
- .catch(() => console.error('Failed to copy'));
64
- on.copy?.(text, language);
63
+ // eslint-disable-next-line @typescript-eslint/no-floating-promises
64
+ navigator.clipboard.writeText(text);
65
65
  setIsCodeByteCopied(true);
66
+ trackClick('copy');
67
+ onCopy?.(text, language);
66
68
  }
67
69
  };
68
70
 
@@ -81,7 +83,7 @@ export const Editor: React.FC<EditorProps> = ({
81
83
  };
82
84
  setStatus('waiting');
83
85
  setOutput('');
84
- on.run?.();
86
+ trackClick('run');
85
87
 
86
88
  try {
87
89
  const response = await postSnippet(data, snippetsBaseUrl);
@@ -132,15 +134,20 @@ export const Editor: React.FC<EditorProps> = ({
132
134
  variant="secondary"
133
135
  onClick={onCopyClick}
134
136
  onBlur={() => setIsCodeByteCopied(false)}
137
+ data-testid="copy-codebyte-btn"
135
138
  >
136
139
  <CopyIconStyled aria-hidden="true" /> Copy Codebyte
137
140
  </TextButton>
138
141
  }
139
142
  >
140
143
  {isCodeByteCopied ? (
141
- <span role="alert">Copied!</span>
144
+ <span data-testid="copy-confirmation-tooltip" role="alert">
145
+ Copied!
146
+ </span>
142
147
  ) : (
143
- <span>Copy to your clipboard</span>
148
+ <span data-testid="copy-prompt-tooltip">
149
+ Copy to your clipboard
150
+ </span>
144
151
  )}
145
152
  </ToolTip>
146
153
  ) : null}
@@ -0,0 +1,43 @@
1
+ import Uri from 'jsuri';
2
+
3
+ import { trackUserClick } from '../libs/eventTracking';
4
+
5
+ export type CodebyteOptions = {
6
+ clientName: string;
7
+ parentPage: string;
8
+ renderMode: string;
9
+ };
10
+
11
+ export enum CodebytesParams {
12
+ Language = 'lang',
13
+ Text = 'text',
14
+ CopyMode = 'copy-mode',
15
+ ClientName = 'client-name',
16
+ Page = 'page',
17
+ Mode = 'mode',
18
+ }
19
+
20
+ export const getOptions = (): CodebyteOptions => {
21
+ const currentUri = new Uri(window.location.href);
22
+
23
+ return {
24
+ clientName:
25
+ currentUri.getQueryParamValue(CodebytesParams.ClientName) || 'Unknown',
26
+ parentPage:
27
+ currentUri.getQueryParamValue(CodebytesParams.Page) || document.referrer,
28
+ renderMode: currentUri.getQueryParamValue(CodebytesParams.Mode) || '',
29
+ };
30
+ };
31
+
32
+ export const trackClick = (target: string) => {
33
+ const options = getOptions();
34
+ const page_name = options.renderMode
35
+ ? `${options.clientName}_${options.renderMode}`
36
+ : options.clientName;
37
+
38
+ trackUserClick({
39
+ page_name,
40
+ context: options.parentPage,
41
+ target,
42
+ });
43
+ };
package/src/index.tsx CHANGED
@@ -3,15 +3,17 @@ import { FaviconIcon } from '@codecademy/gamut-icons';
3
3
  import { Background, states, system } from '@codecademy/gamut-styles';
4
4
  import { StyleProps } from '@codecademy/variance';
5
5
  import styled from '@emotion/styled';
6
- import React, { useState } from 'react';
6
+ import React, { useEffect, useState } from 'react';
7
7
 
8
- import { helloWorld, languageOption } from './consts';
8
+ import { helloWorld, LanguageOption } from './consts';
9
9
  import { Editor } from './editor';
10
+ import { getOptions, trackClick } from './helpers';
10
11
  import { LanguageSelection } from './languageSelection';
12
+ import { trackUserImpression } from './libs/eventTracking';
11
13
  import { CodeByteEditorProps } from './types';
12
14
 
13
15
  const editorStates = states({
14
- isIFrame: { height: '100vh' },
16
+ isForums: { height: '100vh' },
15
17
  });
16
18
 
17
19
  const editorBaseStyles = system.css({
@@ -35,15 +37,42 @@ const EditorContainer = styled(Background)<EditorStyleProps>(
35
37
  export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
36
38
  text: initialText,
37
39
  language: initialLanguage,
38
- hideCopyButton,
39
- isIFrame = false,
40
- on = {},
40
+ hideCopyButton = false,
41
+ isForums = false,
41
42
  snippetsBaseUrl = process.env.CONTAINER_API_BASE,
43
+ onEdit,
44
+ onLanguageChange,
45
+ onCopy,
42
46
  }) => {
43
- const [text, setText] = useState<string>(initialText);
44
- const [language, setLanguage] = useState<languageOption>(initialLanguage);
47
+ const [text, setText] = useState<string>(initialText ?? '');
48
+ const [language, setLanguage] = useState<LanguageOption>(
49
+ initialLanguage ?? ''
50
+ );
51
+ const [hasBeenEdited, setHasBeenEdited] = useState(false);
52
+
53
+ useEffect(() => {
54
+ if (isForums) {
55
+ const options = getOptions();
56
+ const page_name = options.renderMode
57
+ ? `${options.clientName}_${options.renderMode}`
58
+ : options.clientName;
59
+
60
+ trackUserImpression({
61
+ page_name,
62
+ context: options.parentPage,
63
+ target: 'codebyte',
64
+ });
65
+ }
66
+ }, [isForums]);
67
+
68
+ useEffect(() => {
69
+ if (language) {
70
+ setText(initialText ?? (helloWorld[language] || ''));
71
+ }
72
+ }, [language, initialText]);
73
+
45
74
  return (
46
- <EditorContainer bg="black" as="main" isIFrame={isIFrame}>
75
+ <EditorContainer bg="black" as="main" isForums={isForums}>
47
76
  <Box borderBottom={1} borderColor="gray-900" py={4} pl={8}>
48
77
  <IconButton
49
78
  icon={FaviconIcon}
@@ -52,7 +81,7 @@ export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
52
81
  target="_blank"
53
82
  rel="noreferrer"
54
83
  aria-label="visit codecademy.com"
55
- onClick={() => on.logoClick?.()}
84
+ onClick={() => trackClick('logo')}
56
85
  />
57
86
  </Box>
58
87
  {language ? (
@@ -62,18 +91,26 @@ export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
62
91
  hideCopyButton={hideCopyButton}
63
92
  onChange={(newText: string) => {
64
93
  setText(newText);
65
- on.edit?.(newText, language);
94
+ onEdit?.(newText, language);
95
+ const { renderMode } = getOptions();
96
+ if (!renderMode && hasBeenEdited === false) {
97
+ setHasBeenEdited(true);
98
+ trackClick('edit');
99
+ }
66
100
  }}
67
- on={on}
68
101
  snippetsBaseUrl={snippetsBaseUrl}
102
+ onCopy={onCopy}
69
103
  />
70
104
  ) : (
71
105
  <LanguageSelection
72
106
  onChange={(newLanguage) => {
73
- const newText: string = text || helloWorld[newLanguage] || '';
107
+ const newText: string =
108
+ text || (newLanguage ? helloWorld[newLanguage] : '');
74
109
  setLanguage(newLanguage);
75
110
  setText(newText);
76
- on.languageChange?.(newText, newLanguage);
111
+ onLanguageChange?.(newText, newLanguage);
112
+ trackClick('lang_select');
113
+ onLanguageChange?.(newText, newLanguage);
77
114
  }}
78
115
  />
79
116
  )}
@@ -1,45 +1,26 @@
1
- import { Select } from '@codecademy/gamut';
2
- import { Background } from '@codecademy/gamut-styles';
3
- import styled from '@emotion/styled';
1
+ import { Select, Text } from '@codecademy/gamut';
2
+ import { ColorMode } from '@codecademy/gamut-styles';
4
3
  import React from 'react';
5
4
 
6
- import type { languageOption } from './consts';
7
- import { languageOptions } from './consts';
8
-
9
- const StyledSelect = styled(Select)`
10
- margin-top: 1rem;
11
- color: ${({ theme }) => theme.colors.text};
12
- select {
13
- color: ${({ theme }) => theme.colors.text};
14
- background-color: ${({ theme }) => theme.colors.black};
15
-
16
- &:hover,
17
- &:active,
18
- &:focus {
19
- border-color: ${({ theme }) => theme.colors.primary};
20
- }
21
- &:focus {
22
- box-shadow: inset 0 0 0 1px ${({ theme }) => theme.colors.primary};
23
- }
24
- }
25
- `;
5
+ import type { LanguageOption } from './consts';
6
+ import { LanguageOptions } from './consts';
26
7
 
27
8
  export type LanguageSelectionProps = {
28
- onChange: (newLanguage: languageOption) => void;
9
+ onChange: (newLanguage: LanguageOption) => void;
29
10
  };
30
11
 
31
12
  export const LanguageSelection: React.FC<LanguageSelectionProps> = ({
32
13
  onChange,
33
14
  }) => {
34
15
  return (
35
- <Background bg="black" flex={1} px={16} pt={48}>
36
- Which language do you want to code in?
37
- <StyledSelect
16
+ <ColorMode mode="dark" flex={1} px={16} pt={48}>
17
+ <Text mb={16}>Which language do you want to code in?</Text>
18
+ <Select
38
19
  id="language-select"
39
20
  aria-label="Select a language"
40
- options={languageOptions}
41
- onChange={(e) => onChange(e.target.value as languageOption)}
21
+ options={LanguageOptions}
22
+ onChange={(e) => onChange(e.target.value as LanguageOption)}
42
23
  />
43
- </Background>
24
+ </ColorMode>
44
25
  );
45
26
  };
@@ -0,0 +1,16 @@
1
+ import { createTracker } from '@codecademy/tracking';
2
+
3
+ const IS_DEV = process.env.NODE_ENV === 'development';
4
+ const API_BASE_URL =
5
+ process.env.GATSBY_MONOLITH_API_BASE || 'https://www.codecademy.com';
6
+
7
+ const tracker = createTracker({
8
+ apiBaseUrl: API_BASE_URL,
9
+ verbose: IS_DEV,
10
+ });
11
+
12
+ export const {
13
+ click: trackUserClick,
14
+ visit: trackUserVisit,
15
+ impression: trackUserImpression,
16
+ } = tracker;
package/src/types.ts CHANGED
@@ -1,20 +1,17 @@
1
- import { languageOption } from './consts';
1
+ import { LanguageOption } from './consts';
2
2
 
3
- type CodebytesChangeHandler = (text: string, language: languageOption) => void;
4
3
 
5
- export type CodebytesChangeHandlerMap = {
6
- logoClick?: () => void;
7
- edit?: CodebytesChangeHandler;
8
- languageChange?: CodebytesChangeHandler;
9
- copy?: CodebytesChangeHandler;
10
- run?: () => void;
11
- };
4
+ export interface CodebytesChangeHandler {
5
+ (text: string, language: LanguageOption): void;
6
+ }
12
7
 
13
8
  export interface CodeByteEditorProps {
14
- text: string;
15
- language: languageOption;
16
- hideCopyButton: boolean;
17
- isIFrame?: boolean;
18
- 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. */;
19
- on?: CodebytesChangeHandlerMap;
9
+ text?: string;
10
+ language?: LanguageOption;
11
+ hideCopyButton?: boolean;
12
+ onCopy?: CodebytesChangeHandler;
13
+ isForums?: boolean;
14
+ snippetsBaseUrl?: string;
15
+ onEdit?: CodebytesChangeHandler;
16
+ onLanguageChange?: CodebytesChangeHandler;
20
17
  }