Allow multiple config settings, different config name, and/or add additional documentation for config name requirement.

Created on 15 November 2019, almost 5 years ago
Updated 29 June 2023, over 1 year ago

Problem/Motivation

When initially trying to set this up, I kept getting an Invalid custom result display and some js console notices.

It took me a bit to realize why it wasn't working.

When I created the search config, I created it with a machine name of custom_google_cse_search_default. After a bit of spelunking I realized that module requires config to be named search.page.google_cse_search, given references in both google_cse.theme.inc and google_cse.module.

Proposed resolution

Interim Risk Mitigation - 1) Add supporting documentation. 2) Add a message in the form where the config is created that the machine name must match google_cse_search and/or alter the form so that it cannot be changed (in the interim).

Long Term Solution - 3) Allow dynamically loading config and maybe even consider allowing multiple config options?

Remaining tasks

Update documentation to reduce confusion as a stop gap measure.
Subsequently and write code / patches for functionality and tests as needed.

User interface changes

TBD

API changes

N/A

Data model changes

TBD (depending on how solutions for config are managed).

✨ Feature request
Status

Closed: works as designed

Version

4.0

Component

Code

Created by

πŸ‡ΊπŸ‡ΈUnited States matt_paz

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • πŸ‡ΊπŸ‡ΈUnited States mark_fullmer Tucson

    Snippet from original issue description:

    this module requires config to be named search.page.google_cse_search

    Statement indicating that this issue should remain open:

    there is no solution for the 4.x and this still needs to be addressed.

    I'd like to check in on this. My understanding is that the 4.x branch does in fact resolve the original issue here, as it addresses the monolithic search.page.google_cse_search design as described in https://www.drupal.org/project/google_cse/issues/3279974#comment-14605590 β†’

    I tested this again and verified that I can create a Drupal search instance with a machine name other than google_cse_search and that its settings are reflected when placed as a block on the page.

    If I am missing something, please provide steps to reproduce.

    If there is no response in the next 60 days, the maintainers can close this issue as "Works as designed."

  • Status changed to Closed: works as designed over 1 year ago
  • πŸ‡ΊπŸ‡ΈUnited States mark_fullmer Tucson

    Since there has been no response during the timeframe indicated in the previous comment, I will proceed to mark this issue as "Works as designed."

Production build 0.71.5 2024