QLAPI 支持操作环境变量和系统通知

back/loaders/db.ts

@@ -48,16 +48,18 @@ export default async () => {
     } catch (error) {}
     try {
       await sequelize.query('alter table Crontabs add column sub_id NUMBER');
-    } catch (error) { }
+    } catch (error) {}
     try {
-      await sequelize.query('alter table Crontabs add column extra_schedules JSON');
-    } catch (error) { }
+      await sequelize.query(
+        'alter table Crontabs add column extra_schedules JSON',
+      );
+    } catch (error) {}
     try {
       await sequelize.query('alter table Crontabs add column task_before TEXT');
-    } catch (error) { }
+    } catch (error) {}
     try {
       await sequelize.query('alter table Crontabs add column task_after TEXT');
-    } catch (error) { }
+    } catch (error) {}
 
     // 2.10-2.11 升级
     const cronDbFile = path.join(config.rootPath, 'db/crontab.db');

back/loaders/initData.ts

@@ -13,10 +13,11 @@ import { AuthDataType, SystemModel } from '../data/system';
 import SystemService from '../services/system';
 import UserService from '../services/user';
 import { writeFile, readFile } from 'fs/promises';
-import { safeJSONParse } from '../config/util';
+import { createRandomString, safeJSONParse } from '../config/util';
 import OpenService from '../services/open';
 import { shareStore } from '../shared/store';
 import Logger from './logger';
