Merge pull request #629 from auth0/fix-tenant-error-page-skipped

Fix: Error page erroneously skipped for missing HTML
auth0 · Aug 23, 2022 · e62c809 · e62c809
2 parents 4f16194 + 4b28934
commit e62c809
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 4 deletions.
diff --git a/src/context/directory/handlers/pages.ts b/src/context/directory/handlers/pages.ts
@@ -29,11 +29,19 @@ function parse(context: DirectoryContext): ParsedPages {
     return acc;
   }, {});
 
-  const pages = Object.values(sorted).flatMap(({ meta, html }): Asset[] => {
+  const pages = Object.keys(sorted).flatMap((key): Asset[] => {
+    const { meta, html } = sorted[key];
     if (!meta) {
       log.warn(`Skipping pages file ${html} as missing the corresponding '.json' file`);
       return [];
     }
+    if (!html && ['error_page', 'login'].includes(key)) {
+      //Error pages don't require an HTML template, it is valid to redirect errors to URL
+      return {
+        ...loadJSON(meta, context.mappings),
+        html: '',
+      };
+    }
     if (!html) {
       log.warn(`Skipping pages file ${meta} as missing corresponding '.html' file`);
       return [];
@@ -65,7 +73,7 @@ async function dump(context: DirectoryContext): Promise<void> {
       // Dump template html to file
       const htmlFile = path.join(pagesFolder, `${page.name}.html`);
       log.info(`Writing ${htmlFile}`);
-      fs.writeFileSync(htmlFile, page.html);
+      fs.writeFileSync(htmlFile || '', page.html);
       metadata.html = `./${page.name}.html`;
     }
 

diff --git a/test/context/directory/pages.test.js b/test/context/directory/pages.test.js
@@ -44,6 +44,36 @@ describe('#directory context pages', () => {
     expect(context.assets.pages).to.deep.equal(pagesTarget);
   });
 
+  it('should process login and error pages without HTML files', async () => {
+    const repoDir = path.join(testDataDir, 'directory', 'pages4');
+
+    const pagesNoHtml = {
+      'login.json': '{ "name": "login", "enabled": false }',
+      'error_page.json':
+        '{ "name": "error_page", "url": "https://example.com/error", "show_log_link": false }',
+    };
+
+    createDir(repoDir, { [constants.PAGES_DIRECTORY]: pagesNoHtml });
+
+    const config = { AUTH0_INPUT_FILE: repoDir };
+    const context = new Context(config, mockMgmtClient());
+    await context.load();
+
+    expect(context.assets.pages).to.deep.equal([
+      {
+        html: '',
+        name: 'error_page',
+        show_log_link: false,
+        url: 'https://example.com/error',
+      },
+      {
+        html: '',
+        name: 'login',
+        enabled: false,
+      },
+    ]);
+  });
+
   it('should ignore unknown file', async () => {
     const repoDir = path.join(testDataDir, 'directory', 'pages2');
     const invalidFile = {
@@ -132,7 +162,7 @@ describe('#directory context pages', () => {
     );
   });
 
-  it('should dump error page without html', async () => {
+  it('should dump empty error page even if HTML is not set', async () => {
     const dir = path.join(testDataDir, 'directory', 'pagesDump');
     cleanThenMkdir(dir);
     const context = new Context({ AUTH0_INPUT_FILE: dir }, mockMgmtClient());
@@ -143,6 +173,7 @@ describe('#directory context pages', () => {
         name: 'error_page',
         url: errorPageUrl,
         show_log_link: false,
+        html: '',
       },
     ];
 
@@ -153,7 +184,8 @@ describe('#directory context pages', () => {
       name: 'error_page',
       url: errorPageUrl,
       show_log_link: false,
+      html: './error_page.html',
     });
-    expect(fs.existsSync(path.join(pagesFolder, 'error_page.html'))).to.equal(false);
+    expect(fs.existsSync(path.join(pagesFolder, 'error_page.html'))).to.equal(true);
   });
 });