chore: update after code review

Author: sfdctaka

src/shared/identityUtils.ts

@@ -8,30 +8,23 @@
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 /* eslint-disable @typescript-eslint/no-unsafe-return */
 
-import fs from 'node:fs';
 import { randomBytes } from 'node:crypto';
 import { DevServerUtils } from './devServerUtils.js';
 
 class LwrConfigFile {
   public identityToken?: string;
 }
 
-const BYTES_TO_GENERATE = 32;
-
+// **********************************************************************************************
+// * TODO: When we finalize the implementation for the preview commands and things settle down, *
+// *       consider moving this class into CryptoUtils of lwc-dev-mobile-core instead.          *
+// **********************************************************************************************
 export class IdentityUtils {
-  public static async createIdentityToken(): Promise<void> {
-    const lwrConfigFile = DevServerUtils.getServerConfigFileLocation();
-    if (fs.existsSync(lwrConfigFile)) {
-      const config = DevServerUtils.fetchServerConfigFileContent() as LwrConfigFile;
-      if (config?.identityToken == null) {
-        config.identityToken = randomBytes(BYTES_TO_GENERATE).toString();
-        try {
-          await DevServerUtils.writeServerConfigFileContent(config);
-        } catch (err) {
-          const error = err as Error;
-          throw new Error(`Error thrown while trying to write identity token to lwr.config.js: ${error.message}`);
-        }
-      }
+  public static async updateServerConfigFileWithIdentityToken(byteSize = 32): Promise<void> {
+    const config = await DevServerUtils.fetchServerConfigFileContent() as LwrConfigFile;
+    if (config && !config.identityToken) {
+      config.identityToken = randomBytes(byteSize).toString();
+      await DevServerUtils.writeServerConfigFileContent(config);
     }
   }
 }

test/shared/identityUtils.test.ts

@@ -5,7 +5,6 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import fs from 'node:fs';
 import { expect } from 'chai';
 import { TestContext } from '@salesforce/core/testSetup';
 import { DevServerUtils } from '../../src/shared/devServerUtils.js';
@@ -18,56 +17,48 @@ describe('identityUtils', () => {
     $$.restore();
   });
 
-  it('createIdentityToken resolves if lwr.config.json is not found', async () => {
+  it('updateServerConfigFileWithIdentityToken resolves if lwr.config.json is not found', async () => {
     $$.SANDBOX.stub(DevServerUtils, 'getServerConfigFileLocation').returns('lwr.config.json');
-    $$.SANDBOX.stub(fs, 'existsSync').returns(false);
 
-    const resolved = await IdentityUtils.createIdentityToken();
+    const resolved = await IdentityUtils.updateServerConfigFileWithIdentityToken();
     expect(resolved).to.equal(undefined);
   });
 
-  it('createIdentityToken resolves if lwr.config.json has identity token', async () => {
+  it('updateServerConfigFileWithIdentityToken resolves if lwr.config.json has identity token', async () => {
     $$.SANDBOX.stub(DevServerUtils, 'getServerConfigFileLocation').returns('lwr.config.json');
-    $$.SANDBOX.stub(fs, 'existsSync').returns(true);
     $$.SANDBOX.stub(DevServerUtils, 'fetchServerConfigFileContent').returns({ identityToken: 'foo' });
 
-    const resolved = await IdentityUtils.createIdentityToken();
+    const resolved = await IdentityUtils.updateServerConfigFileWithIdentityToken();
     expect(resolved).to.equal(undefined);
   });
 
-  it('createIdentityToken resolves if lwr.config.json has identity token', async () => {
+  it('updateServerConfigFileWithIdentityToken resolves if lwr.config.json has identity token', async () => {
     $$.SANDBOX.stub(DevServerUtils, 'getServerConfigFileLocation').returns('lwr.config.json');
-    $$.SANDBOX.stub(fs, 'existsSync').returns(true);
     $$.SANDBOX.stub(DevServerUtils, 'fetchServerConfigFileContent').returns({ identityToken: 'foo' });
 
-    const resolved = await IdentityUtils.createIdentityToken();
+    const resolved = await IdentityUtils.updateServerConfigFileWithIdentityToken();
     expect(resolved).to.equal(undefined);
   });
 
-  it('createIdentityToken resolves if lwr.config.json has no idenity token and creates one', async () => {
+  it('updateServerConfigFileWithIdentityToken resolves if lwr.config.json has no idenity token and creates one', async () => {
     $$.SANDBOX.stub(DevServerUtils, 'getServerConfigFileLocation').returns('lwr.config.json');
-    $$.SANDBOX.stub(fs, 'existsSync').returns(true);
     $$.SANDBOX.stub(DevServerUtils, 'fetchServerConfigFileContent').returns({});
     $$.SANDBOX.stub(DevServerUtils, 'writeServerConfigFileContent').resolves();
 
-    const resolved = await IdentityUtils.createIdentityToken();
+    const resolved = await IdentityUtils.updateServerConfigFileWithIdentityToken();
     expect(resolved).to.equal(undefined);
   });
 
-  it('createIdentityToken rejects if identity token can not be written to lwr.config.json', async () => {
+  it('updateServerConfigFileWithIdentityToken rejects if identity token can not be written to lwr.config.json', async () => {
     const errorMessage = 'foo bar';
-    $$.SANDBOX.stub(DevServerUtils, 'getServerConfigFileLocation').returns('lwr.config.json');
-    $$.SANDBOX.stub(fs, 'existsSync').returns(true);
     $$.SANDBOX.stub(DevServerUtils, 'fetchServerConfigFileContent').returns({});
     $$.SANDBOX.stub(DevServerUtils, 'writeServerConfigFileContent').throws(new Error(errorMessage));
 
     try {
-      await IdentityUtils.createIdentityToken();
+      await IdentityUtils.updateServerConfigFileWithIdentityToken();
     } catch (err) {
       const error = err as Error;
-      expect(error.message).to.equal(
-        `Error thrown while trying to write identity token to lwr.config.js: ${errorMessage}`
-      );
+      expect(error.message).to.equal(errorMessage);
     }
   });
 });