Deprecate scaffolding for default model (#1173)

* Deprecate scaffolding for default model Also deprecate leveraging build-model script in favor of package.json scripts
thekevinscott · Oct 5, 2023 · fb08416 · fb08416
1 parent bd9281b
commit fb08416
Show file tree

Hide file tree

Showing 21 changed files with 219 additions and 130 deletions.
diff --git a/.deepsource.toml b/.deepsource.toml
@@ -10,7 +10,6 @@ exclude_patterns = [
   "examples/**", 
   "scripts/**", 
   "test/**", 
-  "packages/test-scaffolding/**", 
   "dev/**",
 ]
 

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -12,6 +12,11 @@ jobs:
       - name: 'Checkout repository'
         uses: actions/checkout@v2
 
+      - name: Setup tmate session
+        uses: mxschmitt/action-tmate@v3
+        with:
+          detached: true
+
       - name: 'Setup PNPM with Node 16'
         uses: ./.github/actions/setup-pnpm
         with:
@@ -169,11 +174,6 @@ jobs:
         with:
           gdrive_credentials_data: ${{ secrets.GDRIVE_CREDENTIALS_DATA }}          
 
-      # - name: Setup tmate session
-      #   uses: mxschmitt/action-tmate@v3
-      #   with:
-      #     detached: true
-
       - name: 'Build Models'
         run: pnpm test:integration:browser -- --ci --verbose --skipTest --skipUpscalerBuild --skipBundle
 

diff --git a/internals/upscaler-cli/src/lib/package-scripts/build-model.ts b/internals/upscaler-cli/src/lib/package-scripts/build-model.ts
@@ -221,7 +221,9 @@ const buildModel = async (
   if (opts.verbose) {
     console.log(`Scaffolding dependencies for model ${model}`);
   }
-  scaffoldDependencies(MODEL_ROOT, scaffoldDependenciesConfig);
+  if (model !== 'default-model') {
+    scaffoldDependencies(MODEL_ROOT, scaffoldDependenciesConfig);
+  }
 
   // rimraf(DIST);
   // await mkDistFolder(DIST);

diff --git a/models/default-model/package.json b/models/default-model/package.json
@@ -19,21 +19,24 @@
   },
   "exports": {
     ".": {
-      "require": "./dist/cjs/models/default-model/src/index.js",
-      "import": "./dist/esm/models/default-model/src/index.js"
+      "require": "./dist/cjs/models/default-model/src/cjs.js",
+      "import": "./dist/esm/models/default-model/src/esm.js"
     }
   },
+  "module": "dist/esm/models/default-model/src/esm.js",
+  "types": "dist/esm/models/default-model/src/esm.d.ts",
+  "umd:main": "dist/umd/models/default-model/src/umd.js",
   "scripts": {
-    "scaffold:dependencies": "ts-node ../../scripts/package-scripts/scaffold-dependencies.ts --src models/default-model --config models/scaffolder.ts",
-    "lint:fix": "pnpm lint --fix",
-    "lint": "pnpm scaffold:dependencies && eslint -c ../.eslintrc.js src --ext .ts",
-    "prepublishOnly": "pnpm lint && pnpm build && pnpm validate:build",
-    "validate:build": "ts-node ../../scripts/package-scripts/validate-build.ts models/default-model",
-    "build": "ts-node ../../scripts/package-scripts/build-model.ts default-model -o cjs -o esm -o umd --skipCheckModelsExist",
-    "build:cjs": "ts-node ../../scripts/package-scripts/build-model.ts default-model -o cjs",
-    "build:esm": "ts-node ../../scripts/package-scripts/build-model.ts default-model -o esm",
-    "build:umd": "ts-node ../../scripts/package-scripts/build-model.ts default-model -o umd",
-    "clean": "ts-node ../../scripts/package-scripts/clean-model.ts default-model"
+    "lint": "wireit",
+    "prepublishOnly": "wireit",
+    "validate:build": "wireit",
+    "build": "wireit",
+    "build:cjs": "wireit",
+    "build:esm": "wireit",
+    "build:umd": "wireit",
+    "build:umd:tsc": "wireit",
+    "build:umd:rollup": "wireit",
+    "build:umd:uglify": "wireit"
   },
   "files": [
     "assets/**/*",
@@ -45,15 +48,122 @@
     "@tensorflow/tfjs": "~4.8.0"
   },
   "devDependencies": {
+    "@rollup/plugin-json": "^6.0.0",
+    "@tensorflow/tfjs": "~4.8.0",
     "@tensorflow/tfjs-core": "~4.8.0",
     "@tensorflow/tfjs-layers": "~4.8.0",
-    "@tensorflow/tfjs": "~4.8.0",
     "@tensorflow/tfjs-node": "~4.8.0",
     "@tensorflow/tfjs-node-gpu": "~4.8.0",
+    "babel-plugin-transform-inline-environment-variables": "^0.4.4",
     "seedrandom": "3.0.5"
   },
   "@upscalerjs": {
     "title": "Default Model",
     "modelFamily": "esrgan"
+  },
+  "wireit": {
+    "lint": {
+      "command": "eslint -c ../.eslintrc.js src --ext .ts"
+    },
+    "prepublishOnly": {
+      "command": "pnpm lint && pnpm build && pnpm validate:build"
+    },
+    "validate:build": {
+      "command": "ts-node ../../scripts/package-scripts/validate-build.ts models/default-model"
+    },
+    "scaffold": {
+      "command": "node -e 'const fs = require(\"fs\"); const {name, version} = require(\"./package.json\"); fs.writeFileSync(\"./src/constants.generated.ts\", `export const NAME = \"${name}\";\\nexport const VERSION=\"${version}\"`, \"utf-8\");'",
+      "files": [
+        "package.json"
+      ],
+      "output": [
+        "./src/constants.generated.ts"
+      ]
+    },
+    "build": {
+      "command": "pnpm build:cjs && pnpm build:esm && pnpm build:umd",
+      "dependencies": [
+        "../../packages/core:build",
+        "scaffold"
+      ],
+      "files": [
+        "src/**/*.ts",
+        "!src/**/*.test.ts",
+        "!src/**/*.generated.ts",
+        "../../../packages/shared/src/esrgan/**/*.ts",
+        "package.json",
+        "tsconfig.cjs.json",
+        "tsconfig.esm.json",
+        "tsconfig.umd.json",
+        "tsconfig.json",
+        "../tsconfig.cjs.json",
+        "../tsconfig.esm.json",
+        "../tsconfig.umd.json",
+        "../tsconfig.json"
+      ],
+      "output": [
+        "dist/**"
+      ]
+    },
+    "build:cjs": {
+      "command": "tsc -p ./tsconfig.cjs.json --outDir ./dist/cjs --baseUrl ./src",
+      "files": [
+        "src/**/*.ts",
+        "!src/**/*.test.ts",
+        "!src/**/*.generated.ts",
+        "../../../packages/shared/src/esrgan/**/*.ts",
+        "package.json",
+        "tsconfig.cjs.json",
+        "tsconfig.json",
+        "../tsconfig.cjs.json",
+        "../tsconfig.json"
+      ],
+      "output": [
+        "dist/esm/**"
+      ]
+    },
+    "build:esm": {
+      "command": "tsc -p ./tsconfig.esm.json --outDir ./dist/esm --baseUrl ./src",
+      "files": [
+        "src/**/*.ts",
+        "!src/**/*.test.ts",
+        "!src/**/*.generated.ts",
+        "../../../packages/shared/src/esrgan/**/*.ts",
+        "package.json",
+        "tsconfig.esm.json",
+        "tsconfig.json",
+        "../tsconfig.esm.json",
+        "../tsconfig.json"
+      ],
+      "output": [
+        "dist/esm/**"
+      ]
+    },
+    "build:umd": {
+      "command": "pnpm run build:umd:tsc && pnpm run build:umd:rollup && pnpm run build:umd:uglify && rimraf ./dist/umd-tmp",
+      "files": [
+        "src/**/*.ts",
+        "!src/**/*.test.ts",
+        "!src/**/*.generated.ts",
+        "../../../packages/shared/src/esrgan/**/*.ts",
+        "package.json",
+        "tsconfig.umd.json",
+        "tsconfig.json",
+        "../tsconfig.umd.json",
+        "../tsconfig.json"
+      ],
+      "output": [
+        "dist/umd/**"
+      ]
+    },
+    "build:umd:tsc": {
+      "command": "tsc -p ./tsconfig.umd.json --outDir ./dist/umd-tmp"
+    },
+    "build:umd:rollup": {
+      "command": "rollup -c ../rollup.config.cjs --input ./dist/umd-tmp/models/default-model/src/index.js --file ./dist/umd/index.js --name DefaultUpscalerJSModel --format umd"
+    },
+    "build:umd:uglify": {
+      "command": "uglifyjs ./dist/umd/index.js --output ./dist/umd/index.min.js --compress --mangle --source-map"
+    }
   }
 }
