refactor: address review comments

Author: navinkarkera

src/course-outline/data/apiHooks.ts

@@ -29,15 +29,13 @@ export const useCreateCourseBlock = (
 export const useCourseItemData = (itemId?: string, enabled: boolean = true) => (
   useQuery({
     queryKey: courseOutlineQueryKeys.courseItemId(itemId),
-    queryFn: () => getCourseItem(itemId!),
-    enabled: enabled && itemId !== undefined,
+    queryFn: enabled && itemId !== undefined ? () => getCourseItem(itemId!) : skipToken,
   })
 );
 
 export const useCourseDetails = (courseId?: string, enabled: boolean = true) => (
   useQuery({
     queryKey: courseOutlineQueryKeys.courseDetails(courseId),
-    queryFn: courseId ? () => getCourseDetails(courseId) : skipToken,
-    enabled: enabled && courseId !== undefined,
+    queryFn: enabled && courseId ? () => getCourseDetails(courseId) : skipToken,
   })
 );

src/data/api.mocks.ts

@@ -132,4 +132,4 @@ mockGetMigrationStatus.migrationStatusFailedOneLibraryData = {
     },
   ],
 } as api.MigrateTaskStatusData;
-mockGetMigrationStatus.applyMock = () => jest.spyOn(api, 'getMigrationStatus').mockImplementation(mockGetMigrationStatus);
+mockGetMigrationStatus.applyMock = () => jest.spyOn(api, 'getModulestoreMigrationStatus').mockImplementation(mockGetMigrationStatus);

src/data/api.test.ts

@@ -8,22 +8,22 @@ describe('legacy libraries migration API', () => {
     ({ axiosMock } = initializeMocks());
   });
 
