debug: trial folder-level separation (DONOTMERGE)

[glasnt]

Description

Proof of concept: /compute folder is currently a single "package", taking ~1 hour to test.

Try isolating the custom-hostname-instance by turning into a standalone package

Changes made:

• update config to make compute/ ignored as a parent directory
• copy package.json, remove unrequired deps, update 'package' name
• update local file reference calls
• replace use of create/deleteInstance.js samples with direct API call
• reduce timeout to within tolerance.

Paths of region tags do not change, no upstream change required.

[gemini-code-assist]

Hello @glasnt, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

This pull request is a proof of concept to isolate the custom-hostname-instance sample within the compute directory into a standalone package. The goal is to reduce the overall test time for the compute directory by breaking it into smaller, independently testable units. The changes include updating the configuration to ignore the compute directory as a parent, creating a new package.json with only the necessary dependencies, updating local file references, replacing the use of create/deleteInstance.js samples with direct API calls, and reducing the test timeout.

Highlights

• Configuration Update: The .github/config/nodejs-dev.jsonc and .github/config/nodejs-prod.jsonc files are modified to exclude the compute directory from the parent directory checks. This allows the custom-hostname-instance to be treated as an independent package.
• Package Isolation: A new package.json file is created in the compute/custom-hostname-instance directory, defining the package's name, dependencies, and test script. Unnecessary dependencies have been removed to keep the package lightweight.
• Code Modification: The test file compute/custom-hostname-instance/test/customHostnameInstance.test.js has been updated to use direct API calls instead of relying on the create/deleteInstance.js samples. This reduces dependencies and simplifies the test setup.
• Test Timeout Reduction: The test timeout in compute/custom-hostname-instance/package.json has been adjusted to be within tolerance, likely to speed up the test execution.

Changelog

• .github/config/nodejs-dev.jsonc
  • Added compute to the list of ignored parent directories.
• .github/config/nodejs-prod.jsonc
  • Removed compute from the list of ignored parent directories.
• compute/custom-hostname-instance/package.json
  • Created a new package.json file for the custom-hostname-instance sample.
  • Defined the package name, dependencies, and test script.
• compute/custom-hostname-instance/test/customHostnameInstance.test.js
  • Replaced the use of create/deleteInstance.js samples with direct API calls.
  • Added tests to verify instance creation with custom hostname and retrieval of hostname.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

---

A package grows alone,
Tests take an hour, a groan,
Split it, make it fast,
The tests will quickly pass,
A better build is shown.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request aims to isolate the custom-hostname-instance within the compute folder to reduce test times. The changes involve updating configurations, copying package files, modifying local file references, and replacing the use of create/deleteInstance.js samples with direct API calls. Overall, the changes seem reasonable for the stated goal. However, there are a few areas that could be improved for clarity and maintainability.

Summary of Findings

• Duplicated Code: The createInstance function is duplicated in the test file. This duplication should be addressed by either importing the function or creating a shared utility function.
• Hardcoded Zone: The zone 'europe-central2-b' is hardcoded in the test file. Consider using a configuration or environment variable to manage the zone for better flexibility.
• Inconsistent Timeout: The timeout value in the package.json file is quite high (300000 ms). Verify if this timeout is necessary and consider reducing it if possible.

Merge Readiness

The pull request is a good step towards isolating the custom-hostname-instance package. However, the duplicated code in the test file should be addressed before merging. Additionally, consider making the zone configurable and verifying the necessity of the high timeout value. I am unable to directly approve this pull request, and recommend that others review and approve this code before merging.

[gemini-code-assist]

This createInstance function is a duplicate of the one found in compute/createInstance.js. Duplicating code makes maintenance harder. Consider importing the function or creating a shared utility function to avoid duplication.

// Consider importing createInstance from a shared utility module
// import { createInstance } from '../utils';
// Or define it in a shared location

const createInstance = async (projectId, zone, instanceName)  => {

  const machineType = 'n1-standard-1';
  const sourceImage = 'projects/debian-cloud/global/images/family/debian-11';
  const networkName = 'global/networks/default';
  console.log(`Creating the ${instanceName} instance in ${zone}...`);

  const [response] = await instancesClient.insert({
    instanceResource: {
      name: instanceName,
      disks: [
        {
          initializeParams: {
            diskSizeGb: '10',
            sourceImage,
          },
          autoDelete: true,
          boot: true,
          type: 'PERSISTENT',
        },
      ],
      machineType: `zones/${zone}/machineTypes/${machineType}`,
      networkInterfaces: [
        {
          name: networkName,
        },
      ],
    },
    project: projectId,
    zone,
  });

}

[gemini-code-assist]

The zone is hardcoded here. Consider using a configuration or environment variable to manage the zone for better flexibility and to avoid hardcoding values.

const zone = process.env.GCLOUD_ZONE || 'europe-central2-b';

[gemini-code-assist]

This timeout value seems quite high. Is it necessary? Consider reducing it if possible to speed up the tests.

"test": "c8 mocha -p -j 2 test --timeout 60000"