feat: bundle format_exception rather than all helpers (#571)

* feat: bundle format_exception rather than all helpers

* fix: install pnpm for script

* fix: use js

* Revert "fix: use js"

This reverts commit 7f7c6b6.

* fix: exported types

Exporting a const forces TS to decide what type the const is. This is important because that type is declared and the declaration does not appear in the output

Author: ojeytonwilliams

.github/workflows/ci.yml

@@ -52,11 +52,17 @@ jobs:
       # Checkout the Repo
       - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
 
+      # Just to run the script
+      - name: Install pnpm
+        uses: pnpm/action-setup@41ff72655975bd51cab0327fa583b6e92b6d3061 # v4
+        with:
+          version: 10
+
       # Install Python
       - name: Setup Python
         uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
         with:
           python-version: 3.x
 
       - name: Run Tests
-        run: python ./packages/helpers/python/py_helpers.test.py
+        run: pnpm run test:python

package.json

@@ -13,14 +13,14 @@
   ],
   "exports": {
     ".": {
-      "types": "./dist/types/helpers/lib/index.d.ts",
-      "require": "./dist/curriculum-helpers/index.cjs",
-      "default": "./dist/curriculum-helpers/index.mjs"
+      "types": "./dist/types/helpers/python/index.d.ts",
+      "require": "./dist/curriculum-helpers/format-exception.cjs",
+      "default": "./dist/curriculum-helpers/format-exception.mjs"
     },
-    "./helpers.js": {
-      "types": "./dist/types/helpers/lib/index.d.ts",
-      "require": "./dist/curriculum-helpers/index.cjs",
-      "default": "./dist/curriculum-helpers/index.mjs"
+    "./format-exception.js": {
+      "types": "./dist/types/helpers/python/index.d.ts",
+      "require": "./dist/curriculum-helpers/format-exception.cjs",
+      "default": "./dist/curriculum-helpers/format-exception.mjs"
     },
     "./test-runner.js": {
       "types": "./dist/types/main/src/index.d.ts",
@@ -95,6 +95,7 @@
     "test": "vitest",
     "test:unit": "vitest --config vitest.unit.config.mjs",
     "test:integration": "vitest --config vitest.integration.config.mjs",
+    "test:python": "python ./packages/helpers/python/python.test.py",
     "prepare": "husky install",
     "prepublishOnly": "pnpm clean:build && pnpm build",
     "webpack": "webpack"

packages/helpers/python/format_exception.py

@@ -0,0 +1,38 @@
+# Exception formatting functions for Python error messages
+
+
+def drop_until(*, traces, filename):
+    from itertools import dropwhile
+
+    return list(
+        dropwhile(lambda line: not line.startswith(f'  File "{filename}"'), traces)
+    )
+
+
+def build_message(*, traces, exception_list):
+    return "".join(["Traceback (most recent call last):\n"] + traces + exception_list)
+
+
+def _replace_startswith(string, old, new):
+    if string.startswith(old):
+        return new + string[len(old) :]
+    return string
+
+
+def format_exception(*, exception, traceback, filename, new_filename=None):
+    if new_filename is None:
+        new_filename = filename
+    from traceback import format_exception_only, format_tb
+
+    # The trace up to "filename" are the frames that are not part of the user's
+    # code so we drop them.
+    traces = drop_until(traces=format_tb(traceback), filename=filename)
+    renamed_traces = [
+        _replace_startswith(trace, f'  File "{filename}"', f'  File "{new_filename}"')
+        for trace in traces
+    ]
+    renamed_exception = [
+        _replace_startswith(e, f'  File "{filename}"', f'  File "{new_filename}"')
+        for e in format_exception_only(exception)
+    ]
+    return build_message(traces=renamed_traces, exception_list=renamed_exception)

packages/helpers/python/index.ts

@@ -0,0 +1,3 @@
+import formatExceptionCode from "./format_exception.py";
+
+export const formatException = formatExceptionCode;

packages/helpers/python/py_helpers.py

@@ -547,45 +547,3 @@ def is_ordered(self, *args):
         if None in arg_dict.values():
             return False
         return all(arg_dict[n] < arg_dict[n + 1] for n in range(len(arg_dict) - 1))
-
-
-# Exception formatting functions. Currently bundled with the Node class, until
-# we improve the testing, building and CI so that they can easily handle
-# multiple files.
-
-
-def drop_until(*, traces, filename):
-    from itertools import dropwhile
-
-    return list(
-        dropwhile(lambda line: not line.startswith(f'  File "{filename}"'), traces)
-    )
-
-
-def build_message(*, traces, exception_list):
-    return "".join(["Traceback (most recent call last):\n"] + traces + exception_list)
-
-
-def _replace_startswith(string, old, new):
-    if string.startswith(old):
-        return new + string[len(old) :]
-    return string
-
-
-def format_exception(*, exception, traceback, filename, new_filename=None):
-    if new_filename is None:
-        new_filename = filename
-    from traceback import format_exception_only, format_tb
-
-    # The trace up to "filename" are the frames that are not part of the user's
-    # code so we drop them.
-    traces = drop_until(traces=format_tb(traceback), filename=filename)
-    renamed_traces = [
-        _replace_startswith(trace, f'  File "{filename}"', f'  File "{new_filename}"')
-        for trace in traces
-    ]
-    renamed_exception = [
-        _replace_startswith(e, f'  File "{filename}"', f'  File "{new_filename}"')
-        for e in format_exception_only(exception)
-    ]
-    return build_message(traces=renamed_traces, exception_list=renamed_exception)

…ckages/helpers/python/py_helpers.test.py packages/helpers/python/python.test.pypackages/helpers/python/py_helpers.test.py renamed to packages/helpers/python/python.test.py packages/helpers/python/py_helpers.test.py renamed to packages/helpers/python/python.test.py

@@ -1,7 +1,8 @@
 import unittest
 import ast
 import sys
-from py_helpers import Node, drop_until, build_message, format_exception
+from py_helpers import Node
+from format_exception import drop_until, build_message, format_exception
 
 
 class TestConstructor(unittest.TestCase):

webpack.config.js

@@ -1,9 +1,12 @@
 const path = require("path");
 const webpack = require("webpack");
 
-const baseConfig = {
+const formatExceptionBaseConfig = {
   entry: {
-    index: path.resolve(__dirname, "packages/helpers/lib/index.ts"),
+    "format-exception": path.resolve(
+      __dirname,
+      "packages/helpers/python/index.ts",
+    ),
   },
   module: {
     rules: [
@@ -29,29 +32,29 @@ const baseConfig = {
   },
 };
 
-const nodeConfig = (env = {}) => {
+const formatExceptionNodeConfig = (env = {}) => {
   const isDev = env.development;
   return {
-    ...baseConfig,
-    name: "helpers-commonjs",
+    ...formatExceptionBaseConfig,
+    name: "format-exception-commonjs",
     mode: isDev ? "development" : "production",
     devtool: !isDev ? "source-map" : "inline-source-map",
     target: "node",
     output: {
       library: {
         type: "commonjs",
       },
-      filename: "index.cjs",
+      filename: "[name].cjs",
       path: path.resolve(__dirname, "dist/curriculum-helpers"),
     },
   };
 };
 
-const browserConfig = (env = {}) => {
+const formatExceptionBrowserConfig = (env = {}) => {
   const isDev = env.development;
   return {
-    ...baseConfig,
-    name: "helpers-browser",
+    ...formatExceptionBaseConfig,
+    name: "format-exception-browser",
     mode: isDev ? "development" : "production",
     devtool: !isDev ? "source-map" : "inline-source-map",
     target: "web",
@@ -62,7 +65,7 @@ const browserConfig = (env = {}) => {
       library: {
         type: "module",
       },
-      filename: "index.mjs",
+      filename: "[name].mjs",
       path: path.resolve(__dirname, "dist/curriculum-helpers"),
     },
   };
@@ -178,4 +181,8 @@ const testRunnerConfigs = entrypointSources.map(({ name, path, isWorker }) => {
   return testRunnerConfig(entry, name, isWorker);
 });
 
-module.exports = [nodeConfig, browserConfig, ...testRunnerConfigs];
+module.exports = [
+  formatExceptionNodeConfig,
+  formatExceptionBrowserConfig,
+  ...testRunnerConfigs,
+];