Merge branch 'master' into 'next'

.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

@@ -2,7 +2,13 @@ name: Node CI
 
 on:
   pull_request:
-    types: [opened, synchronize]
+    types: [opened, reopened, synchronize]
+
+concurrency:
+  # Note that the `teardown-pr-preview` workflow needs the same group name
+  # to cancel the running `ci` workflows
+  group: ${{ github.workflow }}-${{ github.event.number }}
+  cancel-in-progress: true
 
 jobs:
   lint:
@@ -19,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 }}
 
@@ -61,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 }}
 
@@ -81,11 +87,43 @@ jobs:
         if: steps.cache-dep.outputs.cache-hit != 'true'
         run: npm ci
 
+      - name: Unit Test
+        run: npm run test
+
       - name: Build release
         run: npm run release
 
       - name: Test generated DTS
         run: npm run test:dts
 
-      - name: Unit Test
-        run: npm run test
+      - name: Pack npm tarball
+        if: ${{ github.repository_owner == 'apache' }}
+        id: pack-tarball
+        run: |
+          export PR_PREVIEW_DIR='echarts-pr-preview'
+          mkdir -p $PR_PREVIEW_DIR
+          npm pack -pack-destination $PR_PREVIEW_DIR
+          echo "PR_PREVIEW_DIR=$PR_PREVIEW_DIR" >> $GITHUB_ENV
+
+      - name: Save PR metadata and dist files
+        if: ${{ steps.pack-tarball.outcome == 'success' }}
+        id: save-pr-data
+        env:
+          PR_NUMBER: ${{ github.event.number }}
+          PR_COMMIT_SHA: ${{ github.event.pull_request.head.sha }}
+          PR_PREVIEW_DIR: ${{ env.PR_PREVIEW_DIR }}
+        run: |
+          cd $PR_PREVIEW_DIR
+          echo $PR_NUMBER > ./pr_number
+          echo $PR_COMMIT_SHA > ./pr_commit_sha
+          find . -type f -regex ".*\.tgz" -exec tar xvzf {} \;
+          rm -f *.tgz
+          echo -e "Dist files: \n$(ls -l)"
+
+      - uses: actions/upload-artifact@v3
+        if: ${{ steps.save-pr-data.outcome == 'success' }}
+        with:
+          name: pr_preview
+          path: ${{ env.PR_PREVIEW_DIR }}
+          retention-days: 1
+          if-no-files-found: error

.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/pr-preview.yml

@@ -0,0 +1,76 @@
+name: Deploy PR Preview
+
+on:
+  workflow_run:
+    workflows: ['Node CI']
+    types: [completed]
+
+jobs:
+  on-success:
+    if: ${{ github.repository_owner == 'apache' }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Determine if workflow build job is successful
+        id: check-build-success
+        uses: actions/github-script@v6
+        with:
+          result-encoding: string
+          script: |
+            const jobsRes = await github.rest.actions.listJobsForWorkflowRun({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              run_id: context.payload.workflow_run.id
+            });
+            return jobsRes.data.jobs.some((job) => job.name.includes('build') && job.conclusion === 'success');
+
+    outputs:
+      SHOULD_DEPOLY: ${{ steps.check-build-success.outputs.result }}
+
+  deploy:
+    needs: [on-success]
+    if: ${{ needs.on-success.outputs.SHOULD_DEPOLY == 'true' }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Install action dependencies
+        run: |
+          mkdir .actions
+          cd .actions
+          git clone --depth=1 https://github.com/dawidd6/action-download-artifact.git
+          git clone --depth=1 https://github.com/actions-cool/maintain-one-comment.git
+
+      - name: Fetch PR dist files
+        uses: ./.actions/action-download-artifact
+        with:
+          workflow: ${{ github.event.workflow.id }}
+          run_id: ${{ github.event.workflow_run.id }}
+          name: pr_preview
+          if_no_artifact_found: fail
+
+      - name: Output PR metadata
+        id: pr-metadata
+        run: |
+          echo "NUMBER=$(cat pr_number)" >> $GITHUB_OUTPUT
+          echo "COMMIT_SHA=$(cat pr_commit_sha)" >> $GITHUB_OUTPUT
+          echo "COMMIT_SHA_SHORT=$(cat pr_commit_sha | cut -c 1-7)" >> $GITHUB_OUTPUT
+
+      - name: Deploy dist files
+        env:
+          PR_NUMBER: ${{ steps.pr-metadata.outputs.NUMBER }}
+          SURGE_TOKEN: ${{ secrets.SURGE_TOKEN }}
+        run: |
+          export SURGE_DOMAIN=https://echarts-pr-$PR_NUMBER.surge.sh
+          npx surge --project ./package --domain $SURGE_DOMAIN --token $SURGE_TOKEN
+
+      - name: Create comment for PR preview
+        uses: ./.actions/maintain-one-comment
+        env:
+          PR_NUMBER: ${{ steps.pr-metadata.outputs.NUMBER }}
+          COMMIT_SHA_SHORT: ${{ steps.pr-metadata.outputs.COMMIT_SHA_SHORT }}
+        with:
+          body: |
+            <!-- ECHARTS_PR_PREVIEW -->
+            The changes brought by this PR can be previewed at: https://echarts.apache.org/examples/editor?version=PR-${{ env.PR_NUMBER }}@${{ env.COMMIT_SHA_SHORT }}
+          body-include: '<!-- ECHARTS_PR_PREVIEW -->'
+          number: ${{ env.PR_NUMBER }}

.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/teardown-pr-preview.yml

@@ -0,0 +1,30 @@
+name: Teardown PR Preview
+
+on:
+  pull_request_target:
+    types: [closed]
+
+jobs:
+  teardown-pr-preview:
+    if: ${{ github.repository_owner == 'apache' && github.event.action == 'closed' && github.event.pull_request.merged != true }}
+    concurrency:
+      # to cancel running `ci` workflows in current PR
+      group: 'Node CI-${{ github.event.number }}'
+      cancel-in-progress: true
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install action dependencies
+        run: git clone --depth=1 https://github.com/actions-cool/maintain-one-comment.git
+
+      - name: Delete PR preview comment
+        uses: ./maintain-one-comment
+        with:
+          body-include: '<!-- ECHARTS_PR_PREVIEW -->'
+          delete: true
+          number: ${{ github.event.number }}
+
+      - name: Teardown closed PR preview
+        continue-on-error: true
+        run: |
+          export SURGE_DOMAIN='https://echarts-pr-${{ github.event.number }}.surge.sh'
+          npx surge teardown $SURGE_DOMAIN --token ${{ secrets.SURGE_TOKEN }}

.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 })