Google Analytics Search API Autocomplete

This module integrates Search API Autocomplete widgets with Google Analytics module. It's aimed to provide full insights about how your users use search autocomplete on your website. With this module installed it is possible to track jQuery UI autocomplete events and pass them to Google Analytics Events tracking.

You can find more details at project's page: https://www.drupal.org/project/google_analytics_search_api_autocomplete
and in README file: http://cgit.drupalcode.org/google_analytics_search_api_autocomplete/tree...

Similar projects/duplication:

This module has been consulted with maintaners of google_analytics and search_api_autocomplete projects,
before I've started it as a standalone piece of code we had a quite intensive conversations,
and we agreed that it's okay to publish it as a separate d.o. project.

From similar projects, there's google_analytics_et , yet it's targeted to track pure jQuery (not jQuery UI) events,
while Google Analytics Search API Autocomplete has a clean purpose - it should be an easy plug n' play module
which will allow product owners / non-technical users to set up autocomplete tracking pretty fast.

Coding standards and style

I've already made a review using ESLint and PHP Code Sniffers, see pareview.sh report:
https://pareview.sh/pareview/https-git.drupal.org-project-google_analyti...

The module has been also tested with caching enabled / JS aggregation / advagg_js module turned on on variety environments.

Git instructions

git clone --branch 8.x-1.x https://git.drupal.org/project/google_analytics_search_api_autocomplete.git

Manual reviews of other projects

https://www.drupal.org/project/projectapplications/issues/2976268#comment-12634815
https://www.drupal.org/project/projectapplications/issues/2976995#comment-12640267
https://www.drupal.org/project/projectapplications/issues/2657506#comment-12641637
https://www.drupal.org/project/projectapplications/issues/2866223#comment-12648772
https://www.drupal.org/project/projectapplications/issues/2978252#comment-12652793

Comments

sandboxpl created an issue. See original summary.

sandboxpl’s picture

sandboxpl
Primary language Polish
Location Poland 🇵🇱
commented
Issue summary: View changes
sleitner’s picture

sleitner commented

Automated Review

Review of the 8.x-1.x branch (commit 016a52d):

  • No automated test cases were found, did you consider writing PHPUnit tests? This is not a requirement but encouraged for professional software development.

This automated report was generated with PAReview.sh, your friendly project application review script.

Manual Review

Individual user account
[Yes: Follows] the guidelines for individual user accounts.
No duplication
[Yes: Does not cause] module duplication and/or fragmentation.
Master Branch
[Yes: Follows] the guidelines for master branch.
Licensing
[Yes: Follows] the licensing requirements.
3rd party assets/code
[Yes: Follows] the guidelines for 3rd party assets/code.
README.txt/README.md
[Yes: Follows] the guidelines for in-project documentation and/or the README Template.
Code long/complex enough for review
[Yes: Follows] the guidelines for project length and complexity.
Secure code
[Yes: Meets the security requirements.]
Coding style & Drupal API usage
No issues

If added, please don't remove the security tag, we keep that for statistics and to show examples of security problems.

This review uses the Project Application Review Template.

sleitner’s picture

sleitner commented
Status: Needs review » Reviewed & tested by the community
zaporylie’s picture

zaporylie
he/him
Primary language Polish
commented
Status: Reviewed & tested by the community » Needs work

I believe there are some errors to google_analytics_search_api_autocomplete.info.yml that should be fixed prior to fixing this issue:
- `hidden: false` is redundant
- dependencies are provided in the wrong format. Correct format is {project}:{module}, where {project} is project's name on drupal.org. Here drupal is used even though listed modules are not provided by drupal.org/project/drupal. Read more on https://www.drupal.org/docs/8/creating-custom-modules/let-drupal-8-know-...

In addition I think that GoogleAnalyticsSearchApiAutocompleteAdminSettingsForm could be changed to something more readable. Thanks to Namespaces we are avoiding name conflicts anyways.

avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Issue summary: View changes
sandboxpl’s picture

sandboxpl
Primary language Polish
Location Poland 🇵🇱
commented
Status: Needs work » Needs review

Thank You so much for spending your time on reviewing this module!
@zaporylie I've applied necessary changes in info.yml file, and I definitely agree with you regarding class name of admin form, simply changed it to AdminSettingsForm. My changes are ready in branch 8.x-1.x, you can check the commit here:
http://cgit.drupalcode.org/google_analytics_search_api_autocomplete/commit/?id=41ddd99565bb77998bfc148667a05a381e617d89

sleitner’s picture

sleitner commented
Status: Needs review » Reviewed & tested by the community

All three issues noticed by @zaporylie are fixed. I found no other issues.

manish.upadhyay’s picture

manish.upadhyay commented

I have tested this module and it is working fine for me and found no major issue.

Thanks,

manish.upadhyay’s picture

manish.upadhyay commented
visabhishek’s picture

visabhishek commented
Status: Reviewed & tested by the community » Fixed

Thank you for your contribution!

I am going to update your account so you can opt into security advisory coverage now.

These are some recommended readings to help with excellent maintainership:

You can find more contributors chatting on the IRC #drupal-contribute channel. So, come hang out and stay involved.

Thank you, also, for your patience with the review process.

Anyone is welcome to participate in the review process. Please consider reviewing other projects that are pending review. I encourage you to learn more about that process and join the group of reviewers.

I thank all the dedicated reviewers as well.

visabhishek’s picture

visabhishek commented

Assigning Credits.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.