adapt-migrations 1.2.0 → 1.4.0

package/examples/script.js

@@ -1,78 +1,78 @@
-// Example migration script
-
-import { describe, whereContent, whereFromPlugin, whereToPlugin, mutateContent, checkContent, throwError, ifErroredAsk, testSuccessWhere, testErrorWhere, testStopWhere } from 'adapt-migrations';
-
-describe('update plugin from v6.1.4 to v6.1.5 and add "Ollie" to display title', async () => {
-  whereFromPlugin('text v6.1.4', { name: 'adapt-contrib-text', version: '<=6.1.4' });
-  whereContent('has configured displayTitles', async content =>
-    content.some(({ displayTitle }) => displayTitle)
-  );
-  mutateContent('change displayTitle', async content => {
-    const quicknavs = content.filter(({ displayTitle }) => displayTitle);
-    quicknavs.forEach(item => (item.displayTitle += ' ollie'));
-    return true;
-  });
-  checkContent('check everything is ok', async content => {
-    const isInvalid = content.some(({ displayTitle }) => displayTitle && !String(displayTitle).endsWith(' ollie'));
-    if (isInvalid) throw new Error('found displayTitle without ollie at the end');
-    return true;
-  });
-  updatePlugin('update text plugin', {name: 'adapt-contrib-text', version: '6.1.5', framework: '>=5.19.4'})
-});
-
-describe('quicknav to pagenav', async () => {
-  addPlugin('add pagenav plugin', { name: 'pagenav', version: '1.0.0'});
-  whereFromPlugin('quicknav v1.0.0', { name: 'quicknav', version: '1.0.0' });
-  whereToPlugin('pagenav v1.0.0', { name: 'pagenav', version: '1.0.0' });
-  removePlugin('remove quicknav plugin', {name: 'quicknav'})
-  whereContent('has configured quicknavs', async content =>
-    content.some(({ _component }) => _component === 'quicknav')
-  );
-  mutateContent('change _component name', async content => {
-    const quicknavs = content.filter(({ _component }) => _component === 'quicknav');
-    quicknavs.forEach(item => (item._component = 'pagenav'));
-    return true;
-  });
-  checkContent('check everything is ok', async content => {
-    const isInvalid = content.some(({ isInvalid }) => isInvalid);
-    if (isInvalid) throw new Error('found invalid content attribute');
-    return true;
-  });
-  // TODO: handle errors with question, allow to run without ui
-  // ifErroredAsk({ question: 'Skip error', yes: 'Yes', no: 'No', defaultSkipError: true });
-  // TODO: modify stack traces one errors to refer to the original migration script rather than the cached one,keep map of cached files to original files
-  testSuccessWhere('Valid plugins and content', {
-    fromPlugins: [{ name: 'quicknav', version: '1.0.0' }],
-    toPlugins: [{ name: 'pagenav', version: '1.0.0' }],
-    content: [{ _component: 'quicknav' }]
-  });
-  testStopWhere('Invalid content', {
-    fromPlugins: [{ name: 'quicknav', version: '1.0.0' }],
-    toPlugins: [{ name: 'pagenav', version: '1.0.0' }],
-    content: [{ _component: 'quicknav1' }]
-  });
-  testStopWhere('Invalid origin plugins', {
-    fromPlugins: [{ name: 'quicknav', version: '0.1.0' }],
-    toPlugins: [{ name: 'pagenav', version: '0.1.0' }],
-    content: [{ _component: 'quicknav' }]
-  });
-  testStopWhere('Invalid destination plugins', {
-    content: [{ _component: 'quicknav' }],
-    fromPlugins: [{ name: 'quicknav', version: '1.0.0' }],
-    toPlugins: [{ name: 'pagenav', version: '0.1.0' }]
-  });
-  testErrorWhere('Has invalid configuration', {
-    fromPlugins: [{ name: 'quicknav', version: '1.0.0' }],
-    toPlugins: [{ name: 'pagenav', version: '1.0.0' }],
-    content: [{ _component: 'quicknav', isInvalid: true }]
-  });
-});
-
-describe('where quicknav is weirdly configured', async () => {
-  checkContent('check everything is ok', async content => {
-    const isInvalid = content.some(({ isInvalid }) => isInvalid);
-    if (isInvalid) throw new Error('Something went wrong');
-    return true;
-  });
-  throwError('this is an error');
-});
+// Example migration script
+
+import { describe, whereContent, whereFromPlugin, whereToPlugin, mutateContent, checkContent, throwError, ifErroredAsk, testSuccessWhere, testErrorWhere, testStopWhere } from 'adapt-migrations';
+
+describe('update plugin from v6.1.4 to v6.1.5 and add "Ollie" to display title', async () => {
+  whereFromPlugin('text v6.1.4', { name: 'adapt-contrib-text', version: '<=6.1.4' });
+  whereContent('has configured displayTitles', async content =>
+    content.some(({ displayTitle }) => displayTitle)
+  );
+  mutateContent('change displayTitle', async content => {
+    const quicknavs = content.filter(({ displayTitle }) => displayTitle);
+    quicknavs.forEach(item => (item.displayTitle += ' ollie'));
+    return true;
+  });
+  checkContent('check everything is ok', async content => {
+    const isInvalid = content.some(({ displayTitle }) => displayTitle && !String(displayTitle).endsWith(' ollie'));
+    if (isInvalid) throw new Error('found displayTitle without ollie at the end');
+    return true;
+  });
+  updatePlugin('update text plugin', {name: 'adapt-contrib-text', version: '6.1.5', framework: '>=5.19.4'})
+});
+
+describe('quicknav to pagenav', async () => {
+  addPlugin('add pagenav plugin', { name: 'pagenav', version: '1.0.0'});
+  whereFromPlugin('quicknav v1.0.0', { name: 'quicknav', version: '1.0.0' });
+  whereToPlugin('pagenav v1.0.0', { name: 'pagenav', version: '1.0.0' });
+  removePlugin('remove quicknav plugin', {name: 'quicknav'})
+  whereContent('has configured quicknavs', async content =>
+    content.some(({ _component }) => _component === 'quicknav')
+  );
+  mutateContent('change _component name', async content => {
+    const quicknavs = content.filter(({ _component }) => _component === 'quicknav');
+    quicknavs.forEach(item => (item._component = 'pagenav'));
+    return true;
+  });
+  checkContent('check everything is ok', async content => {
+    const isInvalid = content.some(({ isInvalid }) => isInvalid);
+    if (isInvalid) throw new Error('found invalid content attribute');
+    return true;
+  });
+  // TODO: handle errors with question, allow to run without ui
+  // ifErroredAsk({ question: 'Skip error', yes: 'Yes', no: 'No', defaultSkipError: true });
+  // TODO: modify stack traces one errors to refer to the original migration script rather than the cached one,keep map of cached files to original files
+  testSuccessWhere('Valid plugins and content', {
+    fromPlugins: [{ name: 'quicknav', version: '1.0.0' }],
+    toPlugins: [{ name: 'pagenav', version: '1.0.0' }],
+    content: [{ _component: 'quicknav' }]
+  });
+  testStopWhere('Invalid content', {
+    fromPlugins: [{ name: 'quicknav', version: '1.0.0' }],
+    toPlugins: [{ name: 'pagenav', version: '1.0.0' }],
+    content: [{ _component: 'quicknav1' }]
+  });
+  testStopWhere('Invalid origin plugins', {
+    fromPlugins: [{ name: 'quicknav', version: '0.1.0' }],
+    toPlugins: [{ name: 'pagenav', version: '0.1.0' }],
+    content: [{ _component: 'quicknav' }]
+  });
+  testStopWhere('Invalid destination plugins', {
+    content: [{ _component: 'quicknav' }],
+    fromPlugins: [{ name: 'quicknav', version: '1.0.0' }],
+    toPlugins: [{ name: 'pagenav', version: '0.1.0' }]
+  });
+  testErrorWhere('Has invalid configuration', {
+    fromPlugins: [{ name: 'quicknav', version: '1.0.0' }],
+    toPlugins: [{ name: 'pagenav', version: '1.0.0' }],
+    content: [{ _component: 'quicknav', isInvalid: true }]
+  });
+});
+
+describe('where quicknav is weirdly configured', async () => {
+  checkContent('check everything is ok', async content => {
+    const isInvalid = content.some(({ isInvalid }) => isInvalid);
+    if (isInvalid) throw new Error('Something went wrong');
+    return true;
+  });
+  throwError('this is an error');
+});

