Waline 评论系统折腾记录

开端

最近正在研究夸父的评论系统。国庆之后有过一段调研，当时了解到了 Waline ，但现在已经忘光，所以从零开始继续学习 Waline 的用法。写这篇文章是因为捣鼓 Waline 的时候遇到了太多困难，发一篇牢骚（谁叫自己造轮子太困难了呢。

发现异常

想要直接部署这个服务非常简单，但想要自定义它的一些功能非常困难。虽然官方有说明支持自定义部分功能，但一系列问题还是让我摸不着头脑：

官方提供的运行方法让自定义看上去不太可能：
这是在直接运行库内的 JS 文件，难道我要去修改他们的包吗
官方提供的文档看上去没有入口函数：
只有一个 module.exports ，却没有说明在哪里使用这个模块，也没有提供运行命令
自定义操作复杂繁琐：
如上面的自定义用户系统，它说可以用“自定义数据库服务”来实现这个功能，于是去查看自定义数据库文档
这个文档刚开始比较难读懂，但读懂之后明白了它的意思：
我们的项目使用的是 Prisma ，这让难度更加上升（暂且不谈函数的执行方法）。我需要有一个数据库，用来执行 prisma migrate ，还要和我们的主项目同步 Prisma Schema 。这才会生成对应的 PrismaClient 。然后我就可以写出类似如下的代码：
红框部分是官方给出的参考类型

函数执行方法复杂：

因为我需要把它传入的参数做一个转换，使其作为 Prisma 的查询条件。这是官方给的查询方法实例：

普通查询：

const model = new CustomModel('Comment');
await model.select({
  url: '/',
  user_id: ['!=', 0],
  createdAt: ['>', '2023-04-16 00:00:00'],
});
// SELECT * FROM Comment WHERE url = '/' AND user_id != 0 AND createdAt > "2023-04-16 00:00:00";

IN / NOT IN 查询

const model = new CustomModel('Users');
await model.select({ objectId: ['IN', [1, 2, 3, 4]] });
// SELECT * FROM Users WHERE objectId IN (1,2,3,4);

const model = new CustomModel('Comment');
await model.select({ status: ['NOT IN', ['waiting', 'spam']] });
// SELECT * FROM Comment WHERE status NOT IN ('waiting', 'spam');

LIKE 查询

const model = new CustomModel('Comment');
await model.select({ content: ['LIKE', '%content%'] });
// SELECT * FROM Comment WHERE content LIKE "%content%";

多条件查询

const model = new CustomModel('Comment');
await model.select({
  url: '/',
  user_id: ['!=', 0],
  createdAt: ['>', '2023-04-16 00:00:00'],
  _logic: 'OR',
});
// SELECT * FROM Comment WHERE url = '/' OR user_id != 0 OR createdAt > "2023-04-16 00:00:00";

复合查询

const model = new CustomModel('Comment');
await model.select({
  url: '/',
  _complex: {
    user_id: 0,
    status: ['NOT IN', ['waiting', 'spam']]
    _logic: 'OR'
  }
});
// SELECT * FROM Comment WHERE url = '/' AND ( user_id = 0 OR status NOT IN ('waiting', 'spam'));

如果你比较熟悉 TypeScript，这里有条件查询的类型定义。

搏斗过程

对 Vercel 的困惑

我发现它对 Vercel 有着很好的支持，甚至这样就可以在 Vercel 上直接运行：

这看上去也没有入口函数，可是为什么 Vercel 却可以直接运行呢。

尤其是 GPT 给出的回答，让我更加好奇：

Vercel 是一个云平台，专门为前端项目和无服务器（Serverless）函数提供部署和托管服务。
当您在本地使用 Vercel CLI 运行 vercel dev 命令时，它模拟了 Vercel 云环境的行为，
让您能够在本地开发和测试无服务器函数。

目前还没有这个精力去研究 Vercel ，留下这个困惑，之后再去和 Vercel 搏斗（

如何运行

所以话说回来，我应该如何在本地运行的同时，又能引入我的自定义模块呢？

又经过一段时间的折腾，我尝试使用 express 来进行模拟。

#初次尝试（失败

第一次是按照官方的方法，使用 module.exports ：

然后在 express 挂在 Application 路由：

结果以失败告终。

成功尝试

然后我换了一种方法，把 module.exports 改为一个变量接收，然后再把该变量放入 express 路由中，结果成功了！

代码如下：

import dotenv from "dotenv";
dotenv.config();

import UserModel from "./userModel";
import express from "express";

const Application = require("@waline/vercel");
const bcrypt = require("bcrypt");

const MyApplication = Application({
  model(tableName: string) {
    if (tableName !== "Users") {
      return;
    }

    return new UserModel();
  },
  encryptPassword() {
    return {
      async hashPassword(password: any) {
        const saltRounds = 10;
        const hashedPassword = await bcrypt.hash(password, saltRounds);
        return hashedPassword;
      },
      async checkPassword(password: any, storeHash: any) {
        const isPasswordValid = await bcrypt.compare(password, storeHash);
        return isPasswordValid;
      },
    };
  },
});

const app = express();
const PORT = process.env.PORT || 3000;

app.use("/", MyApplication);

app.listen(PORT, () => {
  console.log(`Server is running on http://localhost:${PORT}`);
});