test non-svg knitr dev output

UofGAnalytics · May 11, 2022 · 5a54b6e · 5a54b6e
1 parent ddd2b16
commit 5a54b6e
Show file tree

Hide file tree

Showing 6 changed files with 73 additions and 30 deletions.
diff --git a/compiler/src/course/__test__/load-course.test.ts b/compiler/src/course/__test__/load-course.test.ts
@@ -12,7 +12,7 @@ describe('loadCourse', () => {
     const courseYaml = path.join('fixtures', 'basic', 'course.yaml');
 
     try {
-      await fixtureTestProcessor('basic', { week: 2 });
+      await fixtureTestProcessor('basic', { week: 2, shouldFail: true });
     } catch (err) {
       expect(err).toContain(`Week 2 not found in ${courseYaml}`);
     }

diff --git a/compiler/src/knitr/__test__/knitr.test.ts b/compiler/src/knitr/__test__/knitr.test.ts
@@ -78,11 +78,24 @@ describe('knitr', () => {
     `,
       { noEmbedAssets: false }
     );
+    expect(html).toContain('<svg xmlns="http://www.w3.org/2000/svg"');
+  });
+
+  it('should output a graph as png', async () => {
+    const { html } = await testProcessor(
+      `
+      \`\`\`{r, dev='png'}
+      x <- rnorm(100)
+      hist(x)
+      \`\`\`
+    `,
+      { noEmbedAssets: false }
+    );
 
-    const match =
-      html.match(/<svg alt="plot of chunk unnamed-chunk-2"/) || [];
+    expect(html).toContain('<img src="data:image/png;base64');
 
-    expect(match.length).toBe(1);
+    // testing fig.retina=2 in knitr.R
+    expect(html).toContain('style="max-width: 1008px"');
   });
 
   it('should ignore tab whitespace', async () => {

diff --git a/compiler/src/knitr/knitr.R b/compiler/src/knitr/knitr.R
@@ -8,7 +8,8 @@ knitr::opts_knit$set(root.dir=baseDir)
 knitr::opts_chunk$set(
   dev='svglite',
   class.output='knitr-output',
-  fig.path=cacheDir
+  fig.path=cacheDir,
+  fig.retina=2
 )
 
 knitr::knit(

diff --git a/compiler/src/knitr/knitr.ts b/compiler/src/knitr/knitr.ts
@@ -14,6 +14,7 @@ import { mkdir, rmFile, writeFile } from '../utils/utils';
 
 export async function knitr(unit: Unit, ctx: Context) {
   const parentFile = await createParentFile(unit, ctx);
+  // console.log(parentFile.value);
 
   const result = await execKnitr(parentFile, ctx, unit.unitPath);
   // console.log(result);
@@ -61,7 +62,6 @@ async function createParentFile(unit: Unit, ctx: Context) {
   return file;
 }
 
-// TODO: see what can be done with output when "quiet" in knitr.R is turned off
 async function execKnitr(file: VFile, ctx: Context, unitPath: string) {
   const md = file.value as string;
   const uniqueId = getUniqueId(md);
@@ -105,6 +105,10 @@ function createKnitrCommand(
   const baseDir = path.parse(unitPath).dir;
   const cachedFile = path.join(ctx.cacheDir, `${uniqueId}.Rmd`);
   const cacheDir = path.join(ctx.cacheDir, uniqueId);
+
+  // spawn args
+  // return [rFile, cachedFile, baseDir, cacheDir];
+
   return `Rscript "${rFile}" "${cachedFile}" "${baseDir}" "${cacheDir}"`;
 }
 
@@ -233,24 +237,45 @@ function findLanguageForOutput(prev: string[]) {
   return match[1];
 }
 
-// attempt at changing knitr output. doesn't completely work
-// const hooks = `
-//   knit_hooks$set(
-//     source = function(x, options) {
-//       paste(c("\`\`\`r", x, "\`\`\`"), collapse = "\n")
-//     },
-//     output = function(x, options) {
-//       paste(c("\`\`\`", x, "\`\`\`"), collapse = "\n")
-//     },
-//     error = function(x, options) {
-//       paste(
-//         c(
-//           "\`\`\`plaintext error",
-//           gsub("## Error", "\#\# Error", x),
-//           "\`\`\`"
-//         ),
-//         collapse = "\n"
-//       )
-//     }
-//   )
-// `;
+// experimental streaming output
+// async function spawnKnitr(file: VFile, ctx: Context, unitPath: string) {
+//   const md = file.value as string;
+//   const uniqueId = getUniqueId(md);
+//   const cachedFile = path.join(ctx.cacheDir, `${uniqueId}.Rmd`);
+//   const cacheDir = path.join(ctx.cacheDir, uniqueId);
+//   await mkdir(cacheDir);
+//   await writeFile(cachedFile, md);
+
+//   return new Promise<string>((resolve, reject) => {
+//     const args = createKnitrCommand(ctx, uniqueId, unitPath);
+//     const knitr = spawn('Rscript', args);
+//     const result: string[] = [];
+
+//     knitr.stdout.on('data', (data) => {
+//       const str = data.toString();
+//       console.log(str);
+//       result.push(str);
+//     });
+
+//     knitr.stdout.on('end', () => {
+//       console.log('STDOUT END');
+//       const end = result.join('');
+//       console.log('END', end);
+//       reportErrors(end, file);
+//       resolve(formatResponse(end));
+//     });
+
+//     knitr.stdout.on('error', (err) => {
+//       console.log('STDOUT ERROR', err, err.toString());
+//       reject();
+//     });
+
+//     knitr.stderr.on('data', (data) => {
+//       const str = data.toString();
+//       console.log('STDERR ERROR', str);
+//     });
+//   }).then(async (result) => {
+//     await rmFile(cachedFile);
+//     return result;
+//   });
+// }
diff --git a/compiler/src/mdast/images.ts b/compiler/src/mdast/images.ts
@@ -34,7 +34,7 @@ function template(node: Image, count: number) {
     ],
   };
 
-  if (node.data?.width) {
+  if (node.data?.width && /^\d+px/.test(String(node.data.width))) {
     image.properties = {
       ...image.properties,
       style: `width: ${node.data.width};`,

diff --git a/compiler/src/test-utils/fixture-test-processor.ts b/compiler/src/test-utils/fixture-test-processor.ts
@@ -30,11 +30,15 @@ export async function fixtureTestProcessor(
 
     exec(cmd, (err, response, stdErr) => {
       if (stdErr) {
-        console.log(stdErr);
+        if (!options.shouldFail) {
+          console.log(stdErr);
+        }
         reject(stdErr);
       }
       if (err) {
-        console.error(err);
+        if (!options.shouldFail) {
+          console.error(err);
+        }
         reject(err);
       }
       resolve(response);