Module Name: Drupal SearchUnify Connector

Description: The Drupal SearchUnify Connector (SUDC) module integrates SearchUnify with Drupal to enhance search functionality on Drupal websites. The current version (2.0.0) is fully compatible with Drupal 11.

Project link

https://www.drupal.org/project/sudc

CommentFileSizeAuthor
#6 sudc-phpcs-issues.txt81.57 KBvishal.kadam

Comments

neelam-webdev created an issue. See original summary.

vishal.kadam’s picture

Title: Drupal SearchUnify Connector - Security Advisory Coverage Application for Drupal 11 (2.0.0 Release) » [2.0.x] SearchUnify Drupal Connector
Issue summary: View changes
vishal.kadam’s picture

Status: Active » Needs work

Thank you for applying!

For these applications, we need a project where, in at least the branch used for the application, most of the commits (if not all the commits) have been done from the user who applies. You have only renamed the module files and changed namespaces in files in your commit.

The purpose of these applications is reviewing a project to understand what the person who applies understands about writing secure code that follows the Drupal coding standards and correctly uses the Drupal API, not what all the project maintainers collectively understand about those points.

This application can only continue with a project (and a branch) where all the commits (or the majority of the commits) have been done by you.

avpaderno’s picture

Status: Needs work » Needs review

The fist commit done by neelam-webdev significantly changed the files. This application is acceptable.

avpaderno’s picture

Thank you for applying!

Please read Review process for security advisory coverage: What to expect for more details and Security advisory coverage application checklist to understand what reviewers look for. Tips for ensuring a smooth review gives some hints for a smoother review.

The important notes are the following.

  • If you have not done it yet, you should enable GitLab CI for the project and fix the PHP_CodeSniffer errors/warnings it reports.
  • For the time this application is open, only your commits are allowed.
  • The purpose of this application is giving you a new drupal.org role that allows you to opt projects into security advisory coverage, either projects you already created, or projects you will create. The project status will not be changed by this application; once this application is closed, you will be able to change the project status from Not covered to Opt into security advisory coverage. This is possible only 14 days after the project is created.
    Keep in mind that once the project is opted into security advisory coverage, only Security Team members may change coverage.
  • Only the person who created the application will get the permission to opt projects into security advisory coverage. No other person will get the same permission from the same application; that applies also to co-maintainers/maintainers of the project used for the application.
  • We only accept an application per user. If you change your mind about the project to use for this application, or it is necessary to use a different project for the application, please update the issue summary with the link to the correct project and the issue title with the project name and the branch to review.

To the reviewers

Please read How to review security advisory coverage applications, Application workflow, What to cover in an application review, and Tools to use for reviews.

The important notes are the following.

  • It is preferable to wait for a project moderator before posting the first comment on newly created applications. Project moderators will do some preliminary checks that are necessary before any change on the project files is suggested.
  • Reviewers should show the output of a CLI tool only once per application.
  • It may be best to have the applicant fix things before further review.

For new reviewers, I would also suggest to first read In which way the issue queue for coverage applications is different from other project queues.

vishal.kadam’s picture

Status: Needs review » Needs work
StatusFileSize
new81.57 KB

1. Fix phpcs issues.

See attached file - sudc-phpcs-issues.txt

2. FILE: sudc.libraries.yml

version: VERSION

VERSION is only used by Drupal core modules. Contributed modules should use a literal string that does not change with the Drupal core version a site is using.

3. FILE: sudc.module

/**
 * @file
 * Functions to support theming in the SU module.
 */

The usual description for a .module file is Hook implementations for the [module name] module. where [module name] is the module name given in the .info.yml file.

4. FILE: README.txt

Replace README.txt with README.md file, that should follow the content and formatting described in README.md template.

5. FILE: templates/helpcontent.html.twig, templates/su-results.html.twig, templates/sufooter.html.twig

Twig code needs to be correctly indented. Drupal uses two spaces for indentation, not four spaces or tabs.

6. FILE: templates/su-results.html.twig

    <script type="text/javascript" src="{{ data.cdn }}{{ data.uid }}/an.js"></script>
    <script type="text/javascript" src="{{ data.cdn }}{{ data.uid }}/main.js"></script>
    <link rel="stylesheet" href="{{ data.cdn }}{{ data.uid }}/main.css">

Move all scripts (JavaScript) and styles (CSS) into a library and attach them. See the process here.

{# <script type="text/javascript" src="{{ data.epoint }}/resources/search_clients_custom/{{ data.uid }}/external_scripts.js"></script> #}

{# <link rel="stylesheet" href="{{ data.epoint }}/resources/search_clients_custom/{{ data.uid }}/external_styles.css"> #}

Remove commented code.

7. FILE: js/index.js

Javascript code needs to be correctly indented. Drupal uses two spaces for indentation, not four spaces or tabs.

8. FILE: src/Controller/SuResultController.php

    /**
     * Class constructor.
     *
     * @param \sudc\CommonCalls              $ccall    CommonCalls service.
     * @param \sudc\RestCalls                $rcall    RestCalls service.
     * @param \Config\ConfigFactoryInterface $cfactory configuration factory service.
     */
    public function __construct(

FILE: src/Services/CommonCalls.php

    /**
     * The constructor.
     *
     * @param \Render\RendererInterface $rendertemp The renderer interface.
     */
    public function __construct(RendererInterface $rendertemp)

FILE: src/Services/RestCalls.php

    /**
     * The constructor.
     *
     * @param \GuzzleHttp\Client             $httpClient HTTP client manager service
     * @param \config\ConfigFactoryInterface $cfactory   Config factory service
     *
     * @throws \Exception
     *   If the request content is invalid.
     */
    public function __construct(Client $httpClient, ConfigFactoryInterface $cfactory)

The documentation comment for constructors is not mandatory anymore, If it is given, the description must be Constructs a new [class name] object. where [class name] includes the class namespace.

rushikesh raval’s picture

Priority: Normal » Minor

I am changing priority as per Issue priorities.

avpaderno’s picture

This thread has been idle, in the needs work state with no activity for some months.

May you confirm you are still pursuing this application? If this is the case, and you made commits basing on what previously reported, or you can answer the questions previously asked, please change the status to Needs review.

avpaderno’s picture

Status: Needs work » Closed (won't fix)

This thread has been idle, in the Needs work state with no activity for about six months or more; the application has been created about 11 months ago or more. Therefore, I marked it as Closed (won't fix).

If this is incorrect, and you are still pursuing this application, please feel free to re-open it and set the issue status to Needs work or Needs review, depending on the current status of your code.

Now that this issue is closed, please review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, please credit people who helped resolve this issue.