diff --git a/models/default-model/src/cjs.ts b/models/default-model/src/cjs.ts
@@ -0,0 +1,2 @@
+import { default as DefaultModel, } from './index';
+module.exports = DefaultModel; // eslint-disable-line
diff --git a/models/default-model/src/esm.ts b/models/default-model/src/esm.ts
@@ -0,0 +1 @@
+export { default as default, } from './index';
diff --git a/models/default-model/src/index.ts b/models/default-model/src/index.ts
@@ -5,6 +5,8 @@ const SCALE = 2;
 
 const modelDefinition = getESRGANModelDefinition({
   scale: SCALE,
+  // name: getValue(packageJSON, 'name'),
+  // version: getValue(packageJSON, 'version'),
   name: NAME,
   version: VERSION,
   path: 'models/model.json',

diff --git a/models/default-model/src/umd.ts b/models/default-model/src/umd.ts
@@ -0,0 +1 @@
+export { default as default, } from '.';
diff --git a/models/default-model/tsconfig.cjs.json b/models/default-model/tsconfig.cjs.json
@@ -1,10 +1,6 @@
 {
   "extends": "../tsconfig.cjs.json",
-  "compilerOptions": {
-    "baseUrl": "./src",
-    "outDir": "./dist/cjs",
-  },
   "include": [
-    "./src/index.ts",
+    "./src/cjs.ts",
   ]
 }
diff --git a/models/default-model/tsconfig.esm.json b/models/default-model/tsconfig.esm.json
@@ -1,10 +1,6 @@
 {
   "extends": "../tsconfig.esm.json",
-  "compilerOptions": {
-    "baseUrl": "./src",
-    "outDir": "./dist/esm",
-  },
   "include": [
-    "./src/index.ts",
+    "./src/esm.ts",
   ]
 }
diff --git a/models/default-model/tsconfig.json b/models/default-model/tsconfig.json
@@ -1,6 +1,6 @@
 {
   "extends": "../tsconfig.json",
-  "include": ["src/**/*.ts"],
+  "include": ["src/**/*.ts", "src/foo.js"],
   "exclude": ["node_modules", "**/*.test.ts"],
   "compilerOptions": {
     "rootDirs": ["./src", "../../../packages/shared/src"],

diff --git a/models/default-model/tsconfig.umd.json b/models/default-model/tsconfig.umd.json
@@ -1,10 +1,6 @@
 {
   "extends": "../tsconfig.umd.json",
-  "compilerOptions": {
-    "baseUrl": "./src",
-    "outDir": "./dist/tmp",
-  },
   "include": [
-    "./src/index.ts",
+    "./src/umd.ts",
   ]
 }
diff --git a/models/rollup.config.cjs b/models/rollup.config.cjs
@@ -0,0 +1,20 @@
+const commonjs = require('@rollup/plugin-commonjs');
+const rollupJSON = require('@rollup/plugin-json');
+const { nodeResolve, } = require('@rollup/plugin-node-resolve');
+
+module.exports = {
+  context: 'window',
+  external: [
+    '@tensorflow/tfjs',
+  ],
+  plugins: [
+    nodeResolve({
+      preferBuiltins: true,
+      resolveOnly: [
+        /^(?!.*(@tensorflow\/tfjs))/,
+      ],
+    }),
+    commonjs(),
+    rollupJSON(),
+  ],
+};
diff --git a/models/tsconfig.cjs.json b/models/tsconfig.cjs.json
@@ -1,8 +1,8 @@
 {
   "extends": "./tsconfig.json",
   "compilerOptions": {
-    "moduleResolution": "Node",
+    "moduleResolution": "Node16",
+    "module": "CommonJS",
     "target": "ES5",
-    "module": "ESNext",
-  }
+  },
 }
diff --git a/models/tsconfig.json b/models/tsconfig.json
@@ -5,6 +5,7 @@
     "strict": true,
     "removeComments": true,
     "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
     "declaration": true,
     "declarationMap": true,
     "noUnusedLocals": true,
@@ -14,4 +15,5 @@
     "noFallthroughCasesInSwitch": true,
     "rootDirs": ["./src", "../../../packages/shared/src"],
   },
+  "exclude": ["node_modules", "**/*.test.ts"]
 }
diff --git a/package.json b/package.json
@@ -178,7 +178,10 @@
       "command": "pnpm --filter=!\"@upscalerjs/docs\" --filter=!\"@upscalerjs/examples.*\" install"
     },
     "postinstall": {
-      "command": "pnpm --filter @upscalerjs/core --filter @upscalerjs/default-model build"
+      "dependencies": [
+        "./packages/core:build",
+        "./models/default-model:build"
+      ]
     },
     "update:dependency": {
       "command": "pnpm --filter @upscalerjs/scripts update:dependency"
@@ -196,7 +199,7 @@
       "command": "pnpm --filter @upscalerjs/scripts example:start"
     },
     "lint": {
-      "command": "pnpm --filter upscaler --filter @upscalerjs/* lint"
+      "command": "pnpm --parallel --filter=!./models/**/dist/** lint"
     },
     "model:build": {
       "command": "pnpm --filter @upscalerjs/scripts model:build"
@@ -223,7 +226,7 @@
       ]
     },
     "test:integration:node": {
-      "command": "echo 1",
+      "command": "pnpm --filter @upscalerjs/scripts test:integration:node",
       "dependencies": [
         "./packages/upscalerjs:build:node-gpu",
         "./packages/upscalerjs:build:node"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		import { default as DefaultModel, } from './index';
		module.exports = DefaultModel; // eslint-disable-line