RubyGems - workarea - Versions diffs - 3.4.45 → 3.5.0.beta.1 - Mend

workarea 3.4.45 → 3.5.0.beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8c578d3f6ae54da8b8626653682b8a6eb6e8cd482d54f124c620d6d4e1a0514
-  data.tar.gz: 9f78c55818d83fea3dcfd7df34210012d8d7f43abf79582bc9d91ecd070f476b
+  metadata.gz: 5d185842403bac844fda8dc3aaa3c2d95ab10cc118c2340995a1163312bdb548
+  data.tar.gz: 546ff669389350c217233e4a37ca7d7670170cbfef8b16fe2498e75d18a26155
 SHA512:
-  metadata.gz: 0ee6f81aa9e2e2b77d554ba54405da873ceebd9a06b2434d5a3bf1c21b7a3aa313ddfb3f5fa37fb94c2997a7d01d4c455d61384a92f5d67d3ef32e3ea2329197
-  data.tar.gz: 0f5f2b70ebe4c2414cec2acbaee5f0856778bbd688fcdf3b357a65d77a7e0714645cac655a3defe9f12bc63c65932df807aea5c074063e87bdfb42b91bbae607
+  metadata.gz: 11eeb85e4b1eed6d61ebc85bf606479ba5c20c4b6c6eb4df644dbc89baafd6dabf00c655eb7ebfdecf4ad9d8b3fbd75a5f5d01cbecb88e987f924afe56315e16
+  data.tar.gz: 0e467db6433045462068a18881e31609e1e1d18b9c423cd12df51b280454bb1275385cf010093721bb78aaa315237b16813edcd7f16eadfabdccff3784defc33

data/.rubocop.yml CHANGED Viewed

@@ -95,7 +95,7 @@ Layout/EmptyLinesAroundModuleBody:
     - 'storefront/app/view_models/workarea/storefront/search_customization_content.rb'
     - 'testing/lib/workarea/testing/warning_suppressor.rb'
-Layout/FirstArgumentIndentation:
+Layout/IndentFirstArgument:
   Enabled: true
   Exclude:
     - 'admin/test/helpers/workarea/admin/releases_helper_test.rb'
@@ -198,13 +198,13 @@ Layout/SpaceInsideParens:
     - 'core/spec/models/workarea/order/queries_spec.rb'
 # Detect hard tabs, no hard tabs.
-Layout/IndentationStyle:
+Layout/Tab:
   Enabled: true
   Exclude:
     - 'core/vendor/active_shipping/lib/active_shipping/carriers/canada_post.rb'
 # Blank lines should not have any spaces.
-Layout/TrailingEmptyLines:
+Layout/TrailingBlankLines:
   Enabled: true
 # No trailing whitespace.

data/CHANGELOG.md CHANGED Viewed

@@ -1,1125 +1,366 @@
-Workarea 3.4.45 (2021-01-20)
+Workarea 3.5.0.beta.1 (2019-11-07)
 --------------------------------------------------------------------------------
-*   Improve password performance when running tests
-    Lowering the bcrypt cost lowers the time required to encrypt a password, at the
-    cost of increasing the speed at which an attacker can try to crack the password.
-    This is an acceptable tradeoff for improving performance of running tests. This
-    shaves about 5 minutes off of the admin tests.
-    Hat tip to Jeff Yucis for discovery.
-    Ben Crouse
-*   Bump redcarpet version to fix security warnings
-    Redcarpet released a security fix, so ensure using a version with that fix.
-    Redcarpet is only used to render help pages in the admin, so the vulnerability in Workarea is minimal.
-    Ben Crouse
-*   Improve image URL detection for dialog_buttons
-    This only worked if the URL had only one dot (before the file extension)
-    and no query parameters. Run it through the URL parser to provide more
-    robust handling.
-    Jonathan Mast
-Workarea 3.4.44 (2020-11-25)
---------------------------------------------------------------------------------
-*   Bump version for release
-    Ben Crouse
-*   Bump jquery-rails to patch XSS vulnerabilities
+*   Allow storing non-unique recently viewed items
+    This will allow us to do better segmenting in the future with rules like
+    "viewed this product more than once".
+    WORKAREA-88
     Ben Crouse
-*   Add warning to inform developers why redirects aren't working locally
-    This has confused developers a couple of times, so hopefully adding a
-    warning will help.
-    Ben Crouse
-*   Fix Elasticsearch indexes when changing locales in tests
-    This ensures the proper search indexes are in place when you switch
-    locales for an integration test.
-    Ben Crouse
-*   Prevent Error on Missing Custom Template View Model Class
-    Typically, custom product templates use their own subclass of
-    `Workarea::Storefront::ProductViewModel`, but this isn't supposed to be
-    necessary if there's no custom logic that needs to be in the view model
-    layer. However, when developers tried to add a custom template without
-    the view model, they received an error. To prevent this, Workarea will
-    now catch the `NameError` thrown by `Storefront::ProductViewModel.wrap`
-    in the event of a custom product template not having a view model
-    defined.
-    WORKAREA-304
-    Tom Scott
-*   Fix Missing Instance Variable In Cart Items View
-    The `@cart` instance variable was only being conditionally defined if
-    `current_order.add_item` succeeded. This caused an error if `#add_item`
-    happens to fail when calling `POST /cart/items` from the storefront,
-    resulting in a 500 error. To prevent this error, the definition of this
-    variable has been moved above the condition.
-    WORKAREA-303
+*   Fix Incorrect Test Setup
+    The `Pricing::Calculators::Calculator.test_adjust` method accepts two
+    arguments, and expects the first argument is going to be of type
+    `Order`, but in a `TaxCalculator` test only a shipping was being passed
+    in. Update this test to use the correct syntax so that other downstream
+    projects that expect data to be on an Order won't get confused.
     Tom Scott
