@codecademy/codebytes 0.3.1-alpha.405be7.0 → 0.3.1-alpha.6d07c2.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.3.1-alpha.405be7.0](https://github.com/Codecademy/client-modules/compare/@codecademy/codebytes@0.3.0...@codecademy/codebytes@0.3.1-alpha.405be7.0) (2022-01-13)
+### [0.3.1-alpha.6d07c2.0](https://github.com/Codecademy/client-modules/compare/@codecademy/codebytes@0.3.0...@codecademy/codebytes@0.3.1-alpha.6d07c2.0) (2022-01-20)
 
 **Note:** Version bump only for package @codecademy/codebytes
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codecademy/codebytes",
   "description": "Codebytes Code Editor",
-  "version": "0.3.1-alpha.405be7.0",
+  "version": "0.3.1-alpha.6d07c2.0",
   "author": "Codecademy Engineering <dev@codecademy.com>",
   "sideEffects": [
     "**/*.css",
@@ -27,6 +27,7 @@
     "@emotion/react": "^11.4.0",
     "@emotion/styled": "^11.3.0",
     "@monaco-editor/react": "4.3.1",
+    "jsuri": "^1.3.1",
     "monaco-editor": ">= 0.25.0 < 1",
     "react-resize-observer": "1.1.1"
   },
@@ -43,10 +44,12 @@
     "@emotion/jest": "^11.3.0",
     "@testing-library/dom": "^7.31.2",
     "@testing-library/react": "^11.0.4",
-    "@types/loadable__component": "^5.13.2"
+    "@types/jsuri": "^1.3.30",
+    "@types/loadable__component": "^5.13.2",
+    "js-base64": "^3.6.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b0c7c52677bf95764fd29e9baa58a30761858f85"
+  "gitHead": "59865e361c398793d3928dfcd7cd97cacb913fc9"
 }

package/src/editor.tsx

@@ -12,6 +12,7 @@ import React, { useState } from 'react';
 import { postSnippet } from './api';
 import type { languageOption } from './consts';
 import { Drawers } from './drawers';
+import { trackClick } from './helpers';
 import { SimpleMonacoEditor } from './MonacoEditor';
 
 const Output = styled.pre<{ hasError: boolean }>`
@@ -39,7 +40,6 @@ type EditorProps = {
   language: languageOption;
   text: string;
   onChange: (text: string) => void;
-  onCopy?: (text: string, language: string) => void;
   snippetsBaseUrl?: string;
 };
 
@@ -47,7 +47,6 @@ export const Editor: React.FC<EditorProps> = ({
   language,
   text,
   hideCopyButton,
-  onCopy,
   onChange,
   snippetsBaseUrl,
 }) => {
@@ -60,7 +59,7 @@ export const Editor: React.FC<EditorProps> = ({
         .writeText(text)
         // eslint-disable-next-line no-console
         .catch(() => console.error('Failed to copy'));
-      onCopy?.(text, language);
+      trackClick('copy');
       setIsCodeByteCopied(true);
     }
   };
@@ -80,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,60 @@
+import { decode } from 'js-base64';
+import Uri from 'jsuri';
+
+import { trackUserClick } from '../libs/eventTracking';
+
+import { languageOption, validLanguages } from '../consts';
+
+export type CopyButtonMode = 'hide' | undefined;
+
+export type CodebyteOptions = {
+  language: languageOption;
+  text: string;
+  copyMode: CopyButtonMode;
+  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 {
+    language:
+      validLanguages.find(
+        (lang) =>
+          currentUri.getQueryParamValue(CodebytesParams.Language) === lang
+      ) ?? '',
+    text: decode(currentUri.getQueryParamValue(CodebytesParams.Text) ?? ''),
+    copyMode: currentUri
+      .getQueryParamValue(CodebytesParams.CopyMode)
+      ?.toLowerCase() as CopyButtonMode,
+    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,24 +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 { helloWorld, languageOption } from './consts';
 import { Editor } from './editor';
+import { getOptions, trackClick } from './helpers';
 import { LanguageSelection } from './languageSelection';
-
-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;
-}
+import { trackUserImpression } from './libs/eventTracking';
+import { CodeByteEditorProps } from './types';
 
 const editorStates = states({
   isIFrame: { height: '100vh' },
@@ -50,11 +40,24 @@ export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
   hideCopyButton,
   isIFrame = false,
   snippetsBaseUrl = process.env.CONTAINER_API_BASE,
-  onEdit,
-  onLanguageChange,
 }) => {
   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}>
@@ -65,6 +68,7 @@ export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
           target="_blank"
           rel="noreferrer"
           aria-label="visit codecademy.com"
+          onClick={() => trackClick('logo')}
         />
       </Box>
       {language ? (
@@ -74,17 +78,23 @@ export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
           hideCopyButton={hideCopyButton}
           onChange={(newText: string) => {
             setText(newText);
-            onEdit?.(newText, language);
+
+            const { renderMode } = getOptions();
+            if (!renderMode && hasBeenEdited === false) {
+              setHasBeenEdited(true);
+              trackClick('edit');
+            }
           }}
           snippetsBaseUrl={snippetsBaseUrl}
         />
       ) : (
         <LanguageSelection
           onChange={(newLanguage) => {
-            const newText: string = text || helloWorld[newLanguage] || '';
+            const newText: string =
+              text || (newLanguage ? helloWorld[newLanguage] : '');
             setLanguage(newLanguage);
             setText(newText);
-            onLanguageChange?.(newText, newLanguage);
+            trackClick('lang_select');
           }}
         />
       )}

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,9 @@
+import { languageOption } from './consts';
+
+export interface CodeByteEditorProps {
+  text: string;
+  language: languageOption;
+  hideCopyButton: boolean;
+  isIFrame?: boolean;
+  snippetsBaseUrl?: string;
+}