@sdeverywhere/plugin-check 0.1.0

package/template-report/src/overlay.ts

@@ -0,0 +1,32 @@
+// Copyright (c) 2022 Climate Interactive / New Venture Fund
+
+import messagesHtml from '@_prep_/messages.html?raw'
+
+// This constant is exported only for HMR handling within this file; it is
+// not intended to be consumed by outside modules
+export const messages = messagesHtml
+
+// Note that this initialization of the dev overlay component is kept in a
+// separate file so that updates to `messages.html` cause HMR to reload only
+// this file and the overlay element (rather than reloading the entire app)
+export function initOverlay(): void {
+  updateOverlay(messages)
+}
+
+function updateOverlay(m: string): void {
+  const content = document.getElementById('overlay-content')
+  content.style.display = m && m.length > 0 ? 'unset' : 'none'
+  const text = document.getElementById('overlay-text')
+  text.innerHTML = m
+}
+
+// In dev mode (with HMR enabled), when the `messages.html` file is updated,
+// reload its contents into the overlay here instead of having the change
+// event propagate up to the app shell.  This makes the HMR event more
+// precise and makes the text change show up immediately without having
+// to reload other parts of the app.
+if (import.meta.hot) {
+  import.meta.hot.accept(newModule => {
+    updateOverlay(newModule.messages)
+  })
+}

package/template-report/src/url-polyfill.ts

@@ -0,0 +1,10 @@
+// Copyright (c) 2022 Climate Interactive / New Venture Fund
+
+// XXX: This is a workaround for an issue in which threads.js uses `fileURLToPath`
+// (from Node's 'util' module), but that function is not included in the
+// `rollup-plugin-node-polyfills` package we use in the Vite config, so we roll
+// our own no-op polyfill here.  This does not actually get used at runtime
+// in the browser because it is only referenced in the (unused) Node code path.
+export function fileURLToPath(s: string): string {
+  return s
+}

package/template-report/tsconfig.json

@@ -0,0 +1,31 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    // Use "es2020" for dynamic import
+    "module": "es2020",
+    // Emit additional JS to ease support for importing CommonJS modules
+    "esModuleInterop": true,
+    // Use Node.js-style module resolution
+    "moduleResolution": "node",
+    // Enable warnings for transpilation-unsafe code
+    "isolatedModules": true,
+    // Enable strict enforcement of `import type`
+    "importsNotUsedAsValues": "error",
+    "noImplicitAny": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    // "types": ["vite/client", "vite-plugin-glob/client"],
+    "types": ["vite/client"],
+    "skipLibCheck": true,
+    // Use placeholders for path aliases that are configured in the Vite
+    // config; this prevents TypeScript from complaining but still allows
+    // for plugging in "real" files later
+    "baseUrl": ".",
+    "paths": {
+      "@_baseline_bundle_": ["./src/empty-bundle.ts"],
+      "@_current_bundle_": ["./src/empty-bundle.ts"],
+      "@_test_config_": ["./src/empty-test-config.ts"],
+      "@_prep_": ["./src"]
+    }
+  }
+}

package/template-tests/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@sdeverywhere/check-core": "^0.1.0"
+  }
+}

package/template-tests/src/env.d.ts

@@ -0,0 +1,5 @@
+// Copyright (c) 2022 Climate Interactive / New Venture Fund
+
+// These values are injected by Vite at build time, so we need to
+// declare types for them here
+declare const __YAML_PATH__: string

package/template-tests/src/index.ts

@@ -0,0 +1,82 @@
+// Copyright (c) 2022 Climate Interactive / New Venture Fund
+
+import type { Bundle, CompareOptions, ConfigOptions, DatasetKey } from '@sdeverywhere/check-core'
+
+import { DatasetManager, ScenarioManager } from '@sdeverywhere/check-core'
+
+// Load the yaml test files.  Note that we use `vite-plugin-glob` here
+// instead of Vite's built-in `import.meta.globEager` because the plugin
+// does a better job of handling HMR when the yaml files are outside of
+// the `template-report` app root directory.
+const yamlGlob = import.meta.importGlob(__YAML_PATH__, {
+  eager: true,
+  as: 'raw'
+})
+const tests: string[] = []
+for (const yamlKey of Object.keys(yamlGlob)) {
+  const yaml = yamlGlob[yamlKey]
+  tests.push(yaml as unknown as string)
+}
+
+// If an output variable is renamed, define the mapping from the old key
+// to the new key here.  If this step is omitted, the old variable will
+// appear as being removed and the new variable will appear as being added,
+// which will prevent them from being compared.
+// TODO: Inject this from sde.config.ts file
+const renamedDatasetKeys: Map<DatasetKey, DatasetKey> = new Map([
+  // ['Model_old_name', 'Model_new_name']
+])
+
+export interface BundleOptions {
+  nameL?: string
+  nameR?: string
+}
+
+// TODO: Make this pluggable (with default implementation similar to below)
+export async function getConfigOptions(
+  bundleL: Bundle | undefined,
+  bundleR: Bundle,
+  opts: BundleOptions
+): Promise<ConfigOptions> {
+  // Only include compare options if the baseline bundle is defined (and
+  // has the same version)
+  let compareOptions: CompareOptions
+  if (bundleL && bundleL.version === bundleR.version) {
+    // Configure the set of input scenarios used for comparisons.  This includes
+    // the default matrix of scenarios; for any output variable, the model will
+    // be run:
+    //   - once with all inputs at their default
+    //   - once with all inputs at their minimum
+    //   - once with all inputs at their maximum
+    //   - twice for each input
+    //       - once with single input at its minimum
+    //       - once with single input at its maximum
+    const scenarios = new ScenarioManager(bundleL, bundleR)
+    scenarios.addScenarioMatrix()
+
+    // Configure the dataset keys (corresponding to the available model outputs
+    // in the given bundles) that can be used to compare two versions of the model
+    const datasets = new DatasetManager(bundleL, bundleR, renamedDatasetKeys)
+
+    compareOptions = {
+      baseline: {
+        name: opts?.nameL || 'baseline',
+        bundle: bundleL
+      },
+      thresholds: [1, 5, 10],
+      scenarios,
+      datasets
+    }
+  }
+
+  return {
+    current: {
+      name: opts?.nameR || 'current',
+      bundle: bundleR
+    },
+    check: {
+      tests
+    },
+    compare: compareOptions
+  }
+}

package/template-tests/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    // Use "es2020" for dynamic import
+    "module": "es2020",
+    // Emit additional JS to ease support for importing CommonJS modules
+    "esModuleInterop": true,
+    // Use Node.js-style module resolution
+    "moduleResolution": "node",
+    // Enable warnings for transpilation-unsafe code
+    "isolatedModules": true,
+    // Enable strict enforcement of `import type`
+    "importsNotUsedAsValues": "error",
+    "noImplicitAny": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "types": ["vite-plugin-glob/client"]
+  }
+}