-*   Shorten index name
+*   Allow an asset to be tagged 'og-default' to use for open graph images
-    Mongo will raise when index names exceed a certain length. For example,
-    having a long Workarea.config.site_name could cause this.
-    Ben Crouse
+    WORKAREA-76
+    Matt Duffy
-*   Fix missing jump to positions breaking jump to
+*   Move segment overriding into middleware
-    Ruby raises when nil is compared, so default these values.
+    To enable correct segment headers and caching, segment overriding will
+    need to happen in middleware. To accomplish this, we'll need to store
+    whether someone is an admin in their metrics.
+    This has a nice side-effect of not needing the `cache` cookie anymore,
+    so that's being removed.
     Ben Crouse
+*   Add buttons to allow admin users to subscribe/unsubscribe from comments
+    WORKAREA-75
+    Matt Duffy
-Workarea 3.4.43 (2020-11-03)
---------------------------------------------------------------------------------
-*   Delete old user metrics after merging
-    This will ensure the consistency of user-based reports.
+*   Add browser info options for segment rules
+    This also replaces Workarea's `Robots` class with use of the `browser`
+    gem, which keeps far better and updated checks.
     Ben Crouse
-*   Be more specific when matching reverts in changelogs
+*   Adds graceful handling of timestamps from CSV imports
-    This change will allow starting commit messages with the word Revert
-    without the changelog task ignoring the commit.
+    WORKAREA-24
+    Matt Duffy
-    Ben Crouse
+*   Don't default to S3 asset store
-*   Add metrics explanation for users
+    This causes problems spinning up environments in other hosting setups
+    where S3 isn't available or desired.
-    This additional explanation is meant to communicate why customer
-    insights may occasionally mismatch with the orders card.
+    To retain the old behavior (which you'll want if you're on the Workarea
+    Commerce Cloud) drop this into an initializer:
+    `Workarea.config.asset_store = (Rails.env.test? || Rails.env.development?) ?
+    :file_system : :s3`
+    WORKAREA-32
     Ben Crouse
-*   Add Note To Category Default Sort Edit
+*   Use private HTTP caching headers for responses with segmented content
-    The selected `default_sort` of a category will be always used in the
-    storefront. If the category contains featured products, this sort will
-    be labelled "Featured", and this might prove confusing to some admins.
-    To resolve this, add a note just below the dropdown indicating what will
-    occur when products are featured in the category.
+    If a page has segmented content, it can't be cached by any upstream HTTP
+    caches because the user's segments can change request-by-request.
-    WORKAREA-289
-    Tom Scott
+    Our solution is to use the headers we've been using for cached responses
+    if the page has no segmented content. If it does have segmented content,
+    change those headers to force refetching every time, while allowing the
+    server to return a 304 to eliminate sending unnecessary responses.
-*   Include referrer in ending impersonation redirect fallbacks
+    This is being done in a piece of middleware to ensure to
+    Rack::Cache the headers look the same. This allows us to still cache
+    complete responses in Rack::Cache for requests with segmented content.
-    When ending an impersonation, this changes to allow redirecting to the referrer
-    if the return_to parameter isn't present. Better UX for ending
-    impersonations while working in the admin.
-    WORKAREA-293
+    This commit also refactors the middleware that sets this all up into a
+    single ApplicationMiddleware so it's easier to see everything going on
+    in one file.
+    WORKAREA-36
     Ben Crouse
-*   Merge metrics when a user's email is updated
-    This ensures the old metrics info stays around after the email change.
+*   Don't shell out to bundler to get gem path
-    WORKAREA-294
+    This can cause problems if bundler outputs warnings/errors. There's a safe way to do it in Ruby, so use that instead.
+    Fixes #191
     Ben Crouse
+*   Add a hook method to allow extending product's activeness
-Workarea 3.4.42 (2020-10-14)
---------------------------------------------------------------------------------
-*   Prevent Clearing Out Navigable When Saving Taxons
-    The `WORKAREA.newNavigationTaxons` module was looking in the wrong place
-    for the selected navigable item, therefore the `selected` var would
-    always return `undefined`, causing the `navigable_id` param to be
-    blank every time. Fix this by querying for the correct DOM node (the
-    `[data-new-navigation-taxon]` element) and pulling the selected ID from
-    its data.
-    WORKAREA-297
-    Fixes #534
-    Tom Scott
-*   Patch RefererParser for Android URLs
-    Android App URLs have a special `android-app://` scheme that is rejected
-    by the currently released version of the `referer-parser` gem. The code
-    in this patch already exists in the master branch of the gem, but this
-    has not yet been released, and if Android users browse the storefront it
-    can generate an error when collecting referer information. In case a
-    referer cannot be parsed, Workarea also rescues the error so that
-    checkout requests are not blocked.
-    WORKAREA-295
-    Fixes #531
-    Tom Scott
-*   Try to clarify how to use search synonyms
-    There has been repeated confusion around why/how to use synonyms, so this is an attempt to clarify.
+    Plugins like package products need a place to add more logic to a
+    product's activeness without having to reimplement all of active's
+    `super`. With the addition of segments, this becomes a bunch of
+    code.
     Ben Crouse
