Fix package deploy to not depend on rush

Author: jcreedcmu

extensions/ql-vscode/gulpfile.ts/deploy.ts

@@ -1,197 +1,68 @@
 import * as fs from 'fs-extra';
 import * as jsonc from 'jsonc-parser';
-import { IPackageJson } from '@microsoft/node-core-library';
 import * as path from 'path';
-import { getRushContext, RushContext } from './rush';
-import * as packlist from 'npm-packlist';
-import * as glob from 'glob-promise';
-import * as cpp from 'child-process-promise';
-
-interface PackageInfo {
-  name: string;
-  version: string;
-  sourcePath: string;
-  files: string[];
-  dependencies: PackageInfo[];
-  isRoot?: boolean;
-  copied?: boolean;
-}
-
-async function copyPackage(packageFiles: PackageInfo, destPath: string): Promise<void> {
-  for (const file of packageFiles.files) {
-    const sourceFilePath = path.resolve(packageFiles.sourcePath, file);
-    const destFilePath = path.resolve(destPath, file);
-    if (packageFiles.isRoot && (file === 'package.json')) {
-      // For non-release builds, we tweak the version number of the extension to add a prerelease
-      // suffix. Rather than just copying `package.json`, we'll parse the original copy, update the
-      // `version` property, and write it out to the new location.
-      const packageJson = jsonc.parse((await fs.readFile(sourceFilePath)).toString());
-      packageJson.version = packageFiles.version;
-      await fs.writeFile(destFilePath, JSON.stringify(packageJson));
-    }
-    else {
-      await fs.copy(sourceFilePath, destFilePath);
-    }
-  }
-}
 
 export interface DeployedPackage {
   distPath: string;
   name: string;
   version: string;
 }
 
