Merge pull request #36 from strapi/feature/migrateCoreContServ

Add migrations for factory files, config, and various other files

Author: derrickmehaffy

.github/workflows/tests.yml

@@ -1,12 +1,21 @@
 name: 'Tests'
-on: [push]
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    paths-ignore:
+      - '**.mdx?'
+      - '**.md?'
+
 jobs:
   unit_tests:
     name: 'unit_tests (node: ${{ matrix.node }})'
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [12, 14, 16]
+        node: [14, 16]
     steps:
       - uses: actions/checkout@v2
         with:

.gitignore

@@ -120,3 +120,6 @@ dist
 .node_modules
 .DS_Store
 .vscode
+
+# migration related
+v3/*

lib/v4/migration-helpers/__mocks__/mock-package-json-v3.json

@@ -10,5 +10,9 @@
     "strapi-plugin-upload": "3.6.8",
     "strapi-plugin-i18n": "3.6.8",
     "strapi-connector-bookshelf": "3.6.8"
+  },
+  "engines": {
+    "node": ">=10.16.0 <=14.x.x",
+    "npm": ">=10.16.0 <=14.x.x"
   }
 }

lib/v4/migration-helpers/__tests__/update-api-folder-structure.test.js

@@ -15,7 +15,6 @@ const fs = require('fs-extra');
 
 const updateApiFolderStructure = require('../update-api-folder-structure');
 const updateContentTypes = require('../convert-models-to-content-types');
-const updateRoutes = require('../update-routes');
 const updatePolicies = require('../update-api-policies');
 const runJscodeshift = require('../../utils/run-jscodeshift');
 
@@ -64,18 +63,6 @@ describe('update api folder structure', () => {
     ]);
   });
 
-  it('updates routes', async () => {
-    const appPath = 'test-dir';
-
-    await updateApiFolderStructure(appPath);
-
-    const expectedV4Path = join(resolve(appPath), 'src', 'api');
-    expect(updateRoutes.mock.calls).toEqual([
-      [join(expectedV4Path, 'test'), 'test', 'test'],
-      [join(expectedV4Path, 'test-two'), 'test-two', 'test-two'],
-    ]);
-  });
-
   it('updates policies', async () => {
     const appPath = 'test-dir';
 

lib/v4/migration-helpers/__tests__/update-package-dependencies.test.js

@@ -46,15 +46,13 @@ describe('update api folder structure', () => {
     const v4PackageJSON = {
       dependencies: {
         '@strapi/strapi': '4.0.0',
-        '@strapi/admin': '4.0.0',
-        '@strapi/utils': '4.0.0',
-        '@strapi/plugin-content-type-builder': '4.0.0',
-        '@strapi/plugin-content-manager': '4.0.0',
         '@strapi/plugin-users-permissions': '4.0.0',
-        '@strapi/plugin-email': '4.0.0',
-        '@strapi/plugin-upload': '4.0.0',
         '@strapi/plugin-i18n': '4.0.0',
       },
+      engines: {
+        node: '>=14.19.1 <=16.x.x',
+        npm: '>=6.0.0',
+      },
     };
 
     await updatePackageDependencies(testDir);

lib/v4/migration-helpers/convert-models-to-content-types.js

@@ -59,6 +59,20 @@ const convertModelToContentType = async (apiPath, contentTypeName) => {
             required: attribute.required,
             private: attribute.private,
           };
+        } else if (
+          attribute.plugin === 'admin' &&
+          (attribute.model === 'user' || attribute.collection === 'user')
+        ) {
+          // Handle admin user relation
+          attribute = {
+            type: 'relation',
+            target: 'admin::user',
+            relation: _.has(attribute, 'collection') ? 'oneToMany' : 'oneToOne',
+          };
+
+          if (attribute.private) {
+            attribute.private = true;
+          }
         } else if (attribute.via && attribute.model && isSingular(attribute.via)) {
           // One-To-One
           attribute = getRelationObject('oneToOne', { ...attribute, inversed: true });

lib/v4/migration-helpers/generate-application-config.js

@@ -0,0 +1,59 @@
+const { join } = require('path');
+const fs = require('fs-extra');
+
+const logger = require('../../global/utils/logger');
+
+/**
+ * @description Migrates v3 config structure to v4 structure
+ *
+ * @param {string} configPath Path to the config folder
+ * @param {string} database Database Type
+ * @param {function} liquidEngine Liquid engine to use for templating
+ */
+module.exports = async (configPath, database, liquidEngine) => {
+  const files = ['admin', 'api', 'database', 'middlewares', 'plugins', 'server'];
+
+  let paths = {};
+
+  files.forEach((file) => {
+    paths[file] = join(configPath, file);
+  });
+  
+  try {
+    // create config path
+    await fs.ensureDir(configPath);
+  } catch (error) {
+    logger.error(`an error occurred when creating ${configPath} folder`);
+    console.log(error);
+  }
+
+  for (const jsFile in files) {
+    let template;
+
+    const fileName = files[jsFile];
+
+    try {
+      // Compile the template
+      if (fileName !== 'database') {
+        template = await liquidEngine.renderFile(`config-${fileName}`);
+      } else {
+        template = await liquidEngine.renderFile(`config-${fileName}-${database}`);
+      }
+
+      // Create the js file
+      await fs.ensureFile(`${paths[fileName]}.js`);
+
+      // Create write stream for new js file
+      const file = fs.createWriteStream(`${paths[fileName]}.js`);
+
+      // Export core controllers from liquid template file
+      file.write(template);
+
+      // Close the write stream
+      file.end();
+    } catch (error) {
+      logger.error(`an error occurred when migrating ${fileName} config file`);
+      console.log(error);
+    }
+  }
+};