+*   Allow content to be appended to head element in Content
+    WORKAREA-4
+    Curt Howard
-Workarea 3.4.41 (2020-09-30)
---------------------------------------------------------------------------------
-*   Rename Admin::ProductViewModel#options to avoid conflict with normal options method
+*   Add notes about admin config fields and encryption to upgrade guide
+    WORKAREA-25
     Matt Duffy
-*   Improve clarity of discount verbiage
-    This hopes to address some recent confusion around how the discount
-    works.
-    Ben Crouse
-*   Fix safe navigation method calls
-    This will raise if the menu content is nil.
-    Ben Crouse
-*   Redirect back to the previous page after stopping impersonation
-    Currently we redirect to the user's show page, which can be pretty
-    disorienting.
-    Ben Crouse
-Workarea 3.4.40 (2020-09-16)
---------------------------------------------------------------------------------
-*   Fix Editing Product Images in Admin
-    When an image does not include an option, the edit page errors because
-    `#parameterize` cannot be called on `@image.option` since that is
-    returning `nil`. Additionally, the line of code in which this is called
-    is meant to set an ID attribute on the element for which an image is
-    rendered. There doesn't seem to be anything in our codebase that uses
-    this, and furthermore since there's no validation for unique options per
-    set of product images, this could cause a duplicate ID error in certain
-    scenarios. To resolve this, the ID attribute has been removed from this
-    `<img>` tag.
-    WORKAREA-254
-    Tom Scott
-*   Improve display of disabled toggles
-    When a toggle button is disabled, it should reflect that visually
-    instead of just looking like it should be functional.
+*   Integrate segments into discount cache keys
+    Also, since we won't be able to expire keys in a performant way
+    (delete_matched is O(N) on the number of keys in Redis), we'll have to
+    remove discount cache busting.
     Ben Crouse
-*   Remove CSV Messaging For Options Fields
-    This removes the "Comma separated: just, like, this" messaging and
-    tooltip that explains more about comma-separated fields for filters and
-    details. Options do not have these same constraints, and this help
-    bubble just serves as a point of confusion for admins.
-    WORKAREA-266
-    Tom Scott
-Workarea 3.4.39 (2020-09-01)
---------------------------------------------------------------------------------
-*   Set Default Inventory Policy to "Standard" in Create Product Workflow
-    When creating a new product through the workflow, setting the
-    "Inventory" on a particular SKU would still cause the `Inventory::Sku`
-    to be created with the "Ignore" policy rather than "Standard". Setting
-    inventory on a SKU now automatically causes the `Inventory::Sku` record
-    to be created with a policy of "Standard" so as to deduct the given
-    inventory to the varaint. When no inventory is given, Workarea will fall
-    back to the default of "Ignore".
-    WORKAREA-265
-    Tom Scott
-*   Handle missing or invalid current impersonation
-    This surfaced as a random failing test, this should make the feature more robust.
+*   Fix changeset loading missing root
+    Can raise an error when rendering changesets on the release's show page.
     Ben Crouse
-*   Fix wrong sorting on default admin index pages
-    The query for an admin index page can end up inadvertantly introduce a
-    scoring variation, which can cause results to not match the `updated_at`
-    default sort.
-    This makes `updated_at` the true default sort, and allows the general
-    admin search to override, where `_score` is still the desired default
-    sort.
-    Ben Crouse
-Workarea 3.4.38 (2020-08-19)
---------------------------------------------------------------------------------
-*   Return Status of `Checkout#update`
-    For APIs and other consumers of the Checkout model, return a boolean
-    response from the `#update` method to signify whether the operation
-    succeeded or failed. This response is used directly in the API to return
-    an `:unprocessable_entity` response code when an update operation fails.
-    WORKAREA-253
+*   Implement Tribute.js for comment notifications
-    Tom Scott
+    WORKAREA-6
+    Curt Howard
-*   Remove port from host configuration in installer
+*   Fix issue around Visit#referrer and Puma
-    Ports aren't part of hosts, this causes problems when the value is used
-    like a true host.
+    Curt Howard
-    This PR also fixes mailer links with missing ports as a result of this
-    change.
+*   Add segmented icons to index pages
     Ben Crouse
-*   Bump Chartkick to fix bundler audit warning
-    The vulnerability won't affect Workarea in use, but it'll be easier to fix builds doing this.
+*   Add segment icon to content blocks UI
     Ben Crouse
-*   Allow inquiry subjects to be localized
-    WORKAREA-238
+*   Rework FeaturedCategorizations to allow easier decoration
+    WORKAREA-21
     Matt Duffy
