@harperfast/harper-pro 5.0.0-alpha.2 → 5.0.0-alpha.4

package/core/.github/workflows/create-release.yaml

@@ -0,0 +1,181 @@
+name: Create Release on Version Tag
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version; should look like v1.2.3(-[alpha|beta|rc].N])'
+        required: true
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref_name }}
+  cancel-in-progress: true
+
+jobs:
+  create-release:
+    runs-on: ubuntu-latest
+    outputs:
+      harper-version: ${{ steps.package-version.outputs.packageVersion }}
+      draft-release-url: ${{ steps.create-release.outputs.url }}
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
+        with:
+          node-version: latest
+          package-manager-cache: false
+      - name: Get package.json version
+        id: package-version
+        run: echo "packageVersion=$(npm pkg get version | tr -d '\"')" >> "$GITHUB_OUTPUT"
+      - name: Get tag version
+        id: tag-version
+        run: |
+          if [[ "${{ github.event.inputs.version }}" != "" ]]; then
+            echo "tagVersion=${{ github.event.inputs.version }}"
+          else
+            echo "tagVersion=${{ github.ref_name }}"
+          fi >> "$GITHUB_OUTPUT"
+      - name: Confirm tag version matches package.json version
+        run: |
+          echo "Tag version: ${{ steps.tag-version.outputs.tagVersion }}"
+          echo "Package.json version: v${{ steps.package-version.outputs.packageVersion }}"
+          test "${{ steps.tag-version.outputs.tagVersion }}" == "v${{ steps.package-version.outputs.packageVersion }}"
+      - name: Notify release in progress in Slack
+        uses: slackapi/slack-github-action@v2
+        with:
+          method: chat.postMessage
+          token: ${{ secrets.SLACK_BOT_KEY }}
+          payload: |
+            {
+              "channel": "#development-ci",
+              "text": "Harper ${{ steps.tag-version.outputs.tagVersion }} release in progress",
+              "blocks": [
+                {
+                  "type": "header",
+                  "text": {
+                    "type": "plain_text",
+                    "text": "Harper ${{ steps.tag-version.outputs.tagVersion }} release"
+                  }
+                },
+                {
+                  "type": "context",
+                  "elements": [
+                    {
+                      "type": "mrkdwn",
+                      "text": "*Status*"
+                    },
+                    {
+                      "type": "mrkdwn",
+                      "text": ":hourglass_flowing_sand: In progress"
+                    },
+                    {
+                      "type": "mrkdwn",
+                      "text": "<${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|Workflow run ${{ github.run_id }}>"
+                    }
+                  ]
+                }
+              ]
+            }
+      - name: Package Harper
+        run: npm run package
+      - name: Get version components
+        id: version-components
+        uses: matt-usurp/validate-semver@v2
+        with:
+          version: ${{ steps.tag-version.outputs.tagVersion }}
+      - name: Create Release
+        id: create-release
+        uses: softprops/action-gh-release@v2
+        with:
+          name: ${{ steps.tag-version.outputs.tagVersion }}
+          tag_name: ${{ steps.tag-version.outputs.tagVersion }}
+          files: harperfast-harper-*.tgz
+          fail_on_unmatched_files: true
+          generate_release_notes: true
+          prerelease: ${{ steps.version-components.outputs.prerelease != '' }}
+          draft: true
+          make_latest: ${{ github.event.inputs.draft == 'false' && steps.version-components.outputs.prerelease == '' }}
+
+  send-slack-message-on-success:
+    if: success() && !cancelled()
+    needs: [create-release]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: slackapi/slack-github-action@v2
+        with:
+          method: chat.postMessage
+          token: ${{ secrets.SLACK_BOT_KEY }}
+          payload: |
+            {
+              "channel": "#development-ci",
+              "text": "Harper v${{ needs.create-release.outputs.harper-version }} draft release created",
+              "blocks": [
+                {
+                  "type": "header",
+                  "text": {
+                    "type": "plain_text",
+                    "text": "Harper v${{ needs.create-release.outputs.harper-version }} release"
+                  }
+                },
+                {
+                  "type": "context",
+                  "elements": [
+                    {
+                      "type": "mrkdwn",
+                      "text": "*Status*"
+                    },
+                    {
+                      "type": "mrkdwn",
+                      "text": ":github: Draft release waiting for review"
+                    },
+                    {
+                      "type": "mrkdwn",
+                      "text": "<${{ needs.create-release.outputs.draft-release-url }}|Review draft release>"
+                    }
+                  ]
+                }
+              ]
+            }
+
+  send-slack-message-on-failure:
+    if: failure() && !cancelled()
+    needs: [create-release]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: slackapi/slack-github-action@v2
+        with:
+          method: chat.postMessage
+          token: ${{ secrets.SLACK_BOT_KEY }}
+          payload: |
+            {
+              "channel": "#development-ci",
+              "text": "Harper v${{ needs.create-release.outputs.harper-version }} release failed",
+              "blocks": [
+                {
+                  "type": "header",
+                  "text": {
+                    "type": "plain_text",
+                    "text": "Harper v${{ needs.create-release.outputs.harper-version }} release"
+                  }
+                },
+                {
+                  "type": "context",
+                  "elements": [
+                    {
+                      "type": "mrkdwn",
+                      "text": "*Status*"
+                    },
+                    {
+                      "type": "mrkdwn",
+                      "text": ":x: Failed"
+                    },
+                    {
+                      "type": "mrkdwn",
+                      "text": "<${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|Workflow run ${{ github.run_id }}>"
+                    }
+                  ]
+                }
+              ]
+            }

