feat: migrate the server side

Author: boazpoolman

.eslintrc.js

@@ -34,7 +34,8 @@ module.exports = {
         "project": [path.join(__dirname, './tsconfig.jest.json')],
       },
       "rules": {
-        "@typescript-eslint/await-thenable": "off"
+        "@typescript-eslint/await-thenable": "off",
+        "import/no-relative-packages": "off",
       }
     }
   ],
@@ -48,6 +49,6 @@ module.exports = {
     }],
     "import/prefer-default-export": "off",
     "arrow-body-style": "off",
-    "@typescript-eslint/unbound-method": "off"
+    "@typescript-eslint/unbound-method": "off",
   }
 }

packages/core/server/bootstrap.ts

@@ -1,6 +1,4 @@
 import { Core } from '@strapi/strapi';
-import { IStrapi } from './types/strapi';
-import { getPluginService } from './util/getPluginService';
 
 export default async ({ strapi }: { strapi: Core.Strapi }) => {
   try {

packages/core/server/controllers/core.ts

@@ -1,5 +1,6 @@
 
 import { Context } from 'koa';
+import { Schema, UID } from '@strapi/strapi';
 
 import { getPluginService } from '../util/getPluginService';
 import { sanitizeOutput } from '../util/sanitizeOutput';
@@ -13,7 +14,7 @@ export default {
     const { path } = ctx.query;
     const { auth } = ctx.state;
 
-    const { entity, contentType } = await getPluginService('byPathService').byPath(path as string, ctx.query);
+    const { entity, contentType } = await getPluginService('url-alias').findRelatedEntity(path as string, ctx.query);
 
     if (!entity) {
       ctx.notFound();
@@ -25,14 +26,20 @@ export default {
     await strapi.auth.verify(auth, { scope: [`${contentType}.find`] });
 
     // Add content type to response.
-    // @ts-ignore
-    entity.contentType = contentType;
-    const contentTypeObj = strapi.contentTypes[contentType];
+    const responseEntity = {
+      ...entity,
+      contentType,
+    };
+
+    const contentTypeObj = strapi.contentTypes[contentType] as Schema.ContentType;
 
     // Format response.
-    const sanitizedEntity = await sanitizeOutput(entity, contentTypeObj, auth);
-    ctx.body = strapi.controller(contentType)
-      // @ts-ignore
+    const sanitizedEntity = await sanitizeOutput(responseEntity, contentTypeObj, auth);
+    ctx.body = strapi.controller(contentType as UID.Controller)
+      // @ts-expect-error
+      // The strapi object is typed in a way that the following is expected to be a controller.
+      // In fact that is not true, as this also exposes the helper functions of the controller.
+      // That is the reason we put a ts-expect-error here.
       .transformResponse(sanitizedEntity, {});
   },
 };

packages/core/server/controllers/info.ts

@@ -47,7 +47,7 @@ export default {
       uid: string;
     }[] = [];
     if (strapi.plugin('i18n')) {
-      const locales = await strapi.entityService.findMany('plugin::i18n.locale');
+      const locales = await strapi.documents('plugin::i18n.locale').findMany();
       locales.forEach((locale) => {
         formattedLocales.push({
           name: locale.name,
@@ -61,7 +61,7 @@ export default {
   },
 
   getAddons: (ctx: Context) => {
-    const addons = getAddons(strapi);
+    const addons = getAddons();
     ctx.body = addons;
   },
 

packages/core/server/controllers/url-alias.ts

@@ -5,7 +5,7 @@ import { errors } from '@strapi/utils';
 
 import { getPluginService } from '../util/getPluginService';
 import { KoaContext } from '../types/koa';
-import { GenerateParams } from '../admin-api/services/bulk-generate';
+import { GenerateParams } from '../services/bulk-generate';
 
 /**
  * URL alias controller
@@ -16,7 +16,7 @@ const contentTypeSlug = 'plugin::webtools.url-alias';
 export default factories.createCoreController(contentTypeSlug, ({ strapi }) => ({
   editLink: async (ctx: Context) => {
     const { path } = ctx.query;
-    const { entity, contentType } = await getPluginService('byPathService').byPath(path as string);
+    const { entity, contentType } = await getPluginService('url-alias').findRelatedEntity(path as string);
 
     if (!entity) {
       ctx.notFound();
@@ -45,10 +45,10 @@ export default factories.createCoreController(contentTypeSlug, ({ strapi }) => (
       throw new errors.ValidationError('Missing required POST parameter(s)', details);
     }
 
-    const generatedCount = await getPluginService('bulkGenerate').generateUrlAliases({ types, generationType });
+    const generatedCount = await getPluginService('bulk-generate').generateUrlAliases({ types, generationType });
 
     if (strapi.plugin('i18n')) {
-      await getPluginService('bulkGenerate').createLanguageLinksForUrlAliases();
+      await getPluginService('bulk-generate').createLanguageLinksForUrlAliases();
     }
 
     // Return the amount of generated URL aliases.

packages/core/server/controllers/url-pattern.ts

@@ -26,7 +26,7 @@ export default factories.createCoreController(contentTypeSlug, ({ strapi }) => (
       ]) as boolean;
       if (isInContentManager === false) return;
 
-      const fields = getPluginService('urlPatternService').getAllowedFields(
+      const fields = getPluginService('url-pattern').getAllowedFields(
         contentType,
         ['pluralName', 'string', 'uid', 'id'],
       );
@@ -37,7 +37,7 @@ export default factories.createCoreController(contentTypeSlug, ({ strapi }) => (
   },
 
   validatePattern: (ctx: KoaContext<{ pattern: string, modelName: UID.ContentType }>) => {
-    const urlPatternService = getPluginService('urlPatternService');
+    const urlPatternService = getPluginService('url-pattern');
     const { pattern, modelName } = ctx.request.body;
 
     const contentType = strapi.contentTypes[modelName];

packages/core/server/hooks/__tests__/disable.test.ts

@@ -1,7 +1,6 @@
-import { Shared } from '@strapi/strapi';
-import { setupStrapi, stopStrapi } from '../../../../../../playground/tests/helpers';
+import { setupStrapi, stopStrapi } from '../../../../../playground/tests/helpers';
 import { disableContentType } from '../disable';
-import { pluginId } from '../../../util/pluginId';
+import { pluginId } from '../../util/pluginId';
 
 beforeAll(async () => {
   await setupStrapi();
@@ -14,29 +13,27 @@ afterAll(async () => {
 describe('Hooks', () => {
   describe('Disable', () => {
     it('Should delete all the entries for a content type when it is disabled', async () => {
-      const entry = await strapi.entityService.create("api::test.test", {
+      const entry = await strapi.documents('api::test.test').create({
         data: {
           title: 'Some amazing new page',
         },
-        populate: ['url_alias']
+        populate: ['url_alias'],
       });
 
-      const urlAlias = entry.url_alias;
+      const urlAlias = entry.url_alias as { documentId: string, url_path: string }[];
       expect(urlAlias).toBeDefined();
-      
-      const id: number | string = urlAlias[0].id;
-      const urlPath: string | null = urlAlias.url_path;
+
+      const { documentId, url_path: urlPath } = urlAlias[0];
       expect(urlPath).not.toBeNull();
 
       const oldContentTypes = strapi.contentTypes;
-      const contentTypes: Shared.ContentTypes = {
+      const contentTypes = {
         ...oldContentTypes,
         'api::test.test': {
           ...oldContentTypes['api::test.test'],
           pluginOptions: {
             ...oldContentTypes['api::test.test'].pluginOptions,
             webtools: {
-              // @ts-expect-error - This is a test case and it should be able to set this to false
               enabled: false,
             },
           },
@@ -47,8 +44,9 @@ describe('Hooks', () => {
       await disableContentType({ oldContentTypes, contentTypes });
 
       // The url alias should be deleted now
-      // @ts-expect-error - fix types for tests
-      const deletedEntry = await strapi.entityService.findOne(`plugin::${pluginId}.url-alias`, id);
+      const deletedEntry = await strapi.documents(`plugin::${pluginId}.url-alias`).findOne({
+        documentId,
+      });
       expect(deletedEntry).toBeNull();
     });
   });

packages/core/server/register.ts

@@ -3,12 +3,11 @@
 
 import set from 'lodash/set';
 import { Core, Schema } from '@strapi/strapi';
-import { IStrapi } from './types/strapi';
 import { isContentTypeEnabled } from './util/enabledContentTypes';
 import { disableContentType } from './hooks/disable';
 
 export default ({ strapi }: { strapi: Core.Strapi }) => {
-  // strapi.hook('strapi::content-types.beforeSync').register(disableContentType);
+  strapi.hook('strapi::content-types.beforeSync').register(disableContentType);
 
   // Register the url_alias field.
   Object.values(strapi.contentTypes).forEach((contentType: Schema.ContentType) => {