package/index.js

@@ -1,70 +1,70 @@
-import {
-  load,
-  capture,
-  migrate,
-  test
-} from './api/commands.js'
-import {
-  describe
-} from './api/describe.js'
-import {
-  whereContent,
-  whereFromPlugin,
-  whereToPlugin
-} from './api/where.js'
-import {
-  checkContent,
-  mutateContent
-} from './api/data.js'
-import {
-  ifErroredAsk,
-  throwError
-} from './api/errors.js'
-import {
-  testErrorWhere,
-  testStopWhere,
-  testSuccessWhere
-} from './api/tests.js'
-import {
-  updatePlugin,
-  removePlugin,
-  addPlugin
-} from './api/plugins.js'
-import {
-  getConfig,
-  getCourse,
-  getComponents
-} from './api/helpers.js'
-import Journal from './lib/Journal.js'
-import CacheManager from './lib/CacheManager.js'
-import Logger from './lib/Logger.js'
-
-export {
-  // commands
-  load,
-  capture,
-  migrate,
-  test,
-  // migration script api
-  describe,
-  whereContent,
-  whereFromPlugin,
-  whereToPlugin,
-  checkContent,
-  mutateContent,
-  ifErroredAsk,
-  throwError,
-  testErrorWhere,
-  testStopWhere,
-  testSuccessWhere,
-  updatePlugin,
-  removePlugin,
-  addPlugin,
-  getConfig,
-  getCourse,
-  getComponents,
-  // environment objects
-  Journal,
-  CacheManager,
-  Logger
-}
+import {
+  load,
+  capture,
+  migrate,
+  test
+} from './api/commands.js'
+import {
+  describe
+} from './api/describe.js'
+import {
+  whereContent,
+  whereFromPlugin,
+  whereToPlugin
+} from './api/where.js'
+import {
+  checkContent,
+  mutateContent
+} from './api/data.js'
+import {
+  ifErroredAsk,
+  throwError
+} from './api/errors.js'
+import {
+  testErrorWhere,
+  testStopWhere,
+  testSuccessWhere
+} from './api/tests.js'
+import {
+  updatePlugin,
+  removePlugin,
+  addPlugin
+} from './api/plugins.js'
+import {
+  getConfig,
+  getCourse,
+  getComponents
+} from './api/helpers.js'
+import Journal from './lib/Journal.js'
+import CacheManager from './lib/CacheManager.js'
+import Logger from './lib/Logger.js'
+
+export {
+  // commands
+  load,
+  capture,
+  migrate,
+  test,
+  // migration script api
+  describe,
+  whereContent,
+  whereFromPlugin,
+  whereToPlugin,
+  checkContent,
+  mutateContent,
+  ifErroredAsk,
+  throwError,
+  testErrorWhere,
+  testStopWhere,
+  testSuccessWhere,
+  updatePlugin,
+  removePlugin,
+  addPlugin,
+  getConfig,
+  getCourse,
+  getComponents,
+  // environment objects
+  Journal,
+  CacheManager,
+  Logger
+}

