From 6c2c335a9c3b87af53f0a3f489434d9dc9c4e629 Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Sat, 3 Jul 2021 09:42:54 -0400 Subject: [PATCH 01/24] Adding new controls --- app/index.html | 57 ++++++++++++++++++++++++++++++++++---------------- app/render.js | 10 +++++++++ 2 files changed, 49 insertions(+), 18 deletions(-) diff --git a/app/index.html b/app/index.html index 1b17fe7..30b4c96 100644 --- a/app/index.html +++ b/app/index.html @@ -75,30 +75,51 @@
- - - Your Salesforce username must be - in the form of an email address. -
-
- - -
-
- - - Likely you will need your Saleforce - Security token. If you do not have it follow these - reset instructions. + +
+ + +
+
+ + +
+
+
+ + + Your Salesforce username must + be + in the form of an email address. +
+
+ + +
+
+ + + Likely you will need your + Saleforce + Security token. If you do not have it follow these + reset instructions. +
+
diff --git a/app/render.js b/app/render.js index e6b4a15..6c3a527 100644 --- a/app/render.js +++ b/app/render.js @@ -43,6 +43,16 @@ $.when($.ready).then(() => { } }); + // Setup login radio behaviors. + $('#login-password-wrapper').hide(); + $('input[type=radio][name=sfconnect-radio-selectors]').on('change', (event) => { + if ($(event.target, ':checked').val() === 'oauth') { + $('#login-password-wrapper').hide(); + } else { + $('#login-password-wrapper').show(); + } + }); + // Get the current application preferences. window.api.send('get_preferences'); From 87f6e0d6e05b6e1e9e147a7bca1577b295c2932d Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Sat, 3 Jul 2021 09:50:36 -0400 Subject: [PATCH 02/24] Pass auth mode to main. --- app/render.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/app/render.js b/app/render.js index 6c3a527..56240c8 100644 --- a/app/render.js +++ b/app/render.js @@ -406,7 +406,9 @@ const displayDraftSchema = (schema) => { // ========= Messages to the main process =============== // Login document.getElementById('login-trigger').addEventListener('click', () => { + const modeRadio = document.querySelector('input[type=radio][name="sfconnect-radio-selectors"]:checked'); window.api.send('sf_login', { + mode: modeRadio.value, username: document.getElementById('login-username').value, password: document.getElementById('login-password').value, token: document.getElementById('login-token').value, From ce64da5a4a29729f875d6a68ad554082691d3ef4 Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Sat, 3 Jul 2021 11:32:55 -0400 Subject: [PATCH 03/24] Refactor of login calls. --- src/sf_calls.js | 145 ++++++++++++++++++++++++++++-------------------- 1 file changed, 85 insertions(+), 60 deletions(-) diff --git a/src/sf_calls.js b/src/sf_calls.js index c70f800..972e999 100644 --- a/src/sf_calls.js +++ b/src/sf_calls.js @@ -3,6 +3,7 @@ const path = require('path'); const electron = require('electron'); // eslint-disable-line const jsforce = require('jsforce'); const knex = require('knex'); +const oauth = require('./sf_oauth2'); // Get the dialog library from Electron const { dialog } = electron; @@ -11,10 +12,89 @@ const sfConnections = {}; let mainWindow = null; let proposedSchema = {}; +/** + * Send a log message to the console window. + * @param {String} title Message title or sender + * @param {String} channel Message category + * @param {String} message Message + * @returns True (always). + */ +const logMessage = (title, channel, message) => { + mainWindow.webContents.send('log_message', { + sender: title, + channel, + message, + }); + return true; +}; + +/** + * Sets the window object to allow direct return messages. + * @param {Object} window The Electron window used to pass messages to. + */ const setwindow = (window) => { mainWindow = window; }; +/** + * Attempt a traditional Username/Password login. + * @param {String} url + * @param {String} username + * @param {String} password + * @param {String} token + */ +const passwordLogin = (url, username, password, token) => { + const conn = new jsforce.Connection({ + // you can change loginUrl to connect to sandbox or prerelease env. + loginUrl: url, + }); + let pass = password; + if (token !== '') { + pass = `${password}${token}`; + } + + conn.login(username, pass, (err, userInfo) => { + if (err) { + mainWindow.webContents.send('sfShowOrgId', { + status: false, + message: 'Login Failed', + response: err, + limitInfo: conn.limitInfo, + request: { + url, + username, + password: '*****', + token: '*****', + }, + }); + return true; + } + // Now you can get the access token and instance URL information. + // Save them to establish connection next time. + logMessage('Login', 'Info', `Connected to Org: ${userInfo.organizationId} for User: ${userInfo.id}`); + + // Save the next connection in the global storage. + sfConnections[userInfo.organizationId] = { + instanceUrl: conn.instanceUrl, + accessToken: conn.accessToken, + }; + + mainWindow.webContents.send('response_login', { + status: true, + message: 'Login Successful', + response: userInfo, + limitInfo: conn.limitInfo, + request: { + url, + username, + password: '*****', + token: '*****', + }, + }); + return true; + }); +}; + const resolveFieldType = (sfTypeName) => { const typeResolver = { base64: 'binary', @@ -50,22 +130,6 @@ const resolveFieldType = (sfTypeName) => { return 'text'; }; -/** - * Send a log message to the console window. - * @param {String} title Message title or sender - * @param {String} channel Message category - * @param {String} message Message - * @returns True (always). - */ -const logMessage = (title, channel, message) => { - mainWindow.webContents.send('log_message', { - sender: title, - channel, - message, - }); - return true; -}; - /** * Extracts the list of field values from a picklist value set. * @param {Array} valueList list of values from a Salesforce describe response. @@ -401,51 +465,12 @@ const buildDatabase = (settings) => { const handlers = { // Login to an org using password authentication. sf_login: (event, args) => { - const conn = new jsforce.Connection({ - // you can change loginUrl to connect to sandbox or prerelease env. - loginUrl: args.url, - }); - - let { password } = args; - if (args.token !== '') { - password = `${password}${args.token}`; + if (args.mode === 'password') { + passwordLogin(args.url, args.username, args.password, args.token); + } + if (args.mode === 'oauth') { + oauth.attemptLogin(args.url); } - - conn.login(args.username, password, (err, userInfo) => { - // Since we send the args back to the interface, it's a good idea - // to remove the security information. - args.password = ''; - args.token = ''; - - if (err) { - mainWindow.webContents.send('sfShowOrgId', { - status: false, - message: 'Login Failed', - response: err, - limitInfo: conn.limitInfo, - request: args, - }); - return true; - } - // Now you can get the access token and instance URL information. - // Save them to establish connection next time. - logMessage(event.sender.getTitle(), 'Info', `Connection Org ${userInfo.organizationId} for User ${userInfo.id}`); - - // Save the next connection in the global storage. - sfConnections[userInfo.organizationId] = { - instanceUrl: conn.instanceUrl, - accessToken: conn.accessToken, - }; - - mainWindow.webContents.send('response_login', { - status: true, - message: 'Login Successful', - response: userInfo, - limitInfo: conn.limitInfo, - request: args, - }); - return true; - }); }, // Logout of a specific Salesforce org. sf_logout: (event, args) => { From 47f80cd7bd2d68a0eec5fe9d161894060d8465dd Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Sat, 3 Jul 2021 11:33:56 -0400 Subject: [PATCH 04/24] Initial draft of oauth interface (non-functional) --- src/sf_oauth2.js | 101 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 101 insertions(+) create mode 100644 src/sf_oauth2.js diff --git a/src/sf_oauth2.js b/src/sf_oauth2.js new file mode 100644 index 0000000..96de976 --- /dev/null +++ b/src/sf_oauth2.js @@ -0,0 +1,101 @@ +const electron = require("electron"); // eslint-disable-line + +// Extract the needed elements. +const { + app, + BrowserWindow, + session, +} = electron; + +// Additional Tooling. +const path = require('path'); +const jsforce = require('jsforce'); + +function createAuthWindow() { + // Lock down the session. + const authSession = session.fromPartition('auth-partition'); + authSession.setPermissionRequestHandler((webContents, permission, callback) => { + callback(false); + }); + + // Create the browser window. + let authWindow = new BrowserWindow({ + width: 300, + height: 500, + resizable: false, + frame: false, + show: false, + session: authSession, + webPreferences: { + devTools: true, + nodeIntegration: false, // Disable nodeIntegration for security. + nodeIntegrationInWorker: false, + nodeIntegrationInSubFrames: false, + disableBlinkFeatures: 'Auxclick', // See: https://github.com/doyensec/electronegativity/wiki/AUXCLICK_JS_CHECK + contextIsolation: true, // Enabling contextIsolation to protect against prototype pollution. + worldSafeExecuteJavaScript: true, // https://github.com/electron/electron/pull/24712 + enableRemoteModule: false, // Turn off remote to avoid temptation. + // preload: path.join(app.getAppPath(), 'app/authPreload.js'), + }, + }); + + // Emitted when the window is closed. + authWindow.on('closed', () => { + // Dereference the window object, usually you would store windows + // in an array if your app supports multi windows, this is the time + // when you should delete the corresponding element. + authWindow = null; + }); + + return authWindow; +} + +function attemptLogin(authDomain) { + const jsfOauth = new jsforce.OAuth2({ + loginUrl: authDomain, + // Temporary testing value from trailhead org. + clientId: '3MVG9cHH2bfKACZaQ.djia5w9g24IaXl.LCkYPmKS.T7ud235Q8c1pX0_zN6xkDBj.88d1qLf1pTcmZwGODB.', + redirectUri: 'https://localhost/completesetup', + }); + + const authWindow = createAuthWindow(); + + // Prepare to filter only the callbacks for my redirectUri + const filter = { + urls: [`${authDomain}/*`], + }; + + // Intercept 302's triggered on page load attempt and redirect. + authWindow.webContents.session.webRequest.onHeadersReceived(filter, (details, callback) => { + const { statusCode, responseHeaders } = details; + + // This is redirect, so let's try again. + if (statusCode === 302) { + authWindow.loadURL(responseHeaders.Location.pop()); + } + + // don't forget to let the request proceed + callback({ + cancel: false, + }); + }); + + // 'will-navigate' is an event emitted when the window.location changes + // newUrl should contain the tokens you need + authWindow.webContents.on('will-navigate', (event, newUrl) => { + console.log(newUrl); + // More complex code to handle tokens goes here. + }); + + authWindow.once('ready-to-show', () => { + authWindow.show(); + }); + + // Load the authUrl from Salesforce. + const authUrl = jsfOauth.getAuthorizationUrl({ scope: 'api id web refresh_token' }); + authWindow.loadURL(authUrl).catch((err) => { + console.log(err); + }); +} + +exports.attemptLogin = attemptLogin; From 09337b458eceb225c197e26ee43ea3feabd47e3d Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Sat, 3 Jul 2021 11:38:50 -0400 Subject: [PATCH 05/24] Removed unused elements --- src/sf_oauth2.js | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/sf_oauth2.js b/src/sf_oauth2.js index 96de976..4711726 100644 --- a/src/sf_oauth2.js +++ b/src/sf_oauth2.js @@ -2,13 +2,11 @@ const electron = require("electron"); // eslint-disable-line // Extract the needed elements. const { - app, BrowserWindow, session, } = electron; // Additional Tooling. -const path = require('path'); const jsforce = require('jsforce'); function createAuthWindow() { From 8ecc59b79705151a8127dfade9e78e6291f59393 Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Sat, 3 Jul 2021 17:15:01 -0400 Subject: [PATCH 06/24] Fixed Login failure message --- src/sf_calls.js | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/sf_calls.js b/src/sf_calls.js index 972e999..5695da7 100644 --- a/src/sf_calls.js +++ b/src/sf_calls.js @@ -55,7 +55,13 @@ const passwordLogin = (url, username, password, token) => { conn.login(username, pass, (err, userInfo) => { if (err) { - mainWindow.webContents.send('sfShowOrgId', { + logMessage( + 'Login', + 'Error', + `Login Failed ${err}`, + ); + + mainWindow.webContents.send('response_generic', { status: false, message: 'Login Failed', response: err, From c90fb545b9cc9ed1c4786ba789916c46c8dbbafe Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Sat, 3 Jul 2021 17:54:38 -0400 Subject: [PATCH 07/24] correction to partition setup --- main.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/main.js b/main.js index 6890ead..961579f 100644 --- a/main.js +++ b/main.js @@ -51,6 +51,7 @@ function createWindow() { width: display.workArea.width, height: display.workArea.height, frame: true, + partiion: 'secured-partition', webPreferences: { devTools: isDev, nodeIntegration: false, // Disable nodeIntegration for security. @@ -85,7 +86,7 @@ function createWindow() { // https://www.electronjs.org/docs/tutorial/security#4-handle-session-permission-requests-from-remote-content // https://github.com/doyensec/electronegativity/wiki/PERMISSION_REQUEST_HANDLER_GLOBAL_CHECK session - .fromPartition('secured-partition') + .fromPartition('persist: secured-partition') .setPermissionRequestHandler((webContents, permission, callback) => { callback(false); }); From fa80e6848e7f673d31e554528947c2798eb0dfa7 Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Sat, 3 Jul 2021 17:56:08 -0400 Subject: [PATCH 08/24] Further session correction --- main.js | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/main.js b/main.js index 961579f..962511f 100644 --- a/main.js +++ b/main.js @@ -43,6 +43,15 @@ app.allowRendererProcessReuse = true; // be closed automatically when the JavaScript object is garbage collected. let mainWindow; +// Lock down session permissions. +// https://www.electronjs.org/docs/tutorial/security#4-handle-session-permission-requests-from-remote-content +// https://github.com/doyensec/electronegativity/wiki/PERMISSION_REQUEST_HANDLER_GLOBAL_CHECK +session + .fromPartition('persist: secured-partition') + .setPermissionRequestHandler((webContents, permission, callback) => { + callback(false); + }); + // Create the main application window. function createWindow() { const display = electron.screen.getPrimaryDisplay(); @@ -51,7 +60,7 @@ function createWindow() { width: display.workArea.width, height: display.workArea.height, frame: true, - partiion: 'secured-partition', + partiion: 'persist: secured-partition', webPreferences: { devTools: isDev, nodeIntegration: false, // Disable nodeIntegration for security. @@ -82,15 +91,6 @@ function createWindow() { mainWindow = null; }); - // Lock down session permissions. - // https://www.electronjs.org/docs/tutorial/security#4-handle-session-permission-requests-from-remote-content - // https://github.com/doyensec/electronegativity/wiki/PERMISSION_REQUEST_HANDLER_GLOBAL_CHECK - session - .fromPartition('persist: secured-partition') - .setPermissionRequestHandler((webContents, permission, callback) => { - callback(false); - }); - // Add Menu Menu.setApplicationMenu(Menu.buildFromTemplate(menuTemplate)); } From 46b44e466288a9e22c43ee2dc0249f4ec35d8292 Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Sat, 3 Jul 2021 17:56:45 -0400 Subject: [PATCH 09/24] Revert "Further session correction" This reverts commit fa80e6848e7f673d31e554528947c2798eb0dfa7. --- main.js | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/main.js b/main.js index 962511f..961579f 100644 --- a/main.js +++ b/main.js @@ -43,15 +43,6 @@ app.allowRendererProcessReuse = true; // be closed automatically when the JavaScript object is garbage collected. let mainWindow; -// Lock down session permissions. -// https://www.electronjs.org/docs/tutorial/security#4-handle-session-permission-requests-from-remote-content -// https://github.com/doyensec/electronegativity/wiki/PERMISSION_REQUEST_HANDLER_GLOBAL_CHECK -session - .fromPartition('persist: secured-partition') - .setPermissionRequestHandler((webContents, permission, callback) => { - callback(false); - }); - // Create the main application window. function createWindow() { const display = electron.screen.getPrimaryDisplay(); @@ -60,7 +51,7 @@ function createWindow() { width: display.workArea.width, height: display.workArea.height, frame: true, - partiion: 'persist: secured-partition', + partiion: 'secured-partition', webPreferences: { devTools: isDev, nodeIntegration: false, // Disable nodeIntegration for security. @@ -91,6 +82,15 @@ function createWindow() { mainWindow = null; }); + // Lock down session permissions. + // https://www.electronjs.org/docs/tutorial/security#4-handle-session-permission-requests-from-remote-content + // https://github.com/doyensec/electronegativity/wiki/PERMISSION_REQUEST_HANDLER_GLOBAL_CHECK + session + .fromPartition('persist: secured-partition') + .setPermissionRequestHandler((webContents, permission, callback) => { + callback(false); + }); + // Add Menu Menu.setApplicationMenu(Menu.buildFromTemplate(menuTemplate)); } From 25c34bf64b412a8eac700eaf923580e7c78f9967 Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Sat, 3 Jul 2021 17:57:40 -0400 Subject: [PATCH 10/24] partion name change --- main.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/main.js b/main.js index 961579f..71070d8 100644 --- a/main.js +++ b/main.js @@ -51,7 +51,7 @@ function createWindow() { width: display.workArea.width, height: display.workArea.height, frame: true, - partiion: 'secured-partition', + partiion: 'persist: secured-partition', webPreferences: { devTools: isDev, nodeIntegration: false, // Disable nodeIntegration for security. From 95a2e3210bc8481ef2e0e4ee719855d4ba533449 Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Sat, 12 Mar 2022 14:31:56 -0500 Subject: [PATCH 11/24] minor tweaks --- src/sf_oauth2.js | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/sf_oauth2.js b/src/sf_oauth2.js index 4711726..535217a 100644 --- a/src/sf_oauth2.js +++ b/src/sf_oauth2.js @@ -45,6 +45,10 @@ function createAuthWindow() { authWindow = null; }); + authWindow.webContents.on('did-fail-load', () => { + console.log('did-fail-load'); + }); + return authWindow; } @@ -81,7 +85,7 @@ function attemptLogin(authDomain) { // 'will-navigate' is an event emitted when the window.location changes // newUrl should contain the tokens you need authWindow.webContents.on('will-navigate', (event, newUrl) => { - console.log(newUrl); + console.log(`Redirected to: ${newUrl}`); // More complex code to handle tokens goes here. }); @@ -91,9 +95,7 @@ function attemptLogin(authDomain) { // Load the authUrl from Salesforce. const authUrl = jsfOauth.getAuthorizationUrl({ scope: 'api id web refresh_token' }); - authWindow.loadURL(authUrl).catch((err) => { - console.log(err); - }); + authWindow.loadURL(authUrl); } exports.attemptLogin = attemptLogin; From b1fc891b76d347c36225207578210c22878428fb Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Mon, 26 May 2025 16:08:04 -0400 Subject: [PATCH 12/24] Finish Main back merge --- src/sf_calls.js | 82 ++++++++++--------------------------------------- 1 file changed, 17 insertions(+), 65 deletions(-) diff --git a/src/sf_calls.js b/src/sf_calls.js index e88c90f..fde5dfc 100644 --- a/src/sf_calls.js +++ b/src/sf_calls.js @@ -15,6 +15,7 @@ let mainWindow = null; let proposedSchema = {}; let preferences = null; +// Import constants const { typeResolverBases, standardObjectsByFeature, @@ -31,71 +32,6 @@ const setwindow = (window) => { mainWindow = window; }; -/** - * Attempt a traditional Username/Password login. - * @param {String} url - * @param {String} username - * @param {String} password - * @param {String} token - */ -const passwordLogin = (url, username, password, token) => { - const conn = new jsforce.Connection({ - // you can change loginUrl to connect to sandbox or prerelease env. - loginUrl: url, - }); - let pass = password; - if (token !== '') { - pass = `${password}${token}`; - } - - conn.login(username, pass, (err, userInfo) => { - if (err) { - logMessage( - 'Login', - 'Error', - `Login Failed ${err}`, - ); - - mainWindow.webContents.send('response_generic', { - status: false, - message: 'Login Failed', - response: err, - limitInfo: conn.limitInfo, - request: { - url, - username, - password: '*****', - token: '*****', - }, - }); - return true; - } - // Now you can get the access token and instance URL information. - // Save them to establish connection next time. - logMessage('Login', 'Info', `Connected to Org: ${userInfo.organizationId} for User: ${userInfo.id}`); - - // Save the next connection in the global storage. - sfConnections[userInfo.organizationId] = { - instanceUrl: conn.instanceUrl, - accessToken: conn.accessToken, - }; - - mainWindow.webContents.send('response_login', { - status: true, - message: 'Login Successful', - response: userInfo, - limitInfo: conn.limitInfo, - request: { - url, - username, - password: '*****', - token: '*****', - }, - }); - return true; - }); -}; - /** * Sets the preferences for use in generating the schema. * @param {*} prefs The current application preference object to use. @@ -129,6 +65,22 @@ const resolveFieldType = (sfTypeName) => { return 'text'; }; +/** + * Send a log message to the console window. + * @param {String} title Message title or sender + * @param {String} channel Message category + * @param {String} message Message + * @returns True (always). + */ +const logMessage = (title, channel, message) => { + mainWindow.webContents.send('log_message', { + sender: title, + channel, + message, + }); + return true; +}; + /** * Updates the loader message in the interface. * @param {String} message From a4f93048c0f4d71c18dca3602f04f399eef2347e Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Mon, 26 May 2025 18:01:31 -0400 Subject: [PATCH 13/24] Refactor password login into own function --- src/sf_calls.js | 103 +++++++++++++++++++++++++++--------------------- 1 file changed, 58 insertions(+), 45 deletions(-) diff --git a/src/sf_calls.js b/src/sf_calls.js index fde5dfc..de9547c 100644 --- a/src/sf_calls.js +++ b/src/sf_calls.js @@ -647,61 +647,74 @@ const buildDatabase = (settings) => { }); }; +const sfPasswordLogin = (url, username, password) => { + const conn = new jsforce.Connection({ + loginUrl: url, + }); + + conn.login(username, password).then( + (userInfo) => { + // Now you can get the access token and instance URL information. + // Save them to establish connection next time. + logMessage('Password Login Attempt', 'Info', `Connection Org ${userInfo.organizationId} for User ${userInfo.id}`); + + // Save the next connection in the global storage. + sfConnections[userInfo.organizationId] = { + instanceUrl: conn.instanceUrl, + accessToken: conn.accessToken, + version: '63.0', + }; + + mainWindow.webContents.send('response_login', { + status: true, + message: 'Login Successful', + response: userInfo, + limitInfo: conn.limitInfo, + request: { + username, + password: '********', + token: '********', + url, + }, + }); + }, + (err) => { + mainWindow.webContents.send('response_login', { + status: false, + message: 'Login Failed', + response: err, + limitInfo: conn.limitInfo, + request: { + username, + password: '********', + token: '********', + url, + }, + }); + }, + ); +}; + /** * List of remote call handlers for using with IPC. */ const handlers = { /** - * Login to an org using password authentication. + * Login to an org. * @param {*} event Standard message event. * @param {*} args Login credentials from the interface. */ sf_login: (event, args) => { - const conn = new jsforce.Connection({ - loginUrl: args.url, - }); - - let { password } = args; - if (args.token !== '') { - password = `${password}${args.token}`; + if (args.mode === 'oauth') { + oauth.attemptLogin(args.url); + } else { + let { password } = args; + if (args.token && args.token.trim()) { + password = `${password}${args.token.trim()}`; + } + logMessage(event.sender.getTitle(), 'Info', 'Attempting Login with Basic Credentials'); + sfPasswordLogin(args.url, args.username, password); } - - conn.login(args.username, password).then( - (userInfo) => { - // Since we send the args back to the interface, it's a good idea - // to remove the security information. - args.password = ''; - args.token = ''; - - // Now you can get the access token and instance URL information. - // Save them to establish connection next time. - logMessage(event.sender.getTitle(), 'Info', `Connection Org ${userInfo.organizationId} for User ${userInfo.id}`); - - // Save the next connection in the global storage. - sfConnections[userInfo.organizationId] = { - instanceUrl: conn.instanceUrl, - accessToken: conn.accessToken, - version: '63.0', - }; - - mainWindow.webContents.send('response_login', { - status: true, - message: 'Login Successful', - response: userInfo, - limitInfo: conn.limitInfo, - request: args, - }); - }, - (err) => { - mainWindow.webContents.send('response_login', { - status: false, - message: 'Login Failed', - response: err, - limitInfo: conn.limitInfo, - request: args, - }); - }, - ); }, /** * Logout of a specific Salesforce org. From 4bcd3949bfdbdf45ca1426f8281397b9bdfe10e0 Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Mon, 26 May 2025 18:05:05 -0400 Subject: [PATCH 14/24] Ensure passwords do not contain whitespace. --- src/sf_calls.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/sf_calls.js b/src/sf_calls.js index de9547c..3658c13 100644 --- a/src/sf_calls.js +++ b/src/sf_calls.js @@ -710,7 +710,7 @@ const handlers = { } else { let { password } = args; if (args.token && args.token.trim()) { - password = `${password}${args.token.trim()}`; + password = `${password.trim()}${args.token.trim()}`; } logMessage(event.sender.getTitle(), 'Info', 'Attempting Login with Basic Credentials'); sfPasswordLogin(args.url, args.username, password); From 264060fb93c59d8f2b64f56795dd8c8871955312 Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Mon, 26 May 2025 20:49:40 -0400 Subject: [PATCH 15/24] Switch to browser instead of local window --- src/sf_oauth2.js | 153 +++++++++++++++++++++++++++++++++-------------- 1 file changed, 108 insertions(+), 45 deletions(-) diff --git a/src/sf_oauth2.js b/src/sf_oauth2.js index 535217a..fc2e4a6 100644 --- a/src/sf_oauth2.js +++ b/src/sf_oauth2.js @@ -8,6 +8,9 @@ const { // Additional Tooling. const jsforce = require('jsforce'); +const http = require('http'); + +const { shell } = electron; function createAuthWindow() { // Lock down the session. @@ -16,24 +19,45 @@ function createAuthWindow() { callback(false); }); - // Create the browser window. + // Set default security policies for the session + authSession.webRequest.onHeadersReceived((details, callback) => { + callback({ + responseHeaders: { + ...details.responseHeaders, + 'Content-Security-Policy': [ + "default-src 'self' https://*.salesforce.com https://*.force.com https://login.salesforce.com;", + "script-src 'self' https://*.salesforce.com https://*.force.com https://login.salesforce.com;", + "style-src 'self' 'unsafe-inline' https://*.salesforce.com https://*.force.com https://login.salesforce.com;", + "img-src 'self' data: https://*.salesforce.com https://*.force.com https://login.salesforce.com;", + "font-src 'self' data: https://*.salesforce.com https://*.force.com https://login.salesforce.com;", + "connect-src 'self' https://*.salesforce.com https://*.force.com https://login.salesforce.com;", + "frame-src 'self' https://*.salesforce.com https://*.force.com https://login.salesforce.com;", + ].join(' '), + }, + }); + }); + + // Create the browser window with secure defaults let authWindow = new BrowserWindow({ - width: 300, - height: 500, - resizable: false, - frame: false, + width: 600, + height: 700, + resizable: true, + frame: true, show: false, session: authSession, webPreferences: { - devTools: true, - nodeIntegration: false, // Disable nodeIntegration for security. + devTools: process.env.NODE_ENV === 'development', + nodeIntegration: false, nodeIntegrationInWorker: false, nodeIntegrationInSubFrames: false, disableBlinkFeatures: 'Auxclick', // See: https://github.com/doyensec/electronegativity/wiki/AUXCLICK_JS_CHECK contextIsolation: true, // Enabling contextIsolation to protect against prototype pollution. worldSafeExecuteJavaScript: true, // https://github.com/electron/electron/pull/24712 enableRemoteModule: false, // Turn off remote to avoid temptation. - // preload: path.join(app.getAppPath(), 'app/authPreload.js'), + webSecurity: true, + allowRunningInsecureContent: false, + experimentalFeatures: false, + sandbox: true, }, }); @@ -45,57 +69,96 @@ function createAuthWindow() { authWindow = null; }); - authWindow.webContents.on('did-fail-load', () => { - console.log('did-fail-load'); + // Add these handlers after creating the window + authWindow.webContents.on('did-start-loading', () => { + console.log('Window started loading'); }); - return authWindow; -} - -function attemptLogin(authDomain) { - const jsfOauth = new jsforce.OAuth2({ - loginUrl: authDomain, - // Temporary testing value from trailhead org. - clientId: '3MVG9cHH2bfKACZaQ.djia5w9g24IaXl.LCkYPmKS.T7ud235Q8c1pX0_zN6xkDBj.88d1qLf1pTcmZwGODB.', - redirectUri: 'https://localhost/completesetup', + authWindow.webContents.on('did-finish-load', () => { + console.log('Window finished loading'); }); - const authWindow = createAuthWindow(); + authWindow.webContents.on('did-fail-load', (event, errorCode, errorDescription, validatedURL) => { + console.error(`Failed to load: ${errorDescription} (${errorCode}) for URL: ${validatedURL}`); + }); - // Prepare to filter only the callbacks for my redirectUri - const filter = { - urls: [`${authDomain}/*`], - }; + // Open DevTools in detached mode for debugging + if (process.env.NODE_ENV === 'development') { + authWindow.webContents.openDevTools({ mode: 'detach' }); + } - // Intercept 302's triggered on page load attempt and redirect. - authWindow.webContents.session.webRequest.onHeadersReceived(filter, (details, callback) => { - const { statusCode, responseHeaders } = details; + return authWindow; +} - // This is redirect, so let's try again. - if (statusCode === 302) { - authWindow.loadURL(responseHeaders.Location.pop()); - } +function createLocalServer(jsfOauth) { + return new Promise((resolve, reject) => { + // Create local server to handle OAuth callback + const server = http.createServer((req, res) => { + if (req.url.startsWith('/completesetup')) { + const url = new URL(req.url, 'http://localhost'); + const code = url.searchParams.get('code'); + + if (code) { + // Send success response to browser + res.writeHead(200, { 'Content-Type': 'text/html' }); + res.end('

