refactor: add dingtalk-bot and workers-utils package

libs/dingtalk-bot/.gitignore

@@ -0,0 +1 @@
+lib

libs/dingtalk-bot/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@opensumi/dingtalk-bot",
+  "version": "1.0.3",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc -w",
+    "test": "jest",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@opensumi/ide-utils": "^2.23.1",
+    "@opensumi/workers-utils": "workspace:^",
+    "dotenv": "^16.3.1",
+    "magic-string": "^0.30.3",
+    "mri": "^1.2.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  }
+}

libs/dingtalk-bot/src/index.ts

@@ -0,0 +1,57 @@
+import { doSign } from './utils';
+
+function validateTimestamp(timestamp: string) {
+  try {
+    const _tsNumber = parseInt(timestamp, 10);
+    const now = Date.now();
+    const diff = Math.abs(now - _tsNumber);
+    if (diff <= 60 * 60 * 1000) {
+      return true;
+    }
+    return false;
+  } catch (err) {
+    return false;
+  }
+}
+
+/**
+ * 验证接收到的钉钉消息的签名是否合法
+ */
+async function checkSign(
+  timestamp: string,
+  sign: string,
+  token: string,
+): Promise<string | undefined> {
+  if (!token) {
+    return;
+  }
+
+  // 开发者需对header中的timestamp和sign进行验证
+  // 以判断是否是来自钉钉的合法请求，避免其他仿冒钉钉调用开发者的HTTPS服务传送数据，具体验证逻辑如下：
+  // 1. timestamp 与系统当前时间戳如果相差1小时以上，则认为是非法的请求。
+  const tsValid = validateTimestamp(timestamp);
+  if (!tsValid) {
+    return 'timestamp is invalid';
+  }
+  const calculatedSign = await doSign(token, timestamp + '\n' + token);
+  // 2. sign 与开发者自己计算的结果不一致，则认为是非法的请求。
+  if (calculatedSign !== sign) {
+    return 'sign is invalid';
+  }
+  return;
+}
+
+export async function verifyMessage(headers: Headers, token: string) {
+  console.log(`verifyMessage ~ headers`, headers);
+  const timestamp = headers.get('timestamp') as string;
+  const sign = headers.get('sign') as string;
+  if (timestamp && sign) {
+    const errMessage = await checkSign(timestamp, sign, token);
+    if (errMessage) {
+      return errMessage;
+    }
+  } else {
+    // it seem that dingtalk will not send timestamp and sign in header
+    // return 'not valid ding msg, missing validation field';
+  }
+}

libs/dingtalk-bot/src/types.ts

@@ -0,0 +1,140 @@
+export interface TextMessage {
+  content: string;
+}
+
+export interface AtUsersItem {
+  dingtalkId: string;
+  staffId?: string;
+}
+
+export enum ConversationType {
+  private = '1',
+  group = '2',
+}
+
+export interface Message {
+  msgtype: string;
+  text: TextMessage;
+  msgId: string;
+  createAt: number;
+  conversationType: ConversationType;
+  conversationId: string;
+  senderId: string;
+  senderNick: string;
+  senderCorpId?: string;
+  sessionWebhook: string;
+  sessionWebhookExpiredTime: number;
+  isAdmin: boolean;
+}
+
+export interface PrivateMessage extends Message {
+  chatbotCorpId: string;
+  senderStaffId?: string;
+  conversationType: ConversationType.private;
+}
+
+export interface GroupMessage extends Message {
+  atUsers: AtUsersItem[];
+  conversationType: ConversationType.group;
+  conversationTitle: string;
+  isInAtList: boolean;
+}
+
+export function isPrivateMessage(message: any): message is PrivateMessage {
+  return (
+    message &&
+    message.conversationType &&
+    message.conversationType === ConversationType.private
+  );
+}
+
+export function isGroupMessage(message: any): message is GroupMessage {
+  return (
+    message &&
+    message.conversationType &&
+    message.conversationType === ConversationType.group
+  );
+}
+
+export interface At {
+  at: {
+    atDingtalkIds: string[];
+  };
+}
+
+export type Base<T extends string, O> = Record<T, O> & { msgtype: T };
+
+export type Image = Base<
+  'image',
+  {
+    picURL: string;
+  }
+>;
+
+export type Markdown = Base<
+  'markdown',
+  {
+    title: string;
+    text: string;
+  }
+>;
+export type Text = Base<
+  'text',
+  {
+    content: string;
+  }
+>;
+
+export type SendMessage = Image | Markdown | Text;
+
+export function atDingtalkIds(...atDingtalkIds: string[]): At {
+  return {
+    at: {
+      atDingtalkIds,
+    },
+  };
+}
+
+export function text(content: string): Text {
+  return {
+    msgtype: 'text',
+    text: {
+      content: content ? content.toString().trim() : '',
+    },
+  };
+}
+
+export function compose(...objects: any[]) {
+  return Object.assign({}, ...objects);
+}
+
+export function markdown(title: string, text: string): Markdown {
+  return {
+    msgtype: 'markdown',
+    markdown: {
+      title,
+      text,
+    },
+  };
+}
+
+export function image(url: string): Image {
+  return {
+    msgtype: 'image',
+    image: { picURL: url },
+  };
+}
+
+export function extension(extension: Record<string, unknown>) {
+  return {
+    msgtype: 'extension',
+    extension,
+  };
+}
+
+export function code(language: string, code: string) {
+  return {
+    ...extension({ text_type: 'code_snippet', code_language: language }),
+    ...text(code),
+  };
+}

src/im/utils.ts → libs/dingtalk-bot/src/utils.ts

@@ -1,4 +1,4 @@
-import { sign } from '@/runtime/cfworker/crypto';
+import { sign } from '@opensumi/workers-utils/lib/crypto';
 
 export async function doSign(secret: string, content: string): Promise<string> {
   const mac = await sign(secret, content);

libs/dingtalk-bot/tsconfig.json

@@ -0,0 +1,109 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs" /* Specify what module code is generated. */,
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    "baseUrl": "./src" /* Specify the base directory to resolve non-relative module names. */,
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    "declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./lib" /* Specify an output folder for all emitted files. */,
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+    /* Type Checking */
+    "strict": true /* Enable all strict type-checking options. */,
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  }
+}

libs/workers-utils/.gitignore

@@ -0,0 +1 @@
+lib

libs/workers-utils/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@opensumi/workers-utils",
+  "version": "1.0.3",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc -w",
+    "test": "jest",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@opensumi/ide-utils": "^2.23.1",
+    "dotenv": "^16.3.1",
+    "magic-string": "^0.30.3",
+    "mri": "^1.2.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  }
+}

libs/workers-utils/src/index.ts

@@ -0,0 +1 @@
+export {};