Merge pull request #19532 from apache/master

Merge master to release for v5.5.0

.eslintrc-common.yaml

@@ -39,7 +39,7 @@ rules:
                 - "error"
     prefer-const: 1
     no-constant-condition: 0
-    comma-dangle: 2
+    comma-dangle: 0
     no-debugger: 2
     no-dupe-keys: 2
     no-empty-character-class: 2

.github/workflows/.scripts/update-notice-year.js

@@ -0,0 +1,93 @@
+/**
+ * @typedef {import('@octokit/rest').Octokit} Octokit
+ * @typedef {import('@actions/github')['context']} Context
+ */
+
+module.exports = async function updateNoticeYear(
+  /** @type {{ octokit: Octokit, context: Context }} */
+  { octokit, context }
+) {
+  const now = new Date()
+  // Change to UTC+8
+  now.setHours(now.getHours() + 8)
+  const newYear = now.getFullYear()
+  console.log('Prepare to update notice year to', newYear)
+
+  const noticeContent = `Apache ECharts
+Copyright 2017-${newYear} The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (https://www.apache.org/).`
+
+  const repoCtx = context.repo
+
+  const repoInfo = (await octokit.rest.repos.get(repoCtx)).data
+  const defaultBranchName = repoInfo.default_branch
+  const remoteNoticeFile = (await octokit.rest.repos.getContent({
+    ...repoCtx,
+    path: 'NOTICE',
+    ref: defaultBranchName
+  })).data
+  const remoteNoticeContent = base64ToUtf8(remoteNoticeFile.content)
+  if (remoteNoticeContent === noticeContent) {
+    console.log('NOTICE year is already updated.')
+    return
+  }
+
+  console.log('Ready to update the NOTICE file:\n' + noticeContent)
+
+  const defaultBranch = (await octokit.rest.repos.getBranch({
+    ...repoCtx,
+    branch: defaultBranchName
+  })).data
+
+  const newBranchName = `bot/update-notice-year/${newYear}`
+  await octokit.rest.git.createRef({
+    ...repoCtx,
+    ref: `refs/heads/${newBranchName}`,
+    sha: defaultBranch.commit.sha
+  })
+  console.log('Created a new branch:', newBranchName)
+
+  await octokit.rest.repos.createOrUpdateFileContents({
+    ...repoCtx,
+    path: 'NOTICE',
+    message: `chore: update NOTICE year to ${newYear}`,
+    content: utf8ToBase64(noticeContent),
+    sha: remoteNoticeFile.sha,
+    branch: newBranchName
+  })
+
+  console.log('Updated the NOTICE file on the new branch')
+
+  const pr = (await octokit.rest.pulls.create({
+    ...repoCtx,
+    head: newBranchName,
+    base: defaultBranchName,
+    maintainer_can_modify: true,
+    title: `chore: update NOTICE year to ${newYear}`,
+    body: `## Brief Information
+
+This pull request is in the type of:
+
+- [ ] bug fixing
+- [ ] new feature
+- [x] others
+
+### What does this PR do?
+
+Update notice year to ${newYear}. 💖
+
+Happy new year! 祝大家新年快乐！🎇`
+  })).data
+
+  console.log(`Opened PR #${pr.number} for updating the NOTICE file`)
+}
+
+function utf8ToBase64(data) {
+  return Buffer.from(data, 'utf-8').toString('base64')
+}
+
+function base64ToUtf8(data) {
+  return Buffer.from(data, 'base64').toString('utf-8')
+}

.github/workflows/ci.yml

@@ -25,12 +25,12 @@ jobs:
         run: |
           echo "FETCH_DEPTH=$(($PR_COMMIT_COUNT + 1))" >> $GITHUB_ENV
 
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: ${{ env.FETCH_DEPTH }}
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -67,10 +67,10 @@ jobs:
         node-version: [18.x]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
 

.github/workflows/nightly-next.yml

@@ -18,12 +18,12 @@ jobs:
         node-version: [18.x]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: next
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           registry-url: https://registry.npmjs.org/
           node-version: ${{ matrix.node-version }}

.github/workflows/nightly.yml

@@ -18,10 +18,10 @@ jobs:
         node-version: [18.x]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           registry-url: https://registry.npmjs.org/
           node-version: ${{ matrix.node-version }}

.github/workflows/source-release.yml

@@ -14,10 +14,10 @@ jobs:
         node-version: [18.x]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -59,10 +59,10 @@ jobs:
         node-version: [18.x]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -87,6 +87,7 @@ jobs:
             index.d.ts
             src/
             extension-src/
+            ssr/client/src/
             licenses/
             theme/
             build/
@@ -113,7 +114,7 @@ jobs:
 
     steps:
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
 

.github/workflows/update-notice-year.yml

@@ -0,0 +1,24 @@
+name: Update NOTICE year
+
+on:
+  schedule:
+    # 1/1 00:00 UTC+8
+    - cron: '0 16 31 12 *'
+  workflow_dispatch:
+
+jobs:
+  update-notice-year:
+    if: ${{ github.repository_owner == 'apache' }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          sparse-checkout: |
+            .github/workflows/.scripts
+
+      - uses: actions/github-script@v7
+        with:
+          script: |
+            const updateNoticeYear = require('.github/workflows/.scripts/update-notice-year.js')
+            await updateNoticeYear({ octokit: github, context })

.gitignore

@@ -195,6 +195,10 @@ todo
 /index.blank.js
 /extension-esm
 /extension
+/ssr/client/lib
+/ssr/client/types
+/ssr/client/index.js
+/ssr/client/index.d.ts
 /core.js
 /core.d.ts
 /charts.js

.npmignore

@@ -7,6 +7,7 @@
 /npm-debug.log
 /benchmark
 /src
+/ssr/client/src
 .DS_Store
 Thumbs.db
 Desktop.ini

NOTICE

@@ -1,5 +1,5 @@
 Apache ECharts
-Copyright 2017-2023 The Apache Software Foundation
+Copyright 2017-2024 The Apache Software Foundation
 
 This product includes software developed at
-The Apache Software Foundation (https://www.apache.org/).
+The Apache Software Foundation (https://www.apache.org/).

build/build.js

@@ -97,6 +97,12 @@ async function run() {
         ];
         await build(cfgs);
     }
+    else if (buildType === 'ssr') {
+        const cfgs = [
+            config.createSSRClient(opt)
+        ];
+        await build(cfgs);
+    }
     else if (buildType === 'myTransform') {
         const cfgs = [
             config.createMyTransform(opt)

build/config.js

@@ -108,7 +108,7 @@ exports.createECharts = function (opt = {}) {
             opt,
             {
                 name: 'echarts',
-                // Ignore default exports, which is only for compitable code like:
+                // Ignore default exports, which is only for compatible code like:
                 // import echarts from 'echarts/lib/echarts';
                 exports: 'named',
                 format: format
@@ -174,3 +174,19 @@ exports.createMyTransform = function (opt) {
         )
     };
 };
+
+exports.createSSRClient = function (opt) {
+    const input = nodePath.resolve(ecDir, `ssr/client/lib/index.js`);
+
+    return {
+        plugins: [nodeResolvePlugin()],
+        input: input,
+        output: createOutputs(
+            nodePath.resolve(ecDir, `ssr/client/dist/index`),
+            opt,
+            {
+                name: 'echarts-ssr-client'
+            }
+        )
+    };
+};

build/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "commonjs"
+}