reactioncommerce · aldeed · Aug 16, 2018 · Jul 9, 2018 · Jul 10, 2018 · Jul 10, 2018
diff --git a/imports/collections/schemas/registry.js b/imports/collections/schemas/registry.js
@@ -282,7 +282,8 @@ export const CorePackageConfig = PackageConfig.clone().extend({
   },
   "settings.openexchangerates.appId": {
     type: String,
-    label: "Open Exchange Rates App Id"
+    label: "Open Exchange Rates App Id",
+    optional: true
   },
   "settings.openexchangerates.refreshPeriod": {
     type: String,
@@ -313,12 +314,23 @@ export const CorePackageConfig = PackageConfig.clone().extend({
   },
   "settings.cart": {
     type: Object,
-    defaultValue: {}
+    defaultValue: {},
+    optional: true
   },
   "settings.cart.cleanupDurationDays": {
     type: String,
     label: "Cleanup Schedule",
     defaultValue: "older than 3 days"
+  },
+  "settings.sitemaps": {
+    type: Object,
+    defaultValue: {},
+    optional: true
+  },
+  "settings.sitemaps.refreshPeriod": {
+    type: String,
+    label: "Sitemap refresh period",
+    defaultValue: "every 24 hours"
   }
 });
 

diff --git a/imports/plugins/core/dashboard/client/templates/shop/settings/settings.html b/imports/plugins/core/dashboard/client/templates/shop/settings/settings.html
@@ -109,6 +109,11 @@
       {{> afQuickField name='settings.google.clientId'}}
       {{> afQuickField name='settings.google.apiKey'}}
       {{> afQuickField name='settings.cart.cleanupDurationDays' placeholder="older than 3 days"}}
+      {{#if isPackageEnabled "reaction-sitemap-generator"}}
+        <div>
+          {{> React component=SitemapSettingsContainer packageData=packageData}}
+        </div>
+      {{/if}}
       {{> shopSettingsSubmitButton}}
     {{/autoForm}}
   </div>

diff --git a/imports/plugins/core/dashboard/client/templates/shop/settings/settings.js b/imports/plugins/core/dashboard/client/templates/shop/settings/settings.js
@@ -1,10 +1,10 @@
-import _ from "lodash";
 import { Meteor } from "meteor/meteor";
 import { Template } from "meteor/templating";
 import { AutoForm } from "meteor/aldeed:autoform";
 import { Reaction, i18next } from "/client/api";
 import { Packages, Shops } from "/lib/collections";
 import { Media } from "/imports/plugins/core/files/client";
+import SitemapSettingsContainer from "/imports/plugins/included/sitemap-generator/client/containers/sitemap-settings-container";
 import ShopBrandMediaManager from "./ShopBrandMediaManager";
 
 
@@ -34,7 +34,7 @@ Template.shopSettings.helpers({
     });
 
     let selectedMediaId;
-    if (shop && _.isArray(shop.brandAssets)) {
+    if (shop && Array.isArray(shop.brandAssets)) {
       selectedMediaId = shop.brandAssets[0].mediaId;
     }
 
@@ -157,5 +157,13 @@ Template.optionsShopSettings.helpers({
       name: "core",
       shopId: Reaction.getShopId()
     });
+  },
+
+  isPackageEnabled(name) {
+    return Reaction.isPackageEnabled(name);
+  },
+
+  SitemapSettingsContainer() {
+    return SitemapSettingsContainer;
   }
 });
diff --git a/imports/plugins/included/notifications/client/components/notificationRoute.js b/imports/plugins/included/notifications/client/components/notificationRoute.js
@@ -28,7 +28,16 @@ class NotificationRoute extends Component {
       });
       Reaction.showActionView(actionViewData);
     } else {
-      Reaction.Router.go(notify.url);
+      // Determine if url's basename ends in a file extension (i.e. /sitemap.xml).
+      // If so, use window.location to break out of the Reaction app, otherwise navigate via Reaction router
+      const { url } = notify;
+      const urlSplit = url.split("/");
+      const doesBasenameHavePeriod = urlSplit[urlSplit.length - 1].includes(".");
+      if (doesBasenameHavePeriod) {
+        window.location = url;
+      } else {
+        Reaction.Router.go(url);
+      }
     }
 
     const { markOneAsRead } = this.props;

