]*class="[^"]*hidden[^"]*dark:block/);
expect(page).to.match(/ {
({ output } = built);
});
- after(async () => {
- await removeBuilt(built);
- });
+ after(() => removeBuilt(built));
const read = (relative: string) => fs.readFileSync(path.join(output.toString(), relative), 'utf8');
const exists = (relative: string) => fs.existsSync(path.join(output.toString(), relative));
diff --git a/test/e2e/portal-serve.test.ts b/test/e2e/portal-serve.test.ts
index b02122dde..093eca0ff 100644
--- a/test/e2e/portal-serve.test.ts
+++ b/test/e2e/portal-serve.test.ts
@@ -1,4 +1,5 @@
import fs from 'fs';
+import os from 'os';
import path from 'path';
import { expect } from 'chai';
import getPort from 'get-port';
@@ -9,10 +10,7 @@ import { DirectoryPath } from '../../src/types/file/directoryPath';
import { FilePath } from '../../src/types/file/filePath';
import { CodeSampleCatalogs } from '../../src/types/portal/code-samples';
import { PortalArtifacts } from '../../src/types/portal/portal-artifacts';
-import {
- ensurePortalProjectDirectoryBase,
- removePortalProjectDirectoryBase
-} from '../../src/infrastructure/tmp-extensions';
+import { canonical } from '../../src/infrastructure/tmp-extensions';
// Opt-in: a real dev server needs a minute and every runtime dependency.
const enabled = process.env.APIMATIC_E2E === '1';
@@ -21,13 +19,11 @@ const enabled = process.env.APIMATIC_E2E === '1';
this.timeout(10 * 60 * 1000);
const fixture = new DirectoryPath(process.cwd()).join('test/resources/portal-inputs/default/src');
- let base: string | undefined;
let root: string | undefined;
let server: PortalDevServer | undefined;
before(async () => {
- base = await ensurePortalProjectDirectoryBase(fixture);
- root = fs.mkdtempSync(path.join(base, 'portal-serve-e2e-'));
+ root = canonical(fs.mkdtempSync(path.join(os.tmpdir(), 'portal-serve-e2e-')));
const source = (await new PortalSourceContext(fixture).resolve())._unsafeUnwrap();
const delivered = path.join(root, 'delivered');
@@ -55,7 +51,6 @@ const enabled = process.env.APIMATIC_E2E === '1';
after(async () => {
await server?.stop();
if (root !== undefined) fs.rmSync(root, { recursive: true, force: true });
- if (base !== undefined) await removePortalProjectDirectoryBase(base);
});
// A missing file answers 200 too, with the fallback page, so the type says what came back.
@@ -69,14 +64,17 @@ const enabled = process.env.APIMATIC_E2E === '1';
expect(response.headers.get('content-type')).to.contain('javascript');
});
- it('serves an image from the static directory asked for before the page importing it', async () => {
+ // The image comes from the static directory by its address, which Vite serves from any drive.
+ it("serves a page's static image at its public address, its module asked for before the page", async () => {
const image = fs
.realpathSync(path.join(fixture.toString(), 'static', 'images', 'logo.png'))
.split(path.sep)
.join('/');
- const response = await globalThis.fetch(`${server?.url.toString()}/@fs/${image}`);
+ const module = await globalThis.fetch(`${server?.url.toString()}/@fs/${image}?import`);
+ const response = await globalThis.fetch(`${server?.url.toString()}/images/logo.png`);
+ expect(await module.text()).to.contain('export default "/images/logo.png"');
expect(response.status).to.equal(200);
expect(response.headers.get('content-type')).to.equal('image/png');
});
diff --git a/test/infrastructure/tmp-extensions.test.ts b/test/infrastructure/tmp-extensions.test.ts
index 788c306b5..b584cb95a 100644
--- a/test/infrastructure/tmp-extensions.test.ts
+++ b/test/infrastructure/tmp-extensions.test.ts
@@ -1,40 +1,7 @@
import fs from 'fs';
-import os from 'os';
import path from 'path';
import { expect } from 'chai';
-import {
- canonical,
- PORTAL_PROJECT_DIRECTORY_NAME,
- portalProjectDirectoryBase,
- withDirPath,
- withPortalProjectDirectory
-} from '../../src/infrastructure/tmp-extensions';
-import { DirectoryPath } from '../../src/types/file/directoryPath';
-
-describe('portalProjectDirectoryBase', () => {
- // A plain string, not a DirectoryPath: that class resolves against the host's own path
- // rules, and this Windows path is checked on every platform.
- const source = 'D:\\work\\my-api\\src';
-
- it('uses the system temp directory when it shares the drive with the source', () => {
- expect(portalProjectDirectoryBase(source, 'D:\\Temp', 'win32')).to.equal('D:\\Temp');
- });
-
- it('compares drive letters without regard to case', () => {
- expect(portalProjectDirectoryBase(source, 'd:\\Temp', 'win32')).to.equal('d:\\Temp');
- });
-
- it('falls back to a folder beside the source when the temp directory is on another drive', () => {
- expect(portalProjectDirectoryBase(source, 'C:\\Users\\me\\AppData\\Local\\Temp', 'win32')).to.equal(
- path.win32.join('D:\\work\\my-api', PORTAL_PROJECT_DIRECTORY_NAME)
- );
- });
-
- it('never leaves the system temp directory on other platforms', () => {
- expect(portalProjectDirectoryBase('/work/my-api/src', '/tmp', 'linux')).to.equal('/tmp');
- expect(portalProjectDirectoryBase('/work/my-api/src', '/tmp', 'darwin')).to.equal('/tmp');
- });
-});
+import { withDirPath } from '../../src/infrastructure/tmp-extensions';
// The portal's dev server resolves its allow-list to real paths and then compares strings, so a
// temp directory named any other way than its real one has every page under it refused.
@@ -45,21 +12,10 @@ describe('the temp directory a run is given', () => {
});
});
- it('is spelled that way for a portal project too', async () => {
- const source = new DirectoryPath(fs.mkdtempSync(path.join(os.tmpdir(), 'build-real-'))).join('src');
-
- await withPortalProjectDirectory(source, async (directory) => {
- expect(directory.toString()).to.equal(fs.realpathSync.native(directory.toString()));
- });
- });
-});
-
-describe('withPortalProjectDirectory', () => {
- it('hands out a directory that exists while the callback runs and is gone afterwards', async () => {
- const source = new DirectoryPath(fs.mkdtempSync(path.join(os.tmpdir(), 'build-source-'))).join('src');
+ it('exists while the callback runs and is gone afterwards', async () => {
let seen: string | undefined;
- await withPortalProjectDirectory(source, async (directory) => {
+ await withDirPath(async (directory) => {
seen = directory.toString();
expect(fs.existsSync(seen)).to.be.true;
fs.writeFileSync(path.join(seen, 'marker.txt'), 'x');
@@ -68,49 +24,4 @@ describe('withPortalProjectDirectory', () => {
expect(seen).to.be.a('string');
expect(fs.existsSync(seen as string)).to.be.false;
});
-
- // Drive letters only exist on Windows, so the fallback can only be exercised for real there.
- (process.platform === 'win32' ? it : it.skip)(
- 'builds beside the source when the temp directory is on another drive, and cleans up',
- async () => {
- const project = canonical(fs.mkdtempSync(path.join(os.tmpdir(), 'build-project-')));
- const source = new DirectoryPath(project).join('src');
- const foreignTemp = 'Z:\\Temp';
- const fallback = path.join(project, PORTAL_PROJECT_DIRECTORY_NAME);
-
- await withPortalProjectDirectory(
- source,
- async (directory) => {
- expect(directory.toString().toLowerCase().startsWith(fallback.toLowerCase())).to.be.true;
- expect(fs.readFileSync(path.join(fallback, '.gitignore'), 'utf8')).to.equal('*\n');
- },
- foreignTemp
- );
-
- expect(fs.existsSync(fallback)).to.be.false;
- }
- );
-
- (process.platform === 'win32' ? it : it.skip)(
- 'leaves the shared folder alone while another run is in it',
- async () => {
- const project = canonical(fs.mkdtempSync(path.join(os.tmpdir(), 'build-shared-')));
- const source = new DirectoryPath(project).join('src');
- const fallback = path.join(project, PORTAL_PROJECT_DIRECTORY_NAME);
-
- await withPortalProjectDirectory(
- source,
- async () => {
- // Stands in for a second run still building in the same folder.
- fs.mkdirSync(path.join(fallback, 'another-run'), { recursive: true });
- },
- 'Z:\\Temp'
- );
-
- expect(fs.existsSync(path.join(fallback, '.gitignore')), 'the marker survives').to.be.true;
- expect(fs.existsSync(path.join(fallback, 'another-run')), "the other run's directory survives").to.be.true;
-
- fs.rmSync(project, { recursive: true, force: true });
- }
- );
});
diff --git a/test/portal-template.test.ts b/test/portal-template.test.ts
index a7b5b286f..83d5799e2 100644
--- a/test/portal-template.test.ts
+++ b/test/portal-template.test.ts
@@ -11,6 +11,7 @@ import {
TEMPLATE_DEPENDENCIES
} from '../src/infrastructure/portal-project-service';
import { GENERATED_DIRECTORY_NAME, PAGE_TEMPLATES } from '../src/types/portal/generated-pages';
+import { GENERATED_INCLUDES_DIRECTORY_NAME } from '../src/types/portal/page-fragments';
import { PortalIdentity } from '../src/types/portal/portal-config';
import type { BuildPaths } from '../portal-template/portal-config';
import type { Portal } from '../portal-template/src/lib/portal-types';
@@ -145,11 +146,17 @@ describe('portal template packaging', () => {
}
});
- // Named to Tailwind from `src/styles/`; a rename that missed it would cost every utility class in a page, silently.
- it('has Tailwind scan the copy of the pages, by its relative name', () => {
+ // Tailwind reads only the folders `app.css` names, so each must be one the CLI writes pages into.
+ it('has Tailwind scan the directories the CLI writes pages into', () => {
const stylesheet = fs.readFileSync(path.join(templateRoot, 'src/styles/app.css'), 'utf8');
- expect(stylesheet).to.contain(`@source '../../${CONTENT_COPY_DIRECTORY_NAME}';`);
+ for (const directory of [
+ CONTENT_COPY_DIRECTORY_NAME,
+ GENERATED_DIRECTORY_NAME,
+ GENERATED_INCLUDES_DIRECTORY_NAME
+ ]) {
+ expect(stylesheet).to.contain(`@source '../../${directory}';`);
+ }
});
// Left to itself the popover reads `window.location.href`, so a reader's query string and hash
diff --git a/test/portal-template/static-images.test.ts b/test/portal-template/static-images.test.ts
new file mode 100644
index 000000000..557cf64d5
--- /dev/null
+++ b/test/portal-template/static-images.test.ts
@@ -0,0 +1,110 @@
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
+import { expect } from 'chai';
+import { normalizePath, type Plugin } from 'vite';
+import { staticImages } from '../../portal-template/static-images';
+
+type Resolve = (source: string, importer: string | undefined, options: object) => unknown;
+
+interface ResolveHook {
+ filter: { id: RegExp };
+ handler: (this: { resolve: Resolve }, source: string, importer: string | undefined, options: object) => unknown;
+}
+
+const resolveHook = (plugins: Plugin[]) => plugins[0].resolveId as unknown as ResolveHook;
+
+/** The preview's plugin for a portal served under `base`, where Vite counts a `.png` as an asset. */
+function previewLoad(staticDirectory: string, base = '/'): (id: string) => string | null {
+ const preview = staticImages(staticDirectory)[1];
+ const configResolved = preview.configResolved as (config: object) => void;
+ configResolved({ base, assetsInclude: (file: string) => file.endsWith('.png') });
+ return preview.load as (id: string) => string | null;
+}
+
+describe('staticImages', () => {
+ let root: string;
+ let real: string;
+ let linked: string;
+
+ beforeEach(() => {
+ root = fs.mkdtempSync(path.join(os.tmpdir(), 'static-images-'));
+ fs.mkdirSync(path.join(root, 'static'));
+ real = normalizePath(fs.realpathSync.native(path.join(root, 'static')));
+ linked = path.join(root, 'linked');
+ fs.symlinkSync(path.join(root, 'static'), linked, process.platform === 'win32' ? 'junction' : 'dir');
+ });
+
+ afterEach(() => {
+ fs.rmSync(root, { recursive: true, force: true });
+ });
+
+ it('resolves the absolute path Fumadocs puts behind a `./` across Windows drives', () => {
+ const hook = resolveHook(staticImages(null));
+ const asked: unknown[][] = [];
+ const resolve: Resolve = (...args) => {
+ asked.push(args);
+ return 'resolved';
+ };
+
+ for (const source of ['./D:/site/x.png', './d:/site/x.png']) {
+ expect(hook.filter.id.test(source), source).to.be.true;
+ }
+ const resolved = hook.handler.call({ resolve }, './D:/site/src/static/x.png', 'C:/project/content/page.md', {
+ isEntry: false
+ });
+
+ expect(resolved).to.equal('resolved');
+ expect(asked).to.deep.equal([
+ ['D:/site/src/static/x.png', 'C:/project/content/page.md', { isEntry: false, skipSelf: true }]
+ ]);
+ });
+
+ // The CLI builds no portal from a network share, so Fumadocs' `.///server/share/…` is not taken either.
+ it('leaves every other import to Vite', () => {
+ const { filter } = resolveHook(staticImages(null));
+
+ for (const source of [
+ './local.png',
+ './/local.png',
+ '../static/x.png',
+ 'D:/site/x.png',
+ '/images/x.png',
+ 'fumadocs-ui',
+ './//server/share/x.png'
+ ]) {
+ expect(filter.id.test(source), source).to.be.false;
+ }
+ });
+
+ it('changes only the preview, and only for a portal with a static directory', () => {
+ expect(staticImages(null).map((plugin) => plugin.name)).to.deep.equal(['apimatic:static-images:resolve']);
+ expect(staticImages(linked)[1].apply).to.equal('serve');
+ });
+
+ it('loads a static image as the address the public directory serves it at, under the base', () => {
+ expect(previewLoad(real)(`${real}/images/x.png`)).to.equal('export default "/images/x.png";');
+ expect(previewLoad(real, '/docs/')(`${real}/images/x.png`)).to.equal('export default "/docs/images/x.png";');
+ });
+
+ it('knows the static directory by its own spelling and by its real one', () => {
+ const load = previewLoad(linked);
+
+ expect(load(`${normalizePath(linked)}/images/x.png`)).to.equal('export default "/images/x.png";');
+ expect(load(`${real}/images/x.png`)).to.equal('export default "/images/x.png";');
+ });
+
+ it('knows the static directory on Windows whatever the case it is spelled in', function () {
+ if (process.platform !== 'win32') this.skip();
+
+ expect(previewLoad(real)(`${real.toUpperCase()}/images/x.png`)).to.equal('export default "/images/x.png";');
+ });
+
+ it('leaves a query, a file that is no asset and a file elsewhere to Vite', () => {
+ const load = previewLoad(real);
+
+ expect(load(`${real}/images/x.png?raw`)).to.be.null;
+ expect(load(`${real}/data.json`)).to.be.null;
+ expect(load(`${normalizePath(root)}/elsewhere/x.png`)).to.be.null;
+ });
+});
diff --git a/test/resources/portal-inputs/default/src/content/authentication.md b/test/resources/portal-inputs/default/src/content/authentication.mdx
similarity index 55%
rename from test/resources/portal-inputs/default/src/content/authentication.md
rename to test/resources/portal-inputs/default/src/content/authentication.mdx
index baa5213a0..14290046b 100644
--- a/test/resources/portal-inputs/default/src/content/authentication.md
+++ b/test/resources/portal-inputs/default/src/content/authentication.mdx
@@ -4,3 +4,5 @@ description: How requests are authorised.
---
Authentication for the fixture.
+
+Spaced out by a class only this page uses.
diff --git a/test/types/file/directory-path.test.ts b/test/types/file/directory-path.test.ts index 8002e24fa..8419de254 100644 --- a/test/types/file/directory-path.test.ts +++ b/test/types/file/directory-path.test.ts @@ -30,6 +30,17 @@ describe('DirectoryPath.relativeTo', () => { }); }); +describe('DirectoryPath.isOnNetworkShare', () => { + it('holds a Windows share, however its slashes are typed, and no local path', function () { + if (process.platform !== 'win32') this.skip(); + + expect(new DirectoryPath('\\\\server\\share\\api').isOnNetworkShare()).to.equal(true); + expect(new DirectoryPath('//server/share/api').isOnNetworkShare()).to.equal(true); + expect(new DirectoryPath('C:\\api').isOnNetworkShare()).to.equal(false); + expect(new DirectoryPath('\\\\?\\C:\\api').isOnNetworkShare()).to.equal(false); + }); +}); + // What a file the build reads, and a log a reader compares to one, spell a path as on every platform. describe('DirectoryPath.toPosix', () => { it('keeps the whole path with forward slashes between its segments', () => {