+*   Removes Puma auto-configuration (#151)
+    This is going to part of the `workarea-commerce_cloud` gem going forward. If you're a subscriber to the Workarea Commerce Cloud service, you should include that gem in your project to get Puma and other configuration for that service.
+    Jesse McPherson
-Workarea 3.4.37 (2020-07-22)
---------------------------------------------------------------------------------
-*   Configure Sliced Credit Card Attributes
-    To prevent an unnecessary decoration of the `Workarea::Payment` class,
-    the attributes sliced out of the Hash given to `Workarea::Payment#set_credit_card`
-    is now configurable in initializers. This same set of attributes is also
-    used in the `Users::CreditCardsController`, so the configuration will be
-    reused when users are attempting to add a new credit card to their
-    account.
-    WORKAREA-257
-    Tom Scott
-*   Setup PlaceOrderIntegrationTest in a Method
-    Currently, decorating the PlaceOrderIntegrationTest to edit the way its
-    set up (such as when adding an additional step) is impossible, you have
-    to basically copy everything out of the `setup` block and duplicate it
-    in your tests. Setup blocks should be methods anyway, so convert this to
-    a method and allow it to be decorated in host apps.
-    Tom Scott
-*   Improve Content Area Select UX
-    Remove the current content name and replace it with a static label
-    indicating what the `<select>` menu to the right of it is selecting,
-    which is the current content area. This UI only displays when there are
-    multiple areas for a given `Content`.
+*   Fix Product URL In Breadcrumbs
-    WORKAREA-244
+    The `storefront_url_for` method doesn't handle models other than taxons,
+    but the Schema.org helpers use it to render breadcrumb URLs in the
+    `BreadcrumbList` for any model that's in the breadcrumbs. To prevent
+    incorrect URLs from showing up in the breadcrumbs, the
+    `Navigation::Breadcrumbs` class has been modified to accept a model
+    object as its `:last` parameter, instead of just a name, to be added to
+    an arbitrary `Navigation::Taxon` created for the purpose of rendering
+    both the name and URL of the final navigation taxon. This wasn't needed
+    prior to the introduction of Schema.org's `BreadcrumbList`, because the
+    final URL of breadcrumbs was always left out. The helper methods that
+    render the breadcrumbs will continue to leave out the final taxon's URL,
+    but for breadcrumbs in Schema.org, the URL will now be included.
+    (#83)
     Tom Scott
+*   Apply tax to items that do not require shipping
+    * Adds Payment lookup to pricing request
+    * Modifies TaxCalculator to check shipped and not shipped items
+    * Renames TaxApplier to ShippedTaxApplier, Uses TaxApplier for not shipped items
+    Matt Duffy
-Workarea 3.4.36 (2020-07-07)
---------------------------------------------------------------------------------
-*   Patch Jbuilder to Support Varying Cache
-    Previously, admins were not able to see up-to-date data in API requests
-    due to the `#cache!` method in Jbuilder not being patched to skip
-    caching when an admin is logged in. To resolve this, Workarea now
-    applies the same patch to Jbuilder as it does to ActionView. Reading
-    from the cache is now skipped if you're logged in as an admin, and cache
-    keys are appended with the configured `Cache::Varies` just the same as
-    in regular Haml views.
+*   Update order documentation for Workarea 3.5
-    WORKAREA-243
+    Cover suspected fraud.
-    Tom Scott
+    Closes #99
+    Chris Cressman
-*   Bump rack version
+*   Allow setting active by segment
-    Fixes CVE-2020-8184
+    This allows configuring releasable resources to be active only for
+    certain segments. If no segments are specified, it will be active
+    globally. If segments are specified, only those segments will be able to
+    see it.
+    For #102
     Ben Crouse
-*   Add Permissions Append Point to User Workflow
-    This allows a plugin (such as API) to specify permissions categories when
-    admins are either editing or creating a user.
-    WORKAREA-240
+*   Pass Options To `Storefront::UserActivityViewModel`
+    This was an oversight that got caught and fixed in the `flow-io` plugin,
+    but should really be in base since it will allow more control over the
+    product summaries on the recent views action. The `view_model_options`
+    were not getting passed into the `UserActivityViewModel`, and thus the
+    `ProductViewModel` instances that it creates, causing some stale content
+    to appear in the view.
     Tom Scott
+*   Surface Asset alt text and behavior within Content Blocks (#95)
+    In an effort to make the recent updates to alt text overridding in
+    Content Blocks a bit clearer, alt text is now being output:
-Workarea 3.4.35 (2020-06-25)
---------------------------------------------------------------------------------
-*   Reset Geocoder between tests
+    - On the content assets index view
+    - In the title for a content asset summary
-    This ensures individual tests monkeying around with Geocoder config will
-    get restored before the next test runs.
+    Default alt text has been removed from the Content block DSL, which
+    makes the default text come directly from the Asset itself.
-    Ben Crouse
+    The help text displayed on Asset Content Blocks always appears now,
+    better explaining the behavior of this feature.
+    Curt Howard
-*   Use Display Name For Applied Facet Values
+*   Spruce up Timeline UI (#58)
-    When rendering the applied filters, wrap the given facet value in
-    the `facet_value_display_name` helper, ensuring that the value rendered
-    is always human readable. This addresses an issue where if the applied
-    filter value is that of a BSON ID, referencing a model somewhere, the
-    BSON ID was rendered in place of the model's name.
+    The `activity`, `activity-group`, and `date-marker` UIs couple together
+    to create, what's unofficially referred to as, The Timeline UI. These
+    components have been neglected for a long time... until now!
+    Curt Howard
-    WORKAREA-122
+*   Update inventory docs for Workarea 3.5 (#98)
-    Tom Scott
+    Add coverage of inventory collection status, a new concept
+    in Workarea 3.5
+    Chris Cressman
-*   Fix Promo Code Counts in Admin
+*   Update search docs for Workarea 3.5 (#97)
-    Previously, promo codes could only be generated once through the admin,
-    so rendering the count of all promo codes as the count requested to be
-    generated was working out. However, as CSV imports and API updates became
-    more widespread, this began to break down as the `#count` field would
-    have to be updated each time a new set of promo codes were added.
-    Instead of reading from this pre-defined field on the code list, render
-    the actual count of promo codes from the database on the code list and
-    promo codes admin pages.
+    * Remove references to Storefront autocomplete
+    * Update examples to reflect release-specific search documents
+    * Call out the impact of current release and current segments on search documents
+    Chris Cressman
-    WORKAREA-199
+*   Remove Refund Tests
+    Since we're no longer able to regenerate VCR cassettes at-will (due to
+    credentials needing to be scrubbed before pushing to GitHub), this
+    configuration setting is no longer necessary, and furthermore, could
+    potentially prevent legitimate tests from running and catching bugs in
+    the wild. They're only used in one plugin, so remove the tests from base
+    and copy them into the plugin.
     Tom Scott
+*   Refine fullfillment UI around skus and tokens
+    * Change package messaging for items with no carrier and tracking number
+    * Add table of fulfillment tokens associated to an order
+    * Fix paginating fulfillment tokens
-Workarea 3.4.35 (2020-06-25)
---------------------------------------------------------------------------------
-*   Reset Geocoder between tests
-    This ensures individual tests monkeying around with Geocoder config will
-    get restored before the next test runs.
-    Ben Crouse
-*   Use Display Name For Applied Facet Values
-    When rendering the applied filters, wrap the given facet value in
-    the `facet_value_display_name` helper, ensuring that the value rendered
-    is always human readable. This addresses an issue where if the applied
-    filter value is that of a BSON ID, referencing a model somewhere, the
-    BSON ID was rendered in place of the model's name.
+    Closes #93
+    Matt Duffy
-    WORKAREA-122
+*   Remove Schema.org structured data from unspiderable pages
-    Tom Scott
+    There seems to be little reason to bloat the markup of pages explicitly
+    disallowed in our default `robots.txt` file.
-*   Fix Promo Code Counts in Admin
+    Closes #82
+    Curt Howard
-    Previously, promo codes could only be generated once through the admin,
-    so rendering the count of all promo codes as the count requested to be
-    generated was working out. However, as CSV imports and API updates became
-    more widespread, this began to break down as the `#count` field would
-    have to be updated each time a new set of promo codes were added.
-    Instead of reading from this pre-defined field on the code list, render
-    the actual count of promo codes from the database on the code list and
-    promo codes admin pages.
+*   Remove /wish_lists entry from Robots.txt
-    WORKAREA-199
-    Tom Scott
+    This was a relic from a more monolithic age and will be readded by
+    workarea-commerce/workarea-wish-lists#2.
+    Closes #106
+    Curt Howard
+*   Add config field to limit total item count for a single cart
-Workarea 3.4.34 (2020-06-11)
---------------------------------------------------------------------------------
+    Matt Duffy
-*   Bump Geocoder
+*   Update docs to reflect changes in Workarea 3.5
-    This fixes an irrelevant bundler-audit CVE warning, and adds/updates a bunch of Geocoder lookup options. See https://github.com/alexreisner/geocoder/blob/master/CHANGELOG.md for more info.
+    * Storefront price partial removed
+    * `Workarea.with_config` obsoleted by automatic resetting
+    of configuration between tests
+    * Changes to headless Chrome configuration
+    * Changes to Sidekiq queues
+    * Addition of `query_cache` Sidekiq option
+    Chris Cressman
-    Ben Crouse
+*   Add Workarea 3.5 release notes
-*   Add QueuePauser to pause sidekiq queues, pause for search reindexing
+    * Add 3.5 release notes doc
+    * Link to 3.5 release notes doc from release notes index
+    * Rename and modify 3.5 upgrade guide for consistency with 3.4 upgrade guide
+    * Cross-reference 3.5 release notes and upgrade guide
+    * Clean up upgrade guide
+    * Fix title of doc added for v3.5
+    Chris Cressman
-    WORKAREA-236
+*   Factor release id into discount cache keys
+    closes #43
     Matt Duffy
-*   Handle error from attempting to fetch missing S3 CORS configuration
-    WORKAREA-234
+*   Update content block helper to use view helper cache method.
+    This was previously using Rails low level caching, which does not
+    factor in varies headers or prevent caching for admins.
     Matt Duffy
-*   Don't assume promo codes for indexing discounts
-    A custom discount may be implemented that doesn't use promo codes.
-    Ben Crouse
-*   Bump rack-attack to latest version
-    This fixes rack-attack keys without TTLs set piling up in Redis. This has caused hosting problems.
-    Ben Crouse
-*   Bump Kaminari dependency to fix security alert
-    Ben Crouse
-*   Fix incorrect shipping options error flash message
-    A flash error incorrectly showed when the order doesn't require shipping,
-    and addresses are updated.
-    Ben Crouse
-Workarea 3.4.33 (2020-05-26)
---------------------------------------------------------------------------------
-*   Fix incorrect import errors
-    When an import fails due to a missing `DataFile::Import` document, the
-    `ProcessImport` worker will raise a nil error due to the ensure. This
-    fixes by ensuring the `DocumentNotFound` error gets raised.
-    Ben Crouse
-*   Remove caching from direct upload CORS requests
-    The caching continues to give us problems, and this isn't a high-traffic
-    part of the system so there isn't a practical need for it.
-    Ben Crouse
-*   Correct/clarify Dragonfly configuration warning
-    Ben Crouse
-Workarea 3.4.32 (2020-04-28)
---------------------------------------------------------------------------------
-*   Fix bugs with per_page used in page calculation for search queries
-    Even though this shouldn't come from the outside world, it's easy and
-    best to ensure per_page is always a valid number.
-    Ben Crouse
-*   Stub S3 CORS for all integration tests
-    It's annoying and unnecessary to have to stub this for every test that
-    uses an asset picker.
-    WORKAREA-209
-    Ben Crouse
-*   Skip localized activeness test when localized active fields are off
-    Fixes #421
-    Ben Crouse
-*   Fix accepting per_page param from outside world
-    Page size is the most important factor in performance for browse pages,
-    so we don't want these exposed to the outside world out-of-the-box.
-    Ben Crouse
-*   Update grammar for consistency
-    Ben Crouse
-*   Corrected no_available_shipping_options translation typo (#418)
-    JurgenHahn
-*   Fix fullfilment shipped mailer template
+*   Fix showing comments without authors in admin
-    Fullfilment shipped mailer template is using cancellation header.
-    heyqule
-*   Improve visual design of most discounted products insight
-    Ben Crouse
-*   Change HashUpdate to use the setter instead of mutation
-    Simply mutating the value doesn't work when the field is localized.
-    Mongoid's localization behavior only kicks in when you use the setter.
-    Ben Crouse
-*   Allow setting locale fallbacks for a test
-    This is useful if you want to test fallback behavior. Tests in base
-    should be agnostic to whether fallbacks are available or not.
-    Ben Crouse
-*   Fix locale fallback getting unexpectedly autloaded
-    This can happen in the middle of a test suite, causing apparently random
-    test failure. This freedom patch prevents fallbacks from autoloading.
-    We want to let the implementation make that decision.
-    Ben Crouse
-Workarea 3.4.31 (2020-04-15)
---------------------------------------------------------------------------------
-*   Fix harded JS path for admin jump to dropdown
-    This prevents locale from being included in the path to load results.
-    Ben Crouse
-*   Fix index serialization not happening per-locale
-    Previously, indexing was using the same document per-locale. This was
-    masked by Mongoid loading data from the cached document to look correct
-    in most browse scenarios. This fixes it to serialize per-locale so each
-    locale has a separate representation of the document.
-    Ben Crouse
-*   Fix Mongoid not returning defaults for localized fields
-    If a locale is missing from the translations hash, Mongoid returns nil
-    instead of the default specified on the field. That causes all kinds of
-    errors.
-    Ben Crouse
-*   Add missing append points to option-based product templates
-    This append point was only in the generic template, but is useful for
-    plugins.
-    Ben Crouse
-*   Fix dev env autoloading problem with Categorization
-    Ben Crouse
-*   Don't allow more than one valid password reset token per-user
-    Ben Crouse
-Workarea 3.4.30 (2020-03-31)
---------------------------------------------------------------------------------
-*   Fix incorrect placeholder text
-    Ben Crouse
-*   Remove unneeded grid modifier
-    Causes misalignment of the users index aux navigation append point.
-    Ben Crouse
-*   Update critical easymon checks
-    Only elasticsearch, mongodb and redis are critical services for running
-    the application.
+    Comments generated in plugins don't have an author; update the view to
+    handle rendering when the `author_id` is nil.
     Eric Pigeon
-*   Sort jump to results by last updated_at (within each type)
-    This adds updated_at as a sort in jump to so most recent results show at
-    the top within their type. The types are still sorted the same.
-    Ben Crouse
-*   Handle missing price in sell_price method itself
-    Fixes QA issue.
-    WORKAREA-220
-    Tom Scott
+*   add query_cache flag to index workers
-Workarea 3.4.29 (2020-03-17)
---------------------------------------------------------------------------------
-*   Handle Missing Price in Pricing SKUs Admin Index
-    Ensure that price ranges in the pricing SKUs admin index can handle when
-    there are no prices for the SKU.
-    WORKAREA-220
-    Tom Scott
-*   Prevent Tracking Index Filters on JSON Requests
-    When `.json` or Ajax requests are made against the admin, the
-    `#track_index_filters` callback was previously saving off the full path,
-    resulting in issues with the back-linking on the admin UI. To resolve
-    this, Workarea no longer considers `.json` requests on the index page to
-    be a valid `session[:last_index_path]`.
-    WORKAREA-214
-    Tom Scott
-*   Add append point to user index page
-    Jeff Yucis
-*   Add pricing SKU admin append points and align views (#388)
-    Ben Crouse
-*   Improve admin jump to search result types
-    This improves results by limiting the number of results that will show
-    per-type. This allows the user to see a more diverse set of results
-    instead of being overwhelmed by many matches in the top types.
-    Ben Crouse
-Workarea 3.4.28 (2020-03-03)
---------------------------------------------------------------------------------
-*   Fix duplicate suggested searches
-    This can heppen if Predictor and Elasticsearch both return a similar
-    query suggestion.
-    Ben Crouse
-*   Generate weekly and monthly insights for historical data
-    Seeds were only generating insights for a single previous week
-    and month which caused some insights that rely on historical data
-    to not be generated i.e. trending products and searches.
-    WORKAREA-166
     Matt Duffy
-*   Divide By Units Sold in Average Price Calculation
-    When calculating the average price for a product in its insights,
-    Workarea was previously using the amount of orders the product appears
-    in as a divisor. This will not show the correct average price of a
-    product unless every order only has a quantity of 1, since it includes
-    the total price of the item rather than its unit price. To make this
-    number accurately reflect the average price paid per unit on a product,
-    Workarea now uses the number of units sold as the divisor when
-    calculating the average unit price of a product.
-    WORKAREA-215
-    Tom Scott
-*   Randomize Addresses In Seeds
-    Workarea now provides random values for street address, city, and state.
-    All addresses are still in the US, however, so they will still validate
-    with default configuration. This provides more diverse seed data that
-    better reflects the real-life admin.
-    WORKAREA-213
-    Tom Scott
-*   Remove Changes Count in Releases Index
-    The `#changesets_for_releasable` query cannot be optimized any further
-    without using some kind of aggregation. Remove it from the index so it
-    won't cause performance problems.
-    WORKAREA-208
-    Tom Scott
-*   Display Price Range in Pricing SKUs Table
-    The price display in the Pricing SKUs index is somewhat confusing, and
-    would show different "Regular Price" data depending on the sale state of
-    the SKU. To resolve this, replace the two price columns with "Sell
-    Price", a column that renders a price range if there are multiple prices
-    set on the SKU, and indicates that it's always going to show the price
-    that a SKU is being sold for. Otherwise, it will just show the `#sell`
-    price of the SKU.
-    WORKAREA-311
-    Tom Scott
-Workarea 3.4.27 (2020-02-21)
---------------------------------------------------------------------------------
-*   Add Append Point For Post Subtotal Adjustments
-    This adds an append point right underneath the order subtotal and above
-    the shipping total in the admin order attributes view.
-    WORKAREA-183
-    Tom Scott
-*   Handle Deleted Categories in Category Options (#359)
-    In the `options_for_category` method, Workarea did not previously check
-    for whether a category exists, resulting in Mongoid throwing a
-    `DocumentNotFound` error when encountering the method and causing a 500
-    error in the real world. This has now been resolved by rewriting the
-    code to check for whether the model was found before proceeding.
-    `options_for_category` will now return an empty string early.
-    WORKAREA-207
-    Tom Scott
-*   Fix Overwriting CORS Rules for S3 Direct Uploads
-    Workarea previously replaced the existing CORS configuration on the S3
-    bucket used for storing direct uploads with its own, which caused issues
-    for environments that share an S3 bucket between servers (such as ad-hoc
-    demo servers or low-traffic "all-in-one" instances). Instead of
-    replacing the entire configuration, Workarea now reads the existing
-    allowed hosts configuration and appends its own onto the end, preserving
-    the configuration that previously existed. This should address the
-    problem wherein if another server attempts a direct upload, it can
-    revoke the access from previous servers to upload to the S3 bucket,
-    since they were no longer in the CORS configuration.
+*   Eliminate n+1 query from ProductPrimaryNavigation
-    WORKAREA-209
-    Tom Scott
-*   Use correct page title for navigation menus index
-    Luis Mercado
-*   Fix Sidekiq callbacks workers missing due to code reloaded
-    This can cause missing workers in development, which causes callback
-    workers which should be enqueued to be missing.
-    Ben Crouse
-*   Expose shipping service code in admin create and edit screens
-    WORKAREA-190
-    Jeff Yucis
-Workarea 3.4.26 (2020-01-21)
---------------------------------------------------------------------------------
-*   Ignore elements with no ID value when announcing duplicate IDs on-page
-    WORKAREA.duplicateID was throwing a false positive exception when it
-    would find elements containing an `id` attribute with no value
-    specified. This behavior should be allowed, since empty ID values should
-    pose no issues for the developer
-    WORKAREA-184
-    Curt Howard
-*   Order release changesets during publishing, touch releasables after publish
-    WORKAREA-164
-    Matt Duffy
-Workarea 3.4.25 (2020-01-07)
---------------------------------------------------------------------------------
-*   Another hardcoded 2020 fix
-    We've all learned our lesson, right?
-    Ben Crouse
-*   Pin version for wysihtml-rails
-    Setting the version to 0.6.0.beta2 fixes the dependency issues that arose after the new version of Bundler.
-    Jeff Yucis
-*   Use the Rack session ID cookie value for user activity session IDs
-    Rack >= 2.0.8 adds the idea private/public session IDs to prevent timing
-    attacks where a session ID can be stolen. This is big for sessions stored
-    in databases because the session can then be stolen.
-    Workarea only supports a cookie session store, so we can continue to
-    safely use the cookie value of the session ID for metrics lookups.
-    You can learn more about the Rack vulnerability here:
-    https://github.com/rack/rack/security/advisories/GHSA-hrqr-hxpp-chr3
-    Ben Crouse
-Workarea 3.4.24 (2019-12-19)
---------------------------------------------------------------------------------
-*   Fix Performance Test Task
-    Instead of using a Boolean `true` value, use the String `"true"` so Ruby
-    won't complain when running the task.
-    WORKAREA-156
-    Tom Scott
-Workarea 3.4.23 (2019-12-17)
---------------------------------------------------------------------------------
-*   Bump Puma version to fix security advisory
-    See https://github.com/advisories/GHSA-7xx3-m584-x994 for more details.
-    Ben Crouse
-*   Exclude Update Timestamp From Imports
-    Update the `:updated_at` timestamp to the current time when existing
-    models are updated via an import, and ignore any settings of the
-    `:updated_at` timestamp in JSON/CSV imports, as this can interfere with
-    cache key generation.
-    WORKAREA-126
-    Tom Scott
-*   Fix time zone querying for insights and reports
-    Data was getting stored correctly, but not queried correctly. When
-    building aggregations for MongoDB, the Mongoid logic to use UTC does not
-    kick in since it's not going through the Mongoid DSL.
-    This was the lowest impact fix. Changing how we store reporting_on will
-    invalidate current data and not allow for changing timezones later.
-    WORKAREA-135
-    Ben Crouse
-*   Fix Install Generator On Freshly Created App (#274)
-    The `workarea:install` generator failed with an error finding the
-    `Storefront::Engine` constant when it was run against a freshly
-    generated Rails 5.2.3 application. To resolve this, require the
-    necessary engines in **lib/workarea/core.rb** so the application loads
-    properly the first time, and can run the generator.
-    WORKAREA-134
-    Tom Scott
-*   Add index for better redemption querying
-    As suggested by the hosting team.
-    Ben Crouse
-*   Restrict release datetimepicker to dates in the future
-    WORKAREA-65
     Matt Duffy
-*   Fix polymorphic embedded relations in CSV importing/exporting
-    WORKAREA-120
-    Ben Crouse
+*   Eliminate n+1 query from FeaturedCategorization
-Workarea 3.4.22 (2019-11-26)
---------------------------------------------------------------------------------
-*   Base discount auto-deactivation on updated_at, expose auto_deactivate field
-    WORKAREA-114
     Matt Duffy
-*   Ensure UTF-8 Encoding of Data File Import Samples
-    This ensures data file import samples are always treated as UTF-8.
-    While Ruby itself does do this pretty well, and most browsers are good
-    at guessing the file type/encoding based on the contents of the file,
-    there might be some outliers that rely on metadata that's a bit more
-    strictly adhered to. This change ensures that sample CSV/JSON files are
-    delivered to the user as an attachment, and using the correct MIME type,
-    so that they register as such when downloaded by the browser.
-    Previously, all imports were showing as "TXT file" types, when they were
-    really "CSV file" or "JSON file", and at least in Firefox, they were not
-    downloading when you clicked the sample link. Instead, a new tab would
-    open (since Firefox thinks it's a text file), and you have to refresh
-    the page to actually get the browser to download the file.
-    WORKAREA-77
-    Tom Scott
-*   Import UTF-8 CSVs With BOM Characters
-    UTF-8 doesn't need a BOM in order to start or end a file, but these
-    characters can end up in CSVs generated by older software that doesn't
-    have great support for Unicode. As a result, if a BOM is in the CSV near
-    `_id` it will cause improper importing of the data held within. To
-    address this, Workarea now specifies the `bom|` prefix in the `:encoding`
-    param for `CSV.foreach` by default. This can still be overridden if you
-    have an ASCII file, and since BOM stripping doesn't really apply,
-    developers can override the entire encoding string in configuration
-    if necessary. But this is a sane default for those who use UTF-8 and
-    happen to be exporting out of older spreadsheet software.
+*   Add query cache middleware for sidekiq to provide options for enabling query caches
-    WORKAREA-79
-    Tom Scott
-*   Fix content block asset uploads, set redis key to reduce S3 CORS config requests
-    WORKAREA-109
     Matt Duffy
-*   Update Tests Referencing 2020
-    The credit card expiration year `2020` was hard-coded into many Workarea
-    integration tests, and would fail when January 2020 passes. Update these
-    tests to always set the credit card expiration year to 1 year in
-    advance of when the test runs so this won't happen again in the future.
-    WORKAREA-104
-    Fixes #222
-    Tom Scott
-*   [DOCS] Improve table of contents for docs
-    The table of contents that appears within each doc contains a link to
-    every h2-h6 in the document. Therefore, in longer docs, the TOC gets
-    quite crowded and stops communicating the overall structure of the doc.
-    Help readers maintain context by simplifying the TOC, limiting links to
-    h2-h3.
-    I spot-checked docs of various lengths and found this version of the TOC
-    more useful in all cases.
-    WORKAREA-96
-    Chris Cressman
-Workarea 3.4.21 (2019-11-12)
---------------------------------------------------------------------------------
-*   Update `Redis::Rack::Cache` to v2.2.0
-    This new version requires `Rack::Cache` v1.10 and enables over-the-wire
-    gzip compression to the Redis server. This feature is useful for
-    extremely high traffic sites, but should be used with caution since it
-    will increase the CPU/RAM load on your application server. You should
-    use this if the trade-off between RAM increase and bandwidth decrease
-    makes sense.
-    WORKAREA-94
-    Tom Scott
-*   Bump Chartkick dependency to fix security warning
+*   Use the same Mongo connection options for the index enforcement warning.
-    Fixes bundler-audit failures in builds.
+    Fixes #31
     Ben Crouse
-*   Add index to SearchByDay model
+*   Only check notablescan in development
-    Bryan Alexander
+    #31
+    Jesse McPherson
-*   Remove now-unneeded version restriction on the BSON gem
+*   Completely remove jQuery UI Autocomplete
-    If we remove this restriction, we can use newer versions of the `mongo` gem, which contain cluster fixes.
-    Ben Crouse
+    Curt Howard
-*   [DOCS] Rename and update doc for testing CC transactions
+*   Remove Search Autocomplete
-    Rename "Test a Credit Card Transaction" to
-    "Manually Test Credit Card Transactions" and update the content.
+    Porting to
+    https://github.com/workarea-commerce/workarea-classic-search-autocomplete
+    Curt Howard
-    The content was specific to a particular gateway and didn't make that
-    clear. These changes provide a generic solution in addition to the
-    specifics for the default gateway.
+*   Update sales report queries and metric indexes for cancellations (#14)
-    The title confused devs who reviewed this doc in a different PR,
-    thinking that it had to do with automated testing.
+    Matt Duffy
-    WORKAREA-13
-    Chris Cressman
+*   Remove Search Autocomplete (#16)
-*   Adds graceful handling of timestamps from CSV imports
+    This functionality is being moved to `workarea-classic-search-autocomplete` to maintain compatibility. Going forward, a new improved `workarea-search-autocomplete` is the preferred search autocomplete for Workarea. It's much improved.
+    Curt Howard
-    WORKAREA-24
-    Matt Duffy
+*   Remove artifact from conflict resolution
-*   Don't shell out to bundler to get gem path
+    Jake Beresford
-    This can cause problems if bundler outputs warnings/errors. There's a safe way to do it in Ruby, so use that instead.
+*   Initial commit for v3.5
-    Fixes #191
     Ben Crouse