Review fixes: defaultConfig, typo, use pathJoin...

Author: arildm

src/api/analysis.ts

@@ -1,54 +1,7 @@
 import { once } from "es-toolkit";
-import { ensureTrailingSlash } from "@/util";
+import { pathJoin } from "@/util";
 import type { ByLang } from "@/util.types";
 
-// TODO Remove?
-export type AnnotationGroup =
-  | "saldo"
-  | "msd"
-  | "syntax"
-  | "readability"
-  | "wsd"
-  | "sensaldo"
-  | "lexicalClasses"
-  | "swener";
-
-// TODO Remove?
-export const baseAnalyses = [
-  "sbx-swe-sentence-sparv-storsuc",
-  "sbx-swe-tokenization-sparv-betterword",
-];
-
-// TODO Remove?
-export const analysisListing: Record<AnnotationGroup, string[]> = {
-  saldo: [
-    "sbx-swe-compound-sparv-saldolemgram",
-    "sbx-swe-compound-sparv-saldowords",
-    "sbx-swe-lemgram-sparv-saldo",
-    "sbx-swe-lemmatization-sparv-saldo2",
-  ],
-  msd: [
-    "sbx-swe-msd-stanza-stanzamorph-suc3",
-    "sbx-swe-msd-stanza-stanzamorph-ufeats",
-    "sbx-swe-pos-stanza-stanzamorph",
-  ],
-  syntax: ["sbx-swe-dependency-stanza-stanzasynt"],
-  readability: [
-    "sbx-swe-readability-sparv-lix",
-    "sbx-swe-readability-sparv-nk",
-    "sbx-swe-readability-sparv-ovix",
-  ],
-  wsd: ["sbx-swe-sense-sparv"],
-  sensaldo: ["sbx-swe-sentiment-sparv-sensaldo"],
-  lexicalClasses: [
-    "sbx-swe-lexical_classes_text-sparv-blingbring",
-    "sbx-swe-lexical_classes_text-sparv-swefn",
-    "sbx-swe-lexical_classes_token-sparv-blingbring",
-    "sbx-swe-lexical_classes_token-sparv-swefn",
-  ],
-  swener: ["sbx-swe-namedentity-swener", "sbx-swe-geotagcontext-sparv"],
-};
-
 export type AnalysisId = string;
 
 /** Suggested annotation definitions for each known analysis id. */
@@ -103,13 +56,12 @@ export const annotationAnalyses: Readonly<Record<string, AnalysisId>> =
     ),
   );
 
