Create routes for authentication and use variable in another route

[sunnykeerthi]

Hi,
This is not an issue, but a question
I'm building an express app that connects to JSforce using OAuth2. Currently when I have my code placed in a single file, it works fine. But I want to divide them into separate routes and use it.

my app.js is as below.

var express = require('express');
var path = require('path');
const jsforce = require('jsforce');
var indexRouter = require('./routes/index');
var app = express();

app.use(express.json());
app.use(express.urlencoded({ extended: false }));
app.use(express.static(path.join(__dirname, 'public')));

app.use('/', indexRouter);

var oauth2 = new jsforce.OAuth2({
   loginUrl : 'https://login.salesforce.com',
    clientId : '<My_Client_ID>',
    clientSecret : '<My_Client_Secret>',
    redirectUri : '<My_Redirect_URL>'
  }); 

  app.get('/oauth2/auth', function(req, res) {
    res.redirect(oauth2.getAuthorizationUrl({ scope : 'api web full refresh_token offline_access' }));
  });
  
  app.get('/oauth/callback', function(req, res) {
    var conn = new jsforce.Connection({ oauth2 : oauth2 });
    var code = req.param('code');
    conn.authorize(code, function(err, userInfo) {
      if (err) { return console.error(err); }
      console.log("User ID: " + userInfo.id);
      console.log("Org ID: " + userInfo.organizationId);
       res.send('success');
    }); 
  });

This is perfectly working for me. i.e., I am able to console.log the details. But, I want to divide it into modules, like for e.g. app.use('/auth', authRouter);, In this, the authorization stuff should happen.

And I'll create another route /getAccounts, and the file will be /routes/getAccounts.js and I'll have the below code in that file.

var records = [];
conn.query("SELECT Id, Name FROM Account", function(err, result) {
  if (err) { return console.error(err); }
  console.log("total : " + result.totalSize);
  console.log("fetched : " + result.records.length);
})

here the conn used above should be conn from my auth. Please let me know how Can I do it.

[paustint]

If you are going to have many users calling your endpoints, then you need to know which requests belong to which users.

You will either need to store one conn object per user and keep a mapping from user to conn, but this may require a lot of memory if you have a lot of users.

I solved this by having the browser pass back authentication info (e.x. access token) and then I used middleware to init auth connection (not login again, just setup the connection with existing credentials ) and add it to res.locals (assuming you are using express), then you can access it from your routes.

[sunnykeerthi]

Hey @paustint,

Thanks for this suggestion mate. If you don't mind can you share a piece of code?

Thanks

[paustint]

My use-case stores the credentials encrypted in the database and can connect to any org, so my structure may not be the best for your use-case, but here is an example that should be enough to get you started. I took code I had an made some major changes, so it may need to some work to get it working, but hopefully gives you the idea.

You will need to figure out how to have users store the results.

1. store in memory on the server
2. store in a cookie
3. pass back to the browser and let the browser store in local storage or IndexedDb

Note: ideally you should not provide the refreshToken back to the browser because it is considered "sensitive" data, but that will be up to you to decide.

Note: this is using Typescript

For your initial callback from your example above:

const conn = new jsforce.Connection({ oauth2: new jsforce.OAuth2({
    loginUrl,
    clientId: ENV.SFDC_CONSUMER_KEY,
    clientSecret: ENV.SFDC_CONSUMER_SECRET,
    redirectUri: ENV.SFDC_CALLBACK_URL,
}) });
const userInfo = await conn.authorize(req.query.code);
const identity = await conn.identity();

// you will need to figure this part out on your own.

// ideas:
// store in DB, send unique identifier to user (no example provided)
// store in cooke, e.x. res.cookie('SFDC', {instanceUrl: conn.instanceUrl, accessToken: conn.accessToken, refreshToken: conn.refreshToken}, { httpOnly: true, sameSite: 'strict' });
// Send back to browser, res.JSON({{instanceUrl: conn.instanceUrl, accessToken: conn.accessToken, refreshToken: conn.refreshToken}})

res.send('success');

Then in subsequent routes:

import * as jsforce from 'jsforce';
import { NextFunction, Request, Response } from 'express';

export async function addOrgsToLocal(req: express.Request, res: express.Response, next: express.NextFunction) {
  try {

    // Get credentials, depending on where you stored them
    // either parse from header or body (if you added them there)
    // or parse from cookie if you added them there, they will persist for the user
    // (NOTE: parsing bit not shown here - you need to figure that out on your own)

    const conn = new jsforce.Connection({
      oauth2: new jsforce.OAuth2({
        loginUrl,
        clientId: ENV.SFDC_CONSUMER_KEY,
        clientSecret: ENV.SFDC_CONSUMER_SECRET,
        redirectUri: ENV.SFDC_CALLBACK_URL,
      }),
      instanceUrl,
      accessToken,
      refreshToken,
      maxRequest: 5,
      // You are not required to set version, but I find that some metadata API calls might fail if you do not
      // version: ENV.SFDC_FALLBACK_API_VERSION,
    });

    // add connection to locals so it is available in route
    res.locals = res.locals || {};
    res.locals.conn = conn;
    
    // If you are using a refresh token, then you will want to get this back to
    // wherever you are storing the authentication.
    // If you are not using refresh tokens you can ignore this bit
    const handleRefresh = async (accessToken, res) => {
      // update cookies, or send websocket event to browser, etc..
    };
    conn.on('refresh', handleRefresh);

  } catch (ex) {
    next(ex);
  }

  next();
}


routes.post('/query', addOrgsToLocal, async (req: Request, res: Response, next: NextFunction) => {
  const conn: jsforce.Connection = res.locals.conn;
  const results = await conn.query("SELECT Id, Name FROM Account");
  res.json({results})
});