chore(ci): migrate datastore/functions to new ci

[glasnt]

Description

Fixes #

Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google.

Checklist

• I have followed guidelines from CONTRIBUTING.MD and Samples Style Guide
• Tests pass: npm test (see Testing)
• Lint pass: npm run lint (see Style)
• These samples need a new API enabled in testing projects to pass (let us know which ones)
• These samples need a new/updated env vars in testing projects set to pass (let us know which ones)
• This pull request is from a branch created directly off of GoogleCloudPlatform/nodejs-docs-samples. Not a fork.
• This sample adds a new sample directory, and I updated the CODEOWNERS file with the codeowners for this sample
• This sample adds a new sample directory, and I created GitHub Actions workflow for this sample
• This sample adds a new Product API, and I updated the Blunderbuss issue/PR auto-assigner with the codeowners for this sample
• Please merge this PR for me once it is approved

[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 migrates the datastore/functions sample to a new CI setup. The changes include updating the nodejs-dev.jsonc file to include datastore/functions in the list of samples, modifying the index.js file to use ES modules (import instead of require) and export the functions using the export keyword, updating the package.json file to specify type: module, and updating the test file index.test.js to use ES modules and modern assertion methods.

Highlights

• CI Migration: The primary goal is to migrate the datastore/functions sample to a new CI pipeline.
• ES Module Conversion: The code is updated to use ES modules instead of CommonJS modules, using import and export.
• Test Updates: The test suite is updated to align with the ES module conversion and uses modern assertion methods.

Changelog

Click here to see the changelog

• .github/config/nodejs-dev.jsonc
  • Added datastore/functions to the list of samples to be included in the CI.
• datastore/functions/index.js
  • Replaced require('@google-cloud/datastore') with import { Datastore } from '@google-cloud/datastore'; (line 17).
  • Exported the set, get, and del functions using the export async function syntax instead of exports.set = async (lines 61, 97, 127).
• datastore/functions/package.json
  • Added "type": "module" to the package.json file to enable ES module support (line 10).
• datastore/functions/test/index.test.js
  • Replaced require statements with import statements for assertion libraries, path manipulation, UUID generation, sinon stubs, fetch, waitPort, and Datastore (lines 17-24).
  • Replaced require('../') with import { set, get, del } from '../'; (line 27).
  • Replaced assert.ok with ok, assert.strictEqual with strictEqual, and assert.deepStrictEqual with deepStrictEqual (lines 81, 82, 96, 97, 114, 115, 128, 130, 162, 164, 180, 182, 198, 199, 215, 216, 248, 249, 265, 266, 278, 280, 292, 294, 298).
  • Replaced sinon.stub() with stub() (lines 75, 76, 92, 93, 108, 109, 192, 193, 209, 210, 242, 243, 259, 260).

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.

---

Trivia time!

What does the acronym ES stand for in the context of ECMAScript (ES Modules)?

Click here for the answer

ES stands for ECMAScript, which is a scripting-language specification standardized by Ecma International.

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

The pull request migrates the datastore/functions to a new CI. The changes include updating the dependencies, modifying the import statements, and updating the test assertions. Overall, the changes seem reasonable, but there are a few areas that could be improved.

Summary of Findings

• Inconsistent import style: The code uses both require and import statements. It's recommended to use a consistent style throughout the project. Since the project is migrating to use modules, it should use import statements exclusively.
• Test assertions: The test assertions are being changed from assert.ok to ok. While this isn't necessarily wrong, it's worth considering whether this change improves readability or maintainability. It also changes the style of the test assertions, which should be consistent.
• Unnecessary functions-framework execution in tests: The tests execute the functions-framework command, which might not be necessary for unit tests. Consider mocking the function execution instead.

Merge Readiness

The pull request is almost ready for merging. However, the inconsistent import style and test assertions should be addressed before merging. I am unable to directly approve the pull request, and recommend that others review and approve this code before merging. The pull request should not be merged until the high severity issues are addressed.

[gemini-code-assist]

This change switches from sinon.stub() to stub(). Ensure that stub is correctly imported from sinon.

Suggested change

	status: stub().returnsThis(),
	status: stub().returnsThis(),

[gemini-code-assist]

This change switches from sinon.stub() to stub(). Ensure that stub is correctly imported from sinon.

Suggested change

	send: stub(),
	send: stub(),

[gemini-code-assist]

This change switches from program.set to set. Ensure that set is correctly imported.

Suggested change

	await set(req, res);
	await set(req, res);

[gemini-code-assist]

This change switches from assert.ok to ok. While this isn't necessarily wrong, it's worth considering whether this change improves readability or maintainability. It also changes the style of the test assertions, which should be consistent.

Suggested change

	ok(res.status.calledWith(500));
	ok(res.status.calledWith(500));

[gemini-code-assist]

This change switches from assert.ok to ok. While this isn't necessarily wrong, it's worth considering whether this change improves readability or maintainability. It also changes the style of the test assertions, which should be consistent.

Suggested change

	ok(res.send.calledWith(errorMsg('Value')));
	ok(res.send.calledWith(errorMsg('Value')));

[gemini-code-assist]

This change switches from assert.strictEqual to strictEqual. While this isn't necessarily wrong, it's worth considering whether this change improves readability or maintainability. It also changes the style of the test assertions, which should be consistent.

Suggested change

	strictEqual(response.status, 200);
	strictEqual(response.status, 200);

[gemini-code-assist]

This change switches from assert.strictEqual to strictEqual. While this isn't necessarily wrong, it's worth considering whether this change improves readability or maintainability. It also changes the style of the test assertions, which should be consistent.

Suggested change

	strictEqual(body, `Entity ${KIND}/nonexistent deleted.`);
	strictEqual(body, `Entity ${KIND}/nonexistent deleted.`);

[gemini-code-assist]

This change switches from assert.strictEqual to strictEqual. While this isn't necessarily wrong, it's worth considering whether this change improves readability or maintainability. It also changes the style of the test assertions, which should be consistent.

Suggested change

	strictEqual(response.status, 200);
	strictEqual(response.status, 200);

[gemini-code-assist]

This change switches from assert.strictEqual to strictEqual. While this isn't necessarily wrong, it's worth considering whether this change improves readability or maintainability. It also changes the style of the test assertions, which should be consistent.

Suggested change

	strictEqual(body, `Entity ${KIND}/${NAME} deleted.`);
	strictEqual(body, `Entity ${KIND}/${NAME} deleted.`);

[gemini-code-assist]

This change switches from assert.ok to ok. While this isn't necessarily wrong, it's worth considering whether this change improves readability or maintainability. It also changes the style of the test assertions, which should be consistent.

Suggested change

	ok(!entity);
	ok(!entity);