Merge pull request #1380 from polywrap/pileks/patch-0.9.3/add-migrati…

…on-warnings

[Patch 0.9.3] - Add logging to migration actions

packages/cli/package.json

@@ -56,6 +56,7 @@
     "@polywrap/test-env-js": "0.9.3",
     "@polywrap/wasm-js": "0.9.3",
     "@polywrap/wrap-manifest-types-js": "0.9.3",
+    "@polywrap/logging-js": "0.9.3",
     "axios": "0.21.2",
     "chalk": "4.1.0",
     "chokidar": "3.5.1",

packages/cli/src/commands/manifest.ts

@@ -510,7 +510,7 @@ const runMigrateCommand = async (
 
 function migrateManifestFile(
   manifestFile: string,
-  migrationFn: (input: string, to: string) => string,
+  migrationFn: (input: string, to: string, logger?: Logger) => string,
   to: string,
   logger: Logger
 ): void {
@@ -528,7 +528,7 @@ function migrateManifestFile(
     encoding: "utf-8",
   });
 
-  const outputManifestString = migrationFn(manifestString, to);
+  const outputManifestString = migrationFn(manifestString, to, logger);
 
   // Cache the old manifest file
   const cache = new CacheDirectory({

packages/cli/src/commands/utils/createLogger.ts

@@ -1,4 +1,6 @@
-import { Logger, LogLevel, ConsoleLog } from "../../lib";
+import { Logger, ConsoleLog } from "../../lib";
+
+import { LogLevel } from "@polywrap/logging-js";
 
 export function createLogger(flags: {
   verbose?: boolean;

packages/cli/src/lib/logging/Log.ts

@@ -1,9 +1,4 @@
-export enum LogLevel {
-  DEBUG,
-  INFO,
-  WARN,
-  ERROR,
-}
+import { LogLevel } from "@polywrap/logging-js";
 
 export abstract class Log {
   public readonly level: LogLevel;

packages/cli/src/lib/logging/Logger.ts

@@ -1,10 +1,12 @@
-import { Log, LogLevel } from "./Log";
+import { Log } from "./Log";
+
+import { ILogger, LogLevel } from "@polywrap/logging-js";
 
 interface Logs {
   [name: string]: Log;
 }
 
-export class Logger {
+export class Logger implements ILogger {
   private _logs: Logs;
 
   constructor(logs: Logs) {

packages/cli/src/lib/logging/logs/ConsoleLog.ts

@@ -1,6 +1,7 @@
-import { Log, LogLevel } from "../Log";
+import { Log } from "../Log";
 
 import chalk from "chalk";
+import { LogLevel } from "@polywrap/logging-js";
 
 export class ConsoleLog extends Log {
   constructor(level: LogLevel) {

packages/cli/src/lib/logging/logs/FileLog.ts

@@ -1,6 +1,7 @@
-import { Log, LogLevel } from "../Log";
+import { Log } from "../Log";
 
 import fs, { WriteStream } from "fs";
+import { LogLevel } from "@polywrap/logging-js";
 
 export class FileLog extends Log {
   private _logFileStream: WriteStream;

packages/cli/src/lib/manifest/migrate/migrateAnyManifest.ts

@@ -1,12 +1,14 @@
 /* eslint-disable no-empty */
 
+import { ILogger } from "@polywrap/logging-js";
 import YAML from "yaml";
 
 export function migrateAnyManifest(
   manifestString: string,
   manifestTypeName: string,
-  migrateFn: (manifest: unknown, to: string) => unknown,
-  to: string
+  migrateFn: (manifest: unknown, to: string, logger?: ILogger) => unknown,
+  to: string,
+  logger?: ILogger
 ): string {
   let manifest: unknown | undefined;
   try {
@@ -21,7 +23,7 @@ export function migrateAnyManifest(
     throw Error(`Unable to parse ${manifestTypeName}: ${manifestString}`);
   }
 
-  const newManifest = migrateFn(manifest, to);
+  const newManifest = migrateFn(manifest, to, logger);
 
   const cleanedManifest = JSON.parse(JSON.stringify(newManifest));
   delete cleanedManifest.__type;

packages/cli/src/lib/manifest/migrate/migrateAppProjectManifest.ts

@@ -1,15 +1,18 @@
 import { migrateAnyManifest } from "./migrateAnyManifest";
 
 import { migrateAppManifest } from "@polywrap/polywrap-manifest-types-js";
+import { ILogger } from "@polywrap/logging-js";
 
 export function migrateAppProjectManifest(
   manifestString: string,
-  to: string
+  to: string,
+  logger?: ILogger
 ): string {
   return migrateAnyManifest(
     manifestString,
     "AppManifest",
     migrateAppManifest,
-    to
+    to,
+    logger
   );
 }

packages/cli/src/lib/manifest/migrate/migrateBuildExtensionManifest.ts

@@ -1,15 +1,18 @@
 import { migrateAnyManifest } from "./migrateAnyManifest";
 
 import { migrateBuildManifest } from "@polywrap/polywrap-manifest-types-js";
+import { ILogger } from "@polywrap/logging-js";
 
 export function migrateBuildExtensionManifest(
   manifestString: string,
-  to: string
+  to: string,
+  logger?: ILogger
 ): string {
   return migrateAnyManifest(
     manifestString,
     "BuildManifest",
     migrateBuildManifest,
-    to
+    to,
+    logger
   );
 }

packages/cli/src/lib/manifest/migrate/migrateDeployExtensionManifest.ts

@@ -1,15 +1,18 @@
 import { migrateAnyManifest } from "./migrateAnyManifest";
 
 import { migrateDeployManifest } from "@polywrap/polywrap-manifest-types-js";
+import { ILogger } from "@polywrap/logging-js";
 
 export function migrateDeployExtensionManifest(
   manifestString: string,
-  to: string
+  to: string,
+  logger?: ILogger
 ): string {
   return migrateAnyManifest(
     manifestString,
     "DeployManifest",
     migrateDeployManifest,
-    to
+    to,
+    logger
   );
 }

packages/cli/src/lib/manifest/migrate/migrateInfraExtensionManifest.ts

@@ -1,15 +1,18 @@
 import { migrateAnyManifest } from "./migrateAnyManifest";
 
 import { migrateInfraManifest } from "@polywrap/polywrap-manifest-types-js";
+import { ILogger } from "@polywrap/logging-js";
 
 export function migrateInfraExtensionManifest(
   manifestString: string,
-  to: string
+  to: string,
+  logger?: ILogger
 ): string {
   return migrateAnyManifest(
     manifestString,
     "InfraManifest",
     migrateInfraManifest,
-    to
+    to,
+    logger
   );
 }

packages/cli/src/lib/manifest/migrate/migrateMetaExtensionManifest.ts

@@ -1,15 +1,18 @@
 import { migrateAnyManifest } from "./migrateAnyManifest";
 
 import { migrateMetaManifest } from "@polywrap/polywrap-manifest-types-js";
+import { ILogger } from "@polywrap/logging-js";
 
 export function migrateMetaExtensionManifest(
   manifestString: string,
-  to: string
+  to: string,
+  logger?: ILogger
 ): string {
   return migrateAnyManifest(
     manifestString,
     "MetaManifest",
     migrateMetaManifest,
-    to
+    to,
+    logger
   );
 }

packages/cli/src/lib/manifest/migrate/migratePluginProjectManifest.ts

@@ -1,15 +1,18 @@
 import { migrateAnyManifest } from "./migrateAnyManifest";
 
 import { migratePluginManifest } from "@polywrap/polywrap-manifest-types-js";
+import { ILogger } from "@polywrap/logging-js";
 
 export function migratePluginProjectManifest(
   manifestString: string,
-  to: string
+  to: string,
+  logger?: ILogger
 ): string {
   return migrateAnyManifest(
     manifestString,
     "PluginManifest",
     migratePluginManifest,
-    to
+    to,
+    logger
   );
 }

packages/cli/src/lib/manifest/migrate/migratePolywrapProjectManifest.ts

@@ -1,15 +1,18 @@
 import { migrateAnyManifest } from "./migrateAnyManifest";
 
 import { migratePolywrapManifest } from "@polywrap/polywrap-manifest-types-js";
+import { ILogger } from "@polywrap/logging-js";
 
 export function migratePolywrapProjectManifest(
   manifestString: string,
-  to: string
+  to: string,
+  logger?: ILogger
 ): string {
   return migrateAnyManifest(
     manifestString,
     "PolywrapManifest",
     migratePolywrapManifest,
-    to
+    to,
+    logger
   );
 }

packages/cli/src/lib/manifest/migrate/migrateTestExtensionManifest.ts

@@ -1,12 +1,18 @@
 import { migrateAnyManifest } from "./migrateAnyManifest";
 
 import { migratePolywrapWorkflow } from "@polywrap/polywrap-manifest-types-js";
+import { ILogger } from "@polywrap/logging-js";
 
-export function migrateWorkflow(manifestString: string, to: string): string {
+export function migrateWorkflow(
+  manifestString: string,
+  to: string,
+  logger?: ILogger
+): string {
   return migrateAnyManifest(
     manifestString,
     "PolywrapWorkflow",
     migratePolywrapWorkflow,
-    to
+    to,
+    logger
   );
 }

packages/cli/src/lib/project/manifests/app/load.ts

@@ -22,7 +22,7 @@ export async function loadAppManifest(
     }
 
     try {
-      const result = deserializeAppManifest(manifest);
+      const result = deserializeAppManifest(manifest, { logger: logger });
       return Promise.resolve(result);
     } catch (e) {
       return Promise.reject(e);

packages/cli/src/lib/project/manifests/plugin/load.ts

@@ -26,7 +26,7 @@ export async function loadPluginManifest(
     }
 
     try {
-      const result = deserializePluginManifest(manifest);
+      const result = deserializePluginManifest(manifest, { logger: logger });
       return Promise.resolve(result);
     } catch (e) {
       return Promise.reject(e);

packages/cli/src/lib/project/manifests/polywrap/load.ts

@@ -42,7 +42,7 @@ export async function loadPolywrapManifest(
     }
 
     try {
-      const result = deserializePolywrapManifest(manifest);
+      const result = deserializePolywrapManifest(manifest, { logger: logger });
       return Promise.resolve(result);
     } catch (e) {
       return Promise.reject(e);
@@ -102,6 +102,7 @@ export async function loadBuildManifest(
 
     return deserializeBuildManifest(manifest, {
       extSchema: extSchema,
+      logger: logger,
     });
   };
 
@@ -137,7 +138,7 @@ export async function loadDeployManifest(
     }
 
     try {
-      let result = deserializeDeployManifest(manifest);
+      let result = deserializeDeployManifest(manifest, { logger: logger });
       result = (loadEnvironmentVariables(
         (result as unknown) as Record<string, unknown>
       ) as unknown) as DeployManifest;
@@ -213,7 +214,7 @@ export async function loadMetaManifest(
     }
 
     try {
-      const result = deserializeMetaManifest(manifest);
+      const result = deserializeMetaManifest(manifest, { logger: logger });
       return Promise.resolve(result);
     } catch (e) {
       return Promise.reject(e);
@@ -252,7 +253,7 @@ export async function loadInfraManifest(
     }
 
     try {
-      let result = deserializeInfraManifest(manifest);
+      let result = deserializeInfraManifest(manifest, { logger: logger });
       result = (loadEnvironmentVariables(
         (result as unknown) as Record<string, unknown>
       ) as unknown) as InfraManifest;
@@ -294,7 +295,7 @@ export async function loadWorkflowManifest(
     }
 
     try {
-      const result = deserializePolywrapWorkflow(manifest);
+      const result = deserializePolywrapWorkflow(manifest, { logger: logger });
       return Promise.resolve(result);
     } catch (e) {
       return Promise.reject(e);

packages/js/logging/README.md

@@ -0,0 +1,8 @@
+# @polywrap/logging-js
+
+An interface to which Loggers within the Polywrap Toolchain must conform.
+
+Contains:
+
+- `ILogger.ts` - the logger interface
+- `LogLevel.ts` - the log levels supported by the logger

packages/js/logging/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@polywrap/logging-js",
+  "description": "Polywrap Core Logging Interface",
+  "version": "0.9.3",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/polywrap/monorepo.git"
+  },
+  "main": "build/index.js",
+  "files": [
+    "build"
+  ],
+  "scripts": {
+    "build": "rimraf ./build && tsc --project tsconfig.build.json",
+    "lint": "eslint --color -c ../../../.eslintrc.js src/"
+  },
+  "dependencies": {
+  },
+  "devDependencies": {
+    "rimraf": "3.0.2",
+    "typescript": "4.1.6"
+  },
+  "gitHead": "7346adaf5adb7e6bbb70d9247583e995650d390a",
+  "publishConfig": {
+    "access": "public"
+  }
+}

packages/js/logging/src/ILogger.ts

@@ -0,0 +1,9 @@
+import { LogLevel } from "./LogLevel";
+
+export interface ILogger {
+  log(message: string, level: LogLevel): void;
+  debug(message: string): void;
+  info(message: string): void;
+  warn(message: string): void;
+  error(message: string): void;
+}

packages/js/logging/src/LogLevel.ts

@@ -0,0 +1,6 @@
+export enum LogLevel {
+  DEBUG,
+  INFO,
+  WARN,
+  ERROR,
+}