Zoho Node.js SDK认证问题：FileStore读取失败求助

问题背景 #

在Windows 10环境使用Zoho Node.js SDK（@zohocrm/nodejs-sdk-2.1）时，采用Self Client OAuth2认证方式，意图通过临时授权令牌生成刷新令牌并存入FileStore，但SDK初始化阶段直接尝试读取不存在的令牌文件，导致文件读取失败，无法完成令牌写入流程。

原代码示例 #

import * as dotenv from 'dotenv'
dotenv.config();
console.log(process.env.ADMIN_EMAIL_ADDRESS)

import { URL } from 'url'; // in Browser, the URL in native accessible on window

// Will contain trailing slash
const absolute_path = new URL('.', import.meta.url).pathname;
console.log("dirname", absolute_path)

import * as ZOHOCRMSDK from '@zohocrm/nodejs-sdk-2.1';

class Initializer {
    static async initialize() {

        /*
         * Create an UserSignature instance that takes user Email as parameter
         */
        let user = new ZOHOCRMSDK.UserSignature(process.env.ADMIN_EMAIL_ADDRESS);

        /*
         * Configure the environment
         * which is of the pattern Domain.Environment
         * Available Domains: USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter
         * Available Environments: PRODUCTION(), DEVELOPER(), SANDBOX()
         */
        let environment = ZOHOCRMSDK.USDataCenter.PRODUCTION()

        /*
         * Create a Token instance
         * clientId -> OAuth client id.
         * clientSecret -> OAuth client secret.
         * grantToken -> GRANT token.
         * redirectURL -> OAuth redirect URL. Default value is null
         */
        let token = new ZOHOCRMSDK.OAuthBuilder()
            .clientId(process.env.SELF_CLIENT_CLIENT_ID)
            .clientSecret(process.env.SELF_CLIENT_CLIENT_ID)
            .grantToken(process.env.SELF_CLIENT_TEMPORARY_GRANT_TOKEN)
            .redirectURL(process.env.REDIRECT_URL)
            .build();

        /*
         * TokenStore can be any of the following
         * DB Persistence - Create an instance of DBStore
         * File Persistence - Create an instance of FileStore  ** using this to save refresh token
         * Custom Persistence - Create an instance of CustomStore
         */
        const tokenstore_location = `${absolute_path}nodejs_sdk_tokens.txt`
        console.log("tokenstore_location", tokenstore_location)
        let tokenstore = new ZOHOCRMSDK.FileStore(tokenstore_location)


        /*
            * Set the following in InitializeBuilder
            * user -> UserSignature instance required
            * environment -> Environment instance required
            * token -> Token instance required
            * store -> TokenStore instance
            * SDKConfig -> SDKConfig instance
            * resourcePath -> resourcePath
            * logger -> Logger instance. Default value is null
            * requestProxy -> RequestProxy instance. Default value is null
            */
        // The SDK can be initialized by any of the following methods
        (await new ZOHOCRMSDK.InitializeBuilder())
        .user(user)
        .environment(environment)
        .token(token)
        .store(tokenstore)
        .initialize()
        .catch((err) => {
            console.log(err);
        });
    }
}

Initializer.initialize();

问题分析与解决方案 #

1. Windows路径格式错误 #

使用URL模块获取的路径在Windows系统下会呈现Unix风格（例如/C:/project/），而Zoho SDK的FileStore无法正确识别这种格式，导致文件读取/写入失败。

修正方案：使用Node.js原生path模块处理路径，确保生成符合Windows规范的路径：

import path from 'path';
// 获取当前文件所在目录的正确路径
const __dirname = path.dirname(new URL(import.meta.url).pathname);
// 修复Windows盘符前的多余斜杠
const correctedDir = __dirname.replace(/^\/([A-Za-z]:\/)/, '$1');
// 拼接令牌文件路径
const tokenstore_location = path.join(correctedDir, 'nodejs_sdk_tokens.txt');

2. OAuth参数错误 #

代码中clientSecret错误复用了SELF_CLIENT_CLIENT_ID，这会导致OAuth认证失败，进而中断令牌生成与写入流程。

修正方案：将clientSecret替换为正确的环境变量：

let token = new ZOHOCRMSDK.OAuthBuilder()
    .clientId(process.env.SELF_CLIENT_CLIENT_ID)
    .clientSecret(process.env.SELF_CLIENT_CLIENT_SECRET) // 修正为CLIENT_SECRET
    .grantToken(process.env.SELF_CLIENT_TEMPORARY_GRANT_TOKEN)
    .redirectURL(process.env.REDIRECT_URL)
    .build();

3. 文件读写权限与存在性 #

• 确保当前运行Node.js的用户对令牌文件路径有读写权限。
• 可手动创建空的nodejs_sdk_tokens.txt文件，避免SDK因文件不存在触发读取错误。

4. 异步初始化逻辑优化 #

确保initialize()方法的异步处理正确，避免因Promise捕获不完整导致的隐藏错误：

static async initialize() {
    try {
        // ... 其他初始化代码 ...
        await new ZOHOCRMSDK.InitializeBuilder()
            .user(user)
            .environment(environment)
            .token(token)
            .store(tokenstore)
            .initialize();
    } catch (err) {
        console.error("初始化失败:", err);
    }
}

修正后完整代码 #

import * as dotenv from 'dotenv'
dotenv.config();

import path from 'path';
import * as ZOHOCRMSDK from '@zohocrm/nodejs-sdk-2.1';

class Initializer {
    static async initialize() {
        try {
            const user = new ZOHOCRMSDK.UserSignature(process.env.ADMIN_EMAIL_ADDRESS);
            const environment = ZOHOCRMSDK.USDataCenter.PRODUCTION();

            const token = new ZOHOCRMSDK.OAuthBuilder()
                .clientId(process.env.SELF_CLIENT_CLIENT_ID)
                .clientSecret(process.env.SELF_CLIENT_CLIENT_SECRET)
                .grantToken(process.env.SELF_CLIENT_TEMPORARY_GRANT_TOKEN)
                .redirectURL(process.env.REDIRECT_URL)
                .build();

            // 正确生成Windows兼容路径
            const __dirname = path.dirname(new URL(import.meta.url).pathname);
            const correctedDir = __dirname.replace(/^\/([A-Za-z]:\/)/, '$1');
            const tokenstore_location = path.join(correctedDir, 'nodejs_sdk_tokens.txt');
            
            console.log("令牌文件路径:", tokenstore_location);
            const tokenstore = new ZOHOCRMSDK.FileStore(tokenstore_location);

            await new ZOHOCRMSDK.InitializeBuilder()
                .user(user)
                .environment(environment)
                .token(token)
                .store(tokenstore)
                .initialize();
                
            console.log("SDK初始化成功，刷新令牌已写入文件");
        } catch (err) {
            console.error("初始化失败:", err);
        }
    }
}

Initializer.initialize();

内容的提问来源于stack exchange，提问作者user1079785