Merge branch 'callback-to-promises' into add-express-promise-router

Author: ricardo-devis-agullo

src/registry/domain/components-cache/components-list.ts

@@ -1,32 +1,31 @@
-import { promisify } from 'util';
 import semver from 'semver';
 import pLimit from 'p-limit';
 import getUnixUTCTimestamp from 'oc-get-unix-utc-timestamp';
-import { Cdn, ComponentsList, Config } from '../../../types';
+import { ComponentsList, Config } from '../../../types';
+import { StorageAdapter } from 'oc-storage-adapters-utils';
 
-export default function componentsList(conf: Config, cdn: Cdn) {
+export default function componentsList(conf: Config, cdn: StorageAdapter) {
   const filePath = (): string =>
     `${conf.storage.options.componentsDir}/components.json`;
 
   const componentsList = {
-    getFromJson: (): Promise<ComponentsList> =>
-      promisify(cdn.getJson)(filePath(), true),
+    getFromJson: (): Promise<ComponentsList> => cdn.getJson(filePath(), true),
 
     getFromDirectories: async (): Promise<ComponentsList> => {
       const componentsInfo: Dictionary<string[]> = {};
 
       const getVersionsForComponent = async (
         componentName: string
       ): Promise<string[]> => {
-        const versions = await promisify(cdn.listSubDirectories)(
+        const versions = await cdn.listSubDirectories(
           `${conf.storage.options.componentsDir}/${componentName}`
         );
 
         return versions.sort(semver.compare);
       };
 
       try {
-        const components = await promisify(cdn.listSubDirectories)(
+        const components = await cdn.listSubDirectories(
           conf.storage.options.componentsDir
         );
         const limit = pLimit(cdn.maxConcurrentRequests);
@@ -64,7 +63,7 @@ export default function componentsList(conf: Config, cdn: Cdn) {
     },
 
     save: (data: ComponentsList): Promise<unknown> =>
-      promisify(cdn.putFileContent)(JSON.stringify(data), filePath(), true)
+      cdn.putFileContent(JSON.stringify(data), filePath(), true)
   };
 
   return componentsList;

src/registry/domain/components-cache/index.ts

@@ -2,9 +2,10 @@ import _ from 'lodash';
 import getComponentsList from './components-list';
 import * as eventsHandler from '../events-handler';
 import getUnixUTCTimestamp from 'oc-get-unix-utc-timestamp';
-import { Cdn, ComponentsList, Config } from '../../../types';
+import { ComponentsList, Config } from '../../../types';
+import { StorageAdapter } from 'oc-storage-adapters-utils';
 
-export default function componentsCache(conf: Config, cdn: Cdn) {
+export default function componentsCache(conf: Config, cdn: StorageAdapter) {
   let cachedComponentsList: ComponentsList;
   let refreshLoop: NodeJS.Timeout;
 
@@ -36,8 +37,8 @@ export default function componentsCache(conf: Config, cdn: Cdn) {
     return data;
   };
 
-  const throwError = (code: string, message: unknown) => {
-    eventsHandler.fire('error', { code, message });
+  const throwError = (code: string, message: any) => {
+    eventsHandler.fire('error', { code, message: message?.message ?? message });
     throw code;
   };
 

src/registry/domain/components-details.ts

@@ -1,27 +1,26 @@
-import { promisify } from 'util';
 import pLimit from 'p-limit';
 import _ from 'lodash';
 import * as eventsHandler from './events-handler';
 import getUnixUTCTimestamp from 'oc-get-unix-utc-timestamp';
 import {
-  Cdn,
   Component,
   ComponentsDetails,
   ComponentsList,
   Config
 } from '../../types';
+import { StorageAdapter } from 'oc-storage-adapters-utils';
 
-export default function componentsDetails(conf: Config, cdn: Cdn) {
-  const returnError = (code: string, message: unknown) => {
-    eventsHandler.fire('error', { code, message });
+export default function componentsDetails(conf: Config, cdn: StorageAdapter) {
+  const returnError = (code: string, message: any) => {
+    eventsHandler.fire('error', { code, message: message?.message ?? message });
     throw code;
   };
 
   const filePath = (): string =>
     `${conf.storage.options.componentsDir}/components-details.json`;
 
   const getFromJson = (): Promise<ComponentsDetails> =>
-    promisify(cdn.getJson)(filePath(), true);
+    cdn.getJson(filePath(), true);
 
   const getFromDirectories = async (options: {
     componentsList: ComponentsList;
@@ -45,7 +44,7 @@ export default function componentsDetails(conf: Config, cdn: Cdn) {
     await Promise.all(
       missing.map(({ name, version }) =>
         limit(async () => {
-          const content: Component = await promisify(cdn.getJson)(
+          const content: Component = await cdn.getJson(
             `${conf.storage.options.componentsDir}/${name}/${version}/package.json`,
             true
           );
@@ -63,7 +62,7 @@ export default function componentsDetails(conf: Config, cdn: Cdn) {
   };
 
   const save = (data: ComponentsDetails): Promise<unknown> =>
-    promisify(cdn.putFileContent)(JSON.stringify(data), filePath(), true);
+    cdn.putFileContent(JSON.stringify(data), filePath(), true);
 
   const refresh = async (
     componentsList: ComponentsList

src/registry/domain/repository.ts

@@ -1,5 +1,4 @@
 import fs from 'fs-extra';
-import { promisify } from 'util';
 import getUnixUtcTimestamp from 'oc-get-unix-utc-timestamp';
 import path from 'path';
 import _ from 'lodash';
@@ -10,16 +9,20 @@ import registerTemplates from './register-templates';
 import settings from '../../resources/settings';
 import strings from '../../resources';
 import * as validator from './validators';
+import getPromiseBasedAdapter from './storage-adapter';
 import * as versionHandler from './version-handler';
 import errorToString from '../../utils/error-to-string';
-import { Cdn, Component, Config, Repository } from '../../types';
+import { Component, Config, Repository } from '../../types';
+import { StorageAdapter } from 'oc-storage-adapters-utils';
 
 const packageInfo = fs.readJsonSync(
   path.join(__dirname, '..', '..', '..', 'package.json')
 );
 
 export default function repository(conf: Config): Repository {
-  const cdn: Cdn = !conf.local && conf.storage.adapter(conf.storage.options);
+  const cdn: StorageAdapter =
+    !conf.local &&
+    (getPromiseBasedAdapter(conf.storage.adapter(conf.storage.options)) as any);
   const options = !conf.local ? conf.storage.options : null;
   const repositorySource = conf.local
     ? 'local repository'
@@ -111,7 +114,7 @@ export default function repository(conf: Config): Repository {
         return Promise.resolve(local.getCompiledView(componentName));
       }
 
-      return promisify(cdn.getFile)(
+      return cdn.getFile(
         getFilePath(componentName, componentVersion, 'template.js')
       );
     },
@@ -171,7 +174,7 @@ export default function repository(conf: Config): Repository {
         }
       }
 
-      return promisify(cdn.getJson)<Component>(
+      return cdn.getJson<Component>(
         getFilePath(componentName, componentVersion, 'package.json'),
         false
       );
@@ -220,7 +223,7 @@ export default function repository(conf: Config): Repository {
         'server.js'
       );
 
-      const content = await promisify(cdn.getFile)(filePath);
+      const content = await cdn.getFile(filePath);
 
       return { content, filePath };
     },
@@ -327,7 +330,7 @@ export default function repository(conf: Config): Repository {
         pkgDetails.packageJson
       );
 
-      await promisify(cdn.putDir)(
+      await cdn.putDir(
         pkgDetails.outputFolder,
         `${options!.componentsDir}/${componentName}/${componentVersion}`
       );

src/registry/domain/storage-adapter.ts

@@ -0,0 +1,85 @@
+import { fromCallback } from 'universalify';
+import { StorageAdapter } from 'oc-storage-adapters-utils';
+
+type RemovePromiseOverload<T> = T extends {
+  (...args: infer B): void;
+  (...args: any[]): Promise<any>;
+}
+  ? (...args: B) => void
+  : T;
+
+type LegacyStorageAdapter = {
+  [P in keyof StorageAdapter]: RemovePromiseOverload<StorageAdapter[P]>;
+};
+
+const officialAdapters = {
+  s3: { name: 'oc-s3-storage-adapter', firstPromiseBasedVersion: '1.2.0' },
+  gs: { name: 'oc-gs-storage-adapter', firstPromiseBasedVersion: '1.1.0' },
+  'azure-blob-storage': {
+    name: 'oc-azure-storage-adapter',
+    firstPromiseBasedVersion: '0.1.0'
+  }
+};
+type OfficialAdapter = keyof typeof officialAdapters;
+
+function isOfficialAdapter(
+  adapter: LegacyStorageAdapter
+): adapter is LegacyStorageAdapter & { adapterType: OfficialAdapter } {
+  return Object.keys(officialAdapters).includes(
+    adapter.adapterType as OfficialAdapter
+  );
+}
+
+function isPromiseBased(tryFunction: () => unknown) {
+  try {
+    (tryFunction as () => Promise<unknown>)().catch(() => {
+      // To not throw unhandled promise exceptions
+    });
+    return true;
+  } catch (err) {
+    return false;
+  }
+}
+
+function isLegacyAdapter(
+  adapter: StorageAdapter | LegacyStorageAdapter
+): adapter is LegacyStorageAdapter {
+  return !isPromiseBased(() => (adapter as StorageAdapter).getFile(''));
+}
+
+function convertLegacyAdapter(adapter: LegacyStorageAdapter): StorageAdapter {
+  return {
+    getFile: fromCallback(adapter.getFile),
+    getJson: fromCallback(adapter.getJson),
+    listSubDirectories: fromCallback(adapter.listSubDirectories),
+    putDir: fromCallback(adapter.putDir),
+    putFile: fromCallback(adapter.putFile),
+    putFileContent: fromCallback(adapter.putFileContent),
+    getUrl: adapter.getUrl,
+    maxConcurrentRequests: adapter.maxConcurrentRequests,
+    adapterType: adapter.adapterType
+  };
+}
+
+export default function getPromiseBasedAdapter(
+  adapter: StorageAdapter | LegacyStorageAdapter
+): StorageAdapter {
+  if (isLegacyAdapter(adapter)) {
+    if (isOfficialAdapter(adapter)) {
+      const pkg = officialAdapters[adapter.adapterType];
+      process.emitWarning(
+        `Adapters now should work with promises. Consider upgrading your package ${pkg.name} to at least version ${pkg.firstPromiseBasedVersion}`,
+        'DeprecationWarning'
+      );
+    } else {
+      process.emitWarning(
+        'Your adapter is using the old interface of working with callbacks. Consider upgrading it to work with promises, as the previous one will be deprecated.',
+        'DeprecationWarning'
+      );
+    }
+
+    return convertLegacyAdapter(adapter);
+  }
+
+  return adapter;
+}

src/types.ts

@@ -168,24 +168,6 @@ export interface Config {
   verbosity: number;
 }
 
-export interface Cdn {
-  adapterType: string;
-  getFile: (filePath: string, cb: Callback<string>) => void;
-  getJson<T>(filePath: string, force: boolean, cb: Callback<T, string>): void;
-  listSubDirectories: (
-    dir: string,
-    cb: Callback<string[], Error & { code?: string }>
-  ) => void;
-  maxConcurrentRequests: number;
-  putDir: (folderPath: string, filePath: string, cb: Callback) => void;
-  putFileContent: (
-    data: unknown,
-    path: string,
-    isPrivate: boolean,
-    callback: Callback<unknown, string>
-  ) => void;
-}
-
 type CompiledTemplate = (model: unknown) => string;
 
 interface CompilerOptions {