+import { AppModel } from '../data/open';
 
 export default async () => {
   const cronService = Container.get(CronService);
@@ -27,6 +28,19 @@ export default async () => {
   const openService = Container.get(OpenService);
 
   // 初始化增加系统配置
+  let systemApp = (
+    await AppModel.findOne({
+      where: { name: 'system' },
+    })
+  )?.get({ plain: true });
+  if (!systemApp) {
+    systemApp = await AppModel.create({
+      name: 'system',
+      scopes: ['crons', 'system'],
+      client_id: createRandomString(12, 12),
+      client_secret: createRandomString(24, 24),
+    });
+  }
   const [systemConfig] = await SystemModel.findOrCreate({
     where: { type: AuthDataType.systemConfig },
   });

back/protos/api.proto

@@ -0,0 +1,73 @@
+syntax = "proto3";
+
+package com.ql.api;
+
+message EnvItem {
+  optional int32 id = 1;
+  optional string name = 2;
+  optional string value = 3;
+  optional string remarks = 4;
+  optional int32 status = 5;
+  optional int32 position = 6;
+}
+
+message GetEnvsRequest { string searchValue = 1; }
+
+message CreateEnvRequest { repeated EnvItem envs = 1; }
+
+message UpdateEnvRequest { EnvItem env = 1; }
+
+message DeleteEnvsRequest { repeated int32 ids = 1; }
+
+message MoveEnvRequest {
+  int32 id = 1;
+  int32 fromIndex = 2;
+  int32 toIndex = 3;
+}
+
+message DisableEnvsRequest { repeated int32 ids = 1; }
+
+message EnableEnvsRequest { repeated int32 ids = 1; }
+
+message UpdateEnvNamesRequest {
+  repeated int32 ids = 1;
+  string name = 2;
+}
+
+message GetEnvByIdRequest { int32 id = 1; }
+
+message EnvsResponse {
+  int32 code = 1;
+  repeated EnvItem data = 2;
+  optional string message = 3;
+}
+
+message EnvResponse {
+  int32 code = 1;
+  EnvItem data = 2;
+  optional string message = 3;
+}
+
+message Response {
+  int32 code = 1;
+  optional string message = 2;
+}
+
+message SystemNotifyRequest {
+  string title = 1;
+  string content = 2;
+}
+message SystemNotifyResponse {}
+
+service Api {
+  rpc GetEnvs(GetEnvsRequest) returns (EnvsResponse) {}
+  rpc CreateEnv(CreateEnvRequest) returns (EnvsResponse) {}
+  rpc UpdateEnv(UpdateEnvRequest) returns (EnvResponse) {}
+  rpc DeleteEnvs(DeleteEnvsRequest) returns (Response) {}
+  rpc MoveEnv(MoveEnvRequest) returns (EnvResponse) {}
+  rpc DisableEnvs(DisableEnvsRequest) returns (Response) {}
+  rpc EnableEnvs(EnableEnvsRequest) returns (Response) {}
+  rpc UpdateEnvNames(UpdateEnvNamesRequest) returns (Response) {}
+  rpc GetEnvById(GetEnvByIdRequest) returns (EnvResponse) {}
+  rpc SystemNotify(SystemNotifyRequest) returns (SystemNotifyResponse) {}
+}

back/protos/cron.ts

@@ -1,15 +1,21 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.181.2
+//   protoc               v3.17.3
+// source: back/protos/cron.proto
+
 /* eslint-disable */
 import {
-  CallOptions,
+  type CallOptions,
   ChannelCredentials,
   Client,
-  ClientOptions,
-  ClientUnaryCall,
-  handleUnaryCall,
+  type ClientOptions,
+  type ClientUnaryCall,
+  type handleUnaryCall,
   makeGenericClientConstructor,
   Metadata,
-  ServiceError,
-  UntypedServiceImplementation,
+  type ServiceError,
+  type UntypedServiceImplementation,
 } from "@grpc/grpc-js";
 import _m0 from "protobufjs/minimal";
 
@@ -77,19 +83,20 @@ export const ISchedule = {
   },
 
   fromJSON(object: any): ISchedule {
-    return { schedule: isSet(object.schedule) ? String(object.schedule) : "" };
+    return { schedule: isSet(object.schedule) ? globalThis.String(object.schedule) : "" };
   },
 
   toJSON(message: ISchedule): unknown {
     const obj: any = {};
-    message.schedule !== undefined && (obj.schedule = message.schedule);
+    if (message.schedule !== "") {
+      obj.schedule = message.schedule;
+    }
     return obj;
   },
 
   create<I extends Exact<DeepPartial<ISchedule>, I>>(base?: I): ISchedule {
-    return ISchedule.fromPartial(base ?? {});
+    return ISchedule.fromPartial(base ?? ({} as any));
   },
-
   fromPartial<I extends Exact<DeepPartial<ISchedule>, I>>(object: I): ISchedule {
     const message = createBaseISchedule();
     message.schedule = object.schedule ?? "";
@@ -174,34 +181,39 @@ export const ICron = {
 
   fromJSON(object: any): ICron {
     return {
-      id: isSet(object.id) ? String(object.id) : "",
-      schedule: isSet(object.schedule) ? String(object.schedule) : "",
-      command: isSet(object.command) ? String(object.command) : "",
-      extraSchedules: Array.isArray(object?.extraSchedules)
+      id: isSet(object.id) ? globalThis.String(object.id) : "",
+      schedule: isSet(object.schedule) ? globalThis.String(object.schedule) : "",
+      command: isSet(object.command) ? globalThis.String(object.command) : "",
+      extraSchedules: globalThis.Array.isArray(object?.extraSchedules)
         ? object.extraSchedules.map((e: any) => ISchedule.fromJSON(e))
         : [],
-      name: isSet(object.name) ? String(object.name) : "",
+      name: isSet(object.name) ? globalThis.String(object.name) : "",
     };
   },
 
   toJSON(message: ICron): unknown {
     const obj: any = {};
-    message.id !== undefined && (obj.id = message.id);
-    message.schedule !== undefined && (obj.schedule = message.schedule);
-    message.command !== undefined && (obj.command = message.command);
-    if (message.extraSchedules) {
-      obj.extraSchedules = message.extraSchedules.map((e) => e ? ISchedule.toJSON(e) : undefined);
-    } else {
-      obj.extraSchedules = [];
+    if (message.id !== "") {
+      obj.id = message.id;
+    }
+    if (message.schedule !== "") {
+      obj.schedule = message.schedule;
+    }
+    if (message.command !== "") {
+      obj.command = message.command;
+    }
+    if (message.extraSchedules?.length) {
+      obj.extraSchedules = message.extraSchedules.map((e) => ISchedule.toJSON(e));
+    }
+    if (message.name !== "") {
+      obj.name = message.name;
     }
-    message.name !== undefined && (obj.name = message.name);
     return obj;
   },
 
   create<I extends Exact<DeepPartial<ICron>, I>>(base?: I): ICron {
-    return ICron.fromPartial(base ?? {});
+    return ICron.fromPartial(base ?? ({} as any));
   },
-
   fromPartial<I extends Exact<DeepPartial<ICron>, I>>(object: I): ICron {
     const message = createBaseICron();
     message.id = object.id ?? "";
@@ -249,23 +261,20 @@ export const AddCronRequest = {
   },
 
   fromJSON(object: any): AddCronRequest {
-    return { crons: Array.isArray(object?.crons) ? object.crons.map((e: any) => ICron.fromJSON(e)) : [] };
+    return { crons: globalThis.Array.isArray(object?.crons) ? object.crons.map((e: any) => ICron.fromJSON(e)) : [] };
   },
 
   toJSON(message: AddCronRequest): unknown {
     const obj: any = {};
-    if (message.crons) {
-      obj.crons = message.crons.map((e) => e ? ICron.toJSON(e) : undefined);
-    } else {
-      obj.crons = [];
+    if (message.crons?.length) {
+      obj.crons = message.crons.map((e) => ICron.toJSON(e));
     }
     return obj;
   },
 
   create<I extends Exact<DeepPartial<AddCronRequest>, I>>(base?: I): AddCronRequest {
-    return AddCronRequest.fromPartial(base ?? {});
+    return AddCronRequest.fromPartial(base ?? ({} as any));
   },
-
   fromPartial<I extends Exact<DeepPartial<AddCronRequest>, I>>(object: I): AddCronRequest {
     const message = createBaseAddCronRequest();
     message.crons = object.crons?.map((e) => ICron.fromPartial(e)) || [];
@@ -308,9 +317,8 @@ export const AddCronResponse = {
   },
 
   create<I extends Exact<DeepPartial<AddCronResponse>, I>>(base?: I): AddCronResponse {
-    return AddCronResponse.fromPartial(base ?? {});
+    return AddCronResponse.fromPartial(base ?? ({} as any));
   },
-
   fromPartial<I extends Exact<DeepPartial<AddCronResponse>, I>>(_: I): AddCronResponse {
     const message = createBaseAddCronResponse();
     return message;
@@ -353,23 +361,20 @@ export const DeleteCronRequest = {
   },
 
   fromJSON(object: any): DeleteCronRequest {
-    return { ids: Array.isArray(object?.ids) ? object.ids.map((e: any) => String(e)) : [] };
+    return { ids: globalThis.Array.isArray(object?.ids) ? object.ids.map((e: any) => globalThis.String(e)) : [] };
   },
 
   toJSON(message: DeleteCronRequest): unknown {
     const obj: any = {};
-    if (message.ids) {
-      obj.ids = message.ids.map((e) => e);
-    } else {
-      obj.ids = [];
+    if (message.ids?.length) {
+      obj.ids = message.ids;
     }
     return obj;
   },
 
   create<I extends Exact<DeepPartial<DeleteCronRequest>, I>>(base?: I): DeleteCronRequest {
-    return DeleteCronRequest.fromPartial(base ?? {});
+    return DeleteCronRequest.fromPartial(base ?? ({} as any));
   },
-
   fromPartial<I extends Exact<DeepPartial<DeleteCronRequest>, I>>(object: I): DeleteCronRequest {
     const message = createBaseDeleteCronRequest();
     message.ids = object.ids?.map((e) => e) || [];
@@ -412,9 +417,8 @@ export const DeleteCronResponse = {
   },
 
   create<I extends Exact<DeepPartial<DeleteCronResponse>, I>>(base?: I): DeleteCronResponse {
-    return DeleteCronResponse.fromPartial(base ?? {});
+    return DeleteCronResponse.fromPartial(base ?? ({} as any));
   },
-
   fromPartial<I extends Exact<DeepPartial<DeleteCronResponse>, I>>(_: I): DeleteCronResponse {
     const message = createBaseDeleteCronResponse();
     return message;
@@ -484,12 +488,14 @@ export interface CronClient extends Client {
 export const CronClient = makeGenericClientConstructor(CronService, "com.ql.cron.Cron") as unknown as {
   new (address: string, credentials: ChannelCredentials, options?: Partial<ClientOptions>): CronClient;
   service: typeof CronService;
+  serviceName: string;
 };
 
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
 
 export type DeepPartial<T> = T extends Builtin ? T
-  : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>>
+  : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>>
+  : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>>
   : T extends {} ? { [K in keyof T]?: DeepPartial<T[K]> }
   : Partial<T>;
 

back/protos/health.ts

@@ -1,17 +1,23 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.181.2
+//   protoc               v3.17.3
+// source: back/protos/health.proto
+
 /* eslint-disable */
 import {
-  CallOptions,
+  type CallOptions,
   ChannelCredentials,
   Client,
-  ClientOptions,
+  type ClientOptions,
   ClientReadableStream,
-  ClientUnaryCall,
+  type ClientUnaryCall,
   handleServerStreamingCall,
-  handleUnaryCall,
+  type handleUnaryCall,
   makeGenericClientConstructor,
   Metadata,
-  ServiceError,
-  UntypedServiceImplementation,
+  type ServiceError,
+  type UntypedServiceImplementation,
 } from "@grpc/grpc-js";
 import _m0 from "protobufjs/minimal";
 
@@ -106,19 +112,20 @@ export const HealthCheckRequest = {
   },
 
   fromJSON(object: any): HealthCheckRequest {
-    return { service: isSet(object.service) ? String(object.service) : "" };
+    return { service: isSet(object.service) ? globalThis.String(object.service) : "" };
   },
 
   toJSON(message: HealthCheckRequest): unknown {
     const obj: any = {};
-    message.service !== undefined && (obj.service = message.service);
+    if (message.service !== "") {
+      obj.service = message.service;
+    }
     return obj;
   },
 
   create<I extends Exact<DeepPartial<HealthCheckRequest>, I>>(base?: I): HealthCheckRequest {
-    return HealthCheckRequest.fromPartial(base ?? {});
+    return HealthCheckRequest.fromPartial(base ?? ({} as any));
   },
-
   fromPartial<I extends Exact<DeepPartial<HealthCheckRequest>, I>>(object: I): HealthCheckRequest {
     const message = createBaseHealthCheckRequest();
     message.service = object.service ?? "";
@@ -167,14 +174,15 @@ export const HealthCheckResponse = {
 
   toJSON(message: HealthCheckResponse): unknown {
     const obj: any = {};
-    message.status !== undefined && (obj.status = healthCheckResponse_ServingStatusToJSON(message.status));
+    if (message.status !== 0) {
+      obj.status = healthCheckResponse_ServingStatusToJSON(message.status);
+    }
     return obj;
   },
 
   create<I extends Exact<DeepPartial<HealthCheckResponse>, I>>(base?: I): HealthCheckResponse {
-    return HealthCheckResponse.fromPartial(base ?? {});
+    return HealthCheckResponse.fromPartial(base ?? ({} as any));
   },
-
   fromPartial<I extends Exact<DeepPartial<HealthCheckResponse>, I>>(object: I): HealthCheckResponse {
     const message = createBaseHealthCheckResponse();
     message.status = object.status ?? 0;
@@ -236,12 +244,14 @@ export interface HealthClient extends Client {
 export const HealthClient = makeGenericClientConstructor(HealthService, "com.ql.health.Health") as unknown as {
   new (address: string, credentials: ChannelCredentials, options?: Partial<ClientOptions>): HealthClient;
   service: typeof HealthService;
+  serviceName: string;
 };
 
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
 
 export type DeepPartial<T> = T extends Builtin ? T
-  : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>>
+  : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>>
+  : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>>
   : T extends {} ? { [K in keyof T]?: DeepPartial<T[K]> }
   : Partial<T>;
 

back/schedule/api.ts

@@ -0,0 +1,171 @@
+import 'reflect-metadata';
+import { Container } from 'typedi';
+import EnvService from '../services/env';
+import { sendUnaryData, ServerUnaryCall } from '@grpc/grpc-js';
+import {
+  CreateEnvRequest,
+  DeleteEnvsRequest,
+  DisableEnvsRequest,
+  EnableEnvsRequest,
+  EnvItem,
+  EnvResponse,
+  EnvsResponse,
+  GetEnvByIdRequest,
+  GetEnvsRequest,
+  MoveEnvRequest,
+  Response,
+  SystemNotifyRequest,
+  SystemNotifyResponse,
+  UpdateEnvNamesRequest,
+  UpdateEnvRequest,
+} from '../protos/api';
+import LoggerInstance from '../loaders/logger';
+import NotificationService from '../services/notify';
+
+Container.set('logger', LoggerInstance);
+
+export const getEnvs = async (
+  call: ServerUnaryCall<GetEnvsRequest, EnvsResponse>,
+  callback: sendUnaryData<EnvsResponse>,
+) => {
+  try {
+    const envService = Container.get(EnvService);
+    const data = await envService.envs(call.request.searchValue);
+    callback(null, {
+      code: 200,
+      data: data.map((x) => ({ ...x, remarks: x.remarks || '' })),
+    });
+  } catch (e: any) {
+    callback(null, {
+      code: 500,
+      data: [],
+      message: e.message,
+    });
+  }
+};
+
+export const createEnv = async (
+  call: ServerUnaryCall<CreateEnvRequest, EnvsResponse>,
+  callback: sendUnaryData<EnvsResponse>,
+) => {
+  try {
+    const envService = Container.get(EnvService);
+    const data = await envService.create(call.request.envs);
+    callback(null, { code: 200, data });
+  } catch (e: any) {
+    callback(e);
+  }
+};
+
+export const updateEnv = async (
+  call: ServerUnaryCall<UpdateEnvRequest, EnvResponse>,
+  callback: sendUnaryData<EnvResponse>,
+) => {
+  try {
+    const envService = Container.get(EnvService);
+    const data = await envService.update(call.request.env as EnvItem);
+    callback(null, { code: 200, data });
+  } catch (e: any) {
+    callback(e);
+  }
+};
+
+export const deleteEnvs = async (
+  call: ServerUnaryCall<DeleteEnvsRequest, Response>,
+  callback: sendUnaryData<Response>,
+) => {
+  try {
+    const envService = Container.get(EnvService);
+    await envService.remove(call.request.ids);
+    callback(null, { code: 200 });
+  } catch (e: any) {
+    callback(e);
+  }
+};
+
+export const moveEnv = async (
+  call: ServerUnaryCall<MoveEnvRequest, EnvResponse>,
+  callback: sendUnaryData<EnvResponse>,
+) => {
+  try {
+    const envService = Container.get(EnvService);
+    const data = await envService.move(call.request.id, {
+      fromIndex: call.request.fromIndex,
+      toIndex: call.request.toIndex,
+    });
+    callback(null, { code: 200, data });
+  } catch (e: any) {
+    callback(e);
+  }
+};
+
+export const disableEnvs = async (
+  call: ServerUnaryCall<DisableEnvsRequest, Response>,
+  callback: sendUnaryData<Response>,
+) => {
+  try {
+    const envService = Container.get(EnvService);
+    await envService.disabled(call.request.ids);
+    callback(null, { code: 200 });
+  } catch (e: any) {
+    callback(e);
+  }
+};
+
+export const enableEnvs = async (
+  call: ServerUnaryCall<EnableEnvsRequest, Response>,
+  callback: sendUnaryData<Response>,
+) => {
+  try {
+    const envService = Container.get(EnvService);
+    await envService.enabled(call.request.ids);
+    callback(null, { code: 200 });
+  } catch (e: any) {
+    callback(e);
+  }
+};
+
+export const updateEnvNames = async (
+  call: ServerUnaryCall<UpdateEnvNamesRequest, Response>,
+  callback: sendUnaryData<Response>,
+) => {
+  try {
+    const envService = Container.get(EnvService);
+    await envService.updateNames({
+      ids: call.request.ids,
+      name: call.request.name,
+    });
+    callback(null, { code: 200 });
+  } catch (e: any) {
+    callback(e);
+  }
+};
+
+export const getEnvById = async (
+  call: ServerUnaryCall<GetEnvByIdRequest, EnvResponse>,
+  callback: sendUnaryData<EnvResponse>,
+) => {
+  try {
+    const envService = Container.get(EnvService);
+    const data = await envService.getDb({ id: call.request.id });
+    callback(null, { code: 200, data });
+  } catch (e: any) {
+    callback(e);
+  }
+};
+
+export const systemNotify = async (
+  call: ServerUnaryCall<SystemNotifyRequest, SystemNotifyResponse>,
+  callback: sendUnaryData<SystemNotifyResponse>,
+) => {
+  try {
+    const notifyService = Container.get(NotificationService);
+    const data = await notifyService.notify(
+      call.request.title,
+      call.request.content,
+    );
+    callback(null, { code: 200, data });
+  } catch (e: any) {
+    callback(e);
+  }
+};

back/schedule/index.ts

@@ -6,10 +6,13 @@ import { HealthService } from '../protos/health';
 import { check } from './health';
 import config from '../config';
 import Logger from '../loaders/logger';
+import { ApiService } from '../protos/api';
+import * as Api from './api';
 
 const server = new Server({ 'grpc.enable_http_proxy': 0 });
 server.addService(HealthService, { check });
 server.addService(CronService, { addCron, delCron });
+server.addService(ApiService, Api);
 server.bindAsync(
   `0.0.0.0:${config.cronPort}`,
   ServerCredentials.createInsecure(),

back/services/env.ts

@@ -62,7 +62,7 @@ export default class EnvService {
     return await this.getDb({ id: payload.id });
   }
 
-  public async remove(ids: string[]) {
+  public async remove(ids: number[]) {
     await EnvModel.destroy({ where: { id: ids } });
     await this.set_envs();
   }
@@ -150,7 +150,7 @@ export default class EnvService {
         ['position', 'DESC'],
         ['createdAt', 'ASC'],
       ]);
-      return result as any;
+      return result;
     } catch (error) {
       throw error;
     }
@@ -161,7 +161,7 @@ export default class EnvService {
       where: { ...query },
       order: [...sort],
     });
-    return docs;
+    return docs.map((x) => x.get({ plain: true }));
   }
 
   public async getDb(query: FindOptions<Env>['where']): Promise<Env> {
@@ -172,7 +172,7 @@ export default class EnvService {
     return doc.get({ plain: true });
   }
 
-  public async disabled(ids: string[]) {
+  public async disabled(ids: number[]) {
     await EnvModel.update(
       { status: EnvStatus.disabled },
       { where: { id: ids } },
@@ -180,12 +180,12 @@ export default class EnvService {
     await this.set_envs();
   }
 
-  public async enabled(ids: string[]) {
+  public async enabled(ids: number[]) {
     await EnvModel.update({ status: EnvStatus.normal }, { where: { id: ids } });
     await this.set_envs();
   }
 
-  public async updateNames({ ids, name }: { ids: string[]; name: string }) {
+  public async updateNames({ ids, name }: { ids: number[]; name: string }) {
     await EnvModel.update({ name }, { where: { id: ids } });
     await this.set_envs();
   }

back/services/open.ts

@@ -159,16 +159,15 @@ export default class OpenService {
     value: string;
     expiration: number;
   }> {
-    let systemApp = (
-      await AppModel.findOne({
-        where: { name: 'system' },
-      })
-    )?.get({ plain: true });
+    const apps = await shareStore.getApps();
+    const systemApp = apps?.find((x) => x.name === 'system');
     if (!systemApp) {
-      systemApp = await this.create({
-        name: 'system',
-        scopes: ['crons', 'system'],
-      } as App);
+      throw new Error('system app not found');
+    }
+    const now = Math.round(Date.now() / 1000);
+    const currentToken = systemApp.tokens?.find((x) => x.expiration > now);
+    if (currentToken) {
+      return currentToken;
     }
     const { data } = await this.authToken({
       client_id: systemApp.client_id,