Authentication successful!

You can close this window.

'); + + // Close server and resolve promise with auth code + server.close(); + resolve(code); + } else { + reject(new Error('No authorization code received')); + } + } + }); - // don't forget to let the request proceed - callback({ - cancel: false, + // Listen on a random available port + server.listen(0, 'localhost', () => { + const { port } = server.address(); + console.log(`Local server listening on port ${port}`); }); - }); - // 'will-navigate' is an event emitted when the window.location changes - // newUrl should contain the tokens you need - authWindow.webContents.on('will-navigate', (event, newUrl) => { - console.log(`Redirected to: ${newUrl}`); - // More complex code to handle tokens goes here. + // Handle server errors + server.on('error', (error) => { + reject(error); + }); }); +} - authWindow.once('ready-to-show', () => { - authWindow.show(); +async function attemptLogin(authDomain) { + // Create OAuth configuration + const jsfOauth = new jsforce.OAuth2({ + loginUrl: authDomain, + clientId: '3MVG9cHH2bfKACZaQ.djia5w9g24IaXl.LCkYPmKS.T7ud235Q8c1pX0_zN6xkDBj.88d1qLf1pTcmZwGODB.', + redirectUri: 'http://localhost/completesetup', }); - // Load the authUrl from Salesforce. - const authUrl = jsfOauth.getAuthorizationUrl({ scope: 'api id web refresh_token' }); - authWindow.loadURL(authUrl); + try { + // Start local server to handle callback + const codePromise = createLocalServer(jsfOauth); + + // Get authorization URL and open in default browser + const authUrl = jsfOauth.getAuthorizationUrl({ scope: 'api id web refresh_token' }); + console.log(`Opening browser for authentication: ${authUrl}`); + await shell.openExternal(authUrl); + + // Wait for the authorization code + const code = await codePromise; + console.log('Received authorization code'); + + // Exchange code for access token + const conn = new jsforce.Connection({ oauth2: jsfOauth }); + const userInfo = await conn.authorize(code); + + console.log('Authentication successful'); + return { + conn, + userInfo, + }; + } catch (error) { + console.error('Authentication failed:', error); + throw error; + } } exports.attemptLogin = attemptLogin; From e12abee3441e702346e6fccccd9f1244c431ad50 Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Mon, 26 May 2025 21:02:59 -0400 Subject: [PATCH 16/24] Updates to use browser auth not local. --- .env.example | 2 + .github/workflows/build.yml | 9 ++++ .gitignore | 2 + ReadMe.md | 38 ++++++++++++++ src/config.js | 9 ++++ src/sf_oauth2.js | 101 +++++++----------------------------- 6 files changed, 78 insertions(+), 83 deletions(-) create mode 100644 .env.example create mode 100644 src/config.js diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..d87e3bd --- /dev/null +++ b/.env.example @@ -0,0 +1,2 @@ +SALESFORCE_CLIENT_ID=your_client_id_here +SALESFORCE_CLIENT_SECRET=your_client_secret_here diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index d3cb33c..9849080 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -12,6 +12,9 @@ jobs: - name: install dependencies run: npm install - name: build + env: + SALESFORCE_CLIENT_ID: ${{ secrets.SALESFORCE_CLIENT_ID }} + SALESFORCE_CLIENT_SECRET: ${{ secrets.SALESFORCE_CLIENT_SECRET }} run: npm run make build_on_mac: @@ -27,6 +30,9 @@ jobs: - name: install dependencies run: npm install - name: build + env: + SALESFORCE_CLIENT_ID: ${{ secrets.SALESFORCE_CLIENT_ID }} + SALESFORCE_CLIENT_SECRET: ${{ secrets.SALESFORCE_CLIENT_SECRET }} run: npm run make build_on_win: @@ -39,4 +45,7 @@ jobs: - name: install dependencies run: npm install - name: build + env: + SALESFORCE_CLIENT_ID: ${{ secrets.SALESFORCE_CLIENT_ID }} + SALESFORCE_CLIENT_SECRET: ${{ secrets.SALESFORCE_CLIENT_SECRET }} run: npm run make diff --git a/.gitignore b/.gitignore index 5cd04ea..22cd83d 100644 --- a/.gitignore +++ b/.gitignore @@ -60,6 +60,8 @@ typings/ # dotenv environment variables file .env +.env.local +.env.*.local # parcel-bundler cache (https://parceljs.org/) .cache diff --git a/ReadMe.md b/ReadMe.md index b3e05a0..6571853 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -45,3 +45,41 @@ This project has no direct association with Salesforce except the use of the API ## Getting Involved If you would like to contribute to this project please feel invited to do so. Feel free to review open [issues](issues) and read the [contributing guide](contributing.md). + +## Environment Setup + +This application requires specific environment variables to be set for Salesforce OAuth authentication. Create a `.env` file in the root directory with the following variables: + +```env +SALESFORCE_CLIENT_ID=your_client_id_here +SALESFORCE_CLIENT_SECRET=your_client_secret_here +``` + +### Getting the Credentials + +1. Go to Salesforce Setup +2. Navigate to App Manager +3. Create a new Connected App or use an existing one +4. Configure OAuth settings: + - Enable OAuth Settings + - Callback URL: `http://localhost/completesetup` + - OAuth Scopes: + - Access and manage your data (api) + - Access your basic information (id) + - Perform requests on your behalf at any time (refresh_token) +5. After saving, copy the Consumer Key (Client ID) and Consumer Secret (Client Secret) +6. Add these values to your `.env` file + +### Development Setup + +1. Copy `.env.example` to `.env`: + ```bash + cp .env.example .env + ``` +2. Edit `.env` with your Salesforce Connected App credentials +3. Run the application in development mode: + ```bash + npm run dev + ``` + +**Note:** Never commit the `.env` file to version control. The `.env.example` file is provided as a template. diff --git a/src/config.js b/src/config.js new file mode 100644 index 0000000..947fa6b --- /dev/null +++ b/src/config.js @@ -0,0 +1,9 @@ +const config = { + oauth: { + clientId: process.env.SALESFORCE_CLIENT_ID || '', + clientSecret: process.env.SALESFORCE_CLIENT_SECRET || '', + scopes: ['api', 'id', 'web', 'refresh_token'], + }, +}; + +module.exports = config; diff --git a/src/sf_oauth2.js b/src/sf_oauth2.js index fc2e4a6..d99a0f2 100644 --- a/src/sf_oauth2.js +++ b/src/sf_oauth2.js @@ -1,4 +1,5 @@ const electron = require("electron"); // eslint-disable-line +const { shell } = electron; // Extract the needed elements. const { @@ -10,92 +11,16 @@ const { const jsforce = require('jsforce'); const http = require('http'); -const { shell } = electron; - -function createAuthWindow() { - // Lock down the session. - const authSession = session.fromPartition('auth-partition'); - authSession.setPermissionRequestHandler((webContents, permission, callback) => { - callback(false); - }); - - // Set default security policies for the session - authSession.webRequest.onHeadersReceived((details, callback) => { - callback({ - responseHeaders: { - ...details.responseHeaders, - 'Content-Security-Policy': [ - "default-src 'self' https://*.salesforce.com https://*.force.com https://login.salesforce.com;", - "script-src 'self' https://*.salesforce.com https://*.force.com https://login.salesforce.com;", - "style-src 'self' 'unsafe-inline' https://*.salesforce.com https://*.force.com https://login.salesforce.com;", - "img-src 'self' data: https://*.salesforce.com https://*.force.com https://login.salesforce.com;", - "font-src 'self' data: https://*.salesforce.com https://*.force.com https://login.salesforce.com;", - "connect-src 'self' https://*.salesforce.com https://*.force.com https://login.salesforce.com;", - "frame-src 'self' https://*.salesforce.com https://*.force.com https://login.salesforce.com;", - ].join(' '), - }, - }); - }); - - // Create the browser window with secure defaults - let authWindow = new BrowserWindow({ - width: 600, - height: 700, - resizable: true, - frame: true, - show: false, - session: authSession, - webPreferences: { - devTools: process.env.NODE_ENV === 'development', - nodeIntegration: false, - nodeIntegrationInWorker: false, - nodeIntegrationInSubFrames: false, - disableBlinkFeatures: 'Auxclick', // See: https://github.com/doyensec/electronegativity/wiki/AUXCLICK_JS_CHECK - contextIsolation: true, // Enabling contextIsolation to protect against prototype pollution. - worldSafeExecuteJavaScript: true, // https://github.com/electron/electron/pull/24712 - enableRemoteModule: false, // Turn off remote to avoid temptation. - webSecurity: true, - allowRunningInsecureContent: false, - experimentalFeatures: false, - sandbox: true, - }, - }); - - // Emitted when the window is closed. - authWindow.on('closed', () => { - // Dereference the window object, usually you would store windows - // in an array if your app supports multi windows, this is the time - // when you should delete the corresponding element. - authWindow = null; - }); - - // Add these handlers after creating the window - authWindow.webContents.on('did-start-loading', () => { - console.log('Window started loading'); - }); - - authWindow.webContents.on('did-finish-load', () => { - console.log('Window finished loading'); - }); - - authWindow.webContents.on('did-fail-load', (event, errorCode, errorDescription, validatedURL) => { - console.error(`Failed to load: ${errorDescription} (${errorCode}) for URL: ${validatedURL}`); - }); - - // Open DevTools in detached mode for debugging - if (process.env.NODE_ENV === 'development') { - authWindow.webContents.openDevTools({ mode: 'detach' }); - } - - return authWindow; -} +const config = require('./config'); function createLocalServer(jsfOauth) { return new Promise((resolve, reject) => { - // Create local server to handle OAuth callback const server = http.createServer((req, res) => { + console.log('Received callback request:', req.url); // Add debugging + + // Remove any port information from the URL if (req.url.startsWith('/completesetup')) { - const url = new URL(req.url, 'http://localhost'); + const url = new URL(req.url, `http://localhost:${server.address().port}`); const code = url.searchParams.get('code'); if (code) { @@ -115,7 +40,10 @@ function createLocalServer(jsfOauth) { // Listen on a random available port server.listen(0, 'localhost', () => { const { port } = server.address(); + // Update the OAuth config with the actual port + jsfOauth.redirectUri = `http://localhost:${port}/completesetup`; console.log(`Local server listening on port ${port}`); + console.log(`Updated redirect URI: ${jsfOauth.redirectUri}`); }); // Handle server errors @@ -126,10 +54,15 @@ function createLocalServer(jsfOauth) { } async function attemptLogin(authDomain) { + if (!config.oauth.clientId || !config.oauth.clientSecret) { + throw new Error('Missing OAuth credentials. Both Client ID and Client Secret are required.'); + } + // Create OAuth configuration const jsfOauth = new jsforce.OAuth2({ loginUrl: authDomain, - clientId: '3MVG9cHH2bfKACZaQ.djia5w9g24IaXl.LCkYPmKS.T7ud235Q8c1pX0_zN6xkDBj.88d1qLf1pTcmZwGODB.', + clientId: config.oauth.clientId, + clientSecret: config.oauth.clientSecret, redirectUri: 'http://localhost/completesetup', }); @@ -138,7 +71,9 @@ async function attemptLogin(authDomain) { const codePromise = createLocalServer(jsfOauth); // Get authorization URL and open in default browser - const authUrl = jsfOauth.getAuthorizationUrl({ scope: 'api id web refresh_token' }); + const authUrl = jsfOauth.getAuthorizationUrl({ + scope: config.oauth.scopes.join(' '), + }); console.log(`Opening browser for authentication: ${authUrl}`); await shell.openExternal(authUrl); From 69d340dfa665a869f1df644f06d5b280958fe061 Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Mon, 26 May 2025 21:17:51 -0400 Subject: [PATCH 17/24] And URL pattern filtering on open requests for better security. --- src/sf_oauth2.js | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/src/sf_oauth2.js b/src/sf_oauth2.js index d99a0f2..a17f83a 100644 --- a/src/sf_oauth2.js +++ b/src/sf_oauth2.js @@ -53,6 +53,26 @@ function createLocalServer(jsfOauth) { }); } +function isValidSalesforceUrl(url) { + try { + const parsedUrl = new URL(url); + // List of valid Salesforce login domains + const validDomains = [ + 'login.salesforce.com', + 'test.salesforce.com', + 'login.sandbox.salesforce.com', + 'login.cloudforce.com', + ]; + + return validDomains.some((domain) => parsedUrl.hostname === domain + || parsedUrl.hostname.endsWith('.my.salesforce.com') + || parsedUrl.hostname.endsWith('.cloudforce.com')); + } catch (err) { + console.error('Invalid URL format:', err); + return false; + } +} + async function attemptLogin(authDomain) { if (!config.oauth.clientId || !config.oauth.clientSecret) { throw new Error('Missing OAuth credentials. Both Client ID and Client Secret are required.'); @@ -67,13 +87,16 @@ async function attemptLogin(authDomain) { }); try { - // Start local server to handle callback const codePromise = createLocalServer(jsfOauth); - // Get authorization URL and open in default browser const authUrl = jsfOauth.getAuthorizationUrl({ scope: config.oauth.scopes.join(' '), }); + + if (!isValidSalesforceUrl(authUrl)) { + throw new Error('Invalid Salesforce authentication URL'); + } + console.log(`Opening browser for authentication: ${authUrl}`); await shell.openExternal(authUrl); From 28bb03308551d4ec49f0d42129f90f9ede4e5404 Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Mon, 26 May 2025 21:24:25 -0400 Subject: [PATCH 18/24] Remove extra Electron elements --- src/sf_oauth2.js | 6 ------ 1 file changed, 6 deletions(-) diff --git a/src/sf_oauth2.js b/src/sf_oauth2.js index a17f83a..f82cf96 100644 --- a/src/sf_oauth2.js +++ b/src/sf_oauth2.js @@ -1,12 +1,6 @@ const electron = require("electron"); // eslint-disable-line const { shell } = electron; -// Extract the needed elements. -const { - BrowserWindow, - session, -} = electron; - // Additional Tooling. const jsforce = require('jsforce'); const http = require('http'); From ce3262e1f9148c0ac3580480eac1a4739bbe3d96 Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Mon, 26 May 2025 23:19:10 -0400 Subject: [PATCH 19/24] Add schema check Login URL checker --- src/sf_oauth2.js | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/sf_oauth2.js b/src/sf_oauth2.js index f82cf96..fea3d32 100644 --- a/src/sf_oauth2.js +++ b/src/sf_oauth2.js @@ -50,6 +50,13 @@ function createLocalServer(jsfOauth) { function isValidSalesforceUrl(url) { try { const parsedUrl = new URL(url); + + // Check for HTTPS protocol + if (parsedUrl.protocol !== 'https:') { + console.error('Invalid protocol - HTTPS required'); + return false; + } + // List of valid Salesforce login domains const validDomains = [ 'login.salesforce.com', From 853153af8ed8efc2772f0169a79fd784ea61203d Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Sun, 12 Oct 2025 11:57:19 -0400 Subject: [PATCH 20/24] Adding oauth test stub. --- src/config.js | 4 + src/sf_oauth2.js | 13 --- src/tests/__mocks__/electron.js | 3 + src/tests/__mocks__/jsforce.js | 4 + src/tests/sf_oauth2.test.js | 156 ++++++++++++++++++++++++++++++++ 5 files changed, 167 insertions(+), 13 deletions(-) create mode 100644 src/tests/sf_oauth2.test.js diff --git a/src/config.js b/src/config.js index 947fa6b..be77416 100644 --- a/src/config.js +++ b/src/config.js @@ -4,6 +4,10 @@ const config = { clientSecret: process.env.SALESFORCE_CLIENT_SECRET || '', scopes: ['api', 'id', 'web', 'refresh_token'], }, + updateOAuthCredentials(clientId, clientSecret) { + this.oauth.clientId = clientId; + this.oauth.clientSecret = clientSecret; + }, }; module.exports = config; diff --git a/src/sf_oauth2.js b/src/sf_oauth2.js index fea3d32..9b5c184 100644 --- a/src/sf_oauth2.js +++ b/src/sf_oauth2.js @@ -10,7 +10,6 @@ const config = require('./config'); function createLocalServer(jsfOauth) { return new Promise((resolve, reject) => { const server = http.createServer((req, res) => { - console.log('Received callback request:', req.url); // Add debugging // Remove any port information from the URL if (req.url.startsWith('/completesetup')) { @@ -36,13 +35,6 @@ function createLocalServer(jsfOauth) { const { port } = server.address(); // Update the OAuth config with the actual port jsfOauth.redirectUri = `http://localhost:${port}/completesetup`; - console.log(`Local server listening on port ${port}`); - console.log(`Updated redirect URI: ${jsfOauth.redirectUri}`); - }); - - // Handle server errors - server.on('error', (error) => { - reject(error); }); }); } @@ -53,7 +45,6 @@ function isValidSalesforceUrl(url) { // Check for HTTPS protocol if (parsedUrl.protocol !== 'https:') { - console.error('Invalid protocol - HTTPS required'); return false; } @@ -69,7 +60,6 @@ function isValidSalesforceUrl(url) { || parsedUrl.hostname.endsWith('.my.salesforce.com') || parsedUrl.hostname.endsWith('.cloudforce.com')); } catch (err) { - console.error('Invalid URL format:', err); return false; } } @@ -98,18 +88,15 @@ async function attemptLogin(authDomain) { throw new Error('Invalid Salesforce authentication URL'); } - console.log(`Opening browser for authentication: ${authUrl}`); await shell.openExternal(authUrl); // Wait for the authorization code const code = await codePromise; - console.log('Received authorization code'); // Exchange code for access token const conn = new jsforce.Connection({ oauth2: jsfOauth }); const userInfo = await conn.authorize(code); - console.log('Authentication successful'); return { conn, userInfo, diff --git a/src/tests/__mocks__/electron.js b/src/tests/__mocks__/electron.js index 3b0201e..e81d892 100644 --- a/src/tests/__mocks__/electron.js +++ b/src/tests/__mocks__/electron.js @@ -7,4 +7,7 @@ module.exports = { getName: jest.fn().mockReturnValue('appName'), }, dialog: jest.fn(), + shell: { + openExternal: jest.fn().mockResolvedValue(true), + }, }; diff --git a/src/tests/__mocks__/jsforce.js b/src/tests/__mocks__/jsforce.js index 29ca895..414ff2e 100644 --- a/src/tests/__mocks__/jsforce.js +++ b/src/tests/__mocks__/jsforce.js @@ -9,6 +9,10 @@ const jsforce = { execute: jest.fn().mockResolvedValue([]), }), describeGlobal: jest.fn().mockResolvedValue({ sobjects: [] }), + authorize: jest.fn().mockResolvedValue({ id: 'test-user-id' }), + })), + OAuth2: jest.fn().mockImplementation(() => ({ + getAuthorizationUrl: jest.fn().mockReturnValue('https://login.salesforce.com/auth'), })), }; diff --git a/src/tests/sf_oauth2.test.js b/src/tests/sf_oauth2.test.js new file mode 100644 index 0000000..ca49dfa --- /dev/null +++ b/src/tests/sf_oauth2.test.js @@ -0,0 +1,156 @@ +const electron = require('electron'); +const jsforce = require('jsforce'); +const http = require('http'); +const oauth = require('../sf_oauth2'); +const config = require('../config'); + +describe('Salesforce OAuth2 Tests', () => { + let serverHandler = null; + + beforeEach(() => { + // Clear all mocks and reset handler + jest.clearAllMocks(); + serverHandler = null; + + // Single stable mock for http.createServer for all tests + jest.spyOn(http, 'createServer').mockImplementation((handler) => { + // Capture the handler for tests to invoke + serverHandler = handler; + + const server = { + listen: (port, host, cb) => { + let cBack = cb; + if (typeof host === 'function') cBack = host; + // simulate async listen + process.nextTick(() => cBack && cBack()); + }, + address: () => ({ port: 51234 }), + close: (cBack) => cBack && cBack(), + on: jest.fn(), + }; + return server; + }); + + // Ensure electron.shell.openExternal exists on the electron mock + if (electron && electron.shell && !electron.shell.openExternal) { + electron.shell.openExternal = jest.fn().mockResolvedValue(true); + } + }); + + describe('isValidSalesforceUrl', () => { + test('accepts valid Salesforce URLs', () => { + const validUrls = [ + 'https://login.salesforce.com/auth', + 'https://test.salesforce.com/services/oauth2/authorize', + 'https://myorg.my.salesforce.com/setup', + 'https://company.cloudforce.com/oauth', + ]; + + validUrls.forEach((url) => { + expect(oauth.__get__('isValidSalesforceUrl')(url)).toBe(true); + }); + }); + + test('rejects invalid URLs', () => { + const invalidUrls = [ + 'http://login.salesforce.com', + 'https://fake-salesforce.com', + 'https://salesforce.com', + 'not-a-url', + ]; + + invalidUrls.forEach((url) => { + expect(oauth.__get__('isValidSalesforceUrl')(url)).toBe(false); + }); + }); + }); + + describe('createLocalServer', () => { + test('creates server and resolves with auth code', async () => { + const mockJsfOauth = { redirectUri: 'https://localhost/completesetup' }; + const createLocalServer = oauth.__get__('createLocalServer'); + const serverPromise = createLocalServer(mockJsfOauth); + + // invoke captured handler to simulate incoming request + expect(typeof serverHandler).toBe('function'); + serverHandler( + { url: '/completesetup?code=test-auth-code', method: 'GET' }, + { writeHead: jest.fn(), end: jest.fn() }, + ); + + const code = await serverPromise; + expect(code).toBe('test-auth-code'); + }); + + test('rejects when no auth code provided', async () => { + const mockJsfOauth = { redirectUri: 'https://localhost/completesetup' }; + const createLocalServer = oauth.__get__('createLocalServer'); + const serverPromise = createLocalServer(mockJsfOauth); + + expect(typeof serverHandler).toBe('function'); + serverHandler( + { url: '/completesetup', method: 'GET' }, + { writeHead: jest.fn(), end: jest.fn() }, + ); + + await expect(serverPromise).rejects.toThrow('No authorization code received'); + }); + }); + + describe('attemptLogin', () => { + test('successful login flow', async () => { + // Set credentials directly in config + config.updateOAuthCredentials('test-client-id', 'test-client-secret'); + + // start attemptLogin, which will call createLocalServer (handler captured) + const promise = oauth.attemptLogin('https://login.salesforce.com'); + + // simulate callback arriving after server listen + process.nextTick(() => { + expect(typeof serverHandler).toBe('function'); + serverHandler( + { url: '/completesetup?code=test-auth-code', method: 'GET' }, + { writeHead: jest.fn(), end: jest.fn() }, + ); + }); + + const result = await promise; + + expect(jsforce.OAuth2).toHaveBeenCalledWith({ + loginUrl: 'https://login.salesforce.com', + clientId: 'test-client-id', + clientSecret: 'test-client-secret', + redirectUri: expect.stringContaining('localhost'), + }); + + expect(electron.shell.openExternal).toHaveBeenCalledWith( + expect.stringContaining('https://login.salesforce.com'), + ); + + expect(result.conn).toBeDefined(); + expect(result.userInfo).toBeDefined(); + }); + + test('fails with missing credentials', async () => { + // Clear credentials directly in config + config.updateOAuthCredentials('', ''); + + await expect(oauth.attemptLogin('https://login.salesforce.com')) + .rejects + .toThrow('Missing OAuth credentials'); + }); + + test('fails with invalid Salesforce URL', async () => { + // Set credentials directly in config + config.updateOAuthCredentials('test-client-id', 'test-client-secret'); + + jsforce.OAuth2.mockImplementationOnce(() => ({ + getAuthorizationUrl: jest.fn().mockReturnValue('https://not-salesforce.com/auth'), + })); + + await expect(oauth.attemptLogin('https://junk.salesforce.com')) + .rejects + .toThrow('Invalid Salesforce authentication URL'); + }); + }); +}); From f4af7a9edfa82c43d693327d2f54ec77645939c5 Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Sun, 12 Oct 2025 11:58:32 -0400 Subject: [PATCH 21/24] Fix linting error --- src/sf_oauth2.js | 40 +++++++++++++++++----------------------- 1 file changed, 17 insertions(+), 23 deletions(-) diff --git a/src/sf_oauth2.js b/src/sf_oauth2.js index 9b5c184..049295e 100644 --- a/src/sf_oauth2.js +++ b/src/sf_oauth2.js @@ -10,7 +10,6 @@ const config = require('./config'); function createLocalServer(jsfOauth) { return new Promise((resolve, reject) => { const server = http.createServer((req, res) => { - // Remove any port information from the URL if (req.url.startsWith('/completesetup')) { const url = new URL(req.url, `http://localhost:${server.address().port}`); @@ -77,34 +76,29 @@ async function attemptLogin(authDomain) { redirectUri: 'http://localhost/completesetup', }); - try { - const codePromise = createLocalServer(jsfOauth); + const codePromise = createLocalServer(jsfOauth); - const authUrl = jsfOauth.getAuthorizationUrl({ - scope: config.oauth.scopes.join(' '), - }); + const authUrl = jsfOauth.getAuthorizationUrl({ + scope: config.oauth.scopes.join(' '), + }); - if (!isValidSalesforceUrl(authUrl)) { - throw new Error('Invalid Salesforce authentication URL'); - } + if (!isValidSalesforceUrl(authUrl)) { + throw new Error('Invalid Salesforce authentication URL'); + } - await shell.openExternal(authUrl); + await shell.openExternal(authUrl); - // Wait for the authorization code - const code = await codePromise; + // Wait for the authorization code + const code = await codePromise; - // Exchange code for access token - const conn = new jsforce.Connection({ oauth2: jsfOauth }); - const userInfo = await conn.authorize(code); + // Exchange code for access token + const conn = new jsforce.Connection({ oauth2: jsfOauth }); + const userInfo = await conn.authorize(code); - return { - conn, - userInfo, - }; - } catch (error) { - console.error('Authentication failed:', error); - throw error; - } + return { + conn, + userInfo, + }; } exports.attemptLogin = attemptLogin; From f573c98d96cb32bb538041ef46955c300bfc103a Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Sat, 18 Apr 2026 21:44:40 -0400 Subject: [PATCH 22/24] Remove unneeded tests --- src/tests/sf_calls.test.js | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/tests/sf_calls.test.js b/src/tests/sf_calls.test.js index 4a00d78..1cc7d72 100644 --- a/src/tests/sf_calls.test.js +++ b/src/tests/sf_calls.test.js @@ -610,9 +610,6 @@ test('Test sf_login success path', async () => { message: 'Login Successful', }), ); - // Password and token must be cleared before sending back to the renderer. - expect(mockArgs.password).toBe(''); - expect(mockArgs.token).toBe(''); }); test('Test sf_login auth failure path', async () => { From fa4cd9e93da2182f0f7af40f2aa82659f8bcb78f Mon Sep 17 00:00:00 2001 From: Aaron Crosman Date: Sat, 18 Apr 2026 22:17:46 -0400 Subject: [PATCH 23/24] Adding oauth preferences and removing multiple connections --- app/index.html | 26 ++--- app/preferences-render.js | 18 ++- app/preferences.html | 23 ++++ app/render.js | 68 ++++++++---- app/tests/minIndex.html | 75 +++++++------ app/tests/render.test.js | 31 ++++-- main.js | 14 ++- src/preferences.js | 181 +++++++++++++++++++++++++----- src/sf_calls.js | 190 +++++++++++++++++++++++--------- src/tests/__mocks__/electron.js | 5 + src/tests/preferences.test.js | 3 + src/tests/sf_calls.test.js | 108 ++++++++++-------- 12 files changed, 532 insertions(+), 210 deletions(-) diff --git a/app/index.html b/app/index.html index b0f5f5b..d746b85 100644 --- a/app/index.html +++ b/app/index.html @@ -19,9 +19,7 @@
- +
@@ -58,8 +56,7 @@

data-bs-target="#loginModal">Create New Connection