Merge branch 'main' into 4.x

Author: GrahamCampbell

docs/guides/deprecations.md

@@ -30,6 +30,24 @@ Note:
 - The `serverless.yml` setting is ineffective for deprecations reported before the configuration is read.
 - `SLS_DEPRECATION_DISABLE` and `disabledDeprecations` remain respected, and no errors will be thrown for mentioned deprecation codes.
 
+<a name="STANDALONE_UNINSTALL_COMMAND_DEPRECATED"><div>&nbsp;</div></a>
+
+## Command `sls uninstall`
+
+Deprecation code: `STANDALONE_UNINSTALL_COMMAND_DEPRECATED`
+
+Removal target: osls v4.0.0
+
+The top-level standalone `sls uninstall` command is deprecated and scheduled for removal in osls v4.0.0. It only removes the legacy standalone binary directory and does not uninstall npm-installed osls.
+
+Use your package manager to uninstall npm-installed osls instead:
+
+```sh
+npm uninstall -g osls
+```
+
+This does not affect `serverless plugin uninstall`.
+
 <a name="VARIABLES_RESOLUTION_MODE"><div>&nbsp;</div></a>
 
 ## Property `variablesResolutionMode`

lib/cli/commands-schema/no-service.js

@@ -143,7 +143,7 @@ commands.set('plugin search', {
     'in non Windows environment.';
 
   commands.set('uninstall', {
-    usage: 'Uninstall osls',
+    usage: 'Deprecated: uninstall standalone osls binary',
     isHidden,
     noSupportNotice,
     lifecycleEvents: ['uninstall'],

lib/plugins/standalone.js

@@ -5,9 +5,15 @@ const { log, progress, style } = require('../utils/serverless-utils/log');
 const standaloneUtils = require('../utils/standalone');
 const { remove } = require('../utils/fs/remove');
 const cliCommandsSchema = require('../cli/commands-schema');
+const logDeprecation = require('../utils/log-deprecation');
 
 const BINARY_PATH = standaloneUtils.path;
 const mainProgress = progress.get('main');
+const uninstallCommandDeprecationMessage = [
+  'The top-level standalone `sls uninstall` command is deprecated and scheduled for removal in osls v4.0.0.',
+  'It only removes the legacy standalone binary directory and does not uninstall npm-installed osls.',
+  'Use your package manager to uninstall npm-installed osls. This does not affect `serverless plugin uninstall`.',
+].join('\n');
 
 module.exports = class Standalone {
   constructor(serverless, cliOptions) {
@@ -26,6 +32,7 @@ module.exports = class Standalone {
   }
 
   async uninstall() {
+    logDeprecation('STANDALONE_UNINSTALL_COMMAND_DEPRECATED', uninstallCommandDeprecationMessage);
     mainProgress.notice('Uninstalling standalone binary', { isMainEvent: true });
     await remove(path.dirname(BINARY_PATH));
     log.notice();

test/unit/lib/plugins/standalone.test.js

@@ -5,15 +5,17 @@ const fsp = fs.promises;
 const os = require('os');
 const path = require('path');
 const proxyquire = require('proxyquire');
+const sinon = require('sinon');
 const { expect } = require('chai');
 
 const { remove } = require('../../../../lib/utils/fs/remove');
 
-const loadStandalone = ({ binaryPath, removeStub } = {}) =>
+const loadStandalone = ({ binaryPath, logDeprecationStub, removeStub } = {}) =>
   proxyquire('../../../../lib/plugins/standalone', {
     '../utils/standalone': {
       path: binaryPath,
     },
+    '../utils/log-deprecation': logDeprecationStub || sinon.stub(),
     '../utils/fs/remove': { remove: removeStub || remove },
   });
 
@@ -30,14 +32,20 @@ describe('test/unit/lib/plugins/standalone.test.js', () => {
 
   it('recursively removes the standalone install directory on uninstall', async () => {
     const binaryPath = path.join(tmpDir, 'install', 'bin', 'serverless');
+    const logDeprecationStub = sinon.stub();
     await fsp.mkdir(path.dirname(binaryPath), { recursive: true });
     await fsp.writeFile(binaryPath, 'binary');
     await fsp.writeFile(path.join(tmpDir, 'install', 'config.json'), '{}');
-    const Standalone = loadStandalone({ binaryPath });
+    const Standalone = loadStandalone({ binaryPath, logDeprecationStub });
     const standalone = new Standalone({ pluginManager: { commandRunStartTime: Date.now() } }, {});
 
     await standalone.uninstall();
 
+    expect(logDeprecationStub).to.have.been.calledOnce;
+    expect(logDeprecationStub.firstCall.args[0]).to.equal(
+      'STANDALONE_UNINSTALL_COMMAND_DEPRECATED'
+    );
+    expect(logDeprecationStub.firstCall.args[1]).to.include('npm-installed osls');
     expect(fs.existsSync(path.dirname(binaryPath))).to.equal(false);
   });
 });