package/core/.github/workflows/notify-release-published.yaml

@@ -0,0 +1,50 @@
+name: Notify release published
+
+on:
+  release:
+    types: [published]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  notify-slack:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Send Slack release published notification
+        uses: slackapi/slack-github-action@v2
+        with:
+          method: chat.postMessage
+          token: ${{ secrets.SLACK_BOT_KEY }}
+          payload: |
+            {
+              "channel": "#development-ci",
+              "text": "Harper v${{ github.event.release.tag_name }} GitHub release published",
+              "blocks": [
+                {
+                  "type": "header",
+                  "text": {
+                    "type": "plain_text",
+                    "text": "Harper v${{ github.event.release.tag_name }} release"
+                  }
+                },
+                {
+                  "type": "context",
+                  "elements": [
+                    {
+                      "type": "mrkdwn",
+                      "text": "*Status*"
+                    },
+                    {
+                      "type": "mrkdwn",
+                      "text": ":white_check_mark: Release approved and published on :github:"
+                    },
+                    {
+                      "type": "mrkdwn",
+                      "text": "<${{ github.event.release.html_url }}|GitHub release>"
+                    }
+                  ]
+                }
+              ]
+            }

package/core/.github/workflows/publish-docker.yaml

@@ -0,0 +1,174 @@
+name: Publish Docker Image
+
+on:
+  release:
+    types: [published]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ${{ matrix.runner }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - platform: linux/amd64
+            runner: ubuntu-latest
+          - platform: linux/arm64
+            runner: ubuntu-24.04-arm
+    steps:
+      - uses: actions/checkout@v6
+      - name: Setup Docker metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: harperfast/harper
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ vars.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Setup Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Build and push by digest
+        id: build
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          platforms: ${{ matrix.platform }}
+          labels: ${{ steps.meta.outputs.labels }}
+          outputs: type=image,name=harperfast/harper,push-by-digest=true,name-canonical=true,push=true
+      - name: Export digest
+        run: |
+          mkdir -p /tmp/digests
+          digest="${{ steps.build.outputs.digest }}"
+          touch "/tmp/digests/${digest#sha256:}"
+      - name: Upload digest
+        uses: actions/upload-artifact@v4
+        with:
+          name: digest-${{ matrix.platform == 'linux/amd64' && 'amd64' || 'arm64' }}
+          path: /tmp/digests/*
+          if-no-files-found: error
+          retention-days: 1
+
+  merge:
+    runs-on: ubuntu-latest
+    needs: [build]
+    outputs:
+      docker-image-tag: ${{ steps.meta.outputs.version }}
+    steps:
+      - name: Download digests
+        uses: actions/download-artifact@v4
+        with:
+          path: /tmp/digests
+          pattern: digest-*
+          merge-multiple: true
+      - name: Setup Docker metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: harperfast/harper
+          tags: |
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ vars.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Create manifest list and push
+        working-directory: /tmp/digests
+        run: |
+          docker buildx imagetools create $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \
+            $(printf 'harperfast/harper@sha256:%s ' *)
+      - name: Inspect image
+        run: |
+          docker buildx imagetools inspect harperfast/harper:${{ steps.meta.outputs.version }}
+
+  send-slack-message-on-success:
+    if: success() && !cancelled()
+    needs: [merge]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Send Slack published notification
+        uses: slackapi/slack-github-action@v2
+        with:
+          method: chat.postMessage
+          token: ${{ secrets.SLACK_BOT_KEY }}
+          payload: |
+            {
+              "channel": "#development-ci",
+              "text": "Harper v${{ needs.merge.outputs.docker-image-tag }} has been published to Docker Hub",
+              "blocks": [
+                {
+                  "type": "header",
+                  "text": {
+                    "type": "plain_text",
+                    "text": "Harper v${{ needs.merge.outputs.docker-image-tag }} release"
+                  }
+                },
+                {
+                  "type": "context",
+                  "elements": [
+                    {
+                      "type": "mrkdwn",
+                      "text": "*Status*"
+                    },
+                    {
+                      "type": "mrkdwn",
+                      "text": ":white_check_mark: Published to :docker_logo:"
+                    },
+                    {
+                      "type": "mrkdwn",
+                      "text": "<https://hub.docker.com/layers/harperfast/harper/${{ needs.merge.outputs.docker-image-tag }}|harperfast/harper:${{ needs.merge.outputs.docker-image-tag }}>"
+                    }
+                  ]
+                }
+              ]
+            }
+
+  send-slack-message-on-failure:
+    if: failure() && !cancelled()
+    needs: [merge]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: slackapi/slack-github-action@v2
+        with:
+          method: chat.postMessage
+          token: ${{ secrets.SLACK_BOT_KEY }}
+          payload: |
+            {
+              "channel": "#development-ci",
+              "text": "Harper v${{ needs.merge.outputs.docker-image-tag }} Docker publish failed",
+              "blocks": [
+                {
+                  "type": "header",
+                  "text": {
+                    "type": "plain_text",
+                    "text": "Harper v${{ needs.merge.outputs.docker-image-tag }} release"
+                  }
+                },
+                {
+                  "type": "context",
+                  "elements": [
+                    {
+                      "type": "mrkdwn",
+                      "text": "*Status*"
+                    },
+                    {
+                      "type": "mrkdwn",
+                      "text": ":x: Failed to publish to :docker_logo:"
+                    },
+                    {
+                      "type": "mrkdwn",
+                      "text": "<${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|Workflow run ${{ github.run_id }}>"
+                    }
+                  ]
+                }
+              ]
+            }

package/core/.github/workflows/publish-npm.yaml

@@ -0,0 +1,173 @@
+name: Publish NPM Package
+
+on:
+  release:
+    types: [published]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  publish-harper-npm-package:
+    runs-on: ubuntu-latest
+    outputs:
+      harper-version: ${{ steps.version-components.outputs.version }}
+    steps:
+      - uses: actions/setup-node@v6
+        with:
+          node-version: latest
+          registry-url: 'https://registry.npmjs.org'
+      - uses: actions/checkout@v6
+      - name: Get release build
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: gh release download ${{ github.event.release.tag_name }} --pattern "harper-*.tgz"
+      - name: Get version components
+        id: version-components
+        uses: matt-usurp/validate-semver@v2
+        with:
+          version: ${{ github.event.release.tag_name }}
+      - name: Set package tag
+        id: package-tag
+        run: |
+          if [[ "${{ steps.version-components.outputs.prerelease }}" == '' ]]; then
+            echo "packageTag=latest" >> "$GITHUB_OUTPUT"
+          else
+            echo "packageTag=next" >> "$GITHUB_OUTPUT"
+          fi
+      - name: Publish package to NPM registry
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_ACCESS_KEY }}
+        run: npm publish --access=public --tag=${{ steps.package-tag.outputs.packageTag }} harper-*.tgz
+
+  publish-harperfast-npm-package:
+    runs-on: ubuntu-latest
+    outputs:
+      harper-version: ${{ steps.version-components.outputs.version }}
+    steps:
+      - uses: actions/setup-node@v6
+        with:
+          node-version: latest
+          registry-url: 'https://registry.npmjs.org'
+      - uses: actions/checkout@v6
+      - name: Get release build
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: gh release download ${{ github.event.release.tag_name }} --pattern "harper-*.tgz"
+      - name: Get version components
+        id: version-components
+        uses: matt-usurp/validate-semver@v2
+        with:
+          version: ${{ github.event.release.tag_name }}
+      - name: Rename package to '@harperfast/harper'
+        run: |
+          mkdir package
+          tar -xvf harper-${{ steps.version-components.outputs.version }}.tgz -C package --strip-components=1
+          pushd package
+          npm pkg set name=@harperfast/harper
+          popd
+          tar -czvf harperfast-harper-${{ steps.version-components.outputs.version }}.tgz package
+      - name: Set package tag
+        id: package-tag
+        run: |
+          if [[ "${{ steps.version-components.outputs.prerelease }}" == '' ]]; then
+            echo "packageTag=latest" >> "$GITHUB_OUTPUT"
+          else
+            echo "packageTag=next" >> "$GITHUB_OUTPUT"
+          fi
+      - name: Publish package to NPM registry
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_ACCESS_KEY }}
+        run: npm publish --access=public --tag=${{ steps.package-tag.outputs.packageTag }} harperfast-harper-*.tgz
+
+  send-slack-message-on-success:
+    if: success() && !cancelled()
+    needs:
+      - publish-harperfast-npm-package
+      - publish-harper-npm-package
+    runs-on: ubuntu-latest
+    steps:
+      - name: Send Slack published notification
+        uses: slackapi/slack-github-action@v2
+        with:
+          method: chat.postMessage
+          token: ${{ secrets.SLACK_BOT_KEY }}
+          payload: |
+            {
+              "channel": "#development-ci",
+              "text": "Harper v${{ needs.publish-harper-npm-package.outputs.harper-version }} has been published to NPM",
+              "blocks": [
+                {
+                  "type": "header",
+                  "text": {
+                    "type": "plain_text",
+                    "text": "Harper v${{ needs.publish-harper-npm-package.outputs.harper-version }} release"
+                  }
+                },
+                {
+                  "type": "context",
+                  "elements": [
+                    {
+                      "type": "mrkdwn",
+                      "text": "*Status*"
+                    },
+                    {
+                      "type": "mrkdwn",
+                      "text": ":white_check_mark: Published to :npm:"
+                    },
+                    {
+                      "type": "mrkdwn",
+                      "text": "<https://www.npmjs.com/package/harper/v/${{ needs.publish-harper-npm-package.outputs.harper-version }}|harper@${{ needs.publish-harper-npm-package.outputs.harper-version }}>"
+                    },
+                    {
+                      "type": "mrkdwn",
+                      "text": "<https://www.npmjs.com/package/@harperfast/harperfast/v/${{ needs.publish-harperfast-npm-package.outputs.harper-version }}|@harperfast/harper@${{ needs.publish-harperfast-npm-package.outputs.harper-version }}>"
+                    }
+                  ]
+                }
+              ]
+            }
+
+  send-slack-message-on-failure:
+    if: failure() && !cancelled()
+    needs:
+      - publish-harperfast-npm-package
+      - publish-harper-npm-package
+    runs-on: ubuntu-latest
+    steps:
+      - uses: slackapi/slack-github-action@v2
+        with:
+          method: chat.postMessage
+          token: ${{ secrets.SLACK_BOT_KEY }}
+          payload: |
+            {
+              "channel": "#development-ci",
+              "text": "Harper v${{ needs.publish-harper-npm-package.outputs.harper-version }} NPM publish failed",
+              "blocks": [
+                {
+                  "type": "header",
+                  "text": {
+                    "type": "plain_text",
+                    "text": "Harper v${{ needs.publish-harper-npm-package.outputs.harper-version }} release"
+                  }
+                },
+                {
+                  "type": "context",
+                  "elements": [
+                    {
+                      "type": "mrkdwn",
+                      "text": "*Status*"
+                    },
+                    {
+                      "type": "mrkdwn",
+                      "text": ":x: Failed to publish to :npm:"
+                    },
+                    {
+                      "type": "mrkdwn",
+                      "text": "<${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|Workflow run ${{ github.run_id }}>"
+                    }
+                  ]
+                }
+              ]
+            }

package/core/CONTRIBUTING.md

@@ -55,6 +55,8 @@ These are the steps @Ethan-Arrowood has been following to synchronize the reposi
 >
 > # Only fetch `main` branch
 > git config remote.old.fetch '+refs/heads/main:refs/remotes/old/main'
+> # Don't fetch tags
+> git config remote.old.tagOpt '--no-tags'
 > ```
 
 1. Make sure local `main` branch is checked out and clean `git checkout main && git status`.

package/core/bin/harper.js

@@ -118,8 +118,14 @@ async function harper() {
 					process.env.RUN_HDB_APP = appFolder;
 				}
 			} else if (fs.existsSync(hdbTerms.HDB_COMPONENT_CONFIG_FILE) || fs.existsSync('schema.graphql')) {
+				console.warn(
+					`It appears you are running Harper Pro in an application directory, but did not specify the path. I'll go ahead and run the application for you since that's probably what you meant. But to avoid this warning in the future, run applications in the current directory like this: "harper ${service} ."`
+				);
 				process.env.RUN_HDB_APP = '.';
 			} else if (fs.existsSync(hdbTerms.HARPER_CONFIG_FILE) || fs.existsSync(hdbTerms.HDB_CONFIG_FILE)) {
+				console.warn(
+					`It appears you are running Harper Pro in a root data directory, but did not specify the path. I'll go ahead and run Harper Pro with its root path set to "." for you since that's probably what you meant. But to avoid this warning in the future, run it like this: "harper ${service} ."`
+				);
 				process.env.ROOTPATH = '.';
 			}
 		}

package/core/components/PluginModule.ts

@@ -3,5 +3,4 @@ import { Scope } from './Scope';
 export interface PluginModule {
 	handleApplication: (scope: Scope) => void | Promise<void>;
 	defaultTimeout?: number;
-	suppressHandleApplicationWarning?: boolean;
 }

package/core/components/componentLoader.ts

@@ -99,6 +99,8 @@ for (const { name, packageIdentifier } of getEnvBuiltInComponents()) {
 	TRUSTED_RESOURCE_PLUGINS[name] = packageIdentifier;
 }
 
+const BUILT_INS = Object.keys(TRUSTED_RESOURCE_PLUGINS);
+
 const portsStarted = [];
 export const loadedPaths = new Map();
 let errorReporter;
@@ -356,10 +358,6 @@ export async function loadComponent(
 
 				// New Plugin API (`handleApplication`)
 				if (resources.isWorker && extensionModule.handleApplication) {
-					if (extensionModule.suppressHandleApplicationWarning !== true) {
-						harperLogger.warn(`Plugin ${componentName} is using the experimental handleApplication API`);
-					}
-
 					const scope = new Scope(componentName, componentDirectory, configPath, resources, server);
 					if (options.applicationContainment) scope.applicationContainment = options.applicationContainment;
 
@@ -372,6 +370,20 @@ export async function loadComponent(
 				}
 
 				// Old Extension API (`start` or `startOnMainThread`)
+				if (
+					!BUILT_INS.includes(componentName) &&
+					('startOnMainThread' in extensionModule ||
+						'start' in extensionModule ||
+						'handleFile' in extensionModule ||
+						'handleDirectory' in extensionModule ||
+						'setupFile' in extensionModule ||
+						'setupDirectory' in extensionModule)
+				) {
+					harperLogger.warn?.(
+						`Component ${componentName} is using deprecated extension API. Upgrade to the new Plugin API. For more information: https://docs.harperdb.io/docs/reference/components/plugins`
+					);
+				}
+
 				if (isMainThread) {
 					extensionModule =
 						(await extensionModule.startOnMainThread?.({