feat(node-workspace): maintain current version range prefix (#1723)

* feat(node-workspace): maintain current version range prefix

* chore: added tests

* chore: refactor

* chore: review comments

Author: OrKoN

__snapshots__/node-workspace.js

@@ -15,7 +15,7 @@ Release notes for path: node1, releaseType: node
 * update dependency foo/bar to 1.2.3
 * The following workspace dependencies were updated
   * dependencies
-    * @here/pkgA bumped from 3.3.3 to ^3.3.4
+    * @here/pkgA bumped from 3.3.3 to 3.3.4
 </details>
 
 <details><summary>@here/pkgC: 1.1.2</summary>
@@ -41,7 +41,7 @@ exports['NodeWorkspace plugin run appends dependency notes to an updated module
 * update dependency foo/bar to 1.2.3
 * The following workspace dependencies were updated
   * dependencies
-    * @here/pkgA bumped from 3.3.3 to ^3.3.4
+    * @here/pkgA bumped from 3.3.3 to 3.3.4
 `
 
 exports['NodeWorkspace plugin run appends dependency notes to an updated module 4'] = `
@@ -98,6 +98,16 @@ Release notes for path: node1, releaseType: node
 This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
 `
 
+exports['NodeWorkspace plugin run respects version prefix 1'] = `
+{
+  "name": "@here/plugin1",
+  "version": "4.4.4",
+  "peerDependencies": {
+    "@here/pkgA": "^3.3.3"
+  }
+}
+`
+
 exports['NodeWorkspace plugin run should ignore peer dependencies 1'] = `
 :robot: I have created a release *beep* *boop*
 ---

src/plugins/node-workspace.ts

@@ -167,13 +167,17 @@ export class NodeWorkspace extends WorkspacePlugin<Package> {
     for (const [depName, resolved] of graphPackage.localDependencies) {
       const depVersion = updatedVersions.get(depName);
       if (depVersion && resolved.type !== 'directory') {
+        const currentVersion = this.combineDeps(pkg)?.[depName];
+        const prefix = currentVersion
+          ? this.detectRangePrefix(currentVersion)
+          : '';
         updatedPackage.updateLocalDependency(
           resolved,
           depVersion.toString(),
-          '^'
+          prefix
         );
         this.logger.info(
-          `${pkg.name}.${depName} updated to ^${depVersion.toString()}`
+          `${pkg.name}.${depName} updated to ${prefix}${depVersion.toString()}`
         );
       }
     }
@@ -315,11 +319,7 @@ export class NodeWorkspace extends WorkspacePlugin<Package> {
       allPackages.map(packageJson => packageJson.name)
     );
     for (const packageJson of allPackages) {
-      const allDeps = Object.keys({
-        ...(packageJson.dependencies ?? {}),
-        ...(packageJson.devDependencies ?? {}),
-        ...(packageJson.optionalDependencies ?? {}),
-      });
+      const allDeps = Object.keys(this.combineDeps(packageJson));
       const workspaceDeps = allDeps.filter(dep =>
         workspacePackageNames.has(dep)
       );
@@ -343,6 +343,31 @@ export class NodeWorkspace extends WorkspacePlugin<Package> {
   protected pathFromPackage(pkg: Package): string {
     return pkg.location;
   }
+
+  private detectRangePrefix(version: string): string {
+    return (
+      Object.values(SUPPORTED_RANGE_PREFIXES).find(supportedRangePrefix =>
+        version.startsWith(supportedRangePrefix)
+      ) || ''
+    );
+  }
+
+  private combineDeps(packageJson: Package): Record<string, string> {
+    return {
+      ...(packageJson.dependencies ?? {}),
+      ...(packageJson.devDependencies ?? {}),
+      ...(packageJson.optionalDependencies ?? {}),
+    };
+  }
+}
+
+enum SUPPORTED_RANGE_PREFIXES {
+  CARET = '^',
+  TILDE = '~',
+  GREATER_THAN = '>',
+  LESS_THAN = '<',
+  EQUAL_OR_GREATER_THAN = '>=',
+  EQUAL_OR_LESS_THAN = '<=',
 }
 
 function getChangelogDepsNotes(original: Package, updated: Package): string {

test/plugins/node-workspace.ts

@@ -143,6 +143,45 @@ describe('NodeWorkspace plugin', () => {
       assertHasUpdate(updates, 'node1/package.json');
       snapshot(dateSafe(nodeCandidate!.pullRequest.body.toString()));
     });
+    it('respects version prefix', async () => {
+      const candidates: CandidateReleasePullRequest[] = [
+        buildMockCandidatePullRequest('plugin1', 'node', '4.4.4', {
+          component: '@here/plugin1',
+          updates: [
+            buildMockPackageUpdate(
+              'plugin1/package.json',
+              'plugin1/package.json'
+            ),
+          ],
+        }),
+        buildMockCandidatePullRequest('node1', 'node', '2.2.2', {
+          component: '@here/pkgA',
+          updates: [
+            buildMockPackageUpdate('node1/package.json', 'node1/package.json'),
+          ],
+        }),
+      ];
+      plugin = new NodeWorkspace(github, 'main', {
+        plugin1: {releaseType: 'node'},
+        node1: {releaseType: 'node'},
+      });
+      const newCandidates = await plugin.run(candidates);
+      expect(newCandidates).lengthOf(1);
+      const nodeCandidate = newCandidates.find(
+        candidate => candidate.config.releaseType === 'node'
+      );
+      expect(nodeCandidate).to.not.be.undefined;
+      const updates = nodeCandidate!.pullRequest.updates;
+      assertHasUpdate(updates, 'node1/package.json');
+
+      const update = assertHasUpdate(
+        updates,
+        'plugin1/package.json',
+        RawContent
+      );
+      const updater = update.updater as RawContent;
+      snapshot(updater.rawContent);
+    });
     it('combines node packages', async () => {
       const candidates: CandidateReleasePullRequest[] = [
         buildMockCandidatePullRequest('.', 'node', '5.5.6', {