-export const loadAnalysisMetdata = once(async () => {
-  const urlRaw = import.meta.env.VITE_METADATA_URL;
-  if (!urlRaw) throw new Error("Missing VITE_METADATA_URL");
-
-  const url = ensureTrailingSlash(urlRaw);
+export const loadAnalysisMetadata = once(async () => {
+  const url = import.meta.env.VITE_METADATA_URL;
+  if (!url) throw new Error("Missing VITE_METADATA_URL");
 
-  const response = await fetch(url + "analyses");
+  console.log(pathJoin(url, "analyses"));
+  const response = await fetch(pathJoin(url, "analyses"));
   const data = (await response.json()) as AnalysisMetadataResponse;
   return data.resources.filter(
     (resource) =>

src/api/corpusConfig.test.ts

@@ -72,22 +72,22 @@ describe("makeConfig", () => {
 });
 
 describe("parseConfig", () => {
-  test("handle minimal info", async () => {
+  test("handle minimal info", () => {
     const configYaml = Yaml.dump({
       import: { importer: "text_import:parse" },
     });
-    const config = await parseConfig(configYaml);
+    const config = parseConfig(configYaml);
     expect(config.format).toBe("txt");
   });
 
   test("requires format", () => {
     const configYaml = Yaml.dump({
       metadata: { name: { swe: "Nyheter", eng: "News" } },
     });
-    expect(() => parseConfig(configYaml)).rejects.toThrowError();
+    expect(() => parseConfig(configYaml)).toThrowError();
   });
 
-  test("handle full info", async () => {
+  test("handle full info", () => {
     const configYaml = Yaml.dump({
       metadata: {
         name: { swe: "Nyheter", eng: "News" },
@@ -106,7 +106,7 @@ describe("parseConfig", () => {
         annotations: ["<text>:readability.lix", "swener.ne"],
       },
     });
-    const config = await parseConfig(configYaml);
+    const config = parseConfig(configYaml);
     const expected: ConfigOptions = {
       format: "xml",
       name: { swe: "Nyheter", eng: "News" },

src/api/corpusConfig.ts

@@ -2,7 +2,7 @@ import Yaml from "js-yaml";
 import {
   analysisAnnotations,
   annotationAnalyses,
-  loadAnalysisMetdata,
+  loadAnalysisMetadata,
   type AnalysisId,
 } from "./analysis";
 import type {
@@ -149,27 +149,33 @@ export function makeConfig(id: string, options: ConfigOptions): string {
   return Yaml.dump(config as SparvConfig, { noArrayIndent: true });
 }
 
-/** Default values */
-export async function emptyConfig(): Promise<ConfigOptions> {
-  // Let all analyses be enabled by default, except NER because it is heavy, and Geo because it depends on NER.
-  const disabledAnalyses = [
-    "sbx-swe-namedentity-swener",
-    "sbx-swe-geotagcontext-sparv",
-  ];
+/** A minimal config */
+export function emptyConfig(): ConfigOptions {
   return {
     name: { swe: "", eng: "" },
     description: { swe: "", eng: "" },
     format: "txt",
     datetime: undefined,
-    analyses: Object.fromEntries(
-      (await loadAnalysisMetdata()).map((analysis) => [
-        analysis.id,
-        !disabledAnalyses.includes(analysis.id),
-      ]),
-    ),
+    analyses: {},
   };
 }
 
+/** Default config */
+export async function defaultConfig(): Promise<ConfigOptions> {
+  // Let all analyses be enabled by default, except NER because it is heavy, and Geo because it depends on NER.
+  const disabledAnalyses = [
+    "sbx-swe-namedentity-swener",
+    "sbx-swe-geotagcontext-sparv",
+  ];
+
+  const config = emptyConfig();
+
+  for (const { id } of await loadAnalysisMetadata())
+    if (!disabledAnalyses.includes(id)) config.analyses[id] = true;
+
+  return config;
+}
+
 /**
  * Parse a Sparv config YAML string.
  *
@@ -178,7 +184,7 @@ export async function emptyConfig(): Promise<ConfigOptions> {
  *
  * May throw all kinds of errors, the sky is the limit (:
  */
-export async function parseConfig(configYaml: string): Promise<ConfigOptions> {
+export function parseConfig(configYaml: string): ConfigOptions {
   const config = Yaml.load(configYaml) as unknown as Partial<SparvConfig>;
 
   if (!config)
@@ -199,7 +205,7 @@ export async function parseConfig(configYaml: string): Promise<ConfigOptions> {
 
   // Build options object
   const options = {
-    ...(await emptyConfig()),
+    ...emptyConfig(),
     format,
     name,
     description: config.metadata?.description,

src/auth/sbAuth.ts

@@ -4,17 +4,13 @@
 
 import { jwtDecode } from "jwt-decode";
 import { computed, ref } from "vue";
-import {
-  deduplicateRequest,
-  ensureTrailingSlash,
-  pathJoin,
-  progressiveTimeout,
-} from "@/util";
+import { deduplicateRequest, pathJoin, progressiveTimeout } from "@/util";
 import api from "@/api/api";
 
-const AUTH_URL: string = ensureTrailingSlash(import.meta.env.VITE_AUTH_URL);
+const AUTH_URL: string = import.meta.env.VITE_AUTH_URL;
 const LOGOUT_URL: string = import.meta.env.VITE_LOGOUT_URL;
-const JWT_URL: string = import.meta.env.VITE_JWT_URL || AUTH_URL + "jwt";
+const JWT_URL: string =
+  import.meta.env.VITE_JWT_URL || pathJoin(AUTH_URL, "jwt");
 
 export type JwtSbPayload = {
   name: string;
@@ -53,7 +49,7 @@ export function getLoginUrl(redirectLocation = "") {
     import.meta.env.BASE_URL,
     redirectLocation,
   );
-  return AUTH_URL + `login?redirect=${redirectLocation}`;
+  return pathJoin(AUTH_URL, `login?redirect=${redirectLocation}`);
 }
 
 /** Checks cached JWT and updates it if needed. */

src/corpus/config/ConfigPanel.vue

@@ -4,7 +4,7 @@ import { useCorpus } from "../corpus.composable";
 import useLocale from "@/i18n/locale.composable";
 import PendingContent from "@/spin/PendingContent.vue";
 import TerminalOutput from "@/components/TerminalOutput.vue";
-import { loadAnalysisMetdata } from "@/api/analysis";
+import { loadAnalysisMetadata } from "@/api/analysis";
 
 const props = defineProps<{
   corpusId: string;
@@ -19,7 +19,7 @@ const analyses = computedAsync(async () => {
   const map = configOptions.value.analyses;
   const ids = Object.keys(map).filter((id) => map[id]);
   // Get metadata for selected analyses
-  const metadata = await loadAnalysisMetdata();
+  const metadata = await loadAnalysisMetadata();
   return metadata
     .filter((analysis) => ids.includes(analysis.id))
     .sort(thCompare((x) => x.name));
@@ -117,7 +117,10 @@ const analyses = computedAsync(async () => {
               <ul class="list-disc list-outside pl-5 mt-2">
                 <li v-for="analysis of analyses" :key="analysis.id">
                   {{ th(analysis.name) }}
-                  (<a :href="$t('analyses.url', analysis.id)" target="_blank">
+                  (<a
+                    :href="$t('config.analyses.url', analysis.id)"
+                    target="_blank"
+                  >
                     {{ analysis.id }}</a
                   >)
                 </li>

src/corpus/config/CorpusConfiguration.vue

@@ -31,7 +31,7 @@ import LayoutBox from "@/components/LayoutBox.vue";
 import TerminalOutput from "@/components/TerminalOutput.vue";
 import {
   analysisAnnotations,
-  loadAnalysisMetdata,
+  loadAnalysisMetadata,
   type AnalysisId,
 } from "@/api/analysis";
 import useLocale from "@/i18n/locale.composable";
@@ -62,7 +62,7 @@ const tabSelected = ref<TabKey>("metadata");
 
 /** List of metadata for relevant analyses */
 const analyses = computedAsync(async () => {
-  const analyses = await loadAnalysisMetdata();
+  const analyses = await loadAnalysisMetadata();
   // Skip analyses that do not have annotations
   // Sort by most significant property last
   const filtered = analyses
@@ -78,7 +78,7 @@ const analyses = computedAsync(async () => {
   });
 });
 
-const configOptions = computedAsync(getParsedConfig);
+const configOptions = computed(getParsedConfig);
 
 const formatOptions = computed<FormKitOptionsList>(() =>
   FORMATS_EXT.map((ext) => ({
@@ -111,10 +111,10 @@ const segmenterOptions = computed<SegmenterOptions>(() => {
 });
 
 // Like `getParsedConfig` in `corpus.composable.ts` but also alerts on error.
-async function getParsedConfig() {
+function getParsedConfig() {
   if (!config.value) return undefined;
   try {
-    const parsed = await parseConfig(config.value);
+    const parsed = parseConfig(config.value);
     return parsed;
   } catch (error) {
     alert(t("corpus.config.parse.error"), "error");
@@ -124,7 +124,7 @@ async function getParsedConfig() {
 
 async function submit(fields: Form) {
   // If there is no previous config file, start from a minimal one.
-  const configOld = configOptions.value || (await emptyConfig());
+  const configOld = configOptions.value || emptyConfig();
 
   // Merge new form values with existing config.
   const configNew: ConfigOptions = {

src/corpus/corpus.composable.ts

@@ -1,6 +1,6 @@
 import { computed, watch } from "vue";
 import { attempt, uniq } from "es-toolkit";
-import { computedAsync, useInterval } from "@vueuse/core";
+import { useInterval } from "@vueuse/core";
 import { useCorpusStore } from "@/store/corpus.store";
 import {
   makeConfig,
@@ -36,7 +36,7 @@ export function useCorpus(corpusId: string) {
     corpusStore.loadConfig(corpusId);
     return corpus.value?.config || undefined;
   });
-  const configOptions = computedAsync(getParsedConfig);
+  const configOptions = computed(getParsedConfig);
   const isConfigValid = computed(
     () => !attempt(() => validateConfig(configOptions.value!))[0],
   );
@@ -89,10 +89,10 @@ export function useCorpus(corpusId: string) {
     await corpusStore.uploadConfig(corpusId, configYaml);
   }
 
-  async function getParsedConfig() {
+  function getParsedConfig() {
     if (!config.value) return undefined;
     try {
-      const parsed = await parseConfig(config.value);
+      const parsed = parseConfig(config.value);
       return parsed;
     } catch (error) {
       console.error(`Error parsing config for "${corpusId}":`, error);

src/corpus/createCorpus.composable.ts

@@ -8,7 +8,7 @@ import {
   makeConfig,
   type FileFormat,
   type ConfigOptions,
-  emptyConfig,
+  defaultConfig,
 } from "@/api/corpusConfig";
 import type { MinkResponse } from "@/api/api.types";
 import useCreateResource from "@/resource/createResource.composable";
@@ -36,14 +36,11 @@ export default function useCreateCorpus() {
     const corpusId = await createCorpus().catch(alertError);
     if (!corpusId) return;
 
-    // Get file extension of first file, assuming all are using the same extension.
-    const format = getFilenameExtension(files[0].name) as FileFormat;
+    // Create default config.
+    const config = await defaultConfig();
 
-    // Create a minimal config.
-    const config = {
-      ...(await emptyConfig()),
-      format,
-    };
+    // Get file extension of first file, assuming all are using the same extension.
+    config.format = getFilenameExtension(files[0].name) as FileFormat;
 
     // Wait for sources and config to be uploaded in parallel.
     const results = await Promise.allSettled([
@@ -89,7 +86,7 @@ export default function useCreateCorpus() {
     textAnnotation?: string,
   ): Promise<string | undefined> {
     const config = {
-      ...(await emptyConfig()),
+      ...(await defaultConfig()),
       name: { swe: name, eng: name },
       description: { swe: description, eng: description },
       format,

src/page/title.composable.ts

@@ -35,7 +35,7 @@ export default function usePageTitle() {
     const { parseConfig } = await import("@/api/corpusConfig");
     let parsedConfig: ConfigOptions;
     try {
-      parsedConfig = await parseConfig(config);
+      parsedConfig = parseConfig(config);
     } catch (error) {
       console.error(`Error parsing config for "${corpusId}":`, error);
       return;