@codecademy/codebytes 0.4.0 → 0.4.1-alpha.aadc55.0

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 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.aadc55.0](https://github.com/Codecademy/client-modules/compare/@codecademy/codebytes@0.4.0...@codecademy/codebytes@0.4.1-alpha.aadc55.0) (2022-01-24)
+
+**Note:** Version bump only for package @codecademy/codebytes
+
+
+
+
+
 ## [0.4.0](https://github.com/Codecademy/client-modules/compare/@codecademy/codebytes@0.3.0...@codecademy/codebytes@0.4.0) (2022-01-21)
 
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codecademy/codebytes",
   "description": "Codebytes Code Editor",
-  "version": "0.4.0",
+  "version": "0.4.1-alpha.aadc55.0",
   "author": "Codecademy Engineering <dev@codecademy.com>",
   "sideEffects": [
     "**/*.css",
@@ -23,10 +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",
     "@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"
   },
@@ -43,10 +46,11 @@
     "@emotion/jest": "^11.3.0",
     "@testing-library/dom": "^7.31.2",
     "@testing-library/react": "^11.0.4",
+    "@types/jsuri": "^1.3.30",
     "@types/loadable__component": "^5.13.2"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "1e2148c8ef092e66f698d63728eb07ee2d31caba"
+  "gitHead": "5fe221374a7a33aaa0df97afcf34e061d722ebdf"
 }

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 }>`
@@ -47,8 +48,8 @@ export const Editor: React.FC<EditorProps> = ({
   language,
   text,
   hideCopyButton,
-  onCopy,
   onChange,
+  onCopy,
   snippetsBaseUrl,
 }) => {
   const [output, setOutput] = useState('');
@@ -62,6 +63,7 @@ export const Editor: React.FC<EditorProps> = ({
         .catch(() => console.error('Failed to copy'));
       onCopy?.(text, language);
       setIsCodeByteCopied(true);
+      trackClick('copy');
     }
   };
 
@@ -80,6 +82,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,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' },
@@ -55,6 +45,21 @@ export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
 }) => {
   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 +70,7 @@ export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
           target="_blank"
           rel="noreferrer"
           aria-label="visit codecademy.com"
+          onClick={() => trackClick('logo')}
         />
       </Box>
       {language ? (
@@ -75,6 +81,12 @@ export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
           onChange={(newText: string) => {
             setText(newText);
             onEdit?.(newText, language);
+
+            const { renderMode } = getOptions();
+            if (!renderMode && hasBeenEdited === false) {
+              setHasBeenEdited(true);
+              trackClick('edit');
+            }
           }}
           snippetsBaseUrl={snippetsBaseUrl}
         />
@@ -85,6 +97,7 @@ export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
               text || (newLanguage ? helloWorld[newLanguage] : '');
             setLanguage(newLanguage);
             setText(newText);
+            trackClick('lang_select');
             onLanguageChange?.(newText, newLanguage);
           }}
         />

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,14 @@
+import { LanguageOption } from './consts';
+interface 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;
+}