-class PackageMap {
-  private map = new Map<string, Map<string, PackageInfo>>();
-
-  public getPackageInfo(name: string, version: string): PackageInfo | undefined {
-    const versionMap = this.map.get(name);
-    if (versionMap === undefined) {
-      return undefined;
-    }
-
-    return versionMap.get(version);
-  }
-
-  public addPackageInfo(pkg: PackageInfo): void {
-    if (this.getPackageInfo(pkg.name, pkg.version)) {
-      throw new Error(`Attempt to add duplicate package '${pkg.name}@${pkg.version}'.`);
-    }
-
-    let versionMap = this.map.get(pkg.name);
-    if (versionMap === undefined) {
-      versionMap = new Map<string, PackageInfo>();
-      this.map.set(pkg.name, versionMap);
-    }
-
-    versionMap.set(pkg.version, pkg);
-  }
-
-  public hasMultipleVersions(name: string): boolean {
-    return this.map.get(name)!.size > 1;
-  }
-}
-
-async function collectPackages(context: RushContext, name: string, version: string,
-  pkgs: PackageMap): Promise<PackageInfo> {
-
-  let pkg = pkgs.getPackageInfo(name, version);
-  if (!pkg) {
-    const info = await context.getPackageInfo(name, version);
-
-    let files: string[];
-    if (info.isLocal) {
-      // For local packages, use `packlist` to get the list of files that npm would have packed
-      // into the tarball.
-      files = packlist.sync({ path: info.path });
-    }
-    else {
-      // For non-local packages, just copy everything.
-      files = await glob('**/*', {
-        nodir: true,
-        cwd: info.path
-      });
-    }
-
-    pkg = {
-      name: name,
-      version: version,
-      sourcePath: info.path,
-      files: files,
-      dependencies: []
-    };
-
-    pkgs.addPackageInfo(pkg);
-
-    for (const dependencyName of info.dependencies.keys()) {
-      const dependencyVersion = info.dependencies.get(dependencyName)!;
-
-      const dependencyPackage = await collectPackages(context, dependencyName, dependencyVersion, pkgs);
-      pkg.dependencies.push(dependencyPackage);
-    }
-  }
-
-  return pkg;
-}
-
-async function copyPackageAndModules(pkg: PackageInfo, pkgs: PackageMap, destPath: string,
-  rootNodeModulesPath: string): Promise<void> {
-
-  let destPackagePath: string;
-  if (pkgs.hasMultipleVersions(pkg.name) || pkg.isRoot) {
-    // Copy as a nested package, and let `npm dedupe` fix it up later if possible.
-    destPackagePath = path.join(destPath, pkg.name);
-  }
-  else {
-    // Copy to the root `node_modules` directory.
-    if (pkg.copied) {
-      return;
-    }
-    pkg.copied = true;
-    destPackagePath = path.join(rootNodeModulesPath, pkg.name);
-  }
-
-  await copyPackage(pkg, destPackagePath);
-  const nodeModulesPath = path.join(destPackagePath, 'node_modules');
-  for (const dependencyPkg of pkg.dependencies) {
-    await copyPackageAndModules(dependencyPkg, pkgs, nodeModulesPath, rootNodeModulesPath);
+const packageFiles = [
+  '.vscodeignore',
+  'CHANGELOG.md',
+  'README.md',
+  'language-configuration.json',
+  'media',
+  'node_modules',
+  'out'
+];
+
+async function copyPackage(sourcePath: string, destPath: string): Promise<void> {
+  for (const file of packageFiles) {
+    console.log(`copying ${path.resolve(sourcePath, file)} to ${path.resolve(destPath, file)}`);
+    await fs.copy(path.resolve(sourcePath, file), path.resolve(destPath, file));
   }
 }
 
 export async function deployPackage(packageJsonPath: string): Promise<DeployedPackage> {
   try {
-    const context = await getRushContext(path.dirname(packageJsonPath));
-
-    const rootPackage: IPackageJson = jsonc.parse(await fs.readFile(packageJsonPath, 'utf8'));
+    const packageJson: any = jsonc.parse(await fs.readFile(packageJsonPath, 'utf8'));
 
     // Default to development build; use flag --release to indicate release build.
     const isDevBuild = !process.argv.includes('--release');
-    const distDir = path.join(context.rushConfig.rushJsonFolder, 'dist');
+    const distDir = path.join(__dirname, '../../../dist');
     await fs.mkdirs(distDir);
 
     if (isDevBuild) {
       // NOTE: rootPackage.name had better not have any regex metacharacters
-      const oldDevBuildPattern = new RegExp('^' + rootPackage.name + '[^/]+-dev[0-9.]+\\.vsix$');
+      const oldDevBuildPattern = new RegExp('^' + packageJson.name + '[^/]+-dev[0-9.]+\\.vsix$');
       // Dev package filenames are of the form
       //    vscode-codeql-0.0.1-dev.2019.9.27.19.55.20.vsix
       (await fs.readdir(distDir)).filter(name => name.match(oldDevBuildPattern)).map(build => {
         console.log(`Deleting old dev build ${build}...`);
         fs.unlinkSync(path.join(distDir, build));
       });
       const now = new Date();
-      rootPackage.version = rootPackage.version +
+      packageJson.version = packageJson.version +
         `-dev.${now.getUTCFullYear()}.${now.getUTCMonth() + 1}.${now.getUTCDate()}` +
         `.${now.getUTCHours()}.${now.getUTCMinutes()}.${now.getUTCSeconds()}`;
     }
 
-    const distPath = path.join(distDir, rootPackage.name);
+    const distPath = path.join(distDir, packageJson.name);
     await fs.remove(distPath);
     await fs.mkdirs(distPath);
 
-    console.log(`Gathering transitive dependencies of package '${rootPackage.name}'...`);
-    const pkgs = new PackageMap();
-    const rootPkg = await collectPackages(context, rootPackage.name, rootPackage.version, pkgs);
-    rootPkg.isRoot = true;
-
-    console.log(`Copying package '${rootPackage.name}' and its dependencies to '${distPath}'...`);
-    await copyPackageAndModules(rootPkg, pkgs, path.dirname(distPath), path.join(distPath, 'node_modules'));
-    await fs.copy(path.resolve(rootPkg.sourcePath, '.vscodeignore'), path.resolve(distPath, '.vscodeignore'));
+    await fs.writeFile(path.join(distPath, 'package.json'), JSON.stringify(packageJson, null, 2));
 
-    console.log(`Deduplicating dependencies of package '${rootPackage.name}'...`);
-    // We create a temporary `package-lock.json` file just to prevent `npm ls` from printing out the
-    // message that it created a package-lock.json.
-    const packageLockPath = path.join(distPath, 'package-lock.json');
-    await fs.writeFile(packageLockPath, '{}');
-    await cpp.spawn('npm', ['dedupe'], {
-      cwd: distPath,
-      stdio: 'inherit'
-    });
-    await fs.unlink(packageLockPath);
+    const sourcePath = path.join(__dirname, '..');
+    console.log(`Copying package '${packageJson.name}' and its dependencies to '${distPath}'...`);
+    await copyPackage(sourcePath, distPath);
 
     return {
       distPath: distPath,
-      name: rootPackage.name,
-      version: rootPackage.version
+      name: packageJson.name,
+      version: packageJson.version
     };
   }
   catch (e) {

extensions/ql-vscode/gulpfile.ts/index.ts

@@ -3,7 +3,8 @@ import { compileTypeScript, watchTypeScript, copyViewCss } from './typescript';
 import { compileTextMateGrammar } from './textmate';
 import { copyTestData } from './tests';
 import { compileView } from './webpack';
+import { packageExtension } from './package';
 
 export const buildWithoutPackage = gulp.parallel(compileTypeScript, compileTextMateGrammar, compileView, copyTestData, copyViewCss);
 export { compileTextMateGrammar, watchTypeScript, compileTypeScript };
-// exports.default = gulp.series(exports.buildWithoutPackage, packageExtension);
+exports.default = gulp.series(exports.buildWithoutPackage, packageExtension);

extensions/ql-vscode/gulpfile.ts/pnpm.ts

@@ -652,6 +652,7 @@
     "gulp-sourcemaps": "^2.6.5",
     "gulp-typescript": "^5.0.1",
     "husky": "~4.2.5",
+    "jsonc-parser": "^2.3.0",
     "lint-staged": "~10.2.2",
     "mocha": "~6.2.1",
     "mocha-sinon": "~2.1.0",