diff --git a/imports/plugins/included/sitemap-generator/client/components/sitemap-settings.js b/imports/plugins/included/sitemap-generator/client/components/sitemap-settings.js
@@ -0,0 +1,59 @@
+import React, { Component, Fragment } from "react";
+import PropTypes from "prop-types";
+import Select from "@reactioncommerce/components/Select/v1";
+import Button from "@reactioncommerce/components/Button/v1";
+import { Translation } from "/imports/plugins/core/ui/client/components";
+
+export default class SitemapSettings extends Component {
+  static propTypes = {
+    onGenerateClick: PropTypes.func.isRequired,
+    onRefreshPeriodChange: PropTypes.func.isRequired,
+    refreshPeriod: PropTypes.string.isRequired
+  };
+
+  render() {
+    const { onRefreshPeriodChange, onGenerateClick, refreshPeriod } = this.props;
+    const refreshOptions = [
+      {
+        label: "Every 24 hours",
+        value: "every 24 hours"
+      },
+      {
+        label: "Every 12 hours",
+        value: "every 12 hours"
+      },
+      {
+        label: "Every hour",
+        value: "every 1 hour"
+      }
+    ];
+
+    return (
+      <Fragment>
+        <div className="form-group" data-required="true">
+          <label className="control-label" htmlFor="settings.sitemaps.refreshPeriod">Sitemap refresh period</label>
+          <Select
+            options={refreshOptions}
+            onChange={onRefreshPeriodChange}
+            value={refreshPeriod}
+          />
+          <input
+            type="hidden"
+            name="settings.sitemaps.refreshPeriod"
+            data-schema-key="settings.sitemaps.refreshPeriod"
+            value={refreshPeriod}
+          />
+        </div>
+        <div className="form-group pull-left" style={{ width: "100%", marginBottom: 30 }}>
+          <Button actionType="secondary" className="pull-right" isShortHeight onClick={onGenerateClick}>
+            <i className="rui font-icon fa fa-refresh" />&nbsp;
+            <Translation defaultValue="Refresh sitemap" i18nKey={"shopSettings.refreshSitemapsNow"} />
+          </Button>
+          <p className="pull-right" style={{ marginTop: 6, marginRight: 10 }}>
+            <a href="/sitemap.xml" target="_blank">View sitemap</a>
+          </p>
+        </div>
+      </Fragment>
+    );
+  }
+}
diff --git a/imports/plugins/included/sitemap-generator/client/containers/sitemap-settings-container.js b/imports/plugins/included/sitemap-generator/client/containers/sitemap-settings-container.js
@@ -0,0 +1,55 @@
+import React, { Component } from "react";
+import PropTypes from "prop-types";
+import { Meteor } from "meteor/meteor";
+import { i18next } from "/client/api";
+import SitemapSettings from "../components/sitemap-settings";
+
+class SitemapSettingsContainer extends Component {
+  static propTypes = {
+    packageData: PropTypes.object
+  };
+
+  constructor(props) {
+    super(props);
+    const { packageData } = props;
+    const { settings } = packageData;
+    const { sitemaps: sitemapSettings = {} } = settings;
+
+    this.state = {
+      refreshPeriod: sitemapSettings.refreshPeriod || "every 24 hours"
+    };
+  }
+
+  handleRefreshPeriodChange = (refreshPeriod) => {
+    if (refreshPeriod) {
+      this.setState({ refreshPeriod });
+    }
+  };
+
+  handleGenerateClick = () => {
+    Meteor.call("sitemaps/generate", (error) => {
+      if (error) {
+        Alerts.toast(`${i18next.t("shopSettings.sitemapRefreshFailed", {
+          defaultValue: "Sitemap refresh failed"
+        })}: ${error}`, "error");
+      } else {
+        Alerts.toast(i18next.t("shopSettings.sitemapRefreshInitiated", {
+          defaultValue: "Refreshing the sitemap can take up to 5 minutes. You will be notified when it is completed."
+        }), "success");
+      }
+    });
+  };
+
+  render() {
+    const { refreshPeriod } = this.state;
+    return (
+      <SitemapSettings
+        onRefreshPeriodChange={this.handleRefreshPeriodChange}
+        onGenerateClick={this.handleGenerateClick}
+        refreshPeriod={refreshPeriod}
+      />
+    );
+  }
+}
+
+export default SitemapSettingsContainer;
diff --git a/imports/plugins/included/sitemap-generator/lib/collections/schemas/sitemaps-schema.js b/imports/plugins/included/sitemap-generator/lib/collections/schemas/sitemaps-schema.js
@@ -0,0 +1,27 @@
+import SimpleSchema from "simpl-schema";
+import { registerSchema } from "@reactioncommerce/schemas";
+import { check } from "meteor/check";
+import { Tracker } from "meteor/tracker";
+
+/**
+ * @name SitemapsSchema
+ * @memberof Schemas
+ * @summary Schema for Sitemaps collection
+ * @type {SimpleSchema}
+ */
+export const SitemapsSchema = new SimpleSchema({
+  shopId: {
+    type: String
+  },
+  handle: {
+    type: String
+  },
+  xml: {
+    type: String
+  },
+  createdAt: {
+    type: Date
+  }
+}, { check, tracker: Tracker });
+
+registerSchema("Sitemaps", SitemapsSchema);
diff --git a/imports/plugins/included/sitemap-generator/lib/collections/sitemaps.js b/imports/plugins/included/sitemap-generator/lib/collections/sitemaps.js
@@ -0,0 +1,11 @@
+import { Mongo } from "meteor/mongo";
+import { SitemapsSchema } from "./schemas/sitemaps-schema";
+
+/**
+ * @name Sitemaps
+ * @memberof Collections
+ * @summary Collection for auto-generated XML sitemaps
+ */
+export const Sitemaps = new Mongo.Collection("Sitemaps");
+
+Sitemaps.attachSchema(SitemapsSchema);
diff --git a/imports/plugins/included/sitemap-generator/register.js b/imports/plugins/included/sitemap-generator/register.js
@@ -0,0 +1,8 @@
+import Reaction from "/imports/plugins/core/core/server/Reaction";
+
+Reaction.registerPackage({
+  label: "Sitemap Generator",
+  name: "reaction-sitemap-generator",
+  icon: "fa fa-vine",
+  autoEnable: true
+});
diff --git a/imports/plugins/included/sitemap-generator/server/i18n/en.json b/imports/plugins/included/sitemap-generator/server/i18n/en.json
@@ -0,0 +1,13 @@
+[{
+  "i18n": "en",
+  "ns": "reaction-sitemap-generator",
+  "translation": {
+    "reaction-sitemap-generator": {
+      "shopSettings": {
+        "refreshSitemapsNow": "Refresh sitemap",
+        "sitemapRefreshInitiated": "Refreshing the sitemap can take up to 5 minutes. You will be notified when it is completed.",
+        "sitemapRefreshFailed": "Sitemap refresh failed"
+      }
+    }
+  }
+}]
diff --git a/imports/plugins/included/sitemap-generator/server/i18n/index.js b/imports/plugins/included/sitemap-generator/server/i18n/index.js
@@ -0,0 +1,5 @@
+import { loadTranslations } from "/imports/plugins/core/core/server/startup/i18n";
+
+import en from "./en.json";
+
+loadTranslations([en]);
diff --git a/imports/plugins/included/sitemap-generator/server/index.js b/imports/plugins/included/sitemap-generator/server/index.js
@@ -0,0 +1,21 @@
+import { Meteor } from "meteor/meteor";
+import { WebApp } from "meteor/webapp";
+import { Sitemaps } from "../lib/collections/sitemaps";
+import generateSitemapsJob from "./jobs/generate-sitemaps-job";
+import handleSitemapRoutes from "./middleware/handle-sitemap-routes";
+import methods from "./methods";
+
+// Load translations
+import "./i18n";
+
+// Create a compound index to support queries by shopId or shopId & handle
+Sitemaps.rawCollection().createIndex({ shopId: 1, handle: 1 }, { background: true });
+
+// Setup sitemap generation recurring job
+generateSitemapsJob();
+
+// Sitemap front-end routes
+WebApp.connectHandlers.use(handleSitemapRoutes);
+
+// Init methods
+Meteor.methods(methods);
diff --git a/imports/plugins/included/sitemap-generator/server/jobs/generate-sitemaps-job.js b/imports/plugins/included/sitemap-generator/server/jobs/generate-sitemaps-job.js
@@ -0,0 +1,63 @@
+import Hooks from "@reactioncommerce/hooks";
+import Logger from "@reactioncommerce/logger";
+import { Jobs } from "/lib/collections";
+import Reaction from "/imports/plugins/core/core/server/Reaction";
+import { Job } from "/imports/plugins/core/job-collection/lib";
+import generateSitemaps from "../lib/generate-sitemaps";
+
+/**
+ * @name generateSitemapsJob
+ * @summary Initializes and processes a job that regenerates XML sitemaps
+ * @returns {undefined}
+ */
+export default function generateSitemapsJob() {
+  const jobId = "sitemaps/generate";
+
+  // Hook that schedules job
+  Hooks.Events.add("afterCoreInit", () => {
+    const settings = Reaction.getShopSettings();
+    const { sitemaps } = settings;
+    const refreshPeriod = (sitemaps && sitemaps.refreshPeriod) || "every 24 hours";
+
+    Logger.debug(`Adding ${jobId} to JobControl. Refresh ${refreshPeriod}`);
+
+    new Job(Jobs, jobId, {})
+      .retry({
+        retries: 5,
+        wait: 60000,
+        backoff: "exponential"
+      })
+      .repeat({
+        schedule: Jobs.later.parse.text(refreshPeriod)
+      })
+      .save({
+        cancelRepeats: true
+      });
+  });
+
+  // Function that processes job
+  const sitemapGenerationJob = Jobs.processJobs(jobId, {
+    pollInterval: 60 * 60 * 1000, // backup polling, see observer below
+    workTimeout: 180 * 1000
+  }, (job, callback) => {
+    Logger.debug(`Processing ${jobId} job`);
+
+    const { notifyUserId = "" } = job.data;
+    generateSitemaps({ notifyUserId });
+
+    const doneMessage = `${jobId} job done`;
+    Logger.debug(doneMessage);
+    job.done(doneMessage, { repeatId: true });
+    callback();
+  });
+
+  // Observer that triggers processing of job when ready
+  Jobs.find({
+    type: jobId,
+    status: "ready"
+  }).observe({
+    added() {
+      return sitemapGenerationJob.trigger();
+    }
+  });
+}