🏃 Validate site action urls later and infer static

.changeset/odd-icons-complain.md

@@ -0,0 +1,6 @@
+---
+'myst-config': patch
+'myst-cli': patch
+---
+
+Relax site action validation and move later in the build

packages/myst-cli/src/build/site/manifest.ts

@@ -180,10 +180,67 @@ async function resolveTemplateFileOptions(
   return resolvedOptions;
 }
 
-function resolveSiteManifestAction(session: ISession, action: SiteAction): SiteAction {
-  if (!action.static || !action.url) return { ...action };
-  if (!fs.existsSync(action.url))
-    throw new Error(`Could not find static resource at "${action.url}". See 'config.site.actions'`);
+function isUrl(value: string) {
+  // Allow simple relative path in project
+  if (value.match('^(/[a-zA-Z0-9._-]+)+$')) return true;
+  try {
+    new URL(value);
+  } catch {
+    return false;
+  }
+  return true;
+}
+
+/**
+ * Resolves Site Action, including hashing and copying static files
+ *
+ * Infers `static: true` if url is an existing local file
+ */
+function resolveSiteManifestAction(
+  session: ISession,
+  action: SiteAction,
+  file?: string,
+): SiteAction | undefined {
+  if (!action.url) return { ...action };
+  if (action.static === false) {
+    if (!isUrl(action.url)) {
+      addWarningForFile(
+        session,
+        file,
+        `Non-static site action "${action.url}" should be a valid URL`,
+      );
+    }
+    return { ...action };
+  }
+  // Cases where url does not exist as a local file
+  if (!fs.existsSync(action.url)) {
+    if (action.static) {
+      addWarningForFile(
+        session,
+        file,
+        `Could not find static resource at "${action.url}" in site config 'actions'`,
+        'error',
+        { ruleId: RuleId.staticActionFileCopied },
+      );
+      return undefined;
+    }
+    if (!isUrl(action.url)) {
+      addWarningForFile(
+        session,
+        file,
+        `Site action "${action.url}" should be a URL or path to static file`,
+      );
+    }
+    return { ...action };
+  }
+  if (!action.static && isUrl(action.url)) {
+    // Unlikely case where url is both an existing local file and a valid URL
+    addWarningForFile(
+      session,
+      file,
+      `Linking site action "${action.url}" to static file; to mark this as a URL instead, use 'static: false'`,
+    );
+  }
   const fileHash = hashAndCopyStaticFile(session, action.url, session.publicPath(), (m: string) => {
     addWarningForFile(session, action.url, m, 'error', {
       ruleId: RuleId.staticActionFileCopied,
@@ -209,17 +266,19 @@ export async function getSiteManifest(
 ): Promise<SiteManifest> {
   const state = session.store.getState() as RootState;
   const siteConfig = selectors.selectCurrentSiteConfig(state);
+  const siteConfigFile = selectors.selectCurrentSiteFile(state);
   if (!siteConfig) throw Error('no site config defined');
   const siteProjects: ManifestProject[] = (
     await Promise.all(
       siteConfig.projects?.map(async (p) => localToManifestProject(session, p.path, p.slug)) ?? [],
     )
   ).filter((p): p is ManifestProject => !!p);
   const { nav } = siteConfig;
-  const actions = siteConfig.actions?.map((action) => resolveSiteManifestAction(session, action));
+  const actions = siteConfig.actions
+    ?.map((action) => resolveSiteManifestAction(session, action, siteConfigFile))
+    .filter((action): action is SiteAction => !!action);
   const siteFrontmatter = filterKeys(siteConfig as Record<string, any>, SITE_FRONTMATTER_KEYS);
   const mystTemplate = await getMystTemplate(session, opts);
-  const siteConfigFile = selectors.selectCurrentSiteFile(state);
   const validatedOptions = mystTemplate.validateOptions(
     siteFrontmatter.options ?? {},
     siteConfigFile,

packages/myst-config/src/site/site.spec.ts

@@ -88,16 +88,18 @@ describe('validateSiteAction', () => {
     };
     expect(validateSiteAction(siteAction, opts)).toEqual(siteAction);
   });
-  it('invalid url errors', async () => {
+  it('relative url passes', async () => {
     expect(validateSiteAction({ title: 'example', url: '/a/b/c/d' }, opts)).toEqual({
       title: 'example',
       url: '/a/b/c/d',
     });
     expect(opts.messages.errors?.length).toEqual(undefined);
   });
-  it('invalid url errors', async () => {
-    expect(validateSiteAction({ title: 'example', url: '?something' }, opts)).toBeUndefined();
-    expect(opts.messages.errors?.length).toEqual(1);
+  it('invalid url passes', async () => {
+    expect(validateSiteAction({ title: 'example', url: '?something' }, opts)).toEqual({
+      title: 'example',
+      url: '?something',
+    });
   });
   it('valid path returns self', async () => {
     expect(validateSiteAction({ title: 'example', url: '/a/b' }, opts)).toEqual({
@@ -124,18 +126,16 @@ describe('validateSiteConfig', () => {
         {
           projects: [{ path: 'my-proj', slug: '/my/proj' }],
           nav: [{ title: 'cool folder', children: 'a' }],
-          actions: [{ title: 'Go To Example', url: 'bad_url', static: false }],
           domains: ['example.com'],
         },
         opts,
       ),
     ).toEqual({
       projects: [],
       nav: [],
-      actions: [],
       domains: [],
     });
-    expect(opts.messages.errors?.length).toEqual(4);
+    expect(opts.messages.errors?.length).toEqual(3);
   });
   it('invalid required values error', async () => {
     expect(

packages/myst-config/src/site/validators.ts

@@ -103,13 +103,13 @@ export function validateSiteAction(input: any, opts: ValidationOptions) {
   );
   if (value === undefined) return undefined;
   const title = validateString(value.title, incrementOptions('title', opts));
+  const url = validateString(value.url, incrementOptions('url', opts));
+  if (!title || !url) return undefined;
+  const output: SiteAction = { title, url };
   if (defined(value.static)) {
-    value.static = validateBoolean(value.static, incrementOptions('static', opts));
+    output.static = validateBoolean(value.static, incrementOptions('static', opts));
   }
-  const actionUrlValidator = value.static ? validateString : validateUrlOrPath;
-  const url = actionUrlValidator(value.url, incrementOptions('url', opts));
-  if (title === undefined || !url) return undefined;
-  return value as SiteAction;
+  return output;
 }
 
 export function validateSiteConfigKeys(