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

package/jest.config.js

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codecademy/codebytes",
   "description": "Codebytes Code Editor",
-  "version": "0.4.1-alpha.8ec58f.0",
+  "version": "0.4.1-alpha.9c9740.0",
   "author": "Codecademy Engineering <dev@codecademy.com>",
   "sideEffects": [
     "**/*.css",
@@ -56,5 +56,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9686e035e15f8e37928e37dab13cba74abefb8e8"
+  "gitHead": "2d4a49654be02f9ca1f4fa13471a3c1890cb342f"
 }

package/src/__tests__/codebyte-test.tsx

@@ -171,6 +171,7 @@ describe('CodeBytes', () => {
       renderWrapperWith({
         text: 'some-value',
         language: 'javascript',
+        isForums: true,
       });
 
       expect(trackUserImpression).toHaveBeenCalledWith({
@@ -185,6 +186,7 @@ describe('CodeBytes', () => {
         text: 'some-value',
         language: 'javascript',
         mode: 'compose',
+        isForums: true,
       });
 
       expect(trackUserImpression).toHaveBeenCalledWith({
@@ -193,5 +195,16 @@ describe('CodeBytes', () => {
         target: 'codebyte',
       });
     });
+
+    it('does not trigger a trackUserImpression when not isForum is false', () => {
+      renderWrapperWith({
+        text: 'some-value',
+        language: 'javascript',
+        mode: 'compose',
+        isForums: false,
+      });
+
+      expect(trackUserImpression).not.toHaveBeenCalled();
+    });
   });
 });

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 Exclude<LanguageOption, ''>[];
 
 const cpp = `#include <iostream>
 int main() {

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({
@@ -38,7 +38,7 @@ export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
   text: initialText,
   language: initialLanguage,
   hideCopyButton = false,
-  isIFrame = false,
+  isForums = false,
   snippetsBaseUrl = process.env.CONTAINER_API_BASE,
   onEdit,
   onLanguageChange,
@@ -51,17 +51,19 @@ export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
   const [hasBeenEdited, setHasBeenEdited] = useState(false);
 
   useEffect(() => {
-    const options = getOptions();
-    const page_name = options.renderMode
-      ? `${options.clientName}_${options.renderMode}`
-      : options.clientName;
+    if (isForums) {
+      const options = getOptions();
+      const page_name = options.renderMode
+        ? `${options.clientName}_${options.renderMode}`
+        : options.clientName;
 
-    trackUserImpression({
-      page_name,
-      context: options.parentPage,
-      target: 'codebyte',
-    });
-  }, []);
+      trackUserImpression({
+        page_name,
+        context: options.parentPage,
+        target: 'codebyte',
+      });
+    }
+  }, [isForums]);
 
   useEffect(() => {
     if (language) {
@@ -70,7 +72,7 @@ export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
   }, [language, initialText]);
 
   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}

package/src/types.ts

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