feat: delete and unpublish API

src/extension/app/constants.js

@@ -45,7 +45,9 @@ export const EXTERNAL_EVENTS = {
   STATUS_FETCHED: 'statusfetched',
   RESOURCE_UPDATED: 'updated',
   RESOURCE_PREVIEWED: 'previewed',
+  RESOURCE_DELETED: 'deleted',
   RESOURCE_PUBLISHED: 'published',
+  RESOURCE_UNPUBLISHED: 'unpublished',
   EVIRONMENT_SWITCHED: 'envswitched',
   PLUGIN_USED: 'pluginused',
 };

src/extension/app/store/app.js

@@ -498,26 +498,34 @@ export class AppStore {
   }
 
   /**
-   * Reloads the current page. Abstracted for testing.
+   * Opens a new page. Abstracted for testing.
+   * @param {string} url The URL to open
+   * @param {string} [name] The window name (optional)
+   * @returns {Window} The window object
    */
-  reloadPage(newTab) {
-    if (newTab) {
-      // istanbul ignore next
-      window.open(window.location.href);
-    } else {
-      // istanbul ignore next
-      window.location.reload();
-    }
+  // istanbul ignore next 3
+  openPage(url, name) {
+    return window.open(url, name);
   }
 
   /**
-   * Opens a new page. Abstracted for testing.
-   * @param {string} url The URL to open
-   * @returns {Window} The window object
+   * Navigates to the provided URL in the current window. Abstracted for testing.
+   * @param {string} url The URL to load
    */
   // istanbul ignore next 3
-  openPage(url) {
-    return window.open(url);
+  loadPage(url) {
+    window.location.href = url;
+  }
+
+  /**
+   * Reloads the current page. Abstracted for testing.
+   */
+  reloadPage(newTab) {
+    if (newTab) {
+      this.openPage(window.location.href);
+    } else {
+      this.reloadPage(window.location.href);
+    }
   }
 
   /**
@@ -792,6 +800,40 @@ export class AppStore {
     this.switchEnv('preview');
   }
 
+  /**
+   * Deletes the current resource from preview and unpublishes it if published.
+   * @fires Sidekick#deleted
+   * @returns {Promise<AdminResponse>} The response object
+   */
+  async delete() {
+    const { siteStore, status } = this;
+    const path = status.webPath;
+    let resp;
+    try {
+      // delete preview
+      resp = await fetch(
+        getAdminUrl(siteStore, 'preview', path),
+        {
+          method: 'DELETE',
+          ...getAdminFetchOptions(),
+        },
+      );
+      // also unpublish if published
+      if (status.live && status.live.lastModified) {
+        await this.unpublish();
+      }
+      this.fireEvent(EXTERNAL_EVENTS.RESOURCE_DELETED, path);
+    } catch (e) {
+      // eslint-disable-next-line no-console
+      console.log('failed to delete', path, e);
+    }
+    return {
+      ok: (resp && resp.ok) || false,
+      status: (resp && resp.status) || 0,
+      path,
+    };
+  }
+
   /**
    * Publishes the page at the specified path if <code>config.host</code> is defined.
    * @param {string} path The path of the page to publish
@@ -845,6 +887,39 @@ export class AppStore {
     return resp;
   }
 
+  /**
+   * Unpublishes the current page.
+   * @fires Sidekick#unpublished
+   * @returns {Promise<AdminResponse>} The response object
+   */
+  async unpublish() {
+    if (!this.isContent()) {
+      return null;
+    }
+    const { siteStore, status } = this;
+    const path = status.webPath;
+
+    /**
+     * @type {AdminResponse}
+     */
+    let resp;
+    try {
+      // delete live
+      resp = await fetch(
+        getAdminUrl(siteStore, 'live', path),
+        {
+          method: 'DELETE',
+          ...getAdminFetchOptions(),
+        },
+      );
+      this.fireEvent(EXTERNAL_EVENTS.RESOURCE_UNPUBLISHED, path);
+    } catch (e) {
+      // eslint-disable-next-line no-console
+      console.error('failed to unpublish', path, e);
+    }
+    return resp;
+  }
+
   /**
    * Switches to (or opens) a given environment.
    * @param {string} targetEnv One of the following environments:
@@ -872,7 +947,10 @@ export class AppStore {
     if (!status.webPath) {
       // eslint-disable-next-line no-console
       console.log('not ready yet, trying again in a second ...');
-      window.setTimeout(() => this.switchEnv(targetEnv, open), 1000);
+      window.setTimeout(
+        // istanbul ignore next
+        () => this.switchEnv(targetEnv, open), 1000,
+      );
       return;
     }
     const envOrigin = targetEnv === 'dev' ? siteStore.devUrl.origin : `https://${envHost}`;
@@ -895,16 +973,16 @@ export class AppStore {
 
     // switch or open env
     if (open || this.isEditor()) {
-      window.open(envUrl, open
+      this.openPage(envUrl, open
         ? '' : `hlx-sk-env--${siteStore.owner}/${siteStore.repo}/${siteStore.ref}${status.webPath}`);
-      this.hideWait();
     } else {
-      window.location.href = envUrl;
+      this.loadPage(envUrl);
     }
     this.fireEvent(EXTERNAL_EVENTS.EVIRONMENT_SWITCHED, {
       sourceUrl: href,
       targetUrl: envUrl,
     });
+    this.hideWait();
   }
 
   /**

test/app/store/app.test.js

@@ -35,7 +35,7 @@ import { EventBus } from '../../../src/extension/app/utils/event-bus.js';
 import { EVENTS, MODALS } from '../../../src/extension/app/constants.js';
 import { mockHelixEnvironment, restoreEnvironment } from '../../mocks/environment.js';
 import { getAdminFetchOptions, getAdminUrl } from '../../../src/extension/app/utils/helix-admin.js';
-import { defaultSharepointProfileResponse } from '../../fixtures/helix-admin.js';
+import { defaultSharepointProfileResponse, defaultSharepointStatusResponse } from '../../fixtures/helix-admin.js';
 
 // @ts-ignore
 window.chrome = chromeMock;
@@ -394,6 +394,112 @@ describe('Test App Store', () => {
     });
   });
 
+  describe('switchEnv', async () => {
+    const mockStatus = defaultSharepointStatusResponse;
+    let sandbox;
+    let openPage;
+    let loadPage;
+    let instance;
+
+    beforeEach(() => {
+      sandbox = sinon.createSandbox();
+      sandbox.stub(window, 'fetch').resolves(new Response(JSON.stringify({
+        webPath: '/somepath',
+      })));
+      instance = appStore;
+      instance.siteStore = {
+        owner: 'adobe',
+        repo: 'aem-boilerplate',
+        ref: 'main',
+        innerHost: new URL(mockStatus.preview.url).hostname,
+        outerHost: new URL(mockStatus.live.url).hostname,
+        devUrl: new URL('https://localhost:3000'),
+      };
+
+      // Mock other functions
+      sandbox.stub(instance, 'fireEvent');
+
+      openPage = sandbox.spy();
+      loadPage = sandbox.spy();
+      sandbox.stub(instance, 'openPage').callsFake(openPage);
+      sandbox.stub(instance, 'loadPage').callsFake(loadPage);
+    });
+
+    afterEach(() => {
+      sandbox.restore();
+    });
+
+    it('switches from editor to preview', async () => {
+      instance.location = new URL(mockStatus.edit.url);
+      instance.status = mockStatus;
+      await instance.switchEnv('preview');
+      expect(openPage.calledWith(mockStatus.preview.url)).to.be.true;
+    });
+
+    it('switches from preview to editor', async () => {
+      instance.location = new URL(mockStatus.preview.url);
+      instance.status = mockStatus;
+      await instance.switchEnv('edit');
+      expect(loadPage.calledWith(mockStatus.edit.url)).to.be.true;
+    });
+
+    it('switches from live to preview', async () => {
+      instance.location = new URL(mockStatus.live.url);
+      instance.status = mockStatus;
+      await instance.switchEnv('preview');
+      expect(loadPage.calledWith(mockStatus.preview.url)).to.be.true;
+    });
+
+    it('switches from preview to live opening a new window', async () => {
+      instance.location = new URL(mockStatus.preview.url);
+      instance.status = mockStatus;
+      await instance.switchEnv('live', true);
+      expect(openPage.calledWith(mockStatus.live.url)).to.be.true;
+    });
+
+    it('switches from preview to dev', async () => {
+      instance.location = new URL(mockStatus.live.url);
+      instance.status = mockStatus;
+      await instance.switchEnv('dev');
+      const devUrl = new URL(
+        new URL(mockStatus.preview.url).pathname,
+        'https://localhost:3000',
+      );
+      expect(loadPage.calledWith(devUrl.href)).to.be.true;
+    });
+
+    it('switches to live instead of prod', async () => {
+      instance.location = new URL(mockStatus.preview.url);
+      instance.status = mockStatus;
+      await instance.switchEnv('prod');
+      expect(loadPage.calledWith(mockStatus.live.url)).to.be.true;
+    });
+
+    it('aborts on invaid target env', async () => {
+      instance.location = new URL(mockStatus.preview.url);
+      instance.status = mockStatus;
+      await instance.switchEnv('foo');
+      expect(openPage.calledOnce).to.be.false;
+      expect(loadPage.calledOnce).to.be.false;
+    });
+
+    it('aborts on status error', async () => {
+      instance.location = new URL(mockStatus.preview.url);
+      instance.status.error = 'some error occurred';
+      await instance.switchEnv('live');
+      expect(openPage.calledOnce).to.be.false;
+      expect(loadPage.calledOnce).to.be.false;
+    });
+
+    it('retries if status not ready yet', async () => {
+      const consoleSpy = sandbox.spy(console, 'log');
+      instance.location = new URL(mockStatus.preview.url);
+      instance.status = {};
+      await instance.switchEnv('live');
+      expect(consoleSpy.calledWith('not ready yet, trying again in a second ...')).to.be.true;
+    });
+  });
+
   describe('update', async () => {
     let sandbox;
     let fakeFetch;