package/lib/CacheManager.js

@@ -1,95 +1,95 @@
-import crypto from 'crypto'
-import path from 'path'
-import globs from 'globs'
-import fs from 'fs-extra'
-import os from 'os'
-import Logger from './Logger.js'
-
-export const ONE_MINUTE = 60 * 1000
-export const ONE_HOUR = 60 * ONE_MINUTE
-export const ONE_WEEK = 7 * 24 * ONE_HOUR
-
-const logger = Logger.getInstance();
-
-export default class CacheManager {
-  constructor (maxAge = ONE_WEEK) {
-    this.maxAge = maxAge
-  }
-
-  static hash (path) {
-    return crypto
-      .createHash('sha1')
-      .update(path, 'utf8')
-      .digest('hex')
-  }
-
-  async getTempPath () {
-    const osTempPath = await fs.promises.realpath(path.resolve(os.tmpdir()))
-    const tempPath = path.posix.join(osTempPath, 'migrations')
-    await fs.ensureDir(tempPath)
-    return tempPath
-  }
-
-  async getCachePath ({ basePath = process.cwd(), outputPath, tempPath }) {
-    const projectHash = CacheManager.hash(path.join(basePath, outputPath))
-    if (tempPath) await fs.ensureDir(tempPath)
-    const cachePath = path.join(tempPath ?? await this.getTempPath(), `${projectHash}.cache`)
-    return cachePath
-  }
-
-  async getCheckFilePath () {
-    const checkFilePath = path.join(await this.getTempPath(), 'last.touch')
-    return checkFilePath
-  }
-
-  async isCleaningTime () {
-    // By default, clean once a day, or with a floor of one hourly intervals
-    const checkInterval = Math.max(this.maxAge / 7, ONE_HOUR)
-    const checkFilePath = await this.getCheckFilePath()
-    // Check if checkFile is older than the cleaning interval
-    return (!fs.existsSync(checkFilePath) || Date.now() - (await fs.stat(checkFilePath)).mtime >= checkInterval)
-  }
-
-  async clean () {
-    if (!await this.isCleaningTime()) return
-    logger.debug('CacheManager -- Clean running')
-    const checkFilePath = await this.getCheckFilePath()
-    // Touch checkFile
-    await fs.writeFile(checkFilePath, String(Date.now()))
-    logger.debug('CacheManager -- Clearing compilation caches')
-    const tempPath = await this.getTempPath()
-    // Fetch all cache files except checkFile
-    const files = await new Promise((resolve, reject) => globs([
-      `${tempPath}/**`,
-      `!${checkFilePath}`
-    ], {
-      nodir: true
-    }, (err, files) => err ? reject(err) : resolve(files)))
-    // Fetch file ages
-    const fileAges = []
-    const now = Date.now()
-    for (const index in files) {
-      const file = files[index]
-      let age = this.maxAge
-      try {
-        const stat = await fs.stat(file)
-        age = (now - stat.mtime)
-      } catch (err) {
-        logger.error(`CacheManager -- ${err}`)
-      }
-      fileAges[index] = { file, age }
-    }
-    // Sort by oldest
-    fileAges.sort((a, b) => b.age - a.age)
-    // Filter by expired
-    const toRemove = fileAges.filter(fileAge => fileAge.age >= this.maxAge)
-    // Delete expired cache files
-    for (const fileAge of toRemove) {
-      try {
-        await fs.unlink(fileAge.file)
-      } catch (err) {
-        logger.error(`CacheManager -- Could not clear cache file ${fileAge.file}`)
-      }
-    }
-  }
-};
+import crypto from 'crypto'
+import path from 'path'
+import globs from 'globs'
+import fs from 'fs-extra'
+import os from 'os'
+import Logger from './Logger.js'
+
+export const ONE_MINUTE = 60 * 1000
+export const ONE_HOUR = 60 * ONE_MINUTE
+export const ONE_WEEK = 7 * 24 * ONE_HOUR
+
+const logger = Logger.getInstance();
+
+export default class CacheManager {
+  constructor (maxAge = ONE_WEEK) {
+    this.maxAge = maxAge
+  }
+
+  static hash (path) {
+    return crypto
+      .createHash('sha1')
+      .update(path, 'utf8')
+      .digest('hex')
+  }
+
+  async getTempPath () {
+    const osTempPath = await fs.promises.realpath(path.resolve(os.tmpdir()))
+    const tempPath = path.posix.join(osTempPath, 'migrations')
+    await fs.ensureDir(tempPath)
+    return tempPath
+  }
+
+  async getCachePath ({ basePath = process.cwd(), outputPath, tempPath }) {
+    const projectHash = CacheManager.hash(path.join(basePath, outputPath))
+    if (tempPath) await fs.ensureDir(tempPath)
+    const cachePath = path.join(tempPath ?? await this.getTempPath(), `${projectHash}.cache`)
+    return cachePath
+  }
+
+  async getCheckFilePath () {
+    const checkFilePath = path.join(await this.getTempPath(), 'last.touch')
+    return checkFilePath
+  }
+
+  async isCleaningTime () {
+    // By default, clean once a day, or with a floor of one hourly intervals
+    const checkInterval = Math.max(this.maxAge / 7, ONE_HOUR)
+    const checkFilePath = await this.getCheckFilePath()
+    // Check if checkFile is older than the cleaning interval
+    return (!fs.existsSync(checkFilePath) || Date.now() - (await fs.stat(checkFilePath)).mtime >= checkInterval)
+  }
+
+  async clean () {
+    if (!await this.isCleaningTime()) return
+    logger.debug('CacheManager -- Clean running')
+    const checkFilePath = await this.getCheckFilePath()
+    // Touch checkFile
+    await fs.writeFile(checkFilePath, String(Date.now()))
+    logger.debug('CacheManager -- Clearing compilation caches')
+    const tempPath = await this.getTempPath()
+    // Fetch all cache files except checkFile
+    const files = await new Promise((resolve, reject) => globs([
+      `${tempPath}/**`,
+      `!${checkFilePath}`
+    ], {
+      nodir: true
+    }, (err, files) => err ? reject(err) : resolve(files)))
+    // Fetch file ages
+    const fileAges = []
+    const now = Date.now()
+    for (const index in files) {
+      const file = files[index]
+      let age = this.maxAge
+      try {
+        const stat = await fs.stat(file)
+        age = (now - stat.mtime)
+      } catch (err) {
+        logger.error(`CacheManager -- ${err}`)
+      }
+      fileAges[index] = { file, age }
+    }
+    // Sort by oldest
+    fileAges.sort((a, b) => b.age - a.age)
+    // Filter by expired
+    const toRemove = fileAges.filter(fileAge => fileAge.age >= this.maxAge)
+    // Delete expired cache files
+    for (const fileAge of toRemove) {
+      try {
+        await fs.unlink(fileAge.file)
+      } catch (err) {
+        logger.error(`CacheManager -- Could not clear cache file ${fileAge.file}`)
+      }
+    }
+  }
+};