Skip to content

Fix ace editor warnings in test suite by addressing webpack issue #2982

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion craco.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,6 @@ const cracoConfig = {
),
'^.+\\.module\\.(css|sass|scss)$'
];
jestConfig.moduleNameMapper['ace-builds'] = '<rootDir>/node_modules/ace-builds';
jestConfig.moduleNameMapper['unist-util-visit-parents/do-not-use-color'] =
'<rootDir>/node_modules/unist-util-visit-parents/lib';
jestConfig.moduleNameMapper['vfile/do-not-use-conditional-minpath'] =
Expand Down
14 changes: 0 additions & 14 deletions src/commons/assessmentWorkspace/__tests__/AssessmentWorkspace.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { act, render, screen } from '@testing-library/react';
import { require as acequire } from 'ace-builds';
import { Provider } from 'react-redux';
import { createMemoryRouter, RouterProvider } from 'react-router';
import { mockInitialStore } from 'src/commons/mocks/StoreMocks';
Expand All @@ -10,12 +9,6 @@ import { EditorBinding, WorkspaceSettingsContext } from 'src/commons/WorkspaceSe
import { mockAssessments } from '../../mocks/AssessmentMocks';
import AssessmentWorkspace, { AssessmentWorkspaceProps } from '../AssessmentWorkspace';

jest.mock('ace-builds', () => ({
...jest.requireActual('ace-builds'),
require: jest.fn()
}));
const acequireMock = acequire as jest.Mock;

const defaultProps = assertType<AssessmentWorkspaceProps>()({
assessmentId: 0,
needsPassword: false,
Expand Down Expand Up @@ -114,13 +107,6 @@ const getGradingResultTab = (tree: HTMLElement) => tree.querySelector('.GradingR
const getContestVotingTab = (tree: HTMLElement) => tree.querySelector('.ContestEntryVoting');

describe('AssessmentWorkspace', () => {
beforeEach(() => {
acequireMock.mockReturnValue({
Mode: jest.fn(),
setCompleters: jest.fn()
});
});

test('AssessmentWorkspace page "loading" content renders correctly', async () => {
const app = createMemoryRouterWithRoutes(mockUndefinedAssessmentWorkspaceProps);
const tree = await renderTreeJson(app);
Expand Down
14 changes: 14 additions & 0 deletions src/commons/editor/Editor.tsx
Original file line number Diff line number Diff line change
@@ -1,9 +1,23 @@
/* eslint-disable simple-import-sort/imports */

// Next line necessary to prevent "ReferenceError: ace is not defined" error.
// See https://github.com/securingsincity/react-ace/issues/1233 (although there is no explanation).
import 'ace-builds/src-noconflict/ace';
import 'ace-builds/src-noconflict/ext-language_tools';
import 'ace-builds/src-noconflict/ext-searchbox';
import 'ace-builds/src-noconflict/ext-settings_menu';
import 'js-slang/dist/editors/ace/theme/source';

/**
* ace-builds/webpack-resolver is causing some issues in the testing environment.
* Without it, we have to manually import the following keybindings to ensure they are packaged
* together with the editor during lazy loading.
*
* Supersedes changes from: https://github.com/source-academy/frontend/issues/2543
*/
import 'ace-builds/src-noconflict/keybinding-vim';
import 'ace-builds/src-noconflict/keybinding-emacs';

import { Card } from '@blueprintjs/core';
import * as AceBuilds from 'ace-builds';
import { Ace, require as acequire, createEditSession } from 'ace-builds';
Expand Down
6 changes: 0 additions & 6 deletions src/commons/editor/EditorContainer.tsx
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
// Necessary to prevent "ReferenceError: ace is not defined" error.
// See https://github.com/securingsincity/react-ace/issues/1233 (although there is no explanation).
import 'ace-builds/src-noconflict/ace';
// For webpack to resolve properly during lazy loading (see https://github.com/source-academy/frontend/issues/2543)
import 'ace-builds/webpack-resolver';

import _ from 'lodash';
import React from 'react';

Expand Down
12 changes: 0 additions & 12 deletions src/pages/playground/__tests__/Playground.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import { Router } from '@remix-run/router';
import { act, render } from '@testing-library/react';
import { require as acequire } from 'ace-builds';
import { FSModule } from 'browserfs/dist/node/core/FS';
import { Chapter } from 'js-slang/dist/types';
import { Provider } from 'react-redux';
Expand All @@ -21,13 +20,6 @@ import Playground, { handleHash } from '../Playground';
(window as any).Inspector = jest.fn();
(window as any).Inspector.highlightClean = jest.fn();

jest.mock('ace-builds', () => ({
...jest.requireActual('ace-builds'),
require: jest.fn()
}));

const acequireMock = acequire as jest.Mock;

// Using @testing-library/react to render snapshot instead of react-test-renderer
// as the useRefs require the notion of React DOM
const renderTree = async (router: Router) => {
Expand Down Expand Up @@ -61,10 +53,6 @@ describe('Playground tests', () => {
)
}
];
acequireMock.mockReturnValue({
Mode: jest.fn(),
setCompleters: jest.fn()
});
});

test('Playground renders correctly', async () => {
Expand Down
4 changes: 0 additions & 4 deletions src/pages/sicp/subcomponents/__tests__/CodeSnippet.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
import 'ace-builds';
import 'ace-builds/webpack-resolver';
import 'ace-builds/src-noconflict/ace';

import lzString from 'lz-string';
import { shallowRender } from 'src/commons/utils/TestUtils';

Expand Down