lib/v4/migration-helpers/templates/app-env.liquid

@@ -0,0 +1,34 @@
+## Server Settings
+
+HOST={{ host }}
+PORT={{ port }}
+APP_KEYS={{ appKeys }}
+
+## Admin Settings
+
+API_TOKEN_SALT={{ apiTokenSalt }}
+ADMIN_JWT_SECRET={{ adminJwtSecret }}
+
+## Users-Permissions Plugin Settings
+
+JWT_SECRET={{ jwtSecret }}
+
+## Database Settings
+{% if databaseType == 'mysql' %}
+DATABASE_HOST={{ databaseHost }}
+DATABASE_PORT={{ databasePort }}
+DATABASE_NAME={{ databaseName }}
+DATABASE_USERNAME={{ databaseUsername }}
+DATABASE_PASSWORD={{ databasePassword }}
+DATABASE_SSL={{ databaseSsl }}
+{% elsif databaseType == 'postgres' %}
+DATABASE_HOST={{ databaseHost }}
+DATABASE_PORT={{ databasePort }}
+DATABASE_NAME={{ databaseName }}
+DATABASE_USERNAME={{ databaseUsername }}
+DATABASE_PASSWORD={{ databasePassword }}
+DATABASE_SSL={{ databaseSsl }}
+DATABASE_SCHEMA={{ databaseSchema }}
+{% else %}
+DATABASE_FILENAME={{ databaseFilename }}
+{% endif %}

lib/v4/migration-helpers/templates/config-admin.liquid

@@ -0,0 +1,8 @@
+module.exports = ({ env }) => ({
+  auth: {
+    secret: env('ADMIN_JWT_SECRET'),
+  },
+  apiToken: {
+    salt: env('API_TOKEN_SALT'),
+  },
+});

lib/v4/migration-helpers/templates/config-api.liquid

@@ -0,0 +1,7 @@
+module.exports = {
+  rest: {
+    defaultLimit: 25,
+    maxLimit: 100,
+    withCount: true,
+  },
+};