-  describe('getMigrationStatus', () => {
+  describe('getModulestoreMigrationStatus', () => {
     it('should get migration status', async () => {
       const migrationId = '1';
-      const url = api.getMigrationStatusUrl(migrationId);
+      const url = api.getModulestoreMigrationStatusUrl(migrationId);
       axiosMock.onGet(url).reply(200);
-      await api.getMigrationStatus(migrationId);
+      await api.getModulestoreMigrationStatus(migrationId);
 
       expect(axiosMock.history.get[0].url).toEqual(url);
     });
   });
 
   describe('bulkMigrateLegacyLibraries', () => {
     it('should call bulk migrate legacy libraries', async () => {
-      const url = api.bulkMigrateContentToLibrariesUrl();
+      const url = api.bulkModulestoreMigrateUrl();
       axiosMock.onPost(url).reply(200);
-      await api.bulkMigrateContentToLibraries({
+      await api.bulkModulestoreMigrate({
         sources: [],
         target: '1',
       });

src/data/api.ts

@@ -6,12 +6,12 @@ const getStudioBaseUrl = () => getConfig().STUDIO_BASE_URL as string;
 /**
  * Get the URL to check the migration task status
  */
-export const getMigrationStatusUrl = (migrationId: string) => `${getStudioBaseUrl()}/api/modulestore_migrator/v1/migrations/${migrationId}/`;
+export const getModulestoreMigrationStatusUrl = (migrationId: string) => `${getStudioBaseUrl()}/api/modulestore_migrator/v1/migrations/${migrationId}/`;
 
 /**
  * Get the URL for bulk migrate content to libraries
  */
-export const bulkMigrateContentToLibrariesUrl = () => `${getStudioBaseUrl()}/api/modulestore_migrator/v1/bulk_migration/`;
+export const bulkModulestoreMigrateUrl = () => `${getStudioBaseUrl()}/api/modulestore_migrator/v1/bulk_migration/`;
 
 export const getApiWaffleFlagsUrl = (courseId?: string): string => {
   const baseUrl = getStudioBaseUrl();
@@ -121,21 +121,21 @@ export interface BulkMigrateRequestData {
 /**
  * Get migration task status
  */
-export async function getMigrationStatus(
+export async function getModulestoreMigrationStatus(
   migrationId: string,
 ): Promise<MigrateTaskStatusData> {
   const client = getAuthenticatedHttpClient();
-  const { data } = await client.get(getMigrationStatusUrl(migrationId));
+  const { data } = await client.get(getModulestoreMigrationStatusUrl(migrationId));
   return camelCaseObject(data);
 }
 
 /**
  * Bulk migrate content to libraries
  */
-export async function bulkMigrateContentToLibraries(
+export async function bulkModulestoreMigrate(
   requestData: BulkMigrateRequestData,
 ): Promise<MigrateTaskStatusData> {
   const client = getAuthenticatedHttpClient();
-  const { data } = await client.post(bulkMigrateContentToLibrariesUrl(), snakeCaseObject(requestData));
+  const { data } = await client.post(bulkModulestoreMigrateUrl(), snakeCaseObject(requestData));
   return camelCaseObject(data);
 }

src/data/apiHooks.ts

@@ -5,8 +5,8 @@ import { libraryAuthoringQueryKeys } from '@src/library-authoring/data/apiHooks'
 import {
   getWaffleFlags,
   waffleFlagDefaults,
-  bulkMigrateContentToLibraries,
-  getMigrationStatus,
+  bulkModulestoreMigrate,
+  getModulestoreMigrationStatus,
   BulkMigrateRequestData,
 } from './api';
 
@@ -51,10 +51,10 @@ export const useWaffleFlags = (courseId?: string) => {
 /**
  * Use this mutation to migrate multiple sources to a library
  */
-export const useBulkMigrate = () => {
+export const useBulkModulestoreMigrate = () => {
   const queryClient = useQueryClient();
   return useMutation({
-    mutationFn: async (requestData: BulkMigrateRequestData) => bulkMigrateContentToLibraries(requestData),
+    mutationFn: async (requestData: BulkMigrateRequestData) => bulkModulestoreMigrate(requestData),
     onSettled: (_data, _err, variables) => {
       queryClient.invalidateQueries({ queryKey: libraryAuthoringQueryKeys.courseImports(variables.target) });
       queryClient.invalidateQueries({ queryKey: libraryAuthoringQueryKeys.allMigrationInfo() });
@@ -65,10 +65,10 @@ export const useBulkMigrate = () => {
 /**
  * Get the migration status
  */
-export const useMigrationStatus = (migrationId: string | null) => (
+export const useModulestoreMigrationStatus = (migrationId: string | null) => (
   useQuery({
     queryKey: migrationQueryKeys.migrationTask(migrationId),
-    queryFn: migrationId ? () => getMigrationStatus(migrationId!) : skipToken,
+    queryFn: migrationId ? () => getModulestoreMigrationStatus(migrationId!) : skipToken,
     refetchInterval: 1000, // Refresh every second
   })
 );

src/legacy-libraries-migration/LegacyLibMigrationPage.test.tsx

@@ -14,7 +14,7 @@ import { mockGetStudioHomeLibraries } from '@src/studio-home/data/api.mocks';
 import { getContentLibraryV2CreateApiUrl } from '@src/library-authoring/create-library/data/api';
 import { getStudioHomeApiUrl } from '@src/studio-home/data/api';
 
-import { bulkMigrateContentToLibrariesUrl } from '@src/data/api';
+import { bulkModulestoreMigrateUrl } from '@src/data/api';
 import { LegacyLibMigrationPage } from './LegacyLibMigrationPage';
 
 const path = '/libraries-v1/migrate/*';
@@ -320,7 +320,7 @@ describe('<LegacyLibMigrationPage />', () => {
 
   it('should confirm migration', async () => {
     const user = userEvent.setup();
-    axiosMock.onPost(bulkMigrateContentToLibrariesUrl()).reply(200);
+    axiosMock.onPost(bulkModulestoreMigrateUrl()).reply(200);
     renderPage();
     expect(await screen.findByText('Migrate Legacy Libraries')).toBeInTheDocument();
     expect(await screen.findByText('MBA')).toBeInTheDocument();
@@ -377,7 +377,7 @@ describe('<LegacyLibMigrationPage />', () => {
 
   it('should show error when confirm migration', async () => {
     const user = userEvent.setup();
-    axiosMock.onPost(bulkMigrateContentToLibrariesUrl()).reply(400);
+    axiosMock.onPost(bulkModulestoreMigrateUrl()).reply(400);
     renderPage();
     expect(await screen.findByText('Migrate Legacy Libraries')).toBeInTheDocument();
     expect(await screen.findByText('MBA')).toBeInTheDocument();

src/legacy-libraries-migration/LegacyLibMigrationPage.tsx

@@ -25,7 +25,7 @@ import type { LibraryV1Data } from '@src/studio-home/data/api';
 import { ToastContext } from '@src/generic/toast-context';
 import { Filter, LibrariesList } from '@src/studio-home/tabs-section/libraries-tab';
 
-import { useBulkMigrate } from '@src/data/apiHooks';
+import { useBulkModulestoreMigrate } from '@src/data/apiHooks';
 import messages from './messages';
 import { SelectDestinationView } from './SelectDestinationView';
 import { ConfirmationView } from './ConfirmationView';
@@ -83,7 +83,7 @@ export const LegacyLibMigrationPage = () => {
   const [migrationFilter, setMigrationFilter] = useState<Filter[]>([Filter.unmigrated]);
   const [destinationLibrary, setDestination] = useState<ContentLibrary>();
   const [confirmationButtonState, setConfirmationButtonState] = useState('default');
-  const migrate = useBulkMigrate();
+  const migrate = useBulkModulestoreMigrate();
 
   const handleMigrate = useCallback(async () => {
     if (destinationLibrary) {

src/library-authoring/LibraryAuthoringPage.tsx

@@ -24,7 +24,7 @@ import { Add, InfoOutline } from '@openedx/paragon/icons';
 import { Link, useLocation, useNavigate } from 'react-router-dom';
 import { useQueryClient } from '@tanstack/react-query';
 
-import { useMigrationStatus } from '@src/data/apiHooks';
+import { useModulestoreMigrationStatus } from '@src/data/apiHooks';
 import Loading from '@src/generic/Loading';
 import SubHeader from '@src/generic/sub-header/SubHeader';
 import Header from '@src/header';
@@ -152,7 +152,7 @@ const LibraryAuthoringPage = ({
   const migrationId = params.get('migration_task');
   const {
     data: migrationStatusData,
-  } = useMigrationStatus(migrationId);
+  } = useModulestoreMigrationStatus(migrationId);
 
   const {
     isLoadingPage: isLoadingStudioHome,

src/library-authoring/data/apiHooks.ts

@@ -7,6 +7,7 @@ import {
   type QueryClient,
   replaceEqualDeep,
   keepPreviousData,
+  skipToken,
 } from '@tanstack/react-query';
 import { useCallback } from 'react';
 import { type MeiliSearch } from 'meilisearch';
@@ -977,7 +978,6 @@ export const useCourseImports = (libraryId: string) => (
 export const useMigrationInfo = (sourcesKeys: string[], enabled: boolean = true) => (
   useQuery({
     queryKey: libraryAuthoringQueryKeys.migrationInfo(sourcesKeys),
-    queryFn: () => api.getMigrationInfo(sourcesKeys),
-    enabled,
+    queryFn: enabled ? () => api.getMigrationInfo(sourcesKeys) : skipToken,
   })
 );

src/library-authoring/import-course/messages.ts

@@ -206,7 +206,7 @@ const messages = defineMessages({
   },
   importCourseAnalysisCompleteReimportBody: {
     id: 'library-authoring.import-course.review-details.analysis-complete.reimport.body',
-    defaultMessage: '{courseName} has already been imported into the Library "{libraryName}". If this secion is re-imported, all Sections, Subsections, Units and Content Blocks will be reimported again.',
+    defaultMessage: '{courseName} has already been imported into the Library "{libraryName}". If this course is re-imported, all Sections, Subsections, Units and Content Blocks will be reimported again.',
     description: 'Body of the info card when course import analysis is complete and it was already imported before.',
   },
   importCourseCompleteToastMessage: {